form.js

import log from "./logging"
import { is_array, is_function, duplicate } from "./utils"

import {ensure_css, modal} from "./visuals"
// import { tooltip } from "./tooltip"
import DnsValidator from "./dns_validator";
import xhr from "./xhr.js"

/************
 * The intention here is that we won't put any GUI stuff in here at all.
 * We *will* modify things in the DOM, and append event handlers, and
 * whatever else needs to happen, but anything that affects display will be
 * in visuals.js
 */

const options_hash = {
    form_key:  "string",
    manual: "boolean",
    email_field: "DOMNode",
    form: "DOMNodeOrBoolean",
    submit_button: "DOMNodeOrArrayOfDOMNodes",
    debug: "BooleanOrVerbose",
    onGood: "function",
    onBad: "function",
    onChallenge: "function",
    onError: "function",
    visuals: "booleanOrVisualsObj", // this may be deprecated?
    timeout: "number",
    doh_json_server: "string" //need a test for this parameter.
} // css" (not yet?)

const visuals_all_on = {good:true, bad:true, challenge:true}
const visuals_all_off = {good:false, bad:false, challenge:false}

export default class Form {
    constructor(options) {
        log.verbose("Invoking Class constructor!")
        log.verbosedir(options)
        
        for(let key in options) {
            log.verbose("Setting: "+key+" to "+options[key])
            //this[key] = options[key] //this will initialize all the callbacks, btw. Even if 'manual' is turned on! Do we...want that? TODO
            if(!this.unwrap_assign(key, options[key])) {
                //bail out if any options weren't assignable
                return false
            }
        }
        if(!this.doh_json_server) {
            this.doh_json_server = 'https://cloudflare-dns.com/dns-query'
        }

        if(!this.timeout) {
            this.timeout = 15000 // we have been seeing some invalid emails get detected in 11 seconds, so this _should_ be enough room
        } else {
            this.timeout = 1000 * this.timeout //timeout was in seconds, but window.setTimeout() is in milliseconds
        }

        this.doh_server = new DnsValidator(this.doh_json_server,this.timeout)

        if(this.manual) {
            //bail out of the rest of setup for manual-mode
            log.debug("Manual mode selected; exiting setup")
            return
        }
        if(!this.email_field) {
            return log.error("No Email Field set!")
        }
        if(typeof this.form == "undefined" || this.form === true ) { // 'true' is just an explicit way of saying 'automatically figure out what form this lives in'
            log.verbose("Trying to guess Form value")
            //try and guess form from email field's 'form' property
            this.form = this.email_field.form
            log.verbose("Picked: "+this.form)
        }
        if(!this.form && this.form !== false) { // 'false' means "don't mess with the form, or maybe there isn't one"
            return log.error("Could not determine Form!")
        }
        if(this.form && !this.submit_button && this.submit_button !== false) { //'false' means "don't disable submit buttons"
            log.verbose("Trying to find submit buttons...")
            let submit_buttons=[]
            for(let i=0; i < this.form.elements.length; i++) {
                let element = this.form.elements[i]
                log.verbose("Checking element: "+element+" - nodeName: '"+element.nodeName+"' Type: '"+element.type+"'")
                if((element.nodeName == "INPUT" && element.type == "submit") || (element.nodeName == "BUTTON" && element.type != "reset" && element.type != "button")) {
                    log.debug("Found a submit button")
                    submit_buttons.push(element)
                }
            }
            this.submit_button = submit_buttons
        }
        if(!this.visuals) {
            // if no 'visuals' override, default visuals setting is all-on
            this.visuals = duplicate(visuals_all_on)
        }
        this.initialize_dom() // this calls this.disable_submits(), which sets this.submittable = false
        this.modal = new modal(this.email_field)
        if(!!document.createElementNS &&
            !!document.createElementNS("http://www.w3.org/2000/svg", "svg").createSVGRect) {
            this.email_field.className += " goodforms_svg_support"
        }
        // FIXME - add the SVG feature detection here
        // this.tooltip = new tooltip(this.email_field) //this is lightweight and doesn't do anything until you actually *show* it
        if(this.email_field.value) {
            log.debug("Email field was already filled out, so we're going to manually fire the onchange_handler")
            this.onchange_handler()
        }
    }

    unwrap_assign(name, element) {
        if(!options_hash[name]) {
            log.error("Unknown option: "+name+" - aborting")
            return false
        }
        switch(options_hash[name]) {
            case "DOMNode":
                return this.unwrap_domnode(name,element,false)
                break

            case "DOMNodeOrMultipleDOMNodes":
                return this.unwrap_domnode(name,element,true)
                break

            case "booleanOrVisualsObj":
                if(typeof element === "boolean") {
                    if(element) {
                        this.visuals = duplicate(visuals_all_on)
                    } else {
                        this.visuals = duplicate(visuals_all_off)
                    }
                    return true
                }
                if(typeof element === "object") {
                    this.visuals = duplicate(visuals_all_on) //any missing keys should default to 'on' (true)
                    for(var key in element) {
                        if(!visuals_all_on[key]) { //if the 'visuals_all_on' constant doesn't have 'true' for this, this thing has unneeded keys
                            log.error(name+" key "+key+" was unexpected")
                            return false
                        }
                        this.visuals[key] = element[key]
                    }
                    //made it through all of the visual_keys, none were there that we didn't expect.
                    //now make sure to set default 'true' for anything missed.
                    return true
                }
                log.error(name+" is incorrect type - got:"+typeof(element))
                return false
                break

            case "DOMNodeOrBoolean":
                if(typeof element === "boolean") {
                    this[name] = element
                    return true
                } else {
                    return this.unwrap_domnode(name,element,false)
                }
                break

            case "BooleanOrVerbose":
                if(typeof element === "boolean" || (typeof element === "string" && element === "verbose")) {
                    return true;
                } else {
                    log.error('Wanted either boolean true or false, or the string "verbose" for key '+name)
                    return false
                }
            
            default:
                if(typeof element == options_hash[name]) {
                    this[name] = element
                    return true
                } else {
                    log.error("Unknown type for parameter: "+name+" (got: "+(typeof element)+", wanted: "+options_hash[name]+")")
                    return false
                }
        }
    }

    unwrap_domnode(name, element, multiple)  {
        // if it's a jquery element, return the real DOM element underneath.
        // if it's still bad, error.
        if(typeof(element) === 'object' && element['jquery'] && element['get']) {
            log.verbose("jQuery-like object found for "+name)
            if(element.length == 0 ) {
                log.error("No elements found in jQuery selector for "+name)
                return false
            }
            if(element.length > 1) {
                if(!multiple) {
                    log.error("Too many elements found in jQuery selector for "+name+" (count: "+element.length+")")
                    return false
                }
                //multiples allowed
                let unwrapped = []
                for(let i=0 ; i < element.length; i++) {
                    unwrapped.push(element[i])
                }
                this[name] = unwrapped
                return true
            }
            this[name] = element.get(0)
            return true
        }
        if(typeof(element) === "string") {
            let node = document.getElementById(element)
            if(!node) {
                log.error("No element with id "+element+" found for "+name)
                return false
            }
            this[name] = node
            return true
        }
        if((typeof(Element) !== "undefined" && element instanceof Element) || (element['nodeName'] && element['nodeType'] === 1)) {
            this[name] = element
            return true
        }
        if(is_array(element)) {
            for(let i = 0 ; i < element.length ; i++) {
                if(!(element[i] instanceof element_type)) {
                    log.error("Array for "+name+" contains non-DOM element at index "+i)
                    return false
                }
            }
            this[name] = element
            return true
        }
        log.error("Unknown element type passed for "+name+": "+typeof(element)+", and its prototype is: "+(element['prototype'] ? element.prototype : '<unknown>')+", and its source: "+(element && element['prototype'] && element['prototype']['toSource'] ? element.prototype.toSource() : '<unavailable>'))
        return false
    }

    //DOM-mangling stuff

    initialize_dom() {
        // set up the onchange handler for the email field
        let old_onchange = this.email_field.onchange
        this.email_field.onchange = (event) => {
            this.onchange_handler(event)
            if(old_onchange) {
                old_onchange(event)
            }
        }

        //set up the onsubmit handler for the form (if there is one)
        if(this.form) {
            let old_onsubmit = this.form.onsubmit
            this.form.onsubmit = (event) => {
                log.verbose("On Submit handler firing!")
                var results
                if(old_onsubmit) {
                    results = old_onsubmit(event) //TODO - confusing, *their* old onsubmit handler fires *first*?
                }                                   // Well, it could make sense - if you wanted to do something to interrupt the verification, you could?
                if(!old_onsubmit || results) {
                    return this.onsubmit_handler(event)
                }
            }
        }

        //disable submit button, if there is one - 
        this.disable_submits()
    }

    disable_submits() {
        this.set_submit_button_disabled(true)
    }

    enable_submits() {
        this.set_submit_button_disabled(false)
    }

    set_submit_button_disabled(state) {
        this.submittable = !state // if disabled == true, submittable = false; if disabled == false, submittable = true
        if(this.submit_button) {
            log.verbose("Trying to change submit button 'disabled' state to: "+state)
            if(is_array(this.submit_button)) {
                log.verbose("Submit button IS ARRAY")
                for(let x in this.submit_button) {
                    this.submit_button[x].disabled = state
                }
            } else {
                this.submit_button.disabled = state
            }
        }
    }

    update_hidden_fields(checksum, status) {
        this.insert_or_update_hidden('goodforms_checksum',checksum)
        this.insert_or_update_hidden('goodforms_status',status)
    }

    insert_or_update_hidden(name,value) {
        var possibles = this.form.elements //getElementsByName(name)
        for (let possible in possibles) {
            if(possible.name == name) {
                possible.value = value
                return
            }
        }
        var new_elem = document.createElement('input')
        let attributes = {'type': 'hidden','name': name,'value': value}
        for (let key in attributes) {
            new_elem.setAttribute(key,attributes[key])
        }
        this.form.appendChild(new_elem)
    }

    set_state(status) {
        ensure_css()
        let previous_classes = this.email_field.className.split(" ")
        let gf_classes = ["goodforms_valid_email", "goodforms_invalid_email","goodforms_loading_email"]
        let new_classes = []
        for(let className of previous_classes) {
            var found = 0;
            for(let gf_class of gf_classes) {
                if(gf_class == className) {
                    found++
                    break;
                }
            }
            if(!found) {
                new_classes.unshift(className)
            }
        }
        if(status) {
            new_classes.unshift("goodforms_" + status + "_email")
        }
        this.email_field.className = new_classes.join(" ")
    }


    // Event-management/hook-management helper methods

    parse_event_handler_results(result, behavior, visuals, allow_func, params) {
        if(typeof(result) === "undefined") { // undefined (or nothing returned), do default *everything*
            //do default VISUALS, *AND* default BEHAVIOR!
            behavior(...params)
            visuals(...params)
            return 
        } else if(result === false) { //NEGATIVE RESULT from pre-callback - do *NOT* invoke callback!
            // NO VISUALS. NO BEHAVIOR!
            return true
        } else if(result === true) { //TRUE RESULT  - continue normal behavior, but skip visuals
            return behavior(...params)
        } else if(is_function(result)) {
            if(allow_func) { //function allowed, invoke callback with appropriate parameters
                return result((nested_function_result) => {
                    return this.parse_event_handler_results(nested_function_result, behavior, visuals, false, params)
                }) 
            } else {
                log.error("Function type returned when function is not allowed.") //can't say *which* one tho TODO
                // raise? throw? TODO
            }
        } else {
            log.error("Unknown type returned from handler '"+(typeof result)+"'") //TODO would be nice to have *which* handler we've got an unknown type from
            // should we 'throw()' or something here? Great question.
        }
    }

    fire_hooks(name, behavior, visuals, ...params) {
        log.verbose("Firing hooks for: "+name)
        if(this.manual) {
            return
        }

        if(!this[name]) { // side-note, if we want to get super-froggy here we can set a 'default callback' of () => {} then everything runs like normal?
            //no hooks; go ahead and do the default stuff from 'callback'
            behavior(...params)
            visuals(...params)
            return
        }
        let tmp = this[name](...params)
        return this.parse_event_handler_results(tmp, behavior, visuals, true, params)
    }

    onchange_handler() {
        this.disable_submits() //field has changed; not submittable until this returns!
        this.verifying = this.email_field.value
        //FIXME - should we set an 'in-flight' variable, so we know not to double-verify?
        if(this.verifying == "" ) {
            return
        }
        this.verify(this.email_field.value, (results) => {
            log.debug("Verification results are: ")
            log.debugdir(results)
            //so weird, but the 'verify' method fires all the appropriate callbacks, so we don't do anything here?
        })
    }

    onbad_handler(detailed_status, message) {
        this.fire_hooks('onBad', () => {
            this.disable_submits()    
        }, 
        () => {
            if(this.visuals.bad) {
                //this.email_field.className
                //this.tooltip.show(message)
                this.set_state("invalid")
            }
        },
        detailed_status,
        message)
    }

    ongood_handler(detailed_status, checksum, message) {
        log.verbose("Uh, detailed status is, uh: "+detailed_status)
        this.fire_hooks('onGood', () => {
            if(this.form) {
                this.update_hidden_fields(checksum, detailed_status)
            }
            this.enable_submits()
        },
        () => {
            if(this.visuals.good) {
                this.set_state("valid")
            }    
        },
        detailed_status,
        message)
    }

    onchallenge_handler(challenge_key, message) {
        this.fire_hooks('onChallenge', () => {
            this.disable_submits();
        },
        () => {
            ///uh....throw up a prompt?
            if( !this.visuals.challenge ) {
                return
            }
            this.modal.show(challenge_key, message, () => {
                if(this.email_field.value != this.modal.get_challenge_address()) { 
                    log.debug("Field value: "+this.email_field.value+" , challenge_address: "+this.modal.get_challenge_address())
                    this.modal.bad_address()
                                                                                                                //TODO - interntaionalize!
                    return
                }
                this.challenge(this.email_field.value, challenge_key, (results) => {
                    log.verbose("Challenge results are: ")
                    log.verbosedir(results)
                    if(results.status == "ACCEPTED") {
                        this.modal.pin_input()
                        this.modal.set_modal_action( () => {
                            let pin = this.modal.get_pin_code()
                            this.response(this.email_field.value,challenge_key, pin, (response) => {
                                log.debugdir(response)
                                if(response.status == "GOOD") {
                                    this.modal.hide()
                                    /*
                                     * We need the following because the integrator may have their own way of displaying
                                     * a valid message, or hiding an *invalid* message - and we need to make sure
                                     * their hooks fire correctly. But also, we *do* want to update the checksums and all the
                                     * other default behavior of a 'good' verification
                                     */
                                    this.ongood_handler(response.status, response.checksum) //FIXME - that's supposed to be a 'detailed status' - not just GOOD
                                } else {
                                    this.modal.bad_pin()
                                }
                            })
                        })
                    } else {
                        window.alert("Challenge rejected!") //FIXME - should never happen tho! (well, unless maybe you sent too many emails?)
                    }
                })
            })
        })
    } 

    onerror_handler() {
        this.fire_hooks('onError',() => {
            log.debug("Error detected?")
            // this.tooltip.remove()
            this.enable_submits()
        },() => {
            this.set_state() //clears spinner
        })
    }

    onsubmit_handler(event) {
        //customer's hooks have already fired, let's go!
        //the additional check against the contents of the field are just in case some
        //browsers aren't quite so religious about running onChange handlers before onSubmit
        if(this.submittable && this.email_field.value === this.verifying) {
            return true
        }
        log.verbose("Cannot submit form - submittable? "+this.submittable+" our field value? "+this.email_field.value+" what we're verifying? "+this.verifying)
        if(this.email_field.value !== this.verifying) {
            log.verbose("sending new verification!")
            this.verify(this.email_field.value, (results) => {  //FIXME - this could double-verify!
                if(this.submittable && this.form) { //don't directly inspect 'results', assume the onBlah handlers will update 'submittable'
                    this.form.submit()
                }
            })
        }
        return false //the 'verify' callback above will actually do the work of submitting the form
    }

    // LOW-LEVEL JSON helpers
    // I'm wondering if we have a layering problem here, should maybe all the low-level (manual-mode) methods
    // be elsewhere? It could be argued.
    // but also, helpers that *we* use - so should they be invoking our callbacks for us?
    // maybe yes only if manual is false?

    jsp(url, data, complete) {
        data.form_key = this.form_key //this mutates the source; but we don't care for our purposes

        if (!this.form_key) {
            //do JS-based validation only; but invoke the same callbacks and whatnot the same as before.
            this.doh_server.verify(data, complete) // TODO - pass timeout?
        } else {
            //do server-side validation via GoodForms
            // yeah, harder than it seems - move the xhr to the inside of the resolver
            xhr(HOST+'/'+url, data,complete)
        }

    }

    verify(email, callback) {
        log.verbose("VERIFY low-level method invoked!")
        this.set_state("loading")
        this.jsp("verify", {email: email},
            (data) => {
                log.verbose(data)
                if(typeof data.error !== "undefined") { //out-of-band type of error, or does this *never* fire?
                    log.error(data.error)
                }
                let detailed_status = null
                if(data && data.checksum) { // FIXME - grabbing detailed status via SPLIT
                    detailed_status = data.checksum.split(";")[2] //what happens if there's a semicolon in the email? Well, it's gonna mess up.
                }

                switch(data.status) {
                    case "BAD":
                    this.onbad_handler(detailed_status, data.message)
                    break
    
                    case "GOOD":
                    this.ongood_handler(detailed_status, data.checksum, data.message)
                    break
    
                    case "CHALLENGE":
                    this.onchallenge_handler(data.challenge_key, data.message)
                    break

                    case "ERROR":
                    this.onerror_handler(data.message)
                    break
    
                    default:
                    log.error("UNKNOWN STATUS: "+data.status) //error here?
                    this.onerror_handler(data.message)
                }
                if(callback) { //TODO - should callback fire *first*, or *last*?
                    //I kinda feel like all the 'manual' stuff will use this, but nothing else will.
                    //oh, I take that back - if you try and submit the form and it hasn't been validated; then _that_
                    // verification will use this!
                    callback(data)
                }
            }
        )
    }

    challenge(email, challenge_key, callback) {
        this.jsp("challenge",
            {email: email, challenge_key: challenge_key},
            (data) => {
                callback(data)
                // switch(data.status) {
                //     case "GOOD":

                // }
            }
        )
    }

    response(email, challenge_key, pin, callback) {
        this.jsp("response",
            {email: email, challenge_key: challenge_key, pin: pin},
            (data) => { //ugh, this 'success' doesn't mean success.
                // if(data.error) {
                //     //uhm, yeah? Do, what, exactly?
                // }
                // if(this.tooltip) {
                //     this.tooltip.hide()
                // }
                // this.enable_submits()

                // not sure yet - (mental bit-rot) - but I think the above stuff is fully subsumed in firing the ongood_handler()
                callback(data)
        
            }
        )
    }
}