commit 3baf68b4df709c039d8c3d856891afebd6077949 Author: Arturo Filastò <art@fuffa.org> Date: Sun Nov 11 00:40:50 2012 +0100 Implement basic reporting to flat files containing the report ID. * XXX the location of such files is not configurable, they will leave tons of crap in your cwd. --- oonib/report/api.py | 123 ++++++++++++++++++++++++++++++++++++++++++++++---- 1 files changed, 113 insertions(+), 10 deletions(-) diff --git a/oonib/report/api.py b/oonib/report/api.py index 1a4746a..489cc25 100644 --- a/oonib/report/api.py +++ b/oonib/report/api.py @@ -9,6 +9,8 @@ This is the async pcap reporting system. It requires the client to have created import random import string import json +import re +from ooni.utils import randomStr from twisted.internet import reactor, defer @@ -21,12 +23,118 @@ backend_version = '0.0.1' def updateReport(report_id, content): print "Report ID: %s" % report_id print "Content: %s" % content - return {'backend_version': backend_version, 'report_id': report_id} -class NewReportHandler(web.RequestHandler): +def generateReportID(): + return randomStr(100) + +class MissingField(Exception): + pass + +class InvalidRequestField(Exception): + pass + +def parseNewReportRequest(request): + """ + Here we parse a new report request. + """ + version_string = re.compile("[0-9A-Za-z_\-\.]+$") + name = re.compile("[a-zA-Z0-9_\- ]+$") + expected_request = {'software_name': name, + 'software_version': version_string, + 'test_name': name, + 'test_version': version_string, + 'progress': re.compile("[0-9]+$") + } + parsed_request = json.loads(request) + for k, regexp in expected_request.items(): + try: + value_to_check = parsed_request[k] + except KeyError: + raise MissingField(k) + print "Matching %s with %s | %s" % (regexp, value_to_check, k) + if re.match(regexp, str(value_to_check)): + continue + else: + raise InvalidRequestField(k) + return parsed_request + +class NewReportHandlerFile(web.RequestHandler): + """ + Responsible for creating and updating reports by writing to flat file. + """ + def post(self): + """ + Creates a new report with the input + + * Request + + {'software_name': 'XXX', + 'software_version': 'XXX', + 'test_name': 'XXX', + 'test_version': 'XXX', + 'progress': 'XXX', + 'content': 'XXX' + } + + Optional: + 'test_helper': 'XXX' + 'client_ip': 'XXX' + + * Response + + {'backend_version': 'XXX', 'report_id': 'XXX'} + + """ + # XXX here we should validate and sanitize the request + try: + report_data = parseNewReportRequest(self.request.body) + except InvalidRequestField, e: + raise web.HTTPError(400, "Invalid Request Field %s" % e) + except MissingField, e: + raise web.HTTPError(400, "Missing Request Field %s" % e) + + print "Parsed this data %s" % report_data + software_name = report_data['software_name'] + software_version = report_data['software_version'] + test_name = report_data['test_name'] + test_version = report_data['test_version'] + content = report_data['content'] + + report_id = generateReportID() + + #report_filename = '_'.join((report_id, + # report_data['software_name'], + # report_data['software_version'], + # report_data['test_name'], + # report_data['test_version'])) + + report_filename = report_id + report_filename += '.yamloo' + + response = {'backend_version': backend_version, + 'report_id': report_id + } + + fp = open(report_filename, 'w+') + fp.write(report_data['content']) + fp.close() + self.write(response) + + def put(self): + """ + Update an already existing report. + + {'report_id': 'XXX', + 'content': 'XXX' + } + """ + pass + +class NewReportHandlerDB(web.RequestHandler): """ - Responsible for creating and updating reports. + Responsible for creating and updating reports via database. + XXX this is not yet fully implemented. """ @web.asynchronous @@ -55,16 +163,11 @@ class NewReportHandler(web.RequestHandler): """ parsed_request = json.loads(self.request.body) - # XXX here we should validate and sanitize the request - report_data = parsed_request - new_report = models.Report() - print "Got %s as request" % parsed_request result = yield new_report.new(report_data) - self.write(result) self.finish() @@ -85,7 +188,7 @@ class PCAPReportHandler(web.RequestHandler): def post(self): pass -spec = [(r"/report/new", NewReportHandler), +spec = [(r"/report/new", NewReportHandlerFile), (r"/report/pcap", PCAPReportHandler)] -reportingBackend = web.Application(spec) +reportingBackend = web.Application(spec, debug=True)