Changeset 142 for trunk/SRC/ToBeReviewed/LECTURE/read_ftp.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/LECTURE/read_ftp.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/LECTURE/read_ftp.pro

@@ +1 @@
+
+pro ftp_post, u, cmd, res, out=out, count=count
+  compile_opt idl2
+  if (cmd ne '') then begin
+    printf, u, cmd, format='(a)'
+;
+; comment out the following line to disable debug info
+    print, '>'+cmd
+  endif
+  if (size(out,/type) eq 0) then out='2?? *'
+  catch, err
+  if (err ne 0) then return
+  line=''
+  count=0
+  while arg_present(res) do begin
+    readf, u, line
+    if count eq 0 then res=line else res=[res,line]
+    count=count+1
+;
+; comment out the following line to disable debug info
+    print, '<'+line
+    if strmatch(line,out) then break
+  endwhile
+end
+
+pro ftp_parse_pasv, text, host, port
+  t=strtrim(text,2)
+  ind=where(strcmp(t,'227',3))
+  i=ind[0]
+  if (i ne -1) then begin
+    sub=stregex(t[i],'\([0-9,]*\)',/extract)
+    p=strsplit(strmid(sub,1,strlen(sub)-2),',',/extract)
+    p=strtrim(p,2)
+    host=p[0]+'.'+p[1]+'.'+p[2]+'.'+p[3]
+    port=256*long(p[4])+long(p[5])
+  endif
+end
 ;+
-; READ_FTP
 ;
 ; Syntax:
@@ -6 +42 @@
 ;              [,USER=string] [,PASS=string] [,/PTR]
 ;
-; Arguments
-;   remote_host - Name of the remote host (ftp server) that you want
-;                 to connect to, or a complete ftp location such as for example:
-;                      ftp://ftp.rsinc.com/pub/gzip/README.GZIP
+; @param DIR
+; Remote directory where the files reside on the ftp server
 ;
-;   directory - Remote directory where the files reside on the ftp
-;               server
+; @param FILES
+; A single filename or an array of filenames to be retrieved.
 ;
-;   files - A single filename or an array of filenames to be
-;           retrieved.
+; @keyword FILE
+; Set this keyword to make a local copy of the file to be
+; transferred.  The local file will have the same name as the
+; remote file and will be placed in the current working
+; directory.
 ;
-; Keywords
-;   FILE - Set this keyword to make a local copy of the file to be
-;          transferred.  The local file will have the same name as the
-;          remote file and will be placed in the current working
-;          directory.
+; @keyword DATA
+; Set this to a named variable that will contain either a
+; byte array or an array of pointers to byte arrays with the
+; transferred data.  If there is more than one file, an array
+; of pointers is returned, one for each file.
+; Note that when downloading large files using /FILE
+; instead will require much less memory since the entire file
+; is not stored in a variable in that case.
 ;
-;   DATA - Set this to a named variable that will contain either a
-;          byte array or an array of pointers to byte arrays with the
-;          transferred data.  If there is more than one file, an array
-;          of pointers is returned, one for each file.
-;          Note that when downloading large files using /FILE
-;          instead will require much less memory since the entire file
-;          is not stored in a variable in that case.
+; @keyword PTR
+; Set this keyword to return an array of pointers
+; even when there is only one file.
 ;
-;   PTR  - Set this keyword to return an array of pointers
-;          even when there is only one file.
+; @keyword USER
+; Specify user name to connect to server with.  Default is: anonymous.
 ;
-;   USER - Specify user name to connect to server with.  Default is:
-;          anonymous.
+; @keyword PASS
+; Specify password to use when connecting.  Default is: test@test.com.
 ;
-;   PASS - Specify password to use when connecting.  Default is:
-;          test@test.com.
-;
-; Examples of use.
+; @examples
 ; 1) Retrieve and print the contents of ftp://ftp.rsinc.com/pub/gzip/README.GZIP:
 ;   IDL> READ_FTP, 'ftp://ftp.rsinc.com/pub/gzip/README.GZIP', DATA=data
@@ -80 +113 @@
 ;   /COMPRESSED keyword.
 ;
+; @history
+;
+; @version
+; $Id$
+;
+; @todo seb: que fait-on de "syntax" au debut du header?
+; 
 ;-
-pro ftp_post, u, cmd, res, out=out, count=count
-  compile_opt idl2
-  if (cmd ne '') then begin
-    printf, u, cmd, format='(a)'
-;
-; comment out the following line to disable debug info
-    print, '>'+cmd
-  endif
-  if (size(out,/type) eq 0) then out='2?? *'
-  catch, err
-  if (err ne 0) then return
-  line=''
-  count=0
-  while arg_present(res) do begin
-    readf, u, line
-    if count eq 0 then res=line else res=[res,line]
-    count=count+1
-;
-; comment out the following line to disable debug info
-    print, '<'+line
-    if strmatch(line,out) then break
-  endwhile
-end
-
-pro ftp_parse_pasv, text, host, port
-  t=strtrim(text,2)
-  ind=where(strcmp(t,'227',3))
-  i=ind[0]
-  if (i ne -1) then begin
-    sub=stregex(t[i],'\([0-9,]*\)',/extract)
-    p=strsplit(strmid(sub,1,strlen(sub)-2),',',/extract)
-    p=strtrim(p,2)
-    host=p[0]+'.'+p[1]+'.'+p[2]+'.'+p[3]
-    port=256*long(p[4])+long(p[5])
-  endif
-end
-
 pro read_ftp, site, files, dir, port, data=data, file=file, user=user, $
               pass=pass, ptr=ptr