update dialplan module for pcre2

(cherry picked from commit c58e3af)

Author: Steve Ayre

modules/dialplan/Makefile

@@ -10,21 +10,21 @@ NAME=dialplan.so
 
 ifeq ($(CROSS_COMPILE),)
 PCRE_BUILDER = $(shell \
-	if which pcre-config >/dev/null 2>/dev/null; then \
-		echo 'pcre-config'; \
-	elif pkg-config --exists libcre; then \
-		echo 'pkg-config libpcre'; \
+	if which pcre2-config >/dev/null 2>/dev/null; then \
+		echo 'pcre2-config'; \
+	elif pkg-config --exists libpcre2-8; then \
+		echo 'pkg-config libpcre2-8'; \
 	fi)
 endif
 
 ifeq ($(PCRE_BUILDER),)
 	DEFS += -I$(SYSBASE)/include \
 			-I$(LOCALBASE)/include
 	LIBS += -L$(SYSBASE)/lib \
-			-L$(LOCALBASE)/lib -lpcre
+			-L$(LOCALBASE)/lib -lpcre2-8
 else
 	DEFS += $(shell $(PCRE_BUILDER) --cflags)
-	LIBS += $(shell $(PCRE_BUILDER) --libs)
+	LIBS += $(shell $(PCRE_BUILDER) --libs8)
 endif
 
 include ../../Makefile.modules

modules/dialplan/README

@@ -243,7 +243,7 @@ Chapter 1. Admin Guide
 
    The following libraries or applications must be installed
    before running OpenSIPS with this module loaded:
-     * libpcre-dev - the development libraries of PCRE.
+     * libpcre2-dev - the development libraries of PCRE.
 
 1.6. Exported Parameters
 

modules/dialplan/dialplan.c

@@ -869,51 +869,61 @@ static mi_response_t *mi_translate3(const mi_params_t *params,
 }
 
 
-void * wrap_shm_malloc(size_t size)
+void * wrap_shm_malloc(PCRE2_SIZE size, void * memory_data)
 {
+	UNUSED(memory_data);
 	return shm_malloc(size);
 }
 
-void  wrap_shm_free(void * p )
+void wrap_shm_free(void * p, void * memory_data)
 {
+	UNUSED(memory_data);
 	shm_free(p);
 }
 
-
-pcre * wrap_pcre_compile(char *  pattern, int flags)
+pcre2_code * wrap_pcre_compile(char *  pattern, int flags)
 {
-		pcre * ret ;
-		func_malloc old_malloc ;
-		func_free old_free;
-		const char * error;
-		int erroffset;
-		int pcre_flags = 0;
-
-
-		old_malloc = pcre_malloc;
-		old_free = pcre_free;
-
-		pcre_malloc = wrap_shm_malloc;
-		pcre_free = wrap_shm_free;
-
-		if (flags & DP_CASE_INSENSITIVE)
-			pcre_flags |= PCRE_CASELESS;
-
-		ret = pcre_compile(
-				pattern,			/* the pattern */
-				pcre_flags,			/* default options */
-				&error,				/* for error message */
-				&erroffset,			/* for error offset */
-				NULL);
-
-		pcre_malloc = old_malloc;
-		pcre_free = old_free;
-
-		return ret;
+	pcre2_general_context *gcontext;
+	pcre2_compile_context *ccontext;
+	pcre2_code * ret ;
+	int error;
+	PCRE2_SIZE erroffset;
+	int pcre_flags = 0;
+
+	// TODO generate once per worker
+	gcontext = pcre2_general_context_create(wrap_shm_malloc, wrap_shm_free, NULL);
+	if (!gcontext) {
+		LM_ERR("Unable to create pcre general context\n");
+		return NULL;
+	}
+
+	// TODO generate once per worker
+	ccontext = pcre2_compile_context_create(gcontext);
+	if (!ccontext) {
+		LM_ERR("Unable to create pcre compile context\n");
+		pcre2_general_context_free(gcontext);
+		return NULL;
+	}
+
+	if (flags & DP_CASE_INSENSITIVE)
+		pcre_flags |= PCRE2_CASELESS;
+
+	ret = pcre2_compile(
+			(PCRE2_SPTR)pattern,		/* the pattern */
+			PCRE2_ZERO_TERMINATED,
+			pcre_flags,			/* default options */
+			&error,				/* for error message */
+			&erroffset,			/* for error offset */
+			ccontext);                      /* compile context, to allocate memory in shm */
+
+	pcre2_compile_context_free(ccontext);
+	pcre2_general_context_free(gcontext);
+
+	return ret;
 }
 
-void wrap_pcre_free( pcre* re)
+void wrap_pcre_free( pcre2_code* re)
 {
+	// TODO pcre2_code_free
 	shm_free(re);
-
 }

modules/dialplan/dialplan.h

@@ -49,7 +49,7 @@ typedef struct dpl_node{
 	int matchop;
 	int match_flags;
 	str match_exp, subst_exp, repl_exp; /*keeping the original strings*/
-	pcre * match_comp, * subst_comp; /*compiled patterns*/
+	pcre2_code * match_comp, * subst_comp; /*compiled patterns*/
 	struct subst_expr * repl_comp;
 	str attrs;
 	str timerec;
@@ -122,19 +122,11 @@ struct subst_expr* repl_exp_parse(str subst);
 void repl_expr_free(struct subst_expr *se);
 int translate(struct sip_msg *msg, str user_name, str* repl_user, dpl_id_p idp, str *);
 int rule_translate(struct sip_msg *msg, str , dpl_node_t * rule,  str *);
-int test_match(str string, pcre * exp, int * out, int out_max);
+int test_match(str string, pcre2_code * exp, int * out, int out_max);
 
 
-typedef void * (*func_malloc)(size_t );
-typedef void  (*func_free)(void * );
-
-void * wrap_shm_malloc(size_t size);
-void  wrap_shm_free(void *);
-
-
-pcre * wrap_pcre_compile(char *  pattern, int flags);
-void wrap_pcre_free( pcre*);
-
+pcre2_code * wrap_pcre_compile(char *  pattern, int flags);
+void wrap_pcre_free( pcre2_code*);
 
 extern rw_lock_t *ref_lock;
 extern str dp_df_part;

modules/dialplan/dp_db.c

@@ -467,12 +467,12 @@ int str_to_shm(str src, str * dest)
 dpl_node_t * build_rule(db_val_t * values)
 {
 	tmrec_expr *parsed_timerec;
-	pcre * match_comp, *subst_comp;
+	pcre2_code * match_comp, *subst_comp;
 	struct subst_expr * repl_comp;
 	dpl_node_t * new_rule;
 	str match_exp, subst_exp, repl_exp, attrs, timerec;
 	int matchop;
-	int namecount;
+	uint32_t namecount;
 
 	matchop = VAL_INT(values+2);
 
@@ -524,10 +524,9 @@ dpl_node_t * build_rule(db_val_t * values)
 		}
 	}
 
-	pcre_fullinfo(
+	pcre2_pattern_info(
 		subst_comp, /* the compiled pattern */
-		NULL, /* no extra data - we didn't study the pattern */
-		PCRE_INFO_CAPTURECOUNT, /* number of named substrings */
+		PCRE2_INFO_CAPTURECOUNT, /* number of named substrings */
 		&namecount); /* where to put the answer */
 
 	LM_DBG("references:%d , max:%d\n",namecount,

modules/dialplan/dp_repl.c

@@ -110,11 +110,11 @@ int rule_translate(struct sip_msg *msg, str string, dpl_node_t * rule,
 {
 	int repl_nb, offset, match_nb;
 	struct replace_with token;
-	pcre * subst_comp;
+	pcre2_code * subst_comp;
 	struct subst_expr * repl_comp;
 	pv_value_t sv;
 	str* uri;
-	int capturecount;
+	uint32_t capturecount;
 	char *match_begin;
 	int match_len;
 
@@ -133,11 +133,10 @@ int rule_translate(struct sip_msg *msg, str string, dpl_node_t * rule,
 
 	if(subst_comp){
 
-		pcre_fullinfo(
-		subst_comp,                   /* the compiled pattern */
-		NULL,                 /* no extra data - we didn't study the pattern */
-		PCRE_INFO_CAPTURECOUNT ,  /* number of named substrings */
-		&capturecount);          /* where to put the answer */
+		pcre2_pattern_info(
+			subst_comp,              /* the compiled pattern */
+			PCRE2_INFO_CAPTURECOUNT, /* number of named substrings */
+			&capturecount);          /* where to put the answer */
 
 
 		/*just in case something went wrong at load time*/
@@ -397,11 +396,13 @@ int translate(struct sip_msg *msg, str input, str * output, dpl_id_p idp, str *
 }
 
 
-int test_match(str string, pcre * exp, int * out, int out_max)
+int test_match(str string, pcre2_code * exp, int * out, int out_max)
 {
 	int i, result_count;
 	char *substring_start;
 	int substring_length;
+	pcre2_match_data *match_data;
+	PCRE2_SIZE *ovector;
 	UNUSED(substring_start);
 	UNUSED(substring_length);
 
@@ -410,34 +411,50 @@ int test_match(str string, pcre * exp, int * out, int out_max)
 		return -1;
 	}
 
-	result_count = pcre_exec(
-							exp, /* the compiled pattern */
-							NULL, /* no extra data - we didn't study the pattern */
-							string.s, /* the subject string */
-							string.len, /* the length of the subject */
-							0, /* start at offset 0 in the subject */
-							0, /* default options */
-							out, /* output vector for substring information */
-							out_max); /* number of elements in the output vector */
-
-	if( result_count < 0 )
-		return result_count;
+	match_data = pcre2_match_data_create_from_pattern(exp, NULL);
+	if (!match_data) {
+		LM_ERR("failed to allocate match data\n");
+		return -1;
+	}
 
-	if( result_count == 0)
+	result_count = pcre2_match(
+		exp, /* the compiled pattern */
+		(PCRE2_SPTR)string.s, /* the subject string */
+		(PCRE2_SIZE)string.len, /* the length of the subject */
+		0, /* start at offset 0 in the subject */
+		0, /* default options */
+		match_data, /* match data block */
+		NULL); /* match context */
+
+	if (result_count < 0)
 	{
-		LM_ERR("Not enough space for mathing\n");
+		pcre2_match_data_free(match_data);
 		return result_count;
 	}
 
+	if (result_count == 0)
+	{
+		LM_ERR("Not enough space for matching\n");
+		pcre2_match_data_free(match_data);
+		return result_count;
+	}
 
+	ovector = pcre2_get_ovector_pointer(match_data);
 	for (i = 0; i < result_count; i++)
 	{
+		// avoid buffer overflow
+		if (i >= out_max)
+			break;
+
+		// ovector is freed by pcre2_match_data_free, copy offsets to out[]
+		out[i] = ovector[i];
+
 		substring_start = string.s + out[2 * i];
 		substring_length = out[2 * i + 1] - out[2 * i];
 		LM_DBG("test_match:[%d] %.*s\n",i, substring_length, substring_start);
 	}
 
-
+	pcre2_match_data_free(match_data);
 	return result_count;
 }