webutil

README

Web Utility for Golang websites.

Webutil is a simple, lightweight utility for Golang websites.

It loads, selects the right mime, and caches static (js, css, image,...), and html files. It also has a place-holder to apply security in order to withhold a file (i.e. a javascript file).

To run the test sample:

• Start a shell window in sample directory.
• go build -o webutilDemo && ./webutilDemo
• Navigate to http://localhost:8005/mypage.html

Documentation

Overview

Package webutil implements some Web utility functions. It also implments a cache mechanism for any file that is to be served via http.

Index

• type HTTP
  • func NewHTTP(rootPhysicalPath string, cacheDuration time.Duration) *HTTP
  • func (h *HTTP) AddSuffix(rPath string, fileExtension string) string
  • func (h *HTTP) GenerateSessionID(r *http.Request) string
  • func (h *HTTP) GetCookie(cname string, r *http.Request) string
  • func (h *HTTP) GetMIMEContentType(ext string) string
  • func (h *HTTP) IsPortNoValid(portno int) bool
  • func (h *HTTP) RemoveCommentsFromBiteArry(b []byte, begin string, end string) []byte
  • func (h *HTTP) RemoveCommentsFromByBiteArry(b []byte, begin string, end string) []byte
  • func (h *HTTP) RemoveCommentsFromString(s string, begin string, end string) string
  • func (h *HTTP) RemoveCookie(cname string, r *http.Request, w http.ResponseWriter) bool
  • func (h *HTTP) ServeStaticFile(w http.ResponseWriter, r *http.Request)
  • func (h *HTTP) SetContentTypeAndWrite(w http.ResponseWriter, r *http.Request, f []byte) bool
  • func (h *HTTP) SetCookie(cname string, cvalue string, maxAge int, w http.ResponseWriter) string
• type UserSession

Types

type HTTP

type HTTP struct {
	RootPhysicalPath string
	CacheDuration    time.Duration
	Webcache         *webcache.Cache
}

HTTP are common http callback functions.

func NewHTTP

func NewHTTP(rootPhysicalPath string, cacheDuration time.Duration) *HTTP

NewHTTP creates a new instance of webutil.

func (*HTTP) AddSuffix

func (h *HTTP) AddSuffix(rPath string, fileExtension string) string

AddSuffix adds file extension (i.e. .html) to the path if not present. It will check for /null in the path (maybe passed by javascript in error). It also adds index.html to the path, if the path is a directory.

func (*HTTP) GenerateSessionID

func (h *HTTP) GenerateSessionID(r *http.Request) string

GenerateSessionID creates a sessionID that is comprised of a double MD5 of caller's IP address and user agent.

func (*HTTP) GetCookie

func (h *HTTP) GetCookie(cname string, r *http.Request) string

GetCookie finds a target cookie and returns the string.

func (*HTTP) GetMIMEContentType

func (h *HTTP) GetMIMEContentType(ext string) string

GetMIMEContentType first checks the standard extensions i.e. .png, .js,... if not found it uses a custom parsing to return the right content type.

func (*HTTP) IsPortNoValid

func (h *HTTP) IsPortNoValid(portno int) bool

IsPortNoValid checks the ragne of an tcp/ip port number.

func (*HTTP) RemoveCommentsFromBiteArry

func (h *HTTP) RemoveCommentsFromBiteArry(b []byte, begin string, end string) []byte

RemoveCommentsFromByBiteArry removes a block of text from a byte array.

func (*HTTP) RemoveCommentsFromByBiteArry

func (h *HTTP) RemoveCommentsFromByBiteArry(b []byte, begin string, end string) []byte

RemoveCommentsFromByBiteArry removes a block of text from a byte array.

func (*HTTP) RemoveCommentsFromString

func (h *HTTP) RemoveCommentsFromString(s string, begin string, end string) string

RemoveCommentsFromString removes a block of text from inside an string.

func (*HTTP) RemoveCookie

func (h *HTTP) RemoveCookie(cname string, r *http.Request, w http.ResponseWriter) bool

RemoveCookie a cookie by setting its expiration in the past.

func (*HTTP) ServeStaticFile

func (h *HTTP) ServeStaticFile(w http.ResponseWriter, r *http.Request)

ServeStaticFile processes static files for a website. Static files are the ones that require no additional rending before their content is written to a ResponseWrite object, hence no custom error handling, if file is not found. The MIME is written to the Response Header according to the extension of the requested file. Examples are: .js, .css, .html.

func (*HTTP) SetContentTypeAndWrite

func (h *HTTP) SetContentTypeAndWrite(w http.ResponseWriter, r *http.Request, f []byte) bool

SetContentTypeAndWrite writes the response and reutrns false, if mime type not found; returns true if mime type found. It uses the conent passed via an arg rather than than that of the request.

func (*HTTP) SetCookie

func (h *HTTP) SetCookie(cname string, cvalue string, maxAge int, w http.ResponseWriter) string

SetCookie creates a cookie by setting the Set-Cookie header. A value of zeor for maxAge will mean that the cookie will never expire.

type UserSession

type UserSession struct {
	Email                        string
	CustomerID                   int
	FirstName                    string
	LastName                     string
	EmailVerified                bool
	SessionID                    string
	VerificationCodeExpires      time.Time
	LastVerificationCodeRequest  time.Time
	VerificationCodeRequestCount int
}

UserSession defines a web user session.