flarum
diff --git a/‎.github/workflows/backend.yml‎
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/backend.yml‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎composer.json‎
Lines changed: 5 additions & 0 deletions b/‎composer.json‎
Lines changed: 5 additions & 0 deletions
diff --git a/‎extensions/gdpr/.editorconfig‎
Lines changed: 28 additions & 0 deletions b/‎extensions/gdpr/.editorconfig‎
Lines changed: 28 additions & 0 deletions
diff --git a/‎extensions/gdpr/.gitattributes‎
Lines changed: 10 additions & 0 deletions b/‎extensions/gdpr/.gitattributes‎
Lines changed: 10 additions & 0 deletions
diff --git a/‎extensions/gdpr/.gitignore‎
Lines changed: 4 additions & 0 deletions b/‎extensions/gdpr/.gitignore‎
Lines changed: 4 additions & 0 deletions
diff --git a/‎extensions/gdpr/LICENSE.md‎
Lines changed: 21 additions & 0 deletions b/‎extensions/gdpr/LICENSE.md‎
Lines changed: 21 additions & 0 deletions
diff --git a/‎extensions/gdpr/README.md‎
Lines changed: 113 additions & 0 deletions b/‎extensions/gdpr/README.md‎
Lines changed: 113 additions & 0 deletions
diff --git a/‎extensions/gdpr/composer.json‎
Lines changed: 97 additions & 0 deletions b/‎extensions/gdpr/composer.json‎
Lines changed: 97 additions & 0 deletions
@@ -8,4 +8,4 @@ jobs:
     with:
       enable_backend_testing: true
       backend_directory: .
-      monorepo_tests: "framework/core extensions/akismet extensions/approval extensions/flags extensions/likes extensions/mentions extensions/nicknames extensions/statistics extensions/sticky extensions/subscriptions extensions/suspend extensions/tags extensions/messages php-packages/testing/tests"
+      monorepo_tests: "framework/core extensions/akismet extensions/approval extensions/flags extensions/likes extensions/mentions extensions/nicknames extensions/statistics extensions/sticky extensions/subscriptions extensions/suspend extensions/tags extensions/messages extensions/gdpr php-packages/testing/tests"
@@ -42,6 +42,7 @@
             "Flarum\\Approval\\": "extensions/approval/src",
             "Flarum\\BBCode\\": "extensions/bbcode/src",
             "Flarum\\Flags\\": "extensions/flags/src",
+            "Flarum\\Gdpr\\": "extensions/gdpr/src",
             "Flarum\\Likes\\": "extensions/likes/src",
             "Flarum\\Lock\\": "extensions/lock/src",
             "Flarum\\Mentions\\": "extensions/mentions/src",
@@ -67,6 +68,7 @@
             "Flarum\\Akismet\\Tests\\": "extensions/akismet/tests",
             "Flarum\\Approval\\Tests\\": "extensions/approval/tests",
             "Flarum\\Flags\\Tests\\": "extensions/flags/tests",
+            "Flarum\\Gdpr\\Tests\\": "extensions/gdpr/tests",
             "Flarum\\Likes\\Tests\\": "extensions/likes/tests",
             "Flarum\\Lock\\Tests\\": "extensions/lock/tests",
             "Flarum\\Mentions\\Tests\\": "extensions/mentions/tests",
@@ -90,6 +92,7 @@
         "flarum/embed": "self.version",
         "flarum/emoji": "self.version",
         "flarum/flags": "self.version",
+        "flarum/gdpr": "self.version",
         "flarum/lang-english": "self.version",
         "flarum/likes": "self.version",
         "flarum/lock": "self.version",
@@ -147,6 +150,7 @@
         "middlewares/base-path-router": "^2.0.1",
         "middlewares/request-handler": "^2.0.2",
         "monolog/monolog": "^3.3",
+        "nelexa/zip": "^4.0.2",
         "nesbot/carbon": "^3.0",
         "nikic/fast-route": "^1.3",
         "psr/http-message": "^1.1",
@@ -188,6 +192,7 @@
             "extensions/embed",
             "extensions/emoji",
             "extensions/flags",
+            "extensions/gdpr",
             "extensions/lang-english",
             "extensions/likes",
             "extensions/lock",
 
@@ -0,0 +1,28 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.{diff,md}]
+trim_trailing_whitespace = false
+
+[*.{php,xml,json}]
+indent_size = 4
+
+[{tsconfig.json,prettierrc.json}]
+indent_size = 2
+
+[*.neon]
+indent_style = tab
+
+[{install,update}.php]
+indent_size = 2
@@ -0,0 +1,10 @@
+.gitattributes export-ignore
+.github export-ignore
+.gitignore export-ignore
+.gitmodules export-ignore
+js/*/src export-ignore
+js/*/Gulfile.js
+js/*/package.json
+js/*/yarn.lock
+
+js/*/dist/*.js -diff
@@ -0,0 +1,4 @@
+js/node_modules
+vendor/
+composer.lock
+.phpunit.result.cache
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Stichting Flarum (Flarum Foundation)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
@@ -0,0 +1,113 @@
+# GDPR or PII management
+
+This extension allows users increasing control over their data.
+
+### Requirements
+
+- `flarum/core` - `v2.0` or higher
+- `PHP` - `8.2` or higher
+
+### Installation or update
+
+Install manually with composer:
+
+```sh
+composer require flarum/gdpr:^2.0.0
+```
+
+### Use
+
+All forum users now have a `Personal Data` section within their account settings page:
+
+![image](https://github.com/flarum/gdpr/assets/16573496/4e469956-709f-4ba3-a5fe-d3fcb0401b73)
+
+From here, users may self-service export their data from the forum, or start an erasure request. Erasure requests are queued up for admins/moderators to process. Any unprocessed requests that are still pending after 30 days will be processed automatically using the configured default method (Deletion or Anonymization).
+
+#### Specifying which queue to use
+If your forum runs multiple queues, ie `low` and `high`, you may specify which queue jobs for this extension are run on in your skeleton's `extend.php` file:
+
+```php
+Blomstra\Gdpr\Jobs\GdprJob::$onQueue = 'low';
+
+return [
+    ... your current extenders,
+];
+```
+
+### For developers
+
+You can easily register a new Data type, remove an existing Data type, or exclude specific columns from the user table during export by leveraging the `Flarum\Gdpr\Extend\UserData` extender. Ensure that you wrap the GDPR extender in a conditional extend, so that forum owners can choose if they want to enable GDPR functionality or not. This functionality requires `flarum/core` `v2.0` or higher, so that should be set as your extension's minimum requirement.
+
+#### Registering a new Data Type:
+
+Your data type class should implement the `Blomstra\Gdpr\Contracts\DataType`:
+```php
+<?php
+
+use Blomstra\Gdpr\Extend\UserData;
+use Blomstra\Extend;
+
+return [
+    (new Extend\Conditional())
+        ->whenExtensionEnabled('flarum-gdpr', fn () => [
+            (new UserData())
+                ->addType(Your\Own\DataType::class),
+
+            ... other conditional extenders as required ...
+        ]),
+];
+```
+
+The implementation you create needs a export method, it will receive a ZipArchive resource.
+You can use that to add any strings or actual files to the archive. Make sure to properly
+name the file and always prefix it with your extension slug (flarum-something-filename).
+
+#### Removing a Data Type:
+If for any reason you want to exclude a certain DataType from the export:
+```php
+use Blomstra\Gdpr\Extend\UserData;
+use Blomstra\Extend;
+
+return [
+    (new Extend\Conditional())
+        ->whenExtensionEnabled('flarum-gdpr', fn () => [
+            (new UserData())
+                ->removeType(Your\Own\DataType::class),
+
+            ... other conditional extenders as required ...
+        ]),
+];
+```
+
+#### Exclude specific columns from the user table during export:
+```php
+use Blomstra\Gdpr\Extend\UserData;
+
+return [
+    (new Extend\Conditional())
+        ->whenExtensionEnabled('flarum-gdpr', fn () => [
+            (new UserData())
+                ->removeUserColumn('column_name') // For a single column
+                ->removeUserColumns(['column1', 'column2']), // For multiple columns
+
+            ... other conditional extenders as required ...
+        ]),
+];
+```
+### Flarum extensions
+
+These are the known extensions which offer GDPR data integration with this extension. Don't see a required extension listed? Contact the author to request it
+
+- [2FA](https://github.com/imorland/flarum-ext-twofactor), since `2.0`
+- [Boring Avatars](https://github.com/imorland/flarum-ext-boring-avatars), since `2.0`
+- [FoF Ban IPs](https://github.com/FriendsOfFlarum/ban-ips), since `2.0`
+- [FoF Drafts](https://github.com/FriendsOfFlarum/drafts), since `2.0`
+- [FoF Follow Tags](https://github.com/FriendsOfFlarum/follow-tags), since `2.0`
+- [FoF Terms](https://github.com/FriendsOfFlarum/terms), since `2.0`
+- [FoF Upload](https://github.com/FriendsOfFlarum/upload), since `2.0`
+- [FoF User Bio](https://github.com/FriendsOfFlarum/user-bio), since `2.0`
+- [Follow Users](https://github.com/imorland/follow-users), since `2.0`
+
+### FAQ & Recommendations
+
+- Generating the zip archive can be pushed to queue functionality. This is exceptionally important on larger communities and with more extensions that work with the gdpr extension to allow data exports.
@@ -0,0 +1,97 @@
+{
+    "name": "flarum/gdpr",
+    "description": "Features for GDPR, PII management",
+    "keywords": [
+        "extension",
+        "flarum",
+        "pii",
+        "gdpr",
+        "export"
+    ],
+    "type": "flarum-extension",
+    "license": "MIT",
+    "support": {
+        "issues": "https://github.com/flarum/framework/issues",
+        "source": "https://github.com/flarum/gdpr",
+        "forum": "https://discuss.flarum.org"
+    },
+    "homepage": "https://flarum.org",
+    "funding": [
+        {
+            "type": "website",
+            "url": "https://flarum.org/donate/"
+        }
+    ],
+    "require": {
+        "flarum/core": "^2.0.0-beta.4",
+        "nelexa/zip": "^4.0.2"
+    },
+    "autoload": {
+        "psr-4": {
+            "Flarum\\Gdpr\\": "src/"
+        }
+    },
+    "replace": {
+        "blomstra/gdpr": "*"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "2.x-dev"
+        },
+        "flarum-extension": {
+            "title": "GDPR Data Management",
+            "category": "feature",
+            "icon": {
+                "image": "resources/logo.svg",
+                "backgroundColor": "#EBF1FD",
+                "color": "#3a98d0",
+                "backgroundSize": "90%",
+                "backgroundRepeat": "no-repeat",
+                "backgroundPosition": "center"
+            }
+        },
+        "flarum-cli": {
+            "modules": {
+                "githubActions": true,
+                "typescript": true,
+                "backendTesting": true,
+                "jsCommon": true
+            }
+        }
+    },
+    "repositories": [
+        {
+            "type": "path",
+            "url": "../../*/*"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "autoload-dev": {
+        "psr-4": {
+            "Flarum\\Gdpr\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": [
+            "@test:unit",
+            "@test:integration"
+        ],
+        "test:unit": "phpunit -c tests/phpunit.unit.xml",
+        "test:integration": "phpunit -c tests/phpunit.integration.xml",
+        "test:setup": "@php tests/integration/setup.php",
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
+    },
+    "scripts-descriptions": {
+        "test": "Runs all tests.",
+        "test:unit": "Runs all unit tests.",
+        "test:integration": "Runs all integration tests.",
+        "test:setup": "Sets up a database for use with integration tests. Execute this only once.",
+        "analyse:phpstan": "Run static analysis"
+    },
+    "require-dev": {
+        "flarum/testing": "^2.0.0-beta",
+        "flarum/phpstan": "^2.0.0-beta"
+    }
+}