mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-08-30 22:36:05 +02:00
![René Schaar](/assets/img/avatar_default.png)
* Fix display time of milestones * Move the SecToTime function From the models/issue_stopwatch.go file to the modules/util package * Rename the sec_to_time file * Updated formatting * Include copyright notice in sec_to_time.go * Apply PR review suggestions - Update copyright notice dates to 2022 - Change `1 day 3h 5min 7s` to `1d 3h 5m 7s` * Rename hrs var and combine conditions * Update unit tests to match new time pattern Changed `1min` to `1m` Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
267 lines
6.7 KiB
Go
267 lines
6.7 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package models
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/timeutil"
|
|
"code.gitea.io/gitea/modules/util"
|
|
)
|
|
|
|
// ErrIssueStopwatchNotExist represents an error that stopwatch is not exist
|
|
type ErrIssueStopwatchNotExist struct {
|
|
UserID int64
|
|
IssueID int64
|
|
}
|
|
|
|
func (err ErrIssueStopwatchNotExist) Error() string {
|
|
return fmt.Sprintf("issue stopwatch doesn't exist[uid: %d, issue_id: %d", err.UserID, err.IssueID)
|
|
}
|
|
|
|
// ErrIssueStopwatchAlreadyExist represents an error that stopwatch is already exist
|
|
type ErrIssueStopwatchAlreadyExist struct {
|
|
UserID int64
|
|
IssueID int64
|
|
}
|
|
|
|
func (err ErrIssueStopwatchAlreadyExist) Error() string {
|
|
return fmt.Sprintf("issue stopwatch already exists[uid: %d, issue_id: %d", err.UserID, err.IssueID)
|
|
}
|
|
|
|
// Stopwatch represents a stopwatch for time tracking.
|
|
type Stopwatch struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
IssueID int64 `xorm:"INDEX"`
|
|
UserID int64 `xorm:"INDEX"`
|
|
CreatedUnix timeutil.TimeStamp `xorm:"created"`
|
|
}
|
|
|
|
func init() {
|
|
db.RegisterModel(new(Stopwatch))
|
|
}
|
|
|
|
// Seconds returns the amount of time passed since creation, based on local server time
|
|
func (s Stopwatch) Seconds() int64 {
|
|
return int64(timeutil.TimeStampNow() - s.CreatedUnix)
|
|
}
|
|
|
|
// Duration returns a human-readable duration string based on local server time
|
|
func (s Stopwatch) Duration() string {
|
|
return util.SecToTime(s.Seconds())
|
|
}
|
|
|
|
func getStopwatch(ctx context.Context, userID, issueID int64) (sw *Stopwatch, exists bool, err error) {
|
|
sw = new(Stopwatch)
|
|
exists, err = db.GetEngine(ctx).
|
|
Where("user_id = ?", userID).
|
|
And("issue_id = ?", issueID).
|
|
Get(sw)
|
|
return
|
|
}
|
|
|
|
// GetUserStopwatches return list of all stopwatches of a user
|
|
func GetUserStopwatches(userID int64, listOptions db.ListOptions) ([]*Stopwatch, error) {
|
|
sws := make([]*Stopwatch, 0, 8)
|
|
sess := db.GetEngine(db.DefaultContext).Where("stopwatch.user_id = ?", userID)
|
|
if listOptions.Page != 0 {
|
|
sess = db.SetSessionPagination(sess, &listOptions)
|
|
}
|
|
|
|
err := sess.Find(&sws)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return sws, nil
|
|
}
|
|
|
|
// CountUserStopwatches return count of all stopwatches of a user
|
|
func CountUserStopwatches(userID int64) (int64, error) {
|
|
return db.GetEngine(db.DefaultContext).Where("user_id = ?", userID).Count(&Stopwatch{})
|
|
}
|
|
|
|
// StopwatchExists returns true if the stopwatch exists
|
|
func StopwatchExists(userID, issueID int64) bool {
|
|
_, exists, _ := getStopwatch(db.DefaultContext, userID, issueID)
|
|
return exists
|
|
}
|
|
|
|
// HasUserStopwatch returns true if the user has a stopwatch
|
|
func HasUserStopwatch(userID int64) (exists bool, sw *Stopwatch, err error) {
|
|
return hasUserStopwatch(db.GetEngine(db.DefaultContext), userID)
|
|
}
|
|
|
|
func hasUserStopwatch(e db.Engine, userID int64) (exists bool, sw *Stopwatch, err error) {
|
|
sw = new(Stopwatch)
|
|
exists, err = e.
|
|
Where("user_id = ?", userID).
|
|
Get(sw)
|
|
return
|
|
}
|
|
|
|
// FinishIssueStopwatchIfPossible if stopwatch exist then finish it otherwise ignore
|
|
func FinishIssueStopwatchIfPossible(ctx context.Context, user *user_model.User, issue *Issue) error {
|
|
_, exists, err := getStopwatch(ctx, user.ID, issue.ID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if !exists {
|
|
return nil
|
|
}
|
|
return FinishIssueStopwatch(ctx, user, issue)
|
|
}
|
|
|
|
// CreateOrStopIssueStopwatch create an issue stopwatch if it's not exist, otherwise finish it
|
|
func CreateOrStopIssueStopwatch(user *user_model.User, issue *Issue) error {
|
|
_, exists, err := getStopwatch(db.DefaultContext, user.ID, issue.ID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if exists {
|
|
return FinishIssueStopwatch(db.DefaultContext, user, issue)
|
|
}
|
|
return CreateIssueStopwatch(db.DefaultContext, user, issue)
|
|
}
|
|
|
|
// FinishIssueStopwatch if stopwatch exist then finish it otherwise return an error
|
|
func FinishIssueStopwatch(ctx context.Context, user *user_model.User, issue *Issue) error {
|
|
sw, exists, err := getStopwatch(ctx, user.ID, issue.ID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if !exists {
|
|
return ErrIssueStopwatchNotExist{
|
|
UserID: user.ID,
|
|
IssueID: issue.ID,
|
|
}
|
|
}
|
|
|
|
// Create tracked time out of the time difference between start date and actual date
|
|
timediff := time.Now().Unix() - int64(sw.CreatedUnix)
|
|
|
|
// Create TrackedTime
|
|
tt := &TrackedTime{
|
|
Created: time.Now(),
|
|
IssueID: issue.ID,
|
|
UserID: user.ID,
|
|
Time: timediff,
|
|
}
|
|
|
|
if err := db.Insert(ctx, tt); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := issue.loadRepo(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if _, err := createComment(ctx, &CreateCommentOptions{
|
|
Doer: user,
|
|
Issue: issue,
|
|
Repo: issue.Repo,
|
|
Content: util.SecToTime(timediff),
|
|
Type: CommentTypeStopTracking,
|
|
TimeID: tt.ID,
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
_, err = db.GetEngine(ctx).Delete(sw)
|
|
return err
|
|
}
|
|
|
|
// CreateIssueStopwatch creates a stopwatch if not exist, otherwise return an error
|
|
func CreateIssueStopwatch(ctx context.Context, user *user_model.User, issue *Issue) error {
|
|
e := db.GetEngine(ctx)
|
|
if err := issue.loadRepo(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
// if another stopwatch is running: stop it
|
|
exists, sw, err := hasUserStopwatch(e, user.ID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if exists {
|
|
issue, err := getIssueByID(e, sw.IssueID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := FinishIssueStopwatch(ctx, user, issue); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// Create stopwatch
|
|
sw = &Stopwatch{
|
|
UserID: user.ID,
|
|
IssueID: issue.ID,
|
|
}
|
|
|
|
if err := db.Insert(ctx, sw); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := issue.loadRepo(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if _, err := createComment(ctx, &CreateCommentOptions{
|
|
Doer: user,
|
|
Issue: issue,
|
|
Repo: issue.Repo,
|
|
Type: CommentTypeStartTracking,
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// CancelStopwatch removes the given stopwatch and logs it into issue's timeline.
|
|
func CancelStopwatch(user *user_model.User, issue *Issue) error {
|
|
ctx, committer, err := db.TxContext()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer committer.Close()
|
|
if err := cancelStopwatch(ctx, user, issue); err != nil {
|
|
return err
|
|
}
|
|
return committer.Commit()
|
|
}
|
|
|
|
func cancelStopwatch(ctx context.Context, user *user_model.User, issue *Issue) error {
|
|
e := db.GetEngine(ctx)
|
|
sw, exists, err := getStopwatch(ctx, user.ID, issue.ID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if exists {
|
|
if _, err := e.Delete(sw); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := issue.loadRepo(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
if _, err := createComment(ctx, &CreateCommentOptions{
|
|
Doer: user,
|
|
Issue: issue,
|
|
Repo: issue.Repo,
|
|
Type: CommentTypeCancelTracking,
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|