├── .gitignore ├── LICENSE ├── README.md ├── favicon.png ├── info.rkt ├── main.rkt └── screenshot.png /.gitignore: -------------------------------------------------------------------------------- 1 | compiled/ 2 | .*.swp 3 | .DS_Store 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # raco-static-web 2 | 3 | A little raco command to serve some files on the web. Inspired by the command 4 | line mode of the python [http.server module](https://docs.python.org/3/library/http.server.html). 5 | 6 | ![screen shot](screenshot.png) 7 | 8 | ## Usage 9 | 10 | 1. Ensure `raco` is in your `$PATH`. 11 | 2. Open terminal in directory you want to serve. 12 | - Alternatively use the `-d` command line option to specify a directory. 13 | 3. Run `raco static-web` to serve the current directory. 14 | 15 | For help and options use `raco help static-web`. 16 | 17 | ## Changelog 18 | ### 1.1.0 19 | Release date: 2023/01/06 20 | - Add the `--launch` option to open a browser after starting. 21 | 22 | ## 1.0.1 23 | Release date: 2022/09/22 24 | - Use response logging 25 | - Support for content-encoding: gzip 26 | 27 | ## 1.0.0 28 | Release date: 2022/06/05 29 | - Add content-type headers 30 | - Use a non non-blank 404 31 | - Add favicon 32 | 33 | ## 0.9.9 34 | Release date: 2021/11/03 35 | - Initial release 36 | 37 | ## Contributors: 38 | - [Ben Knoble](https://github.com/benknoble) : original code, directory 39 | listing, testing 40 | - [Ryan Culpepper](https://github.com/rmculpepper): command line 41 | - [Stephen De Gabrielle](https://github.com/spdegabrielle): docs 42 | - [Joel Dueck](https://github.com/otherjoel): `--launch` option 43 | - [Fred Fu](https://github.com/capfredf): docs 44 | - [Sorawee Porncharoenwase](https://github.com/sorawee): 404 page, upstream 45 | enhancements, response logging, gzip content encoding 46 | - [Sam Phillips](https://github.com/samdphillips) : shepherding, packaging 47 | 48 | file-line.png, folder-3-line.png, and folder-upload-line.png icons from the 49 | [Remix Icon](https://github.com/Remix-Design/RemixIcon) project. 50 | 51 | ## Plans 52 | Things I might add. PRs welcome if you get to this before me. 53 | 54 | - [ ] MIME types and more icons 55 | - [ ] split out directory listing into separate package 56 | 57 | -------------------------------------------------------------------------------- /favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/samdphillips/raco-static-web/1e93d3632b78fb7324d1edba953ab3b206faecd9/favicon.png -------------------------------------------------------------------------------- /info.rkt: -------------------------------------------------------------------------------- 1 | #lang info 2 | 3 | (define name "raco-static-web") 4 | (define collection "raco-static-web") 5 | (define version "1.1") 6 | (define deps '("base" "mime-type-lib" "net-lib" "version-case" "web-server-lib")) 7 | (define build-deps '()) 8 | (define pkg-authors '(samdphillips@gmail.com)) 9 | (define license 'Apache-2.0) 10 | (define raco-commands 11 | '(["static-web" 12 | (submod raco-static-web main) 13 | "runs a webserver serving files from the given directory" 14 | 10])) 15 | 16 | -------------------------------------------------------------------------------- /main.rkt: -------------------------------------------------------------------------------- 1 | #lang racket/base 2 | 3 | (require net/mime-type 4 | net/sendurl 5 | net/url 6 | racket/string 7 | racket/cmdline 8 | racket/exn 9 | racket/file 10 | racket/format 11 | racket/match 12 | racket/path 13 | racket/runtime-path 14 | raco/command-name 15 | (prefix-in sequencer: web-server/dispatchers/dispatch-sequencer) 16 | (prefix-in static-files: web-server/dispatchers/dispatch-files) 17 | (prefix-in lift: web-server/dispatchers/dispatch-lift) 18 | web-server/dispatchers/dispatch 19 | web-server/dispatchers/filesystem-map 20 | web-server/http/request-structs 21 | web-server/http/response-structs 22 | web-server/http/xexpr 23 | web-server/web-server 24 | version-case 25 | (for-syntax racket/base)) 26 | 27 | (version-case 28 | [(version< (version) "8.6") 29 | (begin 30 | (require (prefix-in log: web-server/dispatchers/dispatch-log)) 31 | (define-syntax-rule (with-logging (option ...) 32 | dispatcher ...) 33 | (sequencer:make (log:make option ...) 34 | dispatcher ...)) 35 | 36 | (define (files:make url->path _gzip?) 37 | (static-files:make #:url->path url->path 38 | #:path->mime-type path-mime-type)))] 39 | [else 40 | (begin 41 | (require (prefix-in log: web-server/dispatchers/dispatch-logresp)) 42 | (define-syntax-rule (with-logging (option ...) 43 | dispatcher ...) 44 | (log:make option ... 45 | (sequencer:make dispatcher ...))) 46 | (define ((path->headers gzip?) p) 47 | (cond 48 | [(and gzip? (string-suffix? (~a p) ".gz")) 49 | (list (header #"Content-Encoding" #"gzip"))] 50 | [else '()])) 51 | (define (files:make url->path gzip?) 52 | (static-files:make #:url->path url->path 53 | #:path->mime-type path-mime-type 54 | #:path->headers (path->headers gzip?))))]) 55 | 56 | 57 | (define-runtime-path favicon-path "favicon.png") 58 | 59 | (define file-icon 60 | (~a "data:image/png;base64," 61 | "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IAr" 62 | "s4c6QAAAJRJREFUSEvtldsRQDAQRU9KUgGlUBml0IGOGDMYr82NWf7ie5" 63 | "2zuUk2gZ+/8DOfFEENtC8aGYFiq1eCt/AbNyZ4gquGptWw11k/HOHNIaJ" 64 | "PBFd4B9w6M/ZEruAJvrA+E2wg69C4I4oJBqASx1VGlBqF5ckCOTByRDmi" 65 | "9JnjvmgybFFgvgc9UDrpp5mlpqPTRdKj75LMzaksGaIVe9kAAAAASUVOR" 66 | "K5CYII=")) 67 | 68 | (define folder-icon 69 | (~a "data:image/png;base64," 70 | "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IAr" 71 | "s4c6QAAAH5JREFUSEvtlcsNgDAMQ18nAzaHDRiFDUBFAvGpiKOqnNJz6h" 72 | "c7VZpofFJjfX4FjED34WgGBmDxuL46WIWLbogXIPSwl+Q0stvbDBQHKuD" 73 | "ULjmoHfzR6K4TgNJMIiLzpUZEEZGZgFzw2kXWhyMrAxPQP5edR0CurV3N" 74 | "Jqg5YAORiSQZT6N44AAAAABJRU5ErkJggg==")) 75 | 76 | (define folder-up-icon 77 | (~a "data:image/png;base64," 78 | "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IAr" 79 | "s4c6QAAALZJREFUSEvtldsNgzAMRQ8bdBNGKN2kTNaO0m7AKGxA5YhIQc" 80 | "3DJqXwAd+Xe3xty2nY+Gs29uevgBdwzSQagBswWlKHCSbFj2ZIDBBr2wW" 81 | "QhK2iCJGIVtIuZuATpOZihTgfbQJl4U62KPRwgPu8aX0m0uoEYv6YjZ9A" 82 | "CrIKEJr74lMQMyBmnoOYAWG7S6tcvUUnwLW79oRXDVlzMooAjYlG83XsS" 83 | "g+OxtRr3kD3i34XobUD3R/wAbP4MRlJ8mCBAAAAAElFTkSuQmCC")) 84 | 85 | (define root-url 86 | (url #f #f #f #f #t null null #f)) 87 | 88 | (define up-url 89 | (url #f #f #f #f #f (list (path/param 'up null)) null #f)) 90 | 91 | (define (relative-path-url-to-root p) 92 | (define simple-path (simplify-path p)) 93 | (define rel-path (find-relative-path (current-directory) simple-path)) 94 | (cond 95 | [(equal? simple-path rel-path) root-url] 96 | [else 97 | (define pp 98 | (for/list ([d (in-list (explode-path rel-path))]) 99 | (path/param (path->string d) null))) 100 | (url #f #f #f #f #t pp null #f)])) 101 | 102 | (define (make-file-link icon url text) 103 | `(li (a ([href ,(url->string url)]) 104 | (img ([src ,icon] 105 | [style "vertical-align: middle"]) "") 106 | ,text))) 107 | 108 | (define (files-list path) 109 | (for/list ([f (directory-list path #:build? #t)]) 110 | (define name (path->string (file-name-from-path f))) 111 | (define u (relative-path-url-to-root f)) 112 | (define icon 113 | (if (directory-exists? f) folder-icon file-icon)) 114 | (make-file-link icon u name))) 115 | 116 | (define (make-template-xexpr title-string body) 117 | `(html 118 | (head 119 | (title ,title-string)) 120 | (link ([rel "icon"] 121 | [type "image/png"] 122 | [href "favicon.png"])) 123 | (body 124 | (h1 ,title-string) 125 | (hr) 126 | ,body))) 127 | 128 | (define (directory-lister:make #:url->path url->path) 129 | (lift:make 130 | (lambda (req) 131 | (define-values (path pieces) (url->path (request-uri req))) 132 | (unless (directory-exists? path) 133 | (next-dispatcher)) 134 | (define root-path? 135 | (match pieces [(list 'same ...) #t] [_ #f])) 136 | (define title-string 137 | (~a "Directory of " 138 | (url->string (request-uri req)))) 139 | (response/xexpr 140 | (make-template-xexpr title-string 141 | `(ul ,@(if root-path? 142 | null 143 | (list (make-file-link folder-up-icon up-url ".."))) 144 | ,@(files-list path))))))) 145 | 146 | (define (favicon-request? req) 147 | (match (url-path (request-uri req)) 148 | [(list (path/param "favicon.png" '())) #t] 149 | [_ #f])) 150 | 151 | (define (favicon:make) 152 | (lift:make 153 | (lambda (req) 154 | (with-handlers ([exn:fail? 155 | (λ (e) (log-error 156 | "an error occurred serving favicon~% ~a" 157 | (exn->string e)) 158 | (next-dispatcher))]) 159 | (cond 160 | [(favicon-request? req) 161 | (response/full 200 #"OK" (current-seconds) #"image/png" null 162 | (list (file->bytes favicon-path)))] 163 | [else (next-dispatcher)]))))) 164 | 165 | (define (not-found req) 166 | (response/xexpr 167 | #:code 404 168 | #:message #"Not Found" 169 | #:seconds (current-seconds) 170 | #:mime-type #f 171 | (make-template-xexpr "Error response" 172 | '(div (p "Error code: 404") 173 | (p "Message: File not found."))))) 174 | 175 | (module* main #f 176 | (define BASE (current-directory)) 177 | (define PORT 8000) 178 | (define GZIP? #t) 179 | (define LAUNCH? #f) 180 | (command-line 181 | #:program (short-program+command-name) 182 | #:once-each 183 | [("-p" "--port") port [(format "Port to listen on (default: ~s)" PORT)] 184 | (let ([portn (string->number port)]) 185 | (unless (exact-positive-integer? portn) 186 | (raise-user-error 187 | (format "~a: bad port number: ~e" (short-program+command-name) port))) 188 | (set! PORT portn))] 189 | [("-d" "--dir") dir "Base directory (default: current directory)" 190 | (set! BASE (string->path dir))] 191 | [("-l" "--launch") "Launch browser after starting server" 192 | (set! LAUNCH? #t)] 193 | [("--no-gzip") "Do not use Content-Encoding 'gzip' on .gz files (for Racket <8.6, this option will always be on whether it's provided)" 194 | (set! GZIP? #f)] 195 | #:args () 196 | (void)) 197 | 198 | (define server-url (~a "http://localhost:" PORT)) 199 | (define shutdown-server 200 | (parameterize ([current-directory BASE]) 201 | (define url->path 202 | (make-url->path (current-directory))) 203 | (serve #:port PORT 204 | #:dispatch 205 | (with-logging (#:format (log:log-format->format 'apache-default) 206 | #:log-path (current-output-port)) 207 | (files:make url->path GZIP?) 208 | (favicon:make) 209 | (directory-lister:make #:url->path url->path) 210 | (lift:make not-found))))) 211 | 212 | (displayln (~a "Now serving " BASE " from " server-url)) 213 | (when LAUNCH? (send-url server-url)) 214 | 215 | (with-handlers ([exn:break? void]) (do-not-return)) 216 | (shutdown-server)) 217 | 218 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/samdphillips/raco-static-web/1e93d3632b78fb7324d1edba953ab3b206faecd9/screenshot.png --------------------------------------------------------------------------------