WashNGo-2.12.0.1: WASH is a family of EDSLs for programming Web applications in Haskell.

WASH.CGI.GuaranteedCGI

Contents

Synopsis

Basics

data CGI a Source

Instances

class Monad cgi => CGIMonad cgi Source

Instances

ask :: CGIMonad cgi => WithHTML DOCUMENT cgi a -> cgi ()Source

tell :: (CGIMonad cgi, CGIOutput a) => a -> cgi ()Source

Terminates script by sending its argument to the browser.

io :: (Read a, Show a) => IO a -> CGI aSource

Safe embedding of an IO action into the CGI monad. Intentionally not parameterized ver its monad to avoid its use inside of transactions.

run :: CGI () -> IO ()Source

Turns a CGI action into an IO action. Used to turn the main CGI action into the main function of the program. Typical use:

 main = run mainCGI

once :: (CGIMonad cgi, Read a, Show a) => cgi a -> cgi aSource

Brackets a CGI action so that only its result is visible. Improves efficiency by not executing the bracketed action after it has been performed once. Use this for avoiding the inefficient buildup of long interaction logs.

forever :: CGIMonad cgi => cgi () -> cgi ()Source

Repeats a CGI action without saving its state so that the size of the interaction log remains constant.

callWithCurrentHistory :: (CGIMonad cgi, Read a, Show a) => ((a -> cgi ()) -> a -> cgi ()) -> a -> cgi ()Source

Control operator for the CGI monad. Its specification is

 callWithCurrentHistory (\backto x -> action x >>= backto) x
 ==
 action x >>= callWithCurrentHistory (\backto x -> action x >>= backto)

However, callWithCurrentHistory is more efficient because it avoids the buildup of long interaction logs by cutting back every time just before action gets executed.

htell :: CGIMonad cgi => WithHTML HTML IO () -> cgi aSource

askOffline :: CGIMonad cgi => WithHTML HTML cgi a -> (Element -> IO ()) -> cgi ()Source

Links and Images

internalImageSource

Arguments

:: CGIMonad cgi 
=> FreeForm

the raw image

-> String

alternative text

-> WithHTML x cgi Image 

Reference to internal image.

externalImageSource

Arguments

:: CGIMonad cgi 
=> URL

URL of image

-> String

alternative text

-> WithHTML x cgi Image 

Reference to image by URL.

makeRef :: (CGIMonad cgi, AdmitChildA y, Monad m) => String -> WithHTML A m () -> cgi (WithHTML y m ())Source

Page Templates

Forms and Widgets

type HTMLField cgi x y a = WithHTML x cgi () -> WithHTML y cgi aSource

Every input widget maps the content generator for the widget (which may produce HTML elements or attributes) to the content generator of the widget.

Form Creation

Form Submission

submit :: (CGIMonad cgi, AdmitChildINPUT y, InputHandle h) => h INVALID -> (h VALID -> cgi ()) -> HTMLField cgi INPUT y ()Source

activeInputField :: (CGIMonad cgi, AdmitChildINPUT y, Reason a, Read a) => (a -> cgi ()) -> HTMLField cgi INPUT y ()Source

activate :: (CGIMonad cgi, InputHandle (i a), HasValue i, AdmitChildINPUT y) => (a -> cgi ()) -> HTMLField cgi INPUT y (i a INVALID) -> HTMLField cgi INPUT y (i a INVALID)Source

submitLink :: (CGIMonad cgi, AdmitChildA y, InputHandle h) => h INVALID -> (h VALID -> cgi ()) -> HTMLCons A y cgi ()Source

data DTree cgi x y Source

Abstract type of decisions trees. These trees provide structured validation.

dtleaf :: CGIMonad cgi => cgi () -> DTree cgi x ySource

Create a leaf in a decision tree from a CGI action.

dtnode :: (CGIMonad cgi, InputHandle h) => h INVALID -> (h VALID -> DTree cgi x y) -> DTree cgi x ySource

Create a node in a decision tree. Takes an invalid input field and a continuation. Validates the input field and passes it to the continuation if the validation was successful. The continuation can dispatch on the value of the input field and produces a new decision tree.

Textual Input

Checkbox

Button

radioGroup :: (CGIMonad cgi, Read a) => WithHTML x cgi (RadioGroup a INVALID)Source

Create a handle for a new radio group. This handle is invisible on the screen!

Image

Selection Box

selectMultiple :: (CGIMonad cgi, AdmitChildSELECT y, Eq a) => (a -> String) -> [a] -> [a] -> (Int, Int) -> HTMLField cgi SELECT y (InputField [a] INVALID)Source

selectSingle :: (CGIMonad cgi, AdmitChildSELECT y, Eq a) => (a -> String) -> Maybe a -> [a] -> HTMLField cgi SELECT y (InputField a INVALID)Source

File

Handle Manipulation

class HasValue i whereSource

Methods

value :: i a VALID -> aSource

extract a value from various kinds of input handles

data F0 x Source

Constructors

F0 

Instances

data F1 a x Source

Constructors

F1 (a x) 

Instances

data F2 a b x Source

Constructors

F2 (a x) (b x) 

Instances

data F3 a b c x Source

Constructors

F3 (a x) (b x) (c x) 

Instances

data F4 a b c d x Source

Constructors

F4 (a x) (b x) (c x) (d x) 

Instances

data F5 a b c d e x Source

Constructors

F5 (a x) (b x) (c x) (d x) (e x) 

Instances

data F6 a b c d e f x Source

Constructors

F6 (a x) (b x) (c x) (d x) (e x) (f x) 

Instances

data F8 a b c d e f g h x Source

Constructors

F8 (a x) (b x) (c x) (d x) (e x) (f x) (g x) (h x) 

data FL a x Source

FL is required to pass an unknown number of handles of the same type need to the callback function in a form submission. The handles need to be collected in a list and then wrapped in the FL data constructor

Constructors

FL [a x] 

Instances

data FA a b x Source

FA comes handy when you want to tag an input handle with some extra information, which is not itsefl an input handle and which is not validated by a form submission. The tag is the first argument and the handle is the second argument of the data constructor.

Constructors

FA a (b x) 

Instances

Attribute Shortcuts

Advanced

Installing Translators

runWithHook :: CGIOptions -> ([String] -> CGI ()) -> CGI () -> IO ()Source

Variant of run where an additional argument cgigen specifies an action taken when the script is invoked with a non-empty query string as in script-name?query-string

docTranslator :: [FreeForm] -> ([String] -> CGI ()) -> [String] -> CGI ()Source

A translator is a function [String] -> CGI (). It takes the query string of the URL (of type [String]) and translates it into a CGI action. docTranslator docs next takes a list of FreeForm documents and a next translator. It tries to select a document by its ffName and falls through to the next translator if no document matches.

lastTranslator :: [String] -> CGI ()Source

Terminates a sequence of translators.

Outputable Stuff

data Status Source

Constructors

Status 

Fields

statusCode :: Int

status code

statusReason :: String

reason phrase

statusContent :: Maybe (WithHTML () IO ())

more explanation

Instances

newtype Location Source

Constructors

Location URL

redirection

Instances

data FreeForm Source

Constructors

FreeForm 

Fields

ffName :: String

internal name

ffContentType :: String

MIME type

ffRawContents :: String

contents as octet stream

Instances

Predefined Types for Input Fields

newtype Text Source

Arbitrary string data. No quotes required.

Constructors

Text 

Fields

unText :: String
 

Instances

newtype NonEmpty Source

Non-empty strings.

Constructors

NonEmpty 

Fields

unNonEmpty :: String
 

newtype AllDigits Source

Non-empty strings of digits.

Constructors

AllDigits 

Fields

unAllDigits :: String
 

newtype Phone Source

Phone numbers.

Constructors

Phone 

Fields

unPhone :: String
 

newtype EmailAddress Source

Reads an email address according to RFC 2822

Constructors

EmailAddress 

newtype CreditCardNumber Source

Reads a credit card number and performs Luhn check on it.

data CreditCardExp Source

Reads credit card expiration dates in format /.

Constructors

CreditCardExp 

Fields

cceMonth :: Int
 
cceYear :: Int
 

newtype Password Source

A Password is a string of length >= 8 with characters taken from at least three of the four sets: lower case characters, upper case characters, digits, and special characters.

Constructors

Password 

Fields

unPassword :: String
 

data Optional a Source

Data type for transforming a field into an optional one. The Read syntax of Absent is the empty string, whereas the Read syntax of Present a is just the Read syntax of a. Analogously for Show.

Constructors

Absent 
Present a 

Instances

Read a => Read (Optional a)

Optional items are either empty or just the item

Show a => Show (Optional a) 
Reason a => Reason (Optional a) 

Lowlevel Options

data CGIOption Source

Constructors

NoPort

do not include port number in generated URLs

AutoPort

include automatically generated port number in generated URLs (default)

Port Int

use this port number in generated URLs

NoHttps

do not attempt to detect Https

AutoHttps

autodetect Https by checking for port number 443 and env var HTTPS (default)

FullURL

generate full URL including scheme, host, and port

PartialURL

generate absolute path URL, only (default)

SessionMode 

newtype URL Source

Constructors

URL 

Fields

unURL :: String
 

Instances

Read URL

String in URL format

Show URL 
Reason URL 

Servlets

makeServlet :: CGI () -> CGIProgramSource

Transform a CGI action into a servlet suitable for running from Marlow's web server.

makeServletWithHook :: ([String] -> CGI ()) -> CGI () -> CGIProgramSource

Like makeServlet with additional CGI generator as in runWithHook.

HTML and Style

Experimental Stuff

data FrameSet Source

Abstract data type of frame set generators.

data FrameLayout Source

Overall layout of a frame set: row-wise or column-wise.

Constructors

ROWS 
COLS 

Instances

data FrameSpacing Source

Division of space between elements of a frameset. See http://wp.netscape.com/assist/net_sites/frame_syntax.html

Constructors

FrameAbsolute Int

in pixels

FrameRelative Int

the * format

FramePercent Int

the % format

Instances

makeFrameset :: CGIMonad cgi => FrameLayout -> [(FrameSpacing, cgi FrameSet)] -> cgi FrameSetSource

Create a frameset, given a layout, its spacing, and its subframe(set)s.

framesetPage :: CGIMonad cgi => String -> cgi FrameSet -> cgi ()Source

Required wrapper for pages with frames. Takes a title and a FrameSet generator and displays the page.