Skip to content

README.md

Latest commit

 

History

History
89 lines (60 loc) · 3.59 KB

README.md

File metadata and controls

89 lines (60 loc) · 3.59 KB
Raw

SimpleHTTPFileServer

A simple http file sharing server written in python (3.6+ required) with aiohttp

Description

A simple server for file uploading and downloading. Renaming, copying and moving are also supported

Usage

Just download SimpleHTTPFileServer.py and use it.

Requirements

Requires python version >= 3.6, and aiohttp library (pip install aiohttp)

It works with pure python environment, tested to work in Pythonista (an iOS App)

Command line: (share a single folder quickly and easily)

python SimpleHTTPFileServer.py [somePath/toShare/]

The path defaults to the current working dir. It could be set to a file

-p [PORT] option could be used to specify a port (default 8080).

-ro option enables read-only mode.

The server will be created on 0.0.0.0:[PORT]

Python: (create a customized server)

import SimpleHTTPFileServer as sfs
import asyncio

eventloop = asyncio.get_event_loop()
bind = ('::1', 7000, None), ('127.0.0.1', 8000, None), ('192.168.1.2', 9000, None)

server = sfs.Server(loop=eventloop,
                    listen=bind,
                    wait=10,
                    logfile=None)

import pathlib
to_share = pathlib.Path('some/path/')

server.add_share('favicon.ico', 'WebRoot/index.ico', hidden=True)
server.add_share('shared', to_share, readonly=True)

server.run()

Everything is in the Server class:

Server.__init__ method: constructor

  • loop allows third party event loops (default asyncio.get_event_loop())

  • listen takes a list (or tuple) of list (or tuple), inner list should have a length of 3. Its format is address, port and ssl context. It will listen on all of them (default: ('0.0.0.0',8080, None),) ssl context could be created as:

ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
ssl_context.load_cert_chain('chain.pem', 'privkey.pem')

  • wait specifies how many seconds the server waits (default: 30). It will wait for existing connections to close themselves. If all existing connections are closed during the waiting, it will exit right after that. If there are still existing connections after wait seconds, it will force them to close.

  • logfile can be specified to None, and no log will be written (default: writes to stdout)

Server.add_share method adds an shared folder (could also be a file)

It needs a name (displayed in the web page, and used in web path) and a file-system path for this entry(string or pathlib.Path object)

  • hidden flag: it won't be displayed in the web page if set to True

  • readonly flag: uploading / renaming / copying / moving is disabled if set to True

Server.add_subapp method adds a async function handler as an entry. The function should have a signature of async def func(request), where request is a aiohttp.web_request.BaseRequest instance provided by aiohttp. All requests under this path will be passed to this function.
Server.remove method could be used to remove an existing shared item. It takes the name as argument.
Finally, Server.run method starts the handling work

It could be terminated by Ctrl + C, but it will wait for existing connections to finish before exiting. The maximum time could be set when creating the Server instance

You may also use async with Server(...your arguments here...) to run it asynchronously

About security

No https support. So the connections are not secured. Added https support.

It is designed to disallow viewing / modifying folder outside of shared ones.

Read-only shares could not be changed.

Any contribution is welcome.