summaryrefslogtreecommitdiff
path: root/internal/processing/report
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2023-01-23 13:14:21 +0100
committerLibravatar GitHub <noreply@github.com>2023-01-23 13:14:21 +0100
commite9747247d58a0423d5e40fda5c5b37b4b4526495 (patch)
tree5574b05f1dec1ad88c49b9891f1e54719f1b9eb1 /internal/processing/report
parent[chore] bump go version to 1.19.5 (#1377) (diff)
downloadgotosocial-e9747247d58a0423d5e40fda5c5b37b4b4526495.tar.xz
[feature] Implement `/api/v1/reports` endpoints on client API (#1330)
* start adding report client api * route + test reports get * start report create endpoint * you can create reports now babyy * stub account report processor * add single reportGet endpoint * fix test * add more filtering params to /api/v1/reports GET * update swagger * use marshalIndent in tests * add + test missing Link info
Diffstat (limited to 'internal/processing/report')
-rw-r--r--internal/processing/report/create.go103
-rw-r--r--internal/processing/report/getreport.go51
-rw-r--r--internal/processing/report/getreports.go79
-rw-r--r--internal/processing/report/report.go51
4 files changed, 284 insertions, 0 deletions
diff --git a/internal/processing/report/create.go b/internal/processing/report/create.go
new file mode 100644
index 000000000..ac4c4390d
--- /dev/null
+++ b/internal/processing/report/create.go
@@ -0,0 +1,103 @@
+/*
+ GoToSocial
+ Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org
+
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package report
+
+import (
+ "context"
+ "errors"
+ "fmt"
+
+ "github.com/superseriousbusiness/gotosocial/internal/ap"
+ apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+ "github.com/superseriousbusiness/gotosocial/internal/db"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+ "github.com/superseriousbusiness/gotosocial/internal/id"
+ "github.com/superseriousbusiness/gotosocial/internal/messages"
+ "github.com/superseriousbusiness/gotosocial/internal/uris"
+)
+
+func (p *processor) Create(ctx context.Context, account *gtsmodel.Account, form *apimodel.ReportCreateRequest) (*apimodel.Report, gtserror.WithCode) {
+ if account.ID == form.AccountID {
+ err := errors.New("cannot report your own account")
+ return nil, gtserror.NewErrorBadRequest(err, err.Error())
+ }
+
+ // validate + fetch target account
+ targetAccount, err := p.db.GetAccountByID(ctx, form.AccountID)
+ if err != nil {
+ if errors.Is(err, db.ErrNoEntries) {
+ err = fmt.Errorf("account with ID %s does not exist", form.AccountID)
+ return nil, gtserror.NewErrorBadRequest(err, err.Error())
+ }
+ err = fmt.Errorf("db error fetching report target account: %w", err)
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ // fetch statuses by IDs given in the report form (noop if no statuses given)
+ statuses, err := p.db.GetStatuses(ctx, form.StatusIDs)
+ if err != nil {
+ err = fmt.Errorf("db error fetching report target statuses: %w", err)
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ for _, s := range statuses {
+ if s.AccountID != form.AccountID {
+ err = fmt.Errorf("status with ID %s does not belong to account %s", s.ID, form.AccountID)
+ return nil, gtserror.NewErrorBadRequest(err, err.Error())
+ }
+ }
+
+ reportID, err := id.NewULID()
+ if err != nil {
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ report := &gtsmodel.Report{
+ ID: reportID,
+ URI: uris.GenerateURIForReport(reportID),
+ AccountID: account.ID,
+ Account: account,
+ TargetAccountID: form.AccountID,
+ TargetAccount: targetAccount,
+ Comment: form.Comment,
+ StatusIDs: form.StatusIDs,
+ Statuses: statuses,
+ Forwarded: &form.Forward,
+ }
+
+ if err := p.db.PutReport(ctx, report); err != nil {
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ p.clientWorker.Queue(messages.FromClientAPI{
+ APObjectType: ap.ObjectProfile,
+ APActivityType: ap.ActivityFlag,
+ GTSModel: report,
+ OriginAccount: account,
+ })
+
+ apiReport, err := p.tc.ReportToAPIReport(ctx, report)
+ if err != nil {
+ err = fmt.Errorf("error converting report to frontend representation: %w", err)
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ return apiReport, nil
+}
diff --git a/internal/processing/report/getreport.go b/internal/processing/report/getreport.go
new file mode 100644
index 000000000..6d4a18daa
--- /dev/null
+++ b/internal/processing/report/getreport.go
@@ -0,0 +1,51 @@
+/*
+ GoToSocial
+ Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org
+
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package report
+
+import (
+ "context"
+ "fmt"
+
+ apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+ "github.com/superseriousbusiness/gotosocial/internal/db"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+)
+
+func (p *processor) ReportGet(ctx context.Context, account *gtsmodel.Account, id string) (*apimodel.Report, gtserror.WithCode) {
+ report, err := p.db.GetReportByID(ctx, id)
+ if err != nil {
+ if err == db.ErrNoEntries {
+ return nil, gtserror.NewErrorNotFound(err)
+ }
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ if report.AccountID != account.ID {
+ err = fmt.Errorf("report with id %s does not belong to account %s", report.ID, account.ID)
+ return nil, gtserror.NewErrorNotFound(err)
+ }
+
+ apiReport, err := p.tc.ReportToAPIReport(ctx, report)
+ if err != nil {
+ return nil, gtserror.NewErrorInternalError(fmt.Errorf("error converting report to api: %s", err))
+ }
+
+ return apiReport, nil
+}
diff --git a/internal/processing/report/getreports.go b/internal/processing/report/getreports.go
new file mode 100644
index 000000000..e58e847a2
--- /dev/null
+++ b/internal/processing/report/getreports.go
@@ -0,0 +1,79 @@
+/*
+ GoToSocial
+ Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org
+
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package report
+
+import (
+ "context"
+ "fmt"
+ "strconv"
+
+ apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+ "github.com/superseriousbusiness/gotosocial/internal/db"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+ "github.com/superseriousbusiness/gotosocial/internal/util"
+)
+
+func (p *processor) ReportsGet(ctx context.Context, account *gtsmodel.Account, resolved *bool, targetAccountID string, maxID string, sinceID string, minID string, limit int) (*apimodel.PageableResponse, gtserror.WithCode) {
+ reports, err := p.db.GetReports(ctx, resolved, account.ID, targetAccountID, maxID, sinceID, minID, limit)
+ if err != nil {
+ if err == db.ErrNoEntries {
+ return util.EmptyPageableResponse(), nil
+ }
+ return nil, gtserror.NewErrorInternalError(err)
+ }
+
+ count := len(reports)
+ items := make([]interface{}, 0, count)
+ nextMaxIDValue := ""
+ prevMinIDValue := ""
+ for i, r := range reports {
+ item, err := p.tc.ReportToAPIReport(ctx, r)
+ if err != nil {
+ return nil, gtserror.NewErrorInternalError(fmt.Errorf("error converting report to api: %s", err))
+ }
+
+ if i == count-1 {
+ nextMaxIDValue = item.ID
+ }
+
+ if i == 0 {
+ prevMinIDValue = item.ID
+ }
+
+ items = append(items, item)
+ }
+
+ extraQueryParams := []string{}
+ if resolved != nil {
+ extraQueryParams = append(extraQueryParams, "resolved="+strconv.FormatBool(*resolved))
+ }
+ if targetAccountID != "" {
+ extraQueryParams = append(extraQueryParams, "target_account_id="+targetAccountID)
+ }
+
+ return util.PackagePageableResponse(util.PageableResponseParams{
+ Items: items,
+ Path: "/api/v1/reports",
+ NextMaxIDValue: nextMaxIDValue,
+ PrevMinIDValue: prevMinIDValue,
+ Limit: limit,
+ ExtraQueryParams: extraQueryParams,
+ })
+}
diff --git a/internal/processing/report/report.go b/internal/processing/report/report.go
new file mode 100644
index 000000000..8658ac808
--- /dev/null
+++ b/internal/processing/report/report.go
@@ -0,0 +1,51 @@
+/*
+ GoToSocial
+ Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org
+
+ 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 <http://www.gnu.org/licenses/>.
+*/
+
+package report
+
+import (
+ "context"
+
+ apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+ "github.com/superseriousbusiness/gotosocial/internal/concurrency"
+ "github.com/superseriousbusiness/gotosocial/internal/db"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+ "github.com/superseriousbusiness/gotosocial/internal/messages"
+ "github.com/superseriousbusiness/gotosocial/internal/typeutils"
+)
+
+type Processor interface {
+ ReportsGet(ctx context.Context, account *gtsmodel.Account, resolved *bool, targetAccountID string, maxID string, sinceID string, minID string, limit int) (*apimodel.PageableResponse, gtserror.WithCode)
+ ReportGet(ctx context.Context, account *gtsmodel.Account, id string) (*apimodel.Report, gtserror.WithCode)
+ Create(ctx context.Context, account *gtsmodel.Account, form *apimodel.ReportCreateRequest) (*apimodel.Report, gtserror.WithCode)
+}
+
+type processor struct {
+ db db.DB
+ tc typeutils.TypeConverter
+ clientWorker *concurrency.WorkerPool[messages.FromClientAPI]
+}
+
+func New(db db.DB, tc typeutils.TypeConverter, clientWorker *concurrency.WorkerPool[messages.FromClientAPI]) Processor {
+ return &processor{
+ tc: tc,
+ db: db,
+ clientWorker: clientWorker,
+ }
+}