com.naryx.tagfusion.expression.function.ext.ip.ipGetCount.java Source code

Introduction

Here is the source code for com.naryx.tagfusion.expression.function.ext.ip.ipGetCount.java

Source

/* 
 *  Copyright (C) 2000 - 2010 TagServlet Ltd
 *
 *  This file is part of Open BlueDragon (OpenBD) CFML Server Engine.
 *  
 *  OpenBD is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  Free Software Foundation,version 3.
 *  
 *  OpenBD 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 OpenBD.  If not, see http://www.gnu.org/licenses/
 *  
 *  Additional permission under GNU GPL version 3 section 7
 *  
 *  If you modify this Program, or any covered work, by linking or combining 
 *  it with any of the JARS listed in the README.txt (or a modified version of 
 *  (that library), containing parts covered by the terms of that JAR, the 
 *  licensors of this Program grant you additional permission to convey the 
 *  resulting work. 
 *  README.txt @ http://www.openbluedragon.org/license/README.txt
 *  
 *  http://www.openbluedragon.org/
 */

package com.naryx.tagfusion.expression.function.ext.ip;

import org.apache.commons.net.util.SubnetUtils;
import org.apache.commons.net.util.SubnetUtils.SubnetInfo;

import com.naryx.tagfusion.cfm.engine.cfArgStructData;
import com.naryx.tagfusion.cfm.engine.cfData;
import com.naryx.tagfusion.cfm.engine.cfNumberData;
import com.naryx.tagfusion.cfm.engine.cfSession;
import com.naryx.tagfusion.cfm.engine.cfmRunTimeException;
import com.naryx.tagfusion.expression.function.functionBase;

/*
 * Checks to see if a DataSource is valid
 */

public class ipGetCount extends functionBase {
    private static final long serialVersionUID = 1L;

    public ipGetCount() {
        min = 1;
        max = 2;
        setNamedParams(new String[] { "ip", "mask" });
    }

    public String[] getParamInfo() {
        return new String[] {
                "ip - the IP address.  If in a simple notation (10.0.0.1) then netmask must be present, otherwise CIDR notation (10.0.0.1/24)",
                "mask - if the IP address is not in CIDR notation, this is the netmask (for example 255.255.255.0)" };
    }

    public java.util.Map getInfo() {
        return makeInfo("network", "Returns the number of IP addresses represented in this range",
                ReturnType.NUMERIC);
    }

    public cfData execute(cfSession _session, cfArgStructData argStruct) throws cfmRunTimeException {
        SubnetInfo info = getInfo(_session, argStruct);
        return new cfNumberData(info.getAddressCount());
    }

    /**
     * Gets the SubnetInfo block from the input parameters
     * @param _session
     * @param argStruct
     * @return
     * @throws cfmRunTimeException
     */
    protected SubnetInfo getInfo(cfSession _session, cfArgStructData argStruct) throws cfmRunTimeException {
        String ipaddress = getNamedStringParam(argStruct, "ip", null);
        if (ipaddress == null)
            throwException(_session, "Missing ip paramter");

        if (ipaddress.lastIndexOf("/") == -1) {
            String mask = getNamedStringParam(argStruct, "mask", null);
            if (mask == null)
                throwException(_session, "Since IP address is not in CIDR notation, please provide a mask");

            return new SubnetUtils(ipaddress, mask).getInfo();
        } else
            return new SubnetUtils(ipaddress).getInfo();
    }
}