iT邦幫忙

2021 iThome 鐵人賽

DAY 24
0
自我挑戰組

實驗室助理的技術文章自我整理系列 第 24

Python - Python SimpleHTTPServerWithUpload 參考筆記

  • 分享至 

  • xImage
  •  

Python - Python SimpleHTTPServerWithUpload 參考筆記

參考資料

設計思路參考:

參考的程式碼來源:

說明

如題,當初會撰寫這篇參考筆記,主要是因為,之前有練習過 Python Django 的網頁框架,於是乎,就想到了,能不能夠單純只用 python 來設計一個簡單的本地網頁檔案伺服器,所以就在 google 搜尋相關的資料之後,還真的有找到類似的模組w,所以就在實際測試完畢之後,把操作過程保留下來了XD。

特此撰寫本篇文章作為紀錄文件,用以方便後續有需要的時候,可以快速的重複查閱,雖然後面比較沒有什麼機會再用到,但也算是一個還不錯的經驗。

簡介

用 Python 的 SimpleHTTPServer 模組來建立一個簡單的臨時網頁伺服器(Web Server)包含檔案上傳功能,上傳的檔案會顯示在網頁上。

操作介紹

執行程式,指令如下:

py fileuploadtest.py

如下圖所示:

可以用網址: http://localhost:8000/ 或是 http://127.0.0.1:8000/ 來訪問網頁,如下圖所示:

然後就可以看到資料夾內放的一些檔案,也可以上傳其他檔案到 fileuploadtest.py 檔案所在的資料夾。

完整程式碼

建議程式檔案可取名為:fileuploadtest.py,取其他名字也可,EX:XXX.py

完整程式碼,如下所示:

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Simple HTTP Server With Upload based on python3.
Python2-Version by [bones7456] and [BUPTGuo]:
	This module builds on BaseHTTPServer by implementing the standard GET and HEAD requests in a fairly straightforward manner.
Python3-Version by [FrozenMap]:
	Based on the new features in python3, this module is built on [http.server] by rewriting some implementations of do_GET, do_HEAD and do_POST and other functions in Python2-Version.
20181029 Update:
With the help of [a.7], we can now upload multiple files together, rather than one file at a time
More details can be found on the blog with the link below:
https://jjayyyyyyy.github.io/2016/10/07/reWrite_SimpleHTTPServerWithUpload_with_python3.html
"""

__version__ = "0.4"
__all__ = ["SimpleHTTPRequestHandler"]
__author__ = "bones7456, BUPTGuo, FrozenMap, a.7"
__home_page__ = "http://luy.li/, http://buptguo.com, https://jjayyyyyyy.github.io"


import os
import posixpath
import http.server
import urllib
import cgi
import shutil
import mimetypes
import re

class SimpleHTTPRequestHandler(http.server.BaseHTTPRequestHandler):

	"""Simple HTTP request handler with GET/HEAD/POST commands.
	This serves files from the current directory and any of its
	subdirectories.  The MIME type for files is determined by
	calling the .guess_type() method. And can reveive file uploaded
	by client.
	The GET/HEAD/POST requests are identical except that the HEAD
	request omits the actual contents of the file.
	"""

	server_version = "SimpleHTTPWithUpload/" + __version__

	def do_GET(self):
		"""Serve a GET request."""
		f = self.send_head()
		if f:
			self.wfile.write(f)

	def do_HEAD(self):
		"""Serve a HEAD request."""
		f = self.send_head()

	def do_POST(self):
		"""Serve a POST request."""
		r, info = self.deal_post_data()

		print(info)
		print("uploaded by:", self.client_address)
		info = info.replace('\n', '<br>')
		f = ('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">') +\
			('<html><head>') +\
			('<meta http-equiv="Content-Type" content="text/html; charset=utf-8">') +\
			('<title>Upload Result Page</title>') +\
			('</head><body>') +\
			('<h1>Upload Result Page</h1>') +\
			('<hr>')
		if r:
			f = f + ('<strong>Success:<strong><br/>') + info
		else:
			f = f + ('<strong>Failed:<strong>') + info
		f = f + '<br><a href="%s">back</a>' % self.headers['referer'] +\
			'</body></html>'

		f = f.encode('utf-8')
		length = len(f)
		self.send_response(200)
		self.send_header("Content-type", "text/html")
		self.send_header("Content-Length", str(length))
		self.end_headers()
		self.wfile.write(f)


	'''
	POST data
	------WebKitFormBoundaryLVlRNkjiiJLtNYQE
	Content-Disposition: form-data; name="file"; filename="file1.txt"
	Content-Type: text/plain
	content in file1
	hello file1
	------WebKitFormBoundaryLVlRNkjiiJLtNYQE
	Content-Disposition: form-data; name="file"; filename="file2.txt"
	Content-Type: text/plain
	content in file2
	hello file2
	------WebKitFormBoundaryLVlRNkjiiJLtNYQE--
	'''
	def deal_post_data(self):
		boundary = self.headers["Content-Type"].split("=")[1]

		boundary_begin = ('--' + boundary + '\r\n').encode('utf-8')
		boundary_end = ('--' + boundary + '--\r\n').encode('utf-8')

		return_status = True
		return_info = '\n'
		outer = 1
		inner = 2
		leave = 3
		loop_info = outer # 1: outer loop, 2: inner_loop, 3: leave and return

		# first line
		# b'------WebKitFormBoundaryLVlRNkjiiJLtNYQE'
		line = self.rfile.readline()

		while loop_info == outer:
			# print(line)
			line = line
			if line != boundary_begin:
				return_status = False
				return_info += "Content NOT begin with boundary\n"
				break

			# get filename
			# b'Content-Disposition: form-data; name="file"; filename="file1.txt"'
			line = self.rfile.readline().decode('utf-8').rstrip('\r\n')
			# print(line)
			filename = re.findall(r'filename="(.*)"', line)[0]
			# print(filename)
			if not filename:
				return_status = False
				return_info += "Can't find out file name...\n"
				loop_info = leave
				break
			path = self.translate_path(self.path)
			filename = os.path.join(path, filename)
			# if filename alread exists
			if os.path.exists(filename):
				filename += "_copy"

			# second line
			# b'Content-Type: text/plain'
			line = self.rfile.readline()
			# print(line)

			# blank line
			line = self.rfile.readline()
			# print(line)

			loop_info = inner
			# POST data
			try:
				with open(filename, 'wb') as f:
					while loop_info == inner:
						line = self.rfile.readline()
						# print(line)
						if line == boundary_begin:
							loop_info = outer
							# print('out')
							break
						elif line == boundary_end:
							# print('leave')
							loop_info = leave
							break
						else:
							# line 还是二进制形式, realine() 不会删掉二进制的'\n'
							f.write(line)
			except Exception as e:
				loop_info = leave
				return_status = False
				return_info += 'Exception!\n'
			return_info += filename + '\n'
		return (return_status, return_info)

	def send_head(self):
		"""Common code for GET and HEAD commands.
		This sends the response code and MIME headers.
		Return value is either a file object (which has to be copied
		to the outputfile by the caller unless the command was HEAD,
		and must be closed by the caller under all circumstances), or
		None, in which case the caller has nothing further to do.
		"""
		path = self.translate_path(self.path)
		f = None
		if os.path.isdir(path):
			if not self.path.endswith('/'):
				# redirect browser - doing basically what apache does
				self.send_response(301)
				self.send_header("Location", self.path + "/")
				self.end_headers()
				return None
			for index in "index.html", "index.htm":
				index = os.path.join(path, index)
				if os.path.exists(index):
					path = index
					break
			else:
				return self.list_directory(path)
		ctype = self.guess_type(path)
		try:
			# Always read in binary mode. Opening files in text mode may cause
			# newline translations, making the actual size of the content
			# transmitted *less* than the content-length!
			f = open(path, 'rb')
		except IOError:
			self.send_error(404, "File not found")
			return None
		self.send_response(200)
		self.send_header("Content-type", ctype)
		fs = os.fstat(f.fileno())
		self.send_header("Content-Length", str(fs[6]))
		self.send_header("Last-Modified", self.date_time_string(fs.st_mtime))
		self.end_headers()
		data = f.read()
		f.close()

		return data

	def list_directory(self, path):
		"""Helper to produce a directory listing (absent index.html).
		Return value is either a file object, or None (indicating an
		error).  In either case, the headers are sent, making the
		interface the same as for send_head().
		"""
		try:
			list = os.listdir(path)
		except os.error:
			self.send_error(404, "No permission to list directory")
			return None
		list.sort(key=lambda a: a.lower())
		displaypath = cgi.escape(urllib.parse.unquote(self.path))

		f = ('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">') +\
			('<html><head>') +\
			('<meta http-equiv="Content-Type" content="text/html; charset=utf-8">') +\
			('<title>Directory listing for %s</title>' % displaypath) +\
			('</head><body>') +\
			('<h1>Directory listing for %s</h1>' % displaypath) +\
			('<form ENCTYPE="multipart/form-data" method="post">') +\
			('<input name="file" type="file" multiple="multiple"/>') +\
			('<input type="submit" value="upload"/></form>') +\
			('<hr><ul>')

		for name in list:
			fullname = os.path.join(path, name)
			displayname = linkname = name
			# Append / for directories or @ for symbolic links
			if os.path.isdir(fullname):
				displayname = name + "/"
				linkname = name + "/"
			if os.path.islink(fullname):
				displayname = name + "@"
				# Note: a link to a directory displays with @ and links with /
			f = f + ('<li><a href="%s">%s</a>' % (urllib.parse.quote(linkname), cgi.escape(displayname)))
		f = f + ("</ul><hr></body></html>")

		f = f.encode('utf-8')
		length = len(f)
		self.send_response(200)
		self.send_header("Content-type", "text/html")
		self.send_header("Content-Length", str(length))
		self.end_headers()
		return f

	def translate_path(self, path):
		"""Translate a /-separated PATH to the local filename syntax.
		Components that mean special things to the local file system
		(e.g. drive or directory names) are ignored.  (XXX They should
		probably be diagnosed.)
		"""
		# abandon query parameters
		path = path.split('?',1)[0]
		path = path.split('#',1)[0]
		path = posixpath.normpath(urllib.parse.unquote(path))
		words = path.split('/')
		words = filter(None, words)
		path = os.getcwd()
		for word in words:
			drive, word = os.path.splitdrive(word)
			head, word = os.path.split(word)
			if word in (os.curdir, os.pardir): continue
			path = os.path.join(path, word)
		return path

	def guess_type(self, path):
		"""Guess the type of a file.
		Argument is a PATH (a filename).
		Return value is a string of the form type/subtype,
		usable for a MIME Content-type header.
		The default implementation looks the file's extension
		up in the table self.extensions_map, using application/octet-stream
		as a default; however it would be permissible (if
		slow) to look inside the data to make a better guess.
		"""

		base, ext = posixpath.splitext(path)
		if ext in self.extensions_map:
			return self.extensions_map[ext]
		ext = ext.lower()
		if ext in self.extensions_map:
			return self.extensions_map[ext]
		else:
			return self.extensions_map['']

	if not mimetypes.inited:
		mimetypes.init() # try to read system mime.types
	extensions_map = mimetypes.types_map.copy()
	extensions_map.update({
		'': 'application/octet-stream', # Default
		'.py': 'text/plain',
		'.c': 'text/plain',
		'.h': 'text/plain',
		})


def test(HandlerClass = SimpleHTTPRequestHandler,
		 ServerClass = http.server.HTTPServer):
	http.server.test(HandlerClass, ServerClass)

if __name__ == '__main__':
	test()

上一篇
Python - PyEnchant 英文單字拼寫檢查套件參考筆記
下一篇
Python - 根據輸入的英文字母排列出有意義的單詞-參考筆記
系列文
實驗室助理的技術文章自我整理30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言