mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-05 04:48:02 +01:00
6433ba0ec3
Use [chi](https://github.com/go-chi/chi) instead of the forked [macaron](https://gitea.com/macaron/macaron). Since macaron and chi have conflicts with session share, this big PR becomes a have-to thing. According my previous idea, we can replace macaron step by step but I'm wrong. :( Below is a list of big changes on this PR. - [x] Define `context.ResponseWriter` interface with an implementation `context.Response`. - [x] Use chi instead of macaron, and also a customize `Route` to wrap chi so that the router usage is similar as before. - [x] Create different routers for `web`, `api`, `internal` and `install` so that the codes will be more clear and no magic . - [x] Use https://github.com/unrolled/render instead of macaron's internal render - [x] Use https://github.com/NYTimes/gziphandler instead of https://gitea.com/macaron/gzip - [x] Use https://gitea.com/go-chi/session which is a modified version of https://gitea.com/macaron/session and removed `nodb` support since it will not be maintained. **BREAK** - [x] Use https://gitea.com/go-chi/captcha which is a modified version of https://gitea.com/macaron/captcha - [x] Use https://gitea.com/go-chi/cache which is a modified version of https://gitea.com/macaron/cache - [x] Use https://gitea.com/go-chi/binding which is a modified version of https://gitea.com/macaron/binding - [x] Use https://github.com/go-chi/cors instead of https://gitea.com/macaron/cors - [x] Dropped https://gitea.com/macaron/i18n and make a new one in `code.gitea.io/gitea/modules/translation` - [x] Move validation form structs from `code.gitea.io/gitea/modules/auth` to `code.gitea.io/gitea/modules/forms` to avoid dependency cycle. - [x] Removed macaron log service because it's not need any more. **BREAK** - [x] All form structs have to be get by `web.GetForm(ctx)` in the route function but not as a function parameter on routes definition. - [x] Move Git HTTP protocol implementation to use routers directly. - [x] Fix the problem that chi routes don't support trailing slash but macaron did. - [x] `/api/v1/swagger` now will be redirect to `/api/swagger` but not render directly so that `APIContext` will not create a html render. Notices: - Chi router don't support request with trailing slash - Integration test `TestUserHeatmap` maybe mysql version related. It's failed on my macOS(mysql 5.7.29 installed via brew) but succeed on CI. Co-authored-by: 6543 <6543@obermui.de>
207 lines
4.4 KiB
Go
Vendored
207 lines
4.4 KiB
Go
Vendored
// Copyright 2013 Beego Authors
|
|
// Copyright 2014 The Macaron Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License"): you may
|
|
// not use this file except in compliance with the License. You may obtain
|
|
// a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
// License for the specific language governing permissions and limitations
|
|
// under the License.
|
|
|
|
package cache
|
|
|
|
import (
|
|
"crypto/md5"
|
|
"encoding/hex"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"log"
|
|
"os"
|
|
"path/filepath"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/unknwon/com"
|
|
)
|
|
|
|
// Item represents a cache item.
|
|
type Item struct {
|
|
Val interface{}
|
|
Created int64
|
|
Expire int64
|
|
}
|
|
|
|
func (item *Item) hasExpired() bool {
|
|
return item.Expire > 0 &&
|
|
(time.Now().Unix()-item.Created) >= item.Expire
|
|
}
|
|
|
|
// FileCacher represents a file cache adapter implementation.
|
|
type FileCacher struct {
|
|
lock sync.Mutex
|
|
rootPath string
|
|
interval int // GC interval.
|
|
}
|
|
|
|
// NewFileCacher creates and returns a new file cacher.
|
|
func NewFileCacher() *FileCacher {
|
|
return &FileCacher{}
|
|
}
|
|
|
|
func (c *FileCacher) filepath(key string) string {
|
|
m := md5.Sum([]byte(key))
|
|
hash := hex.EncodeToString(m[:])
|
|
return filepath.Join(c.rootPath, string(hash[0]), string(hash[1]), hash)
|
|
}
|
|
|
|
// Put puts value into cache with key and expire time.
|
|
// If expired is 0, it will be deleted by next GC operation.
|
|
func (c *FileCacher) Put(key string, val interface{}, expire int64) error {
|
|
filename := c.filepath(key)
|
|
item := &Item{val, time.Now().Unix(), expire}
|
|
data, err := EncodeGob(item)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
os.MkdirAll(filepath.Dir(filename), os.ModePerm)
|
|
return ioutil.WriteFile(filename, data, os.ModePerm)
|
|
}
|
|
|
|
func (c *FileCacher) read(key string) (*Item, error) {
|
|
filename := c.filepath(key)
|
|
|
|
data, err := ioutil.ReadFile(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
item := new(Item)
|
|
return item, DecodeGob(data, item)
|
|
}
|
|
|
|
// Get gets cached value by given key.
|
|
func (c *FileCacher) Get(key string) interface{} {
|
|
item, err := c.read(key)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
|
|
if item.hasExpired() {
|
|
os.Remove(c.filepath(key))
|
|
return nil
|
|
}
|
|
return item.Val
|
|
}
|
|
|
|
// Delete deletes cached value by given key.
|
|
func (c *FileCacher) Delete(key string) error {
|
|
return os.Remove(c.filepath(key))
|
|
}
|
|
|
|
// Incr increases cached int-type value by given key as a counter.
|
|
func (c *FileCacher) Incr(key string) error {
|
|
item, err := c.read(key)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
item.Val, err = Incr(item.Val)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return c.Put(key, item.Val, item.Expire)
|
|
}
|
|
|
|
// Decrease cached int value.
|
|
func (c *FileCacher) Decr(key string) error {
|
|
item, err := c.read(key)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
item.Val, err = Decr(item.Val)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return c.Put(key, item.Val, item.Expire)
|
|
}
|
|
|
|
// IsExist returns true if cached value exists.
|
|
func (c *FileCacher) IsExist(key string) bool {
|
|
return com.IsExist(c.filepath(key))
|
|
}
|
|
|
|
// Flush deletes all cached data.
|
|
func (c *FileCacher) Flush() error {
|
|
return os.RemoveAll(c.rootPath)
|
|
}
|
|
|
|
func (c *FileCacher) startGC() {
|
|
c.lock.Lock()
|
|
defer c.lock.Unlock()
|
|
|
|
if c.interval < 1 {
|
|
return
|
|
}
|
|
|
|
if err := filepath.Walk(c.rootPath, func(path string, fi os.FileInfo, err error) error {
|
|
if err != nil {
|
|
return fmt.Errorf("Walk: %v", err)
|
|
}
|
|
|
|
if fi.IsDir() {
|
|
return nil
|
|
}
|
|
|
|
data, err := ioutil.ReadFile(path)
|
|
if err != nil && !os.IsNotExist(err) {
|
|
fmt.Errorf("ReadFile: %v", err)
|
|
}
|
|
|
|
item := new(Item)
|
|
if err = DecodeGob(data, item); err != nil {
|
|
return err
|
|
}
|
|
if item.hasExpired() {
|
|
if err = os.Remove(path); err != nil && !os.IsNotExist(err) {
|
|
return fmt.Errorf("Remove: %v", err)
|
|
}
|
|
}
|
|
return nil
|
|
}); err != nil {
|
|
log.Printf("error garbage collecting cache files: %v", err)
|
|
}
|
|
|
|
time.AfterFunc(time.Duration(c.interval)*time.Second, func() { c.startGC() })
|
|
}
|
|
|
|
// StartAndGC starts GC routine based on config string settings.
|
|
func (c *FileCacher) StartAndGC(opt Options) error {
|
|
c.lock.Lock()
|
|
c.rootPath = opt.AdapterConfig
|
|
c.interval = opt.Interval
|
|
|
|
if !filepath.IsAbs(c.rootPath) {
|
|
panic("rootPath must be an absolute path")
|
|
}
|
|
c.lock.Unlock()
|
|
|
|
if err := os.MkdirAll(c.rootPath, os.ModePerm); err != nil {
|
|
return err
|
|
}
|
|
|
|
go c.startGC()
|
|
return nil
|
|
}
|
|
|
|
func init() {
|
|
Register("file", NewFileCacher())
|
|
}
|