---

tables.h

Go to the documentation of this file.

/*! \file tables.h
          Header that difines all the tables structure.
 */

#ifdef __cplusplus
extern "C" {
#endif

#ifndef TABLES_HEADER
#define TABLES_HEADER


/*! \brief Maximum number of characters for a radius login.
 */

#define LOGIN_RADIUS_SIZE 51

/*! \brief Maximum number of characters for a MyDns login = radius2mydns(login).
           You MUST set MYDNS_LOGIN_SIZE > 2*LOGIN_RADIUS_SIZE
 */

#define MYDNS_LOGIN_SIZE  128

/*! \brief Maximum number of characters for an IP address (XXX.XXX.XXX.XXX).
 */ 

#define IP_ADDRESS_STR_SIZE 16

/*! \brief Maximum number of characters for the optionnal profile ID.
 */

#define OPTIONNAL_PROFILE_SIZE 256

/*! \brief Maximum number of characters for the radius 'ACCT' identifier.
 */

#define ACCT_IDENTIFIER_SIZE 36

/*! \brief Maximum number of characters for a label. 
 */

#define LABEL_SIZE 256

/*! \brief Maximum number of characters for a comment.
 */

#define COMMENT_SIZE 256

/*! \brief Maximum number of characters for a CIDR (XXX.XXX.XXX.XXX/N).
 */

#define CIDR_SIZE 256

/*! \brief Size, in bytes, for the option's type.
 */

#define OPTION_TYPE_SIZE 20

/*! \brief Size, in bytes, for the option's value.
 */

#define OPTION_VALUE_SIZE 256

/*! \brief Maximum number of options for a DHCP packet's profile.
 */

#define MAX_PROFILE_OPTIONS 256

/*! \brief Size of the buffer used to store the field 'MAC_ADDRESS' of the table 'LOGISTIC_RADIUS'.
 */

#define LOGISTIC_MAC_ADDRESS_SIZE 256

/*! \brief Size of the buffer used to store the field 'RADIUS_LOGIN' of the table 'LOGISTIC_RADIUS'.
 */

#define LOGISTIC_RADIUS_LOGIN_SIZE 256

/*! \brief Size of the buffer used to store the field 'LOGIN_MODEM' of the table 'LOGISTIC_RADIUS'.
 */

#define LOGISTIC_LOGIN_MODEM_SIZE 256

/*! \brief Size of the buffer used to store the field 'LOGIN_MODEM' of the table 'RADONLINE'.
 */ 

#define LOGIN_MODEM_SIZE 128

/*! \brief Number of bytes used to represent a node ID.
    \remark <ul>
                <li>Alcatel's DSLAMs need up to 20 bytes to represent the node ID.
                <li>Utstarcom's DSLAMs need up to 5 bytes (maximum value is "65535" - unsigned shot int).
            </ul>
    \warning If you modify the value of this constant, you must also modify the value of the constant
             NODE_BUFFER_SIZE (see file "packets_data.h"). 
 */

#define NODE_ID_SIZE     20


/*! \brief This data structure represents the table 'abonnes'.
 */

struct table_abonnes
{
    /*! \brief Auto incremented ID. */

    unsigned long int      abonnes_id;

    /*! \brief DSLAM's node ID. */

    char                   node_id[NODE_ID_SIZE];

    /*! \brief DSLAM's shelf number. */

    unsigned char          shelf;

    /*! \brief DSLAM's port number. */

    unsigned char          numero_port;

    /*! \brief DSLAM's slot number. */

    unsigned char          numero_slot;

    /*! \brief Client's radius login. */

    char                   login_radius[LOGIN_RADIUS_SIZE];

    /*! \brief First connection flag. */

    unsigned char          first_connection;

    /*! \brief This flag is used if the client should be assigned a specific list of DHCP options.
               <ul>
                   <li>If the field contains the value "STANDARD", it means that the client 
                       will receive the default list of DHCP option (depending in the VLAN tag and
                       the VALAN gateway).
                   <li>Otherwise, the value represents the pointer to the list of options that
                       will be sent to the client (field "profile_optionnel" of table "options").
               </ul>
     */

     char                  profile[OPTIONNAL_PROFILE_SIZE];

    /*! \brief Field 'nack_flag' of the table 'abonnes'. 
               This flag is used to tell the DHCP to send a NAK.
     */

     unsigned long int     nack_flag;
};

/*! \brief This data structure represents the table 'abonne_ip'.
 */

struct table_abonne_ip
{
    /*! \brief Auto incremented ID. */

    unsigned long int      abonne_ip_id;

    /*! \brief Joint key to table 'abonnes'. */

    unsigned long int      abonnes_id;

    /*! \brief Joint key to table 'vlan'. */

    unsigned long int      vlan_id;

    /*! \brief Fixed IP address for the user. */

    char                   ip[IP_ADDRESS_STR_SIZE];

    /*! \brief Gateway IP address. */

    char                   gateway[IP_ADDRESS_STR_SIZE];

    /*! \brief Subnet IP. */

    char                   subnet[IP_ADDRESS_STR_SIZE];
};

/*! \brief This structure represents the table 'vlan'.
 */

struct table_vlan
{
   /*! \brief Auto incremented ID. */

   unsigned long int      vlan_id;

   /*! \brief Optionnal profile. */

   char                   profile_optionnel[OPTIONNAL_PROFILE_SIZE];

   /*! \brief VLAN ID (from Option 82). */

   unsigned long int      vlan_tag;

   /*! \brief VLAN gateway. */

   char                   vlan_gateway[IP_ADDRESS_STR_SIZE];

   /*! \brief Radius 'ACCT' identifier. */

   char                   radius_identifiant[ACCT_IDENTIFIER_SIZE];

   /*! \brief Label. */

   char                   libelle[LABEL_SIZE];

   /*! \brief Comment. */

   char                   comment[COMMENT_SIZE];

   /*! \brief Timeout for a DHCP offer. */

   unsigned long int      offer_timeout;
};

/*! \brief This table represents the table 'options'.
 */

struct table_options
{
  /*! \brief "Auto incremented" ID. */

  unsigned long int      options_id;

  /*! \brief Profile's ID. */

  char                   profile_optionnel[OPTIONNAL_PROFILE_SIZE];

  /*! \brief Option's code. */

  unsigned char          option_code;

  /*! \brief Option's type. */

  char                   option_type[OPTION_TYPE_SIZE];

  /*! \brief Option's value. */

  char                   option_value[OPTION_VALUE_SIZE];

  /*! \brief Comment. */

  char                   comment[COMMENT_SIZE];
};


/*! \brief This table represents the table 'ip_lease'.
 */

struct table_ip_lease
{
  /*! \brief "Auto incremented" ID. */

  unsigned long int      ip_lease_id;

  /*! \brief Joint key to the table "vlan". */

  unsigned long int      vlan_id;

  /*! \brief "CIRD", as given from Ogre. */

  char                   cidr[CIDR_SIZE];

  /*! \brief Subnet IP. */

  char                   subnet[IP_ADDRESS_STR_SIZE];

  /*! \brief Gateway IP address. */

  char                   gateway[IP_ADDRESS_STR_SIZE];
};

/*! \brief This table represents the table 'pool'.
 */

struct table_pool
{
  /*! \brief "Auto incremented" ID. */

  unsigned long int      pool_id;

  /*! \brief Joint key to the table "ip_lease". */

  unsigned long int      ip_lease_id;

  /*! \brief Joint key to the table "abonnes". */

  unsigned long int      abonnes_id;

  /*! \brief IP address. */

  char                   ip[IP_ADDRESS_STR_SIZE];

  /*! \brief Expiration timestamp. */

  unsigned long int      expiration;

};

/*! \brief This structure represents the table 'LOGISTIC_RADIUS' of the database 'autoconf'.
 */

struct table_logistic_radius
{
  /*! \brief Field 'MAC_ADDRESS'. */

  char MAC_ADDRESS[LOGISTIC_MAC_ADDRESS_SIZE];

  /*! \brief Field 'RADIUS_LOGIN'. */

  char RADIUS_LOGIN[LOGISTIC_RADIUS_LOGIN_SIZE];

  /*! \brief Field 'LOGIN_MODEM'. */

  char LOGIN_MODEM[LOGISTIC_LOGIN_MODEM_SIZE];

  /*! \brief Field 'FLAG_CHECK_RADIUS'. */

  int FLAG_CHECK_RADIUS;

  /* -------------------------------------------------------- */
  /* The following fields are not part of the DB tables       */
  /* -------------------------------------------------------- */

  /*! \brief This field is not part of the table 'LOGISTIC_RADIUS'. But it will be used when
             the server update the Radonline database.
             If this string is not empty, then the Radonline ACCT_IDENTIFIER inserted in the 
             Radonline table will be the value of this string.
   */

  char radonline_acct_identifier[ACCT_IDENTIFIER_SIZE];

  /*! \brief This field is not part of the table 'LOGISTIC_RADIUS'. But it will be used when
             the server update the Radonline database.
             If this string is not empty, then the USERNAME inserted in the Radonline table
             will be the value of this string.
   */

  char radonline_user_name[LOGIN_RADIUS_SIZE];

  /*! \brief This field is not part of the table 'LOGISTIC_RADIUS'. But it will be used when
             the server update the Radonline database.
             If this string is not empty, then the LOGIN_MODEM inserted in the Radonline table
             will be the value of this string.
   */

  char login_modem[LOGISTIC_LOGIN_MODEM_SIZE];

  /*! \brief This field is not part of the table 'LOGISTIC_RADIUS'.
             This fields identifies the modem's manufacturor.
   */

  int modem_manufacturor;
};

/*! \brief This structure contains all the database description.
 */

struct mysql_tables
{
  /*! \brief Table 'abonnes'. */

  struct table_abonnes abonnes;

  /*! \brief Table 'abonne_ip'. */

  struct table_abonne_ip abonne_ip;

  /*! \brief Table 'vlan'. */

  struct table_vlan vlan;

  /*! \brief Table 'options'. */

  struct table_options options[MAX_PROFILE_OPTIONS];

  /*! \brief Table 'ip_lease'. */

  struct table_ip_lease ip_lease;

  /*! \brief Table 'pool'. */

  struct table_pool pool;

  /*! \brief Table 'logistic'. */

  struct table_logistic_radius logistic;

  /*! \brief Number of elements in the array of options (field 'options').
   */

  int option_number;
};

#endif

#ifdef __cplusplus
}
#endif

---