documize/domain/section/github/model.go

// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
//
// This software (Documize Community Edition) is licensed under
// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
//
// You can operate outside the AGPL restrictions by purchasing
// Documize Enterprise Edition and obtaining a commercial license
// by contacting <sales@documize.com>.
//
// https://documize.com

package github

import (
	"context"
	"sort"
	"strings"
	"time"

	gogithub "github.com/google/go-github/github"
)

type githubRender struct {
	Config           githubConfig        `json:"config"`
	List             []githubBranch      `json:"list"`
	RepoCount        int                 `json:"repoCount"`
	ShowList         bool                `json:"showList"`
	ShowIssueNumbers bool                `json:"showIssueNumbers"`
	BranchCommits    []githubCommit      `json:"branchCommits"`
	HasCommits       bool                `json:"hasCommits"`
	CommitCount      int                 `json:"commitCount"`
	Issues           []githubIssue       `json:"issues"`
	HasIssues        bool                `json:"hasIssues"`
	SharedLabels     []githubSharedLabel `json:"sharedLabels"`
	HasSharedLabels  bool                `json:"hasSharedLabels"`
	OpenIssues       int                 `json:"openIssues"`
	ClosedIssues     int                 `json:"closedIssues"`
	Limit            int                 `json:"limit"`
	Milestones       []githubMilestone   `json:"milestones"`
	HasMilestones    bool                `json:"hasMilestones"`
	OpenMS           int                 `json:"openMS"`
	ClosedMS         int                 `json:"closedMS"`
	OpenPRs          int                 `json:"openPRs"`
	ClosedPRs        int                 `json:"closedPRs"`
	AuthorStats      []githubAuthorStats `json:"authorStats"`
	HasAuthorStats   bool                `json:"hasAuthorStats"`
	NumContributors  int                 `json:"numContributors"`
}

type report struct {
	refresh  func(*githubRender, *githubConfig, *gogithub.Client) error
	render   func(*githubRender, *githubConfig) error
	template string
}

var reports = make(map[string]report)

type githubOwner struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type githubBranch struct {
	ID       string `json:"id"`
	Owner    string `json:"owner"`
	Repo     string `json:"repo"`
	Name     string `json:"name"`
	Included bool   `json:"included"`
	URL      string `json:"url"`
	Color    string `json:"color,omitempty"`
	Comma    bool   `json:"comma"`
	Private  bool   `json:"private"`
}

type githubLabel struct {
	ID       string `json:"id"`
	Owner    string `json:"owner"`
	Repo     string `json:"repo"`
	Name     string `json:"name"`
	Included bool   `json:"included"`
	URL      string `json:"url"`
	Color    string `json:"color,omitempty"`
}

type githubConfig struct {
	Token          string            `json:"-"` // NOTE very important that the secret Token is not leaked to the client side, so "-"
	UserID         string            `json:"userId"`
	PageID         string            `json:"pageId"`
	Owner          string            `json:"owner_name"`
	BranchSince    string            `json:"branchSince,omitempty"`
	SincePtr       *time.Time        `json:"-"`
	Since          string            `json:"-"`
	BranchLines    int               `json:"branchLines,omitempty,string"`
	OwnerInfo      githubOwner       `json:"owner"`
	ClientID       string            `json:"clientId"`
	CallbackURL    string            `json:"callbackUrl"`
	Lists          []githubBranch    `json:"lists,omitempty"`
	ReportOrder    []string          `json:"-"`
	DateMessage    string            `json:"-"`
	UserNames      map[string]string `json:"UserNames"`
	ShowMilestones bool              `json:"showMilestones,omitempty"`
	ShowIssues     bool              `json:"showIssues,omitempty"`
	ShowCommits    bool              `json:"showCommits,omitempty"`
}

func (c *githubConfig) Clean() {
	c.Owner = c.OwnerInfo.Name
	if len(c.BranchSince) >= len("yyyy/mm/dd hh:ss") {
		var since time.Time
		tt := []byte("yyyy-mm-ddThh:mm:00Z")
		for _, i := range []int{0, 1, 2, 3, 5, 6, 8, 9, 11, 12, 14, 15} {
			tt[i] = c.BranchSince[i]
		}
		err := since.UnmarshalText(tt)
		if err != nil {
		} else {
			c.SincePtr = &since
		}
	}
	if c.SincePtr == nil {
		c.DateMessage = " (the last 7 days)"
		since := time.Now().AddDate(0, 0, -7)
		c.SincePtr = &since
	} else {
		c.DateMessage = ""
	}
	c.Since = (*c.SincePtr).Format(issuesTimeFormat)

	c.ReportOrder = []string{tagSummaryData}

	if c.ShowMilestones {
		c.ReportOrder = append(c.ReportOrder, tagMilestonesData)
	}
	if c.ShowIssues {
		c.ReportOrder = append(c.ReportOrder, tagIssuesData)
	}
	if c.ShowCommits {
		c.ReportOrder = append(c.ReportOrder, tagCommitsData)
	}

	c.BranchLines = 100 // overide  any existing value with maximum allowable in one call

	sort.Sort(branchesToSort(c.Lists)) // get the configured branches in a sensible order for display

	lastItem := 0
	for i := range c.Lists {
		c.Lists[i].Comma = true
		if c.Lists[i].Included {
			lastItem = i
		}
	}
	if lastItem < len(c.Lists) {
		c.Lists[lastItem].Comma = false
	}

	if c.UserNames == nil {
		c.UserNames = make(map[string]string)
	}

}

type githubCallbackT struct {
	AccessToken string `json:"access_token"`
}

func repoName(branchName string) string {
	bits := strings.Split(branchName, "/")
	if len(bits) != 2 {
		return branchName + "?repo"
	}
	pieces := strings.Split(bits[1], ":")
	if len(pieces) == 0 {
		return branchName + "?repo:?branch"
	}
	return pieces[0]
}

func getUserName(client *gogithub.Client, config *githubConfig, login string) (fullName string) {
	an := login
	if content, found := config.UserNames[login]; found {
		if len(content) > 0 {
			an = content
		}
	} else {
		usr, _, err := client.Users.Get(context.Background(), login)
		if err == nil {
			if usr.Name != nil {
				if len(*usr.Name) > 0 {
					config.UserNames[login] = *usr.Name
					an = *usr.Name
				}
			}
		} else {
			config.UserNames[login] = login // don't look again for a missing name
		}
	}
	return an
}