diff --git a/CitizenWatt-Base/Makefile b/CitizenWatt-Base/Makefile new file mode 100644 index 0000000..02f90f4 --- /dev/null +++ b/CitizenWatt-Base/Makefile @@ -0,0 +1,34 @@ +############################################################################# +# +# Makefile for CitizenWatt install on Raspberry Pi +# +# License: GPL (General Public License) +# Author: AlexFaraino +# Date: 2014/10/20 (v1.0) +# +# Description: +# ------------ +# You can change the install directory by editing the prefix line +# +prefix=$(DESTDIR)/opt/citizenwatt +files=`ls | grep -v debian` +sup_prefix=$(DESTDIR)/etc/supervisor/conf.d/ + +# The recommended compiler flags for the Raspberry Pi +CCFLAGS=-Wall -Ofast -mfpu=vfp -mfloat-abi=hard -march=armv6zk -mtune=arm1176jzf-s + +all: receive + +receive: receive.cpp + g++ ${CCFLAGS} -lrf24 $@.cpp -o $@ + +clean: + rm -rf receive + +install: all + test -d $(prefix) || mkdir -p $(prefix) + test -d $(sup_prefix) || mkdir -p $(sup_prefix) + cp -r $(files) $(prefix)/ + cp system/supervisor_citizenwatt.conf $(sup_prefix)/citizenwatt.conf + +.PHONY: install diff --git a/CitizenWatt-Base/README.md b/CitizenWatt-Base/README.md new file mode 100644 index 0000000..d620492 --- /dev/null +++ b/CitizenWatt-Base/README.md @@ -0,0 +1,39 @@ +## Package needed + +* sqlalchemy +* cherrypy +* numpy +* pycrypto +* psycopg2 for communication with the PostgreSQL database + +## API + +* /api/sensors + * Returns all the available sensors with their types +* /api/sensors/ + * Returns the infos for the specified sensor. +* /api/types + * Returns all the available measure types +* /api/time + * Returns the current timestamp of the server side. +* /api/energy_providers + * Returns all available energy providers +* /api/energy_providers/> + * Returns the targeted energy provider +* /api//get/watts/by_id/ + * Get measure with id nb + * Get measure nth to last measure if nb < 0 (behaviour of Python lists) +* /api//get/[watts|kwatthours|euros]/by_id// + * Get all the measures with id between nb1 and nb2 (nb1 < nb2) + * Get all the measures between nb1 and nb2 starting from the end if nb1, nb2 < 0 (behaviour of Python lists) + * Get the energy / cost associated with these measures if kwatthours or euros is specified +* /api//get/watts/by_time/ + * Idem as above, but with timestamps +* /api//watt_to_euros// + * Returns the price associated to the consumption (in kWh) for the specified provider +* /api//get/[watts|kwatthours|euros]/by_time/// + * Idem as above, but with timestamps + * idem avec id +* idem with ids + +step > 0 diff --git a/CitizenWatt-Base/bottle.py b/CitizenWatt-Base/bottle.py new file mode 100644 index 0000000..d93f933 --- /dev/null +++ b/CitizenWatt-Base/bottle.py @@ -0,0 +1,3624 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +""" +Bottle is a fast and simple micro-framework for small web applications. It +offers request dispatching (Routes) with url parameter support, templates, +a built-in HTTP Server and adapters for many third party WSGI/HTTP-server and +template engines - all in a single file and with no dependencies other than the +Python Standard Library. + +Homepage and documentation: http://bottlepy.org/ + +Copyright (c) 2014, Marcel Hellkamp. +License: MIT (see LICENSE for details) +""" + +from __future__ import with_statement + +__author__ = 'Marcel Hellkamp' +__version__ = '0.13-dev' +__license__ = 'MIT' + +# The gevent and eventlet server adapters need to patch some modules before +# they are imported. This is why we parse the commandline parameters here but +# handle them later +if __name__ == '__main__': + from optparse import OptionParser + _cmd_parser = OptionParser(usage="usage: %prog [options] package.module:app") + _opt = _cmd_parser.add_option + _opt("--version", action="store_true", help="show version number.") + _opt("-b", "--bind", metavar="ADDRESS", help="bind socket to ADDRESS.") + _opt("-s", "--server", default='wsgiref', help="use SERVER as backend.") + _opt("-p", "--plugin", action="append", help="install additional plugin/s.") + _opt("--debug", action="store_true", help="start server in debug mode.") + _opt("--reload", action="store_true", help="auto-reload on file changes.") + _cmd_options, _cmd_args = _cmd_parser.parse_args() + if _cmd_options.server: + if _cmd_options.server.startswith('gevent'): + import gevent.monkey; gevent.monkey.patch_all() + elif _cmd_options.server.startswith('eventlet'): + import eventlet; eventlet.monkey_patch() + +import base64, cgi, email.utils, functools, hmac, imp, itertools, mimetypes,\ + os, re, subprocess, sys, tempfile, threading, time, warnings + +from datetime import date as datedate, datetime, timedelta +from tempfile import TemporaryFile +from traceback import format_exc, print_exc +from inspect import getargspec +from unicodedata import normalize + + +try: from simplejson import dumps as json_dumps, loads as json_lds +except ImportError: # pragma: no cover + try: from json import dumps as json_dumps, loads as json_lds + except ImportError: + try: from django.utils.simplejson import dumps as json_dumps, loads as json_lds + except ImportError: + def json_dumps(data): + raise ImportError("JSON support requires Python 2.6 or simplejson.") + json_lds = json_dumps + + + +# We now try to fix 2.5/2.6/3.1/3.2 incompatibilities. +# It ain't pretty but it works... Sorry for the mess. + +py = sys.version_info +py3k = py >= (3, 0, 0) +py25 = py < (2, 6, 0) +py31 = (3, 1, 0) <= py < (3, 2, 0) + +# Workaround for the missing "as" keyword in py3k. +def _e(): return sys.exc_info()[1] + +# Workaround for the "print is a keyword/function" Python 2/3 dilemma +# and a fallback for mod_wsgi (resticts stdout/err attribute access) +try: + _stdout, _stderr = sys.stdout.write, sys.stderr.write +except IOError: + _stdout = lambda x: sys.stdout.write(x) + _stderr = lambda x: sys.stderr.write(x) + +# Lots of stdlib and builtin differences. +if py3k: + import http.client as httplib + import _thread as thread + from urllib.parse import urljoin, SplitResult as UrlSplitResult + from urllib.parse import urlencode, quote as urlquote, unquote as urlunquote + urlunquote = functools.partial(urlunquote, encoding='latin1') + from http.cookies import SimpleCookie + from collections import MutableMapping as DictMixin + import pickle + from io import BytesIO + from configparser import ConfigParser + basestring = str + unicode = str + json_loads = lambda s: json_lds(touni(s)) + callable = lambda x: hasattr(x, '__call__') + imap = map + def _raise(*a): raise a[0](a[1]).with_traceback(a[2]) +else: # 2.x + import httplib + import thread + from urlparse import urljoin, SplitResult as UrlSplitResult + from urllib import urlencode, quote as urlquote, unquote as urlunquote + from Cookie import SimpleCookie + from itertools import imap + import cPickle as pickle + from StringIO import StringIO as BytesIO + from ConfigParser import SafeConfigParser as ConfigParser + if py25: + msg = "Python 2.5 support may be dropped in future versions of Bottle." + warnings.warn(msg, DeprecationWarning) + from UserDict import DictMixin + def next(it): return it.next() + bytes = str + else: # 2.6, 2.7 + from collections import MutableMapping as DictMixin + unicode = unicode + json_loads = json_lds + eval(compile('def _raise(*a): raise a[0], a[1], a[2]', '', 'exec')) + + +# Some helpers for string/byte handling +def tob(s, enc='utf8'): + return s.encode(enc) if isinstance(s, unicode) else bytes(s) + + +def touni(s, enc='utf8', err='strict'): + if isinstance(s, bytes): + return s.decode(enc, err) + else: + return unicode(s or ("" if s is None else s)) + +tonat = touni if py3k else tob + +# 3.2 fixes cgi.FieldStorage to accept bytes (which makes a lot of sense). +# 3.1 needs a workaround. +if py31: + from io import TextIOWrapper + + class NCTextIOWrapper(TextIOWrapper): + def close(self): pass # Keep wrapped buffer open. + + +# A bug in functools causes it to break if the wrapper is an instance method +def update_wrapper(wrapper, wrapped, *a, **ka): + try: + functools.update_wrapper(wrapper, wrapped, *a, **ka) + except AttributeError: + pass + + +# These helpers are used at module level and need to be defined first. +# And yes, I know PEP-8, but sometimes a lower-case classname makes more sense. + +def depr(message, strict=False): + warnings.warn(message, DeprecationWarning, stacklevel=3) + +def makelist(data): # This is just to handy + if isinstance(data, (tuple, list, set, dict)): + return list(data) + elif data: + return [data] + else: + return [] + + +class DictProperty(object): + """ Property that maps to a key in a local dict-like attribute. """ + def __init__(self, attr, key=None, read_only=False): + self.attr, self.key, self.read_only = attr, key, read_only + + def __call__(self, func): + functools.update_wrapper(self, func, updated=[]) + self.getter, self.key = func, self.key or func.__name__ + return self + + def __get__(self, obj, cls): + if obj is None: return self + key, storage = self.key, getattr(obj, self.attr) + if key not in storage: storage[key] = self.getter(obj) + return storage[key] + + def __set__(self, obj, value): + if self.read_only: raise AttributeError("Read-Only property.") + getattr(obj, self.attr)[self.key] = value + + def __delete__(self, obj): + if self.read_only: raise AttributeError("Read-Only property.") + del getattr(obj, self.attr)[self.key] + + +class cached_property(object): + """ A property that is only computed once per instance and then replaces + itself with an ordinary attribute. Deleting the attribute resets the + property. """ + + def __init__(self, func): + self.__doc__ = getattr(func, '__doc__') + self.func = func + + def __get__(self, obj, cls): + if obj is None: return self + value = obj.__dict__[self.func.__name__] = self.func(obj) + return value + + +class lazy_attribute(object): + """ A property that caches itself to the class object. """ + def __init__(self, func): + functools.update_wrapper(self, func, updated=[]) + self.getter = func + + def __get__(self, obj, cls): + value = self.getter(cls) + setattr(cls, self.__name__, value) + return value + + + + + + +############################################################################### +# Exceptions and Events ######################################################## +############################################################################### + + +class BottleException(Exception): + """ A base class for exceptions used by bottle. """ + pass + + + + + + +############################################################################### +# Routing ###################################################################### +############################################################################### + + +class RouteError(BottleException): + """ This is a base class for all routing related exceptions """ + + +class RouteReset(BottleException): + """ If raised by a plugin or request handler, the route is reset and all + plugins are re-applied. """ + +class RouterUnknownModeError(RouteError): pass + + +class RouteSyntaxError(RouteError): + """ The route parser found something not supported by this router. """ + + +class RouteBuildError(RouteError): + """ The route could not be built. """ + + +def _re_flatten(p): + """ Turn all capturing groups in a regular expression pattern into + non-capturing groups. """ + if '(' not in p: + return p + return re.sub(r'(\\*)(\(\?P<[^>]+>|\((?!\?))', + lambda m: m.group(0) if len(m.group(1)) % 2 else m.group(1) + '(?:', p) + + +class Router(object): + """ A Router is an ordered collection of route->target pairs. It is used to + efficiently match WSGI requests against a number of routes and return + the first target that satisfies the request. The target may be anything, + usually a string, ID or callable object. A route consists of a path-rule + and a HTTP method. + + The path-rule is either a static path (e.g. `/contact`) or a dynamic + path that contains wildcards (e.g. `/wiki/`). The wildcard syntax + and details on the matching order are described in docs:`routing`. + """ + + default_pattern = '[^/]+' + default_filter = 're' + + #: The current CPython regexp implementation does not allow more + #: than 99 matching groups per regular expression. + _MAX_GROUPS_PER_PATTERN = 99 + + def __init__(self, strict=False): + self.rules = [] # All rules in order + self._groups = {} # index of regexes to find them in dyna_routes + self.builder = {} # Data structure for the url builder + self.static = {} # Search structure for static routes + self.dyna_routes = {} + self.dyna_regexes = {} # Search structure for dynamic routes + #: If true, static routes are no longer checked first. + self.strict_order = strict + self.filters = { + 're': lambda conf: + (_re_flatten(conf or self.default_pattern), None, None), + 'int': lambda conf: (r'-?\d+', int, lambda x: str(int(x))), + 'float': lambda conf: (r'-?[\d.]+', float, lambda x: str(float(x))), + 'path': lambda conf: (r'.+?', None, None)} + + def add_filter(self, name, func): + """ Add a filter. The provided function is called with the configuration + string as parameter and must return a (regexp, to_python, to_url) tuple. + The first element is a string, the last two are callables or None. """ + self.filters[name] = func + + rule_syntax = re.compile('(\\\\*)' + '(?:(?::([a-zA-Z_][a-zA-Z_0-9]*)?()(?:#(.*?)#)?)' + '|(?:<([a-zA-Z_][a-zA-Z_0-9]*)?(?::([a-zA-Z_]*)' + '(?::((?:\\\\.|[^\\\\>]+)+)?)?)?>))') + + def _itertokens(self, rule): + offset, prefix = 0, '' + for match in self.rule_syntax.finditer(rule): + prefix += rule[offset:match.start()] + g = match.groups() + if len(g[0])%2: # Escaped wildcard + prefix += match.group(0)[len(g[0]):] + offset = match.end() + continue + if prefix: + yield prefix, None, None + name, filtr, conf = g[4:7] if g[2] is None else g[1:4] + yield name, filtr or 'default', conf or None + offset, prefix = match.end(), '' + if offset <= len(rule) or prefix: + yield prefix+rule[offset:], None, None + + def add(self, rule, method, target, name=None): + """ Add a new rule or replace the target for an existing rule. """ + anons = 0 # Number of anonymous wildcards found + keys = [] # Names of keys + pattern = '' # Regular expression pattern with named groups + filters = [] # Lists of wildcard input filters + builder = [] # Data structure for the URL builder + is_static = True + + for key, mode, conf in self._itertokens(rule): + if mode: + is_static = False + if mode == 'default': mode = self.default_filter + mask, in_filter, out_filter = self.filters[mode](conf) + if not key: + pattern += '(?:%s)' % mask + key = 'anon%d' % anons + anons += 1 + else: + pattern += '(?P<%s>%s)' % (key, mask) + keys.append(key) + if in_filter: filters.append((key, in_filter)) + builder.append((key, out_filter or str)) + elif key: + pattern += re.escape(key) + builder.append((None, key)) + + self.builder[rule] = builder + if name: self.builder[name] = builder + + if is_static and not self.strict_order: + self.static.setdefault(method, {}) + self.static[method][self.build(rule)] = (target, None) + return + + try: + re_pattern = re.compile('^(%s)$' % pattern) + re_match = re_pattern.match + except re.error: + raise RouteSyntaxError("Could not add Route: %s (%s)" % (rule, _e())) + + if filters: + def getargs(path): + url_args = re_match(path).groupdict() + for name, wildcard_filter in filters: + try: + url_args[name] = wildcard_filter(url_args[name]) + except ValueError: + raise HTTPError(400, 'Path has wrong format.') + return url_args + elif re_pattern.groupindex: + def getargs(path): + return re_match(path).groupdict() + else: + getargs = None + + flatpat = _re_flatten(pattern) + whole_rule = (rule, flatpat, target, getargs) + + if (flatpat, method) in self._groups: + if DEBUG: + msg = 'Route <%s %s> overwrites a previously defined route' + warnings.warn(msg % (method, rule), RuntimeWarning) + self.dyna_routes[method][self._groups[flatpat, method]] = whole_rule + else: + self.dyna_routes.setdefault(method, []).append(whole_rule) + self._groups[flatpat, method] = len(self.dyna_routes[method]) - 1 + + self._compile(method) + + def _compile(self, method): + all_rules = self.dyna_routes[method] + comborules = self.dyna_regexes[method] = [] + maxgroups = self._MAX_GROUPS_PER_PATTERN + for x in range(0, len(all_rules), maxgroups): + some = all_rules[x:x+maxgroups] + combined = (flatpat for (_, flatpat, _, _) in some) + combined = '|'.join('(^%s$)' % flatpat for flatpat in combined) + combined = re.compile(combined).match + rules = [(target, getargs) for (_, _, target, getargs) in some] + comborules.append((combined, rules)) + + def build(self, _name, *anons, **query): + """ Build an URL by filling the wildcards in a rule. """ + builder = self.builder.get(_name) + if not builder: raise RouteBuildError("No route with that name.", _name) + try: + for i, value in enumerate(anons): query['anon%d'%i] = value + url = ''.join([f(query.pop(n)) if n else f for (n,f) in builder]) + return url if not query else url+'?'+urlencode(query) + except KeyError: + raise RouteBuildError('Missing URL argument: %r' % _e().args[0]) + + def match(self, environ): + """ Return a (target, url_agrs) tuple or raise HTTPError(400/404/405). """ + verb = environ['REQUEST_METHOD'].upper() + path = environ['PATH_INFO'] or '/' + + if verb == 'HEAD': + methods = ['PROXY', verb, 'GET', 'ANY'] + else: + methods = ['PROXY', verb, 'ANY'] + + for method in methods: + if method in self.static and path in self.static[method]: + target, getargs = self.static[method][path] + return target, getargs(path) if getargs else {} + elif method in self.dyna_regexes: + for combined, rules in self.dyna_regexes[method]: + match = combined(path) + if match: + target, getargs = rules[match.lastindex - 1] + return target, getargs(path) if getargs else {} + + # No matching route found. Collect alternative methods for 405 response + allowed = set([]) + nocheck = set(methods) + for method in set(self.static) - nocheck: + if path in self.static[method]: + allowed.add(verb) + for method in set(self.dyna_regexes) - allowed - nocheck: + for combined, rules in self.dyna_regexes[method]: + match = combined(path) + if match: + allowed.add(method) + if allowed: + allow_header = ",".join(sorted(allowed)) + raise HTTPError(405, "Method not allowed.", Allow=allow_header) + + # No matching route and no alternative method found. We give up + raise HTTPError(404, "Not found: " + repr(path)) + + + + + + +class Route(object): + """ This class wraps a route callback along with route specific metadata and + configuration and applies Plugins on demand. It is also responsible for + turing an URL path rule into a regular expression usable by the Router. + """ + + def __init__(self, app, rule, method, callback, name=None, + plugins=None, skiplist=None, **config): + #: The application this route is installed to. + self.app = app + #: The path-rule string (e.g. ``/wiki/:page``). + self.rule = rule + #: The HTTP method as a string (e.g. ``GET``). + self.method = method + #: The original callback with no plugins applied. Useful for introspection. + self.callback = callback + #: The name of the route (if specified) or ``None``. + self.name = name or None + #: A list of route-specific plugins (see :meth:`Bottle.route`). + self.plugins = plugins or [] + #: A list of plugins to not apply to this route (see :meth:`Bottle.route`). + self.skiplist = skiplist or [] + #: Additional keyword arguments passed to the :meth:`Bottle.route` + #: decorator are stored in this dictionary. Used for route-specific + #: plugin configuration and meta-data. + self.config = ConfigDict().load_dict(config) + + @cached_property + def call(self): + """ The route callback with all plugins applied. This property is + created on demand and then cached to speed up subsequent requests.""" + return self._make_callback() + + def reset(self): + """ Forget any cached values. The next time :attr:`call` is accessed, + all plugins are re-applied. """ + self.__dict__.pop('call', None) + + def prepare(self): + """ Do all on-demand work immediately (useful for debugging).""" + self.call + + def all_plugins(self): + """ Yield all Plugins affecting this route. """ + unique = set() + for p in reversed(self.app.plugins + self.plugins): + if True in self.skiplist: break + name = getattr(p, 'name', False) + if name and (name in self.skiplist or name in unique): continue + if p in self.skiplist or type(p) in self.skiplist: continue + if name: unique.add(name) + yield p + + def _make_callback(self): + callback = self.callback + for plugin in self.all_plugins(): + try: + if hasattr(plugin, 'apply'): + callback = plugin.apply(callback, self) + else: + callback = plugin(callback) + except RouteReset: # Try again with changed configuration. + return self._make_callback() + if not callback is self.callback: + update_wrapper(callback, self.callback) + return callback + + def get_undecorated_callback(self): + """ Return the callback. If the callback is a decorated function, try to + recover the original function. """ + func = self.callback + func = getattr(func, '__func__' if py3k else 'im_func', func) + closure_attr = '__closure__' if py3k else 'func_closure' + while hasattr(func, closure_attr) and getattr(func, closure_attr): + func = getattr(func, closure_attr)[0].cell_contents + return func + + def get_callback_args(self): + """ Return a list of argument names the callback (most likely) accepts + as keyword arguments. If the callback is a decorated function, try + to recover the original function before inspection. """ + return getargspec(self.get_undecorated_callback())[0] + + def get_config(self, key, default=None): + """ Lookup a config field and return its value, first checking the + route.config, then route.app.config.""" + for conf in (self.config, self.app.conifg): + if key in conf: return conf[key] + return default + + def __repr__(self): + cb = self.get_undecorated_callback() + return '<%s %r %r>' % (self.method, self.rule, cb) + + + + + + +############################################################################### +# Application Object ########################################################### +############################################################################### + + +class Bottle(object): + """ Each Bottle object represents a single, distinct web application and + consists of routes, callbacks, plugins, resources and configuration. + Instances are callable WSGI applications. + + :param catchall: If true (default), handle all exceptions. Turn off to + let debugging middleware handle exceptions. + """ + + def __init__(self, catchall=True, autojson=True): + + #: A :class:`ConfigDict` for app specific configuration. + self.config = ConfigDict() + self.config._on_change = functools.partial(self.trigger_hook, 'config') + self.config.meta_set('autojson', 'validate', bool) + self.config.meta_set('catchall', 'validate', bool) + self.config['catchall'] = catchall + self.config['autojson'] = autojson + + #: A :class:`ResourceManager` for application files + self.resources = ResourceManager() + + self.routes = [] # List of installed :class:`Route` instances. + self.router = Router() # Maps requests to :class:`Route` instances. + self.error_handler = {} + + # Core plugins + self.plugins = [] # List of installed plugins. + if self.config['autojson']: + self.install(JSONPlugin()) + self.install(TemplatePlugin()) + + #: If true, most exceptions are caught and returned as :exc:`HTTPError` + catchall = DictProperty('config', 'catchall') + + __hook_names = 'before_request', 'after_request', 'app_reset', 'config' + __hook_reversed = 'after_request' + + @cached_property + def _hooks(self): + return dict((name, []) for name in self.__hook_names) + + def add_hook(self, name, func): + """ Attach a callback to a hook. Three hooks are currently implemented: + + before_request + Executed once before each request. The request context is + available, but no routing has happened yet. + after_request + Executed once after each request regardless of its outcome. + app_reset + Called whenever :meth:`Bottle.reset` is called. + """ + if name in self.__hook_reversed: + self._hooks[name].insert(0, func) + else: + self._hooks[name].append(func) + + def remove_hook(self, name, func): + """ Remove a callback from a hook. """ + if name in self._hooks and func in self._hooks[name]: + self._hooks[name].remove(func) + return True + + def trigger_hook(self, __name, *args, **kwargs): + """ Trigger a hook and return a list of results. """ + return [hook(*args, **kwargs) for hook in self._hooks[__name][:]] + + def hook(self, name): + """ Return a decorator that attaches a callback to a hook. See + :meth:`add_hook` for details.""" + def decorator(func): + self.add_hook(name, func) + return func + return decorator + + def mount(self, prefix, app, **options): + """ Mount an application (:class:`Bottle` or plain WSGI) to a specific + URL prefix. Example:: + + root_app.mount('/admin/', admin_app) + + :param prefix: path prefix or `mount-point`. If it ends in a slash, + that slash is mandatory. + :param app: an instance of :class:`Bottle` or a WSGI application. + + All other parameters are passed to the underlying :meth:`route` call. + """ + + segments = [p for p in prefix.split('/') if p] + if not segments: raise ValueError('Empty path prefix.') + path_depth = len(segments) + + def mountpoint_wrapper(): + try: + request.path_shift(path_depth) + rs = HTTPResponse([]) + def start_response(status, headerlist, exc_info=None): + if exc_info: + _raise(*exc_info) + rs.status = status + for name, value in headerlist: rs.add_header(name, value) + return rs.body.append + body = app(request.environ, start_response) + if body and rs.body: body = itertools.chain(rs.body, body) + rs.body = body or rs.body + return rs + finally: + request.path_shift(-path_depth) + + options.setdefault('skip', True) + options.setdefault('method', 'PROXY') + options.setdefault('mountpoint', {'prefix': prefix, 'target': app}) + options['callback'] = mountpoint_wrapper + + self.route('/%s/<:re:.*>' % '/'.join(segments), **options) + if not prefix.endswith('/'): + self.route('/' + '/'.join(segments), **options) + + def merge(self, routes): + """ Merge the routes of another :class:`Bottle` application or a list of + :class:`Route` objects into this application. The routes keep their + 'owner', meaning that the :data:`Route.app` attribute is not + changed. """ + if isinstance(routes, Bottle): + routes = routes.routes + for route in routes: + self.add_route(route) + + def install(self, plugin): + """ Add a plugin to the list of plugins and prepare it for being + applied to all routes of this application. A plugin may be a simple + decorator or an object that implements the :class:`Plugin` API. + """ + if hasattr(plugin, 'setup'): plugin.setup(self) + if not callable(plugin) and not hasattr(plugin, 'apply'): + raise TypeError("Plugins must be callable or implement .apply()") + self.plugins.append(plugin) + self.reset() + return plugin + + def uninstall(self, plugin): + """ Uninstall plugins. Pass an instance to remove a specific plugin, a type + object to remove all plugins that match that type, a string to remove + all plugins with a matching ``name`` attribute or ``True`` to remove all + plugins. Return the list of removed plugins. """ + removed, remove = [], plugin + for i, plugin in list(enumerate(self.plugins))[::-1]: + if remove is True or remove is plugin or remove is type(plugin) \ + or getattr(plugin, 'name', True) == remove: + removed.append(plugin) + del self.plugins[i] + if hasattr(plugin, 'close'): plugin.close() + if removed: self.reset() + return removed + + def reset(self, route=None): + """ Reset all routes (force plugins to be re-applied) and clear all + caches. If an ID or route object is given, only that specific route + is affected. """ + if route is None: routes = self.routes + elif isinstance(route, Route): routes = [route] + else: routes = [self.routes[route]] + for route in routes: route.reset() + if DEBUG: + for route in routes: route.prepare() + self.trigger_hook('app_reset') + + def close(self): + """ Close the application and all installed plugins. """ + for plugin in self.plugins: + if hasattr(plugin, 'close'): plugin.close() + + def run(self, **kwargs): + """ Calls :func:`run` with the same parameters. """ + run(self, **kwargs) + + def match(self, environ): + """ Search for a matching route and return a (:class:`Route` , urlargs) + tuple. The second value is a dictionary with parameters extracted + from the URL. Raise :exc:`HTTPError` (404/405) on a non-match.""" + return self.router.match(environ) + + def get_url(self, routename, **kargs): + """ Return a string that matches a named route """ + scriptname = request.environ.get('SCRIPT_NAME', '').strip('/') + '/' + location = self.router.build(routename, **kargs).lstrip('/') + return urljoin(urljoin('/', scriptname), location) + + def add_route(self, route): + """ Add a route object, but do not change the :data:`Route.app` + attribute.""" + self.routes.append(route) + self.router.add(route.rule, route.method, route, name=route.name) + if DEBUG: route.prepare() + + def route(self, path=None, method='GET', callback=None, name=None, + apply=None, skip=None, **config): + """ A decorator to bind a function to a request URL. Example:: + + @app.route('/hello/:name') + def hello(name): + return 'Hello %s' % name + + The ``:name`` part is a wildcard. See :class:`Router` for syntax + details. + + :param path: Request path or a list of paths to listen to. If no + path is specified, it is automatically generated from the + signature of the function. + :param method: HTTP method (`GET`, `POST`, `PUT`, ...) or a list of + methods to listen to. (default: `GET`) + :param callback: An optional shortcut to avoid the decorator + syntax. ``route(..., callback=func)`` equals ``route(...)(func)`` + :param name: The name for this route. (default: None) + :param apply: A decorator or plugin or a list of plugins. These are + applied to the route callback in addition to installed plugins. + :param skip: A list of plugins, plugin classes or names. Matching + plugins are not installed to this route. ``True`` skips all. + + Any additional keyword arguments are stored as route-specific + configuration and passed to plugins (see :meth:`Plugin.apply`). + """ + if callable(path): path, callback = None, path + plugins = makelist(apply) + skiplist = makelist(skip) + def decorator(callback): + if isinstance(callback, basestring): callback = load(callback) + for rule in makelist(path) or yieldroutes(callback): + for verb in makelist(method): + verb = verb.upper() + route = Route(self, rule, verb, callback, name=name, + plugins=plugins, skiplist=skiplist, **config) + self.add_route(route) + return callback + return decorator(callback) if callback else decorator + + def get(self, path=None, method='GET', **options): + """ Equals :meth:`route`. """ + return self.route(path, method, **options) + + def post(self, path=None, method='POST', **options): + """ Equals :meth:`route` with a ``POST`` method parameter. """ + return self.route(path, method, **options) + + def put(self, path=None, method='PUT', **options): + """ Equals :meth:`route` with a ``PUT`` method parameter. """ + return self.route(path, method, **options) + + def delete(self, path=None, method='DELETE', **options): + """ Equals :meth:`route` with a ``DELETE`` method parameter. """ + return self.route(path, method, **options) + + def patch(self, path=None, method='PATCH', **options): + """ Equals :meth:`route` with a ``PATCH`` method parameter. """ + return self.route(path, method, **options) + + def error(self, code=500): + """ Decorator: Register an output handler for a HTTP error code""" + def wrapper(handler): + self.error_handler[int(code)] = handler + return handler + return wrapper + + def default_error_handler(self, res): + return tob(template(ERROR_PAGE_TEMPLATE, e=res)) + + def _handle(self, environ): + path = environ['bottle.raw_path'] = environ['PATH_INFO'] + if py3k: + try: + environ['PATH_INFO'] = path.encode('latin1').decode('utf8') + except UnicodeError: + return HTTPError(400, 'Invalid path string. Expected UTF-8') + + try: + environ['bottle.app'] = self + request.bind(environ) + response.bind() + try: + self.trigger_hook('before_request') + route, args = self.router.match(environ) + environ['route.handle'] = route + environ['bottle.route'] = route + environ['route.url_args'] = args + return route.call(**args) + finally: + self.trigger_hook('after_request') + except HTTPResponse: + return _e() + except RouteReset: + route.reset() + return self._handle(environ) + except (KeyboardInterrupt, SystemExit, MemoryError): + raise + except Exception: + if not self.catchall: raise + stacktrace = format_exc() + environ['wsgi.errors'].write(stacktrace) + return HTTPError(500, "Internal Server Error", _e(), stacktrace) + + def _cast(self, out, peek=None): + """ Try to convert the parameter into something WSGI compatible and set + correct HTTP headers when possible. + Support: False, str, unicode, dict, HTTPResponse, HTTPError, file-like, + iterable of strings and iterable of unicodes + """ + + # Empty output is done here + if not out: + if 'Content-Length' not in response: + response['Content-Length'] = 0 + return [] + # Join lists of byte or unicode strings. Mixed lists are NOT supported + if isinstance(out, (tuple, list))\ + and isinstance(out[0], (bytes, unicode)): + out = out[0][0:0].join(out) # b'abc'[0:0] -> b'' + # Encode unicode strings + if isinstance(out, unicode): + out = out.encode(response.charset) + # Byte Strings are just returned + if isinstance(out, bytes): + if 'Content-Length' not in response: + response['Content-Length'] = len(out) + return [out] + # HTTPError or HTTPException (recursive, because they may wrap anything) + # TODO: Handle these explicitly in handle() or make them iterable. + if isinstance(out, HTTPError): + out.apply(response) + out = self.error_handler.get(out.status_code, self.default_error_handler)(out) + return self._cast(out) + if isinstance(out, HTTPResponse): + out.apply(response) + return self._cast(out.body) + + # File-like objects. + if hasattr(out, 'read'): + if 'wsgi.file_wrapper' in request.environ: + return request.environ['wsgi.file_wrapper'](out) + elif hasattr(out, 'close') or not hasattr(out, '__iter__'): + return WSGIFileWrapper(out) + + # Handle Iterables. We peek into them to detect their inner type. + try: + iout = iter(out) + first = next(iout) + while not first: + first = next(iout) + except StopIteration: + return self._cast('') + except HTTPResponse: + first = _e() + except (KeyboardInterrupt, SystemExit, MemoryError): + raise + except: + if not self.catchall: raise + first = HTTPError(500, 'Unhandled exception', _e(), format_exc()) + + # These are the inner types allowed in iterator or generator objects. + if isinstance(first, HTTPResponse): + return self._cast(first) + elif isinstance(first, bytes): + new_iter = itertools.chain([first], iout) + elif isinstance(first, unicode): + encoder = lambda x: x.encode(response.charset) + new_iter = imap(encoder, itertools.chain([first], iout)) + else: + msg = 'Unsupported response type: %s' % type(first) + return self._cast(HTTPError(500, msg)) + if hasattr(out, 'close'): + new_iter = _closeiter(new_iter, out.close) + return new_iter + + def wsgi(self, environ, start_response): + """ The bottle WSGI-interface. """ + try: + out = self._cast(self._handle(environ)) + # rfc2616 section 4.3 + if response._status_code in (100, 101, 204, 304)\ + or environ['REQUEST_METHOD'] == 'HEAD': + if hasattr(out, 'close'): out.close() + out = [] + start_response(response._status_line, response.headerlist) + return out + except (KeyboardInterrupt, SystemExit, MemoryError): + raise + except: + if not self.catchall: raise + err = '

Critical error while processing request: %s

' \ + % html_escape(environ.get('PATH_INFO', '/')) + if DEBUG: + err += '

Error:

\n
\n%s\n
\n' \ + '

Traceback:

\n
\n%s\n
\n' \ + % (html_escape(repr(_e())), html_escape(format_exc())) + environ['wsgi.errors'].write(err) + headers = [('Content-Type', 'text/html; charset=UTF-8')] + start_response('500 INTERNAL SERVER ERROR', headers, sys.exc_info()) + return [tob(err)] + + def __call__(self, environ, start_response): + """ Each instance of :class:'Bottle' is a WSGI application. """ + return self.wsgi(environ, start_response) + + def __enter__(self): + """ Use this application as default for all module-level shortcuts. """ + default_app.push(self) + return self + + def __exit__(self, exc_type, exc_value, traceback): + default_app.pop() + + + + + +############################################################################### +# HTTP and WSGI Tools ########################################################## +############################################################################### + +class BaseRequest(object): + """ A wrapper for WSGI environment dictionaries that adds a lot of + convenient access methods and properties. Most of them are read-only. + + Adding new attributes to a request actually adds them to the environ + dictionary (as 'bottle.request.ext.'). This is the recommended + way to store and access request-specific data. + """ + + __slots__ = ('environ', ) + + #: Maximum size of memory buffer for :attr:`body` in bytes. + MEMFILE_MAX = 102400 + + def __init__(self, environ=None): + """ Wrap a WSGI environ dictionary. """ + #: The wrapped WSGI environ dictionary. This is the only real attribute. + #: All other attributes actually are read-only properties. + self.environ = {} if environ is None else environ + self.environ['bottle.request'] = self + + @DictProperty('environ', 'bottle.app', read_only=True) + def app(self): + """ Bottle application handling this request. """ + raise RuntimeError('This request is not connected to an application.') + + @DictProperty('environ', 'bottle.route', read_only=True) + def route(self): + """ The bottle :class:`Route` object that matches this request. """ + raise RuntimeError('This request is not connected to a route.') + + @DictProperty('environ', 'route.url_args', read_only=True) + def url_args(self): + """ The arguments extracted from the URL. """ + raise RuntimeError('This request is not connected to a route.') + + @property + def path(self): + """ The value of ``PATH_INFO`` with exactly one prefixed slash (to fix + broken clients and avoid the "empty path" edge case). """ + return '/' + self.environ.get('PATH_INFO','').lstrip('/') + + @property + def method(self): + """ The ``REQUEST_METHOD`` value as an uppercase string. """ + return self.environ.get('REQUEST_METHOD', 'GET').upper() + + @DictProperty('environ', 'bottle.request.headers', read_only=True) + def headers(self): + """ A :class:`WSGIHeaderDict` that provides case-insensitive access to + HTTP request headers. """ + return WSGIHeaderDict(self.environ) + + def get_header(self, name, default=None): + """ Return the value of a request header, or a given default value. """ + return self.headers.get(name, default) + + @DictProperty('environ', 'bottle.request.cookies', read_only=True) + def cookies(self): + """ Cookies parsed into a :class:`FormsDict`. Signed cookies are NOT + decoded. Use :meth:`get_cookie` if you expect signed cookies. """ + cookies = SimpleCookie(self.environ.get('HTTP_COOKIE','')).values() + return FormsDict((c.key, c.value) for c in cookies) + + def get_cookie(self, key, default=None, secret=None): + """ Return the content of a cookie. To read a `Signed Cookie`, the + `secret` must match the one used to create the cookie (see + :meth:`BaseResponse.set_cookie`). If anything goes wrong (missing + cookie or wrong signature), return a default value. """ + value = self.cookies.get(key) + if secret and value: + dec = cookie_decode(value, secret) # (key, value) tuple or None + return dec[1] if dec and dec[0] == key else default + return value or default + + @DictProperty('environ', 'bottle.request.query', read_only=True) + def query(self): + """ The :attr:`query_string` parsed into a :class:`FormsDict`. These + values are sometimes called "URL arguments" or "GET parameters", but + not to be confused with "URL wildcards" as they are provided by the + :class:`Router`. """ + get = self.environ['bottle.get'] = FormsDict() + pairs = _parse_qsl(self.environ.get('QUERY_STRING', '')) + for key, value in pairs: + get[key] = value + return get + + @DictProperty('environ', 'bottle.request.forms', read_only=True) + def forms(self): + """ Form values parsed from an `url-encoded` or `multipart/form-data` + encoded POST or PUT request body. The result is returned as a + :class:`FormsDict`. All keys and values are strings. File uploads + are stored separately in :attr:`files`. """ + forms = FormsDict() + for name, item in self.POST.allitems(): + if not isinstance(item, FileUpload): + forms[name] = item + return forms + + @DictProperty('environ', 'bottle.request.params', read_only=True) + def params(self): + """ A :class:`FormsDict` with the combined values of :attr:`query` and + :attr:`forms`. File uploads are stored in :attr:`files`. """ + params = FormsDict() + for key, value in self.query.allitems(): + params[key] = value + for key, value in self.forms.allitems(): + params[key] = value + return params + + @DictProperty('environ', 'bottle.request.files', read_only=True) + def files(self): + """ File uploads parsed from `multipart/form-data` encoded POST or PUT + request body. The values are instances of :class:`FileUpload`. + + """ + files = FormsDict() + for name, item in self.POST.allitems(): + if isinstance(item, FileUpload): + files[name] = item + return files + + @DictProperty('environ', 'bottle.request.json', read_only=True) + def json(self): + """ If the ``Content-Type`` header is ``application/json``, this + property holds the parsed content of the request body. Only requests + smaller than :attr:`MEMFILE_MAX` are processed to avoid memory + exhaustion. """ + ctype = self.environ.get('CONTENT_TYPE', '').lower().split(';')[0] + if ctype == 'application/json': + b = self._get_body_string() + if not b: + return None + return json_loads(b) + return None + + def _iter_body(self, read, bufsize): + maxread = max(0, self.content_length) + while maxread: + part = read(min(maxread, bufsize)) + if not part: break + yield part + maxread -= len(part) + + @staticmethod + def _iter_chunked(read, bufsize): + err = HTTPError(400, 'Error while parsing chunked transfer body.') + rn, sem, bs = tob('\r\n'), tob(';'), tob('') + while True: + header = read(1) + while header[-2:] != rn: + c = read(1) + header += c + if not c: raise err + if len(header) > bufsize: raise err + size, _, _ = header.partition(sem) + try: + maxread = int(tonat(size.strip()), 16) + except ValueError: + raise err + if maxread == 0: break + buff = bs + while maxread > 0: + if not buff: + buff = read(min(maxread, bufsize)) + part, buff = buff[:maxread], buff[maxread:] + if not part: raise err + yield part + maxread -= len(part) + if read(2) != rn: + raise err + + @DictProperty('environ', 'bottle.request.body', read_only=True) + def _body(self): + body_iter = self._iter_chunked if self.chunked else self._iter_body + read_func = self.environ['wsgi.input'].read + body, body_size, is_temp_file = BytesIO(), 0, False + for part in body_iter(read_func, self.MEMFILE_MAX): + body.write(part) + body_size += len(part) + if not is_temp_file and body_size > self.MEMFILE_MAX: + body, tmp = TemporaryFile(mode='w+b'), body + body.write(tmp.getvalue()) + del tmp + is_temp_file = True + self.environ['wsgi.input'] = body + body.seek(0) + return body + + def _get_body_string(self): + """ read body until content-length or MEMFILE_MAX into a string. Raise + HTTPError(413) on requests that are to large. """ + clen = self.content_length + if clen > self.MEMFILE_MAX: + raise HTTPError(413, 'Request too large') + if clen < 0: clen = self.MEMFILE_MAX + 1 + data = self.body.read(clen) + if len(data) > self.MEMFILE_MAX: # Fail fast + raise HTTPError(413, 'Request too large') + return data + + @property + def body(self): + """ The HTTP request body as a seek-able file-like object. Depending on + :attr:`MEMFILE_MAX`, this is either a temporary file or a + :class:`io.BytesIO` instance. Accessing this property for the first + time reads and replaces the ``wsgi.input`` environ variable. + Subsequent accesses just do a `seek(0)` on the file object. """ + self._body.seek(0) + return self._body + + @property + def chunked(self): + """ True if Chunked transfer encoding was. """ + return 'chunked' in self.environ.get('HTTP_TRANSFER_ENCODING', '').lower() + + #: An alias for :attr:`query`. + GET = query + + @DictProperty('environ', 'bottle.request.post', read_only=True) + def POST(self): + """ The values of :attr:`forms` and :attr:`files` combined into a single + :class:`FormsDict`. Values are either strings (form values) or + instances of :class:`cgi.FieldStorage` (file uploads). + """ + post = FormsDict() + # We default to application/x-www-form-urlencoded for everything that + # is not multipart and take the fast path (also: 3.1 workaround) + if not self.content_type.startswith('multipart/'): + pairs = _parse_qsl(tonat(self._get_body_string(), 'latin1')) + for key, value in pairs: + post[key] = value + return post + + safe_env = {'QUERY_STRING':''} # Build a safe environment for cgi + for key in ('REQUEST_METHOD', 'CONTENT_TYPE', 'CONTENT_LENGTH'): + if key in self.environ: safe_env[key] = self.environ[key] + args = dict(fp=self.body, environ=safe_env, keep_blank_values=True) + if py31: + args['fp'] = NCTextIOWrapper(args['fp'], encoding='utf8', + newline='\n') + elif py3k: + args['encoding'] = 'utf8' + data = cgi.FieldStorage(**args) + self['_cgi.FieldStorage'] = data #http://bugs.python.org/issue18394#msg207958 + data = data.list or [] + for item in data: + if item.filename: + post[item.name] = FileUpload(item.file, item.name, + item.filename, item.headers) + else: + post[item.name] = item.value + return post + + @property + def url(self): + """ The full request URI including hostname and scheme. If your app + lives behind a reverse proxy or load balancer and you get confusing + results, make sure that the ``X-Forwarded-Host`` header is set + correctly. """ + return self.urlparts.geturl() + + @DictProperty('environ', 'bottle.request.urlparts', read_only=True) + def urlparts(self): + """ The :attr:`url` string as an :class:`urlparse.SplitResult` tuple. + The tuple contains (scheme, host, path, query_string and fragment), + but the fragment is always empty because it is not visible to the + server. """ + env = self.environ + http = env.get('HTTP_X_FORWARDED_PROTO') or env.get('wsgi.url_scheme', 'http') + host = env.get('HTTP_X_FORWARDED_HOST') or env.get('HTTP_HOST') + if not host: + # HTTP 1.1 requires a Host-header. This is for HTTP/1.0 clients. + host = env.get('SERVER_NAME', '127.0.0.1') + port = env.get('SERVER_PORT') + if port and port != ('80' if http == 'http' else '443'): + host += ':' + port + path = urlquote(self.fullpath) + return UrlSplitResult(http, host, path, env.get('QUERY_STRING'), '') + + @property + def fullpath(self): + """ Request path including :attr:`script_name` (if present). """ + return urljoin(self.script_name, self.path.lstrip('/')) + + @property + def query_string(self): + """ The raw :attr:`query` part of the URL (everything in between ``?`` + and ``#``) as a string. """ + return self.environ.get('QUERY_STRING', '') + + @property + def script_name(self): + """ The initial portion of the URL's `path` that was removed by a higher + level (server or routing middleware) before the application was + called. This script path is returned with leading and tailing + slashes. """ + script_name = self.environ.get('SCRIPT_NAME', '').strip('/') + return '/' + script_name + '/' if script_name else '/' + + def path_shift(self, shift=1): + """ Shift path segments from :attr:`path` to :attr:`script_name` and + vice versa. + + :param shift: The number of path segments to shift. May be negative + to change the shift direction. (default: 1) + """ + script = self.environ.get('SCRIPT_NAME','/') + self['SCRIPT_NAME'], self['PATH_INFO'] = path_shift(script, self.path, shift) + + @property + def content_length(self): + """ The request body length as an integer. The client is responsible to + set this header. Otherwise, the real length of the body is unknown + and -1 is returned. In this case, :attr:`body` will be empty. """ + return int(self.environ.get('CONTENT_LENGTH') or -1) + + @property + def content_type(self): + """ The Content-Type header as a lowercase-string (default: empty). """ + return self.environ.get('CONTENT_TYPE', '').lower() + + @property + def is_xhr(self): + """ True if the request was triggered by a XMLHttpRequest. This only + works with JavaScript libraries that support the `X-Requested-With` + header (most of the popular libraries do). """ + requested_with = self.environ.get('HTTP_X_REQUESTED_WITH','') + return requested_with.lower() == 'xmlhttprequest' + + @property + def is_ajax(self): + """ Alias for :attr:`is_xhr`. "Ajax" is not the right term. """ + return self.is_xhr + + @property + def auth(self): + """ HTTP authentication data as a (user, password) tuple. This + implementation currently supports basic (not digest) authentication + only. If the authentication happened at a higher level (e.g. in the + front web-server or a middleware), the password field is None, but + the user field is looked up from the ``REMOTE_USER`` environ + variable. On any errors, None is returned. """ + basic = parse_auth(self.environ.get('HTTP_AUTHORIZATION','')) + if basic: return basic + ruser = self.environ.get('REMOTE_USER') + if ruser: return (ruser, None) + return None + + @property + def remote_route(self): + """ A list of all IPs that were involved in this request, starting with + the client IP and followed by zero or more proxies. This does only + work if all proxies support the ```X-Forwarded-For`` header. Note + that this information can be forged by malicious clients. """ + proxy = self.environ.get('HTTP_X_FORWARDED_FOR') + if proxy: return [ip.strip() for ip in proxy.split(',')] + remote = self.environ.get('REMOTE_ADDR') + return [remote] if remote else [] + + @property + def remote_addr(self): + """ The client IP as a string. Note that this information can be forged + by malicious clients. """ + route = self.remote_route + return route[0] if route else None + + def copy(self): + """ Return a new :class:`Request` with a shallow :attr:`environ` copy. """ + return Request(self.environ.copy()) + + def get(self, value, default=None): return self.environ.get(value, default) + def __getitem__(self, key): return self.environ[key] + def __delitem__(self, key): self[key] = ""; del(self.environ[key]) + def __iter__(self): return iter(self.environ) + def __len__(self): return len(self.environ) + def keys(self): return self.environ.keys() + def __setitem__(self, key, value): + """ Change an environ value and clear all caches that depend on it. """ + + if self.environ.get('bottle.request.readonly'): + raise KeyError('The environ dictionary is read-only.') + + self.environ[key] = value + todelete = () + + if key == 'wsgi.input': + todelete = ('body', 'forms', 'files', 'params', 'post', 'json') + elif key == 'QUERY_STRING': + todelete = ('query', 'params') + elif key.startswith('HTTP_'): + todelete = ('headers', 'cookies') + + for key in todelete: + self.environ.pop('bottle.request.'+key, None) + + def __repr__(self): + return '<%s: %s %s>' % (self.__class__.__name__, self.method, self.url) + + def __getattr__(self, name): + """ Search in self.environ for additional user defined attributes. """ + try: + var = self.environ['bottle.request.ext.%s'%name] + return var.__get__(self) if hasattr(var, '__get__') else var + except KeyError: + raise AttributeError('Attribute %r not defined.' % name) + + def __setattr__(self, name, value): + if name == 'environ': return object.__setattr__(self, name, value) + self.environ['bottle.request.ext.%s'%name] = value + + + + +def _hkey(s): + return s.title().replace('_','-') + + +class HeaderProperty(object): + def __init__(self, name, reader=None, writer=str, default=''): + self.name, self.default = name, default + self.reader, self.writer = reader, writer + self.__doc__ = 'Current value of the %r header.' % name.title() + + def __get__(self, obj, _): + if obj is None: return self + value = obj.headers.get(self.name, self.default) + return self.reader(value) if self.reader else value + + def __set__(self, obj, value): + obj.headers[self.name] = self.writer(value) + + def __delete__(self, obj): + del obj.headers[self.name] + + +class BaseResponse(object): + """ Storage class for a response body as well as headers and cookies. + + This class does support dict-like case-insensitive item-access to + headers, but is NOT a dict. Most notably, iterating over a response + yields parts of the body and not the headers. + + :param body: The response body as one of the supported types. + :param status: Either an HTTP status code (e.g. 200) or a status line + including the reason phrase (e.g. '200 OK'). + :param headers: A dictionary or a list of name-value pairs. + + Additional keyword arguments are added to the list of headers. + Underscores in the header name are replaced with dashes. + """ + + default_status = 200 + default_content_type = 'text/html; charset=UTF-8' + + # Header blacklist for specific response codes + # (rfc2616 section 10.2.3 and 10.3.5) + bad_headers = { + 204: set(('Content-Type',)), + 304: set(('Allow', 'Content-Encoding', 'Content-Language', + 'Content-Length', 'Content-Range', 'Content-Type', + 'Content-Md5', 'Last-Modified'))} + + def __init__(self, body='', status=None, headers=None, **more_headers): + self._cookies = None + self._headers = {} + self.body = body + self.status = status or self.default_status + if headers: + if isinstance(headers, dict): + headers = headers.items() + for name, value in headers: + self.add_header(name, value) + if more_headers: + for name, value in more_headers.items(): + self.add_header(name, value) + + def copy(self, cls=None): + """ Returns a copy of self. """ + cls = cls or BaseResponse + assert issubclass(cls, BaseResponse) + copy = cls() + copy.status = self.status + copy._headers = dict((k, v[:]) for (k, v) in self._headers.items()) + if self._cookies: + copy._cookies = SimpleCookie() + copy._cookies.load(self._cookies.output()) + return copy + + def __iter__(self): + return iter(self.body) + + def close(self): + if hasattr(self.body, 'close'): + self.body.close() + + @property + def status_line(self): + """ The HTTP status line as a string (e.g. ``404 Not Found``).""" + return self._status_line + + @property + def status_code(self): + """ The HTTP status code as an integer (e.g. 404).""" + return self._status_code + + def _set_status(self, status): + if isinstance(status, int): + code, status = status, _HTTP_STATUS_LINES.get(status) + elif ' ' in status: + status = status.strip() + code = int(status.split()[0]) + else: + raise ValueError('String status line without a reason phrase.') + if not 100 <= code <= 999: raise ValueError('Status code out of range.') + self._status_code = code + self._status_line = str(status or ('%d Unknown' % code)) + + def _get_status(self): + return self._status_line + + status = property(_get_status, _set_status, None, + ''' A writeable property to change the HTTP response status. It accepts + either a numeric code (100-999) or a string with a custom reason + phrase (e.g. "404 Brain not found"). Both :data:`status_line` and + :data:`status_code` are updated accordingly. The return value is + always a status string. ''') + del _get_status, _set_status + + @property + def headers(self): + """ An instance of :class:`HeaderDict`, a case-insensitive dict-like + view on the response headers. """ + hdict = HeaderDict() + hdict.dict = self._headers + return hdict + + def __contains__(self, name): return _hkey(name) in self._headers + def __delitem__(self, name): del self._headers[_hkey(name)] + def __getitem__(self, name): return self._headers[_hkey(name)][-1] + def __setitem__(self, name, value): self._headers[_hkey(name)] = [str(value)] + + def get_header(self, name, default=None): + """ Return the value of a previously defined header. If there is no + header with that name, return a default value. """ + return self._headers.get(_hkey(name), [default])[-1] + + def set_header(self, name, value): + """ Create a new response header, replacing any previously defined + headers with the same name. """ + self._headers[_hkey(name)] = [str(value)] + + def add_header(self, name, value): + """ Add an additional response header, not removing duplicates. """ + self._headers.setdefault(_hkey(name), []).append(str(value)) + + def iter_headers(self): + """ Yield (header, value) tuples, skipping headers that are not + allowed with the current response status code. """ + return self.headerlist + + @property + def headerlist(self): + """ WSGI conform list of (header, value) tuples. """ + out = [] + headers = list(self._headers.items()) + if 'Content-Type' not in self._headers: + headers.append(('Content-Type', [self.default_content_type])) + if self._status_code in self.bad_headers: + bad_headers = self.bad_headers[self._status_code] + headers = [h for h in headers if h[0] not in bad_headers] + out += [(name, val) for name, vals in headers for val in vals] + if self._cookies: + for c in self._cookies.values(): + out.append(('Set-Cookie', c.OutputString())) + return out + + content_type = HeaderProperty('Content-Type') + content_length = HeaderProperty('Content-Length', reader=int) + expires = HeaderProperty('Expires', + reader=lambda x: datetime.utcfromtimestamp(parse_date(x)), + writer=lambda x: http_date(x)) + + @property + def charset(self, default='UTF-8'): + """ Return the charset specified in the content-type header (default: utf8). """ + if 'charset=' in self.content_type: + return self.content_type.split('charset=')[-1].split(';')[0].strip() + return default + + def set_cookie(self, name, value, secret=None, **options): + """ Create a new cookie or replace an old one. If the `secret` parameter is + set, create a `Signed Cookie` (described below). + + :param name: the name of the cookie. + :param value: the value of the cookie. + :param secret: a signature key required for signed cookies. + + Additionally, this method accepts all RFC 2109 attributes that are + supported by :class:`cookie.Morsel`, including: + + :param max_age: maximum age in seconds. (default: None) + :param expires: a datetime object or UNIX timestamp. (default: None) + :param domain: the domain that is allowed to read the cookie. + (default: current domain) + :param path: limits the cookie to a given path (default: current path) + :param secure: limit the cookie to HTTPS connections (default: off). + :param httponly: prevents client-side javascript to read this cookie + (default: off, requires Python 2.6 or newer). + + If neither `expires` nor `max_age` is set (default), the cookie will + expire at the end of the browser session (as soon as the browser + window is closed). + + Signed cookies may store any pickle-able object and are + cryptographically signed to prevent manipulation. Keep in mind that + cookies are limited to 4kb in most browsers. + + Warning: Signed cookies are not encrypted (the client can still see + the content) and not copy-protected (the client can restore an old + cookie). The main intention is to make pickling and unpickling + save, not to store secret information at client side. + """ + if not self._cookies: + self._cookies = SimpleCookie() + + if secret: + value = touni(cookie_encode((name, value), secret)) + elif not isinstance(value, basestring): + raise TypeError('Secret key missing for non-string Cookie.') + + if len(value) > 4096: raise ValueError('Cookie value to long.') + self._cookies[name] = value + + for key, value in options.items(): + if key == 'max_age': + if isinstance(value, timedelta): + value = value.seconds + value.days * 24 * 3600 + if key == 'expires': + if isinstance(value, (datedate, datetime)): + value = value.timetuple() + elif isinstance(value, (int, float)): + value = time.gmtime(value) + value = time.strftime("%a, %d %b %Y %H:%M:%S GMT", value) + self._cookies[name][key.replace('_', '-')] = value + + def delete_cookie(self, key, **kwargs): + """ Delete a cookie. Be sure to use the same `domain` and `path` + settings as used to create the cookie. """ + kwargs['max_age'] = -1 + kwargs['expires'] = 0 + self.set_cookie(key, '', **kwargs) + + def __repr__(self): + out = '' + for name, value in self.headerlist: + out += '%s: %s\n' % (name.title(), value.strip()) + return out + + +def _local_property(): + ls = threading.local() + def fget(_): + try: return ls.var + except AttributeError: + raise RuntimeError("Request context not initialized.") + def fset(_, value): ls.var = value + def fdel(_): del ls.var + return property(fget, fset, fdel, 'Thread-local property') + + +class LocalRequest(BaseRequest): + """ A thread-local subclass of :class:`BaseRequest` with a different + set of attributes for each thread. There is usually only one global + instance of this class (:data:`request`). If accessed during a + request/response cycle, this instance always refers to the *current* + request (even on a multithreaded server). """ + bind = BaseRequest.__init__ + environ = _local_property() + + +class LocalResponse(BaseResponse): + """ A thread-local subclass of :class:`BaseResponse` with a different + set of attributes for each thread. There is usually only one global + instance of this class (:data:`response`). Its attributes are used + to build the HTTP response at the end of the request/response cycle. + """ + bind = BaseResponse.__init__ + _status_line = _local_property() + _status_code = _local_property() + _cookies = _local_property() + _headers = _local_property() + body = _local_property() + + +Request = BaseRequest +Response = BaseResponse + + +class HTTPResponse(Response, BottleException): + def __init__(self, body='', status=None, headers=None, **more_headers): + super(HTTPResponse, self).__init__(body, status, headers, **more_headers) + + def apply(self, other): + other._status_code = self._status_code + other._status_line = self._status_line + other._headers = self._headers + other._cookies = self._cookies + other.body = self.body + + +class HTTPError(HTTPResponse): + default_status = 500 + def __init__(self, status=None, body=None, exception=None, traceback=None, + **options): + self.exception = exception + self.traceback = traceback + super(HTTPError, self).__init__(body, status, **options) + + + + + +############################################################################### +# Plugins ###################################################################### +############################################################################### + +class PluginError(BottleException): pass + + +class JSONPlugin(object): + name = 'json' + api = 2 + + def __init__(self, json_dumps=json_dumps): + self.json_dumps = json_dumps + + def apply(self, callback, _): + dumps = self.json_dumps + if not dumps: return callback + def wrapper(*a, **ka): + try: + rv = callback(*a, **ka) + except HTTPError: + rv = _e() + + if isinstance(rv, dict): + #Attempt to serialize, raises exception on failure + json_response = dumps(rv) + #Set content type only if serialization successful + response.content_type = 'application/json' + return json_response + elif isinstance(rv, HTTPResponse) and isinstance(rv.body, dict): + rv.body = dumps(rv.body) + rv.content_type = 'application/json' + return rv + + return wrapper + + +class TemplatePlugin(object): + """ This plugin applies the :func:`view` decorator to all routes with a + `template` config parameter. If the parameter is a tuple, the second + element must be a dict with additional options (e.g. `template_engine`) + or default variables for the template. """ + name = 'template' + api = 2 + + def apply(self, callback, route): + conf = route.config.get('template') + if isinstance(conf, (tuple, list)) and len(conf) == 2: + return view(conf[0], **conf[1])(callback) + elif isinstance(conf, str): + return view(conf)(callback) + else: + return callback + + +#: Not a plugin, but part of the plugin API. TODO: Find a better place. +class _ImportRedirect(object): + def __init__(self, name, impmask): + """ Create a virtual package that redirects imports (see PEP 302). """ + self.name = name + self.impmask = impmask + self.module = sys.modules.setdefault(name, imp.new_module(name)) + self.module.__dict__.update({'__file__': __file__, '__path__': [], + '__all__': [], '__loader__': self}) + sys.meta_path.append(self) + + def find_module(self, fullname, path=None): + if '.' not in fullname: return + packname = fullname.rsplit('.', 1)[0] + if packname != self.name: return + return self + + def load_module(self, fullname): + if fullname in sys.modules: return sys.modules[fullname] + modname = fullname.rsplit('.', 1)[1] + realname = self.impmask % modname + __import__(realname) + module = sys.modules[fullname] = sys.modules[realname] + setattr(self.module, modname, module) + module.__loader__ = self + return module + + + + + + +############################################################################### +# Common Utilities ############################################################# +############################################################################### + + +class MultiDict(DictMixin): + """ This dict stores multiple values per key, but behaves exactly like a + normal dict in that it returns only the newest value for any given key. + There are special methods available to access the full list of values. + """ + + def __init__(self, *a, **k): + self.dict = dict((k, [v]) for (k, v) in dict(*a, **k).items()) + + def __len__(self): return len(self.dict) + def __iter__(self): return iter(self.dict) + def __contains__(self, key): return key in self.dict + def __delitem__(self, key): del self.dict[key] + def __getitem__(self, key): return self.dict[key][-1] + def __setitem__(self, key, value): self.append(key, value) + def keys(self): return self.dict.keys() + + if py3k: + def values(self): return (v[-1] for v in self.dict.values()) + def items(self): return ((k, v[-1]) for k, v in self.dict.items()) + def allitems(self): + return ((k, v) for k, vl in self.dict.items() for v in vl) + iterkeys = keys + itervalues = values + iteritems = items + iterallitems = allitems + + else: + def values(self): return [v[-1] for v in self.dict.values()] + def items(self): return [(k, v[-1]) for k, v in self.dict.items()] + def iterkeys(self): return self.dict.iterkeys() + def itervalues(self): return (v[-1] for v in self.dict.itervalues()) + def iteritems(self): + return ((k, v[-1]) for k, v in self.dict.iteritems()) + def iterallitems(self): + return ((k, v) for k, vl in self.dict.iteritems() for v in vl) + def allitems(self): + return [(k, v) for k, vl in self.dict.iteritems() for v in vl] + + def get(self, key, default=None, index=-1, type=None): + """ Return the most recent value for a key. + + :param default: The default value to be returned if the key is not + present or the type conversion fails. + :param index: An index for the list of available values. + :param type: If defined, this callable is used to cast the value + into a specific type. Exception are suppressed and result in + the default value to be returned. + """ + try: + val = self.dict[key][index] + return type(val) if type else val + except Exception: + pass + return default + + def append(self, key, value): + """ Add a new value to the list of values for this key. """ + self.dict.setdefault(key, []).append(value) + + def replace(self, key, value): + """ Replace the list of values with a single value. """ + self.dict[key] = [value] + + def getall(self, key): + """ Return a (possibly empty) list of values for a key. """ + return self.dict.get(key) or [] + + #: Aliases for WTForms to mimic other multi-dict APIs (Django) + getone = get + getlist = getall + + +class FormsDict(MultiDict): + """ This :class:`MultiDict` subclass is used to store request form data. + Additionally to the normal dict-like item access methods (which return + unmodified data as native strings), this container also supports + attribute-like access to its values. Attributes are automatically de- + or recoded to match :attr:`input_encoding` (default: 'utf8'). Missing + attributes default to an empty string. """ + + #: Encoding used for attribute values. + input_encoding = 'utf8' + #: If true (default), unicode strings are first encoded with `latin1` + #: and then decoded to match :attr:`input_encoding`. + recode_unicode = True + + def _fix(self, s, encoding=None): + if isinstance(s, unicode) and self.recode_unicode: # Python 3 WSGI + return s.encode('latin1').decode(encoding or self.input_encoding) + elif isinstance(s, bytes): # Python 2 WSGI + return s.decode(encoding or self.input_encoding) + else: + return s + + def decode(self, encoding=None): + """ Returns a copy with all keys and values de- or recoded to match + :attr:`input_encoding`. Some libraries (e.g. WTForms) want a + unicode dictionary. """ + copy = FormsDict() + enc = copy.input_encoding = encoding or self.input_encoding + copy.recode_unicode = False + for key, value in self.allitems(): + copy.append(self._fix(key, enc), self._fix(value, enc)) + return copy + + def getunicode(self, name, default=None, encoding=None): + """ Return the value as a unicode string, or the default. """ + try: + return self._fix(self[name], encoding) + except (UnicodeError, KeyError): + return default + + def __getattr__(self, name, default=unicode()): + # Without this guard, pickle generates a cryptic TypeError: + if name.startswith('__') and name.endswith('__'): + return super(FormsDict, self).__getattr__(name) + return self.getunicode(name, default=default) + + +class HeaderDict(MultiDict): + """ A case-insensitive version of :class:`MultiDict` that defaults to + replace the old value instead of appending it. """ + + def __init__(self, *a, **ka): + self.dict = {} + if a or ka: self.update(*a, **ka) + + def __contains__(self, key): return _hkey(key) in self.dict + def __delitem__(self, key): del self.dict[_hkey(key)] + def __getitem__(self, key): return self.dict[_hkey(key)][-1] + def __setitem__(self, key, value): self.dict[_hkey(key)] = [str(value)] + def append(self, key, value): + self.dict.setdefault(_hkey(key), []).append(str(value)) + def replace(self, key, value): self.dict[_hkey(key)] = [str(value)] + def getall(self, key): return self.dict.get(_hkey(key)) or [] + def get(self, key, default=None, index=-1): + return MultiDict.get(self, _hkey(key), default, index) + def filter(self, names): + for name in [_hkey(n) for n in names]: + if name in self.dict: + del self.dict[name] + + +class WSGIHeaderDict(DictMixin): + """ This dict-like class wraps a WSGI environ dict and provides convenient + access to HTTP_* fields. Keys and values are native strings + (2.x bytes or 3.x unicode) and keys are case-insensitive. If the WSGI + environment contains non-native string values, these are de- or encoded + using a lossless 'latin1' character set. + + The API will remain stable even on changes to the relevant PEPs. + Currently PEP 333, 444 and 3333 are supported. (PEP 444 is the only one + that uses non-native strings.) + """ + #: List of keys that do not have a ``HTTP_`` prefix. + cgikeys = ('CONTENT_TYPE', 'CONTENT_LENGTH') + + def __init__(self, environ): + self.environ = environ + + def _ekey(self, key): + """ Translate header field name to CGI/WSGI environ key. """ + key = key.replace('-','_').upper() + if key in self.cgikeys: + return key + return 'HTTP_' + key + + def raw(self, key, default=None): + """ Return the header value as is (may be bytes or unicode). """ + return self.environ.get(self._ekey(key), default) + + def __getitem__(self, key): + return tonat(self.environ[self._ekey(key)], 'latin1') + + def __setitem__(self, key, value): + raise TypeError("%s is read-only." % self.__class__) + + def __delitem__(self, key): + raise TypeError("%s is read-only." % self.__class__) + + def __iter__(self): + for key in self.environ: + if key[:5] == 'HTTP_': + yield _hkey(key[5:]) + elif key in self.cgikeys: + yield _hkey(key) + + def keys(self): return [x for x in self] + def __len__(self): return len(self.keys()) + def __contains__(self, key): return self._ekey(key) in self.environ + + + +class ConfigDict(dict): + """ A dict-like configuration storage with additional support for + namespaces, validators, meta-data, on_change listeners and more. + """ + + __slots__ = ('_meta', '_on_change') + + def __init__(self): + self._meta = {} + self._on_change = lambda name, value: None + + def load_config(self, filename): + """ Load values from an ``*.ini`` style config file. + + If the config file contains sections, their names are used as + namespaces for the values within. The two special sections + ``DEFAULT`` and ``bottle`` refer to the root namespace (no prefix). + """ + conf = ConfigParser() + conf.read(filename) + for section in conf.sections(): + for key, value in conf.items(section): + if section not in ('DEFAULT', 'bottle'): + key = section + '.' + key + self[key] = value + return self + + def load_dict(self, source, namespace=''): + """ Load values from a dictionary structure. Nesting can be used to + represent namespaces. + + >>> c = ConfigDict() + >>> c.load_dict({'some': {'namespace': {'key': 'value'} } }) + {'some.namespace.key': 'value'} + """ + for key, value in source.items(): + if isinstance(key, str): + nskey = (namespace + '.' + key).strip('.') + if isinstance(value, dict): + self.load_dict(value, namespace=nskey) + else: + self[nskey] = value + else: + raise TypeError('Key has type %r (not a string)' % type(key)) + return self + + def update(self, *a, **ka): + """ If the first parameter is a string, all keys are prefixed with this + namespace. Apart from that it works just as the usual dict.update(). + Example: ``update('some.namespace', key='value')`` """ + prefix = '' + if a and isinstance(a[0], str): + prefix = a[0].strip('.') + '.' + a = a[1:] + for key, value in dict(*a, **ka).items(): + self[prefix+key] = value + + def setdefault(self, key, value): + if key not in self: + self[key] = value + return self[key] + + def __setitem__(self, key, value): + if not isinstance(key, str): + raise TypeError('Key has type %r (not a string)' % type(key)) + value = self.meta_get(key, 'filter', lambda x: x)(value) + if key in self and self[key] is value: + return + self._on_change(key, value) + dict.__setitem__(self, key, value) + + def __delitem__(self, key): + self._on_change(key, None) + dict.__delitem__(self, key) + + def meta_get(self, key, metafield, default=None): + """ Return the value of a meta field for a key. """ + return self._meta.get(key, {}).get(metafield, default) + + def meta_set(self, key, metafield, value): + """ Set the meta field for a key to a new value. This triggers the + on-change handler for existing keys. """ + self._meta.setdefault(key, {})[metafield] = value + if key in self: + self[key] = self[key] + + def meta_list(self, key): + """ Return an iterable of meta field names defined for a key. """ + return self._meta.get(key, {}).keys() + + +class AppStack(list): + """ A stack-like list. Calling it returns the head of the stack. """ + + def __call__(self): + """ Return the current default application. """ + return self[-1] + + def push(self, value=None): + """ Add a new :class:`Bottle` instance to the stack """ + if not isinstance(value, Bottle): + value = Bottle() + self.append(value) + return value + + +class WSGIFileWrapper(object): + + def __init__(self, fp, buffer_size=1024*64): + self.fp, self.buffer_size = fp, buffer_size + for attr in ('fileno', 'close', 'read', 'readlines', 'tell', 'seek'): + if hasattr(fp, attr): setattr(self, attr, getattr(fp, attr)) + + def __iter__(self): + buff, read = self.buffer_size, self.read + while True: + part = read(buff) + if not part: return + yield part + + +class _closeiter(object): + """ This only exists to be able to attach a .close method to iterators that + do not support attribute assignment (most of itertools). """ + + def __init__(self, iterator, close=None): + self.iterator = iterator + self.close_callbacks = makelist(close) + + def __iter__(self): + return iter(self.iterator) + + def close(self): + for func in self.close_callbacks: + func() + + +class ResourceManager(object): + """ This class manages a list of search paths and helps to find and open + application-bound resources (files). + + :param base: default value for :meth:`add_path` calls. + :param opener: callable used to open resources. + :param cachemode: controls which lookups are cached. One of 'all', + 'found' or 'none'. + """ + + def __init__(self, base='./', opener=open, cachemode='all'): + self.opener = opener + self.base = base + self.cachemode = cachemode + + #: A list of search paths. See :meth:`add_path` for details. + self.path = [] + #: A cache for resolved paths. ``res.cache.clear()`` clears the cache. + self.cache = {} + + def add_path(self, path, base=None, index=None, create=False): + """ Add a new path to the list of search paths. Return False if the + path does not exist. + + :param path: The new search path. Relative paths are turned into + an absolute and normalized form. If the path looks like a file + (not ending in `/`), the filename is stripped off. + :param base: Path used to absolutize relative search paths. + Defaults to :attr:`base` which defaults to ``os.getcwd()``. + :param index: Position within the list of search paths. Defaults + to last index (appends to the list). + + The `base` parameter makes it easy to reference files installed + along with a python module or package:: + + res.add_path('./resources/', __file__) + """ + base = os.path.abspath(os.path.dirname(base or self.base)) + path = os.path.abspath(os.path.join(base, os.path.dirname(path))) + path += os.sep + if path in self.path: + self.path.remove(path) + if create and not os.path.isdir(path): + os.makedirs(path) + if index is None: + self.path.append(path) + else: + self.path.insert(index, path) + self.cache.clear() + return os.path.exists(path) + + def __iter__(self): + """ Iterate over all existing files in all registered paths. """ + search = self.path[:] + while search: + path = search.pop() + if not os.path.isdir(path): continue + for name in os.listdir(path): + full = os.path.join(path, name) + if os.path.isdir(full): search.append(full) + else: yield full + + def lookup(self, name): + """ Search for a resource and return an absolute file path, or `None`. + + The :attr:`path` list is searched in order. The first match is + returend. Symlinks are followed. The result is cached to speed up + future lookups. """ + if name not in self.cache or DEBUG: + for path in self.path: + fpath = os.path.join(path, name) + if os.path.isfile(fpath): + if self.cachemode in ('all', 'found'): + self.cache[name] = fpath + return fpath + if self.cachemode == 'all': + self.cache[name] = None + return self.cache[name] + + def open(self, name, mode='r', *args, **kwargs): + """ Find a resource and return a file object, or raise IOError. """ + fname = self.lookup(name) + if not fname: raise IOError("Resource %r not found." % name) + return self.opener(fname, mode=mode, *args, **kwargs) + + +class FileUpload(object): + + def __init__(self, fileobj, name, filename, headers=None): + """ Wrapper for file uploads. """ + #: Open file(-like) object (BytesIO buffer or temporary file) + self.file = fileobj + #: Name of the upload form field + self.name = name + #: Raw filename as sent by the client (may contain unsafe characters) + self.raw_filename = filename + #: A :class:`HeaderDict` with additional headers (e.g. content-type) + self.headers = HeaderDict(headers) if headers else HeaderDict() + + content_type = HeaderProperty('Content-Type') + content_length = HeaderProperty('Content-Length', reader=int, default=-1) + + @cached_property + def filename(self): + """ Name of the file on the client file system, but normalized to ensure + file system compatibility. An empty filename is returned as 'empty'. + + Only ASCII letters, digits, dashes, underscores and dots are + allowed in the final filename. Accents are removed, if possible. + Whitespace is replaced by a single dash. Leading or tailing dots + or dashes are removed. The filename is limited to 255 characters. + """ + fname = self.raw_filename + if not isinstance(fname, unicode): + fname = fname.decode('utf8', 'ignore') + fname = normalize('NFKD', fname).encode('ASCII', 'ignore').decode('ASCII') + fname = os.path.basename(fname.replace('\\', os.path.sep)) + fname = re.sub(r'[^a-zA-Z0-9-_.\s]', '', fname).strip() + fname = re.sub(r'[-\s]+', '-', fname).strip('.-') + return fname[:255] or 'empty' + + def _copy_file(self, fp, chunk_size=2**16): + read, write, offset = self.file.read, fp.write, self.file.tell() + while 1: + buf = read(chunk_size) + if not buf: break + write(buf) + self.file.seek(offset) + + def save(self, destination, overwrite=False, chunk_size=2**16): + """ Save file to disk or copy its content to an open file(-like) object. + If *destination* is a directory, :attr:`filename` is added to the + path. Existing files are not overwritten by default (IOError). + + :param destination: File path, directory or file(-like) object. + :param overwrite: If True, replace existing files. (default: False) + :param chunk_size: Bytes to read at a time. (default: 64kb) + """ + if isinstance(destination, basestring): # Except file-likes here + if os.path.isdir(destination): + destination = os.path.join(destination, self.filename) + if not overwrite and os.path.exists(destination): + raise IOError('File exists.') + with open(destination, 'wb') as fp: + self._copy_file(fp, chunk_size) + else: + self._copy_file(destination, chunk_size) + + + + + + +############################################################################### +# Application Helper ########################################################### +############################################################################### + + +def abort(code=500, text='Unknown Error.'): + """ Aborts execution and causes a HTTP error. """ + raise HTTPError(code, text) + + +def redirect(url, code=None): + """ Aborts execution and causes a 303 or 302 redirect, depending on + the HTTP protocol version. """ + if not code: + code = 303 if request.get('SERVER_PROTOCOL') == "HTTP/1.1" else 302 + res = response.copy(cls=HTTPResponse) + res.status = code + res.body = "" + res.set_header('Location', urljoin(request.url, url)) + raise res + + +def _file_iter_range(fp, offset, bytes, maxread=1024*1024): + """ Yield chunks from a range in a file. No chunk is bigger than maxread.""" + fp.seek(offset) + while bytes > 0: + part = fp.read(min(bytes, maxread)) + if not part: break + bytes -= len(part) + yield part + + +def static_file(filename, root, mimetype='auto', download=False, charset='UTF-8'): + """ Open a file in a safe way and return :exc:`HTTPResponse` with status + code 200, 305, 403 or 404. The ``Content-Type``, ``Content-Encoding``, + ``Content-Length`` and ``Last-Modified`` headers are set if possible. + Special support for ``If-Modified-Since``, ``Range`` and ``HEAD`` + requests. + + :param filename: Name or path of the file to send. + :param root: Root path for file lookups. Should be an absolute directory + path. + :param mimetype: Defines the content-type header (default: guess from + file extension) + :param download: If True, ask the browser to open a `Save as...` dialog + instead of opening the file with the associated program. You can + specify a custom filename as a string. If not specified, the + original filename is used (default: False). + :param charset: The charset to use for files with a ``text/*`` + mime-type. (default: UTF-8) + """ + + root = os.path.abspath(root) + os.sep + filename = os.path.abspath(os.path.join(root, filename.strip('/\\'))) + headers = dict() + + if not filename.startswith(root): + return HTTPError(403, "Access denied.") + if not os.path.exists(filename) or not os.path.isfile(filename): + return HTTPError(404, "File does not exist.") + if not os.access(filename, os.R_OK): + return HTTPError(403, "You do not have permission to access this file.") + + if mimetype == 'auto': + mimetype, encoding = mimetypes.guess_type(filename) + if encoding: headers['Content-Encoding'] = encoding + + if mimetype: + if mimetype[:5] == 'text/' and charset and 'charset' not in mimetype: + mimetype += '; charset=%s' % charset + headers['Content-Type'] = mimetype + + if download: + download = os.path.basename(filename if download == True else download) + headers['Content-Disposition'] = 'attachment; filename="%s"' % download + + stats = os.stat(filename) + headers['Content-Length'] = clen = stats.st_size + lm = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(stats.st_mtime)) + headers['Last-Modified'] = lm + + ims = request.environ.get('HTTP_IF_MODIFIED_SINCE') + if ims: + ims = parse_date(ims.split(";")[0].strip()) + if ims is not None and ims >= int(stats.st_mtime): + headers['Date'] = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime()) + return HTTPResponse(status=304, **headers) + + body = '' if request.method == 'HEAD' else open(filename, 'rb') + + headers["Accept-Ranges"] = "bytes" + ranges = request.environ.get('HTTP_RANGE') + if 'HTTP_RANGE' in request.environ: + ranges = list(parse_range_header(request.environ['HTTP_RANGE'], clen)) + if not ranges: + return HTTPError(416, "Requested Range Not Satisfiable") + offset, end = ranges[0] + headers["Content-Range"] = "bytes %d-%d/%d" % (offset, end-1, clen) + headers["Content-Length"] = str(end-offset) + if body: body = _file_iter_range(body, offset, end-offset) + return HTTPResponse(body, status=206, **headers) + return HTTPResponse(body, **headers) + + + + + + +############################################################################### +# HTTP Utilities and MISC (TODO) ############################################### +############################################################################### + + +def debug(mode=True): + """ Change the debug level. + There is only one debug level supported at the moment.""" + global DEBUG + if mode: warnings.simplefilter('default') + DEBUG = bool(mode) + +def http_date(value): + if isinstance(value, (datedate, datetime)): + value = value.utctimetuple() + elif isinstance(value, (int, float)): + value = time.gmtime(value) + if not isinstance(value, basestring): + value = time.strftime("%a, %d %b %Y %H:%M:%S GMT", value) + return value + +def parse_date(ims): + """ Parse rfc1123, rfc850 and asctime timestamps and return UTC epoch. """ + try: + ts = email.utils.parsedate_tz(ims) + return time.mktime(ts[:8] + (0,)) - (ts[9] or 0) - time.timezone + except (TypeError, ValueError, IndexError, OverflowError): + return None + +def parse_auth(header): + """ Parse rfc2617 HTTP authentication header string (basic) and return (user,pass) tuple or None""" + try: + method, data = header.split(None, 1) + if method.lower() == 'basic': + user, pwd = touni(base64.b64decode(tob(data))).split(':',1) + return user, pwd + except (KeyError, ValueError): + return None + +def parse_range_header(header, maxlen=0): + """ Yield (start, end) ranges parsed from a HTTP Range header. Skip + unsatisfiable ranges. The end index is non-inclusive.""" + if not header or header[:6] != 'bytes=': return + ranges = [r.split('-', 1) for r in header[6:].split(',') if '-' in r] + for start, end in ranges: + try: + if not start: # bytes=-100 -> last 100 bytes + start, end = max(0, maxlen-int(end)), maxlen + elif not end: # bytes=100- -> all but the first 99 bytes + start, end = int(start), maxlen + else: # bytes=100-200 -> bytes 100-200 (inclusive) + start, end = int(start), min(int(end)+1, maxlen) + if 0 <= start < end <= maxlen: + yield start, end + except ValueError: + pass + +def _parse_qsl(qs): + r = [] + for pair in qs.replace(';','&').split('&'): + if not pair: continue + nv = pair.split('=', 1) + if len(nv) != 2: nv.append('') + key = urlunquote(nv[0].replace('+', ' ')) + value = urlunquote(nv[1].replace('+', ' ')) + r.append((key, value)) + return r + +def _lscmp(a, b): + """ Compares two strings in a cryptographically safe way: + Runtime is not affected by length of common prefix. """ + return not sum(0 if x==y else 1 for x, y in zip(a, b)) and len(a) == len(b) + + +def cookie_encode(data, key): + """ Encode and sign a pickle-able object. Return a (byte) string """ + msg = base64.b64encode(pickle.dumps(data, -1)) + sig = base64.b64encode(hmac.new(tob(key), msg).digest()) + return tob('!') + sig + tob('?') + msg + + +def cookie_decode(data, key): + """ Verify and decode an encoded string. Return an object or None.""" + data = tob(data) + if cookie_is_encoded(data): + sig, msg = data.split(tob('?'), 1) + if _lscmp(sig[1:], base64.b64encode(hmac.new(tob(key), msg).digest())): + return pickle.loads(base64.b64decode(msg)) + return None + + +def cookie_is_encoded(data): + """ Return True if the argument looks like a encoded cookie.""" + return bool(data.startswith(tob('!')) and tob('?') in data) + + +def html_escape(string): + """ Escape HTML special characters ``&<>`` and quotes ``'"``. """ + return string.replace('&','&').replace('<','<').replace('>','>')\ + .replace('"','"').replace("'",''') + + +def html_quote(string): + """ Escape and quote a string to be used as an HTTP attribute.""" + return '"%s"' % html_escape(string).replace('\n',' ')\ + .replace('\r',' ').replace('\t',' ') + + +def yieldroutes(func): + """ Return a generator for routes that match the signature (name, args) + of the func parameter. This may yield more than one route if the function + takes optional keyword arguments. The output is best described by example:: + + a() -> '/a' + b(x, y) -> '/b//' + c(x, y=5) -> '/c/' and '/c//' + d(x=5, y=6) -> '/d' and '/d/' and '/d//' + """ + path = '/' + func.__name__.replace('__','/').lstrip('/') + spec = getargspec(func) + argc = len(spec[0]) - len(spec[3] or []) + path += ('/<%s>' * argc) % tuple(spec[0][:argc]) + yield path + for arg in spec[0][argc:]: + path += '/<%s>' % arg + yield path + + +def path_shift(script_name, path_info, shift=1): + """ Shift path fragments from PATH_INFO to SCRIPT_NAME and vice versa. + + :return: The modified paths. + :param script_name: The SCRIPT_NAME path. + :param script_name: The PATH_INFO path. + :param shift: The number of path fragments to shift. May be negative to + change the shift direction. (default: 1) + """ + if shift == 0: return script_name, path_info + pathlist = path_info.strip('/').split('/') + scriptlist = script_name.strip('/').split('/') + if pathlist and pathlist[0] == '': pathlist = [] + if scriptlist and scriptlist[0] == '': scriptlist = [] + if 0 < shift <= len(pathlist): + moved = pathlist[:shift] + scriptlist = scriptlist + moved + pathlist = pathlist[shift:] + elif 0 > shift >= -len(scriptlist): + moved = scriptlist[shift:] + pathlist = moved + pathlist + scriptlist = scriptlist[:shift] + else: + empty = 'SCRIPT_NAME' if shift < 0 else 'PATH_INFO' + raise AssertionError("Cannot shift. Nothing left from %s" % empty) + new_script_name = '/' + '/'.join(scriptlist) + new_path_info = '/' + '/'.join(pathlist) + if path_info.endswith('/') and pathlist: new_path_info += '/' + return new_script_name, new_path_info + + +def auth_basic(check, realm="private", text="Access denied"): + """ Callback decorator to require HTTP auth (basic). + TODO: Add route(check_auth=...) parameter. """ + def decorator(func): + @functools.wraps(func) + def wrapper(*a, **ka): + user, password = request.auth or (None, None) + if user is None or not check(user, password): + err = HTTPError(401, text) + err.add_header('WWW-Authenticate', 'Basic realm="%s"' % realm) + return err + return func(*a, **ka) + return wrapper + return decorator + + +# Shortcuts for common Bottle methods. +# They all refer to the current default application. + +def make_default_app_wrapper(name): + """ Return a callable that relays calls to the current default app. """ + @functools.wraps(getattr(Bottle, name)) + def wrapper(*a, **ka): + return getattr(app(), name)(*a, **ka) + return wrapper + +route = make_default_app_wrapper('route') +get = make_default_app_wrapper('get') +post = make_default_app_wrapper('post') +put = make_default_app_wrapper('put') +delete = make_default_app_wrapper('delete') +patch = make_default_app_wrapper('patch') +error = make_default_app_wrapper('error') +mount = make_default_app_wrapper('mount') +hook = make_default_app_wrapper('hook') +install = make_default_app_wrapper('install') +uninstall = make_default_app_wrapper('uninstall') +url = make_default_app_wrapper('get_url') + + + + + + + +############################################################################### +# Server Adapter ############################################################### +############################################################################### + + +class ServerAdapter(object): + quiet = False + def __init__(self, host='127.0.0.1', port=8080, **options): + self.options = options + self.host = host + self.port = int(port) + + def run(self, handler): # pragma: no cover + pass + + def __repr__(self): + args = ', '.join(['%s=%s'%(k,repr(v)) for k, v in self.options.items()]) + return "%s(%s)" % (self.__class__.__name__, args) + + +class CGIServer(ServerAdapter): + quiet = True + def run(self, handler): # pragma: no cover + from wsgiref.handlers import CGIHandler + def fixed_environ(environ, start_response): + environ.setdefault('PATH_INFO', '') + return handler(environ, start_response) + CGIHandler().run(fixed_environ) + + +class FlupFCGIServer(ServerAdapter): + def run(self, handler): # pragma: no cover + import flup.server.fcgi + self.options.setdefault('bindAddress', (self.host, self.port)) + flup.server.fcgi.WSGIServer(handler, **self.options).run() + + +class WSGIRefServer(ServerAdapter): + + def run(self, app): # pragma: no cover + from wsgiref.simple_server import make_server + from wsgiref.simple_server import WSGIRequestHandler, WSGIServer + import socket + + class FixedHandler(WSGIRequestHandler): + def address_string(self): # Prevent reverse DNS lookups please. + return self.client_address[0] + def log_request(*args, **kw): + if not self.quiet: + return WSGIRequestHandler.log_request(*args, **kw) + + handler_cls = self.options.get('handler_class', FixedHandler) + server_cls = self.options.get('server_class', WSGIServer) + + if ':' in self.host: # Fix wsgiref for IPv6 addresses. + if getattr(server_cls, 'address_family') == socket.AF_INET: + class server_cls(server_cls): + address_family = socket.AF_INET6 + + self.srv = make_server(self.host, self.port, app, server_cls, handler_cls) + self.port = self.srv.server_port # update port actual port (0 means random) + try: + self.srv.serve_forever() + except KeyboardInterrupt: + self.srv.server_close() # Prevent ResourceWarning: unclosed socket + raise + + +class CherryPyServer(ServerAdapter): + def run(self, handler): # pragma: no cover + from cherrypy import wsgiserver + self.options['bind_addr'] = (self.host, self.port) + self.options['wsgi_app'] = handler + + certfile = self.options.get('certfile') + if certfile: + del self.options['certfile'] + keyfile = self.options.get('keyfile') + if keyfile: + del self.options['keyfile'] + + server = wsgiserver.CherryPyWSGIServer(**self.options) + if certfile: + server.ssl_certificate = certfile + if keyfile: + server.ssl_private_key = keyfile + + try: + server.start() + finally: + server.stop() + + +class WaitressServer(ServerAdapter): + def run(self, handler): + from waitress import serve + serve(handler, host=self.host, port=self.port) + + +class PasteServer(ServerAdapter): + def run(self, handler): # pragma: no cover + from paste import httpserver + from paste.translogger import TransLogger + handler = TransLogger(handler, setup_console_handler=(not self.quiet)) + httpserver.serve(handler, host=self.host, port=str(self.port), + **self.options) + + +class MeinheldServer(ServerAdapter): + def run(self, handler): + from meinheld import server + server.listen((self.host, self.port)) + server.run(handler) + + +class FapwsServer(ServerAdapter): + """ Extremely fast webserver using libev. See http://www.fapws.org/ """ + def run(self, handler): # pragma: no cover + import fapws._evwsgi as evwsgi + from fapws import base, config + port = self.port + if float(config.SERVER_IDENT[-2:]) > 0.4: + # fapws3 silently changed its API in 0.5 + port = str(port) + evwsgi.start(self.host, port) + # fapws3 never releases the GIL. Complain upstream. I tried. No luck. + if 'BOTTLE_CHILD' in os.environ and not self.quiet: + _stderr("WARNING: Auto-reloading does not work with Fapws3.\n") + _stderr(" (Fapws3 breaks python thread support)\n") + evwsgi.set_base_module(base) + def app(environ, start_response): + environ['wsgi.multiprocess'] = False + return handler(environ, start_response) + evwsgi.wsgi_cb(('', app)) + evwsgi.run() + + +class TornadoServer(ServerAdapter): + """ The super hyped asynchronous server by facebook. Untested. """ + def run(self, handler): # pragma: no cover + import tornado.wsgi, tornado.httpserver, tornado.ioloop + container = tornado.wsgi.WSGIContainer(handler) + server = tornado.httpserver.HTTPServer(container) + server.listen(port=self.port,address=self.host) + tornado.ioloop.IOLoop.instance().start() + + +class AppEngineServer(ServerAdapter): + """ Adapter for Google App Engine. """ + quiet = True + def run(self, handler): + from google.appengine.ext.webapp import util + # A main() function in the handler script enables 'App Caching'. + # Lets makes sure it is there. This _really_ improves performance. + module = sys.modules.get('__main__') + if module and not hasattr(module, 'main'): + module.main = lambda: util.run_wsgi_app(handler) + util.run_wsgi_app(handler) + + +class TwistedServer(ServerAdapter): + """ Untested. """ + def run(self, handler): + from twisted.web import server, wsgi + from twisted.python.threadpool import ThreadPool + from twisted.internet import reactor + thread_pool = ThreadPool() + thread_pool.start() + reactor.addSystemEventTrigger('after', 'shutdown', thread_pool.stop) + factory = server.Site(wsgi.WSGIResource(reactor, thread_pool, handler)) + reactor.listenTCP(self.port, factory, interface=self.host) + if not reactor.running: + reactor.run() + + +class DieselServer(ServerAdapter): + """ Untested. """ + def run(self, handler): + from diesel.protocols.wsgi import WSGIApplication + app = WSGIApplication(handler, port=self.port) + app.run() + + +class GeventServer(ServerAdapter): + """ Untested. Options: + + * `fast` (default: False) uses libevent's http server, but has some + issues: No streaming, no pipelining, no SSL. + * See gevent.wsgi.WSGIServer() documentation for more options. + """ + def run(self, handler): + from gevent import wsgi, pywsgi, local + if not isinstance(threading.local(), local.local): + msg = "Bottle requires gevent.monkey.patch_all() (before import)" + raise RuntimeError(msg) + if not self.options.pop('fast', None): wsgi = pywsgi + self.options['log'] = None if self.quiet else 'default' + address = (self.host, self.port) + server = wsgi.WSGIServer(address, handler, **self.options) + if 'BOTTLE_CHILD' in os.environ: + import signal + signal.signal(signal.SIGINT, lambda s, f: server.stop()) + server.serve_forever() + + +class GeventSocketIOServer(ServerAdapter): + def run(self,handler): + from socketio import server + address = (self.host, self.port) + server.SocketIOServer(address, handler, **self.options).serve_forever() + + +class GunicornServer(ServerAdapter): + """ Untested. See http://gunicorn.org/configure.html for options. """ + def run(self, handler): + from gunicorn.app.base import Application + + config = {'bind': "%s:%d" % (self.host, int(self.port))} + config.update(self.options) + + class GunicornApplication(Application): + def init(self, parser, opts, args): + return config + + def load(self): + return handler + + GunicornApplication().run() + + +class EventletServer(ServerAdapter): + """ Untested. Options: + + * `backlog` adjust the eventlet backlog parameter which is the maximum + number of queued connections. Should be at least 1; the maximum + value is system-dependent. + * `family`: (default is 2) socket family, optional. See socket + documentation for available families. + """ + def run(self, handler): + from eventlet import wsgi, listen, patcher + if not patcher.is_monkey_patched(os): + msg = "Bottle requires eventlet.monkey_patch() (before import)" + raise RuntimeError(msg) + socket_args = {} + for arg in ('backlog', 'family'): + try: + socket_args[arg] = self.options.pop(arg) + except KeyError: + pass + address = (self.host, self.port) + try: + wsgi.server(listen(address, **socket_args), handler, + log_output=(not self.quiet)) + except TypeError: + # Fallback, if we have old version of eventlet + wsgi.server(listen(address), handler) + + +class RocketServer(ServerAdapter): + """ Untested. """ + def run(self, handler): + from rocket import Rocket + server = Rocket((self.host, self.port), 'wsgi', { 'wsgi_app' : handler }) + server.start() + + +class BjoernServer(ServerAdapter): + """ Fast server written in C: https://github.com/jonashaag/bjoern """ + def run(self, handler): + from bjoern import run + run(handler, self.host, self.port) + + +class AutoServer(ServerAdapter): + """ Untested. """ + adapters = [WaitressServer, PasteServer, TwistedServer, CherryPyServer, WSGIRefServer] + def run(self, handler): + for sa in self.adapters: + try: + return sa(self.host, self.port, **self.options).run(handler) + except ImportError: + pass + +server_names = { + 'cgi': CGIServer, + 'flup': FlupFCGIServer, + 'wsgiref': WSGIRefServer, + 'waitress': WaitressServer, + 'cherrypy': CherryPyServer, + 'paste': PasteServer, + 'fapws3': FapwsServer, + 'tornado': TornadoServer, + 'gae': AppEngineServer, + 'twisted': TwistedServer, + 'diesel': DieselServer, + 'meinheld': MeinheldServer, + 'gunicorn': GunicornServer, + 'eventlet': EventletServer, + 'gevent': GeventServer, + 'geventSocketIO':GeventSocketIOServer, + 'rocket': RocketServer, + 'bjoern' : BjoernServer, + 'auto': AutoServer, +} + + + + + + +############################################################################### +# Application Control ########################################################## +############################################################################### + + +def load(target, **namespace): + """ Import a module or fetch an object from a module. + + * ``package.module`` returns `module` as a module object. + * ``pack.mod:name`` returns the module variable `name` from `pack.mod`. + * ``pack.mod:func()`` calls `pack.mod.func()` and returns the result. + + The last form accepts not only function calls, but any type of + expression. Keyword arguments passed to this function are available as + local variables. Example: ``import_string('re:compile(x)', x='[a-z]')`` + """ + module, target = target.split(":", 1) if ':' in target else (target, None) + if module not in sys.modules: __import__(module) + if not target: return sys.modules[module] + if target.isalnum(): return getattr(sys.modules[module], target) + package_name = module.split('.')[0] + namespace[package_name] = sys.modules[package_name] + return eval('%s.%s' % (module, target), namespace) + + +def load_app(target): + """ Load a bottle application from a module and make sure that the import + does not affect the current default application, but returns a separate + application object. See :func:`load` for the target parameter. """ + global NORUN; NORUN, nr_old = True, NORUN + tmp = default_app.push() # Create a new "default application" + try: + rv = load(target) # Import the target module + return rv if callable(rv) else tmp + finally: + default_app.remove(tmp) # Remove the temporary added default application + NORUN = nr_old + +_debug = debug +def run(app=None, server='wsgiref', host='127.0.0.1', port=8080, + interval=1, reloader=False, quiet=False, plugins=None, + debug=None, **kargs): + """ Start a server instance. This method blocks until the server terminates. + + :param app: WSGI application or target string supported by + :func:`load_app`. (default: :func:`default_app`) + :param server: Server adapter to use. See :data:`server_names` keys + for valid names or pass a :class:`ServerAdapter` subclass. + (default: `wsgiref`) + :param host: Server address to bind to. Pass ``0.0.0.0`` to listens on + all interfaces including the external one. (default: 127.0.0.1) + :param port: Server port to bind to. Values below 1024 require root + privileges. (default: 8080) + :param reloader: Start auto-reloading server? (default: False) + :param interval: Auto-reloader interval in seconds (default: 1) + :param quiet: Suppress output to stdout and stderr? (default: False) + :param options: Options passed to the server adapter. + """ + if NORUN: return + if reloader and not os.environ.get('BOTTLE_CHILD'): + lockfile = None + try: + fd, lockfile = tempfile.mkstemp(prefix='bottle.', suffix='.lock') + os.close(fd) # We only need this file to exist. We never write to it + while os.path.exists(lockfile): + args = [sys.executable] + sys.argv + environ = os.environ.copy() + environ['BOTTLE_CHILD'] = 'true' + environ['BOTTLE_LOCKFILE'] = lockfile + p = subprocess.Popen(args, env=environ) + while p.poll() is None: # Busy wait... + os.utime(lockfile, None) # I am alive! + time.sleep(interval) + if p.poll() != 3: + if os.path.exists(lockfile): os.unlink(lockfile) + sys.exit(p.poll()) + except KeyboardInterrupt: + pass + finally: + if os.path.exists(lockfile): + os.unlink(lockfile) + return + + try: + if debug is not None: _debug(debug) + app = app or default_app() + if isinstance(app, basestring): + app = load_app(app) + if not callable(app): + raise ValueError("Application is not callable: %r" % app) + + for plugin in plugins or []: + if isinstance(plugin, basestring): + plugin = load(plugin) + app.install(plugin) + + if server in server_names: + server = server_names.get(server) + if isinstance(server, basestring): + server = load(server) + if isinstance(server, type): + server = server(host=host, port=port, **kargs) + if not isinstance(server, ServerAdapter): + raise ValueError("Unknown or unsupported server: %r" % server) + + server.quiet = server.quiet or quiet + if not server.quiet: + _stderr("Bottle v%s server starting up (using %s)...\n" % (__version__, repr(server))) + _stderr("Listening on http://%s:%d/\n" % (server.host, server.port)) + _stderr("Hit Ctrl-C to quit.\n\n") + + if reloader: + lockfile = os.environ.get('BOTTLE_LOCKFILE') + bgcheck = FileCheckerThread(lockfile, interval) + with bgcheck: + server.run(app) + if bgcheck.status == 'reload': + sys.exit(3) + else: + server.run(app) + except KeyboardInterrupt: + pass + except (SystemExit, MemoryError): + raise + except: + if not reloader: raise + if not getattr(server, 'quiet', quiet): + print_exc() + time.sleep(interval) + sys.exit(3) + + + +class FileCheckerThread(threading.Thread): + """ Interrupt main-thread as soon as a changed module file is detected, + the lockfile gets deleted or gets to old. """ + + def __init__(self, lockfile, interval): + threading.Thread.__init__(self) + self.daemon = True + self.lockfile, self.interval = lockfile, interval + #: Is one of 'reload', 'error' or 'exit' + self.status = None + + def run(self): + exists = os.path.exists + mtime = lambda p: os.stat(p).st_mtime + files = dict() + + for module in list(sys.modules.values()): + path = getattr(module, '__file__', '') + if path[-4:] in ('.pyo', '.pyc'): path = path[:-1] + if path and exists(path): files[path] = mtime(path) + + while not self.status: + if not exists(self.lockfile)\ + or mtime(self.lockfile) < time.time() - self.interval - 5: + self.status = 'error' + thread.interrupt_main() + for path, lmtime in list(files.items()): + if not exists(path) or mtime(path) > lmtime: + self.status = 'reload' + thread.interrupt_main() + break + time.sleep(self.interval) + + def __enter__(self): + self.start() + + def __exit__(self, exc_type, *_): + if not self.status: self.status = 'exit' # silent exit + self.join() + return exc_type is not None and issubclass(exc_type, KeyboardInterrupt) + + + + + +############################################################################### +# Template Adapters ############################################################ +############################################################################### + + +class TemplateError(HTTPError): + def __init__(self, message): + HTTPError.__init__(self, 500, message) + + +class BaseTemplate(object): + """ Base class and minimal API for template adapters """ + extensions = ['tpl','html','thtml','stpl'] + settings = {} #used in prepare() + defaults = {} #used in render() + + def __init__(self, source=None, name=None, lookup=None, encoding='utf8', **settings): + """ Create a new template. + If the source parameter (str or buffer) is missing, the name argument + is used to guess a template filename. Subclasses can assume that + self.source and/or self.filename are set. Both are strings. + The lookup, encoding and settings parameters are stored as instance + variables. + The lookup parameter stores a list containing directory paths. + The encoding parameter should be used to decode byte strings or files. + The settings parameter contains a dict for engine-specific settings. + """ + self.name = name + self.source = source.read() if hasattr(source, 'read') else source + self.filename = source.filename if hasattr(source, 'filename') else None + self.lookup = [os.path.abspath(x) for x in lookup] if lookup else [] + self.encoding = encoding + self.settings = self.settings.copy() # Copy from class variable + self.settings.update(settings) # Apply + if not self.source and self.name: + self.filename = self.search(self.name, self.lookup) + if not self.filename: + raise TemplateError('Template %s not found.' % repr(name)) + if not self.source and not self.filename: + raise TemplateError('No template specified.') + self.prepare(**self.settings) + + @classmethod + def search(cls, name, lookup=None): + """ Search name in all directories specified in lookup. + First without, then with common extensions. Return first hit. """ + if not lookup: + depr('The template lookup path list should not be empty.', True) #0.12 + lookup = ['.'] + + if os.path.isabs(name) and os.path.isfile(name): + depr('Absolute template path names are deprecated.', True) #0.12 + return os.path.abspath(name) + + for spath in lookup: + spath = os.path.abspath(spath) + os.sep + fname = os.path.abspath(os.path.join(spath, name)) + if not fname.startswith(spath): continue + if os.path.isfile(fname): return fname + for ext in cls.extensions: + if os.path.isfile('%s.%s' % (fname, ext)): + return '%s.%s' % (fname, ext) + + @classmethod + def global_config(cls, key, *args): + """ This reads or sets the global settings stored in class.settings. """ + if args: + cls.settings = cls.settings.copy() # Make settings local to class + cls.settings[key] = args[0] + else: + return cls.settings[key] + + def prepare(self, **options): + """ Run preparations (parsing, caching, ...). + It should be possible to call this again to refresh a template or to + update settings. + """ + raise NotImplementedError + + def render(self, *args, **kwargs): + """ Render the template with the specified local variables and return + a single byte or unicode string. If it is a byte string, the encoding + must match self.encoding. This method must be thread-safe! + Local variables may be provided in dictionaries (args) + or directly, as keywords (kwargs). + """ + raise NotImplementedError + + +class MakoTemplate(BaseTemplate): + def prepare(self, **options): + from mako.template import Template + from mako.lookup import TemplateLookup + options.update({'input_encoding':self.encoding}) + options.setdefault('format_exceptions', bool(DEBUG)) + lookup = TemplateLookup(directories=self.lookup, **options) + if self.source: + self.tpl = Template(self.source, lookup=lookup, **options) + else: + self.tpl = Template(uri=self.name, filename=self.filename, lookup=lookup, **options) + + def render(self, *args, **kwargs): + for dictarg in args: kwargs.update(dictarg) + _defaults = self.defaults.copy() + _defaults.update(kwargs) + return self.tpl.render(**_defaults) + + +class CheetahTemplate(BaseTemplate): + def prepare(self, **options): + from Cheetah.Template import Template + self.context = threading.local() + self.context.vars = {} + options['searchList'] = [self.context.vars] + if self.source: + self.tpl = Template(source=self.source, **options) + else: + self.tpl = Template(file=self.filename, **options) + + def render(self, *args, **kwargs): + for dictarg in args: kwargs.update(dictarg) + self.context.vars.update(self.defaults) + self.context.vars.update(kwargs) + out = str(self.tpl) + self.context.vars.clear() + return out + + +class Jinja2Template(BaseTemplate): + def prepare(self, filters=None, tests=None, globals={}, **kwargs): + from jinja2 import Environment, FunctionLoader + self.env = Environment(loader=FunctionLoader(self.loader), **kwargs) + if filters: self.env.filters.update(filters) + if tests: self.env.tests.update(tests) + if globals: self.env.globals.update(globals) + if self.source: + self.tpl = self.env.from_string(self.source) + else: + self.tpl = self.env.get_template(self.filename) + + def render(self, *args, **kwargs): + for dictarg in args: kwargs.update(dictarg) + _defaults = self.defaults.copy() + _defaults.update(kwargs) + return self.tpl.render(**_defaults) + + def loader(self, name): + fname = self.search(name, self.lookup) + if not fname: return + with open(fname, "rb") as f: + return f.read().decode(self.encoding) + + +class SimpleTemplate(BaseTemplate): + + def prepare(self, escape_func=html_escape, noescape=False, syntax=None, **ka): + self.cache = {} + enc = self.encoding + self._str = lambda x: touni(x, enc) + self._escape = lambda x: escape_func(touni(x, enc)) + self.syntax = syntax + if noescape: + self._str, self._escape = self._escape, self._str + + @cached_property + def co(self): + return compile(self.code, self.filename or '', 'exec') + + @cached_property + def code(self): + source = self.source + if not source: + with open(self.filename, 'rb') as f: + source = f.read() + try: + source, encoding = touni(source), 'utf8' + except UnicodeError: + depr('Template encodings other than utf8 are no longer supported.') #0.11 + source, encoding = touni(source, 'latin1'), 'latin1' + parser = StplParser(source, encoding=encoding, syntax=self.syntax) + code = parser.translate() + self.encoding = parser.encoding + return code + + def _rebase(self, _env, _name=None, **kwargs): + _env['_rebase'] = (_name, kwargs) + + def _include(self, _env, _name=None, **kwargs): + env = _env.copy() + env.update(kwargs) + if _name not in self.cache: + self.cache[_name] = self.__class__(name=_name, lookup=self.lookup) + return self.cache[_name].execute(env['_stdout'], env) + + def execute(self, _stdout, kwargs): + env = self.defaults.copy() + env.update(kwargs) + env.update({'_stdout': _stdout, '_printlist': _stdout.extend, + 'include': functools.partial(self._include, env), + 'rebase': functools.partial(self._rebase, env), '_rebase': None, + '_str': self._str, '_escape': self._escape, 'get': env.get, + 'setdefault': env.setdefault, 'defined': env.__contains__ }) + eval(self.co, env) + if env.get('_rebase'): + subtpl, rargs = env.pop('_rebase') + rargs['base'] = ''.join(_stdout) #copy stdout + del _stdout[:] # clear stdout + return self._include(env, subtpl, **rargs) + return env + + def render(self, *args, **kwargs): + """ Render the template using keyword arguments as local variables. """ + env = {}; stdout = [] + for dictarg in args: env.update(dictarg) + env.update(kwargs) + self.execute(stdout, env) + return ''.join(stdout) + + +class StplSyntaxError(TemplateError): pass + + +class StplParser(object): + """ Parser for stpl templates. """ + _re_cache = {} #: Cache for compiled re patterns + # This huge pile of voodoo magic splits python code into 8 different tokens. + # 1: All kinds of python strings (trust me, it works) + _re_tok = '((?m)[urbURB]?(?:\'\'(?!\')|""(?!")|\'{6}|"{6}' \ + '|\'(?:[^\\\\\']|\\\\.)+?\'|"(?:[^\\\\"]|\\\\.)+?"' \ + '|\'{3}(?:[^\\\\]|\\\\.|\\n)+?\'{3}' \ + '|"{3}(?:[^\\\\]|\\\\.|\\n)+?"{3}))' + _re_inl = _re_tok.replace('|\\n','') # We re-use this string pattern later + # 2: Comments (until end of line, but not the newline itself) + _re_tok += '|(#.*)' + # 3,4: Keywords that start or continue a python block (only start of line) + _re_tok += '|^([ \\t]*(?:if|for|while|with|try|def|class)\\b)' \ + '|^([ \\t]*(?:elif|else|except|finally)\\b)' + # 5: Our special 'end' keyword (but only if it stands alone) + _re_tok += '|((?:^|;)[ \\t]*end[ \\t]*(?=(?:%(block_close)s[ \\t]*)?\\r?$|;|#))' + # 6: A customizable end-of-code-block template token (only end of line) + _re_tok += '|(%(block_close)s[ \\t]*(?=$))' + # 7: And finally, a single newline. The 8th token is 'everything else' + _re_tok += '|(\\r?\\n)' + # Match the start tokens of code areas in a template + _re_split = '(?m)^[ \t]*(\\\\?)((%(line_start)s)|(%(block_start)s))' + # Match inline statements (may contain python strings) + _re_inl = '%%(inline_start)s((?:%s|[^\'"\n]+?)*?)%%(inline_end)s' % _re_inl + + default_syntax = '<% %> % {{ }}' + + def __init__(self, source, syntax=None, encoding='utf8'): + self.source, self.encoding = touni(source, encoding), encoding + self.set_syntax(syntax or self.default_syntax) + self.code_buffer, self.text_buffer = [], [] + self.lineno, self.offset = 1, 0 + self.indent, self.indent_mod = 0, 0 + + def get_syntax(self): + """ Tokens as a space separated string (default: <% %> % {{ }}) """ + return self._syntax + + def set_syntax(self, syntax): + self._syntax = syntax + self._tokens = syntax.split() + if not syntax in self._re_cache: + names = 'block_start block_close line_start inline_start inline_end' + etokens = map(re.escape, self._tokens) + pattern_vars = dict(zip(names.split(), etokens)) + patterns = (self._re_split, self._re_tok, self._re_inl) + patterns = [re.compile(p%pattern_vars) for p in patterns] + self._re_cache[syntax] = patterns + self.re_split, self.re_tok, self.re_inl = self._re_cache[syntax] + + syntax = property(get_syntax, set_syntax) + + def translate(self): + if self.offset: raise RuntimeError('Parser is a one time instance.') + while True: + m = self.re_split.search(self.source[self.offset:]) + if m: + text = self.source[self.offset:self.offset+m.start()] + self.text_buffer.append(text) + offs = self.offset + self.offset += m.end() + if m.group(1): # Escape syntax + line, sep, _ = self.source[self.offset:].partition('\n') + self.text_buffer.append(self.source[offs+m.start():offs+m.start(1)]+m.group(2)+line+sep) + self.offset += len(line+sep) + continue + self.flush_text() + self.read_code(multiline=bool(m.group(4))) + else: break + self.text_buffer.append(self.source[self.offset:]) + self.flush_text() + return ''.join(self.code_buffer) + + def read_code(self, multiline): + code_line, comment = '', '' + while True: + m = self.re_tok.search(self.source[self.offset:]) + if not m: + code_line += self.source[self.offset:] + self.offset = len(self.source) + self.write_code(code_line.strip(), comment) + return + code_line += self.source[self.offset:self.offset+m.start()] + self.offset += m.end() + _str, _com, _blk1, _blk2, _end, _cend, _nl = m.groups() + if code_line and (_blk1 or _blk2): # a if b else c + code_line += _blk1 or _blk2 + continue + if _str: # Python string + code_line += _str + elif _com: # Python comment (up to EOL) + comment = _com + if multiline and _com.strip().endswith(self._tokens[1]): + multiline = False # Allow end-of-block in comments + elif _blk1: # Start-block keyword (if/for/while/def/try/...) + code_line, self.indent_mod = _blk1, -1 + self.indent += 1 + elif _blk2: # Continue-block keyword (else/elif/except/...) + code_line, self.indent_mod = _blk2, -1 + elif _end: # The non-standard 'end'-keyword (ends a block) + self.indent -= 1 + elif _cend: # The end-code-block template token (usually '%>') + if multiline: multiline = False + else: code_line += _cend + else: # \n + self.write_code(code_line.strip(), comment) + self.lineno += 1 + code_line, comment, self.indent_mod = '', '', 0 + if not multiline: + break + + def flush_text(self): + text = ''.join(self.text_buffer) + del self.text_buffer[:] + if not text: return + parts, pos, nl = [], 0, '\\\n'+' '*self.indent + for m in self.re_inl.finditer(text): + prefix, pos = text[pos:m.start()], m.end() + if prefix: + parts.append(nl.join(map(repr, prefix.splitlines(True)))) + if prefix.endswith('\n'): parts[-1] += nl + parts.append(self.process_inline(m.group(1).strip())) + if pos < len(text): + prefix = text[pos:] + lines = prefix.splitlines(True) + if lines[-1].endswith('\\\\\n'): lines[-1] = lines[-1][:-3] + elif lines[-1].endswith('\\\\\r\n'): lines[-1] = lines[-1][:-4] + parts.append(nl.join(map(repr, lines))) + code = '_printlist((%s,))' % ', '.join(parts) + self.lineno += code.count('\n')+1 + self.write_code(code) + + @staticmethod + def process_inline(chunk): + if chunk[0] == '!': return '_str(%s)' % chunk[1:] + return '_escape(%s)' % chunk + + def write_code(self, line, comment=''): + code = ' ' * (self.indent+self.indent_mod) + code += line.lstrip() + comment + '\n' + self.code_buffer.append(code) + + +def template(*args, **kwargs): + """ + Get a rendered template as a string iterator. + You can use a name, a filename or a template string as first parameter. + Template rendering arguments can be passed as dictionaries + or directly (as keyword arguments). + """ + tpl = args[0] if args else None + adapter = kwargs.pop('template_adapter', SimpleTemplate) + lookup = kwargs.pop('template_lookup', TEMPLATE_PATH) + tplid = (id(lookup), tpl) + if tplid not in TEMPLATES or DEBUG: + settings = kwargs.pop('template_settings', {}) + if isinstance(tpl, adapter): + TEMPLATES[tplid] = tpl + if settings: TEMPLATES[tplid].prepare(**settings) + elif "\n" in tpl or "{" in tpl or "%" in tpl or '$' in tpl: + TEMPLATES[tplid] = adapter(source=tpl, lookup=lookup, **settings) + else: + TEMPLATES[tplid] = adapter(name=tpl, lookup=lookup, **settings) + if not TEMPLATES[tplid]: + abort(500, 'Template (%s) not found' % tpl) + for dictarg in args[1:]: kwargs.update(dictarg) + return TEMPLATES[tplid].render(kwargs) + +mako_template = functools.partial(template, template_adapter=MakoTemplate) +cheetah_template = functools.partial(template, template_adapter=CheetahTemplate) +jinja2_template = functools.partial(template, template_adapter=Jinja2Template) + + +def view(tpl_name, **defaults): + """ Decorator: renders a template for a handler. + The handler can control its behavior like that: + + - return a dict of template vars to fill out the template + - return something other than a dict and the view decorator will not + process the template, but return the handler result as is. + This includes returning a HTTPResponse(dict) to get, + for instance, JSON with autojson or other castfilters. + """ + def decorator(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + result = func(*args, **kwargs) + if isinstance(result, (dict, DictMixin)): + tplvars = defaults.copy() + tplvars.update(result) + return template(tpl_name, **tplvars) + elif result is None: + return template(tpl_name, defaults) + return result + return wrapper + return decorator + +mako_view = functools.partial(view, template_adapter=MakoTemplate) +cheetah_view = functools.partial(view, template_adapter=CheetahTemplate) +jinja2_view = functools.partial(view, template_adapter=Jinja2Template) + + + + + + +############################################################################### +# Constants and Globals ######################################################## +############################################################################### + + +TEMPLATE_PATH = ['./', './views/'] +TEMPLATES = {} +DEBUG = False +NORUN = False # If set, run() does nothing. Used by load_app() + +#: A dict to map HTTP status codes (e.g. 404) to phrases (e.g. 'Not Found') +HTTP_CODES = httplib.responses +HTTP_CODES[418] = "I'm a teapot" # RFC 2324 +HTTP_CODES[428] = "Precondition Required" +HTTP_CODES[429] = "Too Many Requests" +HTTP_CODES[431] = "Request Header Fields Too Large" +HTTP_CODES[511] = "Network Authentication Required" +_HTTP_STATUS_LINES = dict((k, '%d %s'%(k,v)) for (k,v) in HTTP_CODES.items()) + +#: The default template used for error pages. Override with @error() +ERROR_PAGE_TEMPLATE = """ +%%try: + %%from %s import DEBUG, request + + + + Error: {{e.status}} + + + +

Error: {{e.status}}

+

Sorry, the requested URL {{repr(request.url)}} + caused an error:

+
{{e.body}}
+ %%if DEBUG and e.exception: +

Exception:

+
{{repr(e.exception)}}
+ %%end + %%if DEBUG and e.traceback: +

Traceback:

+
{{e.traceback}}
+ %%end + + +%%except ImportError: + ImportError: Could not generate the error page. Please add bottle to + the import path. +%%end +""" % __name__ + +#: A thread-safe instance of :class:`LocalRequest`. If accessed from within a +#: request callback, this instance always refers to the *current* request +#: (even on a multithreaded server). +request = LocalRequest() + +#: A thread-safe instance of :class:`LocalResponse`. It is used to change the +#: HTTP response for the *current* request. +response = LocalResponse() + +#: A thread-safe namespace. Not used by Bottle. +local = threading.local() + +# Initialize app stack (create first empty Bottle app) +# BC: 0.6.4 and needed for run() +app = default_app = AppStack() +app.push() + +#: A virtual package that redirects import statements. +#: Example: ``import bottle.ext.sqlite`` actually imports `bottle_sqlite`. +ext = _ImportRedirect('bottle.ext' if __name__ == '__main__' else __name__+".ext", 'bottle_%s').module + +if __name__ == '__main__': + opt, args, parser = _cmd_options, _cmd_args, _cmd_parser + if opt.version: + _stdout('Bottle %s\n'%__version__) + sys.exit(0) + if not args: + parser.print_help() + _stderr('\nError: No application entry point specified.\n') + sys.exit(1) + + sys.path.insert(0, '.') + sys.modules.setdefault('bottle', sys.modules['__main__']) + + host, port = (opt.bind or 'localhost'), 8080 + if ':' in host and host.rfind(']') < host.rfind(':'): + host, port = host.rsplit(':', 1) + host = host.strip('[]') + + run(args[0], host=host, port=int(port), server=opt.server, + reloader=opt.reload, plugins=opt.plugin, debug=opt.debug) + + + + +# THE END diff --git a/CitizenWatt-Base/bottle_sqlalchemy.py b/CitizenWatt-Base/bottle_sqlalchemy.py new file mode 100644 index 0000000..26a4175 --- /dev/null +++ b/CitizenWatt-Base/bottle_sqlalchemy.py @@ -0,0 +1,163 @@ +''' +This bottle-sqlalchemy plugin integrates SQLAlchemy with your Bottle +application. It connects to a database at the beginning of a request, +passes the database handle to the route callback and closes the connection +afterwards. + +The plugin inject an argument to all route callbacks that require a `db` +keyword. + +Usage Example:: + + import bottle + from bottle import HTTPError + from bottle.ext import sqlalchemy + from sqlalchemy import create_engine, Column, Integer, Sequence, String + from sqlalchemy.ext.declarative import declarative_base + + Base = declarative_base() + engine = create_engine('sqlite:///:memory:', echo=True) + + app = bottle.Bottle() + plugin = sqlalchemy.Plugin(engine, Base.metadata, create=True) + app.install(plugin) + + class Entity(Base): + __tablename__ = 'entity' + id = Column(Integer, Sequence('id_seq'), primary_key=True) + name = Column(String(50)) + + def __init__(self, name): + self.name = name + + def __repr__(self): + return "" % (self.id, self.name) + + + @app.get('/:name') + def show(name, db): + entity = db.query(Entity).filter_by(name=name).first() + if entity: + return {'id': entity.id, 'name': entity.name} + return HTTPError(404, 'Entity not found.') + + @app.put('/:name') + def put_name(name, db): + entity = Entity(name) + db.add(entity) + + +It is up to you create engine and metadata, because SQLAlchemy has +a lot of options to do it. The plugin just handles the SQLAlchemy +session. + +Copyright (c) 2011-2012, Iuri de Silvio +License: MIT (see LICENSE for details) +''' + +import inspect + +import bottle +from sqlalchemy.exc import SQLAlchemyError +from sqlalchemy.orm import sessionmaker +from sqlalchemy.orm.scoping import ScopedSession + +# PluginError is defined to bottle >= 0.10 +if not hasattr(bottle, 'PluginError'): + class PluginError(bottle.BottleException): + pass + bottle.PluginError = PluginError + +class SQLAlchemyPlugin(object): + + name = 'sqlalchemy' + api = 2 + + def __init__(self, engine, metadata=None, + keyword='db', commit=True, create=False, use_kwargs=False, create_session=None): + ''' + :param engine: SQLAlchemy engine created with `create_engine` function + :param metadata: SQLAlchemy metadata. It is required only if `create=True` + :param keyword: Keyword used to inject session database in a route + :param create: If it is true, execute `metadata.create_all(engine)` + when plugin is applied + :param commit: If it is true, commit changes after route is executed. + :param use_kwargs: plugin inject session database even if it is not + explicitly defined, using **kwargs argument if defined. + :param create_session: SQLAlchemy session maker created with the + 'sessionmaker' function. Will create its own if undefined. + ''' + self.engine = engine + if create_session is None: + create_session = sessionmaker() + self.create_session = create_session + self.metadata = metadata + self.keyword = keyword + self.create = create + self.commit = commit + self.use_kwargs = use_kwargs + + def setup(self, app): + ''' Make sure that other installed plugins don't affect the same + keyword argument and check if metadata is available.''' + for other in app.plugins: + if not isinstance(other, SQLAlchemyPlugin): + continue + if other.keyword == self.keyword: + raise bottle.PluginError("Found another SQLAlchemy plugin with "\ + "conflicting settings (non-unique keyword).") + elif other.name == self.name: + self.name += '_%s' % self.keyword + if self.create and not self.metadata: + raise bottle.PluginError('Define metadata value to create database.') + + def apply(self, callback, route): + # hack to support bottle v0.9.x + if bottle.__version__.startswith('0.9'): + config = route['config'] + _callback = route['callback'] + else: + config = route.config + _callback = route.callback + + if "sqlalchemy" in config: # support for configuration before `ConfigDict` namespaces + g = lambda key, default: config.get('sqlalchemy', {}).get(key, default) + else: + g = lambda key, default: config.get('sqlalchemy.' + key, default) + + keyword = g('keyword', self.keyword) + create = g('create', self.create) + commit = g('commit', self.commit) + use_kwargs = g('use_kwargs', self.use_kwargs) + + argspec = inspect.getargspec(_callback) + if not ((use_kwargs and argspec.keywords) or keyword in argspec.args): + return callback + + if create: + self.metadata.create_all(self.engine) + + def wrapper(*args, **kwargs): + kwargs[keyword] = session = self.create_session(bind=self.engine) + try: + rv = callback(*args, **kwargs) + if commit: + session.commit() + except (SQLAlchemyError, bottle.HTTPError): + session.rollback() + raise + except bottle.HTTPResponse: + if commit: + session.commit() + raise + finally: + if isinstance(self.create_session, ScopedSession): + self.create_session.remove() + else: + session.close() + return rv + + return wrapper + + +Plugin = SQLAlchemyPlugin diff --git a/CitizenWatt-Base/bottlesession.py b/CitizenWatt-Base/bottlesession.py new file mode 100644 index 0000000..7ba5b68 --- /dev/null +++ b/CitizenWatt-Base/bottlesession.py @@ -0,0 +1,191 @@ +#!/usr/bin/env python +# +# Bottle session manager. See README for full documentation. +# +# Written by: Sean Reifschneider +# +# License: 3-clause BSD + +from __future__ import with_statement + +import bottle +import time + + +def authenticator(session_manager, login_url='/auth/login'): + '''Create an authenticator decorator. + + :param session_manager: A session manager class to be used for storing + and retrieving session data. Probably based on + :class:`BaseSession`. + :param login_url: The URL to redirect to if a login is required. + (default: ``'/auth/login'``). + ''' + def valid_user(login_url=login_url): + def decorator(handler): + import functools + + @functools.wraps(handler) + def check_auth(*args, **kwargs): + try: + data = session_manager.get_session() + if not data['valid']: + raise KeyError('Invalid login') + except (KeyError, TypeError): + bottle.response.set_cookie( + 'validuserloginredirect', + bottle.request.fullpath, path='/', + expires=(int(time.time()) + 3600)) + bottle.redirect(login_url) + + # set environment + if data.get('name'): + bottle.request.environ['REMOTE_USER'] = data['name'] + + return handler(*args, **kwargs) + return check_auth + return decorator + return(valid_user) + + +import pickle +import os +import uuid + + +class BaseSession(object): + '''Base class which implements some of the basic functionality required for + session managers. Cannot be used directly. + + :param cookie_expires: Expiration time of session ID cookie, either `None` + if the cookie is not to expire, a number of seconds in the future, + or a datetime object. (default: 30 days) + ''' + def __init__(self, cookie_expires=86400 * 30): + self.cookie_expires = cookie_expires + + def load(self, sessionid): + raise NotImplementedError + + def save(self, sessionid, data): + raise NotImplementedError + + def make_session_id(self): + return str(uuid.uuid4()) + + def allocate_new_session_id(self): + # retry allocating a unique sessionid + for i in range(100): + sessionid = self.make_session_id() + if not self.load(sessionid): + return sessionid + raise ValueError('Unable to allocate unique session') + + def get_session(self): + # get existing or create new session identifier + sessionid = bottle.request.cookies.get('sessionid') + if not sessionid: + sessionid = self.allocate_new_session_id() + bottle.response.set_cookie( + 'sessionid', sessionid, path='/', + expires=(int(time.time()) + self.cookie_expires)) + + # load existing or create new session + data = self.load(sessionid) + if not data: + data = {'sessionid': sessionid, 'valid': False} + self.save(data) + + return data + + +class PickleSession(BaseSession): + '''Class which stores session information in the file-system. + + :param session_dir: Directory that session information is stored in. + (default: ``'/tmp'``). + ''' + def __init__(self, session_dir='/tmp', *args, **kwargs): + super(PickleSession, self).__init__(*args, **kwargs) + self.session_dir = session_dir + + def load(self, sessionid): + filename = os.path.join(self.session_dir, 'session-%s' % sessionid) + if not os.path.exists(filename): + return None + with open(filename, 'rb') as fp: + session = pickle.load(fp) + return session + + def save(self, data): + sessionid = data['sessionid'] + fileName = os.path.join(self.session_dir, 'session-%s' % sessionid) + tmpName = fileName + '.' + str(uuid.uuid4()) + with open(tmpName, 'wb') as fp: + self.session = pickle.dump(data, fp) + os.rename(tmpName, fileName) + + +class CookieSession(BaseSession): + '''Session manager class which stores session in a signed browser cookie. + + :param cookie_name: Name of the cookie to store the session in. + (default: ``session_data``) + :param secret: Secret to be used for "secure cookie". If ``None``, + a random secret will be generated and written to a temporary + file for future use. This may not be suitable for systems which + have untrusted users on it. (default: ``None``) + :param secret_file: File to read the secret from. If ``secret`` is + ``None`` and ``secret_file`` is set, the first line of this file + is read, and stripped, to produce the secret. + ''' + + def __init__( + self, secret=None, secret_file=None, cookie_name='session_data', + *args, **kwargs): + super(CookieSession, self).__init__(*args, **kwargs) + self.cookie_name = cookie_name + + if not secret and secret_file is not None: + with open(secret_file, 'r') as fp: + secret = fp.readline().strip() + + if not secret: + import string + import random + import tempfile + import sys + + tmpfilename = os.path.join( + tempfile.gettempdir(), + '%s.secret' % os.path.basename(sys.argv[0])) + + if os.path.exists(tmpfilename): + with open(tmpfilename, 'r') as fp: + secret = fp.readline().strip() + else: + # save off a secret to a tmp file + secret = ''.join([ + random.choice(string.ascii_letters) + for x in range(32)]) + + old_umask = os.umask(0o77) + with open(tmpfilename, 'w') as fp: + fp.write(secret) + os.umask(old_umask) + + self.secret = secret + + def load(self, sessionid): + cookie = bottle.request.get_cookie( + self.cookie_name, + secret=self.secret) + if cookie is None: + return {} + return pickle.loads(cookie) + + def save(self, data): + bottle.response.set_cookie( + self.cookie_name, pickle.dumps(data), secret=self.secret, + path='/', expires=int(time.time()) + self.cookie_expires, + secure=True, httponly=True) diff --git a/CitizenWatt-Base/libcitizenwatt/__init__.py b/CitizenWatt-Base/libcitizenwatt/__init__.py new file mode 100644 index 0000000..aec8850 --- /dev/null +++ b/CitizenWatt-Base/libcitizenwatt/__init__.py @@ -0,0 +1,2 @@ +#!/usr/bin/env python2 +# -*- coding: utf-8 -*- diff --git a/CitizenWatt-Base/libcitizenwatt/cache.py b/CitizenWatt-Base/libcitizenwatt/cache.py new file mode 100644 index 0000000..3007471 --- /dev/null +++ b/CitizenWatt-Base/libcitizenwatt/cache.py @@ -0,0 +1,316 @@ +#!/usr/bin/env python3 + +import bisect +import datetime +import json +import numpy +import redis + +from libcitizenwatt import database +from libcitizenwatt import tools +from sqlalchemy import asc, desc +from libcitizenwatt.config import Config + + +config = Config() + + +def do_cache_ids(sensor, watt_euros, id1, id2, db, force_refresh=False): + """ + Computes the cache (if needed) for the API call + /api//get//by_id// + + Returns the stored (or computed) data or None if parameters are invalid. + """ + r = redis.Redis(decode_responses=True) + if not force_refresh: + data = r.get(watt_euros + "_" + str(sensor) + "_" + "by_id" + "_" + + str(id1) + "_" + str(id2)) + if data: + # If found in cache, return it + return json.loads(data) + + if id1 >= 0 and id2 >= 0 and id2 >= id1: + data = (db.query(database.Measures) + .filter(database.Measures.sensor_id == sensor, + database.Measures.id >= id1, + database.Measures.id < id2) + .order_by(asc(database.Measures.timestamp)) + .all()) + elif id1 <= 0 and id2 <= 0 and id2 >= id1: + data = (db.query(database.Measures) + .filter_by(sensor_id=sensor) + .order_by(desc(database.Measures.timestamp)) + .slice(-id2, -id1) + .all()) + data.reverse() + else: + return None + + if not data: + data = None + else: + time1 = data[0].timestamp + time2 = data[-1].timestamp + if watt_euros == 'kwatthours' or watt_euros == 'euros': + data = tools.energy(data) + if watt_euros == 'euros': + if data["night_rate"] != 0: + night_rate = tools.watt_euros(0, + 'night', + data['night_rate'], + db) + else: + night_rate = 0 + if data["day_rate"] != 0: + day_rate = tools.watt_euros(0, + 'day', + data['day_rate'], + db) + else: + day_rate = 0 + data = {"value": night_rate + day_rate} + else: + data = tools.to_dict(data) + + # Store in cache + r.set(watt_euros + "_" + str(sensor) + "_" + "by_id" + "_" + + str(id1) + "_" + str(id2), + json.dumps(data), + time2 - time1) + + return data + + +def do_cache_group_id(sensor, watt_euros, id1, id2, step, db, + timestep=config.get("default_timestep"), + force_refresh=False): + """ + Computes the cache (if needed) for the API call + /api//get//by_id/// + + Returns the stored (or computed) data. + """ + r = redis.Redis(decode_responses=True) + if not force_refresh: + data = r.get(watt_euros + "_" + str(sensor) + "_" + "by_id" + "_" + + str(id1) + "_" + str(id2) + "_" + + str(step) + "_" + str(timestep)) + if data: + # If found in cache, return it + return json.loads(data) + + steps = [i for i in range(id1, id2, step)] + steps.append(id2) + + if id1 >= 0 and id2 >= 0 and id2 >= id1: + data = (db.query(database.Measures) + .filter(database.Measures.sensor_id == sensor, + database.Measures.id >= id1, + database.Measures.id < id2) + .order_by(asc(database.Measures.timestamp)) + .all()) + elif id1 <= 0 and id2 <= 0 and id2 >= id1: + data = (db.query(database.Measures) + .filter_by(sensor_id=sensor) + .order_by(desc(database.Measures.timestamp)) + .slice(-id2, -id1) + .all()) + data.reverse() + else: + raise ValueError + + time2 = None + if not data: + data = [None for i in range(len(steps) - 1)] + else: + time1 = data[0].timestamp + time2 = data[-1].timestamp + data_dict = tools.to_dict(data) + tmp = [[] for i in range(len(steps) - 1)] + for i in data_dict: + tmp[bisect.bisect_left(steps, i["id"]) - 1].append(i) + + data = [] + for i in tmp: + if len(i) == 0: + data.append(None) + continue + + energy = tools.energy(i) + if watt_euros == "watts": + tmp_data = {"value": energy["value"] / (step * timestep) * 1000 * 3600, + "day_rate": energy["day_rate"] / (step * timestep) * 1000 * 3600, + "night_rate": energy["night_rate"] / (step * timestep) * 1000 * 3600} + elif watt_euros == 'kwatthours': + tmp_data = energy + elif watt_euros == 'euros': + if energy["night_rate"] != 0: + night_rate = tools.watt_euros(0, + 'night', + energy['night_rate'], + db) + else: + night_rate = 0 + if energy["day_rate"] != 0: + day_rate = tools.watt_euros(0, + 'day', + energy['day_rate'], + db) + else: + day_rate = 0 + tmp_data = {"value": night_rate + day_rate} + data.append(tmp_data) + if len(data) == 0: + data = None + if time2 is not None: + # Store in cache + if time2 < datetime.datetime.now().timestamp(): + # If new measures are to come, short lifetime (basically timestep) + r.set(watt_euros + "_" + str(sensor) + "_" + "by_id" + "_" + + str(id1) + "_" + str(id2) + "_" + + str(step) + "_" + str(timestep), + json.dumps(data), + timestep) + else: + # Else, store for a greater lifetime (basically time2 - time1) + r.set(watt_euros + "_" + str(sensor) + "_" + "by_id" + "_" + + str(id1) + "_" + str(id2) + "_" + + str(step) + "_" + str(timestep), + json.dumps(data), + time2 - time1) + + return data + + +def do_cache_times(sensor, watt_euros, time1, time2, db, force_refresh=False): + """ + Computes the cache (if needed) for the API call + /api//get//by_time// + Returns the stored (or computed) data. + """ + r = redis.Redis(decode_responses=True) + if not force_refresh: + data = r.get(watt_euros + "_" + str(sensor) + "_" + "by_time" + "_" + + str(time1) + "_" + str(time2)) + if data: + # If found in cache, return it + return json.loads(data) + + data = (db.query(database.Measures) + .filter(database.Measures.sensor_id == sensor, + database.Measures.timestamp >= time1, + database.Measures.timestamp < time2) + .order_by(asc(database.Measures.timestamp)) + .all()) + + if not data: + data = None + else: + if watt_euros == "kwatthours" or watt_euros == "euros": + data = tools.energy(data) + if watt_euros == "euros": + data = {"value": (tools.watt_euros(0, + 'night', + data['night_rate'], + db) + + tools.watt_euros(0, + 'day', + data['day_rate'], + db))} + + else: + data = tools.to_dict(data) + + # Store in cache + r.set(watt_euros + "_" + str(sensor) + "_" + "by_id" + "_" + + str(time1) + "_" + str(time2), + json.dumps(data), + int(time2) - int(time1)) + + return data + + +def do_cache_group_timestamp(sensor, watt_euros, time1, time2, step, db, + force_refresh=True): + """ + Computes the cache (if needed) for the API call + /api//get//by_time/// + + Returns the stored (or computed) data. + """ + r = redis.Redis(decode_responses=True) + if not force_refresh: + data = r.get(watt_euros + "_" + str(sensor) + "_" + "by_time" + "_" + + str(time1) + "_" + str(time2) + "_" + str(step)) + if data: + # If found in cache, return it + return json.loads(data) + + steps = [i for i in numpy.arange(time1, time2, step)] + steps.append(time2) + + data = (db.query(database.Measures) + .filter(database.Measures.sensor_id == sensor, + database.Measures.timestamp + .between(time1, time2)) + .order_by(asc(database.Measures.timestamp)) + .all()) + + if not data: + data = [None for i in range(len(steps) - 1)] + else: + tmp = [[] for i in range(len(steps) - 1)] + for i in data: + index = bisect.bisect_left(steps, i.timestamp) + if index > 0: + index -= 1 + tmp[index].append(i) + + data = [] + for i in tmp: + if len(i) == 0: + data.append(None) + continue + + energy = tools.energy(i) + if watt_euros == "watts": + tmp_data = {"value": energy["value"] / step * 1000 * 3600, + "day_rate": energy["day_rate"] / step * 1000 * 3600, + "night_rate": energy["night_rate"] / step * 1000 * 3600} + elif watt_euros == 'kwatthours': + tmp_data = energy + elif watt_euros == 'euros': + if energy["night_rate"] != 0: + night_rate = tools.watt_euros(0, + 'night', + energy['night_rate'], + db) + else: + night_rate = 0 + if energy["day_rate"] != 0: + day_rate = tools.watt_euros(0, + 'day', + energy['day_rate'], + db) + else: + day_rate = 0 + tmp_data = {"value": night_rate + day_rate} + data.append(tmp_data) + if len(data) == 0: + data = None + # Store in cache + if time2 < datetime.datetime.now().timestamp(): + # If new measures are to come, short lifetime (basically timestep) + r.setex(watt_euros + "_" + str(sensor) + "_" + "by_time" + "_" + + str(time1) + "_" + str(time2) + "_" + str(step), + json.dumps(data), + int(step)) + else: + # Else, store for a greater lifetime (basically time2 - time1) + r.setex(watt_euros + "_" + str(sensor) + "_" + "by_time" + "_" + + str(time1) + "_" + str(time2) + "_" + str(step), + json.dumps(data), + int(time2 - time1)) + + return data diff --git a/CitizenWatt-Base/libcitizenwatt/config.py b/CitizenWatt-Base/libcitizenwatt/config.py new file mode 100644 index 0000000..b550d13 --- /dev/null +++ b/CitizenWatt-Base/libcitizenwatt/config.py @@ -0,0 +1,80 @@ +#!/usr/bin/env python3 +import crypt +import errno +import json +import os +import sys +from libcitizenwatt import tools + + +def make_sure_path_exists(path): + try: + os.makedirs(path) + return False + except OSError as exception: + if exception.errno != errno.EEXIST: + raise + else: + return True + + +class Config(): + def __init__(self, base_config_path="~/.config/citizenwatt/"): + self.config_path = os.path.expanduser(base_config_path) + self.config = {} + self.load() + + def as_dict(self): + return self.config + + def get(self, param): + return self.config.get(param, False) + + def set(self, param, value): + self.config[param] = value + + def initialize(self): + self.set("max_returned_values", 500) + self.set("database_type", "postgresql+psycopg2") + self.set("username", "citizenwatt") + self.set("password", "citizenwatt") + self.set("database", "citizenwatt") + self.set("host", "localhost") + self.set("debug", False) + self.set("url_energy_providers", + "http://dev.citizenwatt.paris/providers/electricity_providers.json") + self.set("salt", crypt.mksalt()) + self.set("named_fifo", "/tmp/sensor") + self.set("default_timestep", 8) + self.set("port", 8080) + self.set("autoreload", False) + self.save() + + def load(self): + try: + folder_exists = make_sure_path_exists(self.config_path) + if(folder_exists and + os.path.isfile(self.config_path + "config.json")): + initialized = True + else: + initialized = False + except OSError: + tools.warning("Unable to create ~/.config folder.") + sys.exit(1) + if not initialized: + self.initialize() + else: + try: + with open(self.config_path + "config.json", 'r') as fh: + self.config = json.load(fh) + except (ValueError, IOError): + tools.warning("Config file could not be read.") + sys.exit(1) + + def save(self): + try: + with open(self.config_path + "config.json", 'w') as fh: + fh.write(json.dumps(self.config)) + except IOError: + tools.warning("Could not write config file.") + sys.exit(1) diff --git a/CitizenWatt-Base/libcitizenwatt/database.py b/CitizenWatt-Base/libcitizenwatt/database.py new file mode 100644 index 0000000..770ea77 --- /dev/null +++ b/CitizenWatt-Base/libcitizenwatt/database.py @@ -0,0 +1,65 @@ +#!/usr/bin/env python3 +from sqlalchemy import Column, Float +from sqlalchemy import ForeignKey, Integer, Text, VARCHAR +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import relationship + + +Base = declarative_base() + + +class Sensor(Base): + __tablename__ = "sensors" + id = Column(Integer, primary_key=True) + name = Column(VARCHAR(255), unique=True) + type_id = Column(Integer, + ForeignKey("measures_types.id", ondelete="CASCADE"), + nullable=False) + measures = relationship("Measures", passive_deletes=True) + last_timer = Column(Integer) + type = relationship("MeasureType", lazy="joined") + aes_key = Column(VARCHAR(255)) + base_address = Column(VARCHAR(30)) + + +class Measures(Base): + __tablename__ = "measures" + id = Column(Integer, primary_key=True) + sensor_id = Column(Integer, + ForeignKey("sensors.id", ondelete="CASCADE"), + nullable=False) + value = Column(Float) + timestamp = Column(Integer, index=True) + night_rate = Column(Integer) # Boolean, 1 if night_rate + + +class Provider(Base): + __tablename__ = "providers" + id = Column(Integer, primary_key=True) + name = Column(VARCHAR(length=255), unique=True) + type_id = Column(Integer, + ForeignKey("measures_types.id", ondelete="CASCADE"), + nullable=False) + day_slope_watt_euros = Column(Float) + day_constant_watt_euros = Column(Float) + night_slope_watt_euros = Column(Float) + night_constant_watt_euros = Column(Float) + current = Column(Integer) + threshold = Column(Integer) + + +class MeasureType(Base): + __tablename__ = "measures_types" + id = Column(Integer, primary_key=True) + name = Column(VARCHAR(255), unique=True) + + +class User(Base): + __tablename__ = "users" + id = Column(Integer, primary_key=True) + login = Column(VARCHAR(length=255), unique=True) + password = Column(Text) + is_admin = Column(Integer) + # Stored as seconds since beginning of day + start_night_rate = Column(Integer) + end_night_rate = Column(Integer) diff --git a/CitizenWatt-Base/libcitizenwatt/tools.py b/CitizenWatt-Base/libcitizenwatt/tools.py new file mode 100644 index 0000000..4d00ea3 --- /dev/null +++ b/CitizenWatt-Base/libcitizenwatt/tools.py @@ -0,0 +1,108 @@ +#!/usr/bin/env python3 +import numpy +import os +import sys + +from libcitizenwatt import database + + +def warning(*objs): + """Write warnings to stderr""" + print("WARNING: ", *objs, file=sys.stderr) + + +def to_dict(model): + """Returns a JSON representation of an SQLAlchemy-backed object. + + Returns a timestamp for DateTime fields, to be easily JSON serializable. + + TODO : Use runtime inspection API + From https://zato.io/blog/posts/converting-sqlalchemy-objects-to-json.html + """ + if isinstance(model, list): + return [to_dict(i) for i in model] + else: + dict = {} + dict['id'] = getattr(model, 'id') + + for col in model._sa_class_manager.mapper.mapped_table.columns: + if str(col.type) == "TIMESTAMP": + dict[col.name] = getattr(model, col.name).timestamp() + else: + dict[col.name] = getattr(model, col.name) + + return dict + + +def last_day(month, year): + """Returns the last day of month of year .""" + if month in [1, 3, 5, 7, 8, 10, 12]: + return 31 + elif month == 2: + if year % 4 == 0 and (not year % 100 or year % 400): + return 29 + else: + return 28 + else: + return 30 + + +def energy(powers, default_timestep=8): + """Compute the energy associated to a list of measures (in W) + and associated timestamps (in s). + """ + energy = {'night_rate': 0, 'day_rate': 0, 'value': 0} + if len(powers) == 1: + if powers[0].night_rate == 1: + energy["night_rate"] = (powers[0].value / 1000 * + default_timestep / 3600) + else: + energy["day_rate"] = (powers[0].value / 1000 * + default_timestep / 3600) + energy['value'] = energy['day_rate'] + energy['night_rate'] + else: + x = [] + day_rate = [] + night_rate = [] + for i in powers: + x.append(i.timestamp) + if i.night_rate == 1: + night_rate.append(i.value) + day_rate.append(0) + else: + day_rate.append(i.value) + night_rate.append(0) + energy["night_rate"] = numpy.trapz(night_rate, x) / 1000 / 3600 + energy["day_rate"] = numpy.trapz(day_rate, x) / 1000 / 3600 + energy['value'] = energy['day_rate'] + energy['night_rate'] + return energy + + +def watt_euros(energy_provider, tariff, consumption, db): + if energy_provider != 0: + provider = (db.query(database.Provider) + .filter_by(id=energy_provider) + .first()) + else: + provider = (db.query(database.Provider) + .filter_by(current=1) + .first()) + if not provider: + data = None + else: + if tariff == "night": + data = provider.night_slope_watt_euros * consumption + elif tariff == "day": + data = provider.day_slope_watt_euros * consumption + else: + data = None + return data + + +def update_base_address(base_address): + """Update the address of the base stored in + ~/.config/citizenwatt/base_address + """ + path = os.path.expanduser("~/.config/citizenwatt/base_address") + with open(path, "w+") as fh: + fh.write(str(base_address)) diff --git a/CitizenWatt-Base/post_update.sh b/CitizenWatt-Base/post_update.sh new file mode 100755 index 0000000..1a24852 --- /dev/null +++ b/CitizenWatt-Base/post_update.sh @@ -0,0 +1 @@ +#!/bin/sh diff --git a/CitizenWatt-Base/process.py b/CitizenWatt-Base/process.py new file mode 100755 index 0000000..5894156 --- /dev/null +++ b/CitizenWatt-Base/process.py @@ -0,0 +1,109 @@ +#!/usr/bin/env python3 + +import datetime +import json +import os +import stat +import struct +import sys +import time + +from libcitizenwatt import database +from libcitizenwatt import tools +from Crypto.Cipher import AES +from libcitizenwatt.config import Config +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + + +def get_rate_type(db): + """Returns "day" or "night" according to current time + """ + user = db.query(database.User).filter_by(is_admin=1).first() + now = datetime.datetime.now() + now = 3600 * now.hour + 60 * now.minute + if user is None: + return -1 + elif user.end_night_rate > user.start_night_rate: + if now > user.start_night_rate and now < user.end_night_rate: + return 1 + else: + return 0 + else: + if now > user.start_night_rate or now < user.end_night_rate: + return 1 + else: + return 0 + +def get_cw_sensor(): + """Returns the citizenwatt sensor object or None""" + db = create_session() + sensor = (db.query(database.Sensor) + .filter_by(name="CitizenWatt") + .first()) + db.close() + return sensor + + +# Configuration +config = Config() + +# DB initialization +database_url = (config.get("database_type") + "://" + config.get("username") + + ":" + config.get("password") + "@" + config.get("host") + "/" + + config.get("database")) +engine = create_engine(database_url, echo=config.get("debug")) +create_session = sessionmaker(bind=engine) +database.Base.metadata.create_all(engine) + +sensor = get_cw_sensor() +while not sensor or not sensor.aes_key: + tools.warning("Install is not complete ! " + + "Visit http://citizenwatt.local first.") + time.sleep(1) + sensor = get_cw_sensor() + +key = json.loads(sensor.aes_key) +key = struct.pack("<16B", *key) + + +try: + assert(stat.S_ISFIFO(os.stat(config.get("named_fifo")).st_mode)) +except (AssertionError, FileNotFoundError): + sys.exit("Unable to open fifo " + config.get("named_fifo") + ".") + +try: + with open(config.get("named_fifo"), 'rb') as fifo: + while True: + measure = fifo.read(16) + print("New encrypted packet:" + str(measure)) + + decryptor = AES.new(key, AES.MODE_ECB) + measure = decryptor.decrypt(measure) + measure = struct.unpack(" 0 and + sensor.last_timer < 4233600000 and + timer < sensor.last_timer): + tools.warning("Invalid timer in the last packet, skipping it") + else: + db = create_session() + measure_db = database.Measures(sensor_id=sensor.id, + value=power, + timestamp=datetime.datetime.now().timestamp(), + night_rate=get_rate_type(db)) + db.add(measure_db) + sensor.last_timer = timer + (db.query(database.Sensor) + .filter_by(name="CitizenWatt") + .update({"last_timer": sensor.last_timer})) + db.commit() + print("Saved successfully.") +except KeyboardInterrupt: + pass diff --git a/CitizenWatt-Base/receive.cpp b/CitizenWatt-Base/receive.cpp new file mode 100644 index 0000000..99dcd25 --- /dev/null +++ b/CitizenWatt-Base/receive.cpp @@ -0,0 +1,109 @@ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +volatile sig_atomic_t flag = 0; +void quit(int sig) { + flag = 1; +} + +const bool DEBUG = true; + +// Speed for the nrf module +// RF24_250KBPS / RF24_1MBPS / RF24_2MBPS +// Reduce it to improve reliability +const rf24_datarate_e NRF_SPEED = RF24_1MBPS; + +// PreAmplifier level for the nRF +// Lower this to reduce power consumption. This will reduce range. +const rf24_pa_dbm_e NRF_PA_LEVEL = RF24_PA_LOW; + +// Channel for the nrf module +// 76 is default safe channel in RF24 +const int NRF_CHANNEL = 0x4c; + +const uint64_t default_addr = 0xE056D446D0LL; + +//RF24 radio(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ); +RF24 radio("/dev/spidev0.0",8000000 , 25); + +// Named pipe +int fd; +char * myfifo = "/tmp/sensor"; + +int main() { + uint8_t payload[] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}; + + // Create FIFO + mkfifo(myfifo, 0666); + signal(SIGINT, quit); + + // Open FIFO - while wait here until another thread opens the same fifo + fd = open(myfifo, O_WRONLY); + + // Get the address to listen on + std::ifstream config_addr; + config_addr.open("~/.config/citizenwatt/base_address", std::ios::in); + uint64_t addr; + if (config_addr.is_open()) { + config_addr >> addr; + config_addr.close(); + } + else { + addr = default_addr; + } + + // Initialize nRF + radio.begin(); + // Max number of retries and max delay between them + radio.setRetries(15, 15); + radio.setChannel(NRF_CHANNEL); + // Reduce payload size to improve reliability + radio.setPayloadSize(16); + // Set the datarate + radio.setDataRate(NRF_SPEED); + // Use the largest CRC + radio.setCRCLength(RF24_CRC_16); + // Ensure auto ACK is enabled + radio.setAutoAck(1); + // Use the best PA level + radio.setPALevel(NRF_PA_LEVEL); + // Open reading pipe + radio.openReadingPipe(1, addr); + + radio.startListening(); + + while(1) { + if(flag) { + close(fd); + unlink(myfifo); + std::cout << "Exiting…\n"; + return 0; + } + + if(radio.available()) { + radio.read(&payload, sizeof(payload)); + + if(DEBUG) { + std::cout << "Received : "; + for(int i=0; i&1 > /dev/null; do + echo "Webserver is starting…" + sleep 1 +done +echo "Webserver started !\n" + +echo "Ready to start !" diff --git a/CitizenWatt-Base/static/css/normalize.css b/CitizenWatt-Base/static/css/normalize.css new file mode 100644 index 0000000..08f8950 --- /dev/null +++ b/CitizenWatt-Base/static/css/normalize.css @@ -0,0 +1,425 @@ +/*! normalize.css v3.0.1 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/CitizenWatt-Base/static/css/style.css b/CitizenWatt-Base/static/css/style.css new file mode 100644 index 0000000..dd48224 --- /dev/null +++ b/CitizenWatt-Base/static/css/style.css @@ -0,0 +1,896 @@ + +/****************************************************************************** + * 0. Font faces + */ + +/* + * 0.1 Open Sans + */ + +@font-face { + font-family: 'Open Sans'; + font-style: normal; + font-weight: 400; + src: + local('Open Sans'), + local('OpenSans'), + url('../font/OpenSans-Regular.ttf'); +} +@font-face { + font-family: 'Open Sans'; + src: + local('Open Sans Light'), + local('OpenSans-Light'), + url('../font/OpenSans-Light.ttf'); + font-style: normal; + font-weight: 300; +} +@font-face { + font-family: 'Open Sans'; + src: + local('Open Sans Semibold'), + local('OpenSans-Semibold'), + url('../font/OpenSans-Bold.ttf'); + font-style: normal; + font-weight: bold; +} +@font-face { + font-family: 'Open Sans'; + src: + local('Open Sans Italic'), + local('OpenSans-Italic'), + url('../font/OpenSans-Italic.ttf'); + font-style: italic; +} +@font-face { + font-family: 'Open Sans'; + src: + local('Open Sans Bold Italic'), + local('OpenSans-BoldItalic'), + url('../font/OpenSans-BoldItalic.ttf'); + font-style: italic; + font-weight: bold; +} + +/* + * 0.2 Alex Brush + */ + +@font-face { + font-family: 'Alex Brush'; + font-style: normal; + font-weight: 400; + src: local('Alex Brush'), local('AlexBrush'), url('../font/AlexBrush-Regular.ttf'); +} + + +/****************************************************************************** + * 1. Styles de base + */ + +html, body { + padding: 0; + margin: 0; + height: 100%; +} + +body { + background-color: #231f20; + color: #d6d6d6; + font-family: "Open Sans", sans-serif; +} + +a { + text-decoration: none; + color: #e3834f; +} + +a:hover { + text-decoration: underline; +} + +article { + border-radius: 3px; + border: none; + margin: 3em 0; +} + +h2 { + color: white; + font-size: 1.5em; + font-weight: 200; + margin-top: 2em; +} + +main { + width: 75%; + margin: auto; + padding-bottom: 4em; + color: #b3abab; +} + +@media screen and (max-width: 900px) { + main { + width: 100%; + } +} + + +/****************************************************************************** + * 2. Classes + */ + +/* + * 2.1 Color classes + */ + +.yellow { + color: #ffd35d; +} + +.orange { + color: #ffb43f; +} + +.red { + color: #ff7b33; +} + +.dark-yellow { + color: # +} + +.dark-orange { + color: #f59b20; +} + +.dark-red { + color: #f2541b; +} + +.blurry { + text-shadow: 0 0 0.5em; +} + +.left { + float: left; + margin-left: 1em; +} + +.no-day { + background-color: transparent !important; +} + +.empty-day { + background-color: #363032 !important; +} + +.dark-red-day { + background-color: #f2541b !important; +} + +.red-day { + background-color: #ff7b33 !important; +} + +.orange-day { + background-color: #ffb43f !important; +} + +.yellow-day { + background-color: #ffd35d !important; +} + +.dark-blue { + color: #2332ff; +} + +.blue { + color: #196cff; +} + +.light-blue { + color: #5d92ff; +} + +.dark-blue-day { + background-color: #2332ff !important; +} + +.blue-day { + background-color: #196cff !important; +} + +.light-blue-day { + background-color: #5d92ff !important; +} + +/* + * 2.2 Dialog boxes + */ + +.dialog-err { + background-color: rgba(255,255,255,0.1); + border-left: 3px solid #cc624d; + + margin: 10px 0; + padding: 5px 10px; +} + +.dialog-err h4 { + font-weight: 500; + margin: 0; + color: #cc624d; +} + +.dialog-err p { + margin: 3px 0; + font-weight: 200; + color: white; +} + +/* + * 2.x Other + */ + +.clearfix { + clear: both; +} + + +/****************************************************************************** + * 3. Header + */ + +header { + background-color: #5f5557; + border-bottom: 5px solid #928688; + + display: -webkit-flex; + display: flex; + + -webkit-flex-flow: row wrap; + flex-flow: row wrap; + + -webkit-justify-content: space-between; + justify-content: space-between; + + -webkit-align-items: center; + align-items: center; +} + +.header-logo img { + margin: 2px 0; + margin-left: 3em; + vertical-align: top; +} + +/* + * 3.1. Menu + */ + +#menu { + font-size: 1.2em; + + display: -webkit-flex; + display: flex; + + -webkit-flex-flow: row wrap; + flex-flow: row wrap; +} + + +#menu>a { + display: inline-block; + margin-right: 1em; + + color: white; + text-transform: uppercase; + font-weight: 200; + border-bottom: 3px solid #5f5557; +} + +#menu a:hover { + text-decoration: none; + border-bottom: 3px solid #928688; +} + +#menu a.active { + border-bottom: 3px solid #e3834f; +} + +#menu a.active:hover { + border-bottom: 3px solid #ad7556; +} + +/* + * 3.2. Rate logo + */ + +.rate-logo { + cursor: help; + position: relative; + margin-left: 2em; + margin-right: auto; + display: none; +} + +.rate-logo img { + width: 2em; +} + +.rate-logo span { + position: absolute; + width: 8em; + left: 50%; + margin-left: -4em; + background-color: rgba(0,0,0,0.7); + border-radius: 3px; + padding: 3px; + text-align: center; + display: none; +} + +.rate-logo:hover span { + display: block; +} + + +/****************************************************************************** + * 4. Footer + */ + + +footer { + padding: 0; + + background-color: #5f5557; + border-top: 5px solid #928688; + + position: absolute; + left: 0; + bottom: 0; + width: 100%; + + font-size: 0.7em; + + display: flex; + align-items: center; + justify-content: space-between; +} + +footer p { + margin: 0.2em; +} + +.pre-footer { + margin-bottom: 2em; +} + + + +/****************************************************************************** + * 5. Overview + */ + +#overview { + display: flex; + align-items: center; + justify-content: center; + margin-bottom: 1em; +} + +#overview div { + margin-left: 2em; + margin-right: 2em; + text-align: center; +} + +#now, #day, #week { + font-size: 3em; + margin-bottom: 0; +} + + +/****************************************************************************** + * 6. Graphe + */ + + +#graph { + background-color: #363032; + border-bottom: 3px solid #52484b; + margin-bottom: 1em; + position: relative; + height: 300px; + + +} + +/* + * 6.1. Values + */ + +#graph_values_wrapper { + overflow: hidden; + width: 100%; + height: 100%; + direction: rtl; +} + +#graph_values { + display: -webkit-inline-flex; + display: inline-flex; + + -webkit-flex-flow: row-reverse nowrap; + flex-flow: row-reverse nowrap; + + -webkit-justify-content: flex-end; + justify-content: flex-end; + + -webkit-align-items: flex-end; + align-items: flex-end; + + height: 100%; + min-width: 100%; + +} + +#graph_values .rect { + display: block; + margin-left: 2px; + height: 100%; + position: relative; +} + +#graph_values .rect { + margin-left: 2px; + height: 100%; + position: relative; +} + +#graph_values .rect.undefined { + background-color: #5C2D2D; +} + +#graph_values .rect.animated { + transition: width 1s; + width: 0; +} + +#graph_values .rect-info { + color: #ddd; + background-color: rgba(0,0,0,0.8); + border-radius: 3px; + padding: 3px; + box-sizing: border-box; + text-align: center; + + position: absolute; + top: 0; + + width: 7em; + left: 50%; + margin-left: -3.5em; + + z-index: 20; + display: none; +} + +#graph_values .rect:hover .rect-info { + display: block; +} + +#graph_values .rect:hover { + background-color: rgba(0,0,0,0.2); +} + +#graph_values .rect-color { + position: absolute; + bottom: 0; + width: 100%; + z-index: 10; +} + +/* + * 6.2. Axis + */ + + +#graph hr { + position: absolute; + margin: 0; + border: 0; + height: 2px; + width: 100%; + background-color: rgba(255,255,255,0.1); + z-index: 20; +} + +#graph hr.absolute-graduation-hr { + background-color: rgba(255,0,0,0.5); +} + +#graph_vertical_axis span { + position:absolute; + z-index: 20; + /*text-shadow: 1px 1px 0px rgba( 0, 0, 0,0.5), + -1px -1px 0px rgba(255,255,255,0.5); + background-color: #363032;*/ +} + +/* + * 6.3. Loading + */ + +#graph_loading { + position: absolute; + top: 0; + bottom: 0; + left: 0; + right: 0; + + display: -webkit-flex; + display: flex; + + -webkit-flex-flow: column wrap; + flex-flow: column wrap; + + -webkit-justify-content: center; + justify-content: center; + + -webkit-align-items: center; + align-items: center; +} + +#graph_loading img { + width: 3em; + animation-name: rotate; + -webkit-animation-name: rotate; + + animation-duration: 5s; + -webkit-animation-duration: 5s; + + animation-iteration-count: infinite; + -webkit-animation-iteration-count: infinite; + + animation-timing-function: linear; + -webkit-animation-timing-function: linear; + + z-index: 20; +} + +/* + * 6.4. Prev/Next + */ + +#prev { + position: absolute; + top: 0; + bottom: 0; + left: -2.5em; + width: 2em; + background-color: rgba(0,0,0,0.5); + border: none; + z-index: 30; +} + +#prev:hover { + background-color: rgba(0,0,0,0.8); +} + +#next { + position: absolute; + top: 0; + bottom: 0; + right: -2.5em; + width: 2em; + background-color: rgba(0,0,0,0.5); + border: none; + z-index: 30; +} + +#next:hover { + background-color: rgba(0,0,0,0.8); +} + +@media screen and (max-width: 780px) { + #prev { + left:0; + } + #next { + right:0; + } +} + +/****************************************************************************** + * 7. Échelle du graphe + */ + +#scale { + display: -webkit-flex; + display: flex; + + -webkit-flex-flow: rowcolumn wrap; + flex-flow: row wrap; + + -webkit-justify-content: flex-start; + justify-content: flex-start; + + -webkit-align-items: center; + align-items: center; +} + +#scale button { + background: #363032; + border: none; + border-bottom: 3px solid #52484b; +} + +#scale button.active { + color: white; + border-bottom: 3px solid #e3834f; +} + +#scale button:hover { + color: white; + background: #60565A; +} + +#unit-energy { + margin-left: auto; + color: white; +} + + +/****************************************************************************** + * 8. Menu blocks + */ + +.menu { + text-transform: uppercase; + color: white; +} + +.menu img { + margin: 3px 0.5em; + vertical-align: middle; +} + +.menu h1 { + font-weight: 200; +} + +.menu a { + color: white; +} + +.menu>a { + color: white; + display: block; + margin: 0.5em 5em; + line-height: 3em; +} + +.menu>a:hover { + background-color: rgba(255, 255, 255, 0.1); + text-decoration: none; +} + +.menu a img { + height: 2em; +} + + +.right-column, .left-column { + width: 50%; +} + +.right-column { + float: right; +} + +.left-column { + width: 50%; + float: left; +} + +@media screen and (max-width: 780px) { + .right-column { + width: 100%; + float: none; + } + + .left-column { + width: 100%; + float: none; + } +} + +/****************************************************************************** + * 9. Form + */ + + +input, select { + color: #444; + border: 0; + border-radius: 3px; + padding: 4px 6px; + background-color: #F8F8F8; + line-height: 1.4em; +} + +input:focus { + box-shadow: 0 0 2px 2px rgba(185, 103, 59, 0.8); +} + +input[type="submit"] { + background-color: #BF6C3F; + text-transform: uppercase; + color: white; +} + + + +.form-item { + display: -webkit-flex; + display: flex; + + -webkit-flex-flow: row wrap; + flex-flow: row wrap; + + -webkit-justify-content: flex-start; + justify-content: flex-start; + + -webkit-align-items: center; + align-items: center; +} + +.form-item label { + width: 275px; +} + +.form-item input { +} + +.form-help { + text-transform: none; + color: #888; + margin: 0 1em; + font-size: 0.9em; + margin-bottom: 2em; +} + + +/****************************************************************************** + * 10. Tableaux + */ + +table { + text-align: center; + margin: auto; +} + +table td, table th { + padding: 0.5em; + border: 1px solid white; +} + +table tr td:first-child, table tr th:first-child { + border-left: none; +} + +table tr td:last-child, table tr th:last-child { + border-right: none; +} + +table tr:first-child td, table tr:first-child th { + border-top: none; +} + +table tr:last-child td, table tr:last-child th { + border-bottom: none; +} + +/****************************************************************************** + * 11. Coming soon + */ + +.coming-soon { + position: absolute; + top: 0; + bottom: 0; + left: 0; + right: 0; + + display: -webkit-flex; + display: flex; + + -webkit-flex-flow: column wrap; + flex-flow: column wrap; + + -webkit-justify-content: center; + justify-content: center; + + -webkit-align-items: center; + align-items: center; + + z-index: -10; +} + +.coming-soon img { + width: 10em; + animation-name: rotate; + -webkit-animation-name: rotate; + + animation-duration: 5s; + -webkit-animation-duration: 5s; + + animation-iteration-count: infinite; + -webkit-animation-iteration-count: infinite; + + animation-timing-function: linear; + -webkit-animation-timing-function: linear; +} + +.coming-soon span { + display: block; + text-transform: uppercase; + color: white; + font-size: 2em; + font-weight: 300; +} + +/****************************************************************************** + * 12. Content + */ + +.content { + color: #d7d7d7; + max-width: 50em; + margin: auto; + padding: 0 2em; + text-align: justify; +} + + +/****************************************************************************** + * 13. Animations + */ + +@keyframes rotate { + from { + transform: rotate(0deg); + } + to { + transform: rotate(360deg); + } +} + +@-webkit-keyframes rotate { + from { + -webkit-transform: rotate(0deg); + } + to { + -webkit-transform: rotate(360deg); + } +} + +/****************************************************************************** + * X. Autre + */ + +#page { + position: relative; + min-height: 100%; + margin: 0; + overflow: hidden; +} + + +@media screen and (max-width: 780px) { + #menu { + display: none; + } +} diff --git a/CitizenWatt-Base/static/font/OpenSans-Bold.ttf b/CitizenWatt-Base/static/font/OpenSans-Bold.ttf new file mode 100644 index 0000000..fd79d43 Binary files /dev/null and b/CitizenWatt-Base/static/font/OpenSans-Bold.ttf differ diff --git a/CitizenWatt-Base/static/font/OpenSans-BoldItalic.ttf b/CitizenWatt-Base/static/font/OpenSans-BoldItalic.ttf new file mode 100644 index 0000000..9bc8009 Binary files /dev/null and b/CitizenWatt-Base/static/font/OpenSans-BoldItalic.ttf differ diff --git a/CitizenWatt-Base/static/font/OpenSans-Italic.ttf b/CitizenWatt-Base/static/font/OpenSans-Italic.ttf new file mode 100644 index 0000000..c90da48 Binary files /dev/null and b/CitizenWatt-Base/static/font/OpenSans-Italic.ttf differ diff --git a/CitizenWatt-Base/static/font/OpenSans-Light.ttf b/CitizenWatt-Base/static/font/OpenSans-Light.ttf new file mode 100644 index 0000000..0d38189 Binary files /dev/null and b/CitizenWatt-Base/static/font/OpenSans-Light.ttf differ diff --git a/CitizenWatt-Base/static/font/OpenSans-Regular.ttf b/CitizenWatt-Base/static/font/OpenSans-Regular.ttf new file mode 100644 index 0000000..db43334 Binary files /dev/null and b/CitizenWatt-Base/static/font/OpenSans-Regular.ttf differ diff --git a/CitizenWatt-Base/static/img/bill.svg b/CitizenWatt-Base/static/img/bill.svg new file mode 100644 index 0000000..ac75720 --- /dev/null +++ b/CitizenWatt-Base/static/img/bill.svg @@ -0,0 +1,118 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/community.svg b/CitizenWatt-Base/static/img/community.svg new file mode 100644 index 0000000..5fc1504 --- /dev/null +++ b/CitizenWatt-Base/static/img/community.svg @@ -0,0 +1,88 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/contact.svg b/CitizenWatt-Base/static/img/contact.svg new file mode 100644 index 0000000..ec46321 --- /dev/null +++ b/CitizenWatt-Base/static/img/contact.svg @@ -0,0 +1,99 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/data.svg b/CitizenWatt-Base/static/img/data.svg new file mode 100644 index 0000000..1405507 --- /dev/null +++ b/CitizenWatt-Base/static/img/data.svg @@ -0,0 +1,97 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/day.svg b/CitizenWatt-Base/static/img/day.svg new file mode 100644 index 0000000..6db6036 --- /dev/null +++ b/CitizenWatt-Base/static/img/day.svg @@ -0,0 +1,100 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + 1 + + + diff --git a/CitizenWatt-Base/static/img/help.svg b/CitizenWatt-Base/static/img/help.svg new file mode 100644 index 0000000..4db6182 --- /dev/null +++ b/CitizenWatt-Base/static/img/help.svg @@ -0,0 +1,83 @@ + + + + + + + + + + image/svg+xml + + + + + + + + ? + + diff --git a/CitizenWatt-Base/static/img/install.svg b/CitizenWatt-Base/static/img/install.svg new file mode 100644 index 0000000..2a3e007 --- /dev/null +++ b/CitizenWatt-Base/static/img/install.svg @@ -0,0 +1,111 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/loading.svg b/CitizenWatt-Base/static/img/loading.svg new file mode 100644 index 0000000..8930af9 --- /dev/null +++ b/CitizenWatt-Base/static/img/loading.svg @@ -0,0 +1,130 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/loading_simple.svg b/CitizenWatt-Base/static/img/loading_simple.svg new file mode 100644 index 0000000..c9f7fb4 --- /dev/null +++ b/CitizenWatt-Base/static/img/loading_simple.svg @@ -0,0 +1,124 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/login.svg b/CitizenWatt-Base/static/img/login.svg new file mode 100644 index 0000000..3df3c01 --- /dev/null +++ b/CitizenWatt-Base/static/img/login.svg @@ -0,0 +1,83 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/logo.png b/CitizenWatt-Base/static/img/logo.png new file mode 100644 index 0000000..82dbaa2 Binary files /dev/null and b/CitizenWatt-Base/static/img/logo.png differ diff --git a/CitizenWatt-Base/static/img/logout.svg b/CitizenWatt-Base/static/img/logout.svg new file mode 100644 index 0000000..43af844 --- /dev/null +++ b/CitizenWatt-Base/static/img/logout.svg @@ -0,0 +1,94 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/month.svg b/CitizenWatt-Base/static/img/month.svg new file mode 100644 index 0000000..bc4b99e --- /dev/null +++ b/CitizenWatt-Base/static/img/month.svg @@ -0,0 +1,100 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + 31 + + + diff --git a/CitizenWatt-Base/static/img/moon.svg b/CitizenWatt-Base/static/img/moon.svg new file mode 100644 index 0000000..50ee25e --- /dev/null +++ b/CitizenWatt-Base/static/img/moon.svg @@ -0,0 +1,195 @@ + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/more.svg b/CitizenWatt-Base/static/img/more.svg new file mode 100644 index 0000000..549d71a --- /dev/null +++ b/CitizenWatt-Base/static/img/more.svg @@ -0,0 +1,89 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/progress.svg b/CitizenWatt-Base/static/img/progress.svg new file mode 100644 index 0000000..051f993 --- /dev/null +++ b/CitizenWatt-Base/static/img/progress.svg @@ -0,0 +1,87 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/results.svg b/CitizenWatt-Base/static/img/results.svg new file mode 100644 index 0000000..6276f66 --- /dev/null +++ b/CitizenWatt-Base/static/img/results.svg @@ -0,0 +1,113 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/sensor.svg b/CitizenWatt-Base/static/img/sensor.svg new file mode 100644 index 0000000..883de98 --- /dev/null +++ b/CitizenWatt-Base/static/img/sensor.svg @@ -0,0 +1,83 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/small-data.svg b/CitizenWatt-Base/static/img/small-data.svg new file mode 100644 index 0000000..eac41dc --- /dev/null +++ b/CitizenWatt-Base/static/img/small-data.svg @@ -0,0 +1,107 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/sun.svg b/CitizenWatt-Base/static/img/sun.svg new file mode 100644 index 0000000..380ffd5 --- /dev/null +++ b/CitizenWatt-Base/static/img/sun.svg @@ -0,0 +1,181 @@ + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/target-no.svg b/CitizenWatt-Base/static/img/target-no.svg new file mode 100644 index 0000000..6f82997 --- /dev/null +++ b/CitizenWatt-Base/static/img/target-no.svg @@ -0,0 +1,94 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/target-ok.svg b/CitizenWatt-Base/static/img/target-ok.svg new file mode 100644 index 0000000..2dada0d --- /dev/null +++ b/CitizenWatt-Base/static/img/target-ok.svg @@ -0,0 +1,89 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + ✓ + + + diff --git a/CitizenWatt-Base/static/img/target-wip.svg b/CitizenWatt-Base/static/img/target-wip.svg new file mode 100644 index 0000000..0c16869 --- /dev/null +++ b/CitizenWatt-Base/static/img/target-wip.svg @@ -0,0 +1,132 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/target.svg b/CitizenWatt-Base/static/img/target.svg new file mode 100644 index 0000000..9f753c3 --- /dev/null +++ b/CitizenWatt-Base/static/img/target.svg @@ -0,0 +1,95 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + ✓ + + + diff --git a/CitizenWatt-Base/static/img/tick.svg b/CitizenWatt-Base/static/img/tick.svg new file mode 100644 index 0000000..f5fa041 --- /dev/null +++ b/CitizenWatt-Base/static/img/tick.svg @@ -0,0 +1,89 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + ✓ + + + diff --git a/CitizenWatt-Base/static/img/user.svg b/CitizenWatt-Base/static/img/user.svg new file mode 100644 index 0000000..7ba4a12 --- /dev/null +++ b/CitizenWatt-Base/static/img/user.svg @@ -0,0 +1,90 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/img/week.svg b/CitizenWatt-Base/static/img/week.svg new file mode 100644 index 0000000..40bff1d --- /dev/null +++ b/CitizenWatt-Base/static/img/week.svg @@ -0,0 +1,100 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + 7 + + + diff --git a/CitizenWatt-Base/static/img/wiki.svg b/CitizenWatt-Base/static/img/wiki.svg new file mode 100644 index 0000000..1ce8a0f --- /dev/null +++ b/CitizenWatt-Base/static/img/wiki.svg @@ -0,0 +1,112 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + diff --git a/CitizenWatt-Base/static/js/conso/App.js b/CitizenWatt-Base/static/js/conso/App.js new file mode 100644 index 0000000..7eef880 --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/App.js @@ -0,0 +1,206 @@ +/** + * Core application + */ +var App = function() { + var api = {}; + var graph = Graph() + , provider = DataProvider() + , menu = Menu() + , hash = HashManager() + , rate = RateDisplay() + ; + + function reload(_, callback) { + var mode = menu.getMode() + , date = menu.getDate() + , unit = menu.getUnit() + ; + + graph.clean(); + graph = unit == 'energy' ? Graph(mode == 'now' ? 'W' : 'kWh') : PriceGraph(mode == 'now' ? 'cents/min' : '€'); + graph.autoremove = mode == 'now' && date === null; + + if (unit == 'price') graph.round = function(v) { return Math.round(v * 100) / 100; }; + + if (mode == 'now' && unit == 'energy') { + provider.getProviderInfo(function(provider) { + graph.addAbsoluteVerticalGraduation(provider['threshold']); + }); + } + graph.init(); + hash.setMode(mode); + hash.setDate(date); + hash.setUnit(unit == 'price' ? 'euros' : 'watt'); + api.initValues(callback); + }; + + menu.onmodechange = function(ev, callback) { + menu.setDate(null, function(){ + reload(null, callback); + }, false); + } + menu.onunitchange = reload; + menu.ondatechange = reload; + + provider.onratechange = rate.setRate; + + /** + * Callbacks + */ + api.oninit = function(){}; // called when init is done + + /** + * Init application. + * Add graduation lines + */ + api.init = function() { + menu.init(); + + provider.get('/time', function(basetime) { + dateutils.offset = parseFloat(basetime) * 1000.0 - (new Date()).getTime(); + + var unit = hash.getUnit() == 'euros' ? 'price' : 'energy'; + + menu.setUnit(unit, function(){ + menu.setMode(hash.getMode(), function(){ + menu.setDate(hash.getDate(), function(){ + reload(null, api.oninit); + }, false); + }, false); + }, false); + + }); + }; + + /** + * Init graph values. + * @param callback: (optional) + */ + api.initValues = function(callback) { + provider.getSensorId(function(sensor_id) { + var target = '/' + sensor_id + '/get/' + menu.getUnitString(); + var mode = menu.getMode(); + var date = menu.getDate() || (new Date()); + var modifier = 0; + + switch (mode) { + case 'now': + menu.timeWidth = Config.timestep * (graph.getWidth()+1) * 1000; + var start_date = new Date(date.getTime() - menu.timeWidth); + target + += '/by_time/' + + start_date.getTime() / 1000.0 + '/' + + date.getTime() / 1000.0 + '/' + + Config.timestep; + if (!menu.getDate()) graph.setOverviewLabel('Consommation actuelle'); + else graph.setOverviewLabel('Consommation entre ' + dateutils.humanTime(start_date) + ' et ' + dateutils.humanTime(date)); + break; + + case 'day': + target + += '/by_time/' + + dateutils.getDayStart(date) / 1000.0 + '/' + + dateutils.getDayEnd(date) / 1000.0 + '/' + + dateutils.getHourLength(date) / 1000.0; + graph.setOverviewLabel('Consommation ' + dateutils.humanDay(date)); + modifier = 1. / (dateutils.getMonthLength(date) / dateutils.getDayLength()); + break; + + case 'week': + target + += '/by_time/' + + (dateutils.getWeekStart(date) / 1000.0) + '/' + + ((dateutils.getWeekStart(date) + dateutils.getDayLength(date) * 7) / 1000.0) + '/' // Avoid pbs with Daylight Saving Time + + (dateutils.getDayLength(date) / 1000.0); + graph.setOverviewLabel('Consommation ' + dateutils.humanWeek(date)); + modifier = 7. / (dateutils.getMonthLength(date) / dateutils.getDayLength()); + break; + + case 'month': + target + += '/by_time/' + + dateutils.getMonthStart(date) / 1000.0 + '/' + + dateutils.getMonthEnd(date) / 1000.0 + '/' + + dateutils.getDayLength(date) / 1000.0; + graph.setOverviewLabel('Consommation ' + dateutils.humanMonth(date)); + modifier = 1.0; + break; + + default: + if (callback) callback(); + return; + } + + graph.setOverview(null); + graph.startLoading(); + provider.get(target, function(data) { + graph.rect_width = graph.getPixelWidth() / data.length - graph.rect_margin; + var s = 0, i = 0; + var last_good_value = null; + var before_last_value = null; + var last_value = null; + data.map(function(m) { + if (m !== null) { + if (last_value === null && before_last_value !== null) { + v = (before_last_value + m.value) / 2.0; + s += v; + graph + .removeRect() + .addRect(v, false, graph.getLegend(mode, date, i)); + } + graph.addRect(m.value, false, graph.getLegend(mode, date, i)); + s += m.value; + last_good_value = m.value; + before_last_value = last_value; + last_value = m.value; + } else if (mode != 'now' || i < data.length - 1) { // Avoid leading undefined rect in instant view + graph.addRect(undefined, false, graph.getLegend(mode, date, i)); + before_last_value = last_value; + last_value = null; + } + i += 1; + }); + if (mode != 'now') { + provider.getConvertInfo(rate.getRate(), function(base_price){ + // Assume that base_price is not dependent of rate type + graph.setOverview(s + base_price * modifier); + }); + } else { + graph.setOverview(last_good_value); + } + graph.stopLoading(); + if (callback) callback(); + }); + + graph.last_call = Date.now() / 1000.0; + }); + }; + + /** + * Go and get new values. This function should be called regularely by the main loop. + */ + api.update = function() { + if (menu.getMode() == 'now' && menu.getDate() === null && menu.isUpdated()) { + provider.getSensorId(function(sensor_id) { + var target + = '/' + sensor_id + '/get/' + + menu.getUnitString() + + '/by_time/' + + graph.last_call + '/' + + (graph.last_call = Date.now() / 1000.0) + '/' + + Config.timestep; + + provider.get(target, function(data) { + data.map(function(m) { + if (m !== null) { + graph.addRect(m.value); + graph.setOverview(m.value); + } + }); + }); + }); + } + }; + + return api; +}; diff --git a/CitizenWatt-Base/static/js/conso/Config.js b/CitizenWatt-Base/static/js/conso/Config.js new file mode 100644 index 0000000..c6554ef --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/Config.js @@ -0,0 +1,7 @@ +// General params +var Config = { + update_timeout: 2000, // Milliseconds + rect_width: 12, // Pixels + rect_margin: 2, // Pixels + timestep: 8 // Second +}; diff --git a/CitizenWatt-Base/static/js/conso/DataProvider.js b/CitizenWatt-Base/static/js/conso/DataProvider.js new file mode 100644 index 0000000..43de849 --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/DataProvider.js @@ -0,0 +1,89 @@ +/** + * Provide a way to get new data. + */ +var DataProvider = function() { + var api = {}; + var energy_provider = null; // Cache for energy provider info + var sensor_id = null; // Cache for sensor ID + + api.onratechange = function(rate){}; + + /** + * Get new data from server. + * @param target: Type of data to get (@see API specification) + * @param callback: callback that take data as first argument + */ + api.get = function(target, callback) { + var req = new XMLHttpRequest(); + req.open('GET', API_URL + target, true); + req.send(); + req.onreadystatechange = function() { + if (req.readyState == 4) { + var res; + try { + res = JSON.parse(req.responseText); + } + catch (e) { + console.log('ERROR while handling `' + target + '`:', req.responseText); + } + if (res && res.rate) { + api.onratechange(res.rate); + } + if (res && res.data === null) res.data = []; + callback(res.data); + } + } + } + + + /** + * Get current provider info + * @param callback: callback that takes provider + */ + api.getProviderInfo = function(callback) { + if (energy_provider === null) { + api.get('/energy_providers/current', function(provider) { + energy_provider = provider; + callback(energy_provider); + }); + } else { + callback(energy_provider); + } + } + + + /** + * Get watt_euros convertion info + * @param rate: day or night tariff + * @param callback: callback that takes origin value and slope + */ + api.getConvertInfo = function(rate, callback) { + api.getProviderInfo(function(provider){ + callback( + provider[rate+'_slope_watt_euros'], + provider[rate+'_constant_watt_euros'] + ); + }); + } + + + /** + * Get active sensor ID (active iff name is 'CitizenWatt') + * @param callback: callback that takes sensor ID + */ + api.getSensorId = function(callback) { + if (sensor_id == null) { + api.get('/sensors', function(sensors) { + for (var i = sensors.length - 1; i >= 0; i--) { + if (sensors[i].name == 'CitizenWatt') + sensor_id = sensors[i].id; + }; + callback(sensor_id); + }); + } else { + callback(sensor_id); + } + } + + return api; +}; diff --git a/CitizenWatt-Base/static/js/conso/Graph.js b/CitizenWatt-Base/static/js/conso/Graph.js new file mode 100644 index 0000000..5b0d980 --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/Graph.js @@ -0,0 +1,345 @@ +/** + * Gather graph-related functions + * @param unit: (optional) Graphe unit + * @param max_value: (optional) Defautl graph max_value + */ +var Graph = function(unit, max_value) { + var api = {}; + + var graph = document.getElementById('graph') + , graph_vertical_axis = document.getElementById('graph_vertical_axis') + , graph_values = document.getElementById('graph_values') + , graph_loading = document.getElementById('graph_loading') + , now = document.getElementById('now') + , now_label = document.getElementById('now_label') + , sum, n_values, mean + ; + + /** + * Function used to convert values received from server + */ + api.convertValue = function(v){ return v; }; + + api.unit = unit || 'W'; + api.type = 'energy'; + api.rect_width = Config.rect_width; + api.rect_margin = Config.rect_margin; + api.autoremove = true; + api.max_value = max_value || 1e-6; + + /** + * Set color class name from height (between 0.0 and 1.0) + */ + api.colorize = function(t) { + return (t > 33.3 ? (t >= 66.7 ? 'red' : 'orange') : 'yellow'); + } + + /** + * Round value according to max value + */ + api.round = function(v) { + return Math.round(v * 10) / 10; + } + + /** + * Init graph + */ + api.init = function() { + n_values = 0; + + var graduations = [0.00, 0.33, 0.66, 1.00]; // Graduation positions (relative) + graduations.map(function (t) { + api.addVerticalGraduation(t) + }); + + return api; + } + + /** + * Set value disaplyed in overview + * @param power: value to display + */ + api.setOverview = function(power) { + if (power === null) { + now.innerHTML = ' '; + return; + } + if (api.unit == 'cents/min') power = power / 8 * 60 * 100; + now.innerHTML = api.round(power) + (api.unit == 'cents/min' ? ' centimes par minute' : api.unit); + var height = power / api.max_value * 100; + now.className = 'blurry ' + api.colorize(height); + }; + + /** + * Set label under overview field. + * @pram label: new label + */ + api.setOverviewLabel = function(label) { + now_label.innerHTML = label; + }; + + + /** + * Add a new rect to the graph. + * @param power: Power represented by the rect. + * @param animated: (optional) Whether the addition of the value must be animated. Default to True + * @param legend: (optional) Legend to add to the rect + */ + api.addRect = function(power, animated, legend) { + if (animated === undefined) animated = true; + var defined = true; + if (power === undefined) { + defined = false; + power = 0; + } + + if (unit == 'cents/min') { + power = power / 8 * 60 * 100; + } + + if (power > api.max_value) { + api.scaleVertically(power / api.max_value); + } + + var div = document.createElement('a'); + div.setAttribute('href', location.hash); // TODO + graph_values.appendChild(div); + + div.className = 'rect'; + if (!defined) div.className += ' undefined'; + if (animated) div.className += ' animated'; + div.className += ' ' + api.type; + + var info = document.createElement('div'); + div.appendChild(info); + + info.className = 'rect-info'; + if (defined) info.innerHTML = api.round(power) + api.unit; + else info.innerHTML = 'Pas de donnée'; + if (legend) info.innerHTML += '
' + legend; + + var color = document.createElement('div'); + div.appendChild(color); + + var height = api.round(power) / api.max_value * 100; + var color_class = api.colorize(height); + + color.className = 'rect-color ' + color_class + '-day'; + color.style.height = height + '%'; + + + ++n_values; + + var max_values = api.getWidth(); + // Le +10 c'est pour prendre de la marge. On ne peut pas mettre + // simplement 1 sinon ça se voit lorsque plusieurs nouvelles mesures + // arrivent en même temps. + if (api.autoremove && n_values > max_values + 10) { + /* + graph_values.firstChild.style.width = '0'; + graph_values.firstChild.addEventListener('transitionend', function(){ + graph_values.removeChild(this); + }, false); + */ + graph_values.removeChild(graph_values.firstChild) + } + + div.style.width = api.rect_width + 'px'; + + + return api; + }; + + /** + * Remove last rect from graph + * @return api; + */ + api.removeRect = function() { + if (graph_values.lastChild) + graph_values.removeChild(graph_values.lastChild); + + return api; + }; + + /** + * Add an horizontal graduation line (so a graduation for the vertical axis) + * @param pos: Relative position at which the graduation is placed + */ + api.addVerticalGraduation = function(pos) { + var height = pos * 100; + var span = document.createElement('span'); + graph_vertical_axis.appendChild(span); + + span.style.bottom = height + '%'; + span.setAttribute('cw-graduation-position', pos); + api.updateVerticalGraduation(span); + + return api; + } + + /** + * Add an horizontal absolute graduation line + * @param pos: Absolute position at which the graduation is placed + */ + api.addAbsoluteVerticalGraduation = function(pos) { + if (pos * 1.1 > api.max_value) { + api.scaleVertically(pos * 1.1 / api.max_value); + } + + var height = pos / api.max_value * 100; + var span = document.createElement('span'); + var hr_id = rand64(5); + graph_vertical_axis.appendChild(span); + + span.style.bottom = height + '%'; + span.setAttribute('cw-absolute-graduation-position', pos); + span.setAttribute('cw-absolute-graduation-hr', hr_id); + + var hr = document.createElement('hr'); + hr.style.bottom = height + '%'; + hr.id = hr_id; + hr.className = 'absolute-graduation-hr'; + graph.appendChild(hr); + + api.updateVerticalGraduation(span); + + return api; + } + + /** + * Update displayed value of vertical graduation + * @param graduation: graduation to resize + */ + api.updateVerticalGraduation = function(graduation) { + if (graduation.getAttribute('cw-graduation-position') !== null) { + var power = api.round(graduation.getAttribute('cw-graduation-position') * api.max_value); + graduation.innerHTML = power + api.unit; + } + if (graduation.getAttribute('cw-absolute-graduation-position') !== null) { + var pos = graduation.getAttribute('cw-absolute-graduation-position'); + var hr_id = graduation.getAttribute('cw-absolute-graduation-hr'); + var hr = document.getElementById(hr_id); + hr.style.bottom = graduation.style.bottom = (pos / api.max_value * 100) + '%'; + var power = api.round(pos); + graduation.innerHTML = power + api.unit; + } + return api; + }; + + /** + * Change single rect vertical scale without modifying the value it represents. + * @param rect: rect to resize + * @param ratio: Value by which multiply the rect vertical scale + */ + api.scaleRect = function(rect, ratio) { + var color = rect.getElementsByClassName('rect-color')[0]; + height = parseInt(color.style.height.slice(0, -1)); + new_height = height / ratio; + color.style.height = new_height + '%'; + + var color_class = api.colorize(new_height); + color.className = color.className.replace(/[^ ]*-day/, color_class + '-day'); + return api; + }; + + /** + * Change graph vertical scale + * @param ratio: Value by which multiply the graph vertical scale + */ + api.scaleVertically = function(ratio) { + api.max_value = api.max_value * ratio; + + var rects = graph_values.children; + for (var i = 0 ; i < rects.length ; i++) { + api.scaleRect(rects[i], ratio); + } + var graduations = graph_vertical_axis.children; + for (var i = 0 ; i < graduations.length ; i++) { + api.updateVerticalGraduation(graduations[i]); + } + return api; + }; + + + /** + * @return the width of the graph in pixels + */ + api.getPixelWidth = function() { + return graph.clientWidth; + }; + + /** + * @return the width of the graph in number of values that can be displayed + */ + api.getWidth = function() { + return Math.floor(api.getPixelWidth() / (api.rect_width + api.rect_margin)); + }; + + /** + * Clean graph (remove all values) + */ + api.clean = function() { + while (graph_values.firstChild) + graph_values.removeChild(graph_values.firstChild); + while (graph_vertical_axis.firstChild) + graph_vertical_axis.removeChild(graph_vertical_axis.firstChild); + + var hr; + while (hr = document.getElementsByClassName('absolute-graduation-hr')[0]) + hr.parentNode.removeChild(hr); + } + + /** + * Hide loading icon + */ + api.stopLoading = function() { + graph_loading.style.visibility = 'hidden'; + } + + /** + * Hide loading icon + */ + api.startLoading = function() { + graph_loading.style.visibility = 'visible'; + } + + + /** + * Return a human readable legend + * @param mode: 'now', 'day', 'week', 'month' + * @param date: view date + * @param i: index + * [Static] + */ + api.getLegend = function(mode, date, i) { + switch(mode) { + case 'now': + return ''; + + case 'day': + return i + 'h - ' + (i+1) + 'h'; + + case 'week': + return dateutils.getStringDay(i); + + case 'month': + return i + ' ' + dateutils.getStringMonth(date); + } + }; + + return api; +}; + + +var PriceGraph = function(unit) { + var api = Graph(unit); + + api.type = 'price'; + + api.colorize = function(t) { + return (t > 33.3 ? (t >= 66.7 ? 'dark-blue' : 'blue') : 'light-blue'); + } + + return api; +}; + diff --git a/CitizenWatt-Base/static/js/conso/HashManager.js b/CitizenWatt-Base/static/js/conso/HashManager.js new file mode 100644 index 0000000..f87d9b1 --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/HashManager.js @@ -0,0 +1,45 @@ +var HashManager = function() { + var api = {}; + var unit, mode; + + components = location.hash.slice(1).split('-'); + unit = components[0]; + mode = components[1] || 'now'; + date = components.length > 2 ? new Date(parseInt(components[2])*1000) : null; + + api.updateHash= function(){ + var hash = '#' + unit + '-' + mode; + if (date !== null) hash += '-' + Math.floor(date.getTime() / 1000); + location.hash = hash; + }; + + api.setUnit = function(new_unit) { + unit = new_unit; + api.updateHash(); + }; + + api.getUnit = function() { + return unit; + }; + + api.setMode = function(new_mode) { + mode = new_mode; + api.updateHash(); + }; + + api.getMode = function() { + return mode; + }; + + api.setDate = function(new_date) { + date = new_date; + api.updateHash(); + }; + + api.getDate = function() { + return date; + }; + + return api; +}; + diff --git a/CitizenWatt-Base/static/js/conso/Menu.js b/CitizenWatt-Base/static/js/conso/Menu.js new file mode 100644 index 0000000..56b5a88 --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/Menu.js @@ -0,0 +1,242 @@ +/** + * Handle graph menu buttons + */ +var Menu = function() { + var api = {}; + var now_btn = document.getElementById('scale-now') + , day_btn = document.getElementById('scale-day') + , week_btn = document.getElementById('scale-week') + , month_btn = document.getElementById('scale-month') + , unit_energy = document.getElementById('unit-energy') + , unit_price = document.getElementById('unit-price') + , update_toggle = document.getElementById('update-toggle') + , prev = document.getElementById('prev') + , next = document.getElementById('next') + , mode = '' + , unit = '' + , date = null // means 'now' + , is_updated = true + ; + + api.onunitchange = function(unit, callback){}; + api.onmodechange = function(mode, callback){}; + api.ondatechange = function(date, callback){}; + + // Defined by user view width. Default to 15min + api.timeWidth = 15*60*1000; + + /** + * Add menu listeners + */ + api.init = function() { + now_btn.addEventListener('click', function() { + api.setMode('now'); + }); + + day_btn.addEventListener('click', function() { + api.setMode('day'); + }); + + week_btn.addEventListener('click', function() { + api.setMode('week'); + }); + + month_btn.addEventListener('click', function() { + api.setMode('month'); + }); + + unit_energy.addEventListener('click', function() { + api.setUnit('energy'); + }); + + unit_price.addEventListener('click', function() { + api.setUnit('price'); + }); + + prev.addEventListener('click', function() { + now_btn.className = ''; + day_btn.className = ''; + week_btn.className = ''; + month_btn.className = ''; + api.setDate(new Date((date || new Date()).getTime() - api.getTimeWidth())); + }); + + next.addEventListener('click', function() { + now_btn.className = ''; + day_btn.className = ''; + week_btn.className = ''; + month_btn.className = ''; + api.setDate(new Date((date || new Date()).getTime() + api.getTimeWidth())); + }); + + update_toggle.addEventListener('click', function() { + is_updated = !is_updated; + }); + } + + /** + * Get display mode + */ + api.getMode = function() { + return mode; + }; + + /** + * Set display mode. + * @param mode: New mode + * @param callback: (optional) + * @param fire_event: (optional) false to avoid running ondatechange + * @return boolean Whether the mode is accepted. + */ + api.setMode = function(new_mode, callback, fire_event) { + if (fire_event === undefined) fire_event = true; + now_btn.className = ''; + day_btn.className = ''; + week_btn.className = ''; + month_btn.className = ''; + switch(new_mode) { + case 'now': + now_btn.className = 'active'; + break; + case 'day': + day_btn.className = 'active'; + break; + case 'week': + week_btn.className = 'active'; + break; + case 'month': + month_btn.className = 'active'; + break; + default: + return false; + } + if (new_mode != mode || date != null) { + mode = new_mode; + + if (fire_event) api.onmodechange(mode, callback); + else if (callback) callback(); + } + else if (callback) callback(); + return true; + }; + + /** + * Set unit. + * @param unit: New unit + * @param callback: (optional) + * @param fire_event: (optional) false to avoid running ondatechange + * @return boolean Whether the unit is accepted. + */ + api.setUnit = function(new_unit, callback, fire_event) { + if (fire_event === undefined) fire_event = true; + unit_energy.className = ''; + unit_price.className = ''; + switch(new_unit) { + case 'energy': + unit_energy.className = 'active'; + break; + case 'price': + unit_price.className = 'active'; + break; + default: + return false; + } + if (new_unit != unit) { + unit = new_unit; + + if (fire_event) api.onunitchange(unit, callback); + else if (callback) callback(); + } + else if (callback) callback(); + return true; + }; + + /** + * Get unit. + */ + api.getUnit = function() { + return unit; + }; + + /** + * Get unit string, which designate unit in ascii chars. + * This is used for example in the API. + * @return unit string. + */ + api.getUnitString = function() { + return { + 'energy': mode == 'now' ? 'watts' : 'kwatthours', + 'price': 'euros' + }[unit]; + }; + + /** + * Get unit shortcut. + * This is used for displaying. + * @return unit shortcut. + */ + api.getUnitShortcut = function() { + return { + 'energy': mode == 'now' ? 'W' : 'kWh', + 'price': '€' + }[unit]; + }; + + /** + * Get date. + */ + api.getDate = function() { + return date; + }; + + /** + * Set date. + * @param date: New date + * @param callback: (optional) + * @param fire_event: (optional) false to avoid running ondatechange + */ + api.setDate = function(new_date, callback, fire_event) { + if (fire_event === undefined) fire_event = true; + if (date != new_date) { + date = new_date; + + // If 'now' view and new date near now, restore auto update + if (mode == 'now' && date !== null) { + var now = new Date(); + if (Math.abs(date.getTime() - now.getTime()) < api.timeWidth / 2) { + date = null; + } + } + + if (fire_event) api.ondatechange(unit, callback); + else if (callback) callback(); + } + else if (callback) callback(); + }; + + /** + * Return view width in milliseconds + */ + api.getTimeWidth = function() { + switch (mode) { + case 'now': + return api.timeWidth; // Written + case 'day': + return dateutils.getDayLength(); + case 'week': + return dateutils.getWeekLength(); + case 'month': + return dateutils.getMonthLength(date); + } + }; + + /** + * @return whether auto-update is activated + */ + api.isUpdated = function() { + return is_updated; + } + + + return api; +} diff --git a/CitizenWatt-Base/static/js/conso/RateDisplay.js b/CitizenWatt-Base/static/js/conso/RateDisplay.js new file mode 100644 index 0000000..156ffd9 --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/RateDisplay.js @@ -0,0 +1,28 @@ +/** + * Display rate type (day or night) in the header + */ +var RateDisplay = function() { + var api = {}; + + var logo_day = document.getElementById('rate-logo-day') + , logo_night = document.getElementById('rate-logo-night') + ; + var rate; + + api.setRate = function(new_rate) { + if (new_rate != rate) { + logo_day.style.display = logo_night.style.display = 'none'; + (new_rate == 'day' ? logo_day : logo_night).style.display = 'block'; + rate = new_rate; + } + }; + + /** + * @return current rate ('day' or 'night') + */ + api.getRate = function() { + return rate; + } + + return api; +} \ No newline at end of file diff --git a/CitizenWatt-Base/static/js/conso/tail.js b/CitizenWatt-Base/static/js/conso/tail.js new file mode 100644 index 0000000..f0dfbaf --- /dev/null +++ b/CitizenWatt-Base/static/js/conso/tail.js @@ -0,0 +1,16 @@ +/** + * Main function + * Create app, Init it and then update it regularly + */ +function init() { + var app = App(); + + app.oninit = function() { + app.update(); + setTimeout(arguments.callee, Config.update_timeout); + } + + app.init(); +} + +window.onload = init(); diff --git a/CitizenWatt-Base/static/js/dateutils.js b/CitizenWatt-Base/static/js/dateutils.js new file mode 100644 index 0000000..2d39879 --- /dev/null +++ b/CitizenWatt-Base/static/js/dateutils.js @@ -0,0 +1,212 @@ +var dateutils = (function() { + var api = {}; + + /** + * Difference between base (raspi) time and local user + */ + api.offset = 0; + + /** + * Get hour length (in milliseconds) + */ + api.getHourLength = function() { + return 3600 * 1000; + } + + /** + * Get day length (in milliseconds) + */ + api.getDayLength = function() { + return api.getHourLength() * 24; + }; + + /** + * Get current day start (in millisecond timestamp) + * @param date: (optional) Replace current date + */ + api.getDayStart = function(date) { + var date = date || new Date(); + return (new Date(date.getFullYear(), date.getMonth(), date.getDate())).getTime() + api.offset; + }; + + /** + * Get current day end (in millisecond timestamp) + * @param date: (optional) Replace current date + */ + api.getDayEnd = function(date) { + var date = date || new Date(); + var day = (date.getHours() + 6) % 7; + return (new Date(date.getFullYear(), date.getMonth(), date.getDate()+1)).getTime() + api.offset; + }; + + /** + * Get week length (in milliseconds) + */ + api.getWeekLength = function() { + return api.getDayLength() * 7; + }; + + /** + * Get current week start (in millisecond timestamp) + * @param date: (optional) Replace current date + */ + api.getWeekStart = function(date) { + var date = date || new Date(); + var day = (date.getDay() + 6) % 7; + return (new Date(date.getFullYear(), date.getMonth(), date.getDate() - day)).getTime() + api.offset; + }; + + /** + * Get current week end (in millisecond timestamp) + * @param date: (optional) Replace current date + */ + api.getWeekEnd = function(date) { + var date = date || new Date(); + var day = (date.getDay() + 6) % 7; + return (new Date(date.getFullYear(), date.getMonth(), date.getDate() - day + 7)).getTime() + api.offset; + }; + + /** + * Get current month length (in milliseconds) + * @param date: (optional) Replace current date + */ + api.getMonthLength = function(date) { + var date = date || new Date(); + return (new Date(date.getFullYear(),date.getMonth()+1,0)).getDate() * api.getDayLength(); + }; + + /** + * Get current month start (in millisecond timestamp) + * @param date: (optional) Replace current date + */ + api.getMonthStart = function(date) { + var date = date || new Date(); + return (new Date(date.getFullYear(), date.getMonth(), 1)).getTime() + api.offset; + }; + + /** + * Get current week end (in millisecond timestamp) + * @param date: (optional) Replace current date + */ + api.getMonthEnd = function(date) { + var date = date || new Date(); + return (new Date(date.getFullYear(), date.getMonth()+1, 1)).getTime() + api.offset; + }; + + /** + * Return human readable day of week + * @param i: index of day or date + */ + api.getStringDay = function(i) { + if (i.getDay !== undefined) i = (i.getDay() + 6) % 7; + return ['Lundi', 'Mardi', 'Mercredi', 'Jeudi', 'Vendredi', 'Samedi', 'Dimanche'][i]; + }; + + /** + * Return human readable month + * @param i: index of month or date + */ + api.getStringMonth = function(i) { + if (i.getMonth !== undefined) i = i.getMonth(); + return ['Janvier', 'Février', 'Mars', 'Avril', 'Mai', 'Juin', 'Juillet', 'Août', 'Septembre', 'Octobre', 'Novembre', 'Décembre'][i]; + }; + + /** + * Human readable time. Relative for first values (now, 1 min ago, etc) and then absolute. + * @param date + * @return string time + */ + api.humanTime = function(date) { + var now = new Date(); + var prefix = now > date ? 'il y a ' : 'dans '; + var diff = Math.abs(date.getTime() - now.getTime()); + if (diff < 60*1000) + return prefix + Math.round(diff / 1000) + 's'; + + if (Math.abs(date.getTime() - now.getTime()) < 3600*1000) + return prefix + Math.round(diff / 60000) + 'min';// + Math.abs(date.getSeconds() - comp.getSeconds()) + 's'; + + if (api.getDayStart(date) == api.getDayStart()) + return date.getHours() + 'h' + date.getMinutes(); + + return api.humanDay() + ' à ' + date.getHours() + 'h' + date.getMinutes(); + }; + + /** + * Human readable date. Relative for first values (today, yesterday) and then absolute. + * @param date + * @return string date + */ + api.humanDay = function(date) { + var comp = new Date(); + if (api.getDayStart(comp) == api.getDayStart(date)) + return 'aujourd\'hui'; + + comp.setDate(comp.getDate() + 1); + if (api.getDayStart(comp) == api.getDayStart(date)) + return 'demain'; + + comp.setDate(comp.getDate() - 2); + if (api.getDayStart(comp) == api.getDayStart(date)) + return 'hier'; + + if (api.getWeekStart() == api.getWeekStart(date) && date < (new Date())) + return api.getStringDay(date).toLowerCase() + ' dernier'; + + //if (api.getMonthStart() == api.getMonthStart(date)) + // return 'le ' + date.getDate(); + + return 'le ' + date.getDate() + ' ' + api.getStringMonth(date).toLowerCase(); + }; + + /** + * Human readable week. Relative for first values (this week, past week) and then absolute. + * @param date + * @return string week + */ + api.humanWeek = function(date) { + var comp = new Date(); + if (api.getWeekStart(comp) == api.getWeekStart(date)) + return 'cette semaine'; + + comp.setDate(comp.getDate() + 7); + if (api.getWeekStart(comp) == api.getWeekStart(date)) + return 'la semaine prochaine'; + + comp.setDate(comp.getDate() - 14); + if (api.getWeekStart(comp) == api.getWeekStart(date)) + return 'la semaine dernière'; + + var f = new Date(api.getWeekStart(date)); + var l = new Date(api.getWeekEnd(date) - 1); + var v + = 'entre le ' + f.getDate() + ' ' + api.getStringMonth(f) + + ' et le ' + l.getDate() + ' ' + api.getStringMonth(l); + return v.toLowerCase(); + }; + + /** + * Human readable month. + * @param date + * @return string month + */ + api.humanMonth = function(date) { + var comp = new Date(); + if (api.getMonthStart(comp) == api.getMonthStart(date)) + return 'ce mois'; + + return 'en ' + api.getStringMonth(date).toLowerCase(); + }; + + return api; +})(); + + +/* +// Exports all for unit testing +for (var property in dateutils) { + if (dateutils.hasOwnProperty(property)) { + exports[property] = dateutils[property]; + } +} +//*/ \ No newline at end of file diff --git a/CitizenWatt-Base/static/js/target.js b/CitizenWatt-Base/static/js/target.js new file mode 100644 index 0000000..f8d0808 --- /dev/null +++ b/CitizenWatt-Base/static/js/target.js @@ -0,0 +1,29 @@ + +function init() { + var target_ok = document.getElementById('target-ok') + , target_wip = document.getElementById('target-wip') + , target_no = document.getElementById('target-no') + , target_more = document.getElementById('target-more') + ; + + target_ok.style.display = 'block'; + target_wip.style.display = 'block'; + target_no.style.display = 'block'; + target_more.style.display = 'none'; + switch (location.hash) { + case '#ok': + target_wip.style.display = 'none'; + target_no.style.display = 'none'; + target_more.style.display = 'block'; + break; + + case '#wip': + target_ok.style.display = 'none'; + target_no.style.display = 'none'; + target_more.style.display = 'block'; + break; + } +} + +window.onload = init(); +window.addEventListener('hashchange', init); diff --git a/CitizenWatt-Base/static/js/utils.js b/CitizenWatt-Base/static/js/utils.js new file mode 100644 index 0000000..65db847 --- /dev/null +++ b/CitizenWatt-Base/static/js/utils.js @@ -0,0 +1,15 @@ + +/** + * @param length: Length of random string + * @return random string + */ +function rand64(length) { + var text = ""; + var alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-"; + + for (var i = length - 1; i >= 0; i--) { + text += alphabet.charAt(Math.floor(Math.random() * alphabet.length)); + } + + return text; +} diff --git a/CitizenWatt-Base/system/README.md b/CitizenWatt-Base/system/README.md new file mode 100644 index 0000000..f675e3d --- /dev/null +++ b/CitizenWatt-Base/system/README.md @@ -0,0 +1,9 @@ +CitizenWatt System scripts +========================== + +Launch these two scripts as root, with bash : +- sudo bash install_python34.sh +- sudo bash cleanup_raspbian.sh (removes Gnome UI) + + +* citizenwatt.sh is a Debian service to add to startup in /etc/init.d diff --git a/CitizenWatt-Base/system/citizenwatt.sh b/CitizenWatt-Base/system/citizenwatt.sh new file mode 100755 index 0000000..1e6c0bd --- /dev/null +++ b/CitizenWatt-Base/system/citizenwatt.sh @@ -0,0 +1,31 @@ +#### BEGIN INIT INFO +# Provides: citizenwatt +# Required-Start: +# Required-Stop: +# Should-Start: +# Should-Stop: +# Default-Start: 1 2 3 4 5 +# Default-Stop: 0 6 +# Short-Description: startup script for citizenwatt +#### END INIT INFO + +#!/bin/sh + +echo "Starting the webserver…" +screen -dmS visu && screen -S visu -p 0 -X stuff "while true; do python3 visu.py; done$(printf \\r)" + +echo "Starting receive script…" +screen -dmS receive && screen -S receive -p 0 -X stuff "while true; do ./receive; done$(printf \\r)" +echo "Done !\n" +sleep 0.2 +echo "Starting processing script…" +screen -dmS process && screen -S process -p 0 -X stuff "while true; do python3 process.py; done$(printf \\r)" +echo "Done !\n" + +while ! curl -s --head http://localhost:8080 2>&1 > /dev/null; do + echo "Webserver is starting…" + sleep 1 +done +echo "Webserver started !\n" + +echo "Ready to start !" diff --git a/CitizenWatt-Base/system/cleanup_raspbian.sh b/CitizenWatt-Base/system/cleanup_raspbian.sh new file mode 100644 index 0000000..1327d2b --- /dev/null +++ b/CitizenWatt-Base/system/cleanup_raspbian.sh @@ -0,0 +1,23 @@ +# Citizenwatt Raspbian cleanup script +# Launch as root + +# Remove useless packages +apt-get --yes purge x11-common lxde dillo gnome-icon-theme \ + gnome-themes-standard-data libgnome-keyring-common libgnome-keyring0 \ + libsoup-gnome2.4-1 lxde-common lxde-icon-theme omxplayer dbus-x11 libx11-6 \ + libx11-data libx11-xcb1 desktop-file-utils debian-reference-en \ + debian-reference-common java-common + +apt-get --yes install mysql-client mysql-server avahi-daemon + +# Remove unused packets +apt-get --yes autoremove --purge + +# Clear APT cache +#apt-get clean + +rm -rf /opt/vc /home/pi/Desktop /home/pi/python_games /home/pi/ocr_pi.png + +# Do updates +apt-get update && apt-get upgrade --yes + diff --git a/CitizenWatt-Base/system/install_citizenwatt.sh b/CitizenWatt-Base/system/install_citizenwatt.sh new file mode 100644 index 0000000..1c26f59 --- /dev/null +++ b/CitizenWatt-Base/system/install_citizenwatt.sh @@ -0,0 +1,35 @@ +# Citizenwatt install script +# Launch as root + +# Change Hostname +echo "citizenwatt" > /etc/hostname + +# Add citizenWatt repository +echo "deb http://ks.citoyenscapteurs.net/repos/apt/debian/ wheezy main" > /etc/apt/sources.list.d/citizenwatt.list + +# Add our GPG key +wget -O - http://ks.citoyenscapteurs.net/repos/apt/citizenwatt.public.key | apt-key add - + +# Install Python +/bin/bash install_python34.sh + +# Install packages +# TODO : add citizenwatt-visu +apt-get --yes install librf24-dev postgresql supervisor avahi-daemon redis-server iptables-persistent + +# Install Python module deps +apt-get -t jessie --yes install postgresql-server-dev-all + +# Python modules +pip3 install requests sqlalchemy pycrypto numpy cherrypy psycopg2 redis + +# Database setup +su - postgresql +psql -c "CREATE DATABASE citizenwatt;" +psql -c "CREATE USER citizenwatt PASSWORD 'citizenwatt';" +psql -c "GRANT ALL ON DATABASE citizenwatt TO citizenwatt;" +exit + +# Firewall setup +iptables -t nat -A PREROUTING -p tcp --dport 80 -j DNAT --to-destination :8080 +/etc/init.d/iptables-persistent save diff --git a/CitizenWatt-Base/system/install_python34.sh b/CitizenWatt-Base/system/install_python34.sh new file mode 100644 index 0000000..23164b1 --- /dev/null +++ b/CitizenWatt-Base/system/install_python34.sh @@ -0,0 +1,17 @@ +# Python 3.4 install script +# Launch as root + +# Add testing sources +echo "deb http://mirrordirector.raspbian.org/raspbian/ jessie main" > /etc/apt/sources.list.d/jessie.list + +# Pinning +echo -e "Package: *\nPin: release a=testing\nPin-Priority: 300" > /etc/apt/preferences.d/jessie.pref + +# Update +apt-get update + +# Install +apt-get -t jessie --yes install python3 gcc python3-pip python3-dev + +# Remove unused packets (ie. Python3.2) +apt-get --yes autoremove --purge diff --git a/CitizenWatt-Base/system/install_rf24.sh b/CitizenWatt-Base/system/install_rf24.sh new file mode 100644 index 0000000..fbd6cd9 --- /dev/null +++ b/CitizenWatt-Base/system/install_rf24.sh @@ -0,0 +1,14 @@ +# CD to home +cd + +# Get RF24 +git clone https://github.com/stanleyseow/RF24.git RF24 + +# Checkout to our version +cd RF24 +git checkout 2a1a4e6e27056844a3bc419d65b8a2d4e0f1770e + +# Build +cd librf24-rpi/librf24 +make +sudo make install diff --git a/CitizenWatt-Base/system/supervisor_citizenwatt.conf b/CitizenWatt-Base/system/supervisor_citizenwatt.conf new file mode 100644 index 0000000..3994963 --- /dev/null +++ b/CitizenWatt-Base/system/supervisor_citizenwatt.conf @@ -0,0 +1,34 @@ +[program:receive] +command=/opt/citizenwatt/receive +autostart=true +autorestart=true +startsecs=10 +startretries=10 +user=pi +environment = HOME="/home/pi",USER="pi" +stdout_logfile = NONE +#stderr_logfile = NONE + +[program:process] +command=/usr/bin/python3 /opt/citizenwatt/process.py +directory=/opt/citizenwatt/ +autostart=true +autorestart=true +startsecs=10 +startretries=10 +user=pi +environment = HOME="/home/pi",USER="pi" +stdout_logfile = NONE +#stderr_logfile = NONE + +[program:visu] +command=/usr/bin/python3 /opt/citizenwatt/visu.py +directory=/opt/citizenwatt/ +autostart=true +autorestart=true +startsecs=10 +startretries=10 +user=pi +environment = HOME="/home/pi",USER="pi" +stdout_logfile = NONE +#stderr_logfile = NONE diff --git a/CitizenWatt-Base/tests/libcitizenwatt b/CitizenWatt-Base/tests/libcitizenwatt new file mode 120000 index 0000000..75c9d9c --- /dev/null +++ b/CitizenWatt-Base/tests/libcitizenwatt @@ -0,0 +1 @@ +../libcitizenwatt \ No newline at end of file diff --git a/CitizenWatt-Base/tests/test_process.py b/CitizenWatt-Base/tests/test_process.py new file mode 100755 index 0000000..c31c3e5 --- /dev/null +++ b/CitizenWatt-Base/tests/test_process.py @@ -0,0 +1,73 @@ +#!/usr/bin/env python3 +"""Generate test data instead of piping from the sensor.""" + +import datetime +import random +import time +import math + +from libcitizenwatt import database +from libcitizenwatt import tools +from libcitizenwatt.config import Config +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + + +def get_rate_type(db): + """Returns "day" or "night" according to current time + """ + user = db.query(database.User).filter_by(is_admin=1).first() + now = datetime.datetime.now() + now = 3600 * now.hour + 60 * now.minute + if user is None: + return -1 + elif user.end_night_rate > user.start_night_rate: + if now > user.start_night_rate and now < user.end_night_rate: + return 1 + else: + return 0 + else: + if now > user.start_night_rate or now < user.end_night_rate: + return 1 + else: + return 0 + + +# Configuration +config = Config() + +# DB initialization +database_url = (config.get("database_type") + "://" + config.get("username") + ":" + + config.get("password") + "@" + config.get("host") + "/" + + config.get("database")) +engine = create_engine(database_url, echo=config.get("debug")) +create_session = sessionmaker(bind=engine) +database.Base.metadata.create_all(engine) + +try: + while True: + power = random.randint(0, 4000) + power = math.sin(time.clock()*2)**2 * 2000 + print("New encrypted packet:" + str(power)) + + db = create_session() + sensor = (db.query(database.Sensor) + .filter_by(name="CitizenWatt") + .first()) + if not sensor: + tools.warning("Got packet "+str(power)+" but install is not " + + "complete ! Visit http://citizenwatt first.") + db.close() + else: + now = datetime.datetime.now().timestamp() + measure_db = database.Measures(sensor_id=sensor.id, + value=power, + timestamp=now, + night_rate=get_rate_type(db)) + db.add(measure_db) + db.commit() + print(now) + print("Saved successfully.") + time.sleep(8) +except KeyboardInterrupt: + pass diff --git a/CitizenWatt-Base/tests/tests.js b/CitizenWatt-Base/tests/tests.js new file mode 100644 index 0000000..15e665f --- /dev/null +++ b/CitizenWatt-Base/tests/tests.js @@ -0,0 +1,48 @@ +#!/usr/bin/node + +/* You have to uncomment the latest lines of ../static/js/datetutils.js to use these tests. */ + +var assert = require('assert'); +var dateutils = require('../static/js/dateutils'); + +assert(dateutils.getHourLength() == 3600 * 1000, 'Hour length'); +assert(dateutils.getDayLength() == 86400 * 1000, 'Day length' ); +assert(dateutils.getWeekLength() == 604800 * 1000, 'Week length'); + +assert(dateutils.getMonthLength(new Date(2000,1,0)) == 31*86400*1000, 'January length' ); +assert(dateutils.getMonthLength(new Date(2000,2,0)) == 29*86400*1000, 'February length'); +assert(dateutils.getMonthLength(new Date(2000,3,0)) == 31*86400*1000, 'March length' ); +assert(dateutils.getMonthLength(new Date(2000,4,0)) == 30*86400*1000, 'April length' ); +assert(dateutils.getMonthLength(new Date(2000,5,0)) == 31*86400*1000, 'May length' ); + +var d = new Date(2000,5,27,12,5,45,0); +assert(dateutils.getDayStart(d) == (new Date(2000,5,27,0,0,0,0)).getTime(), '[1] Day start' ); +assert(dateutils.getDayEnd(d) == (new Date(2000,5,28,0,0,0,0)).getTime(), '[1] Day end' ); +assert(dateutils.getWeekStart(d) == (new Date(2000,5,26,0,0,0,0)).getTime(), '[1] Week start' ); +assert(dateutils.getWeekEnd(d) == (new Date(2000,6, 3,0,0,0,0)).getTime(), '[1] Week end' ); +assert(dateutils.getMonthStart(d) == (new Date(2000,5, 1,0,0,0,0)).getTime(), '[1] Month start'); +assert(dateutils.getMonthEnd(d) == (new Date(2000,6, 1,0,0,0,0)).getTime(), '[1] Month end' ); + +var d = new Date(1999,11,30,18,12,9,0); +assert(dateutils.getDayStart(d) == (new Date(1999,11,30,0,0,0,0)).getTime(), '[2] Day start' ); +assert(dateutils.getDayEnd(d) == (new Date(1999,11,31,0,0,0,0)).getTime(), '[2] Day end' ); +assert(dateutils.getWeekStart(d) == (new Date(1999,11,27,0,0,0,0)).getTime(), '[2] Week start' ); +assert(dateutils.getWeekEnd(d) == (new Date(2000, 0, 3,0,0,0,0)).getTime(), '[2] Week end' ); +assert(dateutils.getMonthStart(d) == (new Date(1999,11, 1,0,0,0,0)).getTime(), '[2] Month start'); +assert(dateutils.getMonthEnd(d) == (new Date(2000, 0, 1,0,0,0,0)).getTime(), '[2] Month end' ); + +console.log(dateutils.getWeekEnd(d) - dateutils.getWeekStart(d)) +assert(dateutils.getDayEnd(d) - dateutils.getDayStart(d) == dateutils.getDayLength() , 'Day length consistency '); +assert(dateutils.getWeekEnd(d) - dateutils.getWeekStart(d) == dateutils.getWeekLength() , 'Week length consistency '); +assert(dateutils.getMonthEnd(d) - dateutils.getMonthStart(d) == dateutils.getMonthLength(d), 'Month length consistency'); + +assert(dateutils.getStringDay(3) == 'Jeudi' , 'String day by index' ); +assert(dateutils.getStringDay(d) == 'Jeudi' , 'String day by date' ); +assert(dateutils.getStringMonth(11) == 'Décembre', 'String month by index'); +assert(dateutils.getStringMonth( d) == 'Décembre', 'String month by date' ); + +assert(dateutils.humanDay(d) == 'le 30 décembre' , 'Human date' ); +assert(dateutils.humanWeek(d) == 'entre le 27 décembre et le 2 janvier', 'Human week' ); +assert(dateutils.humanMonth(d) == 'en décembre' , 'Human month'); + +console.log('Everything is ok.') diff --git a/CitizenWatt-Base/updater.sh b/CitizenWatt-Base/updater.sh new file mode 100755 index 0000000..a9bf588 --- /dev/null +++ b/CitizenWatt-Base/updater.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/CitizenWatt-Base/views/_begin.tpl b/CitizenWatt-Base/views/_begin.tpl new file mode 100644 index 0000000..cf61d92 --- /dev/null +++ b/CitizenWatt-Base/views/_begin.tpl @@ -0,0 +1,34 @@ + + + + + CitizenWatt — {{ title }} + + + + + +
+
+ + + + + % if valid_session(): + + % end +
diff --git a/CitizenWatt-Base/views/_end.tpl b/CitizenWatt-Base/views/_end.tpl new file mode 100644 index 0000000..a76cdf8 --- /dev/null +++ b/CitizenWatt-Base/views/_end.tpl @@ -0,0 +1,27 @@ + +