tool.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543
  1. // Copyright 2014 The Gogs Authors. All rights reserved.
  2. // Use of this source code is governed by a MIT-style
  3. // license that can be found in the LICENSE file.
  4. package base
  5. import (
  6. "crypto/hmac"
  7. "crypto/md5"
  8. "crypto/rand"
  9. "crypto/sha1"
  10. "encoding/base64"
  11. "encoding/hex"
  12. "fmt"
  13. "hash"
  14. "html/template"
  15. "math"
  16. "net/http"
  17. "strings"
  18. "time"
  19. "unicode"
  20. "unicode/utf8"
  21. "github.com/Unknwon/com"
  22. "github.com/Unknwon/i18n"
  23. "github.com/gogits/chardet"
  24. "github.com/gogits/gogs/modules/log"
  25. "github.com/gogits/gogs/modules/setting"
  26. )
  27. // EncodeMD5 encodes string to md5 hex value.
  28. func EncodeMD5(str string) string {
  29. m := md5.New()
  30. m.Write([]byte(str))
  31. return hex.EncodeToString(m.Sum(nil))
  32. }
  33. // Encode string to sha1 hex value.
  34. func EncodeSha1(str string) string {
  35. h := sha1.New()
  36. h.Write([]byte(str))
  37. return hex.EncodeToString(h.Sum(nil))
  38. }
  39. func ShortSha(sha1 string) string {
  40. if len(sha1) > 10 {
  41. return sha1[:10]
  42. }
  43. return sha1
  44. }
  45. func DetectEncoding(content []byte) (string, error) {
  46. if utf8.Valid(content) {
  47. log.Debug("Detected encoding: utf-8 (fast)")
  48. return "UTF-8", nil
  49. }
  50. result, err := chardet.NewTextDetector().DetectBest(content)
  51. if result.Charset != "UTF-8" && len(setting.Repository.AnsiCharset) > 0 {
  52. log.Debug("Using default AnsiCharset: %s", setting.Repository.AnsiCharset)
  53. return setting.Repository.AnsiCharset, err
  54. }
  55. log.Debug("Detected encoding: %s", result.Charset)
  56. return result.Charset, err
  57. }
  58. func BasicAuthDecode(encoded string) (string, string, error) {
  59. s, err := base64.StdEncoding.DecodeString(encoded)
  60. if err != nil {
  61. return "", "", err
  62. }
  63. auth := strings.SplitN(string(s), ":", 2)
  64. return auth[0], auth[1], nil
  65. }
  66. func BasicAuthEncode(username, password string) string {
  67. return base64.StdEncoding.EncodeToString([]byte(username + ":" + password))
  68. }
  69. // GetRandomString generate random string by specify chars.
  70. func GetRandomString(n int, alphabets ...byte) string {
  71. const alphanum = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
  72. var bytes = make([]byte, n)
  73. rand.Read(bytes)
  74. for i, b := range bytes {
  75. if len(alphabets) == 0 {
  76. bytes[i] = alphanum[b%byte(len(alphanum))]
  77. } else {
  78. bytes[i] = alphabets[b%byte(len(alphabets))]
  79. }
  80. }
  81. return string(bytes)
  82. }
  83. // http://code.google.com/p/go/source/browse/pbkdf2/pbkdf2.go?repo=crypto
  84. // FIXME: use https://godoc.org/golang.org/x/crypto/pbkdf2?
  85. func PBKDF2(password, salt []byte, iter, keyLen int, h func() hash.Hash) []byte {
  86. prf := hmac.New(h, password)
  87. hashLen := prf.Size()
  88. numBlocks := (keyLen + hashLen - 1) / hashLen
  89. var buf [4]byte
  90. dk := make([]byte, 0, numBlocks*hashLen)
  91. U := make([]byte, hashLen)
  92. for block := 1; block <= numBlocks; block++ {
  93. // N.B.: || means concatenation, ^ means XOR
  94. // for each block T_i = U_1 ^ U_2 ^ ... ^ U_iter
  95. // U_1 = PRF(password, salt || uint(i))
  96. prf.Reset()
  97. prf.Write(salt)
  98. buf[0] = byte(block >> 24)
  99. buf[1] = byte(block >> 16)
  100. buf[2] = byte(block >> 8)
  101. buf[3] = byte(block)
  102. prf.Write(buf[:4])
  103. dk = prf.Sum(dk)
  104. T := dk[len(dk)-hashLen:]
  105. copy(U, T)
  106. // U_n = PRF(password, U_(n-1))
  107. for n := 2; n <= iter; n++ {
  108. prf.Reset()
  109. prf.Write(U)
  110. U = U[:0]
  111. U = prf.Sum(U)
  112. for x := range U {
  113. T[x] ^= U[x]
  114. }
  115. }
  116. }
  117. return dk[:keyLen]
  118. }
  119. // verify time limit code
  120. func VerifyTimeLimitCode(data string, minutes int, code string) bool {
  121. if len(code) <= 18 {
  122. return false
  123. }
  124. // split code
  125. start := code[:12]
  126. lives := code[12:18]
  127. if d, err := com.StrTo(lives).Int(); err == nil {
  128. minutes = d
  129. }
  130. // right active code
  131. retCode := CreateTimeLimitCode(data, minutes, start)
  132. if retCode == code && minutes > 0 {
  133. // check time is expired or not
  134. before, _ := time.ParseInLocation("200601021504", start, time.Local)
  135. now := time.Now()
  136. if before.Add(time.Minute*time.Duration(minutes)).Unix() > now.Unix() {
  137. return true
  138. }
  139. }
  140. return false
  141. }
  142. const TimeLimitCodeLength = 12 + 6 + 40
  143. // create a time limit code
  144. // code format: 12 length date time string + 6 minutes string + 40 sha1 encoded string
  145. func CreateTimeLimitCode(data string, minutes int, startInf interface{}) string {
  146. format := "200601021504"
  147. var start, end time.Time
  148. var startStr, endStr string
  149. if startInf == nil {
  150. // Use now time create code
  151. start = time.Now()
  152. startStr = start.Format(format)
  153. } else {
  154. // use start string create code
  155. startStr = startInf.(string)
  156. start, _ = time.ParseInLocation(format, startStr, time.Local)
  157. startStr = start.Format(format)
  158. }
  159. end = start.Add(time.Minute * time.Duration(minutes))
  160. endStr = end.Format(format)
  161. // create sha1 encode string
  162. sh := sha1.New()
  163. sh.Write([]byte(data + setting.SecretKey + startStr + endStr + com.ToStr(minutes)))
  164. encoded := hex.EncodeToString(sh.Sum(nil))
  165. code := fmt.Sprintf("%s%06d%s", startStr, minutes, encoded)
  166. return code
  167. }
  168. // HashEmail hashes email address to MD5 string.
  169. // https://en.gravatar.com/site/implement/hash/
  170. func HashEmail(email string) string {
  171. email = strings.ToLower(strings.TrimSpace(email))
  172. h := md5.New()
  173. h.Write([]byte(email))
  174. return hex.EncodeToString(h.Sum(nil))
  175. }
  176. // AvatarLink returns relative avatar link to the site domain by given email,
  177. // which includes app sub-url as prefix. However, it is possible
  178. // to return full URL if user enables Gravatar-like service.
  179. func AvatarLink(email string) (url string) {
  180. if setting.EnableFederatedAvatar && setting.LibravatarService != nil {
  181. var err error
  182. url, err = setting.LibravatarService.FromEmail(email)
  183. if err != nil {
  184. log.Error(1, "LibravatarService.FromEmail: %v", err)
  185. }
  186. }
  187. if len(url) == 0 && !setting.DisableGravatar {
  188. url = setting.GravatarSource + HashEmail(email)
  189. }
  190. if len(url) == 0 {
  191. url = setting.AppSubUrl + "/img/avatar_default.png"
  192. }
  193. return url
  194. }
  195. // Seconds-based time units
  196. const (
  197. Minute = 60
  198. Hour = 60 * Minute
  199. Day = 24 * Hour
  200. Week = 7 * Day
  201. Month = 30 * Day
  202. Year = 12 * Month
  203. )
  204. func computeTimeDiff(diff int64) (int64, string) {
  205. diffStr := ""
  206. switch {
  207. case diff <= 0:
  208. diff = 0
  209. diffStr = "now"
  210. case diff < 2:
  211. diff = 0
  212. diffStr = "1 second"
  213. case diff < 1*Minute:
  214. diffStr = fmt.Sprintf("%d seconds", diff)
  215. diff = 0
  216. case diff < 2*Minute:
  217. diff -= 1 * Minute
  218. diffStr = "1 minute"
  219. case diff < 1*Hour:
  220. diffStr = fmt.Sprintf("%d minutes", diff/Minute)
  221. diff -= diff / Minute * Minute
  222. case diff < 2*Hour:
  223. diff -= 1 * Hour
  224. diffStr = "1 hour"
  225. case diff < 1*Day:
  226. diffStr = fmt.Sprintf("%d hours", diff/Hour)
  227. diff -= diff / Hour * Hour
  228. case diff < 2*Day:
  229. diff -= 1 * Day
  230. diffStr = "1 day"
  231. case diff < 1*Week:
  232. diffStr = fmt.Sprintf("%d days", diff/Day)
  233. diff -= diff / Day * Day
  234. case diff < 2*Week:
  235. diff -= 1 * Week
  236. diffStr = "1 week"
  237. case diff < 1*Month:
  238. diffStr = fmt.Sprintf("%d weeks", diff/Week)
  239. diff -= diff / Week * Week
  240. case diff < 2*Month:
  241. diff -= 1 * Month
  242. diffStr = "1 month"
  243. case diff < 1*Year:
  244. diffStr = fmt.Sprintf("%d months", diff/Month)
  245. diff -= diff / Month * Month
  246. case diff < 2*Year:
  247. diff -= 1 * Year
  248. diffStr = "1 year"
  249. default:
  250. diffStr = fmt.Sprintf("%d years", diff/Year)
  251. diff = 0
  252. }
  253. return diff, diffStr
  254. }
  255. // TimeSincePro calculates the time interval and generate full user-friendly string.
  256. func TimeSincePro(then time.Time) string {
  257. now := time.Now()
  258. diff := now.Unix() - then.Unix()
  259. if then.After(now) {
  260. return "future"
  261. }
  262. var timeStr, diffStr string
  263. for {
  264. if diff == 0 {
  265. break
  266. }
  267. diff, diffStr = computeTimeDiff(diff)
  268. timeStr += ", " + diffStr
  269. }
  270. return strings.TrimPrefix(timeStr, ", ")
  271. }
  272. func timeSince(then time.Time, lang string) string {
  273. now := time.Now()
  274. lbl := i18n.Tr(lang, "tool.ago")
  275. diff := now.Unix() - then.Unix()
  276. if then.After(now) {
  277. lbl = i18n.Tr(lang, "tool.from_now")
  278. diff = then.Unix() - now.Unix()
  279. }
  280. switch {
  281. case diff <= 0:
  282. return i18n.Tr(lang, "tool.now")
  283. case diff <= 2:
  284. return i18n.Tr(lang, "tool.1s", lbl)
  285. case diff < 1*Minute:
  286. return i18n.Tr(lang, "tool.seconds", diff, lbl)
  287. case diff < 2*Minute:
  288. return i18n.Tr(lang, "tool.1m", lbl)
  289. case diff < 1*Hour:
  290. return i18n.Tr(lang, "tool.minutes", diff/Minute, lbl)
  291. case diff < 2*Hour:
  292. return i18n.Tr(lang, "tool.1h", lbl)
  293. case diff < 1*Day:
  294. return i18n.Tr(lang, "tool.hours", diff/Hour, lbl)
  295. case diff < 2*Day:
  296. return i18n.Tr(lang, "tool.1d", lbl)
  297. case diff < 1*Week:
  298. return i18n.Tr(lang, "tool.days", diff/Day, lbl)
  299. case diff < 2*Week:
  300. return i18n.Tr(lang, "tool.1w", lbl)
  301. case diff < 1*Month:
  302. return i18n.Tr(lang, "tool.weeks", diff/Week, lbl)
  303. case diff < 2*Month:
  304. return i18n.Tr(lang, "tool.1mon", lbl)
  305. case diff < 1*Year:
  306. return i18n.Tr(lang, "tool.months", diff/Month, lbl)
  307. case diff < 2*Year:
  308. return i18n.Tr(lang, "tool.1y", lbl)
  309. default:
  310. return i18n.Tr(lang, "tool.years", diff/Year, lbl)
  311. }
  312. }
  313. func RawTimeSince(t time.Time, lang string) string {
  314. return timeSince(t, lang)
  315. }
  316. // TimeSince calculates the time interval and generate user-friendly string.
  317. func TimeSince(t time.Time, lang string) template.HTML {
  318. return template.HTML(fmt.Sprintf(`<span class="time-since" title="%s">%s</span>`, t.Format(setting.TimeFormat), timeSince(t, lang)))
  319. }
  320. const (
  321. Byte = 1
  322. KByte = Byte * 1024
  323. MByte = KByte * 1024
  324. GByte = MByte * 1024
  325. TByte = GByte * 1024
  326. PByte = TByte * 1024
  327. EByte = PByte * 1024
  328. )
  329. var bytesSizeTable = map[string]uint64{
  330. "b": Byte,
  331. "kb": KByte,
  332. "mb": MByte,
  333. "gb": GByte,
  334. "tb": TByte,
  335. "pb": PByte,
  336. "eb": EByte,
  337. }
  338. func logn(n, b float64) float64 {
  339. return math.Log(n) / math.Log(b)
  340. }
  341. func humanateBytes(s uint64, base float64, sizes []string) string {
  342. if s < 10 {
  343. return fmt.Sprintf("%dB", s)
  344. }
  345. e := math.Floor(logn(float64(s), base))
  346. suffix := sizes[int(e)]
  347. val := float64(s) / math.Pow(base, math.Floor(e))
  348. f := "%.0f"
  349. if val < 10 {
  350. f = "%.1f"
  351. }
  352. return fmt.Sprintf(f+"%s", val, suffix)
  353. }
  354. // FileSize calculates the file size and generate user-friendly string.
  355. func FileSize(s int64) string {
  356. sizes := []string{"B", "KB", "MB", "GB", "TB", "PB", "EB"}
  357. return humanateBytes(uint64(s), 1024, sizes)
  358. }
  359. // Subtract deals with subtraction of all types of number.
  360. func Subtract(left interface{}, right interface{}) interface{} {
  361. var rleft, rright int64
  362. var fleft, fright float64
  363. var isInt bool = true
  364. switch left.(type) {
  365. case int:
  366. rleft = int64(left.(int))
  367. case int8:
  368. rleft = int64(left.(int8))
  369. case int16:
  370. rleft = int64(left.(int16))
  371. case int32:
  372. rleft = int64(left.(int32))
  373. case int64:
  374. rleft = left.(int64)
  375. case float32:
  376. fleft = float64(left.(float32))
  377. isInt = false
  378. case float64:
  379. fleft = left.(float64)
  380. isInt = false
  381. }
  382. switch right.(type) {
  383. case int:
  384. rright = int64(right.(int))
  385. case int8:
  386. rright = int64(right.(int8))
  387. case int16:
  388. rright = int64(right.(int16))
  389. case int32:
  390. rright = int64(right.(int32))
  391. case int64:
  392. rright = right.(int64)
  393. case float32:
  394. fright = float64(left.(float32))
  395. isInt = false
  396. case float64:
  397. fleft = left.(float64)
  398. isInt = false
  399. }
  400. if isInt {
  401. return rleft - rright
  402. } else {
  403. return fleft + float64(rleft) - (fright + float64(rright))
  404. }
  405. }
  406. // EllipsisString returns a truncated short string,
  407. // it appends '...' in the end of the length of string is too large.
  408. func EllipsisString(str string, length int) string {
  409. if len(str) < length {
  410. return str
  411. }
  412. return str[:length-3] + "..."
  413. }
  414. // TruncateString returns a truncated string with given limit,
  415. // it returns input string if length is not reached limit.
  416. func TruncateString(str string, limit int) string {
  417. if len(str) < limit {
  418. return str
  419. }
  420. return str[:limit]
  421. }
  422. // StringsToInt64s converts a slice of string to a slice of int64.
  423. func StringsToInt64s(strs []string) []int64 {
  424. ints := make([]int64, len(strs))
  425. for i := range strs {
  426. ints[i] = com.StrTo(strs[i]).MustInt64()
  427. }
  428. return ints
  429. }
  430. // Int64sToStrings converts a slice of int64 to a slice of string.
  431. func Int64sToStrings(ints []int64) []string {
  432. strs := make([]string, len(ints))
  433. for i := range ints {
  434. strs[i] = com.ToStr(ints[i])
  435. }
  436. return strs
  437. }
  438. // Int64sToMap converts a slice of int64 to a int64 map.
  439. func Int64sToMap(ints []int64) map[int64]bool {
  440. m := make(map[int64]bool)
  441. for _, i := range ints {
  442. m[i] = true
  443. }
  444. return m
  445. }
  446. // IsLetter reports whether the rune is a letter (category L).
  447. // https://github.com/golang/go/blob/master/src/go/scanner/scanner.go#L257
  448. func IsLetter(ch rune) bool {
  449. return 'a' <= ch && ch <= 'z' || 'A' <= ch && ch <= 'Z' || ch == '_' || ch >= 0x80 && unicode.IsLetter(ch)
  450. }
  451. func IsTextFile(data []byte) (string, bool) {
  452. contentType := http.DetectContentType(data)
  453. if strings.Index(contentType, "text/") != -1 {
  454. return contentType, true
  455. }
  456. return contentType, false
  457. }
  458. func IsImageFile(data []byte) (string, bool) {
  459. contentType := http.DetectContentType(data)
  460. if strings.Index(contentType, "image/") != -1 {
  461. return contentType, true
  462. }
  463. return contentType, false
  464. }
  465. func IsPDFFile(data []byte) (string, bool) {
  466. contentType := http.DetectContentType(data)
  467. if strings.Index(contentType, "application/pdf") != -1 {
  468. return contentType, true
  469. }
  470. return contentType, false
  471. }