This is the reblocks-file-server Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:45:46 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
reblocks-file-serverA Reblocks extension allowing to create routes for serving static files from disk.
Alexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/reblocks-file-server)
Unlicense
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-40README-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
# reblocks-file-server - A Reblocks extension allowing to create routes for serving static files from disk.
<a id="reblocks-file-server-asdf-system-details"></a>
## REBLOCKS-FILE-SERVER ASDF System Details
* Version: 0.3.0
* Description: A Reblocks extension allowing to create routes for serving static files from disk.
* Licence: Unlicense
* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
* Homepage: [https://40ants.com/reblocks-file-server/][f449]
* Bug tracker: [https://github.com/40ants/reblocks-file-server/issues][a450]
* Source control: [GIT][b09a]
* Depends on: [cl-fad][1059], [cl-ppcre][49b9], [reblocks][184b], [routes][48e8], [trivial-mimes][a154]
[][4729]
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Installation
You can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:
“‘
(ql-dist:install-dist "http://dist.ultralisp.org/"
:prompt nil)
(ql:quickload :reblocks-file-server)
“‘
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Usage
Here is a few examples on how this library can be used. These lines can be added into the code
which starts your Reblocks web application.
This is how to serve all ‘*.txt‘ files from the ‘/var/www‘ folder:
“‘lisp
(reblocks-file-server:make-route :uri "/static/"
:root "/var/www/"
:dir-listing nil
:filter ".*.txt")
“‘
You also can provide a ‘DIR-LISTING‘ argument to repond on /static/ route with a rendered directory listing:
“‘lisp
(reblocks-file-server:make-route :uri "/static/"
:root "/var/www/"
:dir-listing t
:filter ".*.txt")
“‘
In case if you want to serve all files except ‘*.txt‘, you can negate filter expression by giving ‘NIL‘ in ‘FILTER-TYPE‘ argument:
“‘lisp
(reblocks-file-server:make-route :uri "/static/"
:root "/var/www/"
:dir-listing t
:filter ".*.txt"
:filter-type nil)
“‘
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-40API-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## API
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-40REBLOCKS-FILE-SERVER-2FCORE-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
### REBLOCKS-FILE-SERVER/CORE
<a id="x-28-23A-28-2825-29-20BASE-CHAR-20-2E-20-22REBLOCKS-FILE-SERVER-2FCORE-22-29-20PACKAGE-29"></a>
#### [package](c425) ‘reblocks-file-server/core‘
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-FILE-SERVER-2FCORE-3FClasses-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
#### Classes
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-40REBLOCKS-FILE-SERVER-2FCORE-24STATIC-FILES-ROUTE-3FCLASS-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
##### STATIC-FILES-ROUTE
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3ASTATIC-FILES-ROUTE-20CLASS-29"></a>
###### [class](907c) ‘reblocks-file-server/core:static-files-route‘ (route)
**Readers**
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3AGET-DIR-LISTING-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-FILE-SERVER-2FCORE-3ASTATIC-FILES-ROUTE-29-29"></a>
###### [reader](a9af) ‘reblocks-file-server/core:get-dir-listing‘ (static-files-route) (:dir-listing = t)
When nil, directory contents is not shown.
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3AGET-FILTER-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-FILE-SERVER-2FCORE-3ASTATIC-FILES-ROUTE-29-29"></a>
###### [reader](0c78) ‘reblocks-file-server/core:get-filter‘ (static-files-route) (:filter)
A regular expression.
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3AGET-FILTER-TYPE-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-FILE-SERVER-2FCORE-3ASTATIC-FILES-ROUTE-29-29"></a>
###### [reader](3c75) ‘reblocks-file-server/core:get-filter-type‘ (static-files-route) (:filter-type = t)
T means show files that match the filter regexp. ‘NIL‘ means hide files that match the filter regexp
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3AGET-ROOT-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-FILE-SERVER-2FCORE-3ASTATIC-FILES-ROUTE-29-29"></a>
###### [reader](3dc9) ‘reblocks-file-server/core:get-root‘ (static-files-route) (:root)
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3AGET-URI-20-2840ANTS-DOC-2FLOCATIVES-3AREADER-20REBLOCKS-FILE-SERVER-2FCORE-3ASTATIC-FILES-ROUTE-29-29"></a>
###### [reader](c8f8) ‘reblocks-file-server/core:get-uri‘ (static-files-route) (:uri)
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-FILE-SERVER-2FCORE-3FGenerics-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
#### Generics
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3ARENDER-404-20GENERIC-FUNCTION-29"></a>
##### [generic-function](cc57) ‘reblocks-file-server/core:render-404‘ route uri
Returns a string with ‘HTML‘ for a case when ‘uri’ wasn’t found on the disk.
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3ARENDER-DIRECTORY-20GENERIC-FUNCTION-29"></a>
##### [generic-function](a9fe) ‘reblocks-file-server/core:render-directory‘ route uri children
Renders a list of files in a directory
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3ARENDER-STYLES-20GENERIC-FUNCTION-29"></a>
##### [generic-function](7026) ‘reblocks-file-server/core:render-styles‘ route
This method should use reblocks/html:with-html and output a :style element.
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3ASERVE-DIRECTORY-20GENERIC-FUNCTION-29"></a>
##### [generic-function](ffaf) ‘reblocks-file-server/core:serve-directory‘ route uri full-path
Returns a Lack response with a rendered directory listing.
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3ASERVE-FILE-20GENERIC-FUNCTION-29"></a>
##### [generic-function](fef3) ‘reblocks-file-server/core:serve-file‘ route full-path
Returns content of the file.
<a id="x-28REBLOCKS-FILE-SERVER-DOCS-2FINDEX-3A-3A-7C-40REBLOCKS-FILE-SERVER-2FCORE-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
#### Functions
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3ALIST-DIRECTORY-20FUNCTION-29"></a>
##### [function](dab9) ‘reblocks-file-server/core:list-directory‘ full-path filter filter-type
Returns a list of files in the directory.
All items of the list are relative.
<a id="x-28REBLOCKS-FILE-SERVER-2FCORE-3AMAKE-ROUTE-20FUNCTION-29"></a>
##### [function](7bda) ‘reblocks-file-server/core:make-route‘ &key (route-class ’static-files-route) (uri "/") (root "./") (dir-listing t) (filter ".\*") (filter-type t)
[f449]: https://40ants.com/reblocks-file-server/
[b09a]: https://github.com/40ants/reblocks-file-server
[4729]: https://github.com/40ants/reblocks-file-server/actions
[c425]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L1
[dab9]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L100
[907c]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L35
[3dc9]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L36
[c8f8]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L39
[a9af]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L42
[0c78]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L47
[3c75]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L52
[7bda]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L58
[ffaf]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L80
[fef3]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L84
[a9fe]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L88
[cc57]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L92
[7026]: https://github.com/40ants/reblocks-file-server/blob/5d40b7f0df492eabbae5d0d047b91b361ad544f5/src/core.lisp#L96
[a450]: https://github.com/40ants/reblocks-file-server/issues
[1059]: https://quickdocs.org/cl-fad
[49b9]: https://quickdocs.org/cl-ppcre
[184b]: https://quickdocs.org/reblocks
[48e8]: https://quickdocs.org/routes
[a154]: https://quickdocs.org/trivial-mimes
* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]
0.3.0
40ants-asdf-system (system).
reblocks-file-server/core (system).
reblocks-file-server/coreAlexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/reblocks-file-server)
Unlicense
trivial-mimes (system).
reblocks/request (system).
reblocks/html (system).
reblocks/utils/misc (system).
reblocks/routes (system).
routes (system).
cl-fad (system).
cl-ppcre (system).
Files are sorted by type and then listed depth-first from the systems components trees.
reblocks-file-server/reblocks-file-server.asdreblocks-file-server (system).
reblocks-file-server/core/file-type.lispreblocks-file-server/core (system).
get-dir-listing (reader method).
get-filter (reader method).
get-filter-type (reader method).
get-root (reader method).
get-uri (reader method).
list-directory (function).
make-route (function).
render-404 (generic function).
render-directory (generic function).
render-styles (generic function).
serve (method).
serve-directory (generic function).
serve-file (generic function).
static-files-route (class).
make-full-path (function).
Packages are listed by definition order.
reblocks-file-server/corereblocks-file-server
common-lisp.
get-dir-listing (generic reader).
get-filter (generic reader).
get-filter-type (generic reader).
get-root (generic reader).
get-uri (generic reader).
list-directory (function).
make-route (function).
render-404 (generic function).
render-directory (generic function).
render-styles (generic function).
serve-directory (generic function).
serve-file (generic function).
static-files-route (class).
make-full-path (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns a list of files in the directory. All items of the list are relative.
static-files-route)) ¶When nil, directory contents is not shown.
static-files-route)) ¶A regular expression.
static-files-route)) ¶T means show files that match the filter regexp. NIL means hide files that match the filter regexp
static-files-route)) ¶automatically generated reader method
root.
static-files-route)) ¶automatically generated reader method
uri.
Returns a string with HTML for a case when ‘uri’ wasn’t found on the disk.
Renders a list of files in a directory
This method should use reblocks/html:with-html and output a :style element.
Returns a Lack response with a rendered directory listing.
Returns content of the file.
static-files-route) env) ¶Returns a robots of the site.
reblocks/routes.
route.
When nil, directory contents is not shown.
t
:dir-listing
This slot is read-only.
A regular expression.
string
:filter
This slot is read-only.
T means show files that match the filter regexp. NIL means hide files that match the filter regexp
t
:filter-type
This slot is read-only.
Returns a pathname pointing to the file on the filesystem.
Root, is a base directory of the route, route-uri is a path
on the webserver, where files should be served from
and request-path is a requested path from the webrowser.
Request-path is always have a route-uri as a prefix.
For example, if:
root = "/app/build/dist/"
route-uri = "/dist/"
request-path = "/dist/the-file.txt"
Then this function should return a pathname
pointing to "/app/build/dist/the-file.txt"
| Jump to: | F G L M R S |
|---|
| Jump to: | F G L M R S |
|---|
| Jump to: | D F R S U |
|---|
| Jump to: | D F R S U |
|---|
| Jump to: | C F P R S |
|---|
| Jump to: | C F P R S |
|---|