gitea/modules/base/tool.go

505 lines
12 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 (
2014-04-06 14:10:57 -06:00
"crypto/hmac"
2014-02-18 15:31:16 -07:00
"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-11-07 12:46:13 -07:00
"errors"
2014-03-14 00:32:11 -06:00
"fmt"
2014-04-06 14:10:57 -06:00
"hash"
"html/template"
2014-03-15 10:29:49 -06:00
"math"
2014-10-04 15:15:22 -06:00
"regexp"
"strings"
2014-03-14 00:32:11 -06:00
"time"
2014-05-25 18:11:25 -06:00
2014-07-25 22:24:27 -06:00
"github.com/Unknwon/com"
"github.com/Unknwon/i18n"
2014-05-25 18:11:25 -06:00
"github.com/gogits/gogs/modules/setting"
2014-02-18 15:31:16 -07:00
)
2014-10-24 16:43:17 -06:00
// Encode string to md5 hex value.
2014-02-18 15:31:16 -07:00
func EncodeMd5(str string) string {
m := md5.New()
m.Write([]byte(str))
return hex.EncodeToString(m.Sum(nil))
}
2014-03-14 00:32:11 -06:00
2014-11-12 04:48:50 -07:00
// Encode string to sha1 hex value.
func EncodeSha1(str string) string {
h := sha1.New()
h.Write([]byte(str))
return hex.EncodeToString(h.Sum(nil))
}
2014-11-07 12:46:13 -07:00
func BasicAuthDecode(encoded string) (user string, name string, err error) {
var s []byte
s, err = base64.StdEncoding.DecodeString(encoded)
if err != nil {
return user, name, err
}
a := strings.Split(string(s), ":")
if len(a) == 2 {
user, name = a[0], a[1]
} else {
err = errors.New("decode failed")
}
return user, name, err
}
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, alphabets ...byte) string {
2014-03-19 05:21:23 -06:00
const alphanum = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
var bytes = make([]byte, n)
rand.Read(bytes)
for i, b := range bytes {
2014-03-22 11:44:02 -06:00
if len(alphabets) == 0 {
bytes[i] = alphanum[b%byte(len(alphanum))]
} else {
bytes[i] = alphabets[b%byte(len(alphabets))]
}
2014-03-19 05:21:23 -06:00
}
return string(bytes)
}
2014-04-06 14:10:57 -06:00
// http://code.google.com/p/go/source/browse/pbkdf2/pbkdf2.go?repo=crypto
func PBKDF2(password, salt []byte, iter, keyLen int, h func() hash.Hash) []byte {
prf := hmac.New(h, password)
hashLen := prf.Size()
numBlocks := (keyLen + hashLen - 1) / hashLen
var buf [4]byte
dk := make([]byte, 0, numBlocks*hashLen)
U := make([]byte, hashLen)
for block := 1; block <= numBlocks; block++ {
// N.B.: || means concatenation, ^ means XOR
// for each block T_i = U_1 ^ U_2 ^ ... ^ U_iter
// U_1 = PRF(password, salt || uint(i))
prf.Reset()
prf.Write(salt)
buf[0] = byte(block >> 24)
buf[1] = byte(block >> 16)
buf[2] = byte(block >> 8)
buf[3] = byte(block)
prf.Write(buf[:4])
dk = prf.Sum(dk)
T := dk[len(dk)-hashLen:]
copy(U, T)
// U_n = PRF(password, U_(n-1))
for n := 2; n <= iter; n++ {
prf.Reset()
prf.Write(U)
U = U[:0]
U = prf.Sum(U)
for x := range U {
T[x] ^= U[x]
}
}
}
return dk[:keyLen]
}
2014-03-19 10:50:44 -06: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]
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, _ := 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 05:21:23 -06: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-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
}
2014-03-16 22:57:18 -06:00
// AvatarLink returns avatar link by given e-mail.
func AvatarLink(email string) string {
2014-05-25 18:11:25 -06:00
if setting.DisableGravatar {
return setting.AppSubUrl + "/img/avatar_default.jpg"
2014-05-25 18:11:25 -06:00
} else if setting.Service.EnableCacheAvatar {
return setting.AppSubUrl + "/avatar/" + EncodeMd5(email)
2014-03-25 10:12:27 -06:00
}
return "//1.gravatar.com/avatar/" + EncodeMd5(email)
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 = 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, ", ")
}
func timeSince(then time.Time, lang string) string {
2014-03-14 00:32:11 -06:00
now := time.Now()
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")
2014-03-14 00:32:11 -06:00
case diff <= 2:
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
// TimeSince calculates the time interval and generate user-friendly string.
func TimeSince(t time.Time, lang string) template.HTML {
return template.HTML(fmt.Sprintf(`<span class="time-since" title="%s">%s</span>`, t.Format(setting.TimeFormat), timeSince(t, lang)))
}
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
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-14 22:50:51 -06: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-10-04 15:15:22 -06:00
type xssFilter struct {
reg *regexp.Regexp
repl []byte
}
var (
whiteSpace = []byte(" ")
xssFilters = []xssFilter{
{regexp.MustCompile(`\ [ONon]\w*=["]*`), whiteSpace},
{regexp.MustCompile(`<[SCRIPTscript]{6}`), whiteSpace},
{regexp.MustCompile(`=[` + "`" + `'"]*[JAVASCRIPTjavascript \t\0&#x0D;]*:`), whiteSpace},
}
)
// XSS goes through all the XSS filters to make user input content as safe as possible.
func XSS(in []byte) []byte {
for _, filter := range xssFilters {
in = filter.reg.ReplaceAll(in, filter.repl)
}
return in
}
func XSSString(in string) string {
return string(XSS([]byte(in)))
}