piecrust2: piecrust/serving/server.py annotate

annotate piecrust/serving/server.py @ 552:9612cfc6455a

serve: Rewrite of the Server-Sent Event code for build notifications. At the moment the server monitors the asset directories, and notifies the browser when an asset has changed and has been re-processed. * Fix issues around long-running requests/threads which mess up the ability to shutdown the server correctly with `CTRL-C` (see comments in code). * Move the notification queue to each SSE producer, to support having multiple pages open in a browser. * Add JS/CSS for showing quick notifications about re-processed assets. * Add support for hot-reloading CSS and pictures that have been re-processed.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sat, 08 Aug 2015 16:12:04 -0700
parents	f2b875ecc940
children	cc6f3dbe3048

rev	line source
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	1 import io
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	2 import os
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	3 import re
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4 import gzip
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	5 import time
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6 import os.path
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	7 import hashlib
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	8 import logging
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	9 import datetime
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	10 from werkzeug.exceptions import (
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	11 NotFound, MethodNotAllowed, InternalServerError, HTTPException)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	12 from werkzeug.wrappers import Request, Response
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	13 from werkzeug.wsgi import ClosingIterator, wrap_file
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	14 from jinja2 import FileSystemLoader, Environment
409 2bb5327c4c1f debug: Fix serving of resources now that the module moved to a sub-folder. Ludovic Chabant <ludovic@chabant.com> parents: 391 diff changeset	15 from piecrust import CACHE_DIR, RESOURCES_DIR
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16 from piecrust.app import PieCrust
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	17 from piecrust.rendering import QualifiedPage, PageRenderingContext, render_page
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	18 from piecrust.sources.base import MODE_PARSING
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	19 from piecrust.uriutil import split_sub_uri
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	20
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	22 logger = logging.getLogger(__name__)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	23
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	24
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	25 class ServeRecord(object):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	26 def __init__(self):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	27 self.entries = {}
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	28
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	29 def addEntry(self, entry):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	30 key = self._makeKey(entry.uri, entry.sub_num)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	31 self.entries[key] = entry
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	32
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	33 def getEntry(self, uri, sub_num):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	34 key = self._makeKey(uri, sub_num)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	35 return self.entries.get(key)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	36
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	37 def _makeKey(self, uri, sub_num):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	38 return "%s:%s" % (uri, sub_num)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	39
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	40
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	41 class ServeRecordPageEntry(object):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	42 def __init__(self, uri, sub_num):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	43 self.uri = uri
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	44 self.sub_num = sub_num
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	45 self.used_source_names = set()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	46
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	47
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48 class WsgiServerWrapper(object):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	49 def __init__(self, server):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	50 self.server = server
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	51
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	52 def __call__(self, environ, start_response):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	53 return self.server._run_request(environ, start_response)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	54
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	55
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	56 class MultipleNotFound(HTTPException):
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	57 code = 404
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	58
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	59 def __init__(self, description, nfes):
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	60 super(MultipleNotFound, self).__init__(description)
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	61 self._nfes = nfes
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	62
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	63 def get_description(self, environ=None):
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	64 from werkzeug.utils import escape
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	65 desc = '<p>' + self.description + '</p>'
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	66 desc += '<p>'
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	67 for nfe in self._nfes:
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	68 desc += '<li>' + escape(nfe.description) + '</li>'
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	69 desc += '</p>'
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	70 return desc
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	71
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	72
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	73 class Server(object):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	74 def __init__(self, root_dir,
375 aade4ea57e7f serve: Add ability to suppress the debug info window programmatically. Ludovic Chabant <ludovic@chabant.com> parents: 374 diff changeset	75 debug=False, sub_cache_dir=None, enable_debug_info=True,
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	76 static_preview=True, run_sse_check=None):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	77 self.root_dir = root_dir
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	78 self.debug = debug
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	79 self.sub_cache_dir = sub_cache_dir
375 aade4ea57e7f serve: Add ability to suppress the debug info window programmatically. Ludovic Chabant <ludovic@chabant.com> parents: 374 diff changeset	80 self.enable_debug_info = enable_debug_info
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	81 self.run_sse_check = run_sse_check
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	82 self.static_preview = static_preview
391 3e4bb57d8506 tests: Add support for testing the Chef server. Ludovic Chabant <ludovic@chabant.com> parents: 390 diff changeset	83 self._page_record = ServeRecord()
3e4bb57d8506 tests: Add support for testing the Chef server. Ludovic Chabant <ludovic@chabant.com> parents: 390 diff changeset	84 self._out_dir = os.path.join(root_dir, CACHE_DIR, 'server')
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	85 self._proc_loop = None
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	86 self._mimetype_map = load_mimetype_map()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	87
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	88 def getWsgiApp(self):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	89 # Bake all the assets so we know what we have, and so we can serve
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90 # them to the client. We need a temp app for this.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	91 app = PieCrust(root_dir=self.root_dir, debug=self.debug)
391 3e4bb57d8506 tests: Add support for testing the Chef server. Ludovic Chabant <ludovic@chabant.com> parents: 390 diff changeset	92 if self.sub_cache_dir:
3e4bb57d8506 tests: Add support for testing the Chef server. Ludovic Chabant <ludovic@chabant.com> parents: 390 diff changeset	93 app._useSubCacheDir(self.sub_cache_dir)
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	94 self._out_dir = os.path.join(app.sub_cache_dir, 'server')
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	95
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	96 if not self.run_sse_check or self.run_sse_check():
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	97 # When using a server with code reloading, some implementations
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	98 # use process forking and we end up going here twice. We only want
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	99 # to start the pipeline loop in the inner process most of the
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	100 # time so we let the implementation tell us if this is OK.
418 d5724c0c8f1a serve: Fix crash on start. Ludovic Chabant <ludovic@chabant.com> parents: 411 diff changeset	101 from piecrust.processing.pipeline import ProcessorPipeline
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	102 from piecrust.serving.procloop import ProcessingLoop
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	103 pipeline = ProcessorPipeline(app, self._out_dir)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	104 self._proc_loop = ProcessingLoop(pipeline)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	105 self._proc_loop.start()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	106
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	107 # Run the WSGI app.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	108 wsgi_wrapper = WsgiServerWrapper(self)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	109 return wsgi_wrapper
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	110
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	111 def _run_request(self, environ, start_response):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	112 try:
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	113 response = self._try_run_request(environ)
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	114 if isinstance(response, tuple):
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	115 response, close_func = response
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	116 return ClosingIterator(response(environ, start_response),
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	117 [close_func])
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	118 else:
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	119 return response(environ, start_response)
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	120 except Exception as ex:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	121 if self.debug:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	122 raise
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	123 return self._handle_error(ex, environ, start_response)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	124
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	125 def _try_run_request(self, environ):
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	126 request = Request(environ)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	127
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	128 # We don't support anything else than GET requests since we're
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	129 # previewing something that will be static later.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	130 if self.static_preview and request.method != 'GET':
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	131 logger.error("Only GET requests are allowed, got %s" %
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	132 request.method)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	133 raise MethodNotAllowed()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	134
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135 # Handle special requests right away.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	136 response = self._try_special_request(environ, request)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	137 if response is not None:
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	138 return response
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	139
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	140 # Also handle requests to a pipeline-built asset right away.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	141 response = self._try_serve_asset(environ, request)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 if response is not None:
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	143 return response
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145 # Create the app for this request.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	146 app = PieCrust(root_dir=self.root_dir, debug=self.debug)
391 3e4bb57d8506 tests: Add support for testing the Chef server. Ludovic Chabant <ludovic@chabant.com> parents: 390 diff changeset	147 if self.sub_cache_dir:
3e4bb57d8506 tests: Add support for testing the Chef server. Ludovic Chabant <ludovic@chabant.com> parents: 390 diff changeset	148 app._useSubCacheDir(self.sub_cache_dir)
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	149 app.config.set('site/root', '/')
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	150 app.config.set('server/is_serving', True)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	151 if (app.config.get('site/enable_debug_info') and
375 aade4ea57e7f serve: Add ability to suppress the debug info window programmatically. Ludovic Chabant <ludovic@chabant.com> parents: 374 diff changeset	152 self.enable_debug_info and
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	153 '!debug' in request.args):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	154 app.config.set('site/show_debug_info', True)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	155
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	156 # We'll serve page assets directly from where they are.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	157 app.env.base_asset_url_format = '/_asset/%path%'
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	158
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	159 # Let's see if it can be a page asset.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	160 response = self._try_serve_page_asset(app, environ, request)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	161 if response is not None:
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	162 return response
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	163
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	164 # Nope. Let's see if it's an actual page.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	165 try:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	166 response = self._try_serve_page(app, environ, request)
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	167 return response
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	168 except (RouteNotFoundError, SourceNotFoundError) as ex:
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	169 raise NotFound() from ex
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	170 except HTTPException:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	171 raise
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	172 except Exception as ex:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	173 if app.debug:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	174 logger.exception(ex)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	175 raise
523 b22e69ff54f4 serve: Don't show the same error message twice. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	176 logger.error(str(ex))
b22e69ff54f4 serve: Don't show the same error message twice. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	177 msg = "There was an error trying to serve: %s" % request.path
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	178 raise InternalServerError(msg) from ex
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	179
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	180 def _try_special_request(self, environ, request):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	181 static_mount = '/__piecrust_static/'
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	182 if request.path.startswith(static_mount):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	183 rel_req_path = request.path[len(static_mount):]
409 2bb5327c4c1f debug: Fix serving of resources now that the module moved to a sub-folder. Ludovic Chabant <ludovic@chabant.com> parents: 391 diff changeset	184 mount = os.path.join(RESOURCES_DIR, 'server')
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	185 full_path = os.path.join(mount, rel_req_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	186 try:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	187 response = self._make_wrapped_file_response(
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	188 environ, request, full_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	189 return response
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	190 except OSError:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	191 pass
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	192
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	193 debug_mount = '/__piecrust_debug/'
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	194 if request.path.startswith(debug_mount):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	195 rel_req_path = request.path[len(debug_mount):]
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	196 if rel_req_path == 'werkzeug_shutdown':
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	197 shutdown_func = environ.get('werkzeug.server.shutdown')
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	198 if shutdown_func is None:
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	199 raise RuntimeError('Not running with the Werkzeug Server')
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	200 shutdown_func()
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	201 return Response("Server shutting down...")
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	202
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	203 if rel_req_path == 'pipeline_status':
409 2bb5327c4c1f debug: Fix serving of resources now that the module moved to a sub-folder. Ludovic Chabant <ludovic@chabant.com> parents: 391 diff changeset	204 from piecrust.serving.procloop import (
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	205 PipelineStatusServerSentEventProducer)
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	206 provider = PipelineStatusServerSentEventProducer(
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	207 self._proc_loop)
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	208 it = provider.run()
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	209 response = Response(it, mimetype='text/event-stream')
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	210 response.headers['Cache-Control'] = 'no-cache'
552 9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	211 response.headers['Last-Event-ID'] = \
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	212 self._proc_loop.last_status_id
9612cfc6455a serve: Rewrite of the Server-Sent Event code for build notifications. Ludovic Chabant <ludovic@chabant.com> parents: 551 diff changeset	213 return response, provider.close
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	214
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	215 return None
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	216
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	217 def _try_serve_asset(self, environ, request):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	218 rel_req_path = request.path.lstrip('/').replace('/', os.sep)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	219 if request.path.startswith('/_cache/'):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	220 # Some stuff needs to be served directly from the cache directory,
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	221 # like LESS CSS map files.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	222 full_path = os.path.join(self.root_dir, rel_req_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	223 else:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	224 full_path = os.path.join(self._out_dir, rel_req_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	225
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	226 try:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	227 response = self._make_wrapped_file_response(
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	228 environ, request, full_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	229 return response
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	230 except OSError:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	231 pass
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	232 return None
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	233
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	234 def _try_serve_page_asset(self, app, environ, request):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	235 if not request.path.startswith('/_asset/'):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	236 return None
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	237
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	238 full_path = os.path.join(app.root_dir, request.path[len('/_asset/'):])
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	239 if not os.path.isfile(full_path):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	240 return None
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	241
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	242 return self._make_wrapped_file_response(environ, request, full_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	243
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	244 def _try_serve_page(self, app, environ, request):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	245 # Try to find what matches the requested URL.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	246 req_path, page_num = split_sub_uri(app, request.path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	247
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	248 routes = find_routes(app.routes, req_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	249 if len(routes) == 0:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	250 raise RouteNotFoundError("Can't find route for: %s" % req_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	251
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	252 rendered_page = None
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	253 not_found_errors = []
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	254 for route, route_metadata in routes:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	255 try:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	256 logger.debug("Trying to render match from source '%s'." %
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	257 route.source_name)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	258 rendered_page = self._try_render_page(
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	259 app, route, route_metadata, page_num, req_path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	260 if rendered_page is not None:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	261 break
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	262 except NotFound as nfe:
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	263 not_found_errors.append(nfe)
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	264
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	265 # If we haven't found any good match, raise whatever exception we
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	266 # first got. Otherwise, raise a generic exception.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	267 if rendered_page is None:
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	268 msg = ("Can't find path for '%s', looked in sources: %s" %
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	269 (req_path,
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	270 ', '.join([r.source_name for r, _ in routes])))
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	271 raise MultipleNotFound(msg, not_found_errors)
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	272
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	273 # Start doing stuff.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	274 page = rendered_page.page
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	275 rp_content = rendered_page.content
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	276
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	277 # Profiling.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	278 if app.config.get('site/show_debug_info'):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	279 now_time = time.clock()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	280 timing_info = (
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	281 '%8.1f ms' %
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	282 ((now_time - app.env.start_time) * 1000.0))
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	283 rp_content = rp_content.replace(
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	284 '__PIECRUST_TIMING_INFORMATION__', timing_info)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	285
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	286 # Build the response.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	287 response = Response()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	288
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	289 etag = hashlib.md5(rp_content.encode('utf8')).hexdigest()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	290 if not app.debug and etag in request.if_none_match:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	291 response.status_code = 304
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	292 return response
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	293
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	294 response.set_etag(etag)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	295 response.content_md5 = etag
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	296
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	297 cache_control = response.cache_control
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	298 if app.debug:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	299 cache_control.no_cache = True
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	300 cache_control.must_revalidate = True
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	301 else:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	302 cache_time = (page.config.get('cache_time') or
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	303 app.config.get('site/cache_time'))
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	304 if cache_time:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	305 cache_control.public = True
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	306 cache_control.max_age = cache_time
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	307
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	308 content_type = page.config.get('content_type')
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	309 if content_type and '/' not in content_type:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	310 mimetype = content_type_map.get(content_type, content_type)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	311 else:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	312 mimetype = content_type
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	313 if mimetype:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	314 response.mimetype = mimetype
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	315
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	316 if ('gzip' in request.accept_encodings and
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	317 app.config.get('site/enable_gzip')):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	318 try:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	319 with io.BytesIO() as gzip_buffer:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	320 with gzip.open(gzip_buffer, mode='wt',
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	321 encoding='utf8') as gzip_file:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	322 gzip_file.write(rp_content)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	323 rp_content = gzip_buffer.getvalue()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	324 response.content_encoding = 'gzip'
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	325 except Exception:
523 b22e69ff54f4 serve: Don't show the same error message twice. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	326 logger.error("Error compressing response, "
b22e69ff54f4 serve: Don't show the same error message twice. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	327 "falling back to uncompressed.")
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	328 response.set_data(rp_content)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	329
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	330 return response
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	331
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	332 def _try_render_page(self, app, route, route_metadata, page_num, req_path):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	333 # Match the route to an actual factory.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	334 taxonomy_info = None
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	335 source = app.getSource(route.source_name)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	336 if route.taxonomy_name is None:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	337 factory = source.findPageFactory(route_metadata, MODE_PARSING)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	338 if factory is None:
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	339 raise NotFound("No path found for '%s' in source '%s'." %
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	340 (req_path, source.name))
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	341 else:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	342 taxonomy = app.getTaxonomy(route.taxonomy_name)
515 16e705c58cae internal: Improve handling of taxonomy term slugification. Ludovic Chabant <ludovic@chabant.com> parents: 483 diff changeset	343 tax_terms = route.getTaxonomyTerms(route_metadata)
16e705c58cae internal: Improve handling of taxonomy term slugification. Ludovic Chabant <ludovic@chabant.com> parents: 483 diff changeset	344 taxonomy_info = (taxonomy, tax_terms)
16e705c58cae internal: Improve handling of taxonomy term slugification. Ludovic Chabant <ludovic@chabant.com> parents: 483 diff changeset	345
411 e7b865f8f335 bake: Enable multiprocess baking. Ludovic Chabant <ludovic@chabant.com> parents: 409 diff changeset	346 tax_page_ref = taxonomy.getPageRef(source)
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	347 factory = tax_page_ref.getFactory()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	348
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	349 # Build the page.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	350 page = factory.buildPage()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351 # We force the rendering of the page because it could not have
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	352 # changed, but include pages that did change.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	353 qp = QualifiedPage(page, route, route_metadata)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	354 render_ctx = PageRenderingContext(qp,
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	355 page_num=page_num,
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	356 force_render=True)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	357 if taxonomy_info is not None:
515 16e705c58cae internal: Improve handling of taxonomy term slugification. Ludovic Chabant <ludovic@chabant.com> parents: 483 diff changeset	358 _, tax_terms = taxonomy_info
520 bab91fcef741 bake/serve: Improve support for unicode, add slugification options. Ludovic Chabant <ludovic@chabant.com> parents: 517 diff changeset	359 render_ctx.setTaxonomyFilter(tax_terms, needs_slugifier=True)
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	360
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	361 # See if this page is known to use sources. If that's the case,
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	362 # just don't use cached rendered segments for that page (but still
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	363 # use them for pages that are included in it).
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	364 uri = qp.getUri()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	365 entry = self._page_record.getEntry(uri, page_num)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	366 if (taxonomy_info is not None or entry is None or
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	367 entry.used_source_names):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	368 cache_key = '%s:%s' % (uri, page_num)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	369 app.env.rendered_segments_repository.invalidate(cache_key)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	370
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	371 # Render the page.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	372 rendered_page = render_page(render_ctx)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	373
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	374 # Check if this page is a taxonomy page that actually doesn't match
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	375 # anything.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	376 if taxonomy_info is not None:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	377 paginator = rendered_page.data.get('pagination')
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	378 if (paginator and paginator.is_loaded and
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	379 len(paginator.items) == 0):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	380 taxonomy = taxonomy_info[0]
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	381 message = ("This URL matched a route for taxonomy '%s' but "
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	382 "no pages have been found to have it. This page "
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	383 "won't be generated by a bake." % taxonomy.name)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	384 raise NotFound(message)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	385
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	386 # Remember stuff for next time.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	387 if entry is None:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	388 entry = ServeRecordPageEntry(req_path, page_num)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	389 self._page_record.addEntry(entry)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	390 for p, pinfo in render_ctx.render_passes.items():
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	391 entry.used_source_names \|= pinfo.used_source_names
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	392
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	393 # Ok all good.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	394 return rendered_page
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	395
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	396 def _make_wrapped_file_response(self, environ, request, path):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	397 logger.debug("Serving %s" % path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	398
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	399 # Check if we can return a 304 status code.
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	400 mtime = os.path.getmtime(path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	401 etag_str = '%s$$%s' % (path, mtime)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	402 etag = hashlib.md5(etag_str.encode('utf8')).hexdigest()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	403 if etag in request.if_none_match:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	404 response = Response()
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	405 response.status_code = 304
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	406 return response
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	407
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	408 wrapper = wrap_file(environ, open(path, 'rb'))
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	409 response = Response(wrapper)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	410 _, ext = os.path.splitext(path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	411 response.set_etag(etag)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	412 response.last_modified = datetime.datetime.fromtimestamp(mtime)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	413 response.mimetype = self._mimetype_map.get(
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	414 ext.lstrip('.'), 'text/plain')
551 f2b875ecc940 serve: Werkzeug docs say you need to pass a flag with `wrap_file`. Ludovic Chabant <ludovic@chabant.com> parents: 523 diff changeset	415 response.direct_passthrough = True
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	416 return response
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	417
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	418 def _handle_error(self, exception, environ, start_response):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	419 code = 500
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	420 if isinstance(exception, HTTPException):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	421 code = exception.code
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	422
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	423 path = 'error'
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	424 if isinstance(exception, (NotFound, MultipleNotFound)):
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	425 path += '404'
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	426
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	427 descriptions = self._get_exception_descriptions(exception)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	428
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	429 env = Environment(loader=ErrorMessageLoader())
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	430 template = env.get_template(path)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	431 context = {'details': descriptions}
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	432 response = Response(template.render(context), mimetype='text/html')
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	433 response.status_code = code
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	434 return response(environ, start_response)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	435
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	436 def _get_exception_descriptions(self, exception):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	437 desc = []
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	438 while exception is not None:
517 c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	439 if isinstance(exception, MultipleNotFound):
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	440 desc += [e.description for e in exception._nfes]
c7e8b4a5afe3 serve: Improve error reporting when pages are not found. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	441 elif isinstance(exception, HTTPException):
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	442 desc.append(exception.description)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	443 else:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	444 desc.append(str(exception))
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	445
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	446 inner_ex = exception.__cause__
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	447 if inner_ex is None:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	448 inner_ex = exception.__context__
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	449 exception = inner_ex
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	450 return desc
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	451
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	452
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	453 class RouteNotFoundError(Exception):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	454 pass
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	455
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	456
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	457 class SourceNotFoundError(Exception):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	458 pass
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	459
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	460
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	461 content_type_map = {
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	462 'html': 'text/html',
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	463 'xml': 'text/xml',
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	464 'txt': 'text/plain',
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	465 'text': 'text/plain',
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	466 'css': 'text/css',
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	467 'xhtml': 'application/xhtml+xml',
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	468 'atom': 'application/atom+xml', # or 'text/xml'?
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	469 'rss': 'application/rss+xml', # or 'text/xml'?
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	470 'json': 'application/json'}
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	471
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	472
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	473 def find_routes(routes, uri):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	474 res = []
483 64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 449 diff changeset	475 tax_res = []
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	476 for route in routes:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	477 metadata = route.matchUri(uri)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	478 if metadata is not None:
483 64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 449 diff changeset	479 if route.is_taxonomy_route:
64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 449 diff changeset	480 tax_res.append((route, metadata))
64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 449 diff changeset	481 else:
64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 449 diff changeset	482 res.append((route, metadata))
64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 449 diff changeset	483 return res + tax_res
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	484
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	485
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	486 class ErrorMessageLoader(FileSystemLoader):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	487 def __init__(self):
409 2bb5327c4c1f debug: Fix serving of resources now that the module moved to a sub-folder. Ludovic Chabant <ludovic@chabant.com> parents: 391 diff changeset	488 base_dir = os.path.join(RESOURCES_DIR, 'messages')
374 fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	489 super(ErrorMessageLoader, self).__init__(base_dir)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	490
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	491 def get_source(self, env, template):
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	492 template += '.html'
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	493 return super(ErrorMessageLoader, self).get_source(env, template)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	494
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	495
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	496 def load_mimetype_map():
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	497 mimetype_map = {}
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	498 sep_re = re.compile(r'\s+')
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	499 path = os.path.join(os.path.dirname(__file__), 'mime.types')
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	500 with open(path, 'r') as f:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	501 for line in f:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	502 tokens = sep_re.split(line)
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	503 if len(tokens) > 1:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	504 for t in tokens[1:]:
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	505 mimetype_map[t] = tokens[0]
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	506 return mimetype_map
fa3ee8a8ee2d serve: Split the server code in a couple modules inside a `serving` package. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	507

Mercurial > piecrust2

annotate piecrust/serving/server.py @ 552:9612cfc6455a