src/billing/cisco_h323_db_schema-postgres.sql

   1 /*
   2  * --- Peter Nixon [ codemonkey@peternixon.net ]
   3  * This is a custom SQL schema for doing H323 VoIP accounting with FreeRadius and
   4  * Cisco gateways (I am using 5300 and 5350 series).
   5  * It will scale ALOT better than the default radius schema which is designed for
   6  * simple dialup installations of FreeRadius.
   7  *
   8  * For this schema to work properly you MUST replace raddb/postgresql.conf
   9  * with the contents of pgsql-voip.conf
  10  *
  11  * If you wish to do RADIUS Authentication using the same database, you must use
  12  * src/modules/rlm_sql/drivers/rlm_sql_postgresql/db_postgresql.sql as well as
  13  * this schema.
  14  *
  15  */
  16
  17 /*
  18  * Table structure for 'Start' tables
  19  */
  20
  21 CREATE TABLE StartVoIP (
  22   RadAcctId BIGSERIAL PRIMARY KEY,
  23   UserName VARCHAR(64) DEFAULT '' NOT NULL,
  24   Realm VARCHAR(64) DEFAULT '',
  25   NASIPAddress INET NOT NULL,
  26   AcctStartTime timestamp DEFAULT now() NOT NULL,
  27   CalledStationId VARCHAR(30) DEFAULT '' NOT NULL,
  28   CallingStationId VARCHAR(15) DEFAULT '' NOT NULL,
  29   AcctDelayTime NUMERIC(3),
  30   H323GWID VARCHAR(32) DEFAULT '' NOT NULL,
  31   h323CallOrigin VARCHAR(10) DEFAULT '' NOT NULL,
  32   h323CallType VARCHAR(64) DEFAULT '' NOT NULL,
  33   h323SetupTime timestamp with time zone DEFAULT now() NOT NULL,
  34   h323ConfID VARCHAR(35) DEFAULT '' NOT NULL
  35 );
  36 create index startvoipcombo on startvoip (h323SetupTime, nasipaddress);
  37
  38
  39 CREATE TABLE StartTelephony (
  40   RadAcctId BIGSERIAL PRIMARY KEY,
  41   UserName VARCHAR(64) DEFAULT '' NOT NULL,
  42   Realm VARCHAR(64) DEFAULT '',
  43   NASIPAddress INET NOT NULL,
  44   AcctStartTime timestamp DEFAULT now() NOT NULL,
  45   CalledStationId VARCHAR(30) DEFAULT '' NOT NULL,
  46   CallingStationId VARCHAR(15) DEFAULT '' NOT NULL,
  47   AcctDelayTime NUMERIC(3),
  48   H323GWID VARCHAR(32) DEFAULT '' NOT NULL,
  49   h323CallOrigin VARCHAR(10) DEFAULT '' NOT NULL,
  50   h323CallType VARCHAR(64) DEFAULT '' NOT NULL,
  51   h323SetupTime timestamp with time zone DEFAULT now() NOT NULL,
  52   h323ConfID VARCHAR(35) DEFAULT '' NOT NULL
  53 );
  54 create index starttelephonycombo on starttelephony (h323SetupTime, nasipaddress);
  55
  56
  57
  58 /*
  59  * Table structure for 'Stop' tables
  60  */
  61 CREATE TABLE StopVoIP (
  62   RadAcctId BIGSERIAL PRIMARY KEY,
  63   UserName VARCHAR(32) DEFAULT '' NOT NULL,
  64   NASIPAddress INET NOT NULL,
  65   AcctSessionTime BIGINT,
  66   AcctInputOctets BIGINT,
  67   AcctOutputOctets BIGINT,
  68   CalledStationId VARCHAR(50) DEFAULT '' NOT NULL,
  69   CallingStationId VARCHAR(50) DEFAULT '' NOT NULL,
  70   AcctDelayTime SMALLINT,
  71   CiscoNASPort BOOLEAN DEFAULT false,
  72   h323CallOrigin varchar(10) DEFAULT '' NOT NULL,
  73   h323SetupTime timestamp with time zone NOT NULL,
  74   h323ConnectTime timestamp with time zone NOT NULL,
  75   h323DisconnectTime timestamp with time zone NOT NULL,
  76   h323DisconnectCause varchar(2) DEFAULT '' NOT NULL,
  77   H323RemoteAddress INET NOT NULL,
  78   H323VoiceQuality NUMERIC(2),
  79   h323ConfID VARCHAR(35) DEFAULT '' NOT NULL
  80 );
  81 create UNIQUE index stopvoipcombo on stopvoip (h323SetupTime, nasipaddress, h323ConfID);
  82
  83
  84 CREATE TABLE StopTelephony (
  85   RadAcctId BIGSERIAL PRIMARY KEY,
  86   UserName VARCHAR(32) DEFAULT '' NOT NULL,
  87   NASIPAddress INET NOT NULL,
  88   AcctSessionTime BIGINT,
  89   AcctInputOctets BIGINT,
  90   AcctOutputOctets BIGINT,
  91   CalledStationId VARCHAR(50) DEFAULT '' NOT NULL,
  92   CallingStationId VARCHAR(50) DEFAULT '' NOT NULL,
  93   AcctDelayTime SMALLINT,
  94   CiscoNASPort varchar(16) DEFAULT '' NOT NULL,
  95   h323CallOrigin varchar(10) DEFAULT '' NOT NULL,
  96   h323SetupTime timestamp with time zone NOT NULL,
  97   h323ConnectTime timestamp with time zone NOT NULL,
  98   h323DisconnectTime timestamp with time zone NOT NULL,
  99   h323DisconnectCause varchar(2) DEFAULT '' NOT NULL,
 100   H323RemoteAddress BOOLEAN DEFAULT false,
 101   H323VoiceQuality NUMERIC(2),
 102   h323ConfID VARCHAR(35) DEFAULT '' NOT NULL
 103 );
 104 create UNIQUE index stoptelephonycombo on stoptelephony (h323SetupTime, nasipaddress, h323ConfID);
 105
 106 /*
 107  * Table structure for 'gateways'
 108  *
 109  * This table should list the IP addresses, names and locations of all your gateways
 110  * This can be used to make more useful reports.
 111  */
 112
 113 CREATE TABLE gateways (
 114     gw_ip inet NOT NULL,
 115     gw_name character varying(32) NOT NULL,
 116     gw_city character varying(32)
 117 );
 118
 119
 120 /*
 121  * Table structure for 'customers'
 122  *
 123  * This table should list your Customers names and company
 124  * This can be used to make more useful reports.
 125  */
 126
 127 CREATE TABLE customers (
 128     cust_id serial NOT NULL,
 129     company character varying(32),
 130     customer character varying(32)
 131 );
 132
 133 /*
 134  * Table structure for 'cust_gw'
 135  *
 136  * This table should list the IP addresses and Customer IDs of all your Customers gateways
 137  * This can be used to make more useful reports.
 138  */
 139
 140 CREATE TABLE cust_gw (
 141     cust_gw inet NOT NULL,
 142     cust_id integer NOT NULL,
 143     "location" character varying(32)
 144 );
 145
 146
 147 CREATE VIEW customerip AS
 148     SELECT gw.cust_gw AS ipaddr, cust.company, cust.customer, gw."location" FROM customers cust, cust_gw gw WHERE (cust.cust_id = gw.cust_id);
 149
 150
 151
 152 /*
 153  * Function 'strip_dot'
 154  * removes "." from the start of cisco timestamps (NASes that have lost ntp timesync temporarily)
 155  *  * Example useage:
 156  *      insert into mytable values (strip_dot('.16:46:02.356 EET Wed Dec 11 2002'));
 157  *
 158  */
 159
 160 CREATE OR REPLACE FUNCTION strip_dot (VARCHAR) RETURNS TIMESTAMPTZ AS '
 161  DECLARE
 162      original_timestamp ALIAS FOR $1;
 163  BEGIN
 164         IF substring(original_timestamp from 1 for 1) = ''.'' THEN
 165           RETURN substring(original_timestamp from 2);
 166         ELSE
 167           RETURN original_timestamp;
 168         END IF;
 169  END;
 170 ' LANGUAGE 'plpgsql';
 171
 172
 173 /*
 174  * Table structure for 'isdn_error_codes' table
 175  *
 176  * Taken from cisco.com this data can be JOINED against h323DisconnectCause to
 177  * give human readable error reports.
 178  *
 179  */
 180
 181
 182 CREATE TABLE isdn_error_codes (
 183     error_code character varying(2) PRIMARY KEY,
 184     desc_short character varying(90),
 185     desc_long text
 186 );
 187
 188 /*
 189  * Data for 'isdn_error_codes' table
 190  */
 191
 192 INSERT INTO isdn_error_codes VALUES ('1', 'Unallocated (unassigned) number', 'The ISDN number was sent to the switch in the correct format; however, the number is not assigned to any destination equipment.');
 193 INSERT INTO isdn_error_codes VALUES ('10', 'Normal call clearing', 'Normal call clearing has occurred.');
 194 INSERT INTO isdn_error_codes VALUES ('11', 'User busy', 'The called system acknowledges the connection request but is unable to accept the call because all B channels are in use.');
 195 INSERT INTO isdn_error_codes VALUES ('12', 'No user responding', 'The connection cannot be completed because the destination does not respond to the call.');
 196 INSERT INTO isdn_error_codes VALUES ('13', 'No answer from user (user alerted)', 'The destination responds to the connection request but fails to complete the connection within the prescribed time. The problem is at the remote end of the connection.');
 197 INSERT INTO isdn_error_codes VALUES ('15', 'Call rejected', 'The destination is capable of accepting the call but rejected the call for an unknown reason.');
 198 INSERT INTO isdn_error_codes VALUES ('16', 'Number changed', 'The ISDN number used to set up the call is not assigned to any system.');
 199 INSERT INTO isdn_error_codes VALUES ('1A', 'Non-selected user clearing', 'The destination is capable of accepting the call but rejected the call because it was not assigned to the user.');
 200 INSERT INTO isdn_error_codes VALUES ('1B', 'Designation out of order', 'The destination cannot be reached because the interface is not functioning correctly, and a signaling message cannot be delivered. This might be a temporary condition, but it could last for an extended period of time. For example, the remote equipment might be turned off.');
 201 INSERT INTO isdn_error_codes VALUES ('1C', 'Invalid number format', 'The connection could be established because the destination address was presented in an unrecognizable format or because the destination address was incomplete.');
 202 INSERT INTO isdn_error_codes VALUES ('1D', 'Facility rejected', 'The facility requested by the user cannot be provided by the network.');
 203 INSERT INTO isdn_error_codes VALUES ('1E', 'Response to STATUS ENQUIRY', 'The status message was generated in direct response to the prior receipt of a status enquiry message.');
 204 INSERT INTO isdn_error_codes VALUES ('1F', 'Normal, unspecified', 'Reports the occurrence of a normal event when no standard cause applies. No action required.');
 205 INSERT INTO isdn_error_codes VALUES ('2', 'No route to specified transit network', 'The ISDN exchange is asked to route the call through an unrecognized intermediate network.');
 206 INSERT INTO isdn_error_codes VALUES ('22', 'No circuit/channel available', 'The connection cannot be established because no appropriate channel is available to take the call.');
 207 INSERT INTO isdn_error_codes VALUES ('26', 'Network out of order', 'The destination cannot be reached because the network is not functioning correctly, and the condition might last for an extended period of time. An immediate reconnect attempt will probably be unsuccessful.');
 208 INSERT INTO isdn_error_codes VALUES ('29', 'Temporary failure', 'An error occurred because the network is not functioning correctly. The problem will be resolved shortly.');
 209 INSERT INTO isdn_error_codes VALUES ('2A', 'Switching equipment congestion', 'The destination cannot be reached because the network switching equipment is temporarily overloaded.');
 210 INSERT INTO isdn_error_codes VALUES ('2B', 'Access information discarded', 'The network cannot provide the requested access information.');
 211 INSERT INTO isdn_error_codes VALUES ('2C', 'Requested circuit/channel not available', 'The remote equipment cannot provide the requested channel for an unknown reason. This might be a temporary problem.');
 212 INSERT INTO isdn_error_codes VALUES ('2F', 'Resources unavailable, unspecified', 'The requested channel or service is unavailable for an unknown reason. This might be a temporary problem.');
 213 INSERT INTO isdn_error_codes VALUES ('3', 'No route to destination', 'The call was routed through an intermediate network that does not serve the destination address.');
 214 INSERT INTO isdn_error_codes VALUES ('31', 'Quality of service unavailable', 'The requested quality of service cannot be provided by the network. This might be a subscription problem.');
 215 INSERT INTO isdn_error_codes VALUES ('32', 'Requested facility not subscribed', 'The remote equipment supports the requested supplementary service by subscription only.');
 216 INSERT INTO isdn_error_codes VALUES ('39', 'Bearer capability not authorized', 'The user requested a bearer capability that the network provides, but the user is not authorized to use it. This might be a subscription problem.');
 217 INSERT INTO isdn_error_codes VALUES ('3A', 'Bearer capability not presently available', 'The network normally provides the requested bearer capability, but it is unavailable at the present time. This might be due to a temporary network problem or to a subscription problem.');
 218 INSERT INTO isdn_error_codes VALUES ('3F', 'Service or option not available, unspecified', 'The network or remote equipment was unable to provide the requested service option for an unspecified reason. This might be a subscription problem.');
 219 INSERT INTO isdn_error_codes VALUES ('41', 'Bearer capability not implemented', 'The network cannot provide the bearer capability requested by the user.');
 220 INSERT INTO isdn_error_codes VALUES ('42', 'Channel type not implemented', 'The network or the destination equipment does not support the requested channel type.');
 221 INSERT INTO isdn_error_codes VALUES ('45', 'Requested facility not implemented', 'The remote equipment does not support the requested supplementary service.');
 222 INSERT INTO isdn_error_codes VALUES ('46', 'Only restricted digital information bearer capability is available', 'The network is unable to provide unrestricted digital information bearer capability.');
 223 INSERT INTO isdn_error_codes VALUES ('4F', 'Service or option not implemented, unspecified', 'The network or remote equipment is unable to provide the requested service option for an unspecified reason. This might be a subscription problem.');
 224 INSERT INTO isdn_error_codes VALUES ('51', 'Invalid call reference value', 'The remote equipment received a call with a call reference that is not currently in use on the user-network interface.');
 225 INSERT INTO isdn_error_codes VALUES ('52', 'Identified channel does not exist', 'The receiving equipment is requested to use a channel that is not activated on the interface for calls.');
 226 INSERT INTO isdn_error_codes VALUES ('53', 'A suspended call exists, but this call identity does not', 'The network received a call resume request. The call resume request contained a Call Identify information element that indicates that the call identity is being used for a suspended call.');
 227 INSERT INTO isdn_error_codes VALUES ('54', 'Call identity in use', 'The network received a call resume request. The call resume request contained a Call Identify information element that indicates that it is in use for a suspended call.');
 228 INSERT INTO isdn_error_codes VALUES ('55', 'No call suspended', 'The network received a call resume request when there was not a suspended call pending. This might be a transient error that will be resolved by successive call retries.');
 229 INSERT INTO isdn_error_codes VALUES ('56', 'Call having the requested call identity has been cleared', 'The network received a call resume request. The call resume request contained a Call Identity information element, which once indicated a suspended call. However, the suspended call was cleared either by timeout or by the remote user.');
 230 INSERT INTO isdn_error_codes VALUES ('58', 'Incompatible destination', 'Indicates that an attempt was made to connect to non-ISDN equipment. For example, to an analog line.');
 231 INSERT INTO isdn_error_codes VALUES ('5B', 'Invalid transit network selection', 'The ISDN exchange was asked to route the call through an unrecognized intermediate network.');
 232 INSERT INTO isdn_error_codes VALUES ('5F', 'Invalid message, unspecified', 'An invalid message was received, and no standard cause applies. This is usually due to a D-channel error. If this error occurs systematically, report it to your ISDN service provider.');
 233 INSERT INTO isdn_error_codes VALUES ('6', 'Channel unacceptable', 'The service quality of the specified channel is insufficient to accept the connection.');
 234 INSERT INTO isdn_error_codes VALUES ('60', 'Mandatory information element is missing', 'The receiving equipment received a message that did not include one of the mandatory information elements. This is usually due to a D-channel error. If this error occurs systematically, report it to your ISDN service provider.');
 235 INSERT INTO isdn_error_codes VALUES ('61', 'Message type non-existent or not implemented', 'The receiving equipment received an unrecognized message, either because the message type was invalid or because the message type was valid but not supported. The cause is due to either a problem with the remote configuration or a problem with the local D channel.');
 236 INSERT INTO isdn_error_codes VALUES ('62', 'Message not compatible with call state or message type non-existent or not implemented', 'The remote equipment received an invalid message, and no standard cause applies. This cause is due to a D-channel error. If this error occurs systematically, report it to your ISDN service provider.');
 237 INSERT INTO isdn_error_codes VALUES ('63', 'Information element non-existent or not implemented', 'The remote equipment received a message that includes information elements, which were not recognized. This is usually due to a D-channel error. If this error occurs systematically, report it to your ISDN service provider.');
 238 INSERT INTO isdn_error_codes VALUES ('64', 'Invalid information element contents', 'The remote equipment received a message that includes invalid information in the information element. This is usually due to a D-channel error.');
 239 INSERT INTO isdn_error_codes VALUES ('65', 'Message not compatible with call state', 'The remote equipment received an unexpected message that does not correspond to the current state of the connection. This is usually due to a D-channel error.');
 240 INSERT INTO isdn_error_codes VALUES ('66', 'Recovery on timer expires', 'An error-handling (recovery) procedure was initiated by a timer expiry. This is usually a temporary problem.');
 241 INSERT INTO isdn_error_codes VALUES ('6F', 'Protocol error, unspecified', 'An unspecified D-channel error when no other standard cause applies.');
 242 INSERT INTO isdn_error_codes VALUES ('7', 'Call awarded and being delivered in an established channel', 'The user is assigned an incoming call that is being connected to an already-established call channel.');
 243 INSERT INTO isdn_error_codes VALUES ('7F', 'Internetworking, unspecified', 'An event occurred, but the network does not provide causes for the action that it takes. The precise problem is unknown.');
 244