allow index in addition to path

Author: alandekok

doc/antora/modules/reference/pages/unlang/foreach.adoc

@@ -96,9 +96,9 @@ loop over each i in attribute[0..n]
 
 Using a key variable allows the loop to determine exactly which attribute is being modified.  Or for dynamic expansions, which of `0..n` values are being examined.
 
-For attributes, the `<key-type>` must be `string`.  For dynamic expansions, it must be a numerical type such as `uint32`.
+For attributes, the `<key-type>` must be `string` or `uint32`.  For dynamic expansions, it must be a numerical type such as `uint32`.
 
-.Key variable with attribute
+.Key variable with attribute reference
 [source,unlang]
 ----
 string total
@@ -118,6 +118,18 @@ When the loop is finished, the `total` variable will have the following value:
 "Tmp-Integer-0[0] = 1, "Tmp-Integer-0[1] = 3, "Tmp-Integer-0[2] = 5, "Tmp-Integer-0[3] = 11, "
 ----
 
+.Key variable with attribute index
+[source,unlang]
+----
+string total
+Tmp-Integer-0 := { 1, 3, 5, 11 }
+
+foreach uint32 index, uint32 self (Tmp-Integer-0) {
+	...
+}
+----
+
+
 A dynamic expansion can use a keyed index.  If the `SELECT` statement below returns a list of `"a", "b", "c", "d"`. then we have the following example:
 
 .Key variable with expansion

src/lib/unlang/compile.c

@@ -3355,8 +3355,8 @@ static unlang_t *compile_foreach(unlang_t *parent, unlang_compile_t *unlang_ctx,
 	} else {
 		fr_assert(tmpl_is_attr(vpt));
 
-		if ((key_type != FR_TYPE_VOID) && (key_type != FR_TYPE_STRING)) {
-			cf_log_err(cs, "Invalid data type '%s' for 'key' variable - it should be 'string'", fr_type_to_str(key_type));
+		if ((key_type != FR_TYPE_VOID) && (key_type != FR_TYPE_STRING) && (key_type != FR_TYPE_UINT32)) {
+			cf_log_err(cs, "Invalid data type '%s' for 'key' variable - it should be 'string' or 'uint32'", fr_type_to_str(key_type));
 			return NULL;
 		}
 	}

src/lib/unlang/foreach.c

@@ -342,9 +342,22 @@ static void unlang_foreach_attr_key_update(UNUSED request_t *request, unlang_fra
 {
 	if (!state->key) return;
 
-	fr_value_box_clear_value(&state->key->data);
-	if (tmpl_dcursor_print(&FR_SBUFF_IN(state->buffer, BUFFER_SIZE), &state->cc) > 0) {
-		fr_value_box_strdup(state->key, &state->key->data, NULL, state->buffer, false);
+	switch (state->key->vp_type) {
+	case FR_TYPE_UINT32:
+		state->key->vp_uint32++;
+		break;
+
+	case FR_TYPE_STRING:
+		fr_value_box_clear_value(&state->key->data);
+		if (tmpl_dcursor_print(&FR_SBUFF_IN(state->buffer, BUFFER_SIZE), &state->cc) > 0) {
+			fr_value_box_strdup(state->key, &state->key->data, NULL, state->buffer, false);
+		}
+		break;		
+
+	default:
+		fr_assert(0);
+		break;
+
 	}
 }
 
@@ -474,9 +487,9 @@ static unlang_action_t unlang_foreach_attr_init(rlm_rcode_t *p_result, request_t
 	fr_assert(vp != NULL);
 
 	/*
-	 *	Update the key with the current path or index.
+	 *	Update the key with the current path.  Attribute indexes start at zero.
 	 */
-	unlang_foreach_attr_key_update(request, state);
+	if (state->key->vp_type == FR_TYPE_STRING) unlang_foreach_attr_key_update(request, state);
 
 	if (vp->vp_type == FR_TYPE_GROUP) {
 		fr_assert(state->value->vp_type == FR_TYPE_GROUP);

src/tests/keywords/foreach-key-index

@@ -0,0 +1,20 @@
+#
+#  PRE: foreach-key-ref
+#
+string total
+
+Tmp-String-0 := { "a", "b", "c", "d" }
+
+#
+#  Ensure that attributes can be referenced, and
+#  that the count is correct.
+#
+foreach uint32 index, string value (Tmp-String-0[*]) {
+	total += Tmp-String-0[index]
+}
+
+if (total != "abcd") {
+	test_fail
+}
+
+success