☰

Waze Edit & UR Count Monitor

Displays your daily edit count in the WME toolbar. Warns if you might be throttled. Based on MapOMatic Edit Count

  1. // ==UserScript==
  2. // @name             Waze Edit & UR Count Monitor
  3. // @version         2.5
  4. // @description     Displays your daily edit count in the WME toolbar.  Warns if you might be throttled. Based on MapOMatic Edit Count
  5. // @author          Crotalo
  6. // @include         /^https:\/\/(www|beta)\.waze\.com\/(?!user\/)(.{2,6}\/)?editor\/?.*$/
  7. // @require         https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js
  8. // @require         https://greatest.deepsurf.us/scripts/24851-wazewrap/code/WazeWrap.js
  9.  
  10. // @grant           GM_xmlhttpRequest
  11. // @grant           GM_addElement
  12. // @connect         www.waze.com
  13.  
  14. // @namespace https://greatest.deepsurf.us/en/users/45389-mapomatic
  15. // ==/UserScript==
  16.  
  17. /* global W */
  18. /* global toastr */
  19. /* global WazeWrap */
  20.  
  21.  
  22. (function main() {
  23.     'use strict';
  24.  
  25.     
  26.     // This function is injected into the page to allow it to run in the page's context.
  27.     function wecmInjected() {
  28.         const TOASTR_URL = 'https://cdnjs.cloudflare.com/ajax/libs/toastr.js/2.1.4/toastr.min.js';
  29.         const TOASTR_SETTINGS = {
  30.             remindAtEditCount: 100,
  31.             warnAtEditCount: 150,
  32.             wasReminded: false,
  33.             wasWarned: false
  34.         };
  35.         const TOOLTIP_TEXT = 'Ediciones Diarias y URs Históricas.  Click para abrir Perfil';
  36.  
  37.         let _$outputElem = null;
  38.         let _$outputElemContainer = null;
  39.         let _lastEditCount = null;
  40.         let _userName = null;
  41.         let _savesWithoutIncrease = 0;
  42.         let _lastURCount = null;
  43.         let _lastMPCount = null;
  44.  
  45.         function log(message) {
  46.             console.log('Edit Count Monitor:', message);
  47.         }
  48.  
  49.         function checkEditCount() {
  50.             window.postMessage(JSON.stringify(['wecmGetCounts', _userName]), '*');
  51.             TOASTR_SETTINGS.wasReminded = false;
  52.             TOASTR_SETTINGS.wasWarned = false;
  53.             toastr.remove();
  54.         }
  55.  
  56.         function updateEditCount(editCount, urCount, purCount, mpCount, noIncrement) {
  57.             // Add the counter div if it doesn't exist.
  58.             if ($('#wecm-count').length === 0) {
  59.                 _$outputElemContainer = $('<div>', { class: 'toolbar-button', style: 'font-weight: bold; font-size: 16px; border-radius: 10px; margin-left: 4px;' });
  60.                 const $innerDiv = $('<div>', { class: 'item-container', style: 'padding-left: 10px; padding-right: 10px; cursor: default;' });
  61.                 _$outputElem = $('<a>', {
  62.                     id: 'wecm-count',
  63.                     href: `https://www.waze.com/user/editor/${_userName.toLowerCase()}`,
  64.                     target: '_blank',
  65.                     style: 'text-decoration:none',
  66.                     'data-original-title': TOOLTIP_TEXT
  67.                 });
  68.                 $innerDiv.append(_$outputElem);
  69.                 _$outputElemContainer.append($innerDiv);
  70.                 if ($('#toolbar > div > div.secondary-toolbar > div.secondary-toolbar-actions > div.secondary-toolbar-actions-edit').length) {
  71.                     // Production WME, as of 4/25/2023
  72.                     $('#toolbar > div > div.secondary-toolbar > div.secondary-toolbar-actions > div.secondary-toolbar-actions-edit').after(_$outputElemContainer);
  73.                 } else {
  74.                     // Beta WME, as of 4/25/2023
  75.                     $('#toolbar > div > div.secondary-toolbar > div:nth-child(1)').after(_$outputElemContainer);
  76.                 }
  77.                 _$outputElem.tooltip({
  78.                     placement: 'auto top',
  79.                     delay: { show: 100, hide: 100 },
  80.                     html: true,
  81.                     template: '<div class="tooltip" role="tooltip" style="opacity:0.95"><div class="tooltip-arrow"></div>'
  82.                         + '<div class="my-tooltip-header" style="display:block;"><b></b></div>'
  83.                         + '<div class="my-tooltip-body tooltip-inner" style="display:block;  !important; min-width: fit-content"></div></div>'
  84.                 });
  85.             }
  86.  
  87.             // log('edit count = ' + editCount + ', UR count = ' + urCount.count);
  88.             if (_lastEditCount !== editCount || _lastURCount.count !== urCount.count || _lastMPCount.count !== mpCount.count) {
  89.                 _savesWithoutIncrease = 0;
  90.             } else if (!noIncrement) {
  91.                 _savesWithoutIncrease++;
  92.             }
  93.  
  94.             let textColor;
  95.             let bgColor;
  96.             let tooltipTextColor;
  97.             if (_savesWithoutIncrease < 5) {
  98.                 textColor = '#354148';
  99.                 bgColor = 'white';
  100.                 tooltipTextColor = 'black';
  101.             } else if (_savesWithoutIncrease < 10) {
  102.                 textColor = '#354148';
  103.                 bgColor = 'yellow';
  104.                 tooltipTextColor = 'black';
  105.             } else {
  106.                 textColor = 'white';
  107.                 bgColor = 'red';
  108.                 tooltipTextColor = 'white';
  109.             }
  110.             _$outputElemContainer.css('background-color', bgColor);
  111.             _$outputElem.css('color', textColor).html('Edits:&nbsp;' + editCount + ',URs:&nbsp;'+ urCount.count);
  112.             const urCountText = `<div style="margin-top:8px;padding:3px;">URs&nbsp;Closed:&nbsp;${urCount.count.toLocaleString()}&nbsp;&nbsp;(since&nbsp;${
  113.                 (new Date(urCount.since)).toLocaleDateString()})</div>`;
  114.             const purCountText = `<div style="margin-top:0px;padding:0px 3px;">PURs&nbsp;Closed:&nbsp;${
  115.                 purCount.count.toLocaleString()}&nbsp;&nbsp;(since&nbsp;${(
  116.                 new Date(purCount.since)).toLocaleDateString()})</div>`;
  117.             const mpCountText = `<div style="margin-top:0px;padding:0px 3px;">MPs&nbsp;Closed:&nbsp;${mpCount.count.toLocaleString()}&nbsp;&nbsp;(since&nbsp;${(
  118.                 new Date(mpCount.since)).toLocaleDateString()})</div>`;
  119.             let warningText = '';
  120.             if (_savesWithoutIncrease) {
  121.                 warningText = `<div style="border-radius:8px;padding:3px;margin-top:8px;margin-bottom:5px;color:${
  122.                     tooltipTextColor};background-color:${bgColor};">${_savesWithoutIncrease} ${
  123.                     (_savesWithoutIncrease > 1) ? 'consecutive saves' : 'save'} without an increase. ${
  124.                     (_savesWithoutIncrease >= 5) ? '(Are you throttled?)' : ''}</div>`;
  125.             }
  126.             _$outputElem.attr('data-original-title', TOOLTIP_TEXT + urCountText + purCountText + mpCountText + warningText);
  127.             _lastEditCount = editCount;
  128.             _lastURCount = urCount;
  129.             _lastMPCount = mpCount;
  130.         }
  131.  
  132.         function receiveMessage(event) {
  133.             let msg;
  134.             try {
  135.                 msg = JSON.parse(event.data);
  136.             } catch (err) {
  137.                 // Do nothing
  138.             }
  139.  
  140.             if (msg && msg[0] === 'wecmUpdateUi') {
  141.                 const editCount = msg[1][0];
  142.                 const urCount = msg[1][1];
  143.                 const purCount = msg[1][2];
  144.                 const mpCount = msg[1][3];
  145.                 updateEditCount(editCount, urCount, purCount, mpCount);
  146.             }
  147.         }
  148.  
  149.         function errorHandler(callback) {
  150.             try {
  151.                 callback();
  152.             } catch (ex) {
  153.                 console.error('Edit Count Monitor:', ex);
  154.             }
  155.         }
  156.  
  157.         async function init() {
  158.             _userName = W.loginManager.user.getUsername();
  159.             // Listen for events from sandboxed code.
  160.             window.addEventListener('message', receiveMessage);
  161.             // Listen for Save events.
  162.  
  163.             $('head').append(
  164.                 $('<link/>', {
  165.                     rel: 'stylesheet',
  166.                     type: 'text/css',
  167.                     href: 'https://cdnjs.cloudflare.com/ajax/libs/toastr.js/2.1.4/toastr.min.css'
  168.                 }),
  169.                 $('<style type="text/css">#toast-container {position: absolute;} #toast-container > div {opacity: 0.95;} .toast-top-center {top: 30px;}</style>')
  170.             );
  171.             await $.getScript(TOASTR_URL);
  172.             toastr.options = {
  173.                 target: '#map',
  174.                 timeOut: 9999999999,
  175.                 positionClass: 'toast-top-right',
  176.                 closeOnHover: false,
  177.                 closeDuration: 0,
  178.                 showDuration: 0,
  179.                 closeButton: true
  180.                 // preventDuplicates: true
  181.             };
  182.             W.model.actionManager.events.register('afterclearactions', null, () => errorHandler(checkEditCount));
  183.  
  184.             // Update the edit count first time.
  185.             checkEditCount();
  186.             log('Initialized.');
  187.         }
  188.  
  189.         function bootstrap() {
  190.             if (W && W.loginManager && W.loginManager.events && W.loginManager.events.register && W.map && W.loginManager.user) {
  191.                 log('Initializing...');
  192.                 init();
  193.             } else {
  194.                 log('Bootstrap failed. Trying again...');
  195.                 setTimeout(bootstrap, 1000);
  196.             }
  197.         }
  198.  
  199.         bootstrap();
  200.     }
  201.  
  202.     // Code that is NOT injected into the page.
  203.     // Note that jQuery may or may not be available, so don't rely on it in this part of the script.
  204.  
  205.     function getEditCountFromProfile(profile) {
  206.         const { editingActivity } = profile;
  207.         return editingActivity[editingActivity.length - 1];
  208.     }
  209.  
  210.     function getEditCountByTypeFromProfile(profile, type) {
  211.         const edits = profile.editsByType.find(editsEntry => editsEntry.key === type);
  212.         return edits ? edits.value : -1;
  213.     }
  214.  
  215.     // Handle messages from the page.
  216.     function receivePageMessage(event) {
  217.         let msg;
  218.         try {
  219.             msg = JSON.parse(event.data);
  220.         } catch (err) {
  221.             // Ignore errors
  222.         }
  223.  
  224.         if (msg && msg[0] === 'wecmGetCounts') {
  225.             const userName = msg[1];
  226.             GM_xmlhttpRequest({
  227.                 method: 'GET',
  228.                 url: `https://www.waze.com/Descartes/app/UserProfile/Profile?username=${userName}`,
  229.                 onload: res => {
  230.                     const profile = JSON.parse(res.responseText);
  231.                     window.postMessage(JSON.stringify(['wecmUpdateUi', [
  232.                         getEditCountFromProfile(profile),
  233.                         getEditCountByTypeFromProfile(profile, 'mapUpdateRequest'),
  234.                         getEditCountByTypeFromProfile(profile, 'venueUpdateRequest'),
  235.                         getEditCountByTypeFromProfile(profile, 'machineMapProblem')
  236.                     ]]), '*');
  237.                 }
  238.             });
  239.         }
  240.     }
  241.  
  242.     function waitForWazeWrap() {
  243.         return new Promise(resolve => {
  244.             function loopCheck(tries = 0) {
  245.                 if (WazeWrap.Ready) {
  246.                     resolve();
  247.                 } else if (tries < 1000) {
  248.                     setTimeout(loopCheck, 200, ++tries);
  249.                 }
  250.             }
  251.             loopCheck();
  252.         });
  253.     }
  254.  
  255.     async function loadScriptUpdateMonitor() {
  256.         let updateMonitor;
  257.         await waitForWazeWrap();
  258.         try {
  259.             updateMonitor = new WazeWrap.Alerts.ScriptUpdateMonitor(SCRIPT_NAME, SCRIPT_VERSION, DOWNLOAD_URL, GM_xmlhttpRequest);
  260.             updateMonitor.start();
  261.         } catch (ex) {
  262.             // Report, but don't stop if ScriptUpdateMonitor fails.
  263.             console.error(`${SCRIPT_NAME}:`, ex);
  264.         }
  265.     }
  266.  
  267.     function injectScript() {
  268.         GM_addElement('script', {
  269.             textContent: `${wecmInjected.toString()} \nwecmInjected();`
  270.         });
  271.  
  272.         // Listen for events coming from the page script.
  273.         window.addEventListener('message', receivePageMessage);
  274.     }
  275.  
  276.     function mainInit() {
  277.         injectScript();
  278.         loadScriptUpdateMonitor();
  279.     }
  280.  
  281.     mainInit();
  282. })();