[PLUGIN][Pinboard] Refactor and cleanup code

Notification bug fix on Subscription component
Correct docblock

.dir-locals.el

@@ -0,0 +1,3 @@
+((nil . ((php-project-root . auto)
+         (phpstan-executable . (root . "bin/phpstan"))
+ )

.env.test

@@ -3,4 +3,4 @@ KERNEL_CLASS='App\Kernel'
 APP_SECRET='$ecretf0rt3st'
 SYMFONY_DEPRECATIONS_HELPER=999999
 PANTHER_APP_ENV=panther
-DATABASE_URL=postgresql://postgres:password@db:5432/social
+DATABASE_URL=postgresql://postgres:password@db:5432/test

.gitignore

@@ -16,8 +16,9 @@
 ###< symfony/phpunit-bridge ###
 
 ###> friendsofphp/php-cs-fixer ###
-!.php_cs
+!.php-cs-fixer.php
 /.php_cs.cache
+/.php-cs-fixer.cache
 ###< friendsofphp/php-cs-fixer ###
 
 ###> phpunit/phpunit ###

.php-cs-fixer.php

@@ -1,42 +1,46 @@
 <?php
 
+declare(strict_types = 1);
+
 /*
  * This document has been generated with
- * https://mlocati.github.io/php-cs-fixer-configurator/#version:2.16.1|configurator
+ * https://mlocati.github.io/php-cs-fixer-configurator/#version:3.2.1|configurator
  * you can change this configuration by importing this file.
  */
-return PhpCsFixer\Config::create()
+$config = new PhpCsFixer\Config();
+return $config
     ->setRiskyAllowed(true)
     ->setRules([
         // Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one.
         'align_multiline_comment' => ['comment_type' => 'phpdocs_like'],
-        // PHP arrays should be declared using the configured syntax.
-        'array_syntax' => ['syntax' => 'short'],
-        // Binary operators should be surrounded by space as configured.
-        'binary_operator_spaces' => [
-            'default'   => 'align_single_space_minimal',
-            'operators' => ['??' => 'align'],
-        ],
-        // There MUST be one blank line after the namespace declaration.
-        'blank_line_after_namespace' => true,
         // Each element of an array must be indented exactly once.
         'array_indentation' => true,
+        // Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`.
+        'array_push' => true,
+        // PHP arrays should be declared using the configured syntax.
+        'array_syntax' => ['syntax' => 'short'],
+        // Use the null coalescing assignment operator `??=` where possible.
+        'assign_null_coalescing_to_coalesce_equal' => true,
+        // Binary operators should be surrounded by space as configured.
+        'binary_operator_spaces' => ['default' => 'align_single_space_minimal', 'operators' => ['??' => 'align']],
+        // There MUST be one blank line after the namespace declaration.
+        'blank_line_after_namespace' => true,
         // Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line.
-        'blank_line_after_opening_tag' => false,
+        'blank_line_after_opening_tag' => true,
         // The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.
-        'braces' => ['allow_single_line_closure' => true, 'position_after_functions_and_oop_constructs' => 'next',
+        'braces' => ['allow_single_line_anonymous_class_with_empty_body' => true, 'allow_single_line_closure' => true, 'position_after_functions_and_oop_constructs' => 'next'],
-            // 'allow_single_line_functions' => true, // Awaiting PR merge...
-        ],
         // A single space or none should be between cast and variable.
         'cast_spaces' => true,
-        // Class, trait and interface elements must be separated with one blank line.
-        'class_attributes_separation' => false,
         // Whitespace around the keywords of a class, trait or interfaces definition should be one space.
         'class_definition' => ['single_item_single_line' => true, 'single_line' => true],
         // Using `isset($var) &&` multiple times should be done in one call.
         'combine_consecutive_issets' => true,
         // Calling `unset` on multiple items should be done in one call.
         'combine_consecutive_unsets' => true,
+        // Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0.
+        'combine_nested_dirname' => true,
+        // Comments with annotation should be docblock when used on structural elements.
+        'comment_to_phpdoc' => false,
         // Remove extra spaces in a nullable typehint.
         'compact_nullable_typehint' => true,
         // Concatenation should be spaced according configuration.
@@ -45,8 +49,20 @@ return PhpCsFixer\Config::create()
         'constant_case' => true,
         // Equal sign in declare statement should be surrounded by spaces or not following configuration.
         'declare_equal_normalize' => ['space' => 'single'],
+        // There must not be spaces around `declare` statement parentheses.
+        'declare_parentheses' => true,
+        // Force strict types declaration in all files. Requires PHP >= 7.0.
+        'declare_strict_types' => true,
         // Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant.
         'dir_constant' => true,
+        // Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.
+        'echo_tag_syntax' => true,
+        // The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words.
+        'elseif' => true,
+        // Empty loop-body must be in configured style.
+        'empty_loop_body' => true,
+        // Empty loop-condition must be in configured style.
+        'empty_loop_condition' => true,
         // PHP code MUST use only UTF-8 without BOM (remove BOM).
         'encoding' => true,
         // Replace deprecated `ereg` regular expression functions with `preg`.
@@ -65,14 +81,30 @@ return PhpCsFixer\Config::create()
         'function_declaration' => ['closure_function_spacing' => 'one'],
         // Ensure single space between function's argument and its typehint.
         'function_typehint_space' => true,
+        // Imports or fully qualifies global classes/functions/constants.
+        'global_namespace_import' => true,
+        // Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3.
+        'heredoc_indentation' => true,
+        // Convert `heredoc` to `nowdoc` where possible.
+        'heredoc_to_nowdoc' => true,
+        // Function `implode` must be called with 2 arguments in the documented order.
+        'implode_call' => true,
         // Pre- or post-increment and decrement operators should be used if possible.
         'increment_style' => true,
         // Code MUST use configured indentation type.
         'indentation_type' => true,
+        // Lambda must not import variables it doesn't use.
+        'lambda_not_used_import' => true,
         // All PHP files must use same line ending.
         'line_ending' => true,
+        // Ensure there is no code on the same line as the PHP open tag.
+        'linebreak_after_opening_tag' => true,
+        // List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1.
+        'list_syntax' => ['syntax' => 'short'],
         // Use `&&` and `||` logical operators instead of `and` and `or`.
         'logical_operators' => true,
+        // Cast should be written in lower case.
+        'lowercase_cast' => true,
         // PHP keywords MUST be in lower case.
         'lowercase_keywords' => true,
         // Class static references `self`, `static` and `parent` MUST be in lower case.
@@ -81,6 +113,14 @@ return PhpCsFixer\Config::create()
         'magic_constant_casing' => true,
         // Magic method definitions and calls must be using the correct casing.
         'magic_method_casing' => true,
+        // Replace non multibyte-safe functions with corresponding mb function.
+        'mb_str_functions' => true,
+        // In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.
+        'method_argument_space' => ['after_heredoc' => true, 'on_multiline' => 'ensure_fully_multiline'],
+        // Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported.
+        'method_chaining_indentation' => true,
+        // Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible.
+        'modernize_strpos' => true,
         // Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator.
         'modernize_types_casting' => true,
         // DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash.
@@ -88,13 +128,17 @@ return PhpCsFixer\Config::create()
         // Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls.
         'multiline_whitespace_before_semicolons' => true,
         // Add leading `\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.
-        'native_constant_invocation' => false,
+        'native_constant_invocation' => true,
         // Function defined by PHP should be called using the correct casing.
         'native_function_casing' => true,
         // Add leading `\` before function invocation to speed up resolving.
-        'native_function_invocation' => false,
+        'native_function_invocation' => true,
         // Native type hints for functions should use the correct case.
         'native_function_type_declaration_casing' => true,
+        // Master language constructs shall be used instead of aliases.
+        'no_alias_language_construct_call' => true,
+        // Replace control structure alternative syntax to use braces.
+        'no_alternative_syntax' => true,
         // There should be no empty lines after class opening brace.
         'no_blank_lines_after_class_opening' => true,
         // There should not be blank lines between docblock and the documented element.
@@ -107,7 +151,7 @@ return PhpCsFixer\Config::create()
         'no_empty_comment' => true,
         // There should not be empty PHPDoc blocks.
         'no_empty_phpdoc' => true,
-        // Remove useless semicolon statements.
+        // Remove useless (semicolon) statements.
         'no_empty_statement' => true,
         // Removes extra blank lines and/or blank lines following configuration.
         'no_extra_blank_lines' => true,
@@ -123,18 +167,18 @@ return PhpCsFixer\Config::create()
         'no_null_property_initialization' => true,
         // Short cast `bool` using double exclamation mark should not be used.
         'no_short_bool_cast' => true,
-        // Replace short-echo `<?=` with long format `<?php echo` syntax.
-        'no_short_echo_tag' => true,
         // Single-line whitespace before closing semicolon are prohibited.
         'no_singleline_whitespace_before_semicolons' => true,
+        // There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim).
+        'no_space_around_double_colon' => true,
         // When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis.
         'no_spaces_after_function_name' => true,
         // There MUST NOT be spaces around offset braces.
         'no_spaces_around_offset' => true,
         // There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis.
         'no_spaces_inside_parenthesis' => true,
-        // Replaces superfluous `elseif` with `if`.
+        // Removes `@param`, `@return` and `@var` tags that don't provide any useful information.
-        'no_superfluous_elseif' => false,
+        'no_superfluous_phpdoc_tags' => true,
         // Remove trailing commas in list function calls.
         'no_trailing_comma_in_list_call' => true,
         // PHP single-line arrays should not have trailing comma.
@@ -150,13 +194,9 @@ return PhpCsFixer\Config::create()
         // In function arguments there must not be arguments with default values before non-default ones.
         'no_unreachable_default_argument_value' => true,
         // Variables must be set `null` instead of using `(unset)` casting.
-        'no_unset_cast' => false,
+        'no_unset_cast' => true,
-        // Properties should be set to `null` instead of using `unset`.
-        'no_unset_on_property' => true,
         // Unused `use` statements must be removed.
         'no_unused_imports' => true,
-        // There should not be useless `else` cases.
-        'no_useless_else' => false,
         // There should not be an empty `return` statement at the end of a function.
         'no_useless_return' => true,
         // In array declaration, there MUST NOT be a whitespace before each comma.
@@ -167,22 +207,32 @@ return PhpCsFixer\Config::create()
         'non_printable_character' => true,
         // Array index should always be written by using square braces.
         'normalize_index_brace' => true,
-        // There should not be space before or after object `T_OBJECT_OPERATOR` `->`.
+        // Adds or removes `?` before type declarations for parameters with a default `null` value.
+        'nullable_type_declaration_for_default_null_value' => true,
+        // There should not be space before or after object operators `->` and `?->`.
         'object_operator_without_whitespace' => true,
+        // Operators - when multiline - must always be at the beginning or at the end of the line.
+        'operator_linebreak' => true,
         // Ordering `use` statements.
         'ordered_imports' => true,
-        // Orders the elements of classes/interfaces/traits.
-        'ordered_class_elements' => false,
         // PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`.
         'php_unit_construct' => true,
+        // PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`.
+        'php_unit_dedicate_assert' => true,
+        // PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`.
+        'php_unit_dedicate_assert_internal_type' => true,
+        // Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods.
+        'php_unit_expectation' => true,
         // PHPUnit annotations should be a FQCNs including a root namespace.
         'php_unit_fqcn_annotation' => true,
         // Enforce camel (or snake) case for PHPUnit test methods, following configuration.
         'php_unit_method_casing' => true,
         // Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`.
         'php_unit_mock_short_will_return' => true,
-        // Order `@covers` annotation of PHPUnit tests.
+        // PHPUnit classes MUST be used in namespaced version, e.g. `\PHPUnit\Framework\TestCase` instead of `\PHPUnit_Framework_TestCase`.
-        'php_unit_ordered_covers' => true,
+        'php_unit_namespaced' => true,
+        // Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.
+        'php_unit_no_expectation_annotation' => true,
         // Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase.
         'php_unit_set_up_tear_down_visibility' => true,
         // PHPUnit methods like `assertSame` should be used instead of `assertEquals`.
@@ -193,16 +243,26 @@ return PhpCsFixer\Config::create()
         'phpdoc_add_missing_param_annotation' => true,
         // All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.
         'phpdoc_align' => true,
+        // PHPDoc annotation descriptions should not be a sentence.
+        'phpdoc_annotation_without_dot' => true,
         // Docblocks should have the same indentation as the documented subject.
         'phpdoc_indent' => true,
-        // Fix PHPDoc inline tags, make `@inheritdoc` always inline.
+        // Fixes PHPDoc inline tags.
-        'phpdoc_inline_tag' => true,
+        'phpdoc_inline_tag_normalizer' => true,
+        // Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.
+        'phpdoc_line_span' => true,
         // `@access` annotations should be omitted from PHPDoc.
         'phpdoc_no_access' => true,
         // No alias PHPDoc tags should be used.
         'phpdoc_no_alias_tag' => true,
+        // `@return void` and `@return null` annotations should be omitted from PHPDoc.
+        'phpdoc_no_empty_return' => true,
+        // Classy that does not inherit must not have `@inheritdoc` tags.
+        'phpdoc_no_useless_inheritdoc' => true,
         // Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations.
         'phpdoc_order' => true,
+        // Order phpdoc tags by value.
+        'phpdoc_order_by_value' => ['annotations' => ['covers', 'throws']],
         // The type of `@return` annotations of methods returning a reference to itself must the configured one.
         'phpdoc_return_self_reference' => true,
         // Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`.
@@ -210,7 +270,18 @@ return PhpCsFixer\Config::create()
         // Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line.
         'phpdoc_separation' => true,
         // Single line `@var` PHPDoc should have proper spacing.
-        'phpdoc_single_line_var_spacing' => false,
+        'phpdoc_single_line_var_spacing' => true,
+        // Fixes casing of PHPDoc tags.
+        'phpdoc_tag_casing' => true,
+        // Would be neat, but breaks cases where the parents don't have annotations
+        // // EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0.
+        // 'phpdoc_to_param_type' => true,
+        // // EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4.
+        // 'phpdoc_to_property_type' => true,
+        // // EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0.
+        // 'phpdoc_to_return_type' => true,
+        // PHPDoc should start and end with content, excluding the very first and last line of the docblocks.
+        'phpdoc_trim' => true,
         // Removes extra blank lines after summary and after description in PHPDoc.
         'phpdoc_trim_consecutive_blank_line_separation' => true,
         // The correct case must be used for standard PHP types in PHPDoc.
@@ -219,8 +290,14 @@ return PhpCsFixer\Config::create()
         'phpdoc_types_order' => true,
         // `@var` and `@type` annotations must have type and name in the correct order.
         'phpdoc_var_annotation_correct_order' => true,
-        // Class names should match the file name.
+        // Converts `pow` to the `**` operator.
-        'psr4' => true,
+        'pow_to_exponentiation' => true,
+        // Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`.
+        'random_api_migration' => true,
+        // Callables must be called without using `call_user_func*` when possible.
+        'regular_callable_call' => true,
+        // Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method.
+        'return_assignment' => true,
         // There should be one or no space before colon, and one space after it in return type declarations, according to configuration.
         'return_type_declaration' => true,
         // Inside class or interface element `self` should be preferred to the class name itself.
@@ -233,18 +310,26 @@ return PhpCsFixer\Config::create()
         'short_scalar_cast' => true,
         // Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`).
         'simple_to_complex_string_variable' => true,
+        // Simplify `if` control structures that return the boolean result of their condition.
+        'simplified_if_return' => true,
+        // A return statement wishing to return `void` should not return `null`.
+        'simplified_null_return' => true,
+        // A PHP file without end tag must always end with a single empty line feed.
+        'single_blank_line_at_eof' => true,
         // There should be exactly one blank line before a namespace declaration.
         'single_blank_line_before_namespace' => true,
-        // There MUST be one use keyword per declaration.
-        'single_import_per_statement' => true,
         // There MUST NOT be more than one property or constant declared per statement.
         'single_class_element_per_statement' => true,
+        // There MUST be one use keyword per declaration.
+        'single_import_per_statement' => true,
         // Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block.
         'single_line_after_imports' => true,
         // Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax.
         'single_line_comment_style' => true,
         // Convert double quotes to single quotes for simple strings.
         'single_quote' => true,
+        // Ensures a single space after language constructs.
+        'single_space_after_construct' => true,
         // Each trait `use` must be done as single statement.
         'single_trait_insert_per_statement' => true,
         // Fix whitespace after a semicolon.
@@ -253,26 +338,41 @@ return PhpCsFixer\Config::create()
         'standardize_increment' => true,
         // Replace all `<>` with `!=`.
         'standardize_not_equals' => true,
+        // String tests for empty must be done against `''`, not with `strlen`.
+        'string_length_to_empty' => true,
         // A case should be followed by a colon and not a semicolon.
         'switch_case_semicolon_to_colon' => true,
         // Removes extra spaces between colon and case value.
         'switch_case_space' => true,
+        // Switch case must not be ended with `continue` but with `break`.
+        'switch_continue_to_break' => true,
         // Standardize spaces around ternary operator.
         'ternary_operator_spaces' => true,
-        // PHP multi-line arrays should have a trailing comma.
+        // Use the Elvis operator `?:` where possible.
-        'trailing_comma_in_multiline_array' => true,
+        'ternary_to_elvis_operator' => true,
+        // Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0.
+        'ternary_to_null_coalescing' => true,
+        // Multi-line arrays, arguments list and parameters list must have a trailing comma.
+        'trailing_comma_in_multiline' => ['after_heredoc' => true, 'elements' => ['arguments', 'arrays', 'parameters']],
+        // Arrays should be formatted like function/method arguments, without leading or trailing single line space.
+        'trim_array_spaces' => true,
+        // A single space or none should be around union type operator.
+        'types_spaces' => true,
         // Unary operators should be placed adjacent to their operands.
         'unary_operator_spaces' => true,
+        // Anonymous functions with one-liner return statement must use arrow functions.
+        'use_arrow_functions' => true,
         // Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility.
         'visibility_required' => true,
         // In array declaration, there MUST be a whitespace after each comma.
         'whitespace_after_comma_in_array' => true,
     ])
-    ->setFinder(PhpCsFixer\Finder::create()
+    ->setFinder(
-        ->exclude('vendor')
+        PhpCsFixer\Finder::create()
-        ->exclude('var')
+            ->exclude('vendor')
-        ->exclude('docker')
+            ->exclude('var')
-        ->exclude('src/Entity')
+            ->exclude('docker')
-        ->notPath('src/Core/DB/DefaultSettings.php')
+            ->exclude('src/Entity')
-        ->in(__DIR__)
+            ->notPath('src/Core/DB/DefaultSettings.php')
+            ->in(__DIR__),
     );

CREDITS.md

@@ -3,16 +3,22 @@ Credits for GNU social
 The following is an incomplete list of developers
 who've worked on GNU social, or its predecessors
 StatusNet and Free Social. Apologies for any
-oversight; please let mattl@gnu.org know if
+oversight; please let mail@diogo.site know if
 anyone's been overlooked in error.
 
 Current team
 ------------
 * Alexei Sorokin
-* Bruno Casteleiro
 * Diogo Cordeiro
+* Eliseu Amaro
 * Hugo Sales
 
+V2 team
+-------
+* Diogo Cordeiro
+* Alexei Sorokin
+* Bruno Casteleiro
+
 Additional Contributors
 -----------------------
 * Akio

DOCUMENTATION/SYSTEM_ADMINISTRATORS/CONFIGURE.md

@@ -491,7 +491,7 @@ For configuring the public stream.
     some kind of automated poster, testing bots, etc.
 
 * `exclude_sources` (array, default []): Sources of notices that should be kept off of
-    the public timeline (because they're from automatic posters, for instance).
+    the public feed (because they're from automatic posters, for instance).
 
 
 throttle

Makefile

@@ -1,5 +1,12 @@
+
 DIR=$(strip $(notdir $(CURDIR))) # Seems a bit hack-ish, but `basename` works differently
 
+translate-container-name = $$(if docker container inspect $(1) > /dev/null 2>&1; then echo $(1); else echo $(1) | sed 'y/_/-/' ; fi)
+args = `arg="$(filter-out $@,$(MAKECMDGOALS))" && echo $${arg:-${1}}`
+
+%:
+	@:
+
 .PHONY:
 	@if ! docker info > /dev/null; then echo "Docker does not seem to be running"; exit 1; fi
 
@@ -10,22 +17,106 @@ down: .PHONY
 	docker-compose down
 
 redis-shell:
-	docker exec -it $(strip $(DIR))_redis_1 sh -c 'redis-cli'
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_redis_1) sh -c 'redis-cli'
 
 php-repl: .PHONY
-	docker exec -it $(strip $(DIR))_php_1 sh -c '/var/www/social/bin/console psysh'
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) sh -c '/var/www/social/bin/console psysh'
 
 php-shell: .PHONY
-	docker exec -it $(strip $(DIR))_php_1 sh -c 'cd /var/www/social; sh'
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) sh -c 'cd /var/www/social; sh'
 
 psql-shell: .PHONY
-	docker exec -it $(strip $(DIR))_db_1 sh -c "psql -U postgres social"
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_db_1) sh -c "psql -U postgres social"
+
+database-force-nuke:
+	docker stop $(call translate-container-name,$(strip $(DIR))_worker_1) \
+	&& docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) sh -c "cd /var/www/social; bin/console doctrine:database:drop --force && bin/console doctrine:database:create && bin/console doctrine:schema:update --dump-sql --force && bin/console app:populate_initial_values" \
+	&& docker-compose up -d
 
 database-force-schema-update:
-	docker exec -it $(strip $(DIR))_php_1 sh -c "/var/www/social/bin/console doctrine:schema:update --dump-sql --force"
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) sh -c "/var/www/social/bin/console doctrine:schema:update --dump-sql --force"
 
-test: .PHONY
+tooling-docker: .PHONY
-	cd docker/testing && docker-compose run php; docker-compose down
+	@cd docker/tooling && docker-compose up -d --build > /dev/null 2>&1
 
-stop-test: .PHONY
+stop-tooling: .PHONY
-	cd docker/testing && docker-compose down
+	cd docker/tooling && docker-compose down
+
+tooling-php-shell: tooling-docker
+	docker exec -it $(call translate-container-name,tooling_php_1) sh
+
+test-accesibility: tooling-docker
+	cd docker/tooling && docker-compose run pa11y /accessibility.sh
+
+test: tooling-docker
+	docker exec $(call translate-container-name,tooling_php_1) /var/tooling/coverage.sh $(call args,'')
+
+cs-fixer: tooling-docker
+	@bin/php-cs-fixer $${CS_FIXER_FILE}
+
+doc-check: tooling-docker
+	bin/php-doc-check
+
+phpstan: tooling-docker
+	bin/phpstan
+
+remove-var:
+	rm -rf var/*
+
+remove-file:
+	sudo rm -rf file/*
+
+flush-redis-cache:
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_redis_1) sh -c 'redis-cli flushall'
+
+install-plugins:
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) /var/www/social/bin/install_plugins.sh
+
+update-dependencies:
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) sh -c 'cd /var/www/social && composer update'
+
+update-autocode:
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) sh -c 'cd /var/www/social && bin/update_autocode'
+
+backup-actors:
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_db_1) \
+	sh -c 'su postgres -c "mkdir -p /tmp/backup"' && \
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) \
+	sh -c "cd /var/www/social && bin/console doctrine:query:sql \"\
+	copy actor to '/tmp/backup/actor.csv';\
+	copy local_user to '/tmp/backup/local_user.csv';\
+	copy local_group to '/tmp/backup/local_group.csv';\
+	\
+	copy activitypub_actor to '/tmp/backup/ap_actor.csv';\
+	copy activitypub_rsa to '/tmp/backup/ap_rsa.csv';\
+	\
+	copy actor_subscription to '/tmp/backup/actor_subscription.csv';\
+	copy group_member to '/tmp/backup/group_member.csv';\
+	\
+	copy feed to '/tmp/backup/feed.csv';\
+	copy (SELECT 'ALTER SEQUENCE ' || c.relname || ' RESTART WITH ' || nextval(c.relname::regclass) || ';'\
+	FROM pg_class c WHERE c.relkind = 'S') to '/tmp/backup/sequences';\"" && \
+	mkdir -p /tmp/social-sql-backup && \
+	docker cp $(call translate-container-name,$(strip $(DIR))_db_1):/tmp/backup/. /tmp/social-sql-backup
+
+restore-actors:
+	docker cp /tmp/social-sql-backup/. $(call translate-container-name,$(strip $(DIR))_db_1):/tmp/backup
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_db_1) sh -c 'chown postgres /tmp/backup' && \
+	docker exec -it $(call translate-container-name,$(strip $(DIR))_php_1) \
+	sh -c "cd /var/www/social && bin/console doctrine:query:sql \"\
+	copy actor from '/tmp/backup/actor.csv';\
+	copy local_user from '/tmp/backup/local_user.csv';\
+	copy local_group from '/tmp/backup/local_group.csv';\
+	\
+	copy activitypub_actor from '/tmp/backup/ap_actor.csv';\
+	copy activitypub_rsa from '/tmp/backup/ap_rsa.csv';\
+	\
+	copy actor_subscription from '/tmp/backup/actor_subscription.csv';\
+	copy group_member from '/tmp/backup/group_member.csv';\
+	\
+	copy feed from '/tmp/backup/feed.csv';\
+	`cat /tmp/social-sql-backup/sequences`\""
+
+force-nuke-everything: down remove-var remove-file up flush-redis-cache database-force-nuke install-plugins
+
+force-delete-content: backup-actors force-nuke-everything restore-actors

bin/configure

@@ -47,7 +47,7 @@ Choose whether you prefer social to handle all the services it needs though dock
                        3>&1 1>&2 2>&3)
 validate_exit $?
 case ${SERVICES} in
-    'docker') DOCKER='"nginx" "certbot" "php" "db" "redis"' ;; # TODO enable and configure "mail"
+    'docker') DOCKER='"nginx" "certbot" "php" "db" "redis" "worker"' ;; # TODO enable and configure "mail"
     'mixed')
         DOCKER=$(${WHIPTAIL} --title 'GNU social Docker services' --clear --backtitle 'GNU social' \
                              --checklist "\nPick which of the following services you'd like to add to docker-compose.\n* indicates a service that has extra configuration" 0 0 0 \
@@ -57,6 +57,7 @@ case ${SERVICES} in
                              db 'Configure a DBMS*' on \
                              redis 'Configure Redis (optional, recommended)' on \
                              mail 'Confugure a mail server*' on \
+                             worker 'Confugure container with worker queues' on \
                              3>&1 1>&2 2>&3)
         validate_exit $?
         ;;
@@ -141,6 +142,7 @@ fi
 if echo "${DOCKER}" | grep -Fq '"php"'; then
     ${WHIPTAIL} --title "Build PHP container locally?" --clear --backtitle 'GNU social' \
                 --yesno "\nDo you want to compile the needed PHP extensions and build the container locally? (May provide better performance but requires more than 1GiB of RAM)" 0 0 \
+                --defaultno \
                 3>&1 1>&2 2>&3
     BUILD_PHP=$((1-$?)) # Invert output
 fi
@@ -226,7 +228,7 @@ PROFILE=$(${WHIPTAIL} --title 'GNU social site profile' --clear --backtitle 'GNU
                       public 'Make this node publicly accessible, with open registration' \
                       community 'Make this node publicly accessible, but with invite-only registration' \
                       isolated 'Make this node publicly accessible, with open registration but do not federate' \
-                      private 'Make this node publicly accessible, but with invite-only registration, only registered users can see timelines' \
+                      private 'Make this node publicly accessible, but with invite-only registration, only registered users can see feeds' \
                       single_user 'Like public, but only allows registering one user' \
                       3>&1 1>&2 2>&3)
 validate_exit $?
@@ -350,8 +352,8 @@ SOCIAL_DBMS=${DBMS}
 SOCIAL_DB=${DB_NAME}
 SOCIAL_USER=${DB_USER}
 SOCIAL_PASSWORD=${DB_PASSWORD}
-SOCIAL_DOMAIN=${DOMAIN}
+CONFIG_DOMAIN=${DOMAIN}
-SOCIAL_NODE_NAME=${NODE_NAME}
+CONFIG_NODE_NAME=${NODE_NAME}
 SOCIAL_ADMIN_EMAIL=${EMAIL}
 SOCIAL_SITE_PROFILE=${PROFILE}
 MAILER_DSN=${MAILER_DSN}

bin/fix_license

@@ -8,11 +8,9 @@ require INSTALLDIR . '/vendor/autoload.php';
 
 use Functional as F;
 
-use App\Util\Functional;
-
 $filenames = glob(INSTALLDIR . '/src/*/*.php');
 
-$files = F\map($filenames, Functional::arity('file_get_contents', 1));
+$files = F\map($filenames, F\ary('file_get_contents', 1));
 
 $old_licenses = ['/* {{{ License
  * This file is part of GNU social - https://www.gnu.org/software/social

bin/generate_entity_diagrams

@@ -51,7 +51,7 @@ foreach ($files as $file) {
     foreach ($schema['fields'] as $field => $opts) {
         if (isset($opts['foreign key'])) {
             [$foreign_entity, $foreign_key] = explode('.', $opts['target']);
-            $foreign_table = Formatting::camelCaseToSnakeCase(preg_replace('/GSActor/', 'gsactor', $foreign_entity));
+            $foreign_table = Formatting::camelCaseToSnakeCase(preg_replace('/Actor/', 'actor', $foreign_entity));
             $edges[]     = "{$table}:{$field} -- {$foreign_table}:{$foreign_key}";
         }
     }

bin/install_plugins.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+for plugin in plugins/*; do
+    install="${plugin}/bin/install.sh"
+    if [ -x "${install}" ]; then
+        ( # subshell, to clear options/environment
+            set -x
+            "${install}"
+        )
+    fi
+done

bin/php-cs-fixer

@@ -1 +0,0 @@
-../vendor/bin/php-cs-fixer

bin/php-cs-fixer

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+. bin/translate_container_name.sh
+
+if [ "$#" -eq 0 ] || [ -z "$*" ]; then
+    docker exec "$(translate_container_name tooling_php_1)" /var/www/social/vendor/bin/php-cs-fixer -n --config=".php-cs-fixer.php" fix
+else
+    docker exec "$(translate_container_name tooling_php_1)" sh -c "/var/www/social/vendor/bin/php-cs-fixer -q -n --config=\".php-cs-fixer.php\" fix --path-mode=intersection -- $*"
+fi

bin/php-doc-check

@@ -1 +0,0 @@
-../vendor/bin/php-doc-check

bin/php-doc-check

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+. bin/translate_container_name.sh
+
+docker exec -it "$(translate_container_name tooling_php_1)" /var/www/social/vendor/bin/php-doc-check src components plugins

bin/phpstan

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+. bin/translate_container_name.sh
+
+docker exec "$(translate_container_name tooling_php_1)" /var/tooling/phpstan.sh "$@"

bin/pre-commit

@@ -1,28 +1,32 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
 root="$(git rev-parse --show-toplevel)"
 
-# get the list of changed files
+# get the list of changed files that didn't get only partially added
 staged_files="$(git status --porcelain | sed -rn "s/^[^ ][ ] (.*)/\1/p")"
 
-echo "Running php-cs-fixer on edited files"
+if (! (: "${SKIP_ALL?}") 2>/dev/null) && (! (: "${SKIP_CS_FIX?}") 2>/dev/null); then
-
+    echo "Running php-cs-fixer on edited files"
-for staged in ${staged_files}; do
+    for staged in ${staged_files}; do
-    # work only with existing files
+        # work only with existing files
-    if [ -f "${staged}" ] && [[ "${staged}" = *.php ]]
+        if [ -f "${staged}" ] && expr "${staged}" : '^.*\.php$' > /dev/null;  then
-    then
+            # use php-cs-fixer and get flag of correction
-        # use php-cs-fixer and get flag of correction
+            CS_FIXER_FILE="${staged}" make cs-fixer
-        if "${root}/bin/php-cs-fixer" -q fix "${staged}"
+            git add "${staged}"
-        then
-            git add "${staged}" # execute git add directly
         fi
+    done
+fi
+
+if (! (: "${SKIP_ALL?}") 2>/dev/null) && (! (: "${SKIP_DOC_CHECK?}") 2>/dev/null); then
+    if echo "${staged_files}" | grep -F ".php" > /dev/null 2>&1; then
+        echo "Running php-doc-checker"
+        make doc-check < /dev/tty
     fi
-done
+fi
 
-echo "Running php-doc-checker"
+if (! (: "${SKIP_ALL?}") 2>/dev/null) && (! (: "${SKIP_PHPSTAN?}") 2>/dev/null); then
-
+    echo "Running phpstan"
-if echo "${staged_files}" | grep -F ".php"; then
+    make phpstan
-    "${root}/bin/php-doc-check" src plugins components
 fi
 
 # Only commit if there wasn't an error

bin/translate_container_name.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+translate_container_name () {
+    if docker container inspect "$1" > /dev/null 2>&1; then
+        echo "$1"
+    else
+        echo "$1" | sed 'y/_/-/'
+    fi
+}

bin/update-dependencies

@@ -0,0 +1,38 @@
+#!/usr/bin/env php
+<?php
+/**
+ * Raise/update static version numbers in composer.json.
+ *
+ * Run on the CLI: "composer outdated --direct > outdated.txt"
+ */
+$composerJson = json_decode(file_get_contents('composer.json'), true);
+
+system('composer outdated --direct > outdated.txt');
+$listOfOutdatedPackages = file('outdated.txt');
+
+foreach($listOfOutdatedPackages as $line) {
+
+    $regexp = '/(?P<package>[\w]+\/[\w]+).*(?P<currentVersion>\d.\d.\d).*(?P<latestVersion>\d.\d.\d)/';
+    preg_match($regexp, $line, $matches);
+    $matches = array_filter($matches, 'is_string', ARRAY_FILTER_USE_KEY);
+
+    if(isset($matches['package']))
+    {
+        $package = $matches['package'];
+
+        if(isset($composerJson['require'][$package]))
+        {
+            $currentVersion = $composerJson['require'][$package];
+            echo sprintf('Updating %s from %s to %s', $package, $currentVersion, $matches['latestVersion']);
+            $composerJson['require'][$package] = $matches['latestVersion'];
+        }
+        if(isset($composerJson['require-dev'][$package]))
+        {
+            $currentVersion = $composerJson['require-dev'][$package];
+            echo sprintf('Updating %s from %s to %s', $package, $currentVersion, $matches['latestVersion']);
+            $composerJson['require-dev'][$package] = $matches['latestVersion'];
+        }
+    }
+}
+
+file_put_contents('composer.json', json_encode($composerJson, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));

bin/update_autocode

@@ -1,4 +1,4 @@
-#!/usr/local/bin/php
+#!/usr/bin/env php
 <?php
 
 use Symfony\Component\Yaml\Yaml;
@@ -20,25 +20,23 @@ const types = [
     'text'         => 'string',
     'varchar'      => 'string',
     'phone_number' => 'PhoneNumber',
+    'float'        => 'float', // TODO REMOVE THIS
 ];
 
 $files = array_merge(glob(ROOT . '/src/Entity/*.php'),
                      array_merge(glob(ROOT . '/components/*/Entity/*.php'),
                                  glob(ROOT . '/plugins/*/Entity/*.php')));
 
-$classes = [];
+$nullable_no_defaults_warning = [];
 
 foreach ($files as $file) {
 
     require_once $file;
 
-    $declared = get_declared_classes();
+    $class = str_replace(['/', 'src', 'components', 'plugins'], ['\\', 'App', 'Component', 'Plugin'], substr($file, strlen(ROOT) + 1, -4));
-    foreach ($declared as $dc) {
+
-        if (preg_match('/(App|(Component|Plugin)\\\\[^\\\\]+)\\\\Entity/', $dc) && !in_array($dc, $classes)) {
+    if (!method_exists($class, 'schemaDef')) {
-            $class = $dc;
+        continue;
-            $classes[] = $class;
-            break;
-        }
     }
 
     $no_ns_class  = preg_replace('/.*?\\\\/', '', $class);
@@ -47,16 +45,32 @@ foreach ($files as $file) {
     $fields_code  = [];
     $methods_code = [];
     foreach ($fields as $field) {
-        $nullable       = !@$schema['fields'][$field]['not null'] ? '?' : '';
+        $field_schema   = $schema['fields'][$field];
-        $type           = types[$schema['fields'][$field]['type']];
+        $nullable       = ($field_schema['not null'] ?? false) ? '' : '?';
+        $type           = types[$field_schema['type']];
         $type           = $type !== '' ? $nullable . $type : $type;
-        $method_name    = str_replace([' ', 'Gsactor'], ['', 'GSActor'], ucwords(str_replace('_', ' ', $field)));
+        $method_name    = str_replace([' ', 'actor'], ['', 'Actor'], ucwords(str_replace('_', ' ', $field)));
-        $default        = @$schema['fields'][$field]['default'];
+        $length         = $field_schema['length'] ?? null;
 
-        if (isset($default) && $nullable != '?' && $type != '\DateTimeInterface') {
+        $field_setter = "\${$field}";
-            if (is_string($default)) {
+        if (\is_int($length)) {
+            if ($nullable === '?') {
+                $field_setter = "\is_null(\${$field}) ? null : \mb_substr(\${$field}, 0, $length)";
+            } else {
+                $field_setter = "\mb_substr(\${$field}, 0, $length)";
+            }
+        }
+
+        if (($nullable === '?' || \array_key_exists('default', $field_schema)) && $type != '\DateTimeInterface') {
+            if (!\array_key_exists('default', $field_schema)) {
+                $nullable_no_defaults_warning[] = "{$class}::{$field}";
+            }
+            $default = $field_schema['default'] ?? null;
+            if (\is_string($default)) {
                 $default = "'{$default}'";
-            } elseif ($type == 'bool') {
+            } elseif (\is_null($default)) {
+                $default = "null";
+            } elseif ($type === 'bool' || $type === '?bool') {
                 $default = $default ? 'true' : 'false';
             }
 
@@ -66,13 +80,13 @@ foreach ($files as $file) {
         }
 
         $methods_code[] = "    public function set{$method_name}({$type} \${$field}): self" .
-                        "\n    {\n        \$this->{$field} = \${$field};\n        return \$this;\n    }" . "\n\n" .
+                        "\n    {\n        \$this->{$field} = {$field_setter};\n        return \$this;\n    }" . "\n\n" .
                         "    public function get{$method_name}()" . ($type !== '' ? ": {$type}" : '') .
                         "\n    {\n        return \$this->{$field};\n    }" . "\n";
     }
 
     $fields_code  = implode("\n", $fields_code);
-    $methods_code = implode("\n", $methods_code) . "\n";
+    $methods_code = implode("\n", $methods_code);
 
     $begin = '// {{{ Autocode';
     $end   = '// }}} Autocode';
@@ -91,7 +105,13 @@ foreach ($files as $file) {
     }
 
     $in_file  = file_get_contents($file);
-    $out_file = preg_replace("/\\s*{$begin}[^\\/]*{$end}/m", $code, $in_file);
+    $out_file = preg_replace("%\\s*{$begin}.*{$end}%smu", $code, $in_file);
-
     file_put_contents($file, $out_file);
 }
+
+if (!empty($nullable_no_defaults_warning)) {
+    echo "Warning: The following don't have a default value, but we're assigning it `null`. Doctrine might not like this, so update it\n";
+    foreach ($nullable_no_defaults_warning as $n) {
+        echo "    {$n}\n";
+    }
+}

components/Attachment/Attachment.php

@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+namespace Component\Attachment;
+
+use App\Core\Cache;
+use App\Core\DB;
+use App\Core\Event;
+use App\Core\Modules\Component;
+use App\Core\Router;
+use App\Entity\Actor;
+use App\Entity\Note;
+use App\Util\Formatting;
+use Component\Attachment\Controller as C;
+use Component\Attachment\Entity as E;
+use Doctrine\Common\Collections\ExpressionBuilder;
+use Doctrine\ORM\Query\Expr;
+use Doctrine\ORM\QueryBuilder;
+
+class Attachment extends Component
+{
+    public function onAddRoute(Router $r): bool
+    {
+        $r->connect('note_attachment_show', '/object/note/{note_id<\d+>}/attachment/{attachment_id<\d+>}', [C\Attachment::class, 'attachmentShowWithNote']);
+        $r->connect('note_attachment_view', '/object/note/{note_id<\d+>}/attachment/{attachment_id<\d+>}/view', [C\Attachment::class, 'attachmentViewWithNote']);
+        $r->connect('note_attachment_download', '/object/note/{note_id<\d+>}/attachment/{attachment_id<\d+>}/download', [C\Attachment::class, 'attachmentDownloadWithNote']);
+        $r->connect('note_attachment_thumbnail', '/object/note/{note_id<\d+>}/attachment/{attachment_id<\d+>}/thumbnail/{size<big|medium|small>}', [C\Attachment::class, 'attachmentThumbnailWithNote']);
+        return Event::next;
+    }
+
+    /**
+     * Get a unique representation of a file on disk
+     *
+     * This can be used in the future to deduplicate images by visual content
+     */
+    public function onHashFile(string $filename, ?string &$out_hash): bool
+    {
+        $out_hash = hash_file(E\Attachment::FILEHASH_ALGO, $filename);
+        return Event::stop;
+    }
+
+    public function onNoteDeleteRelated(Note &$note, Actor $actor): bool
+    {
+        Cache::delete("note-attachments-{$note->getId()}");
+        foreach ($note->getAttachments() as $attachment) {
+            $attachment->kill();
+        }
+        DB::wrapInTransaction(fn () => E\AttachmentToNote::removeWhereNoteId($note->getId()));
+        Cache::delete("note-attachments-{$note->getId()}");
+        return Event::next;
+    }
+
+    public function onCollectionQueryAddJoins(QueryBuilder &$note_qb, QueryBuilder &$actor_qb): bool
+    {
+        if (!\in_array('attachment_to_note', $note_qb->getAllAliases())) {
+            $note_qb->leftJoin(
+                join: E\AttachmentToNote::class,
+                alias: 'attachment_to_note',
+                conditionType: Expr\Join::WITH,
+                condition: 'note.id = attachment_to_note.note_id',
+            );
+        }
+        return Event::next;
+    }
+
+    /**
+     * Populate $note_expr with the criteria for looking for notes with attachments
+     */
+    public function onCollectionQueryCreateExpression(ExpressionBuilder $eb, string $term, ?string $locale, ?Actor $actor, &$note_expr, &$actor_expr): bool
+    {
+        $include_term = str_contains($term, ':') ? explode(':', $term)[1] : $term;
+        if (Formatting::startsWith($term, ['note-types:', 'notes-incude:', 'note-filter:'])) {
+            if (\is_null($note_expr)) {
+                $note_expr = [];
+            }
+            if (array_intersect(explode(',', $include_term), ['media', 'image', 'images', 'attachment']) !== []) {
+                $note_expr[] = $eb->neq('attachment_to_note.note_id', null);
+            } else {
+                $note_expr[] = $eb->eq('attachment_to_note.note_id', null);
+            }
+        }
+        return Event::next;
+    }
+}

components/Attachment/Controller/Attachment.php

@@ -0,0 +1,180 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Attachment\Controller;
+
+use App\Core\Controller;
+use App\Core\DB;
+use App\Core\Event;
+use App\Core\GSFile;
+use function App\Core\I18n\_m;
+use App\Entity\Note;
+use App\Util\Common;
+use App\Util\Exception\ClientException;
+use App\Util\Exception\NoSuchFileException;
+use App\Util\Exception\NotFoundException;
+use App\Util\Exception\ServerException;
+use Component\Attachment\Entity\AttachmentThumbnail;
+use Component\Attachment\Entity\AttachmentToNote;
+use Symfony\Component\HttpFoundation\HeaderUtils;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Mime\MimeTypes;
+
+class Attachment extends Controller
+{
+    /**
+     * Generic function that handles getting a representation for an attachment
+     */
+    private function attachment(int $attachment_id, Note|int $note, callable $handle)
+    {
+        $attachment = DB::findOneBy('attachment', ['id' => $attachment_id]);
+        $note       = \is_int($note) ? Note::getById($note) : $note;
+
+        // Before anything, two very important things!
+        // first: ensure this attachment is associated with this note
+        if (DB::count(AttachmentToNote::class, ['attachment_id' => $attachment->getId(), 'note_id' => $note->getId()]) <= 0) {
+            throw new ClientException(_m('No such attachment.'), 404);
+        }
+        // second: ensure proper scope
+        if (!$note->isVisibleTo(Common::actor())) {
+            throw new ClientException(_m('You don\'t have permissions to view this attachment.'), 401);
+        }
+
+        $res = null;
+        if (Event::handle('AttachmentFileInfo', [$attachment, $note, &$res]) !== Event::stop) {
+            // If no one else claims this attachment, use the default representation
+            try {
+                $res = GSFile::getAttachmentFileInfo($attachment_id);
+            } catch (NoSuchFileException $e) {
+                // Continue below
+            }
+        }
+
+        if (empty($res)) {
+            throw new ClientException(_m('No such attachment'), 404);
+        } else {
+            if (!\array_key_exists('filepath', $res)) {
+                // @codeCoverageIgnoreStart
+                throw new ServerException('This attachment is not stored locally.');
+            // @codeCoverageIgnoreEnd
+            } else {
+                $res['attachment'] = $attachment;
+                $res['note']       = $note;
+                $res['title']      = $attachment->getBestTitle($note);
+                return $handle($res);
+            }
+        }
+    }
+
+    /**
+     * The page where the attachment and it's info is shown
+     */
+    public function attachmentShowWithNote(Request $request, int $note_id, int $attachment_id)
+    {
+        try {
+            return $this->attachment($attachment_id, $note_id, function ($res) use ($note_id, $attachment_id) {
+                return [
+                    '_template'        => 'attachment/view.html.twig',
+                    'download'         => $res['attachment']->getDownloadUrl(note: $note_id),
+                    'title'            => $res['title'],
+                    'attachment'       => $res['attachment'],
+                    'note'             => $res['note'],
+                    'right_panel_vars' => ['attachment_id' => $attachment_id, 'note_id' => $note_id],
+                ];
+            });
+        } catch (NotFoundException) {
+            throw new ClientException(_m('No such attachment.'), 404);
+        }
+    }
+
+    /**
+     * Display the attachment inline
+     */
+    public function attachmentViewWithNote(Request $request, int $note_id, int $attachment_id)
+    {
+        return $this->attachment(
+            $attachment_id,
+            $note_id,
+            fn (array $res) => GSFile::sendFile(
+                $res['filepath'],
+                $res['mimetype'],
+                GSFile::ensureFilenameWithProperExtension($res['title'], $res['mimetype']) ?? $res['filename'],
+                HeaderUtils::DISPOSITION_INLINE,
+            ),
+        );
+    }
+
+    public function attachmentDownloadWithNote(Request $request, int $note_id, int $attachment_id)
+    {
+        return $this->attachment(
+            $attachment_id,
+            $note_id,
+            fn (array $res) => GSFile::sendFile(
+                $res['filepath'],
+                $res['mimetype'],
+                GSFile::ensureFilenameWithProperExtension($res['title'], $res['mimetype']) ?? $res['filename'],
+                HeaderUtils::DISPOSITION_ATTACHMENT,
+            ),
+        );
+    }
+
+    /**
+     * Controller to produce a thumbnail for a given attachment id
+     *
+     * @param int $attachment_id Attachment ID
+     *
+     * @throws \App\Util\Exception\DuplicateFoundException
+     * @throws ClientException
+     * @throws NotFoundException
+     * @throws ServerException
+     */
+    public function attachmentThumbnailWithNote(Request $request, int $note_id, int $attachment_id, string $size = 'small'): Response
+    {
+        $attachment = DB::findOneBy('attachment', ['id' => $attachment_id]);
+        $note       = Note::getById($note_id);
+
+        // Before anything, two very important things!
+        // first: ensure this attachment is associated with this note
+        if (DB::count(AttachmentToNote::class, ['attachment_id' => $attachment->getId(), 'note_id' => $note->getId()]) <= 0) {
+            throw new ClientException(_m('No such attachment.'), 404);
+        }
+        // second: ensure proper scope
+        if (!$note->isVisibleTo(Common::actor())) {
+            throw new ClientException(_m('You don\'t have permissions to view this attachment.'), 401);
+        }
+
+        $crop = Common::config('thumbnail', 'smart_crop');
+
+        $thumbnail = AttachmentThumbnail::getOrCreate(attachment: $attachment, size: $size, crop: $crop);
+        if (\is_null($thumbnail)) {
+            throw new ClientException(_m('Can not generate thumbnail for attachment with id={id}', ['id' => $attachment->getId()]));
+        }
+
+        $filename = $thumbnail->getFilename();
+        $path     = $thumbnail->getPath();
+        $mimetype = $thumbnail->getMimetype();
+
+        return GSFile::sendFile(filepath: $path, mimetype: $mimetype, output_filename: $filename . '.' . MimeTypes::getDefault()->getExtensions($mimetype)[0], disposition: HeaderUtils::DISPOSITION_INLINE);
+    }
+}

components/Attachment/Entity/ActorToAttachment.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -17,8 +19,9 @@
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
 // }}}
 
-namespace App\Entity;
+namespace Component\Attachment\Entity;
 
+use App\Core\DB;
 use App\Core\Entity;
 use DateTimeInterface;
 
@@ -32,13 +35,13 @@ use DateTimeInterface;
  * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
  * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
  */
-class GSActorToAttachment extends Entity
+class ActorToAttachment extends Entity
 {
     // {{{ Autocode
     // @codeCoverageIgnoreStart
     private int $attachment_id;
-    private int $gsactor_id;
+    private int $actor_id;
-    private \DateTimeInterface $modified;
+    private DateTimeInterface $modified;
 
     public function setAttachmentId(int $attachment_id): self
     {
@@ -51,15 +54,15 @@ class GSActorToAttachment extends Entity
         return $this->attachment_id;
     }
 
-    public function setGSActorId(int $gsactor_id): self
+    public function setActorId(int $actor_id): self
     {
-        $this->gsactor_id = $gsactor_id;
+        $this->actor_id = $actor_id;
         return $this;
     }
 
-    public function getGSActorId(): int
+    public function getActorId(): int
     {
-        return $this->gsactor_id;
+        return $this->actor_id;
     }
 
     public function setModified(DateTimeInterface $modified): self
@@ -76,19 +79,53 @@ class GSActorToAttachment extends Entity
     // @codeCoverageIgnoreEnd
     // }}} Autocode
 
+    public static function removeWhereAttachmentId(int $attachment_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM actor_to_attachment ata
+                WHERE ata.attachment_id = :attachment_id
+                EOF,
+            ['attachment_id' => $attachment_id],
+        );
+    }
+
+    public static function removeWhere(int $attachment_id, int $actor_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM actor_to_attachment ata
+                WHERE (ata.attachment_id = :attachment_id
+                           OR ata.actor_id = :actor_id)
+                EOF,
+            ['attachment_id' => $attachment_id, 'actor_id' => $actor_id],
+        );
+    }
+
+    public static function removeWhereActorId(int $actor_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM actor_to_attachment ata
+                WHERE ata.actor_id = :actor_id
+                EOF,
+            ['actor_id' => $actor_id],
+        );
+    }
+
     public static function schemaDef(): array
     {
         return [
-            'name'   => 'gsactor_to_attachment',
+            'name'   => 'actor_to_attachment',
             'fields' => [
                 'attachment_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Attachment.id', 'multiplicity' => 'one to one', 'name' => 'attachment_to_note_attachment_id_fkey', 'not null' => true, 'description' => 'id of attachment'],
-                'gsactor_id'    => ['type' => 'int', 'foreign key' => true, 'target' => 'GSActor.id', 'multiplicity' => 'one to one', 'name' => 'attachment_to_note_note_id_fkey', 'not null' => true, 'description' => 'id of the note it belongs to'],
+                'actor_id'      => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'name' => 'attachment_to_note_note_id_fkey', 'not null' => true, 'description' => 'id of the note it belongs to'],
                 'modified'      => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
             ],
-            'primary key' => ['attachment_id', 'gsactor_id'],
+            'primary key' => ['attachment_id', 'actor_id'],
             'indexes'     => [
                 'attachment_id_idx' => ['attachment_id'],
-                'gsactor_id_idx'    => ['gsactor_id'],
+                'actor_id_idx'      => ['actor_id'],
             ],
         ];
     }

components/Attachment/Entity/Attachment.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 
 // This file is part of GNU social - https://www.gnu.org/software/social
@@ -19,16 +21,21 @@
 
 // }}}
 
-namespace App\Entity;
+namespace Component\Attachment\Entity;
 
-use App\Core\DB\DB;
+use App\Core\Cache;
+use App\Core\DB;
 use App\Core\Entity;
+use App\Core\Event;
 use App\Core\GSFile;
 use function App\Core\I18n\_m;
 use App\Core\Log;
-use App\Core\Router\Router;
+use App\Core\Router;
+use App\Entity\Note;
 use App\Util\Common;
+use App\Util\Exception\ClientException;
 use App\Util\Exception\DuplicateFoundException;
+use App\Util\Exception\NoSuchFileException;
 use App\Util\Exception\NotFoundException;
 use App\Util\Exception\ServerException;
 use DateTimeInterface;
@@ -53,13 +60,13 @@ class Attachment extends Entity
     // {{{ Autocode
     // @codeCoverageIgnoreStart
     private int $id;
-    private int $lives = 1;
+    private int $lives        = 1;
-    private ?string $filehash;
+    private ?string $filehash = null;
-    private ?string $mimetype;
+    private ?string $mimetype = null;
-    private ?string $filename;
+    private ?string $filename = null;
-    private ?int $size;
+    private ?int $size        = null;
-    private ?int $width;
+    private ?int $width       = null;
-    private ?int $height;
+    private ?int $height      = null;
     private DateTimeInterface $modified;
 
     public function setId(int $id): self
@@ -73,25 +80,20 @@ class Attachment extends Entity
         return $this->id;
     }
 
-    /**
+    public function setLives(int $lives): self
-     * @return int
+    {
-     */
+        $this->lives = $lives;
+        return $this;
+    }
+
     public function getLives(): int
     {
         return $this->lives;
     }
 
-    /**
-     * @param int $lives
-     */
-    public function setLives(int $lives): void
-    {
-        $this->lives = $lives;
-    }
-
     public function setFilehash(?string $filehash): self
     {
-        $this->filehash = $filehash;
+        $this->filehash = \is_null($filehash) ? null : mb_substr($filehash, 0, 64);
         return $this;
     }
 
@@ -102,7 +104,7 @@ class Attachment extends Entity
 
     public function setMimetype(?string $mimetype): self
     {
-        $this->mimetype = $mimetype;
+        $this->mimetype = \is_null($mimetype) ? null : mb_substr($mimetype, 0, 255);
         return $this;
     }
 
@@ -113,7 +115,7 @@ class Attachment extends Entity
 
     public function setFilename(?string $filename): self
     {
-        $this->filename = $filename;
+        $this->filename = \is_null($filename) ? null : mb_substr($filename, 0, 191);
         return $this;
     }
 
@@ -172,44 +174,36 @@ class Attachment extends Entity
     public function getMimetypeMajor(): ?string
     {
         $mime = $this->getMimetype();
-        return is_null($mime) ? $mime : GSFile::mimetypeMajor($mime);
+        return \is_null($mime) ? $mime : GSFile::mimetypeMajor($mime);
     }
 
     public function getMimetypeMinor(): ?string
     {
         $mime = $this->getMimetype();
-        return is_null($mime) ? $mime : GSFile::mimetypeMinor($mime);
+        return \is_null($mime) ? $mime : GSFile::mimetypeMinor($mime);
     }
 
-    /**
-     * @return int
-     */
     public function livesIncrementAndGet(): int
     {
         ++$this->lives;
         return $this->lives;
     }
 
-    /**
-     * @return int
-     */
     public function livesDecrementAndGet(): int
     {
         --$this->lives;
         return $this->lives;
     }
 
-    const FILEHASH_ALGO = 'sha256';
+    public const FILEHASH_ALGO = 'sha256';
 
     /**
      * Delete a file if safe, removes dependencies, cleanups and flushes
-     *
-     * @return bool
      */
     public function kill(): bool
     {
         if ($this->livesDecrementAndGet() <= 0) {
-            return $this->delete();
+            return DB::wrapInTransaction(fn () => $this->delete());
         }
         return true;
     }
@@ -219,7 +213,7 @@ class Attachment extends Entity
      */
     public function deleteStorage(): bool
     {
-        if (!is_null($filepath = $this->getPath())) {
+        if (!\is_null($filepath = $this->getPath())) {
             if (file_exists($filepath)) {
                 if (@unlink($filepath) === false) {
                     // @codeCoverageIgnoreStart
@@ -230,8 +224,7 @@ class Attachment extends Entity
                     $this->setFilename(null);
                     $this->setSize(null);
                     // Important not to null neither width nor height
-                    DB::persist($this);
+                    DB::wrapInTransaction(fn () => DB::persist($this));
-                    DB::flush();
                 }
             } else {
                 // @codeCoverageIgnoreStart
@@ -244,24 +237,44 @@ class Attachment extends Entity
 
     /**
      * Attachment delete always removes dependencies, cleanups and flushes
+     * WARNING: Wrap this function in a transaction!
+     *
+     * @see kill() It's more likely that you want to use that rather than call delete directly
      */
     protected function delete(): bool
     {
+        // Friendly warning because the caller usually doesn't want to delete an attachment that is still referred elsewhere
         if ($this->getLives() > 0) {
             // @codeCoverageIgnoreStart
-            Log::warning("Deleting file {$this->getId()} with {$this->getLives()} lives. Why are you killing it so young?");
+            Log::warning("Deleting file {$this->getId()} with {$this->getLives()} lives. Why are you killing it so old?");
             // @codeCoverageIgnoreEnd
         }
-        // Delete related files from storage
+
+        // Collect files starting with the one associated with this attachment
         $files = [];
-        if (!is_null($filepath = $this->getPath())) {
+        if (!\is_null($filepath = $this->getPath())) {
             $files[] = $filepath;
         }
+
+        // Collect thumbnail files and delete thumbnails
         foreach ($this->getThumbnails() as $at) {
             $files[] = $at->getPath();
             $at->delete(flush: false);
         }
+
+        // Delete eventual remaining relations with Actors
+        ActorToAttachment::removeWhereAttachmentId($this->getId());
+
+        // Delete eventual remaining relations with Notes
+        AttachmentToNote::removeWhereAttachmentId($this->getId());
+
+        // Delete eventual remaining relations with Links
+        AttachmentToLink::removeWhereAttachmentId($this->getId());
+
+        // Remove this attachment
         DB::remove($this);
+
+        // Delete the files from disk
         foreach ($files as $f) {
             if (file_exists($f)) {
                 if (@unlink($f) === false) {
@@ -275,6 +288,8 @@ class Attachment extends Entity
                 // @codeCoverageIgnoreEnd
             }
         }
+
+        // Flush these changes as we have deleted the files from disk
         DB::flush();
         return true;
     }
@@ -282,28 +297,35 @@ class Attachment extends Entity
     /**
      * TODO: Maybe this isn't the best way of handling titles
      *
-     * @param null|Note $note
-     *
      * @throws DuplicateFoundException
      * @throws NotFoundException
      * @throws ServerException
-     *
-     * @return string
      */
     public function getBestTitle(?Note $note = null): string
     {
         // If we have a note, then the best title is the title itself
-        if (!is_null(($note))) {
+        if (!\is_null(($note))) {
-            $attachment_to_note = DB::findOneBy('attachment_to_note', [
+            $title = Cache::get('attachment-title-' . $this->getId() . '-' . $note->getId(), function () use ($note) {
-                'attachment_id' => $this->getId(),
+                try {
-                'note_id'       => $note->getId(),
+                    $attachment_to_note = DB::findOneBy('attachment_to_note', [
-            ]);
+                        'attachment_id' => $this->getId(),
-            if (!is_null($attachment_to_note->getTitle())) {
+                        'note_id'       => $note->getId(),
-                return $attachment_to_note->getTitle();
+                    ]);
+                    if (!\is_null($attachment_to_note->getTitle())) {
+                        return $attachment_to_note->getTitle();
+                    }
+                } catch (NotFoundException) {
+                    $title = null;
+                    Event::handle('AttachmentGetBestTitle', [$this, $note, &$title]);
+                    return $title;
+                }
+            });
+            if ($title != null) {
+                return $title;
             }
         }
         // Else
-        if (!is_null($filename = $this->getFilename())) {
+        if (!\is_null($filename = $this->getFilename())) {
             // A filename would do just as well
             return $filename;
         } else {
@@ -317,23 +339,51 @@ class Attachment extends Entity
      */
     public function getThumbnails()
     {
-        return DB::findBy('attachment_thumbnail', ['attachment_id' => $this->id]);
+        return DB::findBy(
+            AttachmentThumbnail::class,
+            ['attachment_id' => $this->id],
+            order_by: ['size' => 'ASC', 'mimetype' => 'ASC'],
+        );
     }
 
     public function getPath()
     {
         $filename = $this->getFilename();
-        return is_null($filename) ? null : Common::config('attachments', 'dir') . DIRECTORY_SEPARATOR . $filename;
+        return \is_null($filename) ? null : Common::config('attachments', 'dir') . \DIRECTORY_SEPARATOR . $filename;
     }
 
-    public function getUrl()
+    public function getUrl(Note|int $note, int $type = Router::ABSOLUTE_URL): string
     {
-        return Router::url('attachment_view', ['id' => $this->getId()]);
+        return Router::url(id: 'note_attachment_view', args: ['note_id' => \is_int($note) ? $note : $note->getId(), 'attachment_id' => $this->getId()], type: $type);
     }
 
-    public function getThumbnailUrl()
+    public function getShowUrl(Note|int $note, int $type = Router::ABSOLUTE_URL): string
     {
-        return Router::url('attachment_thumbnail', ['id' => $this->getId(), 'w' => Common::config('thumbnail', 'width'), 'h' => Common::config('thumbnail', 'height')]);
+        return Router::url(id: 'note_attachment_show', args: ['note_id' => \is_int($note) ? $note : $note->getId(), 'attachment_id' => $this->getId()], type: $type);
+    }
+
+    public function getDownloadUrl(Note|int $note, int $type = Router::ABSOLUTE_URL): string
+    {
+        return Router::url(id: 'note_attachment_download', args: ['note_id' => \is_int($note) ? $note : $note->getId(), 'attachment_id' => $this->getId()], type: $type);
+    }
+
+    /**
+     * @throws ClientException
+     * @throws NotFoundException
+     * @throws ServerException
+     */
+    public function getThumbnail(?string $size = null, bool $crop = false): ?AttachmentThumbnail
+    {
+        try {
+            return AttachmentThumbnail::getOrCreate(attachment: $this, size: $size, crop: $crop);
+        } catch (NoSuchFileException) {
+            return null;
+        }
+    }
+
+    public function getThumbnailUrl(Note|int $note, ?string $size = null): string
+    {
+        return Router::url('note_attachment_thumbnail', ['note_id' => \is_int($note) ? $note : $note->getId(), 'attachment_id' => $this->getId(), 'size' => $size ?? Common::config('thumbnail', 'default_size')]);
     }
 
     public static function schemaDef(): array
@@ -342,7 +392,7 @@ class Attachment extends Entity
             'name'   => 'attachment',
             'fields' => [
                 'id'       => ['type' => 'serial',    'not null' => true],
-                'lives'    => ['type' => 'int',       'not null' => true, 'description' => 'RefCount'],
+                'lives'    => ['type' => 'int',       'default' => 1, 'not null' => true, 'description' => 'RefCount, starts with 1'],
                 'filehash' => ['type' => 'varchar',   'length' => 64,  'description' => 'sha256 of the file contents, if the file is stored locally'],
                 'mimetype' => ['type' => 'varchar',   'length' => 255,  'description' => 'resource mime type 127+1+127 as per rfc6838#section-4.2'],
                 'filename' => ['type' => 'varchar',   'length' => 191, 'description' => 'file name of resource when available'],

components/Attachment/Entity/AttachmentThumbnail.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 
 // This file is part of GNU social - https://www.gnu.org/software/social
@@ -19,21 +21,22 @@
 
 // }}}
 
-namespace App\Entity;
+namespace Component\Attachment\Entity;
 
 use App\Core\Cache;
-use App\Core\DB\DB;
+use App\Core\DB;
 use App\Core\Entity;
 use App\Core\Event;
 use App\Core\GSFile;
-use function App\Core\I18n\_m;
 use App\Core\Log;
-use App\Core\Router\Router;
+use App\Core\Router;
+use App\Entity\Note;
 use App\Util\Common;
 use App\Util\Exception\ClientException;
 use App\Util\Exception\NotFoundException;
 use App\Util\Exception\NotStoredLocallyException;
 use App\Util\Exception\ServerException;
+use App\Util\TemporaryFile;
 use DateTimeInterface;
 use Symfony\Component\Mime\MimeTypes;
 
@@ -49,19 +52,30 @@ use Symfony\Component\Mime\MimeTypes;
  * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
  * @author    Hugo Sales <hugo@hsal.es>
  * @author    Diogo Peralta Cordeiro <mail@diogo.site>
+ * @author    Eliseu Amaro <mail@eliseuama.ro>
  * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
  * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
  */
 class AttachmentThumbnail extends Entity
 {
+    public const SIZE_SMALL  = 0;
+    public const SIZE_MEDIUM = 1;
+    public const SIZE_BIG    = 2;
+
+    public const SIZE_MAP = [
+        'small'  => self::SIZE_SMALL,
+        'medium' => self::SIZE_MEDIUM,
+        'big'    => self::SIZE_BIG,
+    ];
     // {{{ Autocode
     // @codeCoverageIgnoreStart
     private int $attachment_id;
-    private ?string $mimetype;
+    private ?string $mimetype = null;
+    private int $size         = 0;
+    private string $filename;
     private int $width;
     private int $height;
-    private string $filename;
+    private DateTimeInterface $modified;
-    private \DateTimeInterface $modified;
 
     public function setAttachmentId(int $attachment_id): self
     {
@@ -76,7 +90,7 @@ class AttachmentThumbnail extends Entity
 
     public function setMimetype(?string $mimetype): self
     {
-        $this->mimetype = $mimetype;
+        $this->mimetype = \is_null($mimetype) ? null : mb_substr($mimetype, 0, 129);
         return $this;
     }
 
@@ -85,6 +99,28 @@ class AttachmentThumbnail extends Entity
         return $this->mimetype;
     }
 
+    public function setSize(int $size): self
+    {
+        $this->size = $size;
+        return $this;
+    }
+
+    public function getSize(): int
+    {
+        return $this->size;
+    }
+
+    public function setFilename(string $filename): self
+    {
+        $this->filename = mb_substr($filename, 0, 191);
+        return $this;
+    }
+
+    public function getFilename(): string
+    {
+        return $this->filename;
+    }
+
     public function setWidth(int $width): self
     {
         $this->width = $width;
@@ -107,17 +143,6 @@ class AttachmentThumbnail extends Entity
         return $this->height;
     }
 
-    public function setFilename(string $filename): self
-    {
-        $this->filename = $filename;
-        return $this;
-    }
-
-    public function getFilename(): string
-    {
-        return $this->filename;
-    }
-
     public function setModified(DateTimeInterface $modified): self
     {
         $this->modified = $modified;
@@ -132,6 +157,17 @@ class AttachmentThumbnail extends Entity
     // @codeCoverageIgnoreEnd
     // }}} Autocode
 
+    public static function sizeIntToStr(?int $size): string
+    {
+        $map = array_flip(self::SIZE_MAP);
+        return $map[$size] ?? $map[self::SIZE_SMALL];
+    }
+
+    public static function sizeStrToInt(string $size)
+    {
+        return self::SIZE_MAP[$size] ?? self::SIZE_SMALL;
+    }
+
     private ?Attachment $attachment = null;
 
     public function setAttachment(?Attachment $attachment)
@@ -141,45 +177,50 @@ class AttachmentThumbnail extends Entity
 
     public function getAttachment()
     {
-        if (isset($this->attachment) && !is_null($this->attachment)) {
+        if (isset($this->attachment) && !\is_null($this->attachment)) {
             return $this->attachment;
         } else {
-            return $this->attachment = DB::findOneBy('attachment', ['id' => $this->attachment_id]);
+            return $this->attachment = DB::findOneBy(Attachment::class, ['id' => $this->attachment_id]);
         }
     }
 
+    public static function getCacheKey(int $id, int $size)
+    {
+        return "thumb-{$id}-{$size}";
+    }
+
     /**
-     * @param Attachment $attachment
+     * @param ?string $size 'small'|'medium'|'big'
-     * @param int        $width
-     * @param int        $height
-     * @param bool       $crop
      *
      * @throws ClientException
      * @throws NotFoundException
      * @throws ServerException
      *
-     * @return mixed
+     * @return ?self
      */
-    public static function getOrCreate(Attachment $attachment, int $width, int $height, bool $crop)
+    public static function getOrCreate(Attachment $attachment, ?string $size = null, bool $crop = false): ?self
     {
-        // We need to keep these in mind for DB indexing
+        $size ??= Common::config('thumbnail', 'default_size');
-        $predicted_width  = null;
+        $size_int = self::sizeStrToInt($size);
-        $predicted_height = null;
         try {
-            if (is_null($attachment->getWidth()) || is_null($attachment->getHeight())) {
+            return Cache::get(
-                // @codeCoverageIgnoreStart
+                self::getCacheKey($attachment->getId(), $size_int),
-                // TODO: check if we can generate from an existing thumbnail
+                fn () => DB::findOneBy(self::class, ['attachment_id' => $attachment->getId(), 'size' => $size_int]),
-                throw new ClientException(_m('Invalid dimensions requested for thumbnail.'));
+            );
-                // @codeCoverageIgnoreEnd
+        } catch (NotFoundException) {
+            if (\is_null($attachment->getWidth()) || \is_null($attachment->getHeight())) {
+                return null;
             }
-            return Cache::get('thumb-' . $attachment->getId() . "-{$width}x{$height}",
+            [$predicted_width, $predicted_height] = self::predictScalingValues($attachment->getWidth(), $attachment->getHeight(), $size, $crop);
-                function () use ($crop, $attachment, $width, $height, &$predicted_width, &$predicted_height) {
+            if (\is_null($attachment->getPath()) || !file_exists($attachment->getPath())) {
-                    [$predicted_width, $predicted_height] = self::predictScalingValues($attachment->getWidth(), $attachment->getHeight(), $width, $height, $crop);
+                // Before we quit, check if there's any other thumb
-                    return DB::findOneBy('attachment_thumbnail', ['attachment_id' => $attachment->getId(), 'width' => $predicted_width, 'height' => $predicted_height]);
+                $alternative_thumbs = DB::findBy(self::class, ['attachment_id' => $attachment->getId()]);
-                });
+                usort($alternative_thumbs, fn ($l, $r) => $r->getSize() <=> $l->getSize());
-        } catch (NotFoundException $e) {
+                if (empty($alternative_thumbs)) {
-            if (!file_exists($attachment->getPath())) {
+                    throw new NotStoredLocallyException();
-                throw new NotStoredLocallyException();
+                } else {
+                    return $alternative_thumbs[0];
+                }
             }
             $thumbnail              = self::create(['attachment_id' => $attachment->getId()]);
             $mimetype               = $attachment->getMimetype();
@@ -188,48 +229,39 @@ class AttachmentThumbnail extends Entity
             $event_map[$major_mime] = [];
             Event::handle('FileResizerAvailable', [&$event_map, $mimetype]);
             // Always prefer specific encoders
+            /** @var callable[] function(string $source, ?TemporaryFile &$destination, int &$width, int &$height, bool $smart_crop, ?string &$mimetype): bool */
             $encoders = array_merge($event_map[$mimetype], $event_map[$major_mime]);
             foreach ($encoders as $encoder) {
+                /** @var ?TemporaryFile */
                 $temp = null; // Let the EncoderPlugin create a temporary file for us
-                if ($encoder($attachment->getPath(), $temp, $width, $height, $crop, $mimetype)) {
+                if ($encoder($attachment->getPath(), $temp, $predicted_width, $predicted_height, $crop, $mimetype)) {
                     $thumbnail->setAttachment($attachment);
-                    $thumbnail->setWidth($predicted_width);
+                    $thumbnail->setSize($size_int);
-                    $thumbnail->setHeight($predicted_height);
+                    $mimetype = $temp->getMimeType();
-                    $ext      = '.' . MimeTypes::getDefault()->getExtensions($temp->getMimeType())[0];
+                    $ext      = '.' . MimeTypes::getDefault()->getExtensions($mimetype)[0];
                     $filename = "{$predicted_width}x{$predicted_height}{$ext}-" . $attachment->getFilehash();
                     $thumbnail->setFilename($filename);
                     $thumbnail->setMimetype($mimetype);
+                    $thumbnail->setWidth($predicted_width);
+                    $thumbnail->setHeight($predicted_height);
                     DB::persist($thumbnail);
                     DB::flush();
                     $temp->move(Common::config('thumbnail', 'dir'), $filename);
                     return $thumbnail;
                 }
             }
-            throw new ClientException(_m('Can not generate thumbnail for attachment with id={id}', ['id' => $attachment->getId()]));
+            return null;
         }
     }
 
-    public function getPath()
+    public function getPath(): string
     {
-        return Common::config('thumbnail', 'dir') . DIRECTORY_SEPARATOR . $this->getFilename();
+        return Common::config('thumbnail', 'dir') . \DIRECTORY_SEPARATOR . $this->getFilename();
     }
 
-    public function getUrl()
+    public function getUrl(Note|int $note): string
     {
-        return Router::url('attachment_thumbnail', ['id' => $this->getAttachmentId(), 'w' => $this->getWidth(), 'h' => $this->getHeight()]);
+        return Router::url('note_attachment_thumbnail', ['note_id' => \is_int($note) ? $note : $note->getId(), 'attachment_id' => $this->getAttachmentId(), 'size' => self::sizeIntToStr($this->getSize())]);
-    }
-
-    /**
-     * Get the HTML attributes for this thumbnail
-     */
-    public function getHTMLAttributes(array $orig = [], bool $overwrite = true)
-    {
-        $attrs = [
-            'height' => $this->getHeight(),
-            'width'  => $this->getWidth(),
-            'src'    => $this->getUrl(),
-        ];
-        return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
     }
 
     /**
@@ -241,13 +273,15 @@ class AttachmentThumbnail extends Entity
         if (file_exists($filepath)) {
             if (@unlink($filepath) === false) {
                 // @codeCoverageIgnoreStart
-                Log::warning("Failed deleting file for attachment thumbnail with id={$this->attachment_id}, width={$this->width}, height={$this->height} at {$filepath}");
+                Log::warning("Failed deleting file for attachment thumbnail with id={$this->getAttachmentId()}, size={$this->getSize()} at {$filepath}");
                 // @codeCoverageIgnoreEnd
             }
         }
-        DB::remove($this);
+        Cache::delete(self::getCacheKey($this->getAttachmentId(), $this->getSize()));
         if ($flush) {
-            DB::flush();
+            DB::wrapInTransaction(fn () => DB::remove($this));
+        } else {
+            DB::remove($this);
         }
     }
 
@@ -257,35 +291,75 @@ class AttachmentThumbnail extends Entity
      * Values will scale _up_ to fit max values if cropping is enabled!
      * With cropping disabled, the max value of each axis will be respected.
      *
-     * @param $width    int Original width
+     * @param int $existing_width  Original width
-     * @param $height   int Original height
+     * @param int $existing_height Original height
-     * @param $maxW     int Resulting max width
-     * @param $maxH     int Resulting max height
-     * @param $crop     bool Crop to the size (not preserving aspect ratio)
      *
      * @return array [predicted width, predicted height]
      */
     public static function predictScalingValues(
         int $existing_width,
         int $existing_height,
-        int $requested_width,
+        string $requested_size,
-        int $requested_height,
+        bool $crop,
-        bool $crop
     ): array {
-        if ($crop) {
+        /**
-            $rw = min($existing_width, $requested_width);
+         * 1:1   => Square
-            $rh = min($existing_height, $requested_height);
+         * 4:3   => SD
-        } else {
+         * 11:8  => Academy Ratio
-            if ($existing_width > $existing_height) {
+         * 3:2   => Classic 35mm
-                $rw = min($existing_width, $requested_width);
+         * 16:10 => Golden Ratio
-                $rh = ceil($existing_height * $rw / $existing_width);
+         * 16:9  => Widescreen
-            } else {
+         * 2.2:1 => Standard 70mm film
-                $rh = min($existing_height, $requested_height);
+         */
-                $rw = ceil($existing_width * $rh / $existing_height);
+        $allowed_aspect_ratios = [1, 1.3, 1.376, 1.5, 1.6, 1.7, 2.2]; // Ascending array
-            }
+        $sizes                 = [
+            'small'  => Common::config('thumbnail', 'small'),
+            'medium' => Common::config('thumbnail', 'medium'),
+            'big'    => Common::config('thumbnail', 'big'),
+        ];
+
+        // We only scale if the image is larger than the minimum width and height for a thumbnail
+        if ($existing_width < Common::config('thumbnail', 'minimum_width') && $existing_height < Common::config('thumbnail', 'minimum_height')) {
+            return [$existing_width, $existing_height];
         }
 
-        return [(int) $rw, (int) $rh];
+        // We only scale if the total of pixels is greater than the maximum allowed for a thumbnail
+        $total_of_pixels = $existing_width * $existing_height;
+        if ($total_of_pixels < Common::config('thumbnail', 'maximum_pixels')) {
+            return [$existing_width, $existing_height];
+        }
+
+        // Is this a portrait image?
+        $flip = $existing_height > $existing_width;
+
+        // Find the aspect ratio of the given image
+        $existing_aspect_ratio = !$flip ? $existing_width / $existing_height : $existing_height / $existing_width;
+
+        // Binary search the closer allowed aspect ratio
+        $left  = 0;
+        $right = \count($allowed_aspect_ratios) - 1;
+        while ($left < $right) {
+            $mid = floor($left + ($right - $left) / 2);
+
+            // Comparing absolute distances with middle value and right value
+            if (abs($existing_aspect_ratio - $allowed_aspect_ratios[$mid]) < abs($existing_aspect_ratio - $allowed_aspect_ratios[$right])) {
+                // search the left side of the array
+                $right = $mid;
+            } else {
+                // search the right side of the array
+                $left = $mid + 1;
+            }
+        }
+        $closest_aspect_ratio = $allowed_aspect_ratios[$left];
+        unset($mid, $left, $right);
+
+        // TODO: For crop, we should test a threshold and understand if the image would better be cropped
+
+        // Resulting width and height
+        $rw = (int) ($sizes[$requested_size]);
+        $rh = (int) ($rw / $closest_aspect_ratio);
+
+        return !$flip ? [$rw, $rh] : [$rh, $rw];
     }
 
     public static function schemaDef(): array
@@ -295,12 +369,13 @@ class AttachmentThumbnail extends Entity
             'fields' => [
                 'attachment_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Attachment.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'thumbnail for what attachment'],
                 'mimetype'      => ['type' => 'varchar',   'length' => 129,  'description' => 'resource mime type 64+1+64, images hardly will show up with long mimetypes, this is probably safe considering rfc6838#section-4.2'],
-                'width'         => ['type' => 'int', 'not null' => true, 'description' => 'width of thumbnail'],
+                'size'          => ['type' => 'int', 'not null' => true, 'default' => 0, 'description' => '0 = small; 1 = medium; 2 = big'],
-                'height'        => ['type' => 'int', 'not null' => true, 'description' => 'height of thumbnail'],
                 'filename'      => ['type' => 'varchar', 'length' => 191, 'not null' => true, 'description' => 'thumbnail filename'],
+                'width'         => ['type' => 'int', 'not null' => true,       'description' => 'width in pixels, if it can be described as such and data is available'],
+                'height'        => ['type' => 'int', 'not null' => true,       'description' => 'height in pixels, if it can be described as such and data is available'],
                 'modified'      => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
             ],
-            'primary key' => ['attachment_id', 'width', 'height'],
+            'primary key' => ['attachment_id', 'size'],
             'indexes'     => [
                 'attachment_thumbnail_attachment_id_idx' => ['attachment_id'],
             ],

components/Attachment/Entity/AttachmentToLink.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -17,8 +19,9 @@
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
 // }}}
 
-namespace App\Entity;
+namespace Component\Attachment\Entity;
 
+use App\Core\DB;
 use App\Core\Entity;
 use DateTimeInterface;
 
@@ -36,20 +39,9 @@ class AttachmentToLink extends Entity
 {
     // {{{ Autocode
     // @codeCoverageIgnoreStart
-    private int $attachment_id;
     private int $link_id;
-    private \DateTimeInterface $modified;
+    private int $attachment_id;
-
+    private DateTimeInterface $modified;
-    public function setAttachmentId(int $attachment_id): self
-    {
-        $this->attachment_id = $attachment_id;
-        return $this;
-    }
-
-    public function getAttachmentId(): int
-    {
-        return $this->attachment_id;
-    }
 
     public function setLinkId(int $link_id): self
     {
@@ -62,6 +54,17 @@ class AttachmentToLink extends Entity
         return $this->link_id;
     }
 
+    public function setAttachmentId(int $attachment_id): self
+    {
+        $this->attachment_id = $attachment_id;
+        return $this;
+    }
+
+    public function getAttachmentId(): int
+    {
+        return $this->attachment_id;
+    }
+
     public function setModified(DateTimeInterface $modified): self
     {
         $this->modified = $modified;
@@ -76,6 +79,40 @@ class AttachmentToLink extends Entity
     // @codeCoverageIgnoreEnd
     // }}} Autocode
 
+    public static function removeWhereAttachmentId(int $attachment_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM attachment_to_link atl
+                WHERE atl.attachment_id = :attachment_id
+                EOF,
+            ['attachment_id' => $attachment_id],
+        );
+    }
+
+    public static function removeWhere(int $link_id, int $attachment_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM attachment_to_link atl
+                WHERE (atl.link_id = :link_id
+                           OR atl.attachment_id = :attachment_id)
+                EOF,
+            ['link_id' => $link_id, 'attachment_id' => $attachment_id],
+        );
+    }
+
+    public static function removeWhereLinkId(int $link_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM attachment_to_link atl
+                WHERE atl.link_id = :link_id
+                EOF,
+            ['link_id' => $link_id],
+        );
+    }
+
     public static function schemaDef(): array
     {
         return [

components/Attachment/Entity/AttachmentToNote.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -17,8 +19,9 @@
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
 // }}}
 
-namespace App\Entity;
+namespace Component\Attachment\Entity;
 
+use App\Core\DB;
 use App\Core\Entity;
 use DateTimeInterface;
 
@@ -42,8 +45,8 @@ class AttachmentToNote extends Entity
     // @codeCoverageIgnoreStart
     private int $attachment_id;
     private int $note_id;
-    private ?string $title;
+    private ?string $title = null;
-    private \DateTimeInterface $modified;
+    private DateTimeInterface $modified;
 
     public function setAttachmentId(int $attachment_id): self
     {
@@ -92,6 +95,40 @@ class AttachmentToNote extends Entity
     // @codeCoverageIgnoreEnd
     // }}} Autocode
 
+    public static function removeWhere(int $note_id, int $attachment_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM attachment_to_note atn
+                WHERE (atn.attachment_id = :attachment_id
+                           OR atn.note_id = :note_id)
+                EOF,
+            ['note_id' => $note_id, 'attachment_id' => $attachment_id],
+        );
+    }
+
+    public static function removeWhereNoteId(int $note_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM attachment_to_note atn
+                WHERE atn.note_id = :note_id
+                EOF,
+            ['note_id' => $note_id],
+        );
+    }
+
+    public static function removeWhereAttachmentId(int $attachment_id): mixed
+    {
+        return DB::dql(
+            <<<'EOF'
+                DELETE FROM attachment_to_note atn
+                WHERE atn.attachment_id = :attachment_id
+                EOF,
+            ['attachment_id' => $attachment_id],
+        );
+    }
+
     public static function schemaDef(): array
     {
         return [

components/Attachment/tests/Controller/AttachmentTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 
 // This file is part of GNU social - https://www.gnu.org/software/social
@@ -19,10 +21,12 @@
 
 // }}}
 
-namespace App\Tests\Core;
+namespace Component\Attachment\tests\Controller;
 
-use App\Core\DB\DB;
+use App\Core\DB;
 use App\Util\GNUsocialTestCase;
+use Component\Attachment\Entity\Attachment;
+use Component\Attachment\Entity\AttachmentToNote;
 
 class AttachmentTest extends GNUsocialTestCase
 {
@@ -30,31 +34,33 @@ class AttachmentTest extends GNUsocialTestCase
     {
         // This calls static::bootKernel(), and creates a "client" that is acting as the browser
         $client = static::createClient();
-        $client->request('GET', '/attachment');
+        //$client->request('GET', '/attachment');
+        //$this->assertResponseStatusCodeSame(404);
+        $client->request('GET', '/object/note/1/attachment/-1');
         $this->assertResponseStatusCodeSame(404);
-        $client->request('GET', '/attachment/-1');
+        $client->request('GET', '/object/note/1/attachment/asd');
         $this->assertResponseStatusCodeSame(404);
-        $client->request('GET', '/attachment/asd');
+        $client->request('GET', '/object/note/1/attachment/0');
-        $this->assertResponseStatusCodeSame(404);
-        $client->request('GET', '/attachment/0');
         // In the meantime, throwing ClientException doesn't actually result in the reaching the UI, as it's intercepted
         // by the helpful framework that displays the stack traces and such. This should be easily fixable when we have
         // our own error pages
-        $this->assertSelectorTextContains('.stacktrace', 'ClientException');
+        $this->assertResponseStatusCodeSame(500); // TODO (exception page) 404
+        $this->assertSelectorTextContains('.stacktrace', 'No such attachment.');
     }
 
     private function testAttachment(string $suffix = '')
     {
-        $client  = static::createClient();
+        $client        = static::createClient();
-        $id      = DB::findOneBy('attachment', ['filehash' => '5d8ee7ead51a28803b4ee5cb2306a0b90b6ba570f1e5bcc2209926f6ab08e7ea'])->getId();
+        $attachment_id = DB::findOneBy(Attachment::class, ['filehash' => '5d8ee7ead51a28803b4ee5cb2306a0b90b6ba570f1e5bcc2209926f6ab08e7ea'])->getId();
-        $crawler = $client->request('GET', "/attachment/{$id}{$suffix}");
+        $note_id       = DB::findOneBy(AttachmentToNote::class, ['attachment_id' => $attachment_id])->getNoteId();
+        $crawler       = $client->request('GET', "/object/note/{$note_id}/attachment/{$attachment_id}{$suffix}");
     }
 
     public function testAttachmentShow()
     {
         $this->testAttachment();
         $this->assertResponseIsSuccessful();
-        $this->assertSelectorTextContains('figure figcaption', '5d8ee7ead51a28803b4ee5cb2306a0b90b6ba570f1e5bcc2209926f6ab08e7ea');
+        $this->assertSelectorTextContains('figure figcaption', 'image.jpg');
     }
 
     public function testAttachmentView()
@@ -63,32 +69,27 @@ class AttachmentTest extends GNUsocialTestCase
         $this->assertResponseIsSuccessful();
     }
 
-    public function testAttachmentViewNotStored()
-    {
-        $client          = static::createClient();
-        $last_attachment = DB::findBy('attachment', [], orderBy: ['id' => 'DESC'], limit: 1)[0];
-        $id              = $last_attachment->getId() + 1;
-        $crawler         = $client->request('GET', "/attachment/{$id}/view");
-        $this->assertResponseStatusCodeSame(500); // TODO (exception page) 404
-        $this->assertSelectorTextContains('.stacktrace', 'ClientException');
-    }
-
     public function testAttachmentDownload()
     {
         $this->testAttachment('/download');
         $this->assertResponseIsSuccessful();
     }
 
-    public function testAttachmentThumbnail()
+    public function testAttachmentThumbnailSmall()
     {
-        $this->testAttachment('/thumbnail');
+        $this->testAttachment('/thumbnail/small');
         $this->assertResponseIsSuccessful();
     }
 
-    public function testAttachmentThumbnailWrongSize()
+    public function testAttachmentThumbnailMedium()
     {
-        $this->testAttachment('/thumbnail?w=1&h=1');
+        $this->testAttachment('/thumbnail/medium');
-        $this->assertSelectorTextContains('.stacktrace', 'ClientException');
+        $this->assertResponseIsSuccessful();
-        // $this->assertResponseStatusCodeSame(400);
+    }
+
+    public function testAttachmentThumbnailBig()
+    {
+        $this->testAttachment('/thumbnail/big');
+        $this->assertResponseIsSuccessful();
     }
 }

components/Attachment/tests/Entity/AttachmentTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -17,16 +19,19 @@
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
 // }}}
 
-namespace App\Tests\Entity;
+namespace Component\Attachment\tests\Entity;
 
-use App\Core\DB\DB;
+use App\Core\DB;
 use App\Core\Event;
 use App\Core\GSFile;
-use App\Entity\AttachmentToNote;
+use App\Core\Router;
 use App\Entity\Note;
 use App\Util\GNUsocialTestCase;
 use App\Util\TemporaryFile;
+use Component\Attachment\Entity\AttachmentToNote;
+use Component\Conversation\Conversation;
 use Jchook\AssertThrows\AssertThrows;
+use SplFileInfo;
 use Symfony\Component\HttpFoundation\File\File;
 
 class AttachmentTest extends GNUsocialTestCase
@@ -39,35 +44,36 @@ class AttachmentTest extends GNUsocialTestCase
 
         // Setup first attachment
         $file       = new TemporaryFile();
-        $attachment = GSFile::sanitizeAndStoreFileAsAttachment($file);
+        $attachment = GSFile::storeFileAsAttachment($file, check_is_supported_mimetype: false);
         $path       = $attachment->getPath();
         $hash       = $attachment->getFilehash();
-        static::assertTrue(file_exists($attachment->getPath()));
+        static::assertFileExists($attachment->getPath());
         static::assertSame(1, $attachment->getLives());
-        static::assertTrue(file_exists($path));
+        static::assertFileExists($path);
 
         // Delete the backed storage of the attachment
         static::assertTrue($attachment->deleteStorage());
-        static::assertFalse(file_exists($path));
+        static::assertFileDoesNotExist($path);
         static::assertNull($attachment->getPath());
-        DB::flush($attachment);
+        DB::persist($attachment);
+        DB::flush();
 
         // Setup the second attachment, re-adding the backed store
         $file                = new TemporaryFile();
-        $repeated_attachment = GSFile::sanitizeAndStoreFileAsAttachment($file);
+        $repeated_attachment = GSFile::storeFileAsAttachment($file, check_is_supported_mimetype: false);
         $path                = $attachment->getPath();
         static::assertSame(2, $repeated_attachment->getLives());
-        static::assertTrue(file_exists($path));
+        static::assertFileExists($path);
 
         // Garbage collect the attachment
         $attachment->kill();
-        static::assertTrue(file_exists($path));
+        static::assertFileExists($path);
         static::assertSame(1, $repeated_attachment->getLives());
 
         // Garbage collect the second attachment, which should delete everything
         $repeated_attachment->kill();
         static::assertSame(0, $repeated_attachment->getLives());
-        static::assertFalse(file_exists($path));
+        static::assertFileDoesNotExist($path);
         static::assertSame([], DB::findBy('attachment', ['filehash' => $hash]));
     }
 
@@ -76,15 +82,16 @@ class AttachmentTest extends GNUsocialTestCase
         $test = function (string $method) {
             $temp_file = new TemporaryFile();
             $temp_file->write(file_get_contents(INSTALLDIR . '/tests/sample-uploads/gnu-logo.png'));
+            $hash = null;
             Event::handle('HashFile', [$temp_file->getPathname(), &$hash]);
             $attachment = DB::findOneBy('attachment', ['filehash' => $hash]);
             $attachment->{$method}();
             DB::flush();
 
             $file = new File($temp_file->getRealPath());
-            GSFile::sanitizeAndStoreFileAsAttachment($file);
+            GSFile::storeFileAsAttachment($file);
             static::assertNotNull($attachment->getFilename());
-            static::assertTrue(file_exists($attachment->getPath()));
+            static::assertFileExists($attachment->getPath());
         };
 
         $test('deleteStorage');
@@ -100,8 +107,9 @@ class AttachmentTest extends GNUsocialTestCase
         static::assertSame('Untitled attachment', $attachment->getBestTitle());
         $attachment->setFilename($filename);
 
-        $actor = DB::findOneBy('gsactor', ['nickname' => 'taken_user']);
+        $actor            = DB::findOneBy('actor', ['nickname' => 'taken_user']);
-        DB::persist($note = Note::create(['gsactor_id' => $actor->getId(), 'content' => 'some content']));
+        DB::persist($note = Note::create(['actor_id' => $actor->getId(), 'content' => 'attachment: some content', 'content_type' => 'text/plain', 'is_local' => true]));
+        Conversation::assignLocalConversation($note, null);
         DB::persist(AttachmentToNote::create(['attachment_id' => $attachment->getId(), 'note_id' => $note->getId(), 'title' => 'A title']));
         DB::flush();
 
@@ -110,14 +118,17 @@ class AttachmentTest extends GNUsocialTestCase
 
     public function testGetUrl()
     {
+        static::bootKernel();
         $attachment = DB::findBy('attachment', ['mimetype' => 'image/png'], limit: 1)[0];
         $id         = $attachment->getId();
-        static::assertSame("/attachment/{$id}/view", $attachment->getUrl());
+        static::assertSame("/object/note/42/attachment/{$id}/view", $attachment->getUrl(note: 42, type: Router::ABSOLUTE_PATH));
     }
 
     public function testMimetype()
     {
-        $file = new \SplFileInfo(INSTALLDIR . '/tests/sample-uploads/image.jpg');
+        static::bootKernel();
+        $file = new SplFileInfo(INSTALLDIR . '/tests/sample-uploads/image.jpg');
+        $hash = null;
         Event::handle('HashFile', [$file->getPathname(), &$hash]);
         $attachment = DB::findOneBy('attachment', ['filehash' => $hash]);
 

components/Attachment/tests/Entity/AttachmentThumbnailTest.php

@@ -0,0 +1,177 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+namespace Component\Attachment\tests\Entity;
+
+use App\Core\DB;
+use App\Core\Event;
+use App\Util\Exception\NotStoredLocallyException;
+use App\Util\GNUsocialTestCase;
+use Component\Attachment\Entity\Attachment;
+use Component\Attachment\Entity\AttachmentThumbnail;
+use Functional as F;
+use Jchook\AssertThrows\AssertThrows;
+use SplFileInfo;
+
+class AttachmentThumbnailTest extends GNUsocialTestCase
+{
+    use AssertThrows;
+
+    public function testAttachmentThumbnailLifecycle()
+    {
+        parent::bootKernel();
+
+        // Data fixture already loaded this file, but we need to get its hash to find it
+        $file = new SplFileInfo(INSTALLDIR . '/tests/sample-uploads/attachment-lifecycle-target.jpg');
+        $hash = null;
+        Event::handle('HashFile', [$file->getPathname(), &$hash]);
+        $attachment = DB::findOneBy(Attachment::class, ['filehash' => $hash]);
+
+        $expected = [
+            AttachmentThumbnail::getOrCreate($attachment, 'small', crop: false),
+            AttachmentThumbnail::getOrCreate($attachment, 'medium', crop: false),
+            $thumb = AttachmentThumbnail::getOrCreate($attachment, 'big', crop: false),
+        ];
+
+        static::assertSame($attachment, $thumb->getAttachment());
+        $thumb->setAttachment(null);
+        static::assertSame($attachment, $thumb->getAttachment());
+
+        $actual = $attachment->getThumbnails();
+        static::assertSame(\count($expected), \count($actual));
+        foreach ($expected as $e) {
+            $a = array_shift($actual);
+            static::assertObjectEquals($e, $a);
+        }
+
+        array_pop($expected);
+        $thumb->delete();
+        $actual = $attachment->getThumbnails();
+        static::assertSame(\count($expected), \count($actual));
+        foreach ($expected as $e) {
+            $a = array_shift($actual);
+            static::assertObjectEquals($e, $a);
+        }
+
+        $attachment->deleteStorage();
+
+        foreach (array_reverse($attachment->getThumbnails()) as $t) {
+            // Since we still have thumbnails, those will be used as the new thumbnail, even though we don't have the original
+            $new = AttachmentThumbnail::getOrCreate($attachment, 'big', crop: false);
+            static::assertSame([$t->getFilename(), $t->getSize()], [$new->getFilename(), $new->getSize()]);
+            $t->delete();
+        }
+
+        // Since the backed storage was deleted and we don't have any more previous thumnbs, we can't generate another thumbnail
+        static::assertThrows(NotStoredLocallyException::class, fn () => AttachmentThumbnail::getOrCreate($attachment, 'big', crop: false));
+
+        $attachment->kill();
+        // static::assertThrows(NotStoredLocallyException::class, fn () => AttachmentThumbnail::getOrCreate($attachment, 'big', crop: false));
+    }
+
+    public function testInvalidThumbnail()
+    {
+        parent::bootKernel();
+        $file = new SplFileInfo(INSTALLDIR . '/tests/sample-uploads/spreadsheet.ods');
+        $hash = null;
+        Event::handle('HashFile', [$file->getPathname(), &$hash]);
+        $attachment = DB::findOneBy('attachment', ['filehash' => $hash]);
+        static::assertNull(AttachmentThumbnail::getOrCreate($attachment, 'small', crop: false));
+    }
+
+    public function testPredictScalingValues()
+    {
+        parent::bootKernel();
+        // TODO test with cropping
+
+        $inputs = [
+            [100, 100],
+            [400, 200],
+            [800, 400],
+            [1600, 800],
+            [1600, 1600],
+            // 16:9 video
+            [854,  480],
+            [1280, 720],
+            [1920, 1080],
+            [2560, 1440],
+            [3840, 2160],
+        ];
+
+        $outputs = [
+            'small' => [
+                [100, 100],
+                [400, 200],
+                [32, 14],
+                [32, 14],
+                [32, 32],
+                // 16:9 video
+                [32, 21],
+                [32, 21],
+                [32, 21],
+                [32, 21],
+                [32, 21],
+            ],
+            'medium' => [
+                [100, 100],
+                [400, 200],
+                [256, 116],
+                [256, 116],
+                [256, 256],
+                // 16:9 video
+                [256, 170],
+                [256, 170],
+                [256, 170],
+                [256, 170],
+                [256, 170],
+            ],
+            'big' => [
+                [100, 100],
+                [400, 200],
+                [496, 225],
+                [496, 225],
+                [496, 496],
+                // 16:9 video
+                [496, 330],
+                [496, 330],
+                [496, 330],
+                [496, 330],
+                [496, 330],
+            ],
+        ];
+
+        foreach (['small', 'medium', 'big'] as $size) {
+            foreach (F\zip($inputs, $outputs[$size]) as [$existing, $results]) {
+                static::assertSame($results, AttachmentThumbnail::predictScalingValues(existing_width: $existing[0], existing_height: $existing[1], requested_size: $size, crop: false));
+            }
+        }
+    }
+
+    public function testGetUrl()
+    {
+        parent::bootKernel();
+        $attachment = DB::findBy(Attachment::class, ['mimetype' => 'image/png'], limit: 1)[0];
+        $thumb      = AttachmentThumbnail::getOrCreate($attachment, 'big', crop: false);
+        $id         = $attachment->getId();
+        $expected   = "/object/note/42/attachment/{$id}/thumbnail/big";
+        static::assertSame($expected, $thumb->getUrl(note: 42));
+    }
+}

components/Avatar/Avatar.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -20,104 +22,125 @@
 namespace Component\Avatar;
 
 use App\Core\Cache;
-use App\Core\DB\DB;
+use App\Core\DB;
 use App\Core\Event;
 use App\Core\GSFile;
 use App\Core\Modules\Component;
-use App\Core\Router\Router;
+use App\Core\Router;
 use App\Util\Common;
+use Component\Attachment\Entity\Attachment;
+use Component\Attachment\Entity\AttachmentThumbnail;
 use Component\Avatar\Controller as C;
 use Component\Avatar\Exception\NoAvatarException;
 use Symfony\Component\HttpFoundation\Request;
 
 class Avatar extends Component
 {
-    public function onAddRoute($r): bool
+    public function onInitializeComponent()
     {
-        $r->connect('avatar', '/{gsactor_id<\d+>}/avatar/{size<full|big|medium|small>?full}', [Controller\Avatar::class, 'avatar_view']);
+    }
-        $r->connect('settings_avatar', '/settings/avatar', [Controller\Avatar::class, 'settings_avatar']);
+
+    public function onAddRoute(Router $r): bool
+    {
+        $r->connect('avatar_actor', '/actor/{actor_id<\d+>}/avatar/{size<full|big|medium|small>?medium}', [Controller\Avatar::class, 'avatar_view']);
+        $r->connect('avatar_default', '/avatar/default/{size<full|big|medium|small>?medium}', [Controller\Avatar::class, 'default_avatar_view']);
+        $r->connect('avatar_settings', '/settings/avatar', [Controller\Avatar::class, 'settings_avatar']);
         return Event::next;
     }
 
-    public function onPopulateProfileSettingsTabs(Request $request, &$tabs): bool
+    /**
+     * @throws \App\Util\Exception\ClientException
+     */
+    public function onPopulateSettingsTabs(Request $request, string $section, &$tabs): bool
     {
-        // TODO avatar template shouldn't be on settings folder
+        if ($section === 'profile') {
-        $tabs[] = [
+            $tabs[] = [
-            'title'      => 'Avatar',
+                'title'      => 'Avatar',
-            'desc'       => 'Change your avatar.',
+                'desc'       => 'Change your avatar.',
-            'controller' => C\Avatar::settings_avatar($request),
+                'id'         => 'settings-avatar',
-        ];
+                'controller' => C\Avatar::settings_avatar($request),
-
+            ];
-        return Event::next;
-    }
-
-    public function onStartTwigPopulateVars(array &$vars): bool
-    {
-        if (Common::user() != null) {
-            $vars['user_avatar'] = self::getAvatarUrl();
         }
         return Event::next;
     }
 
-    public function onGetAvatarUrl(int $gsactor_id, ?string &$url): bool
+    public function onAvatarUpdate(int $actor_id): bool
     {
-        $url = self::getAvatarUrl($gsactor_id);
+        Cache::delete("avatar-{$actor_id}");
-        return Event::next;
+        foreach (['full', 'big', 'medium', 'small'] as $size) {
-    }
+            foreach ([Router::ABSOLUTE_PATH, Router::ABSOLUTE_URL] as $type) {
-
+                Cache::delete("avatar-url-{$actor_id}-{$size}-{$type}");
-    public function onAvatarUpdate(int $gsactor_id): bool
+            }
-    {
+            Cache::delete("avatar-file-info-{$actor_id}-{$size}");
-        Cache::delete('avatar-' . $gsactor_id);
+        }
-        Cache::delete('avatar-url-' . $gsactor_id);
-        Cache::delete('avatar-file-info-' . $gsactor_id);
         return Event::next;
     }
 
     // UTILS ----------------------------------
 
     /**
-     * Get the avatar associated with the given GSActor id
+     * Get the avatar associated with the given Actor id
      */
-    public static function getAvatar(?int $gsactor_id = null): Entity\Avatar
+    public static function getAvatar(?int $actor_id = null): Entity\Avatar
     {
-        $gsactor_id = $gsactor_id ?: Common::userId();
+        $actor_id = $actor_id ?: Common::userId();
-        return GSFile::error(NoAvatarException::class,
+        return GSFile::error(
-            $gsactor_id,
+            NoAvatarException::class,
-            Cache::get("avatar-{$gsactor_id}",
+            $actor_id,
-                function () use ($gsactor_id) {
+            Cache::get(
-                    return DB::dql('select a from Component\Avatar\Entity\Avatar a ' .
+                "avatar-{$actor_id}",
-                        'where a.gsactor_id = :gsactor_id',
+                function () use ($actor_id) {
-                        ['gsactor_id' => $gsactor_id]);
+                    return DB::dql(
-                }));
+                        'select a from Component\Avatar\Entity\Avatar a '
+                        . 'where a.actor_id = :actor_id',
+                        ['actor_id' => $actor_id],
+                    );
+                },
+            ),
+        );
     }
 
     /**
-     * Get the cached avatar associated with the given GSActor id, or the current user if not given
+     * Get the cached avatar associated with the given Actor id, or the current user if not given
      */
-    public static function getAvatarUrl(?int $gsactor_id = null, string $size = 'full'): string
+    public static function getUrl(int $actor_id, string $size = 'medium', int $type = Router::ABSOLUTE_PATH): string
     {
-        $gsactor_id = $gsactor_id ?: Common::userId();
+        try {
-        return Cache::get("avatar-url-{$gsactor_id}", function () use ($gsactor_id) {
+            return self::getAvatar($actor_id)->getUrl($size, $type);
-            return Router::url('avatar', ['gsactor_id' => $gsactor_id, 'size' => 'full']);
+        } catch (NoAvatarException) {
-        });
+            return Router::url('avatar_default', ['size' => $size], $type);
+        }
+    }
+
+    public static function getDimensions(int $actor_id, string $size = 'medium')
+    {
+        try {
+            $attachment = self::getAvatar($actor_id)->getAttachment();
+            return ['width' => (int) $attachment->getWidth(), 'height' => (int) $attachment->getHeight()];
+        } catch (NoAvatarException) {
+            return ['width' => (int) (Common::config('thumbnail', 'small')), 'height' => (int) (Common::config('thumbnail', 'small'))];
+        }
     }
 
     /**
-     * Get the cached avatar file info associated with the given GSActor id
+     * Get the cached avatar file info associated with the given Actor id
      *
      * Returns the avatar file's hash, mimetype, title and path.
      * Ensures exactly one cached value exists
      */
-    public static function getAvatarFileInfo(int $gsactor_id): array
+    public static function getAvatarFileInfo(int $actor_id, string $size = 'medium'): array
     {
-        $res = Cache::get("avatar-file-info-{$gsactor_id}",
+        $res = Cache::get(
-            function () use ($gsactor_id) {
+            "avatar-file-info-{$actor_id}-{$size}",
-                return DB::dql('select f.id, f.filename, a.filename title, f.mimetype ' .
+            function () use ($actor_id) {
-                    'from App\Entity\Attachment f ' .
+                return DB::dql(
-                    'join Component\Avatar\Entity\Avatar a with f.id = a.attachment_id ' .
+                    'select f.id, f.filename, a.title, f.mimetype '
-                    'where a.gsactor_id = :gsactor_id',
+                    . 'from Component\Attachment\Entity\Attachment f '
-                    ['gsactor_id' => $gsactor_id]);
+                    . 'join Component\Avatar\Entity\Avatar a with f.id = a.attachment_id '
-            }
+                    . 'where a.actor_id = :actor_id',
+                    ['actor_id' => $actor_id],
+                );
+            },
         );
         if ($res === []) { // Avatar not found
             $filepath = INSTALLDIR . '/public/assets/default-avatar.svg';
@@ -129,8 +152,12 @@ class Avatar extends Component
                 'title'    => 'default_avatar.svg',
             ];
         } else {
-            $res             = $res[0]; // A user must always only have one avatar.
+            $res = $res[0]; // A user must always only have one avatar.
-            $res['filepath'] = DB::findOneBy('attachment', ['id' => $res['id']])->getPath();
+            if ($size === 'full') {
+                $res['filepath'] = Attachment::getByPK(['id' => $res['id']])->getPath();
+            } else {
+                $res['filepath'] = AttachmentThumbnail::getOrCreate(Attachment::getByPK(['id' => $res['id']]), $size)->getPath();
+            }
             return $res;
         }
     }

components/Avatar/Controller/Avatar.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 
 // This file is part of GNU social - https://www.gnu.org/software/social
@@ -22,7 +24,7 @@
 namespace Component\Avatar\Controller;
 
 use App\Core\Controller;
-use App\Core\DB\DB;
+use App\Core\DB;
 use App\Core\Event;
 use App\Core\Form;
 use App\Core\GSFile;
@@ -31,7 +33,6 @@ use function App\Core\I18n\_m;
 use App\Core\Log;
 use App\Util\Common;
 use App\Util\Exception\ClientException;
-use App\Util\Exception\NotFoundException;
 use App\Util\TemporaryFile;
 use Component\Avatar\Entity\Avatar as AvatarEntity;
 use Exception;
@@ -45,18 +46,18 @@ use Symfony\Component\HttpFoundation\Response;
 
 class Avatar extends Controller
 {
+    public function default_avatar_view(Request $request, string $size): Response
+    {
+        return $this->avatar_view($request, 0, $size);
+    }
+
     /**
      * @throws Exception
      */
-    public function avatar_view(Request $request, int $gsactor_id, string $size): Response
+    public function avatar_view(Request $request, int $actor_id, string $size): Response
     {
-        switch ($size) {
+        $res = \Component\Avatar\Avatar::getAvatarFileInfo($actor_id, $size);
-            case 'full':
+        return M::sendFile($res['filepath'], $res['mimetype'], $res['title']);
-                $res = \Component\Avatar\Avatar::getAvatarFileInfo($gsactor_id);
-                return M::sendFile($res['filepath'], $res['mimetype'], $res['title']);
-            default:
-                throw new Exception('Not implemented');
-        }
     }
 
     /**
@@ -74,52 +75,54 @@ class Avatar extends Controller
         $form->handleRequest($request);
 
         if ($form->isSubmitted() && $form->isValid()) {
-            $data       = $form->getData();
+            $data     = $form->getData();
-            $user       = Common::user();
+            $user     = Common::user();
-            $gsactor_id = $user->getId();
+            $actor_id = $user->getId();
             if ($data['remove'] == true) {
-                try {
+                if (\is_null($avatar = DB::findOneBy(AvatarEntity::class, ['actor_id' => $actor_id], return_null: true))) {
-                    $avatar = DB::findOneBy('avatar', ['gsactor_id' => $gsactor_id]);
+                    $form->addError(new FormError(_m('No avatar set, so cannot delete.')));
+                } else {
                     $avatar->delete();
-                    Event::handle('AvatarUpdate', [$user->getId()]);
-                } catch (NotFoundException) {
-                    $form->addError(new FormError(_m('No avatar set, so cannot delete')));
                 }
             } else {
+                $attachment = null;
+                $title      = $data['avatar']?->getClientOriginalName() ?? null;
                 if (isset($data['hidden'])) {
                     // Cropped client side
                     $matches = [];
                     if (!empty(preg_match('/data:([^;]*)(;(base64))?,(.*)/', $data['hidden'], $matches))) {
-                        list(, , , $encoding_user, $data_user) = $matches;
+                        [, , , $encoding_user, $data_user] = $matches;
                         if ($encoding_user === 'base64') {
                             $data_user = base64_decode($data_user);
                             $tempfile  = new TemporaryFile(['prefix' => 'gs-avatar']);
                             $tempfile->write($data_user);
+                            $attachment = GSFile::storeFileAsAttachment($tempfile);
                         } else {
                             Log::info('Avatar upload got an invalid encoding, something\'s fishy and/or wrong');
                         }
                     }
                 } elseif (isset($data['avatar'])) {
                     // Cropping failed (e.g. disabled js), use file as uploaded
-                    $file = $data['avatar'];
+                    $file       = $data['avatar'];
+                    $attachment = GSFile::storeFileAsAttachment($file);
                 } else {
-                    throw new ClientException('Invalid form');
+                    throw new ClientException(_m('Invalid form.'));
                 }
-                $attachment = GSFile::sanitizeAndStoreFileAsAttachment(
-                    $file
-                );
                 // Delete current avatar if there's one
-                $avatar = DB::find('avatar', ['gsactor_id' => $gsactor_id]);
+                if (!\is_null($avatar = DB::findOneBy(AvatarEntity::class, ['actor_id' => $actor_id], return_null: true))) {
-                $avatar?->delete();
+                    $avatar->delete();
+                }
                 DB::persist($attachment);
-                // Can only get new id after inserting
+                DB::persist(AvatarEntity::create([
-                DB::flush();
+                    'actor_id'      => $actor_id,
-                DB::persist(AvatarEntity::create(['gsactor_id' => $gsactor_id, 'attachment_id' => $attachment->getId(), 'filename' => $file->getClientOriginalName()]));
+                    'attachment_id' => $attachment->getId(),
+                    'title'         => $title,
+                ]));
                 DB::flush();
                 Event::handle('AvatarUpdate', [$user->getId()]);
             }
         }
 
-        return ['_template' => 'settings/avatar.html.twig', 'avatar' => $form->createView()];
+        return ['_template' => 'avatar/settings.html.twig', 'avatar' => $form->createView()];
     }
 }

components/Avatar/Entity/Avatar.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 
 // This file is part of GNU social - https://www.gnu.org/software/social
@@ -21,11 +23,14 @@
 
 namespace Component\Avatar\Entity;
 
-use App\Core\DB\DB;
+use App\Core\Cache;
+use App\Core\DB;
 use App\Core\Entity;
-use App\Core\Router\Router;
+use App\Core\Event;
-use App\Entity\Attachment;
+use App\Core\Router;
 use App\Util\Common;
+use Component\Attachment\Entity\Attachment;
+use Component\Attachment\Entity\AttachmentThumbnail;
 use DateTimeInterface;
 
 /**
@@ -46,21 +51,21 @@ class Avatar extends Entity
 {
     // {{{ Autocode
     // @codeCoverageIgnoreStart
-    private int $gsactor_id;
+    private int $actor_id;
     private int $attachment_id;
-    private ?string $filename;
+    private ?string $title = null;
     private DateTimeInterface $created;
     private DateTimeInterface $modified;
 
-    public function setGSActorId(int $gsactor_id): self
+    public function setActorId(int $actor_id): self
     {
-        $this->gsactor_id = $gsactor_id;
+        $this->actor_id = $actor_id;
         return $this;
     }
 
-    public function getGSActorId(): int
+    public function getActorId(): int
     {
-        return $this->gsactor_id;
+        return $this->actor_id;
     }
 
     public function setAttachmentId(int $attachment_id): self
@@ -74,20 +79,15 @@ class Avatar extends Entity
         return $this->attachment_id;
     }
 
-    /**
+    public function setTitle(?string $title): self
-     * @return null|string
-     */
-    public function getFilename(): ?string
     {
-        return $this->filename;
+        $this->title = \is_null($title) ? null : mb_substr($title, 0, 191);
+        return $this;
     }
 
-    /**
+    public function getTitle(): ?string
-     * @param null|string $filename
-     */
-    public function setFilename(?string $filename): void
     {
-        $this->filename = $filename;
+        return $this->title;
     }
 
     public function setCreated(DateTimeInterface $created): self
@@ -117,17 +117,23 @@ class Avatar extends Entity
 
     private ?Attachment $attachment = null;
 
-    public function getUrl(): string
+    public function getUrl(string $size = 'medium', int $type = Router::ABSOLUTE_PATH): string
     {
-        return Router::url('avatar', ['gsactor_id' => $this->gsactor_id]);
+        $actor_id = $this->getActorId();
+        return Cache::get("avatar-url-{$actor_id}-{$size}-{$type}", fn () => Router::url('avatar_actor', ['actor_id' => $actor_id, 'size' => $size], $type));
     }
 
     public function getAttachment(): Attachment
     {
-        $this->attachment = $this->attachment ?: DB::findOneBy('attachment', ['id' => $this->attachment_id]);
+        $this->attachment ??= DB::findOneBy('attachment', ['id' => $this->getAttachmentId()]);
         return $this->attachment;
     }
 
+    public function getAttachmentThumbnail(string $size): ?AttachmentThumbnail
+    {
+        return AttachmentThumbnail::getOrCreate($this->getAttachment(), $size);
+    }
+
     public static function getFilePathStatic(string $filename): string
     {
         return Common::config('avatar', 'dir') . $filename;
@@ -140,15 +146,14 @@ class Avatar extends Entity
 
     /**
      * Delete this avatar and kill corresponding attachment
-     *
-     * @return bool
      */
     public function delete(): bool
     {
-        DB::remove($this);
+        $actor_id   = $this->getActorId();
         $attachment = $this->getAttachment();
+        DB::wrapInTransaction(fn () => DB::removeBy(static::class, ['actor_id' => $actor_id]));
         $attachment->kill();
-        DB::flush();
+        Event::handle('AvatarUpdate', [$actor_id]);
         return true;
     }
 
@@ -157,13 +162,13 @@ class Avatar extends Entity
         return [
             'name'   => 'avatar',
             'fields' => [
-                'gsactor_id'    => ['type' => 'int', 'foreign key' => true, 'target' => 'GSActor.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'foreign key to gsactor table'],
+                'actor_id'      => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'foreign key to actor table'],
                 'attachment_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Attachment.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'foreign key to attachment table'],
-                'filename'      => ['type' => 'varchar',   'length' => 191, 'description' => 'file name of resource when available'],
+                'title'         => ['type' => 'varchar',   'length' => 191, 'description' => 'file name of resource when available'],
                 'created'       => ['type' => 'datetime', 'not null' => true, 'description' => 'date this record was created', 'default' => 'CURRENT_TIMESTAMP'],
                 'modified'      => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified', 'default' => 'CURRENT_TIMESTAMP'],
             ],
-            'primary key' => ['gsactor_id'],
+            'primary key' => ['actor_id'],
             'indexes'     => [
                 'avatar_attachment_id_idx' => ['attachment_id'],
             ],

components/Avatar/Exception/NoAvatarException.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 
 // This file is part of GNU social - https://www.gnu.org/software/social

components/Avatar/config.yaml

@@ -0,0 +1,3 @@
+parameters:
+  avatar:
+    use_avatar: true

components/Avatar/templates/avatar/settings.html.twig

@@ -1,5 +1,4 @@
 <div class='form'>
-    <link href="{{ asset('assets/css/cropperjs/cropper.css') }}" rel="stylesheet">
     <script type="text/javascript" src="{{ asset('assets/javascript/cropping.js') }}"></script>
 
     {{ form(avatar) }}

components/Bridge/Bridge.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //

components/Bridge/Entity/ForeignLink.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -42,14 +44,14 @@ class ForeignLink
     private int $user_id;
     private int $foreign_id;
     private int $service;
-    private ?string $credentials;
+    private ?string $credentials                = null;
-    private int $noticesync  = 1;
+    private int $noticesync                     = 1;
-    private int $friendsync  = 2;
+    private int $friendsync                     = 2;
-    private int $profilesync = 1;
+    private int $profilesync                    = 1;
-    private ?\DateTimeInterface $last_noticesync;
+    private ?DateTimeInterface $last_noticesync = null;
-    private ?\DateTimeInterface $last_friendsync;
+    private ?DateTimeInterface $last_friendsync = null;
-    private \DateTimeInterface $created;
+    private DateTimeInterface $created;
-    private \DateTimeInterface $modified;
+    private DateTimeInterface $modified;
 
     public function setUserId(int $user_id): self
     {
@@ -86,7 +88,7 @@ class ForeignLink
 
     public function setCredentials(?string $credentials): self
     {
-        $this->credentials = $credentials;
+        $this->credentials = \is_null($credentials) ? null : mb_substr($credentials, 0, 191);
         return $this;
     }
 

components/Bridge/Entity/ForeignService.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -41,9 +43,9 @@ class ForeignService
     // @codeCoverageIgnoreStart
     private int $id;
     private string $name;
-    private ?string $description;
+    private ?string $description = null;
-    private \DateTimeInterface $created;
+    private DateTimeInterface $created;
-    private \DateTimeInterface $modified;
+    private DateTimeInterface $modified;
 
     public function setId(int $id): self
     {
@@ -58,7 +60,7 @@ class ForeignService
 
     public function setName(string $name): self
     {
-        $this->name = $name;
+        $this->name = mb_substr($name, 0, 32);
         return $this;
     }
 
@@ -69,7 +71,7 @@ class ForeignService
 
     public function setDescription(?string $description): self
     {
-        $this->description = $description;
+        $this->description = \is_null($description) ? null : mb_substr($description, 0, 191);
         return $this;
     }
 

components/Bridge/Entity/ForeignSubscription.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -42,7 +44,7 @@ class ForeignSubscription
     private int $service;
     private int $subscriber;
     private int $subscribed;
-    private \DateTimeInterface $created;
+    private DateTimeInterface $created;
 
     public function setService(int $service): self
     {

components/Bridge/Entity/ForeignUser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -42,9 +44,9 @@ class ForeignUser
     private int $id;
     private int $service;
     private string $uri;
-    private ?string $nickname;
+    private ?string $nickname = null;
-    private \DateTimeInterface $created;
+    private DateTimeInterface $created;
-    private \DateTimeInterface $modified;
+    private DateTimeInterface $modified;
 
     public function setId(int $id): self
     {
@@ -70,7 +72,7 @@ class ForeignUser
 
     public function setUri(string $uri): self
     {
-        $this->uri = $uri;
+        $this->uri = mb_substr($uri, 0, 191);
         return $this;
     }
 
@@ -81,7 +83,7 @@ class ForeignUser
 
     public function setNickname(?string $nickname): self
     {
-        $this->nickname = $nickname;
+        $this->nickname = \is_null($nickname) ? null : mb_substr($nickname, 0, 191);
         return $this;
     }
 

components/Circle/Circle.php

@@ -0,0 +1,232 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Circle;
+
+use App\Core\Cache;
+use App\Core\DB;
+use App\Core\Event;
+use function App\Core\I18n\_m;
+use App\Core\Modules\Component;
+use App\Core\Router;
+use App\Entity\Actor;
+use App\Entity\Feed;
+use App\Entity\LocalUser;
+use App\Util\Nickname;
+use Component\Circle\Controller as CircleController;
+use Component\Circle\Entity\ActorCircle;
+use Component\Circle\Entity\ActorCircleSubscription;
+use Component\Circle\Entity\ActorTag;
+use Component\Collection\Util\MetaCollectionTrait;
+use Component\Tag\Tag;
+use Functional as F;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Component responsible for handling and representing ActorCircles and ActorTags
+ *
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @author    Phablulo <phablulo@gmail.com>
+ * @author    Diogo Peralta Cordeiro <@diogo.site>
+ * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class Circle extends Component
+{
+    use MetaCollectionTrait;
+    public const TAG_CIRCLE_REGEX = '/' . Nickname::BEFORE_MENTIONS . '@#([\pL\pN_\-\.]{1,64})/';
+    protected const SLUG          = 'circle';
+    protected const PLURAL_SLUG   = 'circles';
+
+    public function onAddRoute(Router $r): bool
+    {
+        $r->connect('actor_circle_view_by_circle_id', '/circle/{circle_id<\d+>}', [CircleController\Circle::class, 'circleById']);
+        // View circle members by (tagger id or nickname) and tag
+        $r->connect('actor_circle_view_by_circle_tagger_tag', '/circle/actor/{tagger_id<\d+>/{tag<' . Tag::TAG_SLUG_REGEX . '>}}', [CircleController\Circle::class, 'circleByTaggerIdAndTag']);
+        $r->connect('actor_circle_view_by_circle_tagger_tag', '/circle/@{nickname<' . Nickname::DISPLAY_FMT . '>}/{tag<' . Tag::TAG_SLUG_REGEX . '>}', [CircleController\Circle::class, 'circleByTaggerNicknameAndTag']);
+
+        // View all circles by actor id or nickname
+        $r->connect(
+            id: 'actor_circles_view_by_actor_id',
+            uri_path: '/actor/{tag<' . Tag::TAG_SLUG_REGEX . '>}/circles',
+            target: [CircleController\Circles::class, 'collectionsViewByActorId'],
+        );
+        $r->connect(
+            id: 'actor_circles_view_by_nickname',
+            uri_path: '/@{nickname<' . Nickname::DISPLAY_FMT . '>}/circles',
+            target: [CircleController\Circles::class, 'collectionsViewByActorNickname'],
+        );
+
+        $r->connect('actor_circle_view_feed_by_circle_id', '/circle/{circle_id<\d+>}/feed', [CircleController\Circles::class, 'feedByCircleId']);
+        // View circle feed by (tagger id or nickname) and tag
+        $r->connect('actor_circle_view_feed_by_circle_tagger_tag', '/circle/actor/{tagger_id<\d+>/{tag<' . Tag::TAG_SLUG_REGEX . '>}}/feed', [CircleController\Circles::class, 'feedByTaggerIdAndTag']);
+        $r->connect('actor_circle_view_feed_by_circle_tagger_tag', '/circle/@{nickname<' . Nickname::DISPLAY_FMT . '>}/{tag<' . Tag::TAG_SLUG_REGEX . '>}/feed', [CircleController\Circles::class, 'feedByTaggerNicknameAndTag']);
+
+        return Event::next;
+    }
+
+    public static function cacheKeys(string $tag_single_or_multi): array
+    {
+        return [
+            'actor_single' => "actor-tag-feed-{$tag_single_or_multi}",
+            'actor_multi'  => "actor-tags-feed-{$tag_single_or_multi}",
+        ];
+    }
+
+    public function onPopulateSettingsTabs(Request $request, string $section, array &$tabs): bool
+    {
+        if ($section === 'profile' && \in_array($request->get('_route'), ['person_actor_settings', 'group_actor_settings'])) {
+            $tabs[] = [
+                'title'      => _m('Self tags'),
+                'desc'       => _m('Add or remove tags to this actor'),
+                'id'         => 'settings-self-tags',
+                'controller' => CircleController\SelfTagsSettings::settingsSelfTags($request, Actor::getById((int) $request->get('id')), 'settings-self-tags-details'),
+            ];
+        }
+        return Event::next;
+    }
+
+    public function onPostingFillTargetChoices(Request $request, Actor $actor, array &$targets): bool
+    {
+        $circles = $actor->getCircles();
+        foreach ($circles as $circle) {
+            $tag                = $circle->getTag();
+            $targets["#{$tag}"] = $tag;
+        }
+        return Event::next;
+    }
+
+    // Meta Collection -------------------------------------------------------------------
+
+    private function getActorIdFromVars(array $vars): int
+    {
+        $id = $vars['request']->get('id', null);
+        if ($id) {
+            return (int) $id;
+        }
+        $nick = $vars['request']->get('nickname');
+        $user = LocalUser::getByNickname($nick);
+        return $user->getId();
+    }
+
+    public static function createCircle(Actor|int $tagger_id, string $tag): int
+    {
+        $tagger_id = \is_int($tagger_id) ? $tagger_id : $tagger_id->getId();
+        $circle    = ActorCircle::create([
+            'tagger'      => $tagger_id,
+            'tag'         => $tag,
+            'description' => null, // TODO
+            'private'     => false, // TODO
+        ]);
+        DB::persist($circle);
+
+        Cache::delete(Actor::cacheKeys($tagger_id)['circles']);
+
+        return $circle->getId();
+    }
+
+    protected function createCollection(Actor $owner, array $vars, string $name)
+    {
+        $this->createCircle($owner, $name);
+        DB::persist(ActorTag::create([
+            'tagger' => $owner->getId(),
+            'tagged' => self::getActorIdFromVars($vars),
+            'tag'    => $name,
+        ]));
+    }
+
+    protected function removeItem(Actor $owner, array $vars, $items, array $collections)
+    {
+        $tagger_id                     = $owner->getId();
+        $tagged_id                     = $this->getActorIdFromVars($vars);
+        $circles_to_remove_tagged_from = DB::findBy(ActorCircle::class, ['id' => $items]);
+        foreach ($circles_to_remove_tagged_from as $circle) {
+            DB::removeBy(ActorCircleSubscription::class, ['actor_id' => $tagged_id, 'circle_id' => $circle->getId()]);
+        }
+        $tags = F\map($circles_to_remove_tagged_from, fn ($x) => $x->getTag());
+        foreach ($tags as $tag) {
+            DB::removeBy(ActorTag::class, ['tagger' => $tagger_id, 'tagged' => $tagged_id, 'tag' => $tag]);
+        }
+        Cache::delete(Actor::cacheKeys($tagger_id)['circles']);
+    }
+
+    protected function addItem(Actor $owner, array $vars, $items, array $collections)
+    {
+        $tagger_id                = $owner->getId();
+        $tagged_id                = $this->getActorIdFromVars($vars);
+        $circles_to_add_tagged_to = DB::findBy(ActorCircle::class, ['id' => $items]);
+        foreach ($circles_to_add_tagged_to as $circle) {
+            DB::persist(ActorCircleSubscription::create(['actor_id' => $tagged_id, 'circle_id' => $circle->getId()]));
+        }
+        $tags = F\map($circles_to_add_tagged_to, fn ($x) => $x->getTag());
+        foreach ($tags as $tag) {
+            DB::persist(ActorTag::create(['tagger' => $tagger_id, 'tagged' => $tagged_id, 'tag' => $tag]));
+        }
+        Cache::delete(Actor::cacheKeys($tagger_id)['circles']);
+    }
+
+    /**
+     * @see MetaCollectionPlugin->shouldAddToRightPanel
+     */
+    protected function shouldAddToRightPanel(Actor $user, $vars, Request $request): bool
+    {
+        return \in_array($vars['path'], ['actor_view_nickname', 'actor_view_id']);
+    }
+
+    /**
+     * Retrieves an array of Collections owned by an Actor.
+     * In this case, Collections of those within Actor's own circle of Actors, aka ActorCircle.
+     *
+     * Differs from the overwritten method in MetaCollectionsTrait, since retrieved Collections come from the $owner
+     * itself, and from every Actor that is a part of its ActorCircle.
+     *
+     * @param Actor      $owner    the Actor, and by extension its own circle of Actors
+     * @param null|array $vars     Page vars sent by AppendRightPanelBlock event
+     * @param bool       $ids_only true if only the Collections ids are to be returned
+     */
+    protected function getCollectionsBy(Actor $owner, ?array $vars = null, bool $ids_only = false): array
+    {
+        $tagged_id = !\is_null($vars) ? $this->getActorIdFromVars($vars) : null;
+        $circles   = \is_null($tagged_id) ? $owner->getCircles() : F\select($owner->getCircles(), function ($x) use ($tagged_id) {
+            foreach ($x->getActorTags() as $at) {
+                if ($at->getTagged() === $tagged_id) {
+                    return true;
+                }
+            }
+            return false;
+        });
+        return $ids_only ? array_map(fn ($x) => $x->getId(), $circles) : $circles;
+    }
+
+    public function onCreateDefaultFeeds(int $actor_id, LocalUser $user, int &$ordering)
+    {
+        DB::persist(Feed::create([
+            'actor_id' => $actor_id,
+            'url'      => Router::url($route = 'actor_circles_view_by_nickname', ['nickname' => $user->getNickname()]),
+            'route'    => $route,
+            'title'    => _m('Circles'),
+            'ordering' => $ordering++,
+        ]));
+        return Event::next;
+    }
+}

components/Circle/Controller/Circle.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Circle\Controller;
+
+use function App\Core\I18n\_m;
+use App\Entity\LocalUser;
+use App\Util\Exception\ClientException;
+use Component\Circle\Entity\ActorCircle;
+use Component\Collection\Util\Controller\CircleController;
+
+class Circle extends CircleController
+{
+    /**
+     * Render an existing ActorCircle with the given id as a Collection of Actors
+     *
+     * @param ActorCircle|int $circle_id the desired ActorCircle id
+     *
+     * @throws \App\Util\Exception\ServerException
+     * @throws ClientException
+     */
+    public function circleById(int|ActorCircle $circle_id): array
+    {
+        $circle = \is_int($circle_id) ? ActorCircle::getByPK(['id' => $circle_id]) : $circle_id;
+        unset($circle_id);
+        if (\is_null($circle)) {
+            throw new ClientException(_m('No such circle.'), 404);
+        } else {
+            return [
+                '_template'        => 'collection/actors.html.twig',
+                'title'            => _m('Circle'),
+                'empty_message'    => _m('No members.'),
+                'sort_form_fields' => [],
+                'page'             => $this->int('page') ?? 1,
+                'actors'           => $circle->getTaggedActors(),
+            ];
+        }
+    }
+
+    public function circleByTaggerIdAndTag(int $tagger_id, string $tag): array
+    {
+        return $this->circleById(ActorCircle::getByPK(['tagger' => $tagger_id, 'tag' => $tag]));
+    }
+
+    public function circleByTaggerNicknameAndTag(string $tagger_nickname, string $tag): array
+    {
+        return $this->circleById(ActorCircle::getByPK(['tagger' => LocalUser::getByNickname($tagger_nickname)->getId(), 'tag' => $tag]));
+    }
+}

components/Circle/Controller/Circles.php

@@ -0,0 +1,107 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Circle\Controller;
+
+use App\Core\Cache;
+use App\Core\DB;
+use App\Core\Router;
+use App\Entity\Actor;
+use App\Entity\LocalUser;
+use Component\Circle\Entity\ActorCircle;
+use Component\Collection\Util\Controller\MetaCollectionController;
+
+class Circles extends MetaCollectionController
+{
+    protected const SLUG         = 'circle';
+    protected const PLURAL_SLUG  = 'circles';
+    protected string $page_title = 'Actor circles';
+
+    public function createCollection(int $owner_id, string $name)
+    {
+        return \Component\Circle\Circle::createCircle($owner_id, $name);
+    }
+    public function getCollectionUrl(int $owner_id, ?string $owner_nickname, int $collection_id): string
+    {
+        return Router::url(
+            'actor_circle_view_by_circle_id',
+            ['circle_id' => $collection_id],
+        );
+    }
+
+    public function getCollectionItems(int $owner_id, $collection_id): array
+    {
+        $notes = []; // TODO: Use Feed::query
+        return [
+            '_template' => 'collection/notes.html.twig',
+            'notes'     => $notes,
+        ];
+    }
+
+    public function feedByCircleId(int $circle_id)
+    {
+        // Owner id isn't used
+        return $this->getCollectionItems(0, $circle_id);
+    }
+
+    public function feedByTaggerIdAndTag(int $tagger_id, string $tag)
+    {
+        // Owner id isn't used
+        $circle_id = ActorCircle::getByPK(['tagger' => $tagger_id, 'tag' => $tag])->getId();
+        return $this->getCollectionItems($tagger_id, $circle_id);
+    }
+
+    public function feedByTaggerNicknameAndTag(string $tagger_nickname, string $tag)
+    {
+        $tagger_id = LocalUser::getByNickname($tagger_nickname)->getId();
+        $circle_id = ActorCircle::getByPK(['tagger' => $tagger_id, 'tag' => $tag])->getId();
+        return $this->getCollectionItems($tagger_id, $circle_id);
+    }
+
+    public function getCollectionsByActorId(int $owner_id): array
+    {
+        return DB::findBy(ActorCircle::class, ['tagger' => $owner_id], order_by: ['id' => 'desc']);
+    }
+    public function getCollectionBy(int $owner_id, int $collection_id): ActorCircle
+    {
+        return DB::findOneBy(ActorCircle::class, ['id' => $collection_id, 'actor_id' => $owner_id]);
+    }
+
+    public function setCollectionName(int $actor_id, string $actor_nickname, ActorCircle $collection, string $name)
+    {
+        foreach ($collection->getActorTags(db_reference: true) as $at) {
+            $at->setTag($name);
+        }
+        $collection->setTag($name);
+        Cache::delete(Actor::cacheKeys($actor_id)['circles']);
+    }
+
+    public function removeCollection(int $actor_id, string $actor_nickname, ActorCircle $collection)
+    {
+        foreach ($collection->getActorTags(db_reference: true) as $at) {
+            DB::remove($at);
+        }
+        DB::remove($collection);
+        Cache::delete(Actor::cacheKeys($actor_id)['circles']);
+    }
+}

components/Circle/Controller/SelfTagsSettings.php

@@ -0,0 +1,118 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\Circle\Controller;
+
+use App\Core\Cache;
+use App\Core\Controller;
+use App\Core\DB;
+use function App\Core\I18n\_m;
+use App\Entity as E;
+use App\Util\Common;
+use App\Util\Exception\ClientException;
+use App\Util\Exception\RedirectException;
+use Component\Circle\Entity\ActorCircle;
+use Component\Circle\Entity\ActorTag;
+use Component\Circle\Form\SelfTagsForm;
+use Component\Tag\Tag as CompTag;
+use Symfony\Component\Form\SubmitButton;
+use Symfony\Component\HttpFoundation\Request;
+
+class SelfTagsSettings extends Controller
+{
+    /**
+     * Generic settings page for an Actor's self tags
+     * TODO: We should have $actor->setSelfTags(), $actor->addSelfTags(), $actor->removeSelfTags()
+     */
+    public static function settingsSelfTags(Request $request, E\Actor $target, string $details_id)
+    {
+        $actor = Common::actor();
+        if (!$actor->canModerate($target)) {
+            throw new ClientException(_m('You don\'t have enough permissions to edit {nickname}\'s settings', ['{nickname}' => $target->getNickname()]));
+        }
+
+        $actor_self_tags            = $target->getSelfTags();
+        [$add_form, $existing_form] = SelfTagsForm::handleTags(
+            $request,
+            $actor_self_tags,
+            handle_new: /**
+             * Handle adding tags
+             */
+            function ($form) use ($request, $target, $details_id) {
+                $data = $form->getData();
+                $tags = $data['new-tags'];
+                foreach ($tags as $tag) {
+                    $tag = CompTag::sanitize($tag);
+
+                    [$actor_tag, $actor_tag_existed] = ActorTag::checkExistingAndCreateOrUpdate([
+                        'tagger' => $target->getId(), // self tag means tagger = tagger in ActorTag
+                        'tagged' => $target->getId(),
+                        'tag'    => $tag,
+                    ]);
+                    if (!$actor_tag_existed) {
+                        DB::persist($actor_tag);
+                        // Try to find the self-tag circle
+                        $actor_circle = DB::findOneBy(
+                            ActorCircle::class,
+                            [
+                                'tagger' => null, // Self-tag circle
+                                'tag'    => $tag,
+                            ],
+                            return_null: true,
+                        );
+                        // It is the first time someone uses this self-tag!
+                        if (\is_null($actor_circle)) {
+                            DB::persist(ActorCircle::create([
+                                'tagger'      => null, // Self-tag circle
+                                'tag'         => $tag,
+                                'private'     => false, // by definition
+                                'description' => null, // The controller can show this in every language as appropriate
+                            ]));
+                        }
+                    }
+                }
+                DB::flush();
+                Cache::delete(E\Actor::cacheKeys($target->getId())['self-tags']);
+                throw new RedirectException($request->get('_route'), ['nickname' => $target->getNickname(), 'open' => $details_id, '_fragment' => $details_id]);
+            },
+            handle_existing: /**
+             * Handle changes to the existing tags
+             */
+            function ($form, array $form_definition) use ($request, $target, $details_id) {
+                $changed = false;
+                foreach (array_chunk($form_definition, 2) as $entry) {
+                    $tag = CompTag::sanitize($entry[0][2]['data']);
+
+                    /** @var SubmitButton $remove */
+                    $remove = $form->get($entry[1][0]);
+                    if ($remove->isClicked()) {
+                        $changed = true;
+                        DB::removeBy(
+                            'actor_tag',
+                            [
+                                'tagger' => $target->getId(),
+                                'tagged' => $target->getId(),
+                                'tag'    => $tag,
+                            ],
+                        );
+                        // We intentionally leave the self-tag actor circle, even if it is now empty
+                    }
+                }
+                if ($changed) {
+                    DB::flush();
+                    Cache::delete(E\Actor::cacheKeys($target->getId())['self-tags']);
+                    throw new RedirectException($request->get('_route'), ['nickname' => $target->getNickname(), 'open' => $details_id, '_fragment' => $details_id]);
+                }
+            },
+            remove_label: _m('Remove self tag'),
+            add_label: _m('Add self tag'),
+        );
+
+        return [
+            '_template'               => 'self_tags_settings.fragment.html.twig',
+            'add_self_tags_form'      => $add_form->createView(),
+            'existing_self_tags_form' => $existing_form?->createView(),
+        ];
+    }
+}

components/Circle/Entity/ActorCircle.php

@@ -0,0 +1,221 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+namespace Component\Circle\Entity;
+
+use App\Core\Cache;
+use App\Core\DB;
+use App\Core\Entity;
+use App\Core\Router;
+use DateTimeInterface;
+
+/**
+ * Entity for List of actors
+ * This entity only makes sense when considered together with the ActorTag one.
+ * Because, every circle entry will be an ActorTag.
+ *
+ * @category  DB
+ * @package   GNUsocial
+ *
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2010 StatusNet Inc.
+ * @author    Mikael Nordfeldth <mmn@hethane.se>
+ * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @author    Diogo Peralta Cordeiro <@diogo.site>
+ * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class ActorCircle extends Entity
+{
+    // {{{ Autocode
+    // @codeCoverageIgnoreStart
+    private int $id;
+    private ?int $tagger = null;
+    private string $tag;
+    private ?string $description = null;
+    private ?bool $private       = false;
+    private DateTimeInterface $created;
+    private DateTimeInterface $modified;
+
+    public function setId(int $id): self
+    {
+        $this->id = $id;
+        return $this;
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function setTagger(?int $tagger): self
+    {
+        $this->tagger = $tagger;
+        return $this;
+    }
+
+    public function getTagger(): ?int
+    {
+        return $this->tagger;
+    }
+
+    public function setTag(string $tag): self
+    {
+        $this->tag = mb_substr($tag, 0, 64);
+        return $this;
+    }
+
+    public function getTag(): string
+    {
+        return $this->tag;
+    }
+
+    public function setDescription(?string $description): self
+    {
+        $this->description = $description;
+        return $this;
+    }
+
+    public function getDescription(): ?string
+    {
+        return $this->description;
+    }
+
+    public function setPrivate(?bool $private): self
+    {
+        $this->private = $private;
+        return $this;
+    }
+
+    public function getPrivate(): ?bool
+    {
+        return $this->private;
+    }
+
+    public function setCreated(DateTimeInterface $created): self
+    {
+        $this->created = $created;
+        return $this;
+    }
+
+    public function getCreated(): DateTimeInterface
+    {
+        return $this->created;
+    }
+
+    public function setModified(DateTimeInterface $modified): self
+    {
+        $this->modified = $modified;
+        return $this;
+    }
+
+    public function getModified(): DateTimeInterface
+    {
+        return $this->modified;
+    }
+
+    // @codeCoverageIgnoreEnd
+    // }}} Autocode
+
+    /**
+     * For use with MetaCollection trait only
+     */
+    public function getName(): string
+    {
+        return $this->tag;
+    }
+
+    public function getActorTags(bool $db_reference = false): array
+    {
+        $handle = fn () => DB::findBy('actor_tag', ['tagger' => $this->getTagger(), 'tag' => $this->getTag()]);
+        if ($db_reference) {
+            return $handle();
+        }
+        return Cache::get(
+            "circle-{$this->getId()}-tagged",
+            $handle,
+        );
+    }
+
+    public function getTaggedActors()
+    {
+        return Cache::get(
+            "circle-{$this->getId()}-tagged-actors",
+            function () {
+                if ($this->getTagger()) {
+                    return DB::dql('SELECT a FROM actor AS a JOIN actor_tag AS at WITH at.tagged = a.id WHERE at.tag = :tag AND at.tagger = :tagger', ['tag' => $this->getTag(), 'tagger' => $this->getTagger()]);
+                } else { // Self-tag
+                    return DB::dql('SELECT a FROM actor AS a JOIN actor_tag AS at WITH at.tagged = a.id WHERE at.tag = :tag AND at.tagger = at.tagged', ['tag' => $this->getTag()]);
+                }
+            },
+        );
+    }
+
+    public function getSubscribedActors(?int $offset = null, ?int $limit = null): array
+    {
+        return Cache::get(
+            "circle-{$this->getId()}-subscribers",
+            fn () => DB::dql(
+                <<< 'EOQ'
+                    SELECT a
+                    FROM actor a
+                    JOIN actor_circle_subscription s
+                        WITH a.id = s.actor_id
+                    ORDER BY s.created DESC, a.id DESC
+                    EOQ,
+                options: [
+                    'offset' => $offset,
+                    'limit'  => $limit,
+                ],
+            ),
+        );
+    }
+
+    public function getUrl(int $type = Router::ABSOLUTE_PATH): string
+    {
+        return Router::url('actor_circle_view_by_circle_id', ['circle_id' => $this->getId()], type: $type);
+    }
+
+    public static function schemaDef(): array
+    {
+        return [
+            'name'        => 'actor_circle',
+            'description' => 'An actor can have lists of actors, to separate their feed or quickly mention his friend',
+            'fields'      => [
+                'id'          => ['type' => 'serial',    'not null' => true, 'description' => 'unique identifier'], // An actor can be tagged by many actors
+                'tagger'      => ['type' => 'int',       'default' => null, 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'many to one', 'name' => 'actor_list_tagger_fkey', 'description' => 'user making the tag, null if self-tag. If null, is the special global self-tag circle'],
+                'tag'         => ['type' => 'varchar',   'length' => 64, 'foreign key' => true, 'target' => 'ActorTag.tag', 'multiplicity' => 'many to one', 'not null' => true, 'description' => 'actor tag'], // Join with ActorTag // // so, Doctrine doesn't like that the target is not unique, even though the pair is  // Many Actor Circles can reference (and probably will) an Actor Tag
+                'description' => ['type' => 'text',      'description' => 'description of the people tag'],
+                'private'     => ['type' => 'bool',      'default' => false, 'description' => 'is this tag private'],
+                'created'     => ['type' => 'datetime',  'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
+                'modified'    => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
+            ],
+            'primary key' => ['id'], // But we will mostly refer to them with `tagger` and `tag`
+            'indexes'     => [
+                'actor_list_modified_idx'   => ['modified'],
+                'actor_list_tagger_tag_idx' => ['tagger', 'tag'], // The actual identifier we will use the most
+                'actor_list_tag_idx'        => ['tag'],
+                'actor_list_tagger_idx'     => ['tagger'],
+            ],
+        ];
+    }
+}

components/Circle/Entity/ActorCircleSubscription.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -17,13 +19,15 @@
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
 // }}}
 
-namespace App\Entity;
+namespace Component\Circle\Entity;
 
 use App\Core\Entity;
 use DateTimeInterface;
 
 /**
- * Entity for subscription
+ * Entity for actor circle subscriptions
+ * This entity only makes sense when considered with the ActorCircle entity.
+ * Because you can only subscribe a Circle that exists.
  *
  * @category  DB
  * @package   GNUsocial
@@ -33,38 +37,39 @@ use DateTimeInterface;
  * @author    Mikael Nordfeldth <mmn@hethane.se>
  * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
  * @author    Hugo Sales <hugo@hsal.es>
+ * @author    Diogo Peralta Cordeiro <@diogo.site>
  * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
  * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
  */
-class Follow extends Entity
+class ActorCircleSubscription extends Entity
 {
     // {{{ Autocode
     // @codeCoverageIgnoreStart
-    private int $follower;
+    private int $actor_id;
-    private int $followed;
+    private int $circle_id;
-    private \DateTimeInterface $created;
+    private DateTimeInterface $created;
-    private \DateTimeInterface $modified;
+    private DateTimeInterface $modified;
 
-    public function setFollower(int $follower): self
+    public function setActorId(int $actor_id): self
     {
-        $this->follower = $follower;
+        $this->actor_id = $actor_id;
         return $this;
     }
 
-    public function getFollower(): int
+    public function getActorId(): int
     {
-        return $this->follower;
+        return $this->actor_id;
     }
 
-    public function setFollowed(int $followed): self
+    public function setCircleId(int $circle_id): self
     {
-        $this->followed = $followed;
+        $this->circle_id = $circle_id;
         return $this;
     }
 
-    public function getFollowed(): int
+    public function getCircleId(): int
     {
-        return $this->followed;
+        return $this->circle_id;
     }
 
     public function setCreated(DateTimeInterface $created): self
@@ -95,17 +100,18 @@ class Follow extends Entity
     public static function schemaDef(): array
     {
         return [
-            'name'   => 'follow',
+            'name'   => 'actor_circle_subscription',
             'fields' => [
-                'follower' => ['type' => 'int', 'foreign key' => true, 'target' => 'GSActor.id', 'multiplicity' => 'one to one', 'name' => 'follow_follower_fkey', 'not null' => true,  'description' => 'gsactor listening'],
+                'actor_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'name' => 'actor_circle_subscription_actor_id_fkey', 'not null' => true, 'description' => 'foreign key to actor table'],
-                'followed' => ['type' => 'int', 'foreign key' => true, 'target' => 'GSActor.id', 'multiplicity' => 'one to one', 'name' => 'follow_followed_fkey', 'not null' => true,  'description' => 'gsactor being listened to'],
+                // An actor subscribes many circles; A Circle is subscribed by many actors.
-                'created'  => ['type' => 'datetime',  'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
+                'circle_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'ActorCircle.id', 'multiplicity' => 'one to many', 'name' => 'actor_circle_subscription_actor_circle_fkey', 'not null' => true, 'description' => 'foreign key to actor_circle'],
-                'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
+                'created'   => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
+                'modified'  => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
             ],
-            'primary key' => ['follower', 'followed'],
+            'primary key' => ['circle_id', 'actor_id'],
             'indexes'     => [
-                'follow_follower_idx' => ['follower', 'created'],
+                'actor_circle_subscription_actor_id_idx' => ['actor_id'],
-                'follow_followed_idx' => ['followed', 'created'],
+                'actor_circle_subscription_created_idx'  => ['created'],
             ],
         ];
     }

components/Circle/Entity/ActorTag.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
@@ -17,13 +19,21 @@
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
 // }}}
 
-namespace App\Entity;
+namespace Component\Circle\Entity;
 
+use App\Core\DB;
 use App\Core\Entity;
+use App\Core\Router;
+use App\Entity\Actor;
+use Component\Tag\Tag;
 use DateTimeInterface;
 
 /**
- * Entity for GSActor Tag
+ * Entity for Actor Tag
+ * This entity represents the relationship between an Actor and a Tag.
+ * That relationship works as follows:
+ * An Actor A tags an Actor B (which can be A - a self tag).
+ * For every tagging that happens between two actors, a new ActorTag is born.
  *
  * @category  DB
  * @package   GNUsocial
@@ -33,17 +43,18 @@ use DateTimeInterface;
  * @author    Mikael Nordfeldth <mmn@hethane.se>
  * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
  * @author    Hugo Sales <hugo@hsal.es>
+ * @author    Diogo Peralta Cordeiro <@diogo.site>
  * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
  * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
  */
-class GSActorTag extends Entity
+class ActorTag extends Entity
 {
     // {{{ Autocode
     // @codeCoverageIgnoreStart
     private int $tagger;
     private int $tagged;
     private string $tag;
-    private \DateTimeInterface $modified;
+    private DateTimeInterface $modified;
 
     public function setTagger(int $tagger): self
     {
@@ -69,7 +80,7 @@ class GSActorTag extends Entity
 
     public function setTag(string $tag): self
     {
-        $this->tag = $tag;
+        $this->tag = mb_substr($tag, 0, 64);
         return $this;
     }
 
@@ -92,27 +103,39 @@ class GSActorTag extends Entity
     // @codeCoverageIgnoreEnd
     // }}} Autocode
 
+    public function getUrl(?Actor $actor = null, int $type = Router::ABSOLUTE_PATH): string
+    {
+        $params = ['tag' => $this->getTag()];
+        if (!\is_null($actor)) {
+            $params['locale'] = $actor->getTopLanguage()->getLocale();
+        }
+        return Router::url('single_actor_tag', $params, type: $type);
+    }
+
+    public function getCircle(): ActorCircle
+    {
+        if ($this->getTagger() === $this->getTagged()) { // Self-tag
+            return DB::findOneBy(ActorCircle::class, ['tagger' => null, 'tag' => $this->getTag()]);
+        } else {
+            return DB::findOneBy(ActorCircle::class, ['tagger' => $this->getTagger(), 'tag' => $this->getTag()]);
+        }
+    }
+
     public static function schemaDef(): array
     {
         return [
-            'name'   => 'gsactor_tag',
+            'name'   => 'actor_tag',
             'fields' => [
-                'tagger'   => ['type' => 'int', 'foreign key' => true, 'target' => 'GSActor.id', 'multiplicity' => 'one to one', 'nmae' => 'gsactor_tag_tagger_fkey', 'not null' => true, 'description' => 'user making the tag'],
+                'tagger'   => ['type' => 'int',       'not null' => true, 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'name' => 'actor_tag_tagger_fkey', 'description' => 'actor making the tag'],
-                'tagged'   => ['type' => 'int', 'foreign key' => true, 'target' => 'GSActor.id', 'multiplicity' => 'one to one', 'name' => 'gsactor_tag_tagged_fkey', 'not null' => true, 'description' => 'gsactor tagged'],
+                'tagged'   => ['type' => 'int',       'not null' => true, 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'name' => 'actor_tag_tagged_fkey', 'description' => 'actor tagged'],
-                'tag'      => ['type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'hash tag associated with this notice'],
+                'tag'      => ['type' => 'varchar',  'length' => Tag::MAX_TAG_LENGTH, 'not null' => true, 'description' => 'hashtag associated with this note'],
                 'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
-            ],
+            ], // We will always assume the tagger's preferred language for tags and circles
             'primary key' => ['tagger', 'tagged', 'tag'],
             'indexes'     => [
-                'gsactor_tag_modified_idx'   => ['modified'],
+                'actor_tag_tagger_tag_idx' => ['tagger', 'tag'], // For Circles
-                'gsactor_tag_tagger_tag_idx' => ['tagger', 'tag'], // For Circles
+                'actor_tag_tagged_idx'     => ['tagged'],
-                'gsactor_tag_tagged_idx'     => ['tagged'],
             ],
         ];
     }
-
-    public function __toString()
-    {
-        return $this->tag;
-    }
 }

components/Circle/Form/SelfTagsForm.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\Circle\Form;
+
+use App\Core\Form;
+use function App\Core\I18n\_m;
+use App\Util\Form\ArrayTransformer;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\HttpFoundation\Request;
+
+abstract class SelfTagsForm
+{
+    /**
+     * @return array [Form (add), ?Form (existing)]
+     */
+    public static function handleTags(
+        Request $request,
+        array $actor_self_tags,
+        callable $handle_new,
+        callable $handle_existing,
+        string $remove_label,
+        string $add_label,
+    ): array {
+        $form_definition = [];
+        foreach ($actor_self_tags as $tag) {
+            $tag               = $tag->getTag();
+            $form_definition[] = ["{$tag}:old-tag", TextType::class, ['data' => $tag, 'label' => ' ', 'disabled' => true]];
+            $form_definition[] = [$existing_form_name = "{$tag}:remove", SubmitType::class, ['label' => $remove_label]];
+        }
+
+        $existing_form = !empty($form_definition) ? Form::create($form_definition) : null;
+
+        $add_form = Form::create([
+            ['new-tags', TextType::class, ['label' => ' ', 'data' => [], 'required' => false, 'help' => _m('Tags for this actor (letters, numbers, -, ., and _), comma- or space-separated.'), 'transformer' => ArrayTransformer::class]],
+            [$add_form_name = 'new-tags-add', SubmitType::class, ['label' => $add_label]],
+        ]);
+
+        if ($request->getMethod() === 'POST' && $request->request->has($add_form_name)) {
+            $add_form->handleRequest($request);
+            if ($add_form->isSubmitted() && $add_form->isValid()) {
+                $handle_new($add_form);
+            }
+        }
+
+        if (!\is_null($existing_form) && $request->getMethod() === 'POST' && $request->request->has($existing_form_name ?? '')) {
+            $existing_form->handleRequest($request);
+            if ($existing_form->isSubmitted() && $existing_form->isValid()) {
+                $handle_existing($existing_form, $form_definition);
+            }
+        }
+
+        return [$add_form, $existing_form];
+    }
+}

components/Collection/Collection.php

@@ -0,0 +1,163 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\Collection;
+
+use App\Core\DB;
+use App\Core\Event;
+use App\Core\Modules\Component;
+use App\Entity\Actor;
+use App\Util\Formatting;
+use Component\Collection\Util\Parser;
+use Component\Subscription\Entity\ActorSubscription;
+use Doctrine\Common\Collections\ExpressionBuilder;
+use Doctrine\ORM\Query\Expr;
+use Doctrine\ORM\QueryBuilder;
+
+class Collection extends Component
+{
+    /**
+     * Perform a high level query on notes or actors
+     *
+     * Supports a variety of query terms and is used both in feeds and
+     * in search. Uses query builders to allow for extension
+     */
+    public static function query(string $query, int $page, ?string $locale = null, ?Actor $actor = null, array $note_order_by = [], array $actor_order_by = []): array
+    {
+        $note_criteria  = null;
+        $actor_criteria = null;
+        if (!empty($query = trim($query))) {
+            [$note_criteria, $actor_criteria] = Parser::parse($query, $locale, $actor);
+        }
+
+        $note_qb  = DB::createQueryBuilder();
+        $actor_qb = DB::createQueryBuilder();
+        // TODO consider selecting note related stuff, to avoid separate queries (though they're cached, so maybe it's okay)
+        $note_qb->select('note')->from('App\Entity\Note', 'note');
+        $actor_qb->select('actor')->from('App\Entity\Actor', 'actor');
+        Event::handle('CollectionQueryAddJoins', [&$note_qb, &$actor_qb, $note_criteria, $actor_criteria]);
+
+        // Handle ordering
+        $note_order_by  = !empty($note_order_by) ? $note_order_by : ['note.created' => 'DESC', 'note.id' => 'DESC'];
+        $actor_order_by = !empty($actor_order_by) ? $actor_order_by : ['actor.created' => 'DESC', 'actor.id' => 'DESC'];
+        foreach ($note_order_by as $field => $order) {
+            $note_qb->addOrderBy($field, $order);
+        }
+        foreach ($actor_order_by as $field => $order) {
+            $actor_qb->addOrderBy($field, $order);
+        }
+
+        $notes  = [];
+        $actors = [];
+        if (!\is_null($note_criteria)) {
+            $note_qb->addCriteria($note_criteria);
+            $notes = $note_qb->getQuery()->execute();
+        }
+
+        if (!\is_null($actor_criteria)) {
+            $actor_qb->addCriteria($actor_criteria);
+            $actors = $actor_qb->getQuery()->execute();
+        }
+
+        // N.B.: Scope is only enforced at FeedController level
+        return ['notes' => $notes ?? null, 'actors' => $actors ?? null];
+    }
+
+    public function onCollectionQueryAddJoins(QueryBuilder &$note_qb, QueryBuilder &$actor_qb): bool
+    {
+        $note_aliases = $note_qb->getAllAliases();
+        if (!\in_array('subscription', $note_aliases)) {
+            $note_qb->leftJoin(ActorSubscription::class, 'subscription', Expr\Join::WITH, 'note.actor_id = subscription.subscribed_id');
+        }
+        if (!\in_array('note_actor', $note_aliases)) {
+            $note_qb->leftJoin(Actor::class, 'note_actor', Expr\Join::WITH, 'note.actor_id = note_actor.id');
+        }
+        return Event::next;
+    }
+
+    /**
+     * Convert $term to $note_expr and $actor_expr, search criteria. Handles searching for text
+     * notes, for different types of actors and for the content of text notes
+     */
+    public function onCollectionQueryCreateExpression(ExpressionBuilder $eb, string $term, ?string $locale, ?Actor $actor, &$note_expr, &$actor_expr)
+    {
+        if (str_contains($term, ':')) {
+            $term = explode(':', $term);
+            if (Formatting::startsWith($term[0], 'note')) {
+                switch ($term[0]) {
+                case 'notes-all':
+                    $note_expr = $eb->neq('note.created', null);
+                    break;
+                case 'note-local':
+                    $note_expr = $eb->eq('note.is_local', filter_var($term[1], \FILTER_VALIDATE_BOOLEAN));
+                    break;
+                case 'note-types':
+                case 'notes-include':
+                case 'note-filter':
+                    if (\is_null($note_expr)) {
+                        $note_expr = [];
+                    }
+                    if (array_intersect(explode(',', $term[1]), ['text', 'words']) !== []) {
+                        $note_expr[] = $eb->neq('note.content', null);
+                    } else {
+                        $note_expr[] = $eb->eq('note.content', null);
+                    }
+                    break;
+                case 'note-conversation':
+                    $note_expr = $eb->eq('note.conversation_id', (int) trim($term[1]));
+                    break;
+                case 'note-from':
+                case 'notes-from':
+                    $subscribed_expr = $eb->eq('subscription.subscriber_id', $actor->getId());
+                    $type_consts     = [];
+                    if ($term[1] === 'subscribed') {
+                        $type_consts = null;
+                    }
+                    foreach (explode(',', $term[1]) as $from) {
+                        if (str_starts_with($from, 'subscribed-')) {
+                            [, $type] = explode('-', $from);
+                            if (\in_array($type, ['actor', 'actors'])) {
+                                $type_consts = null;
+                            } else {
+                                $type_consts[] = \constant(Actor::class . '::' . mb_strtoupper($type === 'organisation' ? 'group' : $type));
+                            }
+                        }
+                    }
+                    if (\is_null($type_consts)) {
+                        $note_expr = $subscribed_expr;
+                    } elseif (!empty($type_consts)) {
+                        $note_expr = $eb->andX($subscribed_expr, $eb->in('note_actor.type', $type_consts));
+                    }
+                    break;
+                }
+            } elseif (Formatting::startsWith($term, 'actor-')) {
+                switch ($term[0]) {
+                    case 'actor-types':
+                    case 'actors-include':
+                    case 'actor-filter':
+                    case 'actor-local':
+                        if (\is_null($actor_expr)) {
+                            $actor_expr = [];
+                        }
+                        foreach (
+                            [
+                                Actor::PERSON => ['person', 'people'],
+                                Actor::GROUP => ['group', 'groups', 'org', 'orgs', 'organisation', 'organisations', 'organization', 'organizations'],
+                                Actor::BOT => ['bot', 'bots'],
+                            ] as $type => $match) {
+                            if (array_intersect(explode(',', $term[1]), $match) !== []) {
+                                $actor_expr[] = $eb->eq('actor.type', $type);
+                            } else {
+                                $actor_expr[] = $eb->neq('actor.type', $type);
+                            }
+                        }
+                        break;
+                }
+            }
+        } else {
+            $note_expr = $eb->contains('note.content', $term);
+        }
+        return Event::next;
+    }
+}

components/Collection/Util/Controller/CircleController.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\Collection\Util\Controller;
+
+class CircleController extends OrderedCollection
+{
+}

components/Collection/Util/Controller/Collection.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\Collection\Util\Controller;
+
+use App\Core\Controller;
+use App\Entity\Actor;
+use App\Util\Common;
+use Component\Collection\Collection as CollectionModule;
+
+class Collection extends Controller
+{
+    public function query(string $query, ?string $locale = null, ?Actor $actor = null, array $note_order_by = [], array $actor_order_by = []): array
+    {
+        $actor  ??= Common::actor();
+        $locale ??= Common::currentLanguage()->getLocale();
+        return CollectionModule::query($query, $this->int('page') ?? 1, $locale, $actor, $note_order_by, $actor_order_by);
+    }
+}

components/Collection/Util/Controller/FeedController.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+/**
+ * Base class for feed controllers
+ *
+ * @package  GNUsocial
+ * @category Controller
+ *
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\Collection\Util\Controller;
+
+use App\Core\Event;
+use App\Entity\Actor;
+use App\Entity\Note;
+use App\Util\Common;
+use Functional as F;
+
+abstract class FeedController extends OrderedCollection
+{
+    /**
+     * Post-processing of the result of a feed controller, to remove any
+     * notes or actors the user specified, as well as format the raw
+     * list of notes into a usable format
+     */
+    protected function postProcess(array $result): array
+    {
+        $actor = Common::actor();
+        if (\array_key_exists('notes', $result)) {
+            $notes = $result['notes'];
+            self::enforceScope($notes, $actor, $result['actor'] ?? null);
+            Event::handle('FilterNoteList', [$actor, &$notes, $result['request']]);
+            Event::handle('FormatNoteList', [$notes, &$result['notes'], &$result['request']]);
+        }
+
+        return $result;
+    }
+
+    private static function enforceScope(array &$notes, ?Actor $actor, ?Actor $in = null): void
+    {
+        $notes = F\select($notes, fn (Note $n) => $n->isVisibleTo($actor, $in));
+    }
+}

components/Collection/Util/Controller/MetaCollectionController.php

@@ -0,0 +1,216 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+/**
+ * Collections Controller for GNU social
+ *
+ * @package   GNUsocial
+ * @category  Plugin
+ *
+ * @author    Phablulo <phablulo@gmail.com>
+ * @copyright 2018-2019, 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\Collection\Util\Controller;
+
+use App\Core\DB;
+use App\Core\Form;
+use function App\Core\I18n\_m;
+use App\Entity\LocalUser;
+use App\Util\Common;
+use App\Util\Exception\RedirectException;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\HttpFoundation\Request;
+
+abstract class MetaCollectionController extends FeedController
+{
+    protected const SLUG         = 'collectionsEntry';
+    protected const PLURAL_SLUG  = 'collectionsList';
+    protected string $page_title = 'Collections';
+
+    abstract public function getCollectionUrl(int $owner_id, string $owner_nickname, int $collection_id): string;
+    abstract public function getCollectionItems(int $owner_id, $collection_id): array;
+    abstract public function getCollectionsByActorId(int $owner_id): array;
+    abstract public function getCollectionBy(int $owner_id, int $collection_id);
+    abstract public function createCollection(int $owner_id, string $name);
+
+    public function collectionsViewByActorNickname(Request $request, string $nickname): array
+    {
+        $user = DB::findOneBy(LocalUser::class, ['nickname' => $nickname]);
+        return self::collectionsView($request, $user->getId(), $nickname);
+    }
+
+    public function collectionsViewByActorId(Request $request, int $id): array
+    {
+        return self::collectionsView($request, $id, null);
+    }
+
+    /**
+     * Generate Collections page
+     *
+     * @param int     $id       actor id
+     * @param ?string $nickname actor nickname
+     *
+     * @return array twig template options
+     */
+    public function collectionsView(Request $request, int $id, ?string $nickname): array
+    {
+        $collections = $this->getCollectionsByActorId($id);
+
+        $create_title      = _m('Create a ' . mb_strtolower(preg_replace('/([a-z0-9])([A-Z])/', '$1 $2', static::SLUG)));
+        $collections_title = _m('The ' . mb_strtolower(preg_replace('/([a-z0-9])([A-Z])/', '$1 $2', static::PLURAL_SLUG)));
+        // create collection form
+        $create = null;
+        if (Common::user()?->getId() === $id) {
+            $create = Form::create([
+                ['name', TextType::class, [
+                    'label' => $create_title,
+                    'attr'  => [
+                        'placeholder' => _m('Name'),
+                        'required'    => 'required',
+                    ],
+                    'data' => '',
+                ]],
+                ['add_collection', SubmitType::class, [
+                    'label' => $create_title,
+                    'attr'  => [
+                        'title' => $create_title,
+                    ],
+                ]],
+            ]);
+            $create->handleRequest($request);
+            if ($create->isSubmitted() && $create->isValid()) {
+                $this->createCollection($id, $create->getData()['name']);
+                DB::flush();
+                throw new RedirectException();
+            }
+        }
+
+        // We need to inject some functions in twig,
+        // but I don't want to create an environment for this
+        // as twig docs suggest in https://twig.symfony.com/doc/2.x/advanced.html#functions.
+        //
+        // Instead, I'm using an anonymous class to encapsulate
+        // the functions and passing that class to the template.
+        // This is suggested at https://web.archive.org/web/20220226132328/https://stackoverflow.com/questions/3595727/twig-pass-function-into-template/50364502
+        $fn = new class($id, $nickname, $request, $this, static::SLUG) {
+            private $id;
+            private $nick;
+            private $request;
+            private $parent;
+            private $slug;
+
+            public function __construct($id, $nickname, $request, $parent, $slug)
+            {
+                $this->id      = $id;
+                $this->nick    = $nickname;
+                $this->request = $request;
+                $this->parent  = $parent;
+                $this->slug    = $slug;
+            }
+            // there's already an injected function called path,
+            // that maps to Router::url(name, args), but since
+            // I want to preserve nicknames, I think it's better
+            // to use that getUrl function
+            public function getUrl($cid)
+            {
+                return $this->parent->getCollectionUrl($this->id, $this->nick, $cid);
+            }
+            // There are many collections in this page and we need two
+            // forms for each one of them: one form to edit the collection's
+            // name and another to remove the collection.
+
+            // creating the edit form
+            public function editForm($collection)
+            {
+                $edit = Form::create([
+                    ['name', TextType::class, [
+                        'attr' => [
+                            'placeholder' => 'New name',
+                            'required'    => 'required',
+                        ],
+                        'data' => '',
+                    ]],
+                    ['update_' . $collection->getId(), SubmitType::class, [
+                        'label' => _m('Save'),
+                        'attr'  => [
+                            'title' => _m('Save'),
+                        ],
+                    ]],
+                ]);
+                $edit->handleRequest($this->request);
+                if ($edit->isSubmitted() && $edit->isValid()) {
+                    $this->parent->setCollectionName($this->id, $this->nick, $collection, $edit->getData()['name']);
+                    DB::flush();
+                    throw new RedirectException();
+                }
+                return $edit->createView();
+            }
+
+            // creating the remove form
+            public function rmForm($collection)
+            {
+                $rm = Form::create([
+                    ['remove_' . $collection->getId(), SubmitType::class, [
+                        'label' => _m('Delete ' . $this->slug),
+                        'attr'  => [
+                            'title' => _m('Delete ' . $this->slug),
+                            'class' => 'danger',
+                        ],
+                    ]],
+                ]);
+                $rm->handleRequest($this->request);
+                if ($rm->isSubmitted()) {
+                    $this->parent->removeCollection($this->id, $this->nick, $collection);
+                    DB::flush();
+                    throw new RedirectException();
+                }
+                return $rm->createView();
+            }
+        };
+
+        return [
+            '_template'      => 'collection/meta_collections.html.twig',
+            'page_title'     => $this->page_title,
+            'list_title'     => $collections_title,
+            'add_collection' => $create?->createView(),
+            'fn'             => $fn,
+            'collections'    => $collections,
+        ];
+    }
+
+    public function collectionsEntryViewNotesByNickname(Request $request, string $nickname, int $cid): array
+    {
+        $user = DB::findOneBy(LocalUser::class, ['nickname' => $nickname]);
+        return self::collectionsEntryViewNotesByActorId($request, $user->getId(), $cid);
+    }
+
+    public function collectionsEntryViewNotesByActorId(Request $request, int $id, int $cid): array
+    {
+        $collection = $this->getCollectionBy($id, $cid);
+        $vars       = $this->getCollectionItems($id, $cid);
+        return array_merge([
+            '_template'  => 'collections/collection_entry_view.html.twig',
+            'page_title' => $collection->getName(),
+        ], $vars);
+    }
+}

components/Collection/Util/Controller/OrderedCollection.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\Collection\Util\Controller;
+
+class OrderedCollection extends Collection
+{
+}

components/Collection/Util/MetaCollectionTrait.php

@@ -0,0 +1,195 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+/**
+ * Collections for GNU social
+ *
+ * @package   GNUsocial
+ * @category  Plugin
+ *
+ * @author    Phablulo <phablulo@gmail.com>
+ * @copyright 2018-2019, 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\Collection\Util;
+
+use App\Core\DB;
+use App\Core\Event;
+use App\Core\Form;
+use function App\Core\I18n\_m;
+use App\Entity\Actor;
+use App\Util\Common;
+use App\Util\Exception\RedirectException;
+use App\Util\Formatting;
+use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\HttpFoundation\Request;
+
+trait MetaCollectionTrait
+{
+    //protected const SLUG        = 'collection';
+    //protected const PLURAL_SLUG = 'collections';
+
+    /**
+     * create a collection owned by Actor $owner.
+     *
+     * @param Actor  $owner The collection's owner
+     * @param array  $vars  Page vars sent by AppendRightPanelBlock event
+     * @param string $name  Collection's name
+     */
+    abstract protected function createCollection(Actor $owner, array $vars, string $name);
+    /**
+     * remove item from collections.
+     *
+     * @param Actor $owner       Current user
+     * @param array $vars        Page vars sent by AppendRightPanelBlock event
+     * @param array $items       Array of collections's ids to remove the current item from
+     * @param array $collections List of ids of collections owned by $owner
+     */
+    abstract protected function removeItem(Actor $owner, array $vars, array $items, array $collections);
+    /**
+     * add item to collections.
+     *
+     * @param Actor $owner       Current user
+     * @param array $vars        Page vars sent by AppendRightPanelBlock event
+     * @param array $items       Array of collections's ids to add the current item to
+     * @param array $collections List of ids of collections owned by $owner
+     */
+    abstract protected function addItem(Actor $owner, array $vars, array $items, array $collections);
+
+    /**
+     * Check the route to determine whether the widget should be added
+     */
+    abstract protected function shouldAddToRightPanel(Actor $user, $vars, Request $request): bool;
+    /**
+     * Get array of collections's owned by $actor
+     *
+     * @param Actor  $owner    Collection's owner
+     * @param ?array $vars     Page vars sent by AppendRightPanelBlock event
+     * @param bool   $ids_only if true, the function must return only the primary key or each collections
+     */
+    abstract protected function getCollectionsBy(Actor $owner, ?array $vars = null, bool $ids_only = false): array;
+
+    /**
+     * Append Collections widget to the right panel.
+     * It's compose of two forms: one to select collections to add
+     * the current item to, and another to create a new collection.
+     */
+    public function onAppendRightPanelBlock(Request $request, $vars, &$res): bool
+    {
+        $user = Common::actor();
+        if (\is_null($user)) {
+            return Event::next;
+        }
+        if (!$this->shouldAddToRightPanel($user, $vars, $request)) {
+            return Event::next;
+        }
+        $collections = $this->getCollectionsBy($user);
+
+        // form: add to collection
+        $choices = [];
+        foreach ($collections as $col) {
+            $choices[$col->getName()] = $col->getId();
+        }
+
+        $collections = array_map(fn ($x) => $x->getId(), $collections);
+
+        $already_selected = $this->getCollectionsBy($user, $vars, true);
+        $add_form         = Form::create([
+            ['collections', ChoiceType::class, [
+                'choices'     => $choices,
+                'multiple'    => true,
+                'required'    => false,
+                'choice_attr' => function ($id) use ($already_selected) {
+                    if (\in_array($id, $already_selected)) {
+                        return ['selected' => 'selected'];
+                    }
+                    return [];
+                },
+            ]],
+            ['add', SubmitType::class, [
+                'label' => _m('Add to ' . static::PLURAL_SLUG),
+                'attr'  => [
+                    'title' => _m('Add to ' . static::PLURAL_SLUG),
+                ],
+            ]],
+        ]);
+        $add_form->handleRequest($request);
+        if ($add_form->isSubmitted() && $add_form->isValid()) {
+            $selected = $add_form->getData()['collections'];
+            $removed  = array_filter($already_selected, fn ($x) => !\in_array($x, $selected));
+            $added = array_filter($selected, fn ($x) => !\in_array($x, $already_selected));
+            if (\count($removed) > 0) {
+                $this->removeItem($user, $vars, $removed, $collections);
+            }
+            if (\count($added) > 0) {
+                $this->addItem($user, $vars, $added, $collections);
+            }
+            DB::flush();
+            throw new RedirectException();
+        }
+
+        // form: add to new collection
+        $create_form = Form::create([
+            ['name', TextType::class, [
+                'label' => _m('Add to a new ' . static::SLUG),
+                'attr'  => [
+                    'placeholder' => _m('New ' . static::SLUG . ' name'),
+                    'required'    => 'required',
+                ],
+                'data' => '',
+            ]],
+            ['create', SubmitType::class, [
+                'label' => _m('Create a new ' . static::SLUG),
+                'attr'  => [
+                    'title' => _m('Create a new ' . static::SLUG),
+                ],
+            ]],
+        ]);
+        $create_form->handleRequest($request);
+        if ($create_form->isSubmitted() && $create_form->isValid()) {
+            $name = $create_form->getData()['name'];
+            $this->createCollection($user, $vars, $name);
+            DB::flush();
+            throw new RedirectException();
+        }
+
+        $res[] = Formatting::twigRenderFile(
+            'collection/widget_add_to.html.twig',
+            [
+                'ctitle'          => _m('Add to ' . static::PLURAL_SLUG),
+                'user'            => $user,
+                'has_collections' => \count($collections) > 0,
+                'add_form'        => $add_form->createView(),
+                'create_form'     => $create_form->createView(),
+            ],
+        );
+        return Event::next;
+    }
+
+    public function onEndShowStyles(array &$styles, string $route): bool
+    {
+        $styles[] = 'components/Collection/assets/css/widget.css';
+        $styles[] = 'components/Collection/assets/css/pages.css';
+        return Event::next;
+    }
+}

components/Collection/Util/Parser.php

@@ -0,0 +1,130 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Collection\Util;
+
+use App\Core\Event;
+use App\Entity\Actor;
+use App\Util\Exception\ServerException;
+use Doctrine\Common\Collections\Criteria;
+
+abstract class Parser
+{
+    /**
+     * Merge $parts into $criteria_arr
+     */
+    private static function connectParts(array &$parts, array &$criteria_arr, string $last_op, mixed $eb, bool $force = false): void
+    {
+        foreach ([' ' => 'orX', '|' => 'orX', '&' => 'andX'] as $op => $func) {
+            if ($last_op === $op || $force) {
+                $criteria_arr[] = $eb->{$func}(...$parts);
+                break;
+            }
+        }
+    }
+
+    /**
+     * Parse $input string into a Doctrine query Criteria
+     *
+     * Currently doesn't support nesting with parenthesis and
+     * recognises either spaces (currently `or`, should be fuzzy match), `OR` or `|` (`or`) and `AND` or `&` (`and`)
+     *
+     * TODO: Better fuzzy match, implement exact match with quotes and nesting with parens
+     * TODO: Proper parser, tokenize better. Mostly a rewrite
+     *
+     * @return array{?Criteria, ?Criteria} [?$note_criteria, ?$actor_criteria]
+     */
+    public static function parse(string $input, ?string $locale = null, ?Actor $actor = null, int $level = 0): array
+    {
+        if ($level === 0) {
+            $input = trim(preg_replace(['/\s+/', '/\s+AND\s+/', '/\s+OR\s+/'], [' ', '&', '|'], $input), ' |&');
+        }
+
+        $left               = 0;
+        $right              = 0;
+        $lenght             = mb_strlen($input);
+        $eb                 = Criteria::expr();
+        $note_criteria_arr  = [];
+        $actor_criteria_arr = [];
+        $note_parts         = [];
+        $actor_parts        = [];
+        $last_op            = null;
+
+        for ($index = 0; $index < $lenght; ++$index) {
+            $end   = false;
+            $match = false;
+
+            foreach (['&', '|', ' '] as $delimiter) {
+                if ($input[$index] === $delimiter || $end = ($index === $lenght - 1)) {
+                    $term      = mb_substr($input, $left, $end ? null : $right - $left);
+                    $note_res  = null;
+                    $actor_res = null;
+                    Event::handle('CollectionQueryCreateExpression', [$eb, $term, $locale, $actor, &$note_res, &$actor_res]);
+                    if (\is_null($note_res) && \is_null($actor_res)) { // @phpstan-ignore-line
+                        //throw new ServerException("No one claimed responsibility for a match term: {$term}");
+                        // It's okay if the term doesn't exist, just perform a regular search
+                    }
+                    if (!empty($note_res)) { // @phpstan-ignore-line currently an open bug. See https://web.archive.org/web/20220226131651/https://github.com/phpstan/phpstan/issues/6234
+                        if (\is_array($note_res)) {
+                            $note_res = $eb->orX(...$note_res);
+                        }
+                        $note_parts[] = $note_res;
+                    }
+                    if (!empty($actor_res)) { // @phpstan-ignore-line currently an open bug. See https://web.archive.org/web/20220226131651/https://github.com/phpstan/phpstan/issues/6234
+                        if (\is_array($actor_res)) {
+                            $actor_res = $eb->orX(...$actor_res);
+                        }
+                        $actor_parts[] = $actor_res;
+                    }
+
+                    $right = $left = $index + 1;
+
+                    if (!\is_null($last_op) && $last_op !== $delimiter) {
+                        self::connectParts($note_parts, $note_criteria_arr, $last_op, $eb, force: false);
+                    } else {
+                        $last_op = $delimiter;
+                    }
+                    $match = true;
+                    break;
+                }
+            }
+            // TODO
+            if (!$match) {
+                ++$right;
+            }
+        }
+
+        $note_criteria  = null;
+        $actor_criteria = null;
+        if (!empty($note_parts)) {
+            self::connectParts($note_parts, $note_criteria_arr, $last_op, $eb, force: true);
+            $note_criteria = new Criteria($eb->orX(...$note_criteria_arr));
+        }
+        if (!empty($actor_parts)) { // @phpstan-ignore-line weird, but this whole thing needs a rewrite
+            self::connectParts($actor_parts, $actor_criteria_arr, $last_op, $eb, force: true);
+            $actor_criteria = new Criteria($eb->orX(...$actor_criteria_arr));
+        }
+
+        return [$note_criteria, $actor_criteria];
+    }
+}

components/Collection/templates/collection/actors.html.twig

@@ -0,0 +1,70 @@
+{% extends 'stdgrid.html.twig' %}
+
+{% block title %}{{ title }}{% endblock %}
+
+{% block body %}
+<section class="frame-section frame-section-padding">
+    <header class="feed-header">
+        {% if actors_feed_title is defined %}
+            {{ actors_feed_title.getHtml() }}
+        {% endif %}
+    </header>
+
+    {% set prepend_actors_collection = handle_event('PrependActorsCollection', request) %}
+    {% for widget in prepend_actors_collection %}
+        {{ widget | raw }}
+    {% endfor %}
+
+    <details class="frame-section section-details-title">
+        <summary class="details-summary-title">
+            <strong>
+                {% trans %}Ordering rules{% endtrans %}
+            </strong>
+        </summary>
+        <form method="GET" class="section-form">
+            <div class="container-grid">
+                <section class="frame-section frame-section-padding">
+                    <strong>{% trans %}Sort by{% endtrans %}</strong>
+                    <hr>
+                    <div class="container-block">
+                        {% for field in sort_form_fields %}
+                            <span class="container-block">
+                                <label for="order_by_{{ field.value }}">{{ field.label }}</label>
+                                <input id="order_by_{{ field.value }}" type="radio" name="order_by" value="{{ field.value }}" {% if field.checked %}checked="checked"{% endif %}>
+                            </span>
+                        {% endfor %}
+                    </div>
+                </section>
+                <section class="frame-section frame-section-padding">
+                    <strong class="section-title">{% trans %}Order{% endtrans %}</strong>
+                    <hr>
+                    <section class="container-block">
+                        <span class="container-block">
+                            <label for="order_op_asc">{% trans %}Ascending{% endtrans %}</label>
+                            <input id="order_op_asc" type="radio" name="order_op" value="ASC">
+                        </span>
+                        <span class="container-block">
+                            <label for="order_op_desc">{% trans %}Descending{% endtrans %}</label>
+                            <input id="order_op_desc" type="radio" name="order_op" value="DESC" checked="checked">
+                        </span>
+                    </section>
+                </section>
+            </div>
+            <button type="submit">{% trans %}Order{% endtrans %}</button>
+        </form>
+    </details>
+
+    <section class="frame-section frame-section-padding">
+        <h2>{% trans %}Results{% endtrans %}</h2>
+        {% if actors is defined and actors is not empty %}
+            {% for actor in actors %}
+                {% block profile_view %}{% include 'cards/blocks/profile.html.twig' %}{% endblock profile_view %}
+                <hr>
+            {% endfor %}
+            <span class="frame-section-button-like">{% trans %}Page: %page%{% endtrans %}</span>
+        {% else %}
+            <span>{{ empty_message }}</span>
+        {% endif %}
+    </section>
+</section>
+{% endblock body %}

components/Collection/templates/collection/collection_entry_view.html.twig

@@ -0,0 +1,11 @@
+{% extends '/collection/notes.html.twig' %}
+
+{% block title %}{% trans %}%page_title%{% endtrans %}{% endblock %}
+
+{% block body %}
+    <div class="frame-section frame-section-padding">
+        <h2 class="frame-section-title">{% trans %}%page_title%{% endtrans %}</h2>
+        {% block collection_items %}
+        {% endblock collection_items %}
+    </div>
+{% endblock body %}

components/Collection/templates/collection/meta_collections.html.twig

@@ -0,0 +1,34 @@
+{% extends 'stdgrid.html.twig' %}
+
+{% block title %}{% trans %}%page_title%{% endtrans %}{% endblock %}
+
+{% block body %}
+    <div class="frame-section frame-section-padding">
+        <h2 class="frame-section-title">{% trans %}%page_title%{% endtrans %}</h2>
+        {% if add_collection %}
+            <div class="frame-section section-form">
+                {{ form(add_collection) }}
+            </div>
+        {% endif %}
+        <div class="frame-section collections-list">
+            <h3>{% trans %}%list_title%{% endtrans %}</h3>
+            {% for col in collections %}
+                <div class="collection-item">
+                    <a class="name" href="{{ fn.getUrl(col.id) }}">{{ col.name }}</a>
+                    <details title="Expand if you want to edit the collection's name">
+                        <summary>
+                            <span class="collection-action">{{ icon('edit') | raw }}</span>
+                        </summary>
+                        {{ form(fn.editForm(col)) }}
+                    </details>
+                    <details title="Expand if you want to delete the collection">
+                        <summary>
+                            <span class="collection-action">{{ icon('delete') | raw }}</span>
+                        </summary>
+                        {{ form(fn.rmForm(col)) }}
+                    </details>
+                </div>
+            {% endfor %}
+        </div>
+    </div>
+{% endblock body %}

components/Collection/templates/collection/notes.html.twig

@@ -0,0 +1,58 @@
+{% extends 'stdgrid.html.twig' %}
+{% import '/cards/macros/note/factory.html.twig' as NoteFactory %}
+
+{% block title %}{% if page_title is defined %}{% trans %}%page_title%{% endtrans %}{% endif %}{% endblock %}
+
+{% block stylesheets %}
+    {{ parent() }}
+    <link rel="stylesheet" href="{{ asset('assets/default_theme/feeds.css') }}" type="text/css">
+{% endblock stylesheets %}
+
+{% block body %}
+    {% for block in handle_event('BeforeFeed', app.request) %}
+        {{ block | raw }}
+    {% endfor %}
+
+    {% if notes is defined %}
+        <header class="feed-header">
+            {% set current_path = app.request.get('_route') %}
+            {% if notes_feed_title is defined %}
+                {{ notes_feed_title.getHtml() }}
+            {% endif %}
+            <nav class="feed-actions" title="{% trans %}Actions that change how the feed behaves{% endtrans %}">
+                <details class="feed-actions-details" role="group">
+                    <summary>
+                        {{ icon('filter', 'icon icon-feed-actions') | raw }} {# button-container #}
+                    </summary>
+                    <menu class="feed-actions-details-dropdown" role="toolbar">
+                        {% for block in handle_event('AddFeedActions', app.request, notes is defined and notes is not empty) %}
+                            {{ block | raw }}
+                        {% endfor %}
+                    </menu>
+                </details>
+            </nav>
+        </header>
+
+        {% if notes is not empty %}
+            {# Backwards compatibility with hAtom 0.1 #}
+            <section class="feed h-feed hfeed notes" role="feed" aria-busy="false" title="{% trans %}Feed content{% endtrans %}">
+                {% for conversation in notes %}
+                    {% block current_note %}
+                        {% if conversation is instanceof('array') %}
+                            {% set args = conversation | merge({'type': 'vanilla_full'}) %}
+                            {{ NoteFactory.constructor(args) }}
+{#                        {% else %}
+                            {% set args = { 'type': 'vanilla_full', 'note': conversation, 'extra': { 'depth': 0 } } %}
+                            {{ NoteFactory.constructor(args) }}#}
+                        {% endif %}
+                        <hr class="hr-replies-end" role="separator" aria-label="{% trans %}Marks the end of previous conversation's initial note{% endtrans %}">
+                    {% endblock current_note %}
+                {% endfor %}
+            </section>
+        {% else %}
+            <section class="feed h-feed hfeed notes" tabindex="0" role="feed">
+                <span>{% trans %}No notes here...{% endtrans %}</span>
+            </section>
+        {% endif %}
+    {% endif %}
+{% endblock body %}

components/Collection/templates/collection/widget_add_to.html.twig

@@ -0,0 +1,27 @@
+<section class="frame-section collections">
+    <details class="section-details-title" title="Expand if you want to access more options.">
+        <summary class="details-summary-title">
+            <span>{{ctitle}}</span>
+        </summary>
+        {% if has_collections %}
+            <section class="section-form">
+                {{ form(add_form) }}
+            </section>
+
+            <details class="frame-section-padding section-details-subtitle"
+                     title="Expand if you want to access more options.">
+                <summary class="details-summary-subtitle">
+                    <strong>{% trans %}Other options{% endtrans %}</strong>
+                </summary>
+                <section class="section-form">
+                    {{ form(create_form) }}
+                </section>
+            </details>
+        {% else %}
+            <section class="section-form">
+                {{ form(create_form) }}
+            </section>
+        {% endif %}
+    </details>
+</section>
+

components/Conversation/Controller/Conversation.php

@@ -0,0 +1,152 @@
+<?php
+
+declare(strict_types = 1);
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+/**
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @author    Eliseu Amaro <mail@eliseuama.ro>
+ * @copyright 2021-2022 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\Conversation\Controller;
+
+use App\Core\Cache;
+use App\Core\DB;
+use App\Core\Form;
+use function App\Core\I18n\_m;
+use App\Core\Log;
+use App\Core\Router;
+use App\Entity\Note;
+use App\Util\Common;
+use App\Util\Exception\ClientException;
+use App\Util\Exception\NoLoggedInUser;
+use App\Util\Exception\NoSuchNoteException;
+use App\Util\Exception\RedirectException;
+use App\Util\Exception\ServerException;
+use App\Util\HTML\Heading;
+use Component\Collection\Util\Controller\FeedController;
+use Component\Conversation\Entity\ConversationMute;
+use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+use Symfony\Component\HttpFoundation\Request;
+
+class Conversation extends FeedController
+{
+    /**
+     * Render conversation page.
+     *
+     * @param int $conversation_id To identify what Conversation is to be rendered
+     *
+     * @throws \App\Util\Exception\ServerException
+     *
+     * @return array Array containing keys: 'notes' (all known notes in the given Conversation), 'should_format' (boolean, stating if onFormatNoteList events may or not format given notes), 'page_title' (used as the title header)
+     */
+    public function showConversation(Request $request, int $conversation_id): array
+    {
+        $page_title = _m('Conversation');
+
+        return [
+            '_template' => 'collection/notes.html.twig',
+            'notes'     => $this->query(
+                query: "note-conversation:{$conversation_id}",
+                note_order_by: ['note.created' => 'ASC', 'note.id' => 'ASC'],
+            )['notes'] ?? [],
+            'should_format'    => false,
+            'page_title'       => $page_title,
+            'notes_feed_title' => (new Heading(1, [], $page_title)),
+        ];
+    }
+
+    /**
+     * Controller for the note reply non-JS page
+     *
+     * Leverages the `PostingModifyData` event to add the `reply_to_id` field from the GET variable 'reply_to_id'
+     *
+     * @throws ClientException
+     * @throws NoLoggedInUser
+     * @throws NoSuchNoteException
+     * @throws ServerException
+     *
+     * @return array
+     */
+    public function addReply(Request $request)
+    {
+        $user            = Common::ensureLoggedIn();
+        $note_id         = $this->int('reply_to_id', new ClientException(_m('Malformed query.')));
+        $note            = Note::ensureCanInteract(Note::getByPK($note_id), $user);
+        $conversation_id = $note->getConversationId();
+        return $this->showConversation($request, $conversation_id);
+    }
+
+    /**
+     * Creates form view for Muting Conversation extra action.
+     *
+     * @param int $conversation_id The Conversation id that this action targets
+     *
+     * @throws \App\Util\Exception\NoLoggedInUser
+     * @throws \App\Util\Exception\RedirectException
+     * @throws \App\Util\Exception\ServerException
+     *
+     * @return array Array containing templating where the form is to be rendered, and the form itself
+     */
+    public function muteConversation(Request $request, int $conversation_id)
+    {
+        $user     = Common::ensureLoggedIn();
+        $is_muted = ConversationMute::isMuted($conversation_id, $user);
+        $form     = Form::create([
+            ['mute_conversation', SubmitType::class, ['label' => $is_muted ? _m('Unmute') : _m('Mute'), 'attr' => ['class' => '']]],
+        ]);
+
+        $form->handleRequest($request);
+        if ($form->isSubmitted() && $form->isValid()) {
+            if (!$is_muted) {
+                DB::persist(ConversationMute::create(['conversation_id' => $conversation_id, 'actor_id' => $user->getId()]));
+            } else {
+                DB::removeBy('conversation_mute', ['conversation_id' => $conversation_id, 'actor_id' => $user->getId()]);
+            }
+            DB::flush();
+            Cache::delete(ConversationMute::cacheKeys($conversation_id, $user->getId())['mute']);
+
+            // Redirect user to where they came from
+            // Prevent open redirect
+            if (!\is_null($from = $this->string('from'))) {
+                if (Router::isAbsolute($from)) {
+                    Log::warning("Actor {$user->getId()} attempted to mute conversation {$conversation_id} and then get redirected to another host, or the URL was invalid ({$from})");
+                    throw new ClientException(_m('Can not redirect to outside the website from here'), 400); // 400 Bad request (deceptive)
+                } else {
+                    // TODO anchor on element id
+                    throw new RedirectException(url: $from);
+                }
+            } else {
+                // If we don't have a URL to return to, go to the instance root
+                throw new RedirectException('root');
+            }
+        }
+
+        return [
+            '_template' => 'conversation/mute.html.twig',
+            'notes'     => $this->query(
+                query: "note-conversation:{$conversation_id}",
+                note_order_by: ['note.created' => 'ASC', 'note.id' => 'ASC'],
+            )['notes'] ?? [],
+            'is_muted' => $is_muted,
+            'form'     => $form->createView(),
+        ];
+    }
+}

components/Conversation/Conversation.php

@@ -0,0 +1,312 @@
+<?php
+
+declare(strict_types = 1);
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+/**
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @author    Eliseu Amaro <mail@eliseuama.ro>
+ * @copyright 2021-2022 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\Conversation;
+
+use App\Core\Cache;
+use App\Core\DB;
+use App\Core\Event;
+use function App\Core\I18n\_m;
+use App\Core\Modules\Component;
+use App\Core\Router;
+use App\Entity\Activity;
+use App\Entity\Actor;
+use App\Entity\Note;
+use App\Util\Common;
+use App\Util\Formatting;
+use Component\Conversation\Entity\Conversation as ConversationEntity;
+use Component\Conversation\Entity\ConversationMute;
+use Functional as F;
+use Symfony\Component\HttpFoundation\Request;
+
+class Conversation extends Component
+{
+    public function onAddRoute(Router $r): bool
+    {
+        $r->connect('conversation', '/conversation/{conversation_id<\d+>}', [Controller\Conversation::class, 'showConversation']);
+        $r->connect('conversation_mute', '/conversation/{conversation_id<\d+>}/mute', [Controller\Conversation::class, 'muteConversation']);
+        $r->connect('conversation_reply_to', '/conversation/reply', [Controller\Conversation::class, 'addReply']);
+
+        return Event::next;
+    }
+
+    /**
+     * **Assigns** the given local Note it's corresponding **Conversation**.
+     *
+     * **If a _$parent_id_ is not given**, then the Actor is not attempting a reply,
+     * therefore, we can assume (for now) that we need to create a new Conversation and assign it
+     * to the newly created Note (please look at Component\Posting::storeLocalNote, where this function is used)
+     *
+     * **On the other hand**, given a _$parent_id_, the Actor is attempting to post a reply. Meaning that,
+     * this Note conversation_id should be same as the parent Note
+     *
+     * @param \App\Entity\Note $current_note Local Note currently being assigned a Conversation
+     * @param null|int         $parent_id    If present, it's a reply
+     */
+    public static function assignLocalConversation(Note $current_note, ?int $parent_id): void
+    {
+        if (!$parent_id) {
+            // If none found, we don't know yet if it is a reply or root
+            // Let's assume for now that it's a new conversation and deal with stitching later
+            $conversation = ConversationEntity::create(['initial_note_id' => $current_note->getId()]);
+
+            // We need the Conversation id itself, so a persist is in order
+            DB::persist($conversation);
+
+            // Set current_note's own conversation_id
+            $current_note->setConversationId($conversation->getId());
+        } else {
+            // It's a reply for sure
+            // Set reply_to property in newly created Note to parent's id
+            // Parent will have a conversation of its own, the reply should have the same one
+            $parent_note = Note::getById($parent_id);
+            $current_note->setConversationId($parent_note->getConversationId());
+        }
+
+        DB::persist($current_note);
+    }
+
+    /**
+     * HTML rendering event that adds a reply link as a note
+     * action, if a user is logged in.
+     *
+     * @param \App\Entity\Note $note    The Note being rendered
+     * @param array            $actions Contains keys 'url' (linking 'conversation_reply_to'
+     *                                  route), 'title' (used as title for aforementioned url),
+     *                                  'classes' (CSS styling classes used to visually inform the user of action context),
+     *                                  'id' (HTML markup id used to redirect user to this anchor upon performing the action)
+     *
+     * @throws \App\Util\Exception\ServerException
+     *
+     * @return bool EventHook
+     */
+    public function onAddNoteActions(Request $request, Note $note, array &$actions): bool
+    {
+        if (\is_null(Common::user())) {
+            return Event::next;
+        }
+
+        $from = $request->query->has('from')
+              ? $request->query->get('from')
+              : $request->getPathInfo();
+
+        $reply_action_url = Router::url(
+            'conversation_reply_to',
+            [
+                'reply_to_id' => $note->getId(),
+                'from'        => $from,
+                '_fragment'   => 'note-anchor-' . $note->getId(),
+            ],
+            Router::ABSOLUTE_PATH,
+        );
+
+        $reply_action = [
+            'url'     => $reply_action_url,
+            'title'   => _m('Reply to this note!'),
+            'classes' => 'button-container reply-button-container note-actions-unset',
+            'id'      => 'reply-button-container-' . $note->getId(),
+        ];
+
+        $actions[] = $reply_action;
+
+        return Event::next;
+    }
+
+    /**
+     * Append on note information about user actions.
+     *
+     * @param array $vars   Contains information related to Note currently being rendered
+     * @param array $result Contains keys 'actors', and 'action'. Needed to construct a string, stating who ($result['actors']), has already performed a reply ($result['action']), in the given Note (vars['note'])
+     *
+     * @return bool EventHook
+     */
+    public function onAppendCardNote(array $vars, array &$result): bool
+    {
+        if (str_contains($vars['request']->getPathInfo(), 'conversation')) {
+            return Event::next;
+        }
+
+        // The current Note being rendered
+        $note = $vars['note'];
+
+        // Will have actors array, and action string
+        // Actors are the subjects, action is the verb (in the final phrase)
+        $reply_actors = F\map(
+            $note->getReplies(),
+            fn (Note $reply) => Actor::getByPK($reply->getActorId()),
+        );
+
+        if (empty($reply_actors)) {
+            return Event::next;
+        }
+
+        // Filter out multiple replies from the same actor
+        $reply_actors = array_unique($reply_actors, \SORT_REGULAR);
+        $result[]     = ['actors' => $reply_actors, 'action' => 'replied to'];
+
+        return Event::next;
+    }
+
+    private function getReplyToIdFromRequest(Request $request): ?int
+    {
+        if (!\is_array($request->get('post_note')) || !\array_key_exists('_next', $request->get('post_note'))) {
+            return null;
+        }
+        $next = parse_url($request->get('post_note')['_next']);
+        if (!\array_key_exists('query', $next)) {
+            return null;
+        }
+        parse_str($next['query'], $query);
+        if (!\array_key_exists('reply_to_id', $query)) {
+            return null;
+        }
+        return (int) $query['reply_to_id'];
+    }
+
+    /**
+     * Informs **\App\Component\Posting::onAppendRightPostingBlock**, of the **current page context** in which the given
+     * Actor is in. This is valuable when posting within a group route, allowing \App\Component\Posting to create a
+     * Note **targeting** that specific Group.
+     *
+     * @param \App\Entity\Actor      $actor         The Actor currently attempting to post a Note
+     * @param null|\App\Entity\Actor $context_actor The 'owner' of the current route (e.g. Group or Actor), used to target it
+     *
+     * @return bool EventHook
+     */
+    public function onPostingGetContextActor(Request $request, Actor $actor, ?Actor &$context_actor): bool
+    {
+        $to_note_id = $this->getReplyToIdFromRequest($request);
+        if (!\is_null($to_note_id)) {
+            // Getting the actor itself
+            $context_actor = Actor::getById(Note::getById((int) $to_note_id)->getActorId());
+            return Event::stop;
+        }
+        return Event::next;
+    }
+
+    /**
+     * Posting event to add extra information to Component\Posting form data
+     *
+     * @param array $data Transport data to be filled with reply_to_id
+     *
+     * @throws \App\Util\Exception\ClientException
+     * @throws \App\Util\Exception\NoSuchNoteException
+     *
+     * @return bool EventHook
+     */
+    public function onPostingModifyData(Request $request, Actor $actor, array &$data): bool
+    {
+        $to_note_id = $this->getReplyToIdFromRequest($request);
+        if (!\is_null($to_note_id)) {
+            Note::ensureCanInteract(Note::getById($to_note_id), $actor);
+            $data['reply_to_id'] = $to_note_id;
+        }
+
+        return Event::next;
+    }
+
+    /**
+     * Add minimal Note card to RightPanel template
+     */
+    public function onPrependPostingForm(Request $request, array &$elements): bool
+    {
+        $elements[] = Formatting::twigRenderFile('cards/blocks/note_compact_wrapper.html.twig', ['note' => Note::getById((int) $request->query->get('reply_to_id'))]);
+        return Event::next;
+    }
+
+    /**
+     * Event launched when deleting given Note, it's deletion implies further changes to object related to this Note.
+     * Please note, **replies are NOT deleted**, their reply_to is only set to null since this Note no longer exists.
+     *
+     * @param \App\Entity\Note  $note  Note being deleted
+     * @param \App\Entity\Actor $actor Actor that performed the delete action
+     *
+     * @return bool EventHook
+     */
+    public function onNoteDeleteRelated(Note &$note, Actor $actor): bool
+    {
+        // Ensure we have the most up to date replies
+        Cache::delete(Note::cacheKeys($note->getId())['replies']);
+        DB::wrapInTransaction(fn () => F\each($note->getReplies(), fn (Note $note) => $note->setReplyTo(null)));
+        Cache::delete(Note::cacheKeys($note->getId())['replies']);
+        return Event::next;
+    }
+
+    /**
+     * Adds extra actions related to Conversation Component, that act upon/from the given Note.
+     *
+     * @param \App\Entity\Note $note    Current Note being rendered
+     * @param array            $actions Containing 'url' (Controller connected route), 'title' (used in anchor link containing the url), ?'classes' (CSS classes required for styling, if needed)
+     *
+     * @throws \App\Util\Exception\ServerException
+     *
+     * @return bool EventHook
+     */
+    public function onAddExtraNoteActions(Request $request, Note $note, array &$actions): bool
+    {
+        if (\is_null($user = Common::user())) {
+            return Event::next;
+        }
+
+        $from = $request->query->has('from')
+            ? $request->query->get('from')
+            : $request->getPathInfo();
+
+        $mute_extra_action_url = Router::url(
+            'conversation_mute',
+            [
+                'conversation_id' => $note->getConversationId(),
+                'from'            => $from,
+                '_fragment'       => 'note-anchor-' . $note->getId(),
+            ],
+            Router::ABSOLUTE_PATH,
+        );
+
+        $actions[] = [
+            'title'   => ConversationMute::isMuted($note, $user) ? _m('Unmute conversation') : _m('Mute conversation'),
+            'classes' => '',
+            'url'     => $mute_extra_action_url,
+        ];
+
+        return Event::next;
+    }
+
+    /**
+     * Prevents new Notifications to appear for muted conversations
+     *
+     * @param Activity $activity Notification Activity
+     *
+     * @return bool EventHook
+     */
+    public function onNewNotificationShould(Activity $activity, Actor $actor): bool
+    {
+        if ($activity->getObjectType() === 'note' && ConversationMute::isMuted($activity, $actor)) {
+            return Event::stop;
+        }
+        return Event::next;
+    }
+}

components/Conversation/Entity/Conversation.php

@@ -1,6 +1,9 @@
 <?php
 
+declare(strict_types = 1);
+
 // {{{ License
+
 // This file is part of GNU social - https://www.gnu.org/software/social
 //
 // GNU social is free software: you can redistribute it and/or modify
@@ -15,17 +18,19 @@
 //
 // You should have received a copy of the GNU Affero General Public License
 // along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
 // }}}
 
-namespace App\Entity;
+namespace Component\Conversation\Entity;
 
+use App\Core\DB;
 use App\Core\Entity;
-use DateTimeInterface;
+use App\Core\Router;
 
 /**
- * Data class for Conversations
+ * Entity class for Conversations
  *
- * @category  Data
+ * @category  DB
  * @package   GNUsocial
  *
  * @author    Zach Copley <zach@status.net>
@@ -33,7 +38,8 @@ use DateTimeInterface;
  * @copyright 2010 StatusNet Inc.
  * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
  * @author    Hugo Sales <hugo@hsal.es>
- * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @author    Eliseu Amaro <mail@eliseuama.ro>
+ * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
  * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
  */
 class Conversation extends Entity
@@ -41,9 +47,7 @@ class Conversation extends Entity
     // {{{ Autocode
     // @codeCoverageIgnoreStart
     private int $id;
-    private int $note_id;
+    private int $initial_note_id;
-    private \DateTimeInterface $created;
-    private \DateTimeInterface $modified;
 
     public function setId(int $id): self
     {
@@ -56,53 +60,42 @@ class Conversation extends Entity
         return $this->id;
     }
 
-    public function setNoteId(int $note_id): self
+    public function setInitialNoteId(int $initial_note_id): self
     {
-        $this->note_id = $note_id;
+        $this->initial_note_id = $initial_note_id;
         return $this;
     }
 
-    public function getNoteId(): int
+    public function getInitialNoteId(): int
     {
-        return $this->note_id;
+        return $this->initial_note_id;
-    }
-
-    public function setCreated(DateTimeInterface $created): self
-    {
-        $this->created = $created;
-        return $this;
-    }
-
-    public function getCreated(): DateTimeInterface
-    {
-        return $this->created;
-    }
-
-    public function setModified(DateTimeInterface $modified): self
-    {
-        $this->modified = $modified;
-        return $this;
-    }
-
-    public function getModified(): DateTimeInterface
-    {
-        return $this->modified;
     }
 
     // @codeCoverageIgnoreEnd
     // }}} Autocode
 
+    public function getUrl(int $type = Router::ABSOLUTE_URL): string
+    {
+        return Router::url('conversation', ['conversation_id' => $this->getId()], $type);
+    }
+
+    public function getUri(): string
+    {
+        return $this->getUrl(type: Router::ABSOLUTE_URL);
+    }
+
     public static function schemaDef(): array
     {
         return [
             'name'   => 'conversation',
             'fields' => [
-                'id'       => ['type' => 'serial',    'not null' => true, 'description' => 'Unique identifier'],
+                'id'              => ['type' => 'serial', 'not null' => true, 'description' => 'Serial identifier, since any additional meaning would require updating its value for every reply upon receiving a new aparent root'],
-                'note_id'  => ['type' => 'int',       'foreign key' => true, 'target' => 'Note.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'Root of note for this conversation'],
+                'initial_note_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Note.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'Initial note seen on this host for this conversation'],
-                'created'  => ['type' => 'datetime',  'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
+            ],
-                'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
+            'primary key'  => ['id'],
+            'foreign keys' => [
+                'initial_note_id_to_id_fkey' => ['note', ['initial_note_id' => 'id']],
             ],
-            'primary key' => ['id'],
         ];
     }
 }

components/Conversation/Entity/ConversationMute.php

@@ -0,0 +1,132 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Conversation\Entity;
+
+use App\Core\Cache;
+use App\Core\DB;
+use App\Core\Entity;
+use App\Entity\Activity;
+use App\Entity\Actor;
+use App\Entity\LocalUser;
+use App\Entity\Note;
+use DateTimeInterface;
+
+/**
+ * Entity class for Conversations Mutes
+ *
+ * @category  DB
+ * @package   GNUsocial
+ *
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @copyright 2022 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class ConversationMute extends Entity
+{
+    // {{{ Autocode
+    // @codeCoverageIgnoreStart
+    private int $conversation_id;
+    private int $actor_id;
+    private DateTimeInterface $created;
+
+    public function setConversationId(int $conversation_id): self
+    {
+        $this->conversation_id = $conversation_id;
+        return $this;
+    }
+
+    public function getConversationId(): int
+    {
+        return $this->conversation_id;
+    }
+
+    public function setActorId(int $actor_id): self
+    {
+        $this->actor_id = $actor_id;
+        return $this;
+    }
+
+    public function getActorId(): int
+    {
+        return $this->actor_id;
+    }
+
+    public function setCreated(DateTimeInterface $created): self
+    {
+        $this->created = $created;
+        return $this;
+    }
+
+    public function getCreated(): DateTimeInterface
+    {
+        return $this->created;
+    }
+
+    // @codeCoverageIgnoreEnd
+    // }}} Autocode
+
+    public static function cacheKeys(int $conversation_id, int $actor_id): array
+    {
+        return [
+            'mute' => "conversation-mute-{$conversation_id}-{$actor_id}",
+        ];
+    }
+
+    /**
+     * Check if a conversation referenced by $object is muted form $actor
+     */
+    public static function isMuted(Activity|Note|int $object, Actor|LocalUser $actor): bool
+    {
+        $conversation_id = null;
+        if (\is_int($object)) {
+            $conversation_id = $object;
+        } elseif ($object instanceof Note) {
+            $conversation_id = $object->getConversationId();
+        } elseif ($object instanceof Activity) {
+            $conversation_id = Note::getById($object->getObjectId())->getConversationId();
+        }
+
+        return Cache::get(
+            self::cacheKeys($conversation_id, $actor->getId())['mute'],
+            fn () => (bool) DB::count('conversation_mute', ['conversation_id' => $conversation_id, 'actor_id' => $actor->getId()]),
+        );
+    }
+
+    public static function schemaDef(): array
+    {
+        return [
+            'name'   => 'conversation_mute',
+            'fields' => [
+                'conversation_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Conversation.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'The conversation being blocked'],
+                'actor_id'        => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'Who blocked the conversation'],
+                'created'         => ['type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
+            ],
+            'primary key'  => ['conversation_id', 'actor_id'],
+            'foreign keys' => [
+                'conversation_id_to_id_fkey' => ['conversation', ['conversation_id' => 'id']],
+                'actor_id_to_id_fkey'        => ['actor', ['actor_id' => 'id']],
+            ],
+        ];
+    }
+}

components/Conversation/templates/conversation/mute.html.twig

@@ -0,0 +1,21 @@
+{% extends 'collection/notes.html.twig' %}
+
+{% block body %}
+    <div class="frame-section frame-section-padding">
+        {% if is_muted %}
+            <span class="frame-section-padding alert">
+            <label>Do you wish to <b>unmute</b> this conversation?</label>
+            {{ form(form) }}
+        </span>
+        {% else %}
+            <span class="frame-section-padding alert">
+            <label>Do you wish to <b>mute</b> this conversation?</label>
+            {{ form(form) }}
+        </span>
+        {% endif %}
+
+        <hr>
+
+        {{ parent() }}
+    </div>
+{% endblock body %}

components/Feed/Controller/Feeds.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+/**
+ * Handle network public feed
+ *
+ * @package  GNUsocial
+ * @category Controller
+ *
+ * @author    Hugo Sales <hugo@hsal.es>
+ * @author    Eliseu Amaro <eliseu@fc.up.pt>
+ * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\Feed\Controller;
+
+use function App\Core\I18n\_m;
+use App\Util\Common;
+use App\Util\HTML\Heading;
+use Component\Collection\Util\Controller\FeedController;
+use Symfony\Component\HttpFoundation\Request;
+
+class Feeds extends FeedController
+{
+    /**
+     * The Planet feed represents every local post. Which is what this instance has to share with the universe.
+     */
+    public function public(Request $request): array
+    {
+        $data       = $this->query('note-local:true');
+        $page_title = _m(\is_null(Common::user()) ? 'Feed' : 'Planet');
+        return [
+            '_template'        => 'collection/notes.html.twig',
+            'page_title'       => $page_title,
+            'notes_feed_title' => (new Heading(level: 1, classes: ['feed-title'], text: $page_title)),
+            'notes'            => $data['notes'],
+        ];
+    }
+
+    /**
+     * The Home feed represents everything that concerns a certain actor (its subscriptions)
+     */
+    public function home(Request $request): array
+    {
+        Common::ensureLoggedIn();
+        $data = $this->query('note-from:subscribed-person,subscribed-group,subscribed-organisation');
+        return [
+            '_template'        => 'collection/notes.html.twig',
+            'page_title'       => _m('Home'),
+            'notes_feed_title' => (new Heading(level: 1, classes: ['feed-title'], text: 'Home')),
+            'notes'            => $data['notes'],
+        ];
+    }
+}

components/Feed/Feed.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Feed;
+
+use App\Core\Event;
+use App\Core\Modules\Component;
+use App\Core\Router;
+use Component\Feed\Controller as C;
+
+class Feed extends Component
+{
+    public function onAddRoute(Router $r): bool
+    {
+        $r->connect('feed_public', '/feed/public', [C\Feeds::class, 'public']);
+        $r->connect('feed_home', '/feed/home', [C\Feeds::class, 'home']);
+        return Event::next;
+    }
+}

components/Feed/tests/Controller/FeedsTest.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+namespace Component\Feed\tests\Controller;
+
+use App\Core\Router;
+use App\Util\GNUsocialTestCase;
+use Component\Feed\Controller\Feeds;
+use Jchook\AssertThrows\AssertThrows;
+
+class FeedsTest extends GNUsocialTestCase
+{
+    use AssertThrows;
+
+    public function testPublic()
+    {
+        // This calls static::bootKernel(), and creates a "client" that is acting as the browser
+        $client  = static::createClient();
+        $crawler = $client->request('GET', Router::url('feed_public'));
+        $this->assertResponseIsSuccessful();
+    }
+
+    public function testHome()
+    {
+        // This calls static::bootKernel(), and creates a "client" that is acting as the browser
+        $client  = static::createClient();
+        $crawler = $client->request('GET', Router::url('feed_home'));
+        $this->assertResponseStatusCodeSame(302);
+    }
+
+    // TODO: It would be nice to actually test whether the feeds are respecting scopes and spitting
+    // out the expected notes... The ActivityPub plugin have a somewhat obvious way of testing it so,
+    // for now, having that, might fill that need, let's see
+}

components/FreeNetwork/Controller/Feeds.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+/**
+ * Handle network public feed
+ *
+ * @package  GNUsocial
+ * @category Controller
+ *
+ * @author    Diogo Peralta Cordeiro <@diogo.site>
+ * @copyright 2020-2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\FreeNetwork\Controller;
+
+use App\Core\DB;
+use function App\Core\I18n\_m;
+use App\Util\Common;
+use Component\Collection\Util\Controller\FeedController;
+use Symfony\Component\HttpFoundation\Request;
+
+class Feeds extends FeedController
+{
+    /**
+     * The Meteorites feed represents every post coming from the
+     * known fediverse to this instance's inbox. I.e., it's our
+     * known network and excludes everything that is local only
+     * or federated out.
+     */
+    public function network(Request $request): array
+    {
+        Common::ensureLoggedIn();
+        $data = $this->query('note-local:false');
+        return [
+            '_template'     => 'collection/notes.html.twig',
+            'page_title'    => _m('Meteorites'),
+            'should_format' => true,
+            'notes'         => $data['notes'],
+        ];
+    }
+
+    /**
+     * The Planetary System feed represents every planet-centric post, i.e.,
+     * everything that is local or comes from outside with relation to local actors
+     * or posts.
+     */
+    public function clique(Request $request): array
+    {
+        Common::ensureLoggedIn();
+        // TODO: maybe make this a Collection::query
+        $notes = DB::dql(
+            <<<'EOF'
+                SELECT n FROM \App\Entity\Note AS n
+                WHERE n.is_local = true OR n.id IN (
+                    SELECT act.object_id FROM \App\Entity\Activity AS act
+                        WHERE act.object_type = 'note' AND act.id IN
+                            (SELECT att.activity_id FROM \Component\Notification\Entity\Notification AS att WHERE att.target_id IN 
+                                (SELECT a.id FROM \App\Entity\Actor a WHERE a.is_local = true))
+                    )
+                ORDER BY n.created DESC, n.id DESC
+                EOF,
+        );
+        return [
+            '_template'     => 'collection/notes.html.twig',
+            'page_title'    => _m('Planetary System'),
+            'should_format' => true,
+            'notes'         => $notes,
+        ];
+    }
+
+    /**
+     * The Galaxy feed represents everything that is federated out or federated in.
+     * Given that any local post can be federated out and it's hard to specifically exclude these,
+     * we simply return everything here, local and remote posts. So, a galaxy.
+     */
+    public function federated(Request $request): array
+    {
+        Common::ensureLoggedIn();
+        $data = $this->query('notes-all:yeah');
+        return [
+            '_template'     => 'collection/notes.html.twig',
+            'page_title'    => _m('Galaxy'),
+            'should_format' => true,
+            'notes'         => $data['notes'],
+        ];
+    }
+}

components/FreeNetwork/Controller/HostMeta.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types = 1);
+
+/**
+ * @author   James Walker <james@status.net>
+ * @author   Craig Andrews <candrews@integralblue.com>
+ * @author   Mikael Nordfeldth <mmn@hethane.se>
+ */
+
+namespace Component\FreeNetwork\Controller;
+
+use App\Core\Event;
+use Component\FreeNetwork\Util\Discovery;
+use Component\FreeNetwork\Util\XrdController;
+
+class HostMeta extends XrdController
+{
+    protected string $default_mimetype = Discovery::JRD_MIMETYPE;
+
+    public function setXRD()
+    {
+        if (Event::handle('StartHostMetaLinks', [&$this->xrd->links])) {
+            Event::handle('EndHostMetaLinks', [&$this->xrd->links]);
+        }
+    }
+}

components/FreeNetwork/Controller/OwnerXrd.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types = 1);
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Component\FreeNetwork\Controller;
+
+/**
+ * @package   WebFingerPlugin
+ *
+ * @author    James Walker <james@status.net>
+ * @author    Mikael Nordfeldth <mmn@hethane.se>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+use App\Entity\LocalUser;
+use App\Util\Common;
+use Component\FreeNetwork\Util\Discovery;
+use Component\FreeNetwork\Util\XrdController;
+use Symfony\Component\HttpFoundation\Request;
+
+class OwnerXrd extends XrdController
+{
+    protected string $default_mimetype = Discovery::XRD_MIMETYPE;
+
+    public function handle(Request $request): array
+    {
+        $user = LocalUser::siteOwner();
+
+        $nick           = common_canonical_nickname($user->nickname);
+        $this->resource = 'acct:' . $nick . '@' . Common::config('site', 'server');
+
+        // We have now set $args['resource'] to the configured value, since
+        // only this local site configuration knows who the owner is!
+        return parent::handle($request);
+    }
+
+    protected function setXRD()
+    {
+        // Check to see if a $config['webfinger']['owner'] has been set
+        // and then make sure 'subject' is set to that primary identity.
+        if (!empty($owner = Common::config('webfinger', 'owner'))) {
+            $this->xrd->aliases[] = $this->xrd->subject;
+            $this->xrd->subject   = Discovery::normalize($owner);
+        } else {
+            $this->xrd->subject = $this->resource;
+        }
+    }
+}

components/FreeNetwork/Controller/Webfinger.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types = 1);
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * 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/>.
+ */
+
+namespace Component\FreeNetwork\Controller;
+
+use App\Core\Event;
+use function App\Core\I18n\_m;
+use App\Util\Exception\ClientException;
+use App\Util\Exception\NoSuchActorException;
+use Component\FreeNetwork\Util\Discovery;
+use Component\FreeNetwork\Util\WebfingerResource;
+use Component\FreeNetwork\Util\XrdController;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @package WebFingerPlugin
+ *
+ * @author James Walker <james@status.net>
+ * @author Mikael Nordfeldth <mmn@hethane.se>
+ * @author Diogo Peralta Cordeiro
+ */
+class Webfinger extends XrdController
+{
+    protected $resource; // string with the resource URI
+    protected $target; // object of the WebFingerResource class
+
+    public function handle(Request $request): array
+    {
+        // throws exception if resource is empty
+        $this->resource = Discovery::normalize($this->string('resource'));
+
+        try {
+            if (Event::handle('StartGetWebFingerResource', [$this->resource, &$this->target, $this->params()])) {
+                Event::handle('EndGetWebFingerResource', [$this->resource, &$this->target, $this->params()]);
+            }
+        } catch (NoSuchActorException $e) {
+            throw new ClientException($e->getMessage(), 404);
+        }
+
+        if (!$this->target instanceof WebfingerResource) {
+            // TRANS: Error message when an object URI which we cannot find was requested
+            throw new ClientException(_m('Resource not found in local database.'), 404);
+        }
+
+        return parent::handle($request);
+    }
+
+    /**
+     * Configures $this->xrd which will later be printed.
+     */
+    protected function setXRD()
+    {
+        $this->xrd->subject = $this->resource;
+
+        foreach ($this->target->getAliases() as $alias) {
+            if ($alias != $this->xrd->subject && !\in_array($alias, $this->xrd->aliases)) {
+                $this->xrd->aliases[] = $alias;
+            }
+        }
+
+        $this->target->updateXRD($this->xrd);
+    }
+}

components/FreeNetwork/EVENTS.txt

@@ -0,0 +1,46 @@
+StartHostMetaLinks: Start /.well-known/host-meta links
+- &links:   array containing the links elements to be written
+
+EndHostMetaLinks: End /.well-known/host-meta links
+- &links:   array containing the links elements to be written
+
+StartGetWebFingerResource: Get a WebFingerResource extended object by resource string
+- $resource String that contains the requested URI
+- &$target  WebFingerResource extended object goes here
+- $args     Array which may contains arguments such as 'rel' filtering values
+
+EndGetWebFingerResource: Last attempts getting a WebFingerResource object
+- $resource String that contains the requested URI
+- &$target  WebFingerResource extended object goes here
+- $args     Array which may contains arguments such as 'rel' filtering values
+
+StartWebFingerReconstruction: Generate an acct: uri from a Profile object
+- $profile: Profile object for which we want a WebFinger ID
+- &$acct:   String reference where reconstructed ID is stored
+
+EndWebFingerReconstruction: Last attempts to generate an acct: uri from a Profile object
+- $profile: Profile object for which we want a WebFinger ID
+- &$acct:   String reference where reconstructed ID is stored
+
+StartWebFingerNoticeLinks: About to set links for the resource descriptor of a Notice
+- $xrd:     XML_XRD object being shown
+- $target:  Notice being shown
+
+EndWebFingerNoticeLinks: Done with links for the resource descriptor of a Notice
+- $xrd:     XML_XRD object being shown
+- $target:  Notice being shown
+
+StartWebFingerProfileLinks: About to set links for the resource descriptor of a Profile
+- $xrd:     XML_XRD object being shown
+- $target:  Profile being shown
+
+EndWebFingerProfileLinks: Done with links for the resource descriptor of a Profile
+- $xrd:     XML_XRD object being shown
+- $target:  Profile being shown
+
+StartDiscoveryMethodRegistration
+- $disco:   Discovery object that accepts the registrations
+
+EndDiscoveryMethodRegistration: Register remote URI discovery methods
+- $disco:   Discovery object that accepts the registrations
+

components/FreeNetwork/Entity/FreeNetworkActorProtocol.php

@@ -0,0 +1,175 @@
+<?php
+
+declare(strict_types = 1);
+// {{{ License
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+// }}}
+
+/**
+ * ActivityPub implementation for GNU social
+ *
+ * @package   GNUsocial
+ *
+ * @author    Diogo Peralta Cordeiro <@diogo.site
+ * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+
+namespace Component\FreeNetwork\Entity;
+
+use App\Core\DB;
+use App\Core\Entity;
+use App\Entity\Actor;
+use Component\FreeNetwork\Util\Discovery;
+use DateTimeInterface;
+
+/**
+ * Table Definition for free_network_actor_protocol
+ *
+ * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class FreeNetworkActorProtocol extends Entity
+{
+    // {{{ Autocode
+    // @codeCoverageIgnoreStart
+    private int $actor_id;
+    private ?string $protocol = null;
+    private string $addr;
+    private DateTimeInterface $created;
+    private DateTimeInterface $modified;
+
+    public function setActorId(int $actor_id): self
+    {
+        $this->actor_id = $actor_id;
+        return $this;
+    }
+
+    public function getActorId(): int
+    {
+        return $this->actor_id;
+    }
+
+    public function setProtocol(?string $protocol): self
+    {
+        $this->protocol = \is_null($protocol) ? null : mb_substr($protocol, 0, 32);
+        return $this;
+    }
+
+    public function getProtocol(): ?string
+    {
+        return $this->protocol;
+    }
+
+    public function setAddr(string $addr): self
+    {
+        $this->addr = $addr;
+        return $this;
+    }
+
+    public function getAddr(): string
+    {
+        return $this->addr;
+    }
+
+    public function setCreated(DateTimeInterface $created): self
+    {
+        $this->created = $created;
+        return $this;
+    }
+
+    public function getCreated(): DateTimeInterface
+    {
+        return $this->created;
+    }
+
+    public function setModified(DateTimeInterface $modified): self
+    {
+        $this->modified = $modified;
+        return $this;
+    }
+
+    public function getModified(): DateTimeInterface
+    {
+        return $this->modified;
+    }
+
+    // @codeCoverageIgnoreEnd
+    // }}} Autocode
+
+    public static function protocolSucceeded(string $protocol, int|Actor $actor_id, string $addr): void
+    {
+        $actor_id            = \is_int($actor_id) ? $actor_id : $actor_id->getId();
+        $attributed_protocol = self::getByPK(['actor_id' => $actor_id]);
+        if (\is_null($attributed_protocol)) {
+            $attributed_protocol = self::create([
+                'actor_id' => $actor_id,
+                'protocol' => $protocol,
+                'addr'     => Discovery::normalize($addr),
+            ]);
+        } else {
+            $attributed_protocol->setProtocol($protocol);
+        }
+        DB::persist($attributed_protocol);
+    }
+
+    public static function canIActor(string $protocol, int|Actor $actor_id): bool
+    {
+        $actor_id            = \is_int($actor_id) ? $actor_id : $actor_id->getId();
+        $attributed_protocol = self::getByPK(['actor_id' => $actor_id])?->getProtocol();
+        if (\is_null($attributed_protocol)) {
+            // If it is not attributed, you can go ahead.
+            return true;
+        } else {
+            // If it is attributed, you can on the condition that you're assigned to it.
+            return $attributed_protocol === $protocol;
+        }
+    }
+
+    public static function canIAddr(string $protocol, string $target): bool
+    {
+        // Normalize $addr, i.e. add 'acct:' if missing
+        $addr                = Discovery::normalize($target);
+        $attributed_protocol = self::getByPK(['addr' => $addr])?->getProtocol();
+        if (\is_null($attributed_protocol)) {
+            // If it is not attributed, you can go ahead.
+            return true;
+        } else {
+            // If it is attributed, you can on the condition that you're assigned to it.
+            return $attributed_protocol === $protocol;
+        }
+    }
+
+    public static function schemaDef(): array
+    {
+        return [
+            'name'   => 'free_network_actor_protocol',
+            'fields' => [
+                'actor_id' => ['type' => 'int', 'not null' => true],
+                'protocol' => ['type' => 'varchar',  'length' => 32, 'description' => 'the protocol plugin that should handle federation of this actor'],
+                'addr'     => ['type' => 'text',  'not null' => true, 'description' => 'webfinger acct'],
+                'created'  => ['type' => 'datetime',  'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'],
+                'modified' => ['type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'],
+            ],
+            'primary key'  => ['actor_id'],
+            'foreign keys' => [
+                'activitypub_actor_actor_id_fkey' => ['actor', ['actor_id' => 'id']],
+            ],
+        ];
+    }
+}

components/FreeNetwork/Exception/WebfingerReconstructionException.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types = 1);
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Class for an exception when a WebFinger acct: URI can not be constructed
+ * using the data we have in a Profile.
+ *
+ * PHP version 5
+ *
+ * LICENCE: 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/>.
+ *
+ * @category  Exception
+ * @package   StatusNet
+ *
+ * @author    Mikael Nordfeldth <mmn@hethane.se>
+ * @copyright 2013 Free Software Foundation, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ *
+ * @see      http://status.net/
+ */
+
+namespace Component\FreeNetwork\Exception;
+
+use function App\Core\I18n\_m;
+use App\Util\Exception\ServerException;
+use Throwable;
+
+/**
+ * Class for an exception when a WebFinger acct: URI can not be constructed
+ * using the data we have in a Profile.
+ *
+ * @category Exception
+ * @package  StatusNet
+ *
+ * @author   Mikael Nordfeldth <mmn@hethane.se>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
+ *
+ * @see     http://status.net/
+ */
+class WebfingerReconstructionException extends ServerException
+{
+    public function __construct(string $message = '', int $code = 500, ?Throwable $previous = null)
+    {
+        // We could log an entry here with the search parameters
+        parent::__construct(_m('WebFinger URI generation failed.'));
+    }
+}

components/FreeNetwork/FreeNetwork.php

@@ -0,0 +1,546 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+namespace Component\FreeNetwork;
+
+use App\Core\DB;
+use App\Core\Event;
+use App\Core\GSFile;
+use App\Core\HTTPClient;
+use function App\Core\I18n\_m;
+use App\Core\Log;
+use App\Core\Modules\Component;
+use App\Core\Router;
+use App\Entity\Activity;
+use App\Entity\Actor;
+use App\Entity\LocalUser;
+use App\Entity\Note;
+use App\Util\Common;
+use App\Util\Exception\ClientException;
+use App\Util\Exception\NicknameEmptyException;
+use App\Util\Exception\NicknameException;
+use App\Util\Exception\NicknameInvalidException;
+use App\Util\Exception\NicknameNotAllowedException;
+use App\Util\Exception\NicknameTakenException;
+use App\Util\Exception\NicknameTooLongException;
+use App\Util\Exception\NoSuchActorException;
+use App\Util\Exception\ServerException;
+use App\Util\Formatting;
+use App\Util\Nickname;
+use Component\FreeNetwork\Controller\Feeds;
+use Component\FreeNetwork\Controller\HostMeta;
+use Component\FreeNetwork\Controller\OwnerXrd;
+use Component\FreeNetwork\Controller\Webfinger;
+use Component\FreeNetwork\Util\Discovery;
+use Component\FreeNetwork\Util\WebfingerResource;
+use Component\FreeNetwork\Util\WebfingerResource\WebfingerResourceActor;
+use Component\FreeNetwork\Util\WebfingerResource\WebfingerResourceNote;
+use Doctrine\Common\Collections\ExpressionBuilder;
+use Exception;
+use const PREG_SET_ORDER;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+use XML_XRD;
+use XML_XRD_Element_Link;
+
+/**
+ * Implements WebFinger (RFC7033) for GNU social, as well as Link-based Resource Descriptor Discovery based on RFC6415,
+ * Web Host Metadata ('.well-known/host-meta') resource.
+ *
+ * @package GNUsocial
+ *
+ * @author  Mikael Nordfeldth <mmn@hethane.se>
+ * @author  Diogo Peralta Cordeiro <mail@diogo.site>
+ */
+class FreeNetwork extends Component
+{
+    public const PLUGIN_VERSION = '0.1.0';
+
+    public const OAUTH_ACCESS_TOKEN_REL  = 'http://apinamespace.org/oauth/access_token';
+    public const OAUTH_REQUEST_TOKEN_REL = 'http://apinamespace.org/oauth/request_token';
+    public const OAUTH_AUTHORIZE_REL     = 'http://apinamespace.org/oauth/authorize';
+    private static array $protocols      = [];
+
+    public function onInitializeComponent(): bool
+    {
+        Event::handle('AddFreeNetworkProtocol', [&self::$protocols]);
+        return Event::next;
+    }
+
+    public function onAddRoute(Router $m): bool
+    {
+        // Feeds
+        $m->connect('feed_network', '/feed/network', [Feeds::class, 'network']);
+        $m->connect('feed_clique', '/feed/clique', [Feeds::class, 'clique']);
+        $m->connect('feed_federated', '/feed/federated', [Feeds::class, 'federated']);
+
+        $m->connect('freenetwork_hostmeta', '.well-known/host-meta', [HostMeta::class, 'handle']);
+        $m->connect(
+            'freenetwork_hostmeta_format',
+            '.well-known/host-meta.:format',
+            [HostMeta::class, 'handle'],
+            ['format' => '(xml|json)'],
+        );
+        // the resource GET parameter can be anywhere, so don't mention it here
+        $m->connect('freenetwork_webfinger', '.well-known/webfinger', [Webfinger::class, 'handle']);
+        $m->connect(
+            'freenetwork_webfinger_format',
+            '.well-known/webfinger.:format',
+            [Webfinger::class, 'handle'],
+            ['format' => '(xml|json)'],
+        );
+        $m->connect('freenetwork_ownerxrd', 'main/ownerxrd', [OwnerXrd::class, 'handle']);
+        return Event::next;
+    }
+
+    public function onCreateDefaultFeeds(int $actor_id, LocalUser $user, int &$ordering)
+    {
+        DB::persist(\App\Entity\Feed::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'feed_network'), 'route' => $route, 'title' => _m('Meteorites'), 'ordering' => $ordering++]));
+        DB::persist(\App\Entity\Feed::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'feed_clique'), 'route' => $route, 'title' => _m('Planetary System'), 'ordering' => $ordering++]));
+        DB::persist(\App\Entity\Feed::create(['actor_id' => $actor_id, 'url' => Router::url($route = 'feed_federated'), 'route' => $route, 'title' => _m('Galaxy'), 'ordering' => $ordering++]));
+        return Event::next;
+    }
+
+    public function onStartGetProfileAcctUri(Actor $profile, &$acct): bool
+    {
+        $wfr = new WebFingerResourceActor($profile);
+        try {
+            $acct = $wfr->reconstructAcct();
+        } catch (Exception) {
+            return Event::next;
+        }
+
+        return Event::stop;
+    }
+
+    /**
+     * Last attempts getting a WebFingerResource object
+     *
+     * @param string                 $resource String that contains the requested URI
+     * @param null|WebfingerResource $target   WebFingerResource extended object goes here
+     * @param array                  $args     Array which may contains arguments such as 'rel' filtering values
+     *
+     * @throws NicknameEmptyException
+     * @throws NicknameException
+     * @throws NicknameInvalidException
+     * @throws NicknameNotAllowedException
+     * @throws NicknameTakenException
+     * @throws NicknameTooLongException
+     * @throws NoSuchActorException
+     * @throws ServerException
+     */
+    public function onEndGetWebFingerResource(string $resource, ?WebfingerResource &$target = null, array $args = []): bool
+    {
+        // * Either we didn't find the profile, then we want to make
+        //   the $profile variable null for clarity.
+        // * Or we did find it but for a possibly malicious remote
+        //   user who might've set their profile URL to a Note URL
+        //   which would've caused a sort of DoS unless we continue
+        //   our search here by discarding the remote profile.
+        $profile = null;
+        if (Discovery::isAcct($resource)) {
+            $parts = explode('@', mb_substr(urldecode($resource), 5)); // 5 is strlen of 'acct:'
+            if (\count($parts) === 2) {
+                [$nick, $domain] = $parts;
+                if ($domain !== Common::config('site', 'server')) {
+                    throw new ServerException(_m('Remote profiles not supported via WebFinger yet.'));
+                }
+
+                $nick              = Nickname::normalize(nickname: $nick, check_already_used: false, check_is_allowed: false);
+                $freenetwork_actor = LocalUser::getByPK(['nickname' => $nick]);
+                if (!($freenetwork_actor instanceof LocalUser)) {
+                    throw new NoSuchActorException($nick);
+                }
+                $profile = $freenetwork_actor->getActor();
+            }
+        } else {
+            try {
+                if (Common::isValidHttpUrl($resource)) {
+                    // This means $resource is a valid url
+                    $resource_parts = parse_url($resource);
+                    // TODO: Use URLMatcher
+                    if ($resource_parts['host'] === Common::config('site', 'server')) {
+                        $str = $resource_parts['path'];
+                        // actor_view_nickname
+                        $renick = '/\/@(' . Nickname::DISPLAY_FMT . ')\/?/m';
+                        // actor_view_id
+                        $reuri = '/\/actor\/(\d+)\/?/m';
+                        if (preg_match_all($renick, $str, $matches, PREG_SET_ORDER, 0) === 1) {
+                            $profile = LocalUser::getByPK(['nickname' => $matches[0][1]])->getActor();
+                        } elseif (preg_match_all($reuri, $str, $matches, PREG_SET_ORDER, 0) === 1) {
+                            $profile = Actor::getById((int) $matches[0][1]);
+                        }
+                    }
+                }
+            } catch (NoSuchActorException $e) {
+                // not a User, maybe a Note? we'll try that further down...
+
+//            try {
+//                Log::debug(__METHOD__ . ': Finding User_group URI for WebFinger lookup on resource==' . $resource);
+//                $group = new User_group();
+//                $group->whereAddIn('uri', array_keys($alt_urls), $group->columnType('uri'));
+//                $group->limit(1);
+//                if ($group->find(true)) {
+//                    $profile = $group->getProfile();
+//                }
+//                unset($group);
+//            } catch (Exception $e) {
+//                Log::error(get_class($e) . ': ' . $e->getMessage());
+//                throw $e;
+//            }
+            }
+        }
+
+        if ($profile instanceof Actor) {
+            Log::debug(__METHOD__ . ': Found Profile with ID==' . $profile->getID() . ' for resource==' . $resource);
+            $target = new WebfingerResourceActor($profile);
+            return Event::stop; // We got our target, stop handler execution
+        }
+
+        if (!\is_null($note = DB::findOneBy(Note::class, ['url' => $resource], return_null: true))) {
+            $target = new WebfingerResourceNote($note);
+            return Event::stop; // We got our target, stop handler execution
+        }
+
+        return Event::next;
+    }
+
+    public function onStartHostMetaLinks(array &$links): bool
+    {
+        foreach (Discovery::supportedMimeTypes() as $type) {
+            $links[] = new XML_XRD_Element_Link(
+                Discovery::LRDD_REL,
+                Router::url(id: 'freenetwork_webfinger', args: [], type: Router::ABSOLUTE_URL) . '?resource={uri}',
+                $type,
+                isTemplate: true,
+            );
+        }
+
+        // TODO OAuth connections
+        //$links[] = new XML_XRD_Element_link(self::OAUTH_ACCESS_TOKEN_REL, common_local_url('ApiOAuthAccessToken'));
+        //$links[] = new XML_XRD_Element_link(self::OAUTH_REQUEST_TOKEN_REL, common_local_url('ApiOAuthRequestToken'));
+        //$links[] = new XML_XRD_Element_link(self::OAUTH_AUTHORIZE_REL, common_local_url('ApiOAuthAuthorize'));
+        return Event::next;
+    }
+
+    /**
+     * Add a link header for LRDD Discovery
+     */
+    public function onStartShowHTML($action): bool
+    {
+        if ($action instanceof ShowstreamAction) {
+            $resource = $action->getTarget()->getUri();
+            $url      = common_local_url('webfinger') . '?resource=' . urlencode($resource);
+
+            foreach ([Discovery::JRD_MIMETYPE, Discovery::XRD_MIMETYPE] as $type) {
+                header('Link: <' . $url . '>; rel="' . Discovery::LRDD_REL . '"; type="' . $type . '"', false);
+            }
+        }
+        return Event::next;
+    }
+
+    public function onStartDiscoveryMethodRegistration(Discovery $disco): bool
+    {
+        $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodWebfinger');
+        return Event::next;
+    }
+
+    public function onEndDiscoveryMethodRegistration(Discovery $disco): bool
+    {
+        $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodHostMeta');
+        $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodLinkHeader');
+        $disco->registerMethod('\Component\FreeNetwork\Util\LrddMethod\LrddMethodLinkHtml');
+        return Event::next;
+    }
+
+    /**
+     * @throws ClientException
+     * @throws ServerException
+     */
+    public function onControllerResponseInFormat(string $route, array $accept_header, array $vars, ?Response &$response = null): bool
+    {
+        if (!\in_array($route, ['freenetwork_hostmeta', 'freenetwork_hostmeta_format', 'freenetwork_webfinger', 'freenetwork_webfinger_format', 'freenetwork_ownerxrd'])) {
+            return Event::next;
+        }
+
+        $mimeType = array_intersect(array_values(Discovery::supportedMimeTypes()), $accept_header);
+        /*
+         * "A WebFinger resource MUST return a JRD as the representation
+         *  for the resource if the client requests no other supported
+         *  format explicitly via the HTTP "Accept" header. [...]
+         *  The WebFinger resource MUST silently ignore any requested
+         *  representations that it does not understand and support."
+         *                                       -- RFC 7033 (WebFinger)
+         *                            http://tools.ietf.org/html/rfc7033
+         */
+        $mimeType = \count($mimeType) !== 0 ? array_pop($mimeType) : $vars['default_mimetype'];
+
+        $headers = [];
+
+        if (Common::config('discovery', 'cors')) {
+            $headers['Access-Control-Allow-Origin'] = '*';
+        }
+
+        $headers['Content-Type'] = $mimeType;
+
+        $response = match ($mimeType) {
+            Discovery::XRD_MIMETYPE => new Response(content: $vars['xrd']->to('xml'), headers: $headers),
+            Discovery::JRD_MIMETYPE, Discovery::JRD_MIMETYPE_OLD => new JsonResponse(data: $vars['xrd']->to('json'), headers: $headers, json: true),
+        };
+
+        $response->headers->set('cache-control', 'no-store, no-cache, must-revalidate');
+
+        return Event::stop;
+    }
+
+    /**
+     * Webfinger matches: @user@example.com or even @user--one.george_orwell@1984.biz
+     *
+     * @param string $text       The text from which to extract webfinger IDs
+     * @param string $preMention Character(s) that signals a mention ('@', '!'...)
+     *
+     * @return array the matching IDs (without $preMention) and each respective position in the given string
+     */
+    public static function extractWebfingerIds(string $text, string $preMention = '@'): array
+    {
+        $wmatches = [];
+        $result   = preg_match_all(
+            '/' . Nickname::BEFORE_MENTIONS . preg_quote($preMention, '/') . '(' . Nickname::WEBFINGER_FMT . ')/',
+            $text,
+            $wmatches,
+            \PREG_OFFSET_CAPTURE,
+        );
+        if ($result === false) {
+            Log::error(__METHOD__ . ': Error parsing webfinger IDs from text (preg_last_error==' . preg_last_error() . ').');
+            return [];
+        } elseif (($n_matches = \count($wmatches)) != 0) {
+            Log::debug((sprintf('Found %d matches for WebFinger IDs: %s', $n_matches, print_r($wmatches, true))));
+        }
+        return $wmatches[1];
+    }
+
+    /**
+     * Profile URL matches: @param string $text The text from which to extract URL mentions
+     *
+     * @param string $preMention Character(s) that signals a mention ('@', '!'...)
+     *
+     * @return array the matching URLs (without @ or acct:) and each respective position in the given string
+     * @example.com/mublog/user
+     */
+    public static function extractUrlMentions(string $text, string $preMention = '@'): array
+    {
+        $wmatches = [];
+        // In the regexp below we need to match / _before_ URL_REGEX_VALID_PATH_CHARS because it otherwise gets merged
+        // with the TLD before (but / is in URL_REGEX_VALID_PATH_CHARS anyway, it's just its positioning that is important)
+        $result = preg_match_all(
+            '/' . Nickname::BEFORE_MENTIONS . preg_quote($preMention, '/') . '(' . URL_REGEX_DOMAIN_NAME . '(?:\/[' . URL_REGEX_VALID_PATH_CHARS . ']*)*)/',
+            $text,
+            $wmatches,
+            \PREG_OFFSET_CAPTURE,
+        );
+        if ($result === false) {
+            Log::error(__METHOD__ . ': Error parsing profile URL mentions from text (preg_last_error==' . preg_last_error() . ').');
+            return [];
+        } elseif (\count($wmatches)) {
+            Log::debug((sprintf('Found %d matches for profile URL mentions: %s', \count($wmatches), print_r($wmatches, true))));
+        }
+        return $wmatches[1];
+    }
+
+    /**
+     * Find any explicit remote mentions. Accepted forms:
+     *   Webfinger: @user@example.com
+     *   Profile link: @param Actor $sender
+     *
+     * @param string $text input markup text
+     * @param $mentions
+     *
+     * @return bool hook return value
+     * @example.com/mublog/user
+     */
+    public function onEndFindMentions(Actor $sender, string $text, array &$mentions): bool
+    {
+        $matches = [];
+
+        foreach (self::extractWebfingerIds($text, $preMention = '@') as $wmatch) {
+            [$target, $pos] = $wmatch;
+            Log::info("Checking webfinger person '{$target}'");
+
+            $actor = null;
+
+            $resource_parts = explode($preMention, $target);
+            if ($resource_parts[1] === Common::config('site', 'server')) {
+                $actor = LocalUser::getByPK(['nickname' => $resource_parts[0]])->getActor();
+            } else {
+                Event::handle('FreeNetworkFindMentions', [$target, &$actor]);
+                if (\is_null($actor)) {
+                    continue;
+                }
+            }
+            \assert($actor instanceof Actor);
+
+            $displayName = !empty($actor->getFullname()) ? $actor->getFullname() : $actor->getNickname() ?? $target; // TODO: we could do getBestName() or getFullname() here
+
+            $matches[$pos] = [
+                'mentioned' => [$actor],
+                'type'      => 'mention',
+                'text'      => $displayName,
+                'position'  => $pos,
+                'length'    => mb_strlen($target),
+                'url'       => $actor->getUri(),
+            ];
+        }
+
+        foreach (self::extractUrlMentions($text) as $wmatch) {
+            [$target, $pos] = $wmatch;
+            $url            = "https://{$target}";
+            if (Common::isValidHttpUrl($url)) {
+                // This means $resource is a valid url
+                $resource_parts = parse_url($url);
+                // TODO: Use URLMatcher
+                if ($resource_parts['host'] === Common::config('site', 'server')) {
+                    $str = $resource_parts['path'];
+                    // actor_view_nickname
+                    $renick = '/\/@(' . Nickname::DISPLAY_FMT . ')\/?/m';
+                    // actor_view_id
+                    $reuri = '/\/actor\/(\d+)\/?/m';
+                    if (preg_match_all($renick, $str, $matches, PREG_SET_ORDER, 0) === 1) {
+                        $actor = LocalUser::getByPK(['nickname' => $matches[0][1]])->getActor();
+                    } elseif (preg_match_all($reuri, $str, $matches, PREG_SET_ORDER, 0) === 1) {
+                        $actor = Actor::getById((int) $matches[0][1]);
+                    } else {
+                        Log::error('Unexpected behaviour onEndFindMentions at FreeNetwork');
+                        throw new ServerException('Unexpected behaviour onEndFindMentions at FreeNetwork');
+                    }
+                } else {
+                    Log::info("Checking actor address '{$url}'");
+
+                    $link = new XML_XRD_Element_Link(
+                        Discovery::LRDD_REL,
+                        'https://' . parse_url($url, \PHP_URL_HOST) . '/.well-known/webfinger?resource={uri}',
+                        Discovery::JRD_MIMETYPE,
+                        true, // isTemplate
+                    );
+                    $xrd_uri  = Discovery::applyTemplate($link->template, $url);
+                    $response = HTTPClient::get($xrd_uri, ['headers' => ['Accept' => $link->type]]);
+                    if ($response->getStatusCode() !== 200) {
+                        continue;
+                    }
+
+                    $xrd = new XML_XRD();
+
+                    switch (GSFile::mimetypeBare($response->getHeaders()['content-type'][0])) {
+                        case Discovery::JRD_MIMETYPE_OLD:
+                        case Discovery::JRD_MIMETYPE:
+                            $type = 'json';
+                            break;
+                        case Discovery::XRD_MIMETYPE:
+                            $type = 'xml';
+                            break;
+                        default:
+                            // fall back to letting XML_XRD auto-detect
+                            Log::debug('No recognized content-type header for resource descriptor body on ' . $xrd_uri);
+                            $type = null;
+                    }
+                    $xrd->loadString($response->getContent(), $type);
+
+                    $actor = null;
+                    Event::handle('FreeNetworkFoundXrd', [$xrd, &$actor]);
+                    if (\is_null($actor)) {
+                        continue;
+                    }
+                }
+                $displayName   = $actor->getFullname() ?? $actor->getNickname() ?? $target; // TODO: we could do getBestName() or getFullname() here
+                $matches[$pos] = [
+                    'mentioned' => [$actor],
+                    'type'      => 'mention',
+                    'text'      => $displayName,
+                    'position'  => $pos,
+                    'length'    => mb_strlen($target),
+                    'url'       => $actor->getUri(),
+                ];
+            }
+        }
+
+        foreach ($mentions as $i => $other) {
+            // If we share a common prefix with a local user, override it!
+            $pos = $other['position'];
+            if (isset($matches[$pos])) {
+                $mentions[$i] = $matches[$pos];
+                unset($matches[$pos]);
+            }
+        }
+        foreach ($matches as $mention) {
+            $mentions[] = $mention;
+        }
+
+        return Event::next;
+    }
+
+    public static function notify(Actor $sender, Activity $activity, array $targets, ?string $reason = null): bool
+    {
+        foreach (self::$protocols as $protocol) {
+            $protocol::freeNetworkDistribute($sender, $activity, $targets, $reason);
+        }
+        return false;
+    }
+
+    public static function mentionTagToName(string $nickname, string $uri): string
+    {
+        return '@' . $nickname . '@' . parse_url($uri, \PHP_URL_HOST);
+    }
+
+    public static function groupTagToName(string $nickname, string $uri): string
+    {
+        return '!' . $nickname . '@' . parse_url($uri, \PHP_URL_HOST);
+    }
+
+    /**
+     * Add fediverse: query expression
+     * // TODO: adding WebFinger would probably be nice
+     */
+    public function onCollectionQueryCreateExpression(ExpressionBuilder $eb, string $term, ?string $locale, ?Actor $actor, &$note_expr, &$actor_expr): bool
+    {
+        if (Formatting::startsWith($term, ['fediverse:'])) {
+            foreach (self::$protocols as $protocol) {
+                // 10 is strlen of `fediverse:`
+                if ($protocol::freeNetworkGrabRemote(mb_substr($term, 10))) {
+                    break;
+                }
+            }
+        }
+        return Event::next;
+    }
+
+    public function onPluginVersion(array &$versions): bool
+    {
+        $versions[] = [
+            'name'     => 'WebFinger',
+            'version'  => self::PLUGIN_VERSION,
+            'author'   => 'Mikael Nordfeldth',
+            'homepage' => GNUSOCIAL_ENGINE_URL,
+            // TRANS: Plugin description.
+            'rawdescription' => _m('WebFinger and LRDD support'),
+        ];
+
+        return true;
+    }
+}

components/FreeNetwork/README.md

@@ -0,0 +1,2 @@
+The FreeNetwork component adds WebFinger (RFC7033) lookup and implements Link-based Resource Descriptor Discovery (LRDD)
+based on RFC6415, Web Host Metadata.

components/FreeNetwork/Util/Discovery.php

@@ -0,0 +1,226 @@
+<?php
+
+declare(strict_types = 1);
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This class performs lookups based on methods implemented in separate
+ * classes, where a resource uri is given. Examples are WebFinger (RFC7033)
+ * and the LRDD (Link-based Resource Descriptor Discovery) in RFC6415.
+ *
+ * PHP version 5
+ *
+ * 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/>.
+ *
+ * @category  Discovery
+ * @package   GNUsocial
+ *
+ * @author    James Walker <james@status.net>
+ * @author    Mikael Nordfeldth <mmn@hethane.se>
+ * @copyright 2010 StatusNet, Inc.
+ * @copyright 2013 Free Software Foundation, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ *
+ * @see      http://www.gnu.org/software/social/
+ */
+
+namespace Component\FreeNetwork\Util;
+
+use App\Core\Event;
+use App\Core\GSFile;
+use App\Core\HTTPClient;
+use function App\Core\I18n\_m;
+use App\Core\Log;
+use App\Util\Exception\ClientException;
+use Exception;
+use XML_XRD;
+use XML_XRD_Element_Link;
+
+class Discovery
+{
+    public const LRDD_REL    = 'lrdd';
+    public const UPDATESFROM = 'http://schemas.google.com/g/2010#updates-from';
+    public const HCARD       = 'http://microformats.org/profile/hcard';
+    public const MF2_HCARD   = 'http://microformats.org/profile/h-card';   // microformats2 h-card
+
+    public const JRD_MIMETYPE_OLD = 'application/json';    // RFC6415 uses this
+    public const JRD_MIMETYPE     = 'application/jrd+json';
+    public const XRD_MIMETYPE     = 'application/xrd+xml';
+
+    public array $methods = [];
+
+    /**
+     * Constructor for a discovery object
+     *
+     * Registers different discovery methods.
+     */
+    public function __construct()
+    {
+        if (Event::handle('StartDiscoveryMethodRegistration', [$this])) {
+            Event::handle('EndDiscoveryMethodRegistration', [$this]);
+        }
+    }
+
+    public static function supportedMimeTypes(): array
+    {
+        return [
+            'json'    => self::JRD_MIMETYPE,
+            'jsonold' => self::JRD_MIMETYPE_OLD,
+            'xml'     => self::XRD_MIMETYPE,
+        ];
+    }
+
+    /**
+     * Register a discovery class
+     *
+     * @param string $class Class name
+     */
+    public function registerMethod($class): void
+    {
+        $this->methods[] = $class;
+    }
+
+    /**
+     * Given a user ID, return the first available resource descriptor
+     *
+     * @param string $id User ID URI
+     *
+     * @return XML_XRD object for the resource descriptor of the id
+     */
+    public function lookup(string $id): XML_XRD
+    {
+        // Normalize the incoming $id to make sure we have an uri
+        $uri = self::normalize($id);
+
+        Log::debug(sprintf('Performing discovery for "%s" (normalized "%s")', $id, $uri));
+
+        foreach ($this->methods as $class) {
+            try {
+                $xrd = new XML_XRD();
+
+                Log::debug("LRDD discovery method for '{$uri}': {$class}");
+                $lrdd  = new $class;
+                $links = $lrdd->discover($uri);
+                $link  = self::getService($links, self::LRDD_REL);
+
+                // Load the LRDD XRD
+                if (!empty($link->template)) {
+                    $xrd_uri = self::applyTemplate($link->template, $uri);
+                } elseif (!empty($link->href)) {
+                    $xrd_uri = $link->href;
+                } else {
+                    throw new Exception('No resource descriptor URI in link.');
+                }
+
+                $headers = [];
+                if (!\is_null($link->type)) {
+                    $headers['Accept'] = $link->type;
+                }
+
+                $response = HTTPClient::get($xrd_uri, ['headers' => $headers]);
+                if ($response->getStatusCode() !== 200) {
+                    throw new Exception('Unexpected HTTP status code.');
+                }
+
+                switch (GSFile::mimetypeBare($response->getHeaders()['content-type'][0])) {
+                    case self::JRD_MIMETYPE_OLD:
+                    case self::JRD_MIMETYPE:
+                        $type = 'json';
+                        break;
+                    case self::XRD_MIMETYPE:
+                        $type = 'xml';
+                        break;
+                    default:
+                        // fall back to letting XML_XRD auto-detect
+                        Log::debug('No recognized content-type header for resource descriptor body on ' . $xrd_uri);
+                        $type = null;
+                }
+                $xrd->loadString($response->getContent(), $type);
+                return $xrd;
+            } catch (ClientException $e) {
+                if ($e->getCode() === 403) {
+                    Log::info(sprintf('%s: Aborting discovery on URL %s: %s', $class, $uri, $e->getMessage()));
+                    break;
+                }
+            } catch (Exception $e) {
+                Log::info(sprintf('%s: Failed for %s: %s', $class, $uri, $e->getMessage()));
+                continue;
+            }
+        }
+
+        // TRANS: Exception. %s is an ID.
+        throw new Exception(sprintf(_m('Unable to find services for %s.'), $id));
+    }
+
+    /**
+     * Given an array of links, returns the matching service
+     *
+     * @param array  $links   Links to check (as instances of XML_XRD_Element_Link)
+     * @param string $service Service to find
+     *
+     * @return XML_XRD_Element_Link $link
+     */
+    public static function getService(array $links, $service): XML_XRD_Element_Link
+    {
+        foreach ($links as $link) {
+            if ($link->rel === $service) {
+                return $link;
+            }
+            Log::debug('LINK: rel ' . $link->rel . ' !== ' . $service);
+        }
+
+        throw new Exception('No service link found');
+    }
+
+    /**
+     * Given a "user id" make sure it's normalized to an acct: uri
+     *
+     * @param string $uri User ID to normalize
+     *
+     * @return string normalized acct: URI
+     */
+    public static function normalize(string $uri): string
+    {
+        $parts = parse_url($uri);
+        // If we don't have a scheme, but the path implies user@host,
+        // though this is far from a perfect matching procedure...
+        if (!isset($parts['scheme']) && isset($parts['path'])
+            && preg_match('/[\w@\w]/u', $parts['path'])) {
+            return 'acct:' . $uri;
+        }
+
+        return $uri;
+    }
+
+    public static function isAcct(string $uri): bool
+    {
+        return mb_strtolower(mb_substr($uri, 0, 5)) == 'acct:';
+    }
+
+    /**
+     * Apply a template using an ID
+     *
+     * Replaces {uri} in template string with the ID given.
+     *
+     * @param string $template Template to match
+     * @param string $uri      URI to replace with
+     *
+     * @return string replaced values
+     */
+    public static function applyTemplate($template, $uri): string
+    {
+        return str_replace('{uri}', urlencode($uri), $template);
+    }
+}

components/FreeNetwork/Util/LinkHeader.php

@@ -0,0 +1,128 @@
+<?php
+
+declare(strict_types = 1);
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * Parse HTTP response for interesting Link: headers
+ *
+ * PHP version 5
+ *
+ * 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/>.
+ *
+ * @category  Discovery
+ * @package   StatusNet
+ *
+ * @author    James Walker <james@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ *
+ * @see      http://status.net/
+ */
+
+namespace Component\FreeNetwork\Util;
+
+/**
+ * Class to represent Link: headers in an HTTP response
+ *
+ * Since these are a fairly important part of Hammer-stack discovery, they're
+ * reified and implemented here.
+ *
+ * @category  Discovery
+ * @package   StatusNet
+ *
+ * @author    James Walker <james@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ *
+ * @see      http://status.net/
+ * @see       Discovery
+ */
+class LinkHeader
+{
+    public $href;
+    public $rel;
+    public $type;
+
+    /**
+     * Initialize from a string
+     *
+     * @param string $str Link: header value
+     */
+    public function __construct(string $str = '')
+    {
+        preg_match('/^<[^>]+>/', $str, $uri_reference);
+        //if (empty($uri_reference)) return;
+
+        $this->href = trim($uri_reference[0], '<>');
+        $this->rel  = [];
+        $this->type = null;
+
+        // remove uri-reference from header
+        $str = mb_substr($str, mb_strlen($uri_reference[0]));
+
+        // parse link-params
+        $params = explode(';', $str);
+
+        foreach ($params as $param) {
+            if (empty($param)) {
+                continue;
+            }
+            [$param_name, $param_value] = explode('=', $param, 2);
+
+            $param_name  = trim($param_name);
+            $param_value = preg_replace('(^"|"$)', '', trim($param_value));
+
+            // for now we only care about 'rel' and 'type' link params
+            // TODO do something with the other links-params
+            switch ($param_name) {
+                case 'rel':
+                    $this->rel = trim($param_value);
+                    break;
+
+                case 'type':
+                    $this->type = trim($param_value);
+            }
+        }
+    }
+
+    /**
+     * Given an HTTP response, return the requested Link: header
+     *
+     * @param HTTP_Request2_Response $response response to check
+     * @param string                 $rel      relationship to look for
+     * @param string                 $type     media type to look for
+     *
+     * @return LinkHeader discovered header, or null on failure
+     */
+    public static function getLink($response, $rel = null, $type = null)
+    {
+        $headers = $response->getHeader('Link');
+        if ($headers) {
+            // Can get an array or string, so try to simplify the path
+            if (!\is_array($headers)) {
+                $headers = [$headers];
+            }
+
+            foreach ($headers as $header) {
+                $lh = new self($header);
+
+                if ((\is_null($rel) || $lh->rel == $rel) && (\is_null($type) || $lh->type == $type)) {
+                    return $lh->href;
+                }
+            }
+        }
+    }
+}

components/FreeNetwork/Util/LrddMethod.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util;
+
+use App\Core\Event;
+use App\Core\HTTPClient;
+use Exception;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+use XML_XRD;
+
+/**
+ * Abstract class for LRDD discovery methods
+ *
+ * Objects that extend this class can retrieve an array of
+ * resource descriptor links for the URI. The array consists
+ * of XML_XRD_Element_Link elements.
+ *
+ * @category  Discovery
+ * @package   StatusNet
+ *
+ * @author    James Walker <james@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ *
+ * @see      http://status.net/
+ */
+abstract class LrddMethod
+{
+    protected $xrd;
+
+    public function __construct()
+    {
+        $this->xrd = new XML_XRD();
+    }
+
+    /**
+     * Discover interesting info about the URI
+     *
+     * @param string $uri URI to inquire about
+     *
+     * @return array of XML_XRD_Element_Link elements to discovered resource descriptors
+     */
+    abstract public function discover($uri);
+
+    protected function fetchUrl($url, $method = 'get'): ResponseInterface
+    {
+        // If we have a blacklist enabled, let's check against it
+        Event::handle('UrlBlacklistTest', [$url]);
+
+        $response = HTTPClient::$method($url);
+
+        if ($response->getStatusCode() !== 200) {
+            throw new Exception('Unexpected HTTP status code.');
+        }
+
+        return $response;
+    }
+}

components/FreeNetwork/Util/LrddMethod/LrddMethodHostMeta.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util\LrddMethod;
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+use App\Core\Log;
+use Component\FreeNetwork\Util\Discovery;
+use Component\FreeNetwork\Util\LrddMethod;
+use Exception;
+
+/**
+ * Implementation of discovery using host-meta file
+ *
+ * Discovers resource descriptor file for a user by going to the
+ * organization's host-meta file and trying to find a template for LRDD.
+ *
+ * @category  Discovery
+ * @package   GNUsocial
+ *
+ * @author    James Walker <james@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class LrddMethodHostMeta extends LRDDMethod
+{
+    /**
+     * For RFC6415 and HTTP URIs, fetch the host-meta file
+     * and look for LRDD templates
+     */
+    public function discover($uri)
+    {
+        // This is allowed for RFC6415 but not the 'WebFinger' RFC7033.
+        $try_schemes = ['https', 'http'];
+
+        $scheme = mb_strtolower(parse_url($uri, \PHP_URL_SCHEME));
+        switch ($scheme) {
+            case 'acct':
+                // We can't use parse_url data for this, since the 'host'
+                // entry is only set if the scheme has '://' after it.
+                $parts = explode('@', parse_url($uri, \PHP_URL_PATH), 2);
+
+                if (!Discovery::isAcct($uri) || \count($parts) != 2) {
+                    throw new Exception('Bad resource URI: ' . $uri);
+                }
+                [, $domain] = $parts;
+                break;
+            case 'http':
+            case 'https':
+                $domain      = mb_strtolower(parse_url($uri, \PHP_URL_HOST));
+                $try_schemes = [$scheme];
+                break;
+            default:
+                throw new Exception('Unable to discover resource descriptor endpoint.');
+        }
+
+        foreach ($try_schemes as $scheme) {
+            $url = $scheme . '://' . $domain . '/.well-known/host-meta';
+
+            try {
+                $response = self::fetchUrl($url);
+                $this->xrd->loadString($response->getContent());
+            } catch (Exception $e) {
+                Log::debug('LRDD could not load resource descriptor: ' . $url . ' (' . $e->getMessage() . ')');
+                continue;
+            }
+            return $this->xrd->links;
+        }
+
+        throw new Exception('Unable to retrieve resource descriptor links.');
+    }
+}

components/FreeNetwork/Util/LrddMethod/LrddMethodLinkHeader.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util\LrddMethod;
+
+use App\Core\Log;
+use Component\FreeNetwork\Util\LinkHeader;
+use Component\FreeNetwork\Util\LrddMethod;
+use Exception;
+use XML_XRD_Element_Link;
+
+/**
+ * Implementation of discovery using HTTP Link header
+ *
+ * Discovers XRD file for a user by fetching the URL and reading any
+ * Link: headers in the HTTP response.
+ *
+ * @category  Discovery
+ * @package   StatusNet
+ *
+ * @author    James Walker <james@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ *
+ * @see      http://status.net/
+ */
+class LrddMethodLinkHeader extends LRDDMethod
+{
+    /**
+     * For HTTP IDs fetch the URL and look for Link headers.
+     *
+     * @todo fail out of WebFinger URIs faster
+     */
+    public function discover($uri)
+    {
+        $response = self::fetchUrl($uri, 'head');
+
+        $link_header = $response->getHeaders()['link'][0];
+        if (empty($link_header)) {
+            throw new Exception('No Link header found');
+        }
+        Log::debug('LRDD LinkHeader found: ' . var_export($link_header, true));
+
+        return self::parseHeader($link_header);
+    }
+
+    /**
+     * Given a string or array of headers, returns JRD-like assoc array
+     *
+     * @param array|string $header string or array of strings for headers
+     *
+     * @return array of associative arrays in JRD-like array format
+     */
+    protected static function parseHeader($header)
+    {
+        $lh = new LinkHeader($header);
+
+        $link = new XML_XRD_Element_Link($lh->rel, $lh->href, $lh->type);
+
+        return [$link];
+    }
+}

components/FreeNetwork/Util/LrddMethod/LrddMethodLinkHtml.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util\LrddMethod;
+
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+use Component\FreeNetwork\Util\LrddMethod;
+use XML_XRD_Element_Link;
+
+/**
+ * Implementation of discovery using HTML <link> element
+ *
+ * Discovers XRD file for a user by fetching the URL and reading any
+ * <link> elements in the HTML response.
+ *
+ * @category  Discovery
+ * @package   GNUsocial
+ *
+ * @author    James Walker <james@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class LrddMethodLinkHtml extends LRDDMethod
+{
+    /**
+     * For HTTP IDs, fetch the URL and look for <link> elements
+     * in the HTML response.
+     *
+     * @todo fail out of WebFinger URIs faster
+     */
+    public function discover($uri)
+    {
+        $response = self::fetchUrl($uri);
+
+        return self::parse($response->getContent());
+    }
+
+    /**
+     * Parse HTML and return <link> elements
+     *
+     * Given an HTML string, scans the string for <link> elements
+     *
+     * @param string $html HTML to scan
+     *
+     * @return array array of associative arrays in JRD-ish array format
+     */
+    public function parse($html)
+    {
+        $links = [];
+
+        preg_match('/<head(\s[^>]*)?>(.*?)<\/head>/is', $html, $head_matches);
+
+        if (\count($head_matches) != 3) {
+            return [];
+        }
+        [, , $head_html] = $head_matches;
+
+        preg_match_all('/<link\s[^>]*>/i', $head_html, $link_matches);
+
+        foreach ($link_matches[0] as $link_html) {
+            $link_url  = null;
+            $link_rel  = null;
+            $link_type = null;
+
+            preg_match('/\srel=(("|\')([^\\2]*?)\\2|[^"\'\s]+)/i', $link_html, $rel_matches);
+            if (\count($rel_matches) > 3) {
+                $link_rel = $rel_matches[3];
+            } elseif (\count($rel_matches) > 1) {
+                $link_rel = $rel_matches[1];
+            }
+
+            preg_match('/\shref=(("|\')([^\\2]*?)\\2|[^"\'\s]+)/i', $link_html, $href_matches);
+            if (\count($href_matches) > 3) {
+                $link_uri = $href_matches[3];
+            } elseif (\count($href_matches) > 1) {
+                $link_uri = $href_matches[1];
+            }
+
+            preg_match('/\stype=(("|\')([^\\2]*?)\\2|[^"\'\s]+)/i', $link_html, $type_matches);
+            if (\count($type_matches) > 3) {
+                $link_type = $type_matches[3];
+            } elseif (\count($type_matches) > 1) {
+                $link_type = $type_matches[1];
+            }
+
+            $links[] = new XML_XRD_Element_Link($link_rel, $link_uri, $link_type);
+        }
+
+        return $links;
+    }
+}

components/FreeNetwork/Util/LrddMethod/LrddMethodWebfinger.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types = 1);
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social 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.
+//
+// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Component\FreeNetwork\Util\LrddMethod;
+
+use Component\FreeNetwork\Util\Discovery;
+use Component\FreeNetwork\Util\LrddMethod;
+use Exception;
+use XML_XRD_Element_Link;
+
+/**
+ * Implementation of WebFinger resource discovery (RFC7033)
+ *
+ * @category  Discovery
+ * @package   GNUsocial
+ *
+ * @author    Mikael Nordfeldth <mmn@hethane.se>
+ * @copyright 2013 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class LrddMethodWebfinger extends LRDDMethod
+{
+    /**
+     * Simply returns the WebFinger URL over HTTPS at the uri's domain:
+     * https://{domain}/.well-known/webfinger?resource={uri}
+     */
+    public function discover($uri)
+    {
+        $parts = explode('@', parse_url($uri, \PHP_URL_PATH), 2);
+
+        if (!Discovery::isAcct($uri) || \count($parts) != 2) {
+            throw new Exception('Bad resource URI: ' . $uri);
+        }
+        [, $domain] = $parts;
+        if (!filter_var($domain, \FILTER_VALIDATE_IP)
+            && !filter_var(gethostbyname($domain), \FILTER_VALIDATE_IP)) {
+            throw new Exception('Bad resource host.');
+        }
+
+        $link = new XML_XRD_Element_Link(
+            Discovery::LRDD_REL,
+            'https://' . $domain . '/.well-known/webfinger?resource={uri}',
+            Discovery::JRD_MIMETYPE,
+            true, // isTemplate
+        );
+
+        return [$link];
+    }
+}

components/FreeNetwork/Util/WebfingerResource.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util;
+
+use App\Core\Entity;
+use App\Util\Common;
+use App\Util\Exception\ServerException;
+use XML_XRD;
+
+/**
+ * WebFinger resource parent class
+ *
+ * @package   GNUsocial
+ *
+ * @author    Mikael Nordfeldth
+ * @copyright 2013 Free Software Foundation, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ *
+ * @see      http://status.net/
+ */
+abstract class WebfingerResource
+{
+    protected $identities = [];
+
+    protected $object;
+    protected $type;
+
+    public function __construct(Entity $object)
+    {
+        $this->object = $object;
+    }
+
+    public function getObject()
+    {
+        if ($this->object === null) {
+            throw new ServerException('Object is not set');
+        }
+        return $this->object;
+    }
+
+    /**
+     * List of alternative IDs of a certain Actor
+     */
+    public function getAliases(): array
+    {
+        $aliases = $this->object->getAliasesWithIDs();
+
+        // Some sites have changed from http to https and still want
+        // (because remote sites look for it) verify that they are still
+        // the same identity as they were on HTTP. Should NOT be used if
+        // you've run HTTPS all the time!
+        if (Common::config('fix', 'legacy_http')) {
+            foreach ($aliases as $alias => $id) {
+                if (!mb_strtolower(parse_url($alias, \PHP_URL_SCHEME)) === 'https') {
+                    continue;
+                }
+                $aliases[preg_replace('/^https:/i', 'http:', $alias, 1)] = $id;
+            }
+        }
+
+        // return a unique set of aliases by extracting only the keys
+        return array_keys($aliases);
+    }
+
+    abstract public function updateXRD(XML_XRD $xrd);
+}

components/FreeNetwork/Util/WebfingerResource/WebfingerResourceActor.php

@@ -0,0 +1,119 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util\WebfingerResource;
+
+use App\Core\Event;
+use App\Core\Log;
+use App\Core\Router;
+use App\Entity\Actor;
+use App\Util\Common;
+use Component\FreeNetwork\Exception\WebfingerReconstructionException;
+use Component\FreeNetwork\Util\WebfingerResource;
+use XML_XRD;
+use XML_XRD_Element_Link;
+
+/**
+ * WebFinger resource for Profile objects
+ *
+ * @package   GNUsocial
+ *
+ * @author    Mikael Nordfeldth
+ * @author    Diogo Peralta Cordeiro
+ * @copyright 2013, 2021 Free Software Foundation, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ */
+class WebfingerResourceActor extends WebFingerResource
+{
+    public const PROFILEPAGE = 'http://webfinger.net/rel/profile-page';
+
+    public function __construct(?Actor $object = null)
+    {
+        // The type argument above verifies that it's our class
+        parent::__construct($object);
+    }
+
+    public function getAliases(): array
+    {
+        $aliases = [];
+
+        try {
+            // Try to create an acct: URI if we're dealing with a profile
+            $aliases[] = $this->reconstructAcct();
+        } catch (WebFingerReconstructionException $e) {
+            Log::debug("WebFinger reconstruction for Profile failed (id={$this->object->getID()})");
+        }
+
+        return array_merge($aliases, parent::getAliases());
+    }
+
+    /**
+     * Reconstruct WebFinger acct: from object
+     *
+     * @throws WebfingerReconstructionException
+     *
+     * @return null|array|false|mixed|string|string[]
+     */
+    public function reconstructAcct()
+    {
+        $acct = null;
+
+        if (Event::handle('StartWebFingerReconstruction', [$this->object, &$acct])) {
+            // TODO: getUri may not always give us the correct host on remote users?
+            $host = parse_url($this->object->getUri(Router::ABSOLUTE_URL), \PHP_URL_HOST);
+            if (empty($this->object->getNickname()) || empty($host)) {
+                throw new WebFingerReconstructionException(print_r($this->object, true));
+            }
+            $acct = mb_strtolower(sprintf('acct:%s@%s', $this->object->getNickname(), $host));
+
+            Event::handle('EndWebFingerReconstruction', [$this->object, &$acct]);
+        }
+
+        return $acct;
+    }
+
+    public function updateXRD(XML_XRD $xrd)
+    {
+        if (Event::handle('StartWebFingerProfileLinks', [$xrd, $this->object])) {
+
+            // Profile page, can give more metadata from Link header or HTML parsing
+            $xrd->links[] = new XML_XRD_Element_Link(
+                self::PROFILEPAGE,
+                $this->object->getUrl(Router::ABSOLUTE_URL),
+                'text/html',
+            );
+
+//            // XFN
+//            $xrd->links[] = new XML_XRD_Element_Link('http://gmpg.org/xfn/11',
+//                $this->object->getUrl(), 'text/html');
+//            if ($this->object->isPerson()) {
+//                // FOAF for user
+//                $xrd->links[] = new XML_XRD_Element_Link('describedby',
+//                    common_local_url('foaf',
+//                        ['nickname' => $this->object->getNickname()]),
+//                    'application/rdf+xml');
+//
+//                // nickname discovery for apps etc.
+//                $link = new XML_XRD_Element_Link('http://apinamespace.org/atom',
+//                    common_local_url('ApiAtomService',
+//                        ['id' => $this->object->getNickname()]),
+//                    'application/atomsvc+xml');
+//                // XML_XRD must implement changing properties first           $link['http://apinamespace.org/atom/username'] = $this->object->getNickname();
+//                $xrd->links[] = clone $link;
+//
+//                $link = new XML_XRD_Element_Link('http://apinamespace.org/twitter', $apiRoot);
+//                // XML_XRD must implement changing properties first            $link['http://apinamespace.org/twitter/username'] = $this->object->getNickname();
+//                $xrd->links[] = clone $link;
+//            } elseif ($this->object->isGroup()) {
+//                // FOAF for group
+//                $xrd->links[] = new XML_XRD_Element_Link('describedby',
+//                    common_local_url('foafgroup',
+//                        ['nickname' => $this->object->getNickname()]),
+//                    'application/rdf+xml');
+//            }
+
+            Event::handle('EndWebFingerProfileLinks', [$xrd, $this->object]);
+        }
+    }
+}

components/FreeNetwork/Util/WebfingerResource/WebfingerResourceNote.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util\WebfingerResource;
+
+use App\Core\Event;
+use App\Entity\Note;
+use Component\FreeNetwork\Util\WebfingerResource;
+use PharIo\Manifest\InvalidUrlException;
+use XML_XRD;
+use XML_XRD_Element_Link;
+
+/**
+ * WebFinger resource for Note objects
+ *
+ * @package   GNUsocial
+ *
+ * @author    Mikael Nordfeldth
+ * @copyright 2013 Free Software Foundation, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ *
+ * @see      http://status.net/
+ */
+class WebfingerResourceNote extends WebfingerResource
+{
+    public function __construct(?Note $object = null)
+    {
+        // The type argument above verifies that it's our class
+        parent::__construct($object);
+    }
+
+    /**
+     * Update given XRD with self's data
+     */
+    public function updateXRD(XML_XRD $xrd)
+    {
+        if (Event::handle('StartWebFingerNoticeLinks', [$xrd, $this->object])) {
+            if ($this->object->isLocal()) {
+                $xrd->links[] = new XML_XRD_Element_Link(
+                    'alternate',
+                    common_local_url(
+                        'ApiStatusesShow',
+                        ['id'        => $this->object->id,
+                            'format' => 'atom', ],
+                    ),
+                    'application/atom+xml',
+                );
+
+                $xrd->links[] = new XML_XRD_Element_Link(
+                    'alternate',
+                    common_local_url(
+                        'ApiStatusesShow',
+                        ['id'        => $this->object->id,
+                            'format' => 'json', ],
+                    ),
+                    'application/json',
+                );
+            } else {
+                try {
+                    $xrd->links[] = new XML_XRD_Element_Link(
+                        'alternate',
+                        $this->object->getUrl(),
+                        'text/html',
+                    );
+                } catch (InvalidUrlException $e) {
+                    // don't do a fallback in webfinger
+                }
+            }
+            Event::handle('EndWebFingerNoticeLinks', [$xrd, $this->object]);
+        }
+    }
+}

components/FreeNetwork/Util/XrdController.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Component\FreeNetwork\Util;
+
+use App\Core\Controller;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use XML_XRD;
+
+abstract class XrdController extends Controller
+{
+    protected string $default_mimetype = Discovery::JRD_MIMETYPE;
+
+    protected XML_XRD $xrd;
+
+    /*
+     * Configures $this->xrd which will later be printed. Must be
+     * implemented by child classes.
+     */
+    abstract protected function setXRD();
+
+    public function __construct(RequestStack $requestStack)
+    {
+        parent::__construct($requestStack);
+
+        if ($this->request->headers->get('format', null) === null) {
+            $this->request->headers->set('format', $this->default_mimetype);
+        }
+
+        $this->xrd = new XML_XRD();
+    }
+
+    public function handle(Request $request): array
+    {
+        $this->setXRD();
+        return ['xrd' => $this->xrd, 'default_mimetype' => $this->default_mimetype];
+    }
+}

components/FreeNetwork/composer.json

@@ -0,0 +1,5 @@
+{
+  "require": {
+    "pear/xml_xrd": "^0.3.1"
+  }
+}

components/FreeNetwork/translations/LRDD.pot

@@ -0,0 +1,23 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2021-07-18 12:38+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#. TRANS: Plugin description.
+#: LRDDPlugin.php:64
+msgid "Implements LRDD support for GNU Social."
+msgstr ""

components/FreeNetwork/translations/WebFinger.pot

@@ -0,0 +1,28 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2021-07-18 12:38+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#. TRANS: Error message when an object URI which we cannot find was requested
+#: actions/webfinger.php:49
+msgid "Resource not found in local database."
+msgstr ""
+
+#. TRANS: Plugin description.
+#: WebFingerPlugin.php:230
+msgid "Adds WebFinger lookup to GNU Social"
+msgstr ""

components/FreeNetwork/translations/af/LC_MESSAGES/LRDD.po

@@ -0,0 +1,23 @@
+# Translation file for GNU social - the free software social networking platform
+# Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
+# This file is under https://www.gnu.org/licenses/agpl v3 or later
+# 
+# Translators:
+msgid ""
+msgstr ""
+"Project-Id-Version: GNU social\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-02-02 17:47+0100\n"
+"PO-Revision-Date: 2015-02-07 08:45+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Afrikaans (http://www.transifex.com/gnu-social/gnu-social/language/af/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: af\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. TRANS: Plugin description.
+#: LRDDPlugin.php:61
+msgid "Implements LRDD support for GNU Social."
+msgstr ""

components/FreeNetwork/translations/af/LC_MESSAGES/WebFinger.po

@@ -0,0 +1,28 @@
+# Translation file for GNU social - the free software social networking platform
+# Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
+# This file is under https://www.gnu.org/licenses/agpl v3 or later
+# 
+# Translators:
+msgid ""
+msgstr ""
+"Project-Id-Version: GNU social\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-02-02 17:47+0100\n"
+"PO-Revision-Date: 2015-02-07 12:23+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Afrikaans (http://www.transifex.com/gnu-social/gnu-social/language/af/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: af\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. TRANS: Error message when an object URI which we cannot find was requested
+#: actions/webfinger.php:49
+msgid "Resource not found in local database."
+msgstr ""
+
+#. TRANS: Plugin description.
+#: WebFingerPlugin.php:147
+msgid "Adds WebFinger lookup to GNU Social"
+msgstr ""

components/FreeNetwork/translations/ar/LC_MESSAGES/LRDD.po

@@ -0,0 +1,23 @@
+# Translation file for GNU social - the free software social networking platform
+# Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
+# This file is under https://www.gnu.org/licenses/agpl v3 or later
+# 
+# Translators:
+msgid ""
+msgstr ""
+"Project-Id-Version: GNU social\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-02-02 17:47+0100\n"
+"PO-Revision-Date: 2015-02-07 08:45+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Arabic (http://www.transifex.com/gnu-social/gnu-social/language/ar/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ar\n"
+"Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"
+
+#. TRANS: Plugin description.
+#: LRDDPlugin.php:61
+msgid "Implements LRDD support for GNU Social."
+msgstr ""

components/FreeNetwork/translations/ar/LC_MESSAGES/WebFinger.po

@@ -0,0 +1,28 @@
+# Translation file for GNU social - the free software social networking platform
+# Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
+# This file is under https://www.gnu.org/licenses/agpl v3 or later
+# 
+# Translators:
+msgid ""
+msgstr ""
+"Project-Id-Version: GNU social\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-02-02 17:47+0100\n"
+"PO-Revision-Date: 2015-02-07 12:23+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Arabic (http://www.transifex.com/gnu-social/gnu-social/language/ar/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ar\n"
+"Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"
+
+#. TRANS: Error message when an object URI which we cannot find was requested
+#: actions/webfinger.php:49
+msgid "Resource not found in local database."
+msgstr ""
+
+#. TRANS: Plugin description.
+#: WebFingerPlugin.php:147
+msgid "Adds WebFinger lookup to GNU Social"
+msgstr ""

components/FreeNetwork/translations/arz/LC_MESSAGES/LRDD.po

@@ -0,0 +1,23 @@
+# Translation file for GNU social - the free software social networking platform
+# Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
+# This file is under https://www.gnu.org/licenses/agpl v3 or later
+# 
+# Translators:
+msgid ""
+msgstr ""
+"Project-Id-Version: GNU social\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-02-02 17:47+0100\n"
+"PO-Revision-Date: 2015-02-07 08:45+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Arabic (Egypt) (http://www.transifex.com/gnu-social/gnu-social/language/ar_EG/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ar_EG\n"
+"Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"
+
+#. TRANS: Plugin description.
+#: LRDDPlugin.php:61
+msgid "Implements LRDD support for GNU Social."
+msgstr ""

components/FreeNetwork/translations/arz/LC_MESSAGES/WebFinger.po

@@ -0,0 +1,28 @@
+# Translation file for GNU social - the free software social networking platform
+# Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
+# This file is under https://www.gnu.org/licenses/agpl v3 or later
+# 
+# Translators:
+msgid ""
+msgstr ""
+"Project-Id-Version: GNU social\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-02-02 17:47+0100\n"
+"PO-Revision-Date: 2015-02-07 12:23+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Arabic (Egypt) (http://www.transifex.com/gnu-social/gnu-social/language/ar_EG/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ar_EG\n"
+"Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;\n"
+
+#. TRANS: Error message when an object URI which we cannot find was requested
+#: actions/webfinger.php:49
+msgid "Resource not found in local database."
+msgstr ""
+
+#. TRANS: Plugin description.
+#: WebFingerPlugin.php:147
+msgid "Adds WebFinger lookup to GNU Social"
+msgstr ""

components/FreeNetwork/translations/ast/LC_MESSAGES/LRDD.po

@@ -0,0 +1,23 @@
+# Translation file for GNU social - the free software social networking platform
+# Copyright (C) 2015 - 2019 Free Software Foundation, Inc http://www.fsf.org
+# This file is under https://www.gnu.org/licenses/agpl v3 or later
+# 
+# Translators:
+msgid ""
+msgstr ""
+"Project-Id-Version: GNU social\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2015-02-02 17:47+0100\n"
+"PO-Revision-Date: 2015-02-07 08:45+0000\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Asturian (http://www.transifex.com/gnu-social/gnu-social/language/ast/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ast\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. TRANS: Plugin description.
+#: LRDDPlugin.php:61
+msgid "Implements LRDD support for GNU Social."
+msgstr ""