4d-plugin-curl-ftp

HTTP client based on libcurl-7.62.0

List of 4D Internet Commands and replacements

FTP_Append : n/a (use APPEND option)
FTP_ChangeDir : n/a (sessions are not kept open)
FTP_Delete : cURL_FTP_Delete
FTP_GetDirList : cURL_FTP_GetDirList
FTP_GetFileInfo : cURL_FTP_GetFileInfo
FTP_GetPassive : n/a (use FTPPORT option)
FTP_GetType : n/a (always binary transfer)
FTP_Login : n/a (sessions are not kept open)
FTP_Logout : n/a (sessions are not kept open)
FTP_MacBinary : n/a (deprecated)
FTP_MakeDir : cURL_FTP_MakeDir
FTP_PrintDir : cURL_FTP_PrintDir
FTP_Receive : cURL_FTP_Receive
FTP_RemoveDir : cURL_FTP_RemoveDir
FTP_Rename : cURL_FTP_Rename
FTP_Send : cURL_FTP_Send
FTP_SetPassive : n/a (use FTPPORT option)
FTP_SetType : n/a (always binary transfer)
FTP_System: cURL_FTP_System
FTP_VerifyID : n/a (sessions are not kept open)
FTP_Progress : n/a (use PRIVATE option)

Points of interest

Missing directories can be created with _MakeDir and _Send
_Receive supports wildcards
reduced CPU consumption
callback method to monitor progress or abort if necessary

although the API is optimsied for FTP, _Send and _Receive actually work with other protocols such as HTTP or TFTP.

Encoding support

For servers that do not support OPTS UTF8 ON the plugin can convert non-unicode text. Any iconv charset can be specified.

C_OBJECT($options)

$URL:="ftp:https://ftp.server.com/"

OB SET($options;\
"URL";$URL;\
"ENCODING_OUT";"cp932";\
"USERNAME";"user";\
"PASSWORD";"pass")

C_TEXT($list)

$error:=cURL_FTP_PrintDir (JSON Stringify($options);$list)

Commands that support ENCODING_IN (outgoing text)

cURL_FTP_Delete
cURL_FTP_MakeDir
cURL_FTP_RemoveDir
cURL_FTP_Rename

Commands that support ENCODING_OUT (incoming text)

cURL_FTP_System
cURL_FTP_PrintDir
cURL_FTP_GetDirList

Note on FTPS

set the protocol to ftps:https:// if you want to use implicit FTPS

set the protocol to ftp:https:// and add the option USE_SSL if you want to use explicit FTPS

use the option CAINFO for server ceritificate verification

to skip verification, set SSL_VERIFYPEER to 0

see also forums.4d.com for dicussion on SFTP.

Syntax

error:=cURL_FTP_Delete(options{;callbackMethod})

Parameter	Type	Description
options	TEXT	`JSON`
callbackMethod	TEXT	optional
error	LONGINT	Error code

calls DELE or rm (sftp:)

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://ftp.example.com/a/b/sample.txt";\
"USERNAME";"user";\
"PASSWORD";"pass")

$error:=cURL_FTP_Delete (JSON Stringify($options))

error:=cURL_FTP_GetDirList(options;list{;callbackMethod})

Parameter	Type	Description
options	TEXT	`JSON`
list	TEXT
callbackMethod	TEXT	optional
error	LONGINT	Error code

calls LIST via CURLOPT_CUSTOMREQUEST

the url must end with a delimiter (/)

C_OBJECT($options)

OB SET($options;"URL";"ftp:https://ftp.4d.com/SAMPLE_DATABASES/4D/4D_v13/demo_dbs/")

$error:=cURL_FTP_GetDirList (JSON Stringify($options);$list)

-r--r--r-- 1 ftp ftp        2845148 Jul 17  2015 4DHierarchicalLists.zip
-r--r--r-- 1 ftp ftp       72547498 Jul 17  2015 4DIndexes.zip
-r--r--r-- 1 ftp ftp        5575780 Jul 17  2015 4DListboxes.zip
-r--r--r-- 1 ftp ftp        4269584 Jul 17  2015 4DObjects.zip
-r--r--r-- 1 ftp ftp       98552632 Jul 17  2015 4DPictures.zip
-r--r--r-- 1 ftp ftp        8482751 Jul 17  2015 4DSQL.zip
-r--r--r-- 1 ftp ftp        5429818 Jul 17  2015 4DStaticWebBuilder.zip

example of splitting elements

$error:=cURL_FTP_GetDirList (JSON Stringify($options);$dir)

If ($error=0)
  ARRAY LONGINT($pos;0)
  ARRAY LONGINT($len;0)
  $i:=1

  While (Match regex("(?m)^(\\S+)\\s+(\\d+)\\s+(\\S+)\\s+(\\S+)\\s+(\\d+)\\s+([:L:]{3}\\s+\\d+)\\s+(\\d+:\\d+)\\s+(.+)$";$dir;$i;$pos;$len))
    $f1:=Substring($dir;$pos{1};$len{1})
    $f2:=Num(Substring($dir;$pos{2};$len{2}))
    $f3:=Substring($dir;$pos{3};$len{3})
    $f4:=Substring($dir;$pos{4};$len{4})
    $f5:=Num(Substring($dir;$pos{5};$len{5}))
    $f6:=Substring($dir;$pos{6};$len{6})
    $f7:=Time(Substring($dir;$pos{7};$len{7}))
    $f8:=Substring($dir;$pos{8};$len{8})
    $i:=$pos{Size of array($pos)}+$len{Size of array($len)}
  End while 

End if

error:=cURL_FTP_GetFileInfo(options;info{;callbackMethod})

Parameter	Type	Description
options	TEXT	`JSON`
info	TEXT
callbackMethod	TEXT	optional
error	LONGINT	Error code

uses curl_easy_getinfo with CURLOPT_FILETIME and CURLINFO_FILETIME

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://test.rebex.net/readme.txt";\
"USERNAME";"demo";\
"PASSWORD";"password")

$error:=cURL_FTP_GetFileInfo (JSON Stringify($options);$info)

{"size":"403","date":"2014-04-08T14:09:39Z"}

error:=cURL_FTP_MakeDir(options{;createMissingDir{;callbackMethod}})

Parameter	Type	Description
options	TEXT	`JSON`
createMissingDir	LONGINT
callbackMethod	TEXT	optional
error	LONGINT	Error code

calls MKD or mkdir (sftp:)

CURLOPT_FTP_CREATE_MISSING_DIRS is CURLFTP_CREATE_DIR_RETRY if createMissingDir is 1

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://ftp.example.com/a/b/c";\
"USERNAME";"user";\
"PASSWORD";"pass")

$createMissingDir:=1

$error:=cURL_FTP_MakeDir (JSON Stringify($options);$createMissingDir)

error:=cURL_FTP_PrintDir(options;dir{;callbackMethod})

Parameter	Type	Description
options	TEXT	`JSON`
dir	TEXT
callbackMethod	TEXT	optional
error	LONGINT	Error code

calls NLST via CURLOPT_DIRLISTONLY

the url must end with a delimiter (/)

C_OBJECT($options)

OB SET($options;"URL";"ftp:https://ftp.4d.com/SAMPLE_DATABASES/4D/4D_v13/demo_dbs/")

$error:=cURL_FTP_PrintDir (JSON Stringify($options);$list)

4DHierarchicalLists.zip
4DIndexes.zip
4DListboxes.zip
4DObjects.zip
4DPictures.zip
4DSQL.zip
4DStaticWebBuilder.zip

error:=cURL_FTP_Receive(options;path{;wildcardMatch{;callbackMethod}})

Parameter	Type	Description
options	TEXT	`JSON`
path	TEXT	local system path (folder or file)
wildcardMatch	LONGINT	optional
callbackMethod	TEXT	optional
error	LONGINT	Error code

CURLOPT_WILDCARDMATCH is used if wildcardMatch is 1

specify a folder in path when using wildcardMatch

otherwise, specify a file

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://ftp.4d.com/SAMPLE_DATABASES/4D/4D_v13/demo_dbs/*.zip")

$path:=System folder(Desktop)+"sample_ftp"+Folder separator

$error:=cURL_FTP_Receive (JSON Stringify($options);$path;1)

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://ftp.4d.com/SAMPLE_DATABASES/4D/4D_v13/demo_dbs/4DIndexes.zip")

$path:=System folder(Desktop)+"sample_ftp"+Folder separator+"sample.zip"

$error:=cURL_FTP_Receive (JSON Stringify($options);$path;0)

error:=cURL_FTP_RemoveDir(options{;callbackMethod}})

Parameter	Type	Description
options	TEXT	`JSON`
callbackMethod	TEXT	optional
error	LONGINT	Error code

calls RMD or rmdir (sftp:)

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://ftp.example.com/a/b/c";\
"USERNAME";"user";\
"PASSWORD";"pass")

$error:=cURL_FTP_RemoveDir (JSON Stringify($options))

error:=cURL_FTP_Rename(options;name{;callbackMethod})

Parameter	Type	Description
options	TEXT	`JSON`
name	TEXT
callbackMethod	TEXT	optional
error	LONGINT	Error code

calls RNFR followed by RNTO or rename (sftp:)

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://ftp.example.com/a/b/c";\
"USERNAME";"user";\
"PASSWORD";"pass")

$name:="/a/b/c/d" 

$error:=cURL_FTP_Rename (JSON Stringify($options);$name)

error:=cURL_FTP_Send(options;path{;createMissingDir{;callbackMethod}}})

Parameter	Type	Description
options	TEXT	`JSON`
path	TEXT	local system path
createMissingDir	LONGINT	optional
callbackMethod	TEXT	optional
error	LONGINT	Error code

CURLOPT_FTP_CREATE_MISSING_DIRS is CURLFTP_CREATE_DIR_RETRY if createMissingDir is 1

$path:=System folder(Desktop)+"test.txt"

C_OBJECT($options)

OB SET($options;\
"URL";"ftp:https://ftp.example.com/a/b/c/test.txt";\
"USERNAME";"user";\
"PASSWORD";"pass")

$createMissingDir:=1

$error:=cURL_FTP_Send (JSON Stringify($options);$path;$createMissingDir)

error:=cURL_FTP_System(options;system{;callbackMethod})

Parameter	Type	Description
options	TEXT	`JSON`
system	TEXT
callbackMethod	TEXT	optional
error	LONGINT	Error code

calls SYST

not supported for SFTP because CURLOPT_PREQUOTE is unavailable

C_OBJECT($options)

OB SET($options;"URL";"ftp:https://ftp.4d.com/")

$error:=cURL_FTP_System (JSON Stringify($options);$system)

UNIX emulated by FileZilla

Properties of options

General

URL
USERNAME
PASSWORD
FTPPORT
APPEND
FTP_ACCOUNT
PRIVATE

RFC 2428

FTP_USE_EPRT
FTP_USE_EPSV

Host Specific

FTP_USE_PRET
FTP_ALTERNATIVE_TO_USER
FTP_FILEMETHOD

values: MULTICWD, NOCWD, SINGLECWD

Connection

TCP_KEEPALIVE
TCP_KEEPIDLE
TCP_KEEPINTVL

Threshold

FTP_RESPONSE_TIMEOUT
CONNECTTIMEOUT
TIMEOUT
LOW_SPEED_TIME
LOW_SPEED_LIMIT

Verification

SSL_VERIFYHOST
SSL_VERIFYPEER
CAINFO

Encryption

FTPSSLAUTH

values: AUTH_DEFAULT, AUTH_SSL, AUTH_TLS

FTP_SSL_CCC

values: CCC_NONE, CCC_PASSIVE, CCC_ACTIVE

added in 1.1

USE_SSL

values: USESSL_NONE USESSL_TRY USESSL_CONTROL USESSL_ALL

SSH

SSH_AUTH_TYPES
SSH_COMPRESSION
SSH_HOST_PUBLIC_KEY_MD5
SSH_PUBLIC_KEYFILE
SSH_PRIVATE_KEYFILE
SSH_KNOWNHOSTS

added in 2.8

TLS13_CIPHERS
PROXY_TLS13_CIPHERS
UPKEEP_INTERVAL_MS
HAPROXYPROTOCOL
DISALLOW_USERNAME_IN_URL
DNS_SHUFFLE_ADDRESSES
HAPPY_EYEBALLS_TIMEOUT_MS
UPLOAD_BUFFERSIZE
DOH_URL

Signature of callbackMethod

abort:=method(curlInfo;userInfo)

Parameter	Type	Description
curlInfo	TEXT	`JSON` (`curl_easy_getinfo`)
userInfo	TEXT	the text passed as the `PRIVATE` property of `option`
abort	BOOLEAN

CURLcode is returned in error. when True is returned from the callback method, CURLE_ABORTED_BY_CALLBACK (42) is returned. same if the process has been aborted via the runtime explorer. aborting the debugger will not kill the process immediately.

Name		Name	Last commit message	Last commit date
Latest commit History 237 Commits
ftp		ftp
LICENSE		LICENSE
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

4d-plugin-curl-ftp

List of 4D Internet Commands and replacements

Points of interest

Note on FTPS

Syntax

About

Releases 56

Packages

Languages

License

miyako/4d-plugin-curl-ftp

Folders and files

Latest commit

History

Repository files navigation

4d-plugin-curl-ftp

List of 4D Internet Commands and replacements

Points of interest

Note on FTPS

Syntax

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 56

Packages 0

Languages

Packages