public_ip.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.network
# @author Maciej Nabożny <mn@mnabozny.pl>
# 
# Functions to manage public leases in database for CM Administrator
# 

from netaddr.ip import IPAddress
from cm.models.public_ip import PublicIP
from cm.utils import log
from cm.utils.exception import CMException
from cm.utils.decorators import admin_cm_log
from cm.models.lease import Lease


@admin_cm_log(log=True)
##
# 
#     @cmview_admin_cm
#     @response{list(dict)} PublicIP.dict property for each PublicIP lease
#     
def get_list(caller_id):
    leases = PublicIP.objects.all()
    return [lease.dict for lease in leases]


@admin_cm_log(log=True)
##
# 
#     Adds addresses pool to available addresses pool. Added pool starts from
#     @prm{start_address} and @prm{count} is its size.
# 
#     @cmview_admin_cm
#     @param_post{start_address,string} first address in pool
#     @param_post{count,int} count of public addresses to add
#     
def add(caller_id, start_address, count):
    pool = IPAddress(start_address)
    for i in xrange(count):
        if PublicIP.objects.filter(address=str(pool + i)).exists() > 0:
            log.debug(caller_id, 'Ip %s is a duplicate! Skipping' % str(pool + i))
        elif not IPAddress(pool + 1).is_unicast():
            log.debug(caller_id, 'Ip %s is not an unicast address! Skipping' % str(pool + i))
        else:
            log.debug(caller_id, 'Adding public ip %s' % str(pool + i))
            public_lease = PublicIP()
            public_lease.address = str(pool + i)
            public_lease.save()


@admin_cm_log(log=True)
##
# 
#     Removes specified addresses from available pool. Address may only be
#     removed if not in use.
# 
#     @cmview_admin_cm
#     @param_post{public_ip_id_list,list(string)} addresses to remove from
#     available pool
#     
def delete(caller_id, public_ip_id_list):
    for ip_address in public_ip_id_list:
        lease = PublicIP.objects.get(id=ip_address)
        if lease.lease != None:
            raise CMException('lease_in_use')

    for ip_address in public_ip_id_list:
        lease = PublicIP.objects.get(id=ip_address)
        lease.delete()


@admin_cm_log(log=True)
##
# 
#     Detaches specified PublicIP from owners VM. Unlinks PublicLease instance
#     from its Lease instance.
# 
#     @cmview_admin_cm
#     @param_post{lease_id,int} id of the VM's lease from which IP should be detached.
# 
#     @raises{lease_not_found,CMException}
#     @raises{public_lease_unassign,CMException}
#     
def unassign(caller_id, lease_id):

    try:
        lease = Lease.objects.get(id=lease_id)
    except Exception, e:
        log.exception(caller_id, str(e))
        raise CMException("lease_not_found")

    if lease.vm == None:
        raise CMException('lease_not_assigned')

    try:
        public_ip = lease.publicip_set.all()[0]
    except:
        raise CMException('public_lease_assigned')

    public_ip.unassign()
    public_ip.save()


@admin_cm_log(log=True)
##
# 
#     Removes PublicIP addresses from their owners pool. Released addresses are
#     back available in public pool.
# 
#     @cmview_admin_cm
#     @param_post{public_ip_id_list,list(int)} list of the specified ids
#     
def release(caller_id, public_ip_id_list):
    for public_ip_id in public_ip_id_list:
        public_lease = PublicIP.objects.get(id=public_ip_id)

        if public_lease.lease:
            public_lease.unassign()

        public_lease.user = None
        public_lease.save()


@admin_cm_log(log=True)
##
# 
#     Deataches PublicIP address from the virtual machine
#     @cmview_admin_cm
#     @parameter{public_ip_id,int} id of the PublicIP address
#     
def revoke(caller_id, public_ip_id):
    public_lease = PublicIP.objects.get(id=public_ip_id)
    public_lease.unassign()
    public_lease.save()