Jump to content

FrontendUserLogin


Recommended Posts

FrontendUserLogin
 
Module to handle frontend user login / logout.

Also should work with Persistent login for users (mode: automatically) out of the box

Version

  • 0.3.1

Requires

Download

Usage

Module isn't available anymore, but it's planed to replace FrontendUserLogin and FrontendUserRegister with the new FrontendUser module which is not released yet.

A new support topic will be created after FrontendUser module is added to the PW module repo.

FrontendUser module

Edited by pwFoo
  • Like 7
Link to post
Share on other sites
  • 1 month later...

Released version 0.1.0

  • minor changes
  • updated compatibility to FormHelper 0.3.2
  • moved render() out of the login() method to make the form changeable via public FormHelper class variable $this->fh->...
  • username sanitized by FormHelper (sanitizer set in username field array)

I would like to make the module flexible and extendable, but at the moment no addons / plugins implemented...

Link to post
Share on other sites
  • 1 month later...

New branch with removed FormHelper dependency. Instead it uses the new form api array input support.

Works in my local test environment. Simple frontend login module with error handling.

After some time playing with JavaScript / ajax I should finish some basic modules *g*

Link to post
Share on other sites
  • 1 month later...

FrontendUserLogin 0.3 released (dev / unstable)

Updated initial post. Tests and feedback welcome! :)

  • FormHelper dependency is removed
  • should work with Persistent login for users  (mode: automatically) out of the box
  • simple error handling (login failed, LoginThrottle, missing required value)

  • Strings translatable by using $this->_()

  • code optimized and some hookable methods removed (use PW Session methods instead!)
    Session::login
    Session::authenticate
    Session::logout
    Session::redirect
  • hookable methods to modify form fields and form process / validation. Also to extend module with plugins / addons.
    FrontendUserLogin::processForm
    FrontendUserLogin::buildLoginForm
    

ToDo

  • Change password field type to password (at the moment isn't supported by PW?!)
  • Remove (optional) field labels (seems not working after field is added to the form object?!)
  • maybe a default style and optional add custom css / js code
  • Change integration of Persistent login for users via plugin module (add Remember me checkbox and trigger PersistLogin manual mode)
  • Forgot Password core module integration?
Edited by pwFoo
Link to post
Share on other sites

Login module should work, but the form is unstyled.

A plugin is a module with attach / detach during install / uninstall to the parent module.

Demo plugins (minimal tested!) are

  • persistLogin module integration (manual mode, remember me checkbox)
  • ProcessForgotPassword (core module) integration

https://bitbucket.org/pwFoo/frontenduserlogin/src/be5b84b78d24060872d0ae96f2e7631f50028099/FrontendUserLogin/?at=master

Edited by pwFoo
Link to post
Share on other sites
  • 1 month later...

I have a local testing version with field callbacks ("prepare" before added to form and "process" after form "basic" process) and preLogin / postLogin callbacks

Possible usage:

// Integrate LoginPersist module (manual mode) after sucessfully logged in
$callback['postLogin'] = function ($fulObj) {
    if ($fulObj->attr('result')) {
        wire('modules')->get('LoginPersist')->persist();
    }
};

// optional login with email address instead of an username... (could also be done as username form field callback "process"! Just an example!!!)
$callback['preLogin'] = function ($fulObj) {
// callback defined outside the module class, so $this and private class attributes won't work!
// module object hand over as function param. Get / set attributes with the attr() method.
$email = $fulObj->attr('form')->get('username')->value;
$userObj = wire('users')->get("email={$email}");
if ($userObj instanceof User) $fulObj->attr('user', $userObj->name);
};

// login call with optional callback
echo $ful->login("{$config->urls->root}login", $callback)->render();

Internal field process callback (sanitize input value)

/**
 * Username form field
 * @return object Username field
 */
protected function fieldUsername() {
    $field = $this->modules->get('InputfieldText');
    $field->label = $this->_('Username');
    $field->attr('id+name', 'username');
    $field->required = 1;
    // Set a "callbackProcess" to sanitize the input value or a "callbackPrepare" executed just before the field will be added to the form
    $field->fulOption = array(
        'callbackProcess' => function ($field) {
//      'callbackProcess' => function ($field, $obj) { // to get module object also outside the module class use an additional param
            // callback defined inside the module class and $this will work here. Also wire() could be used
            $this->user = wire('sanitizer')->username($field->value);
        },
        'callbackPrepare' => function ($field) {
            // Your code here... will be executed before field added to form
        }
    );
    return $field;
}

What do you think about the change and usage of dynamic functions as callbacks?

Link to post
Share on other sites
  • 3 weeks later...

Latest update to my local testing branch...

  • Moved totally from custom callbacks to PW hooks (core and module own hookable methods)
  • Have a working minimal FrontendUserLogin and FrontendUserRegister module.
  • Added FormHelper dependency again (instead of a extended wrapper FormHelper is changed to extend InputfieldForm object)

FrontendUserLogin / FrontendUserRegister (simple use)

// login
echo $modules->get('FrontendUserLogin')->render($redirectAfterLogin);

// register
echo $modules->get('FrontendUserRegister')->render($redirectAfterRegister);

The method render() is a shortcut. Long form with chance to modify parameters, form, ... 

$fu->form();
$fu->validate();
$fu->process($redirect);
$fu->renderForm();

How to add plugins?

After $fu->form() define the plugin field and needed processing validation code as a PW hook

RememberMe plugin to integrate LoginPersist module

    // RememberMe field / persistLogin integration
    $remember = $modules->get('InputfieldCheckboxes');
    $remember->name = 'persist';
    $remember->attr('id+name', 'persist');
    $remember->skipLabel = 4;
    $remember->addoption('persist', 'Remember me?');
    $remember->addHookAfter('processInput', function($event) {
        $field = $event->object;
        if (isset($field->value[0]) && $field->value[0] === 'persist') {
            wire()->addHookAfter('Session::login', function($event) {
                wire('modules')->get('LoginPersist')->persist();
            });
        }
    });
    $fu->attr('form')->add($remember);

Or an integration of core module ProcessForgotPassword

    // ForgotPassword integration
    $forgot = $modules->get('InputfieldMarkup');
    $forgot->value = "<a href='{$page->url}?forgot=1'>{$this->_('Forgot password?')}</a>";
    $fu->attr('form')->add($forgot);
    
    if ($input->get->forgot) {
        function processForgot($event) {
            wire('config')->styles->add('/pw/wire/modules/AdminTheme/AdminThemeDefault/styles/main-classic.css');
            $event->return = wire('modules')->get('ProcessForgotPassword')->execute();
            $event->replace = true;
        }
        $fu->addHookBefore('FrontendUserLogin::login', null, 'processForgot');
    }

Login with email address instead of username?

    // Email login instead of username
    $fieldUser = $fu->attr('form')->get('username');
    $fieldUser->addHookBefore('FrontendUserLogin::auth', function($event) {
        $fu = $event->object;
        $email = $fu->attr('form')->fhValue('username', 'email');
        $loginUser = wire('users')->get("email={$email}");
        if ($loginUser instanceof User && !$loginUser->isGuest()) {
            $event->arguments(0, $loginUser->name);
        }
    });

You have added a nickname field to user template? The plugin to use the nickname (sanitized text instead of username) to login

    // Nickname login instead of username
    $fieldUser = $fu->attr('form')->get('username');
    $fieldUser->addHookBefore('FrontendUserLogin::auth', function($event) {
        $fu = $event->object;
        $nick = $fu->attr('form')->fhValue('username', 'text');
        $loginUser = wire('users')->get("nickname={$nick}");
        if ($loginUser instanceof User && !$loginUser->isGuest()) {
            $event->arguments(0, $loginUser->name);
        }
    });

The plugins are tested and working fine, but I don't know how to ship plugins. At the moment it's code inside the template login.php, but should be moved to a separate plugin file or the FrontendUserLogin module...

Any suggestions?

*Added nickname login plugin and fixed a nickname / email login bug*

Edited by pwFoo
  • Like 4
Link to post
Share on other sites

Here is a FrontendUserLogin screenshot with additional fields (PersistLogin, ProcessForgotPassword integration) and a basic style (removed list style), Form fields without label and placeholder instead.

Frontent_User_Login.jpg

Default css / js can be added inside the module directory. Custom styles will be loaded from templates/FrontendUserLogin/FrontendUserLogin.<css|js>.

FormHelper dependency could be replaced, but in version 0.7+ FormHelper isn't that big and no need to copy & paste form handling to each module with forms or file upload (FrontendUserLogin, FrontendUserRegister, contact form, ...).

  • Like 1
Link to post
Share on other sites

FrontendUserLogin module deletion requested, because it's an old and deprecated version.

Last posts here reference to a redesigned and not compatible new module / branch.

I have deleted this module from the directory, but you should consider removing the link from your first post and explain to users what the alternative is.

Link to post
Share on other sites
  • 2 weeks later...
  • 2 weeks later...

FrontendUser module handles login, logout and user registration.

I moved the complex email validation plugin, ProcessForgotPassword and LoginPersist module integration into the FrontendUser module for testing.

If anyone would do some tests...

Repo: https://bitbucket.org/pwFoo/frontenduser/overview

Doku: https://bitbucket.org/pwFoo/frontenduser/wiki/Documentation

Current download for testing: https://bitbucket.org/pwFoo/frontenduser/get/master.zip

  • Like 2
Link to post
Share on other sites
  • 2 weeks later...

hi pwFoo,

i'm toying around with your great register module. I have a php fatal error and since i'm not-so in-depth to php/versions/objectoriented stuff, would you mind and confirm or not if this may be caused by me being forced to use PW in a php 5.3 environment?
PW (2.58) in itself runs fine; but I noticed from the earlier notes in your module that it needed php >5.5 (?). Anyhow the error looks like $this (no pun intented):

Fatal error: Using $this when not in object context in /var/www/<snipsnap>/site/modules/FrontendUser/FrontendUser.module on line 252

which refers to this line

$username = $this->form->fhValue($field->name);

in here:

protected function usernameRegister() {
        $field = $this->modules->get('InputfieldText');
        $field->label = $this->_('Username');
        $field->attr('id+name', 'username');
        $field->required = 1;
        $field->fhSanitizer = 'username';
        $field->addHookAfter('processInput', function($event) {
            $field = $event->object;
            $username = $this->form->fhValue($field->name);
            
            if (empty($username))   return;
            elseif (wire('users')->count("name={$username}") == 0) {
                $this->userObj->name = $username;
            }
            else {
                $field->error(__('Username already taken!'));  
            }
        });
        return $field;
    }

many thx for the module :-)

cheers
Tom

Link to post
Share on other sites

Hello Tom,

thank You for your feedback here!

It's a anonymous function problem / missing feature. I have to add a PHP 5.4 dependency or find a workaround. I missed that because I tested it with a PHP 5.5.24. 

Version Description 5.4.0 $this can be used in anonymous functions. 5.3.0 Anonymous functions become available.

See here: http://php.net/manual/en/functions.anonymous.php

That could be a workaround...

    /**
     * Username form field
     * @return InputfieldText Username field
     */
    protected function usernameRegister() {
        $field = $this->modules->get('InputfieldText');
        $field->label = $this->_('Username');
        $field->attr('id+name', 'username');
        $field->required = 1;
        $field->fhSanitizer = 'username';

        // workaround PHP 5.3
        $fu = $this; 
        //$field->addHookAfter('processInput', function($event) {
        $field->addHookAfter('processInput', function($event) use ($fu) {
            $field = $event->object;
            // workaround PHP 5.3
            //$username = $this->form->fhValue($field->name);
            $username = $fu->attr('form')->fhValue($field->name);

            if (empty($username))   return;
            elseif (wire('users')->count("name={$username}") == 0) {
                // workaround PHP 5.3
                //$this->userObj->name = $username;
                $fu->attr('userObj')->name = $username;
            }
            else {
                $field->error(__('Username already taken!'));  
            }
        });
        return $field;
    }

I think some more changes like that have to be done to get it work with PHP 5.3

But I don't know if it make sense to make it PHP 5.3 compatible. But should be no problem if that's all...

P.S.:

Sorry for confusion of different topics *g*

The correct support topic is: https://processwire.com/talk/topic/9811-frontenduser-login-logout-and-register-users-members/

  • Like 1
Link to post
Share on other sites
Guest
This topic is now closed to further replies.
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules Fluency is free, and now so is DeepL
      Since this module was first built DeepL has introduced free Developer accounts that allow anyone to start using Fluency at zero cost and beginning with the version 0.3.0 release Fluency now supports free DeepL accounts. As of June 2021 DeepL supports translation to 26 languages and continues to offer more!
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Github issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Github page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      The Module Is Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader).
      DeepL Developer Accounts
      In addition to paid Pro Developer accounts, DeepL now offers no-cost free accounts. Now all ProcessWire developers and users can use Fluency at no cost.
      Learn more about free and paid accounts by visiting the DeepL website. Sign up for a Developer account, get an API key, and start using Fluency today.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Chris Bennett
      https://github.com/chrisbennett-Bene/AdminThemeTweaker
      Inspired by @bernhard's excellent work on the new customisable LESS CSS getting rolled into the core soon, I thought I would offer up the module for beta testing, if it is of interest to anyone.

      It takes a different approach to admin styling, basically using the Cascade part of CSS to over-ride default UiKit values.
      Values are stored in ModuleConfig Module creates a separate AdminThemeTweaker Folder at root, so it can link to AdminThemeTweaker.php as CSS AdminThemeTweaker.php reads the module values, constructs the CSS variables then includes the CSS framework Can be switched on and off with a click. Uninstall removes everything, thanks to bernhard's wonderful remove dir & contents function.
      It won't touch your core. It won't care if stuff is upgraded. You won't need to compile anything and you don't need to touch CSS unless you want to.

      It won't do much at all apart from read some values from your module config, work out the right CSS variables to use (auto contrast based on selected backgrounds) and throw it on your screen.
      You can configure a lot of stuff, leave it as it comes (dark and curvy), change two main colors (background and content background) or delve deep to configure custom margins, height of mastheads, and all manner of silly stuff I never use.

      Have been developing it for somewhere around 2 years now. It has been (and will continue to be) constantly tweaked over that time, as I click on something and find something else to do.
      That said, it is pretty solid and has been in constant use as my sole Admin styling option for all of those 2 years.

      If nothing else, it would be great if it can provide any assistance to @bernhard or other contributor's who may be looking to solve some of the quirkier UiKit behavior.
      Has (in my opinion) more robust and predictable handling of hidden Inputfields, data-colwidths and showIf wrappers.
      I am very keen to help out with that stuff in any way I can, though LESS (and any css frameworks/tools basically) are not my go.
      I love CSS variables and banging-rocks-together, no-dependency CSS you can write with notepad.



       

    • By opalepatrick
      I see old posts saying that repeaters are not the way to go in Custom Process Modules. If that is the case, when using forms (as I am trying to do) how would one tackle things like repeat contact fields where there can be multiple requirements for contact details with different parameters? (Like point of contact, director, etc) or even telephone numbers that have different uses?
      Just for background I am creating a process module that allows me to create types of financial applications in the admin area (no need to publish any of this, pure admin) that require a lot of personal or company information.
      Maybe I am thinking about this incorrectly?
    • By HMCB
      I ran across a reference to IftRunner module. The post was 6 years ago. I cant find it in available modules. Has it been pulled?
×
×
  • Create New...