Migrate to renderGridCellContents(RenderContext, HtmlWriter) (#821)

labkey-adam · web-flow · commit 7b416aace270 · 2025-05-23T10:14:49.000-07:00
diff --git a/WNPRC_EHR/src/org/labkey/wnprc_ehr/table/WNPRC_EHRCustomizer.java b/WNPRC_EHR/src/org/labkey/wnprc_ehr/table/WNPRC_EHRCustomizer.java
@@ -15,8 +15,8 @@
  */
 package org.labkey.wnprc_ehr.table;
 
-import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.jetbrains.annotations.NotNull;
 import org.labkey.api.data.AbstractTableInfo;
 import org.labkey.api.data.BaseColumnInfo;
@@ -51,24 +51,16 @@
 import org.labkey.api.util.HtmlString;
 import org.labkey.api.util.HtmlStringBuilder;
 import org.labkey.api.util.LinkBuilder;
-import org.labkey.api.util.PageFlowUtil;
 import org.labkey.api.util.StringExpressionFactory;
 import org.labkey.api.view.ActionURL;
 import org.labkey.api.writer.HtmlWriter;
 import org.labkey.dbutils.api.SimplerFilter;
 import org.labkey.wnprc_ehr.security.permissions.WNPRCAnimalRequestsEditPermission;
 import org.labkey.wnprc_ehr.security.permissions.WNPRCAnimalRequestsViewPermission;
 
-import java.io.IOException;
-import java.io.Writer;
 import java.util.ArrayList;
 import java.util.List;
 
-/**
- * User: bimber
- * Date: 12/7/12
- * Time: 2:22 PM
- */
 public class WNPRC_EHRCustomizer extends AbstractTableCustomizer
 {
     protected static final Logger _log = LogManager.getLogger(WNPRC_EHRCustomizer.class);
@@ -976,27 +968,23 @@ private void customizeSireIdColumn(AbstractTableInfo ti) {
                 sireid.setDisplayColumnFactory(colInfo -> new DataColumn(colInfo){
 
                     @Override
-                    public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+                    public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
                     {
                         ActionURL url = new ActionURL("ehr", "participantView.view", us.getContainer());
                         String joinedIds = (String)ctx.get(new FieldKey(getBoundColumn().getFieldKey().getParent(), "sireid"));
                         if (joinedIds != null)
                         {
                             String[] ids = joinedIds.split(",");
-                            String urlString = "";
                             for (int i = 0; i < ids.length; i++)
                             {
                                 String id = ids[i];
                                 url.replaceParameter("participantId", id);
-                                urlString += "<a href=\"" + PageFlowUtil.filter(url) + "\">";
-                                urlString += PageFlowUtil.filter(id);
-                                urlString += "</a>";
+                                out.write(LinkBuilder.simpleLink(id, url));
                                 if (i + 1 < ids.length)
                                 {
-                                    urlString += ", ";
+                                    out.write(", ");
                                 }
                             }
-                            oldWriter.write(urlString);
                         }
                     }
 
@@ -1020,7 +1008,7 @@ private void customizeReasonForMoveColumn(AbstractTableInfo ti) {
                 reason.setDisplayColumnFactory(colInfo -> new DataColumn(colInfo){
 
                     @Override
-                    public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+                    public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
                     {
                         ActionURL url = new ActionURL("query", "recordDetails.view", us.getContainer());
                         String joinedReasons = (String)ctx.get(new FieldKey(getBoundColumn().getFieldKey().getParent(), "reason"));
@@ -1031,7 +1019,6 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit
                             url.addParameter("query.queryName", "housing_reason");
                             url.addParameter("keyField", "value");
 
-                            StringBuilder urlString = new StringBuilder();
                             for (int i = 0; i < reasons.length; i++)
                             {
                                 String reasonForMoveValue = reasons[i];
@@ -1044,20 +1031,17 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit
                                 {
                                     reasonForMoveTitle = (String) ts.getMap().get("title");
                                     url.replaceParameter("key", reasonForMoveValue);
-                                    urlString.append("<a href=\"").append(PageFlowUtil.filter(url)).append("\">");
-                                    urlString.append(PageFlowUtil.filter(reasonForMoveTitle));
-                                    urlString.append("</a>");
+                                    out.write(LinkBuilder.simpleLink(reasonForMoveTitle, url));
                                 }
                                 else
                                 {
-                                    urlString.append(PageFlowUtil.filter("<" + reasonForMoveValue + ">"));
+                                    out.write("<" + reasonForMoveValue + ">");
                                 }
                                 if (i + 1 < reasons.length)
                                 {
-                                    urlString.append(", ");
+                                    out.write(", ");
                                 }
                             }
-                            oldWriter.write(urlString.toString());
                         }
                     }
 
diff --git a/WNPRC_Virology/src/org/labkey/wnprc_virology/table/WNPRC_VirologyCustomizer.java b/WNPRC_Virology/src/org/labkey/wnprc_virology/table/WNPRC_VirologyCustomizer.java
@@ -11,8 +11,7 @@
 import org.labkey.api.ldk.table.AbstractTableCustomizer;
 import org.labkey.api.writer.HtmlWriter;
 
-import java.io.IOException;
-import java.io.Writer;
+import static org.labkey.api.util.DOM.STRONG;
 
 public class WNPRC_VirologyCustomizer extends AbstractTableCustomizer
 {
@@ -63,26 +62,21 @@ public LLoDHtmlFormatDisplayColumn(ColumnInfo colInfo)
         }
 
         @Override
-        public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException
+        public void renderGridCellContents(RenderContext ctx, HtmlWriter out)
         {
 
-            StringBuilder htmlString = new StringBuilder();
             String llodCol = ctx.get("below_llod").toString();
-            if (llodCol.toString().contains("Yes"))
+            if (llodCol.contains("Yes"))
             {
                 int parenIdx = llodCol.indexOf("(");
                 String firstPart = llodCol.substring(0, parenIdx);
                 String lastPart = llodCol.substring(parenIdx);
-                htmlString.append("<strong>");
-                htmlString.append(firstPart);
-                htmlString.append("</strong>");
-                htmlString.append(lastPart);
-                oldWriter.write(htmlString.toString());
+                STRONG(firstPart).appendTo(out);
+                out.write(lastPart);
             }
             else
             {
-                htmlString.append(llodCol);
-                oldWriter.write(htmlString.toString());
+                out.write(llodCol);
             }
         }
     }
diff --git a/docker/labkey/application.properties b/docker/labkey/application.properties
@@ -136,52 +136,6 @@ management.server.port=8081
 #jsonaccesslog.condition-if=attributeName
 #jsonaccesslog.condition-unless=attributeName
 
-## Define one or both of 'csp.report' and 'csp.enforce' to enable Content Security Policy (CSP) headers
-## Do not use these examples for any production environment without understanding the meaning of each directive!
-
-## example usage 1 - very strict, disallows 'external' websites, disallows unsafe-inline, but only reports violations (does not enforce)
-
-#csp.report=\
-#    default-src 'self';\
-#    connect-src 'self' ${LABKEY.ALLOWED.CONNECTIONS} ;\
-#    object-src 'none' ;\
-#    style-src 'self' 'unsafe-inline' ;\
-#    img-src 'self' data: ;\
-#    font-src 'self' data: ;\
-#    script-src 'unsafe-eval' 'strict-dynamic' 'nonce-${REQUEST.SCRIPT.NONCE}';\
-#    base-uri 'self' ;\
-#    upgrade-insecure-requests ;\
-#    frame-ancestors 'self' ;\
-#    report-uri https://www.labkey.org/admin-contentsecuritypolicyreport.api?${CSP.REPORT.PARAMS} ;
-
-## example usage 2 - less strict but enforces directives, (NOTE: unsafe-inline is still required for many modules)
-
-#csp.enforce=\
-#    default-src 'self' https: ;\
-#    connect-src 'self' https: ${LABKEY.ALLOWED.CONNECTIONS};\
-#    object-src 'none' ;\
-#    style-src 'self' https: 'unsafe-inline' ;\
-#    img-src 'self' data: ;\
-#    font-src 'self' data: ;\
-#    script-src 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' 'nonce-${REQUEST.SCRIPT.NONCE}';\
-#    base-uri 'self' ;\
-#    upgrade-insecure-requests ;\
-#    frame-ancestors 'self' ;\
-#    report-uri  https://www.labkey.org/admin-contentsecuritypolicyreport.api?${CSP.REPORT.PARAMS} ;
-
-## Default CSP for TeamCity and dev deployments
-csp.report=\
-    default-src 'self' https: http: ;\
-    connect-src 'self' localhost:* ws: ${LABKEY.ALLOWED.CONNECTIONS} ;\
-    object-src 'none' ;\
-    style-src 'self' https: 'unsafe-inline' ;\
-    img-src 'self' https: data: ;\
-    font-src 'self' http: https: data: ;\
-    script-src 'unsafe-eval' 'strict-dynamic' 'nonce-${REQUEST.SCRIPT.NONCE}' ;\
-    base-uri 'self' ;\
-    frame-ancestors 'self' ;\
-    report-uri /admin-contentsecuritypolicyreport.api?${CSP.REPORT.PARAMS} ;
-
 ## Use a custom logging configuration
 #logging.config=path/to/alternative/log4j2.xml
 

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@`
`15`	`15`	`*/`
`16`	`16`	`package org.labkey.wnprc_ehr.table;`
`17`	`17`
`18`		`-import org.apache.logging.log4j.Logger;`
`19`	`18`	`import org.apache.logging.log4j.LogManager;`
	`19`	`+import org.apache.logging.log4j.Logger;`
`20`	`20`	`import org.jetbrains.annotations.NotNull;`
`21`	`21`	`import org.labkey.api.data.AbstractTableInfo;`
`22`	`22`	`import org.labkey.api.data.BaseColumnInfo;`
`@@ -51,24 +51,16 @@`
`51`	`51`	`import org.labkey.api.util.HtmlString;`
`52`	`52`	`import org.labkey.api.util.HtmlStringBuilder;`
`53`	`53`	`import org.labkey.api.util.LinkBuilder;`
`54`		`-import org.labkey.api.util.PageFlowUtil;`
`55`	`54`	`import org.labkey.api.util.StringExpressionFactory;`
`56`	`55`	`import org.labkey.api.view.ActionURL;`
`57`	`56`	`import org.labkey.api.writer.HtmlWriter;`
`58`	`57`	`import org.labkey.dbutils.api.SimplerFilter;`
`59`	`58`	`import org.labkey.wnprc_ehr.security.permissions.WNPRCAnimalRequestsEditPermission;`
`60`	`59`	`import org.labkey.wnprc_ehr.security.permissions.WNPRCAnimalRequestsViewPermission;`
`61`	`60`
`62`		`-import java.io.IOException;`
`63`		`-import java.io.Writer;`
`64`	`61`	`import java.util.ArrayList;`
`65`	`62`	`import java.util.List;`
`66`	`63`
`67`		`-/**`
`68`		`- * User: bimber`
`69`		`- * Date: 12/7/12`
`70`		`- * Time: 2:22 PM`
`71`		`- */`
`72`	`64`	`public class WNPRC_EHRCustomizer extends AbstractTableCustomizer`
`73`	`65`	`{`
`74`	`66`	`protected static final Logger _log = LogManager.getLogger(WNPRC_EHRCustomizer.class);`
`@@ -976,27 +968,23 @@ private void customizeSireIdColumn(AbstractTableInfo ti) {`
`976`	`968`	`sireid.setDisplayColumnFactory(colInfo -> new DataColumn(colInfo){`
`977`	`969`
`978`	`970`	`@Override`
`979`		`- public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException`
	`971`	`+ public void renderGridCellContents(RenderContext ctx, HtmlWriter out)`
`980`	`972`	`{`
`981`	`973`	`ActionURL url = new ActionURL("ehr", "participantView.view", us.getContainer());`
`982`	`974`	`String joinedIds = (String)ctx.get(new FieldKey(getBoundColumn().getFieldKey().getParent(), "sireid"));`
`983`	`975`	`if (joinedIds != null)`
`984`	`976`	`{`
`985`	`977`	`String[] ids = joinedIds.split(",");`
`986`		`- String urlString = "";`
`987`	`978`	`for (int i = 0; i < ids.length; i++)`
`988`	`979`	`{`
`989`	`980`	`String id = ids[i];`
`990`	`981`	`url.replaceParameter("participantId", id);`
`991`		`- urlString += "<a href=\"" + PageFlowUtil.filter(url) + "\">";`
`992`		`- urlString += PageFlowUtil.filter(id);`
`993`		`- urlString += "</a>";`
	`982`	`+ out.write(LinkBuilder.simpleLink(id, url));`
`994`	`983`	`if (i + 1 < ids.length)`
`995`	`984`	`{`
`996`		`- urlString += ", ";`
	`985`	`+ out.write(", ");`
`997`	`986`	`}`
`998`	`987`	`}`
`999`		`- oldWriter.write(urlString);`
`1000`	`988`	`}`
`1001`	`989`	`}`
`1002`	`990`
`@@ -1020,7 +1008,7 @@ private void customizeReasonForMoveColumn(AbstractTableInfo ti) {`
`1020`	`1008`	`reason.setDisplayColumnFactory(colInfo -> new DataColumn(colInfo){`
`1021`	`1009`
`1022`	`1010`	`@Override`
`1023`		`- public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException`
	`1011`	`+ public void renderGridCellContents(RenderContext ctx, HtmlWriter out)`
`1024`	`1012`	`{`
`1025`	`1013`	`ActionURL url = new ActionURL("query", "recordDetails.view", us.getContainer());`
`1026`	`1014`	`String joinedReasons = (String)ctx.get(new FieldKey(getBoundColumn().getFieldKey().getParent(), "reason"));`
`@@ -1031,7 +1019,6 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit`
`1031`	`1019`	`url.addParameter("query.queryName", "housing_reason");`
`1032`	`1020`	`url.addParameter("keyField", "value");`
`1033`	`1021`
`1034`		`- StringBuilder urlString = new StringBuilder();`
`1035`	`1022`	`for (int i = 0; i < reasons.length; i++)`
`1036`	`1023`	`{`
`1037`	`1024`	`String reasonForMoveValue = reasons[i];`
`@@ -1044,20 +1031,17 @@ public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWrit`
`1044`	`1031`	`{`
`1045`	`1032`	`reasonForMoveTitle = (String) ts.getMap().get("title");`
`1046`	`1033`	`url.replaceParameter("key", reasonForMoveValue);`
`1047`		`- urlString.append("<a href=\"").append(PageFlowUtil.filter(url)).append("\">");`
`1048`		`- urlString.append(PageFlowUtil.filter(reasonForMoveTitle));`
`1049`		`- urlString.append("</a>");`
	`1034`	`+ out.write(LinkBuilder.simpleLink(reasonForMoveTitle, url));`
`1050`	`1035`	`}`
`1051`	`1036`	`else`
`1052`	`1037`	`{`
`1053`		`- urlString.append(PageFlowUtil.filter("<" + reasonForMoveValue + ">"));`
	`1038`	`+ out.write("<" + reasonForMoveValue + ">");`
`1054`	`1039`	`}`
`1055`	`1040`	`if (i + 1 < reasons.length)`
`1056`	`1041`	`{`
`1057`		`- urlString.append(", ");`
	`1042`	`+ out.write(", ");`
`1058`	`1043`	`}`
`1059`	`1044`	`}`
`1060`		`- oldWriter.write(urlString.toString());`
`1061`	`1045`	`}`
`1062`	`1046`	`}`
`1063`	`1047`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,7 @@`
`11`	`11`	`import org.labkey.api.ldk.table.AbstractTableCustomizer;`
`12`	`12`	`import org.labkey.api.writer.HtmlWriter;`
`13`	`13`
`14`		`-import java.io.IOException;`
`15`		`-import java.io.Writer;`
	`14`	`+import static org.labkey.api.util.DOM.STRONG;`
`16`	`15`
`17`	`16`	`public class WNPRC_VirologyCustomizer extends AbstractTableCustomizer`
`18`	`17`	`{`
`@@ -63,26 +62,21 @@ public LLoDHtmlFormatDisplayColumn(ColumnInfo colInfo)`
`63`	`62`	`}`
`64`	`63`
`65`	`64`	`@Override`
`66`		`- public void renderGridCellContents(RenderContext ctx, Writer oldWriter, HtmlWriter out) throws IOException`
	`65`	`+ public void renderGridCellContents(RenderContext ctx, HtmlWriter out)`
`67`	`66`	`{`
`68`	`67`
`69`		`- StringBuilder htmlString = new StringBuilder();`
`70`	`68`	`String llodCol = ctx.get("below_llod").toString();`
`71`		`- if (llodCol.toString().contains("Yes"))`
	`69`	`+ if (llodCol.contains("Yes"))`
`72`	`70`	`{`
`73`	`71`	`int parenIdx = llodCol.indexOf("(");`
`74`	`72`	`String firstPart = llodCol.substring(0, parenIdx);`
`75`	`73`	`String lastPart = llodCol.substring(parenIdx);`
`76`		`- htmlString.append("<strong>");`
`77`		`- htmlString.append(firstPart);`
`78`		`- htmlString.append("</strong>");`
`79`		`- htmlString.append(lastPart);`
`80`		`- oldWriter.write(htmlString.toString());`
	`74`	`+ STRONG(firstPart).appendTo(out);`
	`75`	`+ out.write(lastPart);`
`81`	`76`	`}`
`82`	`77`	`else`
`83`	`78`	`{`
`84`		`- htmlString.append(llodCol);`
`85`		`- oldWriter.write(htmlString.toString());`
	`79`	`+ out.write(llodCol);`
`86`	`80`	`}`
`87`	`81`	`}`
`88`	`82`	`}`