MobileBlur

Hex Artifact Content
Login

Artifact 3c04e682e73fbe0a041b593415e002894b9aad7c:


0000: 23 21 2f 75 73 72 2f 62 69 6e 2f 70 79 74 68 6f  #!/usr/bin/pytho
0010: 6e 0a 23 20 2d 2a 2d 20 63 6f 64 69 6e 67 3a 20  n.# -*- coding: 
0020: 75 74 66 2d 38 20 2d 2a 2d 0a 0a 23 20 20 72 6f  utf-8 -*-..#  ro
0030: 75 74 65 72 73 20 61 72 65 20 64 69 63 74 69 6f  uters are dictio
0040: 6e 61 72 69 65 73 20 6f 66 20 55 52 4c 20 72 6f  naries of URL ro
0050: 75 74 69 6e 67 20 70 61 72 61 6d 65 74 65 72 73  uting parameters
0060: 2e 0a 23 0a 23 20 20 46 6f 72 20 65 61 63 68 20  ..#.#  For each 
0070: 72 65 71 75 65 73 74 2c 20 74 68 65 20 65 66 66  request, the eff
0080: 65 63 74 69 76 65 20 72 6f 75 74 65 72 20 69 73  ective router is
0090: 3a 0a 23 20 20 20 20 74 68 65 20 62 75 69 6c 74  :.#    the built
00a0: 2d 69 6e 20 64 65 66 61 75 6c 74 20 62 61 73 65  -in default base
00b0: 20 72 6f 75 74 65 72 20 28 73 68 6f 77 6e 20 62   router (shown b
00c0: 65 6c 6f 77 29 2c 0a 23 20 20 20 20 75 70 64 61  elow),.#    upda
00d0: 74 65 64 20 62 79 20 74 68 65 20 42 41 53 45 20  ted by the BASE 
00e0: 72 6f 75 74 65 72 20 69 6e 20 72 6f 75 74 65 73  router in routes
00f0: 2e 70 79 20 72 6f 75 74 65 72 73 2c 0a 23 20 20  .py routers,.#  
0100: 20 20 75 70 64 61 74 65 64 20 62 79 20 74 68 65    updated by the
0110: 20 61 70 70 2d 73 70 65 63 69 66 69 63 20 72 6f   app-specific ro
0120: 75 74 65 72 20 69 6e 20 72 6f 75 74 65 73 2e 70  uter in routes.p
0130: 79 20 72 6f 75 74 65 72 73 20 28 69 66 20 61 6e  y routers (if an
0140: 79 29 2c 0a 23 20 20 20 20 75 70 64 61 74 65 64  y),.#    updated
0150: 20 62 79 20 74 68 65 20 61 70 70 2d 73 70 65 63   by the app-spec
0160: 69 66 69 63 20 72 6f 75 74 65 72 20 66 72 6f 6d  ific router from
0170: 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2f 61 70   applications/ap
0180: 70 2f 72 6f 75 74 65 73 2e 70 79 20 72 6f 75 74  p/routes.py rout
0190: 65 72 73 20 28 69 66 20 61 6e 79 29 0a 23 0a 23  ers (if any).#.#
01a0: 0a 23 20 20 52 6f 75 74 65 72 20 6d 65 6d 62 65  .#  Router membe
01b0: 72 73 3a 0a 23 0a 23 20 20 64 65 66 61 75 6c 74  rs:.#.#  default
01c0: 5f 61 70 70 6c 69 63 61 74 69 6f 6e 3a 20 64 65  _application: de
01d0: 66 61 75 6c 74 20 61 70 70 6c 69 63 61 74 69 6f  fault applicatio
01e0: 6e 20 6e 61 6d 65 0a 23 20 20 61 70 70 6c 69 63  n name.#  applic
01f0: 61 74 69 6f 6e 73 3a 20 6c 69 73 74 20 6f 66 20  ations: list of 
0200: 61 6c 6c 20 72 65 63 6f 67 6e 69 7a 65 64 20 61  all recognized a
0210: 70 70 6c 69 63 61 74 69 6f 6e 73 2c 20 6f 72 20  pplications, or 
0220: 27 41 4c 4c 27 20 74 6f 20 75 73 65 20 61 6c 6c  'ALL' to use all
0230: 20 63 75 72 72 65 6e 74 6c 79 20 69 6e 73 74 61   currently insta
0240: 6c 6c 65 64 20 61 70 70 6c 69 63 61 74 69 6f 6e  lled application
0250: 73 0a 23 20 20 20 20 20 20 20 4e 61 6d 65 73 20  s.#       Names 
0260: 69 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20  in applications 
0270: 61 72 65 20 61 6c 77 61 79 73 20 74 72 65 61 74  are always treat
0280: 65 64 20 61 73 20 61 6e 20 61 70 70 6c 69 63 61  ed as an applica
0290: 74 69 6f 6e 20 6e 61 6d 65 73 20 77 68 65 6e 20  tion names when 
02a0: 74 68 65 79 20 61 70 70 65 61 72 20 66 69 72 73  they appear firs
02b0: 74 20 69 6e 20 61 6e 20 69 6e 63 6f 6d 69 6e 67  t in an incoming
02c0: 20 55 52 4c 2e 0a 23 20 20 20 20 20 20 20 53 65   URL..#       Se
02d0: 74 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 3d 4e  t applications=N
02e0: 6f 6e 65 20 74 6f 20 64 69 73 61 62 6c 65 20 74  one to disable t
02f0: 68 65 20 72 65 6d 6f 76 61 6c 20 6f 66 20 61 70  he removal of ap
0300: 70 6c 69 63 61 74 69 6f 6e 20 6e 61 6d 65 73 20  plication names 
0310: 66 72 6f 6d 20 6f 75 74 67 6f 69 6e 67 20 55 52  from outgoing UR
0320: 4c 73 2e 0a 23 20 20 64 6f 6d 61 69 6e 73 3a 20  Ls..#  domains: 
0330: 6f 70 74 69 6f 6e 61 6c 20 64 69 63 74 20 6d 61  optional dict ma
0340: 70 70 69 6e 67 20 64 6f 6d 61 69 6e 20 6e 61 6d  pping domain nam
0350: 65 73 20 74 6f 20 61 70 70 6c 69 63 61 74 69 6f  es to applicatio
0360: 6e 20 6e 61 6d 65 73 0a 23 20 20 20 20 20 20 20  n names.#       
0370: 54 68 65 20 64 6f 6d 61 69 6e 20 6e 61 6d 65 20  The domain name 
0380: 63 61 6e 20 69 6e 63 6c 75 64 65 20 61 20 70 6f  can include a po
0390: 72 74 20 6e 75 6d 62 65 72 3a 20 64 6f 6d 61 69  rt number: domai
03a0: 6e 2e 63 6f 6d 3a 38 30 38 30 0a 23 20 20 20 20  n.com:8080.#    
03b0: 20 20 20 54 68 65 20 61 70 70 6c 69 63 61 74 69     The applicati
03c0: 6f 6e 20 6e 61 6d 65 20 63 61 6e 20 69 6e 63 6c  on name can incl
03d0: 75 64 65 20 61 20 63 6f 6e 74 72 6f 6c 6c 65 72  ude a controller
03e0: 3a 20 20 61 70 70 78 2f 63 74 6c 72 78 0a 23 20  :  appx/ctlrx.# 
03f0: 20 20 20 20 20 20 20 20 20 20 6f 72 20 61 20 63            or a c
0400: 6f 6e 74 72 6f 6c 6c 65 72 20 61 6e 64 20 61 20  ontroller and a 
0410: 66 75 6e 63 74 69 6f 6e 3a 20 61 70 70 78 2f 63  function: appx/c
0420: 74 6c 72 78 2f 66 63 6e 78 0a 23 20 20 20 20 20  tlrx/fcnx.#     
0430: 20 20 45 78 61 6d 70 6c 65 3a 0a 23 20 20 20 20    Example:.#    
0440: 20 20 20 64 6f 6d 61 69 6e 73 20 3d 20 7b 20 20     domains = {  
0450: 20 22 64 6f 6d 61 69 6e 2e 63 6f 6d 22 20 3a 20   "domain.com" : 
0460: 22 61 70 70 22 2c 0a 23 20 20 20 20 20 20 20 20  "app",.#        
0470: 20 20 20 20 20 20 20 20 20 20 22 78 2e 64 6f 6d            "x.dom
0480: 61 69 6e 2e 63 6f 6d 22 20 3a 20 22 61 70 70 78  ain.com" : "appx
0490: 22 2c 0a 23 20 20 20 20 20 20 20 20 20 20 20 20  ",.#            
04a0: 20 20 20 20 20 7d 2c 0a 23 20 20 70 61 74 68 5f       },.#  path_
04b0: 70 72 65 66 69 78 3a 20 61 20 70 61 74 68 20 66  prefix: a path f
04c0: 72 61 67 6d 65 6e 74 20 74 68 61 74 20 69 73 20  ragment that is 
04d0: 70 72 65 66 69 78 65 64 20 74 6f 20 61 6c 6c 20  prefixed to all 
04e0: 6f 75 74 67 6f 69 6e 67 20 55 52 4c 73 20 61 6e  outgoing URLs an
04f0: 64 20 73 74 72 69 70 70 65 64 20 66 72 6f 6d 20  d stripped from 
0500: 61 6c 6c 20 69 6e 63 6f 6d 69 6e 67 20 55 52 4c  all incoming URL
0510: 73 0a 23 0a 23 20 20 4e 6f 74 65 3a 20 64 65 66  s.#.#  Note: def
0520: 61 75 6c 74 5f 61 70 70 6c 69 63 61 74 69 6f 6e  ault_application
0530: 2c 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2c 20  , applications, 
0540: 64 6f 6d 61 69 6e 73 20 26 20 70 61 74 68 5f 70  domains & path_p
0550: 72 65 66 69 78 20 61 72 65 20 70 65 72 6d 69 74  refix are permit
0560: 74 65 64 20 6f 6e 6c 79 20 69 6e 20 74 68 65 20  ted only in the 
0570: 42 41 53 45 20 72 6f 75 74 65 72 2c 0a 23 20 20  BASE router,.#  
0580: 20 20 20 20 20 20 61 6e 64 20 64 6f 6d 61 69 6e        and domain
0590: 20 6d 61 6b 65 73 20 73 65 6e 73 65 20 6f 6e 6c   makes sense onl
05a0: 79 20 69 6e 20 61 6e 20 61 70 70 6c 69 63 61 74  y in an applicat
05b0: 69 6f 6e 2d 73 70 65 63 69 66 69 63 20 72 6f 75  ion-specific rou
05c0: 74 65 72 2e 0a 23 20 20 20 20 20 20 20 20 54 68  ter..#        Th
05d0: 65 20 72 65 6d 61 69 6e 69 6e 67 20 6d 65 6d 62  e remaining memb
05e0: 65 72 73 20 63 61 6e 20 61 70 70 65 61 72 20 69  ers can appear i
05f0: 6e 20 74 68 65 20 42 41 53 45 20 72 6f 75 74 65  n the BASE route
0600: 72 20 28 61 73 20 64 65 66 61 75 6c 74 73 20 66  r (as defaults f
0610: 6f 72 20 61 6c 6c 20 61 70 70 6c 69 63 61 74 69  or all applicati
0620: 6f 6e 73 29 0a 23 20 20 20 20 20 20 20 20 6f 72  ons).#        or
0630: 20 69 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d   in application-
0640: 73 70 65 63 69 66 69 63 20 72 6f 75 74 65 72 73  specific routers
0650: 2e 0a 23 0a 23 20 20 64 65 66 61 75 6c 74 5f 63  ..#.#  default_c
0660: 6f 6e 74 72 6f 6c 6c 65 72 3a 20 6e 61 6d 65 20  ontroller: name 
0670: 6f 66 20 64 65 66 61 75 6c 74 20 63 6f 6e 74 72  of default contr
0680: 6f 6c 6c 65 72 0a 23 20 20 64 65 66 61 75 6c 74  oller.#  default
0690: 5f 66 75 6e 63 74 69 6f 6e 3a 20 6e 61 6d 65 20  _function: name 
06a0: 6f 66 20 64 65 66 61 75 6c 74 20 66 75 6e 63 74  of default funct
06b0: 69 6f 6e 20 28 69 6e 20 61 6c 6c 20 63 6f 6e 74  ion (in all cont
06c0: 72 6f 6c 6c 65 72 73 29 20 6f 72 20 64 69 63 74  rollers) or dict
06d0: 69 6f 6e 61 72 79 20 6f 66 20 64 65 66 61 75 6c  ionary of defaul
06e0: 74 20 66 75 6e 63 74 69 6f 6e 73 0a 23 20 20 20  t functions.#   
06f0: 20 20 20 20 62 79 20 63 6f 6e 74 72 6f 6c 6c 65      by controlle
0700: 72 0a 23 20 20 63 6f 6e 74 72 6f 6c 6c 65 72 73  r.#  controllers
0710: 3a 20 6c 69 73 74 20 6f 66 20 76 61 6c 69 64 20  : list of valid 
0720: 63 6f 6e 74 72 6f 6c 6c 65 72 73 20 69 6e 20 73  controllers in s
0730: 65 6c 65 63 74 65 64 20 61 70 70 0a 23 20 20 20  elected app.#   
0740: 20 20 20 20 6f 72 20 22 44 45 46 41 55 4c 54 22      or "DEFAULT"
0750: 20 74 6f 20 75 73 65 20 61 6c 6c 20 63 6f 6e 74   to use all cont
0760: 72 6f 6c 6c 65 72 73 20 69 6e 20 74 68 65 20 73  rollers in the s
0770: 65 6c 65 63 74 65 64 20 61 70 70 20 70 6c 75 73  elected app plus
0780: 20 27 73 74 61 74 69 63 27 0a 23 20 20 20 20 20   'static'.#     
0790: 20 20 6f 72 20 4e 6f 6e 65 20 74 6f 20 64 69 73    or None to dis
07a0: 61 62 6c 65 20 63 6f 6e 74 72 6f 6c 6c 65 72 2d  able controller-
07b0: 6e 61 6d 65 20 72 65 6d 6f 76 61 6c 2e 0a 23 20  name removal..# 
07c0: 20 20 20 20 20 4e 61 6d 65 73 20 69 6e 20 63 6f       Names in co
07d0: 6e 74 72 6f 6c 6c 65 72 73 20 61 72 65 20 61 6c  ntrollers are al
07e0: 77 61 79 73 20 74 72 65 61 74 65 64 20 61 73 20  ways treated as 
07f0: 63 6f 6e 74 72 6f 6c 6c 65 72 20 6e 61 6d 65 73  controller names
0800: 20 77 68 65 6e 20 74 68 65 79 20 61 70 70 65 61   when they appea
0810: 72 20 69 6e 20 61 6e 20 69 6e 63 6f 6d 69 6e 67  r in an incoming
0820: 20 55 52 4c 20 61 66 74 65 72 0a 23 20 20 20 20   URL after.#    
0830: 20 20 74 68 65 20 28 6f 70 74 69 6f 6e 61 6c 29    the (optional)
0840: 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 61 6e 64   application and
0850: 20 6c 61 6e 67 75 61 67 65 20 6e 61 6d 65 73 2e   language names.
0860: 0a 23 20 20 66 75 6e 63 74 69 6f 6e 73 3a 20 6c  .#  functions: l
0870: 69 73 74 20 6f 66 20 76 61 6c 69 64 20 66 75 6e  ist of valid fun
0880: 63 74 69 6f 6e 73 20 69 6e 20 74 68 65 20 64 65  ctions in the de
0890: 66 61 75 6c 74 20 63 6f 6e 74 72 6f 6c 6c 65 72  fault controller
08a0: 20 28 64 65 66 61 75 6c 74 20 4e 6f 6e 65 29 20   (default None) 
08b0: 6f 72 20 64 69 63 74 69 6f 6e 61 72 79 20 6f 66  or dictionary of
08c0: 20 76 61 6c 69 64 0a 23 20 20 20 20 20 20 20 66   valid.#       f
08d0: 75 6e 63 74 69 6f 6e 73 20 62 79 20 63 6f 6e 74  unctions by cont
08e0: 72 6f 6c 6c 65 72 2e 0a 23 20 20 20 20 20 20 20  roller..#       
08f0: 49 66 20 70 72 65 73 65 6e 74 2c 20 74 68 65 20  If present, the 
0900: 64 65 66 61 75 6c 74 20 66 75 6e 63 74 69 6f 6e  default function
0910: 20 6e 61 6d 65 20 77 69 6c 6c 20 62 65 20 6f 6d   name will be om
0920: 69 74 74 65 64 20 77 68 65 6e 20 74 68 65 20 63  itted when the c
0930: 6f 6e 74 72 6f 6c 6c 65 72 20 69 73 20 74 68 65  ontroller is the
0940: 20 64 65 66 61 75 6c 74 20 63 6f 6e 74 72 6f 6c   default control
0950: 6c 65 72 0a 23 20 20 20 20 20 20 20 61 6e 64 20  ler.#       and 
0960: 74 68 65 20 66 69 72 73 74 20 61 72 67 20 64 6f  the first arg do
0970: 65 73 20 6e 6f 74 20 63 72 65 61 74 65 20 61 6e  es not create an
0980: 20 61 6d 62 69 67 75 69 74 79 2e 0a 23 20 20 6c   ambiguity..#  l
0990: 61 6e 67 75 61 67 65 73 3a 20 6c 69 73 74 20 6f  anguages: list o
09a0: 66 20 61 6c 6c 20 73 75 70 70 6f 72 74 65 64 20  f all supported 
09b0: 6c 61 6e 67 75 61 67 65 73 0a 23 20 20 20 20 20  languages.#     
09c0: 20 20 4e 61 6d 65 73 20 69 6e 20 6c 61 6e 67 75    Names in langu
09d0: 61 67 65 73 20 61 72 65 20 61 6c 77 61 79 73 20  ages are always 
09e0: 74 72 65 61 74 65 64 20 61 73 20 6c 61 6e 67 75  treated as langu
09f0: 61 67 65 20 6e 61 6d 65 73 20 77 68 65 6e 20 74  age names when t
0a00: 68 65 79 20 61 70 70 65 61 72 20 69 6e 20 61 6e  hey appear in an
0a10: 20 69 6e 63 6f 6d 69 6e 67 20 55 52 4c 20 61 66   incoming URL af
0a20: 74 65 72 0a 23 20 20 20 20 20 20 20 74 68 65 20  ter.#       the 
0a30: 28 6f 70 74 69 6f 6e 61 6c 29 20 61 70 70 6c 69  (optional) appli
0a40: 63 61 74 69 6f 6e 20 6e 61 6d 65 2e 0a 23 20 20  cation name..#  
0a50: 64 65 66 61 75 6c 74 5f 6c 61 6e 67 75 61 67 65  default_language
0a60: 0a 23 20 20 20 20 20 20 20 54 68 65 20 6c 61 6e  .#       The lan
0a70: 67 75 61 67 65 20 63 6f 64 65 20 28 66 6f 72 20  guage code (for 
0a80: 65 78 61 6d 70 6c 65 3a 20 65 6e 2c 20 69 74 2d  example: en, it-
0a90: 69 74 29 20 6f 70 74 69 6f 6e 61 6c 6c 79 20 61  it) optionally a
0aa0: 70 70 65 61 72 73 20 69 6e 20 74 68 65 20 55 52  ppears in the UR
0ab0: 4c 20 66 6f 6c 6c 6f 77 69 6e 67 0a 23 20 20 20  L following.#   
0ac0: 20 20 20 20 74 68 65 20 61 70 70 6c 69 63 61 74      the applicat
0ad0: 69 6f 6e 20 28 77 68 69 63 68 20 6d 61 79 20 62  ion (which may b
0ae0: 65 20 6f 6d 69 74 74 65 64 29 2e 20 46 6f 72 20  e omitted). For 
0af0: 69 6e 63 6f 6d 69 6e 67 20 55 52 4c 73 2c 20 74  incoming URLs, t
0b00: 68 65 20 63 6f 64 65 20 69 73 20 63 6f 70 69 65  he code is copie
0b10: 64 20 74 6f 0a 23 20 20 20 20 20 20 20 72 65 71  d to.#       req
0b20: 75 65 73 74 2e 6c 61 6e 67 75 61 67 65 3b 20 66  uest.language; f
0b30: 6f 72 20 6f 75 74 67 6f 69 6e 67 20 55 52 4c 73  or outgoing URLs
0b40: 20 69 74 20 69 73 20 74 61 6b 65 6e 20 66 72 6f   it is taken fro
0b50: 6d 20 72 65 71 75 65 73 74 2e 6c 61 6e 67 75 61  m request.langua
0b60: 67 65 2e 0a 23 20 20 20 20 20 20 20 49 66 20 6c  ge..#       If l
0b70: 61 6e 67 75 61 67 65 73 3d 4e 6f 6e 65 2c 20 6c  anguages=None, l
0b80: 61 6e 67 75 61 67 65 20 73 75 70 70 6f 72 74 20  anguage support 
0b90: 69 73 20 64 69 73 61 62 6c 65 64 2e 0a 23 20 20  is disabled..#  
0ba0: 20 20 20 20 20 54 68 65 20 64 65 66 61 75 6c 74       The default
0bb0: 5f 6c 61 6e 67 75 61 67 65 2c 20 69 66 20 61 6e  _language, if an
0bc0: 79 2c 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72  y, is omitted fr
0bd0: 6f 6d 20 74 68 65 20 55 52 4c 2e 0a 23 20 20 72  om the URL..#  r
0be0: 6f 6f 74 5f 73 74 61 74 69 63 3a 20 6c 69 73 74  oot_static: list
0bf0: 20 6f 66 20 73 74 61 74 69 63 20 66 69 6c 65 73   of static files
0c00: 20 61 63 63 65 73 73 65 64 20 66 72 6f 6d 20 72   accessed from r
0c10: 6f 6f 74 20 28 62 79 20 64 65 66 61 75 6c 74 2c  oot (by default,
0c20: 20 66 61 76 69 63 6f 6e 2e 69 63 6f 20 26 20 72   favicon.ico & r
0c30: 6f 62 6f 74 73 2e 74 78 74 29 0a 23 20 20 20 20  obots.txt).#    
0c40: 20 20 20 28 6d 61 70 70 65 64 20 74 6f 20 74 68     (mapped to th
0c50: 65 20 64 65 66 61 75 6c 74 20 61 70 70 6c 69 63  e default applic
0c60: 61 74 69 6f 6e 27 73 20 73 74 61 74 69 63 2f 20  ation's static/ 
0c70: 64 69 72 65 63 74 6f 72 79 29 0a 23 20 20 20 20  directory).#    
0c80: 20 20 20 45 61 63 68 20 64 65 66 61 75 6c 74 20     Each default 
0c90: 28 69 6e 63 6c 75 64 69 6e 67 20 64 6f 6d 61 69  (including domai
0ca0: 6e 2d 6d 61 70 70 65 64 29 20 61 70 70 6c 69 63  n-mapped) applic
0cb0: 61 74 69 6f 6e 20 68 61 73 20 69 74 73 20 6f 77  ation has its ow
0cc0: 6e 20 72 6f 6f 74 2d 73 74 61 74 69 63 20 66 69  n root-static fi
0cd0: 6c 65 73 2e 0a 23 20 20 64 6f 6d 61 69 6e 3a 20  les..#  domain: 
0ce0: 74 68 65 20 64 6f 6d 61 69 6e 20 74 68 61 74 20  the domain that 
0cf0: 6d 61 70 73 20 74 6f 20 74 68 69 73 20 61 70 70  maps to this app
0d00: 6c 69 63 61 74 69 6f 6e 20 28 61 6c 74 65 72 6e  lication (altern
0d10: 61 74 69 76 65 20 74 6f 20 75 73 69 6e 67 20 64  ative to using d
0d20: 6f 6d 61 69 6e 73 20 69 6e 20 74 68 65 20 42 41  omains in the BA
0d30: 53 45 20 72 6f 75 74 65 72 29 0a 23 20 20 65 78  SE router).#  ex
0d40: 63 6c 75 73 69 76 65 5f 64 6f 6d 61 69 6e 3a 20  clusive_domain: 
0d50: 49 66 20 54 72 75 65 20 28 64 65 66 61 75 6c 74  If True (default
0d60: 20 69 73 20 46 61 6c 73 65 29 2c 20 61 6e 20 65   is False), an e
0d70: 78 63 65 70 74 69 6f 6e 20 69 73 20 72 61 69 73  xception is rais
0d80: 65 64 20 69 66 20 61 6e 20 61 74 74 65 6d 70 74  ed if an attempt
0d90: 20 69 73 20 6d 61 64 65 20 74 6f 20 67 65 6e 65   is made to gene
0da0: 72 61 74 65 0a 23 20 20 20 20 20 20 20 61 6e 20  rate.#       an 
0db0: 6f 75 74 67 6f 69 6e 67 20 55 52 4c 20 77 69 74  outgoing URL wit
0dc0: 68 20 61 20 64 69 66 66 65 72 65 6e 74 20 61 70  h a different ap
0dd0: 70 6c 69 63 61 74 69 6f 6e 20 77 69 74 68 6f 75  plication withou
0de0: 74 20 70 72 6f 76 69 64 69 6e 67 20 61 6e 20 65  t providing an e
0df0: 78 70 6c 69 63 69 74 20 68 6f 73 74 2e 0a 23 20  xplicit host..# 
0e00: 20 6d 61 70 5f 68 79 70 68 65 6e 3a 20 49 66 20   map_hyphen: If 
0e10: 54 72 75 65 20 28 64 65 66 61 75 6c 74 20 69 73  True (default is
0e20: 20 46 61 6c 73 65 29 2c 20 68 79 70 68 65 6e 73   False), hyphens
0e30: 20 69 6e 20 69 6e 63 6f 6d 69 6e 67 20 2f 61 2f   in incoming /a/
0e40: 63 2f 66 20 66 69 65 6c 64 73 20 61 72 65 20 63  c/f fields are c
0e50: 6f 6e 76 65 72 74 65 64 0a 23 20 20 20 20 20 20  onverted.#      
0e60: 20 74 6f 20 75 6e 64 65 72 73 63 6f 72 65 73 2c   to underscores,
0e70: 20 61 6e 64 20 62 61 63 6b 20 74 6f 20 68 79 70   and back to hyp
0e80: 68 65 6e 73 20 69 6e 20 6f 75 74 67 6f 69 6e 67  hens in outgoing
0e90: 20 55 52 4c 73 2e 0a 23 20 20 20 20 20 20 20 4c   URLs..#       L
0ea0: 61 6e 67 75 61 67 65 2c 20 61 72 67 73 20 61 6e  anguage, args an
0eb0: 64 20 74 68 65 20 71 75 65 72 79 20 73 74 72 69  d the query stri
0ec0: 6e 67 20 61 72 65 20 6e 6f 74 20 61 66 66 65 63  ng are not affec
0ed0: 74 65 64 2e 0a 23 20 20 6d 61 70 5f 73 74 61 74  ted..#  map_stat
0ee0: 69 63 3a 20 42 79 20 64 65 66 61 75 6c 74 2c 20  ic: By default, 
0ef0: 74 68 65 20 64 65 66 61 75 6c 74 20 61 70 70 6c  the default appl
0f00: 69 63 61 74 69 6f 6e 20 69 73 20 6e 6f 74 20 73  ication is not s
0f10: 74 72 69 70 70 65 64 20 66 72 6f 6d 20 73 74 61  tripped from sta
0f20: 74 69 63 20 55 52 4c 73 2e 0a 23 20 20 20 20 20  tic URLs..#     
0f30: 20 20 53 65 74 20 6d 61 70 5f 73 74 61 74 69 63    Set map_static
0f40: 3d 54 72 75 65 20 74 6f 20 6f 76 65 72 72 69 64  =True to overrid
0f50: 65 20 74 68 69 73 20 70 6f 6c 69 63 79 2e 0a 23  e this policy..#
0f60: 20 20 61 63 66 65 5f 6d 61 74 63 68 3a 20 72 65    acfe_match: re
0f70: 67 65 78 20 66 6f 72 20 76 61 6c 69 64 20 61 70  gex for valid ap
0f80: 70 6c 69 63 61 74 69 6f 6e 2c 20 63 6f 6e 74 72  plication, contr
0f90: 6f 6c 6c 65 72 2c 20 66 75 6e 63 74 69 6f 6e 2c  oller, function,
0fa0: 20 65 78 74 65 6e 73 69 6f 6e 20 2f 61 2f 63 2f   extension /a/c/
0fb0: 66 2e 65 0a 23 20 20 66 69 6c 65 5f 6d 61 74 63  f.e.#  file_matc
0fc0: 68 3a 20 72 65 67 65 78 20 66 6f 72 20 76 61 6c  h: regex for val
0fd0: 69 64 20 66 69 6c 65 20 28 75 73 65 64 20 66 6f  id file (used fo
0fe0: 72 20 73 74 61 74 69 63 20 66 69 6c 65 20 6e 61  r static file na
0ff0: 6d 65 73 29 0a 23 20 20 61 72 67 73 5f 6d 61 74  mes).#  args_mat
1000: 63 68 3a 20 72 65 67 65 78 20 66 6f 72 20 76 61  ch: regex for va
1010: 6c 69 64 20 61 72 67 73 0a 23 20 20 20 20 20 20  lid args.#      
1020: 20 54 68 69 73 20 76 61 6c 69 64 61 74 69 6f 6e   This validation
1030: 20 70 72 6f 76 69 64 65 73 20 61 20 6d 65 61 73   provides a meas
1040: 75 72 65 20 6f 66 20 73 65 63 75 72 69 74 79 2e  ure of security.
1050: 0a 23 20 20 20 20 20 20 20 49 66 20 69 74 20 69  .#       If it i
1060: 73 20 63 68 61 6e 67 65 64 2c 20 74 68 65 20 61  s changed, the a
1070: 70 70 6c 69 63 61 74 69 6f 6e 20 70 65 72 66 6f  pplication perfo
1080: 72 6d 20 69 74 73 20 6f 77 6e 20 76 61 6c 69 64  rm its own valid
1090: 61 74 69 6f 6e 2e 0a 23 0a 23 0a 23 20 20 54 68  ation..#.#.#  Th
10a0: 65 20 62 75 69 6c 74 2d 69 6e 20 64 65 66 61 75  e built-in defau
10b0: 6c 74 20 72 6f 75 74 65 72 20 73 75 70 70 6c 69  lt router suppli
10c0: 65 73 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65  es default value
10d0: 73 20 28 75 6e 64 65 66 69 6e 65 64 20 6d 65 6d  s (undefined mem
10e0: 62 65 72 73 20 61 72 65 20 4e 6f 6e 65 29 3a 0a  bers are None):.
10f0: 23 0a 23 20 20 20 20 20 64 65 66 61 75 6c 74 5f  #.#     default_
1100: 72 6f 75 74 65 72 20 3d 20 64 69 63 74 28 0a 23  router = dict(.#
1110: 20 20 20 20 20 20 20 20 20 64 65 66 61 75 6c 74           default
1120: 5f 61 70 70 6c 69 63 61 74 69 6f 6e 20 3d 20 27  _application = '
1130: 69 6e 69 74 27 2c 0a 23 20 20 20 20 20 20 20 20  init',.#        
1140: 20 20 20 20 20 61 70 70 6c 69 63 61 74 69 6f 6e       application
1150: 73 20 3d 20 27 41 4c 4c 27 2c 0a 23 20 20 20 20  s = 'ALL',.#    
1160: 20 20 20 20 20 64 65 66 61 75 6c 74 5f 63 6f 6e       default_con
1170: 74 72 6f 6c 6c 65 72 20 3d 20 27 64 65 66 61 75  troller = 'defau
1180: 6c 74 27 2c 0a 23 20 20 20 20 20 20 20 20 20 20  lt',.#          
1190: 20 20 20 63 6f 6e 74 72 6f 6c 6c 65 72 73 20 3d     controllers =
11a0: 20 27 44 45 46 41 55 4c 54 27 2c 0a 23 20 20 20   'DEFAULT',.#   
11b0: 20 20 20 20 20 20 64 65 66 61 75 6c 74 5f 66 75        default_fu
11c0: 6e 63 74 69 6f 6e 20 3d 20 27 69 6e 64 65 78 27  nction = 'index'
11d0: 2c 0a 23 20 20 20 20 20 20 20 20 20 20 20 20 20  ,.#             
11e0: 66 75 6e 63 74 69 6f 6e 73 20 3d 20 4e 6f 6e 65  functions = None
11f0: 2c 0a 23 20 20 20 20 20 20 20 20 20 64 65 66 61  ,.#         defa
1200: 75 6c 74 5f 6c 61 6e 67 75 61 67 65 20 3d 20 4e  ult_language = N
1210: 6f 6e 65 2c 0a 23 20 20 20 20 20 20 20 20 20 20  one,.#          
1220: 20 20 20 6c 61 6e 67 75 61 67 65 73 20 3d 20 4e     languages = N
1230: 6f 6e 65 2c 0a 23 20 20 20 20 20 20 20 20 20 72  one,.#         r
1240: 6f 6f 74 5f 73 74 61 74 69 63 20 3d 20 5b 27 66  oot_static = ['f
1250: 61 76 69 63 6f 6e 2e 69 63 6f 27 2c 20 27 72 6f  avicon.ico', 'ro
1260: 62 6f 74 73 2e 74 78 74 27 5d 2c 0a 23 20 20 20  bots.txt'],.#   
1270: 20 20 20 20 20 20 64 6f 6d 61 69 6e 73 20 3d 20        domains = 
1280: 4e 6f 6e 65 2c 0a 23 20 20 20 20 20 20 20 20 20  None,.#         
1290: 6d 61 70 5f 68 79 70 68 65 6e 20 3d 20 46 61 6c  map_hyphen = Fal
12a0: 73 65 2c 0a 23 20 20 20 20 20 20 20 20 20 61 63  se,.#         ac
12b0: 66 65 5f 6d 61 74 63 68 20 3d 20 72 27 5c 77 2b  fe_match = r'\w+
12c0: 24 27 2c 20 20 20 20 20 20 20 20 20 20 20 20 20  $',             
12d0: 20 23 20 6c 65 67 61 6c 20 61 70 70 2f 63 74 6c   # legal app/ctl
12e0: 72 2f 66 63 6e 2f 65 78 74 0a 23 20 20 20 20 20  r/fcn/ext.#     
12f0: 20 20 20 20 66 69 6c 65 5f 6d 61 74 63 68 20 3d      file_match =
1300: 20 72 27 28 5c 77 2b 5b 2d 3d 2e 2f 5d 3f 29 2b   r'(\w+[-=./]?)+
1310: 24 27 2c 20 20 20 20 23 20 6c 65 67 61 6c 20 66  $',    # legal f
1320: 69 6c 65 20 28 70 61 74 68 29 20 6e 61 6d 65 0a  ile (path) name.
1330: 23 20 20 20 20 20 20 20 20 20 61 72 67 73 5f 6d  #         args_m
1340: 61 74 63 68 20 3d 20 72 27 28 5b 5c 77 40 20 2d  atch = r'([\w@ -
1350: 5d 2b 5b 3d 2e 5d 3f 29 2b 24 27 2c 20 23 20 6c  ]+[=.]?)+$', # l
1360: 65 67 61 6c 20 61 72 67 20 69 6e 20 61 72 67 73  egal arg in args
1370: 0a 23 20 20 20 20 20 29 0a 23 0a 23 20 20 53 65  .#     ).#.#  Se
1380: 65 20 72 65 77 72 69 74 65 2e 6d 61 70 5f 75 72  e rewrite.map_ur
1390: 6c 5f 69 6e 28 29 20 61 6e 64 20 72 65 77 72 69  l_in() and rewri
13a0: 74 65 2e 6d 61 70 5f 75 72 6c 5f 6f 75 74 28 29  te.map_url_out()
13b0: 20 66 6f 72 20 69 6d 70 6c 65 6d 65 6e 74 61 74   for implementat
13c0: 69 6f 6e 20 64 65 74 61 69 6c 73 2e 0a 0a 0a 23  ion details....#
13d0: 20 20 54 68 69 73 20 73 69 6d 70 6c 65 20 72 6f    This simple ro
13e0: 75 74 65 72 20 73 65 74 20 6f 76 65 72 72 69 64  uter set overrid
13f0: 65 73 20 6f 6e 6c 79 20 74 68 65 20 64 65 66 61  es only the defa
1400: 75 6c 74 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  ult application 
1410: 6e 61 6d 65 2c 0a 23 20 20 62 75 74 20 70 72 6f  name,.#  but pro
1420: 76 69 64 65 73 20 66 75 6c 6c 20 72 65 77 72 69  vides full rewri
1430: 74 65 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79  te functionality
1440: 2e 0a 0a 72 6f 75 74 65 72 73 20 3d 20 64 69 63  ...routers = dic
1450: 74 28 0a 0a 20 20 20 20 23 20 62 61 73 65 20 72  t(..    # base r
1460: 6f 75 74 65 72 0a 20 20 20 20 42 41 53 45 20 3d  outer.    BASE =
1470: 20 64 69 63 74 28 0a 20 20 20 20 20 20 20 20 64   dict(.        d
1480: 65 66 61 75 6c 74 5f 61 70 70 6c 69 63 61 74 69  efault_applicati
1490: 6f 6e 20 3d 20 27 77 65 6c 63 6f 6d 65 27 2c 0a  on = 'welcome',.
14a0: 20 20 20 20 29 2c 0a 29 0a 0a 0a 23 20 45 72 72      ),.)...# Err
14b0: 6f 72 2d 68 61 6e 64 6c 69 6e 67 20 72 65 64 69  or-handling redi
14c0: 72 65 63 74 73 20 61 6c 6c 20 48 54 54 50 20 65  rects all HTTP e
14d0: 72 72 6f 72 73 20 28 73 74 61 74 75 73 20 63 6f  rrors (status co
14e0: 64 65 73 20 3e 3d 20 34 30 30 29 20 74 6f 20 61  des >= 400) to a
14f0: 20 73 70 65 63 69 66 69 65 64 0a 23 20 70 61 74   specified.# pat
1500: 68 2e 20 20 49 66 20 79 6f 75 20 77 69 73 68 20  h.  If you wish 
1510: 74 6f 20 75 73 65 20 65 72 72 6f 72 2d 68 61 6e  to use error-han
1520: 64 6c 69 6e 67 20 72 65 64 69 72 65 63 74 73 2c  dling redirects,
1530: 20 75 6e 63 6f 6d 6d 65 6e 74 20 74 68 65 20 74   uncomment the t
1540: 75 70 6c 65 0a 23 20 62 65 6c 6f 77 2e 20 20 59  uple.# below.  Y
1550: 6f 75 20 63 61 6e 20 63 75 73 74 6f 6d 69 7a 65  ou can customize
1560: 20 72 65 73 70 6f 6e 73 65 73 20 62 79 20 61 64   responses by ad
1570: 64 69 6e 67 20 61 20 74 75 70 6c 65 20 65 6e 74  ding a tuple ent
1580: 72 79 20 77 69 74 68 20 74 68 65 20 66 69 72 73  ry with the firs
1590: 74 0a 23 20 76 61 6c 75 65 20 69 6e 20 27 61 70  t.# value in 'ap
15a0: 70 4e 61 6d 65 2f 48 54 54 50 73 74 61 74 75 73  pName/HTTPstatus
15b0: 43 6f 64 65 27 20 66 6f 72 6d 61 74 2e 20 28 20  Code' format. ( 
15c0: 4f 6e 6c 79 20 48 54 54 50 20 63 6f 64 65 73 20  Only HTTP codes 
15d0: 3e 3d 20 34 30 30 20 61 72 65 0a 23 20 72 6f 75  >= 400 are.# rou
15e0: 74 65 64 2e 20 29 20 61 6e 64 20 74 68 65 20 76  ted. ) and the v
15f0: 61 6c 75 65 20 61 73 20 61 20 70 61 74 68 20 74  alue as a path t
1600: 6f 20 72 65 64 69 72 65 63 74 20 74 68 65 20 75  o redirect the u
1610: 73 65 72 20 74 6f 2e 20 20 59 6f 75 20 6d 61 79  ser to.  You may
1620: 20 61 6c 73 6f 20 75 73 65 0a 23 20 27 2a 27 20   also use.# '*' 
1630: 61 73 20 61 20 77 69 6c 64 63 61 72 64 2e 0a 23  as a wildcard..#
1640: 0a 23 20 54 68 65 20 65 72 72 6f 72 20 68 61 6e  .# The error han
1650: 64 6c 69 6e 67 20 70 61 67 65 20 69 73 20 61 6c  dling page is al
1660: 73 6f 20 70 61 73 73 65 64 20 74 68 65 20 65 72  so passed the er
1670: 72 6f 72 20 63 6f 64 65 20 61 6e 64 20 74 69 63  ror code and tic
1680: 6b 65 74 20 61 73 0a 23 20 76 61 72 69 61 62 6c  ket as.# variabl
1690: 65 73 2e 20 20 54 72 61 63 65 62 61 63 6b 20 69  es.  Traceback i
16a0: 6e 66 6f 72 6d 61 74 69 6f 6e 20 77 69 6c 6c 20  nformation will 
16b0: 62 65 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65  be stored in the
16c0: 20 74 69 63 6b 65 74 2e 0a 23 0a 23 20 72 6f 75   ticket..#.# rou
16d0: 74 65 73 5f 6f 6e 65 72 72 6f 72 20 3d 20 5b 0a  tes_onerror = [.
16e0: 23 20 20 20 20 20 28 72 27 69 6e 69 74 2f 34 30  #     (r'init/40
16f0: 30 27 2c 20 72 27 2f 69 6e 69 74 2f 64 65 66 61  0', r'/init/defa
1700: 75 6c 74 2f 6c 6f 67 69 6e 27 29 0a 23 20 20 20  ult/login').#   
1710: 20 2c 28 72 27 69 6e 69 74 2f 2a 27 2c 20 72 27   ,(r'init/*', r'
1720: 2f 69 6e 69 74 2f 73 74 61 74 69 63 2f 66 61 69  /init/static/fai
1730: 6c 2e 68 74 6d 6c 27 29 0a 23 20 20 20 20 2c 28  l.html').#    ,(
1740: 72 27 2a 2f 34 30 34 27 2c 20 72 27 2f 69 6e 69  r'*/404', r'/ini
1750: 74 2f 73 74 61 74 69 63 2f 63 61 6e 74 66 69 6e  t/static/cantfin
1760: 64 2e 68 74 6d 6c 27 29 0a 23 20 20 20 20 2c 28  d.html').#    ,(
1770: 72 27 2a 2f 2a 27 2c 20 72 27 2f 69 6e 69 74 2f  r'*/*', r'/init/
1780: 65 72 72 6f 72 2f 69 6e 64 65 78 27 29 0a 23 20  error/index').# 
1790: 5d 0a 0a 23 20 73 70 65 63 69 66 79 20 61 63 74  ]..# specify act
17a0: 69 6f 6e 20 69 6e 20 63 68 61 72 67 65 20 6f 66  ion in charge of
17b0: 20 65 72 72 6f 72 20 68 61 6e 64 6c 69 6e 67 0a   error handling.
17c0: 23 0a 23 20 65 72 72 6f 72 5f 68 61 6e 64 6c 65  #.# error_handle
17d0: 72 20 3d 20 64 69 63 74 28 61 70 70 6c 69 63 61  r = dict(applica
17e0: 74 69 6f 6e 3d 27 65 72 72 6f 72 27 2c 0a 23 20  tion='error',.# 
17f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1800: 20 20 20 20 20 63 6f 6e 74 72 6f 6c 6c 65 72 3d       controller=
1810: 27 64 65 66 61 75 6c 74 27 2c 0a 23 20 20 20 20  'default',.#    
1820: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1830: 20 20 66 75 6e 63 74 69 6f 6e 3d 27 69 6e 64 65    function='inde
1840: 78 27 29 0a 0a 23 20 49 6e 20 74 68 65 20 65 76  x')..# In the ev
1850: 65 6e 74 20 74 68 61 74 20 74 68 65 20 65 72 72  ent that the err
1860: 6f 72 2d 68 61 6e 64 6c 69 6e 67 20 70 61 67 65  or-handling page
1870: 20 69 74 73 65 6c 66 20 72 65 74 75 72 6e 73 20   itself returns 
1880: 61 6e 20 65 72 72 6f 72 2c 20 77 65 62 32 70 79  an error, web2py
1890: 20 77 69 6c 6c 0a 23 20 66 61 6c 6c 20 62 61 63   will.# fall bac
18a0: 6b 20 74 6f 20 69 74 73 20 6f 6c 64 20 73 74 61  k to its old sta
18b0: 74 69 63 20 72 65 73 70 6f 6e 73 65 73 2e 20 20  tic responses.  
18c0: 59 6f 75 20 63 61 6e 20 63 75 73 74 6f 6d 69 7a  You can customiz
18d0: 65 20 74 68 65 6d 20 68 65 72 65 2e 0a 23 20 45  e them here..# E
18e0: 72 72 6f 72 4d 65 73 73 61 67 65 54 69 63 6b 65  rrorMessageTicke
18f0: 74 20 74 61 6b 65 73 20 61 20 73 74 72 69 6e 67  t takes a string
1900: 20 66 6f 72 6d 61 74 20 64 69 63 74 69 6f 6e 61   format dictiona
1910: 72 79 20 63 6f 6e 74 61 69 6e 69 6e 67 20 28 6f  ry containing (o
1920: 6e 6c 79 29 20 74 68 65 0a 23 20 22 74 69 63 6b  nly) the.# "tick
1930: 65 74 22 20 6b 65 79 2e 0a 0a 23 20 65 72 72 6f  et" key...# erro
1940: 72 5f 6d 65 73 73 61 67 65 20 3d 20 27 3c 68 74  r_message = '<ht
1950: 6d 6c 3e 3c 62 6f 64 79 3e 3c 68 31 3e 25 73 3c  ml><body><h1>%s<
1960: 2f 68 31 3e 3c 2f 62 6f 64 79 3e 3c 2f 68 74 6d  /h1></body></htm
1970: 6c 3e 27 0a 23 20 65 72 72 6f 72 5f 6d 65 73 73  l>'.# error_mess
1980: 61 67 65 5f 74 69 63 6b 65 74 20 3d 20 27 3c 68  age_ticket = '<h
1990: 74 6d 6c 3e 3c 62 6f 64 79 3e 3c 68 31 3e 49 6e  tml><body><h1>In
19a0: 74 65 72 6e 61 6c 20 65 72 72 6f 72 3c 2f 68 31  ternal error</h1
19b0: 3e 54 69 63 6b 65 74 20 69 73 73 75 65 64 3a 20  >Ticket issued: 
19c0: 3c 61 20 68 72 65 66 3d 22 2f 61 64 6d 69 6e 2f  <a href="/admin/
19d0: 64 65 66 61 75 6c 74 2f 74 69 63 6b 65 74 2f 25  default/ticket/%
19e0: 28 74 69 63 6b 65 74 29 73 22 20 74 61 72 67 65  (ticket)s" targe
19f0: 74 3d 22 5f 62 6c 61 6e 6b 22 3e 25 28 74 69 63  t="_blank">%(tic
1a00: 6b 65 74 29 73 3c 2f 61 3e 3c 2f 62 6f 64 79 3e  ket)s</a></body>
1a10: 3c 2f 68 74 6d 6c 3e 27 0a 0a 64 65 66 20 5f 5f  </html>'..def __
1a20: 72 6f 75 74 65 73 5f 64 6f 63 74 65 73 74 28 29  routes_doctest()
1a30: 3a 0a 20 20 20 20 27 27 27 0a 20 20 20 20 44 75  :.    '''.    Du
1a40: 6d 6d 79 20 66 75 6e 63 74 69 6f 6e 20 66 6f 72  mmy function for
1a50: 20 64 6f 63 74 65 73 74 69 6e 67 20 72 6f 75 74   doctesting rout
1a60: 65 73 2e 70 79 2e 0a 0a 20 20 20 20 55 73 65 20  es.py...    Use 
1a70: 66 69 6c 74 65 72 5f 75 72 6c 28 29 20 74 6f 20  filter_url() to 
1a80: 74 65 73 74 20 69 6e 63 6f 6d 69 6e 67 20 6f 72  test incoming or
1a90: 20 6f 75 74 67 6f 69 6e 67 20 72 6f 75 74 65 73   outgoing routes
1aa0: 3b 0a 20 20 20 20 66 69 6c 74 65 72 5f 65 72 72  ;.    filter_err
1ab0: 28 29 20 66 6f 72 20 65 72 72 6f 72 20 72 65 64  () for error red
1ac0: 69 72 65 63 74 69 6f 6e 2e 0a 0a 20 20 20 20 66  irection...    f
1ad0: 69 6c 74 65 72 5f 75 72 6c 28 29 20 61 63 63 65  ilter_url() acce
1ae0: 70 74 73 20 6f 76 65 72 72 69 64 65 73 20 66 6f  pts overrides fo
1af0: 72 20 6d 65 74 68 6f 64 20 61 6e 64 20 72 65 6d  r method and rem
1b00: 6f 74 65 20 68 6f 73 74 3a 0a 20 20 20 20 20 20  ote host:.      
1b10: 20 20 66 69 6c 74 65 72 5f 75 72 6c 28 75 72 6c    filter_url(url
1b20: 2c 20 6d 65 74 68 6f 64 3d 27 67 65 74 27 2c 20  , method='get', 
1b30: 72 65 6d 6f 74 65 3d 27 30 2e 30 2e 30 2e 30 27  remote='0.0.0.0'
1b40: 2c 20 6f 75 74 3d 46 61 6c 73 65 29 0a 0a 20 20  , out=False)..  
1b50: 20 20 66 69 6c 74 65 72 5f 65 72 72 28 29 20 61    filter_err() a
1b60: 63 63 65 70 74 73 20 6f 76 65 72 72 69 64 65 73  ccepts overrides
1b70: 20 66 6f 72 20 61 70 70 6c 69 63 61 74 69 6f 6e   for application
1b80: 20 61 6e 64 20 74 69 63 6b 65 74 3a 0a 20 20 20   and ticket:.   
1b90: 20 20 20 20 20 66 69 6c 74 65 72 5f 65 72 72 28       filter_err(
1ba0: 73 74 61 74 75 73 2c 20 61 70 70 6c 69 63 61 74  status, applicat
1bb0: 69 6f 6e 3d 27 61 70 70 27 2c 20 74 69 63 6b 65  ion='app', ticke
1bc0: 74 3d 27 74 6b 74 27 29 0a 0a 20 20 20 20 3e 3e  t='tkt')..    >>
1bd0: 3e 20 69 6d 70 6f 72 74 20 6f 73 0a 20 20 20 20  > import os.    
1be0: 3e 3e 3e 20 69 6d 70 6f 72 74 20 67 6c 75 6f 6e  >>> import gluon
1bf0: 2e 6d 61 69 6e 0a 20 20 20 20 3e 3e 3e 20 66 72  .main.    >>> fr
1c00: 6f 6d 20 67 6c 75 6f 6e 2e 72 65 77 72 69 74 65  om gluon.rewrite
1c10: 20 69 6d 70 6f 72 74 20 6c 6f 61 64 2c 20 66 69   import load, fi
1c20: 6c 74 65 72 5f 75 72 6c 2c 20 66 69 6c 74 65 72  lter_url, filter
1c30: 5f 65 72 72 2c 20 67 65 74 5f 65 66 66 65 63 74  _err, get_effect
1c40: 69 76 65 5f 72 6f 75 74 65 72 0a 20 20 20 20 3e  ive_router.    >
1c50: 3e 3e 20 6c 6f 61 64 28 72 6f 75 74 65 73 3d 6f  >> load(routes=o
1c60: 73 2e 70 61 74 68 2e 62 61 73 65 6e 61 6d 65 28  s.path.basename(
1c70: 5f 5f 66 69 6c 65 5f 5f 29 29 0a 0a 20 20 20 20  __file__))..    
1c80: 3e 3e 3e 20 66 69 6c 74 65 72 5f 75 72 6c 28 27  >>> filter_url('
1c90: 68 74 74 70 3a 2f 2f 64 6f 6d 61 69 6e 2e 63 6f  http://domain.co
1ca0: 6d 2f 61 62 63 27 2c 20 61 70 70 3d 54 72 75 65  m/abc', app=True
1cb0: 29 0a 20 20 20 20 27 77 65 6c 63 6f 6d 65 27 0a  ).    'welcome'.
1cc0: 20 20 20 20 3e 3e 3e 20 66 69 6c 74 65 72 5f 75      >>> filter_u
1cd0: 72 6c 28 27 68 74 74 70 3a 2f 2f 64 6f 6d 61 69  rl('http://domai
1ce0: 6e 2e 63 6f 6d 2f 77 65 6c 63 6f 6d 65 27 2c 20  n.com/welcome', 
1cf0: 61 70 70 3d 54 72 75 65 29 0a 20 20 20 20 27 77  app=True).    'w
1d00: 65 6c 63 6f 6d 65 27 0a 20 20 20 20 3e 3e 3e 20  elcome'.    >>> 
1d10: 6f 73 2e 70 61 74 68 2e 72 65 6c 70 61 74 68 28  os.path.relpath(
1d20: 66 69 6c 74 65 72 5f 75 72 6c 28 27 68 74 74 70  filter_url('http
1d30: 3a 2f 2f 64 6f 6d 61 69 6e 2e 63 6f 6d 2f 66 61  ://domain.com/fa
1d40: 76 69 63 6f 6e 2e 69 63 6f 27 29 29 0a 20 20 20  vicon.ico')).   
1d50: 20 27 61 70 70 6c 69 63 61 74 69 6f 6e 73 2f 77   'applications/w
1d60: 65 6c 63 6f 6d 65 2f 73 74 61 74 69 63 2f 66 61  elcome/static/fa
1d70: 76 69 63 6f 6e 2e 69 63 6f 27 0a 20 20 20 20 3e  vicon.ico'.    >
1d80: 3e 3e 20 66 69 6c 74 65 72 5f 75 72 6c 28 27 68  >> filter_url('h
1d90: 74 74 70 3a 2f 2f 64 6f 6d 61 69 6e 2e 63 6f 6d  ttp://domain.com
1da0: 2f 61 62 63 27 29 0a 20 20 20 20 27 2f 77 65 6c  /abc').    '/wel
1db0: 63 6f 6d 65 2f 64 65 66 61 75 6c 74 2f 61 62 63  come/default/abc
1dc0: 27 0a 20 20 20 20 3e 3e 3e 20 66 69 6c 74 65 72  '.    >>> filter
1dd0: 5f 75 72 6c 28 27 68 74 74 70 3a 2f 2f 64 6f 6d  _url('http://dom
1de0: 61 69 6e 2e 63 6f 6d 2f 69 6e 64 65 78 2f 61 62  ain.com/index/ab
1df0: 63 27 29 0a 20 20 20 20 22 2f 77 65 6c 63 6f 6d  c').    "/welcom
1e00: 65 2f 64 65 66 61 75 6c 74 2f 69 6e 64 65 78 20  e/default/index 
1e10: 5b 27 61 62 63 27 5d 22 0a 20 20 20 20 3e 3e 3e  ['abc']".    >>>
1e20: 20 66 69 6c 74 65 72 5f 75 72 6c 28 27 68 74 74   filter_url('htt
1e30: 70 3a 2f 2f 64 6f 6d 61 69 6e 2e 63 6f 6d 2f 64  p://domain.com/d
1e40: 65 66 61 75 6c 74 2f 61 62 63 2e 63 73 73 27 29  efault/abc.css')
1e50: 0a 20 20 20 20 27 2f 77 65 6c 63 6f 6d 65 2f 64  .    '/welcome/d
1e60: 65 66 61 75 6c 74 2f 61 62 63 2e 63 73 73 27 0a  efault/abc.css'.
1e70: 20 20 20 20 3e 3e 3e 20 66 69 6c 74 65 72 5f 75      >>> filter_u
1e80: 72 6c 28 27 68 74 74 70 3a 2f 2f 64 6f 6d 61 69  rl('http://domai
1e90: 6e 2e 63 6f 6d 2f 64 65 66 61 75 6c 74 2f 69 6e  n.com/default/in
1ea0: 64 65 78 2f 61 62 63 27 29 0a 20 20 20 20 22 2f  dex/abc').    "/
1eb0: 77 65 6c 63 6f 6d 65 2f 64 65 66 61 75 6c 74 2f  welcome/default/
1ec0: 69 6e 64 65 78 20 5b 27 61 62 63 27 5d 22 0a 20  index ['abc']". 
1ed0: 20 20 20 3e 3e 3e 20 66 69 6c 74 65 72 5f 75 72     >>> filter_ur
1ee0: 6c 28 27 68 74 74 70 3a 2f 2f 64 6f 6d 61 69 6e  l('http://domain
1ef0: 2e 63 6f 6d 2f 64 65 66 61 75 6c 74 2f 69 6e 64  .com/default/ind
1f00: 65 78 2f 61 20 62 63 27 29 0a 20 20 20 20 22 2f  ex/a bc').    "/
1f10: 77 65 6c 63 6f 6d 65 2f 64 65 66 61 75 6c 74 2f  welcome/default/
1f20: 69 6e 64 65 78 20 5b 27 61 20 62 63 27 5d 22 0a  index ['a bc']".
1f30: 0a 20 20 20 20 3e 3e 3e 20 66 69 6c 74 65 72 5f  .    >>> filter_
1f40: 75 72 6c 28 27 68 74 74 70 73 3a 2f 2f 64 6f 6d  url('https://dom
1f50: 61 69 6e 2e 63 6f 6d 2f 61 70 70 2f 63 74 72 2f  ain.com/app/ctr/
1f60: 66 63 6e 27 2c 20 6f 75 74 3d 54 72 75 65 29 0a  fcn', out=True).
1f70: 20 20 20 20 27 2f 61 70 70 2f 63 74 72 2f 66 63      '/app/ctr/fc
1f80: 6e 27 0a 20 20 20 20 3e 3e 3e 20 66 69 6c 74 65  n'.    >>> filte
1f90: 72 5f 75 72 6c 28 27 68 74 74 70 73 3a 2f 2f 64  r_url('https://d
1fa0: 6f 6d 61 69 6e 2e 63 6f 6d 2f 77 65 6c 63 6f 6d  omain.com/welcom
1fb0: 65 2f 63 74 72 2f 66 63 6e 27 2c 20 6f 75 74 3d  e/ctr/fcn', out=
1fc0: 54 72 75 65 29 0a 20 20 20 20 27 2f 63 74 72 2f  True).    '/ctr/
1fd0: 66 63 6e 27 0a 20 20 20 20 3e 3e 3e 20 66 69 6c  fcn'.    >>> fil
1fe0: 74 65 72 5f 75 72 6c 28 27 68 74 74 70 73 3a 2f  ter_url('https:/
1ff0: 2f 64 6f 6d 61 69 6e 2e 63 6f 6d 2f 77 65 6c 63  /domain.com/welc
2000: 6f 6d 65 2f 64 65 66 61 75 6c 74 2f 66 63 6e 27  ome/default/fcn'
2010: 2c 20 6f 75 74 3d 54 72 75 65 29 0a 20 20 20 20  , out=True).    
2020: 27 2f 66 63 6e 27 0a 20 20 20 20 3e 3e 3e 20 66  '/fcn'.    >>> f
2030: 69 6c 74 65 72 5f 75 72 6c 28 27 68 74 74 70 73  ilter_url('https
2040: 3a 2f 2f 64 6f 6d 61 69 6e 2e 63 6f 6d 2f 77 65  ://domain.com/we
2050: 6c 63 6f 6d 65 2f 64 65 66 61 75 6c 74 2f 69 6e  lcome/default/in
2060: 64 65 78 27 2c 20 6f 75 74 3d 54 72 75 65 29 0a  dex', out=True).
2070: 20 20 20 20 27 2f 27 0a 20 20 20 20 3e 3e 3e 20      '/'.    >>> 
2080: 66 69 6c 74 65 72 5f 75 72 6c 28 27 68 74 74 70  filter_url('http
2090: 73 3a 2f 2f 64 6f 6d 61 69 6e 2e 63 6f 6d 2f 77  s://domain.com/w
20a0: 65 6c 63 6f 6d 65 2f 61 70 70 61 64 6d 69 6e 2f  elcome/appadmin/
20b0: 69 6e 64 65 78 27 2c 20 6f 75 74 3d 54 72 75 65  index', out=True
20c0: 29 0a 20 20 20 20 27 2f 61 70 70 61 64 6d 69 6e  ).    '/appadmin
20d0: 27 0a 20 20 20 20 3e 3e 3e 20 66 69 6c 74 65 72  '.    >>> filter
20e0: 5f 75 72 6c 28 27 68 74 74 70 3a 2f 2f 64 6f 6d  _url('http://dom
20f0: 61 69 6e 2e 63 6f 6d 2f 77 65 6c 63 6f 6d 65 2f  ain.com/welcome/
2100: 64 65 66 61 75 6c 74 2f 66 63 6e 3f 71 75 65 72  default/fcn?quer
2110: 79 27 2c 20 6f 75 74 3d 54 72 75 65 29 0a 20 20  y', out=True).  
2120: 20 20 27 2f 66 63 6e 3f 71 75 65 72 79 27 0a 20    '/fcn?query'. 
2130: 20 20 20 3e 3e 3e 20 66 69 6c 74 65 72 5f 75 72     >>> filter_ur
2140: 6c 28 27 68 74 74 70 3a 2f 2f 64 6f 6d 61 69 6e  l('http://domain
2150: 2e 63 6f 6d 2f 77 65 6c 63 6f 6d 65 2f 64 65 66  .com/welcome/def
2160: 61 75 6c 74 2f 66 63 6e 23 61 6e 63 68 6f 72 27  ault/fcn#anchor'
2170: 2c 20 6f 75 74 3d 54 72 75 65 29 0a 20 20 20 20  , out=True).    
2180: 27 2f 66 63 6e 23 61 6e 63 68 6f 72 27 0a 20 20  '/fcn#anchor'.  
2190: 20 20 3e 3e 3e 20 66 69 6c 74 65 72 5f 75 72 6c    >>> filter_url
21a0: 28 27 68 74 74 70 3a 2f 2f 64 6f 6d 61 69 6e 2e  ('http://domain.
21b0: 63 6f 6d 2f 77 65 6c 63 6f 6d 65 2f 64 65 66 61  com/welcome/defa
21c0: 75 6c 74 2f 66 63 6e 3f 71 75 65 72 79 23 61 6e  ult/fcn?query#an
21d0: 63 68 6f 72 27 2c 20 6f 75 74 3d 54 72 75 65 29  chor', out=True)
21e0: 0a 20 20 20 20 27 2f 66 63 6e 3f 71 75 65 72 79  .    '/fcn?query
21f0: 23 61 6e 63 68 6f 72 27 0a 0a 20 20 20 20 3e 3e  #anchor'..    >>
2200: 3e 20 66 69 6c 74 65 72 5f 65 72 72 28 32 30 30  > filter_err(200
2210: 29 0a 20 20 20 20 32 30 30 0a 20 20 20 20 3e 3e  ).    200.    >>
2220: 3e 20 66 69 6c 74 65 72 5f 65 72 72 28 33 39 39  > filter_err(399
2230: 29 0a 20 20 20 20 33 39 39 0a 20 20 20 20 3e 3e  ).    399.    >>
2240: 3e 20 66 69 6c 74 65 72 5f 65 72 72 28 34 30 30  > filter_err(400
2250: 29 0a 20 20 20 20 34 30 30 0a 20 20 20 20 27 27  ).    400.    ''
2260: 27 0a 20 20 20 20 70 61 73 73 0a 0a 69 66 20 5f  '.    pass..if _
2270: 5f 6e 61 6d 65 5f 5f 20 3d 3d 20 27 5f 5f 6d 61  _name__ == '__ma
2280: 69 6e 5f 5f 27 3a 0a 20 20 20 20 69 6d 70 6f 72  in__':.    impor
2290: 74 20 64 6f 63 74 65 73 74 0a 20 20 20 20 64 6f  t doctest.    do
22a0: 63 74 65 73 74 2e 74 65 73 74 6d 6f 64 28 29 0a  ctest.testmod().
22b0: 0a                                               .