gitea/modules/base/tool.go

533 lines
13 KiB
Go
Raw Normal View History

2014-02-18 15:31:16 -07: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 15:22:15 -07:00
package base
2014-02-18 15:31:16 -07:00
import (
"crypto/md5"
2014-03-19 05:21:23 -06:00
"crypto/rand"
"crypto/sha1"
2014-11-07 12:46:13 -07:00
"encoding/base64"
2014-02-18 15:31:16 -07:00
"encoding/hex"
2014-03-14 00:32:11 -06:00
"fmt"
"html/template"
2014-03-15 10:29:49 -06:00
"math"
"math/big"
2016-02-20 15:10:05 -07:00
"net/http"
"strconv"
"strings"
2014-03-14 00:32:11 -06:00
"time"
2016-02-20 15:10:05 -07:00
"unicode"
2015-12-27 15:02:36 -07:00
"unicode/utf8"
2014-05-25 18:11:25 -06:00
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
2016-11-11 05:11:45 -07:00
"github.com/Unknwon/com"
"github.com/Unknwon/i18n"
"github.com/gogits/chardet"
2014-02-18 15:31:16 -07:00
)
2015-11-24 16:49:34 -07:00
// EncodeMD5 encodes string to md5 hex value.
func EncodeMD5(str string) string {
2014-02-18 15:31:16 -07:00
m := md5.New()
m.Write([]byte(str))
return hex.EncodeToString(m.Sum(nil))
}
2014-03-14 00:32:11 -06:00
2016-11-24 00:17:44 -07:00
// EncodeSha1 string to sha1 hex value.
2014-11-12 04:48:50 -07:00
func EncodeSha1(str string) string {
h := sha1.New()
h.Write([]byte(str))
return hex.EncodeToString(h.Sum(nil))
}
2016-11-07 15:14:50 -07:00
// ShortSha is basically just truncating.
// It is DEPRECATED and will be removed in the future.
2015-11-13 15:10:25 -07:00
func ShortSha(sha1 string) string {
return TruncateString(sha1, 10)
2015-11-13 15:10:25 -07:00
}
2016-11-24 00:17:44 -07:00
// DetectEncoding detect the encoding of content
func DetectEncoding(content []byte) (string, error) {
if utf8.Valid(content) {
2015-12-27 15:02:36 -07:00
log.Debug("Detected encoding: utf-8 (fast)")
return "UTF-8", nil
2015-12-27 15:02:36 -07:00
}
result, err := chardet.NewTextDetector().DetectBest(content)
if err != nil {
return "", err
}
if result.Charset != "UTF-8" && len(setting.Repository.AnsiCharset) > 0 {
log.Debug("Using default AnsiCharset: %s", setting.Repository.AnsiCharset)
return setting.Repository.AnsiCharset, err
}
log.Debug("Detected encoding: %s", result.Charset)
return result.Charset, err
2015-11-13 15:10:25 -07:00
}
2016-11-24 00:17:44 -07:00
// BasicAuthDecode decode basic auth string
2014-12-10 03:10:26 -07:00
func BasicAuthDecode(encoded string) (string, string, error) {
s, err := base64.StdEncoding.DecodeString(encoded)
2014-11-07 12:46:13 -07:00
if err != nil {
2014-12-10 03:10:26 -07:00
return "", "", err
2014-11-07 12:46:13 -07:00
}
2014-12-10 03:01:17 -07:00
auth := strings.SplitN(string(s), ":", 2)
2014-12-10 03:10:26 -07:00
return auth[0], auth[1], nil
2014-11-07 12:46:13 -07:00
}
2016-11-24 00:17:44 -07:00
// BasicAuthEncode encode basic auth string
2014-11-07 12:46:13 -07:00
func BasicAuthEncode(username, password string) string {
return base64.StdEncoding.EncodeToString([]byte(username + ":" + password))
}
2014-03-22 11:44:02 -06:00
// GetRandomString generate random string by specify chars.
func GetRandomString(n int) (string, error) {
2014-03-19 05:21:23 -06:00
const alphanum = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
buffer := make([]byte, n)
max := big.NewInt(int64(len(alphanum)))
for i := 0; i < n; i++ {
index, err := randomInt(max)
if err != nil {
return "", err
2014-03-22 11:44:02 -06:00
}
buffer[i] = alphanum[index]
2014-03-19 05:21:23 -06:00
}
return string(buffer), nil
}
func randomInt(max *big.Int) (int, error) {
rand, err := rand.Int(rand.Reader, max)
if err != nil {
return 0, err
}
return int(rand.Int64()), nil
2014-03-19 05:21:23 -06:00
}
2016-11-24 00:17:44 -07:00
// VerifyTimeLimitCode verify time limit code
2014-03-19 10:50:44 -06:00
func VerifyTimeLimitCode(data string, minutes int, code string) bool {
if len(code) <= 18 {
return false
}
// split code
start := code[:12]
lives := code[12:18]
2014-07-25 22:24:27 -06:00
if d, err := com.StrTo(lives).Int(); err == nil {
2014-03-19 10:50:44 -06:00
minutes = d
}
// right active code
retCode := CreateTimeLimitCode(data, minutes, start)
if retCode == code && minutes > 0 {
// check time is expired or not
before, _ := time.ParseInLocation("200601021504", start, time.Local)
2014-03-19 10:50:44 -06:00
now := time.Now()
if before.Add(time.Minute*time.Duration(minutes)).Unix() > now.Unix() {
return true
}
}
return false
}
2016-11-24 00:17:44 -07:00
// TimeLimitCodeLength default value for time limit code
2014-03-19 10:50:44 -06:00
const TimeLimitCodeLength = 12 + 6 + 40
2016-11-24 00:17:44 -07:00
// CreateTimeLimitCode create a time limit code
2014-03-19 05:21:23 -06:00
// code format: 12 length date time string + 6 minutes string + 40 sha1 encoded string
func CreateTimeLimitCode(data string, minutes int, startInf interface{}) string {
format := "200601021504"
2014-03-19 05:21:23 -06:00
var start, end time.Time
var startStr, endStr string
if startInf == nil {
// Use now time create code
start = time.Now()
startStr = start.Format(format)
2014-03-19 05:21:23 -06:00
} else {
// use start string create code
startStr = startInf.(string)
start, _ = time.ParseInLocation(format, startStr, time.Local)
startStr = start.Format(format)
2014-03-19 05:21:23 -06:00
}
end = start.Add(time.Minute * time.Duration(minutes))
endStr = end.Format(format)
2014-03-19 05:21:23 -06:00
// create sha1 encode string
sh := sha1.New()
2014-07-25 22:24:27 -06:00
sh.Write([]byte(data + setting.SecretKey + startStr + endStr + com.ToStr(minutes)))
2014-03-19 05:21:23 -06:00
encoded := hex.EncodeToString(sh.Sum(nil))
code := fmt.Sprintf("%s%06d%s", startStr, minutes, encoded)
return code
}
// HashEmail hashes email address to MD5 string.
// https://en.gravatar.com/site/implement/hash/
func HashEmail(email string) string {
return EncodeMD5(strings.ToLower(strings.TrimSpace(email)))
}
2016-08-07 12:01:47 -06:00
// AvatarLink returns relative avatar link to the site domain by given email,
// which includes app sub-url as prefix. However, it is possible
// to return full URL if user enables Gravatar-like service.
func AvatarLink(email string) string {
2016-08-07 12:01:47 -06:00
if setting.EnableFederatedAvatar && setting.LibravatarService != nil {
// TODO: This doesn't check any error. AvatarLink should return (string, error)
url, _ := setting.LibravatarService.FromEmail(email)
return url
2016-08-07 12:01:47 -06:00
}
if !setting.DisableGravatar {
return setting.GravatarSource + HashEmail(email)
2014-03-25 10:12:27 -06:00
}
return setting.AppSubURL + "/img/avatar_default.png"
2014-03-16 22:57:18 -06:00
}
2014-03-14 00:32:11 -06: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 07:21:57 -06: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 -= (diff / Year) * Year
2014-03-22 07:21:57 -06:00
}
return diff, diffStr
}
// TimeSincePro calculates the time interval and generate full user-friendly string.
func TimeSincePro(then time.Time) string {
return timeSincePro(then, time.Now())
}
func timeSincePro(then, now time.Time) string {
2014-03-22 07:21:57 -06:00
diff := now.Unix() - then.Unix()
if then.After(now) {
return "future"
}
if diff == 0 {
return "now"
}
2014-03-22 07:21:57 -06:00
var timeStr, diffStr string
for {
if diff == 0 {
break
}
diff, diffStr = computeTimeDiff(diff)
timeStr += ", " + diffStr
}
return strings.TrimPrefix(timeStr, ", ")
}
func timeSince(then, now time.Time, lang string) string {
2014-07-25 22:24:27 -06:00
lbl := i18n.Tr(lang, "tool.ago")
2014-03-14 00:32:11 -06:00
diff := now.Unix() - then.Unix()
if then.After(now) {
2014-07-25 22:24:27 -06:00
lbl = i18n.Tr(lang, "tool.from_now")
2014-03-14 00:32:11 -06:00
diff = then.Unix() - now.Unix()
}
switch {
case diff <= 0:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.now")
case diff <= 1:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.1s", lbl)
2014-03-14 00:32:11 -06:00
case diff < 1*Minute:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.seconds", diff, lbl)
2014-03-14 00:32:11 -06:00
case diff < 2*Minute:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.1m", lbl)
2014-03-14 00:32:11 -06:00
case diff < 1*Hour:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.minutes", diff/Minute, lbl)
2014-03-14 00:32:11 -06:00
case diff < 2*Hour:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.1h", lbl)
2014-03-14 00:32:11 -06:00
case diff < 1*Day:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.hours", diff/Hour, lbl)
2014-03-14 00:32:11 -06:00
case diff < 2*Day:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.1d", lbl)
2014-03-14 00:32:11 -06:00
case diff < 1*Week:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.days", diff/Day, lbl)
2014-03-14 00:32:11 -06:00
case diff < 2*Week:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.1w", lbl)
2014-03-14 00:32:11 -06:00
case diff < 1*Month:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.weeks", diff/Week, lbl)
2014-03-14 00:32:11 -06:00
case diff < 2*Month:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.1mon", lbl)
2014-03-14 00:32:11 -06:00
case diff < 1*Year:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.months", diff/Month, lbl)
2014-03-14 00:32:11 -06:00
2014-03-22 07:21:57 -06:00
case diff < 2*Year:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.1y", lbl)
2014-03-22 07:21:57 -06:00
default:
2014-07-25 22:24:27 -06:00
return i18n.Tr(lang, "tool.years", diff/Year, lbl)
2014-03-14 00:32:11 -06:00
}
}
2014-03-14 17:34:59 -06:00
2016-11-24 00:17:44 -07:00
// RawTimeSince retrieves i18n key of time since t
2015-08-13 02:07:11 -06:00
func RawTimeSince(t time.Time, lang string) string {
return timeSince(t, time.Now(), lang)
2015-08-13 02:07:11 -06:00
}
// TimeSince calculates the time interval and generate user-friendly string.
func TimeSince(then time.Time, lang string) template.HTML {
return htmlTimeSince(then, time.Now(), lang)
}
func htmlTimeSince(then, now time.Time, lang string) template.HTML {
return template.HTML(fmt.Sprintf(`<span class="time-since" title="%s">%s</span>`,
then.Format(setting.TimeFormat),
timeSince(then, now, lang)))
}
2016-11-24 00:17:44 -07:00
// Storage space size types
2014-03-15 10:29:49 -06: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 10:31:12 -06:00
func FileSize(s int64) string {
2014-03-15 10:29:49 -06:00
sizes := []string{"B", "KB", "MB", "GB", "TB", "PB", "EB"}
return humanateBytes(uint64(s), 1024, sizes)
}
2014-03-14 17:34:59 -06: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
2016-11-24 00:17:44 -07:00
var isInt = true
2014-03-14 17:34:59 -06:00
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(right.(float32))
2014-03-14 17:34:59 -06:00
isInt = false
case float64:
fright = right.(float64)
2014-03-14 17:34:59 -06:00
isInt = false
}
if isInt {
return rleft - rright
}
2016-11-24 00:17:44 -07:00
return fleft + float64(rleft) - (fright + float64(rright))
2014-03-14 17:34:59 -06:00
}
2015-08-10 02:52:08 -06:00
// EllipsisString returns a truncated short string,
// it appends '...' in the end of the length of string is too large.
func EllipsisString(str string, length int) string {
if length <= 3 {
return "..."
}
if len(str) <= length {
return str
}
return str[:length-3] + "..."
}
// TruncateString returns a truncated string with given limit,
// it returns input string if length is not reached limit.
func TruncateString(str string, limit int) string {
if len(str) < limit {
return str
}
return str[:limit]
}
2015-08-10 02:52:08 -06:00
// StringsToInt64s converts a slice of string to a slice of int64.
func StringsToInt64s(strs []string) ([]int64, error) {
2015-08-10 02:52:08 -06:00
ints := make([]int64, len(strs))
for i := range strs {
n, err := com.StrTo(strs[i]).Int64()
if err != nil {
return ints, err
}
ints[i] = n
2015-08-10 02:52:08 -06:00
}
return ints, nil
2015-08-10 02:52:08 -06:00
}
2015-08-25 09:22:05 -06:00
// Int64sToStrings converts a slice of int64 to a slice of string.
func Int64sToStrings(ints []int64) []string {
strs := make([]string, len(ints))
for i := range ints {
strs[i] = strconv.FormatInt(ints[i], 10)
2015-08-25 09:22:05 -06:00
}
return strs
}
2015-08-10 02:52:08 -06:00
// Int64sToMap converts a slice of int64 to a int64 map.
func Int64sToMap(ints []int64) map[int64]bool {
m := make(map[int64]bool)
for _, i := range ints {
m[i] = true
}
return m
}
2016-02-20 15:10:05 -07:00
// IsLetter reports whether the rune is a letter (category L).
// https://github.com/golang/go/blob/master/src/go/scanner/scanner.go#L257
func IsLetter(ch rune) bool {
return 'a' <= ch && ch <= 'z' || 'A' <= ch && ch <= 'Z' || ch == '_' || ch >= 0x80 && unicode.IsLetter(ch)
}
2016-08-31 14:59:23 -06:00
// IsTextFile returns true if file content format is plain text or empty.
2016-08-30 03:08:38 -06:00
func IsTextFile(data []byte) bool {
2016-08-31 14:59:23 -06:00
if len(data) == 0 {
return true
}
2016-08-30 03:08:38 -06:00
return strings.Index(http.DetectContentType(data), "text/") != -1
2016-02-20 15:10:05 -07:00
}
2016-11-24 00:17:44 -07:00
// IsImageFile detectes if data is an image format
2016-08-30 03:08:38 -06:00
func IsImageFile(data []byte) bool {
return strings.Index(http.DetectContentType(data), "image/") != -1
2016-02-20 15:10:05 -07:00
}
2016-11-24 00:17:44 -07:00
// IsPDFFile detectes if data is a pdf format
2016-08-30 03:08:38 -06:00
func IsPDFFile(data []byte) bool {
return strings.Index(http.DetectContentType(data), "application/pdf") != -1
}
// IsVideoFile detectes if data is an video format
func IsVideoFile(data []byte) bool {
return strings.Index(http.DetectContentType(data), "video/") != -1
}