apxtri/routes/trackings.js

const express = require("express");
const glob = require("glob");
const fs = require("fs-extra");
const path = require("path");
const conf = require(`../../../adminapi/objects/tribes/itm/adminapi.json`);
const Odmdb = require("../models/Odmdb.js");
// Middlewares
const checkHeaders = require("../middlewares/checkHeaders");
const isAuthenticated = require("../middlewares/isAuthenticated");
const router = express.Router();


/**
 * @api {get} https://dns.xx/trk/pathtofile? - tracking system
 * @apiGroup Trackings
 * @apiName trackingsystem
 * @apiDescription  
 * 
 * **WARNING** a cors issue must be fix, currently this tracking work for the same domain.
 *  
 * without header:<br>
 * <code>https://dns.xx/trk/pathtofile?alias=anonymous&uuid=1b506f71-1bff-416c-9057-cb8b86296f60&srckey=btnregister&version=1&lg=fr </code>
 * 
 * with header<br>
 * <code>https://dns.xx/trk/pathtofile?srckey=btnregister&version=1</code>
 * 
 * where pathtofile is a ressource accessible from  https://dns.xx/pathtofile 
 * For dummy pathtofile for apxtri project, you have:<br>
 *   /cdn/log/1x1.png (a 1pixel image 95 bytes )
 *   /cdn/log/empty.json (an empty jason 2 bytes)
 * 
 * html usage to track a loading page or email when a picture is load
 * using apxwebapp in /src/ we got:
 * <code> < img src="static/img/photo.jpg" data-trksrckey="loadpage" data-version="1"  > </code>
 * 
 * in js action:
 * 
 * <code> <a data-trksrckey="linktoblabla" href='https:..' onclick="apx.trackvisit("btnaction",1);actionfct();"></a></code>
 *   
 * To hit an eventlistener<br>
 * <code> axios.get("https://dns.xx/trk/cdn/empty.json?alias=anonymous&uuid=1b506f71-1bff-416c-9057-cb8b86296f60&srckey=btnregister&version=1");</code>
 *  
 * If no js available (example:email or pdf document)<br>
 * <code> < img src="https://dns.xx/trk/static/img/photo.jpg?alias=anonymous&uuid=1b506f71-1bff-416c-9057-cb8b86296f60&srckey=loadpage&version=1"</code> 
 *  
 * <code><a href="https://dns.xx/trk/redirect?alias=anonymous&uuid=1b506f71-1bff-416c-9057-cb8b86296f60&srckey=loadpage&version=1&url=http://..." </code>
 *  
 * This will hit a tracker then redirect to url></a> * 
 * 
 * **if you use apx.js** : in html add in < button >, < img >, < a > tag data-trksrc="srckey"
 * <code>
 *  < img src="https://dns.xx/static/img/photo.jpg" data-trkversion="1" data-trksrckey="registerform">
 *  < button data-trksrc="https://dns.xx/static/img/photo.jpg" data-trkversion="1" data-trksrckey="registerform">
 * </code>
 * A lazyloader can also be track. 
 * <code>< img lazysrc="trk/static/img/photo.jpg data-trksrckey="loadpage" data-version="1" ></code>
 
 * 
 * Tracking log are store into tribe/logs/nginx/tribe_appname.trk.log<br>
 * Src have to be manage in tribe/api/models/lg/src_en.json<br>
 * <code>{"srckey":{"app":"presentation|app|apptest","title":"","description":""}}</code>
 *
 * @apiParam {String} alias=anonymous if authenticated we get from headers
 * @apiParam {String} uuid a uuid v4 generate the first time a web page is open on a browser
 * @apiParam {String} srckey  source action that trig this get
 * @apiParam {integer} version=1 can be an int, date or any version of the src
 * @apiParam {integer} [tm] a timestamp of action when it is not immediate (for offline app)
 *  
 */




module.exports=router;