From cf14306c2b3f82a81f8d56669a71633b4d4b5fce Mon Sep 17 00:00:00 2001 From: marvin-borner@live.com Date: Mon, 16 Apr 2018 21:09:05 +0200 Subject: Main merge to user management system - files are now at /main/public/ --- main/app/sprinkles/extend-user/.gitignore | 3 + main/app/sprinkles/extend-user/README.md | 29 +++++ main/app/sprinkles/extend-user/composer.json | 22 ++++ main/app/sprinkles/extend-user/routes/member.php | 7 + .../extend-user/schema/requests/user/create.yaml | 86 ++++++++++++ .../schema/requests/user/edit-info.yaml | 50 +++++++ .../src/Controller/MemberController.php | 123 +++++++++++++++++ .../src/Database/Migrations/v400/MembersTable.php | 34 +++++ .../extend-user/src/Database/Models/Member.php | 124 ++++++++++++++++++ .../extend-user/src/Database/Models/MemberAux.php | 20 +++ .../src/Database/Scopes/MemberAuxScope.php | 36 +++++ .../src/ServicesProvider/ServicesProvider.php | 26 ++++ .../extend-user/templates/forms/user.html.twig | 145 +++++++++++++++++++++ .../extend-user/templates/pages/user.html.twig | 11 ++ 14 files changed, 716 insertions(+) create mode 100755 main/app/sprinkles/extend-user/.gitignore create mode 100755 main/app/sprinkles/extend-user/README.md create mode 100755 main/app/sprinkles/extend-user/composer.json create mode 100755 main/app/sprinkles/extend-user/routes/member.php create mode 100755 main/app/sprinkles/extend-user/schema/requests/user/create.yaml create mode 100755 main/app/sprinkles/extend-user/schema/requests/user/edit-info.yaml create mode 100755 main/app/sprinkles/extend-user/src/Controller/MemberController.php create mode 100755 main/app/sprinkles/extend-user/src/Database/Migrations/v400/MembersTable.php create mode 100755 main/app/sprinkles/extend-user/src/Database/Models/Member.php create mode 100755 main/app/sprinkles/extend-user/src/Database/Models/MemberAux.php create mode 100755 main/app/sprinkles/extend-user/src/Database/Scopes/MemberAuxScope.php create mode 100755 main/app/sprinkles/extend-user/src/ServicesProvider/ServicesProvider.php create mode 100755 main/app/sprinkles/extend-user/templates/forms/user.html.twig create mode 100755 main/app/sprinkles/extend-user/templates/pages/user.html.twig (limited to 'main/app/sprinkles/extend-user') diff --git a/main/app/sprinkles/extend-user/.gitignore b/main/app/sprinkles/extend-user/.gitignore new file mode 100755 index 0000000..5a664d4 --- /dev/null +++ b/main/app/sprinkles/extend-user/.gitignore @@ -0,0 +1,3 @@ +.DS_Store +.idea +*.komodoproject diff --git a/main/app/sprinkles/extend-user/README.md b/main/app/sprinkles/extend-user/README.md new file mode 100755 index 0000000..60a4bcd --- /dev/null +++ b/main/app/sprinkles/extend-user/README.md @@ -0,0 +1,29 @@ +# User Extension Sprinkle (UserFrosting 4.1) + +Example sprinkle for extending the User class to contain additional fields. + +# Installation + +Edit UserFrosting `app/sprinkles.json` and add the following to the `require` list : `"userfrosting/extend-user": "~4.1.1"`. Also add `extend-user` to the `base` list. For example: + +``` +{ + "require": { + "userfrosting/extend-user": "~4.1.1" + }, + "base": [ + "core", + "account", + "admin", + "extend-user" + ] +} +``` + +### Update Composer + +- Run `composer update` from the root project directory. + +### Run migration + +- Run `php bakery bake` from the root project directory. diff --git a/main/app/sprinkles/extend-user/composer.json b/main/app/sprinkles/extend-user/composer.json new file mode 100755 index 0000000..4c8a0fa --- /dev/null +++ b/main/app/sprinkles/extend-user/composer.json @@ -0,0 +1,22 @@ +{ + "name": "userfrosting/extend-user", + "type": "userfrosting-sprinkle", + "description": "An example Sprinkle for extending the User model and table with additional fields or relationships.", + "homepage": "https://github.com/userfrosting/extend-user", + "license" : "MIT", + "authors" : [ + { + "name": "Alexander Weissman", + "homepage": "https://alexanderweissman.com" + } + ], + "autoload": { + "psr-4": { + "UserFrosting\\Sprinkle\\ExtendUser\\": "src/" + } + }, + "extra": { + "installer-name": "extend-user" + } +} + diff --git a/main/app/sprinkles/extend-user/routes/member.php b/main/app/sprinkles/extend-user/routes/member.php new file mode 100755 index 0000000..19028ac --- /dev/null +++ b/main/app/sprinkles/extend-user/routes/member.php @@ -0,0 +1,7 @@ +group('/admin/users', function () { + $this->get('/u/{user_name}', 'UserFrosting\Sprinkle\ExtendUser\Controller\MemberController:pageInfo'); +})->add('authGuard'); \ No newline at end of file diff --git a/main/app/sprinkles/extend-user/schema/requests/user/create.yaml b/main/app/sprinkles/extend-user/schema/requests/user/create.yaml new file mode 100755 index 0000000..2df2955 --- /dev/null +++ b/main/app/sprinkles/extend-user/schema/requests/user/create.yaml @@ -0,0 +1,86 @@ +--- +user_name: + validators: + length: + label: "&USERNAME" + min: 1 + max: 50 + message: VALIDATE.LENGTH_RANGE + no_leading_whitespace: + label: "&USERNAME" + message: VALIDATE.NO_LEAD_WS + no_trailing_whitespace: + label: "&USERNAME" + message: VALIDATE.NO_TRAIL_WS + required: + label: "&USERNAME" + message: VALIDATE.REQUIRED + username: + label: "&USERNAME" + message: VALIDATE.USERNAME +first_name: + validators: + length: + label: "&FIRST_NAME" + min: 1 + max: 20 + message: VALIDATE.LENGTH_RANGE + required: + label: "&FIRST_NAME" + message: VALIDATE.REQUIRED + transformations: + - trim +last_name: + validators: + length: + label: "&LAST_NAME" + min: 1 + max: 30 + message: VALIDATE.LENGTH_RANGE + transformations: + - trim +email: + validators: + required: + label: "&EMAIL" + message: VALIDATE.REQUIRED + length: + label: "&EMAIL" + min: 1 + max: 150 + message: VALIDATE.LENGTH_RANGE + email: + message: VALIDATE.INVALID_EMAIL +locale: + default: en_US + validators: + required: + label: "&LOCALE" + domain: server + message: VALIDATE.REQUIRED + length: + label: "&LOCALE" + min: 1 + max: 10 + domain: server + message: VALIDATE.LENGTH_RANGE +group_id: + validators: + integer: + label: "&GROUP" + domain: server + message: VALIDATE.INTEGER +city: + validators: + length: + label: City + min: 1 + max: 255 + message: VALIDATE.LENGTH_RANGE +country: + validators: + length: + label: Country + min: 1 + max: 255 + message: VALIDATE.LENGTH_RANGE diff --git a/main/app/sprinkles/extend-user/schema/requests/user/edit-info.yaml b/main/app/sprinkles/extend-user/schema/requests/user/edit-info.yaml new file mode 100755 index 0000000..edfae6e --- /dev/null +++ b/main/app/sprinkles/extend-user/schema/requests/user/edit-info.yaml @@ -0,0 +1,50 @@ +--- +first_name: + validators: + length: + label: "&FIRST_NAME" + min: 1 + max: 20 + message: VALIDATE.LENGTH_RANGE +last_name: + validators: + length: + label: "&LAST_NAME" + min: 1 + max: 30 + message: VALIDATE.LENGTH_RANGE +email: + validators: + length: + label: "&EMAIL" + min: 1 + max: 150 + message: VALIDATE.LENGTH_RANGE + email: + message: VALIDATE.INVALID_EMAIL +locale: + validators: + length: + label: "&LOCALE" + min: 1 + max: 10 + message: VALIDATE.LENGTH_RANGE +group_id: + validators: + integer: + label: "&GROUP" + message: VALIDATE.INTEGER +city: + validators: + length: + label: City + min: 1 + max: 255 + message: VALIDATE.LENGTH_RANGE +country: + validators: + length: + label: Country + min: 1 + max: 255 + message: VALIDATE.LENGTH_RANGE \ No newline at end of file diff --git a/main/app/sprinkles/extend-user/src/Controller/MemberController.php b/main/app/sprinkles/extend-user/src/Controller/MemberController.php new file mode 100755 index 0000000..c584286 --- /dev/null +++ b/main/app/sprinkles/extend-user/src/Controller/MemberController.php @@ -0,0 +1,123 @@ +getUserFromParams($args); + + // If the user no longer exists, forward to main user listing page + if (!$user) { + $usersPage = $this->ci->router->pathFor('uri_users'); + return $response->withRedirect($usersPage, 404); + } + + /** @var UserFrosting\Sprinkle\Account\Authorize\AuthorizationManager $authorizer */ + $authorizer = $this->ci->authorizer; + + /** @var UserFrosting\Sprinkle\Account\Database\Models\User $currentUser */ + $currentUser = $this->ci->currentUser; + + // Access-controlled page + if (!$authorizer->checkAccess($currentUser, 'uri_user', [ + 'user' => $user + ])) { + throw new ForbiddenException(); + } + + /** @var UserFrosting\Config\Config $config */ + $config = $this->ci->config; + + // Get a list of all locales + $locales = $config->getDefined('site.locales.available'); + + // Determine fields that currentUser is authorized to view + $fieldNames = ['user_name', 'name', 'email', 'locale', 'group', 'roles', 'address']; + + // Generate form + $fields = [ + // Always hide these + 'hidden' => ['theme'] + ]; + + // Determine which fields should be hidden + foreach ($fieldNames as $field) { + if (!$authorizer->checkAccess($currentUser, 'view_user_field', [ + 'user' => $user, + 'property' => $field + ])) { + $fields['hidden'][] = $field; + } + } + + // Determine buttons to display + $editButtons = [ + 'hidden' => [] + ]; + + if (!$authorizer->checkAccess($currentUser, 'update_user_field', [ + 'user' => $user, + 'fields' => ['name', 'email', 'locale'] + ])) { + $editButtons['hidden'][] = 'edit'; + } + + if (!$authorizer->checkAccess($currentUser, 'update_user_field', [ + 'user' => $user, + 'fields' => ['flag_enabled'] + ])) { + $editButtons['hidden'][] = 'enable'; + } + + if (!$authorizer->checkAccess($currentUser, 'update_user_field', [ + 'user' => $user, + 'fields' => ['flag_verified'] + ])) { + $editButtons['hidden'][] = 'activate'; + } + + if (!$authorizer->checkAccess($currentUser, 'update_user_field', [ + 'user' => $user, + 'fields' => ['password'] + ])) { + $editButtons['hidden'][] = 'password'; + } + + if (!$authorizer->checkAccess($currentUser, 'update_user_field', [ + 'user' => $user, + 'fields' => ['roles'] + ])) { + $editButtons['hidden'][] = 'roles'; + } + + if (!$authorizer->checkAccess($currentUser, 'delete_user', [ + 'user' => $user + ])) { + $editButtons['hidden'][] = 'delete'; + } + + return $this->ci->view->render($response, 'pages/user.html.twig', [ + 'user' => $user, + 'locales' => $locales, + 'fields' => $fields, + 'tools' => $editButtons + ]); + } +} diff --git a/main/app/sprinkles/extend-user/src/Database/Migrations/v400/MembersTable.php b/main/app/sprinkles/extend-user/src/Database/Migrations/v400/MembersTable.php new file mode 100755 index 0000000..a27d485 --- /dev/null +++ b/main/app/sprinkles/extend-user/src/Database/Migrations/v400/MembersTable.php @@ -0,0 +1,34 @@ +schema->hasTable('members')) { + $this->schema->create('members', function (Blueprint $table) { + $table->increments('id'); + $table->string('city', 255)->nullable(); + $table->string('country', 255)->nullable(); + + $table->engine = 'InnoDB'; + $table->collation = 'utf8_unicode_ci'; + $table->charset = 'utf8'; + $table->foreign('id')->references('id')->on('users'); + }); + } + } + + public function down() + { + $this->schema->drop('members'); + } +} diff --git a/main/app/sprinkles/extend-user/src/Database/Models/Member.php b/main/app/sprinkles/extend-user/src/Database/Models/Member.php new file mode 100755 index 0000000..98d9d70 --- /dev/null +++ b/main/app/sprinkles/extend-user/src/Database/Models/Member.php @@ -0,0 +1,124 @@ +createAuxIfNotExists(); + + if ($member->auxType) { + // Set the aux PK, if it hasn't been set yet + if (!$member->aux->id) { + $member->aux->id = $member->id; + } + + $member->aux->save(); + } + }); + } +} + +class Member extends User +{ + use LinkMemberAux; + + protected $fillable = [ + 'user_name', + 'first_name', + 'last_name', + 'email', + 'locale', + 'theme', + 'group_id', + 'flag_verified', + 'flag_enabled', + 'last_activity_id', + 'password', + 'deleted_at', + 'city', + 'country' + ]; + + protected $auxType = 'UserFrosting\Sprinkle\ExtendUser\Database\Models\MemberAux'; + + /** + * Required to be able to access the `aux` relationship in Twig without needing to do eager loading. + * @see http://stackoverflow.com/questions/29514081/cannot-access-eloquent-attributes-on-twig/35908957#35908957 + */ + public function __isset($name) + { + if (in_array($name, [ + 'aux' + ])) { + return true; + } else { + return parent::__isset($name); + } + } + + /** + * Globally joins the `members` table to access additional properties. + */ + protected static function boot() + { + parent::boot(); + + static::addGlobalScope(new MemberAuxScope); + } + + /** + * Custom mutator for Member property + */ + public function setCityAttribute($value) + { + $this->createAuxIfNotExists(); + + $this->aux->city = $value; + } + + /** + * Custom mutator for Member property + */ + public function setCountryAttribute($value) + { + $this->createAuxIfNotExists(); + + $this->aux->country = $value; + } + + /** + * Relationship for interacting with aux model (`members` table). + */ + public function aux() + { + return $this->hasOne($this->auxType, 'id'); + } + + /** + * If this instance doesn't already have a related aux model (either in the db on in the current object), then create one + */ + protected function createAuxIfNotExists() + { + if ($this->auxType && !count($this->aux)) { + // Create aux model and set primary key to be the same as the main user's + $aux = new $this->auxType; + + // Needed to immediately hydrate the relation. It will actually get saved in the bootLinkMemberAux method. + $this->setRelation('aux', $aux); + } + } +} diff --git a/main/app/sprinkles/extend-user/src/Database/Models/MemberAux.php b/main/app/sprinkles/extend-user/src/Database/Models/MemberAux.php new file mode 100755 index 0000000..c826409 --- /dev/null +++ b/main/app/sprinkles/extend-user/src/Database/Models/MemberAux.php @@ -0,0 +1,20 @@ +getTable(); + // Hardcode the table name here, or you can access it using the classMapper and `getTable` + $auxTable = 'members'; + + // Specify columns to load from base table and aux table + $builder->addSelect( + "$baseTable.*", + "$auxTable.city as city", + "$auxTable.country as country" + ); + + // Join on matching `member` records + $builder->leftJoin($auxTable, function ($join) use ($baseTable, $auxTable) { + $join->on("$auxTable.id", '=', "$baseTable.id"); + }); + } +} diff --git a/main/app/sprinkles/extend-user/src/ServicesProvider/ServicesProvider.php b/main/app/sprinkles/extend-user/src/ServicesProvider/ServicesProvider.php new file mode 100755 index 0000000..8ea3860 --- /dev/null +++ b/main/app/sprinkles/extend-user/src/ServicesProvider/ServicesProvider.php @@ -0,0 +1,26 @@ +extend('classMapper', function ($classMapper, $c) { + $classMapper->setClassMapping('user', 'UserFrosting\Sprinkle\ExtendUser\Database\Models\Member'); + return $classMapper; + }); + } +} diff --git a/main/app/sprinkles/extend-user/templates/forms/user.html.twig b/main/app/sprinkles/extend-user/templates/forms/user.html.twig new file mode 100755 index 0000000..b7c98a9 --- /dev/null +++ b/main/app/sprinkles/extend-user/templates/forms/user.html.twig @@ -0,0 +1,145 @@ +
+ {% include "forms/csrf.html.twig" %} +
+
+
+ {% block user_form %} + {% if 'user_name' not in form.fields.hidden %} +
+
+ +
+ + +
+
+
+ {% endif %} + {% if 'group' not in form.fields.hidden %} +
+
+ +
+ + {% if 'group' in form.fields.disabled %} + + {% else %} + + {% endif %} +
+
+
+ {% endif %} + {% if 'name' not in form.fields.hidden %} +
+
+ +
+ + +
+
+
+
+
+ +
+ + +
+
+
+ {% endif %} + {% if 'email' not in form.fields.hidden %} +
+
+ +
+ + + {% if 'email' in form.fields.disabled %} + + + + {% endif %} +
+
+
+ {% endif %} + {% if 'theme' not in form.fields.hidden %} +
+
+ +
+ + {% if 'theme' in form.fields.disabled %} + + {% else %} + + {% endif %} +
+
+
+ {% endif %} + {% if 'locale' not in form.fields.hidden %} +
+
+ +
+ + {% if 'locale' in form.fields.disabled %} + + {% else %} + + {% endif %} +
+
+
+ {% endif %} + {% if 'address' not in form.fields.hidden %} +
+
+ +
+ + +
+
+
+
+
+ +
+ + +
+
+
+ {% endif %} + {% endblock %} +

+
+
+ +
+
+ +
+
+
+ + diff --git a/main/app/sprinkles/extend-user/templates/pages/user.html.twig b/main/app/sprinkles/extend-user/templates/pages/user.html.twig new file mode 100755 index 0000000..46e79aa --- /dev/null +++ b/main/app/sprinkles/extend-user/templates/pages/user.html.twig @@ -0,0 +1,11 @@ +{% extends "@admin/pages/user.html.twig" %} + +{% block user_profile %} + {% if 'locale' not in fields.hidden %} +
+ Location +

+ {{user.city}}, {{user.country}} +

+ {% endif %} +{% endblock %} -- cgit v1.2.3