├── LICENSE.md ├── Makefile ├── README.md ├── config.rkt.default ├── mime.types ├── resources ├── content.md └── test.html └── uiki.rkt /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | ========================== 3 | 4 | Version 3, 29 June 2007 5 | 6 | Copyright © 2007 Free Software Foundation, Inc. <> 7 | 8 | Everyone is permitted to copy and distribute verbatim copies of this license 9 | document, but changing it is not allowed. 10 | 11 | ## Preamble 12 | 13 | The GNU General Public License is a free, copyleft license for software and other 14 | kinds of works. 15 | 16 | The licenses for most software and other practical works are designed to take away 17 | your freedom to share and change the works. By contrast, the GNU General Public 18 | License is intended to guarantee your freedom to share and change all versions of a 19 | program--to make sure it remains free software for all its users. We, the Free 20 | Software Foundation, use the GNU General Public License for most of our software; it 21 | applies also to any other work released this way by its authors. You can apply it to 22 | your programs, too. 23 | 24 | When we speak of free software, we are referring to freedom, not price. Our General 25 | Public Licenses are designed to make sure that you have the freedom to distribute 26 | copies of free software (and charge for them if you wish), that you receive source 27 | code or can get it if you want it, that you can change the software or use pieces of 28 | it in new free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you these rights or 31 | asking you to surrender the rights. Therefore, you have certain responsibilities if 32 | you distribute copies of the software, or if you modify it: responsibilities to 33 | respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether gratis or for a fee, 36 | you must pass on to the recipients the same freedoms that you received. You must make 37 | sure that they, too, receive or can get the source code. And you must show them these 38 | terms so they know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: (1) assert 41 | copyright on the software, and (2) offer you this License giving you legal permission 42 | to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains that there is 45 | no warranty for this free software. For both users' and authors' sake, the GPL 46 | requires that modified versions be marked as changed, so that their problems will not 47 | be attributed erroneously to authors of previous versions. 48 | 49 | Some devices are designed to deny users access to install or run modified versions of 50 | the software inside them, although the manufacturer can do so. This is fundamentally 51 | incompatible with the aim of protecting users' freedom to change the software. The 52 | systematic pattern of such abuse occurs in the area of products for individuals to 53 | use, which is precisely where it is most unacceptable. Therefore, we have designed 54 | this version of the GPL to prohibit the practice for those products. If such problems 55 | arise substantially in other domains, we stand ready to extend this provision to 56 | those domains in future versions of the GPL, as needed to protect the freedom of 57 | users. 58 | 59 | Finally, every program is threatened constantly by software patents. States should 60 | not allow patents to restrict development and use of software on general-purpose 61 | computers, but in those that do, we wish to avoid the special danger that patents 62 | applied to a free program could make it effectively proprietary. To prevent this, the 63 | GPL assures that patents cannot be used to render the program non-free. 64 | 65 | The precise terms and conditions for copying, distribution and modification follow. 66 | 67 | ## TERMS AND CONDITIONS 68 | 69 | ### 0. Definitions. 70 | 71 | “This License” refers to version 3 of the GNU General Public License. 72 | 73 | “Copyright” also means copyright-like laws that apply to other kinds of 74 | works, such as semiconductor masks. 75 | 76 | “The Program” refers to any copyrightable work licensed under this 77 | License. Each licensee is addressed as “you”. “Licensees” and 78 | “recipients” may be individuals or organizations. 79 | 80 | To “modify” a work means to copy from or adapt all or part of the work in 81 | a fashion requiring copyright permission, other than the making of an exact copy. The 82 | resulting work is called a “modified version” of the earlier work or a 83 | work “based on” the earlier work. 84 | 85 | A “covered work” means either the unmodified Program or a work based on 86 | the Program. 87 | 88 | To “propagate” a work means to do anything with it that, without 89 | permission, would make you directly or secondarily liable for infringement under 90 | applicable copyright law, except executing it on a computer or modifying a private 91 | copy. Propagation includes copying, distribution (with or without modification), 92 | making available to the public, and in some countries other activities as well. 93 | 94 | To “convey” a work means any kind of propagation that enables other 95 | parties to make or receive copies. Mere interaction with a user through a computer 96 | network, with no transfer of a copy, is not conveying. 97 | 98 | An interactive user interface displays “Appropriate Legal Notices” to the 99 | extent that it includes a convenient and prominently visible feature that (1) 100 | displays an appropriate copyright notice, and (2) tells the user that there is no 101 | warranty for the work (except to the extent that warranties are provided), that 102 | licensees may convey the work under this License, and how to view a copy of this 103 | License. If the interface presents a list of user commands or options, such as a 104 | menu, a prominent item in the list meets this criterion. 105 | 106 | ### 1. Source Code. 107 | 108 | The “source code” for a work means the preferred form of the work for 109 | making modifications to it. “Object code” means any non-source form of a 110 | work. 111 | 112 | A “Standard Interface” means an interface that either is an official 113 | standard defined by a recognized standards body, or, in the case of interfaces 114 | specified for a particular programming language, one that is widely used among 115 | developers working in that language. 116 | 117 | The “System Libraries” of an executable work include anything, other than 118 | the work as a whole, that (a) is included in the normal form of packaging a Major 119 | Component, but which is not part of that Major Component, and (b) serves only to 120 | enable use of the work with that Major Component, or to implement a Standard 121 | Interface for which an implementation is available to the public in source code form. 122 | A “Major Component”, in this context, means a major essential component 123 | (kernel, window system, and so on) of the specific operating system (if any) on which 124 | the executable work runs, or a compiler used to produce the work, or an object code 125 | interpreter used to run it. 126 | 127 | The “Corresponding Source” for a work in object code form means all the 128 | source code needed to generate, install, and (for an executable work) run the object 129 | code and to modify the work, including scripts to control those activities. However, 130 | it does not include the work's System Libraries, or general-purpose tools or 131 | generally available free programs which are used unmodified in performing those 132 | activities but which are not part of the work. For example, Corresponding Source 133 | includes interface definition files associated with source files for the work, and 134 | the source code for shared libraries and dynamically linked subprograms that the work 135 | is specifically designed to require, such as by intimate data communication or 136 | control flow between those subprograms and other parts of the work. 137 | 138 | The Corresponding Source need not include anything that users can regenerate 139 | automatically from other parts of the Corresponding Source. 140 | 141 | The Corresponding Source for a work in source code form is that same work. 142 | 143 | ### 2. Basic Permissions. 144 | 145 | All rights granted under this License are granted for the term of copyright on the 146 | Program, and are irrevocable provided the stated conditions are met. This License 147 | explicitly affirms your unlimited permission to run the unmodified Program. The 148 | output from running a covered work is covered by this License only if the output, 149 | given its content, constitutes a covered work. This License acknowledges your rights 150 | of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not convey, without 153 | conditions so long as your license otherwise remains in force. You may convey covered 154 | works to others for the sole purpose of having them make modifications exclusively 155 | for you, or provide you with facilities for running those works, provided that you 156 | comply with the terms of this License in conveying all material for which you do not 157 | control copyright. Those thus making or running the covered works for you must do so 158 | exclusively on your behalf, under your direction and control, on terms that prohibit 159 | them from making any copies of your copyrighted material outside their relationship 160 | with you. 161 | 162 | Conveying under any other circumstances is permitted solely under the conditions 163 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 164 | 165 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 166 | 167 | No covered work shall be deemed part of an effective technological measure under any 168 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 169 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 170 | of such measures. 171 | 172 | When you convey a covered work, you waive any legal power to forbid circumvention of 173 | technological measures to the extent such circumvention is effected by exercising 174 | rights under this License with respect to the covered work, and you disclaim any 175 | intention to limit operation or modification of the work as a means of enforcing, 176 | against the work's users, your or third parties' legal rights to forbid circumvention 177 | of technological measures. 178 | 179 | ### 4. Conveying Verbatim Copies. 180 | 181 | You may convey verbatim copies of the Program's source code as you receive it, in any 182 | medium, provided that you conspicuously and appropriately publish on each copy an 183 | appropriate copyright notice; keep intact all notices stating that this License and 184 | any non-permissive terms added in accord with section 7 apply to the code; keep 185 | intact all notices of the absence of any warranty; and give all recipients a copy of 186 | this License along with the Program. 187 | 188 | You may charge any price or no price for each copy that you convey, and you may offer 189 | support or warranty protection for a fee. 190 | 191 | ### 5. Conveying Modified Source Versions. 192 | 193 | You may convey a work based on the Program, or the modifications to produce it from 194 | the Program, in the form of source code under the terms of section 4, provided that 195 | you also meet all of these conditions: 196 | 197 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 198 | relevant date. 199 | * **b)** The work must carry prominent notices stating that it is released under this 200 | License and any conditions added under section 7. This requirement modifies the 201 | requirement in section 4 to “keep intact all notices”. 202 | * **c)** You must license the entire work, as a whole, under this License to anyone who 203 | comes into possession of a copy. This License will therefore apply, along with any 204 | applicable section 7 additional terms, to the whole of the work, and all its parts, 205 | regardless of how they are packaged. This License gives no permission to license the 206 | work in any other way, but it does not invalidate such permission if you have 207 | separately received it. 208 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 209 | Notices; however, if the Program has interactive interfaces that do not display 210 | Appropriate Legal Notices, your work need not make them do so. 211 | 212 | A compilation of a covered work with other separate and independent works, which are 213 | not by their nature extensions of the covered work, and which are not combined with 214 | it such as to form a larger program, in or on a volume of a storage or distribution 215 | medium, is called an “aggregate” if the compilation and its resulting 216 | copyright are not used to limit the access or legal rights of the compilation's users 217 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 218 | does not cause this License to apply to the other parts of the aggregate. 219 | 220 | ### 6. Conveying Non-Source Forms. 221 | 222 | You may convey a covered work in object code form under the terms of sections 4 and 223 | 5, provided that you also convey the machine-readable Corresponding Source under the 224 | terms of this License, in one of these ways: 225 | 226 | * **a)** Convey the object code in, or embodied in, a physical product (including a 227 | physical distribution medium), accompanied by the Corresponding Source fixed on a 228 | durable physical medium customarily used for software interchange. 229 | * **b)** Convey the object code in, or embodied in, a physical product (including a 230 | physical distribution medium), accompanied by a written offer, valid for at least 231 | three years and valid for as long as you offer spare parts or customer support for 232 | that product model, to give anyone who possesses the object code either (1) a copy of 233 | the Corresponding Source for all the software in the product that is covered by this 234 | License, on a durable physical medium customarily used for software interchange, for 235 | a price no more than your reasonable cost of physically performing this conveying of 236 | source, or (2) access to copy the Corresponding Source from a network server at no 237 | charge. 238 | * **c)** Convey individual copies of the object code with a copy of the written offer to 239 | provide the Corresponding Source. This alternative is allowed only occasionally and 240 | noncommercially, and only if you received the object code with such an offer, in 241 | accord with subsection 6b. 242 | * **d)** Convey the object code by offering access from a designated place (gratis or for 243 | a charge), and offer equivalent access to the Corresponding Source in the same way 244 | through the same place at no further charge. You need not require recipients to copy 245 | the Corresponding Source along with the object code. If the place to copy the object 246 | code is a network server, the Corresponding Source may be on a different server 247 | (operated by you or a third party) that supports equivalent copying facilities, 248 | provided you maintain clear directions next to the object code saying where to find 249 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 250 | you remain obligated to ensure that it is available for as long as needed to satisfy 251 | these requirements. 252 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 253 | other peers where the object code and Corresponding Source of the work are being 254 | offered to the general public at no charge under subsection 6d. 255 | 256 | A separable portion of the object code, whose source code is excluded from the 257 | Corresponding Source as a System Library, need not be included in conveying the 258 | object code work. 259 | 260 | A “User Product” is either (1) a “consumer product”, which 261 | means any tangible personal property which is normally used for personal, family, or 262 | household purposes, or (2) anything designed or sold for incorporation into a 263 | dwelling. In determining whether a product is a consumer product, doubtful cases 264 | shall be resolved in favor of coverage. For a particular product received by a 265 | particular user, “normally used” refers to a typical or common use of 266 | that class of product, regardless of the status of the particular user or of the way 267 | in which the particular user actually uses, or expects or is expected to use, the 268 | product. A product is a consumer product regardless of whether the product has 269 | substantial commercial, industrial or non-consumer uses, unless such uses represent 270 | the only significant mode of use of the product. 271 | 272 | “Installation Information” for a User Product means any methods, 273 | procedures, authorization keys, or other information required to install and execute 274 | modified versions of a covered work in that User Product from a modified version of 275 | its Corresponding Source. The information must suffice to ensure that the continued 276 | functioning of the modified object code is in no case prevented or interfered with 277 | solely because modification has been made. 278 | 279 | If you convey an object code work under this section in, or with, or specifically for 280 | use in, a User Product, and the conveying occurs as part of a transaction in which 281 | the right of possession and use of the User Product is transferred to the recipient 282 | in perpetuity or for a fixed term (regardless of how the transaction is 283 | characterized), the Corresponding Source conveyed under this section must be 284 | accompanied by the Installation Information. But this requirement does not apply if 285 | neither you nor any third party retains the ability to install modified object code 286 | on the User Product (for example, the work has been installed in ROM). 287 | 288 | The requirement to provide Installation Information does not include a requirement to 289 | continue to provide support service, warranty, or updates for a work that has been 290 | modified or installed by the recipient, or for the User Product in which it has been 291 | modified or installed. Access to a network may be denied when the modification itself 292 | materially and adversely affects the operation of the network or violates the rules 293 | and protocols for communication across the network. 294 | 295 | Corresponding Source conveyed, and Installation Information provided, in accord with 296 | this section must be in a format that is publicly documented (and with an 297 | implementation available to the public in source code form), and must require no 298 | special password or key for unpacking, reading or copying. 299 | 300 | ### 7. Additional Terms. 301 | 302 | “Additional permissions” are terms that supplement the terms of this 303 | License by making exceptions from one or more of its conditions. Additional 304 | permissions that are applicable to the entire Program shall be treated as though they 305 | were included in this License, to the extent that they are valid under applicable 306 | law. If additional permissions apply only to part of the Program, that part may be 307 | used separately under those permissions, but the entire Program remains governed by 308 | this License without regard to the additional permissions. 309 | 310 | When you convey a copy of a covered work, you may at your option remove any 311 | additional permissions from that copy, or from any part of it. (Additional 312 | permissions may be written to require their own removal in certain cases when you 313 | modify the work.) You may place additional permissions on material, added by you to a 314 | covered work, for which you have or can give appropriate copyright permission. 315 | 316 | Notwithstanding any other provision of this License, for material you add to a 317 | covered work, you may (if authorized by the copyright holders of that material) 318 | supplement the terms of this License with terms: 319 | 320 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 321 | sections 15 and 16 of this License; or 322 | * **b)** Requiring preservation of specified reasonable legal notices or author 323 | attributions in that material or in the Appropriate Legal Notices displayed by works 324 | containing it; or 325 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 326 | modified versions of such material be marked in reasonable ways as different from the 327 | original version; or 328 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 329 | material; or 330 | * **e)** Declining to grant rights under trademark law for use of some trade names, 331 | trademarks, or service marks; or 332 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 333 | who conveys the material (or modified versions of it) with contractual assumptions of 334 | liability to the recipient, for any liability that these contractual assumptions 335 | directly impose on those licensors and authors. 336 | 337 | All other non-permissive additional terms are considered “further 338 | restrictions” within the meaning of section 10. If the Program as you received 339 | it, or any part of it, contains a notice stating that it is governed by this License 340 | along with a term that is a further restriction, you may remove that term. If a 341 | license document contains a further restriction but permits relicensing or conveying 342 | under this License, you may add to a covered work material governed by the terms of 343 | that license document, provided that the further restriction does not survive such 344 | relicensing or conveying. 345 | 346 | If you add terms to a covered work in accord with this section, you must place, in 347 | the relevant source files, a statement of the additional terms that apply to those 348 | files, or a notice indicating where to find the applicable terms. 349 | 350 | Additional terms, permissive or non-permissive, may be stated in the form of a 351 | separately written license, or stated as exceptions; the above requirements apply 352 | either way. 353 | 354 | ### 8. Termination. 355 | 356 | You may not propagate or modify a covered work except as expressly provided under 357 | this License. Any attempt otherwise to propagate or modify it is void, and will 358 | automatically terminate your rights under this License (including any patent licenses 359 | granted under the third paragraph of section 11). 360 | 361 | However, if you cease all violation of this License, then your license from a 362 | particular copyright holder is reinstated (a) provisionally, unless and until the 363 | copyright holder explicitly and finally terminates your license, and (b) permanently, 364 | if the copyright holder fails to notify you of the violation by some reasonable means 365 | prior to 60 days after the cessation. 366 | 367 | Moreover, your license from a particular copyright holder is reinstated permanently 368 | if the copyright holder notifies you of the violation by some reasonable means, this 369 | is the first time you have received notice of violation of this License (for any 370 | work) from that copyright holder, and you cure the violation prior to 30 days after 371 | your receipt of the notice. 372 | 373 | Termination of your rights under this section does not terminate the licenses of 374 | parties who have received copies or rights from you under this License. If your 375 | rights have been terminated and not permanently reinstated, you do not qualify to 376 | receive new licenses for the same material under section 10. 377 | 378 | ### 9. Acceptance Not Required for Having Copies. 379 | 380 | You are not required to accept this License in order to receive or run a copy of the 381 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 382 | using peer-to-peer transmission to receive a copy likewise does not require 383 | acceptance. However, nothing other than this License grants you permission to 384 | propagate or modify any covered work. These actions infringe copyright if you do not 385 | accept this License. Therefore, by modifying or propagating a covered work, you 386 | indicate your acceptance of this License to do so. 387 | 388 | ### 10. Automatic Licensing of Downstream Recipients. 389 | 390 | Each time you convey a covered work, the recipient automatically receives a license 391 | from the original licensors, to run, modify and propagate that work, subject to this 392 | License. You are not responsible for enforcing compliance by third parties with this 393 | License. 394 | 395 | An “entity transaction” is a transaction transferring control of an 396 | organization, or substantially all assets of one, or subdividing an organization, or 397 | merging organizations. If propagation of a covered work results from an entity 398 | transaction, each party to that transaction who receives a copy of the work also 399 | receives whatever licenses to the work the party's predecessor in interest had or 400 | could give under the previous paragraph, plus a right to possession of the 401 | Corresponding Source of the work from the predecessor in interest, if the predecessor 402 | has it or can get it with reasonable efforts. 403 | 404 | You may not impose any further restrictions on the exercise of the rights granted or 405 | affirmed under this License. For example, you may not impose a license fee, royalty, 406 | or other charge for exercise of rights granted under this License, and you may not 407 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 408 | that any patent claim is infringed by making, using, selling, offering for sale, or 409 | importing the Program or any portion of it. 410 | 411 | ### 11. Patents. 412 | 413 | A “contributor” is a copyright holder who authorizes use under this 414 | License of the Program or a work on which the Program is based. The work thus 415 | licensed is called the contributor's “contributor version”. 416 | 417 | A contributor's “essential patent claims” are all patent claims owned or 418 | controlled by the contributor, whether already acquired or hereafter acquired, that 419 | would be infringed by some manner, permitted by this License, of making, using, or 420 | selling its contributor version, but do not include claims that would be infringed 421 | only as a consequence of further modification of the contributor version. For 422 | purposes of this definition, “control” includes the right to grant patent 423 | sublicenses in a manner consistent with the requirements of this License. 424 | 425 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 426 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 427 | import and otherwise run, modify and propagate the contents of its contributor 428 | version. 429 | 430 | In the following three paragraphs, a “patent license” is any express 431 | agreement or commitment, however denominated, not to enforce a patent (such as an 432 | express permission to practice a patent or covenant not to sue for patent 433 | infringement). To “grant” such a patent license to a party means to make 434 | such an agreement or commitment not to enforce a patent against the party. 435 | 436 | If you convey a covered work, knowingly relying on a patent license, and the 437 | Corresponding Source of the work is not available for anyone to copy, free of charge 438 | and under the terms of this License, through a publicly available network server or 439 | other readily accessible means, then you must either (1) cause the Corresponding 440 | Source to be so available, or (2) arrange to deprive yourself of the benefit of the 441 | patent license for this particular work, or (3) arrange, in a manner consistent with 442 | the requirements of this License, to extend the patent license to downstream 443 | recipients. “Knowingly relying” means you have actual knowledge that, but 444 | for the patent license, your conveying the covered work in a country, or your 445 | recipient's use of the covered work in a country, would infringe one or more 446 | identifiable patents in that country that you have reason to believe are valid. 447 | 448 | If, pursuant to or in connection with a single transaction or arrangement, you 449 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 450 | license to some of the parties receiving the covered work authorizing them to use, 451 | propagate, modify or convey a specific copy of the covered work, then the patent 452 | license you grant is automatically extended to all recipients of the covered work and 453 | works based on it. 454 | 455 | A patent license is “discriminatory” if it does not include within the 456 | scope of its coverage, prohibits the exercise of, or is conditioned on the 457 | non-exercise of one or more of the rights that are specifically granted under this 458 | License. You may not convey a covered work if you are a party to an arrangement with 459 | a third party that is in the business of distributing software, under which you make 460 | payment to the third party based on the extent of your activity of conveying the 461 | work, and under which the third party grants, to any of the parties who would receive 462 | the covered work from you, a discriminatory patent license (a) in connection with 463 | copies of the covered work conveyed by you (or copies made from those copies), or (b) 464 | primarily for and in connection with specific products or compilations that contain 465 | the covered work, unless you entered into that arrangement, or that patent license 466 | was granted, prior to 28 March 2007. 467 | 468 | Nothing in this License shall be construed as excluding or limiting any implied 469 | license or other defenses to infringement that may otherwise be available to you 470 | under applicable patent law. 471 | 472 | ### 12. No Surrender of Others' Freedom. 473 | 474 | If conditions are imposed on you (whether by court order, agreement or otherwise) 475 | that contradict the conditions of this License, they do not excuse you from the 476 | conditions of this License. If you cannot convey a covered work so as to satisfy 477 | simultaneously your obligations under this License and any other pertinent 478 | obligations, then as a consequence you may not convey it at all. For example, if you 479 | agree to terms that obligate you to collect a royalty for further conveying from 480 | those to whom you convey the Program, the only way you could satisfy both those terms 481 | and this License would be to refrain entirely from conveying the Program. 482 | 483 | ### 13. Use with the GNU Affero General Public License. 484 | 485 | Notwithstanding any other provision of this License, you have permission to link or 486 | combine any covered work with a work licensed under version 3 of the GNU Affero 487 | General Public License into a single combined work, and to convey the resulting work. 488 | The terms of this License will continue to apply to the part which is the covered 489 | work, but the special requirements of the GNU Affero General Public License, section 490 | 13, concerning interaction through a network will apply to the combination as such. 491 | 492 | ### 14. Revised Versions of this License. 493 | 494 | The Free Software Foundation may publish revised and/or new versions of the GNU 495 | General Public License from time to time. Such new versions will be similar in spirit 496 | to the present version, but may differ in detail to address new problems or concerns. 497 | 498 | Each version is given a distinguishing version number. If the Program specifies that 499 | a certain numbered version of the GNU General Public License “or any later 500 | version” applies to it, you have the option of following the terms and 501 | conditions either of that numbered version or of any later version published by the 502 | Free Software Foundation. If the Program does not specify a version number of the GNU 503 | General Public License, you may choose any version ever published by the Free 504 | Software Foundation. 505 | 506 | If the Program specifies that a proxy can decide which future versions of the GNU 507 | General Public License can be used, that proxy's public statement of acceptance of a 508 | version permanently authorizes you to choose that version for the Program. 509 | 510 | Later license versions may give you additional or different permissions. However, no 511 | additional obligations are imposed on any author or copyright holder as a result of 512 | your choosing to follow a later version. 513 | 514 | ### 15. Disclaimer of Warranty. 515 | 516 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 517 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 518 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 519 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 520 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 521 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 522 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 523 | 524 | ### 16. Limitation of Liability. 525 | 526 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 527 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 528 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 529 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 530 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 531 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 532 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 533 | POSSIBILITY OF SUCH DAMAGES. 534 | 535 | ### 17. Interpretation of Sections 15 and 16. 536 | 537 | If the disclaimer of warranty and limitation of liability provided above cannot be 538 | given local legal effect according to their terms, reviewing courts shall apply local 539 | law that most closely approximates an absolute waiver of all civil liability in 540 | connection with the Program, unless a warranty or assumption of liability accompanies 541 | a copy of the Program in return for a fee. 542 | 543 | END OF TERMS AND CONDITIONS 544 | 545 | ## How to Apply These Terms to Your New Programs 546 | 547 | If you develop a new program, and you want it to be of the greatest possible use to 548 | the public, the best way to achieve this is to make it free software which everyone 549 | can redistribute and change under these terms. 550 | 551 | To do so, attach the following notices to the program. It is safest to attach them 552 | to the start of each source file to most effectively state the exclusion of warranty; 553 | and each file should have at least the “copyright” line and a pointer to 554 | where the full notice is found. 555 | 556 | 557 | Copyright (C) 558 | 559 | This program is free software: you can redistribute it and/or modify 560 | it under the terms of the GNU General Public License as published by 561 | the Free Software Foundation, either version 3 of the License, or 562 | (at your option) any later version. 563 | 564 | This program is distributed in the hope that it will be useful, 565 | but WITHOUT ANY WARRANTY; without even the implied warranty of 566 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 567 | GNU General Public License for more details. 568 | 569 | You should have received a copy of the GNU General Public License 570 | along with this program. If not, see . 571 | 572 | Also add information on how to contact you by electronic and paper mail. 573 | 574 | If the program does terminal interaction, make it output a short notice like this 575 | when it starts in an interactive mode: 576 | 577 | Copyright (C) 578 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 579 | This is free software, and you are welcome to redistribute it 580 | under certain conditions; type 'show c' for details. 581 | 582 | The hypothetical commands 'show w' and 'show c' should show the appropriate parts of 583 | the General Public License. Of course, your program's commands might be different; 584 | for a GUI interface, you would use an “about box”. 585 | 586 | You should also get your employer (if you work as a programmer) or school, if any, to 587 | sign a “copyright disclaimer” for the program, if necessary. For more 588 | information on this, and how to apply and follow the GNU GPL, see 589 | <>. 590 | 591 | The GNU General Public License does not permit incorporating your program into 592 | proprietary programs. If your program is a subroutine library, you may consider it 593 | more useful to permit linking proprietary applications with the library. If this is 594 | what you want to do, use the GNU Lesser General Public License instead of this 595 | License. But first, please read 596 | <>. 597 | 598 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | 2 | .PHONY: run 3 | run: config.rkt db docroot passwd 4 | racket uiki.rkt 5 | 6 | db: 7 | mkdir db 8 | mkdir db/main 9 | cp -v resources/content.md db/main/ 10 | 11 | passwd: 12 | echo 'Enter a password for the user `admin`': 13 | @htpasswd -sc passwd admin 14 | 15 | docroot: 16 | mkdir docroot 17 | cp -v resources/test.html docroot/ 18 | 19 | certs: 20 | mkdir certs 21 | cd certs; openssl req -nodes -new -x509 -keyout private-key.pem -out server-cert.pem; chmod 400 private-key.pem 22 | 23 | .PHONY: runroot 24 | runroot: config.rkt db docroot 25 | sudo racket uiki.rkt 26 | 27 | config.rkt: config.rkt.default 28 | cp -v config.rkt.default config.rkt 29 | 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Uiki: A simple academic wiki 2 | 3 | Uiki (wee-kee) is a simple academic wiki which supports: 4 | 5 | + [MathJax] for LaTeX formatting 6 | + [multimarkdown] for markdown formatting 7 | + git for page versioning/offline editing 8 | + [prettify] for syntax highlighting 9 | + `htpasswd`-style files for user authentication 10 | + SSL-encrypted connections 11 | 12 | To enable remote checkouts/editing and to avoid the 13 | risk of losing data due to upgrades, all uiki pages are stored 14 | in (markdown-formatted) plaintext. 15 | 16 | For a page ``, the content for that page will be (by default) in: 17 | 18 | db//content.md 19 | 20 | which is also easily editable by a text editor on the server. 21 | 22 | This program serves as the motivation for my article on 23 | [web programming in Racket](http://matt.might.net/articles/low-level-web-in-racket/). 24 | 25 | 26 | ## Dependencies 27 | 28 | + racket 29 | + git 30 | + multimarkdown 31 | + sed 32 | + htpasswd (bundled with Apache) 33 | + openssl (if generating a key and cert) 34 | 35 | 36 | ## Installation 37 | 38 | There is no installation. Uiki runs in place. 39 | 40 | 41 | ## Running 42 | 43 | To run uiki, use: 44 | 45 | make run 46 | 47 | or directly with: 48 | 49 | racket uiki.rkt 50 | 51 | By default, it will be on port 8080, and the main page is `/wiki/main`. 52 | 53 | After you start it, set your browser to: 54 | 55 | http://localhost:8080/wiki/main 56 | 57 | 58 | 59 | ## Configuration 60 | 61 | Configuration parameters are in `config.rkt`. 62 | 63 | By default, authentication is on, but SSL is off. 64 | 65 | To generate `config.rkt`, run `make config.rkt`. 66 | 67 | The first time the server runs, it will create a `passwd` 68 | file and ask you to create an `admin` account. 69 | 70 | 71 | 72 | ## Adding users 73 | 74 | You can add users with `htpasswd` by modifying `passwd`, 75 | but users must use SHA1-hashed passwords. 76 | 77 | For example, in the application directory: 78 | 79 | htpasswd -s passwd john 80 | 81 | 82 | 83 | ## Enabling SSL 84 | 85 | Run `make certs` to generate a private key and a self-signed 86 | certificate in the directory `certs`. 87 | 88 | Then, modify the approriate entries in `global.rkt` to point 89 | to these, and set `use-ssl?` to `#t`. 90 | 91 | 92 | 93 | ## Wiki syntax 94 | 95 | You can link to new pages by enclosing their name in `[[` and `]]`. 96 | 97 | You can use the pipe `[[target|text]]` notation to redirect a 98 | within-wiki link. 99 | 100 | 101 | ## Markdown syntax 102 | 103 | Markdown syntax is supported by [multimarkdown]. 104 | 105 | 106 | ## LaTeX syntax 107 | 108 | Inline LaTeX syntax is supported with `$`-notation, as in `$f(x)$`. 109 | 110 | Equation blocks are supported by surrounding LaTeX with `\\[` and `\\]`, 111 | as in: 112 | 113 | ``` 114 | \\[ 115 | Z = \int_0^\infty g(x)d(x) 116 | \\] 117 | ``` 118 | 119 | 120 | ## Syntax highlighting 121 | 122 | You can render code with syntax highlighting in 123 | a fenced block by specifying the language, as in: 124 | 125 | ```javascript 126 | function main () { 127 | printf("Running some code.") 128 | } 129 | ``` 130 | 131 | ## License 132 | 133 | Uiki: A simple academic wiki. 134 | 135 | Copyright (©) 2015 Matthew Might 136 | 137 | This program is free software: you can redistribute it and/or modify 138 | it under the terms of the GNU General Public License as published by 139 | the Free Software Foundation, either version 3 of the License, or 140 | (at your option) any later version. 141 | 142 | This program is distributed in the hope that it will be useful, 143 | but WITHOUT ANY WARRANTY; without even the implied warranty of 144 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 145 | GNU General Public License for more details. 146 | 147 | You should have received a copy of the GNU General Public License 148 | along with this program. If not, see . 149 | 150 | 151 | [prettify]: https://github.com/google/code-prettify 152 | 153 | [MathJax]: https://www.mathjax.org/ 154 | 155 | [multimarkdown]: http://fletcherpenney.net/multimarkdown/ 156 | 157 | -------------------------------------------------------------------------------- /config.rkt.default: -------------------------------------------------------------------------------- 1 | ; the name of the giki: 2 | (define uiki-name "generic uiki") 3 | 4 | ; TCP port number: 5 | (define uiki-port 8080) ; set this to 8080 for testing 6 | ; set this to 80 if unencrypted 7 | ; set this to 443 if using SSL 8 | 9 | 10 | ; the root directory: 11 | (define root (path->string (current-directory))) 12 | 13 | ; mime types: 14 | (define mime-types-file (string-append root "/mime.types")) 15 | 16 | ; the database directory: 17 | (define database-dir (string-append root "/db")) 18 | 19 | ; the root for static files: 20 | (define document-root (string-append root "/docroot")) 21 | 22 | ; the default stylesheet included in every page: 23 | (define default-style 24 | " 25 | body { 26 | font-family: Palatino, Georgia ; 27 | } 28 | 29 | pre { 30 | font-family: \"CMU Typewriter Text\", Courier, \"Courier New\" ; 31 | } 32 | ") 33 | 34 | ; the command for processing markdown into html: 35 | (define markdown-command "multimarkdown") 36 | 37 | ; the command for preprocessing markdown into markdown: 38 | (define markdown-preprocess-command "sed -E -e 's/^```([a-z]+)/```prettyprint lang-\\1/'") 39 | 40 | ; the authentication database: 41 | (define auth-db-path (string-append root "/passwd")) 42 | ; set this to #f to disable authentication 43 | 44 | 45 | ; SSL parameters 46 | (define use-ssl? #f) 47 | 48 | (define ssl-cert-path #f) 49 | ; If enabled, try: 50 | ; (string-append root "/certs/server-cert.pem") 51 | 52 | (define ssl-private-key-path #f) 53 | ; If enabled, try: 54 | ; (string-append root "/certs/private-key.pem") 55 | 56 | ; see the racket documentation on Continue 57 | ; for how to generate the certificate and private key 58 | ; needed for SSL 59 | 60 | -------------------------------------------------------------------------------- /mime.types: -------------------------------------------------------------------------------- 1 | # MIME type Extensions 2 | text/plain txt text conf log 3 | text/html html htm 4 | image/png png 5 | image/jpeg jpeg jpg jpe 6 | -------------------------------------------------------------------------------- /resources/content.md: -------------------------------------------------------------------------------- 1 | # Main page # 2 | 3 | Welcome to the main page. 4 | 5 | To configure this wiki, edit `config.rkt` in the root directory. 6 | 7 | 8 | ## Wiki syntax 9 | 10 | You can link to new pages by enclosing their name in [[ and `]]`, as in [[The Sandbox]]. 11 | 12 | You can use the pipe [[`target|text]]` notation to [[The Sandbox|redirect]] a within-wiki link. 13 | 14 | 15 | ## Markdown syntax 16 | 17 | Markdown syntax is supported by [multimarkdown]. 18 | 19 | 20 | ## LaTeX syntax 21 | 22 | Inline LaTeX syntax is supported with `$`-notation, so that `$f(x)$` produces $f(x)$. 23 | 24 | Equation blocks are supported by surrounding LaTeX with `\\[` and `\\]`, so that 25 | 26 | ``` 27 | \\[ 28 | Z = \int_0^\infty g(x)d(x) 29 | \\] 30 | ``` 31 | 32 | produces: 33 | 34 | \\[ 35 | Z = \int_0^\infty g(x)d(x) 36 | \\] 37 | 38 | 39 | ## Syntax highlighting 40 | 41 | You can render code with syntax highlighting in 42 | a fenced block by specifying the language, so that: 43 | 44 | ````` 45 | ````javascript 46 | function main () { 47 | printf("Running some code.") 48 | } 49 | ```` 50 | ````` 51 | 52 | produces: 53 | 54 | ```javascript 55 | function main () { 56 | printf("Running some code.") 57 | } 58 | ``` 59 | 60 | 61 | 62 | [multimarkdown]: http://fletcherpenney.net/multimarkdown/ 63 | 64 | 65 | -------------------------------------------------------------------------------- /resources/test.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Testing static serving. 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /uiki.rkt: -------------------------------------------------------------------------------- 1 | #lang racket 2 | 3 | ; Uiki: A simple academic wiki. 4 | ; Copyright (C) 2015 Matthew Might 5 | 6 | ; This program is free software: you can redistribute it and/or modify 7 | ; it under the terms of the GNU General Public License as published by 8 | ; the Free Software Foundation, either version 3 of the License, or 9 | ; (at your option) any later version. 10 | 11 | ; This program is distributed in the hope that it will be useful, 12 | ; but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | ; GNU General Public License for more details. 15 | 16 | ; You should have received a copy of the GNU General Public License 17 | ; along with this program. If not, see . 18 | 19 | 20 | ; DEPENDENCIES: 21 | 22 | ; + racket 6.1.1+ (earlier versions might work) 23 | ; + git 24 | ; + multimarkdown 25 | ; + sed 26 | ; + htpasswd (bundled with apache) 27 | 28 | ; FEATURES: 29 | 30 | ; + Markdown support via multimarkdown 31 | ; + LaTeX support via MathJax 32 | ; + Syntax highlighting support via code-prettify 33 | ; + Backup/versioning support via git 34 | 35 | ; KNOWN BUGS: 36 | 37 | ; + No warning on racing edits. 38 | 39 | ; TODO: 40 | 41 | ; + Include suffices in links, e.g., [[cat]]s renders as `cats` 42 | ; + Add web interface for version control 43 | ; + Add support for local install of MathJax 44 | ; + Add support for local install of code-prettify 45 | ; + Add support for git over ssh access to page repos 46 | ; + Add support for git over http access to page repos (git-http-backend) 47 | ; + Add support for site-wide LaTeX macro files inclusion 48 | ; + Add support for HTTP authentication 49 | ; + Allow uplodaing images 50 | ; + Allow uploading other file types (pdf) 51 | ; + Add support for citation management with .bib files 52 | 53 | ; SECURITY ISSUES: 54 | 55 | ; + Strip out problematic (all?) HTML tags: script, style, etc. 56 | ; + Verify absence of injection for shell/system/process uses. 57 | 58 | ; CONSIDER: 59 | 60 | ; + Could git submodules allow database to be giant module? 61 | ; Would this allow checking out entire wiki db locally? 62 | 63 | 64 | (require web-server/servlet 65 | web-server/servlet-env) 66 | 67 | (require web-server/private/mime-types) 68 | 69 | (require xml) 70 | 71 | (require parser-tools/lex) 72 | (require (prefix-in : parser-tools/lex-sre)) 73 | 74 | (require net/uri-codec) 75 | 76 | (require file/sha1) 77 | (require net/base64) 78 | 79 | 80 | ; Import configuration variables: 81 | (include "config.rkt") 82 | 83 | 84 | ; Shell interaction: 85 | (define ($ command) 86 | ; run a shell command, then 87 | ; print out stdout, stderr as needed: 88 | (match (process command) 89 | [`(,stdout ,stdin ,exit ,stderr ,proc) 90 | (define cmd-out (port->string stdout)) 91 | (define cmd-err (port->string stderr)) 92 | 93 | (printf "$ command~n~a~n" cmd-out) 94 | 95 | (when (not (equal? cmd-err "")) 96 | (printf "~nerror:~n~a~n" cmd-err))])) 97 | 98 | 99 | ; Wiki text mark-up routines: 100 | (define wikify-text 101 | ; convert a port into a list of strings, 102 | ; converting wiki mark-ups in the process: 103 | (lexer 104 | [(:: "[[" (complement (:: any-string "]]" any-string)) "]]") 105 | (begin 106 | (define text (substring lexeme 2 (- (string-length lexeme) 2))) 107 | (define target:text (string-split text "|")) 108 | (define link 109 | (match target:text 110 | [`(,target) (wikify-link target)] 111 | [`(,target ,text) (wikify-link target text)])) 112 | (cons link (wikify-text input-port)))] 113 | 114 | [any-char 115 | (cons lexeme (wikify-text input-port))] 116 | 117 | [(eof) 118 | '()])) 119 | 120 | (define (wikify-target target) 121 | ; sanitize a link target: 122 | (string-replace (string-downcase target) #px"[\\W]" "-")) 123 | 124 | (define (wikify-link target [text #f]) 125 | ; create an anchor tag: 126 | (define safe-target (wikify-target target)) 127 | (string-append 128 | "" 129 | (if text text target) 130 | "")) 131 | 132 | 133 | ; Page-generation helpers: 134 | (define (generate-head-xexpr 135 | #:title [title "no title"] 136 | #:style [style ""]) 137 | ; generate a page header: 138 | `(head 139 | (title ,title) 140 | (style 141 | ,(string-append default-style "\n" style)))) 142 | 143 | 144 | ; Basic HTTP request processing helpers: 145 | (define ext=>mime-type (read-mime-types mime-types-file)) 146 | 147 | 148 | ; HTTP Basic Authentication: 149 | (define (htpasswd-credentials-valid? 150 | passwd-file 151 | username 152 | password) 153 | ; checks if the given credentials match those in the database 154 | ; it assumes all entries as SHA1-encoded as in `htpasswd -s`. 155 | 156 | ; read in the lines from the password file: 157 | (define lines (call-with-input-file passwd-file 158 | (λ (port) (port->lines port)))) 159 | 160 | ; convert the password to sha1: 161 | (define sha1-pass (sha1-bytes (open-input-bytes password))) 162 | 163 | ; then to base64 encoding: 164 | (define sha1-pass-b64 165 | (bytes->string/utf-8 (base64-encode sha1-pass #""))) 166 | 167 | ; check if both the username and the password match: 168 | (define (password-matches? line) 169 | 170 | (define user:hash (string-split line ":")) 171 | 172 | (define user (car user:hash)) 173 | (define hash (cadr user:hash)) 174 | 175 | (match (string->list hash) 176 | ; check for SHA1 prefix 177 | [`(#\{ #\S #\H #\A #\} . ,hashpass-chars) 178 | (define hashpass (list->string hashpass-chars)) 179 | (and (equal? username (string->bytes/utf-8 user)) 180 | (equal? hashpass sha1-pass-b64))])) 181 | 182 | ; check to see if any line validates: 183 | (ormap password-matches? lines)) 184 | 185 | (define (authenticated? passwd-file req) 186 | ; checks if a request has valid credentials: 187 | (match (request->basic-credentials req) 188 | [(cons user pass) 189 | (htpasswd-credentials-valid? passwd-file user pass)] 190 | 191 | [else #f])) 192 | 193 | 194 | ; A handler for static files: 195 | (define (handle-file-request req docroot path) 196 | 197 | ; NOTE: In practice, static requests can be replaced by 198 | ; providing an #:extra-files-paths to serve/servlet. 199 | 200 | ; identify the requested file: 201 | (define file (string-append docroot "/" (string-join path "/"))) 202 | 203 | (cond 204 | [(file-exists? file) 205 | ; => 206 | (define extension (string->symbol (bytes->string/utf-8 (filename-extension file)))) 207 | (define content-type 208 | (hash-ref ext=>mime-type extension 209 | (λ () TEXT/HTML-MIME-TYPE))) 210 | 211 | ; send the requested file back: 212 | (response 213 | 200 #"OK" ; code & message 214 | (current-seconds) ; timestamp 215 | content-type ; content-type 216 | '() ; additional headers 217 | (λ (client-out) 218 | (write-bytes (file->bytes file) client-out)))] 219 | 220 | [else 221 | ; => 222 | (response/xexpr 223 | #:preamble #"" 224 | #:code 404 225 | #:message #"Not found" 226 | `(html 227 | ,(generate-head-xexpr 228 | #:title #"Not found") 229 | (body 230 | (p "Not found"))))])) 231 | 232 | 233 | (define (handle-git-version-changes dir-path) 234 | ; if the git repository doesn't exist, create it: 235 | (when (not (directory-exists? (string-append dir-path "/.git"))) 236 | 237 | ; TODO/WARNING/SECURITY: Injection attack vulnerability 238 | ; Need to verify that wikilink-name escapes path. 239 | 240 | (define git-init-cmd 241 | (string-append "git -C '" dir-path "' init;" 242 | "git -C '" dir-path "' add content.md;" 243 | "git -C '" dir-path "' commit -m 'Initial commit.'")) 244 | 245 | ($ git-init-cmd)) 246 | 247 | ; commit changes: 248 | (define git-commit-cmd 249 | (string-append "git -C '" dir-path "' add content.md;" 250 | ; TODO: Let the user set the update comment. 251 | "git -C '" dir-path "' commit -m 'Updated page.'")) 252 | 253 | ($ git-commit-cmd)) 254 | 255 | 256 | ; Wiki-specific requests: 257 | 258 | (define (handle-wiki-content-put-request req page) 259 | ; modifies the contents of the specified page. 260 | 261 | ; directory location: 262 | (define dir-path (string-append database-dir "/" (wikify-target page))) 263 | 264 | 265 | ; create the directory if it does not exist: 266 | (define created? #f) 267 | (when (not (directory-exists? dir-path)) 268 | (set! created? #t) 269 | (make-directory dir-path)) 270 | 271 | ; location of the markdown file: 272 | (define md-file-path (string-append dir-path "/" "content.md")) 273 | 274 | ; grab the new contents: 275 | (define post-data (request-post-data/raw req)) 276 | 277 | (define param-string (bytes->string/utf-8 post-data)) 278 | 279 | (define params (form-urlencoded->alist param-string)) 280 | 281 | (define contents (cdr (assq 'content params))) 282 | 283 | ; edit the content file: 284 | (call-with-output-file 285 | md-file-path 286 | #:exists 'replace 287 | (λ (out) 288 | (write-string contents out))) 289 | 290 | ; Notify git of changes. 291 | (handle-git-version-changes dir-path) 292 | 293 | ; Render the page. 294 | (handle-wiki-view-request 295 | req page 296 | #:message (if created? "Page created." "Page edited."))) 297 | 298 | 299 | 300 | ; A handler to render the interface for editing a page: 301 | (define (handle-wiki-edit-request req page) 302 | ; creates a page to allow editing. 303 | 304 | (define dir-path (string-append database-dir "/" page)) 305 | (define md-file-path (string-append dir-path "/" "content.md")) 306 | 307 | (cond 308 | 309 | [(file-exists? md-file-path) 310 | ; => 311 | (response/xexpr 312 | #:preamble #"" 313 | `(html 314 | ,(generate-head-xexpr 315 | #:title (string-append "edit: " page) 316 | #:style " 317 | 318 | textarea#content { 319 | width: 50em; 320 | height: 30em; 321 | } 322 | 323 | ") 324 | (body 325 | (form ((method "POST") 326 | (action "./")) 327 | (textarea 328 | ((id "content") 329 | (name "content")) 330 | ,(file->string md-file-path)) 331 | (br) 332 | (input ([type "submit"] [value "submit changes"]))))))])) 333 | 334 | 335 | 336 | 337 | ; A handler to render pages: 338 | (define (handle-wiki-view-request req page 339 | #:message [message #f]) 340 | 341 | ; directory containing page contents: 342 | (define dir-path (string-append database-dir "/" page)) 343 | 344 | ; markdown file containing the page: 345 | (define md-file-path (string-append dir-path "/" "content.md")) 346 | 347 | (cond 348 | 349 | [(file-exists? md-file-path) 350 | (response 351 | 200 #"OK" ; code & message 352 | (current-seconds) ; timestamp 353 | TEXT/HTML-MIME-TYPE ; content type 354 | '() ; additional headers 355 | (λ (client-out) 356 | 357 | ; render the top: 358 | (write-bytes #"\n\n" client-out) 359 | 360 | ; render the header: 361 | (define head (generate-head-xexpr 362 | #:title (string-append page " :: " uiki-name))) 363 | 364 | (write-string (xexpr->string head) client-out) 365 | 366 | ; render the body: 367 | (write-bytes #"" client-out) 368 | 369 | ; enable MathJax for LaTeX support: 370 | (write-bytes #"" client-out) 375 | (write-bytes #"" client-out) 376 | 377 | ; Enable prettify for syntax highlighting: 378 | (write-bytes #"" client-out) 379 | 380 | ; Include a message, if any: 381 | (when message 382 | (write-string message client-out) 383 | (write-string "
" client-out)) 384 | 385 | ; Render the menu bar: 386 | (define wiki-top-bar 387 | (string->bytes/utf-8 (string-append " 388 |

389 | [edit] 390 |

391 |
"))) 392 | 393 | ; Render the menu bar: 394 | (write-bytes wiki-top-bar client-out) 395 | 396 | ; Pass content.md through through a markdown formatter, and then 397 | ; through the wikifier to convert wiki syntax: 398 | (match (process (string-append markdown-preprocess-command " " md-file-path " | " markdown-command)) 399 | [(list in out exit err interrupt) 400 | ; Convert contents to wiki: 401 | (define wikified (apply string-append (wikify-text in))) 402 | 403 | (write-string wikified client-out)]) 404 | 405 | ; Write the footer: 406 | (write-bytes #"" client-out) 407 | 408 | (write-bytes #"" client-out)))] 409 | 410 | ; Or, if the page is not found: 411 | [else 412 | ; => 413 | (response/xexpr 414 | #:preamble #"" 415 | `(html 416 | ,(generate-head-xexpr 417 | #:title "page does not yet exist") 418 | (body 419 | (p "Page does not exist") 420 | (form ([method "POST"] [action ,(string-append "/wiki/" page)]) 421 | (input ([type "hidden"] [name "content"] [value "Blank page"])) 422 | (input ([type "submit"] [value "Create page"]))))))])) 423 | 424 | 425 | (define (handle-wiki-request req resource) 426 | ; handle a top level /wiki/ request: 427 | (when (equal? (last resource) "") 428 | (set! resource (reverse (cdr (reverse resource))))) 429 | 430 | (match resource 431 | ; view the page: 432 | [`(,page) 433 | #:when (equal? (request-method req) #"GET") 434 | (handle-wiki-view-request req page)] 435 | 436 | ; modify the page contents: 437 | [`(,page) 438 | #:when (equal? (request-method req) #"POST") 439 | (handle-wiki-content-put-request req page)] 440 | 441 | ; edit the page: 442 | [`(,page "edit") 443 | (handle-wiki-edit-request req page)])) 444 | 445 | (define (start req) 446 | 447 | ; extract the uri from the request: 448 | (define uri (request-uri req)) 449 | 450 | ; extract the path from the uri: 451 | (define path (map path/param-path (url-path uri))) 452 | 453 | ; The first element of the path determines the service; 454 | ; choices are "wiki" or "file": 455 | (define service (car path)) 456 | 457 | (define resource (cdr path)) 458 | 459 | ; NOTE: This could be simplified with a higher-level 460 | ; interface for web-server/dispatch: 461 | 462 | ; http://docs.racket-lang.org/web-server/dispatch.html 463 | 464 | (cond 465 | [(and auth-db-path (not (authenticated? auth-db-path req))) 466 | (response 467 | 401 #"Unauthorized" 468 | (current-seconds) 469 | TEXT/HTML-MIME-TYPE 470 | (list 471 | (make-basic-auth-header 472 | "Authentication required" 473 | )) 474 | void)] 475 | 476 | [(equal? service "file") 477 | (handle-file-request req document-root resource)] 478 | 479 | [(equal? service "wiki") 480 | (handle-wiki-request req resource)] 481 | 482 | [else (response/xexpr 483 | #:preamble #"" 484 | `(html 485 | (head 486 | (title "can't handle service: " ,service) 487 | (body 488 | (p "Unhandled service type: " ,service)))))])) 489 | 490 | (serve/servlet start 491 | #:port uiki-port 492 | #:servlet-path "/wiki/main" 493 | #:servlet-regexp #rx"" 494 | #:launch-browser? #f 495 | #:ssl? use-ssl? 496 | #:ssl-cert ssl-cert-path 497 | #:ssl-key ssl-private-key-path 498 | #;end) 499 | 500 | 501 | --------------------------------------------------------------------------------