1cc2306cbf
* Add the PollVotes table and associated logic. * Multiple choice polls supported. * Expiring and non-expiring polls. * Icons and badges on the forum pages to show posts with polls * Bugfix: non-explicit users getting SQL errors on Newest Posts page.
136 lines
3.3 KiB
Go
136 lines
3.3 KiB
Go
package models
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
"code.nonshy.com/nonshy/website/pkg/config"
|
|
)
|
|
|
|
// Poll table for user surveys posted in the forums.
|
|
type Poll struct {
|
|
ID uint64 `gorm:"primaryKey"`
|
|
|
|
// Poll options
|
|
Choices string // line-separated choices
|
|
MultipleChoice bool // User can vote multiple choices
|
|
CustomAnswers bool // Users can contribute a custom response
|
|
|
|
Expires bool // if it stops accepting new votes
|
|
ExpiresAt time.Time // when it stops accepting new votes
|
|
|
|
CreatedAt time.Time
|
|
UpdatedAt time.Time
|
|
}
|
|
|
|
// CreatePoll initializes a poll.
|
|
//
|
|
// expires is in days (0 = doesn't expire)
|
|
func CreatePoll(choices []string, expires int) *Poll {
|
|
return &Poll{
|
|
Choices: strings.Join(choices, "\n"),
|
|
Expires: expires > 0,
|
|
ExpiresAt: time.Now().Add(time.Duration(expires) * 24 * time.Hour),
|
|
}
|
|
}
|
|
|
|
// GetPoll by ID.
|
|
func GetPoll(id uint64) (*Poll, error) {
|
|
m := &Poll{}
|
|
result := DB.First(&m, id)
|
|
return m, result.Error
|
|
}
|
|
|
|
// Options returns a conveniently formatted listing of the options.
|
|
func (p *Poll) Options() []string {
|
|
return strings.Split(p.Choices, "\n")
|
|
}
|
|
|
|
// IsExpired returns if the poll has ended.
|
|
func (p *Poll) IsExpired() bool {
|
|
return p.Expires && time.Now().After(p.ExpiresAt)
|
|
}
|
|
|
|
// InputType returns "radio" or "checkbox" for multiple choice polls.
|
|
func (p *Poll) InputType() string {
|
|
if p.MultipleChoice {
|
|
return "checkbox"
|
|
}
|
|
return "radio"
|
|
}
|
|
|
|
// Result returns metadata about a poll's status and results, for frontend assist.
|
|
func (p *Poll) Result(currentUser *User) PollResult {
|
|
var (
|
|
result = PollResult{
|
|
AcceptingVotes: true,
|
|
CurrentUserVote: []string{},
|
|
Results: map[string]int{},
|
|
ResultsPercent: map[string]float64{},
|
|
ResultsClass: map[string]string{},
|
|
}
|
|
votes = p.GetAllVotes()
|
|
distinctAnswers int
|
|
)
|
|
|
|
// Populate the CSS classes.
|
|
for i, answer := range p.Options() {
|
|
result.ResultsClass[answer] = config.PollProgressBarClasses[i%len(config.PollProgressBarClasses)]
|
|
}
|
|
|
|
result.TotalVotes = len(votes)
|
|
for _, res := range votes {
|
|
if res.UserID == currentUser.ID {
|
|
result.CurrentUserVote = append(result.CurrentUserVote, res.Answer)
|
|
result.AcceptingVotes = false
|
|
}
|
|
|
|
if _, ok := result.Results[res.Answer]; !ok {
|
|
distinctAnswers++
|
|
result.Results[res.Answer] = 0
|
|
result.ResultsPercent[res.Answer] = 0
|
|
}
|
|
result.Results[res.Answer]++
|
|
}
|
|
|
|
// Compute the percent splits.
|
|
if result.TotalVotes > 0 {
|
|
for answer, count := range result.Results {
|
|
result.ResultsPercent[answer] = float64(count) / float64(result.TotalVotes)
|
|
}
|
|
}
|
|
|
|
// Expired polls don't accept answers.
|
|
if p.IsExpired() {
|
|
result.AcceptingVotes = false
|
|
}
|
|
|
|
return result
|
|
}
|
|
|
|
// Save Poll.
|
|
func (p *Poll) Save() error {
|
|
result := DB.Save(p)
|
|
return result.Error
|
|
}
|
|
|
|
// PollResult holds metadata about the poll result for frontend display.
|
|
type PollResult struct {
|
|
AcceptingVotes bool // user voted or it expired
|
|
CurrentUserVote []string // current user's selection, if any
|
|
Results map[string]int // answers and their %
|
|
ResultsPercent map[string]float64
|
|
ResultsClass map[string]string // progress bar classes
|
|
TotalVotes int
|
|
}
|
|
|
|
func (pr PollResult) GetPercent(answer string) string {
|
|
value := pr.ResultsPercent[answer]
|
|
return fmt.Sprintf("%.1f", value*100)
|
|
}
|
|
|
|
func (pr PollResult) GetClass(answer string) string {
|
|
return pr.ResultsClass[answer]
|
|
}
|