src/server/common.h

   1 /*
   2  * OpenDispense2
   3  *
   4  * This code is published under the terms of the Acess licence.
   5  * See the file COPYING for details.
   6  *
   7  * common.h - Core Header
   8  */
   9 #ifndef _COMMON_H_
  10 #define _COMMON_H_
  11
  12 #include <regex.h>
  13 #include "../cokebank.h"
  14
  15 // === CONSTANTS ===
  16 #define DEFAULT_CONFIG_FILE     "/etc/opendispense/main.cfg"
  17 #define DEFAULT_ITEM_FILE       "/etc/opendispense/items.cfg"
  18
  19 // === HELPER MACROS ===
  20 #define _EXPSTR(x)      #x
  21 #define EXPSTR(x)       _EXPSTR(x)
  22
  23 #define UNUSED(var)     unused__##var __attribute__((__unused__))
  24
  25 // === STRUCTURES ===
  26 typedef struct sItem    tItem;
  27 typedef struct sUser    tUser;
  28 typedef struct sConfigItem      tConfigItem;
  29 typedef struct sHandler tHandler;
  30
  31 struct sItem
  32 {
  33         char    *Name;  //!< Display Name
  34          int    Price;  //!< Price
  35          int    bHidden;        //!< Hidden item?
  36          int    bDisabledi;     //!< Disabled Item
  37
  38         tHandler        *Handler;       //!< Handler for the item
  39         short   ID;     //!< Item ID
  40 };
  41
  42 struct sUser
  43 {
  44          int    ID;             //!< User ID (LDAP ID)
  45          int    Balance;        //!< Balance in cents
  46          int    Bytes;  //!< Traffic Usage
  47         char    Name[]; //!< Username
  48 };
  49
  50 struct sConfigItem
  51 {
  52         char    *Name;
  53         char    *Value;
  54 };
  55
  56 struct sHandler
  57 {
  58         char    *Name;
  59          int    (*Init)(int NConfig, tConfigItem *Config);
  60         /**
  61          * \brief Check if an item can be dispensed
  62          * \return Boolean Failure
  63          */
  64          int    (*CanDispense)(int User, int ID);
  65          int    (*DoDispense)(int User, int ID);
  66 };
  67
  68 // === GLOBALS ===
  69 extern tItem    *gaItems;
  70 extern int      giNumItems;
  71 extern tHandler *gaHandlers[];
  72 extern int      giNumHandlers;
  73 extern int      giDebugLevel;
  74
  75 // === FUNCTIONS ===
  76 extern void     Items_UpdateFile(void);
  77
  78 // --- Helpers --
  79 extern void     StartPeriodicThread(void);
  80 extern void     AddPeriodicFunction(void (*Fcn)(void));
  81 extern void     CompileRegex(regex_t *Regex, const char *Pattern, int Flags);
  82 extern int      RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage);
  83 extern int      InitSerial(const char *Path, int BaudRate);
  84 extern char     *mkstr(const char *Format, ...);
  85
  86 // --- Dispense ---
  87 extern int      DispenseItem(int ActualUser, int User, tItem *Item);
  88 extern int      DispenseRefund(int ActualUser, int DestUser, tItem *Item, int OverridePrice);
  89 extern int      DispenseGive(int ActualUser, int SrcUser, int DestUser, int Ammount, const char *ReasonGiven);
  90 extern int      DispenseAdd(int ActualUser, int User, int Ammount, const char *ReasonGiven);
  91 extern int      DispenseSet(int ActualUser, int User, int Balance, const char *ReasonGiven);
  92 extern int      DispenseDonate(int ActualUser, int User, int Ammount, const char *ReasonGiven);
  93 extern int      DispenseUpdateItem(int User, tItem *Item, const char *NewName, int NewPrice);
  94
  95 // --- Logging ---
  96 extern void     Log_Error(const char *Format, ...);
  97 extern void     Log_Info(const char *Format, ...);
  98
  99 #endif