DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Login User Tracking

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Donald Duck
Changed:2003-05-24T18:50:45
Author:Kasper Skårhøj
Email:kasper@typo3.com
Info 3:
Info 4:

EXT: Login User Tracking

Extension Key: loginusertrack

Copyright 2000-2002, Kasper Skårhøj, <kasper@typo3.com>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Login User Tracking 1

Introduction 1

What does it do? 1

Screenshots 1

User Manual 2

Usage of the statistics 2

Active users 2

Removing inactive users 3

Sending out newsletters 4

Configuration 5

To-Do list 5

Changelog 6

Introduction

What does it do?

This extension adds an extension class to tslib_fe and logs each login by a FrontEnd user in a database table. In the backend there is a module which allows a user to see how often users has logged in on the website.

Further you can see a list of active and inactive users based on when they logged in last time. You are able to send them a notification email and also delete users with a last login greater than a certain number of days. This notification feature could potentially be used to send newsletters to login users - although that was not the original intension.

Screenshots

img-1

User Manual

Usage of the statistics

Using the login statistics is very simple:

  • Simply click the module name in the left menu
  • Then click the page title of the sysFolder where your users are stored
  • Then select the function in the function menu of the module in the right frame.

This goes for the "Login log" and "Monthly view" functions:

img-2

Active users

You can also see a list of active users on your website.

Active users are measured by the last time a user logged in. You will have to determine what this limit is. So the first thing you do is to set the "last login" time in days:

img-3

The criterias for listing active users are that

they were created more than "last login" (here: 100) days ago (thus totally new users are ignored)

they have been logged in since this date

there is a difference between the creation date of the user and last login of at least 20 days.

Having these criterias mean that only "older users which are still active" are selected - and thus the number of "active" users should be relative trustworthy - even though some newer users could surely be very active as well - at the moment!

img-4

Removing inactive users

In the same way as you can select active users you can also see inactive users listed and even remove them. This is done by the function "Inactive users".

After selecting the "Last login" days limit you will see a list of users and in the bottom this form:

img-5

Before describing the options in the screenshot I will explain how this is basically meant to work; the idea is that you send a warning email to all users which have not logged in the last, say, 100 days. In the warning email you ask them to login within a certain time span like 10 days. 10 days after you use this module to select all users who have not logged in the last 110 days (100+10) and then you simply use the delete option to remove them!

The various options are explained as follows:

This is the field where you can write a warning message that will be sent to users. You can user the markers ###USERNAME###, ###NAME### and ###PASSWORD### as you can already see. Please check the text in the field and modify it to suit your needs. If you are going to delete users, then first check the delete box since that will insert another default message about deleting users.These messages will btw. have the same language as your backend user profile is using (if available).

"From" name of the email.

"From" email of the email

In this field you can enter your own frontend username (whether it is within the time span or not, it will be selected) and then you can send a test mail to yourself first.

Press this button to send the test mails.

If you want to delete the users based on the last-login date you check this option. Please make sure to read the instructions in the red field!! Notice that the idea here is that you first send a warning mail, then wait 10 days, then select the same users by using the criteria "110 days" instead of "100" (if that was what you used) and then delete the users who did not login in the mean time.NOTICE: If you delete users AND have some content in the Message field then that content will be sent as a notification - otherwise the users will just be deleted without further notice.

This is how it looks when you send warning emails. In this case I was testing the message by using my own username for lookup - I would simply remove that when I was ready.

img-6

Sending out newsletters

An unexpected effect of this notification system is that you can use it for simple, plaintext newsletters with insertion of name or username! This is done simply by selecting inactive users with a negative number of days. So just insert "-1" and "Last login" day, then you should have all users selected - and then you simply modify the message to be your newsletters content!

img-7

Tip: Getting the list of email addresses

If you just want a comma list of all the email addresses in the selected number of users simply look in the HTML source code of the module (this works for both the "Active" and "Inactive" function):

Lets say I have this listing:

img-8

Then in the source I will find this:

img-9

Configuration

From version 1.0.1 you will have to configure in the TypoScript template whether to log users. This is done by the CONFIG part of the TS object tree. Examples (all frames):

config.tx_loginusertrack_enable = 1

or

config.page.tx_loginusertrack_enable = 1

... if the logging should be enabled for only the "page" PAGE object (useful for frameset sites where pagehits should be logged only for the content frame).

Notice that the setting must also be applied to the target-frame page in order for the system to recognize the login.

To-Do list

  • Make it sensitive to the id of the page on which the login occured
  • Make weekly listing
  • Extension of this manual.

Changelog

((generated))

Version 1.0.2 - 1.1.0
  • Fixed bug: Added sensitivity to the page id that the module receives as parameter. This means that you have to click the page title of the sysFolder where fe_users are stored before you can see any statistics or whatever.
  • Added "Active" and "Inactive" support.

img-10 EXT: Login User Tracking - 6