display ui time with customize time location

Author: lunny

custom/conf/app.ini.sample

@@ -547,6 +547,9 @@ MAX_FILES = 5
 ; Special supported values are ANSIC, UnixDate, RubyDate, RFC822, RFC822Z, RFC850, RFC1123, RFC1123Z, RFC3339, RFC3339Nano, Kitchen, Stamp, StampMilli, StampMicro and StampNano
 ; For more information about the format see http://golang.org/pkg/time/#pkg-constants
 FORMAT =
+; Location the UI time display i.e. Asia/Shanghai
+; Empty means server's location setting
+UI_LOCATION =
 
 [log]
 ROOT_PATH =

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -502,8 +502,12 @@ Two special environment variables are passed to the render command:
 - `GITEA_PREFIX_SRC`, which contains the current URL prefix in the `src` path tree. To be used as prefix for links.
 - `GITEA_PREFIX_RAW`, which contains the current URL prefix in the `raw` path tree. To be used as prefix for image paths.
 
+## Time (`time`)
+- `FORMAT`: Time format to diplay on UI. i.e. RFC1123 or 2006-01-02 15:04:05
+- `UI_LOCATION`: Location of time on the UI, so that we can display correct user's time on UI. i.e. Shanghai/Asia
+
 ## Other (`other`)
 
 - `SHOW_FOOTER_BRANDING`: **false**: Show Gitea branding in the footer.
 - `SHOW_FOOTER_VERSION`: **true**: Show Gitea version information in the footer.
-- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: Show time of template execution in the footer.
+- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: Show time of template execution in the footer.

docs/content/doc/advanced/config-cheat-sheet.zh-cn.md

@@ -237,7 +237,9 @@ IS_INPUT_FILE = false
 - RENDER_COMMAND: 工具的命令行命令及参数。
 - IS_INPUT_FILE: 输入方式是最后一个参数为文件路径还是从标准输入读取。
 
-
+## Time (`time`)
+- `FORMAT`: 显示在界面上的时间格式。比如： RFC1123 或者 2006-01-02 15:04:05
+- `UI_LOCATION`: 显示在界面上的时区，默认为本地时区。比如： Asia/Shanghai
 
 ## Other (`other`)
 

modules/base/tool.go

@@ -399,7 +399,7 @@ func TimeSince(then time.Time, lang string) template.HTML {
 
 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),
+		then.In(setting.UILocation).Format(setting.TimeFormat),
 		timeSince(then, now, lang)))
 }
 
@@ -410,7 +410,7 @@ func TimeSinceUnix(then util.TimeStamp, lang string) template.HTML {
 
 func htmlTimeSinceUnix(then, now util.TimeStamp, lang string) template.HTML {
 	return template.HTML(fmt.Sprintf(`<span class="time-since" title="%s">%s</span>`,
-		then.Format(setting.TimeFormat),
+		then.FormatInLocation(setting.TimeFormat, setting.UILocation),
 		timeSinceUnix(int64(then), int64(now), lang)))
 }
 

modules/setting/setting.go

@@ -278,6 +278,8 @@ var (
 
 	// Time settings
 	TimeFormat string
+	// UILocation is the location on the UI, so that we can display the time on UI.
+	UILocation = time.Local
 
 	CSRFCookieName     = "_csrf"
 	CSRFCookieHTTPOnly = true
@@ -356,10 +358,6 @@ var (
 	HasRobotsTxt      bool
 	InternalToken     string // internal access token
 	IterateBufferSize int
-
-	// UILocation is the location on the UI, so that we can display the time on UI.
-	// Currently only show the default time.Local, it could be added to app.ini after UI is ready
-	UILocation = time.Local
 )
 
 // DateLang transforms standard language locale name to corresponding value in datetime plugin.
@@ -792,7 +790,7 @@ func NewContext() {
 	AttachmentMaxFiles = sec.Key("MAX_FILES").MustInt(5)
 	AttachmentEnabled = sec.Key("ENABLED").MustBool(true)
 
-	TimeFormatKey := Cfg.Section("time").Key("FORMAT").MustString("RFC1123")
+	timeFormatKey := Cfg.Section("time").Key("FORMAT").MustString("RFC1123")
 	TimeFormat = map[string]string{
 		"ANSIC":       time.ANSIC,
 		"UnixDate":    time.UnixDate,
@@ -809,17 +807,28 @@ func NewContext() {
 		"StampMilli":  time.StampMilli,
 		"StampMicro":  time.StampMicro,
 		"StampNano":   time.StampNano,
-	}[TimeFormatKey]
+	}[timeFormatKey]
 	// When the TimeFormatKey does not exist in the previous map e.g.'2006-01-02 15:04:05'
 	if len(TimeFormat) == 0 {
-		TimeFormat = TimeFormatKey
+		TimeFormat = timeFormatKey
 		TestTimeFormat, _ := time.Parse(TimeFormat, TimeFormat)
 		if TestTimeFormat.Format(time.RFC3339) != "2006-01-02T15:04:05Z" {
 			log.Fatal("Can't create time properly, please check your time format has 2006, 01, 02, 15, 04 and 05")
 		}
 		log.Trace("Custom TimeFormat: %s", TimeFormat)
 	}
 
+	zone := Cfg.Section("time").Key("UI_LOCATION").String()
+	if zone != "" {
+		UILocation, err = time.LoadLocation(zone)
+		if err != nil {
+			log.Fatal("Load time zone failed: %v", err)
+		}
+	}
+	if UILocation == nil {
+		UILocation = time.Local
+	}
+
 	RunUser = Cfg.Section("").Key("RUN_USER").MustString(user.CurrentUsername())
 	// Does not check run user when the install lock is off.
 	if InstallLock {

modules/util/time_stamp.go

@@ -35,32 +35,47 @@ func (ts TimeStamp) Year() int {
 
 // AsTime convert timestamp as time.Time in Local locale
 func (ts TimeStamp) AsTime() (tm time.Time) {
-	tm = time.Unix(int64(ts), 0).In(setting.UILocation)
+	return ts.AsTimeInLocation(setting.UILocation)
+}
+
+// AsTimeInLocation convert timestamp as time.Time in Local locale
+func (ts TimeStamp) AsTimeInLocation(loc *time.Location) (tm time.Time) {
+	tm = time.Unix(int64(ts), 0).In(loc)
 	return
 }
 
 // AsTimePtr convert timestamp as *time.Time in Local locale
 func (ts TimeStamp) AsTimePtr() *time.Time {
-	tm := time.Unix(int64(ts), 0).In(setting.UILocation)
+	return ts.AsTimePtrInLocation(setting.UILocation)
+}
+
+// AsTimePtr convert timestamp as *time.Time in Local locale
+func (ts TimeStamp) AsTimePtrInLocation(loc *time.Location) *time.Time {
+	tm := time.Unix(int64(ts), 0).In(loc)
 	return &tm
 }
 
-// Format formats timestamp as
+// Format formats timestamp as given format
 func (ts TimeStamp) Format(f string) string {
-	return ts.AsTime().Format(f)
+	return ts.FormatInLocation(f, setting.UILocation)
+}
+
+// FormatInLocation formats timestamp as given format with spiecific location
+func (ts TimeStamp) FormatInLocation(f string, loc *time.Location) string {
+	return ts.AsTimeInLocation(loc).Format(f)
 }
 
 // FormatLong formats as RFC1123Z
-func (ts TimeStamp) FormatLong() string {
+/*func (ts TimeStamp) FormatLong() string {
 	return ts.Format(time.RFC1123Z)
 }
 
 // FormatShort formats as short
 func (ts TimeStamp) FormatShort() string {
 	return ts.Format("Jan 02, 2006")
-}
+}*/
 
 // IsZero is zero time
 func (ts TimeStamp) IsZero() bool {
-	return ts.AsTime().IsZero()
+	return ts.AsTimeInLocation(time.Local).IsZero()
 }