├── .gitignore ├── COPYING ├── COPYING.LESSER ├── README.md ├── __init__.py ├── docs ├── Choco_leibniz.jpg ├── Screencast_Thumbnail.png ├── Screencast_Thumbnail2.png ├── benchmark.txt └── documentation.md ├── extensions ├── __init__.py ├── additional_datasource_example.py └── form_example.py ├── run_server ├── server.py ├── sites ├── basic-example │ ├── content │ │ ├── config.json │ │ ├── pages │ │ │ ├── de │ │ │ │ ├── 001-about.html │ │ │ │ ├── 002-blog.html │ │ │ │ ├── 004-non-linked-file.html │ │ │ │ └── 00Z-special.html │ │ │ └── en │ │ │ │ ├── 001-about.html │ │ │ │ ├── 002-blog.html │ │ │ │ ├── 003-events.html │ │ │ │ ├── 005-contact.html │ │ │ │ ├── 007-newpage.html │ │ │ │ ├── 00X-my-extended-page.html │ │ │ │ └── 00X-success.html │ │ └── posts │ │ │ ├── blog │ │ │ ├── de │ │ │ │ ├── 2015-10-13-mmu-mein-erster-post.html │ │ │ │ ├── 2016-01-20-mmu-test.html │ │ │ │ └── 2016-01-20-mmu-test.md │ │ │ ├── draft │ │ │ │ ├── .gitkeep │ │ │ │ ├── en-mmu-draft1.html │ │ │ │ └── en-mmu-draft2.html │ │ │ └── en │ │ │ │ ├── 2015-10-13-mmu-my-first-post.html │ │ │ │ ├── 2015-11-04-msc-also-a-post.html │ │ │ │ ├── 2015-11-06-msc-also-a-post.html │ │ │ │ ├── 2015-11-07-msc-also-a-post.html │ │ │ │ └── 2015-12-15-jsm-first-post.html │ │ │ └── news │ │ │ └── en │ │ │ └── 2015-12-15-jsm-first-post.html │ └── design │ │ ├── blog-items.html │ │ ├── news-items.html │ │ ├── static │ │ ├── css │ │ │ └── style.css │ │ └── images │ │ │ ├── .gitkeep │ │ │ └── test2.jpg │ │ └── template.html └── minimal │ ├── content │ ├── config.json │ └── pages │ │ └── en │ │ └── index.html │ └── design │ └── template.html └── tools ├── __init__.py └── guetzli.py /.gitignore: -------------------------------------------------------------------------------- 1 | # OSX 2 | .DS_Store 3 | 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | 8 | # C extensions 9 | *.so 10 | 11 | # Distribution / packaging 12 | .Python 13 | env/ 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .coverage 43 | .coverage.* 44 | .cache 45 | nosetests.xml 46 | coverage.xml 47 | *,cover 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | 56 | # Sphinx documentation 57 | docs/_build/ 58 | 59 | # PyBuilder 60 | target/ 61 | 62 | # Guetzli 63 | guetzli_log 64 | uwsgi.pid 65 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Guetzli, A Deliciously Fast and Simple CMS Based on Files 2 | ========================================================= 3 | 4 | [![Join the chat at https://gitter.im/muellermichel/guetzli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/muellermichel/guetzli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 5 | 6 | Guetzli came about when we became too frustrated with Wordpress and its cesspool of plugins constantly breaking each other just to provide basic features like backups and multilingual pages. Guetzli is 7 | 8 | 1) Insanely simple. It's written in less than 500 lines of Python Flask. 9 | 10 | 2) Powerful. Add as many pages and languages as you like by editing the content directory using favourite local file editor, no server restarts required. Even changing the template or the configuration doesn't require a restart. Need to rollout to production? Just git push, rollout done. 11 | 12 | 3) Fast. On a puny 2GB Hetzner VPS it was measured to get [345 requests per second from the outside internet and 600 requests per second from within the same network](docs/benchmark.txt), using the [multithreaded uwsgi implementation](run_server). 13 | 14 | What's with the name? 'Guetzli' is the Swiss German word for cookie. It's a good metaphor for this CMS, since it's small, quickly digested and comes with [biscuit](docs/documentation.md#the-biscuit) and [chocolate](docs/documentation.md#the-chocolate). 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 |
Introducing GuetzliEditing Guetzli Sites on the WebWhere the name comes from
26 | 27 | Setup 28 | ----- 29 | 1) Fork this repository so you can create your own site. 30 | 31 | 2) Clone your repo and `cd` into it. 32 | 33 | 3) Copy `sites/basic-example` or `sites/minimal` into a new subdirectory of sites that holds the contents of your site. Commit it to your repo. 34 | 35 | 4) `sudo pip install Flask pystache ipaddress requests`. 36 | 37 | 3) Feed guetzli to the python: `python ./server.py --site [site-subdir-name]`. For additional options, see `python ./server.py --help`. 38 | WARNING: This is only meant for development, do *not* use this for production purposes (as it could make your machine vulnerable). For production deployment please see [Going Live!](docs/documentation.md#going-live). 39 | 40 | 4) Enjoy on localhost:5000. For a production ready deployment, please see [Going Live!](docs/documentation.md#going-live) 41 | 42 | Design Principles 43 | ----------------- 44 | 1) No Database! The filesystem is more than enough for a simple multi-page web appearance. 45 | 46 | 2) File changes need to be reflected in the next request. 47 | 48 | 3) Nevertheless, hit the file system the least amount possible - use file modification dates and in-memory cache to do the least amount of File I/O possible. 49 | 50 | 4) Cache the result of all potentially expensive operations (like json.loads or even regex matches). 51 | 52 | Features 53 | -------- 54 | 1) Localized posts, e.g. blogging. 55 | 56 | 2) Automatic reloading of modified resources on the next request, including `content/config.json`. You should never have to restart this server. 57 | 58 | 3) Automatic pulling from changes on github and gitlab.com repositories (requires webhook setup, see [Going Live!](docs/documentation.md#going-live)). 59 | 60 | 4) Full multilanguage support. Add as many languages as you like by editing `content/config.json` and add the linked pages in language-subfolders under `content/pages` (see the example in the repo). Guetzli will match the one that best represents the client's request header and lists the other options just in case. 61 | 62 | 5) Mustache templating - in the template, pages and posts. 63 | 64 | 6) Localized strings, defined in `content/config.json`. 65 | 66 | 7) Extensions - handle user submitted content, add your own datasources to guetzli. 67 | 68 | 7) Redirect to (localized) default page if a page can't be found. 69 | 70 | 8) All URL params are checked to only contain letters, numbers, underscores and dashes (which is also the restriction for the page filenames) - no funny business in your file system! 71 | 72 | Documentation 73 | ------------- 74 | All you need to know should be in the [documentation](docs/documentation.md). Otherwise, please open up an issue with your question. 75 | 76 | Dependencies 77 | ------------ 78 | 1) Python version >= 2.7.x 79 | 80 | 2) Flask 81 | 82 | 3) pystache 83 | 84 | License 85 | ------- 86 | LGPL 87 | 88 | Authors 89 | ------- 90 | Michel Müller, System Architect [Protogrid](http://protogrid.com) 91 | 92 | Mark Schmitz, Web Engineer [Protogrid](http://protogrid.com) 93 | 94 | Contributors 95 | ------------ 96 | Thanks to Renato Testa, Chief DevOps [Protogrid](http://protogrid.com), for contributing the VPS performance benchmarks! 97 | 98 | ToDo 99 | ---- 100 | 1) Markdown support 101 | 102 | 2) Dockerization 103 | 104 | 105 | -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/__init__.py -------------------------------------------------------------------------------- /docs/Choco_leibniz.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/docs/Choco_leibniz.jpg -------------------------------------------------------------------------------- /docs/Screencast_Thumbnail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/docs/Screencast_Thumbnail.png -------------------------------------------------------------------------------- /docs/Screencast_Thumbnail2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/docs/Screencast_Thumbnail2.png -------------------------------------------------------------------------------- /docs/benchmark.txt: -------------------------------------------------------------------------------- 1 | Output of `ab -n 1000 -c 100 [Guetzli-URI]/en/002-blog` from a place with fast internet in Switzerland: 2 | 3 | Document Path: /en/002-blog 4 | Document Length: 1041 bytes 5 | 6 | Concurrency Level: 100 7 | Time taken for tests: 2.893 seconds 8 | Complete requests: 1000 9 | Failed requests: 0 10 | Write errors: 0 11 | Total transferred: 1196000 bytes 12 | HTML transferred: 1041000 bytes 13 | Requests per second: 345.62 [#/sec] (mean) 14 | Time per request: 289.336 [ms] (mean) 15 | Time per request: 2.893 [ms] (mean, across all concurrent requests) 16 | Transfer rate: 403.67 [Kbytes/sec] received 17 | 18 | Connection Times (ms) 19 | min mean[+/-sd] median max 20 | Connect: 20 22 1.9 22 28 21 | Processing: 34 201 26.1 205 254 22 | Waiting: 34 201 26.1 205 254 23 | Total: 55 223 26.2 227 282 24 | 25 | Percentage of the requests served within a certain time (ms) 26 | 50% 227 27 | 66% 230 28 | 75% 232 29 | 80% 234 30 | 90% 238 31 | 95% 239 32 | 98% 242 33 | 99% 257 34 | 100% 282 (longest request) 35 | 36 | ... From a VPS in the same network as Guetzli: 37 | 38 | Document Path: / 39 | Document Length: 490 bytes 40 | 41 | Concurrency Level: 100 42 | Time taken for tests: 1.663 seconds 43 | Complete requests: 1000 44 | Failed requests: 0 45 | Write errors: 0 46 | Total transferred: 644000 bytes 47 | HTML transferred: 490000 bytes 48 | Requests per second: 601.48 [#/sec] (mean) 49 | Time per request: 166.256 [ms] (mean) 50 | Time per request: 1.663 [ms] (mean, across all concurrent requests) 51 | Transfer rate: 378.28 [Kbytes/sec] received 52 | 53 | Connection Times (ms) 54 | min mean[+/-sd] median max 55 | Connect: 3 6 7.6 3 34 56 | Processing: 23 152 25.3 157 173 57 | Waiting: 23 151 25.3 157 172 58 | Total: 55 158 19.1 161 182 59 | 60 | Percentage of the requests served within a certain time (ms) 61 | 50% 161 62 | 66% 165 63 | 75% 168 64 | 80% 168 65 | 90% 170 66 | 95% 172 67 | 98% 175 68 | 99% 176 69 | 100% 182 (longest request) 70 | -------------------------------------------------------------------------------- /docs/documentation.md: -------------------------------------------------------------------------------- 1 | Guetzli Documentation 2 | ===================== 3 | 4 | Guetzli, a deliciously fast and simple Filesystem-Web-CMS. For getting started it is recommended to watch the [screencast](https://www.youtube.com/watch?v=MEUrirTZ-D8) or to have a look at the provided example content and how it is displayed when running the server. For setup and design, please see the [README](../README.md). 5 | 6 | **Contents** 7 | 8 | [The Biscuit (dynamic content)](#the-biscuit) 9 | 10 | [The Chocolate (static content)](#the-chocolate) 11 | 12 | [Templating](#templating) 13 | 14 | [Extensions](#extensions) 15 | 16 | [HowTo](#howto) 17 | 18 | [Going Live!](#going-live) 19 | 20 | The Biscuit 21 | ----------- 22 | Dynamic content (i.e. the 'bisc') is the backbone of Guetzli. It's generated using the pages and posts under `./content` and the templates under `./design`. To your visitors it is served using the following URLs: 23 | 24 | `/` 25 | 26 | The root landing page matches the visitor's language to the available ones listed in `content/config.json` --> `active_languages` and serves the page defined as default in `content/config.json` --> `default_pagename`, rendered using `design/template.html`. In case there is no language match it uses `content/config.json` --> `default_language`. 27 | 28 | `/bisc` 29 | 30 | Same as root. 31 | 32 | `/bisc/[language]` 33 | 34 | Same as root, but serves a specific language. 35 | 36 | `/bisc/[language]/[pagename]` 37 | 38 | Serves a specific page if available under `content/pages/[language]/[pagename].html` using `design/template.html`. If unavailable, serves `default_pagename` in the chosen language. 39 | 40 | `/bisc/[language]/[post-type]/[post-id]` 41 | 42 | Serves a specific post if available under `content/posts/[post-type]/[language]/[post-id].html` using `design/template.html`. If unavailable, serves `default_pagename` in the chosen language. [post-id] should be in `YYYY-MM-DD-[author_shortname]-[post_name]` format. 43 | 44 | Additionally, Guetzli recognizes the following URL arguments (after `?`): 45 | 46 | * `page_number=[integer larger than one]` - page requested for post listings. 47 | 48 | The Chocolate 49 | ------------- 50 | HTML pages are fine, but they may be a bit boring and dry to some visitors. To make your Guetzli more tasty, add some static files like CSS, images, javascript or whatever you like under `./design/static/[your-folder-structure]`. This is served as `/choco/[your-folder-structure]`. 51 | 52 | Templating 53 | ---------- 54 | This section serves as a reference for templating with Guetzli. Please have a look at the provided example that comes with the repository, it's mostly self explanatory. 55 | 56 | **The following tags are available everywhere (pages, posts and templates)** 57 | 58 | * `{{ reference }}` for every reference defined in the current language in `content/config.json` --> `strings_by_template_reference` 59 | 60 | * `{{ current_path }}` - relative URL of the currently rendered page. 61 | 62 | * `{{ language }}` - the currently active language locale. 63 | 64 | * `{{ pagename }}` - the filename (without `.html`) of the currently served page (also serves as the page's identifier in the URL). 65 | 66 | * `{{#menu}} .. {{/menu}}` - repeats the content for each menu entry defined in the current language in `content/config.json` --> `pages_by_language`. Offers the following tags for each entry: 67 | 68 | * `{{ url }}` - the relative URL to the page. 69 | 70 | * `{{ pagename_class }}` - a tag that can be used as e.g. CSS class with the name of `menu-` + filename (without `.html`) for each page linked in the menu : e.g. for `006-signup.html` the tag or CSS class will be `menu-006-signup`. 71 | 72 | * `{{ title }}` - the title as defined in the page metadata in `content/config.json`. 73 | 74 | * `{{#languages}} .. {{/languages}}` - repeats the content for each language defined in `content/config.json` --> `active_languages`. Offers the following tags for each entry: 75 | 76 | * `{{ id }}` - the language locale as defined in the language metadata in `content/config.json`. 77 | 78 | * `{{ language }}` - the human readable language string as defined in the language metadata in `content/config.json`. 79 | 80 | **The following tags are additionally available on pages for each post type that has been registered for the respective page in `content/config.json` --> `active_post_types_by_pagename`** 81 | 82 | * `{{{ [post-type]_listing }}}` - renders a page of `[post-type]` in the current language. A page contains `content/config.json` --> `active_post_types_by_pagename` --> `[pagename]` --> `[items_per_page]` many posts. Each post is defined in a file under `content/posts/[post-type]/[language]` where `[post-type]` is given by `content/config.json` --> `active_post_types_by_pagename` --> `[pagename]` --> `[posts_directory]`. 83 | 84 | **The following tags are additionally available in posts** 85 | 86 | * `{{ author }}` - either the `[author_shortname]` as defined in the post filename or - if available - the author's name as defined in `content/config.json` --> `authors_by_shortname`. 87 | 88 | * `{{ post_path }}` - the relative URL of the post. 89 | 90 | * `{{ publishing_date }}` - the date as defined in the post filename. 91 | 92 | **The following tags are additionally available in `design/template.html`** 93 | 94 | * `{{{ content }}}` - the content of the currently accessed page. 95 | 96 | **The following tags are additionally available in post listings templates `design/[post-type]-items.html`** 97 | 98 | * `{{#[post-type]_items}} .. {{/[post-type]_items}}` - repeats the content for each post on the current page. Offers the following tags for each post: 99 | 100 | * `{{ item }}` - the content for the current post. 101 | 102 | * `{{ first_item_number }}` - a one-based number for the first displayed post on the current page. 103 | 104 | * `{{ last_item_number }}` - a one-based number for the last displayed post on the current page. 105 | 106 | * `{{ number_of_items }}` - the total number of posts available. 107 | 108 | * `{{ number_of_pages }}` - the total number of pages available. 109 | 110 | * `{{ next_page }}` - page number of the next page or `None` if not available. 111 | 112 | * `{{ previous_page }}` - page number of the previous page or `None` if not available. 113 | 114 | Extensions 115 | ---------- 116 | Guetzli automatically loads python files in `/extensions` at startup. See the provided examples in the repository for how to use it. At a minimum you will need to import the `Extension` class like `from tools.guetzli import Extension`, instantiate an object like `my_extension = Extension('my_extension')` (the passed name in the initializer *must* be the same as the object name which *must* be the same as the filename of the extension) and add a flask view handler like 117 | 118 | ```python 119 | @my_extension.route('/') 120 | def handler(): 121 | #handler code 122 | ``` 123 | 124 | This will give you a new URL endpoint "/my-extension" (please note the conversion of _underscore_ to -dash- for the endpoint). Using the Flask routes feature you can define arbitrarily many handlers and routes per handler for your extension. See also the [Flask routing documentation](http://flask.pocoo.org/docs/0.10/quickstart/#routing). 125 | 126 | Useful python functions found in `tools.guetzli`: 127 | 128 | * `render_with_template(context)`: Renders a html page using `design/template.html` and the given context. Use `get_context_with_rendered_content` to create the context object. 129 | * `get_context_with_rendered_content(language, page_or_post_type, post_id=None, additional_context={})`: Creates a context object that has all the template tags defined as described in the section [Templating](#templating). `language` is the language locale as defined in the language metadata in `content/config.json`. `page_or_post_type` is the filename (without `.html`) of the page to be served or the post type. `post_id` is the post's ID in case `page_or_post_type` is a post type. `additional_context` can be used to pass additional tags - use this in order to add your own server side data sources to guetzli pages. 130 | * `is_valid_email_address(visitor_email)`: Checks the passed `visitor_email` string for compliance with the following regular expression `^[^@\s]+@[^@\s]+\.[^@\s]+$`, can be used prior to `send_mail` to have a basic server-side check of the provided e-mail address. 131 | * `send_mail(recipients, sender, subject, text, reply_to=None, files=[], server="localhost")`: Sends a mail using `recipients` (list of e-mail addresses), `sender` (string), `subject` (string), `text` (string), `reply_to` (optional, string), `files` (list of file paths) and `server` (mail server URL, localhost if omitted). 132 | 133 | HowTo 134 | ----- 135 | **Add/Change/Remove a (blog-) post** 136 | 137 | Add/Change/Remove a file under `content/posts/[post-type]/[language]` using a `YYYY-MM-DD-[author_shortname]-[post_name].html` filename format. See the existing examples. Specially available tags for blog entries are `{{ author }}` `{{ post_path }}` (URL to the standalone entry) and `{{ publishing_date }}`. 138 | 139 | **Add/Change/Remove a page** 140 | 141 | Add/Change/Remove a file under `content/pages/[language]`. From the moment the file exists, the page is reachable under the URL `/[language]/[filename(without .html)]`. 142 | 143 | **Change the page titles** 144 | 145 | There are two settings that influence the page titles: 146 | 147 | 1) Title prefixes (prepended with a ': ' separator) can be defined using a `title_prefix` setting per language in `content/config.json` --> `active_languages`. Please note: If the page title already contains the title prefix, the prefix will *not* be prepended. 148 | 149 | 2) The page titles themselves are changed using the `title` setting per page in `content/config.json` --> `pages_by_language` --> given language. 150 | 151 | **Link a page in the menu** 152 | 153 | Add `{"title": "[Given Title]", "name":[filename(without .html)]}` under the correct language list in `content/config.json` --> `pages_by_language`. 154 | 155 | **Add a new localized string** 156 | 157 | Add it in `content/config.json` --> `strings_by_template_reference` using the reference as key (see examples) and use it with `{{ reference }}` in any page, post or template. 158 | 159 | **Change the appearance** 160 | 161 | Edit `design/template.html`. 162 | 163 | **Add a new post type** 164 | 165 | 1) Add a new directory with language subdirectories under `content/posts`. 166 | 167 | 2) Copy `design/blog-items.html` as `design/[post-dir-name]-items.html`. Adapt it to your needs. 168 | 169 | 3) Add the `{{ [post-dir-name]_items }}` tag on a page where you'd like to list your posts. 170 | 171 | 4) Reference the posts directory in `content/config.json` --> `active_post_types_by_pagename` (see the blog as an example). 172 | 173 | **example content/config.json** 174 | ``` 175 | { 176 | "pages_by_language": { 177 | "en": [ 178 | {"title": "About Protogrid", "name": "001-about"}, 179 | {"title": "Blog", "name": "002-blog"}, 180 | {"title": "Events", "name": "003-events"} 181 | ], 182 | "de": [ 183 | {"title": "Über Protogrid", "name": "001-about"}, 184 | {"title": "Blog", "name": "002-blog"}, 185 | {"title": "Ereignisse", "name": "003-events"}, 186 | {"title": "Speziell für Deutschsprechende", "name": "00Z-special"} 187 | ] 188 | }, 189 | "active_languages": [ 190 | {"language": "English", "id":"en", "title_prefix":"Example"}, 191 | {"language": "German", "id":"de", "title_prefix":"Beispiel"}, 192 | {"language": "Spanish", "id":"es"} 193 | ], 194 | "strings_by_template_reference": { 195 | "date_particle": {"en": "on", "de": "am"}, 196 | "page_localized": {"en": "page", "de": "Seite"}, 197 | "of_localized": {"en": "of", "de": "von"}, 198 | "blog_posts_localized": {"en": "blog posts", "de": "Blog-Einträge"}, 199 | "to_localized": {"en": "to", "de": "bis"} 200 | }, 201 | "active_post_types_by_pagename": { 202 | "002-blog": [ 203 | {"posts_directory": "blog", "items_per_page": 3} 204 | ] 205 | }, 206 | "authors_by_shortname": { 207 | "mmu": "Michel Müller", 208 | "msc": "Mark Schmitz" 209 | }, 210 | "default_pagename": "001-about", 211 | "default_language": "en" 212 | } 213 | ``` 214 | 215 | Going Live! 216 | ----------- 217 | To feed Guetzli to many visitors, see the `run_server` script for a production ready multi-threaded execution of this CMS. You need uwsgi to use this script (`./run_server [site-name(optional, default: basic-example)] [webhook-secret(optional)] [repo-branch-to-pull(optional, default: master)] [autopull-untrusted]`). 218 | 219 | Guetzli can be set up to automatically pull the latest repository state, triggered by github or gitlab webhooks. Use the `[Your-Server-URL]/autopull` endpoint for this matter. 220 | 221 | 1) For [*github* Webhooks](https://developer.github.com/webhooks/#service-hooks), set up the webhook in the github interface for push events and specify a secret. Specify the secret as the second argument to `./run_server`. 222 | 223 | 2) For *gitlab* Webhooks there is currently no way for guetzli to authenticate the trigger. Set up the webhook in the gitlab interface for push events. To start the server in this mode, run it with `./run_server [site-name] [some-dummy-secret] [repo-branch] true`, e.g. `./run_server basic-example 1234 true`. 224 | 225 | Adapt the concurrency to your hardware by editing the `./run_server` script (`--processes` for dynamic content `--offload-threads` for static content). It's best to deploy it using the system process manager of your environment (systemd, upstart, docker..). If you have a production config for any of these systems, please share so others can profit from your work. 226 | -------------------------------------------------------------------------------- /extensions/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/extensions/__init__.py -------------------------------------------------------------------------------- /extensions/additional_datasource_example.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: UTF-8 -*- 3 | 4 | # Copyright (C) 2016 Michel Müller 5 | 6 | # This file is part of Guetzli. 7 | 8 | # Guetzli is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Lesser General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # Guetzli is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Lesser General Public License for more details. 17 | 18 | # You should have received a copy of the GNU Lesser General Public License 19 | # along with Guetzli. If not, see . 20 | 21 | from flask import abort 22 | from tools.guetzli import NotAllowedError, UsageError, NotFoundError, \ 23 | Extension, render_with_template, get_context_with_rendered_content 24 | 25 | additional_datasource_example = Extension('additional_datasource_example') 26 | 27 | #registering and defining a view for the /additional_datasource_example/ endpoint 28 | @additional_datasource_example.route('/', methods=['GET'], defaults={'language': None}) 29 | @additional_datasource_example.route('/', methods=['GET']) 30 | def example_view(language): 31 | try: 32 | return render_with_template(get_context_with_rendered_content( 33 | language=language, 34 | page_or_post_type='00X-my-extended-page', 35 | additional_context={ 36 | "my_additional_tag": "hello world!", 37 | "my_example_list": [{"value": "one"}, {"value": "two"}, {"value": "three"}] 38 | } 39 | )) 40 | except NotAllowedError: 41 | abort(403) 42 | except UsageError as e: 43 | abort(500, {'message': str(e)}) 44 | except NotFoundError: 45 | abort(404) -------------------------------------------------------------------------------- /extensions/form_example.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: UTF-8 -*- 3 | 4 | # Copyright (C) 2016 Michel Müller 5 | 6 | # This file is part of Guetzli. 7 | 8 | # Guetzli is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Lesser General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # Guetzli is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Lesser General Public License for more details. 17 | 18 | # You should have received a copy of the GNU Lesser General Public License 19 | # along with Guetzli. If not, see . 20 | 21 | import logging, json 22 | from flask import redirect, url_for, request 23 | from tools.guetzli import Extension, send_mail 24 | 25 | form_example = Extension('form_example') 26 | 27 | #registering and defining a post handler for the /form_example/ endpoint 28 | @form_example.route('/', methods=['POST']) 29 | def handler(language): 30 | logging.info("form content submitted: " + str(request.form)) 31 | try: 32 | send_mail( 33 | recipients=["john.smith@example.com"], 34 | sender=request.form["e-mail"], 35 | subject="form submitted", 36 | text=json.dumps(request.form) 37 | ) 38 | send_mail( 39 | recipients=[request.form["e-mail"]], 40 | sender="john.smith@example.com", 41 | subject="Thank you for contacting us!", 42 | text="We will get back to you as soon as possible" 43 | ) 44 | except Exception as e: 45 | logging.error("Something went wrong when trying to send an E-Mail: Type of error: %s, Message: %s" %( 46 | type(e), 47 | str(e) 48 | )) 49 | return redirect(url_for('page_view', pagename="00X-success", language=language)) -------------------------------------------------------------------------------- /run_server: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Copyright (C) 2016 Michel Müller 4 | 5 | # This file is part of Guetzli. 6 | 7 | # Guetzli is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU Lesser General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | 12 | # Guetzli is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU Lesser General Public License for more details. 16 | 17 | # You should have received a copy of the GNU Lesser General Public License 18 | # along with Guetzli. If not, see . 19 | 20 | # ============ preamble ================== # 21 | set -o errexit #exit when command fails 22 | set -o nounset #exit when trying to use undeclared variable 23 | set -o pipefail #pass along errors within a pipe 24 | 25 | # =============== setup ================== # 26 | working_dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) 27 | log_file="${working_dir}/guetzli_log" 28 | pid_file="${working_dir}/uwsgi.pid" 29 | port=5000 30 | site="" 31 | if [[ $# > 0 ]] ; then 32 | site="$1" 33 | fi 34 | autopull_key="" 35 | if [[ $# > 1 ]] ; then 36 | autopull_key="$2" 37 | fi 38 | autopull_branch="" 39 | if [[ $# > 2 ]] ; then 40 | autopull_branch="$3" 41 | fi 42 | autopull_untrusted="" 43 | if [[ $# > 3 ]] ; then 44 | autopull_untrusted="$4" 45 | fi 46 | 47 | # ========= eat the guetzli ============== # 48 | touch "$log_file" 49 | uwsgi --stop "$pid_file" && : 50 | sleep 1 51 | uwsgi --master --processes 4 --offload-threads 4 --http :$port --daemonize "$log_file" --pidfile "$pid_file" -w server:app --static-map /static="$working_dir/design/static" --pyargv "$site $autopull_key $autopull_branch $autopull_untrusted" --buffer-size 65536 --socket-timeout 5 --listen 5 -------------------------------------------------------------------------------- /server.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: UTF-8 -*- 3 | 4 | # Copyright (C) 2016 Michel Müller 5 | 6 | # This file is part of Guetzli. 7 | 8 | # Guetzli is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Lesser General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # Guetzli is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Lesser General Public License for more details. 17 | 18 | # You should have received a copy of the GNU Lesser General Public License 19 | # along with Guetzli. If not, see . 20 | 21 | # Contributors: 22 | # * Mark Schmitz 23 | 24 | import json, logging, os 25 | from flask import Flask, abort, redirect, url_for, request 26 | from tools.guetzli import \ 27 | NotFoundError, UsageError, NotAllowedError, \ 28 | set_site, get_site, \ 29 | get_repo_path, get_page_path, get_post_path, get_content_config, \ 30 | get_context_with_rendered_content, render_with_template 31 | 32 | _autopull_key = None 33 | _autopull_branch = None 34 | _untrusted_autopull = False 35 | 36 | logging.getLogger().setLevel(logging.INFO) 37 | if __name__ == '__main__': #Option parsing for toy server startup 38 | import optparse 39 | optparser = optparse.OptionParser() 40 | optparser.add_option("--site", dest="site") 41 | optparser.add_option("--autopull-key", dest="autopull_key") 42 | optparser.add_option("--autopull-branch", dest="autopull_branch") 43 | optparser.add_option("--enable-untrusted-autopull", dest="untrusted_autopull", default=False, action='store_true') 44 | (options, args) = optparser.parse_args() 45 | if options.site: 46 | set_site(options.site) 47 | if options.autopull_key: 48 | _autopull_key = options.autopull_key.encode() if type(_autopull_key) == unicode else options.autopull_key 49 | _autopull_branch = options.autopull_branch if options.autopull_branch else "master" 50 | _untrusted_autopull = options.untrusted_autopull 51 | else: #Option parsing for wsgi startup 52 | import sys 53 | if len(sys.argv) > 1: 54 | set_site(sys.argv[1]) 55 | if len(sys.argv) > 2: 56 | _autopull_key = sys.argv[2] 57 | _autopull_branch = sys.argv[3] if len(sys.argv) > 3 else "master" 58 | _untrusted_autopull = len(sys.argv) > 4 and sys.argv[4] == "true" 59 | logging.info("Autopulling is set up: %s; Branch: %s; Untrusted connections allowed: %s" %( 60 | _autopull_key != None or _untrusted_autopull, 61 | _autopull_branch, 62 | _untrusted_autopull 63 | )) 64 | 65 | app = Flask(__name__, static_folder="./sites/%s/design/static" %(get_site()), static_url_path="/choco") 66 | 67 | extensions_directory_list = os.listdir("extensions") 68 | for file_name in extensions_directory_list: 69 | basename_and_file_ext = os.path.splitext(file_name) 70 | if basename_and_file_ext[1] != ".py": 71 | continue 72 | if basename_and_file_ext[0] == "__init__": 73 | continue 74 | guetzli_extension_name = basename_and_file_ext[0] 75 | guetzli_extension_endpoint = "/%s" %(guetzli_extension_name.replace('_', '-')) 76 | guetzli_extension_module = __import__("extensions.%s" %(guetzli_extension_name), fromlist=["extensions"]) 77 | logging.info("registering %s extension with endpoint %s" %(guetzli_extension_name, guetzli_extension_endpoint)) 78 | app.register_blueprint(getattr(guetzli_extension_module, guetzli_extension_name), url_prefix=guetzli_extension_endpoint) 79 | 80 | @app.errorhandler(500) 81 | def custom_error_handler(error): 82 | if hasattr(error, "description"): 83 | return error.description.get('message', "") 84 | return str(error) 85 | 86 | @app.route('/', defaults={'pagename': None, 'language': None, 'post_id': None}, methods=['GET']) 87 | @app.route('/bisc', defaults={'pagename': None, 'language': None, 'post_id': None}, methods=['GET']) 88 | @app.route('/bisc/', defaults={'pagename': None, 'post_id': None}, methods=['GET']) 89 | @app.route("/bisc//", defaults={'post_id': None}, methods = ['GET']) 90 | @app.route("/bisc///", methods = ['GET']) 91 | def page_view(pagename, language, post_id): 92 | try: 93 | return render_with_template(get_context_with_rendered_content( 94 | language=language, 95 | page_or_post_type=pagename, 96 | post_id=post_id 97 | )) 98 | except NotAllowedError: 99 | abort(403) 100 | except UsageError as e: 101 | abort(500, {'message': str(e)}) 102 | except NotFoundError as e: 103 | if not pagename or not language \ 104 | or (pagename == 'index') \ 105 | or (post_id == None and str(e) != get_page_path(pagename, language)) \ 106 | or (post_id and str(e) != get_post_path(pagename, language, post_id)): 107 | abort(500, {'message': 'sorry, %s could not be found' %(str(e))}) 108 | elif pagename == get_content_config().get('default_pagename', 'index'): 109 | abort(404) 110 | else: 111 | return redirect(url_for('page_view', language=language)) 112 | raise Exception("Well that's embarassing - this should never happen.") 113 | 114 | @app.route("/autopull", methods=['GET', 'POST']) 115 | def autopull_view(): 116 | #adapted from https://github.com/razius/github-webhook-handler 117 | import ipaddress, requests 118 | if not _untrusted_autopull and not _autopull_key: 119 | logging.warning("someone tried request autopull, but there is no autopull secret configured for this guetzli instance - aborting") 120 | abort(500) 121 | if not _untrusted_autopull: 122 | request_ip = ipaddress.ip_address(u'{0}'.format(request.remote_addr)) 123 | hook_blocks = requests.get('https://api.github.com/meta').json()['hooks'] 124 | for block in hook_blocks: 125 | if ipaddress.ip_address(request_ip) in ipaddress.ip_network(block): 126 | break 127 | else: 128 | logging.info("someone tried request autopull from unsupported IP %s" %(request_ip)) 129 | abort(403) 130 | if request.headers.get('X-GitHub-Event') == "ping": 131 | logging.info("Received and answered Ping event from github") 132 | return json.dumps({'msg': 'Hi!'}) 133 | if request.headers.get('X-GitHub-Event') != "push" \ 134 | and request.headers.get('X-Gitlab-Event') != "Push Hook": 135 | logging.warning("We have received a webhook, but it is the wrong event type - aborting") 136 | abort(403) 137 | if request.method == 'POST': 138 | if not _untrusted_autopull and _autopull_key: # Check if POST request signature is valid 139 | import hmac, hashlib 140 | signature = request.headers.get('X-Hub-Signature').split('=')[1] 141 | mac = hmac.new(_autopull_key, msg=request.data, digestmod=hashlib.sha1) 142 | try: 143 | if not hmac.compare_digest(mac.hexdigest(), signature): 144 | logging.info("hash did not match for autopull" %(request_ip)) 145 | abort(403) 146 | except AttributeError: 147 | # What compare_digest provides is protection against timing attacks, 148 | # fallback to string comparison for python < 2.7.7 149 | logging.warning("webhooks are used without timing attack protection available from python 2.7.7 - please update if possible") 150 | if not str(mac.hexdigest()) == str(signature): 151 | abort(403) 152 | import subprocess 153 | logging.info("pulling latest repo version upon request by github webhook") 154 | branch = _autopull_branch if _autopull_branch else "master" 155 | subp = subprocess.Popen( 156 | ["git", "checkout", branch], 157 | cwd=get_repo_path() 158 | ) 159 | subp.wait() 160 | subp = subprocess.Popen( 161 | ["git", "pull", "origin", branch], 162 | cwd=get_repo_path() 163 | ) 164 | subp.wait() 165 | return 'OK' 166 | 167 | if __name__ == "__main__": 168 | logging.info("setup completed as main application for site %s; running on port 5000 accessible from localhost" %(get_site())) 169 | app.run(debug=True) 170 | else: 171 | logging.info("setup completed as embedded application for site %s, passed arguments %s; running on your chosen port accessible from everywhere" %(get_site(), sys.argv)) -------------------------------------------------------------------------------- /sites/basic-example/content/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "pages_by_language": { 3 | "en": [ 4 | {"title": "About", "name": "001-about"}, 5 | {"title": "Blog", "name": "002-blog"}, 6 | {"title": "Events", "name": "003-events"}, 7 | {"title": "Contact", "name": "005-contact"}, 8 | {"title": "My new page", "name": "007-newpage"} 9 | ], 10 | "de": [ 11 | {"title": "Über Uns", "name": "001-about"}, 12 | {"title": "Blog", "name": "002-blog"}, 13 | {"title": "Ereignisse", "name": "003-events"}, 14 | {"title": "Speziell für Deutschsprechende", "name": "00Z-special"} 15 | ] 16 | }, 17 | "active_languages": [ 18 | {"language": "English", "id":"en", "title_prefix":"Example"}, 19 | {"language": "German", "id":"de", "title_prefix":"Beispiel"} 20 | ], 21 | "strings_by_template_reference": { 22 | "date_particle": {"en": "on", "de": "am"}, 23 | "tree_localized": {"en": "tree", "de": "Baum"}, 24 | "page_localized": {"en": "page", "de": "Seite"}, 25 | "of_localized": {"en": "of", "de": "von"}, 26 | "blog_posts_localized": {"en": "blog posts", "de": "Blog-Einträge"}, 27 | "to_localized": {"en": "to", "de": "bis"} 28 | }, 29 | "active_post_types_by_pagename": { 30 | "002-blog": [ 31 | {"posts_directory": "blog", "items_per_page": 3} 32 | ], 33 | "001-about": [ 34 | {"posts_directory": "news", "items_per_page": 1} 35 | ] 36 | }, 37 | "authors_by_shortname": { 38 | "mmu": "Michel Müller", 39 | "msc": "Mark Schmitz", 40 | "jsm": "John Smith" 41 | }, 42 | "default_pagename": "001-about", 43 | "default_language": "en" 44 | } -------------------------------------------------------------------------------- /sites/basic-example/content/pages/de/001-about.html: -------------------------------------------------------------------------------- 1 | Guten Tag! Wir sind auf der Hauptseite..... 2 | 3 | my localized string: {{ tree_localized }} . This uses the 'tree_localized' tag. 4 | -------------------------------------------------------------------------------- /sites/basic-example/content/pages/de/002-blog.html: -------------------------------------------------------------------------------- 1 | Unser Blog! 2 | 3 | {{{ blog_listing }}} -------------------------------------------------------------------------------- /sites/basic-example/content/pages/de/004-non-linked-file.html: -------------------------------------------------------------------------------- 1 | Testing something that is not linked yet. -------------------------------------------------------------------------------- /sites/basic-example/content/pages/de/00Z-special.html: -------------------------------------------------------------------------------- 1 | Speziellen Content -------------------------------------------------------------------------------- /sites/basic-example/content/pages/en/001-about.html: -------------------------------------------------------------------------------- 1 | This is the content of a page. Example of a link: Go to events 2 | 3 | See also what we can do with extensions! 4 | 5 | {{{ news_listing }}} -------------------------------------------------------------------------------- /sites/basic-example/content/pages/en/002-blog.html: -------------------------------------------------------------------------------- 1 | Our Blog! 2 | 3 | {{{ blog_listing }}} -------------------------------------------------------------------------------- /sites/basic-example/content/pages/en/003-events.html: -------------------------------------------------------------------------------- 1 | hello world I'm the event page! -------------------------------------------------------------------------------- /sites/basic-example/content/pages/en/005-contact.html: -------------------------------------------------------------------------------- 1 |
2 | E-Mail:
3 |
4 | Message:
5 | 6 | 7 |
-------------------------------------------------------------------------------- /sites/basic-example/content/pages/en/007-newpage.html: -------------------------------------------------------------------------------- 1 | This is a new page. -------------------------------------------------------------------------------- /sites/basic-example/content/pages/en/00X-my-extended-page.html: -------------------------------------------------------------------------------- 1 | I'm a page loaded using an extension. 2 | 3 | See what I can do: tag --> {{ my_additional_tag }}. 4 | 5 |
    6 | {{#my_example_list}} 7 |
  • {{ value }}
    • 8 | {{/my_example_list}} 9 |
-------------------------------------------------------------------------------- /sites/basic-example/content/pages/en/00X-success.html: -------------------------------------------------------------------------------- 1 | Success! -------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/de/2015-10-13-mmu-mein-erster-post.html: -------------------------------------------------------------------------------- 1 |

Mein erster Post

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Hi! Das ist ein Post!

-------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/de/2016-01-20-mmu-test.html: -------------------------------------------------------------------------------- 1 |
2 | test123 3 |
-------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/de/2016-01-20-mmu-test.md: -------------------------------------------------------------------------------- 1 | test markdown 2 | ------------- 3 | 4 | 1. erstens 5 | 2. zweitens -------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/draft/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/sites/basic-example/content/posts/blog/draft/.gitkeep -------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/draft/en-mmu-draft1.html: -------------------------------------------------------------------------------- 1 | This is a draft -------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/draft/en-mmu-draft2.html: -------------------------------------------------------------------------------- 1 |

My first post

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Hi! I'm the second draft.

-------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/en/2015-10-13-mmu-my-first-post.html: -------------------------------------------------------------------------------- 1 |

My first post

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Hi! I'm a post!

-------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/en/2015-11-04-msc-also-a-post.html: -------------------------------------------------------------------------------- 1 |

Another post

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Hi! I'm also a post!

4 | -------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/en/2015-11-06-msc-also-a-post.html: -------------------------------------------------------------------------------- 1 |

Post Number 3

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Totally fascinating

4 | -------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/en/2015-11-07-msc-also-a-post.html: -------------------------------------------------------------------------------- 1 |

Post Number 4

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Interesting story. Some new content.

4 | -------------------------------------------------------------------------------- /sites/basic-example/content/posts/blog/en/2015-12-15-jsm-first-post.html: -------------------------------------------------------------------------------- 1 |

My first post

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Hey guys! I'm John Smith. {{ tree_localized }}

4 | -------------------------------------------------------------------------------- /sites/basic-example/content/posts/news/en/2015-12-15-jsm-first-post.html: -------------------------------------------------------------------------------- 1 |

My first news item

 2 | {{ author }} {{ date_particle }} {{ publishing_date }} 3 |

Hey guys! I'm John Smith. {{ tree_localized }}

4 | -------------------------------------------------------------------------------- /sites/basic-example/design/blog-items.html: -------------------------------------------------------------------------------- 1 |
blog-items
2 | {{#blog_items}} 3 |
4 | {{{ item }}} 5 |
6 | {{/blog_items}} 7 |
8 |

{{ page_localized }} {{ page_number }} {{ of_localized }} {{ number_of_pages }} ({{ blog_posts_localized }} {{ first_item_number }} {{ to_localized }} {{ last_item_number }} {{ of_localized}} {{ number_of_items }})

9 |

10 | {{#next_page}} 11 | Older 12 | {{/next_page}} 13 | {{#previous_page}} 14 | Newer 15 | {{/previous_page}} 16 |

17 |
-------------------------------------------------------------------------------- /sites/basic-example/design/news-items.html: -------------------------------------------------------------------------------- 1 |
blog-items
2 | {{#news_items}} 3 |
4 | {{{ item }}} 5 |
6 | {{/news_items}} 7 |
8 |

{{ page_localized }} {{ page_number }} {{ of_localized }} {{ number_of_pages }} ({{ blog_posts_localized }} {{ first_item_number }} {{ to_localized }} {{ last_item_number }} {{ of_localized}} {{ number_of_items }})

9 |

10 | {{#next_page}} 11 | Older 12 | {{/next_page}} 13 | {{#previous_page}} 14 | Newer 15 | {{/previous_page}} 16 |

17 |
-------------------------------------------------------------------------------- /sites/basic-example/design/static/css/style.css: -------------------------------------------------------------------------------- 1 | .blog-footer { 2 | background-color: grey; 3 | } 4 | -------------------------------------------------------------------------------- /sites/basic-example/design/static/images/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/sites/basic-example/design/static/images/.gitkeep -------------------------------------------------------------------------------- /sites/basic-example/design/static/images/test2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/sites/basic-example/design/static/images/test2.jpg -------------------------------------------------------------------------------- /sites/basic-example/design/template.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | {{ pagetitle }} 4 | 5 | 6 | 7 | 20 |
21 | {{{ content }}} 22 |
23 | 24 | -------------------------------------------------------------------------------- /sites/minimal/content/config.json: -------------------------------------------------------------------------------- 1 | {} -------------------------------------------------------------------------------- /sites/minimal/content/pages/en/index.html: -------------------------------------------------------------------------------- 1 | hello world! -------------------------------------------------------------------------------- /sites/minimal/design/template.html: -------------------------------------------------------------------------------- 1 | {{{ content }}} -------------------------------------------------------------------------------- /tools/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/muellermichel/guetzli/21279ff0ec42ab8804a30c4c56efb078ec7b7c48/tools/__init__.py -------------------------------------------------------------------------------- /tools/guetzli.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: UTF-8 -*- 3 | 4 | # Copyright (C) 2016 Michel Müller 5 | 6 | # This file is part of Guetzli. 7 | 8 | # Guetzli is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU Lesser General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # Guetzli is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU Lesser General Public License for more details. 17 | 18 | # You should have received a copy of the GNU Lesser General Public License 19 | # along with Guetzli. If not, see . 20 | 21 | from __future__ import division 22 | import os, codecs, re, math, logging, json 23 | import pystache 24 | from flask import url_for, request, Blueprint 25 | 26 | _file_content_by_path = {} 27 | _file_modification_date_by_path = {} 28 | _checked_path_components = {} 29 | _content_config = {} 30 | _post_filenames_by_subdirectory_and_language = {} 31 | _post_directory_modification_dates_by_subdirectory_and_language = {} 32 | _site = "basic-example" 33 | 34 | class NotFoundError(Exception): 35 | pass 36 | 37 | class UsageError(Exception): 38 | pass 39 | 40 | class NotAllowedError(Exception): 41 | pass 42 | 43 | class Extension(Blueprint): 44 | def __init__(self, name): 45 | super(Extension, self).__init__(name, "extensions.%s" %(name)) 46 | 47 | def set_site(site): 48 | global _site 49 | _site = site 50 | 51 | def get_site(): 52 | return _site 53 | 54 | def get_repo_path(): 55 | return os.path.join(os.path.dirname(os.path.abspath(__file__)), "..") 56 | 57 | def get_site_path(): 58 | return os.path.join(get_repo_path(), 'sites', _site) 59 | 60 | def get_template_path(template_name="template"): 61 | return os.path.join(get_site_path(), 'design', template_name) + '.html' 62 | 63 | def get_page_path(pagename, language): 64 | return os.path.join(get_site_path(), 'content', 'pages', language, pagename) + '.html' 65 | 66 | def get_post_path(posts_subdirectory, language, post_id=None): 67 | posts_path = os.path.join(get_site_path(), 'content', 'posts', posts_subdirectory, language) 68 | if post_id == None: 69 | return posts_path 70 | return os.path.join(posts_path, post_id) + '.html' 71 | 72 | def get_file_content(path): 73 | if not os.path.isfile(path): 74 | if path in _file_content_by_path: 75 | del _file_content_by_path[path] 76 | if path in _file_modification_date_by_path: 77 | del _file_modification_date_by_path[path] 78 | raise NotFoundError(path) 79 | previous_modification_date = _file_modification_date_by_path.get(path) 80 | curr_modification_date = os.path.getmtime(path) 81 | if previous_modification_date and curr_modification_date <= previous_modification_date: 82 | return _file_content_by_path[path], False 83 | with codecs.open(path, encoding="utf-8") as f: 84 | file_content = f.read() 85 | _file_content_by_path[path] = file_content 86 | _file_modification_date_by_path[path] = curr_modification_date 87 | return file_content, True 88 | 89 | def render_file_content(path, ctx): 90 | return pystache.render(get_file_content(path)[0], ctx) 91 | 92 | def get_content_config(): 93 | config_path = os.path.join(get_site_path(), 'content', 'config') + '.json' 94 | file_content, has_changed = get_file_content(config_path) 95 | global _content_config 96 | if not has_changed: 97 | return _content_config 98 | try: 99 | _content_config = json.loads(file_content) 100 | except Exception as e: 101 | raise UsageError("Wrong format or syntax error in %s, please compare with basic-example." %(config_path)) 102 | return _content_config 103 | 104 | def get_post_content(ctx, content_config, posts_path, posts_subdirectory, file_name): 105 | match = re.match(r'(\d{4}-\d{2}-\d{2})-(\w*)-?(.*?)\.\w*', file_name) 106 | author_shortname = None 107 | publishing_date = None 108 | if match: 109 | publishing_date = match.group(1) 110 | author_shortname = match.group(2) 111 | author = content_config.get('authors_by_shortname', {}).get(author_shortname, author_shortname) 112 | ctx.update({ 113 | "post_path": url_for( 114 | 'page_view', 115 | pagename=posts_subdirectory, 116 | language=ctx["language"], 117 | post_id=file_name.split('.')[0] 118 | ), 119 | "author": author, 120 | "publishing_date": publishing_date 121 | }) 122 | return render_file_content(os.path.join(posts_path, file_name), ctx) 123 | 124 | def get_posts_page_and_page_info(ctx, content_config, posts_subdirectory, items_per_page, page_number): 125 | posts_path = get_post_path(posts_subdirectory, ctx['language']) 126 | if not os.path.isdir(posts_path): 127 | raise NotFoundError(posts_path) 128 | identifier_tuple = (posts_subdirectory, ctx['language']) 129 | previous_directory_modification_date = _post_directory_modification_dates_by_subdirectory_and_language.get( 130 | identifier_tuple 131 | ) 132 | curr_directory_modification_date = os.path.getmtime(posts_path) 133 | file_names = None 134 | if previous_directory_modification_date \ 135 | and curr_directory_modification_date <= previous_directory_modification_date: 136 | file_names = _post_filenames_by_subdirectory_and_language.get(identifier_tuple) 137 | else: 138 | file_names = sorted( 139 | [file_name for file_name in os.listdir(posts_path) if os.path.isfile(os.path.join( 140 | posts_path, 141 | file_name 142 | ))], 143 | reverse=True 144 | ) 145 | _post_filenames_by_subdirectory_and_language[identifier_tuple] = file_names 146 | _post_directory_modification_dates_by_subdirectory_and_language[ 147 | identifier_tuple 148 | ] = curr_directory_modification_date 149 | number_of_pages = int(math.ceil(len(file_names) / items_per_page)) 150 | start_item = (page_number - 1) * items_per_page 151 | page_info = { 152 | "first_item_number": start_item + 1, 153 | "last_item_number": min(start_item + items_per_page, len(file_names)), 154 | "number_of_items": len(file_names), 155 | "number_of_pages": number_of_pages, 156 | "next_page": page_number + 1 if page_number < number_of_pages else None, 157 | "previous_page": page_number - 1 if page_number > 1 else None 158 | } 159 | page = [] 160 | for file_name in file_names[start_item:start_item + items_per_page]: 161 | page.append({ 162 | "item": get_post_content(ctx, content_config, posts_path, posts_subdirectory, file_name) 163 | }) 164 | return page, page_info 165 | 166 | def get_posts_listing(ctx, content_config, posts_subdirectory, items_per_page, page_number=1): 167 | try: 168 | page, page_info = get_posts_page_and_page_info(ctx, content_config, posts_subdirectory, items_per_page, page_number) 169 | ctx[posts_subdirectory + "_items"] = page 170 | ctx.update(page_info) 171 | except NotFoundError: 172 | pass 173 | return render_file_content(get_template_path(posts_subdirectory + "-items"), ctx) 174 | 175 | def get_page_content(ctx, content_config): 176 | for entry in content_config.get("active_post_types_by_pagename", {}).get(ctx["pagename"], []): 177 | posts_subdirectory = entry["posts_directory"] 178 | items_per_page = entry.get("items_per_page") 179 | if not isinstance(items_per_page, int) or items_per_page <= 0: 180 | items_per_page = 5 181 | ctx[posts_subdirectory + "_listing"] = get_posts_listing( 182 | ctx, 183 | content_config, 184 | posts_subdirectory, 185 | items_per_page, 186 | ctx["page_number"] 187 | ) 188 | return render_file_content(get_page_path(ctx["pagename"], ctx["language"]), ctx) 189 | 190 | def get_menu(language, content_config): 191 | menu = [] 192 | for page in content_config.get('pages_by_language', {}).get(language, []): 193 | menu.append({ 194 | "title": page["title"], 195 | "url": url_for("page_view", pagename=page["name"], language=language), 196 | "pagename_class": "menu-" + page["name"] 197 | }) 198 | return menu 199 | 200 | def get_page_title(pagename, language, content_config): 201 | def first_item(list_or_none): 202 | return list_or_none[0] if list_or_none else None 203 | 204 | #TODO: Cache prefixes and titles after content config reload 205 | title_prefix = first_item([ 206 | language_hash.get("title_prefix") 207 | for language_hash in content_config.get('active_languages', []) 208 | if language_hash['id'] == language 209 | ]) 210 | for page in content_config.get('pages_by_language', {}).get(language, []): 211 | if page["name"] == pagename: 212 | pagetitle = page["title"] 213 | if title_prefix and not title_prefix in pagetitle: 214 | pagetitle = "%s: %s" %(title_prefix, pagetitle) 215 | return pagetitle 216 | return title_prefix 217 | 218 | def get_context_with_rendered_content(language, page_or_post_type, post_id=None, additional_context={}): 219 | if not is_valid_path_component(page_or_post_type) \ 220 | or not is_valid_path_component(language) \ 221 | or not is_valid_path_component(post_id): 222 | raise NotAllowedError() 223 | 224 | content_config = get_content_config() 225 | active_languages = content_config.get('active_languages', []) 226 | default_pagename = content_config.get('default_pagename', 'index') 227 | if language == None: 228 | language = request.accept_languages.best_match([ 229 | language_hash['id'] for language_hash in active_languages 230 | ]) 231 | if language == None: 232 | language = content_config.get('default_language', 'en') 233 | if page_or_post_type == None: 234 | page_or_post_type = default_pagename 235 | 236 | ctx = { 237 | "page_number": request.args.get('page_number', 1, type=int), 238 | "pagename": page_or_post_type, 239 | "pagetitle": get_page_title(page_or_post_type, language, content_config), 240 | "language": language, 241 | "menu": get_menu(language, content_config), 242 | "languages": content_config.get('active_languages', []), 243 | "current_path": url_for('page_view', pagename=page_or_post_type, language=language) 244 | } 245 | ctx.update({ 246 | key: lang_dict.get(language) 247 | for key, lang_dict in content_config.get("strings_by_template_reference", {}).iteritems() 248 | }) 249 | ctx.update(additional_context) 250 | if post_id != None: 251 | ctx["content"] = get_post_content( 252 | ctx, 253 | content_config, 254 | get_post_path(page_or_post_type, language), 255 | page_or_post_type, 256 | post_id + '.html' 257 | ) 258 | else: 259 | ctx["content"] = get_page_content(ctx, content_config) 260 | return ctx 261 | 262 | def render_with_template(context): 263 | return render_file_content(get_template_path(), context) 264 | 265 | def is_valid_path_component(component): 266 | '''making sure that the client cannot manipulate his way to parts of the file system where we don't want him to''' 267 | if not component: 268 | return True 269 | if component in _checked_path_components: 270 | return True 271 | if re.match(r'^[A-Za-z0-9_-]*$', component): 272 | _checked_path_components[component] = None 273 | return True 274 | return False 275 | 276 | def is_valid_email_address(visitor_email): 277 | return re.match(r'^[^@\s]+@[^@\s]+\.[^@\s]+$', visitor_email) != None 278 | 279 | def send_mail(recipients, sender, subject, text, reply_to=None, files=[], server="localhost"): 280 | import smtplib 281 | from email.header import Header 282 | from email.MIMEMultipart import MIMEMultipart 283 | from email.MIMEBase import MIMEBase 284 | from email.MIMEText import MIMEText 285 | from email.Utils import COMMASPACE, formatdate 286 | from email import Encoders 287 | if type(recipients) != list: 288 | raise UsageError("recipients must be a list") 289 | if type(files) != list: 290 | raise UsageError("files must be a list") 291 | msg = MIMEText(text.encode('utf-8'), 'plain', 'utf-8') 292 | msg['From'] = sender 293 | msg['To'] = COMMASPACE.join(recipients) 294 | msg['Date'] = formatdate(localtime=True) 295 | msg['Subject'] = Header(subject, 'utf-8') 296 | if reply_to: 297 | msg.add_header('reply-to', reply_to) 298 | for f in files: 299 | part = MIMEBase('application', "octet-stream") 300 | part.set_payload(open(f,"rb").read()) 301 | Encoders.encode_base64(part) 302 | part.add_header('Content-Disposition', 'attachment; filename="%s"' %(os.path.basename(f))) 303 | msg.attach(part) 304 | smtp = smtplib.SMTP(server) 305 | smtp.sendmail(sender, recipients, msg.as_string() ) 306 | smtp.close() 307 | --------------------------------------------------------------------------------