Merge pull request #10634 from firefly-iii/release-1753068994

🤖 Automatically merge the PR into the develop branch.

.ci/.env.ci

@@ -60,7 +60,7 @@ APP_LOG_LEVEL=info
 # Use "pgsql" for PostgreSQL
 # Use "mysql" for MySQL and MariaDB.
 # Use "sqlite" for SQLite.
-DB_CONNECTION=sqlite_test
+DB_CONNECTION=sqlite
 
 # MySQL supports SSL. You can configure it here.
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
@@ -127,7 +127,6 @@ MAIL_ENCRYPTION=null
 MAILGUN_DOMAIN=
 MAILGUN_SECRET=
 
-
 # If you are on EU region in mailgun, use api.eu.mailgun.net, otherwise use api.mailgun.net
 # If you use Docker or similar, you can set this variable from a file by appending it with _FILE
 MAILGUN_ENDPOINT=api.mailgun.net
@@ -136,7 +135,6 @@ MAILGUN_ENDPOINT=api.mailgun.net
 MANDRILL_SECRET=
 SPARKPOST_SECRET=
 
-
 # Firefly III can send you the following messages
 SEND_REGISTRATION_MAIL=true
 SEND_ERROR_MESSAGE=true
@@ -223,7 +221,6 @@ ADLDAP_ADMIN_PASSWORD=
 ADLDAP_ACCOUNT_PREFIX=
 ADLDAP_ACCOUNT_SUFFIX=
 
-
 # LDAP authentication settings.
 ADLDAP_PASSWORD_SYNC=false
 ADLDAP_LOGIN_FALLBACK=false
@@ -304,7 +301,6 @@ PUSHER_ID=
 DEMO_USERNAME=
 DEMO_PASSWORD=
 USE_ENCRYPTION=false
-IS_HEROKU=false
 FIREFLY_III_LAYOUT=v1
 
 #

.ci/all.sh

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 
 #
-# phpunit.sh
-# Copyright (c) 2021 james@firefly-iii.org
+# all.sh
+# Copyright (c) 2024 james@firefly-iii.org
 #
 # This file is part of Firefly III (https://github.com/firefly-iii).
 #
@@ -20,14 +20,11 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-# enable test .env file.
-cp .ci/.env.ci ../.env
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 
-# download test database
-# TODO no longer exists
-wget --quiet https://raw.githubusercontent.com/firefly-iii/test-data/main/test_db.sqlite -o storage/database/test_db.sqlite
-
-# run phpunit
-./vendor/bin/phpunit --configuration phpunit.coverage.xml
-
-exit 0
+echo "Running PHP CS Fixer"
+$SCRIPT_DIR/phpcs.sh
+echo "Running PHPStan"
+$SCRIPT_DIR/phpstan.sh
+echo "Running PHPMD"
+$SCRIPT_DIR/phpmd.sh

.ci/firefly-iii-standard.yml

@@ -1,250 +1,250 @@
 parameters:
-    indentation: spaces
+  indentation: spaces
 
-    file_extensions:
-        - php
+  file_extensions:
+    - php
 
-    exclude_files:
-        - fixtures/*
-        - fixtures*/*
-        - temp/*
-        - tmp/*
+  exclude_files:
+    - fixtures/*
+    - fixtures*/*
+    - temp/*
+    - tmp/*
 
 services:
-    # Checkers bellow aim on 1:1 copy of https://nette.org/en/coding-standard
+  # Checkers bellow aim on 1:1 copy of https://nette.org/en/coding-standard
 
-    # General rules - https://nette.org/en/coding-standard#toc-general-rules
+  # General rules - https://nette.org/en/coding-standard#toc-general-rules
 
-    # use tabs over spaces
-    # PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\DisallowSpaceIndentSniff: ~
-    # PHP code must use only UTF-8 without BOM
-    PhpCsFixer\Fixer\Basic\EncodingFixer: ~
-    # <?php opening tag
-    PhpCsFixer\Fixer\PhpTag\FullOpeningTagFixer: ~
-    # Ensure there is no code on the same line as the PHP open tag.
-    PhpCsFixer\Fixer\PhpTag\LinebreakAfterOpeningTagFixer: ~
-    # The closing ?> tag must be omitted from files containing only PHP.
-    PhpCsFixer\Fixer\PhpTag\NoClosingTagFixer: ~
-    # There must not be trailing whitespace at the end of lines.
-    PhpCsFixer\Fixer\Whitespace\NoTrailingWhitespaceFixer: ~
-    # ...and at the end of blank lines.
-    PhpCsFixer\Fixer\Whitespace\NoWhitespaceInBlankLineFixer: ~
-    # All files must end with a single blank line.
-    PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer: ~
-    # File name should match class name if possible.
-    PhpCsFixer\Fixer\Basic\Psr4Fixer: ~
-    # Enforces using shorthand scalar typehint variants in phpDocs: `int` instead of `integer` and `bool` instead of `boolean`
-    SlevomatCodingStandard\Sniffs\TypeHints\LongTypeHintsSniff: ~
+  # use tabs over spaces
+  # PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\DisallowSpaceIndentSniff: ~
+  # PHP code must use only UTF-8 without BOM
+  PhpCsFixer\Fixer\Basic\EncodingFixer: ~
+  # <?php opening tag
+  PhpCsFixer\Fixer\PhpTag\FullOpeningTagFixer: ~
+  # Ensure there is no code on the same line as the PHP open tag.
+  PhpCsFixer\Fixer\PhpTag\LinebreakAfterOpeningTagFixer: ~
+  # The closing ?> tag must be omitted from files containing only PHP.
+  PhpCsFixer\Fixer\PhpTag\NoClosingTagFixer: ~
+  # There must not be trailing whitespace at the end of lines.
+  PhpCsFixer\Fixer\Whitespace\NoTrailingWhitespaceFixer: ~
+  # ...and at the end of blank lines.
+  PhpCsFixer\Fixer\Whitespace\NoWhitespaceInBlankLineFixer: ~
+  # All files must end with a single blank line.
+  PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer: ~
+  # File name should match class name if possible.
+  PhpCsFixer\Fixer\Basic\Psr4Fixer: ~
+  # Enforces using shorthand scalar typehint variants in phpDocs: `int` instead of `integer` and `bool` instead of `boolean`
+  SlevomatCodingStandard\Sniffs\TypeHints\LongTypeHintsSniff: ~
 
-    # File Header - https://nette.org/en/coding-standard#toc-file-header
+  # File Header - https://nette.org/en/coding-standard#toc-file-header
 
-    # empty line before namespace
-    PhpCsFixer\Fixer\NamespaceNotation\SingleBlankLineBeforeNamespaceFixer: ~
-    # 1 Use statement per line
-    PhpCsFixer\Fixer\Import\SingleImportPerStatementFixer: ~
-    # Use statements are alphabetically ordered
-    PhpCsFixer\Fixer\Import\OrderedImportsFixer: ~
-    # disallow group use declarations use FooLibrary\Bar\Baz\{ ClassA, ClassB, ClassC, ClassD as Fizbo }
-    SlevomatCodingStandard\Sniffs\Namespaces\DisallowGroupUseSniff: ~
-    # Disallows leading backslash in use statement: use \Foo\Bar;
-    SlevomatCodingStandard\Sniffs\Namespaces\UseDoesNotStartWithBackslashSniff: ~
-    # Looks for unused imports from other namespaces.
-    Nette\CodingStandard\Sniffs\Namespaces\UnusedUsesSniff:
-        searchAnnotations: yes
-        ignoredAnnotationNames: ['@testCase']
-        ignoredAnnotations: ['@internal']
+  # empty line before namespace
+  PhpCsFixer\Fixer\NamespaceNotation\SingleBlankLineBeforeNamespaceFixer: ~
+  # 1 Use statement per line
+  PhpCsFixer\Fixer\Import\SingleImportPerStatementFixer: ~
+  # Use statements are alphabetically ordered
+  PhpCsFixer\Fixer\Import\OrderedImportsFixer: ~
+  # disallow group use declarations use FooLibrary\Bar\Baz\{ ClassA, ClassB, ClassC, ClassD as Fizbo }
+  SlevomatCodingStandard\Sniffs\Namespaces\DisallowGroupUseSniff: ~
+  # Disallows leading backslash in use statement: use \Foo\Bar;
+  SlevomatCodingStandard\Sniffs\Namespaces\UseDoesNotStartWithBackslashSniff: ~
+  # Looks for unused imports from other namespaces.
+  Nette\CodingStandard\Sniffs\Namespaces\UnusedUsesSniff:
+    searchAnnotations: yes
+    ignoredAnnotationNames: [ '@testCase' ]
+    ignoredAnnotations: [ '@internal' ]
 
-    # Language Construct (should be placed before some other fixers)
+  # Language Construct (should be placed before some other fixers)
 
-    # Functions should be used with `$strict` param set to `true`
-    PhpCsFixer\Fixer\Strict\StrictParamFixer: ~
-    # replaces is_null(parameter) expression with `null === parameter`.
-    PhpCsFixer\Fixer\LanguageConstruct\IsNullFixer:
-        use_yoda_style: true
-    # Calling `unset` on multiple items should be done in one call.
-    PhpCsFixer\Fixer\LanguageConstruct\CombineConsecutiveUnsetsFixer: ~
-    # Replace all `<>` with `!=`.
-    PhpCsFixer\Fixer\Operator\StandardizeNotEqualsFixer: ~
-    # Include/Require and file path should be divided with a single space. File path should not be placed under brackets.
-    PhpCsFixer\Fixer\ControlStructure\IncludeFixer: ~
-    # Requires short ternary operator ?: when possible
-    SlevomatCodingStandard\Sniffs\ControlStructures\RequireShortTernaryOperatorSniff: ~
+  # Functions should be used with `$strict` param set to `true`
+  PhpCsFixer\Fixer\Strict\StrictParamFixer: ~
+  # replaces is_null(parameter) expression with `null === parameter`.
+  PhpCsFixer\Fixer\LanguageConstruct\IsNullFixer:
+    use_yoda_style: true
+  # Calling `unset` on multiple items should be done in one call.
+  PhpCsFixer\Fixer\LanguageConstruct\CombineConsecutiveUnsetsFixer: ~
+  # Replace all `<>` with `!=`.
+  PhpCsFixer\Fixer\Operator\StandardizeNotEqualsFixer: ~
+  # Include/Require and file path should be divided with a single space. File path should not be placed under brackets.
+  PhpCsFixer\Fixer\ControlStructure\IncludeFixer: ~
+  # Requires short ternary operator ?: when possible
+  SlevomatCodingStandard\Sniffs\ControlStructures\RequireShortTernaryOperatorSniff: ~
 
-    # Arrays - https://nette.org/en/coding-standard#toc-arrays
+  # Arrays - https://nette.org/en/coding-standard#toc-arrays
 
-    # use short array fixes
-    PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer:
-        syntax: short
-    # use trailing command in last array element
-    PhpCsFixer\Fixer\ArrayNotation\TrailingCommaInMultilineArrayFixer: ~
-    # PHP single-line arrays should not have trailing comma.
-    # PhpCsFixer\Fixer\ArrayNotation\NoTrailingCommaInSinglelineArrayFixer: ~
-    # In array declaration, there MUST NOT be a whitespace before each comma.
-    PhpCsFixer\Fixer\ArrayNotation\NoWhitespaceBeforeCommaInArrayFixer: ~
-    # Arrays should be formatted like function/method arguments, without leading or trailing single line space.
-    PhpCsFixer\Fixer\ArrayNotation\TrimArraySpacesFixer: ~
-    # In array declaration, there MUST be a whitespace after each comma.
-    PhpCsFixer\Fixer\ArrayNotation\WhitespaceAfterCommaInArrayFixer: ~
+  # use short array fixes
+  PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer:
+    syntax: short
+  # use trailing command in last array element
+  PhpCsFixer\Fixer\ArrayNotation\TrailingCommaInMultilineArrayFixer: ~
+  # PHP single-line arrays should not have trailing comma.
+  # PhpCsFixer\Fixer\ArrayNotation\NoTrailingCommaInSinglelineArrayFixer: ~
+  # In array declaration, there MUST NOT be a whitespace before each comma.
+  PhpCsFixer\Fixer\ArrayNotation\NoWhitespaceBeforeCommaInArrayFixer: ~
+  # Arrays should be formatted like function/method arguments, without leading or trailing single line space.
+  PhpCsFixer\Fixer\ArrayNotation\TrimArraySpacesFixer: ~
+  # In array declaration, there MUST be a whitespace after each comma.
+  PhpCsFixer\Fixer\ArrayNotation\WhitespaceAfterCommaInArrayFixer: ~
 
-    # Strings
+  # Strings
 
-    # Convert `heredoc` to `nowdoc` where possible.
-    PhpCsFixer\Fixer\StringNotation\HeredocToNowdocFixer: ~
-    # Convert double quotes to single quotes for simple strings.
-    PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer: ~
+  # Convert `heredoc` to `nowdoc` where possible.
+  PhpCsFixer\Fixer\StringNotation\HeredocToNowdocFixer: ~
+  # Convert double quotes to single quotes for simple strings.
+  PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer: ~
 
-    # Keywords and True/False/Null - https://nette.org/en/coding-standard#toc-keywords-and-true-false-null
+  # Keywords and True/False/Null - https://nette.org/en/coding-standard#toc-keywords-and-true-false-null
 
-    # PHP keywords must be in lower case
-    PhpCsFixer\Fixer\Casing\LowercaseKeywordsFixer: ~
-    # The PHP constants `true`, `false`, and `null` MUST be in lower case
-    PhpCsFixer\Fixer\Casing\LowercaseConstantsFixer: ~
+  # PHP keywords must be in lower case
+  PhpCsFixer\Fixer\Casing\LowercaseKeywordsFixer: ~
+  # The PHP constants `true`, `false`, and `null` MUST be in lower case
+  PhpCsFixer\Fixer\Casing\LowercaseConstantsFixer: ~
 
-    # Method and Functions Calls - https://nette.org/en/coding-standard#toc-method-and-function-calls
+  # Method and Functions Calls - https://nette.org/en/coding-standard#toc-method-and-function-calls
 
-    # Function defined by PHP should be called using the correct casing
-    PhpCsFixer\Fixer\Casing\NativeFunctionCasingFixer: ~
-    # In the argument list, there must be one space after each comma, and there must no be a space before each comma
-    PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer: ~
-    # This sniff checks that there are two blank lines between functions declarations and single between signatures.
-    #Nette\CodingStandard\Sniffs\WhiteSpace\FunctionSpacingSniff: ~
+  # Function defined by PHP should be called using the correct casing
+  PhpCsFixer\Fixer\Casing\NativeFunctionCasingFixer: ~
+  # In the argument list, there must be one space after each comma, and there must no be a space before each comma
+  PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer: ~
+  # This sniff checks that there are two blank lines between functions declarations and single between signatures.
+  #Nette\CodingStandard\Sniffs\WhiteSpace\FunctionSpacingSniff: ~
 
-    # Classes - https://nette.org/en/coding-standard#toc-classes
+  # Classes - https://nette.org/en/coding-standard#toc-classes
 
-    # Inside a classy element "self" should be preferred to the class name itself.
-    PhpCsFixer\Fixer\ClassNotation\SelfAccessorFixer: ~
-    # class element order: constants, properties, from public to private
-    PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer:
-        order:
-            - use_trait
-            - constant
-            - constant_public
-            - constant_protected
-            - constant_private
-            - property_public
-            - property_protected
-            - property_private
+  # Inside a classy element "self" should be preferred to the class name itself.
+  PhpCsFixer\Fixer\ClassNotation\SelfAccessorFixer: ~
+  # class element order: constants, properties, from public to private
+  PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer:
+    order:
+      - use_trait
+      - constant
+      - constant_public
+      - constant_protected
+      - constant_private
+      - property_public
+      - property_protected
+      - property_private
 
-    # Constants - https://nette.org/en/coding-standard#toc-constants
+  # Constants - https://nette.org/en/coding-standard#toc-constants
 
-    # constant names are CAPITALIZED (manuall fixing only :()
-    PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\UpperCaseConstantNameSniff: ~
+  # constant names are CAPITALIZED (manuall fixing only :()
+  PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\UpperCaseConstantNameSniff: ~
 
-    # Class Properties - https://nette.org/en/coding-standard#toc-class-properties
+  # Class Properties - https://nette.org/en/coding-standard#toc-class-properties
 
-    # There MUST NOT be more than one property declared per statement.
-    PhpCsFixer\Fixer\ClassNotation\SingleClassElementPerStatementFixer:
-        elements: ['property']
+  # There MUST NOT be more than one property declared per statement.
+  PhpCsFixer\Fixer\ClassNotation\SingleClassElementPerStatementFixer:
+    elements: [ 'property' ]
 
-    # Methods - https://nette.org/en/coding-standard#toc-methods
+  # Methods - https://nette.org/en/coding-standard#toc-methods
 
-    # They must be declared in camelCase.
-    PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff: ~
-    # Checks that there's a single space between a typehint and a parameter name and no whitespace between a nullability symbol and a typehint
-    SlevomatCodingStandard\Sniffs\TypeHints\ParameterTypeHintSpacingSniff: ~
-    # Spaces should be properly placed in a function declaration.
-    PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer: ~
-    # In function arguments there must not be arguments with default values before non-default ones.
-    PhpCsFixer\Fixer\FunctionNotation\NoUnreachableDefaultArgumentValueFixer: ~
+  # They must be declared in camelCase.
+  PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff: ~
+  # Checks that there's a single space between a typehint and a parameter name and no whitespace between a nullability symbol and a typehint
+  SlevomatCodingStandard\Sniffs\TypeHints\ParameterTypeHintSpacingSniff: ~
+  # Spaces should be properly placed in a function declaration.
+  PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer: ~
+  # In function arguments there must not be arguments with default values before non-default ones.
+  PhpCsFixer\Fixer\FunctionNotation\NoUnreachableDefaultArgumentValueFixer: ~
 
-    # Constans, Class Properties, Methods
+  # Constans, Class Properties, Methods
 
-    # Constants and Properties should be separated by 1 blank line
-    #PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer:
-    #    elements: [const, property]
+  # Constants and Properties should be separated by 1 blank line
+  #PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer:
+  #    elements: [const, property]
 
-    # Last property and 1st method should be separated by 2 spaces
-    Nette\CodingStandard\Fixer\ClassNotation\LastPropertyAndFirstMethodSeparationFixer:
-        space_count: 2
+  # Last property and 1st method should be separated by 2 spaces
+  Nette\CodingStandard\Fixer\ClassNotation\LastPropertyAndFirstMethodSeparationFixer:
+    space_count: 2
 
-    # Control Statements - https://nette.org/en/coding-standard#toc-control-statements
+  # Control Statements - https://nette.org/en/coding-standard#toc-control-statements
 
-    # The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words.
-    PhpCsFixer\Fixer\ControlStructure\ElseifFixer: ~
-    # Remove useless semicolon statements.
-    PhpCsFixer\Fixer\Semicolon\NoEmptyStatementFixer: ~
-    # Remove trailing commas in list() calls.
-    PhpCsFixer\Fixer\ControlStructure\NoTrailingCommaInListCallFixer: ~
-    # Removes unneeded parentheses around control statements.
-    PhpCsFixer\Fixer\ControlStructure\NoUnneededControlParenthesesFixer: ~
-    # A case should be followed by a colon and not a semicolon.
-    PhpCsFixer\Fixer\ControlStructure\SwitchCaseSemicolonToColonFixer: ~
-    # The structure body must be indented once.
-    # The closing brace must be on the next line after the body.
-    # There should not be more than one statement per line.
-    #Nette\CodingStandard\Fixer\Basic\BracesFixer:
-    #    allow_single_line_closure: true
-    # changes if (1 === $cond) to if ($cond === 1)
-    #SlevomatCodingStandard\Sniffs\ControlStructures\DisallowYodaComparisonSniff: ~
-    # finds unreachable catch blocks:
-    SlevomatCodingStandard\Sniffs\Exceptions\DeadCatchSniff: ~
+  # The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words.
+  PhpCsFixer\Fixer\ControlStructure\ElseifFixer: ~
+  # Remove useless semicolon statements.
+  PhpCsFixer\Fixer\Semicolon\NoEmptyStatementFixer: ~
+  # Remove trailing commas in list() calls.
+  PhpCsFixer\Fixer\ControlStructure\NoTrailingCommaInListCallFixer: ~
+  # Removes unneeded parentheses around control statements.
+  PhpCsFixer\Fixer\ControlStructure\NoUnneededControlParenthesesFixer: ~
+  # A case should be followed by a colon and not a semicolon.
+  PhpCsFixer\Fixer\ControlStructure\SwitchCaseSemicolonToColonFixer: ~
+  # The structure body must be indented once.
+  # The closing brace must be on the next line after the body.
+  # There should not be more than one statement per line.
+  #Nette\CodingStandard\Fixer\Basic\BracesFixer:
+  #    allow_single_line_closure: true
+  # changes if (1 === $cond) to if ($cond === 1)
+  #SlevomatCodingStandard\Sniffs\ControlStructures\DisallowYodaComparisonSniff: ~
+  # finds unreachable catch blocks:
+  SlevomatCodingStandard\Sniffs\Exceptions\DeadCatchSniff: ~
 
-    # Casting
+  # Casting
 
-    # A single space or none should be between cast and variable (int) $val
-    PhpCsFixer\Fixer\CastNotation\CastSpacesFixer: ~
-    # Cast should be written in lower case.
-    PhpCsFixer\Fixer\CastNotation\LowercaseCastFixer: ~
-    # Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator
-    PhpCsFixer\Fixer\CastNotation\ModernizeTypesCastingFixer: ~
-    # Short cast `bool` using double exclamation mark should not be used
-    PhpCsFixer\Fixer\CastNotation\NoShortBoolCastFixer: ~
-    # Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`
-    PhpCsFixer\Fixer\CastNotation\ShortScalarCastFixer: ~
+  # A single space or none should be between cast and variable (int) $val
+  PhpCsFixer\Fixer\CastNotation\CastSpacesFixer: ~
+  # Cast should be written in lower case.
+  PhpCsFixer\Fixer\CastNotation\LowercaseCastFixer: ~
+  # Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator
+  PhpCsFixer\Fixer\CastNotation\ModernizeTypesCastingFixer: ~
+  # Short cast `bool` using double exclamation mark should not be used
+  PhpCsFixer\Fixer\CastNotation\NoShortBoolCastFixer: ~
+  # Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`
+  PhpCsFixer\Fixer\CastNotation\ShortScalarCastFixer: ~
 
-    # Language Whitespace
+  # Language Whitespace
 
-    # Binary operators should be surrounded by at least one space. DO NOT USE
-    #PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer: ~
-    # Unary operators should be placed adjacent to their operands.
-    PhpCsFixer\Fixer\Operator\UnaryOperatorSpacesFixer: ~
-    # No space after the opening parenthesis and before the closing parenthesis
-    PhpCsFixer\Fixer\Whitespace\NoSpacesInsideParenthesisFixer: ~
-    # There MUST NOT be spaces around offset braces $a[0]
-    PhpCsFixer\Fixer\Whitespace\NoSpacesAroundOffsetFixer: ~
-    # There should not be space before or after object `T_OBJECT_OPERATOR` `->`.
-    PhpCsFixer\Fixer\Operator\ObjectOperatorWithoutWhitespaceFixer: ~
-    # Standardize spaces around ternary operator.
-    PhpCsFixer\Fixer\Operator\TernaryOperatorSpacesFixer: ~
-    # Concatenation $a . $b should be spaced according configuration
-    PhpCsFixer\Fixer\Operator\ConcatSpaceFixer:
-        spacing: one
-    # Removes extra spaces between colon and case value.
-    PhpCsFixer\Fixer\ControlStructure\SwitchCaseSpaceFixer: ~
+  # Binary operators should be surrounded by at least one space. DO NOT USE
+  #PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer: ~
+  # Unary operators should be placed adjacent to their operands.
+  PhpCsFixer\Fixer\Operator\UnaryOperatorSpacesFixer: ~
+  # No space after the opening parenthesis and before the closing parenthesis
+  PhpCsFixer\Fixer\Whitespace\NoSpacesInsideParenthesisFixer: ~
+  # There MUST NOT be spaces around offset braces $a[0]
+  PhpCsFixer\Fixer\Whitespace\NoSpacesAroundOffsetFixer: ~
+  # There should not be space before or after object `T_OBJECT_OPERATOR` `->`.
+  PhpCsFixer\Fixer\Operator\ObjectOperatorWithoutWhitespaceFixer: ~
+  # Standardize spaces around ternary operator.
+  PhpCsFixer\Fixer\Operator\TernaryOperatorSpacesFixer: ~
+  # Concatenation $a . $b should be spaced according configuration
+  PhpCsFixer\Fixer\Operator\ConcatSpaceFixer:
+    spacing: one
+  # Removes extra spaces between colon and case value.
+  PhpCsFixer\Fixer\ControlStructure\SwitchCaseSpaceFixer: ~
 
-    # Comments
+  # Comments
 
-    # Docblocks should have the same indentation as the documented subject.
-    PhpCsFixer\Fixer\Phpdoc\PhpdocIndentFixer: ~
-    # There should not be any empty comments.
-    PhpCsFixer\Fixer\Comment\NoEmptyCommentFixer: ~
-    # There should not be empty PHPDoc blocks.
-    #PhpCsFixer\Fixer\Phpdoc\NoEmptyPhpdocFixer: ~
-    # Phpdocs should start and end with content, excluding the very first and last line of the docblocks.
-    PhpCsFixer\Fixer\Phpdoc\PhpdocTrimFixer: ~
-    # Single-line comments comments with only one line of actual content should use the `//` syntax.
-    PhpCsFixer\Fixer\Comment\SingleLineCommentStyleFixer:
-        comment_types: ['hash']
-    # Require comments with single-line content to be written as one-liners
-    SlevomatCodingStandard\Sniffs\Commenting\RequireOneLinePropertyDocCommentSniff: ~
+  # Docblocks should have the same indentation as the documented subject.
+  PhpCsFixer\Fixer\Phpdoc\PhpdocIndentFixer: ~
+  # There should not be any empty comments.
+  PhpCsFixer\Fixer\Comment\NoEmptyCommentFixer: ~
+  # There should not be empty PHPDoc blocks.
+  #PhpCsFixer\Fixer\Phpdoc\NoEmptyPhpdocFixer: ~
+  # Phpdocs should start and end with content, excluding the very first and last line of the docblocks.
+  PhpCsFixer\Fixer\Phpdoc\PhpdocTrimFixer: ~
+  # Single-line comments comments with only one line of actual content should use the `//` syntax.
+  PhpCsFixer\Fixer\Comment\SingleLineCommentStyleFixer:
+    comment_types: [ 'hash' ]
+  # Require comments with single-line content to be written as one-liners
+  SlevomatCodingStandard\Sniffs\Commenting\RequireOneLinePropertyDocCommentSniff: ~
 
 
-    # Properties MUST not be explicitly initialized with `null`.
-    #PhpCsFixer\Fixer\ClassNotation\NoNullPropertyInitializationFixer: ~
+  # Properties MUST not be explicitly initialized with `null`.
+  #PhpCsFixer\Fixer\ClassNotation\NoNullPropertyInitializationFixer: ~
 
-    PhpCsFixer\Fixer\ControlStructure\NoBreakCommentFixer:
-        comment_text: 'break omitted'
+  PhpCsFixer\Fixer\ControlStructure\NoBreakCommentFixer:
+    comment_text: 'break omitted'
 
-    # declare(strict_types=1);
-    PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer: ~
-    # Enforces consistent formatting of return typehints: function foo(): ?int
-    SlevomatCodingStandard\Sniffs\TypeHints\ReturnTypeHintSpacingSniff: ~
-    # Use `null` coalescing operator `??` where possible.
-    PhpCsFixer\Fixer\Operator\TernaryToNullCoalescingFixer: ~
+  # declare(strict_types=1);
+  PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer: ~
+  # Enforces consistent formatting of return typehints: function foo(): ?int
+  SlevomatCodingStandard\Sniffs\TypeHints\ReturnTypeHintSpacingSniff: ~
+  # Use `null` coalescing operator `??` where possible.
+  PhpCsFixer\Fixer\Operator\TernaryToNullCoalescingFixer: ~
 
-    Nette\CodingStandard\Fixer\ClassNotation\ClassAndTraitVisibilityRequiredFixer:
-        elements: ['const', 'property', 'method']
+  Nette\CodingStandard\Fixer\ClassNotation\ClassAndTraitVisibilityRequiredFixer:
+    elements: [ 'const', 'property', 'method' ]
 
-    # short list() syntax []
-    PhpCsFixer\Fixer\ListNotation\ListSyntaxFixer:
-        syntax: short
+  # short list() syntax []
+  PhpCsFixer\Fixer\ListNotation\ListSyntaxFixer:
+    syntax: short

.ci/php-cs-fixer/.gitignore

@@ -0,0 +1,2 @@
+vendor
+.php-cs-fixer.cache

.ci/php-cs-fixer/.php-cs-fixer.php

@@ -0,0 +1,84 @@
+<?php
+/*
+ * .php-cs-fixer.php
+ * Copyright (c) 2022 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+$current = __DIR__;
+
+$paths = [
+    $current . '/../../app',
+    $current . '/../../config',
+    $current . '/../../routes',
+    $current . '/../../tests',
+];
+
+$finder = PhpCsFixer\Finder::create()
+                           ->in($paths);
+
+
+$config = (new PhpCsFixer\Config())
+        // ->setUnsupportedPhpVersionAllowed(true) // use this when PHP 8.5 comes out.
+        ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+        ;
+return $config->setRules(
+
+    [
+        // rule sets
+        '@PHP83Migration'               => true,
+        '@PhpCsFixer'                   => true,
+        '@PhpCsFixer:risky'             => true,
+        '@PSR12'                        => true,
+        '@PSR12:risky'                  => true,
+        'declare_strict_types'          => true,
+        'strict_param'                  => true,
+        'no_unused_imports'             => true,
+        'single_space_around_construct' => true,
+        'statement_indentation'         => true,
+        'void_return'                   => true,
+
+        // disabled rules
+        'native_function_invocation'    => false, // annoying
+        'php_unit_data_provider_name'   => false, // bloody annoying long test names
+        'static_lambda'                 => false, // breaks the Response macro for API's.
+        'phpdoc_summary'                => false, // annoying.
+        'comment_to_phpdoc'             => false, // breaks phpstan lines in combination with PHPStorm.
+        'type_declaration_spaces'       => false,
+        'cast_spaces'                   => false,
+
+        // enabled rules
+        'global_namespace_import' => true, // matches with rector.
+
+        // complex rules
+        'phpdoc_to_comment' => ['ignored_tags' => ['var']],
+        'php_unit_test_case_static_method_calls' => [
+            'call_type' => 'this',
+        ],
+        'array_syntax'                  => ['syntax' => 'short'],
+        'binary_operator_spaces'        => [
+            'default'   => 'at_least_single_space',
+            'operators' => [
+                '=>'  => 'align_single_space_by_scope',
+                '='   => 'align_single_space_minimal_by_scope',
+                '??=' => 'align_single_space_minimal_by_scope',
+            ],
+        ],
+    ]
+
+)
+              ->setFinder($finder);

.ci/php-cs-fixer/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "friendsofphp/php-cs-fixer": "^3.12"
+    }
+}

.ci/phpcs.sh

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+#
+# phpstan.sh
+# Copyright (c) 2021 james@firefly-iii.org
+#
+# This file is part of Firefly III (https://github.com/firefly-iii).
+#
+# 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 <https://www.gnu.org/licenses/>.
+#
+
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+# clean up php code
+cd $SCRIPT_DIR/php-cs-fixer
+composer update --quiet
+rm -f .php-cs-fixer.cache
+./vendor/bin/php-cs-fixer fix \
+    --config $SCRIPT_DIR/php-cs-fixer/.php-cs-fixer.php \
+    --format=txt \
+    -v \
+    --allow-risky=yes
+
+EXIT_CODE=$?
+
+echo "Exit code for CS fixer is $EXIT_CODE."
+
+cd $SCRIPT_DIR/..
+
+exit $EXIT_CODE

.ci/phpmd.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+#
+# phpmd.sh
+# Copyright (c) 2023 james@firefly-iii.org
+#
+# This file is part of Firefly III (https://github.com/firefly-iii).
+#
+# 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 <https://www.gnu.org/licenses/>.
+#
+
+
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+OUTPUT_FORMAT=text
+
+if [[ $GITHUB_ACTIONS = "true" ]]
+then
+    OUTPUT_FORMAT=github
+fi
+
+
+cd $SCRIPT_DIR/phpmd
+composer update --quiet
+./vendor/bin/phpmd \
+  $SCRIPT_DIR/../app,$SCRIPT_DIR/../database,$SCRIPT_DIR/../routes,$SCRIPT_DIR/../config \
+   $OUTPUT_FORMAT phpmd.xml \
+  --exclude $SCRIPT_DIR/../app/resources/** \
+  --exclude $SCRIPT_DIR/../app/frontend/** \
+  --exclude $SCRIPT_DIR/../app/public/** \
+  --exclude $SCRIPT_DIR/../app/vendor/**
+
+EXIT_CODE=$?
+
+cd $SCRIPT_DIR/..
+
+echo "Exit code is $EXIT_CODE."
+
+# for the time being, exit 0
+exit $EXIT_CODE

.ci/phpmd/.gitignore

@@ -0,0 +1 @@
+vendor

.ci/phpmd/composer.json

@@ -0,0 +1,5 @@
+{
+    "require-dev": {
+        "phpmd/phpmd": "^2.13"
+    }
+}

.ci/phpmd/phpmd.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ phpmd.xml
+  ~ Copyright (c) 2023 james@firefly-iii.org
+  ~
+  ~ This file is part of Firefly III (https://github.com/firefly-iii).
+  ~
+  ~ 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 <https://www.gnu.org/licenses/>.
+  -->
+
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         name="pcsg-generated-ruleset"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <description>Firefly III ruleset.</description>
+    <!-- Import the entire controversial code rule set -->
+    <rule ref="rulesets/controversial.xml">
+        <exclude name="CamelCasePropertyName"/>
+    </rule>
+
+    <!-- clean code -->
+    <!-- <rule ref="rulesets/codesize.xml" /> -->
+    <rule ref="rulesets/unusedcode.xml"/>
+
+
+    <rule ref="rulesets/design.xml/NumberOfChildren">
+        <properties>
+            <!-- This is now at 32, which excludes the controllers but should prevent more monoliths. -->
+            <property name="minimum" value="32"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/design.xml/CouplingBetweenObjects">
+        <properties>
+            <!-- Leaving this at 28 excuses most current code but it can't get worse than that. -->
+            <property name="maximum" value="28"/>
+        </properties>
+    </rule>
+
+
+    <rule ref="rulesets/naming.xml/ShortMethodName">
+        <properties>
+            <property name="minimum" value="3"/>
+        </properties>
+    </rule>
+
+    <!-- code size -->
+    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
+        <properties>
+            <!-- Leave at 20. This means methods will be pretty complex before the system starts complaining. -->
+            <property name="reportLevel" value="20"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/NPathComplexity">
+        <properties>
+            <!-- 2000 results in some pretty complex methods, but it's OK. -->
+            <!-- They should not be much more complex than that though -->
+            <property name="minimum" value="2000"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
+        <properties>
+            <!-- 75 seems like a nice number. Shorter isn't always feasible and there are a few exceptions already -->
+            <property name="minimum" value="75"/>
+            <property name="ignore-whitespace" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
+        <properties>
+            <!-- 5 is fine. 6 is excessive, but I have just one of those. At the end of the day, I still need all params. -->
+            <property name="minimum" value="5"/>
+        </properties>
+    </rule>
+
+    <!-- include clean code manually -->
+    <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag"/>
+    <rule ref="rulesets/cleancode.xml/ElseExpression"/>
+    <rule ref="rulesets/cleancode.xml/MissingImport"/>
+    <rule ref="rulesets/cleancode.xml/UndefinedVariable"/>
+    <rule ref="rulesets/cleancode.xml/IfStatementAssignment"/>
+    <rule ref="rulesets/cleancode.xml/DuplicatedArrayKey"/>
+    <rule ref="rulesets/cleancode.xml/ErrorControlOperator"/>
+</ruleset>

.ci/phpstan.neon

@@ -1,33 +1,38 @@
-includes:
-  - ../vendor/nunomaduro/larastan/extension.neon
-  - ../vendor/ergebnis/phpstan-rules/rules.neon
-  - ../vendor/phpstan/phpstan-deprecation-rules/rules.neon
-  - ../vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
-
 parameters:
-  ignoreErrors:
-    - '#is not allowed to extend#'
-    - '#is neither abstract nor final#'
-    - '#Control structures using switch should not be used\.#'
-    - '#has a nullable return type declaration#'
-    - '#with a nullable type declaration#'
-    - '#with null as default value#'
-    - '#Constructor in [a-zA-Z0-9\\_]+ has parameter \$[a-zA-Z0-9\\_]+ with default value#'
-    -
-        message: '#Function compact\(\) should not be used.#'
-        paths:
-            - ../app/Http/Controllers
-            - ../app/Support/Http/Controllers/RenderPartialViews.php
-            - ../app/Support/Form/FormSupport.php
-            - ../app/Support/Form/CurrencyForm.php
-            - ../app/Support/Form/AccountForm.php
-            - ../app/Support/ExpandedForm.php
-            - ../app/Generator/Report
+  scanFiles:
+    - ../_ide_helper
   paths:
     - ../app
     - ../database
     - ../routes
+    - ../config
     - ../bootstrap/app.php
+  universalObjectCratesClasses:
+    - Illuminate\Database\Eloquent\Model
+  # TODO: slowly remove these parameters and fix the issues found.
+  reportUnmatchedIgnoredErrors: true
+  ignoreErrors:
+  # TODO: slowly remove these exceptions and fix the issues found.
+    - '#Dynamic call to static method#' # all the Laravel ORM things depend on this.
+    - identifier: varTag.nativeType
+    - identifier: varTag.type
+    -
+        identifier: larastan.noEnvCallsOutsideOfConfig
+        path: ../app/Console/Commands/System/CreatesDatabase.php
+    - identifier: missingType.iterableValue # not interesting enough to fix.
+    - identifier: missingType.generics # not interesting enough to fix.
+    - "#Parameter \\#[1-2] \\$num[1-2] of function bc[a-z]+ expects numeric-string, [a-z\\-|&]+ given#"
+    - '#expects view-string, string given#'
+    - '#expects view-string\|null, string given#'
+
+    # phpstan can't handle this so we ignore them.
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::before#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::after#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::withTrashed#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\HasMany::accountTypeIn#'
+    - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Relations\\BelongsTo::withTrashed#'
 
   # The level 8 is the highest level. original was 5
-  level: 3
+  # 7 is more than enough, higher just leaves NULL things.
+  level: 7
+

.ci/phpstan.sh

@@ -23,11 +23,26 @@
 # Install composer packages
 #composer install --no-scripts --no-ansi
 
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
 # enable test .env file.
-cp .ci/.env.ci .env
+# cp .ci/.env.ci .env
 
 # Do static code analysis.
-# ./vendor/bin/phpstan analyse -c .ci/phpstan.neon --no-progress
-./vendor/bin/phpstan analyse -c .ci/phpstan.neon
+if [[ $GITHUB_ACTIONS = "" ]]
+then
+    ./vendor/bin/phpstan analyse -c .ci/phpstan.neon --error-format=table > phpstan-report.txt
+    EXIT_CODE=$?
+    echo "The PHPstan report can be found in phpstan-report.txt. Exit code is $EXIT_CODE."
+fi
 
-exit 0
+if [[ $GITHUB_ACTIONS = "true" ]]
+then
+    ./vendor/bin/phpstan analyse -c .ci/phpstan.neon --no-progress --error-format=github
+    EXIT_CODE=$?
+
+    # temporary exit code 0
+    # EXIT_CODE=0
+fi
+
+exit $EXIT_CODE

.ci/rector.php

@@ -0,0 +1,82 @@
+<?php
+
+
+/*
+ * rector.php
+ * Copyright (c) 2025 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * 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 https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\EarlyReturn\Rector\If_\ChangeOrIfContinueToMultiContinueRector;
+use Rector\Php80\Rector\ClassMethod\AddParamBasedOnParentClassMethodRector;
+use Rector\Transform\Rector\String_\StringToClassConstantRector;
+use RectorLaravel\Set\LaravelLevelSetList;
+
+
+return RectorConfig::configure()
+    ->withSkip([
+        ChangeOrIfContinueToMultiContinueRector::class,
+        AddParamBasedOnParentClassMethodRector::class,
+        StringToClassConstantRector::class => [
+            __DIR__ . '/../app/Http/Controllers/Auth/LoginController.php',
+        ],
+        __DIR__.'/../bootstrap/cache/*'
+    ])
+    ->withPaths([
+        __DIR__ . '/../app',
+        __DIR__ . '/../bootstrap',
+        __DIR__ . '/../config',
+        __DIR__ . '/../public',
+        __DIR__ . '/../resources/lang/en_US',
+        __DIR__ . '/../routes',
+        __DIR__ . '/../tests',
+    ])
+    ->withSets([
+        LaravelLevelSetList::UP_TO_LARAVEL_120,
+    ])
+//    ->withConfiguredRule(ReplaceServiceContainerCallArgRector::class, [
+//        new ReplaceServiceContainerCallArg('log', new ClassConstFetch(new Name('Illuminate\Support\Facades\Log'), 'class')),
+//    ])
+    // uncomment to reach your current PHP version
+    ->withPhpSets()
+    ->withPreparedSets(
+        codingStyle: false, // leave false
+        privatization: false, // leave false.
+        naming: false, // leave false
+        instanceOf: true,
+        earlyReturn: true,
+        strictBooleans: true,
+        carbon: true,
+        rectorPreset: true,
+        phpunitCodeQuality: true,
+        doctrineCodeQuality: true,
+        symfonyCodeQuality: true,
+        symfonyConfigs: true
+
+    )
+    ->withComposerBased(
+        twig: true,
+        doctrine: true,
+        phpunit: true,
+        symfony: true)
+    ->withTypeCoverageLevel(0)
+    ->withDeadCodeLevel(0)
+    ->withCodeQualityLevel(0)
+    ->withImportNames(removeUnusedImports: true);// import statements instead of full classes.

.ci/rector.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+#
+# phpstan.sh
+# Copyright (c) 2021 james@firefly-iii.org
+#
+# This file is part of Firefly III (https://github.com/firefly-iii).
+#
+# 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 <https://www.gnu.org/licenses/>.
+#
+
+# Install composer packages
+#composer install --no-scripts --no-ansi
+
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+echo $1
+
+if [ "$1" == "--dry-run" ]; then
+    echo "Running rector in dry run."
+    $SCRIPT_DIR/../vendor/bin/rector --config $SCRIPT_DIR/rector.php --dry-run
+    exit $?
+fi
+
+$SCRIPT_DIR/../vendor/bin/rector --config $SCRIPT_DIR/rector.php

.deploy/heroku/.env.heroku

@@ -1,321 +0,0 @@
-# You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
-# Never set it to "testing".
-APP_ENV=heroku
-
-# Set to true if you want to see debug information in error screens.
-APP_DEBUG=false
-
-# This should be your email address.
-# If you use Docker or similar, you can set this variable from a file by using SITE_OWNER_FILE
-SITE_OWNER=heroku@example.com
-
-# The encryption key for your sessions. Keep this very secure.
-# If you generate a new one all existing attachments must be considered LOST.
-# Change it to a string of exactly 32 chars or use something like `php artisan key:generate` to generate it.
-# If you use Docker or similar, you can set this variable from a file by using APP_KEY_FILE
-APP_KEY=7ahyYVPVsmxjdhsweWCauGeJfwc92NP2
-
-#
-# Firefly III will launch using this language (for new users and unauthenticated visitors)
-# For a list of available languages: https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang
-#
-# If text is still in English, remember that not everything may have been translated.
-DEFAULT_LANGUAGE=en_US
-
-# The locale defines how numbers are formatted.
-# by default this value is the same as whatever the language is.
-DEFAULT_LOCALE=equal
-
-# Change this value to your preferred time zone.
-# Example: Europe/Amsterdam
-# For a list of supported time zones, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-TZ=UTC
-
-# TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
-# Set it to ** and reverse proxies work just fine.
-TRUSTED_PROXIES=**
-
-# The log channel defines where your log entries go to.
-# Several other options exist. You can use 'single' for one big fat error log (not recommended).
-# Also available are 'syslog', 'errorlog' and 'stdout' which will log to the system itself.
-# A rotating log option is 'daily', creates 5 files that (surprise) rotate.
-# Default setting 'stack' will log to 'daily' and to 'stdout' at the same time.
-
-# - Docker + versions <= 4.8.1.8 and before: use "stdout"
-# - Docker + versions >  4.8.1.8           : use "docker_out"
-# - Docker + versions >=  5.1.1            : use "stack"
-# - For everything else (als not Docker)   : use 'stack'
-
-LOG_CHANNEL=stdout
-
-# Log level. You can set this from least severe to most severe:
-# debug, info, notice, warning, error, critical, alert, emergency
-# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
-# nothing will get logged, ever.
-APP_LOG_LEVEL=notice
-
-# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
-# For other database types, please see the FAQ: https://docs.firefly-iii.org/support/faq
-# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
-# Use "pgsql" for PostgreSQL
-# Use "mysql" for MySQL and MariaDB.
-# Use "sqlite" for SQLite.
-DB_CONNECTION=pgsql
-
-
-# MySQL supports SSL. You can configure it here.
-# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
-MYSQL_USE_SSL=false
-MYSQL_SSL_VERIFY_SERVER_CERT=true
-# You need to set at least of these options
-MYSQL_SSL_CAPATH=/etc/ssl/certs/
-MYSQL_SSL_CA=
-MYSQL_SSL_CERT=
-MYSQL_SSL_KEY=
-MYSQL_SSL_CIPHER=
-
-# PostgreSQL supports SSL. You can configure it here.
-# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
-PGSQL_SSL_MODE=prefer
-PGSQL_SSL_ROOT_CERT=null
-PGSQL_SSL_CERT=null
-PGSQL_SSL_KEY=null
-PGSQL_SSL_CRL_FILE=null
-
-# If you're looking for performance improvements, you could install memcached.
-CACHE_DRIVER=file
-SESSION_DRIVER=file
-
-# If you set either of these to 'redis', you might want to update these settings too
-# If you use Docker or similar, you can set REDIS_HOST_FILE, REDIS_PASSWORD_FILE or
-# REDIS_PORT_FILE to set the value from a file instead of from an environment variable
-
-# can be tcp, unix or http
-REDIS_SCHEME=tcp
-
-# use only when using 'unix' for REDIS_SCHEME. Leave empty otherwise.
-REDIS_PATH=
-
-# use only when using 'tcp' or 'http' for REDIS_SCHEME. Leave empty otherwise.
-REDIS_HOST=127.0.0.1
-REDIS_PORT=6379
-
-REDIS_PASSWORD=null
-# always use quotes and make sure redis db "0" and "1" exists. Otherwise change accordingly.
-REDIS_DB="0"
-REDIS_CACHE_DB="1"
-
-# Cookie settings. Should not be necessary to change these.
-# If you use Docker or similar, you can set COOKIE_DOMAIN_FILE to set
-# the value from a file instead of from an environment variable
-COOKIE_PATH="/"
-COOKIE_DOMAIN=
-COOKIE_SECURE=false
-
-# If you want Firefly III to mail you, update these settings
-# For instructions, see: https://docs.firefly-iii.org/advanced-installation/email
-# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
-MAIL_MAILER=log
-MAIL_HOST=null
-MAIL_PORT=2525
-MAIL_FROM=changeme@example.com
-MAIL_USERNAME=null
-MAIL_PASSWORD=null
-MAIL_ENCRYPTION=null
-
-# Other mail drivers:
-# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
-MAILGUN_DOMAIN=
-MAILGUN_SECRET=
-
-
-# If you are on EU region in mailgun, use api.eu.mailgun.net, otherwise use api.mailgun.net
-# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
-MAILGUN_ENDPOINT=api.mailgun.net
-
-# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
-MANDRILL_SECRET=
-SPARKPOST_SECRET=
-
-
-# Firefly III can send you the following messages
-SEND_REGISTRATION_MAIL=true
-SEND_ERROR_MESSAGE=true
-
-# These messages contain (sensitive) transaction information:
-SEND_REPORT_JOURNALS=true
-
-# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
-# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
-MAPBOX_API_KEY=
-
-# The map will default to this location:
-MAP_DEFAULT_LAT=51.983333
-MAP_DEFAULT_LONG=5.916667
-MAP_DEFAULT_ZOOM=6
-
-# Firefly III currently supports two provider for live Currency Exchange Rates:
-# "fixer", and "ratesapi".
-# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
-# built compatible with Fixer.IO, based on data published by European Central Bank, and doesn't require API key.
-CER_PROVIDER=ratesapi
-
-# If you have select "fixer" as default currency exchange rates,
-# set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
-# Please note that this WILL ONLY WORK FOR PAID fixer.io accounts because they severely limited
-# the free API up to the point where you might as well offer nothing.
-# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
-FIXER_API_KEY=
-
-# Firefly III has two options for user authentication. "eloquent" is the default,
-# and "ldap" for LDAP servers.
-# For full instructions on these settings please visit:
-# https://docs.firefly-iii.org/advanced-installation/authentication
-# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
-LOGIN_PROVIDER=eloquent
-
-#
-# It's also possible to change the way users are authenticated. You could use Authelia for example.
-# Authentication via the REMOTE_USER header is supported. Change the value below to "remote_user_guard".
-#
-# If you do this please read the documentation for instructions and warnings:
-# https://docs.firefly-iii.org/advanced-installation/authentication
-#
-# This function is available in Firefly III v5.3.0 and higher.
-AUTHENTICATION_GUARD=web
-
-#
-# Likewise, it's impossible to log out users who's authentication is handled by an external system.
-# Enter a custom URL here that will force a logout (your authentication provider can tell you).
-# Setting this variable only works when AUTHENTICATION_GUARD != web
-#
-CUSTOM_LOGOUT_URL=
-
-# LDAP connection configuration
-# OpenLDAP, FreeIPA or ActiveDirectory
-# # If you use Docker or similar, you can set this variable from a file by appending it with _FILE
-ADLDAP_CONNECTION_SCHEME=OpenLDAP
-ADLDAP_AUTO_CONNECT=true
-
-# LDAP connection settings
-# You can set the following variables from a file by appending them with _FILE:
-# ADLDAP_CONTROLLERS, ADLDAP_PORT, ADLDAP_BASEDN
-ADLDAP_CONTROLLERS=
-ADLDAP_PORT=389
-ADLDAP_TIMEOUT=5
-ADLDAP_BASEDN=""
-ADLDAP_FOLLOW_REFFERALS=false
-
-# SSL/TLS settings
-ADLDAP_USE_SSL=false
-ADLDAP_USE_TLS=false
-ADLDAP_SSL_CACERTDIR=
-ADLDAP_SSL_CACERTFILE=
-ADLDAP_SSL_CERTFILE=
-ADLDAP_SSL_KEYFILE=
-ADLDAP_SSL_CIPHER_SUITE=
-ADLDAP_SSL_REQUIRE_CERT=
-
-# You can set the following variables from a file by appending them with _FILE:
-ADLDAP_ADMIN_USERNAME=
-ADLDAP_ADMIN_PASSWORD=
-
-# You can set the following variables from a file by appending them with _FILE:
-ADLDAP_ACCOUNT_PREFIX=
-ADLDAP_ACCOUNT_SUFFIX=
-
-
-# LDAP authentication settings.
-ADLDAP_PASSWORD_SYNC=false
-ADLDAP_LOGIN_FALLBACK=false
-
-ADLDAP_DISCOVER_FIELD=distinguishedname
-ADLDAP_AUTH_FIELD=distinguishedname
-
-# Will allow SSO if your server provides an AUTH_USER field.
-# You can set the following variables from a file by appending them with _FILE:
-WINDOWS_SSO_ENABLED=false
-WINDOWS_SSO_DISCOVER=samaccountname
-WINDOWS_SSO_KEY=AUTH_USER
-
-# field to sync as local username.
-# You can set the following variable from a file by appending it with _FILE:
-ADLDAP_SYNC_FIELD=userprincipalname
-
-# You can disable the X-Frame-Options header if it interferes with tools like
-# Organizr. This is at your own risk. Applications running in frames run the risk
-# of leaking information to their parent frame.
-DISABLE_FRAME_HEADER=false
-
-# You can disable the Content Security Policy header when you're using an ancient browser
-# or any version of Microsoft Edge / Internet Explorer (which amounts to the same thing really)
-# This leaves you with the risk of not being able to stop XSS bugs should they ever surface.
-# This is at your own risk.
-DISABLE_CSP_HEADER=false
-
-# If you wish to track your own behavior over Firefly III, set valid analytics tracker information here.
-# Nobody uses this except for me on the demo site. But hey, feel free to use this if you want to.
-# Do not prepend the TRACKER_URL with http:// or https://
-# The only tracker supported is Matomo.
-# You can set the following variables from a file by appending them with _FILE:
-TRACKER_SITE_ID=
-TRACKER_URL=
-
-# You can fine tune the start-up of a Docker container by editing these environment variables.
-# Use this at your own risk. Disabling certain checks and features may result in lost of inconsistent data.
-# However if you know what you're doing you can significantly speed up container start times.
-# Set each value to true to enable, or false to disable.
-
-# Check if the SQLite database exists. Can be skipped if you're not using SQLite.
-# Won't significantly speed up things.
-DKR_CHECK_SQLITE=true
-
-# Run database creation and migration commands. Disable this only if you're 100% sure the DB exists
-# and is up to date.
-DKR_RUN_MIGRATION=true
-
-# Run database upgrade commands. Disable this only when you're 100% sure your DB is up-to-date
-# with the latest fixes (outside of migrations!)
-DKR_RUN_UPGRADE=true
-
-# Verify database integrity. Includes all data checks and verifications.
-# Disabling this makes Firefly III assume your DB is intact.
-DKR_RUN_VERIFY=true
-
-# Run database reporting commands. When disabled, Firefly III won't go over your data to report current state.
-# Disabling this should have no impact on data integrity or safety but it won't warn you of possible issues.
-DKR_RUN_REPORT=true
-
-# Generate OAuth2 keys.
-# When disabled, Firefly III won't attempt to generate OAuth2 Passport keys. This won't be an issue, IFF (if and only if)
-# you had previously generated keys already and they're stored in your database for restoration.
-DKR_RUN_PASSPORT_INSTALL=true
-
-# Leave the following configuration vars as is.
-# Unless you like to tinker and know what you're doing.
-APP_NAME=FireflyIII
-ADLDAP_CONNECTION=default
-BROADCAST_DRIVER=log
-QUEUE_DRIVER=sync
-CACHE_PREFIX=firefly
-SEARCH_RESULT_LIMIT=50
-PUSHER_KEY=
-PUSHER_SECRET=
-PUSHER_ID=
-DEMO_USERNAME=
-DEMO_PASSWORD=
-USE_ENCRYPTION=false
-IS_HEROKU=false
-FIREFLY_III_LAYOUT=v1
-
-#
-# If you have trouble configuring your Firefly III installation, DON'T BOTHER setting this variable.
-# It won't work. It doesn't do ANYTHING. Don't believe the lies you read online. I'm not joking.
-# This configuration value WILL NOT HELP.
-#
-# This variable is ONLY used in some of the emails Firefly III sends around. Nowhere else.
-# So when configuring anything WEB related this variable doesn't do anything. Nothing
-#
-# If you're stuck I understand you get desperate but look SOMEWHERE ELSE.
-#
-APP_URL=http://localhost

.deploy/heroku/.locales

@@ -1,29 +0,0 @@
-bg_BG
-cs_CZ
-da_DK
-de_DE
-el_GR
-en_GB
-en_US
-es_ES
-fi_FI
-fr_FR
-hu_HU
-id_ID
-it_IT
-ja_JP
-nb_NO
-nl_NL
-pl_PL
-pt_BR
-pt_PT
-ro_RO
-ru_RU
-sk_SK
-sl_SI
-sv_SE
-tr_TR
-uk_UA
-vi_VN
-zh-hans_CN
-zh-hant_CN

.editorconfig

@@ -2,8 +2,17 @@ root = true
 
 [*]
 charset = utf-8
-indent_style = space
-indent_size = 2
 end_of_line = lf
+indent_size = 4
+indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.example

@@ -1,12 +1,13 @@
 # You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
 # Never set it to "testing".
-APP_ENV=local
+APP_ENV=production
 
 # Set to true if you want to see debug information in error screens.
 APP_DEBUG=false
 
 # This should be your email address.
 # If you use Docker or similar, you can set this variable from a file by using SITE_OWNER_FILE
+# The variable is used in some errors shown to users who aren't admin.
 SITE_OWNER=mail@example.com
 
 # The encryption key for your sessions. Keep this very secure.
@@ -18,7 +19,7 @@ SITE_OWNER=mail@example.com
 APP_KEY=SomeRandomStringOf32CharsExactly
 
 # Firefly III will launch using this language (for new users and unauthenticated visitors)
-# For a list of available languages: https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang
+# For a list of available languages: https://github.com/firefly-iii/firefly-iii/blob/main/config/firefly.php#L123
 #
 # If text is still in English, remember that not everything may have been translated.
 DEFAULT_LANGUAGE=en_US
@@ -44,12 +45,6 @@ TRUSTED_PROXIES=
 # Default setting 'stack' will log to 'daily' and to 'stdout' at the same time.
 LOG_CHANNEL=stack
 
-#
-# Used when logging to papertrail:
-#
-PAPERTRAIL_HOST=
-PAPERTRAIL_PORT=
-
 # Log level. You can set this from least severe to most severe:
 # debug, info, notice, warning, error, critical, alert, emergency
 # If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
@@ -57,11 +52,33 @@ PAPERTRAIL_PORT=
 APP_LOG_LEVEL=notice
 
 # Audit log level.
-# Set this to "emergency" if you dont want to store audit logs, leave on info otherwise.
-AUDIT_LOG_LEVEL=info
+# The audit log is used to log notable Firefly III events on a separate channel.
+# These log entries may contain sensitive financial information.
+# The audit log is disabled by default.
+#
+# To enable it, set AUDIT_LOG_LEVEL to "info"
+# To disable it, set AUDIT_LOG_LEVEL to "emergency"
+AUDIT_LOG_LEVEL=emergency
+
+#
+# If you want, you can redirect the audit logs to another channel.
+# Set 'audit_stdout', 'audit_syslog', 'audit_errorlog' to log to the system itself.
+# Use audit_daily to log to a rotating file.
+# Use audit_papertrail to log to papertrail.
+#
+# If you do this, the audit logs may be mixed with normal logs because the settings for these channels
+# are often the same as the settings for the normal logs.
+AUDIT_LOG_CHANNEL=
+
+#
+# Used when logging to papertrail:
+# Also used when audit logs log to papertrail:
+#
+PAPERTRAIL_HOST=
+PAPERTRAIL_PORT=
 
 # Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
-# For other database types, please see the FAQ: https://docs.firefly-iii.org/support/faq
+# For other database types, please see the FAQ: https://docs.firefly-iii.org/references/faq/install/#i-want-to-use-sqlite
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 # Use "pgsql" for PostgreSQL
 # Use "mysql" for MySQL and MariaDB.
@@ -94,7 +111,10 @@ PGSQL_SSL_CERT=null
 PGSQL_SSL_KEY=null
 PGSQL_SSL_CRL_FILE=null
 
-# more PostgreSQL settings
+# For postgresql 15 and up, setting this to public will no longer work as expected, becasuse the
+# 'public' schema is without grants. This can be worked around by having a super user grant those
+# necessary privileges, but in security conscious setups that's not viable.
+# You will need to set this to the schema you want to use.
 PGSQL_SCHEMA=public
 
 # If you're looking for performance improvements, you could install memcached or redis
@@ -105,7 +125,7 @@ SESSION_DRIVER=file
 # If you use Docker or similar, you can set REDIS_HOST_FILE, REDIS_PASSWORD_FILE or
 # REDIS_PORT_FILE to set the value from a file instead of from an environment variable
 
-# can be tcp, unix or http
+# can be tcp or unix. http is not supported
 REDIS_SCHEME=tcp
 
 # use only when using 'unix' for REDIS_SCHEME. Leave empty otherwise.
@@ -133,7 +153,7 @@ COOKIE_SECURE=false
 COOKIE_SAMESITE=lax
 
 # If you want Firefly III to email you, update these settings
-# For instructions, see: https://docs.firefly-iii.org/advanced-installation/email
+# For instructions, see: https://docs.firefly-iii.org/how-to/firefly-iii/advanced/notifications/#email
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 MAIL_MAILER=log
 MAIL_HOST=null
@@ -142,6 +162,14 @@ MAIL_FROM=changeme@example.com
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
+MAIL_SENDMAIL_COMMAND=
+
+#
+# If you use self-signed certificates for your STMP server, you can use the following settings.
+#
+MAIL_ALLOW_SELF_SIGNED=false
+MAIL_VERIFY_PEER=true
+MAIL_VERIFY_PEER_NAME=true
 
 # Other mail drivers:
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
@@ -155,25 +183,44 @@ MAILGUN_ENDPOINT=api.mailgun.net
 # If you use Docker or similar, you can set these variables from a file by appending them with _FILE
 MANDRILL_SECRET=
 SPARKPOST_SECRET=
+MAILERSEND_API_KEY=
 
 # Firefly III can send you the following messages.
-SEND_REGISTRATION_MAIL=true
 SEND_ERROR_MESSAGE=true
-SEND_LOGIN_NEW_IP_WARNING=true
 
 # These messages contain (sensitive) transaction information:
 SEND_REPORT_JOURNALS=true
 
-# Set this value to true if you want to set the location
-# of certain things, like transactions. Since this involves an external service, it's optional
-# and disabled by default.
+# Set this value to true if you want to set the location of certain things, like transactions.
+# Since this involves an external service, it's optional and disabled by default.
 ENABLE_EXTERNAL_MAP=false
 
+#
+# Enable or disable exchange rate conversion.
+#
+ENABLE_EXCHANGE_RATES=false
+
+# Set this value to true if you want Firefly III to download currency exchange rates
+# from the internet. These rates are hosted by the creator of Firefly III inside
+# an Azure Storage Container.
+# Not all currencies may be available. Rates may be wrong.
+ENABLE_EXTERNAL_RATES=false
+
 # The map will default to this location:
 MAP_DEFAULT_LAT=51.983333
 MAP_DEFAULT_LONG=5.916667
 MAP_DEFAULT_ZOOM=6
 
+#
+# Some objects have room for an URL, like transactions and webhooks.
+# By default, the following protocols are allowed:
+# http, https, ftp, ftps, mailto
+#
+# To change this, set your preferred comma separated set below.
+# Be sure to include http, https and other default ones if you need to.
+#
+VALID_URL_PROTOCOLS=
+
 #
 # Firefly III authentication settings
 #
@@ -183,7 +230,7 @@ MAP_DEFAULT_ZOOM=6
 # - 'web' (default, uses built in DB)
 # - 'remote_user_guard' for Authelia etc
 # Read more about these settings in the documentation.
-# https://docs.firefly-iii.org/advanced-installation/authentication
+# https://docs.firefly-iii.org/how-to/firefly-iii/advanced/authentication/
 #
 # LDAP is no longer supported :(
 #
@@ -236,51 +283,23 @@ ALLOW_WEBHOOKS=false
 #
 # The static cron job token can be useful when you use Docker and wish to manage cron jobs.
 # 1. Set this token to any 32-character value (this is important!).
-# 2. Use this token in the cron URL instead of a user's command line token.
+# 2. Use this token in the cron URL instead of a user's command line token that you can find in /profile
 #
-# For more info: https://docs.firefly-iii.org/firefly-iii/advanced-installation/cron/
+# For more info: https://docs.firefly-iii.org/how-to/firefly-iii/advanced/cron/
 #
 # You can set this variable from a file by appending it with _FILE
 #
-STATIC_CRON_TOKEN=
+STATIC_CRON_TOKEN=PLEASE_REPLACE_WITH_32_CHAR_CODE
 
 # You can fine tune the start-up of a Docker container by editing these environment variables.
 # Use this at your own risk. Disabling certain checks and features may result in lots of inconsistent data.
 # However if you know what you're doing you can significantly speed up container start times.
 # Set each value to true to enable, or false to disable.
 
-# Set this to true to build all locales supported by Firefly III.
-# This may take quite some time (several minutes) and is generally not recommended.
-# If you wish to change or alter the list of locales, start your Docker container with
-# `docker run -v locale.gen:/etc/locale.gen -e DKR_BUILD_LOCALE=true`
-# and make sure your preferred locales are in your own locale.gen.
-DKR_BUILD_LOCALE=false
-
 # Check if the SQLite database exists. Can be skipped if you're not using SQLite.
 # Won't significantly speed up things.
 DKR_CHECK_SQLITE=true
 
-# Run database creation and migration commands. Disable this only if you're 100% sure the DB exists
-# and is up to date.
-DKR_RUN_MIGRATION=true
-
-# Run database upgrade commands. Disable this only when you're 100% sure your DB is up-to-date
-# with the latest fixes (outside of migrations!)
-DKR_RUN_UPGRADE=true
-
-# Verify database integrity. Includes all data checks and verifications.
-# Disabling this makes Firefly III assume your DB is intact.
-DKR_RUN_VERIFY=true
-
-# Run database reporting commands. When disabled, Firefly III won't go over your data to report current state.
-# Disabling this should have no impact on data integrity or safety but it won't warn you of possible issues.
-DKR_RUN_REPORT=true
-
-# Generate OAuth2 keys.
-# When disabled, Firefly III won't attempt to generate OAuth2 Passport keys. This won't be an issue, IFF (if and only if)
-# you had previously generated keys already and they're stored in your database for restoration.
-DKR_RUN_PASSPORT_INSTALL=true
-
 # Leave the following configuration vars as is.
 # Unless you like to tinker and know what you're doing.
 APP_NAME=FireflyIII
@@ -293,19 +312,27 @@ PUSHER_SECRET=
 PUSHER_ID=
 DEMO_USERNAME=
 DEMO_PASSWORD=
-IS_HEROKU=false
+
+#
+# Disable or enable the running balance column data
+# Please disable this. It's a very experimental feature.
+#
+USE_RUNNING_BALANCE=false
+
+#
+# The v2 layout is very experimental. If it breaks you get to keep both parts.
+# Be wary of data loss.
+#
 FIREFLY_III_LAYOUT=v1
 
 #
-# If you have trouble configuring your Firefly III installation, DON'T BOTHER setting this variable.
-# It won't work. It doesn't do ANYTHING. Don't believe the lies you read online. I'm not joking.
-# This configuration value WILL NOT HELP.
+# Which Query Parser implementation to use for the search engine and rules
+# 'new' is experimental, 'legacy' is the classic one
 #
-# Notable exception to this rule is Synology, which, according to some users, will use APP_URL to rewrite stuff.
+QUERY_PARSER_IMPLEMENTATION=new
+
 #
-# This variable is ONLY used in some of the emails Firefly III sends around. Nowhere else.
-# So when configuring anything WEB related this variable doesn't do anything. Nothing
-#
-# If you're stuck I understand you get desperate but look SOMEWHERE ELSE.
+# Please make sure this URL matches the external URL of your Firefly III installation.
+# It is used to validate specific requests and to generate URLs in emails.
 #
 APP_URL=http://localhost

.env.testing

@@ -0,0 +1,26 @@
+APP_ENV=testing
+APP_DEBUG=true
+SITE_OWNER=mail@example.com
+APP_KEY=TestTestTestTestTestTestTestTest
+DEFAULT_LANGUAGE=en_US
+DEFAULT_LOCALE=equal
+TZ=Europe/Amsterdam
+LOG_CHANNEL=stdout
+APP_LOG_LEVEL=debug
+AUDIT_LOG_LEVEL=info
+AUDIT_LOG_CHANNEL=audit_stdout
+DB_CONNECTION=sqlite
+CACHE_DRIVER=array
+SESSION_DRIVER=array
+MAIL_MAILER=log
+SEND_ERROR_MESSAGE=true
+ENABLE_EXTERNAL_MAP=false
+ENABLE_EXTERNAL_RATES=true
+AUTHENTICATION_GUARD=web
+ALLOW_WEBHOOKS=true
+APP_NAME=FireflyIII
+BROADCAST_DRIVER=log
+QUEUE_DRIVER=sync
+CACHE_PREFIX=firefly
+FIREFLY_III_LAYOUT=v1
+APP_URL=http://localhost

.gitattributes

@@ -1,8 +1,11 @@
-* text=auto
-*.css linguist-vendored
-*.scss linguist-vendored
-*.js linguist-vendored
+* text=auto eol=lf
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
 CHANGELOG.md export-ignore
-/tests       export-ignore
-/phpunit.xml export-ignore
-/.ci export-ignore
+.styleci.yml export-ignore

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# code owners for this Firefly III related repository
+* @JC5 @SDx3

.github/ISSUE_TEMPLATE/bug.yml

@@ -1,4 +1,4 @@
-name: Bug Report
+name: Bug report
 description: Report a bug in Firefly III (or associated tools)
 body:
   - type: checkboxes
@@ -12,11 +12,11 @@ body:
   - type: checkboxes
     attributes:
       label: I've found a bug and checked that ...
-      description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why.
+      description: Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, please explain why.
       options:
         - label: ... [the documentation](https://docs.firefly-iii.org/) does not mention anything about my problem
         - label: ... there are no open or closed issues that are related to my problem
-        - label: ... it's [definitely me, not you](https://github.com/firefly-iii/firefly-iii/blob/main/.github/its_you_not_me.md)
+        - label: ... it's [definitely a Firefly III issue, not me](https://github.com/firefly-iii/firefly-iii/blob/main/.github/its_you_not_me.md)
 
   - type: textarea
     attributes:
@@ -25,17 +25,10 @@ body:
     validations:
       required: true
 
-  - type: textarea
-    attributes:
-      label: Expected behaviour
-      description: Please describe precisely what you'd expect to happen.
-    validations:
-      required: true
-
   - type: textarea
     attributes:
       label: Debug information
-      description: Please provide the table from the /debug page
+      description: Please provide the table from the /debug page. Do not add backticks or quotes.
       placeholder: The output from the /debug page
     validations:
       required: true
@@ -54,4 +47,4 @@ body:
   - type: textarea
     attributes:
       label: Additional info
-      description: Please provide any additional information that seem useful.
+      description: Please provide any additional information that seems useful.

.github/ISSUE_TEMPLATE/config.yml

@@ -3,3 +3,6 @@ contact_links:
   - name: Ask a question
     url: https://github.com/firefly-iii/firefly-iii/discussions
     about: Please ask and answer questions here.
+  - name: I need support! 
+    url: https://github.com/firefly-iii/firefly-iii/discussions
+    about: I think I broke something...

.github/ISSUE_TEMPLATE/fr.yml

@@ -1,4 +1,4 @@
-name: Feature Request
+name: Feature request
 description: Request a feature or enhancement in Firefly III (or associated tools)
 body:
   - type: checkboxes
@@ -8,9 +8,9 @@ body:
       options:
         - label: I've read the [support guidelines](https://github.com/firefly-iii/firefly-iii/blob/main/.github/support.md)
           required: true
-        - label: My request is not listed as [a very good idea, but unfortunately...](https://docs.firefly-iii.org/firefly-iii/about-firefly-iii/what-its-not/)
+        - label: My request is not listed as [a very good idea, but unfortunately...](https://docs.firefly-iii.org/explanation/more-information/what-its-not/)
           required: true
-        - label: I've used [the search](https://github.com/firefly-iii/firefly-iii/issues?q=is%3Aissue) and this has not been discussed before.
+        - label: I've used [the search](https://github.com/firefly-iii/firefly-iii/issues?q=is%3Aissue) and this has not been requested before.
           required: true
 
   - type: textarea
@@ -18,9 +18,9 @@ body:
       label: Description
       description: Please describe your feature request
       placeholder: |
-        - I would like Firefly III to do ABC.
-        - What if you would add feature XYZ?
-        - Firefly III doesn't do DEF.
+        - I would like Firefly III to do (thing).
+        - What if you would add feature (feature here)?
+        - Firefly III doesn't do (thing).
     validations:
       required: true
 
@@ -31,11 +31,6 @@ body:
     validations:
       required: true
 
-  - type: textarea
-    attributes:
-      label: What are alternatives?
-      description: Please describe what alternatives currently exist.
-
   - type: textarea
     attributes:
       label: Additional context

.github/code_of_conduct.md

@@ -2,7 +2,10 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
+participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
+disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -24,23 +27,35 @@ Examples of unacceptable behavior by participants include:
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
+project or its community. Examples of representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed representative at an online or offline
+event. Representation of a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at james@firefly-iii.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
+james@firefly-iii.org. The project team will review and investigate all complaints, and will respond in a way that it
+deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the
+reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+repercussions as determined by other members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available
+at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
+
 [version]: http://contributor-covenant.org/version/1/4/

.github/contributing.md

@@ -1,3 +1,3 @@
-# [Contributing guidelines](https://docs.firefly-iii.org/other-pages/contributing)
+# [Contributing guidelines](https://docs.firefly-iii.org/explanation/support/#contributing-code)
 
-[Contributing guidelines](https://docs.firefly-iii.org/other-pages/contributing)
+[Contributing guidelines](https://docs.firefly-iii.org/explanation/support/#contributing-code)

.github/dependabot.yml

@@ -1,11 +1,18 @@
 version: 2
 updates:
 
+  # Check for updates to GitHub Actions every week
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    labels: []
+    schedule:
+      interval: "weekly"
+
   # composer updates
   - package-ecosystem: "composer"
     directory: "/" # Location of package manifests
     target-branch: develop
-    labels: ["bug"]
+    labels: []
     versioning-strategy: increase
     schedule:
       interval: "weekly"
@@ -13,16 +20,8 @@ updates:
   # yarn / JS updates
   - package-ecosystem: "npm"
     directory: "/"
+    labels: []
     target-branch: develop
-    labels: ["bug"]
-    versioning-strategy: increase
-    schedule:
-      interval: "weekly"
-
-  - package-ecosystem: "github-actions"
-    directory: "/" 
-    target-branch: develop
-    labels: ["bug"]
     versioning-strategy: increase
     schedule:
       interval: "weekly"

.github/funding.yml

@@ -1,4 +1,6 @@
-# These are supported funding model platforms
+# Firefly III sponsor options
 
 github: jc5
 patreon: JC5
+ko_fi: jamesc5
+liberapay: JC5

.github/its_you_not_me.md

@@ -2,9 +2,11 @@
 
 Sometimes bugs reported to Firefly III are configuration and system problems on the user's side.
 
-If you run into any of the following problems, there's a good chance it's not a Firefly III issue, but a configuration issue.
+If you run into any of the following problems, there's a good chance it's not a Firefly III issue, but a configuration
+issue.
 
-- ⚠️ Firefly III can't connect to the database when starting or the password is wrong, even though you're sure it's correct.
+- ⚠️ Firefly III can't connect to the database when starting or the password is wrong, even though you're sure it's
+  correct.
 - ⚠️ Errors about a missing `APP_KEY` or other encryption/hash problems
 - ⚠️ You can't login due to `419` errors (page expired)
 - ⚠️ Any `500` error when starting Firefly III
@@ -13,4 +15,6 @@ If you run into any of the following problems, there's a good chance it's not a
 - ⚠️ Firefly III does not work behind your reverse proxy
 - ⚠️ You can't connect to the Data Importer due to 404's or authentication issues.
 
-If you run into an issue like this, please start a [discussion](https://github.com/firefly-iii/firefly-iii/discussions) or chat on [Gitter.im](https://gitter.im/firefly-iii/firefly-iii). There's a good chance it's not a bug but something we can fix rather quickly :+1:
+If you run into an issue like this, please start a [discussion](https://github.com/firefly-iii/firefly-iii/discussions)
+or chat on [Gitter.im](https://gitter.im/firefly-iii/firefly-iii). There's a good chance it's not a bug but something we
+can fix rather quickly :+1:

.github/label-actions.yml

@@ -0,0 +1,126 @@
+# Configuration for Label Actions - https://github.com/dessant/label-actions
+
+# The `feature` label is added to issues
+fixed:
+  issues:
+    # Post a comment, `{issue-author}` is an optional placeholder
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as fixed. Thanks for reporting! A new version will be released in due time. Unfortunately, [I cannot give an estimate](https://docs.firefly-iii.org/references/faq/firefly-iii/general/#when-will-you-release-version-the-next-version), but [the roadmap](https://roadmap.firefly-iii.org/) is available for your reading pleasure.
+
+      There is no need to close the issue. It will be closed automatically.
+
+      Thank you for your contributions.
+feature:
+  issues:
+    # Post a comment, `{issue-author}` is an optional placeholder
+    unlabel: feature
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as a feature request.
+
+      If you come across this issue, please be aware there is NO need to reply with "+1" or "me too" or "I need this too" or whatever. Such comments are not helpful, and do not influence [the roadmap](https://roadmap.firefly-iii.org/). Your comment may be :skull: deleted. You can subscribe to this issue to get updates.
+
+      Thank you for your contributions.
+
+epic:
+  issues:
+    # Post a comment, `{issue-author}` is an optional placeholder
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as an epic. In epics, large amounts of works are collected that will be part of a major new feature. If you have more ideas that could be a part of this epic, feel free to reply.
+
+      *However*, please be aware there is NO need to reply with "+1" or "me too" or "I need this too" or whatever. Such comments are not helpful, and do not influence [the roadmap](https://roadmap.firefly-iii.org/). Your comment may be :skull: deleted.
+
+      If you are merely interested in this epic's progress, you can subscribe to this issue to get updates.
+
+      Thank you for your contributions.
+
+enhancement:
+  unlabel: enhancement
+  issues:
+    # Post a comment, `{issue-author}` is an optional placeholder
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as an enhancement.
+
+      If you come across this issue, please be aware there is NO need to reply with "+1" or "me too" or "I need this too" or whatever. Such comments are not helpful, and do not influence [the roadmap](https://roadmap.firefly-iii.org/). Your comment may be :skull: deleted. You can subscribe to this issue to get updates.
+
+      Thank you for your contributions.
+
+triage:
+  issues:
+    # Post a comment, `{issue-author}` is an optional placeholder
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      This issue has been marked as being in triage. The root cause is not known yet, or the issue needs more investigation. You can help by sharing debug information (from `/debug`) if you also have this issue or when you haven't already done so.
+
+      Thank you for your contributions.
+
+needs-moar-debug:
+  issues:
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      To learn more about this issue, please make sure you share at least:
+
+      1. The table you can find on the `/debug` page
+      2. Firefly III version
+      2. Docker, self-hosted, or hosted by a third party?
+      3. Operating system and browser
+
+      Thank you for your contributions.
+    unlabel: needs-moar-debug
+
+
+needs-moar-logs:
+  issues:
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      To learn more about this issue, please share the relevant log files from your Firefly III or data importer installation.
+
+      The relevant instructions can be found in the documentation: [How to debug Firefly III?](https://docs.firefly-iii.org/how-to/general/debug/) Once debug mode is activated per these instructions, you can repeat your action and find the logs, depending on your method of installation. All is explained on the page.
+
+      Please share the relevant log lines in your issue, either inline or as an attachment. If you feel the logs contain sensitive information, you may also send them to [james@firefly-iii.org](mailto:james@firefly-iii.org). Without these logs, it may not be possible to properly investigate this issue.
+
+      Thank you for your contributions.
+    unlabel: needs-moar-logs
+
+v2-layout-issue:
+  issues:
+    comment: |
+      Hi there!
+
+      This is an automatic reply. `Share and enjoy`
+
+      It seems your issue is about the new v2-layout that is currently in development for Firefly III.
+
+      These issues are collected in [a GitHub discussion](https://github.com/firefly-iii/firefly-iii/issues/8361).
+
+      Please note that the v2 layout is still very much in development.
+
+      Thank you for your contributions.
+    close: true
+    close-reason: completed
+    lock: false
+    unlabel: v2-layout-issue

.github/mergify.yml

@@ -1,8 +1,16 @@
 pull_request_rules:
+  - name: Make sure PR are up to date before merging
+    description: This automatically updates PRs when they are out-of-date with the
+      base branch to avoid semantic conflicts (next step is using a merge
+      queue).
+    conditions: []
+    actions:
+      update:
   - name: Close all on main
     conditions:
       - base=main
       - -author~=^dependabot(|-preview)\[bot\]$
     actions:
       close:
-        message: Please do not open PR's on the `main` branch, but on the `develop` branch only. Thank you!
+        message: Please do not open PR's on the `main` branch, but on the `develop`
+          branch only. Thank you!

.github/pull_request_template.md

@@ -1,18 +1,23 @@
 <!--
-Before you create a new PR, please consider:
+Thank you for submitting new code to Firefly III, or any of the related projects. Please read the following rules carefully.
 
-1) Pull requests for the MAIN branch will be closed.
-2) DO NOT include translations in your PR. Only English US sentences.
+- Please do not submit solutions for problems that are not already reported in an issue.
+- Unfortunately, Firefly III can't be your learning experience. If you're new to all of this, please open an issue first.
+- Please do not open PRs to "discuss" possible solutions or to "get feedback" on your code. I simply don't have time for that.
+- Pull requests for the MAIN branch will be closed.
+- DO NOT include translated strings in your PR.
+- PRs (or parts thereof) that only fix issues inside code comments will not be accepted.
+
+If it feels necessary to open an issue first, please do so, before you open a PR.
+
+See also: https://docs.firefly-iii.org/explanation/support/#contributing-code
 
-Thanks.
 -->
-
-Fixes issue # (if relevant)
+    
+This PR fixes issue # (if relevant).
 
 Changes in this pull request:
 
-- 
-- 
-- 
-
-@JC5
+-
+-
+-

.github/security.md

@@ -1,53 +1,101 @@
 # Security Policy
 
-Firefly III is an application to manage your personal finances. As such, the developer has adopted this security disclosure and response policy to ensure that critical issues are responsibly handled.
+Firefly III is an application to manage your personal finances. As such, the developer has adopted this security
+disclosure and response policy to ensure that critical issues are responsibly handled.
 
 ## Supported Versions
-Only the latest Firefly III release is maintained. Applicable fixes, including security fixes, will not backported to older release branches. Please refer to [releases.md](https://github.com/firefly-iii/firefly-iii/blob/main/releases.md) for details.
+
+Only the latest Firefly III release is maintained. Applicable fixes, including security fixes, will not backported to
+older release branches. Please refer to [releases.md](https://github.com/firefly-iii/firefly-iii/blob/main/releases.md)
+for details.
 
 ## Reporting a Vulnerability - Private Disclosure Process
-Security is of the highest importance and all security vulnerabilities or suspected security vulnerabilities should be reported to Firefly III privately, to minimize attacks against current users of Firefly III before they are fixed. Vulnerabilities will be investigated and patched on the next patch (or minor) release as soon as possible. This information could be kept entirely internal to the project.  
 
-If you know of a publicly disclosed security vulnerability for Firefly III, please **IMMEDIATELY** contact james@firefly-iii.org to inform the Firefly III developer. You can use my [GPG key](https://keybase.io/jc5) for extra security.
+Security is of the highest importance and all security vulnerabilities or suspected security vulnerabilities should be
+reported to Firefly III privately, to minimize attacks against current users of Firefly III before they are fixed.
+Vulnerabilities will be investigated and patched on the next patch (or minor) release as soon as possible. This
+information could be kept entirely internal to the project.
+
+If you know of a publicly disclosed security vulnerability for Firefly III, please **IMMEDIATELY** contact
+james@firefly-iii.org to inform the Firefly III developer. You can use my [GPG key](https://keybase.io/jc5) for extra
+security.
 
 **IMPORTANT: Do not file public issues on GitHub for security vulnerabilities**
 
-To report a vulnerability or a security-related issue, please email the private address james@firefly-iii.org with the details of the vulnerability. The email will be received by the developer of Firefly III. Emails will be addressed within 3 business days, including a detailed plan to investigate the issue and any potential workarounds to perform in the meantime. Do not report non-security-impacting bugs through this channel. Use [GitHub issues](https://github.com/firefly-iii/firefly-iii/issues/new/choose) instead.
+To report a vulnerability or a security-related issue, please email the private address james@firefly-iii.org with the
+details of the vulnerability. The email will be received by the developer of Firefly III. Emails will be addressed
+within 3 business days, including a detailed plan to investigate the issue and any potential workarounds to perform in
+the meantime. Do not report non-security-impacting bugs through this channel.
+Use [GitHub issues](https://github.com/firefly-iii/firefly-iii/issues/new/choose) instead.
 
 ### Proposed Email Content
+
 Provide a descriptive subject line and in the body of the email include the following information:
+
 * Basic identity information, such as your name and your affiliation or company.
-* Detailed steps to reproduce the vulnerability  (POC scripts, screenshots, and compressed packet captures are all helpful to us).
-* Description of the effects of the vulnerability on Firefly III and the related hardware and software configurations, so that the developer can reproduce it.
+* Detailed steps to reproduce the vulnerability  (POC scripts, screenshots, and compressed packet captures are all
+  helpful to us).
+* Description of the effects of the vulnerability on Firefly III and the related hardware and software configurations,
+  so that the developer can reproduce it.
 * How the vulnerability affects Firefly III usage and an estimation of the attack surface, if there is one.
 * List other projects or dependencies that were used in conjunction with Firefly III to produce the vulnerability.
 
 ## When to report a vulnerability
+
 * When you think Firefly III has a potential security vulnerability.
 * When you suspect a potential vulnerability but you are unsure that it impacts Firefly III.
-* When you know of or suspect a potential vulnerability on another project that is used by Firefly III. For example Firefly III has a dependency on Docker, MySQL, etc.
-  
+* When you know of or suspect a potential vulnerability on another project that is used by Firefly III. For example
+  Firefly III has a dependency on Docker, MySQL, etc.
+
 ## Patch, Release, and Disclosure
+
 The Firefly III developer will respond to vulnerability reports as follows:
- 
-1.  The developer will investigate the vulnerability and determine its effects and criticality.
-2.  If the issue is not deemed to be a vulnerability, the developer will follow up with a detailed reason for rejection.
-3.  The developer will initiate a conversation with the reporter within 3 business days.
-4.  If a vulnerability is acknowledged and the timeline for a fix is determined, the developer will work on a plan to communicate with the appropriate community, including identifying mitigating steps that affected users can take to protect themselves until the fix is rolled out.
-5.  The developer will also create a [CVSS](https://www.first.org/cvss/specification-document) using the [CVSS Calculator](https://www.first.org/cvss/calculator/3.0). The developer makes the final call on the calculated CVSS; it is better to move quickly than making the CVSS perfect. Issues may also be reported to [Mitre](https://cve.mitre.org/) using this [scoring calculator](https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator). The CVE will initially be set to private.
-6.  The developer will work on fixing the vulnerability and perform internal testing before preparing to roll out the fix.
-7. A public disclosure date is negotiated by the Firefly III developer and the bug submitter. We prefer to fully disclose the bug as soon as possible once a user mitigation or patch is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for distributor coordination. The timeframe for disclosure is from immediate (especially if it’s already publicly known) to a few weeks. For a critical vulnerability with a straightforward mitigation, we expect report date to public disclosure date to be on the order of 14 business days. The Firefly III developer holds the final say when setting a public disclosure date.
-9.  Once the fix is confirmed, the developer will patch the vulnerability in the next patch or minor release. Upon release of the patched version of Firefly III, we will follow the **Public Disclosure Process**.
+
+1. The developer will investigate the vulnerability and determine its effects and criticality.
+2. If the issue is not deemed to be a vulnerability, the developer will follow up with a detailed reason for rejection.
+3. The developer will initiate a conversation with the reporter within 3 business days.
+4. If a vulnerability is acknowledged and the timeline for a fix is determined, the developer will work on a plan to
+   communicate with the appropriate community, including identifying mitigating steps that affected users can take to
+   protect themselves until the fix is rolled out.
+5. The developer will also create a [CVSS](https://www.first.org/cvss/specification-document) using
+   the [CVSS Calculator](https://www.first.org/cvss/calculator/3.0). The developer makes the final call on the
+   calculated CVSS; it is better to move quickly than making the CVSS perfect. Issues may also be reported
+   to [Mitre](https://cve.mitre.org/) using
+   this [scoring calculator](https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator). The CVE will initially be set to
+   private.
+6. The developer will work on fixing the vulnerability and perform internal testing before preparing to roll out the
+   fix.
+7. A public disclosure date is negotiated by the Firefly III developer and the bug submitter. We prefer to fully
+   disclose the bug as soon as possible once a user mitigation or patch is available. It is reasonable to delay
+   disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for distributor
+   coordination. The timeframe for disclosure is from immediate (especially if it’s already publicly known) to a few
+   weeks. For a critical vulnerability with a straightforward mitigation, we expect report date to public disclosure
+   date to be on the order of 14 business days. The Firefly III developer holds the final say when setting a public
+   disclosure date.
+8. Once the fix is confirmed, the developer will patch the vulnerability in the next patch or minor release. Upon
+   release of the patched version of Firefly III, we will follow the **Public Disclosure Process**.
 
 ### Public Disclosure Process
-The developer publishes a public [advisory](https://github.com/firefly-iii/firefly-iii/security/advisories) to the Firefly III community via GitHub. In most cases, additional communication via Mastodon, Gitter and other channels will assist in educating Firefly III users and rolling out the patched release to affected users. 
 
-The develop will also publish any mitigating steps users can take until the fix can be applied to their Firefly III instances.
- 
+The developer publishes a public [advisory](https://github.com/firefly-iii/firefly-iii/security/advisories) to the
+Firefly III community via GitHub. In most cases, additional communication via Mastodon, Gitter and other channels will
+assist in educating Firefly III users and rolling out the patched release to affected users.
+
+The developer will also publish any mitigating steps users can take until the fix can be applied to their Firefly III
+instances.
+
 ## Confidentiality, integrity and availability
-We consider vulnerabilities leading to the compromise of data confidentiality, elevation of privilege, or integrity to be our highest priority concerns. Availability, in particular in areas relating to DoS and resource exhaustion, is also a serious security concern. The Firefly III developer takes all vulnerabilities, potential vulnerabilities, and suspected vulnerabilities seriously and will investigate them in an urgent and expeditious manner.
 
-Note that we do not currently consider the default settings for Firefly III to be secure-by-default. It is necessary for operators to explicitly configure settings, role based access control, and other resource related features in Firefly III to provide a hardened Firefly III environment. We will not act on any security disclosure that relates to a lack of safe defaults. Over time, we will work towards improved safe-by-default configuration, taking into account backwards compatibility.
+We consider vulnerabilities leading to the compromise of data confidentiality, elevation of privilege, or integrity to
+be our highest priority concerns. Availability, in particular in areas relating to DoS and resource exhaustion, is also
+a serious security concern. The Firefly III developer takes all vulnerabilities, potential vulnerabilities, and
+suspected vulnerabilities seriously and will investigate them in an urgent and expeditious manner.
+
+Note that we do not currently consider the default settings for Firefly III to be secure-by-default. It is necessary for
+operators to explicitly configure settings, role based access control, and other resource related features in Firefly
+III to provide a hardened Firefly III environment. We will not act on any security disclosure that relates to a lack of
+safe defaults. Over time, we will work towards improved safe-by-default configuration, taking into account backwards
+compatibility.
 
 ## Credits
 

.github/stale.yml

@@ -1,58 +0,0 @@
-# Configuration for probot-stale - https://github.com/probot/stale
-
-# Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 14
-
-# Number of days of inactivity before a stale Issue or Pull Request is closed.
-# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
-daysUntilClose: 14
-
-# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
-# - "[Status] Maybe Later"
-exemptLabels:
-  - enhancement
-  - feature
-  - bug
-  - announcement
-  - "layout-v3"
-
-# Set to true to ignore issues in a project (defaults to false)
-exemptProjects: false
-
-# Set to true to ignore issues in a milestone (defaults to false)
-exemptMilestones: false
-
-# Label to use when marking as stale
-staleLabel: stale
-
-# Comment to post when marking as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-
-# Comment to post when removing the stale label.
-# unmarkComment: >
-#   Your comment here.
-
-# Comment to post when closing a stale Issue or Pull Request.
-# closeComment: >
-#   Your comment here.
-
-# Limit the number of actions per hour, from 1-30. Default is 30
-limitPerRun: 30
-
-# Limit to only `issues` or `pulls`
-# only: issues
-
-# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
-# pulls:
-#   daysUntilStale: 30
-#   markComment: >
-#     This pull request has been automatically marked as stale because it has not had
-#     recent activity. It will be closed if no further activity occurs. Thank you
-#     for your contributions.
-
-# issues:
-#   exemptLabels:
-#     - confirmed

.github/support.md

@@ -4,12 +4,13 @@
 
 ## Reporting an issue
 
-First of all: thank you for reporting a bug instead of ditching the tool altogether. Bugs have a lot of priority! 
+First of all: thank you for reporting a bug instead of ditching the tool altogether. Bugs have a lot of priority!
 
 1. Open bugs will have open issues, so search for one first.
 2. If your feature request is already there, vote on it with :+1: or :-1: reactions.
 3. Do NOT hijack old issues with the bug you found, open your own issue.
-4. If relevant, take the time and see if the [demo site](https://demo.firefly-iii.org/) is also suffering from your issue.
+4. If relevant, take the time and see if the [demo site](https://demo.firefly-iii.org/) is also suffering from your
+   issue.
 5. If relevant, read the [documentation](https://docs.firefly-iii.org/).
 
 Please follow these guidelines when opening new issues:
@@ -25,7 +26,8 @@ Only then [create a new issue](https://github.com/firefly-iii/firefly-iii/issues
 ## Issue closure and abandonment policy
 
 - Issues can be converted into discussions if it's not a bug or feature request.
-- Features that won't be implemented will be labelled "wontfix". [This isn't personal](https://docs.firefly-iii.org/firefly-iii/about-firefly-iii/what-its-not/).
+- Features that won't be implemented will be labelled "
+  wontfix". [This isn't personal](https://docs.firefly-iii.org/explanation/more-information/what-its-not/).
 - Issues can be closed if they're duplicates of other issues.
 - Issues can be closed if the answer is in the FAQ.
 - Issues will be closed automatically after 14 days.

.github/workflows/build.yml

@@ -1,22 +0,0 @@
-name: Sonarcloud CI
-on:
-  push:
-    branches:
-      - main
-      - develop
-      - 5.8-dev
-  pull_request:
-    types: [opened, synchronize, reopened]
-jobs:
-  sonarcloud:
-    name: SonarCloud
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.github/workflows/cleanup.yml

@@ -1,10 +1,13 @@
 # This workflow prunes old workflow runs for an entire repository.
 
-name: Prune old builds
+name: "Chore - Prune old builds"
+
+permissions:
+  actions: write
 
 on:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: '0 1 * * *'
   workflow_dispatch:
 jobs:
   prune:
@@ -12,28 +15,28 @@ jobs:
     timeout-minutes: 10
     steps:
       - name: Prune cancelled/skipped runs
-        uses: actions/github-script@v4
+        uses: actions/github-script@v7
         with:
-          github-token: ${{ secrets.GH_ACTIONS_PERSONAL_ACCESS_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
-            const cancelled = await github.actions.listWorkflowRunsForRepo({
+            const cancelled = await github.rest.actions.listWorkflowRunsForRepo({
               owner: context.repo.owner,
               per_page: 100,
               repo: context.repo.repo,
               status: 'cancelled',
             });
-            
-            const skipped = await github.actions.listWorkflowRunsForRepo({
+
+            const skipped = await github.rest.actions.listWorkflowRunsForRepo({
               owner: context.repo.owner,
               per_page: 100,
               repo: context.repo.repo,
               status: 'skipped',
             });
-            
+
             for (const response of [cancelled, skipped]) {
               for (const run of response.data.workflow_runs) {
                 console.log(`Run id ${run.id} of '${run.name}' is a cancelled/skipped run. Deleting...`);
-                await github.actions.deleteWorkflowRun({
+                await github.rest.actions.deleteWorkflowRun({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   run_id: run.id
@@ -42,39 +45,43 @@ jobs:
             }
 
       - name: Prune runs older than 3 days
-        uses: actions/github-script@v4
+        uses: actions/github-script@v7
         with:
-          github-token: ${{ secrets.GH_ACTIONS_PERSONAL_ACCESS_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
             const days_to_expiration = 3;
             const ms_in_day = 86400000;
             const now = Date.now();
             const pages = 5;
-            
+
             // we don't want to prune old runs from test.yml
             // because we track the duration of runs over time
-            
+
             const workflows = [
-              'build.yml',
               'cleanup.yml',
-              'depsreview.yaml',
-              'laravel.yml',
+              'close-duplicates.yml',
+              'closed-issues.yml',
+              'debug-info-actions.yml',
+              'depsreview.yml',
+              'label-actions.yml',
               'lock.yml',
+              'release.yml',
+              'sonarcloud.yml',
               'stale.yml'
             ]
-            
+
             let runs_to_delete = [];
-            
+
             for (const workflow of workflows) {
               for (let page = 0; page < pages; page += 1) {
-                let response = await github.actions.listWorkflowRuns({
+                let response = await github.rest.actions.listWorkflowRuns({
                   owner: context.repo.owner,
                   page: page,
                   per_page: 100,
                   repo: context.repo.repo,
                   workflow_id: workflow
                 });
-            
+
                 if (response.data.workflow_runs.length > 0) {
                   for (const run of response.data.workflow_runs) {
                     if (now - Date.parse(run.created_at) > ms_in_day * days_to_expiration) {
@@ -84,11 +91,11 @@ jobs:
                 }
               }
             }
-            
+
             for (const run of runs_to_delete) {
               console.log(`Run id ${run[0]} of '${run[1]}' is older than ${days_to_expiration} days. Deleting...`);
               try {
-                await github.actions.deleteWorkflowRun({
+                await github.rest.actions.deleteWorkflowRun({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   run_id: run[0]

.github/workflows/close-duplicates.yml

@@ -0,0 +1,39 @@
+name: "Issues - Command to close duplicate issues"
+
+# the workflow to execute on is comments that are newly created
+on:
+  issue_comment:
+    types: [ created ]
+
+permissions:
+  issues: write
+  checks: read
+
+jobs:
+  close_duplicates:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: github/command@v2.0.1
+        id: command
+        with:
+          allowed_contexts: "issue"
+          command: ".duplicate"
+      - name: reply
+        if: ${{ steps.command.outputs.continue == 'true' }}
+        run: |
+
+          ISSUE_TITLE=$(gh issue view ${{ steps.command.outputs.params }} --json title --jq '.title')
+
+          gh issue comment "$NUMBER" --body "Hi there!
+
+          This is an automatic reply. \`Share and enjoy\`.
+
+          Your issue is probably a duplicate of issue <span>#</span>${{ steps.command.outputs.params }}: [$ISSUE_TITLE](https://github.com/firefly-iii/firefly-iii/issues/${{ steps.command.outputs.params }}). Please refer to issue #${{ steps.command.outputs.params }} for support.
+
+          You can close this issue now. If you believe this is not in fact a duplicate, please reply and let us know. Otherwise, this issue will be automatically closed in a few days time.
+
+          Thank you for your contributions."
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          NUMBER: ${{ github.event.issue.number }}

.github/workflows/closed-issues.yml

@@ -1,22 +1,25 @@
-name: "Reply to closed issue"
-on: 
-  issues: 
-    types: 
+---
+name: Issues - Reply to closed issue
+on:
+  issues:
+    types:
       - closed
-jobs: 
-  auto_comment: 
+jobs:
+  command_and_close:
     runs-on: ubuntu-latest
-    steps: 
-      - 
-        uses: aws-actions/closed-issue-message@v1
-        with: 
+    steps:
+      - uses: aws-actions/closed-issue-message@v2
+        with:
           message: |
-              Hi there! This is an automatic reply. `Share and enjoy`
-              
-              This issue is now closed. Please be aware that closed issues are not actively monitored. If you reply, you may get no response.
-                       
-              - If the original bug is not actually fixed, please feel free to open a new ticket. Please refer to this issue for clarity.
-              - Follow-up questions can also be posted in a new [discussion](https://github.com/firefly-iii/firefly-iii/discussions/)
-              
-              Thank you for your consideration.
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+            Hi there! This is an automatic reply. `Share and enjoy`
+
+            This issue is now 🔒 closed. Please be aware that closed issues are not monitored by the developer of Firefly III.
+
+            - If the original bug is not actually fixed, please open [a new issue](https://github.com/firefly-iii/firefly-iii/issues/new/choose). Refer to this issue for clarity.
+            - Follow-up questions must be posted in a new [discussion](https://github.com/firefly-iii/firefly-iii/discussions/)
+            - Further replies to this issue may get no response.
+
+            If there is more to discuss, please open [a new issue](https://github.com/firefly-iii/firefly-iii/issues/new/choose) or [discussion](https://github.com/firefly-iii/firefly-iii/discussions/).
+
+            Thank you for your contributions.
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/debug-info-actions.yml

@@ -0,0 +1,32 @@
+name: 'Issues - Respond to hidden commands'
+
+# the workflow to execute on is comments that are newly created
+on:
+  issues:
+    types: [ opened, edited ]
+  issue_comment:
+    types: [ created ]
+
+# permissions needed for reacting to IssueOps commands on issues and PRs
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write
+  checks: read
+
+jobs:
+  respond:
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          ISSUE_BODY=$(gh issue view $NUMBER --json body)
+          if [[ $ISSUE_BODY == *".eOxNZAmyGz6CXMyf"* ]]; then
+            gh issue comment "$NUMBER" --body "$V2_ISSUE_REPLY_BODY"
+            gh issue close "$NUMBER" --reason completed
+          fi
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          NUMBER: ${{ github.event.issue.number }}
+          V2_ISSUE_REPLY_BODY: ${{ secrets.V2_ISSUE_REPLY_BODY }}
+          LABELS: v2-layout-issue

.github/workflows/depsreview.yaml

@@ -1,14 +0,0 @@
-name: 'Dependency Review'
-on: [pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  dependency-review:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v3
-      - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v1

.github/workflows/depsreview.yml

@@ -0,0 +1,16 @@
+name: 'Code - Dependency review'
+on: [ pull_request ]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: 'Dependency review'
+        uses: actions/dependency-review-action@v4

.github/workflows/label-actions.yml

@@ -0,0 +1,21 @@
+name: 'Issues - Reply to specific labels'
+
+on:
+  issues:
+    types: [ labeled, unlabeled ]
+  pull_request_target:
+    types: [ labeled, unlabeled ]
+  discussion:
+    types: [ labeled, unlabeled ]
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+  discussions: write
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/label-actions@v4

.github/workflows/laravel.yml

@@ -1,146 +0,0 @@
-name: Firefly III
-
-on:
-  push:
-    branches-ignore:
-      - '**'
-
-jobs:
-  prepare:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Copy .env
-        run: test -f .env || cp .ci/.env.ci .env
-      - name: Prepare dependencies
-        run: |
-          set -euxo pipefail
-          export PATH=$PATH:$HOME/.composer/vendor/bin/
-          composer global require hirak/prestissimo --no-plugins --no-scripts
-          composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist --no-suggest
-
-          touch ./storage/database/database.sqlite
-      - name: Prepare Firefly III
-        run: |
-          chmod -R 777 storage bootstrap/cache
-          php artisan migrate --seed
-          php artisan firefly-iii:upgrade-database
-      - name: Upload database
-        uses: actions/upload-artifact@v2
-        with:
-          name: database
-          path: storage/database/database.sqlite
-      - name: Upload cache
-        uses: actions/upload-artifact@v2
-        with:
-          name: cache
-          path: bootstrap/cache/
-      - name: Upload composer cache
-        uses: actions/upload-artifact@v2
-        with:
-          name: composer
-          path: ~/.composer
-
-  laravel-tests:
-
-    runs-on: ubuntu-latest
-
-    needs:
-      - prepare
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Copy .env
-        run: test -f .env || cp .ci/.env.ci .env
-      - name: Download database
-        uses: actions/download-artifact@v2
-        with:
-          name: database
-          path: storage/database/database.sqlite
-      - name: Download cache
-        uses: actions/download-artifact@v2
-        with:
-          name: cache
-          path: bootstrap/cache/
-      - name: Download vendor
-        uses: actions/download-artifact@v2
-        with:
-          name: composer
-          path: ~/.composer
-      - name: Install composer
-        run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist --no-suggest
-
-      - name: PHPUnit tests
-        uses: php-actions/phpunit@v1
-        with:
-          config: phpunit.xml
-          memory: 512M
-
-  coding-standards:
-
-    runs-on: ubuntu-latest
-
-    needs:
-      - prepare
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Copy .env
-        run: test -f .env || cp .ci/.env.ci .env
-      - name: Download database
-        uses: actions/download-artifact@v2
-        with:
-          name: database
-          path: storage/database/database.sqlite
-      - name: Download cache
-        uses: actions/download-artifact@v2
-        with:
-          name: cache
-          path: bootstrap/cache/
-      - name: Download vendor
-        uses: actions/download-artifact@v2
-        with:
-          name: composer
-          path: ~/.composer
-      - name: install depenencies
-        run: |
-          composer global require nette/coding-standard
-          composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist --no-suggest
-
-      - name: Execute code standard
-        run: /home/runner/.composer/vendor/bin/ecs check app tests --config ./.ci/firefly-iii-standard.yml
-
-  phpstan:
-
-    runs-on: ubuntu-latest
-
-    needs:
-      - prepare
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Copy .env
-        run: test -f .env || cp .ci/.env.ci .env
-      - name: Download database
-        uses: actions/download-artifact@v2
-        with:
-          name: database
-          path: storage/database/database.sqlite
-      - name: Download cache
-        uses: actions/download-artifact@v2
-        with:
-          name: cache
-          path: bootstrap/cache/
-      - name: Download vendor
-        uses: actions/download-artifact@v2
-        with:
-          name: composer
-          path: ~/.composer
-      - name: Install depenencies
-        run: |
-          composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist --no-suggest
-
-      - name: Execute PHPStan
-        run: vendor/bin/phpstan analyse -c .ci/phpstan.neon

.github/workflows/lock.yml

@@ -1,21 +1,29 @@
-name: Lock old issues
+name: 'Issues - Lock old issues'
 
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * *'
+    - cron: '0 2 * * *'
+
+concurrency:
+  group: lock-threads
 
 permissions:
-  contents: read
+  issues: write
+  pull-requests: write
+  discussions: write
 
 jobs:
   lock:
     permissions:
-      issues: write  # for dessant/lock-threads to lock issues
-      pull-requests: write  # for dessant/lock-threads to lock PRs
+      issues: write
+      pull-requests: write
+      discussions: write
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/lock-threads@v2
+      - uses: dessant/lock-threads@v5
         with:
-          github-token: ${{ github.token }}
-          issue-lock-inactive-days: '90'
+          issue-inactive-days: 21
+          pr-inactive-days: 21
+          discussion-inactive-days: 21
+          log-output: true

.github/workflows/release.yml

@@ -0,0 +1,521 @@
+name: 'Code - Create new release'
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Release "v1.2.3" or "develop" or "branch-abc"'
+        required: true
+        default: 'develop'
+      phpversion:
+        description: 'PHP version'
+        required: true
+        default: '8.4'
+  schedule:
+    - cron: '0 3 * * MON'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v6
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.PASSPHRASE }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ github.event.inputs.phpversion }}
+          extensions: mbstring, intl, zip, bcmath
+      - name: Switch and pull
+        run: |
+          #
+          # Always check out origin/develop, unless its a branch release.
+          #
+          BRANCH_TO_PULL=origin/develop
+          if [[ "$version" == branch* ]]; then
+            BRANCH_TO_PULL=origin/$version
+          fi
+
+          echo "Version is '$version', check out '$BRANCH_TO_PULL'-branch"
+
+          git checkout --track $BRANCH_TO_PULL
+          git pull
+          echo "Current branch is $(git branch --show-current)"
+        env:
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Configure Git
+        run: |
+          # do some configuration
+          sudo timedatectl set-timezone Europe/Amsterdam
+          git config user.name JC5
+          git config user.email release@firefly-iii.org
+          git config advice.addIgnoredFile false
+          git config push.autoSetupRemote true
+      - name: Lint PHP
+        run: |
+          php_lint_file()
+          {
+              local php_file="$1"
+              php -l "$php_file" &> /dev/null
+              if [ "$?" -ne 0 ]
+              then
+                  echo -e "[FAIL] $php_file"
+                  return 1
+              fi
+          }
+
+          export -f php_lint_file
+
+          find . -path ./vendor -prune -o -name '*.php' | parallel -j 4 php_lint_file {}
+
+          if [ "$?" -ne 0 ]
+          then
+              exit 1
+          fi
+      - name: Crowdin action
+        uses: crowdin/github-action@v2
+        with:
+          upload_sources: true
+          download_translations: true
+          push_translations: false
+          push_sources: false
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+          CROWDIN_PROJECT_NR: ${{ secrets.CROWDIN_PROJECT_NR }}
+          CROWDIN_TOKEN: ${{ secrets.CROWDIN_TOKEN }}
+      - name: Cleanup changelog
+        id: cleanup-changelog
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:changelog'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ${{ secrets.CHANGELOG_TOKEN }}
+      - name: "Create THANKS.md"
+        id: thank-you
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:thank-you'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Replace version
+        id: replace-version
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:version'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ""
+          FF_III_VERSION: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Generate JSON v1
+        id: json-v1
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:json-translations v1'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Generate JSON v2
+        id: json-v2
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:json-translations v2'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Code cleanup
+        id: code-cleanup
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:code'
+          output: ''
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ''
+      - name: Build JS
+        run: |
+          npm install
+          npm run prod  --workspace=v1
+          npm run build --workspace=v2
+          npm update
+      - name: Run CI
+        run: |
+          rm -rf vendor composer.lock
+          composer update --no-dev --no-scripts --no-plugins -q
+          sudo chown -R runner:docker resources/lang
+          .ci/phpcs.sh || true
+      - name: Calculate variables
+        run: |
+
+          # set some variables
+          releaseName=$version
+          originalName=$version
+          zipName=FireflyIII-$version.zip
+          tarName=FireflyIII-$version.tar.gz
+
+          # if this is a develop build, slightly different variable names.
+          if [[ "develop" == "$version" ]]; then
+            #[[ -z $(git status --untracked-files=normal --porcelain) ]] && echo "this branch is clean, no need to push..." && exit 0;
+            releaseName=$version-$(date +'%Y%m%d')
+            originalName=$releaseName
+            zipName=FireflyIII-develop.zip
+            tarName=FireflyIII-develop.tar.gz
+          fi
+
+          # if this is a branch build, also slightly different variable names.
+          if [[ "$version" == branch* ]]; then
+            #[[ -z $(git status --untracked-files=normal --porcelain) ]] && echo "this branch is clean, no need to push..." && exit 0;
+            # branch builds overrule develop
+            releaseName=$version-$(date +'%Y%m%d')
+            originalName=$releaseName
+            zipName=FireflyIII-$version.zip
+            tarName=FireflyIII-$version.tar.gz
+          fi
+
+          # in both cases, if the release or tag already exists, add ".1" until it no longer exists.
+          tagFound=true
+          tagCount=1
+          while [ "$tagFound" = true ]
+          do
+            if [ $(git tag -l "$releaseName") ]; then
+              echo "Tag $releaseName exists already."
+              releaseName="$originalName"."$tagCount"
+              echo "Tag for release is now $releaseName"
+              tagCount=$((tagCount+1))
+            else
+             echo "Tag $releaseName does not exist, can continue"
+             tagFound=false
+            fi
+          done
+
+          # set some variables
+          echo "Release name is $releaseName."
+          echo "Original name is $originalName."
+          echo "Zip name is $zipName."
+          echo "Tar name is $tarName."
+
+          # create a new branch to store the difference in.
+          BRANCH_NAME=release-$(date +'%s')
+          git checkout -b $BRANCH_NAME
+
+          echo "Temporary branch name is '$BRANCH_NAME'."
+
+          # share variables with next step.
+          echo "releaseName=$releaseName" >> "$GITHUB_ENV"
+          echo "originalName=$originalName" >> "$GITHUB_ENV"
+          echo "zipName=$zipName" >> "$GITHUB_ENV"
+          echo "tarName=$tarName" >> "$GITHUB_ENV"
+          echo "BRANCH_NAME=$BRANCH_NAME" >> "$GITHUB_ENV"
+        env:
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Commit all changes
+        run: |
+          # add all content, except output.txt (this contains the changelog and/or the download instructions)
+          echo 'Add all'
+          git add -A
+          # push to a new branch.
+          echo "Auto commit on branch '$(git branch --show-current)'."
+          git commit -m "🤖 Auto commit for release '$version' on $(date +'%Y-%m-%d')" || true
+          git push
+        env:
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Extract changelog
+        id: extract-changelog
+        uses: JC5/firefly-iii-dev@main
+        with:
+          action: 'ff3:extract-changelog'
+          output: 'output'
+        env:
+          FIREFLY_III_ROOT: /github/workspace
+          GH_TOKEN: ""
+      - name: Describe new release
+        run: |
+
+          # describe the development release.
+          if [[ "develop" == "$version" ]]; then
+            echo 'Describe the latest develop release'
+            rm -f output.txt
+            touch output.txt
+            sudo chown -R runner:docker output.txt
+            echo "Weekly development release of Firefly III with the latest fixes, translations and features. Docker users can find this release under the \`develop\` tag." >> output.txt
+            echo "" >> output.txt
+            echo "This release was created on **$(date +'%Y-%m-%d %H:%M')** and may contain unexpected bugs. Data loss is rare but is not impossible. The releases are signed, and you can verify them using the [Firefly III releases PGP key](https://docs.firefly-iii.org/explanation/more-information/signatures/)." >> output.txt
+            echo "" >> output.txt
+            echo "* Please read the installation instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/installation/docker/), [Portainer](https://docs.firefly-iii.org/how-to/firefly-iii/installation/portainer/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/installation/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/installation/self-managed/)" >> output.txt
+            echo "* Or read the upgrade instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/docker/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/self-managed/)" >> output.txt
+            echo "" >> output.txt
+            echo ":warning: Please be careful with this pre-release, as it may not work as expected." >> output.txt
+
+            # donations!
+            echo '' >> output.txt
+            echo '### Support Firefly III' >> output.txt
+            echo 'Did you know you can support the development of Firefly III? You can donate in many ways, like GitHub Sponsors or Patreon. For more information, please [follow this link](https://bit.ly/donate-to-Firefly-III) for more information.' >> output.txt
+            echo '' >> output.txt
+          fi
+          # describe a branch release
+          if [[ "$version" == branch* ]]; then
+            echo 'Describe a branch release'
+            rm -f output.txt
+            touch output.txt
+            sudo chown -R runner:docker output.txt
+            echo "Irregular BRANCH release of Firefly III. This release contains specific features or changes. Docker users can find this release under the \`$version\` tag." >> output.txt
+            echo "" >> output.txt
+            echo "This release was created on **$(date +'%Y-%m-%d %H:%M')** and may contain unexpected bugs. Data loss is rare but is not impossible. The releases are signed, and you can verify them using the [Firefly III releases PGP key](https://docs.firefly-iii.org/explanation/more-information/signatures/)." >> output.txt
+            echo "" >> output.txt
+            echo "* Please read the installation instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/installation/docker/), [Portainer](https://docs.firefly-iii.org/how-to/firefly-iii/installation/portainer/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/installation/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/installation/self-managed/)" >> output.txt
+            echo "* Or read the upgrade instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/docker/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/self-managed/)" >> output.txt
+            echo "" >> output.txt
+            echo ":warning: Please be careful with this branch pre-release, as it may not work as expected." >> output.txt
+          fi
+          # describe the main release
+          if [[ "develop" != "$version" ]] && [[ "$version" != branch* ]] && [[ "$version" != *alpha* ]] && [[ "$version" != *beta* ]]; then
+            echo 'Describe the latest release'
+            sudo chown -R runner:docker output.txt
+
+            # the changelog is in output.txt
+            mv output.txt output2.txt
+
+            touch output.txt
+            echo '' >> output.txt
+            echo "Welcome to release $version of Firefly III. It contains the the latest fixes, translations and features. Docker users can find this release under the \`latest\` tag." >> output.txt
+            echo '' >> output.txt
+
+            # add changelog to file.
+            cat output2.txt >> output.txt
+            echo '' >> output.txt
+            rm -f output2.txt
+
+            echo '### Instructions' >> output.txt
+            echo '' >> output.txt
+            echo "* Installation instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/installation/docker/), [Portainer](https://docs.firefly-iii.org/how-to/firefly-iii/installation/portainer/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/installation/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/installation/self-managed/)" >> output.txt
+            echo "* Or read the upgrade instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/docker/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/self-managed/)" >> output.txt
+            echo "* The releases are signed, and you can verify them using the [Firefly III releases PGP key](https://docs.firefly-iii.org/explanation/more-information/signatures/)." >> output.txt
+
+            # donations!
+            echo '' >> output.txt
+            echo '### Support Firefly III' >> output.txt
+            echo 'Did you know you can support the development of Firefly III? You can donate in many ways, like GitHub Sponsors or Patreon. For more information, please [follow this link](https://bit.ly/donate-to-Firefly-III) for more information.' >> output.txt
+            echo '' >> output.txt
+          fi
+
+          # describe alpha release
+          if [[ "$version" == *alpha* ]]; then
+            echo 'Describe an ALPHA release'
+            rm -f output.txt
+            touch output.txt
+            sudo chown -R runner:docker output.txt
+            echo "Very early ALPHA release of Firefly III. This release contains specific features or changes. Docker users can find this release under the \`$version\` tag." >> output.txt
+            echo '' >> output.txt
+            echo "This release was created on **$(date +'%Y-%m-%d %H:%M')** and may contain unexpected bugs. Data loss is rare but is not impossible. The releases are signed, and you can verify them using the [Firefly III releases PGP key](https://docs.firefly-iii.org/explanation/more-information/signatures/)." >> output.txt
+            echo '' >> output.txt
+            echo '### Instructions' >> output.txt
+            echo '' >> output.txt
+            echo "* Installation instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/installation/docker/), [Portainer](https://docs.firefly-iii.org/how-to/firefly-iii/installation/portainer/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/installation/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/installation/self-managed/)" >> output.txt
+            echo "* Or read the upgrade instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/docker/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/self-managed/)" >> output.txt
+            echo "* The releases are signed, and you can verify them using the [Firefly III releases PGP key](https://docs.firefly-iii.org/explanation/more-information/signatures/)." >> output.txt
+
+          fi
+
+          # describe beta release
+          if [[ "$version" == *beta* ]]; then
+            echo 'Describe a BETA release'
+            rm -f output.txt
+            touch output.txt
+            sudo chown -R runner:docker output.txt
+            echo "Very early BETA release of Firefly III. This release contains specific features or changes. Docker users can find this release under the \`$version\` tag." >> output.txt
+            echo '' >> output.txt
+            echo "This release was created on **$(date +'%Y-%m-%d %H:%M')** and may contain unexpected bugs. Data loss is rare but is not impossible. The releases are signed, and you can verify them using the [Firefly III releases PGP key](https://docs.firefly-iii.org/explanation/more-information/signatures/)." >> output.txt
+            echo '' >> output.txt
+            echo '### Instructions' >> output.txt
+            echo '' >> output.txt
+            echo "* Installation instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/installation/docker/), [Portainer](https://docs.firefly-iii.org/how-to/firefly-iii/installation/portainer/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/installation/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/installation/self-managed/)" >> output.txt
+            echo "* Or read the upgrade instructions for [Docker](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/docker/), [Kubernetes](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/kubernetes/) or [self-managed servers](https://docs.firefly-iii.org/how-to/firefly-iii/upgrade/self-managed/)" >> output.txt
+            echo "* The releases are signed, and you can verify them using the [Firefly III releases PGP key](https://docs.firefly-iii.org/explanation/more-information/signatures/)." >> output.txt
+
+          fi
+        env:
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Merge all into working branch
+        run: |
+          MERGE_INTO=develop
+            if [[ "$version" == branch* ]]; then
+                MERGE_INTO=$version
+            fi
+
+          echo "Merge all changes from $BRANCH_NAME back into '$MERGE_INTO' using a PR"
+          PR_URL=$(gh pr create -B $MERGE_INTO -H $BRANCH_NAME --title "🤖 Automatic PR to merge all changes into the '$MERGE_INTO' branch." --body '🤖 Created by GitHub action')
+          echo "PR URL is '$PR_URL'"
+          IFS='/' read -ra parts <<< "$PR_URL"
+          PR_NR=$(printf %s\\n "${parts[@]:(-1)}")
+          echo "PR number is '$PR_NR'"
+          gh pr merge $PR_NR -b "🤖 Automatically merge the PR into the $MERGE_INTO branch." -d --merge
+
+          # pull the changes from the $MERGE_INTO branch.
+          git checkout $MERGE_INTO
+          git merge origin/$MERGE_INTO
+          git pull
+          git status
+          echo "Current branch '$(git branch --show-current)'."
+
+          if [[ "develop" != "$version" ]] && [[ "$version" != branch* ]]; then
+            git checkout main
+            git merge origin/main
+            git pull
+            git status
+
+            echo "Also merge everything into main since this is a release."
+            echo 'create PR'
+            PR_URL=$(gh pr create -B main -H develop --title "🤖 Automatic PR to merge all changes into the main branch." --body "🤖 Created by GitHub action")
+            echo "PR URL is '$PR_URL'"
+
+            IFS='/' read -ra parts <<< "$PR_URL"
+            PR_NR=$(printf %s\\n "${parts[@]:(-1)}")
+            echo "PR number is '$PR_NR'"
+
+            echo 'Merge PR'
+            gh pr merge $PR_NR -b "🤖 Automatically merge the PR into the main branch." --merge
+            git checkout main
+            git merge origin/main
+            git pull
+            git status
+            echo "Current branch '$(git branch --show-current)'."
+
+          fi
+          echo "DONE!"
+        env:
+          GH_TOKEN: ${{ github.token }}
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Create archives
+        run: |
+          echo "Create zip file $zipName"
+          zip -rq $zipName . -x "*.git*" "*.ci*" "*.github*" "*node_modules*" "*output.txt*" "*Procfile*" "*crowdin.yml*" "*sonar-project.properties*"
+          touch $tarName
+
+          echo "Create tar file $tarName"
+          tar --exclude=$tarName --exclude=$zipName --exclude='./.git' --exclude='./.ci' --exclude='./.github' --exclude='./node_modules' --exclude='./output.txt' --exclude='./Procfile' --exclude='../crowdin.yml' --exclude='./sonar-project.properties' -czf $tarName .
+          # add sha256 sum
+          echo 'Sha sum ...'
+          sha256sum -b $zipName > $zipName.sha256
+          sha256sum -b $tarName > $tarName.sha256
+
+          # add signatures:
+          gpg --armor --detach-sign $zipName
+          gpg --armor --detach-sign $tarName
+      - name: Create release
+        run: |
+
+          # create a development release:
+          if [[ "develop" == "$version" ]]; then
+            # pull the changes from the develop branch.
+            git checkout develop
+            git merge origin/develop
+            git pull
+
+            # create the release:
+            echo "Create develop release under tag '$releaseName'."
+            git tag -a $releaseName -m "🤖 Development release '$version' on $(date +'%Y-%m-%d')"
+            git push origin $releaseName
+
+            gh release create $releaseName -p --verify-tag \
+              -t "Development release for $(date +'%Y-%m-%d')" \
+              --latest=false \
+              -F output.txt
+
+          fi
+
+          # create a branch release:
+          if [[ "$version" == branch* ]]; then
+
+            # pull the changes from the branch-* branch.
+            git checkout $version
+            git merge origin/$version
+            git pull
+
+            # create the release:
+            echo "Create branch release."
+            git tag -a $releaseName -m "Branch release '$version' on $(date +'%Y-%m-%d')"
+            git push origin $releaseName
+
+            gh release create $releaseName -p --verify-tag \
+              -t "Branch release for $(date +'%Y-%m-%d')" \
+              --latest=false \
+              -F output.txt
+
+          fi
+
+          # Create a production release.
+          if [[ "develop" != "$version" ]] && [[ "$version" != branch* ]]; then
+            git checkout main
+            git merge origin/main
+            git pull
+            git status
+
+            echo "Create prod release."
+            git tag -a $releaseName -m "Release $version"
+            git push origin $releaseName
+
+            # do not tag as latest when alpha or beta.
+            if [[ "$version" == *alpha* ]] || [[ "$version" == *beta* ]]; then
+              echo 'Mark alpha or beta as NOT the latest.'
+              gh release create $releaseName -F output.txt -t "$releaseName" --verify-tag --latest=false
+            fi
+
+            # tag as latest when NOT alpha or beta.
+            if [[ "$version" != *alpha* ]] && [[ "$version" != *beta* ]]; then
+              echo 'Mark prod as the latest.'
+              gh release create $releaseName -F output.txt -t "$releaseName" --verify-tag --latest=true
+            fi
+          fi
+        env:
+          GH_TOKEN: ${{ github.token }}
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}
+      - name: Upload artifacts
+        run: |
+          # add zip file to release.
+          echo "Upload $zipName to $releaseName"
+          gh release upload $releaseName $zipName
+          echo "Upload $tarName to $releaseName"
+          gh release upload $releaseName $tarName
+
+          # add sha256 sum to release
+          echo "Upload $zipName.sha256 to $releaseName"
+          gh release upload $releaseName $zipName.sha256
+          echo "Upload $tarName.sha256 to $releaseName"
+          gh release upload $releaseName $tarName.sha256
+
+          # add signatures to release
+          echo "Upload $zipName.asc to $releaseName"
+          gh release upload $releaseName $zipName.asc
+          echo "Upload $tarName.asc to $releaseName"
+          gh release upload $releaseName $tarName.asc
+
+          # get current HEAD and add as file to the release
+          HEAD=$(git rev-parse HEAD)
+          echo $HEAD > HEAD.txt
+          echo "Upload HEAD.txt to $releaseName"
+          gh release upload $releaseName HEAD.txt
+
+          # remove all temporary files
+          rm -f output.txt
+          rm -f HEAD.txt
+          rm -f $zipName
+          rm -f $zipName.sha256
+          rm -f $tarName
+          rm -f $tarName.sha256
+        env:
+          GH_TOKEN: ${{ github.token }}
+          version: ${{ github.event_name == 'schedule' && 'develop' || github.event.inputs.version }}

.github/workflows/stale.yml

@@ -1,7 +1,7 @@
-name: "Close stale issues"
+name: "Issues - Mark and close stale issues"
 on:
   schedule:
-    - cron: "30 1 * * *"
+    - cron: "0 4 * * *"
   workflow_dispatch:
 
 permissions:
@@ -12,19 +12,29 @@ jobs:
     permissions:
       issues: write  # for actions/stale to close stale issues
       pull-requests: write  # for actions/stale to close stale PRs
+      actions: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v6
+      - uses: actions/stale@v9
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-issue-message: >
-            This issue has been automatically marked as stale because it has not had
-            recent activity. It will be closed if no further activity occurs. Thank you
-            for your contributions.
-          stale-pr-message: >
-            This issue has been automatically marked as stale because it has not had
-            recent activity. It will be closed if no further activity occurs. Thank you
-            for your contributions.
+          stale-issue-message: |
+            Hi there!
+
+            This is an automatic reply. `Share and enjoy`
+
+            This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
+
+            Thank you for your contributions.
+          stale-pr-message: |
+            Hi there!
+
+            This is an automatic reply. `Share and enjoy`
+
+            This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.
+
+            Thank you for your contributions.
           days-before-stale: 14
           days-before-close: 7
-          exempt-issue-labels: 'enhancement,feature,bug,announcement,layout-v3'
+          exempt-all-milestones: true
+          exempt-issue-labels: 'triage'

.gitignore

@@ -1,9 +1,30 @@
 /node_modules
-/frontend/node_modules
 /storage/*.key
 /vendor
-/.vagrant
+public/hot
 npm-debug.log
 yarn-error.log
 .env
 /.ci/php-cs-fixer/vendor
+coverage.xml
+output.txt
+
+# ignore generated files.
+public/build
+
+# ignore v1 build files
+resources/assets/v1/node_modules
+resources/assets/v1/build
+public/v1/js/app.js*
+public/v1/js/app_vue.js*
+public/v1/js/create*
+public/v1/js/edit*
+public/v1/js/profile*
+public/v1/js/administrations
+public/v1/js/exchange-rates
+public/v1/js/webhooks
+
+# ignore v2 build files
+resources/assets/v2/node_modules
+resources/assets/v2/build
+public/v2/i18n

.htaccess

@@ -8,7 +8,5 @@
 # To hide directory listing
 Options All -Indexes
 
-# To prevent access to .env and other files
-<Files .*>
-    Deny from all
-</Files>
+# To prevent access any file
+Deny from all

THANKS.md

@@ -0,0 +1,209 @@
+# Thank you! :tada: :heart: :tada:
+
+Over time, many people have contributed to Firefly III. Their efforts are not always visible, but always remembered and appreciated.
+Please find below all the people who contributed to the Firefly III code. Their names are mentioned in the year of their first contribution.
+
+## 2025
+- Denis Iskandarov
+- =
+- Lompi
+- Jose Diaz-Gonzalez
+- SoftBrix
+
+## 2024
+- Sobuno
+- TasneemTantawy
+- Antônio Franco
+- yparitcher
+- Jhon Pedroza
+- mzhubail
+- tasnim
+- withbest
+- Steve Wasiura
+- imlonghao
+- Rahman Yusuf
+- Michael Thomas
+- WardenJakx
+- kuilin
+- Stevie Robinson
+- luzpaz
+- Lemuel Roberto Bonifácio
+- maureenferreira
+
+## 2023
+- tieu1991
+- Maxco10
+- zqye
+- Mateus Pereira
+- josephbadow
+- Christian Desktop
+- Edgars
+- Hannah K
+- noxonad
+- Kaijia Feng
+- Marc Ordinas i Llopis
+- Kuba Turek
+- Julien Stébenne
+
+## 2022
+- Johannes Zellner
+- Janne Heß
+- charlesteets
+- Nathan PERIER
+- Jan Willhaus
+- canoine
+- Rick Cuddy
+- James
+- Hugo Meyronneinc
+- naveen
+- neilnaveen
+- naveensrinivasan
+- Federico Micelli
+- George Hahn
+
+## 2021
+- StillLoading
+- Igor Rzegocki
+- Lorenzo Breda
+- Hosh
+- Flightkick
+- alex6480
+- VREEdom
+- Hamza FADIL
+- Kasper Læssø Sørensen
+- Alex
+- Jeroen De Meerleer
+- Ruben van Erk
+- Fabian Zimmermann
+- Mirko Berger
+- KaihatsuOnline
+- MihataBG
+
+## 2020
+- Hannes Körber
+- Julien Cassagne
+- bu4ak
+- Viktor Yakovlev
+- Oliver Kaufmann
+- Arvind Chembarpu
+- GrayStrider
+- psychowood
+- Hosh Sadiq
+- emansih
+- Aniruddha Maru
+- johnny
+- sephrat
+- bpatath
+- Florian Dupret
+- Maxim Kurbatov
+- Lucas Guima
+- Sandro
+- Ruben Verhoef
+- Daniel Idzerda
+- Calum Smith
+- Agraphie
+- Tomer Shvueli
+- Tomer S
+
+## 2019
+- Pascal Jungblut
+- Justyn Shull
+- Timendum
+- Nicolas Lœuillet
+- Dominic Guhl
+- Melroy van den Berg
+- Henning Stein
+- Jan Klepek
+- Jonathan
+- Geoffrey “Frogeye” Preud'homme
+- Michael Fix
+- Juraj Mlich
+- Eddybrando Vásquez
+- hulloanson
+- Will Rouesnel
+- lastlink
+- Mr. Funk
+- Simon Taddiken
+- Joris
+- Bastiaan Nijkamp
+
+## 2018
+- a1ex4
+- Daniel Quah
+- Marco Lourenço
+- Dennis Enderink
+- Luca Bognolo
+- Mike Conway
+- Ben
+- Mathieu Post
+- George Hertz
+- HamuZ HamuZ
+- David Meiseles
+- Erik Gelderblom
+- Luca Vallerini
+- Clemens Wijnekus
+- Jacob Weisz
+- Mateusz Gozdek
+- anmol26s
+- Kevin Hellemun
+- Shashank M Chakravarthy
+- Nico Schreiner
+- Paul Sohier
+- Brenden Conte
+- Ben Yanke
+- Andrew Prokhorenkov
+- devlearner
+- Kelvin
+- J'informatique
+
+## 2017
+- Victor Mosin
+- Justin
+- Hugo van Duijn
+- Lukas Winkler
+- Marcin Szymanski
+- Jens Kat
+- koziolek
+- jleeong
+- Simon Hanna
+- richard & xeli.eu
+- Sergey Besedin
+- Welbert Serra
+- Joris de Vries
+- Patrick Kostjens
+- Enrico Lamperti
+- Christian Musa
+- Enno Lohmeier
+
+## 2016
+- Sander
+- Toon Schoenmakers
+- Telyn
+- Sander Kleykens
+- Tom van der Werf
+- Matthew Peck
+- Sander Mulders
+- Bonno Nachtegaal-Karels
+- Niek Haarman
+- Edwin
+- Thijs Alkemade
+- zjean
+- Graham Miller
+- Robert Horlings
+- leander091
+
+## 2015
+- Antonio Spinelli
+- Colin O'Dell
+- RonaldvanMeer
+- Richard Ebbers
+- Balazs Varkonyi
+- Niek van der Kooy
+- Ilya Kil
+
+## 2014
+- Stewart Malik
+- Graham Campbell
+
+
+Thank you for all your support!

app.json

@@ -1,65 +0,0 @@
-{
-  "name": "Firefly III",
-  "description": "A free and open source personal finances manager",
-  "repository": "https://github.com/firefly-iii/firefly-iii",
-  "website": "https://firefly-iii.org/",
-  "logo": "https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/public/mstile-150x150.png",
-  "keywords": [
-    "finance",
-    "finances",
-    "manager",
-    "management",
-    "euro",
-    "dollar",
-    "laravel",
-    "money",
-    "currency",
-    "financials",
-    "financial",
-    "budgets",
-    "administration",
-    "tool",
-    "tooling",
-    "help",
-    "helper",
-    "assistant",
-    "planning",
-    "organizing",
-    "bills",
-    "personal finance",
-    "budgets",
-    "budgeting",
-    "budgeting tool",
-    "budgeting application",
-    "transactions",
-    "self hosted",
-    "self-hosted",
-    "transfers",
-    "management"
-  ],
-  "addons": [
-    {
-      "plan": "heroku-postgresql",
-      "options": {
-        "version": "12"
-      }
-    }
-  ],
-  "scripts": {
-    "postdeploy": "php artisan migrate:refresh --seed;php artisan firefly:instructions install"
-  },
-  "buildpacks": [
-    {
-      "url": "heroku/php"
-    },
-    {
-      "url": "https://github.com/heroku/heroku-buildpack-locale"
-    }
-  ],
-  "env": {
-    "APP_KEY": {
-      "description": "This key is used to create app cookies en secure attachments.",
-      "value": "base64:If1gJN4pyycXTq+WS5TjneDympKuu+8SKvTl6RZnhJg="
-    }
-  }
-}

app/Api/V1/Controllers/Autocomplete/AccountController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -25,14 +26,16 @@ namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
+use FireflyIII\Enums\AccountTypeEnum;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
-use FireflyIII\Models\AccountType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\Debug\Timer;
+use FireflyIII\Support\Facades\Steam;
 use FireflyIII\Support\Http\Api\AccountFilter;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
-use JsonException;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class AccountController
@@ -41,6 +44,10 @@ class AccountController extends Controller
 {
     use AccountFilter;
 
+    // this array only exists to test if the constructor will use it properly.
+    protected array $accepts = ['application/json', 'application/vnd.api+json'];
+
+    /** @var array<int, string> */
     private array                      $balanceTypes;
     private AccountRepositoryInterface $repository;
 
@@ -60,65 +67,79 @@ class AccountController extends Controller
                 return $next($request);
             }
         );
-        $this->balanceTypes = [AccountType::ASSET, AccountType::LOAN, AccountType::DEBT, AccountType::MORTGAGE,];
+        $this->balanceTypes = [AccountTypeEnum::ASSET->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::DEBT->value, AccountTypeEnum::MORTGAGE->value];
     }
 
     /**
      * Documentation for this endpoint:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getAccountsAC
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getAccountsAC
      *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
-     * @throws JsonException
      * @throws FireflyException
      * @throws FireflyException
      */
     public function accounts(AutocompleteRequest $request): JsonResponse
     {
-        $data  = $request->getData();
-        $types = $data['types'];
-        $query = $data['query'];
-        $date  = $data['date'] ?? today(config('app.timezone'));
+        $data   = $request->getData();
+        $types  = $data['types'];
+        $query  = $data['query'];
+        $date   = $data['date'] ?? today(config('app.timezone'));
+        $return = [];
+        Timer::start(sprintf('AC accounts "%s"', $query));
+        $result = $this->repository->searchAccount((string) $query, $types, $this->parameters->get('limit'));
 
-        $return          = [];
-        $result          = $this->repository->searchAccount((string) $query, $types, $data['limit']);
-        $defaultCurrency = app('amount')->getDefaultCurrency();
+        // set date to subday + end-of-day for account balance. so it is at $date 23:59:59
+        $date->endOfDay();
 
         /** @var Account $account */
         foreach ($result as $account) {
             $nameWithBalance = $account->name;
-            $currency        = $this->repository->getAccountCurrency($account) ?? $defaultCurrency;
-
+            $currency        = $this->repository->getAccountCurrency($account) ?? $this->nativeCurrency;
+            $useCurrency     = $currency;
             if (in_array($account->accountType->type, $this->balanceTypes, true)) {
-                $balance         = app('steam')->balance($account, $date);
-                $nameWithBalance = sprintf('%s (%s)', $account->name, app('amount')->formatAnything($currency, $balance, false));
+                // this one is correct.
+                Log::debug(sprintf('accounts: Call finalAccountBalance with date/time "%s"', $date->toIso8601String()));
+                $balance         = Steam::finalAccountBalance($account, $date);
+                $key             = $this->convertToNative && $currency->id !== $this->nativeCurrency->id ? 'native_balance' : 'balance';
+                $useCurrency     = $this->convertToNative && $currency->id !== $this->nativeCurrency->id ? $this->nativeCurrency : $currency;
+                $amount          = $balance[$key] ?? '0';
+                $nameWithBalance = sprintf(
+                    '%s (%s)',
+                    $account->name,
+                    app('amount')->formatAnything($useCurrency, $amount, false)
+                );
             }
 
-            $return[] = [
-                'id'                      => (string) $account->id,
-                'name'                    => $account->name,
-                'name_with_balance'       => $nameWithBalance,
-                'type'                    => $account->accountType->type,
-                'currency_id'             => $currency->id,
-                'currency_name'           => $currency->name,
-                'currency_code'           => $currency->code,
-                'currency_symbol'         => $currency->symbol,
-                'currency_decimal_places' => $currency->decimal_places,
+            $return[]        = [
+                'id'                              => (string) $account->id,
+                'name'                            => $account->name,
+                'name_with_balance'               => $nameWithBalance,
+                'type'                            => $account->accountType->type,
+                'currency_id'                     => (string) $useCurrency->id,
+                'currency_name'                   => $useCurrency->name,
+                'currency_code'                   => $useCurrency->code,
+                'currency_symbol'                 => $useCurrency->symbol,
+                'currency_decimal_places'         => $useCurrency->decimal_places,
+                'account_currency_id'             => (string) $currency->id,
+                'account_currency_name'           => $currency->name,
+                'account_currency_code'           => $currency->code,
+                'account_currency_symbol'         => $currency->symbol,
+                'account_currency_decimal_places' => $currency->decimal_places,
             ];
         }
 
         // custom order.
-        $order = [AccountType::ASSET, AccountType::REVENUE, AccountType::EXPENSE];
         usort(
-            $return, function ($a, $b) use ($order) {
-            $pos_a = array_search($a['type'], $order);
-            $pos_b = array_search($b['type'], $order);
+            $return,
+            static function (array $left, array $right) {
+                $order = [AccountTypeEnum::ASSET->value, AccountTypeEnum::REVENUE->value, AccountTypeEnum::EXPENSE->value];
+                $posA  = (int) array_search($left['type'], $order, true);
+                $posB  = (int) array_search($right['type'], $order, true);
 
-            return $pos_a - $pos_b;
-        }
+                return $posA - $posB;
+            }
         );
+        Timer::stop(sprintf('AC accounts "%s"', $query));
 
-        return response()->json($return);
+        return response()->api($return);
     }
 }

app/Api/V1/Controllers/Autocomplete/BillController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * BillController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -57,26 +58,20 @@ class BillController extends Controller
 
     /**
      * Documentation for this endpoint is at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getBillsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getBillsAC
      */
     public function bills(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
-        $result   = $this->repository->searchBill($data['query'], $data['limit']);
+        $result   = $this->repository->searchBill($data['query'], $this->parameters->get('limit'));
         $filtered = $result->map(
-            static function (Bill $item) {
-                return [
-                    'id'   => (string) $item->id,
-                    'name' => $item->name,
-                ];
-            }
+            static fn (Bill $item) => [
+                'id'     => (string) $item->id,
+                'name'   => $item->name,
+                'active' => $item->active,
+            ]
         );
 
-        return response()->json($filtered->toArray());
+        return response()->api($filtered->toArray());
     }
-
 }

app/Api/V1/Controllers/Autocomplete/BudgetController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * BudgetController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -57,25 +58,19 @@ class BudgetController extends Controller
 
     /**
      * Documentation for this endpoint is at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getBudgetsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getBudgetsAC
      */
     public function budgets(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
-        $result   = $this->repository->searchBudget($data['query'], $data['limit']);
+        $result   = $this->repository->searchBudget($data['query'], $this->parameters->get('limit'));
         $filtered = $result->map(
-            static function (Budget $item) {
-                return [
-                    'id'   => (string) $item->id,
-                    'name' => $item->name,
-                ];
-            }
+            static fn (Budget $item) => [
+                'id'   => (string) $item->id,
+                'name' => $item->name,
+            ]
         );
 
-        return response()->json($filtered);
+        return response()->api($filtered->toArray());
     }
 }

app/Api/V1/Controllers/Autocomplete/CategoryController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * CategoryController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -57,25 +58,19 @@ class CategoryController extends Controller
 
     /**
      * Documentation for this endpoint is at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getCategoriesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getCategoriesAC
      */
     public function categories(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
-        $result   = $this->repository->searchCategory($data['query'], $data['limit']);
+        $result   = $this->repository->searchCategory($data['query'], $this->parameters->get('limit'));
         $filtered = $result->map(
-            static function (Category $item) {
-                return [
-                    'id'   => (string) $item->id,
-                    'name' => $item->name,
-                ];
-            }
+            static fn (Category $item) => [
+                'id'   => (string) $item->id,
+                'name' => $item->name,
+            ]
         );
 
-        return response()->json($filtered);
+        return response()->api($filtered->toArray());
     }
 }

app/Api/V1/Controllers/Autocomplete/CurrencyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * CurrencyController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -23,6 +24,7 @@ declare(strict_types=1);
 
 namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
+use Deprecated;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
 use FireflyIII\Models\TransactionCurrency;
@@ -57,16 +59,12 @@ class CurrencyController extends Controller
 
     /**
      * Documentation for this endpoint is at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getCurrenciesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getCurrenciesAC
      */
     public function currencies(AutocompleteRequest $request): JsonResponse
     {
         $data       = $request->getData();
-        $collection = $this->repository->searchCurrency($data['query'], $data['limit']);
+        $collection = $this->repository->searchCurrency($data['query'], $this->parameters->get('limit'));
         $result     = [];
 
         /** @var TransactionCurrency $currency */
@@ -80,22 +78,18 @@ class CurrencyController extends Controller
             ];
         }
 
-        return response()->json($result);
+        return response()->api($result);
     }
 
     /**
      * Documentation for this endpoint is at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getCurrenciesCodeAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
-     * @deprecated
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getCurrenciesCodeAC
      */
+    #[Deprecated]
     public function currenciesWithCode(AutocompleteRequest $request): JsonResponse
     {
         $data       = $request->getData();
-        $collection = $this->repository->searchCurrency($data['query'], $data['limit']);
+        $collection = $this->repository->searchCurrency($data['query'], $this->parameters->get('limit'));
         $result     = [];
 
         /** @var TransactionCurrency $currency */
@@ -109,6 +103,6 @@ class CurrencyController extends Controller
             ];
         }
 
-        return response()->json($result);
+        return response()->api($result);
     }
 }

app/Api/V1/Controllers/Autocomplete/ObjectGroupController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * ObjectGroupController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -57,17 +58,13 @@ class ObjectGroupController extends Controller
 
     /**
      * Documentation for this endpoint is at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getObjectGroupsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getObjectGroupsAC
      */
     public function objectGroups(AutocompleteRequest $request): JsonResponse
     {
         $data   = $request->getData();
         $return = [];
-        $result = $this->repository->search($data['query'], $data['limit']);
+        $result = $this->repository->search($data['query'], $this->parameters->get('limit'));
 
         /** @var ObjectGroup $objectGroup */
         foreach ($result as $objectGroup) {
@@ -78,7 +75,6 @@ class ObjectGroupController extends Controller
             ];
         }
 
-        return response()->json($return);
+        return response()->api($return);
     }
-
 }

app/Api/V1/Controllers/Autocomplete/PiggyBankController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * PiggyBankController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -61,70 +62,68 @@ class PiggyBankController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getPiggiesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getPiggiesAC
      */
     public function piggyBanks(AutocompleteRequest $request): JsonResponse
     {
-        $data            = $request->getData();
-        $piggies         = $this->piggyRepository->searchPiggyBank($data['query'], $data['limit']);
-        $defaultCurrency = app('amount')->getDefaultCurrency();
-        $response        = [];
+        $data     = $request->getData();
+        $piggies  = $this->piggyRepository->searchPiggyBank($data['query'], $this->parameters->get('limit'));
+        $response = [];
 
         /** @var PiggyBank $piggy */
         foreach ($piggies as $piggy) {
-            $currency   = $this->accountRepository->getAccountCurrency($piggy->account) ?? $defaultCurrency;
-            $response[] = [
+            $currency    = $piggy->transactionCurrency;
+            $objectGroup = $piggy->objectGroups()->first();
+            $response[]  = [
                 'id'                      => (string) $piggy->id,
                 'name'                    => $piggy->name,
-                'currency_id'             => $currency->id,
+                'currency_id'             => (string) $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
                 'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
+                'object_group_id'         => null === $objectGroup ? null : (string) $objectGroup->id,
+                'object_group_title'      => $objectGroup?->title,
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getPiggiesBalanceAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getPiggiesBalanceAC
      */
     public function piggyBanksWithBalance(AutocompleteRequest $request): JsonResponse
     {
-        $data            = $request->getData();
-        $piggies         = $this->piggyRepository->searchPiggyBank($data['query'], $data['limit']);
-        $defaultCurrency = app('amount')->getDefaultCurrency();
-        $response        = [];
+        $data     = $request->getData();
+        $piggies  = $this->piggyRepository->searchPiggyBank($data['query'], $this->parameters->get('limit'));
+        $response = [];
+
         /** @var PiggyBank $piggy */
         foreach ($piggies as $piggy) {
-            $currency      = $this->accountRepository->getAccountCurrency($piggy->account) ?? $defaultCurrency;
-            $currentAmount = $this->piggyRepository->getRepetition($piggy)->currentamount ?? '0';
+            $currency      = $piggy->transactionCurrency;
+            $currentAmount = $this->piggyRepository->getCurrentAmount($piggy);
+            $objectGroup   = $piggy->objectGroups()->first();
             $response[]    = [
                 'id'                      => (string) $piggy->id,
                 'name'                    => $piggy->name,
                 'name_with_balance'       => sprintf(
-                    '%s (%s / %s)', $piggy->name, app('amount')->formatAnything($currency, $currentAmount, false),
-                    app('amount')->formatAnything($currency, $piggy->targetamount, false),
+                    '%s (%s / %s)',
+                    $piggy->name,
+                    app('amount')->formatAnything($currency, $currentAmount, false),
+                    app('amount')->formatAnything($currency, $piggy->target_amount, false),
                 ),
-                'currency_id'             => $currency->id,
+                'currency_id'             => (string) $currency->id,
                 'currency_name'           => $currency->name,
                 'currency_code'           => $currency->code,
                 'currency_symbol'         => $currency->symbol,
                 'currency_decimal_places' => $currency->decimal_places,
+                'object_group_id'         => null === $objectGroup ? null : (string) $objectGroup->id,
+                'object_group_title'      => $objectGroup?->title,
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
-
 }

app/Api/V1/Controllers/Autocomplete/RecurrenceController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * RecurrenceController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -45,6 +46,7 @@ class RecurrenceController extends Controller
         $this->middleware(
             function ($request, $next) {
                 $this->repository = app(RecurringRepositoryInterface::class);
+
                 $this->repository->setUser(auth()->user());
 
                 return $next($request);
@@ -54,16 +56,12 @@ class RecurrenceController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getRecurringAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getRecurringAC
      */
     public function recurring(AutocompleteRequest $request): JsonResponse
     {
         $data        = $request->getData();
-        $recurrences = $this->repository->searchRecurrence($data['query'], $data['limit']);
+        $recurrences = $this->repository->searchRecurrence($data['query'], $this->parameters->get('limit'));
         $response    = [];
 
         /** @var Recurrence $recurrence */
@@ -75,7 +73,6 @@ class RecurrenceController extends Controller
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
-
 }

app/Api/V1/Controllers/Autocomplete/RuleController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * RuleController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -54,16 +55,12 @@ class RuleController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getRulesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getRulesAC
      */
     public function rules(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
-        $rules    = $this->repository->searchRule($data['query'], $data['limit']);
+        $rules    = $this->repository->searchRule($data['query'], $this->parameters->get('limit'));
         $response = [];
 
         /** @var Rule $rule */
@@ -75,7 +72,6 @@ class RuleController extends Controller
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
-
 }

app/Api/V1/Controllers/Autocomplete/RuleGroupController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * RuleGroupController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -54,16 +55,12 @@ class RuleGroupController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getRuleGroupsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getRuleGroupsAC
      */
     public function ruleGroups(AutocompleteRequest $request): JsonResponse
     {
         $data     = $request->getData();
-        $groups   = $this->repository->searchRuleGroup($data['query'], $data['limit']);
+        $groups   = $this->repository->searchRuleGroup($data['query'], $this->parameters->get('limit'));
         $response = [];
 
         /** @var RuleGroup $group */
@@ -75,6 +72,6 @@ class RuleGroupController extends Controller
             ];
         }
 
-        return response()->json($response);
+        return response()->api($response);
     }
 }

app/Api/V1/Controllers/Autocomplete/TagController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * TagController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -57,18 +58,14 @@ class TagController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getTagAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTagAC
      */
     public function tags(AutocompleteRequest $request): JsonResponse
     {
-        $data = $request->getData();
-
-        $result = $this->repository->searchTags($data['query'], $data['limit']);
+        $data   = $request->getData();
+        $result = $this->repository->searchTags($data['query'], $this->parameters->get('limit'));
         $array  = [];
+
         /** @var Tag $tag */
         foreach ($result as $tag) {
             $array[] = [
@@ -78,6 +75,6 @@ class TagController extends Controller
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 }

app/Api/V1/Controllers/Autocomplete/TransactionController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * TransactionController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -23,8 +24,10 @@ declare(strict_types=1);
 
 namespace FireflyIII\Api\V1\Controllers\Autocomplete;
 
+use FireflyIII\Models\TransactionGroup;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Autocomplete\AutocompleteRequest;
+use FireflyIII\Enums\UserRoleEnum;
 use FireflyIII\Models\TransactionJournal;
 use FireflyIII\Repositories\Journal\JournalRepositoryInterface;
 use FireflyIII\Repositories\TransactionGroup\TransactionGroupRepositoryInterface;
@@ -37,6 +40,7 @@ use Illuminate\Support\Collection;
  */
 class TransactionController extends Controller
 {
+    protected array $acceptedRoles = [UserRoleEnum::READ_ONLY];
     private TransactionGroupRepositoryInterface $groupRepository;
     private JournalRepositoryInterface          $repository;
 
@@ -50,10 +54,12 @@ class TransactionController extends Controller
             function ($request, $next) {
                 /** @var User $user */
                 $user                  = auth()->user();
+                $userGroup             = $this->validateUserGroup($request);
                 $this->repository      = app(JournalRepositoryInterface::class);
                 $this->groupRepository = app(TransactionGroupRepositoryInterface::class);
                 $this->repository->setUser($user);
                 $this->groupRepository->setUser($user);
+                $this->groupRepository->setUserGroup($userGroup);
 
                 return $next($request);
             }
@@ -62,16 +68,12 @@ class TransactionController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionsAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTransactionsAC
      */
     public function transactions(AutocompleteRequest $request): JsonResponse
     {
-        $data   = $request->getData();
-        $result = $this->repository->searchJournalDescriptions($data['query'], $data['limit']);
+        $data     = $request->getData();
+        $result   = $this->repository->searchJournalDescriptions($data['query'], $this->parameters->get('limit'));
 
         // limit and unique
         $filtered = $result->unique('description');
@@ -87,25 +89,21 @@ class TransactionController extends Controller
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionsIDAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
+     * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTransactionsIDAC
      */
     public function transactionsWithID(AutocompleteRequest $request): JsonResponse
     {
         $data   = $request->getData();
-        $result = new Collection;
+        $result = new Collection();
         if (is_numeric($data['query'])) {
             // search for group, not journal.
             $firstResult = $this->groupRepository->find((int) $data['query']);
-            if (null !== $firstResult) {
+            if ($firstResult instanceof TransactionGroup) {
                 // group may contain multiple journals, each a result:
                 foreach ($firstResult->transactionJournals as $journal) {
                     $result->push($journal);
@@ -113,11 +111,11 @@ class TransactionController extends Controller
             }
         }
         if (!is_numeric($data['query'])) {
-            $result = $this->repository->searchJournalDescriptions($data['query'], $data['limit']);
+            $result = $this->repository->searchJournalDescriptions($data['query'], $this->parameters->get('limit'));
         }
 
         // limit and unique
-        $array = [];
+        $array  = [];
 
         /** @var TransactionJournal $journal */
         foreach ($result as $journal) {
@@ -129,6 +127,6 @@ class TransactionController extends Controller
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 }

app/Api/V1/Controllers/Autocomplete/TransactionTypeController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * TransactionTypeController.php
  * Copyright (c) 2020 james@firefly-iii.org
@@ -53,17 +54,12 @@ class TransactionTypeController extends Controller
 
     /**
      * This endpoint is documented at
-     * https://api-docs.firefly-iii.org/#/autocomplete/getTransactionTypesAC
-     *
-     * @param AutocompleteRequest $request
-     *
-     * @return JsonResponse
-     * @codeCoverageIgnore
+     * * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/autocomplete/getTransactionTypesAC
      */
     public function transactionTypes(AutocompleteRequest $request): JsonResponse
     {
         $data  = $request->getData();
-        $types = $this->repository->searchTypes($data['query'], $data['limit']);
+        $types = $this->repository->searchTypes($data['query'], $this->parameters->get('limit'));
         $array = [];
 
         /** @var TransactionType $type */
@@ -76,6 +72,6 @@ class TransactionTypeController extends Controller
             ];
         }
 
-        return response()->json($array);
+        return response()->api($array);
     }
 }

app/Api/V1/Controllers/Chart/AccountController.php

@@ -24,20 +24,24 @@ declare(strict_types=1);
 
 namespace FireflyIII\Api\V1\Controllers\Chart;
 
+use FireflyIII\Exceptions\ValidationException;
+use FireflyIII\Models\TransactionCurrency;
 use Carbon\Carbon;
 use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Chart\ChartRequest;
 use FireflyIII\Api\V1\Requests\Data\DateRequest;
+use FireflyIII\Enums\AccountTypeEnum;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
-use FireflyIII\Models\AccountType;
+use FireflyIII\Models\Preference;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
-use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
+use FireflyIII\Support\Chart\ChartData;
+use FireflyIII\Support\Facades\Preferences;
+use FireflyIII\Support\Facades\Steam;
 use FireflyIII\Support\Http\Api\ApiSupport;
+use FireflyIII\Support\Http\Api\CollectsAccountsFromFilter;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
-use JsonException;
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
 
 /**
  * Class AccountController
@@ -45,14 +49,13 @@ use Psr\Container\NotFoundExceptionInterface;
 class AccountController extends Controller
 {
     use ApiSupport;
+    use CollectsAccountsFromFilter;
 
-    private CurrencyRepositoryInterface $currencyRepository;
-    private AccountRepositoryInterface  $repository;
+    private ChartData                  $chartData;
+    private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -61,58 +64,119 @@ class AccountController extends Controller
             function ($request, $next) {
                 /** @var User $user */
                 $user             = auth()->user();
+                $this->chartData  = new ChartData();
                 $this->repository = app(AccountRepositoryInterface::class);
                 $this->repository->setUser($user);
 
-                $this->currencyRepository = app(CurrencyRepositoryInterface::class);
-                $this->currencyRepository->setUser($user);
-
                 return $next($request);
             }
         );
     }
 
     /**
-     * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/charts/getChartAccountOverview
+     * TODO fix documentation
      *
-     * @param DateRequest $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
-     * @throws JsonException
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
+     */
+    public function dashboard(ChartRequest $request): JsonResponse
+    {
+        $queryParameters = $request->getParameters();
+        $accounts        = $this->getAccountList($queryParameters);
+
+        // move date to end of day
+        $queryParameters['start']->startOfDay();
+        $queryParameters['end']->endOfDay();
+
+        // loop each account, and collect info:
+        /** @var Account $account */
+        foreach ($accounts as $account) {
+            $this->renderAccountData($queryParameters, $account);
+        }
+
+        return response()->json($this->chartData->render());
+    }
+
+    /**
+     * @throws FireflyException
+     */
+    private function renderAccountData(array $params, Account $account): void
+    {
+        $currency     = $this->repository->getAccountCurrency($account);
+        if (!$currency instanceof TransactionCurrency) {
+            $currency = $this->default;
+        }
+        $currentSet   = [
+            'label'                   => $account->name,
+
+            // the currency that belongs to the account.
+            'currency_id'             => (string) $currency->id,
+            'currency_code'           => $currency->code,
+            'currency_symbol'         => $currency->symbol,
+            'currency_decimal_places' => $currency->decimal_places,
+
+            // the default currency of the user (could be the same!)
+            'date'                    => $params['start']->toAtomString(),
+            'start'                   => $params['start']->toAtomString(),
+            'end'                     => $params['end']->toAtomString(),
+            'period'                  => '1D',
+            'entries'                 => [],
+        ];
+        $currentStart = clone $params['start'];
+        $range        = Steam::finalAccountBalanceInRange($account, $params['start'], clone $params['end'], $this->convertToNative);
+
+        $previous     = array_values($range)[0]['balance'];
+        while ($currentStart <= $params['end']) {
+            $format                        = $currentStart->format('Y-m-d');
+            $label                         = $currentStart->toAtomString();
+            $balance                       = array_key_exists($format, $range) ? $range[$format]['balance'] : $previous;
+            $previous                      = $balance;
+
+            $currentStart->addDay();
+            $currentSet['entries'][$label] = $balance;
+        }
+        $this->chartData->add($currentSet);
+    }
+
+    /**
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/charts/getChartAccountOverview
+     *
+     * @throws ValidationException
      */
     public function overview(DateRequest $request): JsonResponse
     {
         // parameters for chart:
-        $dates = $request->getAll();
+        $dates      = $request->getAll();
+
         /** @var Carbon $start */
-        $start = $dates['start'];
+        $start      = $dates['start'];
+
         /** @var Carbon $end */
-        $end = $dates['end'];
+        $end        = $dates['end'];
+
+        // set dates to end of day + start of day:
+        $start->startOfDay();
+        $end->endOfDay();
 
         // user's preferences
-        $defaultSet = $this->repository->getAccountsByType([AccountType::ASSET])->pluck('id')->toArray();
-        $frontPage  = app('preferences')->get('frontPageAccounts', $defaultSet);
-        $default    = app('amount')->getDefaultCurrency();
+        $defaultSet = $this->repository->getAccountsByType([AccountTypeEnum::ASSET->value])->pluck('id')->toArray();
 
-        if (empty($frontPage->data)) {
-            $frontPage->data = $defaultSet;
-            $frontPage->save();
+        /** @var Preference $frontpage */
+        $frontpage  = Preferences::get('frontpageAccounts', $defaultSet);
+
+        if (!(is_array($frontpage->data) && count($frontpage->data) > 0)) {
+            $frontpage->data = $defaultSet;
+            $frontpage->save();
         }
 
-
         // get accounts:
-        $accounts  = $this->repository->getAccountsById($frontPage->data);
-        $chartData = [];
+        $accounts   = $this->repository->getAccountsById($frontpage->data);
+        $chartData  = [];
+
         /** @var Account $account */
         foreach ($accounts as $account) {
-            $currency = $this->repository->getAccountCurrency($account);
-            if (null === $currency) {
-                $currency = $default;
-            }
+            $currency     = $this->repository->getAccountCurrency($account) ?? $this->nativeCurrency;
+            $field        = $this->convertToNative && $currency->id !== $this->nativeCurrency->id ? 'native_balance' : 'balance';
             $currentSet   = [
                 'label'                   => $account->name,
                 'currency_id'             => (string) $currency->id,
@@ -125,18 +189,19 @@ class AccountController extends Controller
                 'yAxisID'                 => 0, // 0, 1, 2
                 'entries'                 => [],
             ];
+            // TODO this code is also present in the V2 chart account controller so this method is due to be deprecated.
             $currentStart = clone $start;
-            $range        = app('steam')->balanceInRange($account, $start, clone $end);
-            $previous     = $range[0] ?? '0';
+            $range        = Steam::finalAccountBalanceInRange($account, $start, clone $end, $this->convertToNative);
+            $previous     = array_values($range)[0][$field];
             while ($currentStart <= $end) {
-                $format   = $currentStart->format('Y-m-d');
-                $label    = $currentStart->toAtomString();
-                $balance  = array_key_exists($format, $range) ? $range[$format] : $previous;
-                $previous = $balance;
+                $format                        = $currentStart->format('Y-m-d');
+                $label                         = $currentStart->toAtomString();
+                $balance                       = array_key_exists($format, $range) ? $range[$format][$field] : $previous;
+                $previous                      = $balance;
                 $currentStart->addDay();
                 $currentSet['entries'][$label] = $balance;
             }
-            $chartData[] = $currentSet;
+            $chartData[]  = $currentSet;
         }
 
         return response()->json($chartData);

app/Api/V1/Controllers/Chart/BudgetController.php

@@ -0,0 +1,255 @@
+<?php
+
+/*
+ * BudgetController.php
+ * Copyright (c) 2023 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Chart;
+
+use Carbon\Carbon;
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Generic\DateRequest;
+use FireflyIII\Enums\UserRoleEnum;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\Budget;
+use FireflyIII\Models\BudgetLimit;
+use FireflyIII\Models\TransactionCurrency;
+use FireflyIII\Repositories\Budget\BudgetLimitRepositoryInterface;
+use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
+use FireflyIII\Repositories\Budget\OperationsRepositoryInterface;
+use FireflyIII\Support\Http\Api\CleansChartData;
+use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
+
+/**
+ * Class BudgetController
+ */
+class BudgetController extends Controller
+{
+    use CleansChartData;
+    use ValidatesUserGroupTrait;
+
+    protected array $acceptedRoles                      = [UserRoleEnum::READ_ONLY];
+
+    protected OperationsRepositoryInterface $opsRepository;
+    private BudgetLimitRepositoryInterface  $blRepository;
+    private array                           $currencies = [];
+    private TransactionCurrency             $currency;
+    private BudgetRepositoryInterface       $repository;
+
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository    = app(BudgetRepositoryInterface::class);
+                $this->blRepository  = app(BudgetLimitRepositoryInterface::class);
+                $this->opsRepository = app(OperationsRepositoryInterface::class);
+                $userGroup           = $this->validateUserGroup($request);
+                $this->repository->setUserGroup($userGroup);
+                $this->opsRepository->setUserGroup($userGroup);
+                $this->blRepository->setUserGroup($userGroup);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * TODO see autocomplete/accountcontroller
+     */
+    public function dashboard(DateRequest $request): JsonResponse
+    {
+        $params  = $request->getAll();
+
+        /** @var Carbon $start */
+        $start   = $params['start'];
+
+        /** @var Carbon $end */
+        $end     = $params['end'];
+
+        // code from FrontpageChartGenerator, but not in separate class
+        $budgets = $this->repository->getActiveBudgets();
+        $data    = [];
+
+        /** @var Budget $budget */
+        foreach ($budgets as $budget) {
+            // could return multiple arrays, so merge.
+            $data = array_merge($data, $this->processBudget($budget, $start, $end));
+        }
+
+        return response()->json($this->clean($data));
+    }
+
+    /**
+     * @throws FireflyException
+     */
+    private function processBudget(Budget $budget, Carbon $start, Carbon $end): array
+    {
+        // get all limits:
+        $limits = $this->blRepository->getBudgetLimits($budget, $start, $end);
+        $rows   = [];
+
+        // if no limits
+        if (0 === $limits->count()) {
+            // return as a single item in an array
+            $rows = $this->noBudgetLimits($budget, $start, $end);
+        }
+        if ($limits->count() > 0) {
+            $rows = $this->budgetLimits($budget, $limits);
+        }
+        // is always an array
+        $return = [];
+        foreach ($rows as $row) {
+            $current  = [
+                'label'                   => $budget->name,
+                'currency_id'             => (string) $row['currency_id'],
+                'currency_code'           => $row['currency_code'],
+                'currency_name'           => $row['currency_name'],
+                'currency_decimal_places' => $row['currency_decimal_places'],
+                'period'                  => null,
+                'start'                   => $row['start'],
+                'end'                     => $row['end'],
+                'entries'                 => [
+                    'spent'     => $row['spent'],
+                    'left'      => $row['left'],
+                    'overspent' => $row['overspent'],
+                ],
+            ];
+            $return[] = $current;
+        }
+
+        return $return;
+    }
+
+    /**
+     * When no budget limits are present, the expenses of the whole period are collected and grouped.
+     * This is grouped per currency. Because there is no limit set, "left to spend" and "overspent" are empty.
+     *
+     * @throws FireflyException
+     */
+    private function noBudgetLimits(Budget $budget, Carbon $start, Carbon $end): array
+    {
+        $spent = $this->opsRepository->listExpenses($start, $end, null, new Collection([$budget]));
+
+        return $this->processExpenses($budget->id, $spent, $start, $end);
+    }
+
+    /**
+     * Shared between the "noBudgetLimits" function and "processLimit". Will take a single set of expenses and return
+     * its info.
+     *
+     * @param array<int, array<int, string>> $array
+     *
+     * @throws FireflyException
+     */
+    private function processExpenses(int $budgetId, array $array, Carbon $start, Carbon $end): array
+    {
+        $return = [];
+
+        /**
+         * This array contains the expenses in this budget. Grouped per currency.
+         * The grouping is on the main currency only.
+         *
+         * @var int   $currencyId
+         * @var array $block
+         */
+        foreach ($array as $currencyId => $block) {
+            $this->currencies[$currencyId] ??= TransactionCurrency::find($currencyId);
+            $return[$currencyId]           ??= [
+                'currency_id'             => (string) $currencyId,
+                'currency_code'           => $block['currency_code'],
+                'currency_name'           => $block['currency_name'],
+                'currency_symbol'         => $block['currency_symbol'],
+                'currency_decimal_places' => (int) $block['currency_decimal_places'],
+                'start'                   => $start->toAtomString(),
+                'end'                     => $end->toAtomString(),
+                'spent'                   => '0',
+                'left'                    => '0',
+                'overspent'               => '0',
+            ];
+            $currentBudgetArray = $block['budgets'][$budgetId];
+
+            // var_dump($return);
+            /** @var array $journal */
+            foreach ($currentBudgetArray['transaction_journals'] as $journal) {
+                $return[$currencyId]['spent'] = bcadd($return[$currencyId]['spent'], (string) $journal['amount']);
+            }
+        }
+
+        return $return;
+    }
+
+    /**
+     * Function that processes each budget limit (per budget).
+     *
+     * If you have a budget limit in EUR, only transactions in EUR will be considered.
+     * If you have a budget limit in GBP, only transactions in GBP will be considered.
+     *
+     * If you have a budget limit in EUR, and a transaction in GBP, it will not be considered for the EUR budget limit.
+     *
+     * @throws FireflyException
+     */
+    private function budgetLimits(Budget $budget, Collection $limits): array
+    {
+        Log::debug(sprintf('Now in budgetLimits(#%d)', $budget->id));
+        $data = [];
+
+        /** @var BudgetLimit $limit */
+        foreach ($limits as $limit) {
+            $data = array_merge($data, $this->processLimit($budget, $limit));
+        }
+
+        return $data;
+    }
+
+    /**
+     * @throws FireflyException
+     */
+    private function processLimit(Budget $budget, BudgetLimit $limit): array
+    {
+        Log::debug(sprintf('Created new ExchangeRateConverter in %s', __METHOD__));
+        $end             = clone $limit->end_date;
+        $end->endOfDay();
+        $spent           = $this->opsRepository->listExpenses($limit->start_date, $end, null, new Collection([$budget]));
+        $limitCurrencyId = $limit->transaction_currency_id;
+
+        /** @var array $entry */
+        // only spent the entry where the entry's currency matches the budget limit's currency
+        // so $filtered will only have 1 or 0 entries
+        $filtered        = array_filter($spent, fn ($entry) => $entry['currency_id'] === $limitCurrencyId);
+        $result          = $this->processExpenses($budget->id, $filtered, $limit->start_date, $end);
+        if (1 === count($result)) {
+            $compare = bccomp($limit->amount, (string) app('steam')->positive($result[$limitCurrencyId]['spent']));
+            if (1 === $compare) {
+                // convert this amount into the native currency:
+                $result[$limitCurrencyId]['left'] = bcadd($limit->amount, (string) $result[$limitCurrencyId]['spent']);
+            }
+            if ($compare <= 0) {
+                $result[$limitCurrencyId]['overspent'] = app('steam')->positive(bcadd($limit->amount, (string) $result[$limitCurrencyId]['spent']));
+            }
+        }
+
+        return $result;
+    }
+}

app/Api/V1/Controllers/Chart/CategoryController.php

@@ -0,0 +1,126 @@
+<?php
+
+/*
+ * CategoryController.php
+ * Copyright (c) 2023 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Chart;
+
+use Carbon\Carbon;
+use FireflyIII\Api\V2\Controllers\Controller;
+use FireflyIII\Api\V2\Request\Generic\DateRequest;
+use FireflyIII\Enums\AccountTypeEnum;
+use FireflyIII\Enums\TransactionTypeEnum;
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Helpers\Collector\GroupCollectorInterface;
+use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
+use FireflyIII\Support\Http\Api\CleansChartData;
+use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class BudgetController
+ */
+class CategoryController extends Controller
+{
+    use CleansChartData;
+    use ValidatesUserGroupTrait;
+
+    private AccountRepositoryInterface  $accountRepos;
+    private CurrencyRepositoryInterface $currencyRepos;
+
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->accountRepos  = app(AccountRepositoryInterface::class);
+                $this->currencyRepos = app(CurrencyRepositoryInterface::class);
+                $userGroup           = $this->validateUserGroup($request);
+                $this->accountRepos->setUserGroup($userGroup);
+                $this->currencyRepos->setUserGroup($userGroup);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * TODO may be worth to move to a handler but the data is simple enough.
+     * TODO see autoComplete/account controller
+     *
+     * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
+     */
+    public function dashboard(DateRequest $request): JsonResponse
+    {
+        /** @var Carbon $start */
+        $start      = $this->parameters->get('start');
+
+        /** @var Carbon $end */
+        $end        = $this->parameters->get('end');
+        $accounts   = $this->accountRepos->getAccountsByType([AccountTypeEnum::DEBT->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::MORTGAGE->value, AccountTypeEnum::ASSET->value, AccountTypeEnum::DEFAULT->value]);
+        $currencies = [];
+        $return     = [];
+
+        // get journals for entire period:
+        /** @var GroupCollectorInterface $collector */
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setRange($start, $end)->withAccountInformation();
+        $collector->setXorAccounts($accounts)->withCategoryInformation();
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value, TransactionTypeEnum::RECONCILIATION->value]);
+        $journals   = $collector->getExtractedJournals();
+
+        /** @var array $journal */
+        foreach ($journals as $journal) {
+            $currencyId              = (int) $journal['currency_id'];
+            $currency                = $currencies[$currencyId] ?? $this->currencyRepos->find($currencyId);
+            $currencies[$currencyId] = $currency;
+            $categoryName            = $journal['category_name'] ?? (string) trans('firefly.no_category');
+            $amount                  = app('steam')->positive($journal['amount']);
+            $key                     = sprintf('%s-%s', $categoryName, $currency->code);
+            // create arrays
+            $return[$key] ??= [
+                'label'                   => $categoryName,
+                'currency_id'             => (string) $currency->id,
+                'currency_code'           => $currency->code,
+                'currency_name'           => $currency->name,
+                'currency_symbol'         => $currency->symbol,
+                'currency_decimal_places' => $currency->decimal_places,
+                'period'                  => null,
+                'start'                   => $start->toAtomString(),
+                'end'                     => $end->toAtomString(),
+                'amount'                  => '0',
+            ];
+
+            // add monies
+            $return[$key]['amount']  = bcadd($return[$key]['amount'], (string) $amount);
+        }
+        $return     = array_values($return);
+
+        // order by amount
+        usort($return, static fn (array $a, array $b) => (float) $a['amount'] < (float) $b['amount'] ? 1 : -1);
+
+        return response()->json($this->clean($return));
+    }
+}

app/Api/V1/Controllers/Controller.php

@@ -25,31 +25,52 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V1\Controllers;
 
 use Carbon\Carbon;
-use Carbon\Exceptions\InvalidDateException;
 use Carbon\Exceptions\InvalidFormatException;
+use FireflyIII\Exceptions\BadHttpHeaderException;
+use FireflyIII\Models\Preference;
+use FireflyIII\Models\TransactionCurrency;
+use FireflyIII\Support\Facades\Amount;
+use FireflyIII\Support\Facades\Steam;
+use FireflyIII\Support\Http\Api\ValidatesUserGroupTrait;
+use FireflyIII\Transformers\AbstractTransformer;
+use FireflyIII\User;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Routing\Controller as BaseController;
+use Illuminate\Support\Facades\Log;
 use League\Fractal\Manager;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+use League\Fractal\Resource\Item;
 use League\Fractal\Serializer\JsonApiSerializer;
-use Log;
-use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\NotFoundExceptionInterface;
+use Symfony\Component\HttpFoundation\Exception\BadRequestException;
 use Symfony\Component\HttpFoundation\ParameterBag;
 
 /**
  * Class Controller.
  *
- * @codeCoverageIgnore
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
+ * @SuppressWarnings("PHPMD.NumberOfChildren")
  */
 abstract class Controller extends BaseController
 {
-    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+    use AuthorizesRequests;
+    use DispatchesJobs;
+    use ValidatesRequests;
+    use ValidatesUserGroupTrait;
 
-    protected const CONTENT_TYPE = 'application/vnd.api+json';
-    protected array        $allowedSort;
-    protected ParameterBag $parameters;
+    protected const string CONTENT_TYPE            = 'application/vnd.api+json';
+    protected const string JSON_CONTENT_TYPE       = 'application/json';
+    protected array               $accepts         = ['application/json', 'application/vnd.api+json'];
+
+    /** @var array<int, string> */
+    protected array               $allowedSort;
+    protected bool                $convertToNative = false;
+    protected TransactionCurrency $nativeCurrency;
+    protected ParameterBag        $parameters;
 
     /**
      * Controller constructor.
@@ -58,47 +79,68 @@ abstract class Controller extends BaseController
     {
         // get global parameters
         $this->allowedSort = config('firefly.allowed_sort_parameters');
-        $this->parameters  = $this->getParameters();
         $this->middleware(
             function ($request, $next) {
+                $this->parameters = $this->getParameters();
                 if (auth()->check()) {
-                    $language = app('steam')->getLanguage();
+                    $language              = Steam::getLanguage();
+                    $this->convertToNative = Amount::convertToNative();
+                    $this->nativeCurrency  = Amount::getNativeCurrency();
                     app()->setLocale($language);
                 }
 
+
+                // filter down what this endpoint accepts.
+                if (!$request->accepts($this->accepts)) {
+                    throw new BadHttpHeaderException(sprintf('Sorry, Accept header "%s" is not something this endpoint can provide.', $request->header('Accept')));
+                }
+
+
                 return $next($request);
             }
         );
-
     }
 
     /**
      * Method to grab all parameters from the URL.
-     *
-     * @return ParameterBag
-     * @throws ContainerExceptionInterface
-     * @throws NotFoundExceptionInterface
      */
     private function getParameters(): ParameterBag
     {
-        $bag  = new ParameterBag;
-        $page = (int)request()->get('page');
-        if (0 === $page) {
+        $bag      = new ParameterBag();
+        $page     = (int) request()->get('page');
+        if ($page < 1) {
             $page = 1;
         }
+        if ($page > 2 ** 16) {
+            $page = 2 ** 16;
+        }
         $bag->set('page', $page);
 
         // some date fields:
-        $dates = ['start', 'end', 'date'];
+        $dates    = ['start', 'end', 'date'];
         foreach ($dates as $field) {
-            $date = request()->query->get($field);
+            $date = null;
+
+            try {
+                $date = request()->query->get($field);
+            } catch (BadRequestException $e) {
+                Log::error(sprintf('Request field "%s" contains a non-scalar value. Value set to NULL.', $field));
+                Log::error($e->getMessage());
+                Log::error($e->getTraceAsString());
+            }
             $obj  = null;
             if (null !== $date) {
                 try {
-                    $obj = Carbon::parse($date);
-                } catch (InvalidDateException | InvalidFormatException $e) {
+                    $obj = Carbon::parse((string) $date);
+                } catch (InvalidFormatException $e) {
                     // don't care
-                    Log::warning(sprintf('Ignored invalid date "%s" in API controller parameter check: %s', $date, $e->getMessage()));
+                    Log::warning(
+                        sprintf(
+                            'Ignored invalid date "%s" in API controller parameter check: %s',
+                            substr((string) $date, 0, 20),
+                            $e->getMessage()
+                        )
+                    );
                 }
             }
             $bag->set($field, $obj);
@@ -107,9 +149,35 @@ abstract class Controller extends BaseController
         // integer fields:
         $integers = ['limit'];
         foreach ($integers as $integer) {
-            $value = request()->query->get($integer);
+            try {
+                $value = request()->query->get($integer);
+            } catch (BadRequestException $e) {
+                Log::error(sprintf('Request field "%s" contains a non-scalar value. Value set to NULL.', $integer));
+                Log::error($e->getMessage());
+                Log::error($e->getTraceAsString());
+                $value = null;
+            }
             if (null !== $value) {
-                $bag->set($integer, (int)$value);
+                $value = (int) $value;
+                if ($value < 1) {
+                    $value = 1;
+                }
+                if ($value > 2 ** 16) {
+                    $value = 2 ** 16;
+                }
+
+                $bag->set($integer, $value);
+            }
+            if (null === $value
+                && 'limit' === $integer // @phpstan-ignore-line
+                && auth()->check()) {
+                // set default for user:
+                /** @var User $user */
+                $user     = auth()->user();
+
+                /** @var Preference $pageSize */
+                $pageSize = (int) app('preferences')->getForUser($user, 'listPageSize', 50)->data;
+                $bag->set($integer, $pageSize);
             }
         }
 
@@ -117,19 +185,22 @@ abstract class Controller extends BaseController
         return $this->getSortParameters($bag);
     }
 
-    /**
-     * @param ParameterBag $bag
-     *
-     * @return ParameterBag
-     */
     private function getSortParameters(ParameterBag $bag): ParameterBag
     {
         $sortParameters = [];
-        $param          = (string)request()->query->get('sort');
+
+        try {
+            $param = (string) request()->query->get('sort');
+        } catch (BadRequestException $e) {
+            Log::error('Request field "sort" contains a non-scalar value. Value set to NULL.');
+            Log::error($e->getMessage());
+            Log::error($e->getTraceAsString());
+            $param = '';
+        }
         if ('' === $param) {
             return $bag;
         }
-        $parts = explode(',', $param);
+        $parts          = explode(',', $param);
         foreach ($parts as $part) {
             $part      = trim($part);
             $direction = 'asc';
@@ -146,11 +217,8 @@ abstract class Controller extends BaseController
         return $bag;
     }
 
-
     /**
      * Method to help build URL's.
-     *
-     * @return string
      */
     final protected function buildParams(): string
     {
@@ -162,24 +230,63 @@ abstract class Controller extends BaseController
             }
             if ($value instanceof Carbon) {
                 $params[$key] = $value->format('Y-m-d');
+
                 continue;
             }
             $params[$key] = $value;
         }
 
-        return $return . http_build_query($params);
+        return $return.http_build_query($params);
     }
 
-    /**
-     * @return Manager
-     */
     final protected function getManager(): Manager
     {
         // create some objects:
-        $manager = new Manager;
-        $baseUrl = request()->getSchemeAndHttpHost() . '/api/v1';
+        $manager = new Manager();
+        $baseUrl = request()->getSchemeAndHttpHost().'/api/v1';
         $manager->setSerializer(new JsonApiSerializer($baseUrl));
 
         return $manager;
     }
+
+    final protected function jsonApiList(string $key, LengthAwarePaginator $paginator, AbstractTransformer $transformer): array
+    {
+        $manager  = new Manager();
+        $baseUrl  = sprintf('%s/api/v1/', request()->getSchemeAndHttpHost());
+
+        // TODO add stuff to path?
+
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+
+        $objects  = $paginator->getCollection();
+
+        // the transformer, at this point, needs to collect information that ALL items in the collection
+        // require, like meta-data and stuff like that, and save it for later.
+        // $objects  = $transformer->collectMetaData($objects);
+        $paginator->setCollection($objects);
+
+        $resource = new FractalCollection($objects, $transformer, $key);
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return $manager->createData($resource)->toArray();
+    }
+
+    /**
+     * Returns a JSON API object and returns it.
+     *
+     * @param array<int, mixed>|Model $object
+     */
+    final protected function jsonApiObject(string $key, array|Model $object, AbstractTransformer $transformer): array
+    {
+        // create some objects:
+        $manager  = new Manager();
+        $baseUrl  = sprintf('%s/api/v1', request()->getSchemeAndHttpHost());
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+
+        // $transformer->collectMetaData(new Collection([$object]));
+
+        $resource = new Item($object, $transformer, $key);
+
+        return $manager->createData($resource)->toArray();
+    }
 }

app/Api/V1/Controllers/Data/Bulk/TransactionController.php

@@ -44,9 +44,6 @@ class TransactionController extends Controller
 {
     private AccountRepositoryInterface $repository;
 
-    /**
-     *
-     */
     public function __construct()
     {
         parent::__construct();
@@ -62,10 +59,7 @@ class TransactionController extends Controller
 
     /**
      * This endpoint is documented at:
-     *
-     * @param TransactionRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/bulkUpdateTransactions
      */
     public function update(TransactionRequest $request): JsonResponse
     {
@@ -75,12 +69,12 @@ class TransactionController extends Controller
         // this deserves better code, but for now a loop of basic if-statements
         // to respond to what is in the $query.
         // this is OK because only one thing can be in the query at the moment.
-        if ($this->updatesTransactionAccount($params)) {
+        if ($this->isUpdateTransactionAccount($params)) {
             $original    = $this->repository->find((int) $params['where']['account_id']);
             $destination = $this->repository->find((int) $params['update']['account_id']);
 
             /** @var AccountDestroyService $service */
-            $service = app(AccountDestroyService::class);
+            $service     = app(AccountDestroyService::class);
             $service->moveTransactions($original, $destination);
         }
 
@@ -88,13 +82,10 @@ class TransactionController extends Controller
     }
 
     /**
-     * @param array $params
-     *
-     * @return bool
+     * @param array<string, array<string, string>> $params
      */
-    private function updatesTransactionAccount(array $params): bool
+    private function isUpdateTransactionAccount(array $params): bool
     {
         return array_key_exists('account_id', $params['where']) && array_key_exists('account_id', $params['update']);
     }
-
 }

app/Api/V1/Controllers/Data/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * DestroyController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,11 +26,11 @@ namespace FireflyIII\Api\V1\Controllers\Data;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Data\DestroyRequest;
+use FireflyIII\Enums\AccountTypeEnum;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
-use FireflyIII\Models\AccountType;
 use FireflyIII\Models\TransactionJournal;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
 use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
@@ -45,139 +46,66 @@ use FireflyIII\Repositories\Tag\TagRepositoryInterface;
 use FireflyIII\Services\Internal\Destroy\AccountDestroyService;
 use FireflyIII\Services\Internal\Destroy\JournalDestroyService;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class DestroyController
  */
 class DestroyController extends Controller
 {
+    private bool $unused;
+
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/destroyData
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/destroyData
      *
-     * @param DestroyRequest $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function destroy(DestroyRequest $request): JsonResponse
     {
-        $objects = $request->getObjects();
+        $objects         = $request->getObjects();
+        $this->unused    = $request->boolean('unused');
+
+        $allExceptAssets = [AccountTypeEnum::BENEFICIARY->value, AccountTypeEnum::CASH->value, AccountTypeEnum::CREDITCARD->value, AccountTypeEnum::DEFAULT->value, AccountTypeEnum::EXPENSE->value, AccountTypeEnum::IMPORT->value, AccountTypeEnum::INITIAL_BALANCE->value, AccountTypeEnum::LIABILITY_CREDIT->value, AccountTypeEnum::RECONCILIATION->value, AccountTypeEnum::REVENUE->value];
+        $all             = [AccountTypeEnum::ASSET->value, AccountTypeEnum::BENEFICIARY->value, AccountTypeEnum::CASH->value, AccountTypeEnum::CREDITCARD->value, AccountTypeEnum::DEBT->value, AccountTypeEnum::DEFAULT->value, AccountTypeEnum::EXPENSE->value, AccountTypeEnum::IMPORT->value, AccountTypeEnum::INITIAL_BALANCE->value, AccountTypeEnum::LIABILITY_CREDIT->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::MORTGAGE->value, AccountTypeEnum::RECONCILIATION->value];
+        $liabilities     = [AccountTypeEnum::DEBT->value, AccountTypeEnum::LOAN->value, AccountTypeEnum::MORTGAGE->value, AccountTypeEnum::CREDITCARD->value];
+        $transactions    = [TransactionTypeEnum::WITHDRAWAL->value, TransactionTypeEnum::DEPOSIT->value, TransactionTypeEnum::TRANSFER->value, TransactionTypeEnum::RECONCILIATION->value];
+
+        match ($objects) {
+            'budgets'                => $this->destroyBudgets(),
+            'bills'                  => $this->destroyBills(),
+            'piggy_banks'            => $this->destroyPiggyBanks(),
+            'rules'                  => $this->destroyRules(),
+            'recurring'              => $this->destroyRecurringTransactions(),
+            'categories'             => $this->destroyCategories(),
+            'tags'                   => $this->destroyTags(),
+            'object_groups'          => $this->destroyObjectGroups(),
+            'not_assets_liabilities' => $this->destroyAccounts($allExceptAssets),
+            'accounts'               => $this->destroyAccounts($all),
+            'asset_accounts'         => $this->destroyAccounts([AccountTypeEnum::ASSET->value, AccountTypeEnum::DEFAULT->value]),
+            'expense_accounts'       => $this->destroyAccounts([AccountTypeEnum::BENEFICIARY->value, AccountTypeEnum::EXPENSE->value]),
+            'revenue_accounts'       => $this->destroyAccounts([AccountTypeEnum::REVENUE->value]),
+            'liabilities'            => $this->destroyAccounts($liabilities),
+            'transactions'           => $this->destroyTransactions($transactions),
+            'withdrawals'            => $this->destroyTransactions([TransactionTypeEnum::WITHDRAWAL->value]),
+            'deposits'               => $this->destroyTransactions([TransactionTypeEnum::DEPOSIT->value]),
+            'transfers'              => $this->destroyTransactions([TransactionTypeEnum::TRANSFER->value]),
+            default                  => throw new FireflyException(sprintf('200033: This endpoint can\'t handle object "%s"', $objects)),
+        };
 
-        switch ($objects) {
-            default:
-                throw new FireflyException(sprintf('This endpoint can\'t handle object "%s"', $objects));
-            case 'budgets':
-                $this->destroyBudgets();
-                break;
-            case 'bills':
-                $this->destroyBills();
-                break;
-            case 'piggy_banks':
-                $this->destroyPiggyBanks();
-                break;
-            case 'rules':
-                $this->destroyRules();
-                break;
-            case 'recurring':
-                $this->destroyRecurringTransactions();
-                break;
-            case 'categories':
-                $this->destroyCategories();
-                break;
-            case 'tags':
-                $this->destroyTags();
-                break;
-            case 'object_groups':
-                $this->destroyObjectGroups();
-                break;
-            case 'accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::ASSET, AccountType::DEFAULT,
-                        AccountType::BENEFICIARY, AccountType::EXPENSE,
-                        AccountType::REVENUE, AccountType::INITIAL_BALANCE,
-                        AccountType::DEBT, AccountType::LOAN, AccountType::MORTGAGE, AccountType::CREDITCARD,
-                    ]
-                );
-                break;
-            case 'asset_accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::ASSET, AccountType::DEFAULT,
-                    ]
-                );
-                break;
-            case 'expense_accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::BENEFICIARY, AccountType::EXPENSE,
-                    ]
-                );
-                break;
-            case 'revenue_accounts':
-                $this->destroyAccounts(
-                    [
-                        AccountType::REVENUE,
-                    ]
-                );
-                break;
-            case 'liabilities':
-                $this->destroyAccounts(
-                    [
-                        AccountType::DEBT, AccountType::LOAN, AccountType::MORTGAGE, AccountType::CREDITCARD,
-                    ]
-                );
-                break;
-            case 'transactions':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::WITHDRAWAL,
-                        TransactionType::DEPOSIT,
-                        TransactionType::TRANSFER,
-                        TransactionType::RECONCILIATION,
-                        TransactionType::OPENING_BALANCE,
-                    ]
-                );
-                break;
-            case 'withdrawals':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::WITHDRAWAL,
-                    ]
-                );
-                break;
-            case 'deposits':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::DEPOSIT,
-                    ]
-                );
-                break;
-            case 'transfers':
-                $this->destroyTransactions(
-                    [
-                        TransactionType::TRANSFER,
-                    ]
-                );
-                break;
-        }
         app('preferences')->mark();
 
         return response()->json([], 204);
     }
 
-    /**
-     *
-     */
     private function destroyBudgets(): void
     {
         /** @var AvailableBudgetRepositoryInterface $abRepository */
-        $abRepository = app(AvailableBudgetRepositoryInterface::class);
+        $abRepository     = app(AvailableBudgetRepositoryInterface::class);
         $abRepository->destroyAll();
 
         /** @var BudgetLimitRepositoryInterface $blRepository */
-        $blRepository = app(BudgetLimitRepositoryInterface::class);
+        $blRepository     = app(BudgetLimitRepositoryInterface::class);
         $blRepository->destroyAll();
 
         /** @var BudgetRepositoryInterface $budgetRepository */
@@ -185,9 +113,6 @@ class DestroyController extends Controller
         $budgetRepository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyBills(): void
     {
         /** @var BillRepositoryInterface $repository */
@@ -195,9 +120,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyPiggyBanks(): void
     {
         /** @var PiggyBankRepositoryInterface $repository */
@@ -205,9 +127,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyRules(): void
     {
         /** @var RuleGroupRepositoryInterface $repository */
@@ -215,9 +134,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyRecurringTransactions(): void
     {
         /** @var RecurringRepositoryInterface $repository */
@@ -225,9 +141,6 @@ class DestroyController extends Controller
         $repository->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyCategories(): void
     {
         /** @var CategoryRepositoryInterface $categoryRepos */
@@ -235,9 +148,6 @@ class DestroyController extends Controller
         $categoryRepos->destroyAll();
     }
 
-    /**
-     *
-     */
     private function destroyTags(): void
     {
         /** @var TagRepositoryInterface $tagRepository */
@@ -253,7 +163,7 @@ class DestroyController extends Controller
     }
 
     /**
-     * @param array $types
+     * @param array<int, string> $types
      */
     private function destroyAccounts(array $types): void
     {
@@ -261,14 +171,27 @@ class DestroyController extends Controller
         $repository = app(AccountRepositoryInterface::class);
         $collection = $repository->getAccountsByType($types);
         $service    = app(AccountDestroyService::class);
+
         /** @var Account $account */
         foreach ($collection as $account) {
-            $service->destroy($account, null);
+            $count = $account->transactions()->count();
+            if (true === $this->unused && 0 === $count) {
+                Log::info(sprintf('Deleted unused account #%d "%s"', $account->id, $account->name));
+                Log::channel('audit')->info(sprintf('Deleted unused account #%d "%s"', $account->id, $account->name));
+                $service->destroy($account, null);
+
+                continue;
+            }
+            if (false === $this->unused) {
+                Log::info(sprintf('Deleting account #%d "%s"', $account->id, $account->name));
+                Log::channel('audit')->warning(sprintf('Deleted account #%d "%s"', $account->id, $account->name));
+                $service->destroy($account, null);
+            }
         }
     }
 
     /**
-     * @param array $types
+     * @param array<int, string> $types
      */
     private function destroyTransactions(array $types): void
     {
@@ -276,10 +199,10 @@ class DestroyController extends Controller
         $repository = app(JournalRepositoryInterface::class);
         $journals   = $repository->findByType($types);
         $service    = app(JournalDestroyService::class);
+
         /** @var TransactionJournal $journal */
         foreach ($journals as $journal) {
             $service->destroy($journal);
         }
     }
-
 }

app/Api/V1/Controllers/Data/Export/ExportController.php

@@ -29,6 +29,9 @@ use FireflyIII\Api\V1\Requests\Data\Export\ExportRequest;
 use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Support\Export\ExportDataGenerator;
 use Illuminate\Http\Response as LaravelResponse;
+use Safe\Exceptions\DatetimeException;
+
+use function Safe\date;
 
 /**
  * Class ExportController
@@ -55,26 +58,22 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportAccounts
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportAccounts
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function accounts(ExportRequest $request): LaravelResponse
     {
         $this->exporter->setExportAccounts(true);
 
         return $this->returnExport('accounts');
-
     }
 
     /**
-     * @param string $key
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     * @throws DatetimeException
      */
     private function returnExport(string $key): LaravelResponse
     {
@@ -87,25 +86,25 @@ class ExportController extends Controller
         $response
             ->header('Content-Description', 'File Transfer')
             ->header('Content-Type', 'application/octet-stream')
-            ->header('Content-Disposition', 'attachment; filename=' . $fileName)
+            ->header('Content-Disposition', 'attachment; filename='.$fileName)
             ->header('Content-Transfer-Encoding', 'binary')
             ->header('Connection', 'Keep-Alive')
             ->header('Expires', '0')
             ->header('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
             ->header('Pragma', 'public')
-            ->header('Content-Length', (string) strlen($data[$key]));
+            ->header('Content-Length', (string) strlen((string) $data[$key]))
+        ;
 
         return $response;
     }
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportBills
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportBills
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function bills(ExportRequest $request): LaravelResponse
     {
@@ -116,12 +115,11 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportBudgets
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportBudgets
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function budgets(ExportRequest $request): LaravelResponse
     {
@@ -132,12 +130,11 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportCategories
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportCategories
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function categories(ExportRequest $request): LaravelResponse
     {
@@ -148,12 +145,11 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportPiggies
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportPiggies
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function piggyBanks(ExportRequest $request): LaravelResponse
     {
@@ -164,12 +160,11 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportRecurring
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportRecurring
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function recurring(ExportRequest $request): LaravelResponse
     {
@@ -180,12 +175,11 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportRules
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportRules
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function rules(ExportRequest $request): LaravelResponse
     {
@@ -196,12 +190,11 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportTags
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportTags
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
+     *
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function tags(ExportRequest $request): LaravelResponse
     {
@@ -212,11 +205,8 @@ class ExportController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/data/exportTransactions
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/exportTransactions
      *
-     * @param ExportRequest $request
-     *
-     * @return LaravelResponse
      * @throws FireflyException
      */
     public function transactions(ExportRequest $request): LaravelResponse
@@ -229,5 +219,4 @@ class ExportController extends Controller
 
         return $this->returnExport('transactions');
     }
-
 }

app/Api/V1/Controllers/Data/PurgeController.php

@@ -0,0 +1,104 @@
+<?php
+
+/*
+ * PurgeController.php
+ * Copyright (c) 2022 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Data;
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\Account;
+use FireflyIII\Models\Bill;
+use FireflyIII\Models\Budget;
+use FireflyIII\Models\Category;
+use FireflyIII\Models\Recurrence;
+use FireflyIII\Models\Rule;
+use FireflyIII\Models\RuleGroup;
+use FireflyIII\Models\Tag;
+use FireflyIII\Models\TransactionGroup;
+use FireflyIII\Models\TransactionJournal;
+use FireflyIII\Repositories\PiggyBank\PiggyBankRepositoryInterface;
+use FireflyIII\User;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class PurgeController
+ */
+class PurgeController extends Controller
+{
+    /**
+     * TODO cleanup and use repositories.
+     * This endpoint is documented at:
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/data/purgeData
+     */
+    public function purge(): JsonResponse
+    {
+        /** @var User $user */
+        $user       = auth()->user();
+
+        // some manual code, too lazy to call all repositories.
+
+        // budgets:
+        Budget::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // bills
+        Bill::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // piggies
+        $repository = app(PiggyBankRepositoryInterface::class);
+        $repository->setUser($user);
+        $repository->purgeAll();
+        //        $set  = PiggyBank::leftJoin('accounts', 'accounts.id', 'piggy_banks.account_id')
+        //            ->where('accounts.user_id', $user->id)->onlyTrashed()->get(['piggy_banks.*'])
+        //        ;
+        //
+        //        /** @var PiggyBank $piggy */
+        //        foreach ($set as $piggy) {
+        //            $piggy->forceDelete();
+        //        }
+
+        // rule group
+        RuleGroup::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // rules
+        Rule::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // recurring transactions
+        Recurrence::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // categories
+        Category::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // tags
+        Tag::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // accounts
+        Account::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // transaction groups
+        TransactionGroup::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        // transaction journals
+        TransactionJournal::whereUserId($user->id)->onlyTrashed()->forceDelete();
+
+        return response()->json([], 204);
+    }
+}

app/Api/V1/Controllers/Insight/Expense/AccountController.php

@@ -28,12 +28,10 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Repositories\Account\OperationsRepositoryInterface;
-use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
 use FireflyIII\Support\Http\Api\ApiSupport;
 use Illuminate\Http\JsonResponse;
 
 /**
- *
  * Class AccountController
  *
  * Shows expense information grouped or limited by date.
@@ -43,27 +41,21 @@ class AccountController extends Controller
 {
     use ApiSupport;
 
-    private CurrencyRepositoryInterface   $currencyRepository;
     private OperationsRepositoryInterface $opsRepository;
     private AccountRepositoryInterface    $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
         parent::__construct();
         $this->middleware(
             function ($request, $next) {
-                $user             = auth()->user();
-                $this->repository = app(AccountRepositoryInterface::class);
+                $user                = auth()->user();
+                $this->repository    = app(AccountRepositoryInterface::class);
                 $this->repository->setUser($user);
 
-                $this->currencyRepository = app(CurrencyRepositoryInterface::class);
-                $this->currencyRepository->setUser($user);
-
                 $this->opsRepository = app(OperationsRepositoryInterface::class);
                 $this->opsRepository->setUser($user);
 
@@ -74,11 +66,7 @@ class AccountController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseAsset
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseAsset
      */
     public function asset(GenericRequest $request): JsonResponse
     {
@@ -105,11 +93,7 @@ class AccountController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseExpense
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseExpense
      */
     public function expense(GenericRequest $request): JsonResponse
     {
@@ -134,5 +118,4 @@ class AccountController extends Controller
 
         return response()->json($result);
     }
-
 }

app/Api/V1/Controllers/Insight/Expense/BillController.php

@@ -26,10 +26,12 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Bill\BillRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class BillController
@@ -57,21 +59,19 @@ class BillController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseBill
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseBill
      *
      * Expenses per bill, possibly filtered by bill and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function bill(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $bills    = $request->getBills();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $bills           = $request->getBills();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
+        $response        = [];
 
         // get all bills:
         if (0 === $bills->count()) {
@@ -79,40 +79,43 @@ class BillController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->setBills($bills);
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet      = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $billId            = (int) $journal['bill_id'];
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
-            $key               = sprintf('%d-%d', $billId, $currencyId);
-            $foreignKey        = sprintf('%d-%d', $billId, $foreignCurrencyId);
+            $billId       = (int) $journal['bill_id'];
+            $currencyId   = (int) $journal['currency_id'];
+            $currencyCode = $journal['currency_code'];
+            $field        = 'amount';
+
+            // use the native amount if the user wants to convert to native currency
+            if ($convertToNative && $currencyId !== $default->id) {
+                $currencyId   = $default->id;
+                $currencyCode = $default->code;
+                $field        = 'native_amount';
+            }
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToNative && $journal['currency_id'] !== $default->id && $default->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
+            }
+            Log::debug(sprintf('Journal #%d in bill #%d will use %s (%s %s)', $journal['transaction_group_id'], $billId, $field, $currencyCode, $journal[$field] ?? '0'));
+
+            $key          = sprintf('%d-%d', $billId, $currencyId);
 
             if (0 !== $currencyId) {
-                $response[$key]                     = $response[$key] ?? [
-                        'id'               => (string) $billId,
-                        'name'             => $journal['bill_name'],
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$key]['difference']       = bcadd($response[$key]['difference'], $journal['amount']);
+                $response[$key] ??= [
+                    'id'               => (string) $billId,
+                    'name'             => $journal['bill_name'],
+                    'difference'       => '0',
+                    'difference_float' => 0,
+                    'currency_id'      => (string) $currencyId,
+                    'currency_code'    => $currencyCode,
+                ];
+                $response[$key]['difference']       = bcadd($response[$key]['difference'], (string) ($journal[$field] ?? '0'));
                 $response[$key]['difference_float'] = (float) $response[$key]['difference']; // intentional float
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignKey]                     = $response[$foreignKey] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignKey]['difference']       = bcadd($response[$foreignKey]['difference'], $journal['foreign_amount']);
-                $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference']; // intentional float
-            }
         }
 
         return response()->json(array_values($response));
@@ -120,55 +123,55 @@ class BillController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoBill
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseNoBill
      *
      * Expenses for no bill filtered by account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noBill(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
+        $response        = [];
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->withoutBill();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet      = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
+            $currencyId   = (int) $journal['currency_id'];
+            $currencyCode = $journal['currency_code'];
+            $field        = 'amount';
+
+            // use the native amount if the user wants to convert to native currency
+            if ($convertToNative && $currencyId !== $default->id) {
+                $currencyId   = $default->id;
+                $currencyCode = $default->code;
+                $field        = 'native_amount';
+            }
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToNative && $journal['currency_id'] !== $default->id && $default->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
+            }
+            Log::debug(sprintf('Journal #%d will use %s (%s %s)', $journal['transaction_group_id'], $field, $currencyCode, $journal[$field] ?? '0'));
 
             if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $journal['amount']);
+                $response[$currencyId] ??= [
+                    'difference'       => '0',
+                    'difference_float' => 0,
+                    'currency_id'      => (string) $currencyId,
+                    'currency_code'    => $currencyCode,
+                ];
+                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) ($journal[$field] ?? '0'));
                 $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // intentional float
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignCurrencyId]['difference']       = bcadd($response[$foreignCurrencyId]['difference'], $journal['foreign_amount']);
-                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference']; // intentional float
-            }
         }
 
         return response()->json(array_values($response));
     }
-
 }

app/Api/V1/Controllers/Insight/Expense/BudgetController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * BudgetController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -43,8 +44,6 @@ class BudgetController extends Controller
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -66,11 +65,7 @@ class BudgetController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseBudget
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseBudget
      */
     public function budget(GenericRequest $request): JsonResponse
     {
@@ -82,9 +77,11 @@ class BudgetController extends Controller
         if (0 === $budgets->count()) {
             $budgets = $this->repository->getActiveBudgets();
         }
+
         /** @var Budget $budget */
         foreach ($budgets as $budget) {
             $expenses = $this->opsRepository->sumExpenses($start, $end, $assetAccounts, new Collection([$budget]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
@@ -103,11 +100,7 @@ class BudgetController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoBudget
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseNoBudget
      */
     public function noBudget(GenericRequest $request): JsonResponse
     {
@@ -116,6 +109,7 @@ class BudgetController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumExpenses($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
@@ -127,7 +121,5 @@ class BudgetController extends Controller
         }
 
         return response()->json($result);
-
     }
-
 }

app/Api/V1/Controllers/Insight/Expense/CategoryController.php

@@ -44,8 +44,6 @@ class CategoryController extends Controller
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -67,11 +65,7 @@ class CategoryController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferCategory
      */
     public function category(GenericRequest $request): JsonResponse
     {
@@ -83,9 +77,11 @@ class CategoryController extends Controller
         if (0 === $categories->count()) {
             $categories = $this->repository->getCategories();
         }
+
         /** @var Category $category */
         foreach ($categories as $category) {
             $expenses = $this->opsRepository->sumExpenses($start, $end, $assetAccounts, new Collection([$category]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
@@ -104,11 +100,7 @@ class CategoryController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferNoCategory
      */
     public function noCategory(GenericRequest $request): JsonResponse
     {
@@ -117,6 +109,7 @@ class CategoryController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumExpenses($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
@@ -128,6 +121,5 @@ class CategoryController extends Controller
         }
 
         return response()->json($result);
-
     }
 }

app/Api/V1/Controllers/Insight/Expense/PeriodController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * PeriodController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,62 +26,68 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class PeriodController
  */
 class PeriodController extends Controller
 {
-
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseTotal
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseTotal
      */
     public function total(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $response        = [];
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
 
         // collect all expenses in this period (regardless of type)
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
-        $genericSet = $collector->getExtractedJournals();
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
+        $genericSet      = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
+            // same code as many other sumExpense methods. I think this needs some kind of generic method.
+            $amount                                    = '0';
+            $currencyId                                = (int) $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            if ($convertToNative) {
+                $amount = Amount::getAmountFromJournal($journal);
+                if ($default->id !== (int) $journal['currency_id'] && $default->id !== (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $default->id;
+                    $currencyCode = $default->code;
+                }
+                if ($default->id !== (int) $journal['currency_id'] && $default->id === (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $journal['foreign_currency_id'];
+                    $currencyCode = $journal['foreign_currency_code'];
+                }
+                Log::debug(sprintf('[a] Add amount %s %s', $currencyCode, $amount));
+            }
+            if (!$convertToNative) {
+                // ignore the amount in foreign currency.
+                Log::debug(sprintf('[b] Add amount %s %s', $currencyCode, $journal['amount']));
+                $amount = $journal['amount'];
+            }
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $journal['amount']);
-                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // intentional float
-            }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignCurrencyId]['difference']       = bcadd($response[$foreignCurrencyId]['difference'], $journal['foreign_amount']);
-                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference']; // intentional float
-            }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $amount);
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // intentional float
         }
 
         return response()->json(array_values($response));
     }
-
 }

app/Api/V1/Controllers/Insight/Expense/TagController.php

@@ -26,10 +26,12 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Expense;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 
 /**
  * Class TagController
@@ -56,52 +58,57 @@ class TagController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseNoTag
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseNoTag
      *
      * Expenses for no tag filtered by account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noTag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $response        = [];
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->withoutTags();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet      = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
+            // same code as many other sumExpense methods. I think this needs some kind of generic method.
+            $amount                                    = '0';
+            $currencyId                                = (int) $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            if ($convertToNative) {
+                $amount = Amount::getAmountFromJournal($journal);
+                if ($default->id !== (int) $journal['currency_id'] && $default->id !== (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $default->id;
+                    $currencyCode = $default->code;
+                }
+                if ($default->id !== (int) $journal['currency_id'] && $default->id === (int) $journal['foreign_currency_id']) {
+                    $currencyId   = $journal['foreign_currency_id'];
+                    $currencyCode = $journal['foreign_currency_code'];
+                }
+                Log::debug(sprintf('[a] Add amount %s %s', $currencyCode, $amount));
+            }
+            if (!$convertToNative) {
+                // ignore the amount in foreign currency.
+                Log::debug(sprintf('[b] Add amount %s %s', $currencyCode, $journal['amount']));
+                $amount = $journal['amount'];
+            }
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $journal['amount']);
-                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
-            }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignCurrencyId]['difference']       = bcadd($response[$foreignCurrencyId]['difference'], $journal['foreign_amount']);
-                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
-            }
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], $amount);
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // float but on purpose.
         }
 
         return response()->json(array_values($response));
@@ -109,21 +116,17 @@ class TagController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightExpenseTag
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightExpenseTag
      *
      * Expenses per tag, possibly filtered by tag and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function tag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $tags     = $request->getTags();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts   = $request->getAssetAccounts();
+        $tags       = $request->getTags();
+        $start      = $request->getStart();
+        $end        = $request->getEnd();
+        $response   = [];
 
         // get all tags:
         if (0 === $tags->count()) {
@@ -131,10 +134,11 @@ class TagController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::WITHDRAWAL])->setRange($start, $end)->setSourceAccounts($accounts);
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::WITHDRAWAL->value])->setRange($start, $end)->setSourceAccounts($accounts);
         $collector->setTags($tags);
         $genericSet = $collector->getExtractedJournals();
+
         /** @var array $journal */
         foreach ($genericSet as $journal) {
             $currencyId        = (int) $journal['currency_id'];
@@ -148,33 +152,32 @@ class TagController extends Controller
 
                 // on currency ID
                 if (0 !== $currencyId) {
-                    $response[$key]                     = $response[$key] ?? [
-                            'id'               => (string) $tagId,
-                            'name'             => $tag['name'],
-                            'difference'       => '0',
-                            'difference_float' => 0,
-                            'currency_id'      => (string) $currencyId,
-                            'currency_code'    => $journal['currency_code'],
-                        ];
-                    $response[$key]['difference']       = bcadd($response[$key]['difference'], $journal['amount']);
-                    $response[$key]['difference_float'] = (float) $response[$key]['difference'];
+                    $response[$key] ??= [
+                        'id'               => (string) $tagId,
+                        'name'             => $tag['name'],
+                        'difference'       => '0',
+                        'difference_float' => 0,
+                        'currency_id'      => (string) $currencyId,
+                        'currency_code'    => $journal['currency_code'],
+                    ];
+                    $response[$key]['difference']       = bcadd((string) $response[$key]['difference'], (string) $journal['amount']);
+                    $response[$key]['difference_float'] = (float) $response[$key]['difference']; // float but on purpose.
                 }
 
                 // on foreign ID
                 if (0 !== $foreignCurrencyId) {
                     $response[$foreignKey]                     = $journal[$foreignKey] ?? [
-                            'difference'       => '0',
-                            'difference_float' => 0,
-                            'currency_id'      => (string) $foreignCurrencyId,
-                            'currency_code'    => $journal['foreign_currency_code'],
-                        ];
-                    $response[$foreignKey]['difference']       = bcadd($response[$foreignKey]['difference'], $journal['foreign_amount']);
-                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference'];
+                        'difference'       => '0',
+                        'difference_float' => 0,
+                        'currency_id'      => (string) $foreignCurrencyId,
+                        'currency_code'    => $journal['foreign_currency_code'],
+                    ];
+                    $response[$foreignKey]['difference']       = bcadd((string) $response[$foreignKey]['difference'], (string) $journal['foreign_amount']);
+                    $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference']; // float but on purpose.
                 }
             }
         }
 
         return response()->json(array_values($response));
     }
-
 }

app/Api/V1/Controllers/Insight/Income/AccountController.php

@@ -28,42 +28,34 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Repositories\Account\OperationsRepositoryInterface;
-use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
 use FireflyIII\Support\Http\Api\ApiSupport;
 use Illuminate\Http\JsonResponse;
 
 /**
- *
  * Class AccountController
  *
  * Shows income information grouped or limited by date.
- * Ie. all income grouped by account + currency.
+ * I.e. all income grouped by account + currency.
  */
 class AccountController extends Controller
 {
     use ApiSupport;
 
-    private CurrencyRepositoryInterface   $currencyRepository;
     private OperationsRepositoryInterface $opsRepository;
     private AccountRepositoryInterface    $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
         parent::__construct();
         $this->middleware(
             function ($request, $next) {
-                $user             = auth()->user();
-                $this->repository = app(AccountRepositoryInterface::class);
+                $user                = auth()->user();
+                $this->repository    = app(AccountRepositoryInterface::class);
                 $this->repository->setUser($user);
 
-                $this->currencyRepository = app(CurrencyRepositoryInterface::class);
-                $this->currencyRepository->setUser($user);
-
                 $this->opsRepository = app(OperationsRepositoryInterface::class);
                 $this->opsRepository->setUser($user);
 
@@ -74,26 +66,24 @@ class AccountController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightIncomeAsset
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeAsset
      */
     public function asset(GenericRequest $request): JsonResponse
     {
         $start         = $request->getStart();
         $end           = $request->getEnd();
         $assetAccounts = $request->getAssetAccounts();
+
         $income        = $this->opsRepository->sumIncomeByDestination($start, $end, $assetAccounts);
         $result        = [];
+
         /** @var array $entry */
         foreach ($income as $entry) {
             $result[] = [
                 'id'               => (string) $entry['id'],
                 'name'             => $entry['name'],
                 'difference'       => $entry['sum'],
-                'difference_float' => (float) $entry['sum'],
+                'difference_float' => (float) $entry['sum'], // float but on purpose.
                 'currency_id'      => (string) $entry['currency_id'],
                 'currency_code'    => $entry['currency_code'],
             ];
@@ -104,11 +94,7 @@ class AccountController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightIncomeRevenue
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeRevenue
      */
     public function revenue(GenericRequest $request): JsonResponse
     {
@@ -125,7 +111,7 @@ class AccountController extends Controller
                 'id'               => (string) $entry['id'],
                 'name'             => $entry['name'],
                 'difference'       => $entry['sum'],
-                'difference_float' => (float) $entry['sum'],
+                'difference_float' => (float) $entry['sum'], // float but on purpose.
                 'currency_id'      => (string) $entry['currency_id'],
                 'currency_code'    => $entry['currency_code'],
             ];
@@ -133,5 +119,4 @@ class AccountController extends Controller
 
         return response()->json($result);
     }
-
 }

app/Api/V1/Controllers/Insight/Income/CategoryController.php

@@ -44,8 +44,6 @@ class CategoryController extends Controller
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -67,11 +65,7 @@ class CategoryController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightIncomeCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeCategory
      */
     public function category(GenericRequest $request): JsonResponse
     {
@@ -83,16 +77,18 @@ class CategoryController extends Controller
         if (0 === $categories->count()) {
             $categories = $this->repository->getCategories();
         }
+
         /** @var Category $category */
         foreach ($categories as $category) {
             $expenses = $this->opsRepository->sumIncome($start, $end, $assetAccounts, new Collection([$category]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
                     'id'               => (string) $category->id,
                     'name'             => $category->name,
                     'difference'       => $expense['sum'],
-                    'difference_float' => (float) $expense['sum'],
+                    'difference_float' => (float) $expense['sum'], // float but on purpose.
                     'currency_id'      => (string) $expense['currency_id'],
                     'currency_code'    => $expense['currency_code'],
                 ];
@@ -104,11 +100,7 @@ class CategoryController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightIncomeNoCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeNoCategory
      */
     public function noCategory(GenericRequest $request): JsonResponse
     {
@@ -117,17 +109,17 @@ class CategoryController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumIncome($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
                 'difference'       => $expense['sum'],
-                'difference_float' => (float) $expense['sum'],
+                'difference_float' => (float) $expense['sum'], // float but on purpose.
                 'currency_id'      => (string) $expense['currency_id'],
                 'currency_code'    => $expense['currency_code'],
             ];
         }
 
         return response()->json($result);
-
     }
 }

app/Api/V1/Controllers/Insight/Income/PeriodController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * PeriodController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,8 +26,9 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Income;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -34,55 +36,49 @@ use Illuminate\Http\JsonResponse;
  */
 class PeriodController extends Controller
 {
-
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightIncomeTotal
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeTotal
      */
     public function total(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $response        = [];
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
 
         // collect all expenses in this period (regardless of type)
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::DEPOSIT])->setRange($start, $end)->setDestinationAccounts($accounts);
-        $genericSet = $collector->getExtractedJournals();
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::DEPOSIT->value])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $genericSet      = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToNative && $currencyId !== $default->id ? 'native_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+            // perhaps use default currency instead?
+            if ($convertToNative && $journal['currency_id'] !== $default->id) {
+                $currencyId   = $default->id;
+                $currencyCode = $default->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'], app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToNative && $journal['currency_id'] !== $default->id && $default->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference']; // float but on purpose.
         }
 
         return response()->json(array_values($response));
     }
-
 }

app/Api/V1/Controllers/Insight/Income/TagController.php

@@ -26,9 +26,10 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Income;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -57,54 +58,51 @@ class TagController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightIncomeTag
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeTag
      *
      * Expenses for no tag filtered by account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function noTag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $response        = [];
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::DEPOSIT])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::DEPOSIT->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->withoutTags();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet      = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToNative && $currencyId !== $default->id ? 'native_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+            // perhaps use default currency instead?
+            if ($convertToNative && $journal['currency_id'] !== $default->id) {
+                $currencyId   = $default->id;
+                $currencyCode = $default->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'], app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToNative && $journal['currency_id'] !== $default->id && $default->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+
         }
 
         return response()->json(array_values($response));
@@ -112,21 +110,17 @@ class TagController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightIncomeNoTag
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightIncomeNoTag
      *
      * Expenses per tag, possibly filtered by tag and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function tag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $tags     = $request->getTags();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts   = $request->getAssetAccounts();
+        $tags       = $request->getTags();
+        $start      = $request->getStart();
+        $end        = $request->getEnd();
+        $response   = [];
 
         // get all tags:
         if (0 === $tags->count()) {
@@ -134,10 +128,11 @@ class TagController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::DEPOSIT])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::DEPOSIT->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->setTags($tags);
         $genericSet = $collector->getExtractedJournals();
+
         /** @var array $journal */
         foreach ($genericSet as $journal) {
             $currencyId        = (int) $journal['currency_id'];
@@ -151,28 +146,29 @@ class TagController extends Controller
 
                 // on currency ID
                 if (0 !== $currencyId) {
-                    $response[$key]                     = $response[$key] ?? [
-                            'id'               => (string) $tagId,
-                            'name'             => $tag['name'],
-                            'difference'       => '0',
-                            'difference_float' => 0,
-                            'currency_id'      => (string) $currencyId,
-                            'currency_code'    => $journal['currency_code'],
-                        ];
-                    $response[$key]['difference']       = bcadd($response[$key]['difference'], app('steam')->positive($journal['amount']));
+                    $response[$key] ??= [
+                        'id'               => (string) $tagId,
+                        'name'             => $tag['name'],
+                        'difference'       => '0',
+                        'difference_float' => 0,
+                        'currency_id'      => (string) $currencyId,
+                        'currency_code'    => $journal['currency_code'],
+                    ];
+                    $response[$key]['difference']       = bcadd((string) $response[$key]['difference'], (string) app('steam')->positive($journal['amount']));
                     $response[$key]['difference_float'] = (float) $response[$key]['difference'];
                 }
 
                 // on foreign ID
                 if (0 !== $foreignCurrencyId) {
                     $response[$foreignKey]                     = $journal[$foreignKey] ?? [
-                            'difference'       => '0',
-                            'difference_float' => 0,
-                            'currency_id'      => (string) $foreignCurrencyId,
-                            'currency_code'    => $journal['foreign_currency_code'],
-                        ];
+                        'difference'       => '0',
+                        'difference_float' => 0,
+                        'currency_id'      => (string) $foreignCurrencyId,
+                        'currency_code'    => $journal['foreign_currency_code'],
+                    ];
                     $response[$foreignKey]['difference']       = bcadd(
-                        $response[$foreignKey]['difference'], app('steam')->positive($journal['foreign_amount'])
+                        (string) $response[$foreignKey]['difference'],
+                        (string) app('steam')->positive($journal['foreign_amount'])
                     );
                     $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference'];
                 }
@@ -181,5 +177,4 @@ class TagController extends Controller
 
         return response()->json(array_values($response));
     }
-
 }

app/Api/V1/Controllers/Insight/Transfer/AccountController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * AccountController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -40,8 +41,6 @@ class AccountController extends Controller
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -59,11 +58,7 @@ class AccountController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransfers
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransfers
      */
     public function asset(GenericRequest $request): JsonResponse
     {

app/Api/V1/Controllers/Insight/Transfer/CategoryController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * CategoryController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -43,8 +44,6 @@ class CategoryController extends Controller
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -66,11 +65,7 @@ class CategoryController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransferCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferCategory
      */
     public function category(GenericRequest $request): JsonResponse
     {
@@ -82,9 +77,11 @@ class CategoryController extends Controller
         if (0 === $categories->count()) {
             $categories = $this->repository->getCategories();
         }
+
         /** @var Category $category */
         foreach ($categories as $category) {
             $expenses = $this->opsRepository->sumTransfers($start, $end, $assetAccounts, new Collection([$category]));
+
             /** @var array $expense */
             foreach ($expenses as $expense) {
                 $result[] = [
@@ -103,11 +100,7 @@ class CategoryController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoCategory
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferNoCategory
      */
     public function noCategory(GenericRequest $request): JsonResponse
     {
@@ -116,6 +109,7 @@ class CategoryController extends Controller
         $assetAccounts = $request->getAssetAccounts();
         $result        = [];
         $expenses      = $this->noRepository->sumTransfers($start, $end, $assetAccounts);
+
         /** @var array $expense */
         foreach ($expenses as $expense) {
             $result[] = [
@@ -127,6 +121,5 @@ class CategoryController extends Controller
         }
 
         return response()->json($result);
-
     }
 }

app/Api/V1/Controllers/Insight/Transfer/PeriodController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * PeriodController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,8 +26,9 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Transfer;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -34,55 +36,50 @@ use Illuminate\Http\JsonResponse;
  */
 class PeriodController extends Controller
 {
-
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransferTotal
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferTotal
      */
     public function total(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $response        = [];
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
 
         // collect all expenses in this period (regardless of type)
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::TRANSFER])->setRange($start, $end)->setDestinationAccounts($accounts);
-        $genericSet = $collector->getExtractedJournals();
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::TRANSFER->value])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $genericSet      = $collector->getExtractedJournals();
         foreach ($genericSet as $journal) {
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToNative && $currencyId !== $default->id ? 'native_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+            // perhaps use default currency instead?
+            if ($convertToNative && $journal['currency_id'] !== $default->id) {
+                $currencyId   = $default->id;
+                $currencyCode = $default->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'], app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToNative && $journal['currency_id'] !== $default->id && $default->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+
         }
 
         return response()->json(array_values($response));
     }
-
 }

app/Api/V1/Controllers/Insight/Transfer/TagController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * TagController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -25,9 +26,10 @@ namespace FireflyIII\Api\V1\Controllers\Insight\Transfer;
 
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Insight\GenericRequest;
+use FireflyIII\Enums\TransactionTypeEnum;
 use FireflyIII\Helpers\Collector\GroupCollectorInterface;
-use FireflyIII\Models\TransactionType;
 use FireflyIII\Repositories\Tag\TagRepositoryInterface;
+use FireflyIII\Support\Facades\Amount;
 use Illuminate\Http\JsonResponse;
 
 /**
@@ -56,52 +58,50 @@ class TagController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransferNoTag
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferNoTag
      */
     public function noTag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts        = $request->getAssetAccounts();
+        $start           = $request->getStart();
+        $end             = $request->getEnd();
+        $response        = [];
+        $convertToNative = Amount::convertToNative();
+        $default         = Amount::getNativeCurrency();
+
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::TRANSFER])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector       = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::TRANSFER->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->withoutTags();
 
-        $genericSet = $collector->getExtractedJournals();
+        $genericSet      = $collector->getExtractedJournals();
 
         foreach ($genericSet as $journal) {
-            $currencyId        = (int) $journal['currency_id'];
-            $foreignCurrencyId = (int) $journal['foreign_currency_id'];
+            // currency
+            $currencyId                                = $journal['currency_id'];
+            $currencyCode                              = $journal['currency_code'];
+            $field                                     = $convertToNative && $currencyId !== $default->id ? 'native_amount' : 'amount';
 
-            if (0 !== $currencyId) {
-                $response[$currencyId]                     = $response[$currencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $currencyId,
-                        'currency_code'    => $journal['currency_code'],
-                    ];
-                $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], app('steam')->positive($journal['amount']));
-                $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+            // perhaps use default currency instead?
+            if ($convertToNative && $journal['currency_id'] !== $default->id) {
+                $currencyId   = $default->id;
+                $currencyCode = $default->code;
             }
-            if (0 !== $foreignCurrencyId) {
-                $response[$foreignCurrencyId]                     = $response[$foreignCurrencyId] ?? [
-                        'difference'       => '0',
-                        'difference_float' => 0,
-                        'currency_id'      => (string) $foreignCurrencyId,
-                        'currency_code'    => $journal['foreign_currency_code'],
-                    ];
-                $response[$foreignCurrencyId]['difference']       = bcadd(
-                    $response[$foreignCurrencyId]['difference'], app('steam')->positive($journal['foreign_amount'])
-                );
-                $response[$foreignCurrencyId]['difference_float'] = (float) $response[$foreignCurrencyId]['difference'];
+            // use foreign amount when the foreign currency IS the default currency.
+            if ($convertToNative && $journal['currency_id'] !== $default->id && $default->id === $journal['foreign_currency_id']) {
+                $field = 'foreign_amount';
             }
+
+            $response[$currencyId] ??= [
+                'difference'       => '0',
+                'difference_float' => 0,
+                'currency_id'      => (string) $currencyId,
+                'currency_code'    => $currencyCode,
+            ];
+            $response[$currencyId]['difference']       = bcadd($response[$currencyId]['difference'], (string) app('steam')->positive($journal[$field]));
+            $response[$currencyId]['difference_float'] = (float) $response[$currencyId]['difference'];
+
         }
 
         return response()->json(array_values($response));
@@ -109,21 +109,17 @@ class TagController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/insight/insightTransferTag
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/insight/insightTransferTag
      *
      * Transfers per tag, possibly filtered by tag and account.
-     *
-     * @param GenericRequest $request
-     *
-     * @return JsonResponse
      */
     public function tag(GenericRequest $request): JsonResponse
     {
-        $accounts = $request->getAssetAccounts();
-        $tags     = $request->getTags();
-        $start    = $request->getStart();
-        $end      = $request->getEnd();
-        $response = [];
+        $accounts   = $request->getAssetAccounts();
+        $tags       = $request->getTags();
+        $start      = $request->getStart();
+        $end        = $request->getEnd();
+        $response   = [];
 
         // get all tags:
         if (0 === $tags->count()) {
@@ -131,10 +127,11 @@ class TagController extends Controller
         }
 
         // collect all expenses in this period (regardless of type) by the given bills and accounts.
-        $collector = app(GroupCollectorInterface::class);
-        $collector->setTypes([TransactionType::TRANSFER])->setRange($start, $end)->setDestinationAccounts($accounts);
+        $collector  = app(GroupCollectorInterface::class);
+        $collector->setTypes([TransactionTypeEnum::TRANSFER->value])->setRange($start, $end)->setDestinationAccounts($accounts);
         $collector->setTags($tags);
         $genericSet = $collector->getExtractedJournals();
+
         /** @var array $journal */
         foreach ($genericSet as $journal) {
             $currencyId        = (int) $journal['currency_id'];
@@ -148,28 +145,29 @@ class TagController extends Controller
 
                 // on currency ID
                 if (0 !== $currencyId) {
-                    $response[$key]                     = $response[$key] ?? [
-                            'id'               => (string) $tagId,
-                            'name'             => $tag['name'],
-                            'difference'       => '0',
-                            'difference_float' => 0,
-                            'currency_id'      => (string) $currencyId,
-                            'currency_code'    => $journal['currency_code'],
-                        ];
-                    $response[$key]['difference']       = bcadd($response[$key]['difference'], app('steam')->positive($journal['amount']));
+                    $response[$key] ??= [
+                        'id'               => (string) $tagId,
+                        'name'             => $tag['name'],
+                        'difference'       => '0',
+                        'difference_float' => 0,
+                        'currency_id'      => (string) $currencyId,
+                        'currency_code'    => $journal['currency_code'],
+                    ];
+                    $response[$key]['difference']       = bcadd((string) $response[$key]['difference'], (string) app('steam')->positive($journal['amount']));
                     $response[$key]['difference_float'] = (float) $response[$key]['difference'];
                 }
 
                 // on foreign ID
                 if (0 !== $foreignCurrencyId) {
                     $response[$foreignKey]                     = $journal[$foreignKey] ?? [
-                            'difference'       => '0',
-                            'difference_float' => 0,
-                            'currency_id'      => (string) $foreignCurrencyId,
-                            'currency_code'    => $journal['foreign_currency_code'],
-                        ];
+                        'difference'       => '0',
+                        'difference_float' => 0,
+                        'currency_id'      => (string) $foreignCurrencyId,
+                        'currency_code'    => $journal['foreign_currency_code'],
+                    ];
                     $response[$foreignKey]['difference']       = bcadd(
-                        $response[$foreignKey]['difference'], app('steam')->positive($journal['foreign_amount'])
+                        (string) $response[$foreignKey]['difference'],
+                        (string) app('steam')->positive($journal['foreign_amount'])
                     );
                     $response[$foreignKey]['difference_float'] = (float) $response[$foreignKey]['difference']; // intentional float
                 }

app/Api/V1/Controllers/Models/Account/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -33,14 +34,12 @@ use Illuminate\Http\JsonResponse;
  */
 class DestroyController extends Controller
 {
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -57,14 +56,9 @@ class DestroyController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/deleteAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/deleteAccount
      *
      * Remove the specified resource from storage.
-     *
-     * @param Account $account
-     *
-     * @codeCoverageIgnore
-     * @return JsonResponse
      */
     public function destroy(Account $account): JsonResponse
     {

app/Api/V1/Controllers/Models/Account/ListController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -29,6 +30,7 @@ use FireflyIII\Helpers\Collector\GroupCollectorInterface;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\TransactionFilter;
+use FireflyIII\Support\JsonApi\Enrichments\TransactionGroupEnrichment;
 use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\Transformers\PiggyBankTransformer;
 use FireflyIII\Transformers\TransactionGroupTransformer;
@@ -47,14 +49,12 @@ class ListController extends Controller
 {
     use TransactionFilter;
 
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -71,32 +71,28 @@ class ListController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/listAttachmentByAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/listAttachmentByAccount
      *
-     * @param Account $account
-     *
-     * @return JsonResponse
-     * @codeCoverageIgnore
      * @throws FireflyException
      */
     public function attachments(Account $account): JsonResponse
     {
-        $manager    = $this->getManager();
-        $pageSize   = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
-        $collection = $this->repository->getAttachments($account);
+        $manager     = $this->getManager();
+        $pageSize    = $this->parameters->get('limit');
+        $collection  = $this->repository->getAttachments($account);
 
         $count       = $collection->count();
         $attachments = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.accounts.attachments', [$account->id]) . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.accounts.attachments', [$account->id]).$this->buildParams());
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($attachments, $transformer, 'attachments');
+        $resource    = new FractalCollection($attachments, $transformer, 'attachments');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -104,91 +100,83 @@ class ListController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/listPiggyBankByAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/listPiggyBankByAccount
      *
-     * @param Account $account
-     *
-     * @return JsonResponse
      * @throws FireflyException
-     * @codeCoverageIgnore
      */
     public function piggyBanks(Account $account): JsonResponse
     {
         // create some objects:
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize    = $this->parameters->get('limit');
 
-        // get list of budgets. Count it and split it.
-        $collection = $this->repository->getPiggyBanks($account);
-        $count      = $collection->count();
-        $piggyBanks = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        // get list of piggy banks. Count it and split it.
+        $collection  = $this->repository->getPiggyBanks($account);
+        $count       = $collection->count();
+        $piggyBanks  = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($piggyBanks, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.accounts.piggy_banks', [$account->id]) . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($piggyBanks, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.accounts.piggy-banks', [$account->id]).$this->buildParams());
 
         /** @var PiggyBankTransformer $transformer */
         $transformer = app(PiggyBankTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($piggyBanks, $transformer, 'piggy_banks');
+        $resource    = new FractalCollection($piggyBanks, $transformer, 'piggy_banks');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
-
     }
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/listTransactionByAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/listTransactionByAccount
      *
      * Show all transaction groups related to the account.
      *
-     * @codeCoverageIgnore
-     *
-     * @param Request $request
-     * @param Account $account
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function transactions(Request $request, Account $account): JsonResponse
     {
-        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
-        $type     = $request->get('type') ?? 'default';
+        $pageSize     = $this->parameters->get('limit');
+        $type         = $request->get('type') ?? 'default';
         $this->parameters->set('type', $type);
+        $types        = $this->mapTransactionTypes($this->parameters->get('type'));
+        $manager      = $this->getManager();
 
-        // user can overrule page size with limit parameter.
-        $limit = $this->parameters->get('limit');
-        if (null !== $limit && $limit > 0) {
-            $pageSize = $limit;
-        }
-        $types   = $this->mapTransactionTypes($this->parameters->get('type'));
-        $manager = $this->getManager();
         /** @var User $admin */
-        $admin = auth()->user();
+        $admin        = auth()->user();
 
         // use new group collector:
         /** @var GroupCollectorInterface $collector */
-        $collector = app(GroupCollectorInterface::class);
+        $collector    = app(GroupCollectorInterface::class);
         $collector->setUser($admin)->setAccounts(new Collection([$account]))
-                  ->withAPIInformation()->setLimit($pageSize)->setPage($this->parameters->get('page'))->setTypes($types);
+            ->withAPIInformation()->setLimit($pageSize)->setPage($this->parameters->get('page'))->setTypes($types)
+        ;
 
-        if (null !== $this->parameters->get('start') && null !== $this->parameters->get('end')) {
-            $collector->setRange($this->parameters->get('start'), $this->parameters->get('end'));
+        if (null !== $this->parameters->get('start')) {
+            $collector->setStart($this->parameters->get('start'));
+        }
+        if (null !== $this->parameters->get('end')) {
+            $collector->setEnd($this->parameters->get('end'));
         }
 
-        $paginator = $collector->getPaginatedGroups();
-        $paginator->setPath(route('api.v1.accounts.transactions', [$account->id]) . $this->buildParams());
-        $groups = $paginator->getCollection();
+        $paginator    = $collector->getPaginatedGroups();
+        $paginator->setPath(route('api.v1.accounts.transactions', [$account->id]).$this->buildParams());
+
+        // enrich
+        $enrichment   = new TransactionGroupEnrichment();
+        $enrichment->setUser($admin);
+        $transactions = $enrichment->enrich($paginator->getCollection());
 
         /** @var TransactionGroupTransformer $transformer */
-        $transformer = app(TransactionGroupTransformer::class);
+        $transformer  = app(TransactionGroupTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($groups, $transformer, 'transactions');
+        $resource     = new FractalCollection($transactions, $transformer, 'transactions');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);

app/Api/V1/Controllers/Models/Account/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -28,7 +29,9 @@ use FireflyIII\Exceptions\FireflyException;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
 use FireflyIII\Support\Http\Api\AccountFilter;
+use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
 use FireflyIII\Transformers\AccountTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Pagination\LengthAwarePaginator;
@@ -43,14 +46,12 @@ class ShowController extends Controller
 {
     use AccountFilter;
 
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -67,45 +68,47 @@ class ShowController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/listAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/listAccount
      *
      * Display a listing of the resource.
      *
-     * @param Request $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
-     * @codeCoverageIgnore
      */
     public function index(Request $request): JsonResponse
     {
-        $manager = $this->getManager();
-        $type    = $request->get('type') ?? 'all';
+        $manager     = $this->getManager();
+        $type        = $request->get('type') ?? 'all';
         $this->parameters->set('type', $type);
 
         // types to get, page size:
-        $types    = $this->mapAccountTypes($this->parameters->get('type'));
-        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $types       = $this->mapAccountTypes($this->parameters->get('type'));
+        $pageSize    = $this->parameters->get('limit');
 
         // get list of accounts. Count it and split it.
         $this->repository->resetAccountOrder();
-        $collection = $this->repository->getAccountsByType($types, $this->parameters->get('sort') ?? []);
-        $count      = $collection->count();
+        $collection  = $this->repository->getAccountsByType($types, $this->parameters->get('sort') ?? []);
+        $count       = $collection->count();
 
         // continue sort:
+        $accounts    = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
-
-        $accounts = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new AccountEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setNative($this->nativeCurrency);
+        $accounts    = $enrichment->enrich($accounts);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($accounts, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.accounts.index') . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($accounts, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.accounts.index').$this->buildParams());
 
         /** @var AccountTransformer $transformer */
         $transformer = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($accounts, $transformer, self::RESOURCE_KEY);
+        $resource    = new FractalCollection($accounts, $transformer, self::RESOURCE_KEY);
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -113,27 +116,31 @@ class ShowController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/getAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/getAccount
      *
      * Show single instance.
-     *
-     * @param Account $account
-     *
-     * @return JsonResponse
      */
     public function show(Account $account): JsonResponse
     {
         // get list of accounts. Count it and split it.
         $this->repository->resetAccountOrder();
         $account->refresh();
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new AccountEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setNative($this->nativeCurrency);
+        $account     = $enrichment->enrichSingle($account);
+
 
         /** @var AccountTransformer $transformer */
         $transformer = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new Item($account, $transformer, self::RESOURCE_KEY);
+        $resource    = new Item($account, $transformer, self::RESOURCE_KEY);
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
-
 }

app/Api/V1/Controllers/Models/Account/StoreController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -26,7 +27,9 @@ namespace FireflyIII\Api\V1\Controllers\Models\Account;
 use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\Account\StoreRequest;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
 use FireflyIII\Transformers\AccountTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use League\Fractal\Resource\Item;
 
@@ -35,14 +38,12 @@ use League\Fractal\Resource\Item;
  */
 class StoreController extends Controller
 {
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -59,28 +60,31 @@ class StoreController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/storeAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/storeAccount
      *
      * Store a new instance.
-     *
-     * @param StoreRequest $request
-     *
-     * @return JsonResponse
      */
     public function store(StoreRequest $request): JsonResponse
     {
-        $data = $request->getAllAccountData();
+        $data        = $request->getAllAccountData();
         $this->repository->resetAccountOrder();
-        $account = $this->repository->store($data);
-        $manager = $this->getManager();
+        $account     = $this->repository->store($data);
+        $manager     = $this->getManager();
+
+        // enrich
+        /** @var User $admin */
+        $admin       = auth()->user();
+        $enrichment  = new AccountEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setNative($this->nativeCurrency);
+        $account     = $enrichment->enrichSingle($account);
 
         /** @var AccountTransformer $transformer */
         $transformer = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($account, $transformer, self::RESOURCE_KEY);
+        $resource    = new Item($account, $transformer, self::RESOURCE_KEY);
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
-
 }

app/Api/V1/Controllers/Models/Account/UpdateController.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * AccountController.php
  * Copyright (c) 2019 james@firefly-iii.org
@@ -27,25 +28,24 @@ use FireflyIII\Api\V1\Controllers\Controller;
 use FireflyIII\Api\V1\Requests\Models\Account\UpdateRequest;
 use FireflyIII\Models\Account;
 use FireflyIII\Repositories\Account\AccountRepositoryInterface;
+use FireflyIII\Support\JsonApi\Enrichments\AccountEnrichment;
 use FireflyIII\Transformers\AccountTransformer;
+use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 use League\Fractal\Resource\Item;
-use Log;
-use Preferences;
 
 /**
  * Class UpdateController
  */
 class UpdateController extends Controller
 {
-    public const RESOURCE_KEY = 'accounts';
+    public const string RESOURCE_KEY = 'accounts';
 
     private AccountRepositoryInterface $repository;
 
     /**
      * AccountController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -62,29 +62,32 @@ class UpdateController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/accounts/updateAccount
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/accounts/updateAccount
      *
      * Update account.
-     *
-     * @param UpdateRequest $request
-     * @param Account       $account
-     *
-     * @return JsonResponse
      */
     public function update(UpdateRequest $request, Account $account): JsonResponse
     {
         Log::debug(sprintf('Now in %s', __METHOD__));
         $data         = $request->getUpdateData();
-        $data['type'] = config('firefly.shortNamesByFullName.' . $account->accountType->type);
+        $data['type'] = config('firefly.shortNamesByFullName.'.$account->accountType->type);
         $account      = $this->repository->update($account, $data);
         $manager      = $this->getManager();
         $account->refresh();
-        Preferences::mark();
+        app('preferences')->mark();
+
+        // enrich
+        /** @var User $admin */
+        $admin        = auth()->user();
+        $enrichment   = new AccountEnrichment();
+        $enrichment->setUser($admin);
+        $enrichment->setNative($this->nativeCurrency);
+        $account      = $enrichment->enrichSingle($account);
 
         /** @var AccountTransformer $transformer */
-        $transformer = app(AccountTransformer::class);
+        $transformer  = app(AccountTransformer::class);
         $transformer->setParameters($this->parameters);
-        $resource = new Item($account, $transformer, self::RESOURCE_KEY);
+        $resource     = new Item($account, $transformer, self::RESOURCE_KEY);
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Attachment/DestroyController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * DestroyController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -29,6 +30,8 @@ use FireflyIII\Models\Attachment;
 use FireflyIII\Repositories\Attachment\AttachmentRepositoryInterface;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class DestroyController
@@ -39,8 +42,6 @@ class DestroyController extends Controller
 
     /**
      * DestroyController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -60,18 +61,18 @@ class DestroyController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/attachments/deleteAttachment
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/deleteAttachment
      *
      * Remove the specified resource from storage.
-     *
-     * @codeCoverageIgnore
-     *
-     * @param Attachment $attachment
-     *
-     * @return JsonResponse
      */
     public function destroy(Attachment $attachment): JsonResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+
         $this->repository->destroy($attachment);
         app('preferences')->mark();
 

app/Api/V1/Controllers/Models/Attachment/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -33,9 +34,11 @@ use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Response as LaravelResponse;
 use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Facades\Log;
 use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 use League\Fractal\Resource\Collection as FractalCollection;
 use League\Fractal\Resource\Item;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class ShowController
@@ -46,8 +49,6 @@ class ShowController extends Controller
 
     /**
      * ShowController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -67,18 +68,19 @@ class ShowController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/attachments/downloadAttachment
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/downloadAttachment
      *
      * Download an attachment.
      *
-     * @param Attachment $attachment
-     *
-     * @codeCoverageIgnore
-     * @return LaravelResponse
-     * @throws   FireflyException
+     * @throws FireflyException
      */
     public function download(Attachment $attachment): LaravelResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
         if (false === $attachment->uploaded) {
             throw new FireflyException('200000: File has not been uploaded (yet).');
         }
@@ -86,46 +88,52 @@ class ShowController extends Controller
             throw new FireflyException('200000: File has not been uploaded (yet).');
         }
         if ($this->repository->exists($attachment)) {
-            $content = $this->repository->getContent($attachment);
+            $content  = $this->repository->getContent($attachment);
             if ('' === $content) {
                 throw new FireflyException('200002: File is empty (zero bytes).');
             }
-            $quoted = sprintf('"%s"', addcslashes(basename($attachment->filename), '"\\'));
+            $quoted   = sprintf('"%s"', addcslashes(basename($attachment->filename), '"\\'));
 
             /** @var LaravelResponse $response */
             $response = response($content);
             $response
                 ->header('Content-Description', 'File Transfer')
                 ->header('Content-Type', 'application/octet-stream')
-                ->header('Content-Disposition', 'attachment; filename=' . $quoted)
+                ->header('Content-Disposition', 'attachment; filename='.$quoted)
                 ->header('Content-Transfer-Encoding', 'binary')
                 ->header('Connection', 'Keep-Alive')
                 ->header('Expires', '0')
                 ->header('Cache-Control', 'must-revalidate, post-check=0, pre-check=0')
                 ->header('Pragma', 'public')
-                ->header('Content-Length', (string) strlen($content));
+                ->header('Content-Length', (string) strlen($content))
+            ;
 
             return $response;
         }
+
         throw new FireflyException('200003: File does not exist.');
     }
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/attachments/listAttachment
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/listAttachment
      *
      * Display a listing of the resource.
      *
-     * @return JsonResponse
      * @throws FireflyException
-     * @codeCoverageIgnore
      */
     public function index(): JsonResponse
     {
-        $manager = $this->getManager();
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+
+        $manager     = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize    = $this->parameters->get('limit');
 
         // get list of attachments. Count it and split it.
         $collection  = $this->repository->get();
@@ -133,14 +141,14 @@ class ShowController extends Controller
         $attachments = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.attachments.index') . $this->buildParams());
+        $paginator   = new LengthAwarePaginator($attachments, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.attachments.index').$this->buildParams());
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($attachments, $transformer, 'attachments');
+        $resource    = new FractalCollection($attachments, $transformer, 'attachments');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -148,22 +156,24 @@ class ShowController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/attachments/getAttachment
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/getAttachment
      *
      * Display the specified resource.
-     *
-     * @param Attachment $attachment
-     *
-     * @return JsonResponse
      */
     public function show(Attachment $attachment): JsonResponse
     {
-        $manager = $this->getManager();
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+        $manager     = $this->getManager();
+
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($attachment, $transformer, 'attachments');
+        $resource    = new Item($attachment, $transformer, 'attachments');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/Attachment/StoreController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * StoreController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -34,8 +35,9 @@ use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Log;
 use League\Fractal\Resource\Item;
-use Log;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class StoreController
@@ -46,8 +48,6 @@ class StoreController extends Controller
 
     /**
      * StoreController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -67,43 +67,44 @@ class StoreController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/attachments/uploadAttachment
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/uploadAttachment
      *
      * Store a newly created resource in storage.
      *
-     * @param StoreRequest $request
-     *
-     * @return JsonResponse
      * @throws FireflyException
      */
     public function store(StoreRequest $request): JsonResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
         Log::debug(sprintf('Now in %s', __METHOD__));
-        $data       = $request->getAll();
-        $attachment = $this->repository->store($data);
-        $manager    = $this->getManager();
+        $data        = $request->getAll();
+        $attachment  = $this->repository->store($data);
+        $manager     = $this->getManager();
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($attachment, $transformer, 'attachments');
+        $resource    = new Item($attachment, $transformer, 'attachments');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
 
     /**
      * Upload an attachment.
-     *
-     * @codeCoverageIgnore
-     *
-     * @param Request    $request
-     * @param Attachment $attachment
-     *
-     * @return JsonResponse
      */
     public function upload(Request $request, Attachment $attachment): JsonResponse
     {
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+
         /** @var AttachmentHelperInterface $helper */
         $helper = app(AttachmentHelperInterface::class);
         $body   = $request->getContent();
@@ -112,7 +113,12 @@ class StoreController extends Controller
 
             return response()->json([], 422);
         }
-        $helper->saveAttachmentFromApi($attachment, $body);
+        $result = $helper->saveAttachmentFromApi($attachment, $body);
+        if (false === $result) {
+            Log::error('Could not save attachment from API.');
+
+            return response()->json([], 422);
+        }
 
         return response()->json([], 204);
     }

app/Api/V1/Controllers/Models/Attachment/UpdateController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * UpdateController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -31,7 +32,9 @@ use FireflyIII\Repositories\Attachment\AttachmentRepositoryInterface;
 use FireflyIII\Transformers\AttachmentTransformer;
 use FireflyIII\User;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\Log;
 use League\Fractal\Resource\Item;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
  * Class UpdateController
@@ -42,8 +45,6 @@ class UpdateController extends Controller
 
     /**
      * UpdateController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -63,26 +64,26 @@ class UpdateController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/attachments/updateAttachment
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/attachments/updateAttachment
      *
      * Update the specified resource in storage.
-     *
-     * @param UpdateRequest $request
-     * @param Attachment    $attachment
-     *
-     * @return JsonResponse
      */
     public function update(UpdateRequest $request, Attachment $attachment): JsonResponse
     {
-        $data = $request->getAll();
+        if (true === auth()->user()->hasRole('demo')) {
+            Log::channel('audit')->warning(sprintf('Demo user tries to access attachment API in %s', __METHOD__));
+
+            throw new NotFoundHttpException();
+        }
+        $data        = $request->getAll();
         $this->repository->update($attachment, $data);
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
 
         /** @var AttachmentTransformer $transformer */
         $transformer = app(AttachmentTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($attachment, $transformer, 'attachments');
+        $resource    = new Item($attachment, $transformer, 'attachments');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }

app/Api/V1/Controllers/Models/AvailableBudget/ShowController.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * ShowController.php
  * Copyright (c) 2021 james@firefly-iii.org
@@ -44,8 +45,6 @@ class ShowController extends Controller
 
     /**
      * AvailableBudgetController constructor.
-     *
-     * @codeCoverageIgnore
      */
     public function __construct()
     {
@@ -64,23 +63,21 @@ class ShowController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/available_budgets/getAvailableBudget
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/available_budgets/getAvailableBudget
      *
      * Display a listing of the resource.
      *
-     * @return JsonResponse
      * @throws FireflyException
-     * @codeCoverageIgnore
      */
     public function index(): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager          = $this->getManager();
 
         // types to get, page size:
-        $pageSize = (int) app('preferences')->getForUser(auth()->user(), 'listPageSize', 50)->data;
+        $pageSize         = $this->parameters->get('limit');
 
-        $start = $this->parameters->get('start');
-        $end   = $this->parameters->get('end');
+        $start            = $this->parameters->get('start');
+        $end              = $this->parameters->get('end');
 
         // get list of available budgets. Count it and split it.
         $collection       = $this->abRepository->getAvailableBudgetsByDate($start, $end);
@@ -88,14 +85,14 @@ class ShowController extends Controller
         $availableBudgets = $collection->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
 
         // make paginator:
-        $paginator = new LengthAwarePaginator($availableBudgets, $count, $pageSize, $this->parameters->get('page'));
-        $paginator->setPath(route('api.v1.available_budgets.index') . $this->buildParams());
+        $paginator        = new LengthAwarePaginator($availableBudgets, $count, $pageSize, $this->parameters->get('page'));
+        $paginator->setPath(route('api.v1.available-budgets.index').$this->buildParams());
 
         /** @var AvailableBudgetTransformer $transformer */
-        $transformer = app(AvailableBudgetTransformer::class);
+        $transformer      = app(AvailableBudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new FractalCollection($availableBudgets, $transformer, 'available_budgets');
+        $resource         = new FractalCollection($availableBudgets, $transformer, 'available_budgets');
         $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
@@ -103,26 +100,20 @@ class ShowController extends Controller
 
     /**
      * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/available_budgets/getAvailableBudget
+     * https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/available_budgets/getAvailableBudget
      *
      * Display the specified resource.
-     *
-     * @param AvailableBudget $availableBudget
-     *
-     * @return JsonResponse
-     * @codeCoverageIgnore
      */
     public function show(AvailableBudget $availableBudget): JsonResponse
     {
-        $manager = $this->getManager();
+        $manager     = $this->getManager();
 
         /** @var AvailableBudgetTransformer $transformer */
         $transformer = app(AvailableBudgetTransformer::class);
         $transformer->setParameters($this->parameters);
 
-        $resource = new Item($availableBudget, $transformer, 'available_budgets');
+        $resource    = new Item($availableBudget, $transformer, 'available_budgets');
 
         return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
     }
-
 }

app/Api/V1/Controllers/Models/AvailableBudget/StoreController.php

@@ -1,105 +0,0 @@
-<?php
-/*
- * StoreController.php
- * Copyright (c) 2021 james@firefly-iii.org
- *
- * This file is part of Firefly III (https://github.com/firefly-iii).
- *
- * 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 <https://www.gnu.org/licenses/>.
- */
-
-declare(strict_types=1);
-
-namespace FireflyIII\Api\V1\Controllers\Models\AvailableBudget;
-
-use FireflyIII\Api\V1\Controllers\Controller;
-use FireflyIII\Api\V1\Requests\Models\AvailableBudget\Request;
-use FireflyIII\Exceptions\FireflyException;
-use FireflyIII\Factory\TransactionCurrencyFactory;
-use FireflyIII\Repositories\Budget\AvailableBudgetRepositoryInterface;
-use FireflyIII\Transformers\AvailableBudgetTransformer;
-use FireflyIII\User;
-use Illuminate\Http\JsonResponse;
-use JsonException;
-use League\Fractal\Resource\Item;
-
-/**
- * Class StoreController
- */
-class StoreController extends Controller
-{
-    private AvailableBudgetRepositoryInterface $abRepository;
-
-    /**
-     * AvailableBudgetController constructor.
-     *
-     * @codeCoverageIgnore
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->middleware(
-            function ($request, $next) {
-                /** @var User $user */
-                $user               = auth()->user();
-                $this->abRepository = app(AvailableBudgetRepositoryInterface::class);
-                $this->abRepository->setUser($user);
-
-                return $next($request);
-            }
-        );
-    }
-
-    /**
-     * This endpoint is documented at:
-     * https://api-docs.firefly-iii.org/#/available_budgets/storeAvailableBudget
-     *
-     * Store a newly created resource in storage.
-     *
-     * @param Request $request
-     *
-     * @return JsonResponse
-     * @throws FireflyException
-     * @throws JsonException
-     */
-    public function store(Request $request): JsonResponse
-    {
-        $data = $request->getAll();
-        $data['start']->startOfDay();
-        $data['end']->endOfDay();
-
-        // currency is not mandatory:
-        if (array_key_exists('currency_id', $data) || array_key_exists('currency_code', $data)) {
-            $factory             = app(TransactionCurrencyFactory::class);
-            $currency            = $factory->find($data['currency_id'] ?? null, $data['currency_code'] ?? null);
-            $data['currency_id'] = $currency->id;
-            unset($data['currency_code']);
-        }
-        if (!array_key_exists('currency_id', $data)) {
-            $currency            = app('amount')->getDefaultCurrencyByUser(auth()->user());
-            $data['currency_id'] = $currency->id;
-        }
-
-        $availableBudget = $this->abRepository->store($data);
-        $manager         = $this->getManager();
-
-        /** @var AvailableBudgetTransformer $transformer */
-        $transformer = app(AvailableBudgetTransformer::class);
-        $transformer->setParameters($this->parameters);
-
-        $resource = new Item($availableBudget, $transformer, 'available_budgets');
-
-        return response()->json($manager->createData($resource)->toArray())->header('Content-Type', self::CONTENT_TYPE);
-    }
-}