Repository navigation
Expand file tree
/
Copy pathghostly.go
More file actions
executable file
·378 lines (326 loc) · 8.95 KB
/
Copy pathghostly.go
File metadata and controls
executable file
·378 lines (326 loc) · 8.95 KB
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
package ghostly
import (
"fmt"
"log"
"net/http"
"os"
"strconv"
"strings"
"time"
"github.com/CloudyKit/jet/v6"
"github.com/alexedwards/scs/v2"
"github.com/dgraph-io/badger/v3"
"github.com/dominic-wassef/ghostly/cache"
"github.com/dominic-wassef/ghostly/mailer"
"github.com/dominic-wassef/ghostly/render"
"github.com/dominic-wassef/ghostly/session"
"github.com/go-chi/chi/v5"
"github.com/gomodule/redigo/redis"
"github.com/joho/godotenv"
"github.com/robfig/cron/v3"
)
const version = "1.0.0"
var myRedisCache *cache.RedisCache
var myBadgerCache *cache.BadgerCache
var redisPool *redis.Pool
var badgerConn *badger.DB
// Ghostly is the overall type for the Ghostly package. Members that are exported in this type
// are available to any application that uses it.
type Ghostly struct {
AppName string
Debug bool
Version string
ErrorLog *log.Logger
InfoLog *log.Logger
RootPath string
Routes *chi.Mux
Render *render.Render
Session *scs.SessionManager
DB Database
JetViews *jet.Set
config config
EncryptionKey string
Cache cache.Cache
Scheduler *cron.Cron
Mail mailer.Mail
Server Server
}
type Server struct {
ServerName string
Port string
Secure bool
URL string
}
type config struct {
port string
renderer string
cookie cookieConfig
sessionType string
database databaseConfig
redis redisConfig
}
// New reads the .env file, creates our application config, populates the Ghostly type with settings
// based on .env values, and creates necessary folders and files if they don't exist
func (g *Ghostly) New(rootPath string) error {
pathConfig := initPaths{
rootPath: rootPath,
folderNames: []string{"handlers", "migrations", "views", "mail", "data", "public", "tmp", "logs", "middleware"},
}
err := g.Init(pathConfig)
if err != nil {
return err
}
err = g.checkDotEnv(rootPath)
if err != nil {
return err
}
// read .env
err = godotenv.Load(rootPath + "/.env")
if err != nil {
return err
}
// create loggers
infoLog, errorLog := g.startLoggers()
// connect to database
if os.Getenv("DATABASE_TYPE") != "" {
db, err := g.OpenDB(os.Getenv("DATABASE_TYPE"), g.BuildDSN())
if err != nil {
errorLog.Println(err)
os.Exit(1)
}
g.DB = Database{
DataType: os.Getenv("DATABASE_TYPE"),
Pool: db,
}
}
scheduler := cron.New()
g.Scheduler = scheduler
if os.Getenv("CACHE") == "redis" || os.Getenv("SESSION_TYPE") == "redis" {
myRedisCache = g.createClientRedisCache()
g.Cache = myRedisCache
redisPool = myRedisCache.Conn
}
if os.Getenv("CACHE") == "badger" {
myBadgerCache = g.createClientBadgerCache()
g.Cache = myBadgerCache
badgerConn = myBadgerCache.Conn
_, err = g.Scheduler.AddFunc("@daily", func() {
_ = myBadgerCache.Conn.RunValueLogGC(0.7)
})
if err != nil {
return err
}
}
g.InfoLog = infoLog
g.ErrorLog = errorLog
g.Debug, _ = strconv.ParseBool(os.Getenv("DEBUG"))
g.Version = version
g.RootPath = rootPath
g.Mail = g.createMailer()
g.Routes = g.routes().(*chi.Mux)
g.config = config{
port: os.Getenv("PORT"),
renderer: os.Getenv("RENDERER"),
cookie: cookieConfig{
name: os.Getenv("COOKIE_NAME"),
lifetime: os.Getenv("COOKIE_LIFETIME"),
persist: os.Getenv("COOKIE_PERSISTS"),
secure: os.Getenv("COOKIE_SECURE"),
domain: os.Getenv("COOKIE_DOMAIN"),
},
sessionType: os.Getenv("SESSION_TYPE"),
database: databaseConfig{
database: os.Getenv("DATABASE_TYPE"),
dsn: g.BuildDSN(),
},
redis: redisConfig{
host: os.Getenv("REDIS_HOST"),
password: os.Getenv("REDIS_PASSWORD"),
prefix: os.Getenv("REDIS_PREFIX"),
},
}
secure := true
if strings.ToLower(os.Getenv("SECURE")) == "false" {
secure = false
}
g.Server = Server{
ServerName: os.Getenv("SERVER_NAME"),
Port: os.Getenv("PORT"),
Secure: secure,
URL: os.Getenv("APP_URL"),
}
// create session
sess := session.Session{
CookieLifetime: g.config.cookie.lifetime,
CookiePersist: g.config.cookie.persist,
CookieName: g.config.cookie.name,
SessionType: g.config.sessionType,
CookieDomain: g.config.cookie.domain,
}
switch g.config.sessionType {
case "redis":
sess.RedisPool = myRedisCache.Conn
case "mysql", "postgres", "mariadb", "postgresql":
sess.DBPool = g.DB.Pool
}
g.Session = sess.InitSession()
g.EncryptionKey = os.Getenv("KEY")
if g.Debug {
var views = jet.NewSet(
jet.NewOSFileSystemLoader(fmt.Sprintf("%s/views", rootPath)),
jet.InDevelopmentMode(),
)
g.JetViews = views
} else {
var views = jet.NewSet(
jet.NewOSFileSystemLoader(fmt.Sprintf("%s/views", rootPath)),
)
g.JetViews = views
}
g.createRenderer()
go g.Mail.ListenForMail()
return nil
}
// Init creates necessary folders for our Ghostly application
func (g *Ghostly) Init(p initPaths) error {
root := p.rootPath
for _, path := range
CC99
p.folderNames {
// create folder if it doesn't exist
err := g.CreateDirIfNotExist(root + "/" + path)
if err != nil {
return err
}
}
return nil
}
// ListenAndServe starts the web server
func (g *Ghostly) ListenAndServe() {
srv := &http.Server{
Addr: fmt.Sprintf(":%s", os.Getenv("PORT")),
ErrorLog: g.ErrorLog,
Handler: g.Routes,
IdleTimeout: 30 * time.Second,
ReadTimeout: 30 * time.Second,
WriteTimeout: 600 * time.Second,
}
if g.DB.Pool != nil {
defer g.DB.Pool.Close()
}
if redisPool != nil {
defer redisPool.Close()
}
if badgerConn != nil {
defer badgerConn.Close()
}
g.InfoLog.Printf("Listening on port %s", os.Getenv("PORT"))
err := srv.ListenAndServe()
g.ErrorLog.Fatal(err)
}
func (g *Ghostly) checkDotEnv(path string) error {
err := g.CreateFileIfNotExists(fmt.Sprintf("%s/.env", path))
if err != nil {
return err
}
return nil
}
func (g *Ghostly) startLoggers() (*log.Logger, *log.Logger) {
var infoLog *log.Logger
var errorLog *log.Logger
infoLog = log.New(os.Stdout, "INFO\t", log.Ldate|log.Ltime)
errorLog = log.New(os.Stdout, "ERROR\t", log.Ldate|log.Ltime|log.Lshortfile)
return infoLog, errorLog
}
func (g *Ghostly) createRenderer() {
myRenderer := render.Render{
Renderer: g.config.renderer,
RootPath: g.RootPath,
Port: g.config.port,
JetViews: g.JetViews,
Session: g.Session,
}
g.Render = &myRenderer
}
func (g *Ghostly) createMailer() mailer.Mail {
port, _ := strconv.Atoi(os.Getenv("SMTP_PORT"))
m := mailer.Mail{
Domain: os.Getenv("MAIL_DOMAIN"),
Templates: g.RootPath + "/mail",
Host: os.Getenv("SMTP_HOST"),
Port: port,
Username: os.Getenv("SMTP_USERNAME"),
Password: os.Getenv("SMTP_PASSWORD"),
Encryption: os.Getenv("SMTP_ENCRYPTION"),
FromName: os.Getenv("FROM_NAME"),
FromAddress: os.Getenv("FROM_ADDRESS"),
Jobs: make(chan mailer.Message, 20),
Results: make(chan mailer.Result, 20),
API: os.Getenv("MAILER_API"),
APIKey: os.Getenv("MAILER_KEY"),
APIUrl: os.Getenv("MAILER_URL"),
}
return m
}
func (g *Ghostly) createClientRedisCache() *cache.RedisCache {
cacheClient := cache.RedisCache{
Conn: g.createRedisPool(),
Prefix: g.config.redis.prefix,
}
return &cacheClient
}
func (g *Ghostly) createClientBadgerCache() *cache.BadgerCache {
cacheClient := cache.BadgerCache{
Conn: g.createBadgerConn(),
}
return &cacheClient
}
func (g *Ghostly) createRedisPool() *redis.Pool {
return &redis.Pool{
MaxIdle: 50,
MaxActive: 10000,
IdleTimeout: 240 * time.Second,
Dial: func() (redis.Conn, error) {
return redis.Dial("tcp",
g.config.redis.host,
redis.DialPassword(g.config.redis.password))
},
TestOnBorrow: func(conn redis.Conn, t time.Time) error {
_, err := conn.Do("PING")
return err
},
}
}
func (g *Ghostly) createBadgerConn() *badger.DB {
db, err := badger.Open(badger.DefaultOptions(g.RootPath + "/tmp/badger"))
if err != nil {
return nil
}
return db
}
// BuildDSN builds the datasource name for our database, and returns it as a string
func (g *Ghostly) BuildDSN() string {
var dsn string
switch os.Getenv("DATABASE_TYPE") {
case "postgres", "postgresql":
dsn = fmt.Sprintf("host=%s port=%s user=%s dbname=%s sslmode=%s timezone=UTC connect_timeout=5",
os.Getenv("DATABASE_HOST"),
os.Getenv("DATABASE_PORT"),
os.Getenv("DATABASE_USER"),
os.Getenv("DATABASE_NAME"),
os.Getenv("DATABASE_SSL_MODE"))
// we check to see if a database password has been supplied, since including "password=" with nothing
// after it sometimes causes postgres to fail to allow a connection.
if os.Getenv("DATABASE_PASS") != "" {
dsn = fmt.Sprintf("%s password=%s", dsn, os.Getenv("DATABASE_PASS"))
}
case "mysql", "mariadb":
dsn = fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?collation=utf8_unicode_ci&timeout=5s&parseTime=true&tls=%s&readTimeout=5s",
os.Getenv("DATABASE_USER"),
os.Getenv("DATABASE_PASS"),
os.Getenv("DATABASE_HOST"),
os.Getenv("DATABASE_PORT"),
os.Getenv("DATABASE_NAME"),
os.Getenv("DATABASE_SSL_MODE"))
default:
}
return dsn
}