Merge pull request #228 from sasjs/allanbowe/add-markdown-as-mime-227

feat: adding MARKDOWN support to `mp_streamfile()`
2025-12-11 06:24:35 +00:00 · 2022-04-30 18:58:54 +03:00
parent 9e12409389 1e142f042b
commit dce4630eb8
2 changed files with 58 additions and 42 deletions
--- a/all.sas
+++ b/all.sas
@@ -11722,8 +11722,9 @@ create table &outds as
 %mend mp_stprequests;/**
  @file
  @brief Streams a file to _webout according to content type
-  @details Will set headers using appropriate functions (SAS 9 vs Viya) and send
-  content as a binary stream.
+  @details Will set headers using appropriate functions per the server type
+  (Viya, EBI, [SASjs Server](https://github.com/sasjs/server)) and stream
+  content using mp_binarycopy().

  Usage:

@@ -11733,7 +11734,14 @@ create table &outds as

      %mp_streamfile(contenttype=csv,inloc=/some/where.txt,outname=myfile.txt)

-  @param [in] contenttype= (TEXT) Either TEXT, ZIP, CSV, EXCEL
+  @param [in] contenttype= (TEXT) Supported:
+    @li CSV
+    @li EXCEL
+    @li MARKDOWN
+    @li TEXT
+    @li ZIP
+    Feel free to submit PRs to support more mime types!  The official list is
+    here:  https://www.iana.org/assignments/media-types/media-types.xhtml
  @param [in] inloc= /path/to/file.ext to be sent
  @param [in] inref= fileref of file to be sent (if provided, overrides `inloc`)
  @param [in] iftrue= (1=1) Provide a condition under which to execute.
@@ -11779,7 +11787,7 @@ run;
 %if &contentype=CSV %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/csv');
+      rc=stpsrv_header('Content-Type','application/csv');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -11789,7 +11797,7 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/csv)
+    %mfs_httpheader(Content-Type,application/csv)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
@@ -11797,7 +11805,7 @@ run;
  /* suitable for XLS format */
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/vnd.ms-excel');
+      rc=stpsrv_header('Content-Type','application/vnd.ms-excel');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -11807,14 +11815,14 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/vnd.ms-excel)
+    %mfs_httpheader(Content-Type,application/vnd.ms-excel)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
 %else %if &contentype=GIF or &contentype=JPEG or &contentype=PNG %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type',"image/%lowcase(&contenttype)");
+      rc=stpsrv_header('Content-Type',"image/%lowcase(&contenttype)");
    run;
  %end;
  %else %if &platform=SASVIYA %then %do;
@@ -11822,30 +11830,30 @@ run;
      contenttype="image/%lowcase(&contenttype)";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,image/%lowcase(&contenttype))
+    %mfs_httpheader(Content-Type,image/%lowcase(&contenttype))
  %end;
 %end;
-%else %if &contentype=HTML %then %do;
+%else %if &contentype=HTML or &contenttype=MARKDOWN %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','text/html');
+      rc=stpsrv_header('Content-Type',"text/%lowcase(&contenttype)");
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
  %else %if &platform=SASVIYA %then %do;
    filename &outref filesrvc parenturi="&SYS_JES_JOB_URI" name="_webout.json"
-      contenttype="text/html"
+      contenttype="text/%lowcase(&contenttype)"
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,text/html)
+    %mfs_httpheader(Content-Type,text/%lowcase(&contenttype))
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
 %else %if &contentype=TEXT %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/text');
+      rc=stpsrv_header('Content-Type','application/text');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -11855,14 +11863,14 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/text)
+    %mfs_httpheader(Content-Type,application/text)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
 %else %if &contentype=WOFF or &contentype=WOFF2 or &contentype=TTF %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type',"font/%lowcase(&contenttype)");
+      rc=stpsrv_header('Content-Type',"font/%lowcase(&contenttype)");
    run;
  %end;
  %else %if &platform=SASVIYA %then %do;
@@ -11870,13 +11878,13 @@ run;
      contenttype="font/%lowcase(&contenttype)";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,font/%lowcase(&contenttype))
+    %mfs_httpheader(Content-Type,font/%lowcase(&contenttype))
  %end;
 %end;
 %else %if &contentype=XLSX %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type',
+      rc=stpsrv_header('Content-Type',
        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
@@ -11888,7 +11896,7 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type
+    %mfs_httpheader(Content-Type
      ,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    )
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
@@ -11897,7 +11905,7 @@ run;
 %else %if &contentype=ZIP %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/zip');
+      rc=stpsrv_header('Content-Type','application/zip');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -11907,7 +11915,7 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/zip)
+    %mfs_httpheader(Content-Type,application/zip)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
--- a/base/mp_streamfile.sas
+++ b/base/mp_streamfile.sas
@@ -1,8 +1,9 @@
 /**
  @file
  @brief Streams a file to _webout according to content type
-  @details Will set headers using appropriate functions (SAS 9 vs Viya) and send
-  content as a binary stream.
+  @details Will set headers using appropriate functions per the server type
+  (Viya, EBI, [SASjs Server](https://github.com/sasjs/server)) and stream
+  content using mp_binarycopy().

  Usage:

@@ -12,7 +13,14 @@

      %mp_streamfile(contenttype=csv,inloc=/some/where.txt,outname=myfile.txt)

-  @param [in] contenttype= (TEXT) Either TEXT, ZIP, CSV, EXCEL
+  @param [in] contenttype= (TEXT) Supported:
+    @li CSV
+    @li EXCEL
+    @li MARKDOWN
+    @li TEXT
+    @li ZIP
+    Feel free to submit PRs to support more mime types!  The official list is
+    here:  https://www.iana.org/assignments/media-types/media-types.xhtml
  @param [in] inloc= /path/to/file.ext to be sent
  @param [in] inref= fileref of file to be sent (if provided, overrides `inloc`)
  @param [in] iftrue= (1=1) Provide a condition under which to execute.
@@ -58,7 +66,7 @@ run;
 %if &contentype=CSV %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/csv');
+      rc=stpsrv_header('Content-Type','application/csv');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -68,7 +76,7 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/csv)
+    %mfs_httpheader(Content-Type,application/csv)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
@@ -76,7 +84,7 @@ run;
  /* suitable for XLS format */
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/vnd.ms-excel');
+      rc=stpsrv_header('Content-Type','application/vnd.ms-excel');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -86,14 +94,14 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/vnd.ms-excel)
+    %mfs_httpheader(Content-Type,application/vnd.ms-excel)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
 %else %if &contentype=GIF or &contentype=JPEG or &contentype=PNG %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type',"image/%lowcase(&contenttype)");
+      rc=stpsrv_header('Content-Type',"image/%lowcase(&contenttype)");
    run;
  %end;
  %else %if &platform=SASVIYA %then %do;
@@ -101,30 +109,30 @@ run;
      contenttype="image/%lowcase(&contenttype)";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,image/%lowcase(&contenttype))
+    %mfs_httpheader(Content-Type,image/%lowcase(&contenttype))
  %end;
 %end;
-%else %if &contentype=HTML %then %do;
+%else %if &contentype=HTML or &contenttype=MARKDOWN %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','text/html');
+      rc=stpsrv_header('Content-Type',"text/%lowcase(&contenttype)");
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
  %else %if &platform=SASVIYA %then %do;
    filename &outref filesrvc parenturi="&SYS_JES_JOB_URI" name="_webout.json"
-      contenttype="text/html"
+      contenttype="text/%lowcase(&contenttype)"
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,text/html)
+    %mfs_httpheader(Content-Type,text/%lowcase(&contenttype))
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
 %else %if &contentype=TEXT %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/text');
+      rc=stpsrv_header('Content-Type','application/text');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -134,14 +142,14 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/text)
+    %mfs_httpheader(Content-Type,application/text)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;
 %else %if &contentype=WOFF or &contentype=WOFF2 or &contentype=TTF %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type',"font/%lowcase(&contenttype)");
+      rc=stpsrv_header('Content-Type',"font/%lowcase(&contenttype)");
    run;
  %end;
  %else %if &platform=SASVIYA %then %do;
@@ -149,13 +157,13 @@ run;
      contenttype="font/%lowcase(&contenttype)";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,font/%lowcase(&contenttype))
+    %mfs_httpheader(Content-Type,font/%lowcase(&contenttype))
  %end;
 %end;
 %else %if &contentype=XLSX %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type',
+      rc=stpsrv_header('Content-Type',
        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
@@ -167,7 +175,7 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type
+    %mfs_httpheader(Content-Type
      ,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    )
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
@@ -176,7 +184,7 @@ run;
 %else %if &contentype=ZIP %then %do;
  %if (&platform=SASMETA and &streamweb=1) %then %do;
    data _null_;
-      rc=stpsrv_header('Content-type','application/zip');
+      rc=stpsrv_header('Content-Type','application/zip');
      rc=stpsrv_header('Content-disposition',"attachment; filename=&outname");
    run;
  %end;
@@ -186,7 +194,7 @@ run;
      contentdisp="attachment; filename=&outname";
  %end;
  %else %if &platform=SASJS %then %do;
-    %mfs_httpheader(Content-type,application/zip)
+    %mfs_httpheader(Content-Type,application/zip)
    %mfs_httpheader(Content-disposition,%str(attachment; filename=&outname))
  %end;
 %end;