form_base.go

package page

import (
	"context"
	"encoding/gob"
	"fmt"
	"github.com/goradd/goradd/pkg/config"
	"github.com/goradd/goradd/pkg/crypt"
	"github.com/goradd/goradd/pkg/goradd"
	"github.com/goradd/goradd/pkg/http"
	"github.com/goradd/goradd/pkg/log"
	"github.com/goradd/goradd/pkg/messageServer"
	"github.com/goradd/goradd/pkg/session"
	"github.com/goradd/goradd/pkg/session/location"
	"github.com/goradd/html5tag"
	"github.com/goradd/maps"
	"io"
	"path"
)

type FormI interface {
	ControlI
	PageDrawingFunction() PageDrawFunc

	AddHeadTags()
	DrawHeaderTags(ctx context.Context, w io.Writer)
	Response() *Response
	renderAjax(ctx context.Context, w io.Writer)
	AddRelatedFiles()
	AddStyleSheetFile(path string, attributes html5tag.Attributes)
	AddJavaScriptFile(path string, forceHeader bool, attributes html5tag.Attributes)
	DisplayAlert(ctx context.Context, msg string)
	ChangeLocation(url string)
	PushLocation(ctx context.Context)
	PopLocation(ctx context.Context, fallback string)

	// Lifecycle calls

	// Init is called by the framework immediately after the form structure is instantiated for the first time
	// when responding to a route.
	// It should initialize its member variables and call its embeded Formbase.Init function, passing its
	// accessor variable as the self parameter.
	Init(ctx context.Context, id string)

	// Run is called by the framework after a form is created for the first time, or recreated for an Ajax call.
	// It is a good place to validate credentials and any incoming form variables.
	Run(ctx context.Context)

	// CreateControls is called by the framework after a form is created for the first time. It is the place to
	// add controls to the form.
	CreateControls(ctx context.Context)

	// LoadControls is called after CreateControls and is the place to query the database and load up the value of any
	// controls in the form.
	LoadControls(ctx context.Context)

	// Exit is called after the page is drawn, just before it is saved in the page cache. Its the place to do any last
	// minute local variable initializations.
	Exit(ctx context.Context, err error)

	updateValues(ctx context.Context)
	writeAllStates(ctx context.Context)
}

type headerItem = maps.SliceMap[string, html5tag.Attributes]

// FormBase is a base for the FormBase struct that is in the control package.
// Normally, you should not descend your forms from here, but rather from the control.Form struct.
// It is the basic control structure for the application and also serves as the drawing mechanism for the
// <form> tag in the html output.
type FormBase struct {
	drawing bool
	ControlBase
	response            Response
	headerStyleSheets   *headerItem
	importedStyleSheets *headerItem // when refreshing, these get moved to the headerStyleSheets
	headerJavaScripts   *headerItem
	bodyJavaScripts     *headerItem
	importedJavaScripts *headerItem // when refreshing, these get moved to the bodyJavaScripts
}

// Init initializes the form control. Note that ctx might be nil if we are unit testing.
func (f *FormBase) Init(self any, _ context.Context, id string) {
	var p = new(Page)
	p.Init()

	f.page = p
	if id == "" {
		panic("Forms must have an id assigned")
	}

	f.ControlBase.Init(self, nil, id)
	f.Tag = "form"
	f.this().AddRelatedFiles()
}

func (f *FormBase) this() FormI {
	return f.Self().(FormI)
}

// AddRelatedFiles adds related javascript and style sheet files. This is the default to get the minimum goradd installation working.,
// The order is important, so if you override this, be sure these files get loaded
// before other files.
func (f *FormBase) AddRelatedFiles() {
	f.AddGoraddFiles()
	if messageServer.Messenger != nil {
		files := messageServer.Messenger.JavascriptFiles()
		for file, attr := range files {
			f.AddJavaScriptFile(file, false, attr)
		}
	}
}

// AddGoraddFiles adds the various goradd files to the form
func (f *FormBase) AddGoraddFiles() {
	f.AddJavaScriptFile(path.Join(config.AssetPrefix, "goradd", "js", "goradd.js"), false, nil)
	if !config.Release {
		f.AddJavaScriptFile(path.Join(config.AssetPrefix, "goradd", "test", "js", "goradd-test.js"), false, nil)
	}
	if config.Debug {
		f.AddJavaScriptFile(path.Join(config.AssetPrefix, "goradd", "js", "goradd-debug.js"), false, nil)
	}

	f.AddStyleSheetFile(path.Join(config.AssetPrefix, "goradd", "css", "goradd.css"), nil)
}

// Draw renders the form. Even though forms are technically controls, we use a custom drawing
// routine for performance reasons and for control.
func (f *FormBase) Draw(ctx context.Context, w io.Writer) {
	if f.drawing && !config.Release {
		panic("draw collission")
	}
	f.drawing = true
	defer f.notDrawing()
	f.this().DrawPreRender(ctx, w)
	if _, err := io.WriteString(w, `<form `+f.this().DrawingAttributes(ctx).String()+">\n"); err != nil {
		panic(err)
	}
	if err := f.this().DrawTemplate(ctx, w); err != nil {
		panic(err)
	} // the template is required
	// Render controls that are marked to auto render if the form did not render them
	f.RenderAutoControls(ctx, w)

	// Render hidden controls

	// Place holder for postBack and postAjax functions to place their data
	if _, err := io.WriteString(w, `<input type="hidden" name="`+htmlVarParams+`" id="`+htmlVarParams+`" value="" />`+"\n"); err != nil {
		panic(err)
	}

	// CSRF prevention
	var csrf string

	csrf = session.GetString(ctx, goradd.SessionCsrf)
	if csrf == "" {
		var err error
		// first time
		csrf, err = crypt.GenerateRandomBase64String(16)
		if err != nil {
			panic(err)
		}
		session.Set(ctx, goradd.SessionCsrf, csrf)
	}
	if _, err := fmt.Fprintf(w, `<input type="hidden" name="`+htmlCsrfToken+`" id="`+htmlCsrfToken+`" value="%s" />`+"\n", csrf); err != nil {
		panic(err)
	}

	// Serialize and write out the pagestate
	if _, err := fmt.Fprintf(w, `<input type="hidden" name="`+HtmlVarPagestate+`" id="`+HtmlVarPagestate+`" value="%s" />`, f.page.StateID()); err != nil {
		panic(err)
	}

	if err := f.drawBodyScriptFiles(ctx, w); err != nil {
		panic(err)
	}

	if _, err := io.WriteString(w, "\n</form>\n"); err != nil {
		panic(err)
	}

	// Draw things that come after the form tag

	var s string

	// start the message server before initializing the form so that the form can subscribe to messages
	if messageServer.Messenger != nil {
		s = messageServer.Messenger.JavascriptInit()
	}
	f.GetActionScripts(&f.response) // actions assigned to form during form creation
	s += f.response.JavaScript()
	f.response = NewResponse() // clear response
	s += "\n" + `goradd.initForm();` + "\n"
	if !config.Release {
		// This code registers the form with the test harness. We do not want to do this in release mode since it is a security risk.
		s += "goradd.initFormTest();\n"
	} else {
		s += fmt.Sprintf("goradd.ajaxTimeout = %d;\n", config.AjaxTimeout) // turn on the ajax timeout in release mode
	}
	if _, err := fmt.Fprintf(w, `<script>
%s
</script>`, s); err != nil {
		panic(err)
	}

	f.this().DrawPostRender(ctx, w)
	f.resetDrawingFlags()

	return
}

func (f *FormBase) notDrawing() {
	f.drawing = false
}

func (f *FormBase) resetDrawingFlags() {
	f.RangeSelfAndAllChildren(func(ctrl ControlI) {
		c := ctrl.control()
		c.wasRendered = false
		c.needsRefresh = false
	})
}

func (f *FormBase) updateValues(ctx context.Context) {
	f.RangeAllChildren(func(child ControlI) {
		// Parent is updated after children so that parent can read the state of the children
		// to update any internal caching of the state. Parent can then delete or recreate children
		// as needed.
		if !child.IsDisabled() {
			child.UpdateFormValues(ctx)
		}
	})
}

// writeAllStates is an internal function that will recursively write out the state of all the controls.
// This state is used by controls to restore the visual state of the control if the page is returned to. This is helpful
// in situations where a control is used to filter what is shown on the page, you zoom into an item, and then return to
// the parent control. In this situation, you want to see things in the same state they were in, and not have to set up
// the filter all over again.
func (f *FormBase) writeAllStates(ctx context.Context) {
	f.RangeAllChildren(func(child ControlI) {
		c := child.control()
		c.writeState(ctx)
	})
}

// renderAjax assembles the ajax response for the entire form and draws it to the return buffer
func (f *FormBase) renderAjax(ctx context.Context, w io.Writer) {
	var buf2 []byte
	if f.drawing && !config.Release {
		panic("draw collission")
	}
	f.drawing = true
	defer f.notDrawing()

	if !f.response.hasExclusiveCommand() { // skip drawing if we are in a high priority situation
		// gather modified controls
		f.DrawAjax(ctx, &f.response)
	}

	// Inject any added style sheets and script files
	if f.importedStyleSheets != nil {
		f.importedStyleSheets.Range(func(k string, v html5tag.Attributes) bool {
			f.response.addStyleSheet(k, v)
			return true
		})
	}

	if f.importedJavaScripts != nil {
		f.importedJavaScripts.Range(func(k string, v html5tag.Attributes) bool {
			f.response.addJavaScriptFile(k, v)
			return true
		})
	}

	f.mergeInjectedFiles()

	f.resetDrawingFlags()
	var err error
	buf2, err = f.response.GetAjaxResponse()
	if err != nil {
		panic(err)
	}
	//f.response = NewResponse() Do NOT do this here! It messes with testing framework and multi-processing of ajax responses
	_, err = w.Write(buf2)
	if err != nil {
		panic(err)
	}
	if len(buf2) > 100 {
		log.FrameworkDebug("renderAjax - ", string(buf2[:100]), " ...")
	} else {
		log.FrameworkDebug("renderAjax - ", string(buf2))
	}
}

// DrawingAttributes returns the attributes to add to the form tag.
func (f *FormBase) DrawingAttributes(ctx context.Context) html5tag.Attributes {
	a := f.ControlBase.DrawingAttributes(ctx)
	a.SetData("grctl", "form")
	a.Set("novalidate", "") // form validation is inconsistent on browsers and causes framework problems
	return a
}

// DrawPreRender performs setup operations just before drawing.
func (f *FormBase) DrawPreRender(ctx context.Context, w io.Writer) {
	f.ControlBase.DrawPreRender(ctx, w)

	f.SetAttribute("method", "post")
	// Setting the "action" attribute prevents iFrame clickjacking.
	// This only works because we never ajax draw the form, only server render
	grctx := GetContext(ctx)
	f.SetAttribute("action", http.MakeLocalPath(grctx.HttpContext.URL.RequestURI()))

	return
}

// PageDrawingFunction returns the function used to draw the page object.
// If you want a custom drawing function for your page, implement this function in your form override.
func (f *FormBase) PageDrawingFunction() PageDrawFunc {
	return PageTmpl // Returns the default
}

// AddJavaScriptFile registers a JavaScript file such that it will get loaded on the page.
//
// The path is either a url, or an internal path to the location of the file
// in the development environment.
//
// If forceHeader is true, the file will be listed in the header, which you should only do if the file has some
// preliminary javascript that needs to be executed before the dom loads.
// You can specify forceHeader and a "defer" attribute to get the effect of loading the javascript in the background.
// With forceHeader false, the file will be loaded after
// the dom is loaded, allowing the browser to show the page and then load the javascript in the background, giving the
// appearance of a more responsive website. If you add the file during an ajax operation, the file will be loaded
// dynamically by the goradd javascript. Controls generally should call this during the initial creation of the control if the control
// requires additional javascript to function.
//
// attributes are the attributes that will be included with the script tag, which is useful for things like
// crossorigin and integrity attributes.
func (f *FormBase) AddJavaScriptFile(path string, forceHeader bool, attributes html5tag.Attributes) {
	if forceHeader && f.isOnPage {
		panic("You cannot force a JavaScript file to be in the header if you insert it after the page is drawn.")
	}

	if path[:4] != "http" {
		url := http.GetAssetUrl(path)

		if url == "" {
			panic(path + " is not in a registered asset directory")
		}
		path = url
	}

	if f.isOnPage {
		if f.headerJavaScripts != nil && f.headerJavaScripts.Has(path) ||
			f.bodyJavaScripts != nil && f.bodyJavaScripts.Has(path) {
			return // file is already on the page
		}
		if f.importedJavaScripts == nil {
			f.importedJavaScripts = new(headerItem)
		}
		f.importedJavaScripts.Set(path, attributes)
	} else if forceHeader {
		if f.headerJavaScripts == nil {
			f.headerJavaScripts = new(headerItem)
		}
		f.headerJavaScripts.Set(path, attributes)
	} else {
		if f.bodyJavaScripts == nil {
			f.bodyJavaScripts = new(headerItem)
		}
		f.bodyJavaScripts.Set(path, attributes)
	}
}

// AddMasterJavaScriptFile adds a javascript file that is a concatenation of other javascript files the system uses.
// This allows you to concatenate and minimize all the javascript files you are using without worrying about
// libraries and controls that are adding the individual files through the AddJavaScriptFile function
func (f *FormBase) AddMasterJavaScriptFile(url string, attributes []string, files []string) {
	// TODO
}

// AddStyleSheetFile registers a StyleSheet file such that it will get loaded on the page.
// The file will be loaded on the page at initial draw in the header, or will be inserted into the file if the page
// is already drawn. The path is either a url to an external resource, or a local directory to a resource on disk.
// Paths must be registered with RegisterAssetDirectory, and will be served from their local location in a development environment,
// but from the corresponding registered path when deployed.
//
// attributes are the attributes that will be included with the link tag, which is useful for things like
// crossorigin and integrity attributes.
//
// To control the cache-control settings on the file, you should call SetCacheControl.
func (f *FormBase) AddStyleSheetFile(path string, attributes html5tag.Attributes) {
	if path[:4] != "http" {
		url := http.GetAssetUrl(path)

		if url == "" {
			panic(path + " is not in a registered asset directory")
		}
		path = url
	}

	if f.isOnPage {
		if f.headerStyleSheets != nil && f.headerStyleSheets.Has(path) {
			return // the style sheet was already included when the form was loaded the first time
		}
		if f.importedStyleSheets == nil {
			f.importedStyleSheets = new(headerItem)
		}
		f.importedStyleSheets.Set(path, attributes)
	} else {
		if f.headerStyleSheets == nil {
			f.headerStyleSheets = new(headerItem)
		}
		f.headerStyleSheets.Set(path, attributes)
	}
}

// DrawHeaderTags is called by the page drawing routine to draw its header tags
// If you override this, be sure to call this version too
func (f *FormBase) DrawHeaderTags(ctx context.Context, w io.Writer) {
	f.mergeInjectedFiles()

	if f.headerStyleSheets != nil {
		f.headerStyleSheets.Range(func(path string, attr html5tag.Attributes) bool {
			var attributes = attr
			if attributes == nil {
				attributes = html5tag.NewAttributes()
			}
			attributes.Set("rel", "stylesheet")
			attributes.Set("href", path)
			WriteString(w, html5tag.RenderVoidTag("link", attributes))
			return true
		})
	}

	if f.headerJavaScripts != nil {
		f.headerJavaScripts.Range(func(path string, attr html5tag.Attributes) bool {
			var attributes = attr
			if attributes == nil {
				attributes = html5tag.NewAttributes()
			}
			attributes.Set("src", path)
			attributes.Set("type", "text/javascript")
			WriteString(w, html5tag.RenderTag("script", attributes, ""))
			return true
		})
	}

	return
}

func (f *FormBase) mergeInjectedFiles() {
	if f.importedStyleSheets != nil {
		if f.headerStyleSheets == nil {
			f.headerStyleSheets = new(headerItem)
		}
		f.headerStyleSheets.Merge(f.importedStyleSheets)
		f.importedStyleSheets = nil
	}

	if f.importedJavaScripts != nil {
		if f.headerJavaScripts == nil {
			f.headerJavaScripts = new(headerItem)
		}
		f.headerJavaScripts.Merge(f.importedJavaScripts)
		f.importedJavaScripts = nil
	}
}

func (f *FormBase) drawBodyScriptFiles(ctx context.Context, w io.Writer) (err error) {
	f.bodyJavaScripts.Range(func(path string, attr html5tag.Attributes) bool {
		var attributes = attr
		if attributes == nil {
			attributes = html5tag.NewAttributes()
		}
		attributes.Set("src", path)
		attributes.Set("type", "text/javascript")
		if _, err = io.WriteString(w, html5tag.RenderTag("script", attributes, "")+"\n"); err != nil {
			return false
		}
		return true
	})
	return
}

// DisplayAlert will display a javascript alert with the given message.
func (f *FormBase) DisplayAlert(ctx context.Context, msg string) {
	f.response.displayAlert(msg)
}

// ChangeLocation will redirect the browser to a new URL.
//
// It does this AFTER processing the return
// values sent to the browser. Generally you should use this to redirect the browser since you may
// have some data that needs to be processed first. The exception is
// if you are responding to some kind of security concern where you only want to send back an HTML
// redirect without revealing any goradd information, in which case you should use the http.Redirect function.
func (f *FormBase) ChangeLocation(url string) {
	f.response.SetLocation(http.MakeLocalPath(url))
}

// Response returns the form's response object that you can use to queue up javascript commands to the browser to be
// sent on the next ajax or server request
func (f *FormBase) Response() *Response {
	return &f.response
}

// AddHeadTags is a lifecycle call that happens when a new form is created. This is where you should call
// AddHtmlHeaderTag or SetTitle on the page to set tags that appear in the <head> tag of the page.
// Head tags cannot be changed after the page is created.
func (f *FormBase) AddHeadTags() {

}

// Run is a lifecycle function that gets called whenever a page is run, either by a whole page load, or an ajax call.
// Its a good place to validate that the current user should have access to the information on the page.
// You should panic on any errors.
func (f *FormBase) Run(ctx context.Context) {
}

// CreateControls is a lifecycle function that gets called whenever a page is created. It happens after the Run call.
// This is the place to add controls to the form
func (f *FormBase) CreateControls(ctx context.Context) {
}

// LoadControls is a lifecycle call that happens after a form is first created. It is the place to initialize the value
// of the controls in the form based on variables sent to the form or session variables.
func (f *FormBase) LoadControls(ctx context.Context) {
}

// Exit is a lifecycle function that gets called after the form is processed, just before control is returned to the client.
// err will be set if an error response was detected.
func (f *FormBase) Exit(ctx context.Context, err error) {
	return
}

func (f *FormBase) Refresh() {
	panic("Do not refresh the form. It cannot be drawn in ajax.")
}

// PushLocation pushes the URL that got us to the current page on to the location stack.
func (f *FormBase) PushLocation(ctx context.Context) {
	grctx := GetContext(ctx)
	location.Push(ctx, grctx.URL.RequestURI())
}

// PopLocation pops the most recent location off of the location stack and goes to that location.
// It will go to the fallback url if there is nothing on the stack
func (f *FormBase) PopLocation(ctx context.Context, fallback string) {
	if loc := location.Pop(ctx); loc != "" {
		f.ChangeLocation(loc)
	} else {
		f.ChangeLocation(fallback)
	}
}

type formEncoded struct {
	HeaderSS   *headerItem
	ImportedSS *headerItem
	HeaderJS   *headerItem
	BodyJS     *headerItem
	ImportedJS *headerItem
}

func (f *FormBase) Serialize(e Encoder) {
	f.ControlBase.Serialize(e)
	if !config.Release {
		// The response is currently only changed between posts by the testing framework
		// If we ever need to change forms using some kind of push mechanism, we will need to serialize
		// the response.
		f.response.Serialize(e)
	}

	s := formEncoded{
		HeaderSS:   f.headerStyleSheets,
		ImportedSS: f.importedStyleSheets,
		HeaderJS:   f.headerJavaScripts,
		BodyJS:     f.bodyJavaScripts,
		ImportedJS: f.importedJavaScripts,
	}

	if err := e.Encode(s); err != nil {
		panic(err)
	}
}

func (f *FormBase) Deserialize(d Decoder) {
	f.ControlBase.Deserialize(d)

	if !config.Release {
		// The response is currently only changed between posts by the testing framework
		// If we ever need to change forms using some kind of push mechanism, we will need to serialize
		// the response.
		f.response.Deserialize(d)
	}

	s := formEncoded{}
	if err := d.Decode(&s); err != nil {
		panic(err)
	}

	f.headerStyleSheets = s.HeaderSS
	f.importedStyleSheets = s.ImportedSS
	f.headerJavaScripts = s.HeaderJS
	f.bodyJavaScripts = s.BodyJS
	f.importedJavaScripts = s.ImportedJS

	return
}

func init() {
	gob.Register(&FormBase{})
	gob.Register(new(headerItem))
}

type MockForm struct {
	FormBase
}

func init() {
	RegisterControl(new(MockForm))
}

// NewMockForm creates a form that should be used as a parent of a control when unit testing the control.
func NewMockForm() *MockForm {
	f := new(MockForm)
	f.Init(nil, "MockFormID")
	return f
}

func (f *MockForm) Init(ctx context.Context, id string) {
	f.FormBase.Init(f, ctx, id)
}

func (f *MockForm) AddRelatedFiles() {
}