eric: comparison src/eric7/EricNetwork/EricFtp.py

-:e9e7eca7efee
+:bf71ee032bb4
 Module implementing an extension to the Python FTP class to support FTP
 proxies.
 """
 import enum
-import ftplib           # secok
+import ftplib  # secok
 from socket import _GLOBAL_DEFAULT_TIMEOUT
 class EricFtpProxyError(ftplib.Error):
 """
 Class to signal an error related to proxy configuration.
 The error message starts with a three digit error code followed by a
 space and the error string. Supported error codes are:
 <ul>
 <li>910: proxy error; the second number gives the category of the proxy
 error. The original response from the proxy is appended in the next
 <li>990: proxy usage is enabled but no proxy host given</li>
 <li>991: proxy usage is enabled but no proxy user given</li>
 <li>992: proxy usage is enabled but no proxy password given</li>
 </ul>
 """
 pass
 class EricFtpProxyType(enum.Enum):
 """
 Class defining the supported FTP proxy types.
 """
-NO_PROXY = 0                    # no proxy
-NON_AUTHORIZING = 1             # non authorizing proxy
+NO_PROXY = 0  # no proxy
-USER_SERVER = 2                 # proxy login first, than user@remote.host
+NON_AUTHORIZING = 1  # non authorizing proxy
-SITE = 3                        # proxy login first, than use SITE command
+USER_SERVER = 2  # proxy login first, than user@remote.host
-OPEN = 4                        # proxy login first, than use OPEN command
+SITE = 3  # proxy login first, than use SITE command
-USER_PROXYUSER_SERVER = 5       # one login for both
+OPEN = 4  # proxy login first, than use OPEN command
+USER_PROXYUSER_SERVER = 5  # one login for both
 PROXYUSER_SERVER = 6
 # proxy login with remote host given, than normal remote login
 AUTH_RESP = 7  # authenticate to proxy with AUTH and RESP commands
-BLUECOAT = 8                    # bluecoat proxy
+BLUECOAT = 8  # bluecoat proxy
 class EricFtp(ftplib.FTP):
 """
 Class implementing an extension to the Python FTP class to support FTP
 proxies.
 """
-def __init__(self, host="", user="", password="", acct="",          # secok
-proxyType=EricFtpProxyType.NO_PROXY, proxyHost="",
+def __init__(
-proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="",
+self,
-proxyAccount="", timeout=_GLOBAL_DEFAULT_TIMEOUT):
+host="",
+user="",
+password="",
+acct="",  # secok
+proxyType=EricFtpProxyType.NO_PROXY,
+proxyHost="",
+proxyPort=ftplib.FTP_PORT,
+proxyUser="",
+proxyPassword="",
+proxyAccount="",
+timeout=_GLOBAL_DEFAULT_TIMEOUT,
+):
 """
 Constructor
 @param host name of the FTP host
 @type str
 @param user user name for login to FTP host
 @type str
 @param password password for login to FTP host
 @type str
 @param timeout timeout in seconds for blocking operations
 @type int
 """
 super().__init__()
 self.__timeout = timeout
 self.__proxyType = proxyType
 self.__proxyHost = proxyHost
 self.__proxyPort = proxyPort
 self.__proxyUser = proxyUser
 self.__proxyPassword = proxyPassword
 self.__proxyAccount = proxyAccount
 self.__host = host
 self.__port = ftplib.FTP_PORT
 self.__user = user
 self.__password = password
 self.__acct = acct
 if host:
 self.connect(host)
 if user:
 self.login(user, password, acct)
-def setProxy(self, proxyType=EricFtpProxyType.NO_PROXY, proxyHost="",
+def setProxy(
-proxyPort=ftplib.FTP_PORT, proxyUser="", proxyPassword="",
+self,
-proxyAccount=""):
+proxyType=EricFtpProxyType.NO_PROXY,
+proxyHost="",
+proxyPort=ftplib.FTP_PORT,
+proxyUser="",
+proxyPassword="",
+proxyAccount="",
+):
 """
 Public method to set the proxy configuration.
 @param proxyType type of the FTP proxy
 @type EricFtpProxyType
 @param proxyHost name of the FTP proxy
 @type str
 @param proxyPort port of the FTP proxy
 self.__proxyHost = proxyHost
 self.__proxyPort = proxyPort
 self.__proxyUser = proxyUser
 self.__proxyPassword = proxyPassword
 self.__proxyAccount = proxyAccount
-def setProxyAuthentication(self, proxyUser="", proxyPassword="",
+def setProxyAuthentication(self, proxyUser="", proxyPassword="", proxyAccount=""):
-proxyAccount=""):
 """
 Public method to set the proxy authentication info.
 @param proxyUser user name for login to the proxy
 @type str
 @param proxyPassword password  for login to the proxy
 @type str
 @param proxyAccount accounting info for the proxy
 @type str
 """
 self.__proxyUser = proxyUser
 self.__proxyPassword = proxyPassword
 self.__proxyAccount = proxyAccount
 def connect(self, host="", port=0, timeout=-999):
 """
 Public method to connect to the given FTP server.
 This extended method connects to the proxy instead of the given host,
 if a proxy is to be used. It throws an exception, if the proxy data
 is incomplete.
 @param host name of the FTP host
 @type str
 @param port port of the FTP host
 @type int
 @param timeout timeout in seconds for blocking operations
 self.__host = host
 if port:
 self.__port = port
 if timeout != -999:
 self.__timeout = timeout
 if self.__proxyType != EricFtpProxyType.NO_PROXY:
 if not self.__proxyHost:
 raise EricFtpProxyError(
-"990 Proxy usage requested, but no proxy host given.")
+"990 Proxy usage requested, but no proxy host given."
+)
-return super().connect(
-self.__proxyHost, self.__proxyPort, self.__timeout)
+return super().connect(self.__proxyHost, self.__proxyPort, self.__timeout)
 else:
-return super().connect(
+return super().connect(self.__host, self.__port, self.__timeout)
-self.__host, self.__port, self.__timeout)
+def login(self, user="", password="", acct=""):  # secok
-def login(self, user="", password="", acct=""):         # secok
 """
 Public method to login to the FTP server.
 This extended method respects the FTP proxy configuration. There are
 many different FTP proxy products available. But unfortunately there
 is no standard for how o traverse a FTP proxy. The lis below shows
 the sequence of commands used.
 <table>
 <tr><td>user</td><td>Username for remote host</td></tr>
 <tr><td>pass</td><td>Password for remote host</td></tr>
 <tr><td>pruser</td><td>Username for FTP proxy</td></tr>
 <tr><td>prpass</td><td>Password for FTP proxy</td></tr>
 <tr><td>remote.host</td><td>Hostname of the remote FTP server</td>
 </tr>
 </table>
 <dl>
 <dt>EricFtpProxyType.NO_PROXY:</dt>
 <dd>
 USER user<br/>
 PASS pass
 USER user@remote.host pruser<br/>
 PASS pass<br/>
 ACCT prpass
 </dd>
 </dl>
 @param user username for the remote host
 @type str
 @param password password for the remote host
 @type str
 @param acct accounting information for the remote host
 """
 if not user:
 user = "anonymous"
 if not password:
 # make sure it is a string
-password = ""           # secok
+password = ""  # secok
 if not acct:
 # make sure it is a string
 acct = ""
-if user == "anonymous" and password in {'', '-'}:
+if user == "anonymous" and password in {"", "-"}:
 password += "anonymous@"
 if self.__proxyType != EricFtpProxyType.NO_PROXY:
 if self.__proxyType != EricFtpProxyType.NON_AUTHORIZING:
 # check, if a valid proxy configuration is known
 if not self.__proxyUser:
 raise EricFtpProxyError(
-"991 Proxy usage requested, but no proxy user given")
+"991 Proxy usage requested, but no proxy user given"
+)
 if not self.__proxyPassword:
 raise EricFtpProxyError(
-"992 Proxy usage requested, but no proxy password"
+"992 Proxy usage requested, but no proxy password" " given"
-" given")
+)
-if self.__proxyType in [EricFtpProxyType.NON_AUTHORIZING,
+if self.__proxyType in [
-EricFtpProxyType.AUTH_RESP,
+EricFtpProxyType.NON_AUTHORIZING,
-EricFtpProxyType.BLUECOAT]:
+EricFtpProxyType.AUTH_RESP,
+EricFtpProxyType.BLUECOAT,
+]:
 user += "@" + self.__host
 if self.__proxyType == EricFtpProxyType.BLUECOAT:
 user += " " + self.__proxyUser
 acct = self.__proxyPassword
 elif self.__proxyType == EricFtpProxyType.USER_PROXYUSER_SERVER:
-user = "{0}@{1}@{2}".format(
+user = "{0}@{1}@{2}".format(user, self.__proxyUser, self.__host)
-user, self.__proxyUser, self.__host)
 password = "{0}@{1}".format(password, self.__proxyPassword)
 else:
 pruser = self.__proxyUser
 if self.__proxyType == EricFtpProxyType.USER_SERVER:
 user += "@" + self.__host
 elif self.__proxyType == EricFtpProxyType.PROXYUSER_SERVER:
 pruser += "@" + self.__host
 # authenticate to the proxy first
 presp = self.sendcmd("USER " + pruser)
 if presp[0] == "3":
 presp = self.sendcmd("PASS " + self.__proxyPassword)
 if presp[0] == "3" and self.__proxyAccount:
 presp = self.sendcmd("ACCT " + self.__proxyAccount)
 if presp[0] != "2":
 raise EricFtpProxyError(
-"9{0}0 Error authorizing at proxy\n{1}".format(
+"9{0}0 Error authorizing at proxy\n{1}".format(presp[0], presp)
-presp[0], presp))
+)
 if self.__proxyType == EricFtpProxyType.SITE:
 # send SITE command
 presp = self.sendcmd("SITE " + self.__host)
 if presp[0] != "2":
 raise EricFtpProxyError(
 "9{0}0 Error sending SITE command\n{1}".format(
-presp[0], presp))
+presp[0], presp
+)
+)
 elif self.__proxyType == EricFtpProxyType.OPEN:
 # send OPEN command
 presp = self.sendcmd("OPEN " + self.__host)
 if presp[0] != "2":
 raise EricFtpProxyError(
 "9{0}0 Error sending OPEN command\n{1}".format(
-presp[0], presp))
+presp[0], presp
+)
+)
 # authenticate to the remote host or combined to proxy and remote host
 resp = self.sendcmd("USER " + user)
 if resp[0] == "3":
 resp = self.sendcmd("PASS " + password)
 if resp[0] == "3":
 resp = self.sendcmd("ACCT " + acct)
 if resp[0] != "2":
-raise ftplib.error_reply(resp)          # secok
+raise ftplib.error_reply(resp)  # secok
 if self.__proxyType == EricFtpProxyType.AUTH_RESP:
 # authorize to the FTP proxy
 presp = self.sendcmd("AUTH " + self.__proxyUser)
 if presp[0] == "3":
 presp = self.sendcmd("RESP " + self.__proxyPassword)
 if presp[0] != "2":
 raise EricFtpProxyError(
-"9{0}0 Error authorizing at proxy\n{1}".format(
+"9{0}0 Error authorizing at proxy\n{1}".format(presp[0], presp)
-presp[0], presp))
+)
 return resp

Mercurial Repositories > eric / file comparison

comparison: src/eric7/EricNetwork/EricFtp.py

src/eric7/EricNetwork/EricFtp.py