Sat Nov 1 06:31:11 2008

Asterisk developer's documentation

---

pbx_gtkconsole.c File Reference

GTK Console monitor -- very kludgy right now. More...

#include <sys/types.h>
#include <stdlib.h>
#include <fcntl.h>
#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include <stdarg.h>
#include <signal.h>
#include <sys/time.h>
#include <gtk/gtk.h>
#include <glib.h>
#include "asterisk.h"
#include "asterisk/pbx.h"
#include "asterisk/config.h"
#include "asterisk/module.h"
#include "asterisk/logger.h"
#include "asterisk/options.h"
#include "asterisk/cli.h"
#include "asterisk/utils.h"

Include dependency graph for pbx_gtkconsole.c:

Go to the source code of this file.

Functions
static void	__verboser (const char *stuff, int opos, int replacelast, int complete)
static int	add_mod (const char *module, const char *description, int usecount, const char *like)
static void	add_module (void)
	AST_MUTEX_DEFINE_STATIC (verb_lock)
static int	cleanup (void *useless)
static int	cli_activate (void)
static void	cliinput (void *data, int source, GdkInputCondition ic)
static void *	consolethread (void *data)
char *	description (void)
	Provides a description of the module.
static void	exit_completely (GtkWidget *widget, gpointer data)
static void	exit_nicely (GtkWidget *widget, gpointer data)
static void	exit_now (GtkWidget *widget, gpointer data)
static void	file_ok_sel (GtkWidget *w, GtkFileSelection *fs)
char *	key (void)
	Returns the ASTERISK_GPL_KEY.
int	load_module (void)
	Initialize the module.
static int	mod_update (void)
static void	reload_module (void)
static void	remove_module (void)
static int	show_console (void)
int	unload_module (void)
	Cleanup all module structures, sockets, etc.
static void	update_statusbar (char *msg)
int	usecount (void)
	Provides a usecount.
static void	verboser (const char *stuff, int opos, int replacelast, int complete)
Variables
static int	cleanupid = -1
static GtkWidget *	cli
static int	clipipe [2]
static GtkWidget *	closew
static pthread_t	console_thread
static char *	dtext = "Asterisk PBX Console (GTK Version)"
static int	inuse = 0
static struct timeval	last
static GtkWidget *	modules
static GtkWidget *	quit
static GtkWidget *	statusbar
static GtkWidget *	verb
static GtkWidget *	window

---

Detailed Description

GTK Console monitor -- very kludgy right now.

Definition in file pbx_gtkconsole.c.

---

Function Documentation

static void __verboser	(	const char *	stuff,
		int	opos,
		int	replacelast,
		int	complete
	)			[static]

Definition at line 110 of file pbx_gtkconsole.c.

References cleanup().

Referenced by cliinput(), and verboser().

{
   char *s2[2];
   struct timeval tv;
   int ms;
   s2[0] = (char *)stuff;
   s2[1] = NULL;
   gtk_clist_freeze(GTK_CLIST(verb));
   if (replacelast) 
      gtk_clist_remove(GTK_CLIST(verb), GTK_CLIST(verb)->rows - 1);
   gtk_clist_append(GTK_CLIST(verb), s2);
   if (!ast_tvzero(last)) {
      gdk_threads_leave();
      gettimeofday(&tv, NULL);
      if (cleanupid > -1)
         gtk_timeout_remove(cleanupid);
      ms = ast_tvdiff_ms(tv, last);
      if (ms < 100) {
         /* We just got a message within 100ms, so just schedule an update
            in the near future */
         cleanupid = gtk_timeout_add(200, cleanup, NULL);
      } else {
         cleanup(&cleanupid);
      }
      last = tv;
   } else {
      gettimeofday(&last, NULL);
   }
}

static int add_mod	(	const char *	module,
		const char *	description,
		int	usecount,
		const char *	like
	)			[static]

Definition at line 278 of file pbx_gtkconsole.c.

References pass.

Referenced by mod_update().

{
   char use[10];
   char *pass[4];
   int row;
   snprintf(use, sizeof(use), "%d", usecount);
   pass[0] = module;
   pass[1] = description;
   pass[2] = use;
   pass[3] = NULL;
   row = gtk_clist_append(GTK_CLIST(modules), pass);
   gtk_clist_set_row_data(GTK_CLIST(modules), row, module);
   return 0;   
}

static void add_module

(

void

)

[static]

Definition at line 264 of file pbx_gtkconsole.c.

References ast_config_AST_MODULE_DIR, AST_CONFIG_MAX_PATH, and file_ok_sel().

Referenced by show_console().

{
   char tmp[AST_CONFIG_MAX_PATH];
   GtkWidget *filew;
   snprintf(tmp, sizeof(tmp), "%s/*.so", ast_config_AST_MODULE_DIR);
   filew = gtk_file_selection_new("Load Module");
   gtk_signal_connect(GTK_OBJECT (GTK_FILE_SELECTION(filew)->ok_button),
               "clicked", GTK_SIGNAL_FUNC(file_ok_sel), filew);
   gtk_signal_connect_object(GTK_OBJECT (GTK_FILE_SELECTION(filew)->cancel_button),
               "clicked", GTK_SIGNAL_FUNC(gtk_widget_destroy), GTK_OBJECT(filew));
   gtk_file_selection_set_filename(GTK_FILE_SELECTION(filew), (char *)tmp);
   gtk_widget_show(filew);
}

AST_MUTEX_DEFINE_STATIC

(

verb_lock

)

static int cleanup

(

void *

useless

)

[static]

Definition at line 98 of file pbx_gtkconsole.c.

Referenced by __verboser(), and new_odbc_obj().

{
   gdk_threads_enter();
   gtk_clist_thaw(GTK_CLIST(verb));
   gtk_widget_queue_resize(verb->parent);
   gtk_clist_moveto(GTK_CLIST(verb), GTK_CLIST(verb)->rows - 1, 0, 0, 0);
   cleanupid = -1;
   gdk_threads_leave();
   return 0;
}

static int cli_activate

(

void

)

[static]

Definition at line 347 of file pbx_gtkconsole.c.

References ast_cli_command(), and TRUE.

Referenced by show_console().

{
   char buf[256] = "";
   strncpy(buf, gtk_entry_get_text(GTK_ENTRY(cli)), sizeof(buf) - 1);
   gtk_entry_set_text(GTK_ENTRY(cli), "");
   if (strlen(buf)) {
      ast_cli_command(clipipe[1], buf);
   }
   return TRUE;
}

static void cliinput	(	void *	data,
		int	source,
		GdkInputCondition	ic
	)			[static]

Definition at line 148 of file pbx_gtkconsole.c.

References __verboser(), n, and offset.

Referenced by show_console().

{
   static char buf[256];
   static int offset = 0;
   int res;
   char *c;
   char *l;
   char n;
   /* Read as much stuff is there */
   res = read(source, buf + offset, sizeof(buf) - 1 - offset);
   if (res > -1)
      buf[res + offset] = '\0';
   /* make sure we've null terminated whatever we have so far */
   c = buf;
   l = buf;
   while(*c) {
      if (*c == '\n') {
         /* Keep the trailing \n */
         c++;
         n = *c;
         *c = '\0';
         __verboser(l, 0, 0, 1);
         *(c - 1) = '\0';
         *c = n;
         l = c;
      } else
      c++;
   }
   if (strlen(l)) {
      /* We have some left over */
      memmove(buf, l, strlen(l) + 1);
      offset = strlen(buf);
   } else {
      offset = 0;
   }

}

static void* consolethread

(

void *

data

)

[static]

Definition at line 338 of file pbx_gtkconsole.c.

{
   gtk_widget_show(window);
   gdk_threads_enter();
   gtk_main();
   gdk_threads_leave();
   return NULL;
}

char* description

(

void

)

Provides a description of the module.

Returns:

a short description of your module

Definition at line 510 of file pbx_gtkconsole.c.

{
   return dtext;
}

static void exit_completely	(	GtkWidget *	widget,
		gpointer	data
	)			[static]

Definition at line 322 of file pbx_gtkconsole.c.

References ast_cli_command().

Referenced by show_console().

{
#if 0
   /* Clever... */
   ast_cli_command(clipipe[1], "quit");
#else
   kill(getpid(), SIGTERM);
#endif
}

static void exit_nicely	(	GtkWidget *	widget,
		gpointer	data
	)			[static]

Definition at line 332 of file pbx_gtkconsole.c.

Referenced by show_console().

{
   fflush(stdout);
   gtk_widget_destroy(window);
}

static void exit_now	(	GtkWidget *	widget,
		gpointer	data
	)			[static]

Definition at line 309 of file pbx_gtkconsole.c.

References ast_loader_unregister(), ast_unload_resource(), ast_unregister_verbose(), ast_update_use_count(), ast_verbose(), mod_update(), option_verbose, VERBOSE_PREFIX_2, and verboser.

Referenced by show_console().

{
   ast_loader_unregister(mod_update);
   gtk_main_quit();
   inuse--;
   ast_update_use_count();
   ast_unregister_verbose(verboser);
   ast_unload_resource("pbx_gtkconsole", 0);
   if (option_verbose > 1)
      ast_verbose(VERBOSE_PREFIX_2 "GTK Console Monitor Exiting\n");
   /* XXX Trying to quit after calling this makes asterisk segfault XXX */
}

static void file_ok_sel	(	GtkWidget *	w,
		GtkFileSelection *	fs
	)			[static]

Definition at line 244 of file pbx_gtkconsole.c.

References ast_config_AST_MODULE_DIR, AST_CONFIG_MAX_PATH, ast_load_resource(), and update_statusbar().

Referenced by add_module().

{
   char tmp[AST_CONFIG_MAX_PATH];
   char *module = gtk_file_selection_get_filename(fs);
   char buf[256];
   snprintf(tmp, sizeof(tmp), "%s/", ast_config_AST_MODULE_DIR);
   if (!strncmp(module, (char *)tmp, strlen(tmp))) 
      module += strlen(tmp);
   gdk_threads_leave();
   if (ast_load_resource(module)) {
      snprintf(buf, sizeof(buf), "Error loading module '%s'.", module);
      update_statusbar(buf);
   } else {
      snprintf(buf, sizeof(buf), "Module '%s' loaded", module);
      update_statusbar(buf);
   }
   gdk_threads_enter();
   gtk_widget_destroy(GTK_WIDGET(fs));
}

char* key

(

void

)

Returns the ASTERISK_GPL_KEY.

This returns the ASTERISK_GPL_KEY, signifiying that you agree to the terms of the GPL stated in the ASTERISK_GPL_KEY. Your module will not load if it does not return the EXACT message:

 char *key(void) {
         return ASTERISK_GPL_KEY;
 }

Returns:

ASTERISK_GPL_KEY

Definition at line 515 of file pbx_gtkconsole.c.

References ASTERISK_GPL_KEY.

{
   return ASTERISK_GPL_KEY;
}

int load_module

(

void

)

Initialize the module.

TE STUFF END

Definition at line 481 of file pbx_gtkconsole.c.

References ast_log(), ast_update_use_count(), ast_verbose(), LOG_DEBUG, LOG_WARNING, option_debug, option_verbose, show_console(), and VERBOSE_PREFIX_2.

{
   if (pipe(clipipe)) {
      ast_log(LOG_WARNING, "Unable to create CLI pipe\n");
      return -1;
   }
   g_thread_init(NULL);
   if (gtk_init_check(NULL, NULL))  {
      if (!show_console()) {
         inuse++;
         ast_update_use_count();
         if (option_verbose > 1)
            ast_verbose( VERBOSE_PREFIX_2 "Launched GTK Console monitor\n");     
      } else
         ast_log(LOG_WARNING, "Unable to start GTK console\n");
   } else {
      if (option_debug)
         ast_log(LOG_DEBUG, "Unable to start GTK console monitor -- ignoring\n");
      if (option_verbose > 1)
         ast_verbose( VERBOSE_PREFIX_2 "GTK is not available -- skipping monitor\n");
   }
   return 0;
}

static int mod_update

(

void

)

[static]

Definition at line 293 of file pbx_gtkconsole.c.

References add_mod(), ast_update_module_list(), and modules.

Referenced by exit_now(), and show_console().

{
   char *module= NULL;
   /* Update the mod stuff */
   if (GTK_CLIST(modules)->selection) {
      module= (char *)gtk_clist_get_row_data(GTK_CLIST(modules), (int) GTK_CLIST(modules)->selection->data);
   }
   gtk_clist_freeze(GTK_CLIST(modules));
   gtk_clist_clear(GTK_CLIST(modules));
   ast_update_module_list(add_mod, NULL);
   if (module)
      gtk_clist_select_row(GTK_CLIST(modules), gtk_clist_find_row_from_data(GTK_CLIST(modules), module), -1);
   gtk_clist_thaw(GTK_CLIST(modules));
   return 1;
}

static void reload_module

(

void

)

[static]

Definition at line 206 of file pbx_gtkconsole.c.

References ast_load_resource(), ast_unload_resource(), free, strdup, and update_statusbar().

Referenced by show_console().

{
   int res, x;
   char *module;
   char buf[256];
   if (GTK_CLIST(modules)->selection) {
      module= (char *)gtk_clist_get_row_data(GTK_CLIST(modules), (int) GTK_CLIST(modules)->selection->data);
      module = strdup(module);
      if (module) {
         gdk_threads_leave();
         res = ast_unload_resource(module, 0);
         gdk_threads_enter();
         if (res) {
            snprintf(buf, sizeof(buf), "Module '%s' is in use", module);
            update_statusbar(buf);
         } else {
            gdk_threads_leave();
            res = ast_load_resource(module);
            gdk_threads_enter();
            if (res) {
               snprintf(buf, sizeof(buf), "Error reloading module '%s'", module);
            } else {
               snprintf(buf, sizeof(buf), "Module '%s' reloaded", module);
            }
            for (x=0; x < GTK_CLIST(modules)->rows; x++) {
               if (!strcmp((char *)gtk_clist_get_row_data(GTK_CLIST(modules), x), module)) {
                  gtk_clist_select_row(GTK_CLIST(modules), x, -1);
                  break;
               }
            }
            update_statusbar(buf);
            
         }
         free(module);
      }
   }
}

static void remove_module

(

void

)

[static]

Definition at line 187 of file pbx_gtkconsole.c.

References ast_unload_resource(), and update_statusbar().

Referenced by show_console().

{
   int res;
   char *module;
   char buf[256];
   if (GTK_CLIST(modules)->selection) {
      module= (char *)gtk_clist_get_row_data(GTK_CLIST(modules), (int) GTK_CLIST(modules)->selection->data);
      gdk_threads_leave();
      res = ast_unload_resource(module, 0);
      gdk_threads_enter();
      if (res) {
         snprintf(buf, sizeof(buf), "Module '%s' is in use", module);
         update_statusbar(buf);
      } else {
         snprintf(buf, sizeof(buf), "Module '%s' removed", module);
         update_statusbar(buf);
      }
   }
}

static int show_console

(

void

)

[static]

Definition at line 358 of file pbx_gtkconsole.c.

References add_module(), ast_loader_register(), ast_pthread_create, ast_register_verbose(), cli_activate(), cliinput(), consolethread, exit_completely(), exit_nicely(), exit_now(), FALSE, mod_update(), reload_module(), remove_module(), TRUE, update_statusbar(), and verboser.

Referenced by load_module().

{
   GtkWidget *hbox;
   GtkWidget *wbox;
   GtkWidget *notebook;
   GtkWidget *sw;
   GtkWidget *bbox, *hbbox, *add, *removew, *reloadw;
   char *modtitles[3] = { "Module", "Description", "Use Count" };
   window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
   
   statusbar = gtk_statusbar_new();
   gtk_widget_show(statusbar);
   
   gtk_signal_connect(GTK_OBJECT(window), "delete_event",
         GTK_SIGNAL_FUNC (exit_nicely), window);
   gtk_signal_connect(GTK_OBJECT(window), "destroy",
         GTK_SIGNAL_FUNC (exit_now), window);
   gtk_container_set_border_width(GTK_CONTAINER(window), 10);

   quit = gtk_button_new_with_label("Quit Asterisk");
   gtk_signal_connect(GTK_OBJECT(quit), "clicked",
         GTK_SIGNAL_FUNC (exit_completely), window);
   gtk_widget_show(quit);

   closew = gtk_button_new_with_label("Close Window");
   gtk_signal_connect(GTK_OBJECT(closew), "clicked",
         GTK_SIGNAL_FUNC (exit_nicely), window);
   gtk_widget_show(closew);

   notebook = gtk_notebook_new();
   verb = gtk_clist_new(1);
   gtk_clist_columns_autosize(GTK_CLIST(verb));
   sw = gtk_scrolled_window_new(NULL, NULL);
   gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(sw), GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS);
   gtk_container_add(GTK_CONTAINER(sw), verb);
   gtk_widget_show(verb);
   gtk_widget_show(sw);
   gtk_widget_set_usize(verb, 640, 400);
   gtk_notebook_append_page(GTK_NOTEBOOK(notebook), sw, gtk_label_new("Verbose Status"));

   
   modules = gtk_clist_new_with_titles(3, modtitles);
   gtk_clist_columns_autosize(GTK_CLIST(modules));
   gtk_clist_set_column_auto_resize(GTK_CLIST(modules), 0, TRUE);
   gtk_clist_set_column_auto_resize(GTK_CLIST(modules), 1, TRUE);
   gtk_clist_set_column_auto_resize(GTK_CLIST(modules), 2, TRUE);
   gtk_clist_set_sort_column(GTK_CLIST(modules), 0);
   gtk_clist_set_auto_sort(GTK_CLIST(modules), TRUE);
   gtk_clist_column_titles_passive(GTK_CLIST(modules));
   sw = gtk_scrolled_window_new(NULL, NULL);
   gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(sw), GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS);
   gtk_container_add(GTK_CONTAINER(sw), modules);
   gtk_clist_set_selection_mode(GTK_CLIST(modules), GTK_SELECTION_BROWSE);
   gtk_widget_show(modules);
   gtk_widget_show(sw);

   add = gtk_button_new_with_label("Load...");
   gtk_widget_show(add);
   removew = gtk_button_new_with_label("Unload");
   gtk_widget_show(removew);
   reloadw = gtk_button_new_with_label("Reload");
   gtk_widget_show(reloadw);
   gtk_signal_connect(GTK_OBJECT(removew), "clicked",
         GTK_SIGNAL_FUNC (remove_module), window);
   gtk_signal_connect(GTK_OBJECT(add), "clicked",
         GTK_SIGNAL_FUNC (add_module), window);
   gtk_signal_connect(GTK_OBJECT(reloadw), "clicked",
         GTK_SIGNAL_FUNC (reload_module), window);
      
   bbox = gtk_vbox_new(FALSE, 5);
   gtk_widget_show(bbox);

   gtk_widget_set_usize(bbox, 100, -1);
   gtk_box_pack_start(GTK_BOX(bbox), add, FALSE, FALSE, 5);
   gtk_box_pack_start(GTK_BOX(bbox), removew, FALSE, FALSE, 5);
   gtk_box_pack_start(GTK_BOX(bbox), reloadw, FALSE, FALSE, 5);

   hbbox = gtk_hbox_new(FALSE, 5);
   gtk_widget_show(hbbox);
   
   gtk_box_pack_start(GTK_BOX(hbbox), sw, TRUE, TRUE, 5);
   gtk_box_pack_start(GTK_BOX(hbbox), bbox, FALSE, FALSE, 5);

   gtk_notebook_append_page(GTK_NOTEBOOK(notebook), hbbox, gtk_label_new("Module Information"));

   gtk_widget_show(notebook);

   wbox = gtk_hbox_new(FALSE, 5);
   gtk_widget_show(wbox);
   gtk_box_pack_end(GTK_BOX(wbox), quit, FALSE, FALSE, 5);
   gtk_box_pack_end(GTK_BOX(wbox), closew, FALSE, FALSE, 5);

   hbox = gtk_vbox_new(FALSE, 0);
   gtk_widget_show(hbox);
   
   /* Command line */
   cli = gtk_entry_new();
   gtk_widget_show(cli);

   gtk_signal_connect(GTK_OBJECT(cli), "activate",
         GTK_SIGNAL_FUNC (cli_activate), NULL);

   gtk_box_pack_start(GTK_BOX(hbox), notebook, TRUE, TRUE, 5);
   gtk_box_pack_start(GTK_BOX(hbox), wbox, FALSE, FALSE, 5);
   gtk_box_pack_start(GTK_BOX(hbox), cli, FALSE, FALSE, 0);
   gtk_box_pack_start(GTK_BOX(hbox), statusbar, FALSE, FALSE, 0);
   gtk_container_add(GTK_CONTAINER(window), hbox);
   gtk_window_set_title(GTK_WINDOW(window), "Asterisk Console");
   gtk_widget_grab_focus(cli);
   ast_pthread_create(&console_thread, NULL, consolethread, NULL);
   /* XXX Okay, seriously fix me! XXX */
   usleep(100000);
   ast_register_verbose(verboser);
   gtk_clist_freeze(GTK_CLIST(verb));
   ast_loader_register(mod_update);
   gtk_clist_thaw(GTK_CLIST(verb));
   gdk_input_add(clipipe[0], GDK_INPUT_READ, cliinput, NULL);
   mod_update();
   update_statusbar("Asterisk Console Ready");
   return 0;
}

int unload_module

(

void

)

Cleanup all module structures, sockets, etc.

Standard module functions ...

Definition at line 84 of file pbx_gtkconsole.c.

{
   if (inuse) {
      /* Kill off the main thread */
      pthread_cancel(console_thread);
      gdk_threads_enter();
      gtk_widget_destroy(window);
      gdk_threads_leave();
      close(clipipe[0]);
      close(clipipe[1]);
   }
   return 0;
}

static void update_statusbar

(

char *

msg

)

[static]

Definition at line 78 of file pbx_gtkconsole.c.

Referenced by file_ok_sel(), reload_module(), remove_module(), and show_console().

{
   gtk_statusbar_pop(GTK_STATUSBAR(statusbar), 1);
   gtk_statusbar_push(GTK_STATUSBAR(statusbar), 1, msg);
}

int usecount

(

void

)

Provides a usecount.

This function will be called by various parts of asterisk. Basically, all it has to do is to return a usecount when called. You will need to maintain your usecount within the module somewhere. The usecount should be how many channels provided by this module are in use.

Returns:

The module's usecount.

Definition at line 505 of file pbx_gtkconsole.c.

{
   return inuse;
}

static void verboser	(	const char *	stuff,
		int	opos,
		int	replacelast,
		int	complete
	)			[static]

Definition at line 140 of file pbx_gtkconsole.c.

References __verboser(), ast_mutex_lock(), and ast_mutex_unlock().

{
   ast_mutex_lock(&verb_lock);
   /* Lock appropriately if we're really being called in verbose mode */
   __verboser(stuff, opos, replacelast, complete);
   ast_mutex_unlock(&verb_lock);
}

---

Variable Documentation

int cleanupid = -1 [static]

Definition at line 64 of file pbx_gtkconsole.c.

GtkWidget* cli [static]

Definition at line 74 of file pbx_gtkconsole.c.

int clipipe[2] [static]

Definition at line 63 of file pbx_gtkconsole.c.

GtkWidget* closew [static]

Definition at line 70 of file pbx_gtkconsole.c.

pthread_t console_thread [static]

Definition at line 60 of file pbx_gtkconsole.c.

char* dtext = "Asterisk PBX Console (GTK Version)" [static]

Definition at line 66 of file pbx_gtkconsole.c.

int inuse = 0 [static]

Definition at line 62 of file pbx_gtkconsole.c.

Referenced by ast_extension_state2(), chanavail_exec(), update_call_counter(), and vpb_bridge().

struct timeval last [static]

Definition at line 76 of file pbx_gtkconsole.c.

GtkWidget* modules [static]

Definition at line 72 of file pbx_gtkconsole.c.

Referenced by mod_update().

GtkWidget* quit [static]

Definition at line 69 of file pbx_gtkconsole.c.

GtkWidget* statusbar [static]

Definition at line 73 of file pbx_gtkconsole.c.

GtkWidget* verb [static]

Definition at line 71 of file pbx_gtkconsole.c.

GtkWidget* window [static]

Definition at line 68 of file pbx_gtkconsole.c.

---