mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 16:40:24 +08:00 
			
		
		
		
	Use gitea forked macaron (#7933)
Signed-off-by: Tamal Saha <tamal@appscode.com>
This commit is contained in:
		
				
					committed by
					
						
						techknowlogick
					
				
			
			
				
	
			
			
			
						parent
						
							ca6fb004ac
						
					
				
				
					commit
					171b359877
				
			
							
								
								
									
										122
									
								
								vendor/gitea.com/macaron/cache/cache.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										122
									
								
								vendor/gitea.com/macaron/cache/cache.go
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,122 @@
 | 
			
		||||
// 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 is a middleware that provides the cache management of Macaron.
 | 
			
		||||
package cache
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"fmt"
 | 
			
		||||
 | 
			
		||||
	"gitea.com/macaron/macaron"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
const _VERSION = "0.3.0"
 | 
			
		||||
 | 
			
		||||
func Version() string {
 | 
			
		||||
	return _VERSION
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Cache is the interface that operates the cache data.
 | 
			
		||||
type Cache interface {
 | 
			
		||||
	// Put puts value into cache with key and expire time.
 | 
			
		||||
	Put(key string, val interface{}, timeout int64) error
 | 
			
		||||
	// Get gets cached value by given key.
 | 
			
		||||
	Get(key string) interface{}
 | 
			
		||||
	// Delete deletes cached value by given key.
 | 
			
		||||
	Delete(key string) error
 | 
			
		||||
	// Incr increases cached int-type value by given key as a counter.
 | 
			
		||||
	Incr(key string) error
 | 
			
		||||
	// Decr decreases cached int-type value by given key as a counter.
 | 
			
		||||
	Decr(key string) error
 | 
			
		||||
	// IsExist returns true if cached value exists.
 | 
			
		||||
	IsExist(key string) bool
 | 
			
		||||
	// Flush deletes all cached data.
 | 
			
		||||
	Flush() error
 | 
			
		||||
	// StartAndGC starts GC routine based on config string settings.
 | 
			
		||||
	StartAndGC(opt Options) error
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Options represents a struct for specifying configuration options for the cache middleware.
 | 
			
		||||
type Options struct {
 | 
			
		||||
	// Name of adapter. Default is "memory".
 | 
			
		||||
	Adapter string
 | 
			
		||||
	// Adapter configuration, it's corresponding to adapter.
 | 
			
		||||
	AdapterConfig string
 | 
			
		||||
	// GC interval time in seconds. Default is 60.
 | 
			
		||||
	Interval int
 | 
			
		||||
	// Occupy entire database. Default is false.
 | 
			
		||||
	OccupyMode bool
 | 
			
		||||
	// Configuration section name. Default is "cache".
 | 
			
		||||
	Section string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func prepareOptions(options []Options) Options {
 | 
			
		||||
	var opt Options
 | 
			
		||||
	if len(options) > 0 {
 | 
			
		||||
		opt = options[0]
 | 
			
		||||
	}
 | 
			
		||||
	if len(opt.Section) == 0 {
 | 
			
		||||
		opt.Section = "cache"
 | 
			
		||||
	}
 | 
			
		||||
	sec := macaron.Config().Section(opt.Section)
 | 
			
		||||
 | 
			
		||||
	if len(opt.Adapter) == 0 {
 | 
			
		||||
		opt.Adapter = sec.Key("ADAPTER").MustString("memory")
 | 
			
		||||
	}
 | 
			
		||||
	if opt.Interval == 0 {
 | 
			
		||||
		opt.Interval = sec.Key("INTERVAL").MustInt(60)
 | 
			
		||||
	}
 | 
			
		||||
	if len(opt.AdapterConfig) == 0 {
 | 
			
		||||
		opt.AdapterConfig = sec.Key("ADAPTER_CONFIG").MustString("data/caches")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return opt
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewCacher creates and returns a new cacher by given adapter name and configuration.
 | 
			
		||||
// It panics when given adapter isn't registered and starts GC automatically.
 | 
			
		||||
func NewCacher(name string, opt Options) (Cache, error) {
 | 
			
		||||
	adapter, ok := adapters[name]
 | 
			
		||||
	if !ok {
 | 
			
		||||
		return nil, fmt.Errorf("cache: unknown adapter '%s'(forgot to import?)", name)
 | 
			
		||||
	}
 | 
			
		||||
	return adapter, adapter.StartAndGC(opt)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Cacher is a middleware that maps a cache.Cache service into the Macaron handler chain.
 | 
			
		||||
// An single variadic cache.Options struct can be optionally provided to configure.
 | 
			
		||||
func Cacher(options ...Options) macaron.Handler {
 | 
			
		||||
	opt := prepareOptions(options)
 | 
			
		||||
	cache, err := NewCacher(opt.Adapter, opt)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		panic(err)
 | 
			
		||||
	}
 | 
			
		||||
	return func(ctx *macaron.Context) {
 | 
			
		||||
		ctx.Map(cache)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
var adapters = make(map[string]Cache)
 | 
			
		||||
 | 
			
		||||
// Register registers a adapter.
 | 
			
		||||
func Register(name string, adapter Cache) {
 | 
			
		||||
	if adapter == nil {
 | 
			
		||||
		panic("cache: cannot register adapter with nil value")
 | 
			
		||||
	}
 | 
			
		||||
	if _, dup := adapters[name]; dup {
 | 
			
		||||
		panic(fmt.Errorf("cache: cannot register adapter '%s' twice", name))
 | 
			
		||||
	}
 | 
			
		||||
	adapters[name] = adapter
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user