Merge branch 'devel' into bigbreak
Conflicts: lib/pure/ftpclient.nim
This commit is contained in:
commit
361657dea4
5 changed files with 436 additions and 128 deletions
|
|
@ -32,6 +32,7 @@ export Port, SocketFlags
|
||||||
# TODO: The effect system (raises: []) has trouble with my try transformation.
|
# TODO: The effect system (raises: []) has trouble with my try transformation.
|
||||||
# TODO: Can't await in a 'except' body
|
# TODO: Can't await in a 'except' body
|
||||||
# TODO: getCurrentException(Msg) don't work
|
# TODO: getCurrentException(Msg) don't work
|
||||||
|
# TODO: Check if yielded future is nil and throw a more meaningful exception
|
||||||
|
|
||||||
# -- Futures
|
# -- Futures
|
||||||
|
|
||||||
|
|
@ -187,7 +188,7 @@ proc asyncCheck*[T](future: Future[T]) =
|
||||||
proc `and`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] =
|
proc `and`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] =
|
||||||
## Returns a future which will complete once both ``fut1`` and ``fut2``
|
## Returns a future which will complete once both ``fut1`` and ``fut2``
|
||||||
## complete.
|
## complete.
|
||||||
var retFuture = newFuture[void]()
|
var retFuture = newFuture[void]("asyncdispatch.`and`")
|
||||||
fut1.callback =
|
fut1.callback =
|
||||||
proc () =
|
proc () =
|
||||||
if fut2.finished: retFuture.complete()
|
if fut2.finished: retFuture.complete()
|
||||||
|
|
@ -199,11 +200,12 @@ proc `and`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] =
|
||||||
proc `or`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] =
|
proc `or`*[T, Y](fut1: Future[T], fut2: Future[Y]): Future[void] =
|
||||||
## Returns a future which will complete once either ``fut1`` or ``fut2``
|
## Returns a future which will complete once either ``fut1`` or ``fut2``
|
||||||
## complete.
|
## complete.
|
||||||
var retFuture = newFuture[void]()
|
var retFuture = newFuture[void]("asyncdispatch.`or`")
|
||||||
proc cb() =
|
proc cb() =
|
||||||
if not retFuture.finished: retFuture.complete()
|
if not retFuture.finished: retFuture.complete()
|
||||||
fut1.callback = cb
|
fut1.callback = cb
|
||||||
fut2.callback = cb
|
fut2.callback = cb
|
||||||
|
return retFuture
|
||||||
|
|
||||||
type
|
type
|
||||||
PDispatcherBase = ref object of RootRef
|
PDispatcherBase = ref object of RootRef
|
||||||
|
|
@ -1021,10 +1023,10 @@ proc processBody(node, retFutureSym: PNimrodNode,
|
||||||
|
|
||||||
result.add newNimNode(nnkReturnStmt, node).add(newNilLit())
|
result.add newNimNode(nnkReturnStmt, node).add(newNilLit())
|
||||||
return # Don't process the children of this return stmt
|
return # Don't process the children of this return stmt
|
||||||
of nnkCommand:
|
of nnkCommand, nnkCall:
|
||||||
if node[0].kind == nnkIdent and node[0].ident == !"await":
|
if node[0].kind == nnkIdent and node[0].ident == !"await":
|
||||||
case node[1].kind
|
case node[1].kind
|
||||||
of nnkIdent:
|
of nnkIdent, nnkInfix:
|
||||||
# await x
|
# await x
|
||||||
result = newNimNode(nnkYieldStmt, node).add(node[1]) # -> yield x
|
result = newNimNode(nnkYieldStmt, node).add(node[1]) # -> yield x
|
||||||
of nnkCall, nnkCommand:
|
of nnkCall, nnkCommand:
|
||||||
|
|
@ -1034,8 +1036,8 @@ proc processBody(node, retFutureSym: PNimrodNode,
|
||||||
futureValue, node)
|
futureValue, node)
|
||||||
else:
|
else:
|
||||||
error("Invalid node kind in 'await', got: " & $node[1].kind)
|
error("Invalid node kind in 'await', got: " & $node[1].kind)
|
||||||
elif node[1].kind == nnkCommand and node[1][0].kind == nnkIdent and
|
elif node.len > 1 and node[1].kind == nnkCommand and
|
||||||
node[1][0].ident == !"await":
|
node[1][0].kind == nnkIdent and node[1][0].ident == !"await":
|
||||||
# foo await x
|
# foo await x
|
||||||
var newCommand = node
|
var newCommand = node
|
||||||
result.createVar("future" & $node[0].toStrLit, node[1][1], newCommand[1],
|
result.createVar("future" & $node[0].toStrLit, node[1][1], newCommand[1],
|
||||||
|
|
@ -1186,7 +1188,7 @@ macro async*(prc: stmt): stmt {.immediate.} =
|
||||||
result[6] = outerProcBody
|
result[6] = outerProcBody
|
||||||
|
|
||||||
#echo(treeRepr(result))
|
#echo(treeRepr(result))
|
||||||
#if prc[0].getName == "processClient":
|
#if prc[0].getName == "getFile":
|
||||||
# echo(toStrLit(result))
|
# echo(toStrLit(result))
|
||||||
|
|
||||||
proc recvLine*(socket: TAsyncFD): Future[string] {.async.} =
|
proc recvLine*(socket: TAsyncFD): Future[string] {.async.} =
|
||||||
|
|
@ -1228,3 +1230,11 @@ proc runForever*() =
|
||||||
## Begins a never ending global dispatcher poll loop.
|
## Begins a never ending global dispatcher poll loop.
|
||||||
while true:
|
while true:
|
||||||
poll()
|
poll()
|
||||||
|
|
||||||
|
proc waitFor*[T](fut: PFuture[T]) =
|
||||||
|
## **Blocks** the current thread until the specified future completes.
|
||||||
|
while not fut.finished:
|
||||||
|
poll()
|
||||||
|
|
||||||
|
if fut.failed:
|
||||||
|
raise fut.error
|
||||||
|
|
|
||||||
295
lib/pure/asyncftpclient.nim
Normal file
295
lib/pure/asyncftpclient.nim
Normal file
|
|
@ -0,0 +1,295 @@
|
||||||
|
#
|
||||||
|
#
|
||||||
|
# Nimrod's Runtime Library
|
||||||
|
# (c) Copyright 2014 Dominik Picheta
|
||||||
|
# See the file "copying.txt", included in this
|
||||||
|
# distribution, for details about the copyright.
|
||||||
|
#
|
||||||
|
|
||||||
|
import asyncdispatch, asyncnet, strutils, parseutils, os, times
|
||||||
|
|
||||||
|
from ftpclient import TFtpBase, EInvalidReply, TFtpEvent
|
||||||
|
from net import bufferSize
|
||||||
|
|
||||||
|
type
|
||||||
|
TAsyncFtpClient* = TFtpBase[PAsyncSocket]
|
||||||
|
PAsyncFtpClient* = ref TAsyncFtpClient
|
||||||
|
|
||||||
|
ProgressChangedProc* =
|
||||||
|
proc (total, progress: BiggestInt, speed: float):
|
||||||
|
PFuture[void] {.closure, gcsafe.}
|
||||||
|
|
||||||
|
proc expectReply(ftp: PAsyncFtpClient): PFuture[TaintedString] =
|
||||||
|
result = ftp.csock.recvLine()
|
||||||
|
|
||||||
|
proc send*(ftp: PAsyncFtpClient, m: string): PFuture[TaintedString] {.async.} =
|
||||||
|
## Send a message to the server, and wait for a primary reply.
|
||||||
|
## ``\c\L`` is added for you.
|
||||||
|
await ftp.csock.send(m & "\c\L")
|
||||||
|
return await ftp.expectReply()
|
||||||
|
|
||||||
|
proc assertReply(received: TaintedString, expected: varargs[string]) =
|
||||||
|
for i in items(expected):
|
||||||
|
if received.string.startsWith(i): return
|
||||||
|
raise newException(EInvalidReply,
|
||||||
|
"Expected reply '$1' got: $2" %
|
||||||
|
[expected.join("' or '"), received.string])
|
||||||
|
|
||||||
|
proc pasv(ftp: PAsyncFtpClient) {.async.} =
|
||||||
|
## Negotiate a data connection.
|
||||||
|
ftp.dsock = newAsyncSocket()
|
||||||
|
|
||||||
|
var pasvMsg = (await ftp.send("PASV")).string.strip.TaintedString
|
||||||
|
assertReply(pasvMsg, "227")
|
||||||
|
var betweenParens = captureBetween(pasvMsg.string, '(', ')')
|
||||||
|
var nums = betweenParens.split(',')
|
||||||
|
var ip = nums[0.. -3]
|
||||||
|
var port = nums[-2.. -1]
|
||||||
|
var properPort = port[0].parseInt()*256+port[1].parseInt()
|
||||||
|
await ftp.dsock.connect(ip.join("."), TPort(properPort.toU16))
|
||||||
|
ftp.dsockConnected = True
|
||||||
|
|
||||||
|
proc normalizePathSep(path: string): string =
|
||||||
|
return replace(path, '\\', '/')
|
||||||
|
|
||||||
|
proc connect*(ftp: PAsyncFtpClient) {.async.} =
|
||||||
|
## Connect to the FTP server specified by ``ftp``.
|
||||||
|
await ftp.csock.connect(ftp.address, ftp.port)
|
||||||
|
|
||||||
|
var reply = await ftp.expectReply()
|
||||||
|
if reply.startsWith("120"):
|
||||||
|
# 120 Service ready in nnn minutes.
|
||||||
|
# We wait until we receive 220.
|
||||||
|
reply = await ftp.expectReply()
|
||||||
|
assertReply(reply, "220")
|
||||||
|
|
||||||
|
if ftp.user != "":
|
||||||
|
assertReply(await(ftp.send("USER " & ftp.user)), "230", "331")
|
||||||
|
|
||||||
|
if ftp.pass != "":
|
||||||
|
assertReply(await(ftp.send("PASS " & ftp.pass)), "230")
|
||||||
|
|
||||||
|
proc pwd*(ftp: PAsyncFtpClient): PFuture[TaintedString] {.async.} =
|
||||||
|
## Returns the current working directory.
|
||||||
|
let wd = await ftp.send("PWD")
|
||||||
|
assertReply wd, "257"
|
||||||
|
return wd.string.captureBetween('"').TaintedString # "
|
||||||
|
|
||||||
|
proc cd*(ftp: PAsyncFtpClient, dir: string) {.async.} =
|
||||||
|
## Changes the current directory on the remote FTP server to ``dir``.
|
||||||
|
assertReply(await(ftp.send("CWD " & dir.normalizePathSep)), "250")
|
||||||
|
|
||||||
|
proc cdup*(ftp: PAsyncFtpClient) {.async.} =
|
||||||
|
## Changes the current directory to the parent of the current directory.
|
||||||
|
assertReply(await(ftp.send("CDUP")), "200")
|
||||||
|
|
||||||
|
proc getLines(ftp: PAsyncFtpClient): PFuture[string] {.async.} =
|
||||||
|
## Downloads text data in ASCII mode
|
||||||
|
result = ""
|
||||||
|
assert ftp.dsockConnected
|
||||||
|
while ftp.dsockConnected:
|
||||||
|
let r = await ftp.dsock.recvLine()
|
||||||
|
if r.string == "":
|
||||||
|
ftp.dsockConnected = false
|
||||||
|
else:
|
||||||
|
result.add(r.string & "\n")
|
||||||
|
|
||||||
|
assertReply(await(ftp.expectReply()), "226")
|
||||||
|
|
||||||
|
proc listDirs*(ftp: PAsyncFtpClient, dir = ""): PFuture[seq[string]] {.async.} =
|
||||||
|
## Returns a list of filenames in the given directory. If ``dir`` is "",
|
||||||
|
## the current directory is used. If ``async`` is true, this
|
||||||
|
## function will return immediately and it will be your job to
|
||||||
|
## use asyncio's ``poll`` to progress this operation.
|
||||||
|
await ftp.pasv()
|
||||||
|
|
||||||
|
assertReply(await(ftp.send("NLST " & dir.normalizePathSep)), ["125", "150"])
|
||||||
|
|
||||||
|
result = splitLines(await ftp.getLines())
|
||||||
|
|
||||||
|
proc existsFile*(ftp: PAsyncFtpClient, file: string): PFuture[bool] {.async.} =
|
||||||
|
## Determines whether ``file`` exists.
|
||||||
|
var files = await ftp.listDirs()
|
||||||
|
for f in items(files):
|
||||||
|
if f.normalizePathSep == file.normalizePathSep: return true
|
||||||
|
|
||||||
|
proc createDir*(ftp: PAsyncFtpClient, dir: string, recursive = false){.async.} =
|
||||||
|
## Creates a directory ``dir``. If ``recursive`` is true, the topmost
|
||||||
|
## subdirectory of ``dir`` will be created first, following the secondmost...
|
||||||
|
## etc. this allows you to give a full path as the ``dir`` without worrying
|
||||||
|
## about subdirectories not existing.
|
||||||
|
if not recursive:
|
||||||
|
assertReply(await(ftp.send("MKD " & dir.normalizePathSep)), "257")
|
||||||
|
else:
|
||||||
|
var reply = TaintedString""
|
||||||
|
var previousDirs = ""
|
||||||
|
for p in split(dir, {os.dirSep, os.altSep}):
|
||||||
|
if p != "":
|
||||||
|
previousDirs.add(p)
|
||||||
|
reply = await ftp.send("MKD " & previousDirs)
|
||||||
|
previousDirs.add('/')
|
||||||
|
assertReply reply, "257"
|
||||||
|
|
||||||
|
proc chmod*(ftp: PAsyncFtpClient, path: string,
|
||||||
|
permissions: set[TFilePermission]) {.async.} =
|
||||||
|
## Changes permission of ``path`` to ``permissions``.
|
||||||
|
var userOctal = 0
|
||||||
|
var groupOctal = 0
|
||||||
|
var otherOctal = 0
|
||||||
|
for i in items(permissions):
|
||||||
|
case i
|
||||||
|
of fpUserExec: userOctal.inc(1)
|
||||||
|
of fpUserWrite: userOctal.inc(2)
|
||||||
|
of fpUserRead: userOctal.inc(4)
|
||||||
|
of fpGroupExec: groupOctal.inc(1)
|
||||||
|
of fpGroupWrite: groupOctal.inc(2)
|
||||||
|
of fpGroupRead: groupOctal.inc(4)
|
||||||
|
of fpOthersExec: otherOctal.inc(1)
|
||||||
|
of fpOthersWrite: otherOctal.inc(2)
|
||||||
|
of fpOthersRead: otherOctal.inc(4)
|
||||||
|
|
||||||
|
var perm = $userOctal & $groupOctal & $otherOctal
|
||||||
|
assertReply(await(ftp.send("SITE CHMOD " & perm &
|
||||||
|
" " & path.normalizePathSep)), "200")
|
||||||
|
|
||||||
|
proc list*(ftp: PAsyncFtpClient, dir = ""): PFuture[string] {.async.} =
|
||||||
|
## Lists all files in ``dir``. If ``dir`` is ``""``, uses the current
|
||||||
|
## working directory.
|
||||||
|
await ftp.pasv()
|
||||||
|
|
||||||
|
let reply = await ftp.send("LIST" & " " & dir.normalizePathSep)
|
||||||
|
assertReply(reply, ["125", "150"])
|
||||||
|
|
||||||
|
result = await ftp.getLines()
|
||||||
|
|
||||||
|
proc retrText*(ftp: PAsyncFtpClient, file: string): PFuture[string] {.async.} =
|
||||||
|
## Retrieves ``file``. File must be ASCII text.
|
||||||
|
await ftp.pasv()
|
||||||
|
let reply = await ftp.send("RETR " & file.normalizePathSep)
|
||||||
|
assertReply(reply, ["125", "150"])
|
||||||
|
|
||||||
|
result = await ftp.getLines()
|
||||||
|
|
||||||
|
proc getFile(ftp: PAsyncFtpClient, file: TFile, total: BiggestInt,
|
||||||
|
onProgressChanged: ProgressChangedProc) {.async.} =
|
||||||
|
assert ftp.dsockConnected
|
||||||
|
var progress = 0
|
||||||
|
var progressInSecond = 0
|
||||||
|
var countdownFut = sleepAsync(1000)
|
||||||
|
var dataFut = ftp.dsock.recv(bufferSize)
|
||||||
|
while ftp.dsockConnected:
|
||||||
|
await dataFut or countdownFut
|
||||||
|
if countdownFut.finished:
|
||||||
|
asyncCheck onProgressChanged(total, progress,
|
||||||
|
progressInSecond.float)
|
||||||
|
progressInSecond = 0
|
||||||
|
countdownFut = sleepAsync(1000)
|
||||||
|
|
||||||
|
if dataFut.finished:
|
||||||
|
let data = dataFut.read
|
||||||
|
if data != "":
|
||||||
|
progress.inc(data.len)
|
||||||
|
progressInSecond.inc(data.len)
|
||||||
|
file.write(data)
|
||||||
|
dataFut = ftp.dsock.recv(bufferSize)
|
||||||
|
else:
|
||||||
|
ftp.dsockConnected = False
|
||||||
|
|
||||||
|
assertReply(await(ftp.expectReply()), "226")
|
||||||
|
|
||||||
|
proc defaultOnProgressChanged*(total, progress: BiggestInt,
|
||||||
|
speed: float): PFuture[void] {.nimcall,gcsafe.} =
|
||||||
|
## Default FTP ``onProgressChanged`` handler. Does nothing.
|
||||||
|
result = newFuture[void]()
|
||||||
|
#echo(total, " ", progress, " ", speed)
|
||||||
|
result.complete()
|
||||||
|
|
||||||
|
proc retrFile*(ftp: PAsyncFtpClient, file, dest: string,
|
||||||
|
onProgressChanged = defaultOnProgressChanged) {.async.} =
|
||||||
|
## Downloads ``file`` and saves it to ``dest``.
|
||||||
|
## The ``EvRetr`` event is passed to the specified ``handleEvent`` function
|
||||||
|
## when the download is finished. The event's ``filename`` field will be equal
|
||||||
|
## to ``file``.
|
||||||
|
var destFile = open(dest, mode = fmWrite)
|
||||||
|
await ftp.pasv()
|
||||||
|
var reply = await ftp.send("RETR " & file.normalizePathSep)
|
||||||
|
assertReply reply, ["125", "150"]
|
||||||
|
if {'(', ')'} notin reply.string:
|
||||||
|
raise newException(EInvalidReply, "Reply has no file size.")
|
||||||
|
var fileSize: biggestInt
|
||||||
|
if reply.string.captureBetween('(', ')').parseBiggestInt(fileSize) == 0:
|
||||||
|
raise newException(EInvalidReply, "Reply has no file size.")
|
||||||
|
|
||||||
|
await getFile(ftp, destFile, fileSize, onProgressChanged)
|
||||||
|
|
||||||
|
proc doUpload(ftp: PAsyncFtpClient, file: TFile,
|
||||||
|
onProgressChanged: ProgressChangedProc) {.async.} =
|
||||||
|
assert ftp.dsockConnected
|
||||||
|
|
||||||
|
let total = file.getFileSize()
|
||||||
|
var data = newStringOfCap(4000)
|
||||||
|
var progress = 0
|
||||||
|
var progressInSecond = 0
|
||||||
|
var countdownFut = sleepAsync(1000)
|
||||||
|
var sendFut: PFuture[void] = nil
|
||||||
|
while ftp.dsockConnected:
|
||||||
|
if sendFut == nil or sendFut.finished:
|
||||||
|
progress.inc(data.len)
|
||||||
|
progressInSecond.inc(data.len)
|
||||||
|
# TODO: Async file reading.
|
||||||
|
let len = file.readBuffer(addr(data[0]), 4000)
|
||||||
|
setLen(data, len)
|
||||||
|
if len == 0:
|
||||||
|
# File finished uploading.
|
||||||
|
ftp.dsock.close()
|
||||||
|
ftp.dsockConnected = false
|
||||||
|
|
||||||
|
assertReply(await(ftp.expectReply()), "226")
|
||||||
|
else:
|
||||||
|
sendFut = ftp.dsock.send(data)
|
||||||
|
|
||||||
|
if countdownFut.finished:
|
||||||
|
asyncCheck onProgressChanged(total, progress, progressInSecond.float)
|
||||||
|
progressInSecond = 0
|
||||||
|
countdownFut = sleepAsync(1000)
|
||||||
|
|
||||||
|
await countdownFut or sendFut
|
||||||
|
|
||||||
|
proc storeFile*(ftp: PAsyncFtpClient, file, dest: string,
|
||||||
|
onProgressChanged = defaultOnProgressChanged) {.async.} =
|
||||||
|
## Uploads ``file`` to ``dest`` on the remote FTP server. Usage of this
|
||||||
|
## function asynchronously is recommended to view the progress of
|
||||||
|
## the download.
|
||||||
|
## The ``EvStore`` event is passed to the specified ``handleEvent`` function
|
||||||
|
## when the upload is finished, and the ``filename`` field will be
|
||||||
|
## equal to ``file``.
|
||||||
|
var destFile = open(file)
|
||||||
|
await ftp.pasv()
|
||||||
|
|
||||||
|
let reply = await ftp.send("STOR " & dest.normalizePathSep)
|
||||||
|
assertReply reply, ["125", "150"]
|
||||||
|
|
||||||
|
await doUpload(ftp, destFile, onProgressChanged)
|
||||||
|
|
||||||
|
proc newAsyncFtpClient*(address: string, port = TPort(21),
|
||||||
|
user, pass = ""): PAsyncFtpClient =
|
||||||
|
## Creates a new ``PAsyncFtpClient`` object.
|
||||||
|
new result
|
||||||
|
result.user = user
|
||||||
|
result.pass = pass
|
||||||
|
result.address = address
|
||||||
|
result.port = port
|
||||||
|
result.dsockConnected = false
|
||||||
|
result.csock = newAsyncSocket()
|
||||||
|
|
||||||
|
when isMainModule:
|
||||||
|
var ftp = newAsyncFtpClient("example.com", user = "test", pass = "test")
|
||||||
|
proc main(ftp: PAsyncFtpClient) {.async.} =
|
||||||
|
await ftp.connect()
|
||||||
|
echo await ftp.pwd()
|
||||||
|
echo await ftp.listDirs()
|
||||||
|
await ftp.storeFile("payload.jpg", "payload.jpg")
|
||||||
|
await ftp.retrFile("payload.jpg", "payload2.jpg")
|
||||||
|
echo("Finished")
|
||||||
|
|
||||||
|
waitFor main(ftp)
|
||||||
|
|
@ -100,7 +100,8 @@ proc sendStatus(client: PAsyncSocket, status: string): PFuture[void] =
|
||||||
client.send("HTTP/1.1 " & status & "\c\L")
|
client.send("HTTP/1.1 " & status & "\c\L")
|
||||||
|
|
||||||
proc processClient(client: PAsyncSocket, address: string,
|
proc processClient(client: PAsyncSocket, address: string,
|
||||||
callback: proc (request: TRequest): PFuture[void]) {.async.} =
|
callback: proc (request: TRequest):
|
||||||
|
PFuture[void] {.closure, gcsafe.}) {.async.} =
|
||||||
while true:
|
while true:
|
||||||
# GET /path HTTP/1.1
|
# GET /path HTTP/1.1
|
||||||
# Header: val
|
# Header: val
|
||||||
|
|
@ -187,7 +188,7 @@ proc processClient(client: PAsyncSocket, address: string,
|
||||||
break
|
break
|
||||||
|
|
||||||
proc serve*(server: PAsyncHttpServer, port: TPort,
|
proc serve*(server: PAsyncHttpServer, port: TPort,
|
||||||
callback: proc (request: TRequest): PFuture[void] {.gcsafe.},
|
callback: proc (request: TRequest): PFuture[void] {.closure,gcsafe.},
|
||||||
address = "") {.async.} =
|
address = "") {.async.} =
|
||||||
## Starts the process of listening for incoming HTTP connections on the
|
## Starts the process of listening for incoming HTTP connections on the
|
||||||
## specified address and port.
|
## specified address and port.
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,10 @@ include "system/inclrtl"
|
||||||
|
|
||||||
import sockets, strutils, parseutils, times, os, asyncio
|
import sockets, strutils, parseutils, times, os, asyncio
|
||||||
|
|
||||||
|
from asyncnet import nil
|
||||||
|
from rawsockets import nil
|
||||||
|
from asyncdispatch import PFuture
|
||||||
|
|
||||||
## This module **partially** implements an FTP client as specified
|
## This module **partially** implements an FTP client as specified
|
||||||
## by `RFC 959 <http://tools.ietf.org/html/rfc959>`_.
|
## by `RFC 959 <http://tools.ietf.org/html/rfc959>`_.
|
||||||
##
|
##
|
||||||
|
|
@ -33,34 +37,32 @@ import sockets, strutils, parseutils, times, os, asyncio
|
||||||
## to change.
|
## to change.
|
||||||
|
|
||||||
type
|
type
|
||||||
FTPClientObj* = object of RootObj
|
FtpBase*[SockType] = ref FtpBaseObj[SockType]
|
||||||
case isAsync: bool
|
FtpBaseObj*[SockType] = object
|
||||||
of false:
|
csock*: SockType
|
||||||
csock: Socket # Command connection socket
|
dsock*: SockType
|
||||||
dsock: Socket # Data connection socket
|
when SockType is asyncio.AsyncSocket:
|
||||||
else:
|
|
||||||
dummyA, dummyB: pointer # workaround a Nim API issue
|
|
||||||
asyncCSock: AsyncSocket
|
|
||||||
asyncDSock: AsyncSocket
|
|
||||||
handleEvent*: proc (ftp: AsyncFTPClient, ev: FTPEvent){.closure,gcsafe.}
|
handleEvent*: proc (ftp: AsyncFTPClient, ev: FTPEvent){.closure,gcsafe.}
|
||||||
disp: Dispatcher
|
disp: Dispatcher
|
||||||
asyncDSockID: Delegate
|
asyncDSockID: Delegate
|
||||||
user, pass: string
|
user*, pass*: string
|
||||||
address: string
|
address*: string
|
||||||
port: Port
|
when SockType is asyncnet.AsyncSocket:
|
||||||
|
port*: rawsockets.Port
|
||||||
|
else:
|
||||||
|
port*: Port
|
||||||
|
|
||||||
jobInProgress: bool
|
jobInProgress*: bool
|
||||||
job: ref FTPJob
|
job*: FTPJob[SockType]
|
||||||
|
|
||||||
dsockConnected: bool
|
dsockConnected*: bool
|
||||||
|
|
||||||
FTPClient* = ref FTPClientObj
|
|
||||||
|
|
||||||
FTPJobType* = enum
|
FTPJobType* = enum
|
||||||
JRetrText, JRetr, JStore
|
JRetrText, JRetr, JStore
|
||||||
|
|
||||||
FTPJob = object
|
FtpJob[T] = ref FtpJobObj[T]
|
||||||
prc: proc (ftp: PFTPClient, async: bool): bool {.nimcall, gcsafe.}
|
FTPJobObj[T] = object
|
||||||
|
prc: proc (ftp: FTPBase[T], async: bool): bool {.nimcall, gcsafe.}
|
||||||
case typ*: FTPJobType
|
case typ*: FTPJobType
|
||||||
of JRetrText:
|
of JRetrText:
|
||||||
lines: string
|
lines: string
|
||||||
|
|
@ -74,8 +76,11 @@ type
|
||||||
toStore: string # Data left to upload (Only used with async)
|
toStore: string # Data left to upload (Only used with async)
|
||||||
else: nil
|
else: nil
|
||||||
|
|
||||||
AsyncFTPClient* = ref AsyncFTPClientObj ## Async alternative to TFTPClient.
|
FtpClientObj* = FtpBaseObj[Socket]
|
||||||
AsyncFTPClientObj* = object of FTPClientObj
|
FtpClient* = ref FtpClientObj
|
||||||
|
|
||||||
|
AsyncFtpClient* = ref AsyncFtpClientObj ## Async alternative to TFTPClient.
|
||||||
|
AsyncFtpClientObj* = FtpBaseObj[asyncio.AsyncSocket]
|
||||||
|
|
||||||
FTPEventType* = enum
|
FTPEventType* = enum
|
||||||
EvTransferProgress, EvLines, EvRetr, EvStore
|
EvTransferProgress, EvLines, EvRetr, EvStore
|
||||||
|
|
@ -103,38 +108,38 @@ type
|
||||||
].}
|
].}
|
||||||
|
|
||||||
proc ftpClient*(address: string, port = TPort(21),
|
proc ftpClient*(address: string, port = TPort(21),
|
||||||
user, pass = ""): PFTPClient =
|
user, pass = ""): FtpClient =
|
||||||
## Create a ``PFTPClient`` object.
|
## Create a ``FtpClient`` object.
|
||||||
new(result)
|
new(result)
|
||||||
result.user = user
|
result.user = user
|
||||||
result.pass = pass
|
result.pass = pass
|
||||||
result.address = address
|
result.address = address
|
||||||
result.port = port
|
result.port = port
|
||||||
|
|
||||||
result.isAsync = false
|
|
||||||
result.dsockConnected = false
|
result.dsockConnected = false
|
||||||
result.csock = socket()
|
result.csock = socket()
|
||||||
if result.csock == InvalidSocket: osError(osLastError())
|
if result.csock == invalidSocket: raiseOSError(osLastError())
|
||||||
|
|
||||||
proc getDSock(ftp: PFTPClient): TSocket =
|
proc getDSock[T](ftp: FtpBase[T]): TSocket =
|
||||||
if ftp.isAsync: return ftp.asyncDSock else: return ftp.dsock
|
return ftp.dsock
|
||||||
|
|
||||||
proc getCSock(ftp: PFTPClient): TSocket =
|
proc getCSock[T](ftp: FtpBase[T]): TSocket =
|
||||||
if ftp.isAsync: return ftp.asyncCSock else: return ftp.csock
|
return ftp.csock
|
||||||
|
|
||||||
template blockingOperation(sock: TSocket, body: stmt) {.immediate.} =
|
template blockingOperation(sock: TSocket, body: stmt) {.immediate.} =
|
||||||
if ftp.isAsync:
|
|
||||||
sock.setBlocking(true)
|
|
||||||
body
|
body
|
||||||
if ftp.isAsync:
|
|
||||||
sock.setBlocking(false)
|
|
||||||
|
|
||||||
proc expectReply(ftp: PFTPClient): TaintedString =
|
template blockingOperation(sock: asyncio.PAsyncSocket, body: stmt) {.immediate.} =
|
||||||
|
sock.setBlocking(true)
|
||||||
|
body
|
||||||
|
sock.setBlocking(false)
|
||||||
|
|
||||||
|
proc expectReply[T](ftp: FtpBase[T]): TaintedString =
|
||||||
result = TaintedString""
|
result = TaintedString""
|
||||||
blockingOperation(ftp.getCSock()):
|
blockingOperation(ftp.getCSock()):
|
||||||
ftp.getCSock().readLine(result)
|
ftp.getCSock().readLine(result)
|
||||||
|
|
||||||
proc send*(ftp: PFTPClient, m: string): TaintedString =
|
proc send*[T](ftp: FtpBase[T], m: string): TaintedString =
|
||||||
## Send a message to the server, and wait for a primary reply.
|
## Send a message to the server, and wait for a primary reply.
|
||||||
## ``\c\L`` is added for you.
|
## ``\c\L`` is added for you.
|
||||||
blockingOperation(ftp.getCSock()):
|
blockingOperation(ftp.getCSock()):
|
||||||
|
|
@ -154,8 +159,8 @@ proc assertReply(received: TaintedString, expected: varargs[string]) =
|
||||||
"Expected reply '$1' got: $2" %
|
"Expected reply '$1' got: $2" %
|
||||||
[expected.join("' or '"), received.string])
|
[expected.join("' or '"), received.string])
|
||||||
|
|
||||||
proc createJob(ftp: PFTPClient,
|
proc createJob[T](ftp: FtpBase[T],
|
||||||
prc: proc (ftp: PFTPClient, async: bool): bool {.
|
prc: proc (ftp: FtpBase[T], async: bool): bool {.
|
||||||
nimcall,gcsafe.},
|
nimcall,gcsafe.},
|
||||||
cmd: FTPJobType) =
|
cmd: FTPJobType) =
|
||||||
if ftp.jobInProgress:
|
if ftp.jobInProgress:
|
||||||
|
|
@ -170,7 +175,7 @@ proc createJob(ftp: PFTPClient,
|
||||||
of JRetr, JStore:
|
of JRetr, JStore:
|
||||||
ftp.job.toStore = ""
|
ftp.job.toStore = ""
|
||||||
|
|
||||||
proc deleteJob(ftp: PFTPClient) =
|
proc deleteJob[T](ftp: FtpBase[T]) =
|
||||||
assert ftp.jobInProgress
|
assert ftp.jobInProgress
|
||||||
ftp.jobInProgress = false
|
ftp.jobInProgress = false
|
||||||
case ftp.job.typ
|
case ftp.job.typ
|
||||||
|
|
@ -178,12 +183,9 @@ proc deleteJob(ftp: PFTPClient) =
|
||||||
ftp.job.lines = ""
|
ftp.job.lines = ""
|
||||||
of JRetr, JStore:
|
of JRetr, JStore:
|
||||||
ftp.job.file.close()
|
ftp.job.file.close()
|
||||||
if ftp.isAsync:
|
ftp.dsock.close()
|
||||||
ftp.asyncDSock.close()
|
|
||||||
else:
|
|
||||||
ftp.dsock.close()
|
|
||||||
|
|
||||||
proc handleTask(s: PAsyncSocket, ftp: PFTPClient) =
|
proc handleTask(s: PAsyncSocket, ftp: PAsyncFTPClient) =
|
||||||
if ftp.jobInProgress:
|
if ftp.jobInProgress:
|
||||||
if ftp.job.typ in {JRetr, JStore}:
|
if ftp.job.typ in {JRetr, JStore}:
|
||||||
if epochTime() - ftp.job.lastProgressReport >= 1.0:
|
if epochTime() - ftp.job.lastProgressReport >= 1.0:
|
||||||
|
|
@ -198,12 +200,12 @@ proc handleTask(s: PAsyncSocket, ftp: PFTPClient) =
|
||||||
ftp.job.oneSecond = 0
|
ftp.job.oneSecond = 0
|
||||||
ftp.handleEvent(PAsyncFTPClient(ftp), r)
|
ftp.handleEvent(PAsyncFTPClient(ftp), r)
|
||||||
|
|
||||||
proc handleWrite(s: PAsyncSocket, ftp: PFTPClient) =
|
proc handleWrite(s: PAsyncSocket, ftp: PAsyncFTPClient) =
|
||||||
if ftp.jobInProgress:
|
if ftp.jobInProgress:
|
||||||
if ftp.job.typ == JStore:
|
if ftp.job.typ == JStore:
|
||||||
assert (not ftp.job.prc(ftp, true))
|
assert (not ftp.job.prc(ftp, true))
|
||||||
|
|
||||||
proc handleConnect(s: PAsyncSocket, ftp: PFTPClient) =
|
proc handleConnect(s: PAsyncSocket, ftp: PAsyncFTPClient) =
|
||||||
ftp.dsockConnected = true
|
ftp.dsockConnected = true
|
||||||
assert(ftp.jobInProgress)
|
assert(ftp.jobInProgress)
|
||||||
if ftp.job.typ == JStore:
|
if ftp.job.typ == JStore:
|
||||||
|
|
@ -211,30 +213,32 @@ proc handleConnect(s: PAsyncSocket, ftp: PFTPClient) =
|
||||||
else:
|
else:
|
||||||
s.delHandleWrite()
|
s.delHandleWrite()
|
||||||
|
|
||||||
proc handleRead(s: PAsyncSocket, ftp: PFTPClient) =
|
proc handleRead(s: PAsyncSocket, ftp: PAsyncFTPClient) =
|
||||||
assert ftp.jobInProgress
|
assert ftp.jobInProgress
|
||||||
assert ftp.job.typ != JStore
|
assert ftp.job.typ != JStore
|
||||||
# This can never return true, because it shouldn't check for code
|
# This can never return true, because it shouldn't check for code
|
||||||
# 226 from csock.
|
# 226 from csock.
|
||||||
assert(not ftp.job.prc(ftp, true))
|
assert(not ftp.job.prc(ftp, true))
|
||||||
|
|
||||||
proc pasv(ftp: PFTPClient) =
|
proc pasv[T](ftp: FtpBase[T]) =
|
||||||
## Negotiate a data connection.
|
## Negotiate a data connection.
|
||||||
if not ftp.isAsync:
|
when T is TSocket:
|
||||||
ftp.dsock = socket()
|
ftp.dsock = socket()
|
||||||
if ftp.dsock == InvalidSocket: osError(osLastError())
|
if ftp.dsock == invalidSocket: raiseOSError(osLastError())
|
||||||
else:
|
elif T is PAsyncSocket:
|
||||||
ftp.asyncDSock = AsyncSocket()
|
ftp.dsock = asyncSocket()
|
||||||
ftp.asyncDSock.handleRead =
|
ftp.dsock.handleRead =
|
||||||
proc (s: PAsyncSocket) =
|
proc (s: PAsyncSocket) =
|
||||||
handleRead(s, ftp)
|
handleRead(s, ftp)
|
||||||
ftp.asyncDSock.handleConnect =
|
ftp.dsock.handleConnect =
|
||||||
proc (s: PAsyncSocket) =
|
proc (s: PAsyncSocket) =
|
||||||
handleConnect(s, ftp)
|
handleConnect(s, ftp)
|
||||||
ftp.asyncDSock.handleTask =
|
ftp.dsock.handleTask =
|
||||||
proc (s: PAsyncSocket) =
|
proc (s: PAsyncSocket) =
|
||||||
handleTask(s, ftp)
|
handleTask(s, ftp)
|
||||||
ftp.disp.register(ftp.asyncDSock)
|
ftp.disp.register(ftp.dsock)
|
||||||
|
else:
|
||||||
|
{.fatal: "Incorrect socket instantiation".}
|
||||||
|
|
||||||
var pasvMsg = ftp.send("PASV").string.strip.TaintedString
|
var pasvMsg = ftp.send("PASV").string.strip.TaintedString
|
||||||
assertReply(pasvMsg, "227")
|
assertReply(pasvMsg, "227")
|
||||||
|
|
@ -243,23 +247,24 @@ proc pasv(ftp: PFTPClient) =
|
||||||
var ip = nums[0.. -3]
|
var ip = nums[0.. -3]
|
||||||
var port = nums[-2.. -1]
|
var port = nums[-2.. -1]
|
||||||
var properPort = port[0].parseInt()*256+port[1].parseInt()
|
var properPort = port[0].parseInt()*256+port[1].parseInt()
|
||||||
if ftp.isAsync:
|
ftp.dsock.connect(ip.join("."), TPort(properPort.toU16))
|
||||||
ftp.asyncDSock.connect(ip.join("."), TPort(properPort.toU16))
|
when T is PAsyncSocket:
|
||||||
ftp.dsockConnected = False
|
ftp.dsockConnected = false
|
||||||
else:
|
else:
|
||||||
ftp.dsock.connect(ip.join("."), TPort(properPort.toU16))
|
ftp.dsockConnected = true
|
||||||
ftp.dsockConnected = True
|
|
||||||
|
|
||||||
proc normalizePathSep(path: string): string =
|
proc normalizePathSep(path: string): string =
|
||||||
return replace(path, '\\', '/')
|
return replace(path, '\\', '/')
|
||||||
|
|
||||||
proc connect*(ftp: PFTPClient) =
|
proc connect*[T](ftp: FtpBase[T]) =
|
||||||
## Connect to the FTP server specified by ``ftp``.
|
## Connect to the FTP server specified by ``ftp``.
|
||||||
if ftp.isAsync:
|
when T is PAsyncSocket:
|
||||||
blockingOperation(ftp.asyncCSock):
|
blockingOperation(ftp.csock):
|
||||||
ftp.asyncCSock.connect(ftp.address, ftp.port)
|
ftp.csock.connect(ftp.address, ftp.port)
|
||||||
else:
|
elif T is TSocket:
|
||||||
ftp.csock.connect(ftp.address, ftp.port)
|
ftp.csock.connect(ftp.address, ftp.port)
|
||||||
|
else:
|
||||||
|
{.fatal: "Incorrect socket instantiation".}
|
||||||
|
|
||||||
# TODO: Handle 120? or let user handle it.
|
# TODO: Handle 120? or let user handle it.
|
||||||
assertReply ftp.expectReply(), "220"
|
assertReply ftp.expectReply(), "220"
|
||||||
|
|
@ -270,39 +275,41 @@ proc connect*(ftp: PFTPClient) =
|
||||||
if ftp.pass != "":
|
if ftp.pass != "":
|
||||||
assertReply ftp.send("PASS " & ftp.pass), "230"
|
assertReply ftp.send("PASS " & ftp.pass), "230"
|
||||||
|
|
||||||
proc pwd*(ftp: PFTPClient): string =
|
proc pwd*(ftp: FtpClient): string =
|
||||||
## Returns the current working directory.
|
## Returns the current working directory.
|
||||||
var wd = ftp.send("PWD")
|
var wd = ftp.send("PWD")
|
||||||
assertReply wd, "257"
|
assertReply wd, "257"
|
||||||
return wd.string.captureBetween('"') # "
|
return wd.string.captureBetween('"') # "
|
||||||
|
|
||||||
proc cd*(ftp: PFTPClient, dir: string) =
|
proc cd*(ftp: FtpClient, dir: string) =
|
||||||
## Changes the current directory on the remote FTP server to ``dir``.
|
## Changes the current directory on the remote FTP server to ``dir``.
|
||||||
assertReply ftp.send("CWD " & dir.normalizePathSep), "250"
|
assertReply ftp.send("CWD " & dir.normalizePathSep), "250"
|
||||||
|
|
||||||
proc cdup*(ftp: PFTPClient) =
|
proc cdup*(ftp: FtpClient) =
|
||||||
## Changes the current directory to the parent of the current directory.
|
## Changes the current directory to the parent of the current directory.
|
||||||
assertReply ftp.send("CDUP"), "200"
|
assertReply ftp.send("CDUP"), "200"
|
||||||
|
|
||||||
proc getLines(ftp: PFTPClient, async: bool = false): bool =
|
proc getLines[T](ftp: FtpBase[T], async: bool = false): bool =
|
||||||
## Downloads text data in ASCII mode
|
## Downloads text data in ASCII mode
|
||||||
## Returns true if the download is complete.
|
## Returns true if the download is complete.
|
||||||
## It doesn't if `async` is true, because it doesn't check for 226 then.
|
## It doesn't if `async` is true, because it doesn't check for 226 then.
|
||||||
if ftp.dsockConnected:
|
if ftp.dsockConnected:
|
||||||
var r = TaintedString""
|
var r = TaintedString""
|
||||||
if ftp.isAsync:
|
when T is PAsyncSocket:
|
||||||
if ftp.asyncDSock.readLine(r):
|
if ftp.asyncDSock.readLine(r):
|
||||||
if r.string == "":
|
if r.string == "":
|
||||||
ftp.dsockConnected = false
|
ftp.dsockConnected = false
|
||||||
else:
|
else:
|
||||||
ftp.job.lines.add(r.string & "\n")
|
ftp.job.lines.add(r.string & "\n")
|
||||||
else:
|
elif T is TSocket:
|
||||||
assert(not async)
|
assert(not async)
|
||||||
ftp.dsock.readLine(r)
|
ftp.dsock.readLine(r)
|
||||||
if r.string == "":
|
if r.string == "":
|
||||||
ftp.dsockConnected = false
|
ftp.dsockConnected = false
|
||||||
else:
|
else:
|
||||||
ftp.job.lines.add(r.string & "\n")
|
ftp.job.lines.add(r.string & "\n")
|
||||||
|
else:
|
||||||
|
{.fatal: "Incorrect socket instantiation".}
|
||||||
|
|
||||||
if not async:
|
if not async:
|
||||||
var readSocks: seq[TSocket] = @[ftp.getCSock()]
|
var readSocks: seq[TSocket] = @[ftp.getCSock()]
|
||||||
|
|
@ -312,14 +319,14 @@ proc getLines(ftp: PFTPClient, async: bool = false): bool =
|
||||||
assertReply ftp.expectReply(), "226"
|
assertReply ftp.expectReply(), "226"
|
||||||
return true
|
return true
|
||||||
|
|
||||||
proc listDirs*(ftp: PFTPClient, dir: string = "",
|
proc listDirs*[T](ftp: FtpBase[T], dir: string = "",
|
||||||
async = false): seq[string] =
|
async = false): seq[string] =
|
||||||
## Returns a list of filenames in the given directory. If ``dir`` is "",
|
## Returns a list of filenames in the given directory. If ``dir`` is "",
|
||||||
## the current directory is used. If ``async`` is true, this
|
## the current directory is used. If ``async`` is true, this
|
||||||
## function will return immediately and it will be your job to
|
## function will return immediately and it will be your job to
|
||||||
## use asyncio's ``poll`` to progress this operation.
|
## use asyncio's ``poll`` to progress this operation.
|
||||||
|
|
||||||
ftp.createJob(getLines, JRetrText)
|
ftp.createJob(getLines[T], JRetrText)
|
||||||
ftp.pasv()
|
ftp.pasv()
|
||||||
|
|
||||||
assertReply ftp.send("NLST " & dir.normalizePathSep), ["125", "150"]
|
assertReply ftp.send("NLST " & dir.normalizePathSep), ["125", "150"]
|
||||||
|
|
@ -330,7 +337,7 @@ proc listDirs*(ftp: PFTPClient, dir: string = "",
|
||||||
ftp.deleteJob()
|
ftp.deleteJob()
|
||||||
else: return @[]
|
else: return @[]
|
||||||
|
|
||||||
proc fileExists*(ftp: PFTPClient, file: string): bool {.deprecated.} =
|
proc fileExists*(ftp: FtpClient, file: string): bool {.deprecated.} =
|
||||||
## **Deprecated since version 0.9.0:** Please use ``existsFile``.
|
## **Deprecated since version 0.9.0:** Please use ``existsFile``.
|
||||||
##
|
##
|
||||||
## Determines whether ``file`` exists.
|
## Determines whether ``file`` exists.
|
||||||
|
|
@ -341,7 +348,7 @@ proc fileExists*(ftp: PFTPClient, file: string): bool {.deprecated.} =
|
||||||
for f in items(files):
|
for f in items(files):
|
||||||
if f.normalizePathSep == file.normalizePathSep: return true
|
if f.normalizePathSep == file.normalizePathSep: return true
|
||||||
|
|
||||||
proc existsFile*(ftp: PFTPClient, file: string): bool =
|
proc existsFile*(ftp: FtpClient, file: string): bool =
|
||||||
## Determines whether ``file`` exists.
|
## Determines whether ``file`` exists.
|
||||||
##
|
##
|
||||||
## Warning: This function may block. Especially on directories with many
|
## Warning: This function may block. Especially on directories with many
|
||||||
|
|
@ -350,7 +357,7 @@ proc existsFile*(ftp: PFTPClient, file: string): bool =
|
||||||
for f in items(files):
|
for f in items(files):
|
||||||
if f.normalizePathSep == file.normalizePathSep: return true
|
if f.normalizePathSep == file.normalizePathSep: return true
|
||||||
|
|
||||||
proc createDir*(ftp: PFTPClient, dir: string, recursive: bool = false) =
|
proc createDir*(ftp: FtpClient, dir: string, recursive: bool = false) =
|
||||||
## Creates a directory ``dir``. If ``recursive`` is true, the topmost
|
## Creates a directory ``dir``. If ``recursive`` is true, the topmost
|
||||||
## subdirectory of ``dir`` will be created first, following the secondmost...
|
## subdirectory of ``dir`` will be created first, following the secondmost...
|
||||||
## etc. this allows you to give a full path as the ``dir`` without worrying
|
## etc. this allows you to give a full path as the ``dir`` without worrying
|
||||||
|
|
@ -360,14 +367,14 @@ proc createDir*(ftp: PFTPClient, dir: string, recursive: bool = false) =
|
||||||
else:
|
else:
|
||||||
var reply = TaintedString""
|
var reply = TaintedString""
|
||||||
var previousDirs = ""
|
var previousDirs = ""
|
||||||
for p in split(dir, {os.dirSep, os.altSep}):
|
for p in split(dir, {os.DirSep, os.AltSep}):
|
||||||
if p != "":
|
if p != "":
|
||||||
previousDirs.add(p)
|
previousDirs.add(p)
|
||||||
reply = ftp.send("MKD " & previousDirs)
|
reply = ftp.send("MKD " & previousDirs)
|
||||||
previousDirs.add('/')
|
previousDirs.add('/')
|
||||||
assertReply reply, "257"
|
assertReply reply, "257"
|
||||||
|
|
||||||
proc chmod*(ftp: PFTPClient, path: string,
|
proc chmod*(ftp: FtpClient, path: string,
|
||||||
permissions: set[TFilePermission]) =
|
permissions: set[TFilePermission]) =
|
||||||
## Changes permission of ``path`` to ``permissions``.
|
## Changes permission of ``path`` to ``permissions``.
|
||||||
var userOctal = 0
|
var userOctal = 0
|
||||||
|
|
@ -389,12 +396,12 @@ proc chmod*(ftp: PFTPClient, path: string,
|
||||||
assertReply ftp.send("SITE CHMOD " & perm &
|
assertReply ftp.send("SITE CHMOD " & perm &
|
||||||
" " & path.normalizePathSep), "200"
|
" " & path.normalizePathSep), "200"
|
||||||
|
|
||||||
proc list*(ftp: PFTPClient, dir: string = "", async = false): string =
|
proc list*[T](ftp: FtpBase[T], dir: string = "", async = false): string =
|
||||||
## Lists all files in ``dir``. If ``dir`` is ``""``, uses the current
|
## Lists all files in ``dir``. If ``dir`` is ``""``, uses the current
|
||||||
## working directory. If ``async`` is true, this function will return
|
## working directory. If ``async`` is true, this function will return
|
||||||
## immediately and it will be your job to call asyncio's
|
## immediately and it will be your job to call asyncio's
|
||||||
## ``poll`` to progress this operation.
|
## ``poll`` to progress this operation.
|
||||||
ftp.createJob(getLines, JRetrText)
|
ftp.createJob(getLines[T], JRetrText)
|
||||||
ftp.pasv()
|
ftp.pasv()
|
||||||
|
|
||||||
assertReply(ftp.send("LIST" & " " & dir.normalizePathSep), ["125", "150"])
|
assertReply(ftp.send("LIST" & " " & dir.normalizePathSep), ["125", "150"])
|
||||||
|
|
@ -406,11 +413,11 @@ proc list*(ftp: PFTPClient, dir: string = "", async = false): string =
|
||||||
else:
|
else:
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
proc retrText*(ftp: PFTPClient, file: string, async = false): string =
|
proc retrText*[T](ftp: FtpBase[T], file: string, async = false): string =
|
||||||
## Retrieves ``file``. File must be ASCII text.
|
## Retrieves ``file``. File must be ASCII text.
|
||||||
## If ``async`` is true, this function will return immediately and
|
## If ``async`` is true, this function will return immediately and
|
||||||
## it will be your job to call asyncio's ``poll`` to progress this operation.
|
## it will be your job to call asyncio's ``poll`` to progress this operation.
|
||||||
ftp.createJob(getLines, JRetrText)
|
ftp.createJob(getLines[T], JRetrText)
|
||||||
ftp.pasv()
|
ftp.pasv()
|
||||||
assertReply ftp.send("RETR " & file.normalizePathSep), ["125", "150"]
|
assertReply ftp.send("RETR " & file.normalizePathSep), ["125", "150"]
|
||||||
|
|
||||||
|
|
@ -421,15 +428,17 @@ proc retrText*(ftp: PFTPClient, file: string, async = false): string =
|
||||||
else:
|
else:
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
proc getFile(ftp: PFTPClient, async = false): bool =
|
proc getFile[T](ftp: FtpBase[T], async = false): bool =
|
||||||
if ftp.dsockConnected:
|
if ftp.dsockConnected:
|
||||||
var r = "".TaintedString
|
var r = "".TaintedString
|
||||||
var bytesRead = 0
|
var bytesRead = 0
|
||||||
var returned = false
|
var returned = false
|
||||||
if async:
|
if async:
|
||||||
if not ftp.isAsync: raise newException(EFTP, "FTPClient must be async.")
|
when T is TSocket:
|
||||||
bytesRead = ftp.AsyncDSock.recvAsync(r, BufferSize)
|
raise newException(EFTP, "FTPClient must be async.")
|
||||||
returned = bytesRead != -1
|
else:
|
||||||
|
bytesRead = ftp.dsock.recvAsync(r, BufferSize)
|
||||||
|
returned = bytesRead != -1
|
||||||
else:
|
else:
|
||||||
bytesRead = getDSock(ftp).recv(r, BufferSize)
|
bytesRead = getDSock(ftp).recv(r, BufferSize)
|
||||||
returned = true
|
returned = true
|
||||||
|
|
@ -439,7 +448,7 @@ proc getFile(ftp: PFTPClient, async = false): bool =
|
||||||
ftp.job.oneSecond.inc(r2.len)
|
ftp.job.oneSecond.inc(r2.len)
|
||||||
ftp.job.file.write(r2)
|
ftp.job.file.write(r2)
|
||||||
elif returned and r2 == "":
|
elif returned and r2 == "":
|
||||||
ftp.dsockConnected = False
|
ftp.dsockConnected = false
|
||||||
|
|
||||||
if not async:
|
if not async:
|
||||||
var readSocks: seq[TSocket] = @[ftp.getCSock()]
|
var readSocks: seq[TSocket] = @[ftp.getCSock()]
|
||||||
|
|
@ -448,20 +457,20 @@ proc getFile(ftp: PFTPClient, async = false): bool =
|
||||||
assertReply ftp.expectReply(), "226"
|
assertReply ftp.expectReply(), "226"
|
||||||
return true
|
return true
|
||||||
|
|
||||||
proc retrFile*(ftp: PFTPClient, file, dest: string, async = false) =
|
proc retrFile*[T](ftp: FtpBase[T], file, dest: string, async = false) =
|
||||||
## Downloads ``file`` and saves it to ``dest``. Usage of this function
|
## Downloads ``file`` and saves it to ``dest``. Usage of this function
|
||||||
## asynchronously is recommended to view the progress of the download.
|
## asynchronously is recommended to view the progress of the download.
|
||||||
## The ``EvRetr`` event is passed to the specified ``handleEvent`` function
|
## The ``EvRetr`` event is passed to the specified ``handleEvent`` function
|
||||||
## when the download is finished, and the ``filename`` field will be equal
|
## when the download is finished, and the ``filename`` field will be equal
|
||||||
## to ``file``.
|
## to ``file``.
|
||||||
ftp.createJob(getFile, JRetr)
|
ftp.createJob(getFile[T], JRetr)
|
||||||
ftp.job.file = open(dest, mode = fmWrite)
|
ftp.job.file = open(dest, mode = fmWrite)
|
||||||
ftp.pasv()
|
ftp.pasv()
|
||||||
var reply = ftp.send("RETR " & file.normalizePathSep)
|
var reply = ftp.send("RETR " & file.normalizePathSep)
|
||||||
assertReply reply, ["125", "150"]
|
assertReply reply, ["125", "150"]
|
||||||
if {'(', ')'} notin reply.string:
|
if {'(', ')'} notin reply.string:
|
||||||
raise newException(EInvalidReply, "Reply has no file size.")
|
raise newException(EInvalidReply, "Reply has no file size.")
|
||||||
var fileSize: biggestInt
|
var fileSize: BiggestInt
|
||||||
if reply.string.captureBetween('(', ')').parseBiggestInt(fileSize) == 0:
|
if reply.string.captureBetween('(', ')').parseBiggestInt(fileSize) == 0:
|
||||||
raise newException(EInvalidReply, "Reply has no file size.")
|
raise newException(EInvalidReply, "Reply has no file size.")
|
||||||
|
|
||||||
|
|
@ -473,11 +482,11 @@ proc retrFile*(ftp: PFTPClient, file, dest: string, async = false) =
|
||||||
while not ftp.job.prc(ftp, false): discard
|
while not ftp.job.prc(ftp, false): discard
|
||||||
ftp.deleteJob()
|
ftp.deleteJob()
|
||||||
|
|
||||||
proc doUpload(ftp: PFTPClient, async = false): bool =
|
proc doUpload[T](ftp: FtpBase[T], async = false): bool =
|
||||||
if ftp.dsockConnected:
|
if ftp.dsockConnected:
|
||||||
if ftp.job.toStore.len() > 0:
|
if ftp.job.toStore.len() > 0:
|
||||||
assert(async)
|
assert(async)
|
||||||
let bytesSent = ftp.asyncDSock.sendAsync(ftp.job.toStore)
|
let bytesSent = ftp.dsock.sendAsync(ftp.job.toStore)
|
||||||
if bytesSent == ftp.job.toStore.len:
|
if bytesSent == ftp.job.toStore.len:
|
||||||
ftp.job.toStore = ""
|
ftp.job.toStore = ""
|
||||||
elif bytesSent != ftp.job.toStore.len and bytesSent != 0:
|
elif bytesSent != ftp.job.toStore.len and bytesSent != 0:
|
||||||
|
|
@ -490,7 +499,7 @@ proc doUpload(ftp: PFTPClient, async = false): bool =
|
||||||
setLen(s, len)
|
setLen(s, len)
|
||||||
if len == 0:
|
if len == 0:
|
||||||
# File finished uploading.
|
# File finished uploading.
|
||||||
if ftp.isAsync: ftp.asyncDSock.close() else: ftp.dsock.close()
|
ftp.dsock.close()
|
||||||
ftp.dsockConnected = false
|
ftp.dsockConnected = false
|
||||||
|
|
||||||
if not async:
|
if not async:
|
||||||
|
|
@ -501,7 +510,7 @@ proc doUpload(ftp: PFTPClient, async = false): bool =
|
||||||
if not async:
|
if not async:
|
||||||
getDSock(ftp).send(s)
|
getDSock(ftp).send(s)
|
||||||
else:
|
else:
|
||||||
let bytesSent = ftp.asyncDSock.sendAsync(s)
|
let bytesSent = ftp.dsock.sendAsync(s)
|
||||||
if bytesSent == 0:
|
if bytesSent == 0:
|
||||||
ftp.job.toStore.add(s)
|
ftp.job.toStore.add(s)
|
||||||
elif bytesSent != s.len:
|
elif bytesSent != s.len:
|
||||||
|
|
@ -511,14 +520,14 @@ proc doUpload(ftp: PFTPClient, async = false): bool =
|
||||||
ftp.job.progress.inc(len)
|
ftp.job.progress.inc(len)
|
||||||
ftp.job.oneSecond.inc(len)
|
ftp.job.oneSecond.inc(len)
|
||||||
|
|
||||||
proc store*(ftp: PFTPClient, file, dest: string, async = false) =
|
proc store*[T](ftp: FtpBase[T], file, dest: string, async = false) =
|
||||||
## Uploads ``file`` to ``dest`` on the remote FTP server. Usage of this
|
## Uploads ``file`` to ``dest`` on the remote FTP server. Usage of this
|
||||||
## function asynchronously is recommended to view the progress of
|
## function asynchronously is recommended to view the progress of
|
||||||
## the download.
|
## the download.
|
||||||
## The ``EvStore`` event is passed to the specified ``handleEvent`` function
|
## The ``EvStore`` event is passed to the specified ``handleEvent`` function
|
||||||
## when the upload is finished, and the ``filename`` field will be
|
## when the upload is finished, and the ``filename`` field will be
|
||||||
## equal to ``file``.
|
## equal to ``file``.
|
||||||
ftp.createJob(doUpload, JStore)
|
ftp.createJob(doUpload[T], JStore)
|
||||||
ftp.job.file = open(file)
|
ftp.job.file = open(file)
|
||||||
ftp.job.total = ftp.job.file.getFileSize()
|
ftp.job.total = ftp.job.file.getFileSize()
|
||||||
ftp.job.lastProgressReport = epochTime()
|
ftp.job.lastProgressReport = epochTime()
|
||||||
|
|
@ -531,16 +540,12 @@ proc store*(ftp: PFTPClient, file, dest: string, async = false) =
|
||||||
while not ftp.job.prc(ftp, false): discard
|
while not ftp.job.prc(ftp, false): discard
|
||||||
ftp.deleteJob()
|
ftp.deleteJob()
|
||||||
|
|
||||||
proc close*(ftp: PFTPClient) =
|
proc close*[T](ftp: FtpBase[T]) =
|
||||||
## Terminates the connection to the server.
|
## Terminates the connection to the server.
|
||||||
assertReply ftp.send("QUIT"), "221"
|
assertReply ftp.send("QUIT"), "221"
|
||||||
if ftp.jobInProgress: ftp.deleteJob()
|
if ftp.jobInProgress: ftp.deleteJob()
|
||||||
if ftp.isAsync:
|
ftp.csock.close()
|
||||||
ftp.asyncCSock.close()
|
ftp.dsock.close()
|
||||||
ftp.asyncDSock.close()
|
|
||||||
else:
|
|
||||||
ftp.csock.close()
|
|
||||||
ftp.dsock.close()
|
|
||||||
|
|
||||||
proc csockHandleRead(s: PAsyncSocket, ftp: PAsyncFTPClient) =
|
proc csockHandleRead(s: PAsyncSocket, ftp: PAsyncFTPClient) =
|
||||||
if ftp.jobInProgress:
|
if ftp.jobInProgress:
|
||||||
|
|
@ -571,36 +576,34 @@ proc asyncFTPClient*(address: string, port = TPort(21),
|
||||||
## Create a ``PAsyncFTPClient`` object.
|
## Create a ``PAsyncFTPClient`` object.
|
||||||
##
|
##
|
||||||
## Use this if you want to use asyncio's dispatcher.
|
## Use this if you want to use asyncio's dispatcher.
|
||||||
var dres: PAsyncFTPClient
|
var dres: AsyncFtpClient
|
||||||
new(dres)
|
new(dres)
|
||||||
dres.user = user
|
dres.user = user
|
||||||
dres.pass = pass
|
dres.pass = pass
|
||||||
dres.address = address
|
dres.address = address
|
||||||
dres.port = port
|
dres.port = port
|
||||||
dres.isAsync = true
|
|
||||||
dres.dsockConnected = false
|
dres.dsockConnected = false
|
||||||
dres.handleEvent = handleEvent
|
dres.handleEvent = handleEvent
|
||||||
dres.asyncCSock = AsyncSocket()
|
dres.csock = asyncSocket()
|
||||||
dres.asyncCSock.handleRead =
|
dres.csock.handleRead =
|
||||||
proc (s: PAsyncSocket) =
|
proc (s: AsyncSocket) =
|
||||||
csockHandleRead(s, dres)
|
csockHandleRead(s, dres)
|
||||||
result = dres
|
result = dres
|
||||||
|
|
||||||
proc register*(d: PDispatcher, ftp: PAsyncFTPClient): PDelegate {.discardable.} =
|
proc register*(d: PDispatcher, ftp: PAsyncFTPClient): PDelegate {.discardable.} =
|
||||||
## Registers ``ftp`` with dispatcher ``d``.
|
## Registers ``ftp`` with dispatcher ``d``.
|
||||||
assert ftp.isAsync
|
|
||||||
ftp.disp = d
|
ftp.disp = d
|
||||||
return ftp.disp.register(ftp.asyncCSock)
|
return ftp.disp.register(ftp.csock)
|
||||||
|
|
||||||
when isMainModule:
|
when isMainModule:
|
||||||
proc main =
|
proc main =
|
||||||
var d = newDispatcher()
|
var d = newDispatcher()
|
||||||
let hev =
|
let hev =
|
||||||
proc (ftp: PAsyncFTPClient, event: TFTPEvent) =
|
proc (ftp: AsyncFTPClient, event: FTPEvent) =
|
||||||
case event.typ
|
case event.typ
|
||||||
of EvStore:
|
of EvStore:
|
||||||
echo("Upload finished!")
|
echo("Upload finished!")
|
||||||
ftp.retrFile("payload.JPG", "payload2.JPG", async = true)
|
ftp.retrFile("payload.jpg", "payload2.jpg", async = true)
|
||||||
of EvTransferProgress:
|
of EvTransferProgress:
|
||||||
var time: int64 = -1
|
var time: int64 = -1
|
||||||
if event.speed != 0:
|
if event.speed != 0:
|
||||||
|
|
@ -615,13 +618,13 @@ when isMainModule:
|
||||||
ftp.close()
|
ftp.close()
|
||||||
echo d.len
|
echo d.len
|
||||||
else: assert(false)
|
else: assert(false)
|
||||||
var ftp = asyncFTPClient("picheta.me", user = "test", pass = "asf", handleEvent = hev)
|
var ftp = asyncFTPClient("example.com", user = "foo", pass = "bar", handleEvent = hev)
|
||||||
|
|
||||||
d.register(ftp)
|
d.register(ftp)
|
||||||
d.len.echo()
|
d.len.echo()
|
||||||
ftp.connect()
|
ftp.connect()
|
||||||
echo "connected"
|
echo "connected"
|
||||||
ftp.store("payload.JPG", "payload.JPG", async = true)
|
ftp.store("payload.jpg", "payload.jpg", async = true)
|
||||||
d.len.echo()
|
d.len.echo()
|
||||||
echo "uploading..."
|
echo "uploading..."
|
||||||
while true:
|
while true:
|
||||||
|
|
@ -629,15 +632,15 @@ when isMainModule:
|
||||||
main()
|
main()
|
||||||
|
|
||||||
when isMainModule and false:
|
when isMainModule and false:
|
||||||
var ftp = ftpClient("picheta.me", user = "asdasd", pass = "asfwq")
|
var ftp = ftpClient("example.com", user = "foo", pass = "bar")
|
||||||
ftp.connect()
|
ftp.connect()
|
||||||
echo ftp.pwd()
|
echo ftp.pwd()
|
||||||
echo ftp.list()
|
echo ftp.list()
|
||||||
echo("uploading")
|
echo("uploading")
|
||||||
ftp.store("payload.JPG", "payload.JPG", async = false)
|
ftp.store("payload.jpg", "payload.jpg", async = false)
|
||||||
|
|
||||||
echo("Upload complete")
|
echo("Upload complete")
|
||||||
ftp.retrFile("payload.JPG", "payload2.JPG", async = false)
|
ftp.retrFile("payload.jpg", "payload2.jpg", async = false)
|
||||||
|
|
||||||
echo("Download complete")
|
echo("Download complete")
|
||||||
sleep(5000)
|
sleep(5000)
|
||||||
|
|
|
||||||
|
|
@ -662,8 +662,7 @@ when isMainModule:
|
||||||
resp = await client.request("http://nim-lang.org/download.html")
|
resp = await client.request("http://nim-lang.org/download.html")
|
||||||
echo("Got response: ", resp.status)
|
echo("Got response: ", resp.status)
|
||||||
|
|
||||||
asyncCheck main()
|
waitFor main()
|
||||||
runForever()
|
|
||||||
|
|
||||||
else:
|
else:
|
||||||
#downloadFile("http://force7.de/nim/index.html", "nimindex.html")
|
#downloadFile("http://force7.de/nim/index.html", "nimindex.html")
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue