Mercurial > octave

annotate liboctave/util/url-transfer.h @ 29359:7854d5752dd2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: merge stable to default.
author John W. Eaton <jwe@octave.org>
date Wed, 10 Feb 2021 10:10:40 -0500
parents 28913793f678 0a5b15007766
children e38202d3628d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 //
29358
0a5b15007766 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27978
diff changeset
3 // Copyright (C) 2006-2021 The Octave Project Developers
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
26 #if ! defined (octave_url_transfer_h)
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 #define octave_url_transfer_h 1
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21017
diff changeset
29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21017
diff changeset
30
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
31 #include <istream>
24254
4bca68f0d8d5 use shared_ptr to manage url_transfer object
John W. Eaton <jwe@octave.org>
parents: 23696
diff changeset
32 #include <memory>
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
33 #include <ostream>
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 #include <string>
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
23442
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
36 #include "str-vec.h"
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
37
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
38 template <typename T> class Array;
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
39
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
40 namespace octave
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 {
27048
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
42 struct weboptions
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
43 {
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
44 std::string UserAgent;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
45 long Timeout;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
46 std::string Username;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
47 std::string Password;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
48 Array<std::string> HeaderFields;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
49 std::string ContentReader;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
50 std::string RequestMethod;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
51 std::string ArrayFormat;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
52 std::string CertificateFilename;
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
53 };
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
54
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
55 class
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
56 OCTAVE_API
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
57 base_url_transfer
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 {
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
59 public:
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
60
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
61 friend class url_transfer;
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
62
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
63 base_url_transfer (void);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
65 base_url_transfer (const std::string& host,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
66 const std::string& /* user_arg */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
67 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
68 std::ostream& os);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69
25438
cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
70 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
71
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
72 // No copying!
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 (const base_url_transfer&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
75
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
76 base_url_transfer& operator = (const base_url_transfer&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
77
22868
87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
78 virtual ~base_url_transfer (void) = default;
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
79
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
80 bool is_valid (void) const { return m_valid; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
81
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
82 bool good (void) const { return m_valid && m_ok; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
84 virtual void perform (void) { }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
85
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
86 virtual std::string lasterror (void) const { return m_errmsg; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
87
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
88 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
89 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
90 return *m_curr_ostream;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
91 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
92
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
93 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
94 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
95 return *m_curr_istream;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
96 }
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 ascii (void) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
99
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
100 virtual void binary (void) { }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
101
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
102 bool is_ascii (void) const { return m_ascii_mode; }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
104 bool is_binary (void) const { return ! m_ascii_mode; }
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 cwd (const std::string& /* path */) { }
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 del (const std::string& /* file */) { }
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 rmdir (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 mkdir (const std::string& /* path */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
113
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
114 virtual void rename (const std::string& /* oldname */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
115 const std::string& /* newname */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
116
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
117 virtual void put (const std::string& /* file */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
118 std::istream& /* is */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
119
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
120 virtual void get (const std::string& /* file */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
121 std::ostream& /* os */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
122
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
123 void mget_directory (const std::string& directory,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
124 const std::string& target);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
125
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
126 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
127 const std::string& directory);
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 void dir (void) { }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
130
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
131 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
132
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
133 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
134 double& /* filesize */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
135 time_t& /* filetime */,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
136 bool& /* fileisdir */) { }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
137
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
138 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
139
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
140 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
141
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
142 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
143
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
144 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
145 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
146
27048
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
147 virtual void cookie_jar (const std::string& /* filename */) { }
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
148
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
149 virtual void set_header_fields (const Array<std::string>& /* param */) { }
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
150
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
151 virtual void form_data_post (const Array<std::string>& /* param */) { }
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
152
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
153 virtual void set_weboptions (const struct weboptions& /* param */) { }
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
154
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
155 protected:
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
156
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
157 // Host for ftp transfers or full URL for http requests.
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
158 std::string m_host_or_url;
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
159 bool m_valid;
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
160 bool m_ftp;
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
161 bool m_ascii_mode;
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
162 bool m_ok;
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
163 std::string m_errmsg;
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
164 std::istream *m_curr_istream;
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
165 std::ostream *m_curr_ostream;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
166 };
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
167
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
168 class
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
169 OCTAVE_API
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
170 url_transfer
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
171 {
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
172 public:
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
173
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
174 url_transfer (void);
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
175
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
176 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
177 const std::string& passwd, std::ostream& os);
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 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
180
24991
831389905438 omit argument name from default copy ctors and assignment operators
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
181 url_transfer (const url_transfer&) = default;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
182
24991
831389905438 omit argument name from default copy ctors and assignment operators
John W. Eaton <jwe@octave.org>
parents: 24534
diff changeset
183 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
184
24254
4bca68f0d8d5 use shared_ptr to manage url_transfer object
John W. Eaton <jwe@octave.org>
parents: 23696
diff changeset
185 ~url_transfer (void) = default;
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
186
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
187 bool is_valid (void) const { return m_rep->is_valid (); }
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
188
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
189 bool good (void) const { return m_rep->good (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
190
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
191 std::string lasterror (void) const { return m_rep->lasterror (); }
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 std::ostream& set_ostream (std::ostream& os)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
194 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
195 return m_rep->set_ostream (os);
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
196 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
197
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
198 std::istream& set_istream (std::istream& is)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
199 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
200 return m_rep->set_istream (is);
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
201 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
202
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
203 void ascii (void) { m_rep->ascii (); }
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
204
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
205 void binary (void) { m_rep->binary (); }
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
206
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
207 bool is_ascii (void) const { return m_rep->is_ascii (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
208
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
209 bool is_binary (void) const { return m_rep->is_binary (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
210
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
211 void cwd (const std::string& path) { m_rep->cwd (path); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
212
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
213 void del (const std::string& file) { m_rep->del (file); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
214
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
215 void rmdir (const std::string& path) { m_rep->rmdir (path); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
216
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
217 void mkdir (const std::string& path) { m_rep->mkdir (path); }
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 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
220 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
221 m_rep->rename (oldname, newname);
21744
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 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
225 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
226 m_rep->put (file, is);
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
227 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
228
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
229 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
230 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
231 m_rep->get (file, os);
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
232 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
233
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
234 void mget_directory (const std::string& directory,
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
235 const std::string& target)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
236 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
237 m_rep->mget_directory (directory, target);
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
238 }
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 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
241 const std::string& directory)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
242 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
243 return m_rep->mput_directory (base, directory);
21744
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
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
246 void dir (void) { m_rep->dir (); }
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
247
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
248 string_vector list (void) { return m_rep->list (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
249
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
250 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
251 time_t& filetime, bool& fileisdir)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
252 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
253 m_rep->get_fileinfo (filename, filesize, filetime, fileisdir);
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
254 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
255
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
256 std::string pwd (void) { return m_rep->pwd (); }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
257
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
258 void http_get (const Array<std::string>& param)
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
259 {
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
260 m_rep->http_get (param);
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
261 }
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
262
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
263 void http_post (const Array<std::string>& param)
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
264 {
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
265 m_rep->http_post (param);
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
266 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
267
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
268 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
269 const std::string& action)
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
270 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
271 m_rep->http_action (param, action);
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
272 }
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
273
27048
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
274 void cookie_jar (const std::string& filename)
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
275 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
276 m_rep->cookie_jar (filename);
27048
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
277 }
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
278
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
279 void set_header_fields (const Array<std::string>& param)
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
280 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
281 m_rep->set_header_fields (param);
27048
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
282 }
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
283
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
284 void form_data_post (const Array<std::string>& param)
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
285 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
286 m_rep->form_data_post (param);
27048
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
287 }
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
288
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
289 void set_weboptions (const struct weboptions& param)
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
290 {
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
291 m_rep->set_weboptions (param);
27048
159402e52cfa New implementation of RESTful web services as part of GSoC 2018 (patch #9795).
Sahil Yadav <yadavsahil5198@gmail.com>
parents: 26376
diff changeset
292 }
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
293
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
294 private:
17596
43b9181340fb separate object creation from http actions in url_transfer class
John W. Eaton <jwe@octave.org>
parents: 17557
diff changeset
295
27174
b42350f18afb style fixes for url-transfer classes
John W. Eaton <jwe@octave.org>
parents: 27048
diff changeset
296 std::shared_ptr<base_url_transfer> m_rep;
21744
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
297 };
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
298 }
e1be0b36fbed use namespace for url_transfer class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
299
17555
0946b0e06544 move url_transfer classes to liboctave
John W. Eaton <jwe@octave.org>
parents:
diff changeset
300 #endif