forgejo/modules/base/tool.go

573 lines
14 KiB
Go
Raw Normal View History

2014-02-18 22:31:16 +00:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
2014-03-07 22:22:15 +00:00
package base
2014-02-18 22:31:16 +00:00
import (
2014-03-16 16:07:35 +00:00
"bytes"
2014-02-18 22:31:16 +00:00
"crypto/md5"
2014-03-19 11:21:23 +00:00
"crypto/rand"
"crypto/sha1"
2014-02-18 22:31:16 +00:00
"encoding/hex"
2014-03-16 15:30:35 +00:00
"encoding/json"
2014-03-14 06:32:11 +00:00
"fmt"
2014-03-15 16:29:49 +00:00
"math"
2014-03-19 12:27:27 +00:00
"strconv"
"strings"
2014-03-14 06:32:11 +00:00
"time"
2014-02-18 22:31:16 +00:00
)
// Encode string to md5 hex value
func EncodeMd5(str string) string {
m := md5.New()
m.Write([]byte(str))
return hex.EncodeToString(m.Sum(nil))
}
2014-03-14 06:32:11 +00:00
2014-03-22 17:44:02 +00:00
// GetRandomString generate random string by specify chars.
func GetRandomString(n int, alphabets ...byte) string {
2014-03-19 11:21:23 +00:00
const alphanum = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
var bytes = make([]byte, n)
rand.Read(bytes)
for i, b := range bytes {
2014-03-22 17:44:02 +00:00
if len(alphabets) == 0 {
bytes[i] = alphanum[b%byte(len(alphanum))]
} else {
bytes[i] = alphabets[b%byte(len(alphabets))]
}
2014-03-19 11:21:23 +00:00
}
return string(bytes)
}
2014-03-19 16:50:44 +00:00
// verify time limit code
func VerifyTimeLimitCode(data string, minutes int, code string) bool {
if len(code) <= 18 {
return false
}
// split code
start := code[:12]
lives := code[12:18]
if d, err := StrTo(lives).Int(); err == nil {
minutes = d
}
// right active code
retCode := CreateTimeLimitCode(data, minutes, start)
if retCode == code && minutes > 0 {
// check time is expired or not
before, _ := DateParse(start, "YmdHi")
now := time.Now()
if before.Add(time.Minute*time.Duration(minutes)).Unix() > now.Unix() {
return true
}
}
return false
}
const TimeLimitCodeLength = 12 + 6 + 40
2014-03-19 11:21:23 +00:00
// create a time limit code
// code format: 12 length date time string + 6 minutes string + 40 sha1 encoded string
func CreateTimeLimitCode(data string, minutes int, startInf interface{}) string {
format := "YmdHi"
var start, end time.Time
var startStr, endStr string
if startInf == nil {
// Use now time create code
start = time.Now()
startStr = DateFormat(start, format)
} else {
// use start string create code
startStr = startInf.(string)
start, _ = DateParse(startStr, format)
startStr = DateFormat(start, format)
}
end = start.Add(time.Minute * time.Duration(minutes))
endStr = DateFormat(end, format)
// create sha1 encode string
sh := sha1.New()
2014-03-19 12:27:27 +00:00
sh.Write([]byte(data + SecretKey + startStr + endStr + ToStr(minutes)))
2014-03-19 11:21:23 +00:00
encoded := hex.EncodeToString(sh.Sum(nil))
code := fmt.Sprintf("%s%06d%s", startStr, minutes, encoded)
return code
}
2014-03-17 04:57:18 +00:00
// AvatarLink returns avatar link by given e-mail.
func AvatarLink(email string) string {
2014-03-25 16:12:27 +00:00
if Service.EnableCacheAvatar {
return "/avatar/" + EncodeMd5(email)
}
return "http://1.gravatar.com/avatar/" + EncodeMd5(email)
2014-03-17 04:57:18 +00:00
}
2014-03-14 06:32:11 +00:00
// Seconds-based time units
const (
Minute = 60
Hour = 60 * Minute
Day = 24 * Hour
Week = 7 * Day
Month = 30 * Day
Year = 12 * Month
)
2014-03-22 13:21:57 +00:00
func computeTimeDiff(diff int64) (int64, string) {
diffStr := ""
switch {
case diff <= 0:
diff = 0
diffStr = "now"
case diff < 2:
diff = 0
diffStr = "1 second"
case diff < 1*Minute:
diffStr = fmt.Sprintf("%d seconds", diff)
diff = 0
case diff < 2*Minute:
diff -= 1 * Minute
diffStr = "1 minute"
case diff < 1*Hour:
diffStr = fmt.Sprintf("%d minutes", diff/Minute)
diff -= diff / Minute * Minute
case diff < 2*Hour:
diff -= 1 * Hour
diffStr = "1 hour"
case diff < 1*Day:
diffStr = fmt.Sprintf("%d hours", diff/Hour)
diff -= diff / Hour * Hour
case diff < 2*Day:
diff -= 1 * Day
diffStr = "1 day"
case diff < 1*Week:
diffStr = fmt.Sprintf("%d days", diff/Day)
diff -= diff / Day * Day
case diff < 2*Week:
diff -= 1 * Week
diffStr = "1 week"
case diff < 1*Month:
diffStr = fmt.Sprintf("%d weeks", diff/Week)
diff -= diff / Week * Week
case diff < 2*Month:
diff -= 1 * Month
diffStr = "1 month"
case diff < 1*Year:
diffStr = fmt.Sprintf("%d months", diff/Month)
diff -= diff / Month * Month
case diff < 2*Year:
diff -= 1 * Year
diffStr = "1 year"
default:
diffStr = fmt.Sprintf("%d years", diff/Year)
diff = 0
}
return diff, diffStr
}
// TimeSincePro calculates the time interval and generate full user-friendly string.
func TimeSincePro(then time.Time) string {
now := time.Now()
diff := now.Unix() - then.Unix()
if then.After(now) {
return "future"
}
var timeStr, diffStr string
for {
if diff == 0 {
break
}
diff, diffStr = computeTimeDiff(diff)
timeStr += ", " + diffStr
}
return strings.TrimPrefix(timeStr, ", ")
}
2014-03-14 06:32:11 +00:00
// TimeSince calculates the time interval and generate user-friendly string.
func TimeSince(then time.Time) string {
now := time.Now()
lbl := "ago"
diff := now.Unix() - then.Unix()
if then.After(now) {
lbl = "from now"
diff = then.Unix() - now.Unix()
}
switch {
case diff <= 0:
return "now"
case diff <= 2:
return fmt.Sprintf("1 second %s", lbl)
case diff < 1*Minute:
return fmt.Sprintf("%d seconds %s", diff, lbl)
case diff < 2*Minute:
return fmt.Sprintf("1 minute %s", lbl)
case diff < 1*Hour:
return fmt.Sprintf("%d minutes %s", diff/Minute, lbl)
case diff < 2*Hour:
return fmt.Sprintf("1 hour %s", lbl)
case diff < 1*Day:
return fmt.Sprintf("%d hours %s", diff/Hour, lbl)
case diff < 2*Day:
return fmt.Sprintf("1 day %s", lbl)
case diff < 1*Week:
return fmt.Sprintf("%d days %s", diff/Day, lbl)
case diff < 2*Week:
return fmt.Sprintf("1 week %s", lbl)
case diff < 1*Month:
return fmt.Sprintf("%d weeks %s", diff/Week, lbl)
case diff < 2*Month:
return fmt.Sprintf("1 month %s", lbl)
case diff < 1*Year:
return fmt.Sprintf("%d months %s", diff/Month, lbl)
2014-03-22 13:21:57 +00:00
case diff < 2*Year:
2014-03-14 06:32:11 +00:00
return fmt.Sprintf("1 year %s", lbl)
2014-03-22 13:21:57 +00:00
default:
return fmt.Sprintf("%d years %s", diff/Year, lbl)
2014-03-14 06:32:11 +00:00
}
return then.String()
}
2014-03-14 23:34:59 +00:00
2014-03-15 16:29:49 +00:00
const (
Byte = 1
KByte = Byte * 1024
MByte = KByte * 1024
GByte = MByte * 1024
TByte = GByte * 1024
PByte = TByte * 1024
EByte = PByte * 1024
)
var bytesSizeTable = map[string]uint64{
"b": Byte,
"kb": KByte,
"mb": MByte,
"gb": GByte,
"tb": TByte,
"pb": PByte,
"eb": EByte,
}
func logn(n, b float64) float64 {
return math.Log(n) / math.Log(b)
}
func humanateBytes(s uint64, base float64, sizes []string) string {
if s < 10 {
return fmt.Sprintf("%dB", s)
}
e := math.Floor(logn(float64(s), base))
suffix := sizes[int(e)]
val := float64(s) / math.Pow(base, math.Floor(e))
f := "%.0f"
if val < 10 {
f = "%.1f"
}
return fmt.Sprintf(f+"%s", val, suffix)
}
// FileSize calculates the file size and generate user-friendly string.
2014-03-15 16:31:12 +00:00
func FileSize(s int64) string {
2014-03-15 16:29:49 +00:00
sizes := []string{"B", "KB", "MB", "GB", "TB", "PB", "EB"}
return humanateBytes(uint64(s), 1024, sizes)
}
2014-03-14 23:34:59 +00:00
// Subtract deals with subtraction of all types of number.
func Subtract(left interface{}, right interface{}) interface{} {
var rleft, rright int64
var fleft, fright float64
var isInt bool = true
switch left.(type) {
case int:
rleft = int64(left.(int))
case int8:
rleft = int64(left.(int8))
case int16:
rleft = int64(left.(int16))
case int32:
rleft = int64(left.(int32))
case int64:
rleft = left.(int64)
case float32:
fleft = float64(left.(float32))
isInt = false
case float64:
fleft = left.(float64)
isInt = false
}
switch right.(type) {
case int:
rright = int64(right.(int))
case int8:
rright = int64(right.(int8))
case int16:
rright = int64(right.(int16))
case int32:
rright = int64(right.(int32))
case int64:
rright = right.(int64)
case float32:
fright = float64(left.(float32))
isInt = false
case float64:
fleft = left.(float64)
isInt = false
}
if isInt {
return rleft - rright
} else {
return fleft + float64(rleft) - (fright + float64(rright))
}
}
2014-03-15 04:50:51 +00:00
// DateFormat pattern rules.
var datePatterns = []string{
// year
"Y", "2006", // A full numeric representation of a year, 4 digits Examples: 1999 or 2003
"y", "06", //A two digit representation of a year Examples: 99 or 03
// month
"m", "01", // Numeric representation of a month, with leading zeros 01 through 12
"n", "1", // Numeric representation of a month, without leading zeros 1 through 12
"M", "Jan", // A short textual representation of a month, three letters Jan through Dec
"F", "January", // A full textual representation of a month, such as January or March January through December
// day
"d", "02", // Day of the month, 2 digits with leading zeros 01 to 31
"j", "2", // Day of the month without leading zeros 1 to 31
// week
"D", "Mon", // A textual representation of a day, three letters Mon through Sun
"l", "Monday", // A full textual representation of the day of the week Sunday through Saturday
// time
"g", "3", // 12-hour format of an hour without leading zeros 1 through 12
"G", "15", // 24-hour format of an hour without leading zeros 0 through 23
"h", "03", // 12-hour format of an hour with leading zeros 01 through 12
"H", "15", // 24-hour format of an hour with leading zeros 00 through 23
"a", "pm", // Lowercase Ante meridiem and Post meridiem am or pm
"A", "PM", // Uppercase Ante meridiem and Post meridiem AM or PM
"i", "04", // Minutes with leading zeros 00 to 59
"s", "05", // Seconds, with leading zeros 00 through 59
// time zone
"T", "MST",
"P", "-07:00",
"O", "-0700",
// RFC 2822
"r", time.RFC1123Z,
}
// Parse Date use PHP time format.
func DateParse(dateString, format string) (time.Time, error) {
replacer := strings.NewReplacer(datePatterns...)
format = replacer.Replace(format)
return time.ParseInLocation(format, dateString, time.Local)
}
// Date takes a PHP like date func to Go's time format.
func DateFormat(t time.Time, format string) string {
replacer := strings.NewReplacer(datePatterns...)
format = replacer.Replace(format)
return t.Format(format)
}
2014-03-19 16:50:44 +00:00
// convert string to specify type
2014-03-19 12:27:27 +00:00
2014-03-19 16:50:44 +00:00
type StrTo string
func (f StrTo) Exist() bool {
return string(f) != string(0x1E)
}
func (f StrTo) Int() (int, error) {
v, err := strconv.ParseInt(f.String(), 10, 32)
return int(v), err
}
2014-03-27 23:42:10 +00:00
func (f StrTo) Int64() (int64, error) {
v, err := strconv.ParseInt(f.String(), 10, 64)
return int64(v), err
}
2014-03-19 16:50:44 +00:00
func (f StrTo) String() string {
if f.Exist() {
return string(f)
2014-03-19 12:27:27 +00:00
}
2014-03-19 16:50:44 +00:00
return ""
2014-03-19 12:27:27 +00:00
}
// convert any type to string
func ToStr(value interface{}, args ...int) (s string) {
switch v := value.(type) {
case bool:
s = strconv.FormatBool(v)
case float32:
s = strconv.FormatFloat(float64(v), 'f', argInt(args).Get(0, -1), argInt(args).Get(1, 32))
case float64:
s = strconv.FormatFloat(v, 'f', argInt(args).Get(0, -1), argInt(args).Get(1, 64))
case int:
s = strconv.FormatInt(int64(v), argInt(args).Get(0, 10))
case int8:
s = strconv.FormatInt(int64(v), argInt(args).Get(0, 10))
case int16:
s = strconv.FormatInt(int64(v), argInt(args).Get(0, 10))
case int32:
s = strconv.FormatInt(int64(v), argInt(args).Get(0, 10))
case int64:
s = strconv.FormatInt(v, argInt(args).Get(0, 10))
case uint:
s = strconv.FormatUint(uint64(v), argInt(args).Get(0, 10))
case uint8:
s = strconv.FormatUint(uint64(v), argInt(args).Get(0, 10))
case uint16:
s = strconv.FormatUint(uint64(v), argInt(args).Get(0, 10))
case uint32:
s = strconv.FormatUint(uint64(v), argInt(args).Get(0, 10))
case uint64:
s = strconv.FormatUint(v, argInt(args).Get(0, 10))
case string:
s = v
case []byte:
s = string(v)
default:
s = fmt.Sprintf("%v", v)
}
return s
}
2014-03-19 16:50:44 +00:00
type argInt []int
func (a argInt) Get(i int, args ...int) (r int) {
if i >= 0 && i < len(a) {
r = a[i]
}
if len(args) > 0 {
r = args[0]
}
return
}
2014-03-15 04:50:51 +00:00
type Actioner interface {
GetOpType() int
GetActUserName() string
GetRepoName() string
2014-03-23 10:27:01 +00:00
GetBranch() string
2014-03-16 15:30:35 +00:00
GetContent() string
2014-03-15 04:50:51 +00:00
}
// ActionIcon accepts a int that represents action operation type
// and returns a icon class name.
func ActionIcon(opType int) string {
switch opType {
case 1: // Create repository.
return "plus-circle"
2014-03-16 15:30:35 +00:00
case 5: // Commit repository.
return "arrow-circle-o-right"
2014-03-25 18:04:57 +00:00
case 6: // Create issue.
return "exclamation-circle"
2014-03-15 04:50:51 +00:00
default:
return "invalid type"
}
}
const (
2014-03-25 18:04:57 +00:00
TPL_CREATE_REPO = `<a href="/user/%s">%s</a> created repository <a href="/%s">%s</a>`
TPL_COMMIT_REPO = `<a href="/user/%s">%s</a> pushed to <a href="/%s/src/%s">%s</a> at <a href="/%s">%s</a>%s`
TPL_COMMIT_REPO_LI = `<div><img src="%s?s=16" alt="user-avatar"/> <a href="/%s/commit/%s">%s</a> %s</div>`
TPL_CREATE_Issue = `<a href="/user/%s">%s</a> opened issue <a href="/%s/issues/%s">%s#%s</a>
<div><img src="%s?s=16" alt="user-avatar"/> %s</div>`
2014-03-15 04:50:51 +00:00
)
2014-03-29 11:29:52 +00:00
type PushCommit struct {
Sha1 string
Message string
AuthorEmail string
AuthorName string
}
2014-03-23 10:27:01 +00:00
type PushCommits struct {
Len int
2014-03-29 11:29:52 +00:00
Commits []*PushCommit
2014-03-23 10:27:01 +00:00
}
2014-03-15 04:50:51 +00:00
// ActionDesc accepts int that represents action operation type
// and returns the description.
2014-03-16 16:07:35 +00:00
func ActionDesc(act Actioner, avatarLink string) string {
2014-03-15 04:50:51 +00:00
actUserName := act.GetActUserName()
repoName := act.GetRepoName()
2014-03-25 18:04:57 +00:00
repoLink := actUserName + "/" + repoName
2014-03-23 10:27:01 +00:00
branch := act.GetBranch()
2014-03-16 15:30:35 +00:00
content := act.GetContent()
2014-03-15 04:50:51 +00:00
switch act.GetOpType() {
case 1: // Create repository.
2014-03-25 18:04:57 +00:00
return fmt.Sprintf(TPL_CREATE_REPO, actUserName, actUserName, repoLink, repoName)
2014-03-16 15:30:35 +00:00
case 5: // Commit repository.
2014-03-23 10:27:01 +00:00
var push *PushCommits
if err := json.Unmarshal([]byte(content), &push); err != nil {
2014-03-16 15:30:35 +00:00
return err.Error()
}
2014-03-16 16:07:35 +00:00
buf := bytes.NewBuffer([]byte("\n"))
2014-03-23 10:34:41 +00:00
for _, commit := range push.Commits {
2014-03-29 11:29:52 +00:00
buf.WriteString(fmt.Sprintf(TPL_COMMIT_REPO_LI, avatarLink, repoLink, commit.Sha1, commit.Sha1[:7], commit.Message) + "\n")
2014-03-16 16:07:35 +00:00
}
2014-03-23 10:34:41 +00:00
if push.Len > 3 {
2014-03-23 12:40:40 +00:00
buf.WriteString(fmt.Sprintf(`<div><a href="/%s/%s/commits/%s">%d other commits >></a></div>`, actUserName, repoName, branch, push.Len))
2014-03-23 10:27:01 +00:00
}
2014-03-25 18:04:57 +00:00
return fmt.Sprintf(TPL_COMMIT_REPO, actUserName, actUserName, repoLink, branch, branch, repoLink, repoLink,
2014-03-16 16:07:35 +00:00
buf.String())
2014-03-25 18:04:57 +00:00
case 6: // Create issue.
infos := strings.SplitN(content, "|", 2)
return fmt.Sprintf(TPL_CREATE_Issue, actUserName, actUserName, repoLink, infos[0], repoLink, infos[0],
avatarLink, infos[1])
2014-03-15 04:50:51 +00:00
default:
return "invalid type"
}
}
2014-03-26 11:24:20 +00:00
func DiffTypeToStr(diffType int) string {
2014-03-27 23:42:10 +00:00
diffTypes := map[int]string{
1: "add", 2: "modify", 3: "del",
2014-03-26 11:24:20 +00:00
}
2014-03-27 23:42:10 +00:00
return diffTypes[diffType]
2014-03-26 11:24:20 +00:00
}
2014-03-26 20:41:16 +00:00
func DiffLineTypeToStr(diffType int) string {
switch diffType {
case 2:
return "add"
case 3:
return "del"
case 4:
return "tag"
}
return "same"
}