-
-
Save glowinthedark/625eb4caeca12c5aa52778a3b4b0adb4 to your computer and use it in GitHub Desktop.
| #!/usr/bin/env python3 | |
| # NOTE: this script is deprecated; | |
| # maintained version with SVG icons: https://github.com/glowinthedark/index-html-generator/ | |
| # --- | |
| # Copyright 2020 glowinthedark | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # | |
| # You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, | |
| # software distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # | |
| # See the License for the specific language governing permissions and limitations under the License. | |
| # --- | |
| # | |
| # - Generate index.html in a directory tree. | |
| # - handle symlinked files and folders: displayed with custom icons | |
| # - by default only the current folder is processed unless `-r` (`--recursive`) is specified | |
| # - hidden files (starting with a dot) are skipped; use `--include-hidden` to force inclusion | |
| # - skip specific files by regex, e.g.: `--exclude-regex "(build|node_modules|target|__pycache__)"` | |
| import argparse | |
| import datetime | |
| import os | |
| import re | |
| import sys | |
| from pathlib import Path | |
| from urllib.parse import quote | |
| DEFAULT_OUTPUT_FILE = 'index.html' | |
| def process_dir(top_dir, opts): | |
| glob_patt = opts.filter or '*' | |
| path_top_dir = Path(top_dir) | |
| index_path = Path(path_top_dir, opts.output_file) | |
| if opts.verbose: | |
| print(f'Traversing dir {path_top_dir.absolute()}') | |
| try: | |
| index_file = open(index_path, 'w', encoding='utf-8') | |
| except Exception as e: | |
| print('cannot create file %s %s' % (index_path, e)) | |
| return | |
| index_file.write("""<!DOCTYPE html> | |
| <html> | |
| <head> | |
| <meta charset="utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| <style> | |
| * { padding: 0; margin: 0; } | |
| body { | |
| font-family: sans-serif; | |
| text-rendering: optimizespeed; | |
| background-color: #ffffff; | |
| } | |
| a { | |
| color: #006ed3; | |
| text-decoration: none; | |
| } | |
| a:hover, | |
| h1 a:hover { | |
| color: #319cff; | |
| } | |
| header, | |
| #summary { | |
| padding-left: 5%; | |
| padding-right: 5%; | |
| } | |
| th:first-child, | |
| td:first-child { | |
| width: 5%; | |
| } | |
| th:last-child, | |
| td:last-child { | |
| width: 5%; | |
| } | |
| header { | |
| padding-top: 25px; | |
| padding-bottom: 15px; | |
| background-color: #f2f2f2; | |
| } | |
| h1 { | |
| font-size: 20px; | |
| font-weight: normal; | |
| white-space: nowrap; | |
| overflow-x: hidden; | |
| text-overflow: ellipsis; | |
| color: #999; | |
| } | |
| h1 a { | |
| color: #000; | |
| margin: 0 4px; | |
| } | |
| h1 a:hover { | |
| text-decoration: underline; | |
| } | |
| h1 a:first-child { | |
| margin: 0; | |
| } | |
| main { | |
| display: block; | |
| } | |
| .meta { | |
| font-size: 12px; | |
| font-family: Verdana, sans-serif; | |
| border-bottom: 1px solid #9C9C9C; | |
| padding-top: 10px; | |
| padding-bottom: 10px; | |
| } | |
| .meta-item { | |
| margin-right: 1em; | |
| } | |
| #filter { | |
| padding: 4px; | |
| border: 1px solid #CCC; | |
| } | |
| table { | |
| width: 100%; | |
| border-collapse: collapse; | |
| } | |
| tr { | |
| border-bottom: 1px dashed #dadada; | |
| } | |
| tbody tr:hover { | |
| background-color: #ffffec; | |
| } | |
| th, | |
| td { | |
| text-align: left; | |
| padding: 10px 0; | |
| } | |
| th { | |
| padding-top: 15px; | |
| padding-bottom: 15px; | |
| font-size: 16px; | |
| white-space: nowrap; | |
| } | |
| th a { | |
| color: black; | |
| } | |
| th svg { | |
| vertical-align: middle; | |
| } | |
| td { | |
| white-space: nowrap; | |
| font-size: 14px; | |
| } | |
| td:nth-child(2) { | |
| width: 80%; | |
| } | |
| td:nth-child(3) { | |
| padding: 0 20px 0 20px; | |
| } | |
| th:nth-child(4), | |
| td:nth-child(4) { | |
| text-align: right; | |
| } | |
| td:nth-child(2) svg { | |
| position: absolute; | |
| } | |
| td .name { | |
| margin-left: 1.75em; | |
| word-break: break-all; | |
| overflow-wrap: break-word; | |
| white-space: pre-wrap; | |
| } | |
| td .goup { | |
| margin-left: 1.75em; | |
| padding: 0; | |
| word-break: break-all; | |
| overflow-wrap: break-word; | |
| white-space: pre-wrap; | |
| } | |
| .icon { | |
| margin-right: 5px; | |
| } | |
| tr.clickable { | |
| cursor: pointer; | |
| } | |
| tr.clickable a { | |
| display: block; | |
| } | |
| @media (max-width: 600px) { | |
| * { | |
| font-size: 1.06rem; | |
| } | |
| .hideable { | |
| display: none; | |
| } | |
| td:nth-child(2) { | |
| width: auto; | |
| } | |
| th:nth-child(3), | |
| td:nth-child(3) { | |
| padding-right: 5%; | |
| text-align: right; | |
| } | |
| h1 { | |
| color: #000; | |
| } | |
| h1 a { | |
| margin: 0; | |
| } | |
| #filter { | |
| max-width: 100px; | |
| } | |
| } | |
| @media (prefers-color-scheme: dark) { | |
| body { | |
| color: #eee; | |
| background: #121212; | |
| } | |
| header { | |
| color: #eee; | |
| background: #151515; | |
| } | |
| tbody tr:hover { | |
| background-color: #000020; | |
| } | |
| } | |
| </style> | |
| </head> | |
| <body> | |
| <svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" height="0" width="0" style="position: absolute;"> | |
| <defs> | |
| <!-- Go-up --> | |
| <g id="go-up"> | |
| <path d="M10,9V5L3,12L10,19V14.9C15,14.9 18.5,16.5 21,20C20,15 17,10 10,9Z" fill="#696969"/> | |
| </g> | |
| <!-- Folder --> | |
| <g id="folder" fill-rule="nonzero" fill="none"> | |
| <path d="M285.22 37.55h-142.6L110.9 0H31.7C14.25 0 0 16.9 0 37.55v75.1h316.92V75.1c0-20.65-14.26-37.55-31.7-37.55z" fill="#FFA000"/> | |
| <path d="M285.22 36H31.7C14.25 36 0 50.28 0 67.74v158.7c0 17.47 14.26 31.75 31.7 31.75H285.2c17.44 0 31.7-14.3 31.7-31.75V67.75c0-17.47-14.26-31.75-31.7-31.75z" fill="#FFCA28"/> | |
| </g> | |
| <g id="folder-shortcut" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"> | |
| <g id="folder-shortcut-group" fill-rule="nonzero"> | |
| <g id="folder-shortcut-shape"> | |
| <path d="M285.224876,37.5486902 L142.612438,37.5486902 L110.920785,0 L31.6916529,0 C14.2612438,0 0,16.8969106 0,37.5486902 L0,112.646071 L316.916529,112.646071 L316.916529,75.0973805 C316.916529,54.4456008 302.655285,37.5486902 285.224876,37.5486902 Z" id="Shape" fill="#FFA000"></path> | |
| <path d="M285.224876,36 L31.6916529,36 C14.2612438,36 0,50.2838568 0,67.7419039 L0,226.451424 C0,243.909471 14.2612438,258.193328 31.6916529,258.193328 L285.224876,258.193328 C302.655285,258.193328 316.916529,243.909471 316.916529,226.451424 L316.916529,67.7419039 C316.916529,50.2838568 302.655285,36 285.224876,36 Z" id="Shape" fill="#FFCA28"></path> | |
| </g> | |
| <path d="M126.154134,250.559184 C126.850974,251.883673 127.300549,253.006122 127.772602,254.106122 C128.469442,255.206122 128.919016,256.104082 129.638335,257.002041 C130.559962,258.326531 131.728855,259 133.100057,259 C134.493737,259 135.415364,258.55102 136.112204,257.67551 C136.809044,257.002041 137.258619,255.902041 137.258619,254.577551 C137.258619,253.904082 137.258619,252.804082 137.033832,251.457143 C136.786566,249.908163 136.561779,249.032653 136.561779,248.583673 C136.089726,242.814286 135.864939,237.920408 135.864939,233.273469 C135.864939,225.057143 136.786566,217.514286 138.180246,210.846939 C139.798713,204.202041 141.889234,198.634694 144.429328,193.763265 C147.216689,188.869388 150.678411,184.873469 154.836973,181.326531 C158.995535,177.779592 163.626149,174.883673 168.481552,172.661224 C173.336954,170.438776 179.113983,168.665306 185.587852,167.340816 C192.061722,166.218367 198.760378,165.342857 205.481514,164.669388 C212.18017,164.220408 219.598146,163.995918 228.162535,163.995918 L246.055591,163.995918 L246.055591,195.514286 C246.055591,197.736735 246.752431,199.510204 248.370899,201.059184 C250.214153,202.608163 252.079886,203.506122 254.372715,203.506122 C256.463236,203.506122 258.531277,202.608163 260.172223,201.059184 L326.102289,137.797959 C327.720757,136.24898 328.642384,134.47551 328.642384,132.253061 C328.642384,130.030612 327.720757,128.257143 326.102289,126.708163 L260.172223,63.4469388 C258.553756,61.8979592 256.463236,61 254.395194,61 C252.079886,61 250.236632,61.8979592 248.393377,63.4469388 C246.77491,64.9959184 246.07807,66.7693878 246.07807,68.9918367 L246.07807,100.510204 L228.162535,100.510204 C166.863084,100.510204 129.166282,117.167347 115.274437,150.459184 C110.666301,161.54898 108.350993,175.310204 108.350993,191.742857 C108.350993,205.279592 113.903236,223.912245 124.760454,247.438776 C125.00772,248.112245 125.457294,249.010204 126.154134,250.559184 Z" id="Shape" fill="#FFFFFF" transform="translate(218.496689, 160.000000) scale(-1, 1) translate(-218.496689, -160.000000) "></path> | |
| </g> | |
| </g> | |
| <!-- File --> | |
| <g id="file" stroke="#000" stroke-width="25" fill="#FFF" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"> | |
| <path d="M13 24.12v274.76c0 6.16 5.87 11.12 13.17 11.12H239c7.3 0 13.17-4.96 13.17-11.12V136.15S132.6 13 128.37 13H26.17C18.87 13 13 17.96 13 24.12z"/> | |
| <path d="M129.37 13L129 113.9c0 10.58 7.26 19.1 16.27 19.1H249L129.37 13z"/> | |
| </g> | |
| <g id="file-shortcut" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"> | |
| <g id="file-shortcut-group" transform="translate(13.000000, 13.000000)"> | |
| <g id="file-shortcut-shape" stroke="#000000" stroke-width="25" fill="#FFFFFF" stroke-linecap="round" stroke-linejoin="round"> | |
| <path d="M0,11.1214886 L0,285.878477 C0,292.039924 5.87498876,296.999983 13.1728373,296.999983 L225.997983,296.999983 C233.295974,296.999983 239.17082,292.039942 239.17082,285.878477 L239.17082,123.145388 C239.17082,123.145388 119.58541,2.84217094e-14 115.369423,2.84217094e-14 L13.1728576,2.84217094e-14 C5.87500907,-1.71479982e-05 0,4.96022995 0,11.1214886 Z" id="rect1171"></path> | |
| <path d="M116.37005,0 L116,100.904964 C116,111.483663 123.258008,120 132.273377,120 L236,120 L116.37005,0 L116.37005,0 Z" id="rect1794"></path> | |
| </g> | |
| <path d="M47.803141,294.093878 C48.4999811,295.177551 48.9495553,296.095918 49.4216083,296.995918 C50.1184484,297.895918 50.5680227,298.630612 51.2873415,299.365306 C52.2089688,300.44898 53.3778619,301 54.7490634,301 C56.1427436,301 57.0643709,300.632653 57.761211,299.916327 C58.4580511,299.365306 58.9076254,298.465306 58.9076254,297.381633 C58.9076254,296.830612 58.9076254,295.930612 58.6828382,294.828571 C58.4355724,293.561224 58.2107852,292.844898 58.2107852,292.477551 C57.7387323,287.757143 57.5139451,283.753061 57.5139451,279.95102 C57.5139451,273.228571 58.4355724,267.057143 59.8292526,261.602041 C61.44772,256.165306 63.5382403,251.610204 66.0783349,247.62449 C68.8656954,243.620408 72.3274172,240.35102 76.4859792,237.44898 C80.6445412,234.546939 85.2751561,232.177551 90.1305582,230.359184 C94.9859603,228.540816 100.76299,227.089796 107.236859,226.006122 C113.710728,225.087755 120.409385,224.371429 127.13052,223.820408 C133.829177,223.453061 141.247152,223.269388 149.811542,223.269388 L167.704598,223.269388 L167.704598,249.057143 C167.704598,250.87551 168.401438,252.326531 170.019905,253.593878 C171.86316,254.861224 173.728893,255.595918 176.021722,255.595918 C178.112242,255.595918 180.180284,254.861224 181.82123,253.593878 L247.751296,201.834694 C249.369763,200.567347 250.291391,199.116327 250.291391,197.297959 C250.291391,195.479592 249.369763,194.028571 247.751296,192.761224 L181.82123,141.002041 C180.202763,139.734694 178.112242,139 176.044201,139 C173.728893,139 171.885639,139.734694 170.042384,141.002041 C168.423917,142.269388 167.727077,143.720408 167.727077,145.538776 L167.727077,171.326531 L149.811542,171.326531 C88.5120908,171.326531 50.8152886,184.955102 36.9234437,212.193878 C32.3153075,221.267347 30,232.526531 30,245.971429 C30,257.046939 35.5522422,272.291837 46.4094607,291.540816 C46.6567266,292.091837 47.1063009,292.826531 47.803141,294.093878 Z" id="Shape-Copy" fill="#000000" fill-rule="nonzero" transform="translate(140.145695, 220.000000) scale(-1, 1) translate(-140.145695, -220.000000) "></path> | |
| </g> | |
| </g> | |
| </defs> | |
| </svg> | |
| <header> | |
| <h1>""" | |
| f'{path_top_dir.name}' | |
| """</h1> | |
| </header> | |
| <main> | |
| <div class="listing"> | |
| <table aria-describedby="summary"> | |
| <thead> | |
| <tr> | |
| <th></th> | |
| <th>Name</th> | |
| <th>Size</th> | |
| <th class="hideable"> | |
| Modified | |
| </th> | |
| <th class="hideable"></th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr class="clickable"> | |
| <td></td> | |
| <td><a href=".."><svg width="1.5em" height="1em" version="1.1" viewBox="0 0 24 24"><use xlink:href="#go-up"></use></svg> | |
| <span class="goup">..</span></a></td> | |
| <td>—</td> | |
| <td class="hideable">—</td> | |
| <td class="hideable"></td> | |
| </tr> | |
| """) | |
| # sort dirs first | |
| sorted_entries = sorted(path_top_dir.glob(glob_patt), key=lambda p: (p.is_file(), p.name)) | |
| entry: Path | |
| for entry in sorted_entries: | |
| # - don't include index.html in the file listing | |
| # - skip .hidden dot files unless explicitly requested | |
| # - skip by regex if defined | |
| if (entry.name.lower() == opts.output_file.lower()) \ | |
| or (not opts.include_hidden and entry.name.startswith('.')) \ | |
| or (opts.exclude_regex and opts.exclude_regex.search(entry.name)): | |
| continue | |
| if entry.is_dir() and opts.recursive: | |
| process_dir(entry, opts) | |
| # From Python 3.6, os.access() accepts path-like objects | |
| if (not entry.is_symlink()) and not os.access(str(entry), os.R_OK): | |
| print(f"*** WARNING *** entry {entry.absolute()} is not readable! SKIPPING!") | |
| continue | |
| if opts.verbose: | |
| print(f'{entry.absolute()}') | |
| size_bytes = -1 # is a folder | |
| size_pretty = '—' | |
| last_modified = '-' | |
| last_modified_human_readable = '-' | |
| last_modified_iso = '' | |
| try: | |
| if entry.is_file(): | |
| size_bytes = entry.stat().st_size | |
| size_pretty = pretty_size(size_bytes) | |
| if entry.is_dir() or entry.is_file(): | |
| last_modified = datetime.datetime.fromtimestamp(entry.stat().st_mtime).replace(microsecond=0) | |
| last_modified_iso = last_modified.isoformat() | |
| last_modified_human_readable = last_modified.strftime("%c") | |
| except Exception as e: | |
| print('ERROR accessing file name:', e, entry) | |
| continue | |
| entry_path = str(entry.name) | |
| if entry.is_dir() and not entry.is_symlink(): | |
| entry_type = 'folder' | |
| if os.name not in ('nt',): | |
| # append trailing slash to dirs, unless it's windows | |
| entry_path = os.path.join(entry.name, '') | |
| elif entry.is_dir() and entry.is_symlink(): | |
| entry_type = 'folder-shortcut' | |
| print('dir-symlink', entry.absolute()) | |
| elif entry.is_file() and entry.is_symlink(): | |
| entry_type = 'file-shortcut' | |
| print('file-symlink', entry.absolute()) | |
| else: | |
| entry_type = 'file' | |
| index_file.write(f""" | |
| <tr class="file"> | |
| <td></td> | |
| <td> | |
| <a href="{quote(entry_path)}"> | |
| <svg width="1.5em" height="1em" version="1.1" viewBox="0 0 265 323"><use xlink:href="#{entry_type}"></use></svg> | |
| <span class="name">{entry.name}</span> | |
| </a> | |
| </td> | |
| <td data-order="{size_bytes}">{size_pretty}</td> | |
| <td class="hideable"><time datetime="{last_modified_iso}">{last_modified_human_readable}</time></td> | |
| <td class="hideable"></td> | |
| </tr> | |
| """) | |
| index_file.write(""" | |
| </tbody> | |
| </table> | |
| </div> | |
| </main> | |
| </body> | |
| </html>""") | |
| if index_file: | |
| index_file.close() | |
| # bytes pretty-printing | |
| UNITS_MAPPING = [ | |
| (1024 ** 5, ' PB'), | |
| (1024 ** 4, ' TB'), | |
| (1024 ** 3, ' GB'), | |
| (1024 ** 2, ' MB'), | |
| (1024 ** 1, ' KB'), | |
| (1024 ** 0, (' byte', ' bytes')), | |
| ] | |
| def pretty_size(bytes, units=UNITS_MAPPING): | |
| """Human-readable file sizes. | |
| ripped from https://pypi.python.org/pypi/hurry.filesize/ | |
| """ | |
| for factor, suffix in units: | |
| if bytes >= factor: | |
| break | |
| amount = int(bytes / factor) | |
| if isinstance(suffix, tuple): | |
| singular, multiple = suffix | |
| if amount == 1: | |
| suffix = singular | |
| else: | |
| suffix = multiple | |
| return str(amount) + suffix | |
| def type_regex(s): | |
| if not s: | |
| return None | |
| try: | |
| return re.compile(s) | |
| except re.error as e: | |
| raise argparse.ArgumentTypeError(f"Invalid regular expression: {e}") | |
| if __name__ == "__main__": | |
| parser = argparse.ArgumentParser(description='''DESCRIPTION: | |
| Generate directory index files (recursive is OFF by default). | |
| Start from current dir or from folder passed as first positional argument. | |
| Optionally filter by file types with --filter "*.py". ''') | |
| parser.add_argument('top_dir', | |
| nargs='?', | |
| action='store', | |
| help='top folder from which to start generating indexes, ' | |
| 'use current folder if not specified', | |
| default=os.getcwd()) | |
| parser.add_argument('--filter', '-f', | |
| help='only include files matching glob', | |
| required=False) | |
| parser.add_argument('--output-file', '-o', | |
| metavar='filename', | |
| default=DEFAULT_OUTPUT_FILE, | |
| help=f'Custom output file, by default "{DEFAULT_OUTPUT_FILE}"') | |
| parser.add_argument('--recursive', '-r', | |
| action='store_true', | |
| help="recursively process nested dirs (FALSE by default)", | |
| required=False) | |
| parser.add_argument('--include-hidden', '-i', | |
| action='store_true', | |
| help="include dot hidden files (FALSE by default)", | |
| required=False) | |
| parser.add_argument('--exclude-regex', '-x', | |
| type=type_regex, | |
| help="exclude files matching regular expression", | |
| required=False) | |
| parser.add_argument('--verbose', '-v', | |
| action='store_true', | |
| help='***WARNING: can take longer time with complex file tree structures on slow terminals***' | |
| ' verbosely list every processed file', | |
| required=False) | |
| config = parser.parse_args(sys.argv[1:]) | |
| process_dir(config.top_dir, config) |
@cmlara: Thanks for spotting it! Updated the gist with your changes and also fixed the display of symlinks.
Which is the license of this script?
Thanks for writing this script: before I tried it, I attempted to use tree but it includes index.html in the listing and adds a spammy attribution section.
I removed a fork that I just made, as the option that I added is not needed.
@carlosame: added a license section: With Apache 2 a reference is valid (no need to include the full license text).
Thanks for devising this very useful script. However, I noticed a tiny snafu in it: entry paths are not url encoded/quoted at all so file names that have for instance a plus sign in them – like in a PAR2-checksum file called E1B738C543A2F123-00-25.vol015+016.par2 – will be passed with the plus sign intact into the href attribute of the A/anchor tag and web servers don't like that as a plus sign is usually considered an encoding of the regular space character ’ ’. This is easily remedied by changing line 386 into <a href="{quote(entry_path)}"> where quote() should be imported as from urllib.parse import quote in the preamble. Otherwise this is a very nicely written script. :)
Thank you @jkniiv for the feedback!
Indeed, the w3 standard and RFC-3968 recommend encoding the reserved characters and I didn't test the script on sufficiently complex file names to run into this. caddy for example could handle the plus sign, but choked on other reserved chars in a filename like ":#"[]()@:#[]()@&$,;?=~. Gist updated!
@glowinthedark You're welcome and thanks for the update! Not being a web developer I had only a vague recollection of those reserved characters in URLs/URIs. I knew that the plus sign was generally used to encode spaces at least in query strings. When I was testing your previous version out and accessing my nominally public Backblaze B2 bucket (or cloud drive) of the form https://my-example-files.s3.my-region.backblazeb2.com/ with files stored under a randomly generated "folder" name like KtcZHMvbF9yMhYPCfbfvYi68w (to work as a sort of access control for the otherwise publicly readable bucket), and with a generated index file like https://my-example-files.s3.my-region.backblazeb2.com/KtcZHMvbF9yMhYPCfbfvYi68w/index.html, any unencoded relative paths in the index meant they were accessed similar to the URL https://my-example-files.s3.my-region.backblazeb2.com/KtcZHMvbF9yMhYPCfbfvYi68w/E1B738C543A2F123-00-25.vol015+016.par2 with the B2 web server then pretty much responding that it could not find a key (i.e. a file) of the type /KtcZHMvbF9yMhYPCfbfvYi68w/E1B738C543A2F123-00-25.vol015 016.par2 (with a space instead of a plus). Considering that the whole URL these days pretty much functions as the query string for most web apps, it's understandable that the RFC-3968 you mentioned above (as I read it) places the plus character squarely in the list of reserved characters. The fact that Caddy takes the plus character at face value is surprising but of course allowed but this case proves you shouldn't rely on it.
Since the modification in March 18 (the url encoding), the script no longer works correctly on Windows, because it encodes the "reverse solidus" at the end of a directory name as "5C". Not sure what the best solution could be.
EDIT: previous to that revision, it produced directory entries like the following:
<a href="xml-dtd\">which is bad but at least worked.
At line 370 I'd replace:
entry_path = os.path.join(entry.name, '')with
entry_path = entry.name + '/'It works for me. (And removing the trailing whitespace at line 402 would be nice too :-) ).
@carlosame: The trailing slash is appended to the folder href because on most servers (e.g. apache2) that will help avoid a redirect from abc to abc/.
It would depend on the server you use but I suppose that on Windows it makes little sense to append a \ (correct me if I'm wrong), so I've added a check to not append the character on windows. In the previous version you could have just deleted that line containing os.path.join(entry.name, '').
In case a literal backward slash is needed on windows then you could remove the os check at line 370 and then on line 389 you could use quote(entry_path, safe='\\') instead of quote(entry_path).
The trailing slash is appended to the folder href because on most servers (e.g. apache2) that will help avoid a redirect
Yes, and that's why the solution that I proposed (I edited the message not long after posting it) sounds better to me: replace
entry_path = os.path.join(entry.name, '')with
entry_path = entry.name + '/'No need to check for OS, after all we are building a URI and not a OS-internal file path.
I added automatic dark mode CSS in my fork, feel free to copy the change.
@InsanePrawn: thanks! 👍 I've pulled in your revision!
I'm not sure why it checks that each file is writable:
if (not entry.is_symlink()) and not os.access(str(entry), os.W_OK):
print(f"*** WARNING *** entry {entry.absolute()} is not writable! SKIPPING!")I replaced that with
if (not entry.is_symlink()) and not os.access(str(entry), os.R_OK):
print(f"*** WARNING *** entry {entry.absolute()} is not readable! SKIPPING!")
@stephencmorton: access check is only needed in order to get the file size, so, indeed, no need for them to be writable, readable is enough. Thank you! Script updated.
@glowinthedark in your latest update you renamed the gist from generate_directory_index_caddystyle.py to write. Was that intentional?
@carlosame: not at all intentional; I guess I have mistaken the name field for the search field and then saved the gist LOL! 😆 🤣 Thank you for pointing it out!
@glowinthedark Thank you for Awesome script. Could you please guide me how to change script to sort in descending order. Currently its ordering in ascending order !
@PavanMudigondaTR: at line 344 change
sorted_entries = sorted(path_top_dir.glob(glob_patt), key=lambda p: (p.is_file(), p.name))to
sorted_entries = sorted(path_top_dir.glob(glob_patt), key=lambda p: (p.is_file(), p.name), reverse=True)...but then you'll get folders at the bottom, rather than at the top; if you need more fine-grained sorting then use a custom sort function.
to have reverse sort but with folders coming first try something like
sorted_entries = sorted(path_top_dir.glob(glob_patt), key=lambda p: (!p.is_file(), p.name), reverse=True)
@glowinthedark Thanks for your solution. have a good day !
Is there a way to exclude specific files? For example, favico.ico
@cxplay: some file are already excluded, like for example files that start with a . character, see line #354
I've updated the script to take a --exclude-regex argument (short form -x) which takes a regular expression pattern for the files to skip.
For example, generate_directory_index_caddystyle.py -x '(favicon|node_modules|target|build)' will skip any files/folders that contain the given substrings. You can also go wild with regexes and define whatever exclusion logic you need.
@cxplay: some file are already excluded, like for example files that start with a
.character, see line #354I've updated the script to take a
--exclude-regexargument (short form-x) which takes a regular expression pattern for the files to skip.For example,
generate_directory_index_caddystyle.py -x '(favicon|node_modules|target|build)'will skip any files/folders that contain the given substrings. You can also go wild with regexes and define whatever exclusion logic you need.
Thank you!
I suggest changing line 45 of the script: index_file = open(index_path, 'w') to index_file = open(index_path, 'w', encoding='utf-8'). This prevents the index.html output from being garbled when CJK characters and special characters are used in the HTML template.
@cxplay: with modern python3 versions this is not strictly necessary as python defaults to UTF-8 ootb, for example (on both mac and linux):
In [5]: open('/etc/hosts')
Out[5]: <_io.TextIOWrapper name='/etc/hosts' mode='r' encoding='UTF-8'>What do you get if you run this from a shell on your system?
python3 -c 'import locale; print(locale.getpreferredencoding()); import sys; print(sys.getdefaultencoding())'
@cxplay: with modern python3 versions this is not strictly necessary as python defaults to UTF-8 ootb, for example (on both mac and linux):
In [5]: open('/etc/hosts') Out[5]: <_io.TextIOWrapper name='/etc/hosts' mode='r' encoding='UTF-8'>What do you get if you run this from a shell on your system?
python3 -c 'import locale; print(locale.getpreferredencoding()); import sys; print(sys.getdefaultencoding())'
Its return:
cp936
utf-8
@cxplay: that explains it; since you are on windows your preferred locale encoding is microsoft's version of simplified Chinese, so open() by default will use cp936 rather than utf-8. As of Windows 10 microsoft uses UTF-8 as default so you are probably on a previous version.
I am assuming nowadays probably nobody would normally want to use something else than utf-8 so I've updated the script to explicitly use utf-8.
@cxplay: that explains it; since you are on windows your preferred locale encoding is microsoft's version of simplified Chinese, so
open()by default will usecp936rather thanutf-8. As of Windows 10 microsoft uses UTF-8 as default so you are probably on a previous version.I am assuming nowadays probably nobody would normally want to use something else than utf-8 so I've updated the script to explicitly use utf-8.
I'm actually using the latest Windwos 10, but it's probably a language preference issue, resulting in the default encoding being cp936.
FWIW on my bog-standard Windows 11:
python3 -c 'import locale; print(locale.getpreferredencoding()); import sys; print(sys.getdefaultencoding())'
cp1252
utf-8
@cxplay, @carlosame: thanks, indeed, this proves that assuming utf-8 as default won't always work on all platforms ootb, so the change was needed, as long as you don't insist that python should treat by default all your files as extended Latin encoding or whatever the OS decides to use as default unless explicitly specified 😄
with the latest update it should now work as expected
A quick note about relative hyperlinks.
On line 361, entry.name will list a folder as "folder", depending on the web system being run you may instead want/need it to include the tail slash to be "folder/" to avoid breaking relative hyperlinks.
I was working on an web system where index.html is displayed whenever a person goes to "/folder" or "/folder/" without redirecting to include the trailing slash. This unfortunately will mess up the relative links on the browser side after the user is viewing the "/folder" index.html and instead I would need ot make sure they clicked on it and were sent to "/folder/" so the next set of links will work.
I worked around this real quick and dirty since I couldn't find a pathlib option for it inside of 60 seconds of searching by changing around line 347 to look like
and making line 361 be:
<a href="{str(entry_name)}">