octave: liboctave/util/url-transfer.h annotate

annotate liboctave/util/url-transfer.h @ 24991:831389905438 stable

omit argument name from default copy ctors and assignment operators * thread-manager.h, fcn-info.h, graphics.in.h, load-path.h, oct-stream.cc, pr-flt-fmt.h, symrec.h, octave.h, oct-lvalue.h, child-list.h, pathsearch.h, url-transfer.h: Use "(const foo&)" instead of "(const foo& arg)" for declaration of default copy constructors and assignment operators.

author	John W. Eaton <jwe@octave.org>
date	Mon, 26 Mar 2018 13:10:42 -0400
parents	194eb4bd202b
children	6652d3823428

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
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 2013-2017 John W. Eaton
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	4 Copyright (C) 2006-2016 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
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	33 #include <iosfwd>
24254 4bca68f0d8d5 use shared_ptr to manage url_transfer object John W. Eaton <jwe@octave.org> parents: 23696 diff changeset	34 #include <memory>
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	35 #include <string>
0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	36
23442 53f5f8231c37 allow most header files to be compiled separately John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	37 #include "str-vec.h"
53f5f8231c37 allow most header files to be compiled separately John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	38
53f5f8231c37 allow most header files to be compiled separately John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	39 template <typename T> class Array;
53f5f8231c37 allow most header files to be compiled separately John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	40
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	41 namespace octave
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	42 {
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	43 class
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	44 OCTAVE_API
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	45 base_url_transfer
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	46 {
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	47 private:
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	48
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	49 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	50
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	51 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	52 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	53 curl_xfer->cwd ("..");
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	54 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	55
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	56 public:
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	57
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	58 friend class url_transfer;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	59
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	60 base_url_transfer (void)
24254 4bca68f0d8d5 use shared_ptr to manage url_transfer object John W. Eaton <jwe@octave.org> parents: 23696 diff changeset	61 : host_or_url (), valid (false), ftp (false),
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	62 ascii_mode (false), ok (true), errmsg (),
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	63 curr_istream (&std::cin), curr_ostream (&std::cout) { }
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 */,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	68 std::ostream& os)
24254 4bca68f0d8d5 use shared_ptr to manage url_transfer object John W. Eaton <jwe@octave.org> parents: 23696 diff changeset	69 : host_or_url (host), valid (false), ftp (true),
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	70 ascii_mode (false), ok (true), errmsg (), curr_istream (&std::cin),
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	71 curr_ostream (&os) { }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	72
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	73 base_url_transfer (const std::string& url, std::ostream& os)
24254 4bca68f0d8d5 use shared_ptr to manage url_transfer object John W. Eaton <jwe@octave.org> parents: 23696 diff changeset	74 : host_or_url (url), valid (false), ftp (false),
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	75 ascii_mode (false), ok (true), errmsg (),
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	76 curr_istream (&std::cin), curr_ostream (&os) { }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	77
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	78 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	79
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	80 base_url_transfer (const base_url_transfer&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	81
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	82 base_url_transfer& operator = (const base_url_transfer&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	83
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	84 virtual ~base_url_transfer (void) = default;
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 bool is_valid (void) const { return valid; }
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 bool good (void) const { return valid && ok; }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	89
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	90 virtual void perform (void) { }
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	91
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	92 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	93
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	94 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	95 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	96 return *curr_ostream;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	97 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	98
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	99 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	100 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	101 return *curr_istream;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	102 }
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 ascii (void) { }
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 binary (void) { }
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	107
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	108 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	109
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	110 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	111
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	112 virtual void cwd (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 del (const std::string& /* file */) { }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	115
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	116 virtual void rmdir (const std::string& /* path */) { }
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 mkdir (const std::string& /* path */) { }
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 rename (const std::string& /* oldname */,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	121 const std::string& /* newname */) { }
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 virtual void put (const std::string& /* file */,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	124 std::istream& /* is */) { }
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 virtual void get (const std::string& /* file */,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	127 std::ostream& /* os */) { }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	128
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	129 void mget_directory (const std::string& directory,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	130 const std::string& target);
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	131
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	132 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	133 const std::string& directory);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	134
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	135 virtual void dir (void) { }
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	136
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	137 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	138
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	139 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	140 double& /* filesize */,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	141 time_t& /* filetime */,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	142 bool& /* fileisdir */) { }
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 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	145
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	146 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	147
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	148 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	149
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	150 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	151 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	152
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	153 protected:
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	154
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	155 // 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	156 std::string host_or_url;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	157 bool valid;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	158 bool ftp;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	159 bool ascii_mode;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	160 bool ok;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	161 std::string errmsg;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	162 std::istream *curr_istream;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	163 std::ostream *curr_ostream;
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	164 };
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 class
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	167 OCTAVE_API
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	168 url_transfer
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	169 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	170 public:
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	171
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	172 url_transfer (void);
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 (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	175 const std::string& passwd, std::ostream& os);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	176
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	177 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	178
24991 831389905438 omit argument name from default copy ctors and assignment operators John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	179 url_transfer (const url_transfer&) = default;
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 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& operator = (const url_transfer&) = default;
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	182
24254 4bca68f0d8d5 use shared_ptr to manage url_transfer object John W. Eaton <jwe@octave.org> parents: 23696 diff changeset	183 ~url_transfer (void) = default;
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	184
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	185 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	186
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	187 bool good (void) const { return rep->good (); }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	188
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	189 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	190
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	191 std::ostream& set_ostream (std::ostream& os)
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	192 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	193 return rep->set_ostream (os);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	194 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	195
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	196 std::istream& set_istream (std::istream& is)
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	197 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	198 return rep->set_istream (is);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	199 }
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 ascii (void) { rep->ascii (); }
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	202
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	203 void binary (void) { rep->binary (); }
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	204
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	205 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	206
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	207 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	208
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	209 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	210
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	211 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	212
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	213 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	214
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	215 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	216
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	217 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	218 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	219 rep->rename (oldname, newname);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	220 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	221
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	222 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	223 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	224 rep->put (file, is);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	225 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	226
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	227 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	228 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	229 rep->get (file, os);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	230 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	231
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	232 void mget_directory (const std::string& directory,
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	233 const std::string& target)
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	234 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	235 rep->mget_directory (directory, target);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	236 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	237
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	238 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	239 const std::string& directory)
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	240 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	241 return rep->mput_directory (base, directory);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	242 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	243
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	244 void dir (void) { rep->dir (); }
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	245
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	246 string_vector list (void) { return rep->list (); }
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 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	249 time_t& filetime, bool& fileisdir)
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	250 {
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	251 rep->get_fileinfo (filename, filesize, filetime, fileisdir);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	252 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	253
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	254 std::string pwd (void) { return rep->pwd (); }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	255
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	256 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	257
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	258 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	259
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	260 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	261 const std::string& action)
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 rep->http_action (param, action);
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	264 }
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	265
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	266 private:
17596 43b9181340fb separate object creation from http actions in url_transfer class John W. Eaton <jwe@octave.org> parents: 17557 diff changeset	267
24254 4bca68f0d8d5 use shared_ptr to manage url_transfer object John W. Eaton <jwe@octave.org> parents: 23696 diff changeset	268 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	269 };
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	270 }
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	271
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	272 #if defined (OCTAVE_USE_DEPRECATED_FUNCTIONS)
17596 43b9181340fb separate object creation from http actions in url_transfer class John W. Eaton <jwe@octave.org> parents: 17557 diff changeset	273
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	274 OCTAVE_DEPRECATED (4.2, "use 'octave::base_url_transfer' instead")
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	275 typedef octave::base_url_transfer base_url_transfer;
17596 43b9181340fb separate object creation from http actions in url_transfer class John W. Eaton <jwe@octave.org> parents: 17557 diff changeset	276
23615 be7b884ac589 use version number in OCTAVE_DEPRECATED macro John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	277 OCTAVE_DEPRECATED (4.2, "use 'octave::url_transfer' instead")
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	278 typedef octave::url_transfer url_transfer;
17555 0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	279
0946b0e06544 move url_transfer classes to liboctave John W. Eaton <jwe@octave.org> parents: diff changeset	280 #endif
21744 e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	281
e1be0b36fbed use namespace for url_transfer class John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	282 #endif

Mercurial > octave

annotate liboctave/util/url-transfer.h @ 24991:831389905438 stable