Grosse amélioration des stats de connexion (pages /stats)

v4.106.3-3.7.9

Grosse amélioration des stats de connexion (pages /stats)
v4.106.3-3.7.9
Etienne Pallier
1 parent f226ca53
Showing 8 changed files with 263 additions and 54 deletions Show diff stats
CHANGES.txt
README.md
config/bootstrap.php
database/update/script_sql/db-update-2020-10-22.sql
src/Controller/UsersController.php
src/Routing/Filter/SessionTimeoutFilter.php
src/Template/Stats/index.ctp
tests/Fixture/UsersFixture.php
@@ -134,12 +134,12 @@ Outre ces changements, voici d&#39;autres changements importants :
 ======= CHANGES =======
  
 -------
-22/10/2020	v4.106.1-3.7.9
-	- (b) Bugfix vues pour les stats
+22/10/2020	v4.106.3-3.7.9
+	- (e) Grosse amélioration des stats de connexion (pages /stats)
  
 -------
 21/10/2020	v4.106.0-3.7.9
-	- (i) Ajout d'une nouvelle table "stats" qui maintient pour chaque utilisateur son nb de connexions et sa durée de connexion par année
+	- (i) Ajout d'une nouvelle table "stats" (/stats) qui maintient pour chaque utilisateur son nb de connexions et sa durée de connexion par année
 	- (i) Correction d'un TRÈS VIEUX problème qui faisait que lorsqu'on POST des données (bouton Submit)
 		puis qu'on revient en arrière, on avait une page blanche avec message erreur "Le document a expiré..."
 		C'est enfin réglé !
@@ -43,7 +43,7 @@ Logiciel testé et validé sur les configurations suivantes :
 --------------------------------------------------------------------------------------------
  
 Date: 22/10/2020
-Version: 4.106.1-3.7.9
+Version: 4.106.3-3.7.9
  
  
 HISTORIQUE DES CHANGEMENTS DE VERSION : voir le fichier CHANGES.txt (ou la page web /pages/changes)
-    <?php
+<?php
+
+//header('Cache-Control: private_no_expire, must-revalidate');
+
 /**
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
@@ -277,3 +280,7 @@ Type::build(&#39;datetime&#39;)
 //Cake\Core\Plugin::load('BootstrapUI');
 //Plugin::load('BootstrapUI');
 Plugin::load('BootstrapUI', ['autoload' => true]);
+
+// (EP20201022) Pour gérer le timeout auto
+DispatcherFactory::add('SessionTimeout');
+
@@ -0,0 +1,8 @@
+use database;
+
+--
+-- Ajout du champ stats.last_connex_dur
+--
+ALTER TABLE stats 
+  ADD last_connex_dur INT NOT NULL DEFAULT 0 AFTER last_login_time COMMENT 'Temps de connexion de la derniere session',
+  CHANGE connex_dur connex_dur_tot INT(11) NOT NULL DEFAULT 0 COMMENT "Total temps connexion cumulé sur l'année (sec)";
@@ -208,7 +208,7 @@ class UsersController extends AppController
                 ]
                 */
  
-                $this->_updateStatsForUserLogin($user);
+                $this->_updateStatsForCurrentUserOnLogin();
                 //exit;
  
                 // On va maintenant à la page qui etait demandée
@@ -220,45 +220,63 @@ class UsersController extends AppController
         }
     }
  
-    public function logout()
-    {
+    public function logout() {
+        //debug("LOGOUT !");
         //debug($this->u);
-        $this->_updateStatsForUserLogout($this->u);
-        //exit;
+        $this->_updateStatsForCurrentUserOnLogout();
         //$this->Flash->success('You are now logged out.');
         return $this->redirect($this->LdapAuth->logout());
         // Puis ça va sur /users/login
     }
  
+    
+    /*
+     * Renvoie les infos de l'utilisateur qui sont dans la session
+     * 
+     * Voici ce que contient $_SESSION['Auth']['User'] par exemple :
+    [
+        'sn' => [
+            (int) 0 => 'Pallier'
+        ],
+        'mail' => [
+            (int) 0 => 'Etienne.Pallier@irap.omp.eu'
+        ],
+        'givenname' => [
+            (int) 0 => 'Etienne'
+        ],
+        'uid' => [
+            (int) 0 => 'epallier'
+        ],
+        'userpassword' => [
+            (int) 0 => 'mot-de-passe-crypté'
+        ]
+    ]
+     */
+    private function _getCurrentUserInfosFromSession() {
+        // Current user infos
+        return isset($_SESSION['Auth']['User']) ? $_SESSION['Auth']['User'] : [];
+    }
+    private function _getCurrentUserFullNameFromSession($user_infos = null) {
+        if (!$user_infos) $user_infos = $this->_getCurrentUserInfosFromSession();
+        // "Pallier Etienne"
+        return $user_infos ? $user_infos['sn'][0].' '.$user_infos['givenname'][0] : 'Name Firstname';
+    }
+    private function _getCurrentUserEntityFromSession($session_user = null) {
+        $user_fullname = $this->_getCurrentUserFullNameFromSession($session_user);
+        //debug($user_fullname);
+        // "Pallier Etienne"
+        return $this->Users->find()->where(['nom'=>$user_fullname])->first();
+    }
+    
+    
     /* 
      * Mise à jour des stats pour ce user (et pour l'année courante) au moment du login
      * => on enregistre son heure de connexion
      * => on incrémente le nombre de connexions
-     * 
-     * Voici ce que contient $user_infos par exemple :
-     [
-         'sn' => [
-             (int) 0 => 'Pallier'
-         ],
-         'mail' => [
-             (int) 0 => 'Etienne.Pallier@irap.omp.eu'
-         ],
-         'givenname' => [
-             (int) 0 => 'Etienne'
-         ],
-         'uid' => [
-             (int) 0 => 'epallier'
-         ],
-         'userpassword' => [
-             (int) 0 => 'mot-de-passe-crypté'
-         ]
-     ]
      */
-    private function _updateStatsForUserLogin($user_infos) {
+    private function _updateStatsForCurrentUserOnLogin() {
  
-        // "Pallier Etienne"
-        $user_fullname = $user_infos['sn'][0].' '.$user_infos['givenname'][0];
-        $user = $this->Users->find()->where(['nom'=>$user_fullname])->first();
+        $user_id = $this->_getCurrentUserEntityFromSession()->id;
         //debug($user);
  
         $now = new FrozenTime();
@@ -266,8 +284,9 @@ class UsersController extends AppController
         $year = $now->format('yy');
         //debug($year);
  
+        // On recup la Stat du user courant
         $table_stats = $this->Users->Stats;
-        $stat_id = [$year,$user->id];
+        $stat_id = [$year,$user_id];
         $current_user_stat = null;
         try {
             // Si un enregistrement existe pour ce user (et cette année) => on le récupère
@@ -291,20 +310,32 @@ class UsersController extends AppController
             //$stat_entity = $table_stats->newEntity($stat);
             $current_user_stat = $table_stats->newEntity();
             $current_user_stat->year = $year;
-            $current_user_stat->user_id = $user->id;
+            $current_user_stat->user_id = $user_id;
         }
         $last_login_time = $current_user_stat->last_login_time;
         $last_logout_time = $current_user_stat->last_logout_time;
+        
         /*
          * Check le cas où le logout n'a pas été enregistré 
          * (le user n'a pas fait logout, ça s'est fait tout seul par timeout)
-         * => Dans ce cas, on ajoute un temps de connexion FORFAITAIRE de 10 minutes à la durée totale 
+         * => Dans ce cas, on ajoute à la durée totale le dernier temps de connexion last_connex_dur
          */
-        if ($last_logout_time < $last_login_time)
-            $current_user_stat->connex_dur += 10*60;
-        // On met à jour le champ last_login_time
+        if ($last_logout_time < $last_login_time) {
+            $last_connex_dur = $current_user_stat->last_connex_dur;
+            /*
+             * (Optimisation): Si la dernière session a été très courte (<10s), on ne le comptabilise pas
+             * => on décrémente le nb de connexions (passées)
+             */
+            if ($current_user_stat->connex_nb>0 && $last_connex_dur<10)
+                $current_user_stat->connex_nb--;
+            else
+                $current_user_stat->connex_dur_tot += $last_connex_dur;
+        }
+        
+        // On met à jour le champs last_login_time, RAZ last_connex_dur, et incrémente le nb de connexions
         $current_user_stat->last_login_time = $now;
-        // et 1 connexion de plus, 1 !
+        $current_user_stat->last_connex_dur = 0;
+        // et 1 NOUVELLE connexion de plus, 1 !
         $current_user_stat->connex_nb++;
         //debug($current_user_stat);
         // On sauvegarde en table
@@ -324,15 +355,58 @@ class UsersController extends AppController
          debug("yes");
          }
          */
-    } // _updateStatsForUserLogin()
+    } // _updateStatsForCurrentUserOnLogin()
  
+    /*
+     * Mise à jour des stats pour ce user (et pour l'année courante) durant la session, à chaque action
+     * => on met à jour son temps de connexion
+     */
+    public function updateStatsForCurrentUserDuringSession($session_user = null) {
+        
+        //debug("ici");
+        //exit;
+        // Current user
+        //$user_id = $this->u->id;
+        //debug($session_user);
+        $user_id = $this->_getCurrentUserEntityFromSession($session_user)->id;
+        //debug($user_id);
+
+        // On récupère la Stat de ce user
+        $now = new FrozenTime();
+        //debug($last_login_time);
+        $year = $now->format('yy');
+        //debug($year);
+        $table_stats = $this->Users->Stats;
+        $stat_id = [$year,$user_id];
+        $current_user_stat = $table_stats->get($stat_id);
+        
+        // On met à jour le temps de connexion
+        $connex_duration = $now->diff($current_user_stat->last_login_time);
+        //debug($connex_duration);
+        //exit;
+        $current_user_stat->last_connex_dur = $connex_duration->h*3600 + $connex_duration->i*60 + $connex_duration->s;
+        //debug($current_user_stat->last_connex_dur);
+        
+        // On sauvegarde en table
+        if (! $table_stats->save($current_user_stat)) {
+            echo "Impossible de sauvegarder une stat durant la session !";
+            debug($current_user_stat->getErrors());
+            debug($current_user_stat);
+            exit;
+        }
+        
+    } // updateStatsForCurrentUserDuringSession()
  
     /*
      * Mise à jour des stats pour ce user (et pour l'année courante) au moment du logout
      * => on enregistre son heure de dé-connexion
-     * => on calcule son temps de connexion et on l'ajoute au champ qui totalise le temps de connexion : connex_dur
+     * => on calcule son temps de connexion et on l'ajoute au champ qui totalise le temps de connexion : connex_dur_tot
      */
-    private function _updateStatsForUserLogout(Entity $user) {
+    private function _updateStatsForCurrentUserOnLogout() {
+        
+        // Current user
+        $user_id = $this->u->id;
+        
         $last_logout_time = new FrozenTime();
         //debug($last_login_time);
         $year = $last_logout_time->format('yy');
@@ -342,7 +416,7 @@ class UsersController extends AppController
         // Normalement, elle doit exister puisque il y a déjà eu login !
         // TODO: Cas particulier où le login se fait le 31 décembre, et le logout l'année suivante => BUG !!!
         $table_stats = $this->Users->Stats;
-        $stat_id = [$year,$user->id];
+        $stat_id = [$year,$user_id];
         $current_user_stat = $table_stats->get($stat_id);
         $last_login_time = $current_user_stat->last_login_time;
  
@@ -355,12 +429,12 @@ class UsersController extends AppController
         $connex_duration = $connex_duration->h*3600 + $connex_duration->i*60 + $connex_duration->s;
         //debug($last_login_time);
         //debug($last_logout_time);
-        //debug($connex_duration);
+        //debug($connex_dur_totation);
         // - on cumule ce temps au temps total
-        //debug($current_user_stat->connex_dur);
-        //debug($connex_duration);
-        $current_user_stat->connex_dur += $connex_duration;
-        //debug($current_user_stat->connex_dur);
+        //debug($current_user_stat->connex_dur_tot);
+        //debug($connex_dur_totation);
+        $current_user_stat->connex_dur_tot += $connex_duration;
+        //debug($current_user_stat->connex_dur_tot);
  
         // On sauvegarde en table
         if (! $table_stats->save($current_user_stat)) {
@@ -369,7 +443,7 @@ class UsersController extends AppController
             debug($current_user_stat);
             exit;
         }
-    } // _updateStatsForUserLogout()
+    } // _updateStatsForCurrentUserOnLogout()
  
  
  
@@ -0,0 +1,77 @@
+<?php
+
+/* 
+ * (EP20201022)
+ * 
+ * Pour pouvoir mettre à jour les stats de connexion
+ * au moment d'un timeout automatique (qui fait un logout auto sans appeler Users.logout())
+ * 
+ * https://stackoverflow.com/questions/32298817/how-to-prevent-cakephp-3-0-from-extending-session-timeout-with-ajax-requests
+ * 
+ */
+
+namespace App\Routing\Filter;
+
+use Cake\Core\Configure;
+use Cake\Event\Event;
+use Cake\Routing\DispatcherFilter;
+use App\Controller\UsersController;
+
+class SessionTimeoutFilter extends DispatcherFilter
+{
+    
+    public function beforeDispatch(Event $event) {
+        
+        //debug("iciii1");
+        // Si déjà TIMEOUT => on ne peut plus rien faire, donc on quitte
+        //debug($_SESSION);
+        $request = $event->data['request'];
+        $session = $request->session();
+        $session_user = $session->read('Auth.User');
+        if (! $session_user) return;
+        // MARCHE PAS, WHY ???????
+        //if (! isset($_SESSION['Auth']['User']) ) return;
+        //debug("iciii2");
+        
+        // Sinon, on met à jour les stats de connexion 
+        //(new UsersController())->updateStatsForCurrentUserDuringSession();
+        (new UsersController())->updateStatsForCurrentUserDuringSession($session_user);
+        //exit;
+        
+        
+        /*
+        //debug($event->data['request']);
+        //debug($event);
+        
+        /S @var $request \Cake\Network\Request S/
+        $request = $event->data['request'];
+        $session = $request->session();
+        $lastAccess = $session->read('SessionTimeoutFilter.lastAccess'); // en sec
+        //debug($lastAccess);
+
+        if ($lastAccess !== null) {
+            // On calcule le temps d'inactivité de l'utilisateur
+            $inactivity_duration = time() - $lastAccess;
+            //debug($inactivity_duration);
+            //debug(Configure::read('Session.timeout')*60);
+            //debug("avant");
+            /S
+            $sess = $_SESSION['Auth']['User'];
+            $user_fullname = $sess['sn'][0].' '.$sess['givenname'][0];
+            //debug($user_fullname);
+            S/
+            //debug("after");
+            // Si ce temps d'inactivité est supérieur au timeout, on détruit la session,
+            if ($inactivity_duration > Configure::read('Session.timeout') * 60) {
+                // Sans doute inutile vu que logout() l'a déjà fait normalement...
+                $request->session()->destroy();
+            }
+        }
+        
+        // On écrit l'heure actuelle dans la variable de session lastAccess
+        if (! $request->is('ajax') )
+            $session->write('SessionTimeoutFilter.lastAccess', time()); // en sec
+        */
+    }
+    
+}
 \ No newline at end of file
@@ -3,6 +3,22 @@
  * @var \App\View\AppView $this
  * @var \App\Model\Entity\Stat[]|\Cake\Collection\CollectionInterface $stats
  */
+
+// Variables passées par le controleur
+$stats = $stats;
+
+
+function getHourMnSecForDuration($duration_sec) {
+    //debug($duration_sec);
+    $h = intdiv($duration_sec,3600);
+    $m = intdiv($duration_sec-$h*3600 , 60);
+    $s = $duration_sec-$h*3600-$m*60;
+    return [$h,$m,$s];
+}
+
+
+
+
 ?>
 <nav class="large-3 medium-4 columns" id="actions-sidebar">
     <ul class="side-nav">
@@ -20,9 +36,11 @@
                 <th scope="col"><?= $this->Paginator->sort('year') ?></th>
                 <th scope="col"><?= $this->Paginator->sort('user_id') ?></th>
                 <th scope="col"><?= $this->Paginator->sort('last_login_time') ?></th>
+                <th scope="col"><?= $this->Paginator->sort('last_connex_dur', 'Durée connexion (mn)') ?></th>
                 <th scope="col"><?= $this->Paginator->sort('last_logout_time') ?></th>
-                <th scope="col"><?= $this->Paginator->sort('connex_nb') ?></th>
-                <th scope="col"><?= $this->Paginator->sort('connex_dur') ?></th>
+                <th scope="col"><?= $this->Paginator->sort('connex_dur_tot', "Durée connexion cumulée (sur année) (mn)") ?></th>
+                <th scope="col"><?= $this->Paginator->sort('connex_nb', "Nb connexions (sur année)") ?></th>
+                <th scope="col"><?= "Durée connexion moyenne (sur année)" ?></th>
                 <th scope="col" class="actions"><?= __('Actions') ?></th>
             </tr>
         </thead>
@@ -32,9 +50,33 @@
                 <td><?= h($stat->year) ?></td>
                 <td><?= $stat->has('user') ? $this->Html->link($stat->user->nom, ['controller' => 'Users', 'action' => 'view', $stat->user->id]) : '' ?></td>
                 <td><?= h($stat->last_login_time) ?></td>
+                
+                <?php
+                list($h,$m,$s) = getHourMnSecForDuration($stat->last_connex_dur); 
+                ?>
+                <td><?="$h h $m mn $s sec"?></td>
+                <!-- 
+                <td><= h($stat->last_connex_dur) ?></td>
+                 -->
+                
                 <td><?= h($stat->last_logout_time) ?></td>
+                
+				<?php
+				list($h,$m,$s) = getHourMnSecForDuration($stat->connex_dur_tot);
+                ?>
+                <td><?="$h h $m mn $s sec"?></td>
+                <!-- 
+                <td><= $this->Number->format($stat->connex_dur_tot) ?></td>
+                 -->
+                
                 <td><?= $this->Number->format($stat->connex_nb) ?></td>
-                <td><?= $this->Number->format($stat->connex_dur) ?></td>
+
+				<?php
+				$connex_dur_avg = intdiv($stat->connex_dur_tot , $stat->connex_nb);
+				list($h,$m,$s) = getHourMnSecForDuration($connex_dur_avg);
+                ?>
+                <td><?="$h h $m mn $s sec"?></td>
+                
                 <td class="actions">
                     <?= $this->Html->link(__('View'), ['action' => 'view', $stat->year,$stat->user_id]) ?>
                     <?= $this->Html->link(__('Edit'), ['action' => 'edit', $stat->year,$stat->user_id]) ?>
@@ -58,7 +58,8 @@ class UsersFixture extends TestFixture
         [
             //'id' => 1,
             // Nom Prénom
-            'nom' => 'user1 SUPER',
+            /////'nom' => 'user1 SUPER',
+            'nom' => 'SUPER user1',
             //'nom' => 'test1 test2',
             //'username' => 'testa',
             'username' => 'user1_SUPER',