annotate scripts/@ftp/ftp.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents fd0a3ac60b0e
children 7912e682aa30
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
1 ## Copyright (C) 2009-2012 David Bateman
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
3 ## This file is part of Octave.
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
6 ## under the terms of the GNU General Public License as published by
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
8 ## your option) any later version.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
9 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
13 ## General Public License for more details.
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
17 ## <http://www.gnu.org/licenses/>.
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 11469
diff changeset
20 ## @deftypefn {Function File} {@var{f} =} ftp (@var{host})
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 11469
diff changeset
21 ## @deftypefnx {Function File} {@var{f} =} ftp (@var{host}, @var{username}, @var{password})
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## Connect to the FTP server @var{host} with @var{username} and @var{password}.
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## If @var{username} and @var{password} are not specified, user "anonymous"
10711
fbd7843974fa Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents: 9897
diff changeset
24 ## with no password is used. The returned FTP object @var{f} represents the
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## established FTP connection.
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## @end deftypefn
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
27
9897
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
28 function obj = ftp (host, username = "anonymous", password = "")
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
29 if (nargin == 0)
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
30 p.host = "";
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
31 p.username = username;
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
32 p.password = password;
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
33 p.curlhandle = tmpnam ("ftp-");
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
34 obj = class (p, "ftp");
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
35 elseif (nargin == 1 && strcmp (class (host), "ftp"))
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
36 obj = host;
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
37 else
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
38 p.host = host;
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
39 p.username = username;
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
40 p.password = password;
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
41 p.curlhandle = tmpnam ("ftp-");
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
42 __ftp__ (p.curlhandle, host, username, password);
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
43 obj = class (p, "ftp");
4bf50a7d533b fix for FTP object constructor. Allow basic operation with matlab FTP objects
David Bateman <dbateman@free.fr>
parents: 9880
diff changeset
44 endif
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 endfunction