-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
log.go
192 lines (169 loc) · 4.34 KB
/
log.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
package logger
import (
"context"
"errors"
"fmt"
"os"
"path/filepath"
"strings"
"sync"
"time"
"github.com/KJHJason/Cultured-Downloader-Logic/constants"
cdlerrors "github.com/KJHJason/Cultured-Downloader-Logic/errors"
"github.com/KJHJason/Cultured-Downloader-Logic/iofuncs"
)
const (
LOG_SUFFIX = "\n\n"
LOG_PERMS = 0644 // rw-r--r--
LOG_THRESHOLD = 15 * 24 * time.Hour
)
var (
MainLogger Logger
logFolder = filepath.Join(iofuncs.APP_PATH, "logs")
logFilePath = filepath.Join(logFolder, getLogFileName())
)
func getLogFileName() string {
return fmt.Sprintf(
"cultured_downloader-logic_v%s_%s.log",
constants.VERSION,
time.Now().Format("2006-01-02"),
)
}
func init() {
// create the logs directory if it does not exist
os.MkdirAll(logFolder, LOG_PERMS)
// will be opened throughout the program's runtime
// hence, there is no need to call f.Close() at the end of this function
logFlags := os.O_WRONLY | os.O_CREATE | os.O_APPEND
f, fileErr := os.OpenFile(
logFilePath,
logFlags,
LOG_PERMS,
)
if fileErr == nil {
MainLogger = NewLogger(f)
} else {
fileErr = fmt.Errorf(
"error opening log file: %w\nlog file path: %s",
fileErr,
logFilePath,
)
// fallback to cwd if the logs directory cannot be created
var fallbackFileErr error
f, fallbackFileErr = os.OpenFile(
getLogFileName(),
logFlags,
LOG_PERMS,
)
if fallbackFileErr != nil {
panic(fileErr)
}
MainLogger = NewLogger(f)
LogError(fileErr, ERROR)
}
DeleteEmptyAndOldLogs()
}
func DeleteLogsOnCond(condToSkip func(os.FileInfo) bool) error {
return filepath.Walk(logFolder, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() || path == logFilePath || (condToSkip != nil && condToSkip(info)) {
return nil
}
return os.Remove(path)
})
}
// Delete all empty log files and log files
// older than the log threshold except for the current day's log file.
func DeleteEmptyAndOldLogs() error {
return DeleteLogsOnCond(func(info os.FileInfo) bool {
isNewerThan7Days := time.Since(info.ModTime()) < LOG_THRESHOLD
return isNewerThan7Days
})
}
// Thread-safe logging function that logs to "cultured_downloader.log" in the logs directory
func LogError(err error, level int) {
if err == nil {
return
}
MainLogger.LogBasedOnLvl(level, err.Error()+LOG_SUFFIX)
}
// Uses the thread-safe LogError() function to log multiple errors
//
// Also returns if any errors were due to context.Canceled which is caused by Ctrl + C.
func LogErrors(level int, errs ...error) bool {
var hasCanceled bool
for _, err := range errs {
if errors.Is(err, context.Canceled) {
if !hasCanceled {
hasCanceled = true
}
continue
}
LogError(err, level)
}
return hasCanceled
}
// Uses the thread-safe LogError() function to log a channel of errors
//
// Also returns if any errors were due to context.Canceled which is caused by Ctrl + C.
func LogChanErrors(level int, errChan chan error) (bool, []error) {
var hasCanceled bool
errSlice := make([]error, 0, len(errChan))
for err := range errChan {
if errors.Is(err, context.Canceled) {
if !hasCanceled {
hasCanceled = true
}
continue
}
LogError(err, level)
errSlice = append(errSlice, err)
}
return hasCanceled, errSlice
}
var logToPathMux sync.Mutex
// Thread-safe logging function that logs to the provided file path
func LogMessageToPath(message, filePath string, level int) {
logToPathMux.Lock()
defer logToPathMux.Unlock()
os.MkdirAll(filepath.Dir(filePath), LOG_PERMS)
if iofuncs.PathExists(filePath) {
logFileContents, err := os.ReadFile(filePath)
if err != nil {
err = fmt.Errorf(
"error %d: failed to read log file, more info => %w\nfile path: %s\noriginal message: %s",
cdlerrors.OS_ERROR,
err,
filePath,
message,
)
LogError(err, ERROR)
return
}
// check if the same message has already been logged
if strings.Contains(string(logFileContents), message) {
return
}
}
logFile, err := os.OpenFile(
filePath,
os.O_RDWR|os.O_CREATE|os.O_APPEND,
LOG_PERMS,
)
if err != nil {
err = fmt.Errorf(
"error %d: failed to open log file, more info => %w\nfile path: %s\noriginal message: %s",
cdlerrors.OS_ERROR,
err,
filePath,
message,
)
LogError(err, ERROR)
return
}
defer logFile.Close()
pathLogger := NewLogger(logFile)
pathLogger.LogBasedOnLvl(level, message)
}