Fix #6919: add token to ADT, parsing, serialization

Author: avernet

form-runner/shared/src/main/scala/org/orbeon/oxf/fr/email/EmailMetadata.scala

@@ -75,15 +75,15 @@ object EmailMetadata {
   object Param extends Enum[Param] {
     case class ControlValueParam     (name: String, controlName: String) extends Param
     case class ExpressionParam       (name: String, expression : String) extends Param
-    case class AllControlValuesParam (name: String)                      extends Param
-    case class LinkToEditPageParam   (name: String)                      extends Param
-    case class LinkToViewPageParam   (name: String)                      extends Param
-    case class LinkToNewPageParam    (name: String)                      extends Param
-    case class LinkToSummaryPageParam(name: String)                      extends Param
-    case class LinkToHomePageParam   (name: String)                      extends Param
-    case class LinkToFormsPageParam  (name: String)                      extends Param
-    case class LinkToAdminPageParam  (name: String)                      extends Param
-    case class LinkToPdfParam        (name: String)                      extends Param
+    case class AllControlValuesParam (name: String                     ) extends Param
+    case class LinkToEditPageParam   (name: String, token: Boolean     ) extends Param
+    case class LinkToViewPageParam   (name: String, token: Boolean     ) extends Param
+    case class LinkToNewPageParam    (name: String                     ) extends Param
+    case class LinkToSummaryPageParam(name: String                     ) extends Param
+    case class LinkToHomePageParam   (name: String                     ) extends Param
+    case class LinkToFormsPageParam  (name: String                     ) extends Param
+    case class LinkToAdminPageParam  (name: String                     ) extends Param
+    case class LinkToPdfParam        (name: String, token: Boolean     ) extends Param
     override def values: immutable.IndexedSeq[Param] = super.findValues
   }
 

form-runner/shared/src/main/scala/org/orbeon/oxf/fr/email/EmailMetadataConversion.scala

@@ -59,14 +59,14 @@ object EmailMetadataConversion {
                 case p @ EmailMetadata.Param.ControlValueParam     (_, _) => p.copy(name = newName)
                 case p @ EmailMetadata.Param.ExpressionParam       (_, _) => p.copy(name = newName)
                 case p @ EmailMetadata.Param.AllControlValuesParam (_)    => p.copy(name = newName)
-                case p @ EmailMetadata.Param.LinkToEditPageParam   (_)    => p.copy(name = newName)
-                case p @ EmailMetadata.Param.LinkToViewPageParam   (_)    => p.copy(name = newName)
+                case p @ EmailMetadata.Param.LinkToEditPageParam   (_, _) => p.copy(name = newName)
+                case p @ EmailMetadata.Param.LinkToViewPageParam   (_, _) => p.copy(name = newName)
                 case p @ EmailMetadata.Param.LinkToNewPageParam    (_)    => p.copy(name = newName)
                 case p @ EmailMetadata.Param.LinkToSummaryPageParam(_)    => p.copy(name = newName)
                 case p @ EmailMetadata.Param.LinkToHomePageParam   (_)    => p.copy(name = newName)
                 case p @ EmailMetadata.Param.LinkToFormsPageParam  (_)    => p.copy(name = newName)
                 case p @ EmailMetadata.Param.LinkToAdminPageParam  (_)    => p.copy(name = newName)
-                case p @ EmailMetadata.Param.LinkToPdfParam        (_)    => p.copy(name = newName)
+                case p @ EmailMetadata.Param.LinkToPdfParam        (_, _) => p.copy(name = newName)
               }
             } else
               param

form-runner/shared/src/main/scala/org/orbeon/oxf/fr/email/EmailMetadataParsing.scala

@@ -219,18 +219,20 @@ object EmailMetadataParsing {
     val paramTypeSource = paramNodeInfo.attValue("type")
     // Fix possible incorrect serialization on migration, done between 2022.1 and 2022.1.4 (fixed in 2022.1.5 per #5923)
     val paramTypeFixed  = paramTypeSource.split("\\(")(0)
+    def hasToken        = paramNodeInfo.child("token").exists(_.stringValue == "true")
+
     paramTypeFixed match {
       case "ControlValueParam"      => EmailMetadata.Param.ControlValueParam     (name, paramNodeInfo.child("controlName").stringValue)
       case "ExpressionParam"        => EmailMetadata.Param.ExpressionParam       (name, paramNodeInfo.child("expr"       ).stringValue)
       case "AllControlValuesParam"  => EmailMetadata.Param.AllControlValuesParam (name)
-      case "LinkToEditPageParam"    => EmailMetadata.Param.LinkToEditPageParam   (name)
-      case "LinkToViewPageParam"    => EmailMetadata.Param.LinkToViewPageParam   (name)
+      case "LinkToEditPageParam"    => EmailMetadata.Param.LinkToEditPageParam   (name, hasToken)
+      case "LinkToViewPageParam"    => EmailMetadata.Param.LinkToViewPageParam   (name, hasToken)
       case "LinkToNewPageParam"     => EmailMetadata.Param.LinkToNewPageParam    (name)
       case "LinkToSummaryPageParam" => EmailMetadata.Param.LinkToSummaryPageParam(name)
       case "LinkToHomePageParam"    => EmailMetadata.Param.LinkToHomePageParam   (name)
       case "LinkToFormsPageParam"   => EmailMetadata.Param.LinkToFormsPageParam  (name)
       case "LinkToAdminPageParam"   => EmailMetadata.Param.LinkToAdminPageParam  (name)
-      case "LinkToPdfParam"         => EmailMetadata.Param.LinkToPdfParam        (name)
+      case "LinkToPdfParam"         => EmailMetadata.Param.LinkToPdfParam        (name, hasToken)
     }
   }
 

form-runner/shared/src/main/scala/org/orbeon/oxf/fr/email/EmailMetadataSerialization.scala

@@ -132,6 +132,9 @@ object EmailMetadataSerialization {
             NodeInfoFactory.elementInfo  (QName("expr"), List(StringValue.makeStringValue(expression))),
           )
         )
+      case EmailMetadata.Param.LinkToEditPageParam(name, token) => serializeParamWithToken(param.entryName, name, token)
+      case EmailMetadata.Param.LinkToViewPageParam(name, token) => serializeParamWithToken(param.entryName, name, token)
+      case EmailMetadata.Param.LinkToPdfParam     (name, token) => serializeParamWithToken(param.entryName, name, token)
       case _ =>
         NodeInfoFactory.elementInfo(
           QName("param"),
@@ -141,4 +144,15 @@ object EmailMetadataSerialization {
           )
         )
     }
+
+  private def serializeParamWithToken(paramType: String, name: String, token: Boolean): NodeInfo =
+    NodeInfoFactory.elementInfo(
+      QName("param"),
+      List(
+        NodeInfoFactory.attributeInfo(QName("type"), paramType),
+        NodeInfoFactory.elementInfo  (QName("name"), List(StringValue.makeStringValue(name))),
+      ) ::: (if (token)
+             List(NodeInfoFactory.elementInfo(QName("token"), List(StringValue.makeStringValue("true"))))
+             else Nil)
+    )
 }