~mdw / chopwood / blame
| Commit | Line | Data |
|---|---|---|
| a2916c06 MW |
1 | ### -*-python-*- |
| 2 | ### | |
| 3 | ### CGI commands | |
| 4 | ### | |
| 5 | ### (c) 2013 Mark Wooding | |
| 6 | ### | |
| 7 | ||
| 8 | ###----- Licensing notice --------------------------------------------------- | |
| 9 | ### | |
| 10 | ### This file is part of Chopwood: a password-changing service. | |
| 11 | ### | |
| 12 | ### Chopwood is free software; you can redistribute it and/or modify | |
| 13 | ### it under the terms of the GNU Affero General Public License as | |
| 14 | ### published by the Free Software Foundation; either version 3 of the | |
| 15 | ### License, or (at your option) any later version. | |
| 16 | ### | |
| 17 | ### Chopwood is distributed in the hope that it will be useful, | |
| 18 | ### but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 | ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 20 | ### GNU Affero General Public License for more details. | |
| 21 | ### | |
| 22 | ### You should have received a copy of the GNU Affero General Public | |
| 23 | ### License along with Chopwood; if not, see | |
| 24 | ### <http://www.gnu.org/licenses/>. | |
| 25 | ||
| 26 | from __future__ import with_statement | |
| 27 | ||
| 28 | import errno as E | |
| 29 | import os as OS | |
| 30 | ||
| 31 | from auto import PACKAGE, VERSION | |
| 32 | import agpl as AGPL | |
| 33 | import cgi as CGI | |
| 34 | import cmdutil as CU | |
| 35 | import dbmaint as D | |
| 36 | import httpauth as HA | |
| 37 | import operation as OP | |
| 38 | import output as O; OUT = O.OUT; PRINT = O.PRINT | |
| 39 | import service as S | |
| 40 | import subcommand as SC | |
| 41 | import util as U | |
| 42 | ||
| 43 | ###-------------------------------------------------------------------------- | |
| 44 | ### Utilities. | |
| 45 | ||
| 46 | def operate(what, op, services, *args, **kw): | |
| 47 | accts = CU.resolve_accounts(CU.USER, services) | |
| 48 | o, ii, rq, ops = OP.operate(op, accts, *args, **kw) | |
| 49 | CGI.page('operate.fhtml', | |
| 50 | header = dict(pragma = 'no-cache', cache_control = 'no-cache'), | |
| 51 | title = 'Chopwood: %s' % what, | |
| 52 | what = what, | |
| 53 | outcome = o, info = ii, results = ops) | |
| 54 | ||
| 55 | ###-------------------------------------------------------------------------- | |
| 56 | ### Commands. | |
| 57 | ||
| 58 | @CGI.subcommand('list', ['cgi-query'], 'List available accounts') | |
| 59 | def cmd_list_cgi(): | |
| 60 | CGI.page('list.fhtml', | |
| 6a749ccf | 61 | header = dict(pragma = 'no-cache', cache_control = 'no-cache'), |
| a2916c06 MW |
62 | title = 'Chopwood: accounts list', |
| 63 | accts = CU.list_accounts(CU.USER), | |
| 64 | nonce = HA.NONCE) | |
| 65 | ||
| 66 | @CGI.subcommand( | |
| 67 | 'set', ['cgi'], 'Set password for a collection of services.', | |
| 68 | params = [SC.Arg('first'), SC.Arg('second')], | |
| 69 | rparam = SC.Arg('services')) | |
| 70 | def cmd_set_cgi(first, second, services = []): | |
| 71 | if first != second: raise U.ExpectedError, (400, "Passwords don't match") | |
| 72 | operate('set passwords', 'set', services, first) | |
| 73 | ||
| 74 | @CGI.subcommand( | |
| 75 | 'reset', ['cgi'], | |
| 76 | 'Reset passwords for a collection of services.', | |
| 77 | rparam = SC.Arg('services')) | |
| 78 | def cmd_reset_cgi(services = []): | |
| 79 | operate('reset passwords', 'reset', services) | |
| 80 | ||
| 81 | @CGI.subcommand( | |
| 82 | 'clear', ['cgi'], | |
| 83 | 'Clear passwords for a collection of services.', | |
| 84 | rparam = SC.Arg('services')) | |
| 85 | def cmd_clear_cgi(services = []): | |
| 86 | operate('clear passwords', 'clear', services) | |
| 87 | ||
| 88 | @CGI.subcommand( | |
| 89 | 'fail', ['cgi-noauth'], | |
| 90 | 'Raise an exception, to test the error reporting machinery.', | |
| 91 | opts = [SC.Opt('partial', '-p', '--partial', | |
| 92 | 'Raise exception after producing partial output.')]) | |
| 93 | def cmd_fail_cgi(partial = False): | |
| 94 | if partial: | |
| 95 | OUT.header(content_type = 'text/html') | |
| 96 | PRINT("""\ | |
| 97 | <html> | |
| 98 | <head><title>Chopwood: filler text</title></head> | |
| 99 | <body> | |
| 100 | <h1>Failure expected soon | |
| 101 | <p>This is some normal output which will be rudely interrupted.""") | |
| 102 | raise Exception, 'You asked for this.' | |
| 103 | ||
| 104 | ###-------------------------------------------------------------------------- | |
| 105 | ### Static content. | |
| 106 | ||
| 107 | ## A map of file names to content objects. See below. | |
| 108 | CONTENT = {} | |
| 109 | ||
| 110 | class PlainOutput (O.FileOutput): | |
| 111 | def header(me, **kw): | |
| 112 | pass | |
| 113 | ||
| 114 | class StaticContent (object): | |
| 115 | def __init__(me, type): | |
| 116 | me._type = type | |
| 117 | def emit(me): | |
| 118 | OUT.header(content_type = me._type) | |
| 119 | me._emit() | |
| 120 | def _write(me, dest): | |
| 121 | with open(dest, 'w') as f: | |
| 122 | with OUT.redirect_to(PlainOutput(f)): | |
| 123 | me.emit() | |
| 124 | def write(me, dest): | |
| 125 | new = dest + '.new' | |
| 126 | try: OS.unlink(new) | |
| 127 | except OSError, e: | |
| 128 | if e.errno != E.ENOENT: raise | |
| 129 | me._write(new) | |
| 130 | OS.rename(new, dest) | |
| 131 | ||
| 132 | class TemplateContent (StaticContent): | |
| 133 | def __init__(me, template, *args, **kw): | |
| 134 | super(TemplateContent, me).__init__(*args, **kw) | |
| 135 | me._template = template | |
| 136 | def _emit(me): | |
| 137 | CGI.format_tmpl(CGI.TMPL[me._template]) | |
| 138 | ||
| 139 | class HTMLContent (StaticContent): | |
| 140 | def __init__(me, title, template, type = 'text/html', *args, **kw): | |
| 141 | super(HTMLContent, me).__init__(type = type, *args, **kw) | |
| 142 | me._template = template | |
| 143 | me._title = title | |
| 144 | def emit(me): | |
| 145 | CGI.page(me._template, title = me._title) | |
| 146 | ||
| 147 | CONTENT.update({ | |
| 148 | 'chpwd.css': TemplateContent(template = 'chpwd.css', | |
| 149 | type = 'text/css'), | |
| 150 | 'chpwd.js': TemplateContent(template = 'chpwd.js', | |
| 151 | type = 'text/javascript'), | |
| 152 | 'about.html': HTMLContent('Chopwood: about this program', | |
| 153 | template = 'about.fhtml'), | |
| 154 | 'cookies.html': HTMLContent('Chopwood: use of cookies', | |
| 155 | template = 'cookies.fhtml') | |
| 156 | }) | |
| 157 | ||
| 158 | @CGI.subcommand( | |
| 159 | 'static', ['cgi-noauth'], 'Output a static file.', | |
| 160 | rparam = SC.Arg('path')) | |
| 161 | def cmd_static_cgi(path): | |
| 162 | name = '/'.join(path) | |
| 163 | try: content = CONTENT[name] | |
| 164 | except KeyError: raise U.ExpectedError, (404, "Unknown file `%s'" % name) | |
| 165 | content.emit() | |
| 166 | ||
| 167 | @SC.subcommand( | |
| 168 | 'static', ['admin'], 'Write the static files to DIR.', | |
| 169 | params = [SC.Arg('dir')]) | |
| 170 | def cmd_static_admin(dir): | |
| 171 | try: OS.makedirs(dir, 0777) | |
| 172 | except OSError, e: | |
| 173 | if e.errno != E.EEXIST: raise | |
| 174 | for f, c in CONTENT.iteritems(): | |
| 175 | c.write(OS.path.join(dir, f)) | |
| 176 | ||
| 177 | TARBALL = '%s-%s.tar.gz' % (PACKAGE, VERSION) | |
| 178 | @CGI.subcommand(TARBALL, ['cgi-noauth'], """\ | |
| 179 | Download source code (in `.tar.gz' format).""") | |
| 180 | def cmd_source_cgi(): | |
| 181 | OUT.header(content_type = 'application/octet-stream') | |
| 182 | AGPL.source(OUT) | |
| 183 | ||
| 184 | @CGI.subcommand('source', ['cgi-noauth'], """\ | |
| d674bfda | 185 | Redirect to the source code tarball (so that it's correctly named).""") |
| a2916c06 MW |
186 | def cmd_sourceredirect_cgi(): |
| 187 | CGI.redirect(CGI.action(TARBALL)) | |
| 188 | ||
| 189 | ###----- That's all, folks -------------------------------------------------- |