user.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
# @COPYRIGHT_begin
#
# Copyright [2010-2014] Institute of Nuclear Physics PAN, Krakow, Poland
#
# Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#
# @COPYRIGHT_end

##
# @package src.clm.views.user.user
# @alldecoratedby{src.clm.utils.decorators.user_log}
# 

from django.conf import settings

from clm.models.cluster import Cluster
from clm.models.user import User
from clm.utils import mail
from clm.utils.decorators import user_log, cm_request
from clm.utils.exception import CLMException
from common.states import cluster_states


@user_log(log=True)
##
# 
#     Returns user's data.
# 
#     @clmview_user
#     
def get_my_data(cm_id, caller_id):
    user = User.get(caller_id)
    user = user.dict
    endpoints = []
    for cm_name in [c.short_dict['name'] for c in Cluster.objects.filter(state=cluster_states['ok'])]:
        endpoints.append(cm_name + "." + settings.EC2_URL)
    user["ec2_endpoints"] = endpoints
    return user


@user_log(log=True)
##
# 
#     Sets user's password.
# 
#     @clmview_user
#     @param_post{new_password,string}
#     
def set_password(cm_id, caller_id, new_password):
    user = User.get(caller_id)
    user.password = new_password
    try:
        user.save()
    except:
        raise CLMException('user_set_password')

    return user.dict


@user_log(log=True)
##
# 
#     Function for editing user's data.
# 
#     @clmview_user
#     @param_post{email,string}
#     @param_post{default_cluster_id}
# 
#     @response{dict} new user's info
#     
def edit(cm_id, caller_id, email, default_cluster_id):

    user = User.get(caller_id)
    user.email = email
    user.default_cluster_id = default_cluster_id
    try:
        user.save()
    except:
        raise CLMException('user_edit')

    return user.dict


@user_log(log=True, pack=False)
@cm_request
##
# 
#     @clmview_user
#     @cm_request_transparent{user.user.get_quota()}
#     
def get_quota(cm_response, **data):
    return cm_response


@user_log(log=True, pack=False)
@cm_request
##
# 
#     @clmview_user
#     @cm_request_transparent{user.user.point_history()}
#     
def points_history(cm_response, **data):
    return cm_response


@user_log(log=True)
##
# 
#     Send issue email
# 
#     @clmview_user
#     @param_post{topic,string} topic of the issue email
#     @param_post{issue,string} content of the issue email
#     
def send_issue(cm_id, caller_id, topic, issue):
    try:
        mail.send(settings.ISSUE_EMAIL, issue, topic)
    except Exception:
        raise CLMException('send_issue_error')


# @todo: monia not defined in CM
# @user_log(log=True, pack=False)
# def stat_test(cm_id, caller_id, vm_name, stats, start_time, stop_time, resolution):
# """
#    @param_post{vm_name,string}
#    @param_post{stats}
#    @param_post{start_time}
#    @param_post{stop_time}
#    @param_post{resolution}
#    @returns @asreturned{src.cm.views.user.user.stat_test()}
# """