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.cm.views.admin_cm.user
# @alldecoratedby{src.cm.utils.decorators.admin_cm_log} (except for \c add)
# 
# @author Tomek Sośnicki <tom.sosnicki@gmail.com>
# 
from cm.utils.exception import CMException
from cm.models.user import User
from cm.utils.decorators import admin_cm_log, user_log


@user_log(log=True)
##
# 
#     Adds specified CC1 User to current CM.
# 
#     @cmview_user
#     @note This method is decorated by user_log decorator, not by admin_cm_log.
#     This is caused by the fact that CLMAdmin doesn't need to be CMAdmin and
#     despite not having rights to call CMAdmin functions he needs to call it on
#     CMAdmin privileges.
# 
#     @param_post{user_id}
#     
def add(caller_id, user_id):

    User.create(user_id)


@admin_cm_log(log=True)
##
# 
#     Changes specified User's quota.
# 
#     @cmview_admin_cm
#     @param_post{user_id}
#     @param_post{memory}
#     @param_post{cpu,int}
#     @param_post{storage,int}
#     @param_post{public_ip,int}
#     @param_post{points,int}
#     
def change_quota(caller_id, user_id, memory=None, cpu=None, storage=None, public_ip=None, points=None):

    user = User.get(user_id)

    user.memory = memory or user.memory
    user.cpu = cpu or user.cpu
    user.storage = storage or user.storage
    user.public_ip = public_ip or user.public_ip
    user.points = points or user.points

    try:
        user.save()
    except:
        raise CMException('user_change_quota')


@admin_cm_log(log=True)
##
# 
#     Changes quota of multiple users.
# 
#     @cmview_admin_cm
#     @param_post{user_ids,list(int)}
#     @param_post{memory,int} new RAM memory limit [MB]
#     @param_post{cpu,int} new CPU's limit
#     @param_post{storage,int} new storage space's limit [MB]
#     @param_post{public_ip,int} new limit of public_ips
#     @param_post{points,int} new monthly points limit
#     
def multiple_change_quota(caller_id, user_ids, memory=None, cpu=None, storage=None, public_ip=None, points=None):

    for user_id in user_ids:
        user = User.get(user_id)
        user.memory = memory or user.memory
        user.cpu = cpu or user.cpu
        user.storage = storage or user.storage
        user.public_ip = public_ip or user.public_ip
        user.points = points or user.points
        try:
            user.save()
        except:
            raise CMException('user_change_quota')

@admin_cm_log(log=True)
##
# 
#     Get specified User's qouta.
# 
#     @cmview_admin_cm
#     @param_post{user_id,int}
# 
#     @response{dict} Full User's quota
#     
def get_quota(caller_id, user_id):
    return User.get(user_id).long_dict


@admin_cm_log(log=False)
##
# 
#     Returns all Users.
# 
#     @cmview_admin_cm
#     @param_post{short,bool} caller's CM admin password
#     @response{list(dict)} User.long_dict property for each User
#     
def get_list(caller_id, short=False):
    return [user.dict if short else user.long_dict for user in User.objects.all()]