incubator/dirl
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
A minimal but flexible directory listing server
273 commits 1 branch 0 tags 365 KiB
C 97.8%
Makefile 1.7%
Dockerfile 0.5%
Find a file
Armin Friedl 66558aa615 Stat full path, allocate enough space 
Not stat'ing the full path (just entry->d_name) strangely works on glibc/fedora
but fails on musl/alpine. Stat'ing the full path is the right thing to do,
anyways.

There was a heap corruption in `dirl_find_templ_dir` due not allocating enough
space for the terminating NULL in `path_buf`. This again only showed up in
musl/alpine.
2020-08-31 06:42:23 +02:00
.clang-format Read from template files with placeholder replacement 2020-08-28 00:46:08 +02:00
.drone.yml Add README for dirl, publish CI builds 2020-08-30 19:07:57 +02:00
.gitignore Read from template files with placeholder replacement 2020-08-28 00:46:08 +02:00
arg.h Correct arg.h license 2018-07-16 11:49:51 +02:00
config.def.h Read from template files with placeholder replacement 2020-08-28 00:46:08 +02:00
config.mk Be extra pedantic again and remove all warnings 2018-03-05 00:30:53 +01:00
data.c Stat full path, allocate enough space 2020-08-31 06:42:23 +02:00
data.h Add http_send_body() and data_send_error() and refactor 2020-08-29 00:49:16 +02:00
dirl.c Stat full path, allocate enough space 2020-08-31 06:42:23 +02:00
dirl.h Stat full path, allocate enough space 2020-08-31 06:42:23 +02:00
http.c Add http_send_body() and data_send_error() and refactor 2020-08-29 00:49:16 +02:00
http.h Add logmsg() and refactor connection handling 2020-08-29 13:02:51 +02:00
LICENSE Use timegm() instead of mktime() to generate UNIX-timestamp 2020-07-23 16:48:34 +02:00
main.c Add logmsg() and refactor connection handling 2020-08-29 13:02:51 +02:00
Makefile Merge branch 'master' into dirlist 2020-08-30 14:16:41 +02:00
quark.1 Mention default behaviour in the manual when the host is not given 2020-08-23 13:36:56 +02:00
README.md Add README for dirl, publish CI builds 2020-08-30 19:07:57 +02:00
sock.c Refactor sock_get_uds() a bit 2020-08-23 13:35:49 +02:00
sock.h Ensure const-correctness where possible and refactor parse_range() 2020-08-05 18:28:21 +02:00
util.c Fix merge leftovers, add attribution footer by default 2020-08-30 18:07:23 +02:00
util.h Merge branch 'master' into dirlist 2020-08-30 14:16:41 +02:00

README.md

Build Status

This is my private tree of quark. Upstream can be found at https://git.suckless.org/quark.

Quark is a small http server.

DIRL

dirl is a quark extension for customized directory listings.

Per default dirl generates html for a directory listing like this:

<!DOCTYPE HTML PUBLIC " - // W3C//DTD HTML 3.2 Final//EN">
<!-- Header Section -->
<html>
  <head>
    <link rel="stylesheet" href="style.css">
    <title>Index of {uri}</title>
  </head>
  <body>
    <h1>Index of {uri}</h1>
    <p><a href="..">&crarr; Parent Directory</a></p>
    <hr />
    <table>
      <tr><th>Name</th><th>Modified</th><th>Size</th></tr>
<!-- /Header Section -->

<!-- Entry Section -->
<!-- (repeated for each entry in the directory) -->
      <tr>
        <td><a href="{entry}">{entry}{suffix}</a>
        <td>{modified}</td>
        <td>{size}</td>
      </tr>
<!-- /Entry Section -->

<!-- Footer Section -->
    </table>
    <hr />
    <p>
      Served by <a href="http://tools.suckless.org/quark/">quark</a> and <a href="https://git.friedl.net/playground/suckless-quark/src/branch/dirlist">dirl</a>
    </p>
</body>
</html>
<!-- /Footer Section -->

Customize

The default listing can be styled by a style.css in the root directory.

You can also use your fully customized template by creating one or all the template files for each section. Per default the section templates are named:

  • .header.tpl
  • .entry.tpl (repeated for each directory entry)
  • .footer.tpl

Note that if you only provide some of the template files, they have to be compatible with the generated default for the other sections.

For each of these templates you can use placeholders that are replaced by their respective values:

  • header
    • {uri}: Replaced by the current path
  • entry
    • {entry}: Name of the entry
    • {suffix}: A suffix for the entry, mostly useful to distinguish directories (suffix '/') from files
    • {modified}: Date the entry was last modified
    • {size}: Size of the entry (if available)

Subdirectory styling

dirl tries to the closest template for the currently visited path. This gives you the opportunity to override templates in subdirectories. dirl walks the directory hierarchy upwards from the currently visited path. As soon as it finds one of the template files in a directory, it stops searching and uses the templates in that directory.

In case no templates are found up until and including root, the default templates are used.

Customize names

The files defined as templates and style are ignored in the directory listing itself. In case you need to list one of these directories, or have any other reason to choose different names, the filenames can be configured in dirl.h. Note that you need to compile your own quark version then.

Download

You can also download CI builds for quark-dirl.

There are no official releases. Quark has no dependencies and you can easily build it from source. Don't forget to read up on the suckless philosophy.

Github Users

If you are visiting this repository on GitHub, you are on a mirror of https://git.friedl.net/playground/suckless-quark. This mirror is regularily updated with my other GitHub mirrors. In contrast to other projects I do not intend to move this tree to GitHub in the future. It is meant to stay a read-only mirror.

You are welcome to pull any changes from this repository into your quark tree. If you want to contribute consider contributing directly to upstream.

If you still - for whichever reasons - want to contribute to my tree directly, feel free to send patches to dev[at]friedl[dot]net. Alternatviely you can issue a pull request on GitHub which will be cherry picked into my tree.