controller

Documentation

Index

• Constants
• func AddRouters(router *mux.Router)
• func AllGrids(userid int) []string
• func CheckForExistingUser(u User) (bool, error)
• func Connect() (*sql.DB, error)
• func CountGridsWithName(gridname string) int
• func GetDocumentRoot() string
• func GetUserID(u User) (int, error)
• func GridChanged(w http.ResponseWriter, r *http.Request)
• func GridChooser(w http.ResponseWriter, r *http.Request)
• func GridClick(w http.ResponseWriter, r *http.Request)
• func GridDelete(w http.ResponseWriter, r *http.Request)
• func GridLoad(gridname string, userid int) string
• func GridNameUsed(w http.ResponseWriter, r *http.Request)
• func GridNew(w http.ResponseWriter, r *http.Request)
• func GridOpen(w http.ResponseWriter, r *http.Request)
• func GridPreview(w http.ResponseWriter, r *http.Request)
• func GridRedo(w http.ResponseWriter, r *http.Request)
• func GridSave(w http.ResponseWriter, r *http.Request)
• func GridSaveAs(w http.ResponseWriter, r *http.Request)
• func GridSaveCommon(w http.ResponseWriter, r *http.Request, gridname string)
• func GridScreen(w http.ResponseWriter, r *http.Request)
• func GridStatistics(w http.ResponseWriter, r *http.Request)
• func GridUndo(w http.ResponseWriter, r *http.Request)
• func HandleLogin(w http.ResponseWriter, r *http.Request)
• func HandleRegister(w http.ResponseWriter, r *http.Request)
• func HandleRequests()
• func MainPage(w http.ResponseWriter, r *http.Request)
• func Register(w http.ResponseWriter, r *http.Request)
• func UpdateDatabase(u User) error
• func ValidateForm(u User) error
• type Enabled
• type Session
  • func GetSession(w http.ResponseWriter, r *http.Request) (*Session, bool)
  • func NewSession() *Session
• type UIState
  • func (st UIState) GetEnabled() Enabled
  • func (st UIState) String() string
• type User

Constants

const (
	SESSION_COOKIE = "session_id"
)

Functions

func AddRouters

func AddRouters(router *mux.Router)

AddRouters adds the router handler functions

func AllGrids

func AllGrids(userid int) []string

AllGrids returns the list of all grid file names for this user.

func CheckForExistingUser

func CheckForExistingUser(u User) (bool, error)

CheckForExistingUser looks up a username in the users table and returns true if it exists

func Connect

func Connect() (*sql.DB, error)

Connect opens a connection to the gocrossword database.

func CountGridsWithName

func CountGridsWithName(gridname string) int

CountGridsWithName gets the number of grids in the table with a specified name. Broken out from the main function for ease of unit testing.

func GetDocumentRoot

func GetDocumentRoot() string

GetDocumentRoot returns the absolute path to the $PROJECT_ROOT/view/static directory.

func GetUserID

func GetUserID(u User) (int, error)

GetUserID returns the userid assigned for this username.

func GridChanged

func GridChanged(w http.ResponseWriter, r *http.Request)

GridChanged is a REST method to determine whether the grid has changed

func GridChooser

func GridChooser(w http.ResponseWriter, r *http.Request)

GridChooser displays a list of grids to choose from.

func GridClick

func GridClick(w http.ResponseWriter, r *http.Request)

GridClick handles adding or deleting a black cell on the grid.

func GridDelete

func GridDelete(w http.ResponseWriter, r *http.Request)

GridDelete delete the specified grid and redirects to main screen.

func GridLoad

func GridLoad(gridname string, userid int) string

GridLoad gets the jsonstr for the specified gridname from the database.

func GridNameUsed

func GridNameUsed(w http.ResponseWriter, r *http.Request)

GridNameUsed is a REST method to determine whether a grid by the specified name already exists in the database.

func GridNew

func GridNew(w http.ResponseWriter, r *http.Request)

GridNew creates a new grid and redirects to GridScreen

func GridOpen

func GridOpen(w http.ResponseWriter, r *http.Request)

GridOpen starts a new grid editing session with the specified grid name.

func GridPreview

func GridPreview(w http.ResponseWriter, r *http.Request)

GridPreview is a REST method that return the scaled SVG for the specified grid name.

func GridRedo

func GridRedo(w http.ResponseWriter, r *http.Request)

GridRedo redoes the latest add or remove black cell.

func GridSave

func GridSave(w http.ResponseWriter, r *http.Request)

GridSave adds or updates the database entry for this grid.

func GridSaveAs

func GridSaveAs(w http.ResponseWriter, r *http.Request)

GridSaveAs saves the grid under a new name

func GridSaveCommon

func GridSaveCommon(w http.ResponseWriter, r *http.Request, gridname string)

GridSaveCommon is a method used by both grid_save and grid_save_as.

func GridScreen

func GridScreen(w http.ResponseWriter, r *http.Request)

GridScreen displays the grid screen

func GridStatistics

func GridStatistics(w http.ResponseWriter, r *http.Request)

GridStatistics runs the statistics methods and returns the results

func GridUndo

func GridUndo(w http.ResponseWriter, r *http.Request)

GridUndo undoes the latest add or remove black cell.

func HandleLogin

func HandleLogin(w http.ResponseWriter, r *http.Request)

HandleLogin is a POST method that accepts a username and password, verifies them against the database, and redirects to the main page if they are valid.

func HandleRegister

func HandleRegister(w http.ResponseWriter, r *http.Request)

HandleRegister is a POST method that creates a new user in the database.

func HandleRequests

func HandleRequests()

HandleRequests registers all the routers and starts the server.

func MainPage

func MainPage(w http.ResponseWriter, r *http.Request)

MainPage shows the main page of the application

func Register

func Register(w http.ResponseWriter, r *http.Request)

Register displays the registration screen

func UpdateDatabase

func UpdateDatabase(u User) error

UpdateDatabase adds a user to the database. If the user already exists, updates the record. Returns any error message.

func ValidateForm

func ValidateForm(u User) error

ValidateForm checks for required fields

Types

type Enabled

type Enabled struct {
	GridNew      bool
	GridOpen     bool
	GridSave     bool
	GridSaveAs   bool
	GridClose    bool
	GridStats    bool
	GridEditGrid bool
	GridUndo     bool
	GridRedo     bool
	GridDelete   bool
}

type Session

type Session struct {
	USERID           int
	USERNAME         string
	EXPIRES          time.Time
	ENABLED          Enabled
	UISTATE          UIState
	MESSAGES         []string
	GRID             string
	GRID_INITIAL_SHA string
	GRIDNAME         string
	N                int
	BOXSIZE          int
	SVGSTR           string
	STATS            *model.Statistics
	GRIDLIST         []string
	NEXTURL          string
}

Session holds the values for an HTTP session

func GetSession

func GetSession(w http.ResponseWriter, r *http.Request) (*Session, bool)

GetSession gets the session ID from the request cookie and looks up the correct session in the session map. If there is no cookie, or if the session does not exist or has expired, a 401 HTTP error is written to the response and the ok boolean is set to false.

func NewSession

func NewSession() *Session

NewSession creates a new session and returns a pointer to it.

type UIState

type UIState byte

UIState reflects the state of the UI, and which menu items to enable.

const (
	MAIN_MENU            UIState = iota // 0
	GRID_CHOOSER                        // 1
	PROMPT_FOR_GRID_SIZE                // 2
	EDITING_GRID                        // 3
	EDITING_PUZZLE                      // 4
	EDITING_WORD                        // 5
)

func (UIState) GetEnabled

func (st UIState) GetEnabled() Enabled

GetEnabled returns a map of menu item names to whether to enable them.

func (UIState) String

func (st UIState) String() string

String returns a string representation of the byte value of this state.

type User

type User struct {
	// contains filtered or unexported fields
}