site-visit

Cette action permet de comptabiliser le nombre de visites de l'article où figure le shortcode.
Elle permet également d'afficher le nombre de visites pour toutes ou partie des pages selon l'option info du shortcode

Elle n'a pas vocation de remplacer les grands ténors de l'analytique,
mais offre une solution rapide pour évaluer la renommée d'un article.
A l'origine, j'ai écrit cette action pour connaitre les popularités respectives des différentes actions de UP.

Cette action ne prend pas en compte les pages affichées par des composants

Un exemple simple

Pour connaitre le nombre de vues de cet article, ce shortcode suffit :

{up site-visit | info | class=bd-rouge p1 | main-tag=span}

site-visit

Aucun argument n'est requis dans le contexte d'affichage des visites

info

L'option info sans argument demande l'affichage des visites pour l'article en cours

Pour avoir toutes les pages ayant des stats, il  faut indiquer un masque de sélection sur le nom des alias des articles. Exemple : * pour tous les articles, foo* pour les articles dont l'alias commence par foo

class, main-tag

des options classiques de UP auxquelles vous devez être habitués maintenant.

Activer le comptage

Pour afficher des stats, il faut dans un premier temps activer cette fonction à l'aide du shortcode {up site-visit}

Un shortcode qui demande l'affichage avec l'option info ne comptabilise pas les visites. Cela évite de doublonner avec un shortcode dans un module.

Par défaut, la page est mémorisée sous le nom de son alias (forcement unique !). Vous pouvez spécifier un nom. Ce qui pourrait permettre de regrouper plusieurs pages. Cette possibilité existe, même si j'en vois moins l'intérêt. Son usage est proscrit si le shortcode est dans un module. 

Plusieurs options permettent de limiter le comptage :

catid-include, catid-exclude

La liste des ID des catégories à inclure ou à exclure du comptage. ex: 10,25

usergroup-list

La liste des groupes d'utilisateurs dont la visite ne sera pas comptabilisée.

ip-list

Les adresses IP à ne pas prendre en compte. Un bon complément à l'option usergroup-list qui demande d'être connecté.

bots-list

La liste des robots qui ne sont pas vraiment des visiteurs.
La liste de base est : bot,spider,crawler,libwww,search,archive,slurp,teoma,facebook,twitter

Outre le fait de ne pas avoir à les saisir à chaque fois, cette méthode permet d'appliquer une modification à toutes les actions en activité.
Il devient beaucoup plus simple de compléter la liste des IP ou des robots

Paramètres experts

log

Par défaut, uniquement le total des pages vues et la date de la dernière consultation sont mémorisés. Les visiteurs uniques ne sont pas pris en charge.

Cette option demande de comptabiliser le nombre total de pages vues ainsi que le nombre de visiteurs. Une seule visite jour est comptabilisée pour une même IP.

Elle est activée par défaut, mais vous pouvez la désactiver pour économiser la place disque. Notez qu'un mécanisme de compactage automatique regroupe les nouvelles visites pour le jour en cours par langage et IP, puis par mois pour l'année courante avec seulement une ventilation par langage. Au début d'une année, les mois de l'année précédente sont regroupés.

dir-logs

Le stockage des compteurs est fait dans des fichiers situés dans le dossier 'up/site-visit'.
Cette option permet de changer cet emplacement en l'indiquant dans le fichier prefs.ini pour qu'il s'applique à l'ensemble du site.

Afficher les résultats

C'est bien beau de compter les visites, mais c'est encore mieux de savourer la popularité de son site.

Comme nous l'avons déjà vu, il suffit d'ajouter l'option info pour passer dans ce mode.

Plusieurs options sont consacrées à ce mode

info

Sans argument, il affiche les résultats pour l'article en cours. Le shortcode peut être dans un article ou dans un module.

Pour avoir toutes les pages ayant des stats, il  faut indiquer un masque de sélection sur le nom des alias des articles. Exemple : * pour tous les articles, foo* pour les articles dont l'alias commence par foo

info-catid-include

Un autre moyen de limiter les pages concernées est d'indiquer la ou les ID des catégories désirées

info-template

Pour mettre en forme le résultat, on utilise un template avec des mots clés. Le bbcode est admis et même encouragé. Nous verrons quelques exemples par la suite.

• ##counter##  : le cumul des visites
• ##lastdate## : la date dernière consultation
• ##id##, ##alias##, ##title##, ##created##, ##updated## : les données de l'article
• ##catid##, ##catalias## : id et alias de la catégorie de l'article
• ##detail## : affiche le détail des visites par année, mois, langue. Il s'agit des données étendues mémorisées par l'option log

info-sort

info-sort-order

Par défaut, les résultats sont affichés dans l'ordre alphabétique de l'alias des articles.

Vous pouvez utiliser les mots-clés pour indiquer votre préférence. Exemple : info-sort=##catalias## ##alias## pour trier par catégorie puis par alias.

Par défaut, l'ordre est ascendant, mais vous pouvez l'inverser globalement par l'option info-sort-order=desc

detail-period-style

Les données retournées par le mot clé ##detail## se présentent sous la forme : période (fr:200/100 en:30/10). Soit l'année, le mois ou la date du jour, suivi du total des pages affichées et du nombre de visiteurs uniques identifiés par leur IP.

Cette option peut contenir des classes et des styles qui seront appliqués à la période. Exemple: color:#333;bg-jaune

date-format

Permets de choisir le format d'affichage des dates. On utilise le format de la fonction (obsolète) PHP strftime qui sera converti pour être PHP8 compatible.

%y:AA, %Y:AAAA, %m:01-12, %b:mois 3 lettres, %B:nom mois, %d:01-31, %e:1-31, %a:joursem 3 lettres, %A:(Lmin) jour sem, %U:N° semaine, %l:heure (1-12) AM/PM - L minuscule, %I:heure (01-12) AM/PM - i majuscule, %k:heure (0-23), %H:heure (00-23), %P:am/pm, %p:AM/PM, %M:minute (00-59)

no-content-html

Message affiché si aucune donnée n'est trouvée. Le BBCode est encouragé.

idées de shortcodes

Je ne vais pas mettre de démo de cette action pour plusieurs raisons :

• l'affichage du compte-rendu des visites demande beaucoup de ressources (600 fichiers à analyser pour ce site). Cette fonction n'a de sens que pour les administrateurs du site.
• l'action étant récente, je n'ai des données que pour un mois. Je préfère donc mettre des copies d'écran des simulations réalisées pour tester la fiabilité du code.

Par contre, l'affichage des statistiques non détaillées pour un nombre de pages limité est possible.

Un exemple simple

{up site-visit
 | info 
 | info-template=
    {up lang
      | fr=La page "##title##" a reçu [b class="fs120"]##counter##[/b] visites au ##lastdate##
      | en=The "##title##" page received [b class="fs120"]##counter##[/b] as of  ##lastdate##
    }
}

Un autre exemple simple

Aucune donnée statistique

{up site-visit | info=*csv*
 | info-template=##title## : [b class="fs120"]##counter##[/b] au ##lastdate##
 | main-tag=ul | item-tag=li
 | class=ph2 bd-bleu}

Un exemple pratique pour analyser la fréquentation

Pour votre utilisation de webmaster, je vous conseille cette forme qui vous permet de :

• trier les résultats en cliquant sur le titre de la colonne
• de rechercher rapidement un ou plusieurs articles en filtrant sur leur titre ou catégorie

{up table-sort | col-type=a-n-a-n-a-n-a-a-a}
  {up csv2table | model=line
   | header=titre;nbre;à la date du;id;alias;catid;catalias;created;modified
   | col=x-c5-x-c5-x-c5
   | col-style-2=color:red;font-weight:bold}
     {up site-visit
      | info=*csv*
      | info-template=##title##;##counter##;##lastdate##;##id##;##alias##;##catid##;##catalias##;##created##;##modified## }
  {/up csv2table}
{/up table-sort}

Un exemple avec des données détaillées

Pour cette démo, dont vous voyez une copie d'écran ci-dessous, j'ai fabriqué un fichier log sur mesure pour avoir un test sur 2 années.

Si les 4 premières colonnes sont identiques aux exemples précédents, la cinquième affiche le détail des visites :

• globalement pour les années précédentes à l'année en cours
• mensuellement pour les mois précédents celui en cours
• journellement pour aujourd'hui. Les test a été fait le 10 décembre 2022

Pour chaque période, nous avons le détail par langage du navigateur du visiteur. Le premier nombre est le nombre total de vues et le second est le nombre de visiteurs uniques (identifié par leurs IP). 

{up table-sort | col-type=a-n-a-a}
  {up csv2table | model=line
   | header=alias;nbre;dernière;catalias;détail | col=10-c5-c10-10}
    {up site-visit | info=presentation
     | info-template= ##alias##;##counter##;##lastdate##;##catalias##;##detail##
     | date-format=%Y-%m-%d
     | detail-period-style=color:red | use-bbcode}
  {/up csv2table}
{/up table-sort}