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
20 #define USE_NCURSES_INTERFACE 0
21 #define DEBUG_TRACE_SERVER 0
22 #define USE_AUTOAUTH 1
24 #define MAX_TXT_ARGS 5 // Maximum number of textual arguments (including command)
25 #define DISPENSE_MULTIPLE_MAX 20 // Maximum argument to -c
31 int main(int argc, char *argv[]);
32 int ParseArguments(int argc, char *argv[]);
33 // --- Coke Server Communication ---
35 char *trim(char *string);
36 int RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage);
37 void CompileRegex(regex_t *regex, const char *pattern, int flags);
40 char *gsDispenseServer = "merlo.ucc.gu.uwa.edu.au";
41 int giDispensePort = 11020;
45 regex_t gArrayRegex, gItemRegex, gSaltRegex, gUserInfoRegex, gUserItemIdentRegex;
46 int gbIsAuthenticated = 0;
48 char *gsItemPattern; //!< Item pattern
49 char *gsEffectiveUser; //!< '-u' Dispense as another user
51 enum eUI_Modes giUIMode = UI_MODE_STANDARD;
52 int gbDryRun = 0; //!< '-n' Read-only
53 int gbDisallowSelectWithoutBalance = 1; //!< Don't allow items to be hilighted if not affordable
55 int giMinimumBalance = INT_MIN; //!< '-m' Minumum balance for `dispense acct`
56 int giMaximumBalance = INT_MAX; //!< '-M' Maximum balance for `dispense acct`
58 char *gsUserName; //!< User that dispense will happen as
59 char *gsUserFlags; //!< User's flag set
60 int giUserBalance = -1; //!< User balance (set by Authenticate)
61 int giDispenseCount = 1; //!< Number of dispenses to do
63 char *gsTextArgs[MAX_TXT_ARGS];
74 " Show interactive list\n"
75 " dispense <name>|<index>|<itemid>\n"
76 " Dispense named item (<name> matches if it is a unique prefix)\n"
78 " Show the finger output\n"
80 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "give") == 0 )
82 " dispense give <user> <amount> \"<reason>\"\n"
83 " Give money to another user\n"
86 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "donate") == 0 )
88 " dispense donate <amount> \"<reason>\"\n"
89 " Donate to the club\n"
91 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "iteminfo") == 0 )
93 " dispense iteminfo <itemid>\n"
94 " Get the name and price for an item\n"
96 // if( giTextArgc == 0 || strcmp(gsTextArgs[0], "enumitems") == 0 )
98 // " dispense enumitems\n"
99 // " List avaliable items\n"
101 if( giTextArgc == 0 )
102 printf(" == Coke members == \n");
103 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "acct") == 0 )
105 " dispense acct [<user>]\n"
106 " Show user balances\n"
107 " dispense acct <user> [+-]<amount> \"<reason>\"\n"
108 " Alter a account value\n"
109 " dispense acct <user> =<amount> \"<reason>\"\n"
110 " Set an account balance\n"
112 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "refund") == 0 )
114 " dispense refund <user> <itemid> [<price>]\n"
115 " Refund an item to a user (with optional price override)\n"
116 " Item IDs can be seen in the cokelog (in the brackets after the item name)\n"
117 " e.g. coke:6 for a coke, snack:33 for slot 33 of the snack machine\n"
119 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "slot") == 0 )
121 " dispense slot <itemid> <price> <name>\n"
122 " Rename/Re-price a slot\n"
124 if( giTextArgc == 0 )
125 printf(" == Dispense administrators ==\n");
126 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "user") == 0 )
128 " dispense user add <user>\n"
129 " Create new account\n"
130 " dispense user type <user> <flags> <reason>\n"
131 " Alter a user's flags\n"
132 " <flags> is a comma-separated list of user, coke, admin, internal or disabled\n"
133 " Flags are removed by preceding the name with '-' or '!'\n"
135 if( giTextArgc == 0 )
139 " Dispense multiple times\n"
141 " Set a different user (Coke members only)\n"
145 " Use simple textual interface (instead of ncurses)\n"
147 " Dry run - Do not actually do dispenses\n"
148 " -m <min balance>\n"
149 " -M <max balance>\n"
150 " Set the Maximum/Minimum balances shown in `dispense acct`\n"
153 " 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"
163 int subcommand_finger(void)
166 int sock = OpenConnection(gsDispenseServer, giDispensePort);
167 if( sock < 0 ) return RV_SOCKET_ERROR;
170 PopulateItemList(sock);
172 printf("The UCC Coke machine.\n\n");
174 // Only get coke slot statuses
175 for( int i = 0; i <= 6; i ++ )
178 switch(gaItems[i].Status)
180 case 0: status = "Avail"; break;
181 case 1: status = "Sold "; break;
186 printf("%i - %s %3i %s\n", gaItems[i].ID, status, gaItems[i].Price, gaItems[i].Desc);
189 printf("\nMay your pink fish bing into the distance.\n");
196 // - Display/manipulate account balances
198 int subcommand_acct(void)
203 int sock = OpenConnection(gsDispenseServer, giDispensePort);
204 if( sock < 0 ) return RV_SOCKET_ERROR;
206 if( giTextArgc == 1 ) {
207 ret = Dispense_EnumUsers(sock);
212 // gsTextArgs[1]: Username
215 if( giTextArgc != 2 )
217 if( giTextArgc != 4 ) {
218 fprintf(stderr, "`dispense acct` requires a reason\n");
223 // Authentication required
224 ret = Authenticate(sock);
227 // gsTextArgs[1]: Username
228 // gsTextArgs[2]: Ammount
229 // gsTextArgs[3]: Reason
231 long int balance = strtol(gsTextArgs[2]+(gsTextArgs[2][0] == '='), &tmp, 10);
232 if(!tmp || *tmp != '\0') {
233 fprintf(stderr, "dispense acct: Value must be a decimal number of cents\n");
237 if( gsTextArgs[2][0] == '=' ) {
239 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
240 ret = Dispense_SetBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
244 ret = Dispense_AlterBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
253 // Show user information
254 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
262 // - Transfer credit from the current user to another account
264 // "Here, have some money."
266 int subcommand_give(int argc, char *args[])
271 fprintf(stderr, "`dispense give` takes three arguments\n");
276 const char *dst_acct = args[0];
277 const char *amt_str = args[1];
278 const char *message = args[2];
281 int sock = OpenConnection(gsDispenseServer, giDispensePort);
282 if( sock < 0 ) return RV_SOCKET_ERROR;
285 ret = Authenticate(sock);
289 long amt = strtol(amt_str, &end, 10);
290 if( !end || *end != '\0' ) {
291 fprintf(stderr, "dispense give: Balance is invalid, must be decimal number of cents");
294 ret = Dispense_Give(sock, dst_acct, amt, message);
302 // - User administration (Admin Only)
304 int subcommand_user(int argc, char *args[])
308 // Check argument count
310 fprintf(stderr, "Error: `dispense user` requires arguments\n");
316 int sock = OpenConnection(gsDispenseServer, giDispensePort);
317 if( sock < 0 ) return RV_SOCKET_ERROR;
319 // Attempt authentication
320 ret = Authenticate(sock);
324 if( strcmp(args[0], "add") == 0 )
326 if( giTextArgc != 3 ) {
327 fprintf(stderr, "Error: `dispense user add` requires an argument\n");
332 ret = Dispense_AddUser(sock, args[1]);
335 else if( strcmp(args[0], "type") == 0 || strcmp(args[0], "flags") == 0 )
337 if( argc < 3 || argc > 4 ) {
338 fprintf(stderr, "Error: `dispense user type` requires two arguments\n");
343 ret = Dispense_SetUserType(sock, args[1], args[2], (argc == 3 ? "" : args[3]));
347 fprintf(stderr, "Error: Unknown sub-command for `dispense user`\n");
357 // - Donate money to the club
359 int subcommand_donate(int argc, char *args[])
363 // Check argument count
365 fprintf(stderr, "Error: `dispense donate` requires two arguments\n");
371 int sock = OpenConnection(gsDispenseServer, giDispensePort);
372 if( sock < 0 ) return RV_SOCKET_ERROR;
374 // Attempt authentication
375 ret = Authenticate(sock);
379 ret = Dispense_Donate(sock, atoi(args[0]), args[1]);
388 // - Refund a purchased item
390 // "Well excuuuuse me, princess"
392 int subcommand_refund(int argc, char *args[])
396 // Check argument count
397 if( argc != 2 && argc != 3 ) {
398 fprintf(stderr, "Error: `dispense refund` takes 2 or 3 arguments\n");
404 int sock = OpenConnection(gsDispenseServer, giDispensePort);
405 if(sock < 0) return RV_SOCKET_ERROR;
407 // Attempt authentication
408 ret = Authenticate(sock);
413 price = atoi(args[2]);
415 fprintf(stderr, "Error: Override price is invalid (should be > 0)\n");
420 // Username, Item, cost
421 ret = Dispense_Refund(sock, args[0], args[1], price);
429 // `dispense iteminfo`
430 // - Get the state of an item
432 int subcommand_iteminfo(int argc, char *args[])
436 // Check argument count
438 fprintf(stderr, "Error: `dispense iteminfo` takes one argument\n");
443 char *item_id = args[0];
445 regmatch_t matches[3];
447 if( RunRegex(&gUserItemIdentRegex, item_id, 3, matches, NULL) != 0 ) {
448 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
451 char *type = item_id + matches[1].rm_so;
452 item_id[ matches[1].rm_eo ] = '\0';
453 int id = atoi( item_id + matches[2].rm_so );
455 int sock = OpenConnection(gsDispenseServer, giDispensePort);
456 if( sock < 0 ) return RV_SOCKET_ERROR;
458 ret = Dispense_ItemInfo(sock, type, id);
465 // - Update the name/price of an item
467 int subcommand_slot(int argc, char *args[])
473 fprintf(stderr, "Error: `dispense slot` takes three arguments\n");
477 char *slot_id = args[0];
478 char *price_str = args[1];
479 char *newname = args[2];
482 regmatch_t matches[3];
483 if( RunRegex(&gUserItemIdentRegex, slot_id, 3, matches, NULL) != 0 ) {
484 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
487 const char *item_type = slot_id + matches[1].rm_so;
488 slot_id[ matches[1].rm_eo ] = '\0';
489 int item_id = atoi( slot_id + matches[2].rm_so );
493 int price = strtol( price_str, &end, 0 );
494 if( price < 0 || *end != '\0' ) {
495 fprintf(stderr, "Error: Invalid price passed (must be >= 0)\n");
500 for( char *pos = newname; *pos; pos ++ )
502 if( !isalnum(*pos) && *pos != ' ' ) {
503 fprintf(stderr, "Error: You should only have letters, numbers and spaces in an item name\n");
508 // Connect & Authenticate
509 int sock = OpenConnection(gsDispenseServer, giDispensePort);
510 if( sock < 0 ) return RV_SOCKET_ERROR;
512 ret = Authenticate(sock);
516 ret = Dispense_SetItem(sock, item_type, item_id, price, newname);
523 // `dispense pincheck`
524 // - Validate a user's pin (used by the snack machine)
526 int subcommand_pincheck(int argc, char *args[])
530 if( argc < 1 || argc > 2 ) {
531 fprintf(stderr, "Error: `dispense pincheck` takes one/two arguments\n");
536 struct passwd *pwd = getpwuid( getuid() );
537 gsUserName = strdup(pwd->pw_name);
539 const char *pin = args[0];
540 const char *user = (argc > 1 ? args[1] : gsUserName);
542 int sock = OpenConnection(gsDispenseServer, giDispensePort);
543 if( sock < 0 ) return RV_SOCKET_ERROR;
545 ret = Authenticate(sock);
548 ret = DispenseCheckPin(sock, user, pin);
556 // - Set the pin of the current account
558 int subcommand_pinset(int argc, char *args[])
563 fprintf(stderr, "Error: `dispense pinset` takes one argument\n");
568 const char *pin = args[0];
570 int sock = OpenConnection(gsDispenseServer, giDispensePort);
571 if( sock < 0 ) return RV_SOCKET_ERROR;
573 ret = Authenticate(sock);
576 ret = DispenseSetPin(sock, pin);
582 int main(int argc, char *argv[])
589 // -- Create regular expressions
590 // > Code Type Count ...
591 CompileRegex(&gArrayRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([0-9]+)", REG_EXTENDED); //
592 // > Code Type Ident Status Price Desc
593 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);
594 // > Code 'SALT' salt
595 CompileRegex(&gSaltRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+(.+)$", REG_EXTENDED);
596 // > Code 'User' Username Balance Flags
597 CompileRegex(&gUserInfoRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([^ ]+)\\s+(-?[0-9]+)\\s+(.+)$", REG_EXTENDED);
599 CompileRegex(&gUserItemIdentRegex, "^([A-Za-z]+):([0-9]+)$", REG_EXTENDED);
602 ret = ParseArguments(argc, argv);
607 if( strcmp(gsTextArgs[0], "finger") == 0 ) {
608 return subcommand_finger();
610 else if( strcmp(gsTextArgs[0], "acct") == 0 ) {
611 return subcommand_acct();
613 else if( strcmp(gsTextArgs[0], "give") == 0 ) {
614 return subcommand_give(giTextArgc-1, gsTextArgs+1);
616 else if( strcmp(gsTextArgs[0], "user") == 0 ) {
617 return subcommand_user(giTextArgc-1, gsTextArgs+1);
619 else if( strcmp(gsTextArgs[0], "donate") == 0 ) {
620 return subcommand_donate(giTextArgc-1, gsTextArgs+1);
622 else if( strcmp(gsTextArgs[0], "refund") == 0 ) {
623 return subcommand_refund(giTextArgc-1, gsTextArgs+1);
625 else if( strcmp(gsTextArgs[0], "iteminfo") == 0 ) {
626 return subcommand_iteminfo(giTextArgc-1, gsTextArgs+1);
628 else if( strcmp(gsTextArgs[0], "slot") == 0 ) {
629 return subcommand_slot(giTextArgc-1, gsTextArgs+1);
631 else if(strcmp(gsTextArgs[0], "pincheck") == 0) {
632 return subcommand_pincheck(giTextArgc-1, gsTextArgs+1);
634 else if(strcmp(gsTextArgs[0], "pinset") == 0) {
635 return subcommand_pinset(giTextArgc-1, gsTextArgs+1);
638 // Item name / pattern
639 gsItemPattern = gsTextArgs[0];
643 int sock = OpenConnection(gsDispenseServer, giDispensePort);
644 if( sock < 0 ) return RV_SOCKET_ERROR;
646 // Get the user's balance
647 ret = GetUserBalance(sock);
651 PopulateItemList(sock);
653 // Disconnect from server
656 if( gsItemPattern && gsItemPattern[0] )
658 regmatch_t matches[3];
660 if( strcmp(gsItemPattern, "door") == 0 )
662 // Connect, Authenticate, dispense and close
663 sock = OpenConnection(gsDispenseServer, giDispensePort);
664 if( sock < 0 ) return RV_SOCKET_ERROR;
665 ret = Authenticate(sock);
667 ret = DispenseItem(sock, "door", 0);
671 // Item id (<type>:<num>)
672 else if( RunRegex(&gUserItemIdentRegex, gsItemPattern, 3, matches, NULL) == 0 )
677 // Get and finish ident
678 ident = gsItemPattern + matches[1].rm_so;
679 gsItemPattern[matches[1].rm_eo] = '\0';
681 id = atoi( gsItemPattern + matches[2].rm_so );
683 // Connect, Authenticate, dispense and close
684 sock = OpenConnection(gsDispenseServer, giDispensePort);
685 if( sock < 0 ) return RV_SOCKET_ERROR;
687 Dispense_ItemInfo(sock, ident, id);
689 ret = Authenticate(sock);
691 ret = DispenseItem(sock, ident, id);
695 // Item number (6 = coke)
696 else if( strcmp(gsItemPattern, "0") == 0 || atoi(gsItemPattern) > 0 )
698 i = atoi(gsItemPattern);
705 for( i = 0; i < giNumItems; i ++ )
707 // Prefix match (with case-insensitive match)
708 for( j = 0; gsItemPattern[j]; j ++ )
710 if( gaItems[i].Desc[j] == gsItemPattern[j] )
712 if( tolower(gaItems[i].Desc[j]) == tolower(gsItemPattern[j]) )
716 // Check if the prefix matched
717 if( gsItemPattern[j] != '\0' )
721 if( gaItems[i].Desc[j] == '\0' ) {
726 // Only one match allowed
731 // TODO: Allow ambiguous matches?
732 // or just print a wanrning
733 printf("Warning - Ambiguous pattern, stopping\n");
738 // Was a match found?
741 fprintf(stderr, "No item matches the passed string\n");
748 else if( giUIMode != UI_MODE_BASIC )
754 // Very basic dispense interface
755 for( i = 0; i < giNumItems; i ++ ) {
757 if( i && strcmp(gaItems[i].Type, gaItems[i-1].Type) != 0 )
760 printf("%2i %s:%i\t%3i %s\n", i, gaItems[i].Type, gaItems[i].ID,
761 gaItems[i].Price, gaItems[i].Desc);
770 fgets(buffer, BUFSIZ, stdin);
774 if( buf[0] == 'q' ) break;
778 if( i != 0 || buf[0] == '0' )
780 if( i < 0 || i >= giNumItems ) {
781 printf("Bad item %i (should be between 0 and %i)\n", i, giNumItems);
790 // Check for a valid item ID
794 // Connect, Authenticate, dispense and close
795 sock = OpenConnection(gsDispenseServer, giDispensePort);
796 if( sock < 0 ) return RV_SOCKET_ERROR;
798 ret = Dispense_ItemInfo(sock, gaItems[i].Type, gaItems[i].ID);
801 ret = Authenticate(sock);
804 for( j = 0; j < giDispenseCount; j ++ ) {
805 ret = DispenseItem(sock, gaItems[i].Type, gaItems[i].ID);
809 printf("%i items dispensed\n", j);
811 Dispense_ShowUser(sock, gsUserName);
819 int ParseArguments(int argc, char *argv[])
821 for( int i = 1; i < argc; i ++ )
835 if( i > 2 && strcmp(argv[i-1], "type") == 0 )
837 if( i + 1 >= argc ) {
838 fprintf(stderr, "%s: -c takes an argument\n", argv[0]);
842 giDispenseCount = atoi(argv[++i]);
843 if( giDispenseCount < 1 || giDispenseCount > DISPENSE_MULTIPLE_MAX ) {
844 fprintf(stderr, "Sorry, only 1-20 can be passed to -c (safety)\n");
850 case 'm': // Minimum balance
851 if( i + 1 >= argc ) {
852 fprintf(stderr, "%s: -m takes an argument\n", argv[0]);
856 giMinimumBalance = atoi(argv[++i]);
858 case 'M': // Maximum balance
859 if( i + 1 >= argc ) {
860 fprintf(stderr, "%s: -M takes an argument\n", argv[0]);
864 giMaximumBalance = atoi(argv[++i]);
867 case 'u': // Override User
868 if( i + 1 >= argc ) {
869 fprintf(stderr, "%s: -u takes an argument\n", argv[0]);
873 gsEffectiveUser = argv[++i];
876 case 'H': // Override remote host
877 if( i + 1 >= argc ) {
878 fprintf(stderr, "%s: -H takes an argument\n", argv[0]);
882 gsDispenseServer = argv[++i];
884 case 'P': // Override remote port
885 if( i + 1 >= argc ) {
886 fprintf(stderr, "%s: -P takes an argument\n", argv[0]);
890 giDispensePort = atoi(argv[++i]);
893 // Set slot name/price
895 if( giTextArgc != 0 ) {
896 fprintf(stderr, "%s: -s must appear before other arguments\n", argv[0]);
900 gsTextArgs[0] = "slot"; // HACK!!
904 case 'G': // Don't use GUI
905 giUIMode = UI_MODE_BASIC;
907 case 'D': // Drinks only
908 giUIMode = UI_MODE_DRINKSONLY;
910 case 'n': // Dry Run / read-only
914 if( strcmp(argv[i], "--help") == 0 ) {
918 else if( strcmp(argv[i], "--dry-run") == 0 ) {
921 else if( strcmp(argv[i], "--drinks-only") == 0 ) {
922 giUIMode = UI_MODE_DRINKSONLY;
924 else if( strcmp(argv[i], "--can-select-all") == 0 ) {
925 gbDisallowSelectWithoutBalance = 0;
928 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
934 // The first argument is not allowed to begin with 'i'
935 // (catches most bad flags)
936 if( giTextArgc == 0 ) {
937 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
941 if( giTextArgc == MAX_TXT_ARGS )
943 fprintf(stderr, "ERROR: Too many arguments\n");
946 gsTextArgs[giTextArgc++] = argv[i];
953 if( giTextArgc == MAX_TXT_ARGS )
955 fprintf(stderr, "ERROR: Too many arguments\n");
959 gsTextArgs[giTextArgc++] = argv[i];
968 char *trim(char *string)
972 while( isspace(*string) )
975 for( i = strlen(string); i--; )
977 if( isspace(string[i]) )
986 int RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage)
990 ret = regexec(regex, string, nMatches, matches, 0);
991 if( ret && errorMessage ) {
992 size_t len = regerror(ret, regex, NULL, 0);
994 regerror(ret, regex, errorStr, len);
995 printf("string = '%s'\n", string);
996 fprintf(stderr, "%s\n%s", errorMessage, errorStr);
1003 void CompileRegex(regex_t *regex, const char *pattern, int flags)
1005 int ret = regcomp(regex, pattern, flags);
1007 size_t len = regerror(ret, regex, NULL, 0);
1009 regerror(ret, regex, errorStr, len);
1010 fprintf(stderr, "Regex compilation failed - %s\n", errorStr);