~azzar1/unity/add-show-desktop-key

# IVLE
# Copyright (C) 2007-2008 The University of Melbourne
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# App: userservice
# Author: Matt Giuca
# Date: 14/2/2008

# Provides an Ajax service for handling user management requests.
# This includes when a user logs in for the first time.

# NOTE: This app does NOT require authentication. This is because otherwise it
# would be blocked from receiving requests to activate when the user is trying
# to accept the TOS.

# It must do its own authentication and authorization.

### Actions ###

# The one-and-only path segment to userservice determines the action being
# undertaken.
# All actions require that you are logged in.
# All actions require method = POST, unless otherwise stated.

# userservice/activate_me
# Required cap: None
# declaration = "I accept the IVLE Terms of Service"
# Activate the currently-logged-in user's account. Requires that "declaration"
# is as above, and that the user's state is "no_agreement".

# userservice/create_user
# Required cap: CAP_CREATEUSER
# Arguments are the same as the database columns for the "login" table.
# Required:
#   login, fullname, rolenm
# Optional:
#   password, nick, email, studentid

# TODO
# userservice/get_user
# method: May be GET
# Required cap: None to see yourself.
#   CAP_GETUSER to see another user.
# Gets the login details of a user. Returns as a JSON object.
# login = Optional login name of user to get. If omitted, get yourself.

# userservice/update_user
# Required cap: None to update yourself.
#   CAP_UPDATEUSER to update another user (and also more fields).
#   (This is all-powerful so should be only for admins)
# login = Optional login name of user to update. If omitted, update yourself.
# Other fields are optional, and will set the given field of the user.
# Without CAP_UPDATEUSER, you may change the following fields of yourself:
#   password, nick, email
# With CAP_UPDATEUSER, you may also change the following fields of any user:
#   password, nick, email, login, rolenm, unixid, fullname, studentid
# (You can't change "state", but see userservice/[en|dis]able_user).

# TODO
# userservice/enable_user
# Required cap: CAP_UPDATEUSER
# Enable a user whose account has been disabled. Does not work for
# no_agreement or pending users.
# login = Login name of user to enable.

# TODO
# userservice/disable_user
# Required cap: CAP_UPDATEUSER
# Disable a user's account. Does not work for no_agreement or pending users.
# login = Login name of user to disable.

import os
import sys

import cjson

import common
from common import (util, chat, caps)
import conf

from conf import (usrmgt_host, usrmgt_port, usrmgt_magic)

# The user must send this declaration message to ensure they acknowledge the
# TOS
USER_DECLARATION = "I accept the IVLE Terms of Service"

def handle(req):
    """Handler for the Console Service AJAX backend application."""
    if req.username is None:
        # Not logged in
        req.throw_error(req.HTTP_FORBIDDEN)
    if len(req.path) > 0 and req.path[-1] == os.sep:
        path = req.path[:-1]
    else:
        path = req.path
    # The path determines which "command" we are receiving
    fields = req.get_fieldstorage()
    if req.path == "activate_me":
        handle_activate_me(req, fields)
    else:
        req.throw_error(req.HTTP_BAD_REQUEST)

def handle_activate_me(req, fields):
    """Create the jail, svn, etc, for the currently logged in user (this is
    put in the queue for usermgt to do).
    This will block until usermgt returns, which could take seconds to minutes
    in the extreme. Therefore, it is designed to be called by Ajax, with a
    nice "Please wait" message on the frontend.

    This will signal that the user has accepted the terms of the license
    agreement, and will result in the user's database status being set to
    "enabled". (Note that it will be set to "pending" for the duration of the
    handling).

    As such, it takes a single POST field, "declaration", which
    must have the value, "I accept the IVLE Terms of Service".
    (Otherwise users could navigate to /userservice/createme without
    "accepting" the terms - at least this way requires them to acknowledge
    their acceptance). It must only be called through a POST request.
    """
    if req.method != "POST":
        req.throw_error(req.HTTP_BAD_REQUEST)
    try:
        declaration = fields.getfirst('declaration')
    except AttributeError:
        req.throw_error(req.HTTP_BAD_REQUEST)
    if declaration != USER_DECLARATION:
        req.throw_error(req.HTTP_BAD_REQUEST)

    session = req.get_session()
    # Check that the user's status is "no_agreement".
    # (Both to avoid redundant calls, and to stop disabled users from
    # re-enabling their accounts).
    if session['state'] != "no_agreement":
        req.throw_error(req.HTTP_BAD_REQUEST)

    # Get the arguments for usermgt.activate_user from the session
    # (The user must have already logged in to use this app)
    args = {
        "login": req.username,
    }
    msg = {'activate_user': args}

    response = chat.chat(usrmgt_host, usrmgt_port, msg, usrmgt_magic,
        decode = False)
    # TODO: Figure out a way to let the user be "enabled" in this session.
    # (Would require a write to the session?)
    req.content_type = "text/plain"
    req.write(response)

create_user_fields_required = [
    'login', 'fullname', 'rolenm'
]
create_user_fields_optional = [
    'password', 'nick', 'email', 'studentid'
]
def handle_create_user(req, fields):
    """Create a new user, whose state is no_agreement.
    This does not create the user's jail, just an entry in the database which
    allows the user to accept an agreement.
    """
    session = req.get_session()
    if req.method != "POST":
        req.throw_error(req.HTTP_BAD_REQUEST)
    # Check if this user has CAP_CREATEUSER
    if not session['role'].hasCap(caps.CAP_UPDATEUSER):
        req.throw_error(req.HTTP_FORBIDDEN)

    # Make a dict of fields to create
    create = {}
    for f in create_user_fields_required:
        try:
            create[f] = fields.getfirst(f)
        except AttributeError:
            req.throw_error(req.HTTP_BAD_REQUEST)
    for f in create_user_fields_optional:
        try:
            create[f] = fields.getfirst(f)
        except AttributeError:
            pass

    # Get the arguments for usermgt.create_user from the session
    # (The user must have already logged in to use this app)
    msg = {'create_user': create}
    # TEMP
    req.write(msg)
    return
    # END TEMP

    response = chat.chat(usrmgt_host, usrmgt_port, msg, usrmgt_magic,
        decode = False)
    req.content_type = "text/plain"
    req.write(response)

update_user_fields_anyone = [
    'password', 'nick', 'email'
]
update_user_fields_admin = [
    'password', 'nick', 'email', 'login', 'rolenm', 'unixid', 'fullname',
    'studentid'
]
def handle_update_user(req, fields):
    """Update a user's account details.
    This can be done in a limited form by any user, on their own account,
    or with full powers by a user with CAP_UPDATEUSER on any account.
    """
    session = req.get_session()
    if req.method != "POST":
        req.throw_error(req.HTTP_BAD_REQUEST)

    # Only give full powers if this user has CAP_UPDATEUSER
    fullpowers = session['role'].hasCap(caps.CAP_UPDATEUSER)
    # List of fields that may be changed
    fieldlist = (update_user_fields_admin if fullpowers
        else update_user_fields_anyone)

    try:
        login = fields.getfirst('login')
        if not fullpowers and login != req.username:
            # Not allowed to edit other users
            req.throw_error(req.HTTP_FORBIDDEN)
    except AttributeError:
        # If login not specified, update yourself
        login = req.username

    # Make a dict of fields to update
    update = {}
    for f in fieldlist:
        try:
            update[f] = fields.getfirst(f)
        except AttributeError:
            pass

    # Get the arguments for usermgt.create_user from the session
    # (The user must have already logged in to use this app)
    args = {
        "login": req.username,
        "update": update,
    }
    msg = {'update_user': args}
    # TEMP
    req.write(msg)
    return
    # END TEMP

    response = chat.chat(usrmgt_host, usrmgt_port, msg, usrmgt_magic,
        decode = False)
    req.content_type = "text/plain"
    req.write(response)