code-b860ede03056/roundup/web/NOTES.md0000644000000000000000000000320712361202661015333 0ustar 00000000000000 Engineering notes for Roundup components for web. ### Logical structure of web components An attempt to see what components are present in web request processing. +-----------+ | | | Router | └─----------+ (pure logic) ---------------------------------------------- +-----------+ | | | Login | └-----------+ (logic + templates + messages) ---------------------------------------------- +-----------+ ¦ ¦ ¦ User DB ¦ └-----------+ (messages) Every component consists of messages (data), logic (code) and representation (templates). Message definition (data) also takes into account actions that make component work. Templates are mostly needed for human readability. ### Router Status for Roundup URL map check: [ ] check urlpath values for [ ] example.com [ ] example.com/ [ ] example.com/tracker [ ] example.com/tracker/ [ ] example.com/tracker/item [ ] example.com/tracker?anything [ ] example.com/tracker/?anything [ ] example.com/tracker/item?anything [ ] get full list of url handlers [ ] check url handling for db scheme paths [ ] example.com/tracker/class [ ] example.com/tracker/class/ [ ] example.com/tracker/class1 [ ] example.com/tracker/class1/ [ ] check url handling for static files /_file/(.*) StaticFileHandler [ ] /_file [ ] /_file/ [ ] /_file/name /@@file/(.*) StaticFileHandler [ ] /@@file [ ] /@@file/ [ ] /@@file/name code-b860ede03056/roundup/web/router.py0000644000000000000000000000236612361202661016020 0ustar 00000000000000#!/usr/bin/env python """ The purpose of router is to make Roundup URL scheme configurable and allow extensions add their own handlers and URLs to tracker. Public domain work by: anatoly techtonik """ import re # --- Example URL mapping class NamedObject(object): """Object that outputs given name when printed""" def __init__(self, name): self.name = name def __repr__(self): return self.name ExampleHandler = NamedObject('ExampleHandler') ExampleFileHandler = NamedObject('ExampleFileHandler') EXAMPLE_URLMAP = ( '/static/(.*)', ExampleFileHandler, '/', ExampleHandler ) # --- Regexp based router class Router(object): def __init__(self, urlmap=[]): """ `urlmap` is a list (pattern, handler, pattern, ...) """ self.urlmap = urlmap def get_handler(self, urlpath): """ `urlpath` is a part of url /that/looks?like=this returns tuple (handler, arguments) or (None, ()) """ for i in range(0, len(self.urlmap), 2): pattern, handler = self.urlmap[i], self.urlmap[i+1] match = re.match(pattern, urlpath) if match: return handler, match.groups() return (None, ())