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;
83 snprintf(fbuf, sizeof(fbuf), "%s/.srfsh.xml", home);
85 if(!access(fbuf, R_OK)) {
86 if( ! osrf_system_bootstrap_client(fbuf, "srfsh") ) {
87 fprintf(stderr,"Unable to bootstrap client for requests\n");
88 osrfLogError( OSRF_LOG_MARK, "Unable to bootstrap client for requests");
93 fprintf(stderr,"No Config file found at %s\n", fbuf );
98 /* for now.. the first arg is used as a script file for processing */
100 if( (f = open(argv[1], O_RDONLY)) == -1 ) {
101 osrfLogError( OSRF_LOG_MARK, "Unable to open file %s for reading, exiting...", argv[1]);
105 if(dup2(f, STDIN_FILENO) == -1) {
106 osrfLogError( OSRF_LOG_MARK, "Unable to duplicate STDIN, exiting...");
114 /* --------------------------------------------- */
118 client = osrfSystemGetTransportClient();
120 /* main process loop */
121 int newline_needed = 1; /* used as boolean */
123 while((request=readline(prompt))) {
125 // Find first non-whitespace character
127 char * cmd = request;
128 while( isspace( (unsigned char) *cmd ) )
131 // ignore comments and empty lines
133 if( '\0' == *cmd || '#' == *cmd )
136 // Remove trailing whitespace. We know at this point that
137 // there is at least one non-whitespace character somewhere,
138 // or we would have already skipped this line. Hence we
139 // needn't check to make sure that we don't back up past
143 // The curly braces limit the scope of the end variable
145 char * end = cmd + strlen(cmd) - 1;
146 while( isspace( (unsigned char) *end ) )
151 if( !strcasecmp(cmd, "exit") || !strcasecmp(cmd, "quit"))
157 char* req_copy = strdup(cmd);
159 parse_request( req_copy );
160 if( request && *cmd ) {
161 add_history(request);
171 if( newline_needed ) {
173 // We left the readline loop after seeing an EOF, not after
174 // seeing "quit" or "exit". So we issue a newline in order
175 // to avoid leaving a dangling prompt.
180 if(history_file != NULL )
181 write_history(history_file);
186 osrf_system_shutdown();
190 static int load_history( void ) {
192 char* home = getenv("HOME");
193 int l = strlen(home) + 24;
195 snprintf(fbuf, sizeof(fbuf), "%s/.srfsh_history", home);
196 history_file = strdup(fbuf);
198 if(!access(history_file, W_OK | R_OK )) {
199 history_length = 5000;
200 read_history(history_file);
206 static int parse_error( char* words[] ) {
211 growing_buffer * gbuf = buffer_init( 64 );
212 buffer_add( gbuf, *words );
214 buffer_add( gbuf, " " );
215 buffer_add( gbuf, *words );
217 fprintf( stderr, "???: %s\n", gbuf->buf );
225 static int parse_request( char* request ) {
227 if( request == NULL )
230 char* original_request = strdup( request );
231 char* words[COMMAND_BUFSIZE];
238 char* cur_tok = strtok( req, " " );
240 if( cur_tok == NULL )
242 free( original_request );
246 /* Load an array with pointers to */
247 /* the tokens as defined by strtok() */
249 while(cur_tok != NULL) {
250 if( i < COMMAND_BUFSIZE - 1 ) {
251 words[i++] = cur_tok;
252 cur_tok = strtok( NULL, " " );
254 fprintf( stderr, "Too many tokens in command\n" );
255 free( original_request );
262 /* pass off to the top level command */
263 if( !strcmp(words[0],"router") )
264 ret_val = handle_router( words );
266 else if( !strcmp(words[0],"time") )
267 ret_val = handle_time( words );
269 else if (!strcmp(words[0],"request"))
270 ret_val = handle_request( words, 0 );
272 else if (!strcmp(words[0],"relay"))
273 ret_val = handle_request( words, 1 );
275 else if (!strcmp(words[0],"help"))
276 ret_val = print_help();
278 else if (!strcmp(words[0],"set"))
279 ret_val = handle_set(words);
281 else if (!strcmp(words[0],"print"))
282 ret_val = handle_print(words);
284 else if (!strcmp(words[0],"math_bench"))
285 ret_val = handle_math(words);
287 else if (!strcmp(words[0],"introspect"))
288 ret_val = handle_introspect(words);
290 else if (!strcmp(words[0],"login"))
291 ret_val = handle_login(words);
293 else if (words[0][0] == '!') {
294 system( original_request + 1 );
298 free( original_request );
301 return parse_error( words );
307 static int handle_introspect(char* words[]) {
312 fprintf(stderr, "--> %s\n", words[1]);
314 // Build a command in a suitably-sized
315 // buffer and then parse it
319 static const char text[] = "request %s opensrf.system.method %s";
320 len = sizeof( text ) + strlen( words[1] ) + strlen( words[2] );
322 snprintf( buf, sizeof(buf), text, words[1], words[2] );
323 return parse_request( buf );
326 static const char text[] = "request %s opensrf.system.method.all";
327 len = sizeof( text ) + strlen( words[1] );
329 snprintf( buf, sizeof(buf), text, words[1] );
330 return parse_request( buf );
336 static int handle_login( char* words[]) {
338 if( words[1] && words[2]) {
340 char* username = words[1];
341 char* password = words[2];
342 char* type = words[3];
343 char* orgloc = words[4];
344 char* workstation = words[5];
345 int orgloci = (orgloc) ? atoi(orgloc) : 0;
346 if(!type) type = "opac";
348 char login_text[] = "request open-ils.auth open-ils.auth.authenticate.init \"%s\"";
349 size_t len = sizeof( login_text ) + strlen(username) + 1;
352 snprintf( buf, sizeof(buf), login_text, username );
356 if(last_result && last_result->_result_content) {
357 jsonObject* r = last_result->_result_content;
358 hash = jsonObjectGetString(r);
362 char* pass_buf = md5sum(password);
364 size_t both_len = strlen( hash ) + strlen( pass_buf ) + 1;
365 char both_buf[both_len];
366 snprintf(both_buf, sizeof(both_buf), "%s%s", hash, pass_buf);
368 char* mess_buf = md5sum(both_buf);
370 growing_buffer* argbuf = buffer_init(64);
372 "request open-ils.auth open-ils.auth.authenticate.complete "
373 "{ \"username\" : \"%s\", \"password\" : \"%s\"", username, mess_buf );
375 if(type) buffer_fadd( argbuf, ", \"type\" : \"%s\"", type );
376 if(orgloci) buffer_fadd( argbuf, ", \"org\" : %d", orgloci );
377 if(workstation) buffer_fadd( argbuf, ", \"workstation\" : \"%s\"", workstation);
378 buffer_add(argbuf, "}");
383 parse_request( argbuf->buf );
386 if( login_session != NULL )
387 free( login_session );
389 const jsonObject* x = last_result->_result_content;
392 const char* authtoken = jsonObjectGetString(
393 jsonObjectGetKeyConst(jsonObjectGetKeyConst(x,"payload"), "authtoken"));
394 authtime = jsonObjectGetNumber(
395 jsonObjectGetKeyConst(jsonObjectGetKeyConst(x,"payload"), "authtime"));
398 login_session = strdup(authtoken);
400 login_session = NULL;
402 else login_session = NULL;
404 printf("Login Session: %s. Session timeout: %f\n",
405 (login_session ? login_session : "(none)"), authtime );
414 static int handle_set( char* words[]) {
417 if( (variable=words[1]) ) {
420 if( (val=words[2]) ) {
422 if(!strcmp(variable,"pretty_print")) {
423 if(!strcmp(val,"true")) {
425 printf("pretty_print = true\n");
428 if(!strcmp(val,"false")) {
430 printf("pretty_print = false\n");
435 if(!strcmp(variable,"raw_print")) {
436 if(!strcmp(val,"true")) {
438 printf("raw_print = true\n");
441 if(!strcmp(val,"false")) {
443 printf("raw_print = false\n");
455 static int handle_print( char* words[]) {
458 if( (variable=words[1]) ) {
459 if(!strcmp(variable,"pretty_print")) {
461 printf("pretty_print = true\n");
464 printf("pretty_print = false\n");
469 if(!strcmp(variable,"raw_print")) {
471 printf("raw_print = true\n");
474 printf("raw_print = false\n");
479 if(!strcmp(variable,"login")) {
480 printf("login session = %s\n",
481 login_session ? login_session : "(none)" );
489 static int handle_router( char* words[] ) {
497 if( !strcmp(words[1],"query") ) {
499 if( words[2] && !strcmp(words[2],"servers") ) {
500 for(i=3; i < COMMAND_BUFSIZE - 3 && words[i]; i++ ) {
501 router_query_servers( words[i] );
514 static int handle_request( char* words[], int relay ) {
520 char* server = words[1];
521 char* method = words[2];
523 growing_buffer* buffer = NULL;
525 buffer = buffer_init(128);
526 buffer_add(buffer, "[");
527 for(i = 3; words[i] != NULL; i++ ) {
528 /* removes trailing semicolon if user accidentally enters it */
529 if( words[i][strlen(words[i])-1] == ';' )
530 words[i][strlen(words[i])-1] = '\0';
531 buffer_add( buffer, words[i] );
532 buffer_add(buffer, " ");
534 buffer_add(buffer, "]");
537 int rc = send_request( server, method, buffer, relay );
538 buffer_free( buffer );
545 int send_request( char* server,
546 char* method, growing_buffer* buffer, int relay ) {
547 if( server == NULL || method == NULL )
550 jsonObject* params = NULL;
552 if( buffer != NULL && buffer->n_used > 0 )
553 params = jsonParseString(buffer->buf);
555 if(!last_result || ! last_result->_result_content) {
556 printf("We're not going to call 'relay' with no result params\n");
560 jsonObject* o = jsonNewObject(NULL);
561 jsonObjectPush(o, last_result->_result_content );
567 if(buffer->n_used > 0 && params == NULL) {
568 fprintf(stderr, "JSON error detected, not executing\n");
572 osrfAppSession* session = osrf_app_client_session_init(server);
574 if(!osrf_app_session_connect(session)) {
575 osrfLogWarning( OSRF_LOG_MARK, "Unable to connect to remote service %s\n", server );
579 double start = get_timestamp_millis();
581 int req_id = osrfAppSessionMakeRequest( session, params, method, 1, NULL );
584 osrf_message* omsg = osrfAppSessionRequestRecv( session, req_id, recv_timeout );
587 printf("\nReceived no data from server\n");
590 signal(SIGPIPE, SIG_IGN);
593 if(!is_from_script) less = popen( "less -EX", "w");
596 if( less == NULL ) { less = stdout; }
598 growing_buffer* resp_buffer = buffer_init(4096);
604 if(omsg->_result_content) {
606 osrf_message_free(last_result);
612 char* j = jsonObjectToJSON(omsg->_result_content);
613 //content = json_printer(j);
614 content = jsonFormatString(j);
617 const char * temp_content = jsonObjectGetString(omsg->_result_content);
619 temp_content = "[null]";
620 content = strdup( temp_content );
623 printf( "\nReceived Data: %s\n", content );
629 snprintf( code, sizeof(code), "%d", omsg->status_code );
630 buffer_add( resp_buffer, code );
632 printf( "\nReceived Exception:\nName: %s\nStatus: %s\nStatus: %s\n",
633 omsg->status_name, omsg->status_text, code );
640 if(omsg->_result_content) {
642 osrf_message_free(last_result);
647 if( pretty_print && omsg->_result_content ) {
648 char* j = jsonObjectToJSON(omsg->_result_content);
649 //content = json_printer(j);
650 content = jsonFormatString(j);
653 const char * temp_content = jsonObjectGetString(omsg->_result_content);
655 content = strdup( temp_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: " );
673 snprintf( code, sizeof(code), "%d", omsg->status_code );
674 buffer_add( resp_buffer, code );
679 omsg = osrfAppSessionRequestRecv( session, req_id, recv_timeout );
683 double end = get_timestamp_millis();
685 fprintf( less, resp_buffer->buf );
686 buffer_free( resp_buffer );
687 fprintf( less, "\n------------------------------------\n");
688 if( osrf_app_session_request_complete( session, req_id ))
689 fprintf(less, "Request Completed Successfully\n");
692 fprintf(less, "Request Time in seconds: %.6f\n", end - start );
693 fprintf(less, "------------------------------------\n");
697 osrf_app_session_request_finish( session, req_id );
698 osrf_app_session_disconnect( session );
699 osrfAppSessionFree( session );
707 static int handle_time( char* words[] ) {
709 printf("%f\n", get_timestamp_millis());
711 time_t epoch = (time_t) atoi(words[1]);
712 printf("%s", ctime(&epoch));
719 static int router_query_servers( const char* router_server ) {
721 if( ! router_server || strlen(router_server) == 0 )
724 const static char router_text[] = "router@%s/router";
725 size_t len = sizeof( router_text ) + strlen( router_server ) + 1;
727 snprintf(rbuf, sizeof(rbuf), router_text, router_server );
729 transport_message* send =
730 message_init( "servers", NULL, NULL, rbuf, NULL );
731 message_set_router_info( send, NULL, NULL, NULL, "query", 0 );
733 client_send_message( client, send );
734 message_free( send );
736 transport_message* recv = client_recv( client, -1 );
738 fprintf(stderr, "NULL message received from router\n");
743 "---------------------------------------------------------------------------------\n"
744 "Received from 'server' query on %s\n"
745 "---------------------------------------------------------------------------------\n"
746 "original reg time | latest reg time | last used time | class | server\n"
747 "---------------------------------------------------------------------------------\n"
749 "---------------------------------------------------------------------------------\n"
750 , router_server, recv->body );
752 message_free( recv );
757 static int print_help( void ) {
760 "---------------------------------------------------------------------------------\n"
762 "---------------------------------------------------------------------------------\n"
763 "help - Display this message\n"
764 "!<command> [args] - Forks and runs the given command in the shell\n"
766 "time - Prints the current time\n"
767 "time <timestamp> - Formats seconds since epoch into readable format\n"
769 "set <variable> <value> - set a srfsh variable (e.g. set pretty_print true )\n"
770 "print <variable> - Displays the value of a srfsh variable\n"
771 "---------------------------------------------------------------------------------\n"
773 "router query servers <server1 [, server2, ...]>\n"
774 " - Returns stats on connected services\n"
777 "request <service> <method> [ <json formatted string of params> ]\n"
778 " - Anything passed in will be wrapped in a json array,\n"
779 " so add commas if there is more than one param\n"
782 "relay <service> <method>\n"
783 " - Performs the requested query using the last received result as the param\n"
786 "math_bench <num_batches> [0|1|2]\n"
787 " - 0 means don't reconnect, 1 means reconnect after each batch of 4, and\n"
788 " 2 means reconnect after every request\n"
790 "introspect <service>\n"
791 " - prints the API for the service\n"
794 "---------------------------------------------------------------------------------\n"
795 " Commands for Open-ILS\n"
796 "---------------------------------------------------------------------------------\n"
797 "login <username> <password>\n"
798 " - Logs into the 'server' and displays the session id\n"
799 " - To view the session id later, enter: print login\n"
800 "---------------------------------------------------------------------------------\n"
803 "Note: long output is piped through 'less'. To search in 'less', type: /<search>\n"
804 "---------------------------------------------------------------------------------\n"
813 static char* tabs(int count) {
814 growing_buffer* buf = buffer_init(24);
816 for(i=0;i!=count;i++)
817 buffer_add(buf, " ");
819 char* final = buffer_data( buf );
826 static int handle_math( char* words[] ) {
828 return do_math( atoi(words[1]), 0 );
833 static int do_math( int count, int style ) {
835 osrfAppSession* session = osrf_app_client_session_init( "opensrf.math" );
836 osrf_app_session_connect(session);
838 jsonObject* params = jsonParseString("[]");
839 jsonObjectPush(params,jsonNewObject("1"));
840 jsonObjectPush(params,jsonNewObject("2"));
842 char* methods[] = { "add", "sub", "mult", "div" };
843 char* answers[] = { "3", "-1", "2", "0.500000" };
845 float times[ count * 4 ];
846 memset(times, 0, sizeof(times));
849 for(k=0;k!=100;k++) {
856 fprintf(stderr,"\n\n");
860 for(i=0; i!= count; i++) {
863 for(j=0; j != 4; j++) {
867 double start = get_timestamp_millis();
868 int req_id = osrfAppSessionMakeRequest( session, params, methods[j], 1, NULL );
869 osrf_message* omsg = osrfAppSessionRequestRecv( session, req_id, 5 );
870 double end = get_timestamp_millis();
872 times[(4*i) + j] = end - start;
876 if(omsg->_result_content) {
877 char* jsn = jsonObjectToJSON(omsg->_result_content);
878 if(!strcmp(jsn, answers[j]))
879 fprintf(stderr, "+");
881 fprintf(stderr, "\n![%s] - should be %s\n", jsn, answers[j] );
886 osrf_message_free(omsg);
888 } else { fprintf( stderr, "\nempty message for tt: %d\n", req_id ); }
890 osrf_app_session_request_finish( session, req_id );
893 osrf_app_session_disconnect( session );
896 fprintf(stderr,"\n");
900 osrf_app_session_disconnect( session );
903 osrfAppSessionFree( session );
904 jsonObjectFree(params);
908 for(c=0; c!= count*4; c++)
911 float avg = total / (count*4);
912 fprintf(stderr, "\n Average round trip time: %f\n", avg );