ghttp_response_view.go 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. // Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
  2. //
  3. // This Source Code Form is subject to the terms of the MIT License.
  4. // If a copy of the MIT was not distributed with this file,
  5. // You can obtain one at https://github.com/gogf/gf.
  6. //
  7. package ghttp
  8. import (
  9. "github.com/gogf/gf/os/gcfg"
  10. "github.com/gogf/gf/os/gview"
  11. "github.com/gogf/gf/util/gconv"
  12. "github.com/gogf/gf/util/gmode"
  13. "github.com/gogf/gf/util/gutil"
  14. )
  15. // WriteTpl parses and responses given template file.
  16. // The parameter <params> specifies the template variables for parsing.
  17. func (r *Response) WriteTpl(tpl string, params ...gview.Params) error {
  18. if b, err := r.ParseTpl(tpl, params...); err != nil {
  19. if !gmode.IsProduct() {
  20. r.Write("Template Parsing Error: " + err.Error())
  21. }
  22. return err
  23. } else {
  24. r.Write(b)
  25. }
  26. return nil
  27. }
  28. // WriteTplDefault parses and responses the default template file.
  29. // The parameter <params> specifies the template variables for parsing.
  30. func (r *Response) WriteTplDefault(params ...gview.Params) error {
  31. if b, err := r.ParseTplDefault(params...); err != nil {
  32. if !gmode.IsProduct() {
  33. r.Write("Template Parsing Error: " + err.Error())
  34. }
  35. return err
  36. } else {
  37. r.Write(b)
  38. }
  39. return nil
  40. }
  41. // WriteTplContent parses and responses the template content.
  42. // The parameter <params> specifies the template variables for parsing.
  43. func (r *Response) WriteTplContent(content string, params ...gview.Params) error {
  44. if b, err := r.ParseTplContent(content, params...); err != nil {
  45. if !gmode.IsProduct() {
  46. r.Write("Template Parsing Error: " + err.Error())
  47. }
  48. return err
  49. } else {
  50. r.Write(b)
  51. }
  52. return nil
  53. }
  54. // ParseTpl parses given template file <tpl> with given template variables <params>
  55. // and returns the parsed template content.
  56. func (r *Response) ParseTpl(tpl string, params ...gview.Params) (string, error) {
  57. return r.Request.GetView().Parse(r.Request.Context(), tpl, r.buildInVars(params...))
  58. }
  59. // ParseTplDefault parses the default template file with params.
  60. func (r *Response) ParseTplDefault(params ...gview.Params) (string, error) {
  61. return r.Request.GetView().ParseDefault(r.Request.Context(), r.buildInVars(params...))
  62. }
  63. // ParseTplContent parses given template file <file> with given template parameters <params>
  64. // and returns the parsed template content.
  65. func (r *Response) ParseTplContent(content string, params ...gview.Params) (string, error) {
  66. return r.Request.GetView().ParseContent(r.Request.Context(), content, r.buildInVars(params...))
  67. }
  68. // buildInVars merges build-in variables into <params> and returns the new template variables.
  69. // TODO performance improving.
  70. func (r *Response) buildInVars(params ...map[string]interface{}) map[string]interface{} {
  71. m := gutil.MapMergeCopy(r.Request.viewParams)
  72. if len(params) > 0 {
  73. gutil.MapMerge(m, params[0])
  74. }
  75. // Retrieve custom template variables from request object.
  76. sessionMap := gconv.MapDeep(r.Request.Session.Map())
  77. gutil.MapMerge(m, map[string]interface{}{
  78. "Form": r.Request.GetFormMap(),
  79. "Query": r.Request.GetQueryMap(),
  80. "Request": r.Request.GetMap(),
  81. "Cookie": r.Request.Cookie.Map(),
  82. "Session": sessionMap,
  83. })
  84. // Note that it should assign no Config variable to template
  85. // if there's no configuration file.
  86. if c := gcfg.Instance(); c.Available() {
  87. m["Config"] = c.Map()
  88. }
  89. return m
  90. }