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_SetBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
243 ret = Dispense_AlterBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
252 // Show user information
253 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
261 // - Transfer credit from the current user to another account
263 // "Here, have some money."
265 int subcommand_give(int argc, char *args[])
270 fprintf(stderr, "`dispense give` takes three arguments\n");
275 const char *dst_acct = args[0];
276 const char *amt_str = args[1];
277 const char *message = args[2];
280 int sock = OpenConnection(gsDispenseServer, giDispensePort);
281 if( sock < 0 ) return RV_SOCKET_ERROR;
284 ret = Authenticate(sock);
288 long amt = strtol(amt_str, &end, 10);
289 if( !end || *end != '\0' ) {
290 fprintf(stderr, "dispense give: Balance is invalid, must be decimal number of cents");
293 ret = Dispense_Give(sock, dst_acct, amt, message);
301 // - User administration (Admin Only)
303 int subcommand_user(int argc, char *args[])
307 // Check argument count
309 fprintf(stderr, "Error: `dispense user` requires arguments\n");
315 int sock = OpenConnection(gsDispenseServer, giDispensePort);
316 if( sock < 0 ) return RV_SOCKET_ERROR;
318 // Attempt authentication
319 ret = Authenticate(sock);
323 if( strcmp(args[0], "add") == 0 )
325 if( giTextArgc != 3 ) {
326 fprintf(stderr, "Error: `dispense user add` requires an argument\n");
331 ret = Dispense_AddUser(sock, args[1]);
334 else if( strcmp(args[0], "type") == 0 || strcmp(args[0], "flags") == 0 )
336 if( argc < 3 || argc > 4 ) {
337 fprintf(stderr, "Error: `dispense user type` requires two arguments\n");
342 ret = Dispense_SetUserType(sock, args[1], args[2], (argc == 3 ? "" : args[3]));
346 fprintf(stderr, "Error: Unknown sub-command for `dispense user`\n");
356 // - Donate money to the club
358 int subcommand_donate(int argc, char *args[])
362 // Check argument count
364 fprintf(stderr, "Error: `dispense donate` requires two arguments\n");
370 int sock = OpenConnection(gsDispenseServer, giDispensePort);
371 if( sock < 0 ) return RV_SOCKET_ERROR;
373 // Attempt authentication
374 ret = Authenticate(sock);
378 ret = Dispense_Donate(sock, atoi(args[0]), args[1]);
387 // - Refund a purchased item
389 // "Well excuuuuse me, princess"
391 int subcommand_refund(int argc, char *args[])
395 // Check argument count
396 if( argc != 2 && argc != 3 ) {
397 fprintf(stderr, "Error: `dispense refund` takes 2 or 3 arguments\n");
403 int sock = OpenConnection(gsDispenseServer, giDispensePort);
404 if(sock < 0) return RV_SOCKET_ERROR;
406 // Attempt authentication
407 ret = Authenticate(sock);
412 price = atoi(args[2]);
414 fprintf(stderr, "Error: Override price is invalid (should be > 0)\n");
419 // Username, Item, cost
420 ret = Dispense_Refund(sock, args[0], args[1], price);
428 // `dispense iteminfo`
429 // - Get the state of an item
431 int subcommand_iteminfo(int argc, char *args[])
435 // Check argument count
437 fprintf(stderr, "Error: `dispense iteminfo` takes one argument\n");
442 char *item_id = args[0];
444 regmatch_t matches[3];
446 if( RunRegex(&gUserItemIdentRegex, item_id, 3, matches, NULL) != 0 ) {
447 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
450 char *type = item_id + matches[1].rm_so;
451 item_id[ matches[1].rm_eo ] = '\0';
452 int id = atoi( item_id + matches[2].rm_so );
454 int sock = OpenConnection(gsDispenseServer, giDispensePort);
455 if( sock < 0 ) return RV_SOCKET_ERROR;
457 ret = Dispense_ItemInfo(sock, type, id);
464 // - Update the name/price of an item
466 int subcommand_slot(int argc, char *args[])
472 fprintf(stderr, "Error: `dispense slot` takes three arguments\n");
476 char *slot_id = args[0];
477 char *price_str = args[1];
478 char *newname = args[2];
481 regmatch_t matches[3];
482 if( RunRegex(&gUserItemIdentRegex, slot_id, 3, matches, NULL) != 0 ) {
483 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
486 const char *item_type = slot_id + matches[1].rm_so;
487 slot_id[ matches[1].rm_eo ] = '\0';
488 int item_id = atoi( slot_id + matches[2].rm_so );
492 int price = strtol( price_str, &end, 0 );
493 if( price < 0 || *end != '\0' ) {
494 fprintf(stderr, "Error: Invalid price passed (must be >= 0)\n");
499 for( char *pos = newname; *pos; pos ++ )
501 if( !isalnum(*pos) && *pos != ' ' ) {
502 fprintf(stderr, "Error: You should only have letters, numbers and spaces in an item name\n");
507 // Connect & Authenticate
508 int sock = OpenConnection(gsDispenseServer, giDispensePort);
509 if( sock < 0 ) return RV_SOCKET_ERROR;
511 ret = Authenticate(sock);
515 ret = Dispense_SetItem(sock, item_type, item_id, price, newname);
522 // `dispense pincheck`
523 // - Validate a user's pin (used by the snack machine)
525 int subcommand_pincheck(int argc, char *args[])
529 if( argc < 1 || argc > 2 ) {
530 fprintf(stderr, "Error: `dispense pincheck` takes one/two arguments\n");
535 struct passwd *pwd = getpwuid( getuid() );
536 gsUserName = strdup(pwd->pw_name);
538 const char *pin = args[0];
539 const char *user = (argc > 1 ? args[1] : gsUserName);
541 int sock = OpenConnection(gsDispenseServer, giDispensePort);
542 if( sock < 0 ) return RV_SOCKET_ERROR;
544 ret = Authenticate(sock);
547 ret = DispenseCheckPin(sock, user, pin);
555 // - Set the pin of the current account
557 int subcommand_pinset(int argc, char *args[])
562 fprintf(stderr, "Error: `dispense pinset` takes one argument\n");
567 const char *pin = args[0];
569 int sock = OpenConnection(gsDispenseServer, giDispensePort);
570 if( sock < 0 ) return RV_SOCKET_ERROR;
572 ret = Authenticate(sock);
575 ret = DispenseSetPin(sock, pin);
581 int main(int argc, char *argv[])
588 // -- Create regular expressions
589 // > Code Type Count ...
590 CompileRegex(&gArrayRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([0-9]+)", REG_EXTENDED); //
591 // > Code Type Ident Status Price Desc
592 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);
593 // > Code 'SALT' salt
594 CompileRegex(&gSaltRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+(.+)$", REG_EXTENDED);
595 // > Code 'User' Username Balance Flags
596 CompileRegex(&gUserInfoRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([^ ]+)\\s+(-?[0-9]+)\\s+(.+)$", REG_EXTENDED);
598 CompileRegex(&gUserItemIdentRegex, "^([A-Za-z]+):([0-9]+)$", REG_EXTENDED);
601 ret = ParseArguments(argc, argv);
606 if( strcmp(gsTextArgs[0], "finger") == 0 ) {
607 return subcommand_finger();
609 else if( strcmp(gsTextArgs[0], "acct") == 0 ) {
610 return subcommand_acct();
612 else if( strcmp(gsTextArgs[0], "give") == 0 ) {
613 return subcommand_give(giTextArgc-1, gsTextArgs+1);
615 else if( strcmp(gsTextArgs[0], "user") == 0 ) {
616 return subcommand_user(giTextArgc-1, gsTextArgs+1);
618 else if( strcmp(gsTextArgs[0], "donate") == 0 ) {
619 return subcommand_donate(giTextArgc-1, gsTextArgs+1);
621 else if( strcmp(gsTextArgs[0], "refund") == 0 ) {
622 return subcommand_refund(giTextArgc-1, gsTextArgs+1);
624 else if( strcmp(gsTextArgs[0], "iteminfo") == 0 ) {
625 return subcommand_iteminfo(giTextArgc-1, gsTextArgs+1);
627 else if( strcmp(gsTextArgs[0], "slot") == 0 ) {
628 return subcommand_slot(giTextArgc-1, gsTextArgs+1);
630 else if(strcmp(gsTextArgs[0], "pincheck") == 0) {
631 return subcommand_pincheck(giTextArgc-1, gsTextArgs+1);
633 else if(strcmp(gsTextArgs[0], "pinset") == 0) {
634 return subcommand_pinset(giTextArgc-1, gsTextArgs+1);
637 // Item name / pattern
638 gsItemPattern = gsTextArgs[0];
642 int sock = OpenConnection(gsDispenseServer, giDispensePort);
643 if( sock < 0 ) return RV_SOCKET_ERROR;
645 // Get the user's balance
646 ret = GetUserBalance(sock);
650 PopulateItemList(sock);
652 // Disconnect from server
655 if( gsItemPattern && gsItemPattern[0] )
657 regmatch_t matches[3];
659 if( strcmp(gsItemPattern, "door") == 0 )
661 // Connect, Authenticate, dispense and close
662 sock = OpenConnection(gsDispenseServer, giDispensePort);
663 if( sock < 0 ) return RV_SOCKET_ERROR;
664 ret = Authenticate(sock);
666 ret = DispenseItem(sock, "door", 0);
670 // Item id (<type>:<num>)
671 else if( RunRegex(&gUserItemIdentRegex, gsItemPattern, 3, matches, NULL) == 0 )
676 // Get and finish ident
677 ident = gsItemPattern + matches[1].rm_so;
678 gsItemPattern[matches[1].rm_eo] = '\0';
680 id = atoi( gsItemPattern + matches[2].rm_so );
682 // Connect, Authenticate, dispense and close
683 sock = OpenConnection(gsDispenseServer, giDispensePort);
684 if( sock < 0 ) return RV_SOCKET_ERROR;
686 Dispense_ItemInfo(sock, ident, id);
688 ret = Authenticate(sock);
690 ret = DispenseItem(sock, ident, id);
694 // Item number (6 = coke)
695 else if( strcmp(gsItemPattern, "0") == 0 || atoi(gsItemPattern) > 0 )
697 i = atoi(gsItemPattern);
704 for( i = 0; i < giNumItems; i ++ )
706 // Prefix match (with case-insensitive match)
707 for( j = 0; gsItemPattern[j]; j ++ )
709 if( gaItems[i].Desc[j] == gsItemPattern[j] )
711 if( tolower(gaItems[i].Desc[j]) == tolower(gsItemPattern[j]) )
715 // Check if the prefix matched
716 if( gsItemPattern[j] != '\0' )
720 if( gaItems[i].Desc[j] == '\0' ) {
725 // Only one match allowed
730 // TODO: Allow ambiguous matches?
731 // or just print a wanrning
732 printf("Warning - Ambiguous pattern, stopping\n");
737 // Was a match found?
740 fprintf(stderr, "No item matches the passed string\n");
747 else if( giUIMode != UI_MODE_BASIC )
753 // Very basic dispense interface
754 for( i = 0; i < giNumItems; i ++ ) {
756 if( i && strcmp(gaItems[i].Type, gaItems[i-1].Type) != 0 )
759 printf("%2i %s:%i\t%3i %s\n", i, gaItems[i].Type, gaItems[i].ID,
760 gaItems[i].Price, gaItems[i].Desc);
769 fgets(buffer, BUFSIZ, stdin);
773 if( buf[0] == 'q' ) break;
777 if( i != 0 || buf[0] == '0' )
779 if( i < 0 || i >= giNumItems ) {
780 printf("Bad item %i (should be between 0 and %i)\n", i, giNumItems);
789 // Check for a valid item ID
793 // Connect, Authenticate, dispense and close
794 sock = OpenConnection(gsDispenseServer, giDispensePort);
795 if( sock < 0 ) return RV_SOCKET_ERROR;
797 ret = Dispense_ItemInfo(sock, gaItems[i].Type, gaItems[i].ID);
800 ret = Authenticate(sock);
803 for( j = 0; j < giDispenseCount; j ++ ) {
804 ret = DispenseItem(sock, gaItems[i].Type, gaItems[i].ID);
808 printf("%i items dispensed\n", j);
810 Dispense_ShowUser(sock, gsUserName);
818 int ParseArguments(int argc, char *argv[])
820 for( int i = 1; i < argc; i ++ )
834 if( i > 2 && strcmp(argv[i-1], "type") == 0 )
836 if( i + 1 >= argc ) {
837 fprintf(stderr, "%s: -c takes an argument\n", argv[0]);
841 giDispenseCount = atoi(argv[++i]);
842 if( giDispenseCount < 1 || giDispenseCount > DISPENSE_MULTIPLE_MAX ) {
843 fprintf(stderr, "Sorry, only 1-20 can be passed to -c (safety)\n");
849 case 'm': // Minimum balance
850 if( i + 1 >= argc ) {
851 fprintf(stderr, "%s: -m takes an argument\n", argv[0]);
855 giMinimumBalance = atoi(argv[++i]);
857 case 'M': // Maximum balance
858 if( i + 1 >= argc ) {
859 fprintf(stderr, "%s: -M takes an argument\n", argv[0]);
863 giMaximumBalance = atoi(argv[++i]);
866 case 'u': // Override User
867 if( i + 1 >= argc ) {
868 fprintf(stderr, "%s: -u takes an argument\n", argv[0]);
872 gsEffectiveUser = argv[++i];
875 case 'H': // Override remote host
876 if( i + 1 >= argc ) {
877 fprintf(stderr, "%s: -H takes an argument\n", argv[0]);
881 gsDispenseServer = argv[++i];
883 case 'P': // Override remote port
884 if( i + 1 >= argc ) {
885 fprintf(stderr, "%s: -P takes an argument\n", argv[0]);
889 giDispensePort = atoi(argv[++i]);
892 // Set slot name/price
894 if( giTextArgc != 0 ) {
895 fprintf(stderr, "%s: -s must appear before other arguments\n", argv[0]);
899 gsTextArgs[0] = "slot"; // HACK!!
903 case 'G': // Don't use GUI
904 giUIMode = UI_MODE_BASIC;
906 case 'D': // Drinks only
907 giUIMode = UI_MODE_DRINKSONLY;
909 case 'n': // Dry Run / read-only
913 if( strcmp(argv[i], "--help") == 0 ) {
917 else if( strcmp(argv[i], "--dry-run") == 0 ) {
920 else if( strcmp(argv[i], "--drinks-only") == 0 ) {
921 giUIMode = UI_MODE_DRINKSONLY;
923 else if( strcmp(argv[i], "--can-select-all") == 0 ) {
924 gbDisallowSelectWithoutBalance = 0;
927 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
933 // The first argument is not allowed to begin with 'i'
934 // (catches most bad flags)
935 if( giTextArgc == 0 ) {
936 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
940 if( giTextArgc == MAX_TXT_ARGS )
942 fprintf(stderr, "ERROR: Too many arguments\n");
945 gsTextArgs[giTextArgc++] = argv[i];
952 if( giTextArgc == MAX_TXT_ARGS )
954 fprintf(stderr, "ERROR: Too many arguments\n");
958 gsTextArgs[giTextArgc++] = argv[i];
967 char *trim(char *string)
971 while( isspace(*string) )
974 for( i = strlen(string); i--; )
976 if( isspace(string[i]) )
985 int RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage)
989 ret = regexec(regex, string, nMatches, matches, 0);
990 if( ret && errorMessage ) {
991 size_t len = regerror(ret, regex, NULL, 0);
993 regerror(ret, regex, errorStr, len);
994 printf("string = '%s'\n", string);
995 fprintf(stderr, "%s\n%s", errorMessage, errorStr);
1002 void CompileRegex(regex_t *regex, const char *pattern, int flags)
1004 int ret = regcomp(regex, pattern, flags);
1006 size_t len = regerror(ret, regex, NULL, 0);
1008 regerror(ret, regex, errorStr, len);
1009 fprintf(stderr, "Regex compilation failed - %s\n", errorStr);