6ff7b6a72a
As a response to #638, it seems that POST /publicRooms is already implemented. It is, however, unclear from the code that it is. Add some comments and change a method name to make this more clear.
113 lines
3.5 KiB
Go
113 lines
3.5 KiB
Go
// Copyright 2017 Vector Creations 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 directory
|
|
|
|
import (
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"github.com/matrix-org/dendrite/clientapi/httputil"
|
|
"github.com/matrix-org/dendrite/clientapi/jsonerror"
|
|
"github.com/matrix-org/dendrite/publicroomsapi/storage"
|
|
"github.com/matrix-org/dendrite/publicroomsapi/types"
|
|
"github.com/matrix-org/util"
|
|
)
|
|
|
|
type publicRoomReq struct {
|
|
Since string `json:"since,omitempty"`
|
|
Limit int16 `json:"limit,omitempty"`
|
|
Filter filter `json:"filter,omitempty"`
|
|
}
|
|
|
|
type filter struct {
|
|
SearchTerms string `json:"generic_search_term,omitempty"`
|
|
}
|
|
|
|
type publicRoomRes struct {
|
|
Chunk []types.PublicRoom `json:"chunk"`
|
|
NextBatch string `json:"next_batch,omitempty"`
|
|
PrevBatch string `json:"prev_batch,omitempty"`
|
|
Estimate int64 `json:"total_room_count_estimate,omitempty"`
|
|
}
|
|
|
|
// GetPostPublicRooms implements GET and POST /publicRooms
|
|
func GetPostPublicRooms(
|
|
req *http.Request, publicRoomDatabase *storage.PublicRoomsServerDatabase,
|
|
) util.JSONResponse {
|
|
var limit int16
|
|
var offset int64
|
|
var request publicRoomReq
|
|
var response publicRoomRes
|
|
|
|
if fillErr := fillPublicRoomsReq(req, &request); fillErr != nil {
|
|
return *fillErr
|
|
}
|
|
|
|
limit = request.Limit
|
|
offset, err := strconv.ParseInt(request.Since, 10, 64)
|
|
// ParseInt returns 0 and an error when trying to parse an empty string
|
|
// In that case, we want to assign 0 so we ignore the error
|
|
if err != nil && len(request.Since) > 0 {
|
|
return httputil.LogThenError(req, err)
|
|
}
|
|
|
|
if response.Estimate, err = publicRoomDatabase.CountPublicRooms(req.Context()); err != nil {
|
|
return httputil.LogThenError(req, err)
|
|
}
|
|
|
|
if offset > 0 {
|
|
response.PrevBatch = strconv.Itoa(int(offset) - 1)
|
|
}
|
|
nextIndex := int(offset) + int(limit)
|
|
if response.Estimate > int64(nextIndex) {
|
|
response.NextBatch = strconv.Itoa(nextIndex)
|
|
}
|
|
|
|
if response.Chunk, err = publicRoomDatabase.GetPublicRooms(
|
|
req.Context(), offset, limit, request.Filter.SearchTerms,
|
|
); err != nil {
|
|
return httputil.LogThenError(req, err)
|
|
}
|
|
|
|
return util.JSONResponse{
|
|
Code: http.StatusOK,
|
|
JSON: response,
|
|
}
|
|
}
|
|
|
|
// fillPublicRoomsReq fills the Limit, Since and Filter attributes of a GET or POST request
|
|
// on /publicRooms by parsing the incoming HTTP request
|
|
// Filter is only filled for POST requests
|
|
func fillPublicRoomsReq(httpReq *http.Request, request *publicRoomReq) *util.JSONResponse {
|
|
if httpReq.Method == http.MethodGet {
|
|
limit, err := strconv.Atoi(httpReq.FormValue("limit"))
|
|
// Atoi returns 0 and an error when trying to parse an empty string
|
|
// In that case, we want to assign 0 so we ignore the error
|
|
if err != nil && len(httpReq.FormValue("limit")) > 0 {
|
|
reqErr := httputil.LogThenError(httpReq, err)
|
|
return &reqErr
|
|
}
|
|
request.Limit = int16(limit)
|
|
request.Since = httpReq.FormValue("since")
|
|
return nil
|
|
} else if httpReq.Method == http.MethodPost {
|
|
return httputil.UnmarshalJSONRequest(httpReq, request)
|
|
}
|
|
|
|
return &util.JSONResponse{
|
|
Code: http.StatusMethodNotAllowed,
|
|
JSON: jsonerror.NotFound("Bad method"),
|
|
}
|
|
}
|