Rename the Exiftool module

No migrations or checks yet
2022-02-20 13:46:29 +01:00 · 2022-02-20 13:46:29 +01:00 · 8303af84ce
parent 551721e41a
commit 8303af84ce
8 changed files with 20 additions and 18 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -12,6 +12,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

 ### Changed
 - Allow users to remove their emails if instance does not need email to register
+- Uploadfilter `Pleroma.Upload.Filter.Exiftool` has been renamed to `Pleroma.Upload.Filter.Exiftool.StripLocation`

 ### Added
 - `activeMonth` and `activeHalfyear` fields in NodeInfo usage.users object
@ -30,6 +31,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Configuration: Add `birthday_required` and `birthday_min_age` settings to provide a way to require users to enter their birth date.
 - PleromaAPI: Add `GET /api/v1/pleroma/birthdays` API endpoint
 - Make backend-rendered pages translatable. This includes emails. Pages returned as a HTTP response are translated using the language specified in the `userLanguage` cookie, or the `Accept-Language` header. Emails are translated using the `language` field when registering. This language can be changed by `PATCH /api/v1/accounts/update_credentials` with the `language` field.
+- Uploadfilter `Pleroma.Upload.Filter.Exiftool.ReadDescription` returns description values to the FE so they can pre fill the image description field

 ### Fixed
 - Subscription(Bell) Notifications: Don't create from Pipeline Ingested replies
--- a/docs/configuration/cheatsheet.md
+++ b/docs/configuration/cheatsheet.md
@ -627,7 +627,7 @@ This filter replaces the filename (not the path) of an upload. For complete obfu

 No specific configuration.

-#### Pleroma.Upload.Filter.Exiftool
+#### Pleroma.Upload.Filter.Exiftool.StripLocation

 This filter only strips the GPS and location metadata with Exiftool leaving color profiles and attributes intact.

--- a/docs/installation/optional/media_graphics_packages.md
+++ b/docs/installation/optional/media_graphics_packages.md
@ -29,5 +29,5 @@ It is required for the following Pleroma features:
 `exiftool` is media files metadata reader/writer.

 It is required for the following Pleroma features:
-    * `Pleroma.Upload.Filters.Exiftool` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)
+    * `Pleroma.Upload.Filters.Exiftool.StripLocation` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)
    * `Pleroma.Upload.Filters.Exiftool.ReadDescription` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)
--- a/lib/mix/tasks/pleroma/instance.ex
+++ b/lib/mix/tasks/pleroma/instance.ex
@ -34,7 +34,7 @@ def run(["gen" | rest]) do
          static_dir: :string,
          listen_ip: :string,
          listen_port: :string,
-          strip_uploads: :string,
+          strip_uploads_location: :string,
          read_uploads_description: :string,
          anonymize_uploads: :string,
          dedupe_uploads: :string
@ -162,7 +162,7 @@ def run(["gen" | rest]) do
        )
        |> Path.expand()

-      {strip_uploads_message, strip_uploads_default} =
+      {strip_uploads_location_message, strip_uploads_location_default} =
        if Pleroma.Utils.command_available?("exiftool") do
          {"Do you want to strip location (GPS) data from uploaded images? This requires exiftool, it was detected as installed. (y/n)",
           "y"}
@ -171,12 +171,12 @@ def run(["gen" | rest]) do
           "n"}
        end

-      strip_uploads =
+      strip_uploads_location =
        get_option(
          options,
-          :strip_uploads,
-          strip_uploads_message,
-          strip_uploads_default
+          :strip_uploads_location,
+          strip_uploads_location_message,
+          strip_uploads_location_default
        ) === "y"

      {read_uploads_description_message, read_uploads_description_default} =
@ -247,7 +247,7 @@ def run(["gen" | rest]) do
          listen_port: listen_port,
          upload_filters:
            upload_filters(%{
-              strip: strip_uploads,
+              strip_location: strip_uploads_location,
              read_description: read_uploads_description,
              anonymize: anonymize_uploads,
              dedupe: dedupe_uploads
@ -316,8 +316,8 @@ defp write_robots_txt(static_dir, indexable, template_dir) do

  defp upload_filters(filters) when is_map(filters) do
    enabled_filters =
-      if filters.strip do
-        [Pleroma.Upload.Filter.Exiftool]
+      if filters.strip_location do
+        [Pleroma.Upload.Filter.Exiftool.StripLocation]
      else
        []
      end
--- a/lib/pleroma/application_requirements.ex
+++ b/lib/pleroma/application_requirements.ex
@ -164,7 +164,7 @@ defp do_check_rum!(setting, migrate) do

  defp check_system_commands!(:ok) do
    filter_commands_statuses = [
-      check_filter(Pleroma.Upload.Filter.Exiftool, "exiftool"),
+      check_filter(Pleroma.Upload.Filter.Exiftool.StripLocation, "exiftool"),
      check_filter(Pleroma.Upload.Filter.Exiftool.ReadDescription, "exiftool"),
      check_filter(Pleroma.Upload.Filter.Mogrify, "mogrify"),
      check_filter(Pleroma.Upload.Filter.Mogrifun, "mogrify"),
--- a/lib/pleroma/upload/filter/exiftool/strip_location.ex
+++ b/lib/pleroma/upload/filter/exiftool/strip_location.ex
@ -2,7 +2,7 @@
 # Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
 # SPDX-License-Identifier: AGPL-3.0-only

-defmodule Pleroma.Upload.Filter.Exiftool do
+defmodule Pleroma.Upload.Filter.Exiftool.StripLocation do
  @moduledoc """
  Strips GPS related EXIF tags and overwrites the file in place.
  Also strips or replaces filesystem metadata e.g., timestamps.
--- a/test/mix/tasks/pleroma/instance_test.exs
+++ b/test/mix/tasks/pleroma/instance_test.exs
@ -67,7 +67,7 @@ test "running gen" do
        "test/uploads",
        "--static-dir",
        "./test/../test/instance/static/",
-        "--strip-uploads",
+        "--strip-uploads-location",
        "y",
        "--read-uploads-description",
        "y",
@ -95,7 +95,7 @@ test "running gen" do
    assert generated_config =~ "http: [ip: {127, 0, 0, 1}, port: 4000]"

    assert generated_config =~
-             "filters: [Pleroma.Upload.Filter.Exiftool, Pleroma.Upload.Filter.Exiftool.ReadDescription]"
+             "filters: [Pleroma.Upload.Filter.Exiftool.StripLocation, Pleroma.Upload.Filter.Exiftool.ReadDescription]"

    assert File.read!(tmp_path() <> "setup.psql") == generated_setup_psql()
    assert File.exists?(Path.expand("./test/instance/static/robots.txt"))
--- a/test/pleroma/upload/filter/exiftool/strip_location_test.exs
+++ b/test/pleroma/upload/filter/exiftool/strip_location_test.exs
@ -2,7 +2,7 @@
 # Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
 # SPDX-License-Identifier: AGPL-3.0-only

-defmodule Pleroma.Upload.Filter.ExiftoolTest do
+defmodule Pleroma.Upload.Filter.Exiftool.StripLocationTest do
  use Pleroma.DataCase, async: true
  alias Pleroma.Upload.Filter

@ -21,7 +21,7 @@ test "apply exiftool filter" do
      tempfile: Path.absname("test/fixtures/DSCN0010_tmp.jpg")
    }

-    assert Filter.Exiftool.filter(upload) == {:ok, :filtered}
+    assert Filter.Exiftool.StripLocation.filter(upload) == {:ok, :filtered}

    {exif_original, 0} = System.cmd("exiftool", ["test/fixtures/DSCN0010.jpg"])
    {exif_filtered, 0} = System.cmd("exiftool", ["test/fixtures/DSCN0010_tmp.jpg"])
@ -37,6 +37,6 @@ test "verify webp files are skipped" do
      content_type: "image/webp"
    }

-    assert Filter.Exiftool.filter(upload) == {:ok, :noop}
+    assert Filter.Exiftool.StripLocation.filter(upload) == {:ok, :noop}
  end
 end