source: ccsd/private/modules/ccs_rurallink_billing.py @ 1253

# Copyright (C) 2006  Rural Link Ltd.
#
# This file is an extension to crcnetd - CRCnet Configuration System Daemon
#
# RuralLink Billing Module - Provides logic for manipulating customer accounts
#                            according to the Rural Link business rules.
#
# Author:       Matt Brown <matt@crc.net.nz>
#               Ivan Meredith <ivan@ivan.net.nz>
# Version:      $Id$
#
# No usage or redistribution rights are granted for this file unless
# otherwise confirmed in writing by the copyright holder.
from crcnetd._utils.ccsd_common import *
from crcnetd._utils.ccsd_log import *
from crcnetd._utils.ccsd_events import *
from crcnetd._utils.ccsd_session import getSession, getSessionE
from crcnetd._utils.ccsd_server import exportViaXMLRPC, registerResource, \
        registerRecurring, registerHalfHourly, registerDailyAt
from crcnetd._utils.ccsd_ca import ccs_ca, getCertificateParameters, \
        CERT_PARAM_NAMES, REVOKE_SUPERSEDED
from datetime import *
ccs_mod_type = CCSD_SERVER

def updateRadius():
    """
    Should this function be here or just consolidate into checkUsage(), ill figure
    out later, for now this is fine.
    """
    session = getSession(ADMIN_SESSION_ID)

    sql = "SELECT FROM update_customer_state()"

    session.execute(sql, ())

def checkUsage():
    """
    Checks each customers usage, and if usage is greater than the cap,
    do the cap action
    """
    #Update the customer_states before checking data used.
    updateRadius()
    
    session = getSession(ADMIN_SESSION_ID)
    
    sql = "SELECT DISTINCT * FROM customer_state WHERE used_mb > cap_at_mb"

    res = session.query(sql, ())
    for state in res:
        doCapAction(state)

@registerHalfHourly()
def updateStatus():
    """
    This is the function that is run every 30 mins to update the state
    table with the data done for the last 30mins.
    """
    checkUsage()

def doRollover(type):
    """
    Performs the nightly rollover check.
    """
    
    session = getSession(ADMIN_SESSION_ID)
    
    sql = "SELECT * FROM rollover WHERE cap_period=%s"

    res = session.query(sql, (type))

    for ro in res:
        #Generate the billing records
        sql = "INSERT INTO billing_record(contact_id, record_date, " \
            "description, amount, quantity) VALUES (%s,CURRENT_TIMESTAMP, " \
            "%s, %s,1);"

        session.execute(sql, (ro["contact_id"],ro["plan_name"], ro["price"]))
        
        #Update the customer state.
        sql = "UPDATE customer_state SET plan_start=CURRENT_TIMESTAMP, "\
            "cap_at_mb=%s, used_mb=0, radius_plan=%s WHERE contact_id=%s"

        session.execute(sql, (ro["included_mb"], ro["contact_id"], \
            ro["radius_plan"]))

@registerDailyAt((00,30,00))
def updateNightly():
    """
    This function is called every night and does checks do see if caps need
    rolling over etc.
    """
    #If its the start of the month, its time to bill them for a new 
    #month
    if datetime.now().day == 1:
        doRollover("monthy")
    #Monday = 0 ... Sunday = 6
    if datetime.now().weekday() == 1:
        doRollover("weekly")
    
    
    #do all daily rollovers
    doRollover("daily")
    
    
def doCapAction(customer):
    """
    Supported actions at the moment are:
        Throttling.
        Top up.
    """
    session = getSession(ADMIN_SESSION_ID)

    sql = "SELECT cap_action, cap_param, cap_price FROM billing_plan" \
        " WHERE plan_id=%s"

    res = session.query(sql, (customer["plan_id"]))
    
    if res[0]["cap_action"] == "throttle":
        sql = "UPDATE customer_state SET radius_plan=%s WHERE contact_id=%s"
        session.execute(sql,(res[0]["cap_param"], customer["contact_id"]))
    elif res[0]["cap_action"] == "purchase":
        cap_at_mb = customer["cap_at_mb"]
        used_mb = customer["used_mb"]
        
        # If for some reason they manage to go over the cap + 1 unit of
        # cap_param we want to keep selling them data until the cap is 
        # higher than there current data. 
        while cap_at_mb < used_mb:
            sql = "UPDATE customer_state SET cap_at_mb=cap_at_mb+%s " \
                "WHERE contact_id=%s"
            session.execute(sql,(res[0]["cap_param"], customer["contact_id"]))
            
            sql = "INSERT INTO billing_record (contact_id, record_date, " \
                "description, amount, quantity) VALUES (%%s, CURRENT_TIMESTAMP, " \
                "'%sGB data pack', %%s, 1)" % (res[0]["cap_param"]/1024)
            session.execute(sql, (customer["contact_id"], res[0]["cap_price"]))
            cap_at_mb += res[0]["cap_param"]
    
def generateInvoice(contact_id):
    """
    Generates an invoice for all bills in the database that havent been
    assigned an invoice number.
    """

def emailInvoiceTo(contact_id, invoice_id):
    """
    Emails an invoice to a customer.
    """