bbj/server.py

564 lines
19 KiB
Python
Raw Normal View History

2017-04-02 14:53:55 +00:00
from src.exceptions import BBJException, BBJParameterError, BBJUserError
2017-04-11 20:31:01 +00:00
from src import db, schema, formatting
2017-04-02 07:35:58 +00:00
from functools import wraps
2017-04-02 14:53:55 +00:00
from uuid import uuid1
2017-04-13 07:08:19 +00:00
from sys import argv
2017-04-02 14:53:55 +00:00
import traceback
2017-04-02 07:35:58 +00:00
import cherrypy
import sqlite3
import json
dbname = "data.sqlite"
2017-04-28 00:07:18 +00:00
debug = False
def api_method(function):
2017-04-02 07:35:58 +00:00
"""
A wrapper that handles encoding of objects and errors to a
standard format for the API, resolves and authorizes users
from header data, and prepares the arguments for each method.
In the body of each api method and all the functions
they utilize, BBJExceptions are caught and their attached
schema is dispatched to the client. All other unhandled
exceptions will throw a code 1 back at the client and log
2017-04-02 14:53:55 +00:00
it for inspection. Errors related to JSON decoding are
caught as well and returned to the client as code 0.
2017-04-02 07:35:58 +00:00
"""
function.exposed = True
2017-04-02 07:35:58 +00:00
@wraps(function)
def wrapper(self, *args, **kwargs):
response = None
try:
connection = sqlite3.connect(dbname)
2017-04-02 14:53:55 +00:00
# read in the body from the request to a string...
if cherrypy.request.method == "POST":
body = str(cherrypy.request.body.read(), "utf8")
else:
body = ""
# the body may be empty, not all methods require input
2017-04-02 14:53:55 +00:00
if body:
body = json.loads(body)
if isinstance(body, dict):
# lowercase all of its top-level keys
2017-04-03 08:52:51 +00:00
body = {key.lower(): value for key, value in body.items()}
2017-04-02 14:53:55 +00:00
username = cherrypy.request.headers.get("User")
auth = cherrypy.request.headers.get("Auth")
2017-04-28 00:07:18 +00:00
if debug:
print("Body: {}\n\n-----------\n{}".format(body, (username, auth)))
if (username and not auth) or (auth and not username):
raise BBJParameterError("User or Auth was given without the other.")
2017-04-02 07:35:58 +00:00
elif not username and not auth:
user = db.anon
else:
user = db.user_resolve(connection, username)
2017-04-02 14:53:55 +00:00
if not user:
raise BBJUserError("User %s is not registered" % username)
2017-04-28 00:31:19 +00:00
elif auth.lower() != user["auth_hash"].lower():
raise BBJException(5, "Invalid authorization key for user.")
2017-04-02 07:35:58 +00:00
# api_methods may choose to bind a usermap into the thread_data
# which will send it off with the response
cherrypy.thread_data.usermap = {}
value = function(self, body, connection, user)
response = schema.response(value, cherrypy.thread_data.usermap)
2017-04-02 14:53:55 +00:00
2017-04-02 07:35:58 +00:00
except BBJException as e:
response = e.schema
2017-04-02 07:35:58 +00:00
except json.JSONDecodeError as e:
response = schema.error(0, str(e))
2017-04-02 07:35:58 +00:00
except Exception as e:
2017-04-02 14:53:55 +00:00
error_id = uuid1().hex
response = schema.error(1,
"Internal server error: code {} {}"
.format(error_id, repr(e)))
2017-04-02 14:53:55 +00:00
with open("logs/exceptions/" + error_id, "a") as log:
traceback.print_tb(e.__traceback__, file=log)
log.write(repr(e))
print("logged code 1 exception " + error_id)
finally:
connection.close()
return json.dumps(response)
2017-04-02 07:35:58 +00:00
return wrapper
def create_usermap(connection, obj, index=False):
2017-04-02 07:35:58 +00:00
"""
Creates a mapping of all the user_ids that occur in OBJ to
their full user objects (names, profile info, etc). Can
be a thread_index or a messages object from one.
"""
user_set = {item["author"] for item in obj}
if index:
[user_set.add(item["last_author"]) for item in obj]
2017-04-02 07:35:58 +00:00
return {
user_id: db.user_resolve(
connection,
user_id,
externalize=True,
return_false=False)
for user_id in user_set
2017-04-02 07:35:58 +00:00
}
def do_formatting(format_spec, messages):
if not format_spec:
return None
elif format_spec == "sequential":
method = formatting.sequential_expressions
else:
raise BBJParameterError("invalid formatter specification")
formatting.apply_formatting(messages, method)
return True
2017-04-02 07:35:58 +00:00
def validate(json, args):
"""
Ensure the json object contains all the keys needed to satisfy
2017-04-02 14:53:55 +00:00
its endpoint (and isnt empty)
2017-04-02 07:35:58 +00:00
"""
2017-04-02 14:53:55 +00:00
if not json:
raise BBJParameterError(
"JSON input is empty. This method requires the following "
"arguments: {}".format(", ".join(args)))
2017-04-02 07:35:58 +00:00
for arg in args:
if arg not in json.keys():
raise BBJParameterError(
2017-04-02 14:53:55 +00:00
"Required parameter {} is absent from the request. "
"This method requires the following arguments: {}"
.format(arg, ", ".join(args)))
2017-04-02 07:35:58 +00:00
class API(object):
"""
This object contains all the API endpoints for bbj.
The html serving part of the server is not written
yet, so this is currently the only module being
served.
"""
@api_method
def user_register(self, args, database, user, **kwargs):
"""
Register a new user into the system and return the new object.
Requires the string arguments `user_name` and `auth_hash`.
Do not send User/Auth headers with this method.
"""
validate(args, ["user_name", "auth_hash"])
return db.user_register(
database, args["user_name"], args["auth_hash"])
@api_method
def user_update(self, args, database, user, **kwargs):
"""
Receives new parameters and assigns them to the user_object
in the database. The following new parameters can be supplied:
`user_name`, `auth_hash`, `quip`, `bio`, and `color`. Any number
of them may be supplied.
The newly updated user object is returned on success.
"""
if user == db.anon:
raise BBJParameterError("Anons cannot modify their account.")
validate(args, []) # just make sure its not empty
return db.user_update(database, user, args)
@api_method
def get_me(self, args, database, user, **kwargs):
"""
Requires no arguments. Returns your internal user object,
including your authorization hash.
"""
return user
2017-04-28 00:07:18 +00:00
@api_method
def user_map(self, args, database, user, **kwargs):
"""
Returns an array with all registered user_ids, with the usermap
object populated by their full objects.
"""
users = {user[0] for user in database.execute("SELECT user_id FROM users")}
cherrypy.thread_data.usermap = {
user: db.user_resolve(
database,
user,
externalize=True,
return_false=False)
for user in users
}
return list(users)
@api_method
def user_get(self, args, database, user, **kwargs):
"""
Retreive an external user object for the given `user`.
Can be a user_id or user_name.
"""
2017-04-02 14:53:55 +00:00
validate(args, ["user"])
return db.user_resolve(
database, args["user"], return_false=False, externalize=True)
@api_method
def user_is_registered(self, args, database, user, **kwargs):
"""
Takes the argument `target_user` and returns true or false
whether they are in the system or not.
"""
validate(args, ["target_user"])
return bool(db.user_resolve(database, args["target_user"]))
@api_method
def check_auth(self, args, database, user, **kwargs):
"""
Takes the arguments `target_user` and `target_hash`, and
returns boolean true or false whether the hash is valid.
"""
validate(args, ["target_user", "target_hash"])
user = db.user_resolve(database, args["target_user"], return_false=False)
2017-04-28 00:31:19 +00:00
return args["target_hash"].lower() == user["auth_hash"].lower()
@api_method
def thread_index(self, args, database, user, **kwargs):
"""
Return an array with all the threads, ordered by most recent activity.
Requires no arguments.
"""
threads = db.thread_index(database)
cherrypy.thread_data.usermap = create_usermap(database, threads, True)
return threads
2017-04-02 07:35:58 +00:00
2017-04-26 19:51:03 +00:00
@api_method
def message_feed(self, args, database, user, **kwargs):
"""
Returns a special object representing all activity on the board since
the argument `time`, a unix/epoch timestamp.
{
"threads": {
"thread_id": {
...thread object
},
...more thread_id/object pairs
},
"messages": [...standard message object array sorted by date]
}
The message objects in "messages" are the same objects returned
in threads normally. They each have a thread_id parameter, and
you can access metadata for these threads by the "threads" object
which is also provided.
The "messages" array is already sorted by submission time, newest
first. The order in the threads object is undefined and you should
instead use their `last_mod` attribute if you intend to list them
out visually.
You may optionally provide a `format` argument: this is treated
the same way as the `thread_load` endpoint and you should refer
to its documentation for more info.
2017-04-26 19:51:03 +00:00
"""
validate(args, ["time"])
feed = db.message_feed(database, args["time"])
_map = create_usermap(database, feed["messages"])
_map.update(create_usermap(database, feed["threads"].values(), True))
cherrypy.thread_data.usermap.update(_map)
2017-04-26 19:51:03 +00:00
do_formatting(args.get("format"), feed["messages"])
return feed
2017-04-26 19:51:03 +00:00
@api_method
def thread_create(self, args, database, user, **kwargs):
"""
Creates a new thread and returns it. Requires the non-empty
string arguments `body` and `title`.
If the argument `send_raw` is specified and has a non-nil
value, the OP message will never recieve special formatting.
"""
2017-04-02 07:35:58 +00:00
validate(args, ["body", "title"])
thread = db.thread_create(
database, user["user_id"], args["body"],
args["title"], args.get("send_raw"))
cherrypy.thread_data.usermap = \
create_usermap(database, thread["messages"])
return thread
2017-04-02 07:35:58 +00:00
@api_method
def thread_reply(self, args, database, user, **kwargs):
"""
Creates a new reply for the given thread and returns it.
Requires the string arguments `thread_id` and `body`
If the argument `send_raw` is specified and has a non-nil
value, the message will never recieve special formatting.
"""
2017-04-02 07:35:58 +00:00
validate(args, ["thread_id", "body"])
return db.thread_reply(
database, user["user_id"], args["thread_id"],
args["body"], args.get("send_raw"))
2017-04-02 07:35:58 +00:00
@api_method
def thread_load(self, args, database, user, **kwargs):
"""
Returns the thread object with all of its messages loaded.
Requires the argument `thread_id`. `format` may also be
specified as a formatter to run the messages through.
Currently only "sequential" is supported.
"""
2017-04-02 07:35:58 +00:00
validate(args, ["thread_id"])
thread = db.thread_get(database, args["thread_id"])
cherrypy.thread_data.usermap = \
create_usermap(database, thread["messages"])
do_formatting(args.get("format"), thread["messages"])
return thread
2017-04-02 07:35:58 +00:00
@api_method
def edit_post(self, args, database, user, **kwargs):
"""
Replace a post with a new body. Requires the arguments
`thread_id`, `post_id`, and `body`. This method verifies
that the user can edit a post before commiting the change,
otherwise an error object is returned whose description
should be shown to the user.
To perform sanity checks and retrieve the unformatted body
of a post without actually attempting to replace it, use
`edit_query` first.
Optionally you may also include the argument `send_raw` to
set the message's formatting flag. However, if this is the
only change you would like to make, you should use the
endpoint `set_post_raw` instead.
Returns the new message object.
"""
if user == db.anon:
raise BBJUserError("Anons cannot edit messages.")
validate(args, ["body", "thread_id", "post_id"])
return db.message_edit_commit(
database, user["user_id"], args["thread_id"],
args["post_id"], args["body"], args.get("send_raw"))
2017-04-02 07:35:58 +00:00
@api_method
def delete_post(self, args, database, user, **kwargs):
"""
Requires the arguments `thread_id` and `post_id`.
Delete a message from a thread. The same rules apply
here as `edit_post` and `edit_query`: the logged in user
must either be the one who posted the message within 24hrs,
or have admin rights. The same error descriptions and code
are returned on falilure. Boolean true is returned on
success.
If the post_id is 0, the whole thread is deleted.
"""
if user == db.anon:
raise BBJUserError("Anons cannot delete messages.")
validate(args, ["thread_id", "post_id"])
return db.message_delete(
database, user["user_id"], args["thread_id"], args["post_id"])
@api_method
def set_post_raw(self, args, database, user, **kwargs):
"""
Requires the boolean argument of `value`, string argument
`thread_id`, and integer argument `post_id`. `value`, when false,
means that the message will be passed through message formatters
before being sent to clients. When `value` is true, this means
it will never go through formatters, all of its whitespace is
sent to clients verbatim and expressions are not processed.
The same rules for editing messages (see `edit_query`) apply here
and the same error objects are returned for violations.
You may optionally set this value as well when using `edit_post`,
but if this is the only change you want to make to the message,
using this endpoint instead is preferable.
"""
if user == db.anon:
raise BBJUserError("Anons cannot edit messages.")
validate(args, ["value", "thread_id", "post_id"])
return db.message_edit_commit(
database, user["user_id"],
args["thread_id"], args["post_id"],
None, args["value"], None)
@api_method
def is_admin(self, args, database, user, **kwargs):
"""
Requires the argument `target_user`. Returns a boolean
of whether that user is an admin.
"""
validate(args, ["target_user"])
user = db.user_resolve(database, args["target_user"], return_false=False)
return user["is_admin"]
@api_method
def edit_query(self, args, database, user, **kwargs):
"""
Queries the database to ensure the user can edit a given
message. Requires the arguments `thread_id` and `post_id`
(does not require a new body)
Returns the original message object without any formatting
on success. Returns a descriptive code 4 otherwise.
"""
if user == db.anon:
raise BBJUserError("Anons cannot edit messages.")
2017-04-02 07:35:58 +00:00
validate(args, ["thread_id", "post_id"])
return db.message_edit_query(
database, user["user_id"], args["thread_id"], args["post_id"])
2017-04-02 07:35:58 +00:00
@api_method
def format_message(self, args, database, user, **kwargs):
"""
Requires the arguments `body` and `format`. Applies
`format` to `body` and returns the new object. See
`thread_load` for supported specifications for `format`.
"""
validate(args, ["format", "body"])
message = [{"body": args["body"]}]
do_formatting(args["format"], message)
return message[0]["body"]
@api_method
2017-04-08 07:27:05 +00:00
def set_thread_pin(self, args, database, user, **kwargs):
"""
Requires the arguments `thread_id` and `value`. `value`
2017-04-08 07:27:05 +00:00
must be a boolean of what the pinned status should be.
This method requires that the caller is logged in and
has admin status on their account.
Returns the same boolean you supply as `value`
2017-04-08 07:27:05 +00:00
"""
validate(args, ["thread_id", "value"])
2017-04-08 07:27:05 +00:00
if not user["is_admin"]:
raise BBJUserError("Only admins can set thread pins")
return db.set_thread_pin(database, args["thread_id"], args["value"])
2017-04-08 07:27:05 +00:00
@api_method
def db_validate(self, args, database, user, **kwargs):
"""
Requires the arguments `key` and `value`. Returns an object
with information about the database sanity criteria for
key. This can be used to validate user input in the client
before trying to send it to the server.
If the argument `error` is supplied with a non-nil value,
the server will return a standard error object on failure
instead of the special object described below.
The returned object has two keys:
{
"bool": true/false,
"description": null/"why this value is bad"
}
If bool == false, description is a string describing the
problem. If bool == true, description is null and the
provided value is safe to use.
"""
validate(args, ["key", "value"])
response = dict()
try:
db.validate([(args["key"], args["value"])])
response["bool"] = True
response["description"] = None
except BBJException as e:
if args.get("error"):
raise
response["bool"] = False
response["description"] = e.description
return response
def api_http_error(status, message, traceback, version):
return json.dumps(schema.error(2, "HTTP error {}: {}".format(status, message)))
CONFIG = {
"/": {
"error_page.default": api_http_error
}
}
2017-04-02 07:35:58 +00:00
def run():
# user anonymity is achieved in the laziest possible way: a literal user
# named anonymous. may god have mercy on my soul.
_c = sqlite3.connect(dbname)
try:
db.anon = db.user_resolve(_c, "anonymous")
if not db.anon:
db.anon = db.user_register(
_c, "anonymous", # this is the hash for "anon"
"5430eeed859cad61d925097ec4f53246"
"1ccf1ab6b9802b09a313be1478a4d614")
finally:
_c.close()
cherrypy.quickstart(API(), "/api", CONFIG)
2017-04-02 07:35:58 +00:00
if __name__ == "__main__":
2017-04-13 07:08:19 +00:00
try:
port_spec = argv.index("--port")
port = argv[port_spec+1]
except ValueError: # --port not specified
port = 7099
except IndexError: # flag given but no value
exit("thats not how this works, silly! --port 7099")
try:
host_spec = argv.index("--host")
host = argv[host_spec+1]
except ValueError: # --host not specified
host = "127.0.0.1"
except IndexError: # flag given but no value
exit("thats not how this works, silly! --host 127.0.0.1")
2017-04-28 00:07:18 +00:00
try:
host_spec = argv.index("--debug")
debug = True
except ValueError:
pass
cherrypy.config.update({
"server.socket_port": int(port),
"server.socket_host": host
})
2017-04-13 07:08:19 +00:00
run()