mediaproxy

Documentation

Index

• Variables
• type BasicConfig
• type GetMediaFunc
• type GetMediaResponse
• type GetMediaResponseCallback
  • func (d *GetMediaResponseCallback) GetContentLength() int64
  • func (d *GetMediaResponseCallback) GetContentType() string
  • func (d *GetMediaResponseCallback) WriteTo(w io.Writer) (int64, error)
• type GetMediaResponseData
  • func (d *GetMediaResponseData) GetContentLength() int64
  • func (d *GetMediaResponseData) GetContentType() string
  • func (d *GetMediaResponseData) WriteTo(w io.Writer) (int64, error)
• type GetMediaResponseFile
• type GetMediaResponseURL
• type GetMediaResponseWriter
• type MediaProxy
  • func New(serverName string, serverKey string, getMedia GetMediaFunc) (*MediaProxy, error)
  • func NewFromConfig(cfg BasicConfig, getMedia GetMediaFunc) (*MediaProxy, error)
  • func (mp *MediaProxy) DownloadMedia(w http.ResponseWriter, r *http.Request)
  • func (mp *MediaProxy) DownloadMediaFederation(w http.ResponseWriter, r *http.Request)
  • func (mp *MediaProxy) GetServerKey() *federation.SigningKey
  • func (mp *MediaProxy) GetServerName() string
  • func (mp *MediaProxy) Listen(cfg ServerConfig) error
  • func (mp *MediaProxy) PreviewURLNotSupported(w http.ResponseWriter, r *http.Request)
  • func (mp *MediaProxy) RegisterRoutes(router *mux.Router)
  • func (mp *MediaProxy) UnknownEndpoint(w http.ResponseWriter, r *http.Request)
  • func (mp *MediaProxy) UnsupportedMethod(w http.ResponseWriter, r *http.Request)
  • func (mp *MediaProxy) UploadNotSupported(w http.ResponseWriter, r *http.Request)
• type ResponseError
  • func (err *ResponseError) Error() string
• type ServerConfig

Variables

var (
	ErrUploadNotSupported = mautrix.MUnrecognized.
							WithMessage("This is a media proxy and does not support media uploads.").
							WithStatus(http.StatusNotImplemented)
	ErrPreviewURLNotSupported = mautrix.MUnrecognized.
								WithMessage("This is a media proxy and does not support URL previews.").
								WithStatus(http.StatusNotImplemented)
	ErrUnknownEndpoint = mautrix.MUnrecognized.
						WithMessage("Unrecognized endpoint")
	ErrUnsupportedMethod = mautrix.MUnrecognized.
							WithMessage("Invalid method for endpoint").
							WithStatus(http.StatusMethodNotAllowed)
)

var ErrInvalidMediaIDSyntax = errors.New("invalid media ID syntax")

Types

type BasicConfig

type BasicConfig struct {
	ServerName        string `yaml:"server_name" json:"server_name"`
	ServerKey         string `yaml:"server_key" json:"server_key"`
	WellKnownResponse string `yaml:"well_known_response" json:"well_known_response"`
}

type GetMediaFunc

type GetMediaFunc = func(ctx context.Context, mediaID string, params map[string]string) (response GetMediaResponse, err error)

type GetMediaResponse

type GetMediaResponse interface {
	// contains filtered or unexported methods
}

type GetMediaResponseCallback

type GetMediaResponseCallback struct {
	Callback      func(w io.Writer) (int64, error)
	ContentType   string
	ContentLength int64
}

func (*GetMediaResponseCallback) GetContentLength

func (d *GetMediaResponseCallback) GetContentLength() int64

func (*GetMediaResponseCallback) GetContentType

func (d *GetMediaResponseCallback) GetContentType() string

func (*GetMediaResponseCallback) WriteTo

func (d *GetMediaResponseCallback) WriteTo(w io.Writer) (int64, error)

type GetMediaResponseData

type GetMediaResponseData struct {
	Reader        io.ReadCloser
	ContentType   string
	ContentLength int64
}

func (*GetMediaResponseData) GetContentLength

func (d *GetMediaResponseData) GetContentLength() int64

func (*GetMediaResponseData) GetContentType

func (d *GetMediaResponseData) GetContentType() string

func (*GetMediaResponseData) WriteTo

func (d *GetMediaResponseData) WriteTo(w io.Writer) (int64, error)

type GetMediaResponseFile

type GetMediaResponseFile struct {
	Callback    func(w *os.File) error
	ContentType string
}

type GetMediaResponseURL

type GetMediaResponseURL struct {
	URL       string
	ExpiresAt time.Time
}

type GetMediaResponseWriter

type GetMediaResponseWriter interface {
	GetMediaResponse
	io.WriterTo
	GetContentType() string
	GetContentLength() int64
}

type MediaProxy

type MediaProxy struct {
	KeyServer *federation.KeyServer

	ForceProxyLegacyFederation bool

	GetMedia            GetMediaFunc
	PrepareProxyRequest func(*http.Request)

	FederationRouter  *mux.Router
	ClientMediaRouter *mux.Router
	// contains filtered or unexported fields
}

func New

func New(serverName string, serverKey string, getMedia GetMediaFunc) (*MediaProxy, error)

func NewFromConfig

func NewFromConfig(cfg BasicConfig, getMedia GetMediaFunc) (*MediaProxy, error)

func (*MediaProxy) DownloadMedia

func (mp *MediaProxy) DownloadMedia(w http.ResponseWriter, r *http.Request)

func (*MediaProxy) DownloadMediaFederation

func (mp *MediaProxy) DownloadMediaFederation(w http.ResponseWriter, r *http.Request)

func (*MediaProxy) GetServerKey

func (mp *MediaProxy) GetServerKey() *federation.SigningKey

func (*MediaProxy) GetServerName

func (mp *MediaProxy) GetServerName() string

func (*MediaProxy) Listen

func (mp *MediaProxy) Listen(cfg ServerConfig) error

func (*MediaProxy) PreviewURLNotSupported

func (mp *MediaProxy) PreviewURLNotSupported(w http.ResponseWriter, r *http.Request)

func (*MediaProxy) RegisterRoutes

func (mp *MediaProxy) RegisterRoutes(router *mux.Router)

func (*MediaProxy) UnknownEndpoint

func (mp *MediaProxy) UnknownEndpoint(w http.ResponseWriter, r *http.Request)

func (*MediaProxy) UnsupportedMethod

func (mp *MediaProxy) UnsupportedMethod(w http.ResponseWriter, r *http.Request)

func (*MediaProxy) UploadNotSupported

func (mp *MediaProxy) UploadNotSupported(w http.ResponseWriter, r *http.Request)

type ResponseError

type ResponseError struct {
	Status int
	Data   any
}

Deprecated: use mautrix.RespError instead

func (*ResponseError) Error

func (err *ResponseError) Error() string

type ServerConfig

type ServerConfig struct {
	Hostname string `yaml:"hostname" json:"hostname"`
	Port     uint16 `yaml:"port" json:"port"`
}