Browse Source

Merge remote-tracking branch 'upstream/develop' into develop

develop
Dashie der otter 1 year ago
parent
commit
0dfef05dec
100 changed files with 1337 additions and 1066 deletions
  1. +4
    -25
      .gitlab-ci.yml
  2. +6
    -0
      CHANGELOG.md
  3. +2
    -1
      config/config.exs
  4. +0
    -0
      docs/API/admin_api.md
  5. +0
    -0
      docs/API/differences_in_mastoapi_responses.md
  6. +6
    -5
      docs/API/pleroma_api.md
  7. +0
    -0
      docs/API/prometheus.md
  8. +19
    -0
      docs/administration/CLI_tasks/config.md
  9. +48
    -0
      docs/administration/CLI_tasks/database.md
  10. +13
    -0
      docs/administration/CLI_tasks/digest.md
  11. +30
    -0
      docs/administration/CLI_tasks/emoji.md
  12. +30
    -0
      docs/administration/CLI_tasks/instance.md
  13. +30
    -0
      docs/administration/CLI_tasks/relay.md
  14. +12
    -0
      docs/administration/CLI_tasks/uploads.md
  15. +94
    -0
      docs/administration/CLI_tasks/user.md
  16. +0
    -0
      docs/administration/backup.md
  17. +0
    -0
      docs/administration/updating.md
  18. +0
    -17
      docs/config/General-tips-for-customizing-Pleroma-FE.md
  19. +0
    -12
      docs/config/small_customizations.md
  20. +38
    -35
      docs/configuration/cheatsheet.md
  21. +1
    -0
      docs/configuration/custom_emoji.md
  22. +0
    -0
      docs/configuration/hardening.md
  23. +0
    -0
      docs/configuration/howto_mediaproxy.md
  24. +0
    -0
      docs/configuration/howto_mongooseim.md
  25. +0
    -0
      docs/configuration/howto_proxy.md
  26. +0
    -0
      docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md
  27. +0
    -0
      docs/configuration/howto_user_recomendation.md
  28. +0
    -0
      docs/configuration/i2p.md
  29. +0
    -0
      docs/configuration/mrf.md
  30. +0
    -0
      docs/configuration/onion_federation.md
  31. +0
    -0
      docs/configuration/static_dir.md
  32. +4
    -6
      docs/installation/alpine_linux_en.md
  33. +4
    -6
      docs/installation/arch_linux_en.md
  34. +4
    -6
      docs/installation/centos7_en.md
  35. +4
    -6
      docs/installation/debian_based_en.md
  36. +4
    -6
      docs/installation/debian_based_jp.md
  37. +4
    -6
      docs/installation/gentoo_en.md
  38. +5
    -5
      docs/installation/migrating_from_source_otp_en.md
  39. +6
    -6
      docs/installation/otp_en.md
  40. +1
    -12
      lib/mix/tasks/pleroma/config.ex
  41. +1
    -27
      lib/mix/tasks/pleroma/database.ex
  42. +1
    -9
      lib/mix/tasks/pleroma/digest.ex
  43. +1
    -48
      lib/mix/tasks/pleroma/emoji.ex
  44. +1
    -30
      lib/mix/tasks/pleroma/instance.ex
  45. +1
    -18
      lib/mix/tasks/pleroma/relay.ex
  46. +1
    -9
      lib/mix/tasks/pleroma/uploads.ex
  47. +1
    -79
      lib/mix/tasks/pleroma/user.ex
  48. +3
    -1
      lib/pleroma/application.ex
  49. +8
    -0
      lib/pleroma/healthcheck.ex
  50. +78
    -0
      lib/pleroma/job_queue_monitor.ex
  51. +26
    -1
      lib/pleroma/reverse_proxy/reverse_proxy.ex
  52. +1
    -1
      lib/pleroma/user.ex
  53. +1
    -1
      lib/pleroma/web/activity_pub/activity_pub.ex
  54. +0
    -32
      lib/pleroma/web/activity_pub/activity_pub_controller.ex
  55. +39
    -0
      lib/pleroma/web/activity_pub/transmogrifier.ex
  56. +9
    -15
      lib/pleroma/web/activity_pub/utils.ex
  57. +0
    -36
      lib/pleroma/web/activity_pub/views/object_view.ex
  58. +1
    -1
      lib/pleroma/web/activity_pub/views/user_view.ex
  59. +5
    -0
      lib/pleroma/web/activity_pub/visibility.ex
  60. +12
    -3
      lib/pleroma/web/common_api/common_api.ex
  61. +12
    -0
      lib/pleroma/web/controller_helper.ex
  62. +36
    -0
      lib/pleroma/web/masto_fe_controller.ex
  63. +39
    -0
      lib/pleroma/web/mastodon_api/controllers/app_controller.ex
  64. +91
    -0
      lib/pleroma/web/mastodon_api/controllers/auth_controller.ex
  65. +11
    -0
      lib/pleroma/web/mastodon_api/controllers/custom_emoji_controller.ex
  66. +17
    -0
      lib/pleroma/web/mastodon_api/controllers/instance_controller.ex
  67. +0
    -452
      lib/pleroma/web/mastodon_api/controllers/mastodon_api_controller.ex
  68. +42
    -0
      lib/pleroma/web/mastodon_api/controllers/media_controller.ex
  69. +53
    -0
      lib/pleroma/web/mastodon_api/controllers/poll_controller.ex
  70. +16
    -4
      lib/pleroma/web/mastodon_api/controllers/status_controller.ex
  71. +63
    -0
      lib/pleroma/web/mastodon_api/controllers/suggestion_controller.ex
  72. +28
    -0
      lib/pleroma/web/mastodon_api/views/custom_emoji_view.ex
  73. +35
    -0
      lib/pleroma/web/mastodon_api/views/instance_view.ex
  74. +0
    -8
      lib/pleroma/web/mastodon_api/views/mastodon_view.ex
  75. +32
    -28
      lib/pleroma/web/mastodon_api/views/notification_view.ex
  76. +74
    -0
      lib/pleroma/web/mastodon_api/views/poll_view.ex
  77. +3
    -71
      lib/pleroma/web/mastodon_api/views/status_view.ex
  78. +22
    -4
      lib/pleroma/web/oauth/oauth_controller.ex
  79. +35
    -0
      lib/pleroma/web/pleroma_api/controllers/mascot_controller.ex
  80. +24
    -24
      lib/pleroma/web/router.ex
  81. +4
    -0
      lib/pleroma/web/streamer/ping.ex
  82. +4
    -0
      lib/pleroma/web/streamer/state.ex
  83. +4
    -0
      lib/pleroma/web/streamer/streamer_socket.ex
  84. +4
    -0
      lib/pleroma/web/streamer/supervisor.ex
  85. +8
    -4
      lib/pleroma/web/streamer/worker.ex
  86. +1
    -1
      lib/pleroma/web/templates/masto_fe/index.html.eex
  87. +16
    -4
      lib/pleroma/web/translation_helpers.ex
  88. +102
    -0
      lib/pleroma/web/views/masto_fe_view.ex
  89. +0
    -0
      priv/static/adminfe/app.8589ec81.css
  90. +0
    -0
      priv/static/adminfe/chunk-0cb6.8d811a09.css
  91. +0
    -0
      priv/static/adminfe/chunk-15fa.6e185c68.css
  92. +0
    -0
      priv/static/adminfe/chunk-18e1.5bd2ca85.css
  93. +1
    -1
      priv/static/adminfe/chunk-23b2.723b6cc5.css
  94. +0
    -0
      priv/static/adminfe/chunk-2943.1b6fd9a7.css
  95. +0
    -0
      priv/static/adminfe/chunk-3d1c.b2eb7234.css
  96. +0
    -0
      priv/static/adminfe/chunk-4df4.e217dea0.css
  97. +0
    -0
      priv/static/adminfe/chunk-538a.062aa087.css
  98. +0
    -0
      priv/static/adminfe/chunk-7c6b.c7882778.css
  99. +1
    -0
      priv/static/adminfe/chunk-7f8e.b6944d38.css
  100. +0
    -0
      priv/static/adminfe/chunk-elementUI.a842fb0a.css

+ 4
- 25
.gitlab-ci.yml View File

@@ -28,23 +28,6 @@ build:
- mix deps.get
- mix compile --force

docs-build:
stage: build
only:
- master@pleroma/pleroma
- develop@pleroma/pleroma
variables:
MIX_ENV: dev
PLEROMA_BUILD_ENV: prod
script:
- mix deps.get
- mix compile
- mix docs
artifacts:
paths:
- priv/static/doc


unit-testing:
stage: test
services:
@@ -85,19 +68,14 @@ analysis:

docs-deploy:
stage: deploy
image: alpine:3.9
image: alpine:latest
only:
- master@pleroma/pleroma
- develop@pleroma/pleroma
before_script:
- apk update && apk add openssh-client rsync
- apk add curl
script:
- mkdir -p ~/.ssh
- echo "${SSH_HOST_KEY}" > ~/.ssh/known_hosts
- eval $(ssh-agent -s)
- echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add -
- rsync -hrvz --delete -e "ssh -p ${SSH_PORT}" priv/static/doc/ "${SSH_USER_HOST_LOCATION}/${CI_COMMIT_REF_NAME}"

- curl -X POST -F"token=$DOCS_PIPELINE_TRIGGER" -F'ref=master' -F"variables[BRANCH]=$CI_COMMIT_REF_NAME" https://git.pleroma.social/api/v4/projects/673/trigger/pipeline
review_app:
image: alpine:3.9
stage: deploy
@@ -151,6 +129,7 @@ amd64:
only: &release-only
- master@pleroma/pleroma
- develop@pleroma/pleroma
- /^maint/.*$/@pleroma/pleroma
artifacts: &release-artifacts
name: "pleroma-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA-$CI_JOB_NAME"
paths:


+ 6
- 0
CHANGELOG.md View File

@@ -6,10 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]
### Added
- Refreshing poll results for remote polls
- Job queue stats to the healthcheck page
- Admin API: Add ability to require password reset
- Mastodon API: Account entities now include `follow_requests_count` (planned Mastodon 3.x addition)
- Pleroma API: `GET /api/v1/pleroma/accounts/:id/scrobbles` to get a list of recently scrobbled items
- Pleroma API: `POST /api/v1/pleroma/scrobble` to scrobble a media item
- Mastodon API: Add `upload_limit`, `avatar_upload_limit`, `background_upload_limit`, and `banner_upload_limit` to `/api/v1/instance`

### Changed
- **Breaking:** Elixir >=1.8 is now required (was >= 1.7)
@@ -22,6 +24,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

### Fixed
- Mastodon API: Fix private and direct statuses not being filtered out from the public timeline for an authenticated user (`GET /api/v1/timelines/public`)
- Mastodon API: Inability to get some local users by nickname in `/api/v1/accounts/:id_or_nickname`
- Added `:instance, extended_nickname_format` setting to the default config

## [1.1.0] - 2019-??-??
### Security
@@ -73,6 +77,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- ActivityPub: Deactivated user deletion
- ActivityPub: Fix `/users/:nickname/inbox` crashing without an authenticated user
- MRF: fix ability to follow a relay when AntiFollowbotPolicy was enabled
- Mastodon API: Blocks are now treated consistently between the Streaming API and the Timeline APIs

### Added
- Expiring/ephemeral activites. All activities can have expires_at value set, which controls when they should be deleted automatically.
@@ -117,6 +122,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Mastodon API: Added an endpoint to get multiple statuses by IDs (`GET /api/v1/statuses/?ids[]=1&ids[]=2`)
- ActivityPub: Add ActivityPub actor's `discoverable` parameter.
- Admin API: Added moderation log filters (user/start date/end date/search/pagination)
- Reverse Proxy: Do not retry failed requests to limit pressure on the peer

### Changed
- Configuration: Filter.AnonymizeFilename added ability to retain file extension with custom text


+ 2
- 1
config/config.exs View File

@@ -279,7 +279,8 @@ config :pleroma, :instance,
max_remote_account_fields: 20,
account_field_name_length: 512,
account_field_value_length: 2048,
external_user_synchronization: true
external_user_synchronization: true,
extended_nickname_format: false

config :pleroma, :markup,
# XXX - unfortunately, inline images must be enabled by default right now, because


docs/api/admin_api.md → docs/API/admin_api.md View File


docs/api/differences_in_mastoapi_responses.md → docs/API/differences_in_mastoapi_responses.md View File


docs/api/pleroma_api.md → docs/API/pleroma_api.md View File

@@ -124,7 +124,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
```

## `/api/pleroma/admin/`…
See [Admin-API](Admin-API.md)
See [Admin-API](admin_api.md)

## `/api/v1/pleroma/notifications/read`
### Mark notifications as read
@@ -317,7 +317,8 @@ See [Admin-API](Admin-API.md)
"active": 0, # active processes
"idle": 0, # idle processes
"memory_used": 0.00, # Memory used
"healthy": true # Instance state
"healthy": true, # Instance state
"job_queue_stats": {} # Job queue stats
}
```

@@ -391,7 +392,7 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
### Update a file in a custom emoji pack
* Method `POST`
* Authentication: required
* Params:
* Params:
* if the `action` is `add`, adds an emoji named `shortcode` to the pack `pack_name`,
that means that the emoji file needs to be uploaded with the request
(thus requiring it to be a multipart request) and be named `file`.
@@ -408,7 +409,7 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
### Updates (replaces) pack metadata
* Method `POST`
* Authentication: required
* Params:
* Params:
* `new_data`: new metadata to replace the old one
* Response: JSON, updated "metadata" section of the pack and 200 status or 400 if there was a
problem with the new metadata (the error is specified in the "error" part of the response JSON)
@@ -417,7 +418,7 @@ The status posting endpoint takes an additional parameter, `in_reply_to_conversa
### Requests the instance to download the pack from another instance
* Method `POST`
* Authentication: required
* Params:
* Params:
* `instance_address`: the address of the instance to download from
* `pack_name`: the pack to download from that instance
* Response: JSON, "ok" and 200 status if the pack was downloaded, or 500 if there were

docs/api/prometheus.md → docs/API/prometheus.md View File


+ 19
- 0
docs/administration/CLI_tasks/config.md View File

@@ -0,0 +1,19 @@
# Transfering the config to/from the database

!!! danger
This is a Work In Progress, not usable just yet.

Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl config` and in case of source installs it's
`mix pleroma.config`.

## Transfer config from file to DB.

```sh
$PREFIX migrate_to_db
```

## Transfer config from DB to `config/env.exported_from_db.secret.exs`

```sh
$PREFIX migrate_from_db <env>
```

+ 48
- 0
docs/administration/CLI_tasks/database.md View File

@@ -0,0 +1,48 @@
# Database maintenance tasks

Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl database` and in case of source installs it's `mix pleroma.database`.

## Replace embedded objects with their references

Replaces embedded objects with references to them in the `objects` table. Only needs to be ran once if the instance was created before Pleroma 1.0.5. The reason why this is not a migration is because it could significantly increase the database size after being ran, however after this `VACUUM FULL` will be able to reclaim about 20% (really depends on what is in the database, your mileage may vary) of the db size before the migration.

```sh
$PREFIX remove_embedded_objects [<options>]
```

### Options
- `--vacuum` - run `VACUUM FULL` after the embedded objects are replaced with their references

## Prune old remote posts from the database

This will prune remote posts older than 90 days (configurable with [`config :pleroma, :instance, remote_post_retention_days`](../../configuration/cheatsheet.md#instance)) from the database, they will be refetched from source when accessed.

!!! note
The disk space will only be reclaimed after `VACUUM FULL`

```sh
$PREFIX pleroma.database prune_objects [<options>]
```

### Options
- `--vacuum` - run `VACUUM FULL` after the objects are pruned

## Create a conversation for all existing DMs

Can be safely re-run

```sh
$PREFIX bump_all_conversations
```

## Remove duplicated items from following and update followers count for all users

```sh
$PREFIX update_users_following_followers_counts
```

## Fix the pre-existing "likes" collections for all objects

```sh
$PREFIX fix_likes_collections
```

+ 13
- 0
docs/administration/CLI_tasks/digest.md View File

@@ -0,0 +1,13 @@
# Managing digest emails
Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl digest` and in case of source installs it's `mix pleroma.digest`.

## Send digest email since given date (user registration date by default) ignoring user activity status.

```sh
$PREFIX test <nickname> [<since_date>]
```

Example:
```sh
$PREFIX test donaldtheduck 2019-05-20
```

+ 30
- 0
docs/administration/CLI_tasks/emoji.md View File

@@ -0,0 +1,30 @@
# Managing emoji packs

Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl emoji` and in case of source installs it's `mix pleroma.emoji`.

## Lists emoji packs and metadata specified in the manifest

```sh
$PREFIX ls-packs [<options>]
```

### Options
- `-m, --manifest PATH/URL` - path to a custom manifest, it can either be an URL starting with `http`, in that case the manifest will be fetched from that address, or a local path

## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME`
```sh
$PREFIX get-packs [<options>] <packs>
```

### Options
- `-m, --manifest PATH/URL` - same as [`ls-packs`](#ls-packs)

## Create a new manifest entry and a file list from the specified remote pack file
```sh
$PREFIX gen-pack PACK-URL
```
Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you.

The manifest entry will either be written to a newly created `index.json` file or appended to the existing one, *replacing* the old pack with the same name if it was in the file previously.

The file list will be written to the file specified previously, *replacing* that file. You _should_ check that the file list doesn't contain anything you don't need in the pack, that is, anything that is not an emoji (the whole pack is downloaded, but only emoji files are extracted).

+ 30
- 0
docs/administration/CLI_tasks/instance.md View File

@@ -0,0 +1,30 @@
# Managing instance configuration

Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl instance` and in case of source installs it's `mix pleroma.instance`.

## Generate a new configuration file
```sh
$PREFIX gen [<options>]
```

If any of the options are left unspecified, you will be prompted interactively.

### Options
- `-f`, `--force` - overwrite any output files
- `-o <path>`, `--output <path>` - the output file for the generated configuration
- `--output-psql <path>` - the output file for the generated PostgreSQL setup
- `--domain <domain>` - the domain of your instance
- `--instance-name <instance_name>` - the name of your instance
- `--admin-email <email>` - the email address of the instance admin
- `--notify-email <email>` - email address for notifications
- `--dbhost <hostname>` - the hostname of the PostgreSQL database to use
- `--dbname <database_name>` - the name of the database to use
- `--dbuser <username>` - the user (aka role) to use for the database connection
- `--dbpass <password>` - the password to use for the database connection
- `--rum <Y|N>` - Whether to enable RUM indexes
- `--indexable <Y|N>` - Allow/disallow indexing site by search engines
- `--db-configurable <Y|N>` - Allow/disallow configuring instance from admin part
- `--uploads-dir <path>` - the directory uploads go in when using a local uploader
- `--static-dir <path>` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
- `--listen-ip <ip>` - the ip the app should listen to, defaults to 127.0.0.1
- `--listen-port <port>` - the port the app should listen to, defaults to 4000

+ 30
- 0
docs/administration/CLI_tasks/relay.md View File

@@ -0,0 +1,30 @@
# Managing relays

Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl relay` and in case of source installs it's `mix pleroma.relay`.

## Follow a relay
```sh
$PREFIX follow <relay_url>
```

Example:
```sh
$PREFIX follow https://example.org/relay
```

## Unfollow a remote relay

```sh
$PREFIX unfollow <relay_url>
```

Example:
```sh
$PREFIX unfollow https://example.org/relay
```

## List relay subscriptions

```sh
$PREFIX list
```

+ 12
- 0
docs/administration/CLI_tasks/uploads.md View File

@@ -0,0 +1,12 @@
# Managing uploads

Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl uploads` and in case of source installs it's `mix pleroma.uploads`.

## Migrate uploads from local to remote storage
```sh
$PREFIX migrate_local <target_uploader> [<options>]
```
### Options
- `--delete` - delete local uploads after migrating them to the target uploader

A list of available uploaders can be seen in [Configuration Cheat Sheet](../../configuration/cheatsheet.md#pleromaupload)

+ 94
- 0
docs/administration/CLI_tasks/user.md View File

@@ -0,0 +1,94 @@
# Managing users

Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl user` and in case of source installs it's `mix pleroma.user`.

## Create a user
```sh
$PREFIX new <nickname> <email> [<options>]
```

### Options
- `--name <name>` - the user's display name
- `--bio <bio>` - the user's bio
- `--password <password>` - the user's password
- `--moderator`/`--no-moderator` - whether the user should be a moderator
- `--admin`/`--no-admin` - whether the user should be an admin
- `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions

## Generate an invite link
```sh
$PREFIX invite [<options>]
```

### Options
- `--expires-at DATE` - last day on which token is active (e.g. "2019-04-05")
- `--max-use NUMBER` - maximum numbers of token uses

## List generated invites
```sh
$PREFIX invites
```

## Revoke invite
```sh
$PREFIX revoke_invite <token_or_id>
```

## Delete a user
```sh
$PREFIX rm <nickname>
```

## Delete user's posts and interactions
```sh
$PREFIX delete_activities <nickname>
```

## Sign user out from all applications (delete user's OAuth tokens and authorizations)
```sh
$PREFIX sign_out <nickname>
```

## Deactivate or activate a user
```sh
$PREFIX toggle_activated <nickname>
```

## Unsubscribe local users from a user and deactivate the user
```sh
$PREFIX unsubscribe NICKNAME
```

## Unsubscribe local users from an instance and deactivate all accounts on it
```sh
$PREFIX unsubscribe_all_from_instance <instance>
```

## Create a password reset link for user
```sh
$PREFIX reset_password <nickname>
```

## Set the value of the given user's settings
```sh
$PREFIX set <nickname> [<options>]
```
### Options
- `--locked`/`--no-locked` - whether the user should be locked
- `--moderator`/`--no-moderator` - whether the user should be a moderator
- `--admin`/`--no-admin` - whether the user should be an admin

## Add tags to a user
```sh
$PREFIX tag <nickname> <tags>
```

## Delete tags from a user
```sh
$PREFIX untag <nickname> <tags>
```

## Toggle confirmation status of the user
```sh
$PREFIX toggle_confirmed <nickname>
```

docs/admin/backup.md → docs/administration/backup.md View File


docs/admin/updating.md → docs/administration/updating.md View File


+ 0
- 17
docs/config/General-tips-for-customizing-Pleroma-FE.md View File

@@ -1,17 +0,0 @@
# General tips for customizing Pleroma FE
There are some configuration scripts for Pleroma BE and FE:

1. `config/prod.secret.exs`
1. `config/config.exs`
1. `priv/static/static/config.json`

The `prod.secret.exs` affects first. `config.exs` is for fallback or default. `config.json` is for GNU-social-BE-Pleroma-FE instances.

Usually all you have to do is:

1. Copy the section in the `config/config.exs` which you want to activate.
1. Paste into `config/prod.secret.exs`.
1. Edit `config/prod.secret.exs`.
1. Restart the Pleroma daemon.

`prod.secret.exs` is for the `MIX_ENV=prod` environment. `dev.secret.exs` is for the `MIX_ENV=dev` environment respectively.

+ 0
- 12
docs/config/small_customizations.md View File

@@ -1,12 +0,0 @@
# Small customizations

See also static_dir.md for visual settings.

## Theme

All users of your instance will be able to change the theme they use by going to the settings (the cog in the top-right hand corner). However, if you wish to change the default theme, you can do so by editing `theme` in `config/dev.secret.exs` accordingly.

## Message Visibility

To enable message visibility options when posting like in the Mastodon frontend, set
`scope_options_enabled` to `true` in `config/dev.secret.exs`.

docs/config.md → docs/configuration/cheatsheet.md View File

@@ -1,7 +1,11 @@
# Configuration
# Configuration Cheat Sheet

This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here.

Pleroma configuration works by first importing the base config (`config/config.exs` on source installs, compiled-in on OTP releases), then overriding it by the environment config (`config/$MIX_ENV.exs` on source installs, N/A to OTP releases) and then overriding it by user config (`config/$MIX_ENV.secret.exs` on source installs, typically `/etc/pleroma/config.exs` on OTP releases).

You shouldn't edit the base config directly to avoid breakages and merge conflicts, but it can be used as a reference if you don't understand how an option is supposed to be formatted, the latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs).

This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory.
If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``.

## Pleroma.Upload
* `uploader`: Select which `Pleroma.Uploaders` to use
@@ -11,7 +15,8 @@ If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherw
* `proxy_remote`: If you're using a remote uploader, Pleroma will proxy media requests instead of redirecting to it.
* `proxy_opts`: Proxy options, see `Pleroma.ReverseProxy` documentation.

Note: `strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.
!!! warning
`strip_exif` has been replaced by `Pleroma.Upload.Filter.Mogrify`.

## Pleroma.Uploaders.Local
* `uploads`: Which directory to store the user-uploads in, relative to pleroma’s working directory
@@ -111,12 +116,6 @@ config :pleroma, Pleroma.Emails.Mailer,
* `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML)
* `mrf_transparency`: Make the content of your Message Rewrite Facility settings public (via nodeinfo).
* `mrf_transparency_exclusions`: Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.
* `scope_copy`: Copy the scope (private/unlisted/public) in replies to posts by default.
* `subject_line_behavior`: Allows changing the default behaviour of subject lines in replies. Valid values:
* "email": Copy and preprend re:, as in email.
* "masto": Copy verbatim, as in Mastodon.
* "noop": Don't copy the subject.
* `always_show_subject_input`: When set to false, auto-hide the subject field when it's empty.
* `extended_nickname_format`: Set to `true` to use extended local nicknames format (allows underscores/dashes). This will break federation with
older software for theses nicknames.
* `max_pinned_statuses`: The maximum number of pinned statuses. `0` will disable the feature.
@@ -132,13 +131,17 @@ config :pleroma, Pleroma.Emails.Mailer,
* `user_name_length`: A user name maximum length (default: `100`)
* `skip_thread_containment`: Skip filter out broken threads. The default is `false`.
* `limit_to_local_content`: Limit unauthenticated users to search for local statutes and users only. Possible values: `:unauthenticated`, `:all` and `false`. The default is `:unauthenticated`.
* `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.
* `max_account_fields`: The maximum number of custom fields in the user profile (default: `10`)
* `max_remote_account_fields`: The maximum number of custom fields in the remote user profile (default: `20`)
* `account_field_name_length`: An account field name maximum length (default: `512`)
* `account_field_value_length`: An account field value maximum length (default: `2048`)
* `external_user_synchronization`: Enabling following/followers counters synchronization for external users.

!!! danger
This is a Work In Progress, not usable just yet

* `dynamic_configuration`: Allow transferring configuration to DB with the subsequent customization from Admin api.



## :logger
@@ -186,7 +189,7 @@ See the [Quack Github](https://github.com/azohra/quack) for more details

## :frontend_configurations

This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured.
This can be used to configure a keyword list that keeps the configuration data for any kind of frontend. By default, settings for `pleroma_fe` and `masto_fe` are configured. You can find the documentation for `pleroma_fe` configuration into [Pleroma-FE configuration and customization for instance administrators](/frontend/CONFIGURATION/#options).

Frontends can access these settings at `/api/pleroma/frontend_configurations`

@@ -208,14 +211,15 @@ These settings **need to be complete**, they will override the defaults.
NOTE: for versions < 1.0, you need to set [`:fe`](#fe) to false, as shown a few lines below.

## :fe
__THIS IS DEPRECATED__
!!! warning
__THIS IS DEPRECATED__

If you are using this method, please change it to the [`frontend_configurations`](#frontend_configurations) method.
Please **set this option to false** in your config like this:
If you are using this method, please change it to the [`frontend_configurations`](#frontend_configurations) method.
Please **set this option to false** in your config like this:

```elixir
config :pleroma, :fe, false
```
```elixir
config :pleroma, :fe, false
```

This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:instance`` is set to false.

@@ -261,7 +265,7 @@ All criteria are configured as a map of regular expressions to lists of policy m

Example:

```
```elixir
config :pleroma, :mrf_subchain,
match_actor: %{
~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
@@ -301,7 +305,10 @@ config :pleroma, :mrf_subchain,
* `dstport`: Port advertised in urls (optional, defaults to `port`)

## Pleroma.Web.Endpoint
`Phoenix` endpoint configuration, all configuration options can be viewed [here](https://hexdocs.pm/phoenix/Phoenix.Endpoint.html#module-dynamic-configuration), only common options are listed here

!!! note
`Phoenix` endpoint configuration, all configuration options can be viewed [here](https://hexdocs.pm/phoenix/Phoenix.Endpoint.html#module-dynamic-configuration), only common options are listed here.

* `http` - a list containing http protocol configuration, all configuration options can be viewed [here](https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html#module-options), only common options are listed here. For deployment using docker, you need to set this to `[ip: {0,0,0,0}, port: 4000]` to make pleroma accessible from other containers (such as your nginx server).
- `ip` - a tuple consisting of 4 integers
- `port`
@@ -314,7 +321,8 @@ config :pleroma, :mrf_subchain,



**Important note**: if you modify anything inside these lists, default `config.exs` values will be overwritten, which may result in breakage, to make sure this does not happen please copy the default value for the list from `config.exs` and modify/add only what you need
!!! warning
If you modify anything inside these lists, default `config.exs` values will be overwritten, which may result in breakage, to make sure this does not happen please copy the default value for the list from `config.exs` and modify/add only what you need

Example:
```elixir
@@ -440,11 +448,6 @@ This config contains two queues: `federator_incoming` and `federator_outgoing`.

`config :pleroma_job_queue, :queues` is replaced by `config :pleroma, Oban, :queues` and uses the same format (keys are queues' names, values are max concurrent jobs numbers).

### Note on running with PostgreSQL in silent mode

If you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1), it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings (see https://github.com/sorentwo/oban/issues/52).

## :workers

Includes custom worker options not interpretable directly by `Oban`.
@@ -552,7 +555,7 @@ The above example defines a single job which invokes `Pleroma.Web.Websub.refresh

## Pleroma.ActivityExpiration

# `enabled`: whether expired activities will be sent to the job queue to be deleted
* `enabled`: whether expired activities will be sent to the job queue to be deleted

## Pleroma.Web.Auth.Authenticator

@@ -628,13 +631,14 @@ Email notifications settings.
OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.).
Implementation is based on Ueberauth; see the list of [available strategies](https://github.com/ueberauth/ueberauth/wiki/List-of-Strategies).

Note: each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`,
e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`.
The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.
!!! note
Each strategy is shipped as a separate dependency; in order to get the strategies, run `OAUTH_CONSUMER_STRATEGIES="..." mix deps.get`, e.g. `OAUTH_CONSUMER_STRATEGIES="twitter facebook google microsoft" mix deps.get`. The server should also be started with `OAUTH_CONSUMER_STRATEGIES="..." mix phx.server` in case you enable any strategies.

Note: each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.
!!! note
Each strategy requires separate setup (on external provider side and Pleroma side). Below are the guidelines on setting up most popular strategies.

Note: make sure that `"SameSite=Lax"` is set in `extra_cookie_attrs` when you have this feature enabled. OAuth consumer mode will not work with `"SameSite=Strict"`
!!! note
Make sure that `"SameSite=Lax"` is set in `extra_cookie_attrs` when you have this feature enabled. OAuth consumer mode will not work with `"SameSite=Strict"`

* For Twitter, [register an app](https://developer.twitter.com/en/apps), configure callback URL to https://<your_host>/oauth/twitter/callback

@@ -739,8 +743,6 @@ A keyword list of rate limiters where a key is a limiter name and value is the l

It is also possible to have different limits for unauthenticated and authenticated users: the keyword value must be a list of two tuples where the first one is a config for unauthenticated users and the second one is for authenticated.

See [`Pleroma.Plugs.RateLimiter`](Pleroma.Plugs.RateLimiter.html) documentation for examples.

Supported rate limiters:

* `:search` for the search requests (account & status search etc.)
@@ -761,7 +763,8 @@ Available caches:

## Pleroma.Plugs.RemoteIp

**If your instance is not behind at least one reverse proxy, you should not enable this plug.**
!!! warning
If your instance is not behind at least one reverse proxy, you should not enable this plug.

`Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.


docs/config/custom_emoji.md → docs/configuration/custom_emoji.md View File

@@ -4,6 +4,7 @@ Before you add your own custom emoji, check if they are available in an existing
See `Mix.Tasks.Pleroma.Emoji` for information about emoji packs.

To add custom emoji:

* Create the `STATIC-DIR/emoji/` directory if it doesn't exist
(`STATIC-DIR` is configurable, `instance/static/` by default)
* Create a directory with whatever name you want (custom is a good name to show the purpose of it).

docs/config/hardening.md → docs/configuration/hardening.md View File


docs/config/howto_mediaproxy.md → docs/configuration/howto_mediaproxy.md View File


docs/config/howto_mongooseim.md → docs/configuration/howto_mongooseim.md View File


docs/config/howto_proxy.md → docs/configuration/howto_proxy.md View File


docs/config/howto_set_richmedia_cache_ttl_based_on_image.md → docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md View File


docs/config/howto_user_recomendation.md → docs/configuration/howto_user_recomendation.md View File


docs/config/i2p.md → docs/configuration/i2p.md View File


docs/config/mrf.md → docs/configuration/mrf.md View File


docs/config/onion_federation.md → docs/configuration/onion_federation.md View File


docs/config/static_dir.md → docs/configuration/static_dir.md View File


+ 4
- 6
docs/installation/alpine_linux_en.md View File

@@ -225,12 +225,10 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress

#### Further reading

* [Backup your instance](backup.html)
* [Configuration tips](general-tips-for-customizing-pleroma-fe.html)
* [Hardening your instance](hardening.html)
* [How to activate mediaproxy](howto_mediaproxy.html)
* [Small Pleroma-FE customizations](small_customizations.html)
* [Updating your instance](updating.html)
* [Backup your instance](../administration/backup.md)
* [Hardening your instance](../configuration/hardening.md)
* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
* [Updating your instance](../administration/updating.md)

## Questions



+ 4
- 6
docs/installation/arch_linux_en.md View File

@@ -200,12 +200,10 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress

#### Further reading

* [Backup your instance](backup.html)
* [Configuration tips](general-tips-for-customizing-pleroma-fe.html)
* [Hardening your instance](hardening.html)
* [How to activate mediaproxy](howto_mediaproxy.html)
* [Small Pleroma-FE customizations](small_customizations.html)
* [Updating your instance](updating.html)
* [Backup your instance](../administration/backup.md)
* [Hardening your instance](../configuration/hardening.md)
* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
* [Updating your instance](../administration/updating.md)

## Questions



+ 4
- 6
docs/installation/centos7_en.md View File

@@ -264,12 +264,10 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress

#### Further reading

* [Backup your instance](backup.html)
* [Configuration tips](general-tips-for-customizing-pleroma-fe.html)
* [Hardening your instance](hardening.html)
* [How to activate mediaproxy](howto_mediaproxy.html)
* [Small Pleroma-FE customizations](small_customizations.html)
* [Updating your instance](updating.html)
* [Backup your instance](../administration/backup.md)
* [Hardening your instance](../configuration/hardening.md)
* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
* [Updating your instance](../administration/updating.md)

## Questions



+ 4
- 6
docs/installation/debian_based_en.md View File

@@ -190,12 +190,10 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress

#### Further reading

* [Backup your instance](backup.html)
* [Configuration tips](general-tips-for-customizing-pleroma-fe.html)
* [Hardening your instance](hardening.html)
* [How to activate mediaproxy](howto_mediaproxy.html)
* [Small Pleroma-FE customizations](small_customizations.html)
* [Updating your instance](updating.html)
* [Backup your instance](../administration/backup.md)
* [Hardening your instance](../configuration/hardening.md)
* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
* [Updating your instance](../administration/updating.md)

## Questions



+ 4
- 6
docs/installation/debian_based_jp.md View File

@@ -179,12 +179,10 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress

#### その他の設定とカスタマイズ

* [Backup your instance](backup.html)
* [Configuration tips](general-tips-for-customizing-pleroma-fe.html)
* [Hardening your instance](hardening.html)
* [How to activate mediaproxy](howto_mediaproxy.html)
* [Small Pleroma-FE customizations](small_customizations.html)
* [Updating your instance](updating.html)
* [Backup your instance](../administration/backup.md)
* [Hardening your instance](../configuration/hardening.md)
* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
* [Updating your instance](../administration/updating.md)

## 質問ある?



+ 4
- 6
docs/installation/gentoo_en.md View File

@@ -283,12 +283,10 @@ If you opted to allow sudo for the `pleroma` user but would like to remove the a

#### Further reading

* [Backup your instance](backup.html)
* [Configuration tips](general-tips-for-customizing-pleroma-fe.html)
* [Hardening your instance](hardening.html)
* [How to activate mediaproxy](howto_mediaproxy.html)
* [Small Pleroma-FE customizations](small_customizations.html)
* [Updating your instance](updating.html)
* [Backup your instance](../administration/backup.md)
* [Hardening your instance](../configuration/hardening.md)
* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
* [Updating your instance](../administration/updating.md)

## Questions



+ 5
- 5
docs/installation/migrating_from_source_otp_en.md View File

@@ -11,7 +11,7 @@ Benefits of OTP releases over from-source installs include:
* **Faster and less bug-prone mix tasks.** On a from-source install one has to wait untill a new Pleroma node is started for each mix task and they execute outside of the instance context (for example if a user was deleted via a mix task, the instance will have no knowledge of that and continue to display status count and follows before the cache expires). Mix tasks in OTP releases are executed by calling into a running instance via RPC, which solves both of these problems.

### Sounds great, how do I switch?
Currently we support Linux machines with GNU (e.g. Debian, Ubuntu) or musl (e.g. Alpine) libc and `x86_64`, `aarch64` or `armv7l` CPUs. If you are unsure, check the [Detecting flavour](otp_en.html#detecting-flavour) section in OTP install guide. If your platform is supported, proceed with the guide, if not check the [My platform is not supported](#my-platform-is-not-supported) section.
Currently we support Linux machines with GNU (e.g. Debian, Ubuntu) or musl (e.g. Alpine) libc and `x86_64`, `aarch64` or `armv7l` CPUs. If you are unsure, check the [Detecting flavour](otp_en.md#detecting-flavour) section in OTP install guide. If your platform is supported, proceed with the guide, if not check the [My platform is not supported](#my-platform-is-not-supported) section.
### I don't think it is worth the effort, can I stay on a from-source install?
Yes, currently there are no plans to deprecate them.

@@ -70,7 +70,7 @@ and then copy custom emojis to `/var/lib/pleroma/static/emoji/custom`.

This is needed because storing custom emojis in the root directory is deprecated, but if you just move them to `/var/lib/pleroma/static/emoji/custom` it will break emoji urls on old posts.

Note that globs have been replaced with `pack_extensions`, so if your emojis are not in png/gif you should [modify the default value](config.html#emoji).
Note that globs have been replaced with `pack_extensions`, so if your emojis are not in png/gif you should [modify the default value](../configuration/cheatsheet.md#emoji).

### Moving the config
```sh
@@ -86,7 +86,7 @@ mv ~pleroma/config/prod.secret.exs /etc/pleroma/config.exs
$EDITOR /etc/pleroma/config.exs
```
## Installing the release
Before proceeding, get the flavour from [Detecting flavour](otp_en.html#detecting-flavour) section in OTP installation guide.
Before proceeding, get the flavour from [Detecting flavour](otp_en.md#detecting-flavour) section in OTP installation guide.
```sh
# Delete all files in pleroma user's directory
rm -r ~pleroma/*
@@ -148,6 +148,6 @@ cp -f ~pleroma/installation/init.d/pleroma /etc/init.d/pleroma
rc-service pleroma start
```
## Running mix tasks
Refer to [Running mix tasks](otp_en.html#running-mix-tasks) section from OTP release installation guide.
Refer to [Running mix tasks](otp_en.md#running-mix-tasks) section from OTP release installation guide.
## Updating
Refer to [Updating](otp_en.html#updating) section from OTP release installation guide.
Refer to [Updating](otp_en.md#updating) section from OTP release installation guide.

+ 6
- 6
docs/installation/otp_en.md View File

@@ -42,7 +42,7 @@ apk add curl unzip ncurses postgresql postgresql-contrib nginx certbot
## Setup
### Configuring PostgreSQL
#### (Optional) Installing RUM indexes
RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. You can read more about them on the [Configuration page](config.html#rum-indexing-for-full-text-search). They are completely optional and most of the time are not worth it, especially if you are running a single user instance (unless you absolutely need ordered search results).
RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. You can read more about them on the [Configuration page](../configuration/cheatsheet.md#rum-indexing-for-full-text-search). They are completely optional and most of the time are not worth it, especially if you are running a single user instance (unless you absolutely need ordered search results).

Debian/Ubuntu (available only on Buster/19.04):
```sh
@@ -262,8 +262,8 @@ su pleroma -s $SHELL -lc "./bin/pleroma_ctl migrate"
But you should **always check the release notes/changelog** in case there are config deprecations, special update steps, etc.

## Further reading
* [Configuration](config.html)
* [Pleroma's base config.exs](https://git.pleroma.social/pleroma/pleroma/blob/master/config/config.exs)
* [Hardening your instance](hardening.html)
* [Pleroma Clients](clients.html)
* [Emoji pack manager](Mix.Tasks.Pleroma.Emoji.html)
* [Backup your instance](../administration/backup.md)
* [Hardening your instance](../configuration/hardening.md)
* [How to activate mediaproxy](../configuration/howto_mediaproxy.md)
* [Updating your instance](../administration/updating.md)

+ 1
- 12
lib/mix/tasks/pleroma/config.ex View File

@@ -8,18 +8,7 @@ defmodule Mix.Tasks.Pleroma.Config do
alias Pleroma.Repo
alias Pleroma.Web.AdminAPI.Config
@shortdoc "Manages the location of the config"
@moduledoc """
Manages the location of the config.

## Transfers config from file to DB.

mix pleroma.config migrate_to_db

## Transfers config from DB to file `config/env.exported_from_db.secret.exs`

mix pleroma.config migrate_from_db ENV
"""

@moduledoc File.read!("docs/administration/CLI_tasks/config.md")
def run(["migrate_to_db"]) do
start_pleroma()



+ 1
- 27
lib/mix/tasks/pleroma/database.ex View File

@@ -13,34 +13,8 @@ defmodule Mix.Tasks.Pleroma.Database do
use Mix.Task

@shortdoc "A collection of database related tasks"
@moduledoc """
A collection of database related tasks
@moduledoc File.read!("docs/administration/CLI_tasks/database.md")

## Replace embedded objects with their references

Replaces embedded objects with references to them in the `objects` table. Only needs to be ran once. The reason why this is not a migration is because it could significantly increase the database size after being ran, however after this `VACUUM FULL` will be able to reclaim about 20% (really depends on what is in the database, your mileage may vary) of the db size before the migration.

mix pleroma.database remove_embedded_objects

Options:
- `--vacuum` - run `VACUUM FULL` after the embedded objects are replaced with their references

## Prune old objects from the database

mix pleroma.database prune_objects

## Create a conversation for all existing DMs. Can be safely re-run.

mix pleroma.database bump_all_conversations

## Remove duplicated items from following and update followers count for all users

mix pleroma.database update_users_following_followers_counts

## Fix the pre-existing "likes" collections for all objects

mix pleroma.database fix_likes_collections
"""
def run(["remove_embedded_objects" | args]) do
{options, [], []} =
OptionParser.parse(


+ 1
- 9
lib/mix/tasks/pleroma/digest.ex View File

@@ -2,16 +2,8 @@ defmodule Mix.Tasks.Pleroma.Digest do
use Mix.Task

@shortdoc "Manages digest emails"
@moduledoc """
Manages digest emails
@moduledoc File.read!("docs/administration/CLI_tasks/digest.md")

## Send digest email since given date (user registration date by default)
ignoring user activity status.

``mix pleroma.digest test <nickname> <since_date>``

Example: ``mix pleroma.digest test donaldtheduck 2019-05-20``
"""
def run(["test", nickname | opts]) do
Mix.Pleroma.start_pleroma()



+ 1
- 48
lib/mix/tasks/pleroma/emoji.ex View File

@@ -6,54 +6,7 @@ defmodule Mix.Tasks.Pleroma.Emoji do
use Mix.Task

@shortdoc "Manages emoji packs"
@moduledoc """
Manages emoji packs

## ls-packs

mix pleroma.emoji ls-packs [OPTION...]

Lists the emoji packs and metadata specified in the manifest.

### Options

- `-m, --manifest PATH/URL` - path to a custom manifest, it can
either be an URL starting with `http`, in that case the
manifest will be fetched from that address, or a local path

## get-packs

mix pleroma.emoji get-packs [OPTION...] PACKS

Fetches, verifies and installs the specified PACKS from the
manifest into the `STATIC-DIR/emoji/PACK-NAME`

### Options

- `-m, --manifest PATH/URL` - same as ls-packs

## gen-pack

mix pleroma.emoji gen-pack PACK-URL

Creates a new manifest entry and a file list from the specified
remote pack file. Currently, only .zip archives are recognized
as remote pack files and packs are therefore assumed to be zip
archives. This command is intended to run interactively and will
first ask you some basic questions about the pack, then download
the remote file and generate an SHA256 checksum for it, then
generate an emoji file list for you.

The manifest entry will either be written to a newly created
`index.json` file or appended to the existing one, *replacing*
the old pack with the same name if it was in the file previously.

The file list will be written to the file specified previously,
*replacing* that file. You _should_ check that the file list doesn't
contain anything you don't need in the pack, that is, anything that is
not an emoji (the whole pack is downloaded, but only emoji files
are extracted).
"""
@moduledoc File.read!("docs/administration/CLI_tasks/emoji.md")

def run(["ls-packs" | args]) do
Application.ensure_all_started(:hackney)


+ 1
- 30
lib/mix/tasks/pleroma/instance.ex View File

@@ -7,36 +7,7 @@ defmodule Mix.Tasks.Pleroma.Instance do
import Mix.Pleroma

@shortdoc "Manages Pleroma instance"
@moduledoc """
Manages Pleroma instance.

## Generate a new instance config.

mix pleroma.instance gen [OPTION...]

If any options are left unspecified, you will be prompted interactively

## Options

- `-f`, `--force` - overwrite any output files
- `-o PATH`, `--output PATH` - the output file for the generated configuration
- `--output-psql PATH` - the output file for the generated PostgreSQL setup
- `--domain DOMAIN` - the domain of your instance
- `--instance-name INSTANCE_NAME` - the name of your instance
- `--admin-email ADMIN_EMAIL` - the email address of the instance admin
- `--notify-email NOTIFY_EMAIL` - email address for notifications
- `--dbhost HOSTNAME` - the hostname of the PostgreSQL database to use
- `--dbname DBNAME` - the name of the database to use
- `--dbuser DBUSER` - the user (aka role) to use for the database connection
- `--dbpass DBPASS` - the password to use for the database connection
- `--rum Y/N` - Whether to enable RUM indexes
- `--indexable Y/N` - Allow/disallow indexing site by search engines
- `--db-configurable Y/N` - Allow/disallow configuring instance from admin part
- `--uploads-dir` - the directory uploads go in when using a local uploader
- `--static-dir` - the directory custom public files should be read from (custom emojis, frontend bundle overrides, robots.txt, etc.)
- `--listen-ip` - the ip the app should listen to, defaults to 127.0.0.1
- `--listen-port` - the port the app should listen to, defaults to 4000
"""
@moduledoc File.read!("docs/administration/CLI_tasks/instance.md")

def run(["gen" | rest]) do
{options, [], []} =


+ 1
- 18
lib/mix/tasks/pleroma/relay.ex View File

@@ -9,25 +9,8 @@ defmodule Mix.Tasks.Pleroma.Relay do
alias Pleroma.Web.ActivityPub.Relay

@shortdoc "Manages remote relays"
@moduledoc """
Manages remote relays
@moduledoc File.read!("docs/administration/CLI_tasks/relay.md")

## Follow a remote relay

``mix pleroma.relay follow <relay_url>``

Example: ``mix pleroma.relay follow https://example.org/relay``

## Unfollow a remote relay

``mix pleroma.relay unfollow <relay_url>``

Example: ``mix pleroma.relay unfollow https://example.org/relay``

## List relay subscriptions

``mix pleroma.relay list``
"""
def run(["follow", target]) do
start_pleroma()



+ 1
- 9
lib/mix/tasks/pleroma/uploads.ex View File

@@ -12,16 +12,8 @@ defmodule Mix.Tasks.Pleroma.Uploads do
@log_every 50

@shortdoc "Migrates uploads from local to remote storage"
@moduledoc """
Manages uploads
@moduledoc File.read!("docs/administration/CLI_tasks/uploads.md")

## Migrate uploads from local to remote storage
mix pleroma.uploads migrate_local TARGET_UPLOADER [OPTIONS...]
Options:
- `--delete` - delete local uploads after migrating them to the target uploader

A list of available uploaders can be seen in config.exs
"""
def run(["migrate_local", target_uploader | args]) do
delete? = Enum.member?(args, "--delete")
start_pleroma()


+ 1
- 79
lib/mix/tasks/pleroma/user.ex View File

@@ -10,86 +10,8 @@ defmodule Mix.Tasks.Pleroma.User do
alias Pleroma.Web.OAuth

@shortdoc "Manages Pleroma users"
@moduledoc """
Manages Pleroma users.
@moduledoc File.read!("docs/administration/CLI_tasks/user.md")

## Create a new user.

mix pleroma.user new NICKNAME EMAIL [OPTION...]

Options:
- `--name NAME` - the user's name (i.e., "Lain Iwakura")
- `--bio BIO` - the user's bio
- `--password PASSWORD` - the user's password
- `--moderator`/`--no-moderator` - whether the user is a moderator
- `--admin`/`--no-admin` - whether the user is an admin
- `-y`, `--assume-yes`/`--no-assume-yes` - whether to assume yes to all questions

## Generate an invite link.

mix pleroma.user invite [OPTION...]

Options:
- `--expires-at DATE` - last day on which token is active (e.g. "2019-04-05")
- `--max-use NUMBER` - maximum numbers of token uses

## List generated invites

mix pleroma.user invites

## Revoke invite

mix pleroma.user revoke_invite TOKEN OR TOKEN_ID

## Delete the user's account.

mix pleroma.user rm NICKNAME

## Delete the user's activities.

mix pleroma.user delete_activities NICKNAME

## Sign user out from all applications (delete user's OAuth tokens and authorizations).

mix pleroma.user sign_out NICKNAME

## Deactivate or activate the user's account.

mix pleroma.user toggle_activated NICKNAME

## Unsubscribe local users from user's account and deactivate it

mix pleroma.user unsubscribe NICKNAME

## Unsubscribe local users from an entire instance and deactivate all accounts

mix pleroma.user unsubscribe_all_from_instance INSTANCE

## Create a password reset link.

mix pleroma.user reset_password NICKNAME

## Set the value of the given user's settings.

mix pleroma.user set NICKNAME [OPTION...]

Options:
- `--locked`/`--no-locked` - whether the user's account is locked
- `--moderator`/`--no-moderator` - whether the user is a moderator
- `--admin`/`--no-admin` - whether the user is an admin

## Add tags to a user.

mix pleroma.user tag NICKNAME TAGS

## Delete tags from a user.

mix pleroma.user untag NICKNAME TAGS

## Toggle confirmation of the user's account.

mix pleroma.user toggle_confirmed NICKNAME
"""
def run(["new", nickname, email | rest]) do
{options, [], []} =
OptionParser.parse(


+ 3
- 1
lib/pleroma/application.ex View File

@@ -42,6 +42,7 @@ defmodule Pleroma.Application do
hackney_pool_children() ++
[
Pleroma.Stats,
Pleroma.JobQueueMonitor,
{Oban, Pleroma.Config.get(Oban)}
] ++
task_children(@env) ++
@@ -102,7 +103,8 @@ defmodule Pleroma.Application do
build_cachex("scrubber", limit: 2500),
build_cachex("idempotency", expiration: idempotency_expiration(), limit: 2500),
build_cachex("web_resp", limit: 2500),
build_cachex("emoji_packs", expiration: emoji_packs_expiration(), limit: 10)
build_cachex("emoji_packs", expiration: emoji_packs_expiration(), limit: 10),
build_cachex("failed_proxy_url", limit: 2500)
]
end



+ 8
- 0
lib/pleroma/healthcheck.ex View File

@@ -14,6 +14,7 @@ defmodule Pleroma.Healthcheck do
active: 0,
idle: 0,
memory_used: 0,
job_queue_stats: nil,
healthy: true

@type t :: %__MODULE__{
@@ -21,6 +22,7 @@ defmodule Pleroma.Healthcheck do
active: non_neg_integer(),
idle: non_neg_integer(),
memory_used: number(),
job_queue_stats: map(),
healthy: boolean()
}

@@ -30,6 +32,7 @@ defmodule Pleroma.Healthcheck do
memory_used: Float.round(:erlang.memory(:total) / 1024 / 1024, 2)
}
|> assign_db_info()
|> assign_job_queue_stats()
|> check_health()
end

@@ -55,6 +58,11 @@ defmodule Pleroma.Healthcheck do
Map.merge(healthcheck, db_info)
end

defp assign_job_queue_stats(healthcheck) do
stats = Pleroma.JobQueueMonitor.stats()
Map.put(healthcheck, :job_queue_stats, stats)
end

@spec check_health(Healthcheck.t()) :: Healthcheck.t()
def check_health(%{pool_size: pool_size, active: active} = check)
when active >= pool_size do


+ 78
- 0
lib/pleroma/job_queue_monitor.ex View File

@@ -0,0 +1,78 @@
# Pleroma: A lightweight social networking server
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.JobQueueMonitor do
use GenServer

@initial_state %{workers: %{}, queues: %{}, processed_jobs: 0}
@queue %{processed_jobs: 0, success: 0, failure: 0}
@operation %{processed_jobs: 0, success: 0, failure: 0}

def start_link(_) do
GenServer.start_link(__MODULE__, @initial_state, name: __MODULE__)
end

@impl true
def init(state) do
:telemetry.attach("oban-monitor-failure", [:oban, :failure], &handle_event/4, nil)
:telemetry.attach("oban-monitor-success", [:oban, :success], &handle_event/4, nil)

{:ok, state}
end

def stats do
GenServer.call(__MODULE__, :stats)
end

def handle_event([:oban, status], %{duration: duration}, meta, _) do
GenServer.cast(__MODULE__, {:process_event, status, duration, meta})
end

@impl true
def handle_call(:stats, _from, state) do
{:reply, state, state}
end

@impl true
def handle_cast({:process_event, status, duration, meta}, state) do
state =
state
|> Map.update!(:workers, fn workers ->
workers
|> Map.put_new(meta.worker, %{})
|> Map.update!(meta.worker, &update_worker(&1, status, meta, duration))
end)
|> Map.update!(:queues, fn workers ->
workers
|> Map.put_new(meta.queue, @queue)
|> Map.update!(meta.queue, &update_queue(&1, status, meta, duration))
end)
|> Map.update!(:processed_jobs, &(&1 + 1))

{:noreply, state}
end

defp update_worker(worker, status, meta, duration) do
worker
|> Map.put_new(meta.args["op"], @operation)
|> Map.update!(meta.args["op"], &update_op(&1, status, meta, duration))
end

defp update_op(op, :enqueue, _meta, _duration) do
op
|> Map.update!(:enqueued, &(&1 + 1))
end

defp update_op(op, status, _meta, _duration) do
op
|> Map.update!(:processed_jobs, &(&1 + 1))
|> Map.update!(status, &(&1 + 1))
end

defp update_queue(queue, status, _meta, _duration) do
queue
|> Map.update!(:processed_jobs, &(&1 + 1))
|> Map.update!(status, &(&1 + 1))
end
end

+ 26
- 1
lib/pleroma/reverse_proxy/reverse_proxy.ex View File

@@ -15,6 +15,7 @@ defmodule Pleroma.ReverseProxy do
@valid_resp_codes [200, 206, 304]
@max_read_duration :timer.seconds(30)
@max_body_length :infinity
@failed_request_ttl :timer.seconds(60)
@methods ~w(GET HEAD)

@moduledoc """
@@ -48,6 +49,8 @@ defmodule Pleroma.ReverseProxy do
* `max_read_duration` (default `#{inspect(@max_read_duration)}` ms): the total time the connection is allowed to
read from the remote upstream.

* `failed_request_ttl` (default `#{inspect(@failed_request_ttl)}` ms): the time the failed request is cached and cannot be retried.

* `inline_content_types`:
* `true` will not alter `content-disposition` (up to the upstream),
* `false` will add `content-disposition: attachment` to any request,
@@ -83,6 +86,7 @@ defmodule Pleroma.ReverseProxy do
{:keep_user_agent, boolean}
| {:max_read_duration, :timer.time() | :infinity}
| {:max_body_length, non_neg_integer() | :infinity}
| {:failed_request_ttl, :timer.time() | :infinity}
| {:http, []}
| {:req_headers, [{String.t(), String.t()}]}
| {:resp_headers, [{String.t(), String.t()}]}
@@ -108,7 +112,8 @@ defmodule Pleroma.ReverseProxy do
opts
end

with {:ok, code, headers, client} <- request(method, url, req_headers, hackney_opts),
with {:ok, nil} <- Cachex.get(:failed_proxy_url_cache, url),
{:ok, code, headers, client} <- request(method, url, req_headers, hackney_opts),
:ok <-
header_length_constraint(
headers,
@@ -116,12 +121,18 @@ defmodule Pleroma.ReverseProxy do
) do
response(conn, client, url, code, headers, opts)
else
{:ok, true} ->
conn
|> error_or_redirect(url, 500, "Request failed", opts)
|> halt()

{:ok, code, headers} ->
head_response(conn, url, code, headers, opts)
|> halt()

{:error, {:invalid_http_response, code}} ->
Logger.error("#{__MODULE__}: request to #{inspect(url)} failed with HTTP status #{code}")
track_failed_url(url, code, opts)

conn
|> error_or_redirect(
@@ -134,6 +145,7 @@ defmodule Pleroma.ReverseProxy do

{:error, error} ->
Logger.error("#{__MODULE__}: request to #{inspect(url)} failed: #{inspect(error)}")
track_failed_url(url, error, opts)

conn
|> error_or_redirect(url, 500, "Request failed", opts)
@@ -388,4 +400,17 @@ defmodule Pleroma.ReverseProxy do
end

defp client, do: Pleroma.ReverseProxy.Client

defp track_failed_url(url, code, opts) do
code = to_string(code)

ttl =
if code in ["403", "404"] or String.starts_with?(code, "5") do
Keyword.get(opts, :failed_request_ttl, @failed_request_ttl)
else
nil
end

Cachex.put(:failed_proxy_url_cache, url, true, ttl: ttl)
end
end

+ 1
- 1
lib/pleroma/user.ex View File

@@ -583,7 +583,7 @@ defmodule Pleroma.User do
is_integer(nickname_or_id) or FlakeId.flake_id?(nickname_or_id) ->
get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)

restrict_to_local == false ->
restrict_to_local == false or not String.contains?(nickname_or_id, "@") ->
get_cached_by_nickname(nickname_or_id)

restrict_to_local == :unauthenticated and match?(%User{}, opts[:for]) ->


+ 1
- 1
lib/pleroma/web/activity_pub/activity_pub.ex View File

@@ -346,7 +346,7 @@ defmodule Pleroma.Web.ActivityPub.ActivityPub do
local \\ true,
public \\ true
) do
with true <- is_public?(object),
with true <- is_announceable?(object, user, public),
announce_data <- make_announce_data(user, object, activity_id, public),
{:ok, activity} <- insert(announce_data, local),
{:ok, object} <- add_announce_to_object(activity, object),


+ 0
- 32
lib/pleroma/web/activity_pub/activity_pub_controller.ex View File

@@ -82,38 +82,6 @@ defmodule Pleroma.Web.ActivityPub.ActivityPubController do
conn
end

def object_likes(conn, %{"uuid" => uuid, "page" => page}) do
with ap_id <- o_status_url(conn, :object, uuid),
%Object{} = object <- Object.get_cached_by_ap_id(ap_id),
{_, true} <- {:public?, Visibility.is_public?(object)},
likes <- Utils.get_object_likes(object) do
{page, _} = Integer.parse(page)

conn
|> put_resp_content_type("application/activity+json")
|> put_view(ObjectView)
|> render("likes.json", %{ap_id: ap_id, likes: likes, page: page})
else
{:public?, false} ->
{:error, :not_found}
end
end

def object_likes(conn, %{"uuid" => uuid}) do
with ap_id <- o_status_url(conn, :object, uuid),
%Object{} = object <- Object.get_cached_by_ap_id(ap_id),
{_, true} <- {:public?, Visibility.is_public?(object)},
likes <- Utils.get_object_likes(object) do
conn
|> put_resp_content_type("application/activity+json")
|> put_view(ObjectView)
|> render("likes.json", %{ap_id: ap_id, likes: likes})
else
{:public?, false} ->
{:error, :not_found}
end
end

def activity(conn, %{"uuid" => uuid}) do
with ap_id <- o_status_url(conn, :activity, uuid),
%Activity{} = activity <- Activity.normalize(ap_id),


+ 39
- 0
lib/pleroma/web/activity_pub/transmogrifier.ex View File

@@ -753,6 +753,24 @@ defmodule Pleroma.Web.ActivityPub.Transmogrifier do
end
end

# For Undos that don't have the complete object attached, try to find it in our database.
def handle_incoming(
%{
"type" => "Undo",
"object" => object
} = activity,
options
)
when is_binary(object) do
with %Activity{data: data} <- Activity.get_by_ap_id(object) do
activity
|> Map.put("object", data)
|> handle_incoming(options)
else
_e -> :error
end
end

def handle_incoming(_, _), do: :error

@spec get_obj_helper(String.t(), Keyword.t()) :: {:ok, Object.t()} | nil
@@ -812,6 +830,27 @@ defmodule Pleroma.Web.ActivityPub.Transmogrifier do
{:ok, data}
end

def prepare_outgoing(%{"type" => "Announce", "actor" => ap_id, "object" => object_id} = data) do
object =
object_id
|> Object.normalize()

data =
if Visibility.is_private?(object) && object.data["actor"] == ap_id do
data |> Map.put("object", object |> Map.get(:data) |> prepare_object)
else
data |> maybe_fix_object_url
end

data =
data
|> strip_internal_fields
|> Map.merge(Utils.make_json_ld_header())
|> Map.delete("bcc")

{:ok, data}
end

# Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
# because of course it does.
def prepare_outgoing(%{"type" => "Accept"} = data) do


+ 9
- 15
lib/pleroma/web/activity_pub/utils.ex View File

@@ -251,16 +251,6 @@ defmodule Pleroma.Web.ActivityPub.Utils do
|> Repo.one()
end

@doc """
Returns like activities targeting an object
"""
def get_object_likes(%{data: %{"id" => id}}) do
id
|> Activity.Queries.by_object_id()
|> Activity.Queries.by_type("Like")
|> Repo.all()
end

@spec make_like_data(User.t(), map(), String.t()) :: map()
def make_like_data(
%User{ap_id: ap_id} = actor,
@@ -461,14 +451,16 @@ defmodule Pleroma.Web.ActivityPub.Utils do
"""
def make_unannounce_data(
%User{ap_id: ap_id} = user,
%Activity{data: %{"context" => context}} = activity,
%Activity{data: %{"context" => context, "object" => object}} = activity,
activity_id
) do
object = Object.normalize(object)

%{
"type" => "Undo",
"actor" => ap_id,
"object" => activity.data,
"to" => [user.follower_address, activity.data["actor"]],
"to" => [user.follower_address, object.data["actor"]],
"cc" => [Pleroma.Constants.as_public()],
"context" => context
}
@@ -477,14 +469,16 @@ defmodule Pleroma.Web.ActivityPub.Utils do

def make_unlike_data(
%User{ap_id: ap_id} = user,
%Activity{data: %{"context" => context}} = activity,
%Activity{data: %{"context" => context, "object" => object}} = activity,
activity_id
) do
object = Object.normalize(object)

%{
"type" => "Undo",
"actor" => ap_id,
"object" => activity.data,
"to" => [user.follower_address, activity.data["actor"]],
"to" => [user.follower_address, object.data["actor"]],
"cc" => [Pleroma.Constants.as_public()],
"context" => context
}
@@ -494,7 +488,7 @@ defmodule Pleroma.Web.ActivityPub.Utils do
@spec add_announce_to_object(Activity.t(), Object.t()) ::
{:ok, Object.t()} | {:error, Ecto.Changeset.t()}
def add_announce_to_object(
%Activity{data: %{"actor" => actor, "cc" => [Pleroma.Constants.as_public()]}},
%Activity{data: %{"actor" => actor}},
object
) do
announcements = take_announcements(object)


+ 0
- 36
lib/pleroma/web/activity_pub/views/object_view.ex View File

@@ -37,40 +37,4 @@ defmodule Pleroma.Web.ActivityPub.ObjectView do

Map.merge(base, additional)
end

def render("likes.json", %{ap_id: ap_id, likes: likes, page: page}) do
collection(likes, "#{ap_id}/likes", page)
|> Map.merge(Pleroma.Web.ActivityPub.Utils.make_json_ld_header())
end

def render("likes.json", %{ap_id: ap_id, likes: likes}) do
%{
"id" => "#{ap_id}/likes",
"type" => "OrderedCollection",
"totalItems" => length(likes),
"first" => collection(likes, "#{ap_id}/likes", 1)
}
|> Map.merge(Pleroma.Web.ActivityPub.Utils.make_json_ld_header())
end

def collection(collection, iri, page) do
offset = (page - 1) * 10
items = Enum.slice(collection, offset, 10)
items = Enum.map(items, fn object -> Transmogrifier.prepare_object(object.data) end)
total = length(collection)

map = %{
"id" => "#{iri}?page=#{page}",
"type" => "OrderedCollectionPage",
"partOf" => iri,
"totalItems" => total,
"orderedItems" => items
}

if offset + length(items) < total do
Map.put(map, "next", "#{iri}?page=#{page + 1}")
else
map
end
end
end

+ 1
- 1
lib/pleroma/web/activity_pub/views/user_view.ex View File

@@ -22,7 +22,7 @@ defmodule Pleroma.Web.ActivityPub.UserView do
def render("endpoints.json", %{user: %User{local: true} = _user}) do
%{
"oauthAuthorizationEndpoint" => Helpers.o_auth_url(Endpoint, :authorize),
"oauthRegistrationEndpoint" => Helpers.mastodon_api_url(Endpoint, :create_app),
"oauthRegistrationEndpoint" => Helpers.app_url(Endpoint, :create),
"oauthTokenEndpoint" => Helpers.o_auth_url(Endpoint, :token_exchange),
"sharedInbox" => Helpers.activity_pub_url(Endpoint, :inbox),
"uploadMedia" => Helpers.activity_pub_url(Endpoint, :upload_media)


+ 5
- 0
lib/pleroma/web/activity_pub/visibility.ex View File

@@ -27,6 +27,11 @@ defmodule Pleroma.Web.ActivityPub.Visibility do
end
end

def is_announceable?(activity, user, public \\ true) do
is_public?(activity) ||
(!public && is_private?(activity) && activity.data["actor"] == user.ap_id)
end

def is_direct?(%Activity{data: %{"directMessage" => true}}), do: true
def is_direct?(%Object{data: %{"directMessage" => true}}), do: true



+ 12
- 3
lib/pleroma/web/common_api/common_api.ex View File

@@ -76,11 +76,12 @@ defmodule Pleroma.Web.CommonAPI do
end
end

def repeat(id_or_ap_id, user) do
def repeat(id_or_ap_id, user, params \\ %{}) do
with %Activity{} = activity <- get_by_id_or_ap_id(id_or_ap_id),
object <- Object.normalize(activity),
nil <- Utils.get_existing_announce(user.ap_id, object) do
ActivityPub.announce(user, object)
nil <- Utils.get_existing_announce(user.ap_id, object),
public <- public_announce?(object, params) do
ActivityPub.announce(user, object, nil, true, public)
else
_ -> {:error, dgettext("errors", "Could not repeat")}
end
@@ -169,6 +170,14 @@ defmodule Pleroma.Web.CommonAPI do
end
end

def public_announce?(_, %{"visibility" => visibility})
when visibility in ~w{public unlisted private direct},
do: visibility in ~w(public unlisted)

def public_announce?(object, _) do
Visibility.is_public?(object)
end

def get_visibility(_, _, %Participation{}), do: {"direct", "direct"}

def get_visibility(%{"visibility" => visibility}, in_reply_to, _)


+ 12
- 0
lib/pleroma/web/controller_helper.ex View File

@@ -75,4 +75,16 @@ defmodule Pleroma.Web.ControllerHelper do
nil -> Pleroma.Web.MastodonAPI.FallbackController.call(conn, {:error, :not_found}) |> halt()
end
end

def try_render(conn, target, params)
when is_binary(target) do
case render(conn, target, params) do
nil -> render_error(conn, :not_implemented, "Can't display this activity")
res -> res
end
end

def try_render(conn, _, _) do
render_error(conn, :not_implemented, "Can't display this activity")
end
end

+ 36
- 0
lib/pleroma/web/masto_fe_controller.ex View File

@@ -0,0 +1,36 @@
# Pleroma: A lightweight social networking server
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Web.MastoFEController do
use Pleroma.Web, :controller

alias Pleroma.User

@doc "GET /web/*path"
def index(%{assigns: %{user: user}} = conn, _params) do
token = get_session(conn, :oauth_token)

if user && token do
conn
|> put_layout(false)
|> render("index.html", token: token, user: user, custom_emojis: Pleroma.Emoji.get_all())
else
conn
|> put_session(:return_to, conn.request_path)
|> redirect(to: "/web/login")
end
end

@doc "PUT /api/web/settings"
def put_settings(%{assigns: %{user: user}} = conn, %{"data" => settings} = _params) do
with {:ok, _} <- User.update_info(user, &User.Info.mastodon_settings_update(&1, settings)) do
json(conn, %{})
else
e ->
conn
|> put_status(:internal_server_error)
|> json(%{error: inspect(e)})
end
end
end

+ 39
- 0
lib/pleroma/web/mastodon_api/controllers/app_controller.ex View File

@@ -0,0 +1,39 @@
# Pleroma: A lightweight social networking server
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Web.MastodonAPI.AppController do
use Pleroma.Web, :controller

alias Pleroma.Repo
alias Pleroma.Web.OAuth.App
alias Pleroma.Web.OAuth.Scopes
alias Pleroma.Web.OAuth.Token

action_fallback(Pleroma.Web.MastodonAPI.FallbackController)

@local_mastodon_name "Mastodon-Local"

@doc "POST /api/v1/apps"
def create(conn, params) do
scopes = Scopes.fetch_scopes(params, ["read"])

app_attrs =
params
|> Map.drop(["scope", "scopes"])
|> Map.put("scopes", scopes)

with cs <- App.register_changeset(%App{}, app_attrs),
false <- cs.changes[:client_name] == @local_mastodon_name,
{:ok, app} <- Repo.insert(cs) do
render(conn, "show.json", app: app)
end
end

@doc "GET /api/v1/apps/verify_credentials"
def verify_credentials(%{assigns: %{user: _user, token: token}} = conn, _) do
with %Token{app: %App{} = app} <- Repo.preload(token, :app) do
render(conn, "short.json", app: app)
end
end
end

+ 91
- 0
lib/pleroma/web/mastodon_api/controllers/auth_controller.ex View File

@@ -0,0 +1,91 @@
# Pleroma: A lightweight social networking server
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only

defmodule Pleroma.Web.MastodonAPI.AuthController do
use Pleroma.Web, :controller

alias Pleroma.User
alias Pleroma.Web.OAuth.App
alias Pleroma.Web.OAuth.Authorization
alias Pleroma.Web.OAuth.Token
alias Pleroma.Web.TwitterAPI.TwitterAPI

action_fallback(Pleroma.Web.MastodonAPI.FallbackController)

@local_mastodon_name "Mastodon-Local"

plug(Pleroma.Plugs.RateLimiter, :password_reset when action == :password_reset)

@doc "GET /web/login"
def login(%{assigns: %{user: %User{}}} = conn, _params) do
redirect(conn, to: local_mastodon_root_path(conn))
end

@doc "Local Mastodon FE login init action"
def login(conn, %{"code" => auth_token}) do
with {:ok, app} <- get_or_make_app(),
{:ok, auth} <- Authorization.get_by_token(app, auth_token),
{:ok, token} <- Token.exchange_token(app, auth) do
conn
|> put_session(:oauth_token, token.token)
|> redirect(to: local_mastodon_root_path(conn))
end
end

@doc "Local Mastodon FE callback action"
def login(conn, _) do
with {:ok, app} <- get_or_make_app() do
path =
o_auth_path(conn, :authorize,
response_type: "code",
client_id: app.client_id,
redirect_uri: ".",
scope: Enum.join(app.scopes, " ")
)

redirect(conn, to: path)
end
end

@doc "DELETE /auth/sign_out"
def logout(conn, _) do
conn
|> clear_session
|> redirect(to: "/")
end

@doc "POST /auth/password"
def password_reset(conn, params) do
nickname_or_email = params["email"] || params["nickname"]