Skip to content

Commit f793d43

Browse files
JoshuaDoesJoshuaDoes
committed
main: Initial commit
- Import old .gitignore and LICENSE - Add logrus wrapper - Import old watchdog to monitor and respawn the bot process - Add empty bot mode
0 parents  commit f793d43

File tree

7 files changed

+295
-0
lines changed

7 files changed

+295
-0
lines changed

‎.gitignore

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Bot configuration
2+
config.json
3+
4+
# Bot save states
5+
state/
6+
7+
# Bot temporaries
8+
.update
9+
.restart
10+
crash.txt
11+
stacktrace.txt
12+
.firstrun
13+
14+
# Output executables
15+
*.exe
16+
*.app
17+
*.old
18+
19+
# Most probable output executables for Linux
20+
clinet
21+
22+
# Log files
23+
*.log
24+
25+
# OS leftovers
26+
desktop.ini

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017-2019 JoshuaDoes
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# clinet-rewrite
2+
It's about time I started on this, tbh. Check back often to see the progress!

‎bot.go

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
package main
2+
3+
func doBot() {
4+
log.Trace("--- doBot() ---")
5+
6+
log.Warn("Bot mode is not yet implemented!")
7+
}

‎main.go

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
package main
2+
3+
import (
4+
5+
flag "github.com/spf13/pflag"
6+
"github.com/Clinet/clinet/utils/logger"
7+
)
8+
9+
var (
10+
//Various command-line flags
11+
verbosity int //0 = default (info, warning, error), 1 = 0 + debug, 2 = 1 + trace
12+
isBot bool //if true, act as the bot process instead of the watchdog process
13+
killOldBot bool //if true, search for dangling bot processes and kill them
14+
watchdogPID int //stores the watchdog PID if acting as a bot process, used as the exception when killing old bot processes
15+
16+
//Logging
17+
log *logger.Logger
18+
logPrefix string = "WATCHDOG"
19+
)
20+
21+
func init() {
22+
//Apply all command-line flags
23+
flag.IntVar(&verbosity, "verbosity", 0, "sets the verbosity level; 0 = default, 1 = debug, 2 = trace")
24+
flag.BoolVar(&isBot, "isBot", false, "act as the bot process instead of the watchdog process")
25+
flag.BoolVar(&killOldBot, "killOldBot", false, "search for dangling bot processes and kill them")
26+
flag.IntVar(&watchdogPID, "watchdogPID", -1, "used as the exception when killing old bot processes, requires --killOldBot")
27+
flag.Parse()
28+
29+
//Create the logger
30+
if isBot {
31+
logPrefix = "BOT"
32+
}
33+
log = logger.NewLogger(logPrefix, verbosity)
34+
}
35+
36+
func main() {
37+
log.Trace("--- main() ---")
38+
39+
if watchdogPID == -1 {
40+
log.Info("Clinet © JoshuaDoes: 2017-2020.")
41+
}
42+
43+
if isBot {
44+
doBot()
45+
} else {
46+
doWatchdog()
47+
}
48+
49+
log.Info("Good-bye!")
50+
}

‎utils/logger/logger.go

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
package logger
2+
3+
/*
4+
verbosity := 2 (0 = default, 1 = debug, 2 = trace)
5+
log := logger.NewLogger(verbosity)
6+
log.Trace("Something very low level.")
7+
log.Debug("Useful debugging information.")
8+
log.Info("Something noteworthy happened!")
9+
log.Warn("You should probably take a look at this.")
10+
log.Error("Something failed but I'm not quitting.")
11+
// Calls os.Exit(1) after logging
12+
log.Fatal("Bye.")
13+
// Calls panic() after logging
14+
log.Panic("I'm bailing.")
15+
*/
16+
17+
import (
18+
"github.com/sirupsen/logrus"
19+
prefixed "github.com/x-cray/logrus-prefixed-formatter"
20+
)
21+
22+
type Logger struct {
23+
logger *logrus.Logger
24+
prefix string
25+
}
26+
27+
//NewLogger returns a logger with the specified verbosity level.
28+
// prefix: string: the prefix for the logger
29+
// verbosity: int: declares the verbosity level
30+
// - 0: default logging (info, warning, error)
31+
// - 1: includes 0, plus debug logging
32+
// - 2: includes 1, plus trace logging
33+
func NewLogger(prefix string, verbosity int) *Logger {
34+
formatter := new(prefixed.TextFormatter)
35+
formatter.FullTimestamp = true
36+
37+
log := logrus.New()
38+
log.Formatter = formatter
39+
40+
switch verbosity {
41+
case 2:
42+
log.Level = logrus.TraceLevel
43+
case 1:
44+
log.Level = logrus.DebugLevel
45+
case 0:
46+
log.Level = logrus.InfoLevel
47+
}
48+
49+
return &Logger{
50+
logger: log,
51+
prefix: prefix,
52+
}
53+
}
54+
55+
func (logger *Logger) Trace(args ...interface{}) {
56+
logger.logger.WithField("prefix", logger.prefix).Trace(args...)
57+
}
58+
func (logger *Logger) Debug(args ...interface{}) {
59+
logger.logger.WithField("prefix", logger.prefix).Debug(args...)
60+
}
61+
func (logger *Logger) Info(args ...interface{}) {
62+
logger.logger.WithField("prefix", logger.prefix).Info(args...)
63+
}
64+
func (logger *Logger) Warn(args ...interface{}) {
65+
logger.logger.WithField("prefix", logger.prefix).Warn(args...)
66+
}
67+
func (logger *Logger) Error(args ...interface{}) {
68+
logger.logger.WithField("prefix", logger.prefix).Error(args...)
69+
}
70+
func (logger *Logger) Fatal(args ...interface{}) {
71+
logger.logger.WithField("prefix", logger.prefix).Fatal(args...)
72+
}
73+
func (logger *Logger) Panic(args ...interface{}) {
74+
logger.logger.WithField("prefix", logger.prefix).Panic(args...)
75+
}

‎watchdog.go

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
package main
2+
3+
import (
4+
"os"
5+
"os/exec"
6+
"os/signal"
7+
"path/filepath"
8+
"runtime"
9+
"strconv"
10+
"syscall"
11+
"time"
12+
13+
"github.com/mitchellh/go-ps"
14+
)
15+
16+
var sig = syscall.SIGINT
17+
var watchdogDelay = (5 * time.Second)
18+
19+
func doWatchdog() {
20+
log.Trace("--- doWatchdog() ---")
21+
22+
log.Debug("Spawning initial bot process")
23+
botPID := spawnBot()
24+
log.Debug("Creating signal channel")
25+
sc := make(chan os.Signal, 1)
26+
log.Debug("Registering notification for ", sig, " on signal channel")
27+
signal.Notify(sc, sig)
28+
log.Debug("Creating watchdog ticker for ", watchdogDelay)
29+
watchdogTicker := time.Tick(watchdogDelay)
30+
31+
for {
32+
select {
33+
case _, ok := <-sc:
34+
if ok {
35+
log.Debug("Finding process for bot PID ", botPID)
36+
botProcess, _ := os.FindProcess(botPID)
37+
log.Debug("Sending ", sig, " signal to bot process")
38+
_ = botProcess.Signal(sig)
39+
log.Debug("Waiting for bot process to exit gracefully")
40+
waitProcess(botPID)
41+
log.Debug("Exiting")
42+
os.Exit(0)
43+
}
44+
case <- watchdogTicker:
45+
if !isProcessRunning(botPID) {
46+
botPID = spawnBot()
47+
}
48+
}
49+
}
50+
}
51+
52+
func spawnBot() int {
53+
log.Trace("--- spawnBot() ---")
54+
55+
if killOldBot {
56+
processList, err := ps.Processes()
57+
if err == nil {
58+
for _, process := range processList {
59+
if process.Pid() != os.Getpid() && process.Pid() != watchdogPID && process.Executable() == filepath.Base(os.Args[0]) {
60+
oldProcess, err := os.FindProcess(process.Pid())
61+
if err == nil {
62+
oldProcess.Signal(syscall.SIGKILL)
63+
}
64+
}
65+
}
66+
}
67+
}
68+
69+
botProcess := exec.Command(os.Args[0], "--isBot", "--watchdogPID", strconv.Itoa(os.Getpid()), "--verbosity", strconv.Itoa(verbosity))
70+
botProcess.Stdout = os.Stdout
71+
botProcess.Stderr = os.Stderr
72+
73+
log.Debug("Spawning bot process")
74+
err := botProcess.Start()
75+
if err != nil {
76+
panic(err)
77+
}
78+
log.Debug("Created bot process with PID ", botProcess.Process.Pid)
79+
80+
return botProcess.Process.Pid
81+
}
82+
83+
func isProcessRunning(pid int) bool {
84+
log.Trace("--- isProcessRunning(pid: ", pid, ") ---")
85+
86+
process, err := os.FindProcess(pid)
87+
if err != nil {
88+
return false
89+
}
90+
91+
if runtime.GOOS != "windows" {
92+
return process.Signal(syscall.Signal(0)) == nil
93+
}
94+
95+
processState, err := process.Wait()
96+
if err != nil {
97+
return false
98+
}
99+
if processState.Exited() {
100+
return false
101+
}
102+
103+
return true
104+
}
105+
106+
func waitProcess(pid int) {
107+
log.Trace("--- waitProcess(pid: ", pid, ") ---")
108+
109+
process, err := os.FindProcess(pid)
110+
if err != nil {
111+
return
112+
}
113+
_, _ = process.Wait()
114+
}

0 commit comments

Comments
 (0)