web

Documentation

Overview

Package web provides a webserver which allows for: viewing of results; administration of submissions, projects and tools; user management;

Index

• Constants
• Variables
• func Active() bool
• func AddProject(r *http.Request, c *context.C) (string, error)
• func AddSkeleton(r *http.Request, c *context.C) (string, error)
• func BaseTemplates() []string
• func CheckAccess(p string, c *context.C, ps map[string]user.Permission) error
• func CreateCheckstyle(r *http.Request, c *context.C) (string, error)
• func CreateFindbugs(r *http.Request, c *context.C) (string, error)
• func CreateJPF(r *http.Request, c *context.C) (string, error)
• func CreateJUnit(r *http.Request, c *context.C) (string, error)
• func CreateMake(r *http.Request, c *context.C) (string, error)
• func CreatePMD(r *http.Request, c *context.C) (string, error)
• func DeleteProjects(r *http.Request, c *context.C) (string, error)
• func DeleteResults(r *http.Request, c *context.C) (string, error)
• func DeleteSkeletons(r *http.Request, c *context.C) (string, error)
• func DeleteSubmissions(r *http.Request, c *context.C) (string, error)
• func DeleteUsers(r *http.Request, c *context.C) (string, error)
• func Downloaders() map[string]Downloader
• func EditFile(r *http.Request, c *context.C) (string, error)
• func EditProject(r *http.Request, c *context.C) (string, error)
• func EditSubmission(r *http.Request, c *context.C) (string, error)
• func EditTest(r *http.Request, c *context.C) (string, error)
• func EditUser(r *http.Request, c *context.C) (string, error)
• func ExportData(r *http.Request) (string, error)
• func FileHandler(origin string) http.Handler
• func GenerateAJAX(r *pat.Router)
• func GenerateDownloads(r *pat.Router, d map[string]Downloader)
• func GenerateGets(r *pat.Router, gets map[string]Getter, views map[string]string)
• func GeneratePosts(router *pat.Router, posts map[string]Poster, indexPosts map[string]bool)
• func GenerateViews(r *pat.Router, views map[string]string)
• func GetResult(r *context.Result, fileId bson.ObjectId) (result.Displayer, error)
• func Getters() map[string]Getter
• func ImportData(r *http.Request, c *context.C) (string, error)
• func IndexPosters() map[string]bool
• func LoadIntlola(r *http.Request) (string, error)
• func LoadSkeleton(r *http.Request) (string, error)
• func LoadTest(r *http.Request) (string, error)
• func Login(r *http.Request, c *context.C) (string, error)
• func Logout(r *http.Request, c *context.C) (string, error)
• func Permissions() map[string]user.Permission
• func Posters() map[string]Poster
• func RedirectHandler(dest string) http.Handler
• func Register(r *http.Request, c *context.C) (string, error)
• func RenameFiles(r *http.Request, c *context.C) (string, error)
• func Run(port uint)
• func RunTools(r *http.Request, c *context.C) (string, error)
• func StaticDir() string
• func SubmitArchive(r *http.Request, c *context.C) (string, error)
• func T(names ...string) *template.Template
• func TemplateDir() string
• func Views() map[string]string
• type AJAXGet
  • func (a AJAXGet) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type AJAXPost
  • func (a AJAXPost) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Args
• type Downloader
  • func (d Downloader) CreateDownload() Handler
• type Getter
  • func (g Getter) CreateGet(name, view string) Handler
• type Handler
  • func LoadView(n, v string) Handler
  • func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Poster
  • func (p Poster) CreatePost(index bool) Handler
• type Select
• type Selects
  • func (s Selects) Len() int
  • func (s Selects) Less(i, j int) bool
  • func (s Selects) Swap(i, j int)

Constants

const (
	LOG_SERVER      = "webserver/server.go"
	PORT       uint = 8080
)

const (
	LOG_HANDLERS = "webserver/handlers.go"
)

const (
	OUT user.Permission = 42
)

Variables

var (
	CountsError   = errors.New("unsupported counts request")
	CommentsError = errors.New("unsupported comments request")
	ResultsError  = errors.New("cannot retrieve results")
)

var (
	InvalidArgsError = errors.New("invalid args call")
)

var (
	JPFKeyError = errors.New("JPF key cannot be empty")
)

Functions

func Active

func Active() bool

Active is whether the server is currently running.

func AddProject

func AddProject(r *http.Request, c *context.C) (string, error)

AddProject creates a new Impendulo Project.

func AddSkeleton

func AddSkeleton(r *http.Request, c *context.C) (string, error)

func BaseTemplates

func BaseTemplates() []string

BaseTemplates loads the base HTML templates used by all views in the web app.

func CheckAccess

func CheckAccess(p string, c *context.C, ps map[string]user.Permission) error

CheckAccess verifies that a user is allowed access to a url.

func CreateCheckstyle

func CreateCheckstyle(r *http.Request, c *context.C) (string, error)

CreateCheckstyle

func CreateFindbugs

func CreateFindbugs(r *http.Request, c *context.C) (string, error)

CreateFindbugs

func CreateJPF

func CreateJPF(r *http.Request, c *context.C) (string, error)

CreateJPF replaces a project's JPF configuration with a new, provided configuration.

func CreateJUnit

func CreateJUnit(r *http.Request, c *context.C) (string, error)

CreateJUnit adds a new JUnit test for a given project.

func CreateMake

func CreateMake(r *http.Request, c *context.C) (string, error)

CreateMake

func CreatePMD

func CreatePMD(r *http.Request, c *context.C) (string, error)

CreatePMD creates PMD rules for a project from a provided list.

func DeleteProjects

func DeleteProjects(r *http.Request, c *context.C) (string, error)

DeleteProjects removes a project and all data associated with it from the system.

func DeleteResults

func DeleteResults(r *http.Request, c *context.C) (string, error)

DeleteResults removes all results for a specic project.

func DeleteSkeletons

func DeleteSkeletons(r *http.Request, c *context.C) (string, error)

func DeleteSubmissions

func DeleteSubmissions(r *http.Request, c *context.C) (string, error)

func DeleteUsers

func DeleteUsers(r *http.Request, c *context.C) (string, error)

DeleteUsers removes users and all data associated with them from the system.

func Downloaders

func Downloaders() map[string]Downloader

func EditFile

func EditFile(r *http.Request, c *context.C) (string, error)

EditFile

func EditProject

func EditProject(r *http.Request, c *context.C) (string, error)

EditProject is used to modify a project's metadata.

func EditSubmission

func EditSubmission(r *http.Request, c *context.C) (string, error)

EditSubmission

func EditTest

func EditTest(r *http.Request, c *context.C) (string, error)

func EditUser

func EditUser(r *http.Request, c *context.C) (string, error)

EditUser

func ExportData

func ExportData(r *http.Request) (string, error)

ExportData

func FileHandler

func FileHandler(origin string) http.Handler

func GenerateAJAX

func GenerateAJAX(r *pat.Router)

func GenerateDownloads

func GenerateDownloads(r *pat.Router, d map[string]Downloader)

GenerateDownloads

func GenerateGets

func GenerateGets(r *pat.Router, gets map[string]Getter, views map[string]string)

GenerateGets loads post request handlers and adds them to the router.

func GeneratePosts

func GeneratePosts(router *pat.Router, posts map[string]Poster, indexPosts map[string]bool)

GeneratePosts loads post request handlers and adds them to the router.

func GenerateViews

func GenerateViews(r *pat.Router, views map[string]string)

GenerateViews is used to load all the basic views used by our web app.

func GetResult

func GetResult(r *context.Result, fileId bson.ObjectId) (result.Displayer, error)

GetResult retrieves a DisplayResult for a given file and result name.

func Getters

func Getters() map[string]Getter

Getters retrieves all getters

func ImportData

func ImportData(r *http.Request, c *context.C) (string, error)

ImportData

func IndexPosters

func IndexPosters() map[string]bool

indexPosters loads the posters which need to be redirected to the home page on success.

func LoadIntlola

func LoadIntlola(r *http.Request) (string, error)

func LoadSkeleton

func LoadSkeleton(r *http.Request) (string, error)

LoadSkeleton makes a project skeleton available for download.

func LoadTest

func LoadTest(r *http.Request) (string, error)

LoadSkeleton makes a project skeleton available for download.

func Login

func Login(r *http.Request, c *context.C) (string, error)

Login signs a user into the web app.

func Logout

func Logout(r *http.Request, c *context.C) (string, error)

Logout logs a user out of the system.

func Permissions

func Permissions() map[string]user.Permission

Permissions loads all permissions.

func Posters

func Posters() map[string]Poster

Posters retrieves all posters

func RedirectHandler

func RedirectHandler(dest string) http.Handler

func Register

func Register(r *http.Request, c *context.C) (string, error)

Register registers a new user with Impendulo.

func RenameFiles

func RenameFiles(r *http.Request, c *context.C) (string, error)

func Run

func Run(port uint)

Run starts up the webserver if it is not currently running.

func RunTools

func RunTools(r *http.Request, c *context.C) (string, error)

RunTools runs a tool on submissions in a given project. Previous results are deleted if the user has specified that the tool should be rerun on all files.

func StaticDir

func StaticDir() string

StaticDir retrieves the directory containing all the static files for the web server.

func SubmitArchive

func SubmitArchive(r *http.Request, c *context.C) (string, error)

SubmitArchive adds an Intlola archive to the database.

func T

func T(names ...string) *template.Template

T creates a new HTML template from the given files.

func TemplateDir

func TemplateDir() string

TemplateDir retrieves the directory in which HTML templates are stored.

func Views

func Views() map[string]string

Views loads all views.

Types

type AJAXGet

type AJAXGet func(*http.Request) ([]byte, error)

func (AJAXGet) ServeHTTP

func (a AJAXGet) ServeHTTP(w http.ResponseWriter, r *http.Request)

type AJAXPost

type AJAXPost func(http.ResponseWriter, *http.Request) error

func (AJAXPost) ServeHTTP

func (a AJAXPost) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Args

type Args map[string]interface{}

Args represents arguments passed to html templates or to template.Execute.

type Downloader

type Downloader func(*http.Request) (path string, err error)

func (Downloader) CreateDownload

func (d Downloader) CreateDownload() Handler

CreateDownload.

type Getter

type Getter func(r *http.Request, c *context.C) (Args, string, error)

func (Getter) CreateGet

func (g Getter) CreateGet(name, view string) Handler

type Handler

type Handler func(http.ResponseWriter, *http.Request, *context.C) error

Handler is used to handle incoming requests. It allows for better session management.

func LoadView

func LoadView(n, v string) Handler

LoadView loads a view so that it is accessible in our web app.

func (Handler) ServeHTTP

func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP loads a the current session, handles the request and then stores the session.

type Poster

type Poster func(*http.Request, *context.C) (string, error)

A function used to fullfill a POST request.

func (Poster) CreatePost

func (p Poster) CreatePost(index bool) Handler

CreatePost loads a post request handler.

type Select

type Select struct {
	Id, Name string
	User     bool
}

type Selects

type Selects []*Select

func (Selects) Len

func (s Selects) Len() int

func (Selects) Less

func (s Selects) Less(i, j int) bool

func (Selects) Swap

func (s Selects) Swap(i, j int)