Mercurial > octave
view scripts/web/webread.m @ 28912:0de38a6ef693
maint: Use Octave convention of space after function name in scripts dir.
* cplxpair.m, gradient.m, integral.m, integral3.m, interp2.m, interpft.m,
num2str.m, pol2cart.m, quad2d.m, quadgk.m, quadl.m, repelem.m, sph2cart.m,
convhull.m, delaunay.m, delaunayn.m, movegui.m, print_usage.m,
__strip_html_tags__.m, colormap.m, gray2ind.m, imformats.m, importdata.m,
javachk.m, condest.m, isbanded.m, krylov.m, lscov.m, rref.m, inputParser.m,
publish.m, symvar.m, validateattributes.m, ode15i.m, ode15s.m, ode23.m,
ode23s.m, ode45.m, fminbnd.m, fminsearch.m, glpk.m, qp.m, get_forge_pkg.m,
installed_packages.m, annotation.m, axis.m, camorbit.m, campos.m, camva.m,
camzoom.m, daspect.m, legend.m, pbaspect.m, __gnuplot_legend__.m, light.m,
patch.m, plotyy.m, __pie__.m, reducepatch.m, ribbon.m, streamline.m, trisurf.m,
figure.m, ndgrid.m, __gnuplot_draw_axes__.m, __opengl_print__.m, padecoef.m,
polygcd.m, ppval.m, spline.m, union.m, bicg.m, bicgstab.m, cgs.m, eigs.m,
gmres.m, pcg.m, pcr.m, __alltohandles__.m, __sprand__.m, qmr.m, tfqmr.m,
betaincinv.m, cosint.m, gammainc.m, discrete_cdf.m, discrete_inv.m,
discrete_rnd.m, base2dec.m, strtok.m, compare_plot_demos.m,
html_compare_plot_demos.m, speed.m, test.m, weboptions.m, webread.m, webwrite.m:
Use Octave convention of space after function name and before '(' in scripts
directory.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 13 Oct 2020 18:17:29 -0700 |
parents | 90fea9cc9caa |
children | 7854d5752dd2 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2018-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{response} =} webread (@var{url}) ## @deftypefnx {} {@var{response} =} webread (@var{url}, @var{name1}, @var{value1}, @dots{}) ## @deftypefnx {} {@var{response} =} webread (@dots{}, @var{options}) ## ## Read content from RESTful web service. ## ## Read content from the web service specified by @var{url} and return the ## content in @var{response}. ## ## All key-value pairs given (@var{name1}, @var{value1}, @dots{}) are appended ## as query parameters to @var{url}. To place a query in the body of the ## message, use @code{webwrite}. The web service defines the acceptable query ## parameters. ## ## @var{options} is a @code{weboptions} object that may be used to add other ## HTTP request options. This argument can be used with either calling form. ## See @code{help weboptions} for a complete list of supported HTTP options. ## ## @seealso{weboptions, webwrite} ## @end deftypefn function response = webread (url, varargin) if (nargin == 0) print_usage (); endif if (! (ischar (url) && isrow (url))) error ("webread: URL must be a string"); endif if (nargin > 1 && isa (varargin{end}, "weboptions")) has_weboptions = true; options = varargin{end}; varargin(end) = []; else has_weboptions = false; options = weboptions (); endif if (strcmp (options.MediaType, "auto")) options.MediaType = "application/x-www-form-urlencoded"; endif ## If MediaType is set by the user, append it to other headers. if (! strcmp (options.CharacterEncoding, "auto")) options.HeaderFields{end+1,1} = "Content-Type"; options.HeaderFields{end,2} = [options.MediaType, ... "; charset=", options.CharacterEncoding]; endif if (! isempty (options.KeyName)) options.HeaderFields{end+1,1} = options.KeyName; options.HeaderFields{end,2} = options.KeyValue; endif if (strcmp (options.RequestMethod, "auto")) options.RequestMethod = "get"; endif ## Flatten the cell array because the internal processing takes place on ## a flattened array. options.HeaderFields = options.HeaderFields(:)'; nargs = 1 + numel (varargin); if (nargs == 1) response = __restful_service__ (url, cell (), options); elseif (rem (nargs, 2) == 1) if (! iscellstr (varargin)) error ("webwrite: KEYS and VALUES must be strings"); else response = __restful_service__ (url, varargin, options); endif else error ("webread: KEYS/VALUES must occur in pairs"); endif endfunction ## Test input validation %!error <Invalid call> webread () %!error <URL must be a string> webread (1) %!error <URL must be a string> webread (["a";"b"]) %!error <KEYS and VALUES must be strings> webread ("URL", "NAME1", 5) %!error <KEYS/VALUES must occur in pairs> webread ("URL", "KEY1")