Mercurial > octave-nkf
annotate src/DLD-FUNCTIONS/urlwrite.cc @ 9064:7c02ec148a3c
Check grammar on all .cc files
Same check as previously done on .m files
Attempt to enforce some conformity in documentation text for rules
such as two spaces after a period, commas around latin abbreviations, etc.
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Sat, 28 Mar 2009 13:57:22 -0700 |
| parents | eb63fbe60fab |
| children | 7f77e5081e83 |
| rev | line source |
|---|---|
| 6043 | 1 // urlwrite and urlread, a curl front-end for octave |
| 2 /* | |
| 3 | |
| 8920 | 4 Copyright (C) 2006, 2007, 2008 Alexander Barth |
| 6043 | 5 |
| 6 This file is part of Octave. | |
| 7 | |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 6043 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 6043 | 21 |
| 22 */ | |
| 23 | |
| 24 // Author: Alexander Barth <abarth@marine.usf.edu> | |
| 25 // Adapted-By: jwe | |
| 26 | |
| 27 #ifdef HAVE_CONFIG_H | |
| 28 #include <config.h> | |
| 29 #endif | |
| 30 | |
| 31 #include <string> | |
| 32 #include <fstream> | |
| 33 #include <iomanip> | |
| 34 | |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
35 #include "file-ops.h" |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
36 #include "file-stat.h" |
| 6043 | 37 #include "oct-env.h" |
| 38 | |
| 39 #include "defun-dld.h" | |
| 40 #include "error.h" | |
| 41 #include "oct-obj.h" | |
| 42 #include "ov-cell.h" | |
| 43 #include "pager.h" | |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
44 #include "unwind-prot.h" |
| 6043 | 45 |
| 46 #if defined (HAVE_CURL) | |
| 47 | |
| 48 #include <curl/curl.h> | |
| 49 #include <curl/types.h> | |
| 50 #include <curl/easy.h> | |
| 51 | |
| 52 // Write callback function for curl. | |
| 53 | |
| 6986 | 54 static int |
| 6043 | 55 write_data (void *buffer, size_t size, size_t nmemb, void *streamp) |
| 56 { | |
| 57 // *stream is actually an ostream object. | |
| 58 std::ostream& stream = *(static_cast<std::ostream*> (streamp)); | |
| 59 stream.write (static_cast<const char*> (buffer), size*nmemb); | |
| 60 return (stream.fail () ? 0 : size * nmemb); | |
| 61 } | |
| 62 | |
| 63 // Form the query string based on param. | |
| 64 | |
| 6986 | 65 static std::string |
| 6043 | 66 form_query_string (CURL *curl, const Cell& param) |
| 67 { | |
| 68 std::ostringstream query; | |
| 69 | |
| 70 for (int i = 0; i < param.numel (); i += 2) | |
| 71 { | |
| 72 std::string name = param(i).string_value (); | |
| 73 std::string text = param(i+1).string_value (); | |
| 74 | |
| 75 // Encode strings. | |
| 76 char *enc_name = curl_easy_escape (curl, name.c_str (), name.length ()); | |
| 77 char *enc_text = curl_easy_escape (curl, text.c_str (), text.length ()); | |
| 78 | |
| 79 query << enc_name << "=" << enc_text; | |
| 80 | |
| 81 curl_free (enc_name); | |
| 82 curl_free (enc_text); | |
| 83 | |
| 84 if (i < param.numel()-1) | |
| 85 query << "&"; | |
| 86 } | |
| 87 | |
| 88 query.flush (); | |
| 89 | |
| 90 return query.str (); | |
| 91 } | |
| 92 | |
| 93 // curl front-end | |
| 94 | |
| 6992 | 95 static void |
| 96 urlget_cleanup (CURL *curl) | |
| 97 { | |
| 98 curl_easy_cleanup (curl); | |
| 99 curl_global_cleanup (); | |
| 100 } | |
| 101 | |
| 6986 | 102 static CURLcode |
| 6043 | 103 urlget (const std::string& url, const std::string& method, |
| 104 const Cell& param, std::ostream& stream) | |
| 105 { | |
| 106 CURL *curl; | |
| 107 | |
| 108 curl_global_init(CURL_GLOBAL_DEFAULT); | |
| 109 | |
| 110 curl = curl_easy_init(); | |
| 111 | |
| 112 if (! curl) | |
| 113 return CURLE_FAILED_INIT; | |
| 114 | |
| 115 // handle paramters of GET or POST request | |
| 116 | |
| 117 std::string query_string = form_query_string (curl,param); | |
| 118 //octave_stdout << "query_string " << query_string << std::endl; | |
| 119 | |
| 120 if (method == "get") | |
| 121 { | |
| 122 query_string = url + "?" + query_string; | |
| 123 curl_easy_setopt (curl, CURLOPT_URL, query_string.c_str ()); | |
| 124 } | |
| 125 else if (method == "post") | |
| 126 { | |
| 127 curl_easy_setopt (curl, CURLOPT_URL, url.c_str ()); | |
| 128 curl_easy_setopt (curl, CURLOPT_POSTFIELDS, query_string.c_str ()); | |
| 129 } | |
| 130 else | |
| 7013 | 131 curl_easy_setopt (curl, CURLOPT_URL, url.c_str()); |
| 6043 | 132 |
| 133 // Define our callback to get called when there's data to be written. | |
| 134 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, write_data); | |
| 135 | |
| 136 // Set a pointer to our struct to pass to the callback. | |
| 137 curl_easy_setopt (curl, CURLOPT_WRITEDATA, static_cast<void*> (&stream)); | |
| 138 | |
| 6390 | 139 // Follow redirects. |
| 7013 | 140 curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, true); |
| 141 | |
| 142 // Don't use EPSV since connecting to sites that don't support it | |
| 143 // will hang for some time (3 minutes?) before moving on to try PASV | |
| 144 // instead. | |
| 145 curl_easy_setopt (curl, CURLOPT_FTP_USE_EPSV, false); | |
| 6390 | 146 |
| 6992 | 147 curl_easy_setopt (curl, CURLOPT_NOPROGRESS, true); |
| 6043 | 148 curl_easy_setopt (curl, CURLOPT_PROGRESSDATA, url.c_str ()); |
| 149 curl_easy_setopt (curl, CURLOPT_FAILONERROR, true); | |
| 150 | |
| 7013 | 151 // Switch on full protocol/debug output. |
| 152 // curl_easy_setopt (curl, CURLOPT_VERBOSE, true); | |
| 6043 | 153 |
| 6992 | 154 CURLcode res = CURLE_OK; |
| 155 | |
| 156 // To understand the following, see the definitions of these macros | |
| 157 // in libcruft/misc/quit.h. The idea is that we call sigsetjmp here | |
| 158 // then the signal handler calls siglongjmp to get back here | |
| 159 // immediately. Then we perform some cleanup and throw an interrupt | |
| 160 // exception which will get us back to the top level, cleaning up | |
| 161 // any local C++ objects on the stack as we go. | |
| 162 | |
| 163 BEGIN_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE_1; | |
| 164 | |
| 165 // We were interrupted (this code is inside a block that is only | |
| 166 // called when siglongjmp is called from a signal handler). | |
| 6043 | 167 |
| 6992 | 168 // Is there a better error code to use? Maybe it doesn't matter |
| 169 // because we are about to throw an execption. | |
| 170 | |
| 171 res = CURLE_ABORTED_BY_CALLBACK; | |
| 172 urlget_cleanup (curl); | |
|
7481
78f3811155f7
use exceptions in liboctave error handler
John W. Eaton <jwe@octave.org>
parents:
7031
diff
changeset
|
173 octave_rethrow_exception (); |
| 6992 | 174 |
| 175 BEGIN_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE_2; | |
| 6043 | 176 |
| 6992 | 177 res = curl_easy_perform (curl); |
| 178 | |
| 179 END_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE; | |
| 180 | |
| 181 // If we are not interuppted, we will end up here, so we still need | |
| 182 // to clean up. | |
| 183 | |
| 184 urlget_cleanup (curl); | |
| 6043 | 185 |
| 186 return res; | |
| 187 } | |
| 188 | |
| 189 #endif | |
| 190 | |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
191 static bool urlwrite_delete_file; |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
192 |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
193 static std::string urlwrite_filename; |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
194 |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
195 static void |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
196 urlwrite_cleanup_file (void *) |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
197 { |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
198 if (urlwrite_delete_file) |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
199 file_ops::unlink (urlwrite_filename); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
200 } |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
201 |
| 6043 | 202 DEFUN_DLD (urlwrite, args, nargout, |
| 203 "-*- texinfo -*-\n\ | |
| 204 @deftypefn {Loadable Function} {} urlwrite (@var{URL}, @var{localfile})\n\ | |
| 205 @deftypefnx {Loadable Function} {@var{f} =} urlwrite (@var{url}, @var{localfile})\n\ | |
| 206 @deftypefnx {Loadable Function} {[@var{f}, @var{success}] =} urlwrite (@var{url}, @var{localfile})\n\ | |
| 207 @deftypefnx {Loadable Function} {[@var{f}, @var{success}, @var{message}] =} urlwrite (@var{url}, @var{localfile})\n\ | |
| 208 Download a remote file specified by its @var{URL} and save it as\n\ | |
| 209 @var{localfile}. For example,\n\ | |
| 210 \n\ | |
| 211 @example\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
212 @group\n\ |
| 7031 | 213 urlwrite (\"ftp://ftp.octave.org/pub/octave/README\", \n\ |
| 214 \"README.txt\");\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
215 @end group\n\ |
| 6043 | 216 @end example\n\ |
| 217 \n\ | |
| 218 The full path of the downloaded file is returned in @var{f}. The\n\ | |
| 219 variable @var{success} is 1 if the download was successful,\n\ | |
| 220 otherwise it is 0 in which case @var{message} contains an error\n\ | |
| 221 message. If no output argument is specified and if an error occurs,\n\ | |
| 6588 | 222 then the error is signaled through Octave's error handling mechanism.\n\ |
| 6043 | 223 \n\ |
| 224 This function uses libcurl. Curl supports, among others, the HTTP,\n\ | |
| 225 FTP and FILE protocols. Username and password may be specified in\n\ | |
| 226 the URL, for example:\n\ | |
| 227 \n\ | |
| 228 @example\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
229 @group\n\ |
| 6588 | 230 urlwrite (\"http://username:password@@example.com/file.txt\",\n\ |
| 231 \"file.txt\");\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
232 @end group\n\ |
| 6043 | 233 @end example\n\ |
| 234 \n\ | |
| 235 GET and POST requests can be specified by @var{method} and @var{param}.\n\ | |
| 6589 | 236 The parameter @var{method} is either @samp{get} or @samp{post}\n\ |
| 6588 | 237 and @var{param} is a cell array of parameter and value pairs.\n\ |
| 238 For example:\n\ | |
| 6043 | 239 \n\ |
| 240 @example\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
241 @group\n\ |
| 6588 | 242 urlwrite (\"http://www.google.com/search\", \"search.html\",\n\ |
| 243 \"get\", @{\"query\", \"octave\"@});\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
244 @end group\n\ |
| 6043 | 245 @end example\n\ |
| 246 @seealso{urlread}\n\ | |
| 247 @end deftypefn") | |
| 248 { | |
| 249 octave_value_list retval; | |
| 250 | |
| 251 #if defined (HAVE_CURL) | |
| 252 | |
| 253 int nargin = args.length (); | |
| 254 | |
| 255 // verify arguments | |
| 256 if (nargin != 2 && nargin != 4) | |
| 257 { | |
| 258 print_usage (); | |
| 259 return retval; | |
| 260 } | |
| 261 | |
| 262 std::string url = args(0).string_value(); | |
| 263 | |
| 264 if (error_state) | |
| 265 { | |
| 266 error ("urlwrite: url must be a character string"); | |
| 267 return retval; | |
| 268 } | |
| 269 | |
| 270 // name to store the file if download is succesful | |
| 271 std::string filename = args(1).string_value(); | |
| 272 | |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
273 urlwrite_filename = filename; |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
274 |
| 6043 | 275 if (error_state) |
| 276 { | |
| 277 error ("urlwrite: localfile must be a character string"); | |
| 278 return retval; | |
| 279 } | |
| 280 | |
| 281 std::string method; | |
| 282 Cell param; // empty cell array | |
| 283 | |
| 284 if (nargin == 4) | |
| 285 { | |
| 286 method = args(2).string_value(); | |
| 287 | |
| 288 if (error_state) | |
| 289 { | |
| 290 error ("urlwrite: method can only be \"get\" or \"post\""); | |
| 291 return retval; | |
| 292 } | |
| 293 | |
| 294 if (method != "get" && method != "post") | |
| 295 { | |
| 296 error ("urlwrite: method can only be \"get\" or \"post\""); | |
| 297 return retval; | |
| 298 } | |
| 299 | |
| 300 param = args(3).cell_value(); | |
| 301 | |
| 302 if (error_state) | |
| 303 { | |
| 304 error ("urlwrite: parameters for get and post requests must be given as a cell"); | |
| 305 return retval; | |
| 306 } | |
| 307 | |
| 308 | |
| 309 if (param.numel () % 2 == 1 ) | |
| 310 { | |
| 311 error ("urlwrite: number of elements in param must be even"); | |
| 312 return retval; | |
| 313 } | |
| 314 } | |
| 315 | |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
316 // The file should only be deleted if it doesn't initially exist, we |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
317 // create it, and the download fails. We use unwind_protect to do |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
318 // it so that the deletion happens no matter how we exit the function. |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
319 |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
320 file_stat fs (filename); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
321 |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
322 urlwrite_delete_file = ! fs.exists (); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
323 |
| 6986 | 324 std::ofstream ofile (filename.c_str(), std::ios::out | std::ios::binary); |
| 6043 | 325 |
| 6986 | 326 if (! ofile.is_open ()) |
| 6043 | 327 { |
| 328 error ("urlwrite: unable to open file"); | |
| 329 return retval; | |
| 330 } | |
| 331 | |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
332 unwind_protect::add (urlwrite_cleanup_file); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
333 |
| 6986 | 334 CURLcode res = urlget (url, method, param, ofile); |
| 6043 | 335 |
| 6986 | 336 ofile.close (); |
| 6043 | 337 |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
338 urlwrite_delete_file = (res != CURLE_OK); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
339 |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
340 unwind_protect::run (); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
341 |
| 6043 | 342 if (nargout > 0) |
| 343 { | |
|
8151
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
344 if (res == CURLE_OK) |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
345 { |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
346 retval(2) = std::string (); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
347 retval(1) = true; |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
348 retval(0) = octave_env::make_absolute (filename, octave_env::getcwd ()); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
349 } |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
350 else |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
351 { |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
352 retval(2) = std::string (curl_easy_strerror (res)); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
353 retval(1) = false; |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
354 retval(0) = std::string (); |
|
3725f819b5b3
urlwrite.cc (Furlwrite): delete files we create if download fails
John W. Eaton <jwe@octave.org>
parents:
7481
diff
changeset
|
355 } |
| 6043 | 356 } |
| 357 | |
| 6484 | 358 if (nargout < 2 && res != CURLE_OK) |
| 6043 | 359 error ("urlwrite: curl: %s", curl_easy_strerror (res)); |
| 360 | |
| 361 #else | |
| 6981 | 362 error ("urlwrite: not available in this version of Octave"); |
| 6043 | 363 #endif |
| 364 | |
| 365 return retval; | |
| 366 } | |
| 367 | |
| 368 DEFUN_DLD (urlread, args, nargout, | |
| 369 "-*- texinfo -*-\n\ | |
| 6549 | 370 @deftypefn {Loadable Function} {@var{s} =} urlread (@var{url})\n\ |
| 6043 | 371 @deftypefnx {Loadable Function} {[@var{s}, @var{success}] =} urlread (@var{url})\n\ |
| 6549 | 372 @deftypefnx {Loadable Function} {[@var{s}, @var{success}, @var{message}] =} urlread (@var{url})\n\ |
| 6547 | 373 @deftypefnx {Loadable Function} {[@dots{}] =} urlread (@var{url}, @var{method}, @var{param})\n\ |
| 6043 | 374 Download a remote file specified by its @var{URL} and return its content\n\ |
| 375 in string @var{s}. For example,\n\ | |
| 376 \n\ | |
| 377 @example\n\ | |
| 6588 | 378 s = urlread (\"ftp://ftp.octave.org/pub/octave/README\");\n\ |
| 6043 | 379 @end example\n\ |
| 380 \n\ | |
| 381 The variable @var{success} is 1 if the download was successful,\n\ | |
| 382 otherwise it is 0 in which case @var{message} contains an error\n\ | |
| 383 message. If no output argument is specified and if an error occurs,\n\ | |
| 6588 | 384 then the error is signaled through Octave's error handling mechanism.\n\ |
| 6043 | 385 \n\ |
| 386 This function uses libcurl. Curl supports, among others, the HTTP,\n\ | |
| 387 FTP and FILE protocols. Username and password may be specified in the\n\ | |
| 388 URL. For example,\n\ | |
| 389 \n\ | |
| 390 @example\n\ | |
| 7031 | 391 s = urlread (\"http://user:password@@example.com/file.txt\");\n\ |
| 6043 | 392 @end example\n\ |
| 393 \n\ | |
| 394 GET and POST requests can be specified by @var{method} and @var{param}.\n\ | |
| 6588 | 395 The parameter @var{method} is either @samp{get} or @samp{post}\n\ |
| 396 and @var{param} is a cell array of parameter and value pairs.\n\ | |
| 6650 | 397 For example,\n\ |
| 6043 | 398 \n\ |
| 399 @example\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
400 @group\n\ |
| 6588 | 401 s = urlread (\"http://www.google.com/search\", \"get\",\n\ |
| 402 @{\"query\", \"octave\"@});\n\ | |
|
9064
7c02ec148a3c
Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
403 @end group\n\ |
| 6043 | 404 @end example\n\ |
| 405 @seealso{urlwrite}\n\ | |
| 406 @end deftypefn") | |
| 407 { | |
| 6588 | 408 // Octave's return value |
| 6043 | 409 octave_value_list retval; |
| 410 | |
| 411 #if defined (HAVE_CURL) | |
| 412 | |
| 413 int nargin = args.length (); | |
| 414 | |
| 415 // verify arguments | |
| 416 if (nargin != 1 && nargin != 3) | |
| 417 { | |
| 418 print_usage (); | |
| 419 return retval; | |
| 420 } | |
| 421 | |
| 422 std::string url = args(0).string_value(); | |
| 423 | |
| 424 if (error_state) | |
| 425 { | |
| 426 error ("urlread: url must be a character string"); | |
| 427 return retval; | |
| 428 } | |
| 429 | |
| 430 std::string method; | |
| 431 Cell param; // empty cell array | |
| 432 | |
| 433 if (nargin == 3) | |
| 434 { | |
| 435 method = args(1).string_value(); | |
| 436 | |
| 437 if (error_state) | |
| 438 { | |
| 439 error ("urlread: method can only be \"get\" or \"post\""); | |
| 440 return retval; | |
| 441 } | |
| 442 | |
| 443 if (method != "get" && method != "post") | |
| 444 { | |
| 445 error ("urlread: method can only be \"get\" or \"post\""); | |
| 446 return retval; | |
| 447 } | |
| 448 | |
| 449 param = args(2).cell_value(); | |
| 450 | |
| 451 if (error_state) | |
| 452 { | |
| 453 error ("urlread: parameters for get and post requests must be given as a cell"); | |
| 454 return retval; | |
| 455 } | |
| 456 | |
| 457 if (param.numel () % 2 == 1 ) | |
| 458 { | |
| 459 error ("urlread: number of elements in param must be even"); | |
| 460 return retval; | |
| 461 } | |
| 462 } | |
| 463 | |
| 6986 | 464 std::ostringstream buf; |
| 6043 | 465 |
| 6986 | 466 CURLcode res = urlget (url, method, param, buf); |
| 6043 | 467 |
| 468 if (nargout > 0) | |
| 469 { | |
| 6986 | 470 retval(0) = buf.str (); |
| 6043 | 471 retval(1) = res == CURLE_OK; |
| 6986 | 472 // Return empty string if no error occured. |
| 6043 | 473 retval(2) = std::string (res == CURLE_OK ? "" : curl_easy_strerror (res)); |
| 474 } | |
| 475 | |
| 6484 | 476 if (nargout < 2 && res != CURLE_OK) |
| 6043 | 477 error ("urlread: curl: %s", curl_easy_strerror (res)); |
| 478 | |
| 479 #else | |
| 6981 | 480 error ("urlread: not available in this version of Octave"); |
| 6043 | 481 #endif |
| 482 | |
| 483 return retval; | |
| 484 } |