2014-02-19 22:04:31 +04:00
// Copyright 2014 The Gogs Authors. All rights reserved.
2016-12-21 15:13:17 +03:00
// Copyright 2016 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2014-02-19 13:50:53 +04:00
2023-07-21 12:28:19 +03:00
package main
2014-02-12 21:49:46 +04:00
import (
2014-02-19 13:50:53 +04:00
"os"
2019-01-24 18:22:51 +03:00
"runtime"
2017-02-28 03:40:02 +03:00
"strings"
2020-11-18 01:44:52 +03:00
"time"
2016-12-01 02:56:15 +03:00
2016-11-10 19:24:48 +03:00
"code.gitea.io/gitea/cmd"
2017-01-04 16:16:03 +03:00
"code.gitea.io/gitea/modules/log"
2016-11-10 19:24:48 +03:00
"code.gitea.io/gitea/modules/setting"
2018-11-01 16:41:07 +03:00
2017-09-21 08:20:14 +03:00
// register supported doc types
2023-01-18 03:46:58 +03:00
_ "code.gitea.io/gitea/modules/markup/asciicast"
2022-06-09 00:46:39 +03:00
_ "code.gitea.io/gitea/modules/markup/console"
2018-07-21 00:08:15 +03:00
_ "code.gitea.io/gitea/modules/markup/csv"
2017-09-21 08:20:14 +03:00
_ "code.gitea.io/gitea/modules/markup/markdown"
_ "code.gitea.io/gitea/modules/markup/orgmode"
2023-08-05 18:36:45 +03:00
"github.com/urfave/cli/v2"
2014-02-12 21:49:46 +04:00
)
2023-07-21 12:28:19 +03:00
// these flags will be set by the build flags
2019-04-02 19:10:11 +03:00
var (
2023-07-21 12:28:19 +03:00
Version = "development" // program version for this build
Tags = "" // the Golang build tags
MakeVersion = "" // "make" program version if built with make
2019-04-02 19:10:11 +03:00
)
2017-02-28 03:40:02 +03:00
2014-02-12 23:54:09 +04:00
func init ( ) {
2016-11-04 14:32:04 +03:00
setting . AppVer = Version
2019-06-12 22:41:28 +03:00
setting . AppBuiltWith = formatBuiltWith ( )
2020-11-18 01:44:52 +03:00
setting . AppStartTime = time . Now ( ) . UTC ( )
Refactor path & config system (#25330)
# The problem
There were many "path tricks":
* By default, Gitea uses its program directory as its work path
* Gitea tries to use the "work path" to guess its "custom path" and
"custom conf (app.ini)"
* Users might want to use other directories as work path
* The non-default work path should be passed to Gitea by GITEA_WORK_DIR
or "--work-path"
* But some Gitea processes are started without these values
* The "serv" process started by OpenSSH server
* The CLI sub-commands started by site admin
* The paths are guessed by SetCustomPathAndConf again and again
* The default values of "work path / custom path / custom conf" can be
changed when compiling
# The solution
* Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use
test code to cover its behaviors.
* When Gitea's web server runs, write the WORK_PATH to "app.ini", this
value must be the most correct one, because if this value is not right,
users would find that the web UI doesn't work and then they should be
able to fix it.
* Then all other sub-commands can use the WORK_PATH in app.ini to
initialize their paths.
* By the way, when Gitea starts for git protocol, it shouldn't output
any log, otherwise the git protocol gets broken and client blocks
forever.
The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path
> env var GITEA_WORK_DIR > builtin default
The "app.ini" searching order is: cmd arg --config > cmd arg "work path
/ custom path" > env var "work path / custom path" > builtin default
## ⚠️ BREAKING
If your instance's "work path / custom path / custom conf" doesn't meet
the requirements (eg: work path must be absolute), Gitea will report a
fatal error and exit. You need to set these values according to the
error log.
----
Close #24818
Close #24222
Close #21606
Close #21498
Close #25107
Close #24981
Maybe close #24503
Replace #23301
Replace #22754
And maybe more
2023-06-21 08:50:26 +03:00
}
2019-04-29 21:08:21 +03:00
2014-02-12 21:49:46 +04:00
func main ( ) {
2023-08-05 18:36:45 +03:00
cli . OsExiter = func ( code int ) {
log . GetManager ( ) . Close ( )
os . Exit ( code )
2016-12-01 02:56:15 +03:00
}
2024-04-27 15:23:37 +03:00
app := cmd . NewMainApp ( cmd . AppVersion { Version : Version , Extra : formatBuiltWith ( ) } )
2023-08-05 18:36:45 +03:00
_ = cmd . RunMainApp ( app , os . Args ... ) // all errors should have been handled by the RunMainApp
Rewrite logger system (#24726)
## ⚠️ Breaking
The `log.<mode>.<logger>` style config has been dropped. If you used it,
please check the new config manual & app.example.ini to make your
instance output logs as expected.
Although many legacy options still work, it's encouraged to upgrade to
the new options.
The SMTP logger is deleted because SMTP is not suitable to collect logs.
If you have manually configured Gitea log options, please confirm the
logger system works as expected after upgrading.
## Description
Close #12082 and maybe more log-related issues, resolve some related
FIXMEs in old code (which seems unfixable before)
Just like rewriting queue #24505 : make code maintainable, clear legacy
bugs, and add the ability to support more writers (eg: JSON, structured
log)
There is a new document (with examples): `logging-config.en-us.md`
This PR is safer than the queue rewriting, because it's just for
logging, it won't break other logic.
## The old problems
The logging system is quite old and difficult to maintain:
* Unclear concepts: Logger, NamedLogger, MultiChannelledLogger,
SubLogger, EventLogger, WriterLogger etc
* Some code is diffuclt to konw whether it is right:
`log.DelNamedLogger("console")` vs `log.DelNamedLogger(log.DEFAULT)` vs
`log.DelLogger("console")`
* The old system heavily depends on ini config system, it's difficult to
create new logger for different purpose, and it's very fragile.
* The "color" trick is difficult to use and read, many colors are
unnecessary, and in the future structured log could help
* It's difficult to add other log formats, eg: JSON format
* The log outputer doesn't have full control of its goroutine, it's
difficult to make outputer have advanced behaviors
* The logs could be lost in some cases: eg: no Fatal error when using
CLI.
* Config options are passed by JSON, which is quite fragile.
* INI package makes the KEY in `[log]` section visible in `[log.sub1]`
and `[log.sub1.subA]`, this behavior is quite fragile and would cause
more unclear problems, and there is no strong requirement to support
`log.<mode>.<logger>` syntax.
## The new design
See `logger.go` for documents.
## Screenshot
<details>
![image](https://github.com/go-gitea/gitea/assets/2114189/4462d713-ba39-41f5-bb08-de912e67e1ff)
![image](https://github.com/go-gitea/gitea/assets/2114189/b188035e-f691-428b-8b2d-ff7b2199b2f9)
![image](https://github.com/go-gitea/gitea/assets/2114189/132e9745-1c3b-4e00-9e0d-15eaea495dee)
</details>
## TODO
* [x] add some new tests
* [x] fix some tests
* [x] test some sub-commands (manually ....)
---------
Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-05-22 01:35:11 +03:00
log . GetManager ( ) . Close ( )
2014-02-12 21:49:46 +04:00
}
2017-02-28 03:40:02 +03:00
2019-06-12 22:41:28 +03:00
func formatBuiltWith ( ) string {
2022-01-20 20:46:10 +03:00
version := runtime . Version ( )
2019-04-02 19:10:11 +03:00
if len ( MakeVersion ) > 0 {
version = MakeVersion + ", " + runtime . Version ( )
}
2017-02-28 03:40:02 +03:00
if len ( Tags ) == 0 {
2019-04-02 19:10:11 +03:00
return " built with " + version
2017-02-28 03:40:02 +03:00
}
2020-10-11 23:27:20 +03:00
return " built with " + version + " : " + strings . ReplaceAll ( Tags , " " , ", " )
2017-02-28 03:40:02 +03:00
}