Jump to content

FrontendUser: login, logout and register users / members


Recommended Posts

FrontendUser
 
The FrontendUser module provides a frontend login, logout and user registration functionality.

 
Features

See module documentation for details.

  • login with error handling and value sanitizing
  • Plugin: ProcessForgotPassword core module integration
  • Plugin: LoginPersist module integration
     
  • user registration with username and email address already in use check
  • email adress pre-register validation (email verification)
     
  • Extendable with additional fields and by PW hooks
  • forms generated by PW form api
     
  • Custom style / script 
     

Requirements

Usage

Repository

ToDo / Issues

I hope it will be helpful to the community and I would be glad to get feedback or suggestions for improvement!

  • Like 8
Link to post
Share on other sites

Hi pwFoo. I've tried to install first FormHelper on a clean local installation with Mamp Pro (PW 2.5.29, PHP 5.6.2). FormHelper.module was installed properly, but the FormHelperExtra.module gives me the following error: "Unable to install module 'FormHelperExtra': Can't save page 0: /fhstorage/: It has no parent assigned".

post-192-0-54688400-1430739618_thumb.png

Link to post
Share on other sites

Hello jacmaes,

fhstorage is a hidden admin page to handle file uploads to not existing pages (during frontend page creation for example). It should be added and removed during FormHelperExtra module un-/install. I'll take a look at it later.

But FormHelperExtra isn't needed! Just install FormHelper and FrontendUser modules and it should work.

Link to post
Share on other sites

Thanks. I realize that FormHelperExtra was not needed, so I went ahead and successfully installed everything else. The login and registration process work fine in my test environment, and it's pretty easy and quick to implement. Great job. 

Now I'd like to go one step further, and allow users to edit their profiles (after adding fields to the user template like "first name", "last name" and "birthdate" for example). I believe that FormHelper should help out with this, but how should I proceed? Could you add a simple example to the module docs? 

Link to post
Share on other sites

I should be easy to extend the register form with additional fields (like done with the login and register plugins examples).

A FrontendUserProfile is planned and should be easy to build with the FormHelper module (and also without, but I like it ;) It simplify some tasks like sanitize values or form processing). Maybe ProcessProfile core module could do the job...

I take a look and maybe add a simple example, but that should be moved to the FormHelper topic.

  • Like 1
Link to post
Share on other sites

Here is the source code of the LoginPersist integration.

        $persist = $this->modules->get('InputfieldCheckboxes');
        $persist->name = 'persist';
        $persist->attr('id+name', 'persist');
        $persist->skipLabel = 4;
        $persist->addoption('persist', $this->_('Remember me?'));
        $persist->addHookAfter('Session::login', function($event) use (&$persist) {
            if (isset($persist->value[0]) && $persist->value[0] === 'persist') {
                $this->modules->get('LoginPersist')->persist();
            }
        });

The examples hook into existing form fields.

Add own fields (example "$myField") or change order

$fu->login(array('username', 'password', 'persist', 'forgot', $myField));

See basic usage

Link to post
Share on other sites

Updated FU version 0.8.2 replaced hard coded verification email with simple html / plain templates to send an html email with wiremail. Has to be improved / changed in the future, but I don't know how I'll implement it (module configuration, template, ...) to keep it flexible and simple.

  • Like 1
Link to post
Share on other sites

I have some problems with the email template / config. Subject and text should be configurable, but I won't write a template parser to replace tokens like 

{{token}}
{{url}}
...

or something similar. 

Write the text to the template isn't a good way and also not translatable.

So how should / could it be done a nice way?

  1. Set text block in module configuration to be shown before the token / link?
  2. Move the complex email verification plugin to a separated module file with own config section?
  3. Use a page for email subject / text to be translatable like other fields?
  4. ...

I try to build a universal usable login / register module, so suggestions and feedback is welcome! ;)

Link to post
Share on other sites

Version 0.8.3

  • moved email validation to sub-module FrontendUserRegisterEmailValidation
  • Added FrontendUserRegisterEmailValidation module configuration (email subject and text)
  • Removed plain email template (now generated by php based on the html one)
  • simple example html email template
Link to post
Share on other sites

Hi again ;-)

thanks for the tips regarding php 5.3 workaround - that did the trick!

Another (minor) issue I encountered is that the generated email will still append the "normal" _main.php template file, which results in a doubled html / body code and may confuse some mail clients. By changing the line

//$mail->body($emailContentPlain)->bodyHTML($emailContentHtml);
$mail->body($emailContentPlain);

in FrontendUserRegisterEmailValidation.module the regex will strip out the _main.php tags as well, which for me right now works as a workaround, but of course I am wondering where I'd be able to undo the automatic appending of the _main.php … my guess is, that

$emailContentHtml = wire('page')->render($this->fu->getFile('validationEmail.php', 'templates'), $vars);

is the right place to look, but I've yet to find the correct setting for $vars. :-)

cheers;
Tom

Link to post
Share on other sites

Hi Tom,

I think the email template isn't loaded! 

Again a PHP 5.3 workaround is needed ;)

I have an idea how to fix it and make the module compatible to PHP 5.3. I'll update it soon!

  • Like 1
Link to post
Share on other sites

hi,

sorry for being unclear, the email template is loaded, i.e. the infos and content etc are in the email. it's only that after that, the _main.php is included, as well, which in my case will add additional (and content-less) html,body,etc markup to the already existing html,body,etc markup in the mail's source code. :-) Changes to the email template are reflected in the mail sent. It's only the additional markup that I'm wondering about.
 

Link to post
Share on other sites

ok. Maybe a prepand / append to template problem? Could you check the config file?

I load a custom template from module folder. Maybe I need another way to load it to prevent the template append / prepand...

Updated module to 0.8.4 / email validation plugin to 0.0.2. 

  • module instance / object is now available via wire('fu') to simplify plugin hooks and...
  • add PHP 5.3 compatibility :)

Minimum tested at the moment! Could you test it and post the results here?

  • Like 1
Link to post
Share on other sites

Thanks for feedback. 

Is the template append problems also fixed with the new version?

Because that was also a anonymous function / php 5.3 problem.

Have to verified that the FrontendUserRegisterEmailValidation module configuration is working? It's used as email subject ($this->subject) an prepanded email text ($this->content). Works fine with php 5.5, but haven't tested it with php 5.3.

I merged your latest master with my local changes, keeping your 5.3 compat changes.

Could you tell me that you have changed? Customization should be possible without hack / modify the module. Just with PW hooks, custom plugins and additional fields ;)

Link to post
Share on other sites

Hi,

well, basically I added a function to send another mail after sucessful registration, and bypassed the need to login after the user has entered his/her desired password in the second step.

I can send you a pull request of my dev-branch if you like, but rather wouldn't have this public for now since we hard-coded some email adresses and client-related stuff into the code… may I mail you a zip or invite you to our bitbucket team so you can see the fork?
(it's all a bit rushed right now b/c it needs to work tomorrow morning (launch) :-D )

Link to post
Share on other sites

The hole email verification (hide password field, add verification code field, process additional fields and send the email) is based on hooks without a FU module modification. ;)

Additional email and auto login should be done by an additional hook ;)

Maybe I can take a look in the evening, but don't know yet...

FrontendUser module should work fine, but keep in mind it's alpha at the moment and needs testing!

Link to post
Share on other sites

the template append is still there.

here's a excerpt from the mail source code if the

$mail->body($emailContentPlain)->bodyHTML($emailContentHtml);

is used, if I change this to

$mail->body($emailContentPlain);

the mail is ok (due to the regex stripping I guess).

--==Multipart_Boundary_x737b845286a9a5899d535817f4d80ca2x
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 7bit

<html>
    <body>
        <p>Thank you, (snip snap) .... </p>
        <!-- empty line and comment only lines works as a linebreak with plain emails -->
        
        <p>User: Testtest<br />
        Email: test@test.te</p>

        <p>Code: 2b7d110cb29be35bbac13d506e02f7de</p>

        <p>Link: (domain)/registration/?registerToken=2b7d110cb29be35bbac13d506e02f7de</p>
    </body>
</html>
<!DOCTYPE html>
<html lang="de">
<head>
    <meta charset="utf-8" />
    <title></title>
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <script type="text/javascript" src="/site/templates/js/modernizr-custom.js"></script>

    <link rel="stylesheet" type="text/css" href="/site/templates/css/styles.css">

</head>
<body id="pid-1032" class="pid-1032 p-registration t-user_registration">
<div class="page">
            <main class="page-main">
        <!-- main content -->
            </main>
    <footer class="page-footer">
        <div class="container">
                    </div>
    </footer>
</div>
<script type="text/javascript" src="/site/templates/js/jquery.min.js"></script>
<script type="text/javascript" src="/site/templates/js/scripts.js"></script>

</body>
</html>

--==Multipart_Boundary_x737b845286a9a5899d535817f4d80ca2x--

The hole email verification (hide password field, add verification code field, process additional fields and send the email) is based on hooks without a FU module modification. ;)

Additional email and auto login should be done by an additional hook ;)

Maybe I can take a look in the evening, but don't know yet...

FrontendUser module should work fine, but keep in mind it's alpha at the moment and needs testing!

yes, and thank you for the alpha reminder ;-)
I need to learn the hook things better, and then I'll keep my fingers out of the module's code, promised! :-)

ah, and of course I don't expect you to tackle my problems here (just realised that the above may be read as "uh it's urgent, please have a look") but this is not how it was meant; I mentioned it only as an explanation why I hacked in your module's code :-))

Link to post
Share on other sites

No problem. If you send me the additional code and I have the time I could rewrite it to a hook.

I would like to see the module used by the community and extended by hooks / plugins to keep the module core simple, clean and reusable ;)

Custom plugins could be added to my git repo / wiki to share with other PW users.

I'm also interested in feedback if you use it inside a project. Just to see how it could be improved.

  • Like 1
Link to post
Share on other sites

Version 0.8.5

  • Add some more comments to FrontendUserRegisterEmailValidation module
  • FrontendUser::auth() is now hookable (to build a auto login after sucessful user registration)
  • Add usage shorthand to call login / register with one method call by set a second param ($redirect)
    // load module
    $fu = $modules->get('FrontendUser');
    
    // login
    echo $fu->login(null, $redirectDestination);   // with default fields
    //echo $fu->login(array('username', 'password', 'persist', 'forgot'), $redirectDestination);
    
    // load module
    $fu = $modules->get('FrontendUser');
    
    // registration
    echo $fu->register(null, $redirectDestination);  // with default fields
    //echo $fu->register(array('username', 'email', 'emailValidation', 'password'), $redirectDestination);
    

The compatibility to PHP 5.3 seems to work fine, but isn't fully tested. Because Processwire 2.5 / 2.6 requires PHP 5.3+ I would't increase the requirements to PHP 5.4 ;)

  • Like 2
Link to post
Share on other sites

I'm testing the latest version, but:

Apache/2.2.23 (Unix) mod_ssl/2.2.23 OpenSSL/0.9.8r DAV/2 PHP/5.4.10

Compile Error: Can't use method return value in write context (line 63 of /Volumes/Docs/MAMP/htdocs/pwire_test05/site/modules/FrontendUser/FrontendUser/FrontendUserRegisterEmailValidation.module) 
Link to post
Share on other sites

Hello Macrura,

line 63 of FrontendUserRegisterEmailValidation.module:

        if (empty(wire('session')->get('registerStep'))) {

Seems to be PHP < 5.5 related...

Note:

Prior to PHP 5.5, empty() only supports variables; anything else will result in a parse error. In other words, the following will not work: empty(trim($name)). Instead, use trim($name) == false.

 To be compatible with PHP 5.3 and 5.4 I have to check the usage of empty() in combination with wire() and replace such calls... I'll take a look later.

You could test this:

//        if (empty(wire('session')->get('registerStep'))) {
        $session = wire('session');
        if (empty($session->get('registerStep'))) {
Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • 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?
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
×
×
  • Create New...