|
|
import os.path
|
|
|
import ftplib
|
|
|
|
|
|
|
|
|
class Ftp():
|
|
|
"""
|
|
|
Ftp is a public class used to define custom File Transfer Protocol from "ftplib" python module
|
|
|
|
|
|
Non-standard Python modules used: None
|
|
|
|
|
|
Written by "Daniel Suarez":mailto:daniel.suarez@jro.igp.gob.pe Oct. 26, 2010
|
|
|
"""
|
|
|
|
|
|
def __init__(self,host = None, username=None, passw=None, remotefolder=None):
|
|
|
"""
|
|
|
This method is used to setting parameters for FTP and establishing connection to remote host
|
|
|
|
|
|
Inputs:
|
|
|
host - remote host IP Address
|
|
|
|
|
|
username - remote host Username
|
|
|
|
|
|
passw - remote host Passw
|
|
|
|
|
|
remotefolder - remote host current working directory
|
|
|
|
|
|
Return: void
|
|
|
|
|
|
Affects:
|
|
|
self.status - in Error Case or Connection Failed this parameter is set to 1 else 0
|
|
|
|
|
|
self.folderList - sub-folder list of remote folder
|
|
|
|
|
|
self.fileList - file list of remote folder
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
|
if ((host == None) and (username==None) and (passw==None) and (remotefolder==None)):
|
|
|
host, username, passw, remotefolder = self.parmsByDefault()
|
|
|
|
|
|
self.host = host
|
|
|
self.username = username
|
|
|
self.passw = passw
|
|
|
self.remotefolder = remotefolder
|
|
|
self.file = None
|
|
|
self.ftp = None
|
|
|
self.status = 0
|
|
|
|
|
|
try:
|
|
|
self.ftp = ftplib.FTP(self.host)
|
|
|
self.ftp.login(self.username,self.passw)
|
|
|
self.ftp.cwd(self.remotefolder)
|
|
|
# print 'Connect to FTP Server: Successfully'
|
|
|
|
|
|
except ftplib.all_errors:
|
|
|
print 'Error FTP Service'
|
|
|
self.status = 1
|
|
|
return
|
|
|
|
|
|
|
|
|
|
|
|
self.dirList = []
|
|
|
|
|
|
try:
|
|
|
self.dirList = self.ftp.nlst()
|
|
|
|
|
|
except ftplib.error_perm, resp:
|
|
|
if str(resp) == "550 No files found":
|
|
|
print "no files in this directory"
|
|
|
self.status = 1
|
|
|
return
|
|
|
|
|
|
except ftplib.all_errors:
|
|
|
print 'Error Displaying Dir-Files'
|
|
|
self.status = 1
|
|
|
return
|
|
|
|
|
|
self.fileList = []
|
|
|
self.folderList = []
|
|
|
#only for test
|
|
|
for f in self.dirList:
|
|
|
name, ext = os.path.splitext(f)
|
|
|
if ext != '':
|
|
|
self.fileList.append(f)
|
|
|
# print 'filename: %s - size: %d'%(f,self.ftp.size(f))
|
|
|
|
|
|
def parmsByDefault(self):
|
|
|
host = 'jro.igp.gob.pe'
|
|
|
username = 'operaciones'
|
|
|
passw = 'mst98vhf'
|
|
|
remotefolder = '/users/database/on-line/'
|
|
|
|
|
|
return host, username, passw, remotefolder
|
|
|
|
|
|
|
|
|
def mkd(self,dirname):
|
|
|
"""
|
|
|
mkd is used to make directory in remote host
|
|
|
|
|
|
Input:
|
|
|
dirname - directory name
|
|
|
|
|
|
Return:
|
|
|
1 in error case else 0
|
|
|
"""
|
|
|
try:
|
|
|
self.ftp.mkd(dirname)
|
|
|
except:
|
|
|
print 'Error creating remote folder:%s'%dirname
|
|
|
return 1
|
|
|
|
|
|
return 0
|
|
|
|
|
|
|
|
|
def delete(self,filename):
|
|
|
"""
|
|
|
delete is used to delete file in current working directory of remote host
|
|
|
|
|
|
Input:
|
|
|
filename - filename to delete in remote folder
|
|
|
|
|
|
Return:
|
|
|
1 in error case else 0
|
|
|
"""
|
|
|
|
|
|
try:
|
|
|
self.ftp.delete(filename)
|
|
|
except:
|
|
|
print 'Error deleting remote file:%s'%filename
|
|
|
return 1
|
|
|
|
|
|
return 0
|
|
|
|
|
|
def download(self,filename,localfolder):
|
|
|
"""
|
|
|
download is used to downloading file from remote folder into local folder
|
|
|
|
|
|
Inputs:
|
|
|
filename - filename to donwload
|
|
|
|
|
|
localfolder - directory local to store filename
|
|
|
|
|
|
Returns:
|
|
|
self.status - 1 in error case else 0
|
|
|
"""
|
|
|
|
|
|
self.status = 0
|
|
|
|
|
|
|
|
|
if not(filename in self.fileList):
|
|
|
print 'filename:%s not exists'%filename
|
|
|
self.status = 1
|
|
|
return self.status
|
|
|
|
|
|
newfilename = os.path.join(localfolder,filename)
|
|
|
|
|
|
self.file = open(newfilename, 'wb')
|
|
|
|
|
|
try:
|
|
|
print 'Download: ' + filename
|
|
|
self.ftp.retrbinary('RETR ' + filename, self.__handleDownload)
|
|
|
print 'Download Complete'
|
|
|
except ftplib.all_errors:
|
|
|
print 'Error Downloading ' + filename
|
|
|
self.status = 1
|
|
|
return self.status
|
|
|
|
|
|
self.file.close()
|
|
|
|
|
|
return self.status
|
|
|
|
|
|
|
|
|
def __handleDownload(self,block):
|
|
|
"""
|
|
|
__handleDownload is used to handle writing file
|
|
|
"""
|
|
|
self.file.write(block)
|
|
|
|
|
|
|
|
|
def upload(self,filename,remotefolder=None):
|
|
|
"""
|
|
|
upload is used to uploading local file to remote directory
|
|
|
|
|
|
Inputs:
|
|
|
filename - full path name of local file to store in remote directory
|
|
|
|
|
|
remotefolder - remote directory
|
|
|
|
|
|
Returns:
|
|
|
self.status - 1 in error case else 0
|
|
|
"""
|
|
|
|
|
|
if remotefolder == None:
|
|
|
remotefolder = self.remotefolder
|
|
|
|
|
|
self.status = 0
|
|
|
|
|
|
try:
|
|
|
self.ftp.cwd(remotefolder)
|
|
|
|
|
|
self.file = open(filename, 'rb')
|
|
|
|
|
|
(head, tail) = os.path.split(filename)
|
|
|
|
|
|
command = "STOR " + tail
|
|
|
|
|
|
print 'Uploading: ' + tail
|
|
|
self.ftp.storbinary(command, self.file)
|
|
|
print 'Upload Completed'
|
|
|
|
|
|
except ftplib.all_errors:
|
|
|
print 'Error Uploading ' + tail
|
|
|
self.status = 1
|
|
|
return self.status
|
|
|
|
|
|
self.file.close()
|
|
|
|
|
|
#back to initial directory in __init__()
|
|
|
self.ftp.cwd(self.remotefolder)
|
|
|
|
|
|
return self.status
|
|
|
|
|
|
|
|
|
def dir(self,remotefolder):
|
|
|
"""
|
|
|
dir is used to change working directory of remote host and get folder and file list
|
|
|
|
|
|
Input:
|
|
|
remotefolder - current working directory
|
|
|
|
|
|
Affects:
|
|
|
self.fileList - file list of working directory
|
|
|
|
|
|
Return:
|
|
|
infoList - list with filenames and size of file in bytes
|
|
|
|
|
|
self.folderList - folder list
|
|
|
"""
|
|
|
|
|
|
self.remotefolder = remotefolder
|
|
|
print 'Change to ' + self.remotefolder
|
|
|
try:
|
|
|
self.ftp.cwd(remotefolder)
|
|
|
except ftplib.all_errors:
|
|
|
print 'Error Change to ' + self.remotefolder
|
|
|
infoList = None
|
|
|
self.folderList = None
|
|
|
return infoList,self.folderList
|
|
|
|
|
|
self.dirList = []
|
|
|
|
|
|
try:
|
|
|
self.dirList = self.ftp.nlst()
|
|
|
|
|
|
except ftplib.error_perm, resp:
|
|
|
if str(resp) == "550 No files found":
|
|
|
print "no files in this directory"
|
|
|
infoList = None
|
|
|
self.folderList = None
|
|
|
return infoList,self.folderList
|
|
|
except ftplib.all_errors:
|
|
|
print 'Error Displaying Dir-Files'
|
|
|
infoList = None
|
|
|
self.folderList = None
|
|
|
return infoList,self.folderList
|
|
|
|
|
|
infoList = []
|
|
|
self.fileList = []
|
|
|
self.folderList = []
|
|
|
for f in self.dirList:
|
|
|
name,ext = os.path.splitext(f)
|
|
|
if ext != '':
|
|
|
self.fileList.append(f)
|
|
|
value = (f,self.ftp.size(f))
|
|
|
infoList.append(value)
|
|
|
|
|
|
if ext == '':
|
|
|
self.folderList.append(f)
|
|
|
|
|
|
return infoList,self.folderList
|
|
|
|
|
|
|
|
|
def close(self):
|
|
|
"""
|
|
|
close is used to close and end FTP connection
|
|
|
|
|
|
Inputs: None
|
|
|
|
|
|
Return: void
|
|
|
|
|
|
"""
|
|
|
self.ftp.close()
|
