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 // --- Coke Server Communication ---
34 char *trim(char *string);
35 int RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage);
36 void CompileRegex(regex_t *regex, const char *pattern, int flags);
39 char *gsDispenseServer = "merlo.ucc.gu.uwa.edu.au";
40 int giDispensePort = 11020;
44 regex_t gArrayRegex, gItemRegex, gSaltRegex, gUserInfoRegex, gUserItemIdentRegex;
45 int gbIsAuthenticated = 0;
47 char *gsItemPattern; //!< Item pattern
48 char *gsEffectiveUser; //!< '-u' Dispense as another user
50 enum eUI_Modes giUIMode = UI_MODE_STANDARD;
51 int gbDryRun = 0; //!< '-n' Read-only
52 int gbDisallowSelectWithoutBalance = 1; //!< Don't allow items to be hilighted if not affordable
54 int giMinimumBalance = INT_MIN; //!< '-m' Minumum balance for `dispense acct`
55 int giMaximumBalance = INT_MAX; //!< '-M' Maximum balance for `dispense acct`
57 char *gsUserName; //!< User that dispense will happen as
58 char *gsUserFlags; //!< User's flag set
59 int giUserBalance = -1; //!< User balance (set by Authenticate)
60 int giDispenseCount = 1; //!< Number of dispenses to do
62 char *gsTextArgs[MAX_TXT_ARGS];
73 " Show interactive list\n"
74 " dispense <name>|<index>|<itemid>\n"
75 " Dispense named item (<name> matches if it is a unique prefix)\n"
77 " Show the finger output\n"
79 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "give") == 0 )
81 " dispense give <user> <amount> \"<reason>\"\n"
82 " Give money to another user\n"
85 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "donate") == 0 )
87 " dispense donate <amount> \"<reason>\"\n"
88 " Donate to the club\n"
90 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "iteminfo") == 0 )
92 " dispense iteminfo <itemid>\n"
93 " Get the name and price for an item\n"
95 // if( giTextArgc == 0 || strcmp(gsTextArgs[0], "enumitems") == 0 )
97 // " dispense enumitems\n"
98 // " List avaliable items\n"
100 if( giTextArgc == 0 )
101 printf(" == Coke members == \n");
102 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "acct") == 0 )
104 " dispense acct [<user>]\n"
105 " Show user balances\n"
106 " dispense acct <user> [+-]<amount> \"<reason>\"\n"
107 " Alter a account value\n"
108 " dispense acct <user> =<amount> \"<reason>\"\n"
109 " Set an account balance\n"
111 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "refund") == 0 )
113 " dispense refund <user> <itemid> [<price>]\n"
114 " Refund an item to a user (with optional price override)\n"
115 " Item IDs can be seen in the cokelog (in the brackets after the item name)\n"
116 " e.g. coke:6 for a coke, snack:33 for slot 33 of the snack machine\n"
118 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "slot") == 0 )
120 " dispense slot <itemid> <price> <name>\n"
121 " Rename/Re-price a slot\n"
123 if( giTextArgc == 0 )
124 printf(" == Dispense administrators ==\n");
125 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "user") == 0 )
127 " dispense user add <user>\n"
128 " Create new account\n"
129 " dispense user type <user> <flags> <reason>\n"
130 " Alter a user's flags\n"
131 " <flags> is a comma-separated list of user, coke, admin, internal or disabled\n"
132 " Flags are removed by preceding the name with '-' or '!'\n"
134 if( giTextArgc == 0 )
138 " Dispense multiple times\n"
140 " Set a different user (Coke members only)\n"
144 " Use simple textual interface (instead of ncurses)\n"
146 " Dry run - Do not actually do dispenses\n"
147 " -m <min balance>\n"
148 " -M <max balance>\n"
149 " Set the Maximum/Minimum balances shown in `dispense acct`\n"
152 " 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"
158 int main(int argc, char *argv[])
166 // -- Create regular expressions
167 // > Code Type Count ...
168 CompileRegex(&gArrayRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([0-9]+)", REG_EXTENDED); //
169 // > Code Type Ident Status Price Desc
170 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);
171 // > Code 'SALT' salt
172 CompileRegex(&gSaltRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+(.+)$", REG_EXTENDED);
173 // > Code 'User' Username Balance Flags
174 CompileRegex(&gUserInfoRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([^ ]+)\\s+(-?[0-9]+)\\s+(.+)$", REG_EXTENDED);
176 CompileRegex(&gUserItemIdentRegex, "^([A-Za-z]+):([0-9]+)$", REG_EXTENDED);
179 for( i = 1; i < argc; i ++ )
193 if( i > 2 && strcmp(argv[i-1], "type") == 0 )
195 if( i + 1 >= argc ) {
196 fprintf(stderr, "%s: -c takes an argument\n", argv[0]);
200 giDispenseCount = atoi(argv[++i]);
201 if( giDispenseCount < 1 || giDispenseCount > DISPENSE_MULTIPLE_MAX ) {
202 fprintf(stderr, "Sorry, only 1-20 can be passed to -c (safety)\n");
208 case 'm': // Minimum balance
209 if( i + 1 >= argc ) {
210 fprintf(stderr, "%s: -m takes an argument\n", argv[0]);
214 giMinimumBalance = atoi(argv[++i]);
216 case 'M': // Maximum balance
217 if( i + 1 >= argc ) {
218 fprintf(stderr, "%s: -M takes an argument\n", argv[0]);
222 giMaximumBalance = atoi(argv[++i]);
225 case 'u': // Override User
226 if( i + 1 >= argc ) {
227 fprintf(stderr, "%s: -u takes an argument\n", argv[0]);
231 gsEffectiveUser = argv[++i];
234 case 'H': // Override remote host
235 if( i + 1 >= argc ) {
236 fprintf(stderr, "%s: -H takes an argument\n", argv[0]);
240 gsDispenseServer = argv[++i];
242 case 'P': // Override remote port
243 if( i + 1 >= argc ) {
244 fprintf(stderr, "%s: -P takes an argument\n", argv[0]);
248 giDispensePort = atoi(argv[++i]);
251 // Set slot name/price
253 if( giTextArgc != 0 ) {
254 fprintf(stderr, "%s: -s must appear before other arguments\n", argv[0]);
258 gsTextArgs[0] = "slot"; // HACK!!
262 case 'G': // Don't use GUI
263 giUIMode = UI_MODE_BASIC;
265 case 'D': // Drinks only
266 giUIMode = UI_MODE_DRINKSONLY;
268 case 'n': // Dry Run / read-only
272 if( strcmp(argv[i], "--help") == 0 ) {
276 else if( strcmp(argv[i], "--dry-run") == 0 ) {
279 else if( strcmp(argv[i], "--drinks-only") == 0 ) {
280 giUIMode = UI_MODE_DRINKSONLY;
282 else if( strcmp(argv[i], "--can-select-all") == 0 ) {
283 gbDisallowSelectWithoutBalance = 0;
286 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
292 // The first argument is not allowed to begin with 'i'
293 // (catches most bad flags)
294 if( giTextArgc == 0 ) {
295 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
299 if( giTextArgc == MAX_TXT_ARGS )
301 fprintf(stderr, "ERROR: Too many arguments\n");
304 gsTextArgs[giTextArgc++] = argv[i];
311 if( giTextArgc == MAX_TXT_ARGS )
313 fprintf(stderr, "ERROR: Too many arguments\n");
317 gsTextArgs[giTextArgc++] = argv[i];
324 if( strcmp(gsTextArgs[0], "finger") == 0 )
327 sock = OpenConnection(gsDispenseServer, giDispensePort);
328 if( sock < 0 ) return RV_SOCKET_ERROR;
331 PopulateItemList(sock);
333 printf("The UCC Coke machine.\n\n");
335 // Only get coke slot statuses
336 for( i = 0; i <= 6; i ++ )
339 switch(gaItems[i].Status)
341 case 0: status = "Avail"; break;
342 case 1: status = "Sold "; break;
347 printf("%i - %s %3i %s\n", gaItems[i].ID, status, gaItems[i].Price, gaItems[i].Desc);
350 printf("\nMay your pink fish bing into the distance.\n");
358 if( strcmp(gsTextArgs[0], "acct") == 0 )
361 sock = OpenConnection(gsDispenseServer, giDispensePort);
362 if( sock < 0 ) return RV_SOCKET_ERROR;
364 if( giTextArgc == 1 ) {
365 ret = Dispense_EnumUsers(sock);
370 // gsTextArgs[1]: Username
373 if( giTextArgc != 2 )
375 if( giTextArgc != 4 ) {
376 fprintf(stderr, "`dispense acct` requires a reason\n");
381 // Authentication required
382 ret = Authenticate(sock);
385 // gsTextArgs[1]: Username
386 // gsTextArgs[2]: Ammount
387 // gsTextArgs[3]: Reason
389 long int balance = strtol(gsTextArgs[2]+(gsTextArgs[2][0] == '='), &tmp, 10);
390 if(!tmp || *tmp != '\0') {
391 fprintf(stderr, "dispense acct: Value must be a decimal number of cents\n");
395 if( gsTextArgs[2][0] == '=' ) {
397 ret = Dispense_SetBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
401 ret = Dispense_AlterBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
410 // Show user information
411 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
418 // - "Here, have some money."
419 else if( strcmp(gsTextArgs[0], "give") == 0 )
421 if( giTextArgc != 4 ) {
422 fprintf(stderr, "`dispense give` takes three arguments\n");
427 // gsTextArgs[1]: Destination
428 // gsTextArgs[2]: Ammount
429 // gsTextArgs[3]: Reason
432 sock = OpenConnection(gsDispenseServer, giDispensePort);
433 if( sock < 0 ) return RV_SOCKET_ERROR;
436 ret = Authenticate(sock);
440 int amt = strtol(gsTextArgs[2], &tmp, 10);
441 if( !tmp || *tmp != '\0' ) {
442 fprintf(stderr, "dispense give: Balance is invalid, must be decimal number of cents");
445 ret = Dispense_Give(sock, gsTextArgs[1], amt, gsTextArgs[3]);
453 // - User administration (Admin Only)
454 if( strcmp(gsTextArgs[0], "user") == 0 )
456 // Check argument count
457 if( giTextArgc == 1 ) {
458 fprintf(stderr, "Error: `dispense user` requires arguments\n");
464 sock = OpenConnection(gsDispenseServer, giDispensePort);
465 if( sock < 0 ) return RV_SOCKET_ERROR;
467 // Attempt authentication
468 ret = Authenticate(sock);
472 if( strcmp(gsTextArgs[1], "add") == 0 )
474 if( giTextArgc != 3 ) {
475 fprintf(stderr, "Error: `dispense user add` requires an argument\n");
480 ret = Dispense_AddUser(sock, gsTextArgs[2]);
483 else if( strcmp(gsTextArgs[1], "type") == 0 || strcmp(gsTextArgs[1], "flags") == 0 )
485 if( giTextArgc < 4 || giTextArgc > 5 ) {
486 fprintf(stderr, "Error: `dispense user type` requires two arguments\n");
491 if( giTextArgc == 4 )
492 ret = Dispense_SetUserType(sock, gsTextArgs[2], gsTextArgs[3], "");
494 ret = Dispense_SetUserType(sock, gsTextArgs[2], gsTextArgs[3], gsTextArgs[4]);
498 fprintf(stderr, "Error: Unknown sub-command for `dispense user`\n");
506 else if( strcmp(gsTextArgs[0], "donate") == 0 )
508 // Check argument count
509 if( giTextArgc != 3 ) {
510 fprintf(stderr, "Error: `dispense donate` requires two arguments\n");
516 sock = OpenConnection(gsDispenseServer, giDispensePort);
517 if( sock < 0 ) return RV_SOCKET_ERROR;
519 // Attempt authentication
520 ret = Authenticate(sock);
524 ret = Dispense_Donate(sock, atoi(gsTextArgs[1]), gsTextArgs[2]);
531 else if( strcmp(gsTextArgs[0], "refund") == 0 )
534 // Check argument count
535 if( giTextArgc != 3 && giTextArgc != 4 ) {
536 fprintf(stderr, "Error: `dispense refund` takes 2 or 3 arguments\n");
542 sock = OpenConnection(gsDispenseServer, giDispensePort);
543 if(sock < 0) return RV_SOCKET_ERROR;
545 // Attempt authentication
546 ret = Authenticate(sock);
549 if( giTextArgc == 4 ) {
550 price = atoi(gsTextArgs[3]);
552 fprintf(stderr, "Error: Override price is invalid (should be > 0)\n");
557 // Username, Item, cost
558 ret = Dispense_Refund(sock, gsTextArgs[1], gsTextArgs[2], price);
564 // Query an item price
565 else if( strcmp(gsTextArgs[0], "iteminfo") == 0 )
567 regmatch_t matches[3];
570 // Check argument count
571 if( giTextArgc != 2 ) {
572 fprintf(stderr, "Error: `dispense iteminfo` requires an argument\n");
577 if( RunRegex(&gUserItemIdentRegex, gsTextArgs[1], 3, matches, NULL) != 0 ) {
578 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
581 type = gsTextArgs[1] + matches[1].rm_so;
582 gsTextArgs[1][ matches[1].rm_eo ] = '\0';
583 id = atoi( gsTextArgs[1] + matches[2].rm_so );
585 sock = OpenConnection(gsDispenseServer, giDispensePort);
586 if( sock < 0 ) return RV_SOCKET_ERROR;
588 ret = Dispense_ItemInfo(sock, type, id);
593 else if( strcmp(gsTextArgs[0], "slot") == 0 )
595 regmatch_t matches[3];
596 char *item_type, *newname;
600 if( giTextArgc != 4 ) {
601 fprintf(stderr, "Error: `dispense slot` takes three arguments\n");
607 if( RunRegex(&gUserItemIdentRegex, gsTextArgs[1], 3, matches, NULL) != 0 ) {
608 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
611 item_type = gsTextArgs[1] + matches[1].rm_so;
612 gsTextArgs[1][ matches[1].rm_eo ] = '\0';
613 item_id = atoi( gsTextArgs[1] + matches[2].rm_so );
616 price = atoi( gsTextArgs[2] );
617 if( price <= 0 && gsTextArgs[2][0] != '0' ) {
618 fprintf(stderr, "Error: Invalid price passed (must be >= 0)\n");
623 newname = gsTextArgs[3];
627 for( pos = newname; *pos; pos ++ )
629 if( !isalnum(*pos) && *pos != ' ' ) {
630 fprintf(stderr, "Error: You should only have letters, numbers and spaces in an item name\n");
636 // Connect & Authenticate
637 sock = OpenConnection(gsDispenseServer, giDispensePort);
638 if( sock < 0 ) return RV_SOCKET_ERROR;
639 ret = Authenticate(sock);
642 ret = Dispense_SetItem(sock, item_type, item_id, price, newname);
647 // Check a user's pin
648 else if(strcmp(gsTextArgs[0], "pincheck") == 0)
650 if( giTextArgc < 2 || giTextArgc > 3 ) {
651 fprintf(stderr, "Error: `dispense pincheck` takes one/two arguments\n");
655 struct passwd *pwd = getpwuid( getuid() );
656 gsUserName = strdup(pwd->pw_name);
658 const char *pin = gsTextArgs[1];
659 const char *user = gsUserName;
660 if( giTextArgc == 3 )
661 user = gsTextArgs[2];
664 sock = OpenConnection(gsDispenseServer, giDispensePort);
665 if( sock < 0 ) return RV_SOCKET_ERROR;
666 ret = Authenticate(sock);
669 ret = DispenseCheckPin(sock, user, pin);
675 else if(strcmp(gsTextArgs[0], "pinset") == 0)
677 if( giTextArgc != 2 ) {
678 fprintf(stderr, "Error: `dispense pinset` takes one argument\n");
683 const char *pin = gsTextArgs[1];
685 sock = OpenConnection(gsDispenseServer, giDispensePort);
686 if( sock < 0 ) return RV_SOCKET_ERROR;
687 ret = Authenticate(sock);
690 ret = DispenseSetPin(sock, pin);
695 // Item name / pattern
698 gsItemPattern = gsTextArgs[0];
702 sock = OpenConnection(gsDispenseServer, giDispensePort);
703 if( sock < 0 ) return RV_SOCKET_ERROR;
705 // Get the user's balance
706 ret = GetUserBalance(sock);
710 PopulateItemList(sock);
712 // Disconnect from server
715 if( gsItemPattern && gsItemPattern[0] )
717 regmatch_t matches[3];
719 if( strcmp(gsItemPattern, "door") == 0 )
721 // Connect, Authenticate, dispense and close
722 sock = OpenConnection(gsDispenseServer, giDispensePort);
723 if( sock < 0 ) return RV_SOCKET_ERROR;
724 ret = Authenticate(sock);
726 ret = DispenseItem(sock, "door", 0);
730 // Item id (<type>:<num>)
731 else if( RunRegex(&gUserItemIdentRegex, gsItemPattern, 3, matches, NULL) == 0 )
736 // Get and finish ident
737 ident = gsItemPattern + matches[1].rm_so;
738 gsItemPattern[matches[1].rm_eo] = '\0';
740 id = atoi( gsItemPattern + matches[2].rm_so );
742 // Connect, Authenticate, dispense and close
743 sock = OpenConnection(gsDispenseServer, giDispensePort);
744 if( sock < 0 ) return RV_SOCKET_ERROR;
746 Dispense_ItemInfo(sock, ident, id);
748 ret = Authenticate(sock);
750 ret = DispenseItem(sock, ident, id);
754 // Item number (6 = coke)
755 else if( strcmp(gsItemPattern, "0") == 0 || atoi(gsItemPattern) > 0 )
757 i = atoi(gsItemPattern);
764 for( i = 0; i < giNumItems; i ++ )
766 // Prefix match (with case-insensitive match)
767 for( j = 0; gsItemPattern[j]; j ++ )
769 if( gaItems[i].Desc[j] == gsItemPattern[j] )
771 if( tolower(gaItems[i].Desc[j]) == tolower(gsItemPattern[j]) )
775 // Check if the prefix matched
776 if( gsItemPattern[j] != '\0' )
780 if( gaItems[i].Desc[j] == '\0' ) {
785 // Only one match allowed
790 // TODO: Allow ambiguous matches?
791 // or just print a wanrning
792 printf("Warning - Ambiguous pattern, stopping\n");
797 // Was a match found?
800 fprintf(stderr, "No item matches the passed string\n");
807 else if( giUIMode != UI_MODE_BASIC )
813 // Very basic dispense interface
814 for( i = 0; i < giNumItems; i ++ ) {
816 if( i && strcmp(gaItems[i].Type, gaItems[i-1].Type) != 0 )
819 printf("%2i %s:%i\t%3i %s\n", i, gaItems[i].Type, gaItems[i].ID,
820 gaItems[i].Price, gaItems[i].Desc);
829 fgets(buffer, BUFSIZ, stdin);
833 if( buf[0] == 'q' ) break;
837 if( i != 0 || buf[0] == '0' )
839 if( i < 0 || i >= giNumItems ) {
840 printf("Bad item %i (should be between 0 and %i)\n", i, giNumItems);
849 // Check for a valid item ID
853 // Connect, Authenticate, dispense and close
854 sock = OpenConnection(gsDispenseServer, giDispensePort);
855 if( sock < 0 ) return RV_SOCKET_ERROR;
857 ret = Dispense_ItemInfo(sock, gaItems[i].Type, gaItems[i].ID);
860 ret = Authenticate(sock);
863 for( j = 0; j < giDispenseCount; j ++ ) {
864 ret = DispenseItem(sock, gaItems[i].Type, gaItems[i].ID);
868 printf("%i items dispensed\n", j);
870 Dispense_ShowUser(sock, gsUserName);
881 char *trim(char *string)
885 while( isspace(*string) )
888 for( i = strlen(string); i--; )
890 if( isspace(string[i]) )
899 int RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage)
903 ret = regexec(regex, string, nMatches, matches, 0);
904 if( ret && errorMessage ) {
905 size_t len = regerror(ret, regex, NULL, 0);
907 regerror(ret, regex, errorStr, len);
908 printf("string = '%s'\n", string);
909 fprintf(stderr, "%s\n%s", errorMessage, errorStr);
916 void CompileRegex(regex_t *regex, const char *pattern, int flags)
918 int ret = regcomp(regex, pattern, flags);
920 size_t len = regerror(ret, regex, NULL, 0);
922 regerror(ret, regex, errorStr, len);
923 fprintf(stderr, "Regex compilation failed - %s\n", errorStr);