1 #include <opensrf/transport_client.h>
2 #include <opensrf/osrf_message.h>
3 #include <opensrf/osrf_app_session.h>
10 #include <opensrf/utils.h>
11 #include <opensrf/log.h>
16 #include <readline/readline.h>
17 #include <readline/history.h>
19 #define SRFSH_PORT 5222
20 #define COMMAND_BUFSIZE 4096
24 static const char* prompt = "srfsh# ";
26 static char* history_file = NULL;
28 //static int child_dead = 0;
30 static char* login_session = NULL;
32 /* true if we're pretty printing json results */
33 static int pretty_print = 1;
34 /* true if we're bypassing 'less' */
35 static int raw_print = 0;
37 /* our jabber connection */
38 static transport_client* client = NULL;
40 /* the last result we received */
41 static osrf_message* last_result = NULL;
44 static int parse_request( char* request );
46 /* handles router requests */
47 static int handle_router( char* words[] );
49 /* utility method for print time data */
50 /* static int handle_time( char* words[] ); */
52 /* handles app level requests */
53 static int handle_request( char* words[], int relay );
54 static int handle_set( char* words[]);
55 static int handle_print( char* words[]);
56 static int send_request( char* server,
57 char* method, growing_buffer* buffer, int relay );
58 static int parse_error( char* words[] );
59 static int router_query_servers( const char* server );
60 static int print_help( void );
62 //static int srfsh_client_connect();
63 //static char* tabs(int count);
64 //static void sig_child_handler( int s );
65 //static void sig_int_handler( int s );
67 static int load_history( void );
68 static int handle_math( char* words[] );
69 static int do_math( int count, int style );
70 static int handle_introspect(char* words[]);
71 static int handle_login( char* words[]);
73 static int recv_timeout = 120;
74 static int is_from_script = 0;
76 int main( int argc, char* argv[] ) {
78 /* --------------------------------------------- */
79 /* see if they have a .srfsh.xml in their home directory */
80 char* home = getenv("HOME");
81 int l = strlen(home) + 36;
84 sprintf(fbuf,"%s/.srfsh.xml",home);
86 if(!access(fbuf, R_OK)) {
87 if( ! osrf_system_bootstrap_client(fbuf, "srfsh") ) {
88 fprintf(stderr,"Unable to bootstrap client for requests\n");
89 osrfLogError( OSRF_LOG_MARK, "Unable to bootstrap client for requests");
94 fprintf(stderr,"No Config file found at %s\n", fbuf );
99 /* for now.. the first arg is used as a script file for processing */
101 if( (f = open(argv[1], O_RDONLY)) == -1 ) {
102 osrfLogError( OSRF_LOG_MARK, "Unable to open file %s for reading, exiting...", argv[1]);
106 if(dup2(f, STDIN_FILENO) == -1) {
107 osrfLogError( OSRF_LOG_MARK, "Unable to duplicate STDIN, exiting...");
115 /* --------------------------------------------- */
119 client = osrf_system_get_transport_client();
121 /* main process loop */
122 int newline_needed = 1; /* used as boolean */
124 while((request=readline(prompt))) {
126 // Find first non-whitespace character
128 char * cmd = request;
129 while( isspace( (unsigned char) *cmd ) )
132 // ignore comments and empty lines
134 if( '\0' == *cmd || '#' == *cmd )
137 // Remove trailing whitespace. We know at this point that
138 // there is at least one non-whitespace character somewhere,
139 // or we would have already skipped this line. Hence we
140 // needn't check to make sure that we don't back up past
144 // The curly braces limit the scope of the end variable
146 char * end = cmd + strlen(cmd) - 1;
147 while( isspace( (unsigned char) *end ) )
152 if( !strcasecmp(cmd, "exit") || !strcasecmp(cmd, "quit"))
158 char* req_copy = strdup(cmd);
160 parse_request( req_copy );
161 if( request && *cmd ) {
162 add_history(request);
172 if( newline_needed ) {
174 // We left the readline loop after seeing an EOF, not after
175 // seeing "quit" or "exit". So we issue a newline in order
176 // to avoid leaving a dangling prompt.
181 if(history_file != NULL )
182 write_history(history_file);
186 osrf_system_shutdown();
191 static void sig_child_handler( int s ) {
197 void sig_int_handler( int s ) {
200 signal(SIGINT,sig_int_handler);
204 static int load_history( void ) {
206 char* home = getenv("HOME");
207 int l = strlen(home) + 24;
211 sprintf(fbuf,"%s/.srfsh_history",home);
212 history_file = strdup(fbuf);
214 if(!access(history_file, W_OK | R_OK )) {
215 history_length = 5000;
216 read_history(history_file);
222 static int parse_error( char* words[] ) {
227 growing_buffer * gbuf = buffer_init( 64 );
228 buffer_add( gbuf, *words );
230 buffer_add( gbuf, " " );
231 buffer_add( gbuf, *words );
233 fprintf( stderr, "???: %s\n", gbuf->buf );
241 static int parse_request( char* request ) {
243 if( request == NULL )
246 char* original_request = strdup( request );
247 char* words[COMMAND_BUFSIZE];
254 char* cur_tok = strtok( req, " " );
256 if( cur_tok == NULL )
258 free( original_request );
262 /* Load an array with pointers to */
263 /* the tokens as defined by strtok() */
265 while(cur_tok != NULL) {
266 if( i < COMMAND_BUFSIZE - 1 ) {
267 words[i++] = cur_tok;
268 cur_tok = strtok( NULL, " " );
270 fprintf( stderr, "Too many tokens in command\n" );
271 free( original_request );
278 /* pass off to the top level command */
279 if( !strcmp(words[0],"router") )
280 ret_val = handle_router( words );
283 else if( !strcmp(words[0],"time") )
284 ret_val = handle_time( words );
287 else if (!strcmp(words[0],"request"))
288 ret_val = handle_request( words, 0 );
290 else if (!strcmp(words[0],"relay"))
291 ret_val = handle_request( words, 1 );
293 else if (!strcmp(words[0],"help"))
294 ret_val = print_help();
296 else if (!strcmp(words[0],"set"))
297 ret_val = handle_set(words);
299 else if (!strcmp(words[0],"print"))
300 ret_val = handle_print(words);
302 else if (!strcmp(words[0],"math_bench"))
303 ret_val = handle_math(words);
305 else if (!strcmp(words[0],"introspect"))
306 ret_val = handle_introspect(words);
308 else if (!strcmp(words[0],"login"))
309 ret_val = handle_login(words);
311 else if (words[0][0] == '!') {
312 system( original_request + 1 );
316 free( original_request );
319 return parse_error( words );
325 static int handle_introspect(char* words[]) {
330 fprintf(stderr, "--> %s\n", words[1]);
332 // Build a command in a suitably-sized
333 // buffer and then parse it
337 static const char text[] = "request %s opensrf.system.method %s";
338 len = sizeof( text ) + strlen( words[1] ) + strlen( words[2] );
340 sprintf( buf, text, words[1], words[2] );
341 return parse_request( buf );
344 static const char text[] = "request %s opensrf.system.method.all";
345 len = sizeof( text ) + strlen( words[1] );
347 sprintf( buf, text, words[1] );
348 return parse_request( buf );
354 static int handle_login( char* words[]) {
356 if( words[1] && words[2]) {
358 char* username = words[1];
359 char* password = words[2];
360 char* type = words[3];
361 char* orgloc = words[4];
362 char* workstation = words[5];
363 int orgloci = (orgloc) ? atoi(orgloc) : 0;
364 if(!type) type = "opac";
373 "request open-ils.auth open-ils.auth.authenticate.init \"%s\"", username );
377 if(last_result && last_result->_result_content) {
378 jsonObject* r = last_result->_result_content;
379 hash = jsonObjectGetString(r);
383 char* pass_buf = md5sum(password);
386 memset(both_buf,0,256);
387 sprintf(both_buf,"%s%s",hash, pass_buf);
389 char* mess_buf = md5sum(both_buf);
392 sprintf( buf2, "request open-ils.auth open-ils.auth.authenticate.complete "
393 "{ \"username\" : \"%s\", \"password\" : \"%s\", "
394 "\"type\" : \"%s\", \"org\" : %d, \"workstation\": \"%s\"}",
395 username, mess_buf, type, orgloci, workstation );
398 growing_buffer* argbuf = buffer_init(64);
400 "request open-ils.auth open-ils.auth.authenticate.complete "
401 "{ \"username\" : \"%s\", \"password\" : \"%s\"", username, mess_buf );
403 if(type) buffer_fadd( argbuf, ", \"type\" : \"%s\"", type );
404 if(orgloci) buffer_fadd( argbuf, ", \"org\" : %d", orgloci );
405 if(workstation) buffer_fadd( argbuf, ", \"workstation\" : \"%s\"", workstation);
406 buffer_add(argbuf, "}");
411 parse_request( argbuf->buf );
414 jsonObject* x = last_result->_result_content;
417 char* authtoken = jsonObjectGetString(
418 jsonObjectGetKey(jsonObjectGetKey(x,"payload"), "authtoken"));
419 authtime = jsonObjectGetNumber(
420 jsonObjectGetKey(jsonObjectGetKey(x,"payload"), "authtime"));
421 if(authtoken) login_session = strdup(authtoken);
422 else login_session = NULL;
424 else login_session = NULL;
426 printf("Login Session: %s. Session timeout: %f\n", login_session, authtime );
435 static int handle_set( char* words[]) {
438 if( (variable=words[1]) ) {
441 if( (val=words[2]) ) {
443 if(!strcmp(variable,"pretty_print")) {
444 if(!strcmp(val,"true")) {
446 printf("pretty_print = true\n");
449 if(!strcmp(val,"false")) {
451 printf("pretty_print = false\n");
456 if(!strcmp(variable,"raw_print")) {
457 if(!strcmp(val,"true")) {
459 printf("raw_print = true\n");
462 if(!strcmp(val,"false")) {
464 printf("raw_print = false\n");
476 static int handle_print( char* words[]) {
479 if( (variable=words[1]) ) {
480 if(!strcmp(variable,"pretty_print")) {
482 printf("pretty_print = true\n");
485 printf("pretty_print = false\n");
490 if(!strcmp(variable,"login")) {
491 printf("login session = %s\n", login_session );
499 static int handle_router( char* words[] ) {
507 if( !strcmp(words[1],"query") ) {
509 if( words[2] && !strcmp(words[2],"servers") ) {
510 for(i=3; i < COMMAND_BUFSIZE - 3 && words[i]; i++ ) {
511 router_query_servers( words[i] );
524 static int handle_request( char* words[], int relay ) {
530 char* server = words[1];
531 char* method = words[2];
533 growing_buffer* buffer = NULL;
535 buffer = buffer_init(128);
536 buffer_add(buffer, "[");
537 for(i = 3; words[i] != NULL; i++ ) {
538 /* removes trailing semicolon if user accidentally enters it */
539 if( words[i][strlen(words[i])-1] == ';' )
540 words[i][strlen(words[i])-1] = '\0';
541 buffer_add( buffer, words[i] );
542 buffer_add(buffer, " ");
544 buffer_add(buffer, "]");
547 return send_request( server, method, buffer, relay );
553 int send_request( char* server,
554 char* method, growing_buffer* buffer, int relay ) {
555 if( server == NULL || method == NULL )
558 jsonObject* params = NULL;
560 if( buffer != NULL && buffer->n_used > 0 )
561 params = jsonParseString(buffer->buf);
563 if(!last_result || ! last_result->_result_content) {
564 printf("We're not going to call 'relay' with no result params\n");
568 jsonObject* o = jsonNewObject(NULL);
569 jsonObjectPush(o, last_result->_result_content );
575 if(buffer->n_used > 0 && params == NULL) {
576 fprintf(stderr, "JSON error detected, not executing\n");
580 osrf_app_session* session = osrf_app_client_session_init(server);
582 if(!osrf_app_session_connect(session)) {
583 osrfLogWarning( OSRF_LOG_MARK, "Unable to connect to remote service %s\n", server );
587 double start = get_timestamp_millis();
588 //int req_id = osrf_app_session_make_request( session, params, method, 1, NULL );
589 int req_id = osrf_app_session_make_req( session, params, method, 1, NULL );
592 osrf_message* omsg = osrf_app_session_request_recv( session, req_id, recv_timeout );
595 printf("\nReceived no data from server\n");
598 signal(SIGPIPE, SIG_IGN);
601 if(!is_from_script) less = popen( "less -EX", "w");
604 if( less == NULL ) { less = stdout; }
606 growing_buffer* resp_buffer = buffer_init(4096);
612 if(omsg->_result_content) {
614 osrf_message_free(last_result);
619 if( pretty_print && omsg->_result_content ) {
620 char* j = jsonObjectToJSON(omsg->_result_content);
621 //content = json_printer(j);
622 content = jsonFormatString(j);
625 content = jsonObjectGetString(omsg->_result_content);
627 printf( "\nReceived Data: %s\n", content );
634 sprintf( code, "%d", omsg->status_code );
635 buffer_add( resp_buffer, code );
637 printf( "\nReceived Exception:\nName: %s\nStatus: %s\nStatus: %s\n",
638 omsg->status_name, omsg->status_text, code );
645 if(omsg->_result_content) {
647 osrf_message_free(last_result);
652 if( pretty_print && omsg->_result_content ) {
653 char* j = jsonObjectToJSON(omsg->_result_content);
654 //content = json_printer(j);
655 content = jsonFormatString(j);
658 content = jsonObjectGetString(omsg->_result_content);
660 buffer_add( resp_buffer, "\nReceived Data: " );
661 buffer_add( resp_buffer, content );
662 buffer_add( resp_buffer, "\n" );
667 buffer_add( resp_buffer, "\nReceived Exception:\nName: " );
668 buffer_add( resp_buffer, omsg->status_name );
669 buffer_add( resp_buffer, "\nStatus: " );
670 buffer_add( resp_buffer, omsg->status_text );
671 buffer_add( resp_buffer, "\nStatus: " );
674 sprintf( code, "%d", omsg->status_code );
675 buffer_add( resp_buffer, code );
680 omsg = osrf_app_session_request_recv( session, req_id, recv_timeout );
684 double end = get_timestamp_millis();
686 fprintf( less, resp_buffer->buf );
687 buffer_free( resp_buffer );
688 fprintf( less, "\n------------------------------------\n");
689 if( osrf_app_session_request_complete( session, req_id ))
690 fprintf(less, "Request Completed Successfully\n");
693 fprintf(less, "Request Time in seconds: %.6f\n", end - start );
694 fprintf(less, "------------------------------------\n");
698 osrf_app_session_request_finish( session, req_id );
699 osrf_app_session_disconnect( session );
700 osrf_app_session_destroy( session );
709 static int handle_time( char* words[] ) {
716 printf( "%s\n", buf );
721 time_t epoch = (time_t)atoi( words[1] );
722 char* localtime = strdup( ctime( &epoch ) );
723 printf( "%s => %s", words[1], localtime );
735 static int router_query_servers( const char* router_server ) {
737 if( ! router_server || strlen(router_server) == 0 )
742 sprintf(rbuf,"router@%s/router", router_server );
744 transport_message* send =
745 message_init( "servers", NULL, NULL, rbuf, NULL );
746 message_set_router_info( send, NULL, NULL, NULL, "query", 0 );
748 client_send_message( client, send );
749 message_free( send );
751 transport_message* recv = client_recv( client, -1 );
753 fprintf(stderr, "NULL message received from router\n");
758 "---------------------------------------------------------------------------------\n"
759 "Received from 'server' query on %s\n"
760 "---------------------------------------------------------------------------------\n"
761 "original reg time | latest reg time | last used time | class | server\n"
762 "---------------------------------------------------------------------------------\n"
764 "---------------------------------------------------------------------------------\n"
765 , router_server, recv->body );
767 message_free( recv );
772 static int print_help( void ) {
775 "---------------------------------------------------------------------------------\n"
777 "---------------------------------------------------------------------------------\n"
778 "help - Display this message\n"
779 "!<command> [args] - Forks and runs the given command in the shell\n"
781 "time - Prints the current time\n"
782 "time <timestamp> - Formats seconds since epoch into readable format\n"
784 "set <variable> <value> - set a srfsh variable (e.g. set pretty_print true )\n"
785 "print <variable> - Displays the value of a srfsh variable\n"
786 "---------------------------------------------------------------------------------\n"
788 "router query servers <server1 [, server2, ...]>\n"
789 " - Returns stats on connected services\n"
792 "request <service> <method> [ <json formatted string of params> ]\n"
793 " - Anything passed in will be wrapped in a json array,\n"
794 " so add commas if there is more than one param\n"
797 "relay <service> <method>\n"
798 " - Performs the requested query using the last received result as the param\n"
801 "math_bench <num_batches> [0|1|2]\n"
802 " - 0 means don't reconnect, 1 means reconnect after each batch of 4, and\n"
803 " 2 means reconnect after every request\n"
805 "introspect <service>\n"
806 " - prints the API for the service\n"
809 "---------------------------------------------------------------------------------\n"
810 " Commands for Open-ILS\n"
811 "---------------------------------------------------------------------------------\n"
812 "login <username> <password>\n"
813 " - Logs into the 'server' and displays the session id\n"
814 " - To view the session id later, enter: print login\n"
815 "---------------------------------------------------------------------------------\n"
818 "Note: long output is piped through 'less'. To search in 'less', type: /<search>\n"
819 "---------------------------------------------------------------------------------\n"
828 static char* tabs(int count) {
829 growing_buffer* buf = buffer_init(24);
831 for(i=0;i!=count;i++)
832 buffer_add(buf, " ");
834 char* final = buffer_data( buf );
841 static int handle_math( char* words[] ) {
843 return do_math( atoi(words[1]), 0 );
848 static int do_math( int count, int style ) {
850 osrf_app_session* session = osrf_app_client_session_init( "opensrf.math" );
851 osrf_app_session_connect(session);
853 jsonObject* params = jsonParseString("[]");
854 jsonObjectPush(params,jsonNewObject("1"));
855 jsonObjectPush(params,jsonNewObject("2"));
857 char* methods[] = { "add", "sub", "mult", "div" };
858 char* answers[] = { "3", "-1", "2", "0.500000" };
860 float times[ count * 4 ];
861 memset(times,0,count*4);
864 for(k=0;k!=100;k++) {
871 fprintf(stderr,"\n\n");
875 for(i=0; i!= count; i++) {
878 for(j=0; j != 4; j++) {
882 double start = get_timestamp_millis();
883 int req_id = osrf_app_session_make_req( session, params, methods[j], 1, NULL );
884 osrf_message* omsg = osrf_app_session_request_recv( session, req_id, 5 );
885 double end = get_timestamp_millis();
887 times[(4*i) + j] = end - start;
891 if(omsg->_result_content) {
892 char* jsn = jsonObjectToJSON(omsg->_result_content);
893 if(!strcmp(jsn, answers[j]))
894 fprintf(stderr, "+");
896 fprintf(stderr, "\n![%s] - should be %s\n", jsn, answers[j] );
901 osrf_message_free(omsg);
903 } else { fprintf( stderr, "\nempty message for tt: %d\n", req_id ); }
905 osrf_app_session_request_finish( session, req_id );
908 osrf_app_session_disconnect( session );
911 fprintf(stderr,"\n");
915 osrf_app_session_disconnect( session );
918 osrf_app_session_destroy( session );
919 jsonObjectFree(params);
923 for(c=0; c!= count*4; c++)
926 float avg = total / (count*4);
927 fprintf(stderr, "\n Average round trip time: %f\n", avg );