3 * UCC (University [of WA] Computer Club) Electronic Accounting System
6 * main.c - Core and Initialisation
8 * This file is licenced under the 3-clause BSD Licence. See the file
9 * COPYING for full details.
14 #include <ctype.h> // isspace
15 #include <pwd.h> // getpwuids
16 #include <unistd.h> // close/getuid
17 #include <limits.h> // INT_MIN/INT_MAX
19 #include "../common/doregex.h"
21 #define USE_NCURSES_INTERFACE 0
22 #define DEBUG_TRACE_SERVER 0
23 #define USE_AUTOAUTH 1
25 #define MAX_TXT_ARGS 5 // Maximum number of textual arguments (including command)
26 #define DISPENSE_MULTIPLE_MAX 20 // Maximum argument to -c
32 int main(int argc, char *argv[]);
33 int ParseArguments(int argc, char *argv[]);
34 // --- Coke Server Communication ---
36 char *trim(char *string);
37 int RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage);
38 void CompileRegex(regex_t *regex, const char *pattern, int flags);
41 char *gsDispenseServer = "merlo.ucc.gu.uwa.edu.au";
42 int giDispensePort = 11020;
46 regex_t gArrayRegex, gItemRegex, gSaltRegex, gUserInfoRegex, gUserItemIdentRegex;
47 int gbIsAuthenticated = 0;
49 char *gsItemPattern; //!< Item pattern
50 char *gsEffectiveUser; //!< '-u' Dispense as another user
52 enum eUI_Modes giUIMode = UI_MODE_STANDARD;
53 int gbDryRun = 0; //!< '-n' Read-only
54 int gbDisallowSelectWithoutBalance = 1; //!< Don't allow items to be hilighted if not affordable
56 int giMinimumBalance = INT_MIN; //!< '-m' Minumum balance for `dispense acct`
57 int giMaximumBalance = INT_MAX; //!< '-M' Maximum balance for `dispense acct`
59 char *gsUserName; //!< User that dispense will happen as
60 char *gsUserFlags; //!< User's flag set
61 int giUserBalance = -1; //!< User balance (set by Authenticate)
62 int giDispenseCount = 1; //!< Number of dispenses to do
64 char *gsTextArgs[MAX_TXT_ARGS];
75 " Show interactive list\n"
76 " dispense <name>|<index>|<itemid>\n"
77 " Dispense named item (<name> matches if it is a unique prefix)\n"
79 " Show the finger output\n"
81 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "give") == 0 )
83 " dispense give <user> <amount> \"<reason>\"\n"
84 " Give money to another user\n"
87 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "donate") == 0 )
89 " dispense donate <amount> \"<reason>\"\n"
90 " Donate to the club\n"
92 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "iteminfo") == 0 )
94 " dispense iteminfo <itemid>\n"
95 " Get the name and price for an item\n"
97 // if( giTextArgc == 0 || strcmp(gsTextArgs[0], "enumitems") == 0 )
99 // " dispense enumitems\n"
100 // " List avaliable items\n"
102 if( giTextArgc == 0 )
103 printf(" == Coke members == \n");
104 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "acct") == 0 )
106 " dispense acct [<user>]\n"
107 " Show user balances\n"
108 " dispense acct <user> [+-]<amount> \"<reason>\"\n"
109 " Alter a account value\n"
110 " dispense acct <user> =<amount> \"<reason>\"\n"
111 " Set an account balance\n"
113 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "refund") == 0 )
115 " dispense refund <user> <itemid> [<price>]\n"
116 " Refund an item to a user (with optional price override)\n"
117 " Item IDs can be seen in the cokelog (in the brackets after the item name)\n"
118 " e.g. coke:6 for a coke, snack:33 for slot 33 of the snack machine\n"
120 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "slot") == 0 )
122 " dispense slot <itemid> <price> <name>\n"
123 " Rename/Re-price a slot\n"
125 if( giTextArgc == 0 )
126 printf(" == Dispense administrators ==\n");
127 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "user") == 0 )
129 " dispense user add <user>\n"
130 " Create new account\n"
131 " dispense user type <user> <flags> <reason>\n"
132 " Alter a user's flags\n"
133 " <flags> is a comma-separated list of user, coke, admin, internal or disabled\n"
134 " Flags are removed by preceding the name with '-' or '!'\n"
136 if( giTextArgc == 0 )
140 " Dispense multiple times\n"
142 " Set a different user (Coke members only)\n"
146 " Use simple textual interface (instead of ncurses)\n"
148 " Dry run - Do not actually do dispenses\n"
149 " -m <min balance>\n"
150 " -M <max balance>\n"
151 " Set the Maximum/Minimum balances shown in `dispense acct`\n"
154 " Item ID of the form <type>:<num> where <type> is a non-empty string of alpha-numeric characters, and <num> is a non-negative integer\n"
164 int subcommand_finger(void)
167 int sock = OpenConnection(gsDispenseServer, giDispensePort);
168 if( sock < 0 ) return RV_SOCKET_ERROR;
171 PopulateItemList(sock);
173 printf("The UCC Coke machine.\n\n");
175 // Only get coke slot statuses
176 for( int i = 0; i <= 6; i ++ )
179 switch(gaItems[i].Status)
181 case 0: status = "Avail"; break;
182 case 1: status = "Sold "; break;
187 printf("%i - %s %3i %s\n", gaItems[i].ID, status, gaItems[i].Price, gaItems[i].Desc);
190 printf("\nMay your pink fish bing into the distance.\n");
197 // - Display/manipulate account balances
199 int subcommand_acct(void)
204 int sock = OpenConnection(gsDispenseServer, giDispensePort);
205 if( sock < 0 ) return RV_SOCKET_ERROR;
207 if( giTextArgc == 1 ) {
208 ret = Dispense_EnumUsers(sock);
213 // gsTextArgs[1]: Username
216 if( giTextArgc != 2 )
218 if( giTextArgc != 4 ) {
219 fprintf(stderr, "`dispense acct` requires a reason\n");
224 // Authentication required
225 ret = Authenticate(sock);
228 // gsTextArgs[1]: Username
229 // gsTextArgs[2]: Ammount
230 // gsTextArgs[3]: Reason
232 long int balance = strtol(gsTextArgs[2]+(gsTextArgs[2][0] == '='), &tmp, 10);
233 if(!tmp || *tmp != '\0') {
234 fprintf(stderr, "dispense acct: Value must be a decimal number of cents\n");
238 if( gsTextArgs[2][0] == '=' ) {
240 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
241 ret = Dispense_SetBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
245 ret = Dispense_AlterBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
254 // Show user information
255 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
263 // - Transfer credit from the current user to another account
265 // "Here, have some money."
267 int subcommand_give(int argc, char *args[])
272 fprintf(stderr, "`dispense give` takes three arguments\n");
277 const char *dst_acct = args[0];
278 const char *amt_str = args[1];
279 const char *message = args[2];
282 int sock = OpenConnection(gsDispenseServer, giDispensePort);
283 if( sock < 0 ) return RV_SOCKET_ERROR;
286 ret = Authenticate(sock);
290 long amt = strtol(amt_str, &end, 10);
291 if( !end || *end != '\0' ) {
292 fprintf(stderr, "dispense give: Balance is invalid, must be decimal number of cents");
295 ret = Dispense_Give(sock, dst_acct, amt, message);
303 // - User administration (Admin Only)
305 int subcommand_user(int argc, char *args[])
309 // Check argument count
311 fprintf(stderr, "Error: `dispense user` requires arguments\n");
317 int sock = OpenConnection(gsDispenseServer, giDispensePort);
318 if( sock < 0 ) return RV_SOCKET_ERROR;
320 // Attempt authentication
321 ret = Authenticate(sock);
325 if( strcmp(args[0], "add") == 0 )
327 if( giTextArgc != 3 ) {
328 fprintf(stderr, "Error: `dispense user add` requires an argument\n");
333 ret = Dispense_AddUser(sock, args[1]);
336 else if( strcmp(args[0], "type") == 0 || strcmp(args[0], "flags") == 0 )
338 if( argc < 3 || argc > 4 ) {
339 fprintf(stderr, "Error: `dispense user type` requires two arguments\n");
344 ret = Dispense_SetUserType(sock, args[1], args[2], (argc == 3 ? "" : args[3]));
348 fprintf(stderr, "Error: Unknown sub-command for `dispense user`\n");
358 // - Donate money to the club
360 int subcommand_donate(int argc, char *args[])
364 // Check argument count
366 fprintf(stderr, "Error: `dispense donate` requires two arguments\n");
372 int sock = OpenConnection(gsDispenseServer, giDispensePort);
373 if( sock < 0 ) return RV_SOCKET_ERROR;
375 // Attempt authentication
376 ret = Authenticate(sock);
380 ret = Dispense_Donate(sock, atoi(args[0]), args[1]);
389 // - Refund a purchased item
391 // "Well excuuuuse me, princess"
393 int subcommand_refund(int argc, char *args[])
397 // Check argument count
398 if( argc != 2 && argc != 3 ) {
399 fprintf(stderr, "Error: `dispense refund` takes 2 or 3 arguments\n");
405 int sock = OpenConnection(gsDispenseServer, giDispensePort);
406 if(sock < 0) return RV_SOCKET_ERROR;
408 // Attempt authentication
409 ret = Authenticate(sock);
414 price = atoi(args[2]);
416 fprintf(stderr, "Error: Override price is invalid (should be > 0)\n");
421 // Username, Item, cost
422 ret = Dispense_Refund(sock, args[0], args[1], price);
430 // `dispense iteminfo`
431 // - Get the state of an item
433 int subcommand_iteminfo(int argc, char *args[])
437 // Check argument count
439 fprintf(stderr, "Error: `dispense iteminfo` takes one argument\n");
444 char *item_id = args[0];
446 regmatch_t matches[3];
448 if( RunRegex(&gUserItemIdentRegex, item_id, 3, matches, NULL) != 0 ) {
449 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
452 char *type = item_id + matches[1].rm_so;
453 item_id[ matches[1].rm_eo ] = '\0';
454 int id = atoi( item_id + matches[2].rm_so );
456 int sock = OpenConnection(gsDispenseServer, giDispensePort);
457 if( sock < 0 ) return RV_SOCKET_ERROR;
459 ret = Dispense_ItemInfo(sock, type, id);
466 // - Update the name/price of an item
468 int subcommand_slot(int argc, char *args[])
474 fprintf(stderr, "Error: `dispense slot` takes three arguments\n");
478 char *slot_id = args[0];
479 char *price_str = args[1];
480 char *newname = args[2];
483 regmatch_t matches[3];
484 if( RunRegex(&gUserItemIdentRegex, slot_id, 3, matches, NULL) != 0 ) {
485 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
488 const char *item_type = slot_id + matches[1].rm_so;
489 slot_id[ matches[1].rm_eo ] = '\0';
490 int item_id = atoi( slot_id + matches[2].rm_so );
494 int price = strtol( price_str, &end, 0 );
495 if( price < 0 || *end != '\0' ) {
496 fprintf(stderr, "Error: Invalid price passed (must be >= 0)\n");
501 for( char *pos = newname; *pos; pos ++ )
503 if( !isalnum(*pos) && *pos != ' ' ) {
504 fprintf(stderr, "Error: You should only have letters, numbers and spaces in an item name\n");
509 // Connect & Authenticate
510 int sock = OpenConnection(gsDispenseServer, giDispensePort);
511 if( sock < 0 ) return RV_SOCKET_ERROR;
513 ret = Authenticate(sock);
517 ret = Dispense_SetItem(sock, item_type, item_id, price, newname);
524 // `dispense pincheck`
525 // - Validate a user's pin (used by the snack machine)
527 int subcommand_pincheck(int argc, char *args[])
531 if( argc < 1 || argc > 2 ) {
532 fprintf(stderr, "Error: `dispense pincheck` takes one/two arguments\n");
537 struct passwd *pwd = getpwuid( getuid() );
538 gsUserName = strdup(pwd->pw_name);
540 const char *pin = args[0];
541 const char *user = (argc > 1 ? args[1] : gsUserName);
543 int sock = OpenConnection(gsDispenseServer, giDispensePort);
544 if( sock < 0 ) return RV_SOCKET_ERROR;
546 ret = Authenticate(sock);
549 ret = DispenseCheckPin(sock, user, pin);
557 // - Set the pin of the current account
559 int subcommand_pinset(int argc, char *args[])
564 fprintf(stderr, "Error: `dispense pinset` takes one argument\n");
569 const char *pin = args[0];
571 int sock = OpenConnection(gsDispenseServer, giDispensePort);
572 if( sock < 0 ) return RV_SOCKET_ERROR;
574 ret = Authenticate(sock);
577 ret = DispenseSetPin(sock, pin);
583 int main(int argc, char *argv[])
590 // -- Create regular expressions
591 // > Code Type Count ...
592 CompileRegex(&gArrayRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([0-9]+)", REG_EXTENDED); //
593 // > Code Type Ident Status Price Desc
594 CompileRegex(&gItemRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([A-Za-z]+):([0-9]+)\\s+(avail|sold|error)\\s+([0-9]+)\\s+(.+)$", REG_EXTENDED);
595 // > Code 'SALT' salt
596 CompileRegex(&gSaltRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+(.+)$", REG_EXTENDED);
597 // > Code 'User' Username Balance Flags
598 CompileRegex(&gUserInfoRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([^ ]+)\\s+(-?[0-9]+)\\s+(.+)$", REG_EXTENDED);
600 CompileRegex(&gUserItemIdentRegex, "^([A-Za-z]+):([0-9]+)$", REG_EXTENDED);
603 ret = ParseArguments(argc, argv);
608 if( strcmp(gsTextArgs[0], "finger") == 0 ) {
609 return subcommand_finger();
611 else if( strcmp(gsTextArgs[0], "acct") == 0 ) {
612 return subcommand_acct();
614 else if( strcmp(gsTextArgs[0], "give") == 0 ) {
615 return subcommand_give(giTextArgc-1, gsTextArgs+1);
617 else if( strcmp(gsTextArgs[0], "user") == 0 ) {
618 return subcommand_user(giTextArgc-1, gsTextArgs+1);
620 else if( strcmp(gsTextArgs[0], "donate") == 0 ) {
621 return subcommand_donate(giTextArgc-1, gsTextArgs+1);
623 else if( strcmp(gsTextArgs[0], "refund") == 0 ) {
624 return subcommand_refund(giTextArgc-1, gsTextArgs+1);
626 else if( strcmp(gsTextArgs[0], "iteminfo") == 0 ) {
627 return subcommand_iteminfo(giTextArgc-1, gsTextArgs+1);
629 else if( strcmp(gsTextArgs[0], "slot") == 0 ) {
630 return subcommand_slot(giTextArgc-1, gsTextArgs+1);
632 else if(strcmp(gsTextArgs[0], "pincheck") == 0) {
633 return subcommand_pincheck(giTextArgc-1, gsTextArgs+1);
635 else if(strcmp(gsTextArgs[0], "pinset") == 0) {
636 return subcommand_pinset(giTextArgc-1, gsTextArgs+1);
639 // Item name / pattern
640 gsItemPattern = gsTextArgs[0];
644 int sock = OpenConnection(gsDispenseServer, giDispensePort);
645 if( sock < 0 ) return RV_SOCKET_ERROR;
647 // Get the user's balance
648 ret = GetUserBalance(sock);
652 PopulateItemList(sock);
654 // Disconnect from server
657 if( gsItemPattern && gsItemPattern[0] )
659 regmatch_t matches[3];
661 if( strcmp(gsItemPattern, "door") == 0 )
663 // Connect, Authenticate, dispense and close
664 sock = OpenConnection(gsDispenseServer, giDispensePort);
665 if( sock < 0 ) return RV_SOCKET_ERROR;
666 ret = Authenticate(sock);
668 ret = DispenseItem(sock, "door", 0);
672 // Item id (<type>:<num>)
673 else if( RunRegex(&gUserItemIdentRegex, gsItemPattern, 3, matches, NULL) == 0 )
678 // Get and finish ident
679 ident = gsItemPattern + matches[1].rm_so;
680 gsItemPattern[matches[1].rm_eo] = '\0';
682 id = atoi( gsItemPattern + matches[2].rm_so );
684 // Connect, Authenticate, dispense and close
685 sock = OpenConnection(gsDispenseServer, giDispensePort);
686 if( sock < 0 ) return RV_SOCKET_ERROR;
688 Dispense_ItemInfo(sock, ident, id);
690 ret = Authenticate(sock);
692 ret = DispenseItem(sock, ident, id);
696 // Item number (6 = coke)
697 else if( strcmp(gsItemPattern, "0") == 0 || atoi(gsItemPattern) > 0 )
699 i = atoi(gsItemPattern);
706 for( i = 0; i < giNumItems; i ++ )
708 // Prefix match (with case-insensitive match)
709 for( j = 0; gsItemPattern[j]; j ++ )
711 if( gaItems[i].Desc[j] == gsItemPattern[j] )
713 if( tolower(gaItems[i].Desc[j]) == tolower(gsItemPattern[j]) )
717 // Check if the prefix matched
718 if( gsItemPattern[j] != '\0' )
722 if( gaItems[i].Desc[j] == '\0' ) {
727 // Only one match allowed
732 // TODO: Allow ambiguous matches?
733 // or just print a wanrning
734 printf("Warning - Ambiguous pattern, stopping\n");
739 // Was a match found?
742 fprintf(stderr, "No item matches the passed string\n");
749 else if( giUIMode != UI_MODE_BASIC )
755 // Very basic dispense interface
756 for( i = 0; i < giNumItems; i ++ ) {
758 if( i && strcmp(gaItems[i].Type, gaItems[i-1].Type) != 0 )
761 printf("%2i %s:%i\t%3i %s\n", i, gaItems[i].Type, gaItems[i].ID,
762 gaItems[i].Price, gaItems[i].Desc);
771 fgets(buffer, BUFSIZ, stdin);
775 if( buf[0] == 'q' ) break;
779 if( i != 0 || buf[0] == '0' )
781 if( i < 0 || i >= giNumItems ) {
782 printf("Bad item %i (should be between 0 and %i)\n", i, giNumItems);
791 // Check for a valid item ID
795 // Connect, Authenticate, dispense and close
796 sock = OpenConnection(gsDispenseServer, giDispensePort);
797 if( sock < 0 ) return RV_SOCKET_ERROR;
799 ret = Dispense_ItemInfo(sock, gaItems[i].Type, gaItems[i].ID);
802 ret = Authenticate(sock);
805 for( j = 0; j < giDispenseCount; j ++ ) {
806 ret = DispenseItem(sock, gaItems[i].Type, gaItems[i].ID);
810 printf("%i items dispensed\n", j);
812 Dispense_ShowUser(sock, gsUserName);
820 int ParseArguments(int argc, char *argv[])
822 for( int i = 1; i < argc; i ++ )
836 if( i > 2 && strcmp(argv[i-1], "type") == 0 )
838 if( i + 1 >= argc ) {
839 fprintf(stderr, "%s: -c takes an argument\n", argv[0]);
843 giDispenseCount = atoi(argv[++i]);
844 if( giDispenseCount < 1 || giDispenseCount > DISPENSE_MULTIPLE_MAX ) {
845 fprintf(stderr, "Sorry, only 1-20 can be passed to -c (safety)\n");
851 case 'm': // Minimum balance
852 if( i + 1 >= argc ) {
853 fprintf(stderr, "%s: -m takes an argument\n", argv[0]);
857 giMinimumBalance = atoi(argv[++i]);
859 case 'M': // Maximum balance
860 if( i + 1 >= argc ) {
861 fprintf(stderr, "%s: -M takes an argument\n", argv[0]);
865 giMaximumBalance = atoi(argv[++i]);
868 case 'u': // Override User
869 if( i + 1 >= argc ) {
870 fprintf(stderr, "%s: -u takes an argument\n", argv[0]);
874 gsEffectiveUser = argv[++i];
877 case 'H': // Override remote host
878 if( i + 1 >= argc ) {
879 fprintf(stderr, "%s: -H takes an argument\n", argv[0]);
883 gsDispenseServer = argv[++i];
885 case 'P': // Override remote port
886 if( i + 1 >= argc ) {
887 fprintf(stderr, "%s: -P takes an argument\n", argv[0]);
891 giDispensePort = atoi(argv[++i]);
894 // Set slot name/price
896 if( giTextArgc != 0 ) {
897 fprintf(stderr, "%s: -s must appear before other arguments\n", argv[0]);
901 gsTextArgs[0] = "slot"; // HACK!!
905 case 'G': // Don't use GUI
906 giUIMode = UI_MODE_BASIC;
908 case 'D': // Drinks only
909 giUIMode = UI_MODE_DRINKSONLY;
911 case 'n': // Dry Run / read-only
915 if( strcmp(argv[i], "--help") == 0 ) {
919 else if( strcmp(argv[i], "--dry-run") == 0 ) {
922 else if( strcmp(argv[i], "--drinks-only") == 0 ) {
923 giUIMode = UI_MODE_DRINKSONLY;
925 else if( strcmp(argv[i], "--can-select-all") == 0 ) {
926 gbDisallowSelectWithoutBalance = 0;
929 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
935 // The first argument is not allowed to begin with 'i'
936 // (catches most bad flags)
937 if( giTextArgc == 0 ) {
938 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
942 if( giTextArgc == MAX_TXT_ARGS )
944 fprintf(stderr, "ERROR: Too many arguments\n");
947 gsTextArgs[giTextArgc++] = argv[i];
954 if( giTextArgc == MAX_TXT_ARGS )
956 fprintf(stderr, "ERROR: Too many arguments\n");
960 gsTextArgs[giTextArgc++] = argv[i];
969 char *trim(char *string)
973 while( isspace(*string) )
976 for( i = strlen(string); i--; )
978 if( isspace(string[i]) )