tool.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  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) == 40 {
  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 avatar link by given email.
  177. func AvatarLink(email string) string {
  178. if setting.DisableGravatar || setting.OfflineMode {
  179. return setting.AppSubUrl + "/img/avatar_default.jpg"
  180. }
  181. return setting.GravatarSource + HashEmail(email)
  182. }
  183. // Seconds-based time units
  184. const (
  185. Minute = 60
  186. Hour = 60 * Minute
  187. Day = 24 * Hour
  188. Week = 7 * Day
  189. Month = 30 * Day
  190. Year = 12 * Month
  191. )
  192. func computeTimeDiff(diff int64) (int64, string) {
  193. diffStr := ""
  194. switch {
  195. case diff <= 0:
  196. diff = 0
  197. diffStr = "now"
  198. case diff < 2:
  199. diff = 0
  200. diffStr = "1 second"
  201. case diff < 1*Minute:
  202. diffStr = fmt.Sprintf("%d seconds", diff)
  203. diff = 0
  204. case diff < 2*Minute:
  205. diff -= 1 * Minute
  206. diffStr = "1 minute"
  207. case diff < 1*Hour:
  208. diffStr = fmt.Sprintf("%d minutes", diff/Minute)
  209. diff -= diff / Minute * Minute
  210. case diff < 2*Hour:
  211. diff -= 1 * Hour
  212. diffStr = "1 hour"
  213. case diff < 1*Day:
  214. diffStr = fmt.Sprintf("%d hours", diff/Hour)
  215. diff -= diff / Hour * Hour
  216. case diff < 2*Day:
  217. diff -= 1 * Day
  218. diffStr = "1 day"
  219. case diff < 1*Week:
  220. diffStr = fmt.Sprintf("%d days", diff/Day)
  221. diff -= diff / Day * Day
  222. case diff < 2*Week:
  223. diff -= 1 * Week
  224. diffStr = "1 week"
  225. case diff < 1*Month:
  226. diffStr = fmt.Sprintf("%d weeks", diff/Week)
  227. diff -= diff / Week * Week
  228. case diff < 2*Month:
  229. diff -= 1 * Month
  230. diffStr = "1 month"
  231. case diff < 1*Year:
  232. diffStr = fmt.Sprintf("%d months", diff/Month)
  233. diff -= diff / Month * Month
  234. case diff < 2*Year:
  235. diff -= 1 * Year
  236. diffStr = "1 year"
  237. default:
  238. diffStr = fmt.Sprintf("%d years", diff/Year)
  239. diff = 0
  240. }
  241. return diff, diffStr
  242. }
  243. // TimeSincePro calculates the time interval and generate full user-friendly string.
  244. func TimeSincePro(then time.Time) string {
  245. now := time.Now()
  246. diff := now.Unix() - then.Unix()
  247. if then.After(now) {
  248. return "future"
  249. }
  250. var timeStr, diffStr string
  251. for {
  252. if diff == 0 {
  253. break
  254. }
  255. diff, diffStr = computeTimeDiff(diff)
  256. timeStr += ", " + diffStr
  257. }
  258. return strings.TrimPrefix(timeStr, ", ")
  259. }
  260. func timeSince(then time.Time, lang string) string {
  261. now := time.Now()
  262. lbl := i18n.Tr(lang, "tool.ago")
  263. diff := now.Unix() - then.Unix()
  264. if then.After(now) {
  265. lbl = i18n.Tr(lang, "tool.from_now")
  266. diff = then.Unix() - now.Unix()
  267. }
  268. switch {
  269. case diff <= 0:
  270. return i18n.Tr(lang, "tool.now")
  271. case diff <= 2:
  272. return i18n.Tr(lang, "tool.1s", lbl)
  273. case diff < 1*Minute:
  274. return i18n.Tr(lang, "tool.seconds", diff, lbl)
  275. case diff < 2*Minute:
  276. return i18n.Tr(lang, "tool.1m", lbl)
  277. case diff < 1*Hour:
  278. return i18n.Tr(lang, "tool.minutes", diff/Minute, lbl)
  279. case diff < 2*Hour:
  280. return i18n.Tr(lang, "tool.1h", lbl)
  281. case diff < 1*Day:
  282. return i18n.Tr(lang, "tool.hours", diff/Hour, lbl)
  283. case diff < 2*Day:
  284. return i18n.Tr(lang, "tool.1d", lbl)
  285. case diff < 1*Week:
  286. return i18n.Tr(lang, "tool.days", diff/Day, lbl)
  287. case diff < 2*Week:
  288. return i18n.Tr(lang, "tool.1w", lbl)
  289. case diff < 1*Month:
  290. return i18n.Tr(lang, "tool.weeks", diff/Week, lbl)
  291. case diff < 2*Month:
  292. return i18n.Tr(lang, "tool.1mon", lbl)
  293. case diff < 1*Year:
  294. return i18n.Tr(lang, "tool.months", diff/Month, lbl)
  295. case diff < 2*Year:
  296. return i18n.Tr(lang, "tool.1y", lbl)
  297. default:
  298. return i18n.Tr(lang, "tool.years", diff/Year, lbl)
  299. }
  300. }
  301. func RawTimeSince(t time.Time, lang string) string {
  302. return timeSince(t, lang)
  303. }
  304. // TimeSince calculates the time interval and generate user-friendly string.
  305. func TimeSince(t time.Time, lang string) template.HTML {
  306. return template.HTML(fmt.Sprintf(`<span class="time-since" title="%s">%s</span>`, t.Format(setting.TimeFormat), timeSince(t, lang)))
  307. }
  308. const (
  309. Byte = 1
  310. KByte = Byte * 1024
  311. MByte = KByte * 1024
  312. GByte = MByte * 1024
  313. TByte = GByte * 1024
  314. PByte = TByte * 1024
  315. EByte = PByte * 1024
  316. )
  317. var bytesSizeTable = map[string]uint64{
  318. "b": Byte,
  319. "kb": KByte,
  320. "mb": MByte,
  321. "gb": GByte,
  322. "tb": TByte,
  323. "pb": PByte,
  324. "eb": EByte,
  325. }
  326. func logn(n, b float64) float64 {
  327. return math.Log(n) / math.Log(b)
  328. }
  329. func humanateBytes(s uint64, base float64, sizes []string) string {
  330. if s < 10 {
  331. return fmt.Sprintf("%dB", s)
  332. }
  333. e := math.Floor(logn(float64(s), base))
  334. suffix := sizes[int(e)]
  335. val := float64(s) / math.Pow(base, math.Floor(e))
  336. f := "%.0f"
  337. if val < 10 {
  338. f = "%.1f"
  339. }
  340. return fmt.Sprintf(f+"%s", val, suffix)
  341. }
  342. // FileSize calculates the file size and generate user-friendly string.
  343. func FileSize(s int64) string {
  344. sizes := []string{"B", "KB", "MB", "GB", "TB", "PB", "EB"}
  345. return humanateBytes(uint64(s), 1024, sizes)
  346. }
  347. // Subtract deals with subtraction of all types of number.
  348. func Subtract(left interface{}, right interface{}) interface{} {
  349. var rleft, rright int64
  350. var fleft, fright float64
  351. var isInt bool = true
  352. switch left.(type) {
  353. case int:
  354. rleft = int64(left.(int))
  355. case int8:
  356. rleft = int64(left.(int8))
  357. case int16:
  358. rleft = int64(left.(int16))
  359. case int32:
  360. rleft = int64(left.(int32))
  361. case int64:
  362. rleft = left.(int64)
  363. case float32:
  364. fleft = float64(left.(float32))
  365. isInt = false
  366. case float64:
  367. fleft = left.(float64)
  368. isInt = false
  369. }
  370. switch right.(type) {
  371. case int:
  372. rright = int64(right.(int))
  373. case int8:
  374. rright = int64(right.(int8))
  375. case int16:
  376. rright = int64(right.(int16))
  377. case int32:
  378. rright = int64(right.(int32))
  379. case int64:
  380. rright = right.(int64)
  381. case float32:
  382. fright = float64(left.(float32))
  383. isInt = false
  384. case float64:
  385. fleft = left.(float64)
  386. isInt = false
  387. }
  388. if isInt {
  389. return rleft - rright
  390. } else {
  391. return fleft + float64(rleft) - (fright + float64(rright))
  392. }
  393. }
  394. // EllipsisString returns a truncated short string,
  395. // it appends '...' in the end of the length of string is too large.
  396. func EllipsisString(str string, length int) string {
  397. if len(str) < length {
  398. return str
  399. }
  400. return str[:length-3] + "..."
  401. }
  402. // TruncateString returns a truncated string with given limit,
  403. // it returns input string if length is not reached limit.
  404. func TruncateString(str string, limit int) string {
  405. if len(str) < limit {
  406. return str
  407. }
  408. return str[:limit]
  409. }
  410. // StringsToInt64s converts a slice of string to a slice of int64.
  411. func StringsToInt64s(strs []string) []int64 {
  412. ints := make([]int64, len(strs))
  413. for i := range strs {
  414. ints[i] = com.StrTo(strs[i]).MustInt64()
  415. }
  416. return ints
  417. }
  418. // Int64sToStrings converts a slice of int64 to a slice of string.
  419. func Int64sToStrings(ints []int64) []string {
  420. strs := make([]string, len(ints))
  421. for i := range ints {
  422. strs[i] = com.ToStr(ints[i])
  423. }
  424. return strs
  425. }
  426. // Int64sToMap converts a slice of int64 to a int64 map.
  427. func Int64sToMap(ints []int64) map[int64]bool {
  428. m := make(map[int64]bool)
  429. for _, i := range ints {
  430. m[i] = true
  431. }
  432. return m
  433. }
  434. // IsLetter reports whether the rune is a letter (category L).
  435. // https://github.com/golang/go/blob/master/src/go/scanner/scanner.go#L257
  436. func IsLetter(ch rune) bool {
  437. return 'a' <= ch && ch <= 'z' || 'A' <= ch && ch <= 'Z' || ch == '_' || ch >= 0x80 && unicode.IsLetter(ch)
  438. }
  439. func IsTextFile(data []byte) (string, bool) {
  440. contentType := http.DetectContentType(data)
  441. if strings.Index(contentType, "text/") != -1 {
  442. return contentType, true
  443. }
  444. return contentType, false
  445. }
  446. func IsImageFile(data []byte) (string, bool) {
  447. contentType := http.DetectContentType(data)
  448. if strings.Index(contentType, "image/") != -1 {
  449. return contentType, true
  450. }
  451. return contentType, false
  452. }