[asterisk-commits] oej: trunk r136005 - /trunk/res/res_jabber.c
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Wed Aug 6 08:34:08 CDT 2008
Author: oej
Date: Wed Aug 6 08:34:08 2008
New Revision: 136005
URL: http://svn.digium.com/view/asterisk?view=rev&rev=136005
Log:
- Formatting
- Changing debug messages from VERBOSE to DEBUG channel
- Adding a few todo's
- Adding a few more "XMPP"'s to compliment Jabber...
Modified:
trunk/res/res_jabber.c
Modified: trunk/res/res_jabber.c
URL: http://svn.digium.com/view/asterisk/trunk/res/res_jabber.c?view=diff&rev=136005&r1=136004&r2=136005
==============================================================================
--- trunk/res/res_jabber.c (original)
+++ trunk/res/res_jabber.c Wed Aug 6 08:34:08 2008
@@ -17,12 +17,16 @@
*/
/*! \file
- * \brief A resource for interfacing asterisk directly as a client
- * or a component to a jabber compliant server.
+ * \brief A resource for interfacing Asterisk directly as a client
+ * or a component to a XMPP/Jabber compliant server.
+ *
+ * References:
+ * - http://www.xmpp.org - The XMPP standards foundation
*
* \extref Iksemel http://code.google.com/p/iksemel/
*
* \todo If you unload this module, chan_gtalk/jingle will be dead. How do we handle that?
+ * \todo Dialplan applications need RETURN variable, like JABBERSENDSTATUS
*
*/
@@ -55,6 +59,8 @@
#include "asterisk/astdb.h"
#include "asterisk/manager.h"
+/*! \todo This should really be renamed to xmpp.conf. For backwards compatibility, we
+ need to read both files */
#define JABBER_CONFIG "jabber.conf"
#ifndef FALSE
@@ -133,8 +139,8 @@
static char *ajisend_descrip =
"JabberSend(Jabber,ScreenName,Message)\n"
" Jabber - Client or transport Asterisk uses to connect to Jabber\n"
-" ScreenName - User Name to message.\n"
-" Message - Message to be sent to the buddy\n";
+" ScreenName - XMPP/Jabber JID (Name) of recipient\n"
+" Message - Message to be sent to the budd (UTF8)y\n";
static char *app_ajistatus = "JabberStatus";
@@ -145,8 +151,9 @@
" Jabber - Client or transport Asterisk uses to connect to Jabber\n"
" ScreenName - User Name to retrieve status from.\n"
" Variable - Variable to store presence in will be 1-6.\n"
-" In order, Online, Chatty, Away, XAway, DND, Offline\n"
-" If not in roster variable will = 7\n";
+" In order, 1=Online, 2=Chatty, 3=Away, 4=XAway, 5=DND, 6=Offline\n"
+" If not in roster variable will be set to 7\n\n"
+"Note: This application is deprecated. Please use the JABBER_STATUS() function instead.\n";
struct aji_client_container clients;
struct aji_capabilities *capabilities = NULL;
@@ -407,13 +414,13 @@
);
if (!data) {
- ast_log(LOG_ERROR, "Usage: JABBER_STATUS(<sender>,<screenname>[/<resource>])\n");
+ ast_log(LOG_ERROR, "Usage: JABBER_STATUS(<sender>,<jid>[/<resource>])\n");
return 0;
}
AST_STANDARD_APP_ARGS(args, data);
if (args.argc != 2) {
- ast_log(LOG_ERROR, "JABBER_STATUS requires 2 arguments.\n");
+ ast_log(LOG_ERROR, "JABBER_STATUS requires 2 arguments: sender and jid.\n");
return -1;
}
@@ -445,8 +452,11 @@
.syntax = "JABBER_STATUS(<sender>,<buddy>[/<resource>])",
.read = acf_jabberstatus_read,
.desc =
-"Retrieves the numeric status associated with the specified buddy. If the\n"
-"buddy does not exist in the buddylist, returns 7.\n",
+"Retrieves the numeric status associated with the specified buddy (jid). If the\n"
+"buddy does not exist in the buddylist, returns 7.\n"
+"Status will be 1-7.\n"
+" 1=Online, 2=Chatty, 3=Away, 4=XAway, 5=DND, 6=Offline\n"
+" If not in roster variable will be set to 7\n\n",
};
/*!
@@ -776,8 +786,9 @@
ast_verbose("\nJABBER: %s INCOMING: %s\n", client->name, xmpp);
else {
if( strlen(xmpp) == 1) {
- if(option_debug > 2 && xmpp[0] == ' ')
- ast_verbose("\nJABBER: Keep alive packet\n");
+ if(option_debug > 2 && xmpp[0] == ' ') {
+ ast_verbose("\nJABBER: Keep alive packet\n");
+ }
} else
ast_verbose("\nJABBER: %s OUTGOING: %s\n", client->name, xmpp);
}
@@ -1040,7 +1051,7 @@
return IKS_OK;
}
/*!
- * \brief Uknown
+ * \brief Unknown
* \param data void
* \param pak ikspak
* \return IKS_FILTER_EAT.
@@ -1083,7 +1094,7 @@
return IKS_FILTER_EAT;
}
/*!
- * \brief register query
+ * \brief register handler for incoming querys (IQ's)
* \param data incoming aji_client request
* \param pak ikspak
* \return IKS_FILTER_EAT.
@@ -1093,14 +1104,15 @@
struct aji_client *client = ASTOBJ_REF((struct aji_client *) data);
struct aji_buddy *buddy = NULL;
char *node = NULL;
+ iks *iq = NULL, *query = NULL;
client = (struct aji_client *) data;
buddy = ASTOBJ_CONTAINER_FIND(&client->buddies, pak->from->partial);
if (!buddy) {
- iks *iq = NULL, *query = NULL, *error = NULL, *notacceptable = NULL;
-
- ast_verbose("Someone.... %s tried to register but they aren't allowed\n", pak->from->partial);
+ iks *error = NULL, *notacceptable = NULL;
+
+ ast_log(LOG_ERROR, "Someone.... %s tried to register but they aren't allowed\n", pak->from->partial);
iq = iks_new("iq");
query = iks_new("query");
error = iks_new("error");
@@ -1122,12 +1134,10 @@
ast_log(LOG_ERROR, "Out of memory.\n");
}
- iks_delete(iq);
- iks_delete(query);
iks_delete(error);
iks_delete(notacceptable);
} else if (!(node = iks_find_attrib(pak->query, "node"))) {
- iks *iq = NULL, *query = NULL, *instructions = NULL;
+ iks *instructions = NULL;
char *explain = "Welcome to Asterisk - the Open Source PBX.\n";
iq = iks_new("iq");
query = iks_new("query");
@@ -1146,10 +1156,10 @@
ast_log(LOG_ERROR, "Out of memory.\n");
}
- iks_delete(iq);
- iks_delete(query);
iks_delete(instructions);
}
+ iks_delete(iq);
+ iks_delete(query);
ASTOBJ_UNREF(client, aji_client_destroy);
return IKS_FILTER_EAT;
}
@@ -1264,7 +1274,7 @@
resource = aji_find_resource(buddy, pak->from->resource);
if (pak->subtype == IKS_TYPE_RESULT) {
if (!resource) {
- ast_log(LOG_NOTICE,"JABBER: Received client info from %s when not requested.\n", pak->from->full);
+ ast_log(LOG_NOTICE, "JABBER: Received client info from %s when not requested.\n", pak->from->full);
ASTOBJ_UNREF(client, aji_client_destroy);
return IKS_FILTER_EAT;
}
@@ -1686,35 +1696,35 @@
}
switch (pak->subtype) {
case IKS_TYPE_AVAILABLE:
- ast_verb(5, "JABBER: I am available ^_* %i\n", pak->subtype);
+ ast_debug(3, "JABBER: I am available ^_* %i\n", pak->subtype);
break;
case IKS_TYPE_UNAVAILABLE:
- ast_verb(5, "JABBER: I am unavailable ^_* %i\n", pak->subtype);
+ ast_debug(3, "JABBER: I am unavailable ^_* %i\n", pak->subtype);
break;
default:
- ast_verb(5, "JABBER: Ohh sexy and the wrong type: %i\n", pak->subtype);
+ ast_debug(3, "JABBER: Ohh sexy and the wrong type: %i\n", pak->subtype);
}
switch (pak->show) {
case IKS_SHOW_UNAVAILABLE:
- ast_verb(5, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
+ ast_debug(3, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
break;
case IKS_SHOW_AVAILABLE:
- ast_verb(5, "JABBER: type is available\n");
+ ast_debug(3, "JABBER: type is available\n");
break;
case IKS_SHOW_CHAT:
- ast_verb(5, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
+ ast_debug(3, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
break;
case IKS_SHOW_AWAY:
- ast_verb(5, "JABBER: type is away\n");
+ ast_debug(3, "JABBER: type is away\n");
break;
case IKS_SHOW_XA:
- ast_verb(5, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
+ ast_debug(3, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
break;
case IKS_SHOW_DND:
- ast_verb(5, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
+ ast_debug(3, "JABBER: type: %i subtype %i\n", pak->subtype, pak->show);
break;
default:
- ast_verb(5, "JABBER: Kinky! how did that happen %i\n", pak->show);
+ ast_debug(3, "JABBER: Kinky! how did that happen %i\n", pak->show);
}
}
@@ -1893,7 +1903,7 @@
int res = IKS_HOOK;
while(res != IKS_OK) {
- ast_verb(4, "JABBER: Connecting.\n");
+ ast_debug(3, "JABBER: Connecting.\n");
res = aji_reconnect(client);
sleep(4);
}
@@ -1901,7 +1911,7 @@
do {
if (res == IKS_NET_RWERR || client->timeout == 0) {
while(res != IKS_OK) {
- ast_verb(4, "JABBER: reconnecting.\n");
+ ast_debug(3, "JABBER: reconnecting.\n");
res = aji_reconnect(client);
sleep(4);
}
@@ -1921,7 +1931,7 @@
if (res == IKS_HOOK)
ast_log(LOG_WARNING, "JABBER: Got hook event.\n");
else if (res == IKS_NET_TLSFAIL)
- ast_log(LOG_WARNING, "JABBER: Failure in TLS.\n");
+ ast_log(LOG_ERROR, "JABBER: Failure in TLS.\n");
else if (client->timeout == 0 && client->state == AJI_CONNECTED) {
res = client->keepalive ? aji_send_raw(client, " ") : IKS_OK;
if(res == IKS_OK)
@@ -2046,6 +2056,7 @@
* \brief goes through roster and prunes users not needed in list, or adds them accordingly.
* \param client the configured XMPP client we use to connect to a XMPP server
* \return void.
+ * \note The messages here should be configurable.
*/
static void aji_pruneregister(struct aji_client *client)
{
@@ -2067,10 +2078,10 @@
* be called at the same time */
if (ast_test_flag(&iterator->flags, AJI_AUTOPRUNE)) {
res = ast_aji_send(client, iks_make_s10n(IKS_TYPE_UNSUBSCRIBE, iterator->name,
- "GoodBye your status is no longer needed by Asterisk the Open Source PBX"
+ "GoodBye. Your status is no longer needed by Asterisk the Open Source PBX"
" so I am no longer subscribing to your presence.\n"));
res = ast_aji_send(client, iks_make_s10n(IKS_TYPE_UNSUBSCRIBED, iterator->name,
- "GoodBye you are no longer in the asterisk config file so I am removing"
+ "GoodBye. You are no longer in the Asterisk config file so I am removing"
" your access to my presence.\n"));
iks_insert_attrib(removeiq, "from", client->jid->full);
iks_insert_attrib(removeiq, "type", "set");
@@ -2080,7 +2091,7 @@
res = ast_aji_send(client, removeiq);
} else if (ast_test_flag(&iterator->flags, AJI_AUTOREGISTER)) {
res = ast_aji_send(client, iks_make_s10n(IKS_TYPE_SUBSCRIBE, iterator->name,
- "Greetings I am the Asterisk Open Source PBX and I want to subscribe to your presence\n"));
+ "Greetings! I am the Asterisk Open Source PBX and I want to subscribe to your presence\n"));
ast_clear_flag(&iterator->flags, AJI_AUTOREGISTER);
}
ASTOBJ_UNLOCK(iterator);
@@ -2178,6 +2189,7 @@
ASTOBJ_UNREF(client, aji_client_destroy);
return IKS_FILTER_EAT;
}
+
/*!
* \brief reconnect to jabber server
* \param client the configured XMPP client we use to connect to a XMPP server
@@ -2199,6 +2211,7 @@
return res;
}
+
/*!
* \brief Get the roster of jabber users
* \param client the configured XMPP client we use to connect to a XMPP server
@@ -2348,7 +2361,7 @@
e->command = "jabber set debug {on|off}";
e->usage =
"Usage: jabber set debug {on|off}\n"
- " Enables/disables dumping of Jabber packets for debugging purposes.\n";
+ " Enables/disables dumping of XMPP/Jabber packets for debugging purposes.\n";
return NULL;
case CLI_GENERATE:
return NULL;
More information about the asterisk-commits
mailing list