dialog: Change create_dialog() to use explicit flag names

Author: liviuchircu

modules/dialog/dialog.c

@@ -39,6 +39,7 @@
 #include "../../script_var.h"
 #include "../../mem/mem.h"
 #include "../../mi/mi.h"
+#include "../../lib/csv.h"
 #include "../rr/api.h"
 #include "../../bin_interface.h"
 #include "../clusterer/api.h"
@@ -118,7 +119,7 @@ static int pv_get_dlg_count( struct sip_msg *msg, pv_param_t *param,
 		pv_value_t *res);
 
 /* commands wrappers and fixups */
-static int w_create_dialog(struct sip_msg*, str *flags_str);
+static int w_create_dialog(struct sip_msg*, void *flags_param);
 static int w_match_dialog(struct sip_msg *msg, void *seq_match_mode_val);
 static int api_match_dialog(struct sip_msg *msg, int _seq_match_mode);
 static int w_validate_dialog(struct sip_msg*);
@@ -134,6 +135,7 @@ static int fixup_check_avp(void** param);
 static int fixup_check_var(void** param);
 static int fixup_lmode(void **param);
 static int fixup_leg(void **param);
+static int fixup_create_dlg_flags(void **param);
 static int w_set_dlg_flag(struct sip_msg *msg, void *mask);
 static int w_reset_dlg_flag(struct sip_msg *msg, void *mask);
 static int w_is_dlg_flag_set(struct sip_msg *msg, void *mask);
@@ -186,7 +188,7 @@ int pv_get_dlg_ctx_json(struct sip_msg *msg, pv_param_t *param,
 
 static const cmd_export_t cmds[]={
 	{"create_dialog", (cmd_function)w_create_dialog, {
-		{CMD_PARAM_STR|CMD_PARAM_OPT,0,0}, {0,0,0}},
+		{CMD_PARAM_STR|CMD_PARAM_OPT,fixup_create_dlg_flags,0}, {0,0,0}},
 		REQUEST_ROUTE},
 	{"set_dlg_profile", (cmd_function)w_set_dlg_profile, {
 		{CMD_PARAM_STR,0,0},
@@ -599,6 +601,64 @@ static int free_fixup_route(void** param)
 	return 0;
 }
 
+/*
+ * Keep this array in sync with create_dlg_flags[] below: if you add, remove
+ * or reorder a create_dialog() flag here, make the identical change there.
+ */
+static str create_dlg_flag_names[] = {
+	str_init("bye-on-timeout"),       /* DLG_FLAG_BYEONTIMEOUT */
+	str_init("options-ping-caller"),  /* DLG_FLAG_PING_CALLER */
+	str_init("options-ping-callee"),  /* DLG_FLAG_PING_CALLEE */
+	str_init("reinvite-ping-caller"), /* DLG_FLAG_REINVITE_PING_CALLER */
+	str_init("reinvite-ping-callee"), /* DLG_FLAG_REINVITE_PING_CALLEE */
+	str_init("end-on-race-condition"), /* DLG_FLAG_END_ON_RACE_CONDITION */
+	str_init("auto-prack"),           /* DLG_FLAG_AUTOPRACK */
+	STR_NULL
+};
+
+static int fixup_create_dlg_flags(void **param)
+{
+	static const unsigned int create_dlg_flags[] = {
+		DLG_FLAG_BYEONTIMEOUT,
+		DLG_FLAG_PING_CALLER,
+		DLG_FLAG_PING_CALLEE,
+		DLG_FLAG_REINVITE_PING_CALLER,
+		DLG_FLAG_REINVITE_PING_CALLEE,
+		DLG_FLAG_END_ON_RACE_CONDITION,
+		DLG_FLAG_AUTOPRACK
+	};
+	str *flags_str = (str *)*param;
+	csv_record *list, *rec;
+	unsigned int flags = 0;
+	int i;
+
+	list = parse_csv_record(flags_str);
+	if (!list) {
+		LM_ERR("Failed to parse list of create_dialog flags\n");
+		return -1;
+	}
+
+	for (rec = list; rec; rec = rec->next) {
+		for (i = 0; create_dlg_flag_names[i].s; i++) {
+			if (str_strcasecmp(&rec->s, &create_dlg_flag_names[i]) == 0) {
+				flags |= create_dlg_flags[i];
+				break;
+			}
+		}
+
+		if (!create_dlg_flag_names[i].s) {
+			LM_ERR("Unknown create_dialog flag: %.*s\n",
+				rec->s.len, rec->s.s);
+			free_csv_record(list);
+			return -1;
+		}
+	}
+
+	free_csv_record(list);
+	*param = (void *)(unsigned long)flags;
+	return 0;
+}
+
 
 static int create_dialog_wrapper(struct sip_msg *req,int flags)
 {
@@ -1008,12 +1068,12 @@ static void mod_destroy(void)
 }
 
 
-static int w_create_dialog(struct sip_msg *req, str *flags_str)
+static int w_create_dialog(struct sip_msg *req, void *flags_param)
 {
 	struct cell *t;
-	int flags;
+	unsigned int flags;
 
-	flags = flags_str? parse_create_dlg_flags(flags_str): 0;
+	flags = flags_param ? (unsigned int)(unsigned long)flags_param : 0;
 
 	/* don't allow both Re-INVITE and OPTIONS pinging */
 	if ((flags & (DLG_FLAG_PING_CALLER|DLG_FLAG_REINVITE_PING_CALLER)) ==

modules/dialog/dlg_hash.h

@@ -349,54 +349,6 @@ void destroy_dlg(struct dlg_cell *dlg);
 		}\
 	}while(0)
 
-/*
- * @input - str
- * @return - integer flag bitmask
- */
-#define parse_create_dlg_flags(input) \
-	({ \
-		char *___p; \
-		int ___flags = 0; \
-		for (___p=(input)->s; ___p < (input)->s + (input)->len; ___p++) \
-		{ \
-			switch (*___p) \
-			{ \
-				case 'P': \
-					___flags |= DLG_FLAG_PING_CALLER; \
-					LM_DBG("will ping caller\n"); \
-					break; \
-				case 'p': \
-					___flags |= DLG_FLAG_PING_CALLEE; \
-					LM_DBG("will ping callee\n"); \
-					break; \
-				case 'B': \
-					___flags |= DLG_FLAG_BYEONTIMEOUT; \
-					LM_DBG("bye on timeout activated\n"); \
-					break; \
-				case 'R': \
-					___flags |= DLG_FLAG_REINVITE_PING_CALLER; \
-					LM_DBG("re-invite ping caller activated\n"); \
-					break; \
-				case 'r': \
-					___flags |= DLG_FLAG_REINVITE_PING_CALLEE; \
-					LM_DBG("re-invite ping callee activated\n"); \
-					break; \
-				case 'E': \
-					___flags |= DLG_FLAG_END_ON_RACE_CONDITION; \
-					LM_DBG("ending call on 200OK race conditions \n"); \
-					break; \
-				case 'L': \
-					___flags |= DLG_FLAG_AUTOPRACK; \
-					LM_DBG("auto-PRACK for reliable provisional replies activated\n"); \
-					break; \
-				default: \
-					LM_DBG("unknown create_dialog flag : [%c] ." \
-						   "Skipping\n", *___p); \
-			} \
-		} \
-		___flags; \
-	})
-
 int dialog_cleanup( struct sip_msg *msg, void *param );
 
 int init_dlg_table(unsigned int size);

modules/dialog/doc/dialog_admin.xml

@@ -1439,45 +1439,56 @@ modparam("dialog", "cluster_auto_sync", 0)
 		<itemizedlist>
 			<listitem><para>
 				<emphasis>flags (string, optional)</emphasis>
-				Possible values here are :
+				Possible values here are:
 				<itemizedlist>
 				<listitem><para>
-				B - Upon reaching dialog lifetime, BYEs will be triggered
-				both ways
+				<quote>bye-on-timeout</quote> - upon reaching dialog lifetime,
+				BYEs will be triggered both ways
 				</para></listitem>
 				<listitem><para>
-				P - Ping caller side with OPTIONS messages, once every
-				options_ping_interval seconds
+				<quote>options-ping-caller</quote> - ping caller side with
+				OPTIONS messages, once every
+				<varname>options_ping_interval</varname> seconds
 				</para></listitem>
 				<listitem><para>
-				p - Ping callee side with OPTIONS messages, once every
-				options_ping_interval seconds
+				<quote>options-ping-callee</quote> - ping callee side with
+				OPTIONS messages, once every
+				<varname>options_ping_interval</varname> seconds
 				</para></listitem>
 				<listitem><para>
-				R - Ping caller side with RE-INVITE messages, once every
-				reinvite_ping_interval seconds
+				<quote>reinvite-ping-caller</quote> - ping caller side with
+				RE-INVITE messages, once every
+				<varname>reinvite_ping_interval</varname> seconds
 				</para></listitem>
 				<listitem><para>
-				r - Ping callee side with RE-INVITE messages, once every
-				reinvite_ping_interval seconds
+				<quote>reinvite-ping-callee</quote> - ping callee side with
+				RE-INVITE messages, once every
+				<varname>reinvite_ping_interval</varname> seconds
 				</para></listitem>
 				<listitem><para>
-				E - Upon detecting a SIP Race condition (see RFC 5407),
-				end the call after race_condition_timeout seconds
+				<quote>end-on-race-condition</quote> - upon detecting a SIP
+				Race condition (see RFC 5407), end the call after
+				<varname>race_condition_timeout</varname> seconds
 				</para></listitem>
 				<listitem><para>
-				L - Automatically generate PRACK requests for reliable
-				101-199 provisional INVITE replies carrying an RSeq header
+				<quote>auto-prack</quote> - automatically generate PRACK
+				requests for reliable 101-199 provisional INVITE replies
+				carrying an RSeq header
 				</para></listitem>
 				</itemizedlist>
-				Multiple string flags can be used at the same time,
-				ie. passing "BPp" flags will enable all 3 flags.
+				Multiple string flags can be used at the same time as a CSV,
+				i.e. passing
+				<quote>bye-on-timeout,options-ping-caller,options-ping-callee</quote>
+				will enable all 3 flags.
 			</para></listitem>
 		</itemizedlist>
 		<para>
 		NOTE: both RE-INVITE and OPTIONS pinging cannot be enabled at the same time
-		for a single dialog leg. If both flags ("<emphasis>PR</emphasis>" or
-		"<emphasis>pr</emphasis>") are provided only RE-INVITE pinging will be used.
+		for a single dialog leg. If both flags for the same leg are provided
+		(for example
+		<quote>options-ping-caller,reinvite-ping-caller</quote> or
+		<quote>options-ping-callee,reinvite-ping-callee</quote>),
+		only RE-INVITE pinging will be used.
 		</para>
 		<para>
 		The function returns true if the dialog was successfully created or
@@ -1493,16 +1504,16 @@ modparam("dialog", "cluster_auto_sync", 0)
 create_dialog();
 ...
 #ping caller
-create_dialog("P");
+create_dialog("options-ping-caller");
 ...
 #ping caller and callee
-create_dialog("Pp");
+create_dialog("options-ping-caller,options-ping-callee");
 
 #bye on timeout
-create_dialog("B");
+create_dialog("bye-on-timeout");
 
 #auto-PRACK reliable provisional replies
-create_dialog("L");
+create_dialog("auto-prack");
 ...
 </programlisting>
 		</example>