src/cokebank.h

   1 /*
   2  * OpenDispense 2
   3  * UCC (University [of WA] Computer Club) Electronic Accounting System
   4  *
   5  * cokebank.h - Coke-Bank common definitions
   6  *
   7  * This file is licenced under the 3-clause BSD Licence. See the file COPYING
   8  * for full details.
   9  */
  10 /**
  11  * \file cokebank.h
  12  * \brief Coke Bank API Documentation
  13  */
  14 #ifndef _COKEBANK_H_
  15 #define _COKEBANK_H_
  16
  17 #include <stdlib.h>
  18
  19 #define COKEBANK_SALES_ACCT     ">sales"        //!< Sales made into
  20 #define COKEBANK_SALES_PREFIX   ">sales:"       //!< Sales made into
  21 #define COKEBANK_DEBT_ACCT      ">liability"    //!< Credit taken out of
  22 #define COKEBANK_FREE_ACCT      ">freeitems"    //!< ODay drink costs taken out of
  23 #define COKEBANK_DONATE_ACCT    ">donations"    //!< Donations go here
  24
  25 /**
  26  * \brief Account iterator opaque structure
  27  *
  28  * Opaque structure for account iterators returned by Bank_Iterator
  29  * and used by Bank_IteratorNext and Bank_DelIterator
  30  */
  31 typedef struct sAcctIterator    tAcctIterator;
  32
  33 #if 0
  34 /**
  35  * \brief Iterator for a collection of items
  36  */
  37 typedef struct sItemIterator    tItemIterator;
  38
  39 /**
  40  * \brief Item structure
  41  */
  42 typedef struct
  43 {
  44         char    *Handler;
  45          int    ID;
  46          int    Price;
  47         char    Name[];
  48 }       tItem;
  49 #endif
  50
  51 /**
  52  * \brief Flag values for the \a Flags parameter to Bank_Iterator
  53  */
  54 enum eBank_ItFlags
  55 {
  56         BANK_ITFLAG_MINBALANCE  = 0x01, //!< Balance value is Minium Balance
  57         BANK_ITFLAG_MAXBALANCE  = 0x02, //!< Balance value is Maximum Balance (higher priority)
  58         BANK_ITFLAG_SEENAFTER   = 0x04, //!< Last seen value is lower bound
  59         BANK_ITFLAG_SEENBEFORE  = 0x08, //!< Last seen value is upper bound (higher priority)
  60
  61         BANK_ITFLAG_SORT_NONE   = 0x000,        //!< No sorting (up to the implementation)
  62         BANK_ITFLAG_SORT_NAME   = 0x100,        //!< Sort alphabetically ascending by name
  63         BANK_ITFLAG_SORT_BAL    = 0x200,        //!< Sort by balance, ascending
  64         BANK_ITFLAG_SORT_UNIXID = 0x300,        //!< Sort by UnixUID (TODO: Needed?)
  65         BANK_ITFLAG_SORT_LASTSEEN = 0x400,      //!< Sort by last seen time (ascending)
  66         BANK_ITFLAG_SORTMASK    = 0x700,        //!< Sort type mask
  67         BANK_ITFLAG_REVSORT     = 0x800 //!< Sort descending instead
  68 };
  69 /**
  70  * \brief Flag values for the \a Flags parameter to Items_Iterator
  71  */
  72 enum eItems_ItFlags
  73 {
  74         ITEMS_ITFLAG_SHOWDISABLED = 0x001,      //!< Show disabled items
  75         ITEMS_ITFLAG_SORT_NONE  = 0x000,        //!< No sorting (up to the implementation)
  76         ITEMS_ITFLAG_SORT_NAME  = 0x100,        //!< Sort alphabetically ascending by name
  77         ITEMS_ITFLAG_SORT_PRICE = 0x200,        //!< Sort by price, ascending
  78         ITEMS_ITFLAG_SORT_IDENT = 0x300,        //!< Sort by Identifier (handler:id)
  79         ITEMS_ITFLAG_SORTMASK   = 0x700,        //!< Sort type mask
  80         ITEMS_ITFLAG_REVSORT    = 0x800 //!< Sort descending instead
  81 };
  82
  83 /**
  84  * \brief User flag values
  85  *
  86  * User flag values used by Bank_GetFlags and Bank_SetFlags
  87  */
  88 enum eCokebank_Flags {
  89         USER_FLAG_COKE          = 0x01, //!< User is a coke member (can do coke accounting)
  90         USER_FLAG_ADMIN         = 0x02, //!< User is a administrator (can create, delete and lock accounts)
  91         USER_FLAG_DOORGROUP     = 0x04, //!< User is in the door group (can open the clubroom door)
  92         USER_FLAG_INTERNAL      = 0x40, //!< Account is internal (cannot be authenticated, no lower balance limit)
  93         USER_FLAG_DISABLED      = 0x80  //!< Account is disabled (no transactions allowed)
  94 };
  95
  96 // --- Cokebank Functions ---
  97 /**
  98  * \brief Initialise the cokebank
  99  * \param Argument      Cokebank argument specified in the dispense config file (typically the database path)
 100  * \return Boolean Failure
 101  */
 102 extern int      Bank_Initialise(const char *Argument);
 103
 104 /**
 105  * \brief Transfer money from one account to another
 106  * \param SourceAcct    UID (from \a Bank_GetUserID) to take the money from
 107  * \param DestAcct      UID (from \a Bank_GetUserID) give money to
 108  * \param Ammount       Amount of money (in cents) to transfer
 109  * \param Reason        Reason for the transfer
 110  */
 111 extern int      Bank_Transfer(int SourceAcct, int DestAcct, int Ammount, const char *Reason);
 112 /**
 113  * \brief Get flags on an account
 114  * \param AcctID        UID to get flags from
 115  * \return Flag set as defined in eCokebank_Flags
 116  */
 117 extern int      Bank_GetFlags(int AcctID);
 118 /**
 119  * \brief Set an account's flags
 120  * \param AcctID        UID to set flags on
 121  * \param Mask  Mask of flags changed
 122  * \param Value Final value of changed flags
 123  */
 124 extern int      Bank_SetFlags(int AcctID, int Mask, int Value);
 125 /**
 126  * \brief Get an account's balance
 127  * \param AcctID        Account to query
 128  */
 129 extern int      Bank_GetBalance(int AcctID);
 130 /**
 131  * \brief Get the name associated with an account
 132  * \return Heap string
 133  */
 134 extern char     *Bank_GetAcctName(int AcctID);
 135 /**
 136  * \brief Get an account ID from a passed name
 137  * \param Name  Name to search for
 138  * \return ID of the account, or -1 if not found
 139  */
 140 extern int      Bank_GetAcctByName(const char *Name, int bCreate);
 141 /**
 142  * \brief Create a new account
 143  * \param Name  Name for the new account (if NULL, an anoymous account is created)
 144  * \return ID of the new account
 145  */
 146 extern int      Bank_CreateAcct(const char *Name);
 147
 148 /**
 149  * \brief Create an account iterator
 150  * \param FlagMask      Mask of account flags to check
 151  * \param FlagValues    Wanted values for checked flags
 152  * \param Flags Specifies the operation of \a MinMaxBalance and \a Timestamp  (\see eBank_ItFlags)
 153  * \param MinMaxBalance Mininum/Maximum balance
 154  * \param LastSeen      Latest/Earliest last seen time
 155  * \return Pointer to an iterator across the selected data set
 156  */
 157 extern tAcctIterator    *Bank_Iterator(int FlagMask, int FlagValues,
 158         int Flags, int MinMaxBalance, time_t LastSeen);
 159
 160 /**
 161  * \brief Get the current entry in the iterator and move to the next
 162  * \param It    Iterator returned by Bank_Iterator
 163  * \return Accoun ID, or -1 for end of list
 164  */
 165 extern int      Bank_IteratorNext(tAcctIterator *It);
 166
 167 /**
 168  * \brief Free an allocated iterator
 169  * \param It    Iterator returned by Bank_Iterator
 170  */
 171 extern void     Bank_DelIterator(tAcctIterator *It);
 172
 173 /**
 174  * \brief Validates a user's authentication
 175  * \param Salt  Salt given to the client for hashing the password
 176  * \param Username      Username used
 177  * \param Password      Password sent by the client
 178  * \return User ID
 179  */
 180 extern int      Bank_GetUserAuth(const char *Salt, const char *Username, const char *Password);
 181
 182 /**
 183  * \brief Get an account ID from a MIFARE card ID
 184  * \param CardID        MIFARE card ID
 185  * \return Account ID
 186  */
 187 extern int      Bank_GetAcctByCard(const char *CardID);
 188
 189 /**
 190  * \brief Add a card to an account
 191  * \param AcctID        Account ID
 192  * \param CardID        MIFARE card ID
 193  * \return Boolean failure
 194  * \retval 0    Success
 195  * \retval 1    Bad account ID
 196  * \retval 2    Card in use
 197  */
 198 extern int      Bank_AddAcctCard(int AcctID, const char *CardID);
 199
 200 // === Item Manipulation ===
 201 #if 0
 202 extern tItem    *Items_GetItem(char *Handler, int ID);
 203 /**
 204  * \brief Create an item iterator
 205  * \return Pointer to an iterator across the selected data set
 206  */
 207 extern tItemIterator    *Items_Iterator(int Flags, char *Handler, int MaxPrice);
 208
 209 /**
 210  * \brief Get the current entry in the iterator and move to the next
 211  * \param It    Iterator returned by Items_Iterator
 212  * \return Item ID, or -1 for end of list
 213  */
 214 extern tItem    *Items_IteratorNext(tItemIterator *It);
 215
 216 /**
 217  * \brief Free an allocated iterator
 218  * \param It    Iterator returned by Items_Iterator
 219  */
 220 extern void     Items_DelIterator(tItemIterator *It);
 221 #endif
 222
 223 // ---
 224 // Server provided helper functions
 225 // ---
 226 /**
 227  * \brief Create a formatted string on the heap
 228  * \param Format        Format string
 229  * \return Heap string
 230  */
 231 extern char     *mkstr(const char *Format, ...);
 232
 233 /**
 234  * \brief Dispense log access
 235  * \note Try not to over-use, only stuff that matters should go in here
 236  */
 237 extern void     Log_Info(const char *Format, ...);
 238
 239 #endif