amphp / http-server-static-content

An HTTP server plugin to serve static files like HTML, CSS, JavaScript, and images effortlessly.

http-server-static-content

AMPHP is a collection of event-driven libraries for PHP designed with fibers and concurrency in mind. This package provides an HTTP server plugin to serve static files like HTML, CSS, JavaScript, and images effortlessly.

Installation

This package can be installed as a Composer dependency.

composer require amphp/http-server-static-content

Usage

This package provides two RequestHandler implementations:

• DocumentRoot: Serves all files within a directory.
• StaticResource: Serves a single specific file.

The example below combines static file serving and request routing to demonstrate how they work well together:

<?php

use Amp\Http\Server\DefaultErrorHandler;
use Amp\Http\Server\RequestHandler\ClosureRequestHandler;
use Amp\Http\Server\Response;
use Amp\Http\Server\SocketHttpServer;
use Amp\Http\Server\StaticContent\DocumentRoot;
use Amp\Http\Status;

$router = new Amp\Http\Server\Router;
// $server is an instance of HttpServer and $errorHandler an instance of ErrorHandler
$router->setFallback(new DocumentRoot($server, $errorHandler, __DIR__ . '/public'));
$router->addRoute('GET', '/', new ClosureRequestHandler(function () {
    return new Response(Status::OK, ['content-type' => 'text/plain'], 'Hello, world!');
}));


$server->start($router, new DefaultErrorHandler());

A full example is found in examples/server.php.

Contributing

Please read our rules for details on our code of conduct, and the process for submitting pull requests to us.

Security

If you discover any security related issues, please use the private security issue reporter instead of using the public issue tracker.

License

The MIT License (MIT). Please see LICENSE for more information.

http-server-static-content's Issues

Why libuv?

In documentation there is a note that I should use libuv when using this. However the reason for that or what happens if it isn't used is missing.

Also if it is important it should be mentioned in the readme of this package.

I can send PRs if you can explain the reasons to me.

Extract remoteDotSegments

removeDotSegments() is currently a static function in DocumentRoot, it should be extracted to a function.

Issue with If-Modified-Since HTTP header

Hi there 👋🙂
I noticed that when I modify a file served by DocumentRoot, I have to force the refresh in my browser to actually see the updated file.
After some debugging, I think there is an inversion in the order of comparison:
https://github.com/amphp/http-server-static-content/blob/2.x/src/DocumentRoot.php#L304C49-L304C66

The code returns "unmodified" status if $mtime > $ifModifiedSince, but if I understand correctly it's the opposite, if $mtime > $ifModifiedSince it means that the file has been updated. (Corresponding doc for reference)

I'm currently running version 1, but as far as I can see the bug is present on branch 2 as well.
It doesn't seem to be covered by tests.

By the way, thank you very much for your work on this awesome library 😊

Cannot run example: Missing dependency http-server-roter

In order to execute the example the amphp/http-server-router dependency has be installed as well.

Cached size is not updated

The cached size of files is not updated. If files are changed, this might result in a wrong content-length header.

Commit 9f43db6 content-length

PHP Recoverable fatal error:  Object of class Amp\Coroutine could not be converted to string in [...]/vendor/amphp/http-server-static-content/src/DocumentRoot.php on line 393

missed a yield there @ src/DocumentRoot.php:393

$headers["Content-Length"] = (string) $this->filesystem->size($fileInfo->path);

to

$headers["Content-Length"] = (string) yield $this->filesystem->size($fileInfo->path);

Support for amphp/file v2

This amphp library is blocking the amphp/file v2 upgrade in our dependency chain.

Serving from a subdirectory

If a path looks like /static/css/screen.css, and we want to only have a docroot for things inside /static, what's the way to go? (I.e. I have a file /foo/bar/css/screen.css and want to map /foo/bar onto /static)

Or another use case: in combination with prefixed Routers. Currently DocumentRoot looks at the full URI path and dispatches from there.

I know of amphp/http-server-router#3 which could solve the second case in particular, but we probably should provide a generic solution for this.

Make DocumentRoot final

DocumentRoot should be final.

Provide responder for a single file

There should be a responder for a single file, that still enables the caching and range responses. See amphp/http-server#218 for context.

Refactor options

Instead of setOption() we should have an Options object similar to amphp/http-server and other repositories.