mirror of
https://github.com/codex-storage/deluge.git
synced 2025-01-10 19:46:22 +00:00
123 lines
4.7 KiB
Python
123 lines
4.7 KiB
Python
#
|
|
# httpdownloader.py
|
|
#
|
|
# Copyright (C) 2009 Andrew Resch <andrewresch@gmail.com>
|
|
#
|
|
# Deluge is free software.
|
|
#
|
|
# You may redistribute it and/or modify it under the terms of the
|
|
# GNU General Public License, as published by the Free Software
|
|
# Foundation; either version 3 of the License, or (at your option)
|
|
# any later version.
|
|
#
|
|
# deluge is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
# See the GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with deluge. If not, write to:
|
|
# The Free Software Foundation, Inc.,
|
|
# 51 Franklin Street, Fifth Floor
|
|
# Boston, MA 02110-1301, USA.
|
|
#
|
|
# In addition, as a special exception, the copyright holders give
|
|
# permission to link the code of portions of this program with the OpenSSL
|
|
# library.
|
|
# You must obey the GNU General Public License in all respects for all of
|
|
# the code used other than OpenSSL. If you modify file(s) with this
|
|
# exception, you may extend this exception to your version of the file(s),
|
|
# but you are not obligated to do so. If you do not wish to do so, delete
|
|
# this exception statement from your version. If you delete this exception
|
|
# statement from all source files in the program, then also delete it here.
|
|
#
|
|
|
|
from twisted.web import client, http
|
|
from twisted.web.error import PageRedirect
|
|
from twisted.python.failure import Failure
|
|
from twisted.internet import reactor
|
|
|
|
class HTTPDownloader(client.HTTPDownloader):
|
|
"""
|
|
Factory class for downloading files and keeping track of progress.
|
|
"""
|
|
def __init__(self, url, filename, part_callback=None, headers=None):
|
|
"""
|
|
:param url: the url to download from
|
|
:type url: string
|
|
:param filename: the filename to save the file as
|
|
:type filename: string
|
|
:param part_callback: a function to be called when a part of data
|
|
is received, it's signature should be: func(data, current_length, total_length)
|
|
:type part_callback: function
|
|
:param headers: any optional headers to send
|
|
:type headers: dictionary
|
|
"""
|
|
self.__part_callback = part_callback
|
|
self.current_length = 0
|
|
self.value = filename
|
|
client.HTTPDownloader.__init__(self, url, filename, headers=headers)
|
|
|
|
def gotStatus(self, version, status, message):
|
|
self.code = int(status)
|
|
client.HTTPDownloader.gotStatus(self, version, status, message)
|
|
|
|
def gotHeaders(self, headers):
|
|
if self.code == http.OK:
|
|
if "content-length" in headers:
|
|
self.total_length = int(headers["content-length"][0])
|
|
else:
|
|
self.total_length = 0
|
|
elif self.code in (http.TEMPORARY_REDIRECT, http.MOVED_PERMANENTLY):
|
|
location = headers["location"][0]
|
|
error = PageRedirect(self.code, location=location)
|
|
self.noPage(Failure(error))
|
|
|
|
return client.HTTPDownloader.gotHeaders(self, headers)
|
|
|
|
def pagePart(self, data):
|
|
if self.code == http.OK:
|
|
self.current_length += len(data)
|
|
if self.__part_callback:
|
|
self.__part_callback(data, self.current_length, self.total_length)
|
|
|
|
return client.HTTPDownloader.pagePart(self, data)
|
|
|
|
def download_file(url, filename, callback=None, headers=None):
|
|
"""
|
|
Downloads a file from a specific URL and returns a Deferred. You can also
|
|
specify a callback function to be called as parts are received.
|
|
|
|
:param url: the url to download from
|
|
:type url: string
|
|
:param filename: the filename to save the file as
|
|
:type filename: string
|
|
:param callback: a function to be called when a part of data is received,
|
|
it's signature should be: func(data, current_length, total_length)
|
|
:type callback: function
|
|
:param headers: any optional headers to send
|
|
:type headers: dictionary
|
|
|
|
:returns: the filename of the downloaded file
|
|
:rtype: Deferred
|
|
|
|
:raises t.w.e.PageRedirect: when server responds with a temporary redirect
|
|
or permanently moved.
|
|
:raises t.w.e.Error: for all other HTTP response errors (besides OK)
|
|
"""
|
|
url = str(url)
|
|
filename = str(filename)
|
|
if headers:
|
|
for key, value in headers.items():
|
|
headers[str(key)] = str(value)
|
|
|
|
scheme, host, port, path = client._parse(url)
|
|
factory = HTTPDownloader(url, filename, callback, headers)
|
|
if scheme == "https":
|
|
from twisted.internet import ssl
|
|
reactor.connectSSL(host, port, factory, ssl.ClientContextFactory())
|
|
else:
|
|
reactor.connectTCP(host, port, factory)
|
|
|
|
return factory.deferred
|