mirror of
				https://github.com/caddyserver/caddy.git
				synced 2025-10-31 10:37:24 -04:00 
			
		
		
		
	* templates: Offically make templates extensible This supercedes #4757 (and #4568) by making template extensions configurable. The previous implementation was never documented AFAIK and had only 1 consumer, which I'll notify as a courtesy. * templates: Add 'maybe' function for optional components * Try to fix lint error
		
			
				
	
	
		
			83 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			83 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2015 Matthew Holt and The Caddy 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 templates
 | |
| 
 | |
| import (
 | |
| 	"github.com/caddyserver/caddy/v2"
 | |
| 	"github.com/caddyserver/caddy/v2/caddyconfig"
 | |
| 	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
 | |
| 	"github.com/caddyserver/caddy/v2/caddyconfig/httpcaddyfile"
 | |
| 	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
 | |
| )
 | |
| 
 | |
| func init() {
 | |
| 	httpcaddyfile.RegisterHandlerDirective("templates", parseCaddyfile)
 | |
| }
 | |
| 
 | |
| // parseCaddyfile sets up the handler from Caddyfile tokens. Syntax:
 | |
| //
 | |
| //	templates [<matcher>] {
 | |
| //	    mime <types...>
 | |
| //	    between <open_delim> <close_delim>
 | |
| //	    root <path>
 | |
| //	}
 | |
| func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
 | |
| 	t := new(Templates)
 | |
| 	for h.Next() {
 | |
| 		for h.NextBlock(0) {
 | |
| 			switch h.Val() {
 | |
| 			case "mime":
 | |
| 				t.MIMETypes = h.RemainingArgs()
 | |
| 				if len(t.MIMETypes) == 0 {
 | |
| 					return nil, h.ArgErr()
 | |
| 				}
 | |
| 			case "between":
 | |
| 				t.Delimiters = h.RemainingArgs()
 | |
| 				if len(t.Delimiters) != 2 {
 | |
| 					return nil, h.ArgErr()
 | |
| 				}
 | |
| 			case "root":
 | |
| 				if !h.Args(&t.FileRoot) {
 | |
| 					return nil, h.ArgErr()
 | |
| 				}
 | |
| 			case "extensions":
 | |
| 				if h.NextArg() {
 | |
| 					return nil, h.ArgErr()
 | |
| 				}
 | |
| 				if t.ExtensionsRaw != nil {
 | |
| 					return nil, h.Err("extensions already specified")
 | |
| 				}
 | |
| 				for nesting := h.Nesting(); h.NextBlock(nesting); {
 | |
| 					extensionModuleName := h.Val()
 | |
| 					modID := "http.handlers.templates.functions." + extensionModuleName
 | |
| 					unm, err := caddyfile.UnmarshalModule(h.Dispenser, modID)
 | |
| 					if err != nil {
 | |
| 						return nil, err
 | |
| 					}
 | |
| 					cf, ok := unm.(CustomFunctions)
 | |
| 					if !ok {
 | |
| 						return nil, h.Errf("module %s (%T) does not provide template functions", modID, unm)
 | |
| 					}
 | |
| 					if t.ExtensionsRaw == nil {
 | |
| 						t.ExtensionsRaw = make(caddy.ModuleMap)
 | |
| 					}
 | |
| 					t.ExtensionsRaw[extensionModuleName] = caddyconfig.JSON(cf, nil)
 | |
| 				}
 | |
| 			}
 | |
| 		}
 | |
| 	}
 | |
| 	return t, nil
 | |
| }
 |