Add simplify plugin by rdeutz · Pull Request #10347 · joomla/joomla-cms

rdeutz · 2016-05-08T22:17:08Z

Executive summary

This new plugin allow registration of a user only with an email address. If the plugin is enabled the username field is not available in forms. As default also the name field isn’t available but this can be configured.

Backwards compatibility

Problems can occur when a template overwrite has changed one of the following views:

com_users/views/login/default_login.php
com_users/views/profile/default_core.php
com_users/views/registration/default.php

Same is possible for the login module.

A small problem can be if someone has a direct link to the „Username Reminder Request“ as we have in our test data. This doesn’t makes sense in this configuration.

Translation impact

Two new language files with 8 new language tags.

Core changes

New User Plugin Event „onUserBeforeDataValidation“
New User Plugin Event „onUserAfterDataValidation“
New JForm Class method getFieldXml as public getter for the protected method findField
New parameter path for the setField method of JForm, allows to add a field at a specific place in the xml tree.

All core changes are only additions and full B/C, even if the plugin isn’t accepted these changes allow more flexibility for JForm.

Testing instruction

Apply the patch
Go to extensions and discover install the new plugin
Enable the plugin
Enable user registration

Test registration process
Test login
Test profile edit frontend
Test user data change backend

# Executive summary This new plugin allow registration of a user only with an email address. If the plugin is enabled the username fields is not available in forms. As default also the name field isn’t available but this can be configured. # Backwards compatibility A problems can occur when a template overwrite has the changed one of the following views: * com_users/views/login/default_login.php * com_users/views/profile/default_core.php * com_users/views/registration/default.php Same is possible for the login module. A small problem can be if someone has a direct link to the „Username Reminder Request“ as we have in our test data. This doesn’t makes sense in this case. # Translation impact Two new language files with 8 new language tags. # Core changes * New User Plugin Event „onUserBeforeDataValidation“ * New User Plugin Event „onUserAfterDataValidation“ * New JForm Class method getFieldXml as public getter for the protected method findField * New parameter path for the setField method of JForm, allows to add a field at a specific place in the xml tree. All core changes are only additions and full B/C, even if the plugin isn’t accepted these changes allow more flexibility for JForm. # Testing instruction * Apply the patch * go to extensions and discover install the new plugin * enable the plugin * enable user registration 1) Test registration process 2) Test login 3) Test profile edit frontend 4) Test user data change backend

richard67 · 2016-05-08T22:24:40Z

administrator/language/en-GB/en-GB.plg_user_simplify.ini

+PLG_USER_SIMPLIFY_EMAIL="Email (username)"
+PLG_USER_SIMPLIFY_USERNAME="Email"
+PLG_USER_SIMPLIFY_FIELD_REMOVENAME_DESC="Remove name field from forms."
+PLG_USER__SIMPLIFY_FIELD_REMOVENAME_LABEL="Remove Name"


Why 2 underscores in this text name?

just a typo

brianteeman · 2016-05-08T22:29:40Z

administrator/language/en-GB/en-GB.plg_user_simplify.ini

+PLG_USER_SIMPLIFY_USERNAME="Email"
+PLG_USER_SIMPLIFY_FIELD_REMOVENAME_DESC="Remove name field from forms."
+PLG_USER__SIMPLIFY_FIELD_REMOVENAME_LABEL="Remove Name"
+PLG_USER_SIMPLIFY_XML_DESCRIPTION="Simplify the user registration, allows registration only with email address"


it would be better as

+PLG_USER_SIMPLIFY_XML_DESCRIPTION="Simplify the user registration process. This allows registration only with email address."

brianteeman · 2016-05-08T22:30:51Z

Made som en-GB suggestions inline

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/10347.}

smz · 2016-05-08T22:37:11Z

A very good idea... with a not so good name!
I find "simplify" to be a too broad concept/name: why not "emailonly"?

mbabker · 2016-05-08T22:37:41Z

components/com_users/views/profile/tmpl/default_core.php

+
+	$plugin = JPluginHelper::getPlugin('user', 'simplify');
+
+	$params = (new JRegistry)->loadString($plugin->params);


You've got PHP 5.4 code here

@brianteeman

Thanks @brianteeman, @mbabker, @richard67

rdeutz · 2016-05-09T05:46:29Z

I made the suggested changes, thanks all for looking into it. I don't care so much about the name. Maybe @mikeveeckmans can make a suggestion with the marketing hat on.

SharkyKZ · 2016-05-09T06:23:38Z

Are you sure a plugin is the correct approach here? Wouldn't it be better off as an option in com_users?

roland-d · 2016-05-09T06:32:19Z

@pe7er Are you not doing something similar?

zero-24 · 2016-05-09T06:36:46Z

plugins/user/simplify/simplify.php

+			$data['name'] = $value;
+		}
+
+		if ($this->params->get('remove_username_field', 1) == 1)


There is no option for "remove username field" in the plugin options we just have the first one

Thanks for spotting this, I changed my mind and removed the option because you can simple disable the plugin to achieve the same

zero-24 · 2016-05-09T06:40:15Z

We need the languagetag change also for the com_joomlaupdate login view :)

rdeutz · 2016-05-09T07:00:48Z

@SharkyKZ if you do it in com_user then you would simply allow the make some fields optional, that sounds easier but it is a big change that would effect also other extensions. The plugin just copies some data and does a bit of reordering fields. I think that is the minimalistic way to achieve the goal and has (hopefully) no side effects.

@zero-24 not sure what you are talking about, I didn't made the SQL changes so that the plugin is part of the package, though before spending time on this I will make sure it goes in :-)

infograf768 · 2016-05-09T07:10:11Z

hmm, a new plugin. You also have to modify the admin language/en-GB/install.xml

rdeutz · 2016-05-09T07:14:11Z

Thanks for all the notes what I have to do but if nobody tests this it will go to nowhere :-)

zero-24 · 2016-05-09T07:17:54Z

@rdeutz see: https://github.com/joomla/joomla-cms/blob/staging/administrator/components/com_joomlaupdate/views/upload/tmpl/captive.php

Its a login view too so it needs to be catched here too.

A test is on my todo list but it is not that easy on phone ;)

We also need to add update SQL changes and the script php. Let me know if i should send it as pull request to your branch ;)

infograf768 · 2016-05-09T07:59:54Z

I have tested this item 🔴 unsuccessfully on d71ee98

When the plugin is enabled, when the user is editing in back-end his profile the values of name and username are changed to the user email.

_{This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/10347.}

brianteeman · 2016-05-09T08:02:50Z

Does this needs to be in the core. There are several extensions that already do this.

rdeutz · 2016-05-09T08:04:53Z

@infograf768 that's expected behaviour. These fields aren't available, if I allow to change the username I can't really know how I should login someone.

infograf768 · 2016-05-09T08:06:33Z

@rdeutz
This is not B/C at all. It broke my Super User credentials.

rdeutz · 2016-05-09T08:14:35Z

@infograf768 let me guess, username is now the same as you email, right?

@brianteeman good question, I have seen one that does it over a special register form. It is not really the same

infograf768 · 2016-05-09T08:16:15Z

As I said : the Name (It was Super User) and Username (was admin) are changed to the user email

rdeutz · 2016-05-09T08:27:12Z

As I said: expected behaviour. You can't have both, register with only email/password and then login with a username

infograf768 · 2016-05-09T08:29:21Z

Yes, this is why I say it is not B/C and vote against this plugin which can be enabled without the knowledge of its consequences.
It should respect existing user credentials while providing, if desired, the new type of credentials.

brianteeman · 2016-05-09T08:36:38Z

This is one on the JED. There may be more I can't really use the JED on my phone.

http://extensions.joomla.org/extensions/extension/access-a-security/site-access/email-as-username

brianteeman · 2016-05-09T08:37:49Z

Also I guess this is not suitable for any site that displays an author name. As with this plugin it would display the email address as the author.

infograf768 · 2016-05-09T08:39:43Z

and not cloaked...

rdeutz · 2016-05-09T08:39:56Z

@brianteeman you can enable the name field

pe7er · 2016-05-09T08:45:26Z

@roland-d Yeah, last week I was trying to write my own plugin to register with your Email address only. My reason was to lower the threshold to register at a website.

My plugin would remove the Name, Username, 2nd Email + 1st Password + 2nd Password field. Username + Password would be generated by the plugin. I noticed that some events were missing and ran into problems sending the right data in the email notification.

Having new events would make it much easier to change the registration form.

rdeutz · 2016-05-09T08:51:28Z

@pe7er I though about removing the 2nd email/password fields. I also run into some problems with JForm and the fact that the validation runs on the request data (what makes 100% sense). If you check my code you will see I added new events and called it in the models. I might split this PR into 2, one with the non plugin code changes and another with the plugin itself.

bembelimen · 2016-05-09T08:59:36Z

I don't like the fact, that com_users output looks explicit if this plugin is installed/activated. Because I have my own plugin which do something similar + split the name field. If I want to use this feature, I have to activate this plugin and override every change with my own.
Perhaps it's possible to add a more general approach

Bakual · 2016-05-09T09:00:03Z

I wouldn't put such a plugin into core, but I think we should make the life easier for those who want to create such plugins.
So if it's the plugin events that are missing, lets add those and make com_users more extendible but don't necessary add an own plugin.

rdeutz · 2016-05-09T09:04:38Z

ok, let me spilt it. As long as we make these things possible I don't care if the plugin goes into core or not

SharkyKZ · 2016-05-09T09:04:38Z

you can enable the name field

Also consider 3rd party extensions which display usernames instead of names. I've seen many of those. Perhaps add options to customize usernames (e.g. based on IDs, randomly generated, etc.). And then use actual email for authentication.

In any case, I still think this should be a part of com_users rather than a separate plugin.

rdeutz · 2016-05-09T09:41:50Z

Closing this one here, I have created #10350 and #10351 with the need functions to make a plugin like this.

rdeutz added 3 commits May 8, 2016 23:41

Code Style

0a9911a

Unit tests fix method compatability, code styles again

c9c58b2

joomla-cms-bot added Language Change This is for Translators PR-staging Unit/System Tests labels May 8, 2016

rdeutz added the Feature label May 8, 2016

rdeutz added this to the Joomla 3.6.0 milestone May 8, 2016

richard67 reviewed May 8, 2016
View reviewed changes

joomla-cms-bot removed this from the Joomla 3.6.0 milestone May 8, 2016

brianteeman reviewed May 8, 2016
View reviewed changes

mbabker reviewed May 8, 2016
View reviewed changes

minor changes after codereview

d71ee98

Thanks @brianteeman, @mbabker, @richard67

rdeutz added this to the Joomla 3.6.0 milestone May 9, 2016

zero-24 reviewed May 9, 2016
View reviewed changes

rdeutz removed this from the Joomla 3.6.0 milestone May 9, 2016

rdeutz closed this May 9, 2016

rdeutz mentioned this pull request May 9, 2016

New Plugin Events onUserBeforeDataValidation #10351

Closed

rdeutz mentioned this pull request May 23, 2017

Let users use their username OR password as credential to log in #15725

Closed

rdeutz mentioned this pull request Mar 1, 2018

[4.0] RFC: Drop username, use email instead #19785

Closed

rdeutz deleted the add_simplify_plugin branch February 20, 2020 22:33


		$plugin = JPluginHelper::getPlugin('user', 'simplify');

		$params = (new JRegistry)->loadString($plugin->params);

Uh oh!

Conversation

rdeutz commented May 8, 2016 • edited by joomla-cms-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Executive summary

Backwards compatibility

Translation impact

Core changes

Testing instruction

Uh oh!

richard67 May 8, 2016

Choose a reason for hiding this comment

Uh oh!

rdeutz May 9, 2016

Choose a reason for hiding this comment

Uh oh!

brianteeman May 8, 2016

Choose a reason for hiding this comment

Uh oh!

brianteeman commented May 8, 2016

Uh oh!

smz commented May 8, 2016

Uh oh!

mbabker May 8, 2016

Choose a reason for hiding this comment

Uh oh!

rdeutz commented May 9, 2016

Uh oh!

SharkyKZ commented May 9, 2016

Uh oh!

roland-d commented May 9, 2016

Uh oh!

zero-24 May 9, 2016

Choose a reason for hiding this comment

Uh oh!

rdeutz May 9, 2016

Choose a reason for hiding this comment

Uh oh!

zero-24 commented May 9, 2016

Uh oh!

rdeutz commented May 9, 2016

Uh oh!

infograf768 commented May 9, 2016

Uh oh!

rdeutz commented May 9, 2016

Uh oh!

zero-24 commented May 9, 2016

Uh oh!

infograf768 commented May 9, 2016

Uh oh!

brianteeman commented May 9, 2016

Uh oh!

rdeutz commented May 9, 2016

Uh oh!

infograf768 commented May 9, 2016

Uh oh!

rdeutz commented May 9, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

infograf768 commented May 9, 2016

Uh oh!

rdeutz commented May 9, 2016

Uh oh!

infograf768 commented May 9, 2016

Uh oh!

brianteeman commented May 9, 2016

Uh oh!

brianteeman commented May 9, 2016

Uh oh!

infograf768 commented May 9, 2016

Uh oh!

rdeutz commented May 9, 2016

Uh oh!

pe7er commented May 9, 2016

Uh oh!

rdeutz commented May 9, 2016

Uh oh!

bembelimen commented May 9, 2016

Uh oh!

Bakual commented May 9, 2016

rdeutz commented May 8, 2016 •

edited by joomla-cms-bot

Loading

rdeutz commented May 9, 2016 •

edited

Loading