aboutsummaryrefslogtreecommitdiff
path: root/appservice/query
diff options
context:
space:
mode:
authorruben <code@rbn.im>2019-05-21 22:56:55 +0200
committerBrendan Abolivier <babolivier@matrix.org>2019-05-21 21:56:55 +0100
commit74827428bd3e11faab65f12204449c1b9469b0ae (patch)
tree0decafa542436a0667ed2d3e3cfd4df0f03de1e5 /appservice/query
parent4d588f7008afe5600219ac0930c2eee2de5c447b (diff)
use go module for dependencies (#594)
Diffstat (limited to 'appservice/query')
-rw-r--r--appservice/query/query.go214
1 files changed, 214 insertions, 0 deletions
diff --git a/appservice/query/query.go b/appservice/query/query.go
new file mode 100644
index 00000000..fde3ab09
--- /dev/null
+++ b/appservice/query/query.go
@@ -0,0 +1,214 @@
+// Copyright 2018 New Vector Ltd
+//
+// 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 query handles requests from other internal dendrite components when
+// they interact with the AppServiceQueryAPI.
+package query
+
+import (
+ "context"
+ "encoding/json"
+ "net/http"
+ "net/url"
+ "time"
+
+ "github.com/matrix-org/dendrite/appservice/api"
+ "github.com/matrix-org/dendrite/common"
+ "github.com/matrix-org/dendrite/common/config"
+ "github.com/matrix-org/util"
+ opentracing "github.com/opentracing/opentracing-go"
+ log "github.com/sirupsen/logrus"
+)
+
+const roomAliasExistsPath = "/rooms/"
+const userIDExistsPath = "/users/"
+
+// AppServiceQueryAPI is an implementation of api.AppServiceQueryAPI
+type AppServiceQueryAPI struct {
+ HTTPClient *http.Client
+ Cfg *config.Dendrite
+}
+
+// RoomAliasExists performs a request to '/room/{roomAlias}' on all known
+// handling application services until one admits to owning the room
+func (a *AppServiceQueryAPI) RoomAliasExists(
+ ctx context.Context,
+ request *api.RoomAliasExistsRequest,
+ response *api.RoomAliasExistsResponse,
+) error {
+ span, ctx := opentracing.StartSpanFromContext(ctx, "ApplicationServiceRoomAlias")
+ defer span.Finish()
+
+ // Create an HTTP client if one does not already exist
+ if a.HTTPClient == nil {
+ a.HTTPClient = makeHTTPClient()
+ }
+
+ // Determine which application service should handle this request
+ for _, appservice := range a.Cfg.Derived.ApplicationServices {
+ if appservice.URL != "" && appservice.IsInterestedInRoomAlias(request.Alias) {
+ // The full path to the rooms API, includes hs token
+ URL, err := url.Parse(appservice.URL + roomAliasExistsPath)
+ URL.Path += request.Alias
+ apiURL := URL.String() + "?access_token=" + appservice.HSToken
+
+ // Send a request to each application service. If one responds that it has
+ // created the room, immediately return.
+ req, err := http.NewRequest(http.MethodGet, apiURL, nil)
+ if err != nil {
+ return err
+ }
+ req = req.WithContext(ctx)
+
+ resp, err := a.HTTPClient.Do(req)
+ if resp != nil {
+ defer func() {
+ err = resp.Body.Close()
+ if err != nil {
+ log.WithFields(log.Fields{
+ "appservice_id": appservice.ID,
+ "status_code": resp.StatusCode,
+ }).WithError(err).Error("Unable to close application service response body")
+ }
+ }()
+ }
+ if err != nil {
+ log.WithError(err).Errorf("Issue querying room alias on application service %s", appservice.ID)
+ return err
+ }
+ switch resp.StatusCode {
+ case http.StatusOK:
+ // OK received from appservice. Room exists
+ response.AliasExists = true
+ return nil
+ case http.StatusNotFound:
+ // Room does not exist
+ default:
+ // Application service reported an error. Warn
+ log.WithFields(log.Fields{
+ "appservice_id": appservice.ID,
+ "status_code": resp.StatusCode,
+ }).Warn("Application service responded with non-OK status code")
+ }
+ }
+ }
+
+ response.AliasExists = false
+ return nil
+}
+
+// UserIDExists performs a request to '/users/{userID}' on all known
+// handling application services until one admits to owning the user ID
+func (a *AppServiceQueryAPI) UserIDExists(
+ ctx context.Context,
+ request *api.UserIDExistsRequest,
+ response *api.UserIDExistsResponse,
+) error {
+ span, ctx := opentracing.StartSpanFromContext(ctx, "ApplicationServiceUserID")
+ defer span.Finish()
+
+ // Create an HTTP client if one does not already exist
+ if a.HTTPClient == nil {
+ a.HTTPClient = makeHTTPClient()
+ }
+
+ // Determine which application service should handle this request
+ for _, appservice := range a.Cfg.Derived.ApplicationServices {
+ if appservice.URL != "" && appservice.IsInterestedInUserID(request.UserID) {
+ // The full path to the rooms API, includes hs token
+ URL, err := url.Parse(appservice.URL + userIDExistsPath)
+ URL.Path += request.UserID
+ apiURL := URL.String() + "?access_token=" + appservice.HSToken
+
+ // Send a request to each application service. If one responds that it has
+ // created the user, immediately return.
+ req, err := http.NewRequest(http.MethodGet, apiURL, nil)
+ if err != nil {
+ return err
+ }
+ resp, err := a.HTTPClient.Do(req.WithContext(ctx))
+ if resp != nil {
+ defer func() {
+ err = resp.Body.Close()
+ if err != nil {
+ log.WithFields(log.Fields{
+ "appservice_id": appservice.ID,
+ "status_code": resp.StatusCode,
+ }).Error("Unable to close application service response body")
+ }
+ }()
+ }
+ if err != nil {
+ log.WithFields(log.Fields{
+ "appservice_id": appservice.ID,
+ }).WithError(err).Error("issue querying user ID on application service")
+ return err
+ }
+ if resp.StatusCode == http.StatusOK {
+ // StatusOK received from appservice. User ID exists
+ response.UserIDExists = true
+ return nil
+ }
+
+ // Log non OK
+ log.WithFields(log.Fields{
+ "appservice_id": appservice.ID,
+ "status_code": resp.StatusCode,
+ }).Warn("application service responded with non-OK status code")
+ }
+ }
+
+ response.UserIDExists = false
+ return nil
+}
+
+// makeHTTPClient creates an HTTP client with certain options that will be used for all query requests to application services
+func makeHTTPClient() *http.Client {
+ return &http.Client{
+ Timeout: time.Second * 30,
+ }
+}
+
+// SetupHTTP adds the AppServiceQueryPAI handlers to the http.ServeMux. This
+// handles and muxes incoming api requests the to internal AppServiceQueryAPI.
+func (a *AppServiceQueryAPI) SetupHTTP(servMux *http.ServeMux) {
+ servMux.Handle(
+ api.AppServiceRoomAliasExistsPath,
+ common.MakeInternalAPI("appserviceRoomAliasExists", func(req *http.Request) util.JSONResponse {
+ var request api.RoomAliasExistsRequest
+ var response api.RoomAliasExistsResponse
+ if err := json.NewDecoder(req.Body).Decode(&request); err != nil {
+ return util.ErrorResponse(err)
+ }
+ if err := a.RoomAliasExists(req.Context(), &request, &response); err != nil {
+ return util.ErrorResponse(err)
+ }
+ return util.JSONResponse{Code: http.StatusOK, JSON: &response}
+ }),
+ )
+ servMux.Handle(
+ api.AppServiceUserIDExistsPath,
+ common.MakeInternalAPI("appserviceUserIDExists", func(req *http.Request) util.JSONResponse {
+ var request api.UserIDExistsRequest
+ var response api.UserIDExistsResponse
+ if err := json.NewDecoder(req.Body).Decode(&request); err != nil {
+ return util.ErrorResponse(err)
+ }
+ if err := a.UserIDExists(req.Context(), &request, &response); err != nil {
+ return util.ErrorResponse(err)
+ }
+ return util.JSONResponse{Code: http.StatusOK, JSON: &response}
+ }),
+ )
+}
generated by cgit v1.2.3 (git 2.26.2) at 2025-03-18 08:59:32 +0000