Merge pull request #3084 from rrb3942/dialog_profile_remove_all

Add options to set_dlg_profile and unset_dlg_profile to remove all values on a profile

Author: liviuchircu

modules/dialog/dialog.c

@@ -123,7 +123,7 @@ 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*);
 static int w_fix_route_dialog(struct sip_msg*);
-static int w_set_dlg_profile(struct sip_msg *msg, str *prof_name, str *value);
+static int w_set_dlg_profile(struct sip_msg *msg, str *prof_name, str *value, int *clear_values);
 static int w_unset_dlg_profile(struct sip_msg *msg, str *prof_name, str *value);
 static int w_is_in_profile(struct sip_msg *msg, str *prof_name, str *value);
 static int w_get_profile_size(struct sip_msg *msg, str *prof_name,
@@ -189,7 +189,8 @@ static const cmd_export_t cmds[]={
 		REQUEST_ROUTE},
 	{"set_dlg_profile", (cmd_function)w_set_dlg_profile, {
 		{CMD_PARAM_STR,0,0},
-		{CMD_PARAM_STR|CMD_PARAM_OPT,0,0}, {0,0,0}},
+		{CMD_PARAM_STR|CMD_PARAM_OPT,0,0},
+		{CMD_PARAM_INT|CMD_PARAM_OPT,0,0}, {0,0,0}},
 		REQUEST_ROUTE| FAILURE_ROUTE | ONREPLY_ROUTE | BRANCH_ROUTE},
 	{"unset_dlg_profile", (cmd_function)w_unset_dlg_profile, {
 		{CMD_PARAM_STR,0,0},
@@ -1135,7 +1136,7 @@ static int w_fix_route_dialog(struct sip_msg *req)
 }
 
 
-static int w_set_dlg_profile(struct sip_msg *msg, str *prof_name, str *value)
+static int w_set_dlg_profile(struct sip_msg *msg, str *prof_name, str *value, int *clear_values)
 {
 	struct dlg_cell *dlg;
 	struct dlg_profile_table *profile;
@@ -1156,6 +1157,14 @@ static int w_set_dlg_profile(struct sip_msg *msg, str *prof_name, str *value)
 			LM_WARN("missing value\n");
 			return -1;	
 		}
+
+		if (clear_values && *clear_values) {
+			if (unset_dlg_profile_all_values(dlg, profile) < 0) {
+				LM_DBG("dialog not found in profile %.*s\n",
+				       prof_name->len, prof_name->s);
+			}
+		}
+
 		if ( set_dlg_profile( dlg, value, profile, 0) < 0 ) {
 			LM_ERR("failed to set profile\n");
 			return -1;
@@ -1188,10 +1197,12 @@ static int w_unset_dlg_profile(struct sip_msg *msg, str *prof_name, str *value)
 
 	if (profile->has_value) {
 		if (!value) {
-			LM_WARN("missing value\n");
-			return -1;
-		}
-		if ( unset_dlg_profile( dlg, value, profile) < 0 ) {
+			if (unset_dlg_profile_all_values(dlg, profile) < 0) {
+				LM_DBG("dialog not found in profile %.*s\n",
+						prof_name->len, prof_name->s);
+				return -1;
+			}
+		} else if (unset_dlg_profile( dlg, value, profile) < 0) {
 			LM_WARN("dialog not found in profile %.*s with value %.*s\n",
 					prof_name->len, prof_name->s, value->len, value->s);
 			return -1;

modules/dialog/dlg_profile.c

@@ -954,6 +954,65 @@ int unset_dlg_profile(struct dlg_cell *dlg, str *value,
 	return 1;
 }
 
+/*Unset all values set for a dialog on a profile*/
+int unset_dlg_profile_all_values(struct dlg_cell *dlg, struct dlg_profile_table *profile)
+{
+	struct dlg_profile_link *linker;
+	struct dlg_profile_link *linker_prev;
+	struct dlg_entry *d_entry;
+	int found = -1;
+
+	/* get current dialog */
+	if (dlg==NULL) {
+		LM_ERR("dialog was not yet created - script error\n");
+		return -1;
+	}
+
+	/* check the dialog linkers */
+	d_entry = &d_table->entries[dlg->h_entry];
+	/* lock dialog (if not already locked via a callback triggering)*/
+	if (dlg->locked_by!=process_no)
+		dlg_lock( d_table, d_entry);
+
+	linker = dlg->profile_links;
+	linker_prev = NULL;
+	while (linker) {
+		if (linker->profile==profile) {
+			found = 1;
+
+			/* Take the linker to remove and advance linker for next iter */
+			struct dlg_profile_link *tmp = linker;
+			linker = linker->next;
+
+			/* Fixup list integrity */
+			if (linker_prev == NULL) {
+				dlg->profile_links = linker;
+			} else {
+				linker_prev->next = linker;
+			}
+
+			/* Dealloc linker */
+			dlg->flags |= DLG_FLAG_VP_CHANGED;
+			destroy_linker(tmp, dlg, 1);
+			shm_free(tmp);
+
+			if (profile->has_value==0) {
+				break;
+			}
+
+			/* keep searching to remove all instances */
+			continue;
+		}
+
+		linker_prev = linker;
+		linker = linker->next;
+	}
+
+	if (dlg->locked_by!=process_no)
+		dlg_unlock( d_table, d_entry);
+
+	return found;
+}
 
 int is_dlg_in_profile(struct dlg_cell *dlg, struct dlg_profile_table *profile,
 																str *value)

modules/dialog/dlg_profile.h

@@ -118,6 +118,8 @@ int set_dlg_profile(struct dlg_cell *dlg, str *value,
 int unset_dlg_profile(struct dlg_cell *dlg, str *value,
 		struct dlg_profile_table *profile);
 
+int unset_dlg_profile_all_values(struct dlg_cell *dlg, struct dlg_profile_table *profile);
+
 int is_dlg_in_profile(struct dlg_cell *dlg, struct dlg_profile_table *profile,
 		str *value);
 

modules/dialog/doc/dialog_admin.xml

@@ -1951,7 +1951,7 @@ if (load_dialog_ctx("$var(callid)")) {
 
 	<section id="func_set_dlg_profile" xreflabel="set_dlg_profile()">
 		<title>
-		<function moreinfo="none">set_dlg_profile(profile,[value])</function>
+		<function moreinfo="none">set_dlg_profile(profile, [value], [clear_values])</function>
 		</title>
 		<para>
 		Inserts the current dialog into a profile. Note that if the profile does
@@ -1975,6 +1975,12 @@ if (load_dialog_ctx("$var(callid)")) {
 			profile must support values.
 			</para>
 		</listitem>
+		<listitem>
+			<para><emphasis>clear_values (boolean, optional)</emphasis> - if set to
+				<emphasis>true</emphasis> (1), all values of the profile will be cleared
+				before setting the given value.  Default: <emphasis>false</emphasis>.
+			</para>
+		</listitem>
 		</itemizedlist>
 		<para>
 		This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
@@ -1985,7 +1991,12 @@ if (load_dialog_ctx("$var(callid)")) {
 		<programlisting format="linespecific">
 ...
 set_dlg_profile("inboundCall");
-set_dlg_profile("caller",$fu);
+
+# Set a new value (all other values are kept intact)
+set_dlg_profile("caller", $fu);
+
+# Set a new value while removing all previous values
+set_dlg_profile("caller", $fu, true);
 ...
 </programlisting>
 		</example>
@@ -1994,7 +2005,7 @@ set_dlg_profile("caller",$fu);
 
 	<section id="func_unset_dlg_profile" xreflabel="unset_dlg_profile()">
 		<title>
-		<function moreinfo="none">unset_dlg_profile(profile,[value])</function>
+		<function moreinfo="none">unset_dlg_profile(profile, [value])</function>
 		</title>
 		<para>
 		Removes the current dialog from a profile.
@@ -2015,6 +2026,9 @@ set_dlg_profile("caller",$fu);
 			define the belonging of the dialog to the profile - note that the
 			profile must support values.
 			</para>
+			<para>NEW in 3.4: for profiles with value, by omitting this parameter
+				you can now clear all values of the given profile.
+			</para>
 		</listitem>
 		</itemizedlist>
 		<para>
@@ -2026,7 +2040,10 @@ set_dlg_profile("caller",$fu);
 		<programlisting format="linespecific">
 ...
 unset_dlg_profile("inboundCall");
-unset_dlg_profile("caller",$fu);
+unset_dlg_profile("caller", $fu);
+...
+# Remove all values in a profile
+unset_dlg_profile("caller");
 ...
 </programlisting>
 		</example>