]> git.evergreen-ils.org Git - OpenSRF.git/blob - src/srfsh/srfsh.c
added an 'introspect' command
[OpenSRF.git] / src / srfsh / srfsh.c
1 #include "srfsh.h"
2
3 int caught_sigint = 0;
4
5 int main( int argc, char* argv[] ) {
6
7
8
9         /* --------------------------------------------- */
10         if( argc < 2 ) {
11
12                 /* see if they have a .srfsh.xml in their home directory */
13                 char* home = getenv("HOME");
14                 int l = strlen(home) + 36;
15                 char fbuf[l];
16                 memset(fbuf, 0, l);
17                 sprintf(fbuf,"%s/.srfsh.xml",home);
18
19                 if(!access(fbuf, R_OK)) {
20                         if( ! osrf_system_bootstrap_client(fbuf) ) 
21                                 fatal_handler( "Unable to bootstrap client for requests");
22
23                 } else {
24                         fatal_handler( "No Config file found at %s and none specified. "
25                                         "\nusage: %s <config_file>", fbuf, argv[0] );
26                 }
27
28         } else {
29                 if( ! osrf_system_bootstrap_client(argv[1]) ) 
30                         fatal_handler( "Unable to bootstrap client for requests");
31         }
32         /* --------------------------------------------- */
33         load_history();
34
35
36         client = osrf_system_get_transport_client();
37
38
39         /* main process loop */
40         char* request;
41         signal(SIGINT,sig_int_handler);
42         while((request=readline(prompt))) {
43
44                 if( !strcmp(request, "exit") || !strcmp(request,"quit")) 
45                         break; 
46
47                 char* req_copy = strdup(request);
48
49                 parse_request( req_copy ); 
50                 if( request && strlen(request) > 1 ) {
51                         add_history(request);
52                 }
53
54                 free(request);
55                 free(req_copy);
56         }
57
58         if(history_file != NULL )
59                 write_history(history_file);
60         free(request);
61         client_disconnect( client );
62         client_free( client );  
63         config_reader_free();   
64         log_free();
65                 
66         return 0;
67 }
68
69 void sig_child_handler( int s ) {
70         child_dead = 1;
71 }
72
73 void sig_int_handler( int s ) {
74         printf("\n");
75         caught_sigint = 1;
76         signal(SIGINT,sig_int_handler);
77 }
78
79 int load_history() {
80
81         char* home = getenv("HOME");
82         int l = strlen(home) + 24;
83         char fbuf[l];
84
85         memset(fbuf, 0, l);
86         sprintf(fbuf,"%s/.srfsh_history",home);
87         history_file = strdup(fbuf);
88
89         if(!access(history_file, W_OK | R_OK )) {
90                 //set_history_length(999);
91                 history_length = 999;
92                 read_history(history_file);
93         }
94         return 1;
95 }
96
97
98 int parse_error( char* words[] ) {
99
100         if( ! words )
101                 return 0;
102
103         int i = 0;
104         char* current;
105         char buffer[256];
106         memset(buffer, 0, 256);
107         while( (current=words[i++]) ) {
108                 strcat(buffer, current);
109                 strcat(buffer, " ");
110         }
111         if( ! buffer || strlen(buffer) < 1 ) 
112                 printf("\n");
113
114         fprintf( stderr, "???: %s\n", buffer );
115         return 0;
116
117 }
118
119
120 int parse_request( char* request ) {
121
122         if( request == NULL )
123                 return 0;
124
125         int ret_val = 0;
126         int i = 0;
127         char* words[COMMAND_BUFSIZE]; 
128         memset(words,0,COMMAND_BUFSIZE);
129         char* req = request;
130
131         char* cur_tok = strtok( req, " " );
132
133         if( cur_tok == NULL )
134                 return 0;
135
136         while(cur_tok != NULL) {
137                 words[i++] = cur_tok;
138                 cur_tok = strtok( NULL, " " );
139         }
140
141
142         // not sure why (strtok?), but this is necessary
143         memset( words + i, 0, COMMAND_BUFSIZE - i );
144
145         /* pass off to the top level command */
146         if( !strcmp(words[0],"router") ) 
147                 ret_val = handle_router( words );
148
149         else if( !strcmp(words[0],"time") ) 
150                 ret_val = handle_time( words );
151
152         else if (!strcmp(words[0],"request"))
153                 ret_val = handle_request( words, 0 );
154
155         else if (!strcmp(words[0],"relay"))
156                 ret_val = handle_request( words, 1 );
157
158         else if (!strcmp(words[0],"help"))
159                 ret_val = print_help();
160
161         else if (!strcmp(words[0],"set"))
162                 ret_val = handle_set(words);
163
164         else if (!strcmp(words[0],"print"))
165                 ret_val = handle_print(words);
166
167         else if (!strcmp(words[0],"math_bench"))
168                 ret_val = handle_math(words);
169
170         else if (!strcmp(words[0],"introspect"))
171                 ret_val = handle_introspect(words);
172
173         else if (words[0][0] == '!')
174                 ret_val = handle_exec( words );
175
176         if(!ret_val)
177                 return parse_error( words );
178
179         return 1;
180
181 }
182
183
184 int handle_introspect(char* words[]) {
185
186         if(words[1]) {
187                 fprintf(stderr, "--> %s\n", words[1]);
188                 char buf[256];
189                 memset(buf,0,256);
190                 sprintf( buf, "request %s opensrf.system.method.all", words[1] );
191                 return parse_request( buf );
192         }
193
194         return 0;
195 }
196
197
198
199 int handle_set( char* words[]) {
200
201         char* variable;
202         if( (variable=words[1]) ) {
203
204                 char* val;
205                 if( (val=words[2]) ) {
206
207                         if(!strcmp(variable,"pretty_print")) {
208                                 if(!strcmp(val,"true")) {
209                                         pretty_print = 1;
210                                         printf("pretty_print = true\n");
211                                         return 1;
212                                 } 
213                                 if(!strcmp(val,"false")) {
214                                         pretty_print = 0;
215                                         printf("pretty_print = false\n");
216                                         return 1;
217                                 } 
218                         }
219                 }
220         }
221
222         return 0;
223 }
224
225
226 int handle_print( char* words[]) {
227
228         char* variable;
229         if( (variable=words[1]) ) {
230                 if(!strcmp(variable,"pretty_print")) {
231                         if(pretty_print) {
232                                 printf("pretty_print = true\n");
233                                 return 1;
234                         } else {
235                                 printf("pretty_print = false\n");
236                                 return 1;
237                         }
238                 }
239         }
240         return 0;
241 }
242
243 int handle_router( char* words[] ) {
244
245         if(!client)
246                 return 1;
247
248         int i;
249
250         if( words[1] ) { 
251                 if( !strcmp(words[1],"query") ) {
252                         
253                         if( words[2] && !strcmp(words[2],"servers") ) {
254                                 for(i=3; i < COMMAND_BUFSIZE - 3 && words[i]; i++ ) {   
255                                         router_query_servers( words[i] );
256                                 }
257                                 return 1;
258                         }
259                         return 0;
260                 }
261                 return 0;
262         }
263         return 0;
264 }
265
266
267 int handle_exec(char* words[]) {
268
269         int len = strlen(words[0]);
270         char command[len];
271         memset(command,0,len);
272
273         int i; /* chop out the ! */
274         for( i=1; i!= len; i++) {
275                 command[i-1] = words[0][i];
276         }
277
278         free(words[0]);
279         words[0] = strdup(command);
280         signal(SIGCHLD,sig_child_handler);
281         if(fork()) {
282                 while(1) {
283                         sleep(100);
284                         if(child_dead) {
285                                 signal(SIGCHLD,sig_child_handler);
286                                 child_dead = 0;
287                                 break;
288                         }
289                 }
290         } else {
291                 execvp( words[0], words );
292                 exit(0);
293         }
294         return 1;
295 }
296
297
298 int handle_request( char* words[], int relay ) {
299
300         if(!client)
301                 return 1;
302
303         if(words[1]) {
304                 char* server = words[1];
305                 char* method = words[2];
306                 int i;
307                 growing_buffer* buffer = NULL;
308                 if(!relay) {
309                         buffer = buffer_init(128);
310                         buffer_add(buffer, "[");
311                         for(i = 3; words[i] != NULL; i++ ) {
312                                 /* removes trailing semicolon if user accidentally enters it */
313                                 if( words[i][strlen(words[i])-1] == ';' )
314                                         words[i][strlen(words[i])-1] = '\0';
315                                 buffer_add( buffer, words[i] );
316                                 buffer_add(buffer, " ");
317                         }
318                         buffer_add(buffer, "]");
319                 }
320
321                 return send_request( server, method, buffer, relay );
322         } 
323
324         return 0;
325 }
326
327 int send_request( char* server, 
328                 char* method, growing_buffer* buffer, int relay ) {
329         if( server == NULL || method == NULL )
330                 return 0;
331
332         json* params = NULL;
333         if( !relay ) {
334                 if( buffer != NULL && buffer->n_used > 0 ) 
335                         params = json_tokener_parse(buffer->buf);
336         } else {
337                 if(!last_result || ! last_result->result_content) { 
338                         printf("We're not going to call 'relay' with no result params\n");
339                         return 1;
340                 }
341                 else {
342                         json* arr = json_object_new_array();
343                         json_object_array_add( arr, last_result->result_content );
344                         params = arr;
345                 }
346         }
347
348         osrf_app_session* session = osrf_app_client_session_init(server);
349
350         if(!osrf_app_session_connect(session)) {
351                 warning_handler( "Unable to connect to remote service %s\n", server );
352                 return 1;
353         }
354
355         double start = get_timestamp_millis();
356         int req_id = osrf_app_session_make_request( session, params, method, 1 );
357
358         if( caught_sigint ) 
359                 caught_sigint = 0;
360
361         osrf_message* omsg = osrf_app_session_request_recv( session, req_id, 8 );
362
363         if( caught_sigint ) {
364                 caught_sigint = 0;
365                 return 1;
366         }
367
368         if(!omsg) 
369                 printf("\nReceived no data from server\n");
370         
371         
372         signal(SIGPIPE, SIG_IGN);
373
374         FILE* less = popen( "less -EX", "w");
375         if( less == NULL ) { less = stdout; }
376
377         growing_buffer* resp_buffer = buffer_init(4096);
378
379         while(omsg) {
380
381                 if(omsg->result_content) {
382
383                         osrf_message_free(last_result);
384                         last_result = omsg;
385
386                         if( pretty_print ) {
387                                 char* content = json_printer( omsg->result_content );
388                                 buffer_add( resp_buffer, "\nReceived Data:" ); 
389                                 buffer_add( resp_buffer, content );
390                                 buffer_add( resp_buffer, "\n" );
391                                 free(content);
392                         } else {
393                                 char* content = json_object_get_string(omsg->result_content);
394                                         buffer_add( resp_buffer, "\nReceived Data:" ); 
395                                         buffer_add( resp_buffer, content );
396                                         buffer_add( resp_buffer, "\n" );
397                         }
398
399                 } else {
400
401                         buffer_add( resp_buffer, "\nReceived Exception:\nName: " );
402                         buffer_add( resp_buffer, omsg->status_name );
403                         buffer_add( resp_buffer, "\nStatus: " );
404                         buffer_add( resp_buffer, omsg->status_text );
405                         buffer_add( resp_buffer, "\nStatus: " );
406                         char code[16];
407                         memset(code, 0, 16);
408                         sprintf( code, "%d", omsg->status_code );
409                         buffer_add( resp_buffer, code );
410                 }
411
412                 if( caught_sigint ) 
413                         caught_sigint = 0;
414
415                 omsg = osrf_app_session_request_recv( session, req_id, 5 );
416
417                 if( caught_sigint ) {
418                         caught_sigint = 0;
419                         return 1;
420                 }
421         }
422
423
424         double end = get_timestamp_millis();
425
426         fprintf( less, resp_buffer->buf );
427         buffer_free( resp_buffer );
428         fprintf( less, "\n------------------------------------\n");
429         if( osrf_app_session_request_complete( session, req_id ))
430                 fprintf(less, "Request Completed Successfully\n");
431
432
433         fprintf(less, "Request Time in seconds: %.3f\n", end - start );
434         fprintf(less, "------------------------------------\n");
435
436         pclose(less); 
437
438         osrf_app_session_request_finish( session, req_id );
439         osrf_app_session_disconnect( session );
440         osrf_app_session_destroy( session );
441
442
443         return 1;
444
445
446 }
447
448 int handle_time( char* words[] ) {
449
450         if( ! words[1] ) {
451
452                 char buf[36];
453                 memset(buf,0,36);
454                 get_timestamp(buf);
455                 printf( "%s\n", buf );
456                 return 1;
457         }
458
459         if( words[1] ) {
460                 time_t epoch = (time_t)atoi( words[1] );
461                 char* localtime = strdup( ctime( &epoch ) );
462                 printf( "%s => %s", words[1], localtime );
463                 free(localtime);
464                 return 1;
465         }
466
467         return 0;
468
469 }
470
471                 
472
473 int router_query_servers( char* router_server ) {
474
475         if( ! router_server || strlen(router_server) == 0 ) 
476                 return 0;
477
478         char rbuf[256];
479         memset(rbuf,0,256);
480         sprintf(rbuf,"router@%s/router", router_server );
481                 
482         transport_message* send = 
483                 message_init( "servers", NULL, NULL, rbuf, NULL );
484         message_set_router_info( send, NULL, NULL, NULL, "query", 0 );
485
486         client_send_message( client, send );
487         message_free( send );
488
489         transport_message* recv = client_recv( client, -1 );
490         if( recv == NULL ) {
491                 fprintf(stderr, "NULL message received from router\n");
492                 return 1;
493         }
494         
495         printf( 
496                         "---------------------------------------------------------------------------------\n"
497                         "Received from 'server' query on %s\n"
498                         "---------------------------------------------------------------------------------\n"
499                         "original reg time | latest reg time | last used time | class | server\n"
500                         "---------------------------------------------------------------------------------\n"
501                         "%s"
502                         "---------------------------------------------------------------------------------\n"
503                         , router_server, recv->body );
504
505         message_free( recv );
506         
507         return 1;
508 }
509                 
510 int print_help() {
511
512         printf(
513                         "---------------------------------------------------------------------------------\n"
514                         "Commands:\n"
515                         "---------------------------------------------------------------------------------\n"
516                         "help                   - Display this message\n"
517                         "!<command> [args] - Forks and runs the given command in the shell\n"
518                         "time                   - Prints the current time\n"                                    
519                         "time <timestamp>       - Formats seconds since epoch into readable format\n"   
520                         "set <variable> <value> - set a srfsh variable (e.g. set pretty_print true )\n"
521                         "print <variable>               - Displays the value of a srfsh variable\n"
522                         "---------------------------------------------------------------------------------\n"
523
524                         "router query servers <server1 [, server2, ...]>\n"
525                         "       - Returns stats on connected services\n"
526                         "\n"
527                         "\n"
528                         "request <service> <method> [ <json formatted string of params> ]\n"
529                         "       - Anything passed in will be wrapped in a json array,\n"
530                         "               so add commas if there is more than one param\n"
531                         "\n"
532                         "\n"
533                         "relay <service> <method>\n"
534                         "       - Performs the requested query using the last received result as the param\n"
535                         "\n"
536                         "\n"
537                         "math_bench <num_batches> [0|1|2]\n"
538                         "       - 0 means don't reconnect, 1 means reconnect after each batch of 4, and\n"
539                         "                2 means reconnect after every request\n"
540                         "\n"
541                         "introspect <service>\n"
542                         "       - prints the API for the service\n"
543                         "\n"
544                         "---------------------------------------------------------------------------------\n"
545                         "Note: long output is piped through 'less'.  To search in 'less', type: /<search>\n"
546                         "---------------------------------------------------------------------------------\n"
547                         "\n"
548                         );
549
550         return 1;
551 }
552
553
554
555 char* tabs(int count) {
556         growing_buffer* buf = buffer_init(24);
557         int i;
558         for(i=0;i!=count;i++)
559                 buffer_add(buf, "   ");
560
561         char* final = buffer_data( buf );
562         buffer_free( buf );
563         return final;
564 }
565
566 char* json_printer( json* object ) {
567
568         if(object == NULL)
569                 return NULL;
570         char* string = json_object_get_string(object);
571
572         growing_buffer* buf = buffer_init(64);
573         int i;
574         int tab_var = 0;
575         for(i=0; i!= strlen(string); i++) {
576
577                 if( string[i] == '{' ) {
578
579                         buffer_add(buf, "\n");
580                         char* tab = tabs(tab_var);
581                         buffer_add(buf, tab);
582                         free(tab);
583                         buffer_add( buf, "{");
584                         tab_var++;
585                         buffer_add( buf, "\n" );        
586                         tab = tabs(tab_var);
587                         buffer_add( buf, tab ); 
588                         free(tab);
589
590                 } else if( string[i] == '[' ) {
591
592                         buffer_add(buf, "\n");
593                         char* tab = tabs(tab_var);
594                         buffer_add(buf, tab);
595                         free(tab);
596                         buffer_add( buf, "[");
597                         tab_var++;
598                         buffer_add( buf, "\n" );        
599                         tab = tabs(tab_var);
600                         buffer_add( buf, tab ); 
601                         free(tab);
602
603                 } else if( string[i] == '}' ) {
604
605                         tab_var--;
606                         buffer_add(buf, "\n");
607                         char* tab = tabs(tab_var);
608                         buffer_add(buf, tab);
609                         free(tab);
610                         buffer_add( buf, "}");
611                         buffer_add( buf, "\n" );        
612                         tab = tabs(tab_var);
613                         buffer_add( buf, tab ); 
614                         free(tab);
615
616                 } else if( string[i] == ']' ) {
617
618                         tab_var--;
619                         buffer_add(buf, "\n");
620                         char* tab = tabs(tab_var);
621                         buffer_add(buf, tab);
622                         free(tab);
623                         buffer_add( buf, "]");
624                         buffer_add( buf, "\n" );        
625                         tab = tabs(tab_var);
626                         buffer_add( buf, tab ); 
627                         free(tab);
628
629                 } else if( string[i] == ',' ) {
630
631                         buffer_add( buf, ",");
632                         buffer_add( buf, "\n" );        
633                         char* tab = tabs(tab_var);
634                         buffer_add(buf, tab);
635                         free(tab);
636
637                 } else {
638
639                         char b[2];
640                         b[0] = string[i];
641                         b[1] = '\0';
642                         buffer_add( buf, b ); 
643                 }
644
645         }
646
647         char* result = buffer_data(buf);
648         buffer_free(buf);
649         return result;
650
651 }
652
653 int handle_math( char* words[] ) {
654         if( words[1] && words[2] ) 
655                 return do_math( atoi(words[1]), atoi(words[2]) );
656         return 0;
657 }
658
659
660 int do_math( int count, int style ) {
661
662         osrf_app_session* session = osrf_app_client_session_init(  "opensrf.math" );
663
664         json* params = json_object_new_array();
665         json_object_array_add(params, json_object_new_string("1"));
666         json_object_array_add(params, json_object_new_string("2"));
667
668         char* methods[] = { "add", "sub", "mult", "div" };
669         char* answers[] = { "3", "-1", "2", "0.500000" };
670
671         float times[ count * 4 ];
672         memset(times,0,count*4);
673
674         int k;
675         for(k=0;k!=100;k++) {
676                 if(!(k%10)) 
677                         fprintf(stderr,"|");
678                 else
679                         fprintf(stderr,".");
680         }
681
682         fprintf(stderr,"\n\n");
683
684         int running = 0;
685         int i;
686         for(i=0; i!= count; i++) {
687
688                 int j;
689                 for(j=0; j != 4; j++) {
690
691                         ++running;
692                         struct timeb t1;
693                         struct timeb t2;
694
695                         ftime(&t1);
696                         int req_id = osrf_app_session_make_request( session, params, methods[j], 1 );
697
698                         if( caught_sigint ) 
699                                 caught_sigint = 0;
700
701                         osrf_message* omsg = osrf_app_session_request_recv( session, req_id, 5 );
702
703                         if( caught_sigint )  {
704                                 caught_sigint = 0;
705                                 return 1;
706                         }
707
708                         ftime(&t2);
709
710                         double start    = ( (int)t1.time        + ( ((float)t1.millitm) / 1000 ) );
711                         double end              = ( (int)t2.time        + ( ((float)t2.millitm) / 1000 ) );
712
713                         times[(4*i) + j] = end - start;
714
715                         if(omsg) {
716         
717                                 if(omsg->result_content) {
718                                         char* jsn = json_object_get_string( omsg->result_content );
719                                         if(!strcmp(jsn, answers[j]))
720                                                 fprintf(stderr, "+");
721                                         else
722                                                 fprintf(stderr, "\n![%s] - should be %s\n", jsn, answers[j] );
723                                 }
724
725                                 osrf_message_free(omsg);
726                 
727                         } else { fprintf( stderr, "\nempty message for tt: %d\n", req_id ); }
728
729                         osrf_app_session_request_finish( session, req_id );
730
731                         if(style == 2)
732                                 osrf_app_session_disconnect( session );
733
734                         if(!(running%100))
735                                 fprintf(stderr,"\n");
736                 }
737
738                 if(style==1)
739                         osrf_app_session_disconnect( session );
740         }
741
742         osrf_app_session_destroy( session );
743         json_object_put( params );
744
745         int c;
746         float total = 0;
747         for(c=0; c!= count*4; c++) 
748                 total += times[c];
749
750         float avg = total / (count*4); 
751         fprintf(stderr, "\n      Average round trip time: %f\n", avg );
752
753         return 1;
754 }