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"
20 #include "../common/config.h"
22 #define USE_NCURSES_INTERFACE 0
23 #define DEBUG_TRACE_SERVER 0
24 #define USE_AUTOAUTH 1
26 #define MAX_TXT_ARGS 5 // Maximum number of textual arguments (including command)
27 #define DISPENSE_MULTIPLE_MAX 20 // Maximum argument to -c
33 int main(int argc, char *argv[]);
34 int ParseArguments(int argc, char *argv[]);
35 // --- Coke Server Communication ---
37 char *trim(char *string);
38 int RunRegex(regex_t *regex, const char *string, int nMatches, regmatch_t *matches, const char *errorMessage);
39 void CompileRegex(regex_t *regex, const char *pattern, int flags);
42 const char *gsConfigFile = "/etc/opendispense/client.conf";
44 const char *gsDispenseServer = "merlo.ucc.gu.uwa.edu.au";
45 int giDispensePort = 11020;
46 int giDispenseServerSet = 0; // True if set by command line
47 int giDispensePortSet = 0; // True if set by command line
51 regex_t gArrayRegex, gItemRegex, gSaltRegex, gUserInfoRegex, gUserItemIdentRegex;
52 int gbIsAuthenticated = 0;
54 char *gsItemPattern; //!< Item pattern
55 char *gsEffectiveUser; //!< '-u' Dispense as another user
57 enum eUI_Modes giUIMode = UI_MODE_STANDARD;
58 int gbDryRun = 0; //!< '-n' Read-only
59 int gbDisallowSelectWithoutBalance = 1; //!< Don't allow items to be hilighted if not affordable
61 int giMinimumBalance = INT_MIN; //!< '-m' Minumum balance for `dispense acct`
62 int giMaximumBalance = INT_MAX; //!< '-M' Maximum balance for `dispense acct`
64 char *gsUserName; //!< User that dispense will happen as
65 char *gsUserFlags; //!< User's flag set
66 int giUserBalance = -1; //!< User balance (set by Authenticate)
67 int giDispenseCount = 1; //!< Number of dispenses to do
69 char *gsTextArgs[MAX_TXT_ARGS];
80 " Show interactive list\n"
81 " dispense <name>|<index>|<itemid>\n"
82 " Dispense named item (<name> matches if it is a unique prefix)\n"
84 " Show the finger output\n"
86 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "give") == 0 )
88 " dispense give <user> <amount> \"<reason>\"\n"
89 " Give money to another user\n"
92 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "donate") == 0 )
94 " dispense donate <amount> \"<reason>\"\n"
95 " Donate to the club\n"
97 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "iteminfo") == 0 )
99 " dispense iteminfo <itemid>\n"
100 " Get the name and price for an item\n"
102 // if( giTextArgc == 0 || strcmp(gsTextArgs[0], "enumitems") == 0 )
104 // " dispense enumitems\n"
105 // " List avaliable items\n"
107 if( giTextArgc == 0 )
108 printf(" == Coke members == \n");
109 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "acct") == 0 )
111 " dispense acct [<user>]\n"
112 " Show user balances\n"
113 " dispense acct <user> [+-]<amount> \"<reason>\"\n"
114 " Alter a account value\n"
115 " dispense acct <user> =<amount> \"<reason>\"\n"
116 " Set an account balance\n"
118 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "refund") == 0 )
120 " dispense refund <user> <itemid> [<price>]\n"
121 " Refund an item to a user (with optional price override)\n"
122 " Item IDs can be seen in the cokelog (in the brackets after the item name)\n"
123 " e.g. coke:6 for a coke, snack:33 for slot 33 of the snack machine\n"
125 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "slot") == 0 )
127 " dispense slot <itemid> <price> <name>\n"
128 " Rename/Re-price a slot\n"
130 if( giTextArgc == 0 )
131 printf(" == Dispense administrators ==\n");
132 if( giTextArgc == 0 || strcmp(gsTextArgs[0], "user") == 0 )
134 " dispense user add <user>\n"
135 " Create new account\n"
136 " dispense user type <user> <flags> <reason>\n"
137 " Alter a user's flags\n"
138 " <flags> is a comma-separated list of user, coke, admin, internal or disabled\n"
139 " Flags are removed by preceding the name with '-' or '!'\n"
141 if( giTextArgc == 0 )
145 " Dispense multiple times\n"
147 " Set a different user (Coke members only)\n"
151 " Use simple textual interface (instead of ncurses)\n"
153 " Drinks only in user interface\n"
155 " Dry run - Do not actually do dispenses\n"
156 " -m <min balance>\n"
157 " -M <max balance>\n"
158 " Set the Maximum/Minimum balances shown in `dispense acct`\n"
160 " Set the config file path (default: `/etc/opendispense/client.conf'\n"
162 " Set a different dispense host\n"
164 " Set a different dispense port\n"
167 " 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"
177 int subcommand_finger(void)
180 int sock = OpenConnection(gsDispenseServer, giDispensePort);
181 if( sock < 0 ) return RV_SOCKET_ERROR;
184 PopulateItemList(sock);
186 printf("The UCC Coke machine.\n\n");
188 // Only get coke slot statuses
189 for( int i = 0; i <= 6; i ++ )
192 switch(gaItems[i].Status)
194 case 0: status = "Avail"; break;
195 case 1: status = "Sold "; break;
200 printf("%i - %s %3i %s\n", gaItems[i].ID, status, gaItems[i].Price, gaItems[i].Desc);
203 printf("\nMay your pink fish bing into the distance.\n");
210 // - Display/manipulate account balances
212 int subcommand_acct(void)
217 int sock = OpenConnection(gsDispenseServer, giDispensePort);
218 if( sock < 0 ) return RV_SOCKET_ERROR;
220 if( giTextArgc == 1 ) {
221 ret = Dispense_EnumUsers(sock);
226 // gsTextArgs[1]: Username
229 if( giTextArgc != 2 )
231 if( giTextArgc != 4 ) {
232 fprintf(stderr, "`dispense acct` requires a reason\n");
237 // Authentication required
238 ret = Authenticate(sock);
241 // gsTextArgs[1]: Username
242 // gsTextArgs[2]: Ammount
243 // gsTextArgs[3]: Reason
245 long int balance = strtol(gsTextArgs[2]+(gsTextArgs[2][0] == '='), &tmp, 10);
246 if(!tmp || *tmp != '\0') {
247 fprintf(stderr, "dispense acct: Value must be a decimal number of cents\n");
251 if( gsTextArgs[2][0] == '=' ) {
253 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
254 ret = Dispense_SetBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
258 ret = Dispense_AlterBalance(sock, gsTextArgs[1], balance, gsTextArgs[3]);
267 // Show user information
268 ret = Dispense_ShowUser(sock, gsTextArgs[1]);
276 // - Transfer credit from the current user to another account
278 // "Here, have some money."
280 int subcommand_give(int argc, char *args[])
285 fprintf(stderr, "`dispense give` takes three arguments\n");
290 const char *dst_acct = args[0];
291 const char *amt_str = args[1];
292 const char *message = args[2];
295 int sock = OpenConnection(gsDispenseServer, giDispensePort);
296 if( sock < 0 ) return RV_SOCKET_ERROR;
299 ret = Authenticate(sock);
303 long amt = strtol(amt_str, &end, 10);
304 if( !end || *end != '\0' ) {
305 fprintf(stderr, "dispense give: Balance is invalid, must be decimal number of cents");
308 ret = Dispense_Give(sock, dst_acct, amt, message);
316 // - User administration (Admin Only)
318 int subcommand_user(int argc, char *args[])
322 // Check argument count
324 fprintf(stderr, "Error: `dispense user` requires arguments\n");
330 int sock = OpenConnection(gsDispenseServer, giDispensePort);
331 if( sock < 0 ) return RV_SOCKET_ERROR;
333 // Attempt authentication
334 ret = Authenticate(sock);
338 if( strcmp(args[0], "add") == 0 )
340 if( giTextArgc != 3 ) {
341 fprintf(stderr, "Error: `dispense user add` requires an argument\n");
346 ret = Dispense_AddUser(sock, args[1]);
349 else if( strcmp(args[0], "type") == 0 || strcmp(args[0], "flags") == 0 )
351 if( argc < 3 || argc > 4 ) {
352 fprintf(stderr, "Error: `dispense user type` requires two arguments\n");
357 ret = Dispense_SetUserType(sock, args[1], args[2], (argc == 3 ? "" : args[3]));
361 fprintf(stderr, "Error: Unknown sub-command for `dispense user`\n");
371 // - Donate money to the club
373 int subcommand_donate(int argc, char *args[])
377 // Check argument count
379 fprintf(stderr, "Error: `dispense donate` requires two arguments\n");
385 int sock = OpenConnection(gsDispenseServer, giDispensePort);
386 if( sock < 0 ) return RV_SOCKET_ERROR;
388 // Attempt authentication
389 ret = Authenticate(sock);
393 ret = Dispense_Donate(sock, atoi(args[0]), args[1]);
402 // - Refund a purchased item
404 // "Well excuuuuse me, princess"
406 int subcommand_refund(int argc, char *args[])
410 // Check argument count
411 if( argc != 2 && argc != 3 ) {
412 fprintf(stderr, "Error: `dispense refund` takes 2 or 3 arguments\n");
418 int sock = OpenConnection(gsDispenseServer, giDispensePort);
419 if(sock < 0) return RV_SOCKET_ERROR;
421 // Attempt authentication
422 ret = Authenticate(sock);
427 price = atoi(args[2]);
429 fprintf(stderr, "Error: Override price is invalid (should be > 0)\n");
434 // Username, Item, cost
435 ret = Dispense_Refund(sock, args[0], args[1], price);
443 // `dispense iteminfo`
444 // - Get the state of an item
446 int subcommand_iteminfo(int argc, char *args[])
450 // Check argument count
452 fprintf(stderr, "Error: `dispense iteminfo` takes one argument\n");
457 char *item_id = args[0];
459 regmatch_t matches[3];
461 if( RunRegex(&gUserItemIdentRegex, item_id, 3, matches, NULL) != 0 ) {
462 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
465 char *type = item_id + matches[1].rm_so;
466 item_id[ matches[1].rm_eo ] = '\0';
467 int id = atoi( item_id + matches[2].rm_so );
469 int sock = OpenConnection(gsDispenseServer, giDispensePort);
470 if( sock < 0 ) return RV_SOCKET_ERROR;
472 ret = Dispense_ItemInfo(sock, type, id);
479 // - Update the name/price of an item
481 int subcommand_slot(int argc, char *args[])
487 fprintf(stderr, "Error: `dispense slot` takes three arguments\n");
491 char *slot_id = args[0];
492 char *price_str = args[1];
493 char *newname = args[2];
496 regmatch_t matches[3];
497 if( RunRegex(&gUserItemIdentRegex, slot_id, 3, matches, NULL) != 0 ) {
498 fprintf(stderr, "Error: Invalid item ID passed (<type>:<id> expected)\n");
501 const char *item_type = slot_id + matches[1].rm_so;
502 slot_id[ matches[1].rm_eo ] = '\0';
503 int item_id = atoi( slot_id + matches[2].rm_so );
507 int price = strtol( price_str, &end, 0 );
508 if( price < 0 || *end != '\0' ) {
509 fprintf(stderr, "Error: Invalid price passed (must be >= 0)\n");
514 for( char *pos = newname; *pos; pos ++ )
516 if( !isalnum(*pos) && *pos != ' ' ) {
517 fprintf(stderr, "Error: You should only have letters, numbers and spaces in an item name\n");
522 // Connect & Authenticate
523 int sock = OpenConnection(gsDispenseServer, giDispensePort);
524 if( sock < 0 ) return RV_SOCKET_ERROR;
526 ret = Authenticate(sock);
530 ret = Dispense_SetItem(sock, item_type, item_id, price, newname);
537 // `dispense pincheck`
538 // - Validate a user's pin (used by the snack machine)
540 int subcommand_pincheck(int argc, char *args[])
544 if( argc < 1 || argc > 2 ) {
545 fprintf(stderr, "Error: `dispense pincheck` takes one/two arguments\n");
550 struct passwd *pwd = getpwuid( getuid() );
551 gsUserName = strdup(pwd->pw_name);
553 const char *pin = args[0];
554 const char *user = (argc > 1 ? args[1] : gsUserName);
556 int sock = OpenConnection(gsDispenseServer, giDispensePort);
557 if( sock < 0 ) return RV_SOCKET_ERROR;
559 ret = Authenticate(sock);
562 ret = DispenseCheckPin(sock, user, pin);
570 // - Set the pin of the current account
572 int subcommand_pinset(int argc, char *args[])
577 fprintf(stderr, "Error: `dispense pinset` takes one argument\n");
582 const char *pin = args[0];
584 int sock = OpenConnection(gsDispenseServer, giDispensePort);
585 if( sock < 0 ) return RV_SOCKET_ERROR;
587 ret = Authenticate(sock);
590 ret = DispenseSetPin(sock, pin);
596 int main(int argc, char *argv[])
603 // -- Create regular expressions
604 // > Code Type Count ...
605 CompileRegex(&gArrayRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([0-9]+)", REG_EXTENDED); //
606 // > Code Type Ident Status Price Desc
607 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);
608 // > Code 'SALT' salt
609 CompileRegex(&gSaltRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+(.+)$", REG_EXTENDED);
610 // > Code 'User' Username Balance Flags
611 CompileRegex(&gUserInfoRegex, "^([0-9]{3})\\s+([A-Za-z]+)\\s+([^ ]+)\\s+(-?[0-9]+)\\s+(.+)$", REG_EXTENDED);
613 CompileRegex(&gUserItemIdentRegex, "^([A-Za-z]+):([0-9]+)$", REG_EXTENDED);
616 ret = ParseArguments(argc, argv);
621 Config_ParseFile(gsConfigFile);
623 // Parse config values
624 if (!giDispenseServerSet) {
625 gsDispenseServer = Config_GetValue("dispense_server",0);
627 if (!giDispensePortSet) {
628 giDispensePort = Config_GetValue_Int("dispense_port",0);
633 if( strcmp(gsTextArgs[0], "finger") == 0 ) {
634 return subcommand_finger();
636 else if( strcmp(gsTextArgs[0], "acct") == 0 ) {
637 return subcommand_acct();
639 else if( strcmp(gsTextArgs[0], "give") == 0 ) {
640 return subcommand_give(giTextArgc-1, gsTextArgs+1);
642 else if( strcmp(gsTextArgs[0], "user") == 0 ) {
643 return subcommand_user(giTextArgc-1, gsTextArgs+1);
645 else if( strcmp(gsTextArgs[0], "donate") == 0 ) {
646 return subcommand_donate(giTextArgc-1, gsTextArgs+1);
648 else if( strcmp(gsTextArgs[0], "refund") == 0 ) {
649 return subcommand_refund(giTextArgc-1, gsTextArgs+1);
651 else if( strcmp(gsTextArgs[0], "iteminfo") == 0 ) {
652 return subcommand_iteminfo(giTextArgc-1, gsTextArgs+1);
654 else if( strcmp(gsTextArgs[0], "slot") == 0 ) {
655 return subcommand_slot(giTextArgc-1, gsTextArgs+1);
657 else if(strcmp(gsTextArgs[0], "pincheck") == 0) {
658 return subcommand_pincheck(giTextArgc-1, gsTextArgs+1);
660 else if(strcmp(gsTextArgs[0], "pinset") == 0) {
661 return subcommand_pinset(giTextArgc-1, gsTextArgs+1);
664 // Item name / pattern
665 gsItemPattern = gsTextArgs[0];
669 int sock = OpenConnection(gsDispenseServer, giDispensePort);
670 if( sock < 0 ) return RV_SOCKET_ERROR;
672 // Get the user's balance
673 ret = GetUserBalance(sock);
677 PopulateItemList(sock);
679 // Disconnect from server
682 if( gsItemPattern && gsItemPattern[0] )
684 regmatch_t matches[3];
686 if( strcmp(gsItemPattern, "door") == 0 )
688 // Connect, Authenticate, dispense and close
689 sock = OpenConnection(gsDispenseServer, giDispensePort);
690 if( sock < 0 ) return RV_SOCKET_ERROR;
691 ret = Authenticate(sock);
693 ret = DispenseItem(sock, "door", 0);
697 // Item id (<type>:<num>)
698 else if( RunRegex(&gUserItemIdentRegex, gsItemPattern, 3, matches, NULL) == 0 )
703 // Get and finish ident
704 ident = gsItemPattern + matches[1].rm_so;
705 gsItemPattern[matches[1].rm_eo] = '\0';
707 id = atoi( gsItemPattern + matches[2].rm_so );
709 // Connect, Authenticate, dispense and close
710 sock = OpenConnection(gsDispenseServer, giDispensePort);
711 if( sock < 0 ) return RV_SOCKET_ERROR;
713 Dispense_ItemInfo(sock, ident, id);
715 ret = Authenticate(sock);
717 ret = DispenseItem(sock, ident, id);
721 // Item number (6 = coke)
722 else if( strcmp(gsItemPattern, "0") == 0 || atoi(gsItemPattern) > 0 )
724 i = atoi(gsItemPattern);
731 for( i = 0; i < giNumItems; i ++ )
733 // Prefix match (with case-insensitive match)
734 for( j = 0; gsItemPattern[j]; j ++ )
736 if( gaItems[i].Desc[j] == gsItemPattern[j] )
738 if( tolower(gaItems[i].Desc[j]) == tolower(gsItemPattern[j]) )
742 // Check if the prefix matched
743 if( gsItemPattern[j] != '\0' )
747 if( gaItems[i].Desc[j] == '\0' ) {
752 // Only one match allowed
757 // TODO: Allow ambiguous matches?
758 // or just print a wanrning
759 printf("Warning - Ambiguous pattern, stopping\n");
764 // Was a match found?
767 fprintf(stderr, "No item matches the passed string\n");
774 else if( giUIMode != UI_MODE_BASIC )
780 // Very basic dispense interface
781 for( i = 0; i < giNumItems; i ++ ) {
783 if( i && strcmp(gaItems[i].Type, gaItems[i-1].Type) != 0 )
786 printf("%2i %s:%i\t%3i %s\n", i, gaItems[i].Type, gaItems[i].ID,
787 gaItems[i].Price, gaItems[i].Desc);
796 fgets(buffer, BUFSIZ, stdin);
800 if( buf[0] == 'q' ) break;
804 if( i != 0 || buf[0] == '0' )
806 if( i < 0 || i >= giNumItems ) {
807 printf("Bad item %i (should be between 0 and %i)\n", i, giNumItems);
816 // Check for a valid item ID
820 // Connect, Authenticate, dispense and close
821 sock = OpenConnection(gsDispenseServer, giDispensePort);
822 if( sock < 0 ) return RV_SOCKET_ERROR;
824 ret = Dispense_ItemInfo(sock, gaItems[i].Type, gaItems[i].ID);
827 ret = Authenticate(sock);
830 for( j = 0; j < giDispenseCount; j ++ ) {
831 ret = DispenseItem(sock, gaItems[i].Type, gaItems[i].ID);
835 printf("%i items dispensed\n", j);
837 Dispense_ShowUser(sock, gsUserName);
845 int ParseArguments(int argc, char *argv[])
847 for( int i = 1; i < argc; i ++ )
861 if( i > 2 && strcmp(argv[i-1], "type") == 0 )
863 if( i + 1 >= argc ) {
864 fprintf(stderr, "%s: -c takes an argument\n", argv[0]);
868 giDispenseCount = atoi(argv[++i]);
869 if( giDispenseCount < 1 || giDispenseCount > DISPENSE_MULTIPLE_MAX ) {
870 fprintf(stderr, "Sorry, only 1-20 can be passed to -c (safety)\n");
876 case 'm': // Minimum balance
877 if( i + 1 >= argc ) {
878 fprintf(stderr, "%s: -m takes an argument\n", argv[0]);
882 giMinimumBalance = atoi(argv[++i]);
884 case 'M': // Maximum balance
885 if( i + 1 >= argc ) {
886 fprintf(stderr, "%s: -M takes an argument\n", argv[0]);
890 giMaximumBalance = atoi(argv[++i]);
893 case 'f': // Override Config File
894 if( i + 1 >= argc ) {
895 fprintf(stderr, "%s: -f takes an argument\n", argv[0]);
899 gsConfigFile = argv[++i];
902 case 'u': // Override User
903 if( i + 1 >= argc ) {
904 fprintf(stderr, "%s: -u takes an argument\n", argv[0]);
908 gsEffectiveUser = argv[++i];
911 case 'H': // Override remote host
912 if( i + 1 >= argc ) {
913 fprintf(stderr, "%s: -H takes an argument\n", argv[0]);
917 gsDispenseServer = argv[++i];
918 giDispenseServerSet = 1;
920 case 'P': // Override remote port
921 if( i + 1 >= argc ) {
922 fprintf(stderr, "%s: -P takes an argument\n", argv[0]);
926 giDispensePort = atoi(argv[++i]);
927 giDispensePortSet = 1;
930 // Set slot name/price
932 if( giTextArgc != 0 ) {
933 fprintf(stderr, "%s: -s must appear before other arguments\n", argv[0]);
937 gsTextArgs[0] = "slot"; // HACK!!
941 case 'G': // Don't use GUI
942 giUIMode = UI_MODE_BASIC;
944 case 'D': // Drinks only
945 giUIMode = UI_MODE_DRINKSONLY;
947 case 'n': // Dry Run / read-only
951 if( strcmp(argv[i], "--help") == 0 ) {
955 else if( strcmp(argv[i], "--dry-run") == 0 ) {
958 else if( strcmp(argv[i], "--drinks-only") == 0 ) {
959 giUIMode = UI_MODE_DRINKSONLY;
961 else if( strcmp(argv[i], "--can-select-all") == 0 ) {
962 gbDisallowSelectWithoutBalance = 0;
965 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
971 // The first argument is not allowed to begin with 'i'
972 // (catches most bad flags)
973 if( giTextArgc == 0 ) {
974 fprintf(stderr, "%s: Unknown switch '%s'\n", argv[0], argv[i]);
978 if( giTextArgc == MAX_TXT_ARGS )
980 fprintf(stderr, "ERROR: Too many arguments\n");
983 gsTextArgs[giTextArgc++] = argv[i];
990 if( giTextArgc == MAX_TXT_ARGS )
992 fprintf(stderr, "ERROR: Too many arguments\n");
996 gsTextArgs[giTextArgc++] = argv[i];
1005 char *trim(char *string)
1009 while( isspace(*string) )
1012 for( i = strlen(string); i--; )
1014 if( isspace(string[i]) )