2025-03-10 08:44:03 +01:00
|
|
|
package frankenphp
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
2025-11-10 14:12:14 +01:00
|
|
|
"errors"
|
|
|
|
|
"fmt"
|
2025-04-26 17:04:46 +08:00
|
|
|
"log/slog"
|
2025-03-10 08:44:03 +01:00
|
|
|
"net/http"
|
|
|
|
|
"os"
|
2025-08-25 16:18:20 +02:00
|
|
|
"strconv"
|
2025-03-10 08:44:03 +01:00
|
|
|
"strings"
|
|
|
|
|
"time"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// frankenPHPContext provides contextual information about the Request to handle.
|
|
|
|
|
type frankenPHPContext struct {
|
2025-11-18 09:59:53 +01:00
|
|
|
mercureContext
|
|
|
|
|
|
2025-03-10 08:44:03 +01:00
|
|
|
documentRoot string
|
|
|
|
|
splitPath []string
|
|
|
|
|
env PreparedEnv
|
2025-04-26 17:04:46 +08:00
|
|
|
logger *slog.Logger
|
2025-03-10 08:44:03 +01:00
|
|
|
request *http.Request
|
|
|
|
|
originalRequest *http.Request
|
2025-07-01 10:27:11 +02:00
|
|
|
worker *worker
|
2025-03-10 08:44:03 +01:00
|
|
|
|
|
|
|
|
docURI string
|
|
|
|
|
pathInfo string
|
|
|
|
|
scriptName string
|
|
|
|
|
scriptFilename string
|
2026-02-11 15:21:55 +01:00
|
|
|
requestURI string
|
2025-03-10 08:44:03 +01:00
|
|
|
|
|
|
|
|
// Whether the request is already closed by us
|
|
|
|
|
isDone bool
|
|
|
|
|
|
2026-02-11 15:21:55 +01:00
|
|
|
responseWriter http.ResponseWriter
|
|
|
|
|
responseController *http.ResponseController
|
|
|
|
|
handlerParameters any
|
|
|
|
|
handlerReturn any
|
2025-03-10 08:44:03 +01:00
|
|
|
|
2025-08-14 16:01:06 +02:00
|
|
|
done chan any
|
2025-03-10 08:44:03 +01:00
|
|
|
startedAt time.Time
|
|
|
|
|
}
|
|
|
|
|
|
2025-11-17 16:32:23 +01:00
|
|
|
type contextHolder struct {
|
|
|
|
|
ctx context.Context
|
|
|
|
|
frankenPHPContext *frankenPHPContext
|
|
|
|
|
}
|
|
|
|
|
|
2025-03-10 08:44:03 +01:00
|
|
|
// fromContext extracts the frankenPHPContext from a context.
|
|
|
|
|
func fromContext(ctx context.Context) (fctx *frankenPHPContext, ok bool) {
|
|
|
|
|
fctx, ok = ctx.Value(contextKey).(*frankenPHPContext)
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
2025-10-09 14:10:09 +02:00
|
|
|
func newFrankenPHPContext() *frankenPHPContext {
|
|
|
|
|
return &frankenPHPContext{
|
2025-08-14 16:01:06 +02:00
|
|
|
done: make(chan any),
|
2025-03-10 08:44:03 +01:00
|
|
|
startedAt: time.Now(),
|
|
|
|
|
}
|
2025-10-09 14:10:09 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// NewRequestWithContext creates a new FrankenPHP request context.
|
|
|
|
|
func NewRequestWithContext(r *http.Request, opts ...RequestOption) (*http.Request, error) {
|
|
|
|
|
fc := newFrankenPHPContext()
|
|
|
|
|
fc.request = r
|
|
|
|
|
|
2025-03-10 08:44:03 +01:00
|
|
|
for _, o := range opts {
|
|
|
|
|
if err := o(fc); err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if fc.logger == nil {
|
2025-11-17 16:32:23 +01:00
|
|
|
fc.logger = globalLogger
|
2025-03-10 08:44:03 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if fc.documentRoot == "" {
|
|
|
|
|
if EmbeddedAppPath != "" {
|
|
|
|
|
fc.documentRoot = EmbeddedAppPath
|
|
|
|
|
} else {
|
|
|
|
|
var err error
|
|
|
|
|
if fc.documentRoot, err = os.Getwd(); err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2025-08-25 16:18:20 +02:00
|
|
|
// If a worker is already assigned explicitly, use its filename and skip parsing path variables
|
2025-07-01 10:27:11 +02:00
|
|
|
if fc.worker != nil {
|
|
|
|
|
fc.scriptFilename = fc.worker.fileName
|
|
|
|
|
} else {
|
2025-08-25 16:18:20 +02:00
|
|
|
// If no worker was assigned, split the path into the "traditional" CGI path variables.
|
|
|
|
|
// This needs to already happen here in case a worker script still matches the path.
|
|
|
|
|
splitCgiPath(fc)
|
2025-07-01 10:27:11 +02:00
|
|
|
}
|
|
|
|
|
|
2026-02-11 15:21:55 +01:00
|
|
|
fc.requestURI = r.URL.RequestURI()
|
|
|
|
|
|
2025-03-10 08:44:03 +01:00
|
|
|
c := context.WithValue(r.Context(), contextKey, fc)
|
|
|
|
|
|
|
|
|
|
return r.WithContext(c), nil
|
|
|
|
|
}
|
|
|
|
|
|
2025-08-25 16:18:20 +02:00
|
|
|
// newDummyContext creates a fake context from a request path
|
2025-03-10 08:44:03 +01:00
|
|
|
func newDummyContext(requestPath string, opts ...RequestOption) (*frankenPHPContext, error) {
|
2025-11-23 23:14:23 +01:00
|
|
|
r, err := http.NewRequestWithContext(globalCtx, http.MethodGet, requestPath, nil)
|
2025-03-10 08:44:03 +01:00
|
|
|
if err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fr, err := NewRequestWithContext(r, opts...)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fc, _ := fromContext(fr.Context())
|
|
|
|
|
|
|
|
|
|
return fc, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// closeContext sends the response to the client
|
|
|
|
|
func (fc *frankenPHPContext) closeContext() {
|
|
|
|
|
if fc.isDone {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
close(fc.done)
|
|
|
|
|
fc.isDone = true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// validate checks if the request should be outright rejected
|
2025-11-10 14:12:14 +01:00
|
|
|
func (fc *frankenPHPContext) validate() error {
|
2025-08-25 16:18:20 +02:00
|
|
|
if strings.Contains(fc.request.URL.Path, "\x00") {
|
2025-11-10 14:12:14 +01:00
|
|
|
fc.reject(ErrInvalidRequestPath)
|
2025-08-25 16:18:20 +02:00
|
|
|
|
2025-11-10 14:12:14 +01:00
|
|
|
return ErrInvalidRequestPath
|
2025-03-10 08:44:03 +01:00
|
|
|
}
|
|
|
|
|
|
2025-08-25 16:18:20 +02:00
|
|
|
contentLengthStr := fc.request.Header.Get("Content-Length")
|
|
|
|
|
if contentLengthStr != "" {
|
|
|
|
|
if contentLength, err := strconv.Atoi(contentLengthStr); err != nil || contentLength < 0 {
|
2025-11-10 14:12:14 +01:00
|
|
|
e := fmt.Errorf("%w: %q", ErrInvalidContentLengthHeader, contentLengthStr)
|
|
|
|
|
|
|
|
|
|
fc.reject(e)
|
2025-08-25 16:18:20 +02:00
|
|
|
|
2025-11-10 14:12:14 +01:00
|
|
|
return e
|
2025-08-25 16:18:20 +02:00
|
|
|
}
|
|
|
|
|
}
|
2025-03-10 08:44:03 +01:00
|
|
|
|
2025-11-10 14:12:14 +01:00
|
|
|
return nil
|
2025-03-10 08:44:03 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (fc *frankenPHPContext) clientHasClosed() bool {
|
2025-10-09 14:10:09 +02:00
|
|
|
if fc.request == nil {
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
|
2025-03-10 08:44:03 +01:00
|
|
|
select {
|
|
|
|
|
case <-fc.request.Context().Done():
|
|
|
|
|
return true
|
|
|
|
|
default:
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2025-11-10 14:12:14 +01:00
|
|
|
// reject sends a response with the given status code and error
|
|
|
|
|
func (fc *frankenPHPContext) reject(err error) {
|
2025-03-10 08:44:03 +01:00
|
|
|
if fc.isDone {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
2025-11-10 14:12:14 +01:00
|
|
|
re := &ErrRejected{}
|
|
|
|
|
if !errors.As(err, re) {
|
|
|
|
|
// Should never happen
|
|
|
|
|
panic("only instance of ErrRejected can be passed to reject")
|
|
|
|
|
}
|
|
|
|
|
|
2025-03-10 08:44:03 +01:00
|
|
|
rw := fc.responseWriter
|
|
|
|
|
if rw != nil {
|
2025-11-10 14:12:14 +01:00
|
|
|
rw.WriteHeader(re.status)
|
|
|
|
|
_, _ = rw.Write([]byte(err.Error()))
|
2025-05-10 14:31:58 +02:00
|
|
|
|
2025-05-10 02:01:49 +10:00
|
|
|
if f, ok := rw.(http.Flusher); ok {
|
2025-05-10 14:31:58 +02:00
|
|
|
f.Flush()
|
2025-05-10 02:01:49 +10:00
|
|
|
}
|
2025-03-10 08:44:03 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fc.closeContext()
|
|
|
|
|
}
|
