// GoToSocial // Copyright (C) GoToSocial Authors admin@gotosocial.org // SPDX-License-Identifier: AGPL-3.0-or-later // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package nodeinfo import ( "net/http" "github.com/gin-gonic/gin" apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util" "github.com/superseriousbusiness/gotosocial/internal/config" "github.com/superseriousbusiness/gotosocial/internal/gtserror" "github.com/superseriousbusiness/gotosocial/internal/middleware" "github.com/superseriousbusiness/gotosocial/internal/processing" ) const ( // NodeInfoWellKnownPath is the base path for serving responses // to nodeinfo lookup requests, minus the '.well-known' prefix. NodeInfoWellKnownPath = "/nodeinfo" ) type Module struct { processor *processing.Processor } // New returns a new nodeinfo module func New(processor *processing.Processor) *Module { return &Module{ processor: processor, } } func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) { // If instance is configured to serve instance stats // faithfully at nodeinfo, we should allow robots to // crawl nodeinfo endpoints in a limited capacity. // In all other cases, disallow everything. var robots gin.HandlerFunc if config.GetInstanceStatsMode() == config.InstanceStatsModeServe { robots = middleware.RobotsHeaders("allowSome") } else { robots = middleware.RobotsHeaders("") } // Attach handler, injecting robots http header middleware. attachHandler(http.MethodGet, NodeInfoWellKnownPath, robots, m.NodeInfoWellKnownGETHandler) } // NodeInfoWellKnownGETHandler swagger:operation GET /.well-known/nodeinfo nodeInfoWellKnownGet // // Returns a well-known response which redirects callers to `/nodeinfo/2.0`. // // eg. `{"links":[{"rel":"http://nodeinfo.diaspora.software/ns/schema/2.0","href":"http://example.org/nodeinfo/2.0"}]}` // See: https://nodeinfo.diaspora.software/protocol.html // // --- // tags: // - .well-known // // produces: // - application/json // // responses: // '200': // schema: // "$ref": "#/definitions/wellKnownResponse" func (m *Module) NodeInfoWellKnownGETHandler(c *gin.Context) { if _, err := apiutil.NegotiateAccept(c, apiutil.JSONAcceptHeaders...); err != nil { apiutil.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGetV1) return } resp, errWithCode := m.processor.Fedi().NodeInfoRelGet(c.Request.Context()) if errWithCode != nil { apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1) return } // Encode JSON HTTP response. apiutil.EncodeJSONResponse( c.Writer, c.Request, http.StatusOK, apiutil.AppJSON, resp, ) }