/* global $: true */ /* global waitForKeyElements: true */ /* global GM_xmlhttpRequest: true */ /* global GM_getValue: true */ /* global GM_setValue: true */ /* global unsafeWindow: true */ // jshint newcap:false // jshint multistr:true // ==UserScript== // @name Geocaching.com + Project-GC // @namespace PGC // @description Adds links and data to Geocaching.com to make it collaborate with PGC // @include http://www.geocaching.com/* // @include https://www.geocaching.com/* // @version 1.4.6 // @require http://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js // @require https://greasyfork.org/scripts/5392-waitforkeyelements/code/WaitForKeyElements.js?version=19641 // @grant GM_xmlhttpRequest // @grant GM_setValue // @grant GM_getValue // @license The MIT License (MIT) // @downloadURL none // ==/UserScript== (function() { 'use strict'; var pgcUrl = 'http://project-gc.com/', pgcApiUrl = pgcUrl + 'api/gm/v1/', externalLinkIcon = 'http://maxcdn.project-gc.com/images/external_small.png', galleryLinkIcon = 'http://maxcdn.project-gc.com/images/pictures_16.png', mapLinkIcon = 'http://maxcdn.project-gc.com/images/map_app_16.png', loggedIn = null, subscription = null, pgcUsername = null, gccomUsername = null, latestLogs = [], latestLogsAlert = false, settings = {}, path = window.location.pathname; // Don't run the script for iframes if (window.top == window.self) { Main(); } function Main() { ReadSettings(); CheckPGCLogin(); } function Router() { if (path.match(/^\/geocache\/.*/) !== null) { Page_CachePage(); } else if (path.match(/^\/seek\/cache_details\.aspx.*/) !== null) { Page_CachePage(); } else if (path.match(/^\/seek\/cache_logbook\.aspx.*/) !== null) { Page_Logbook(); } else if (path.match(/^\/map\/.*/) !== null) { Page_Map(); } } function GetSettingsItems() { var items = { showVGPS: { title: 'Show Virtual GPS', default: true }, addChallengeCheckers: { title: 'Add challenge checkers', default: true }, makeCopyFriendly: { title: 'Make copy friendly GC-Code and link', default: true }, addPgcMapLinks: { title: 'Add PGC map links', default: true }, addLatestLogs: { title: 'Add latest logs', default: true }, cloneLogsPerType: { title: 'Clone number of logs per type', default: true }, addPGCLocation: { title: 'Add PGC Location', default: true }, addAddress: { title: 'Add reverse geocoded address', default: true }, removeUTM: { title: 'Remove UTM coordinates', default: true }, addPgcFp: { title: 'Add FP from PGC', default: true }, profileStatsLinks: { title: 'Add links to Profile stats', default: true }, tidy: { title: 'Tidy the web a bit', default: true }, collapseDownloads: { title: 'Collapse download links', default: false }, addPgcGalleryLinks: { title: 'Add links to PGC gallery', default: true }, addMapBookmarkListLinks: { title: 'Add links for bookmark lists', default: true }, decryptHints: { title: 'Automatically decrypt hints', default: true }, addElevation: { title: 'Add elevation', default: true }, imperial: { title: 'Use imperial units', default: false }, removeDisclaimer: { title: 'Remove disclaimer', default: false } }; return items; } function ReadSettings() { settings = GM_getValue('settings'); if (typeof(settings) != 'undefined') { settings = JSON.parse(settings); if (settings === null) { settings = []; } } else { settings = []; } var items = GetSettingsItems(); for (var item in items) { if (typeof(settings[item]) == 'undefined') { settings[item] = items[item].default; } } } function SaveSettings(e) { e.preventDefault(); settings = {}; for (var item in GetSettingsItems()) { settings[item] = Boolean($('#pgcUserMenuForm input[name="' + item + '"]').is(':checked')); } var json = JSON.stringify(settings); GM_setValue('settings', json); $('#pgcUserMenuWarning').css('display', 'inherit'); } function IsSettingEnabled(setting) { return settings[setting]; } function MetersToFeet(meters) { return Math.round(meters * 3.28084); } function FormatDistance(distance) { distance = parseInt(distance, 10); distance = IsSettingEnabled('imperial') ? MetersToFeet(distance) : distance; distance = distance.toLocaleString(); return distance; } /** * Check that we are logged in at PGC, and that it's with the same username */ function CheckPGCLogin() { GM_xmlhttpRequest({ method: "GET", url: pgcApiUrl + 'GetMyUsername', onload: function(response) { var result = JSON.parse(response.responseText); if (result.status !== 'OK') { alert(response.responseText); return false; } pgcUsername = result.data.username; loggedIn = Boolean(result.data.loggedIn); subscription = Boolean(result.data.subscription); BuildPGCUserMenu(); Router(); }, onerror: function(response) { alert(response); return false; } }); } function BuildPGCUserMenu() { var loggedInContent, html, subscriptionContent = ''; gccomUsername = false; if ($('#ctl00_divSignedIn').length) { gccomUsername = $('#ctl00_divSignedIn .li-user-info span').html(); } else if ($('ul.profile-panel-menu').length) { gccomUsername = $('ul.profile-panel-menu .li-user-info span:nth-child(2)').text(); } else if ($('div.LogIn ul.logged-in-user li.li-user a.CommonUsername').text().length) { gccomUsername = $('div.LogIn ul.logged-in-user li.li-user a.CommonUsername').text(); } if (loggedIn === false) { loggedInContent = 'Not logged in'; } else { if (pgcUsername == gccomUsername) { loggedInContent = '' + pgcUsername + ''; } else { loggedInContent = '' + pgcUsername + ''; } if (subscription) { subscriptionContent = 'Paid membership'; } else { subscriptionContent = 'Missing membership'; } } html = '\ \
\ \ \ Logo\ \ \ \ \ ' + loggedInContent + '\ \ \ ' + subscriptionContent + '\ \ \ \
\ '; if ($('#ctl00_divSignedIn ul.logged-in-user').length) { // The default look of the header bar $('#ctl00_divSignedIn ul.logged-in-user').prepend('
  • ' + html + '
  • '); } else if ($('ul.profile-panel-menu').length) { // Special case for https://www.geocaching.com/account/settings/preferences $('ul.profile-panel-menu').prepend('
  • ' + html + '
  • '); } else if ($('div.LogIn ul.logged-in-user').length) { // Special case for https://www.geocaching.com/map/ $('div.LogIn ul.logged-in-user').prepend('
  • ' + html + '
  • '); } $('#pgcUserMenuSave').click(function(e) { SaveSettings(e); }); } /** * getGcCodeFromPage * @return string */ function getGcCodeFromPage() { return $('#ctl00_ContentBody_CoordInfoLinkControl1_uxCoordInfoCode').html(); } /** * addToVGPS */ function addToVGPS(gccode = false) { var listId = $('#comboVGPS').val(), url = pgcApiUrl + 'AddToVGPSList?listId=' + listId + '&gccode=' + gccode + '§ionName=GM-script'; if (gccode === false) { // The map provides the gccode itself gccode = getGcCodeFromPage(); } GM_xmlhttpRequest({ method: "GET", url: url, onload: function(response) { var result = JSON.parse(response.responseText), msg = (result.status === 'OK') ? 'Geocache added to Virtual-GPS!' : 'Geocache not added to Virtual-GPS :('; $('#btnAddToVGPS').css('display', 'none'); $('#btnRemoveFromVGPS').css('display', ''); alert(msg); return true; }, onerror: function(response) { console.log(response); return false; } }); return true; } /** * removeFromVGPS */ function removeFromVGPS(gccode = false) { var listId = $('#comboVGPS').val(), url = pgcApiUrl + 'RemoveFromVGPSList?listId=' + listId + '&gccode=' + gccode; if (gccode === false) { // The map provides the gccode itself gccode = getGcCodeFromPage(); } GM_xmlhttpRequest({ method: "GET", url: url, onload: function(response) { var result = JSON.parse(response.responseText), msg = (result.status === 'OK') ? 'Geocache removed from Virtual-GPS!' : 'Geocache not removed from Virtual-GPS :('; $('#btnAddToVGPS').css('display', ''); $('#btnRemoveFromVGPS').css('display', 'none'); alert(msg); return true; }, onerror: function(response) { console.log(response); return false; } }); } /** * Page_CachePage */ function Page_CachePage() { var gccode = getGcCodeFromPage(), placedBy = $('#ctl00_ContentBody_mcd1 a').html(), lastUpdated = $('#ctl00_ContentBody_bottomSection p small time').get(1), lastFound = $('#ctl00_ContentBody_bottomSection p small time').get(2), coordinates, latitude, longitude, url; lastUpdated = (lastUpdated) ? lastUpdated.dateTime : false; lastFound = (lastFound) ? lastFound.dateTime : false; // Since everything in the logbook is ajax, we need to wait for the elements waitForKeyElements('#cache_logs_table tr', Logbook); if (subscription) { // Get geocache data from Project-GC url = pgcApiUrl + 'GetCacheDataFromGccode&gccode=' + gccode; if (lastUpdated) url += '&lastUpdated=' + lastUpdated; if (lastFound) url += '&lastFound=' + lastFound; GM_xmlhttpRequest({ method: "GET", url: url, onload: function(response) { var result = JSON.parse(response.responseText), cacheData = result.data.cacheData, cacheOwner = result.data.owner, challengeCheckerTagIds = result.data.challengeCheckerTagIds, location = [], fp = 0, fpp = 0, fpw = 0, elevation = '', html = ''; if (result.status == 'OK' && typeof cacheData !== 'undefined') { // If placed by != owner, show the real owner as well. if (placedBy !== cacheOwner) { $('#ctl00_ContentBody_mcd1 span.message__owner').before(' (' + cacheOwner + ')'); } // Append link to Profile Stats for the cache owner // Need to real cache owner name from PGC since the web only has placed by if (IsSettingEnabled('profileStatsLinks')) { $('#ctl00_ContentBody_mcd1 span.message__owner').before(''); } // Add FP/FP%/FPW below the current FP if (IsSettingEnabled('addPgcFp')) { fp = parseInt(+cacheData.favorite_points, 10), fpp = parseInt(+cacheData.favorite_points_pct, 10), fpw = parseInt(+cacheData.favorite_points_wilson, 10); $('#uxFavContainerLink').append('

    PGC: ' + fp + ' FP, ' + fpp + '%, ' + fpw + 'W

    '); $('.favorite-container').css({ "border-bottom-left-radius": "0", "border-bottom-right-radius": "0" }); } // Add elevation (Metres above mean sea level = mamsl) if (IsSettingEnabled('addElevation')) { var formattedElevation = FormatDistance(cacheData.elevation), elevationUnit = IsSettingEnabled('imperial') ? 'ft' : 'm', elevationArrow = (cacheData.elevation >= 0) ? '↥' : '↧'; elevation = formattedElevation + ' ' + elevationUnit + ' ' + elevationArrow; if (cacheData.elevation >= 0) { html = ' (' + elevation + ')'; } else { html = ' (' + elevation + ')'; } ($('#uxLatLonLink').length > 0 ? $('#uxLatLonLink') : $('#uxLatLon').parent()).after(html); } // Add PGC location if (IsSettingEnabled('addPGCLocation')) { if (cacheData.country.length > 0) { location.push(cacheData.country); } if (cacheData.region.length > 0) { location.push(cacheData.region); } if (cacheData.county.length > 0) { location.push(cacheData.county); } location = location.join(' / '); var gccomLocationData = $('#ctl00_ContentBody_Location').html(); $('#ctl00_ContentBody_Location').html('' + gccomLocationData + '
    ' + location + ''); } // Add challenge checkers if (IsSettingEnabled('addChallengeCheckers') && challengeCheckerTagIds.length > 0) { html = '

    Challenge checker(s)

    '; for (var i = 0; i < challengeCheckerTagIds.length; i++) { html += 'PGC Checker'; } html += '
    '; $('#map_preview_canvas').before(html); } } } }); } // Tidy the web if (IsSettingEnabled('tidy')) { $('#lnkMessageOwner').html(''); $('#ctl00_divContentMain p.Clear').css('margin', '0'); $('div.Note.PersonalCacheNote').css('margin', '0'); $('h3.CacheDescriptionHeader').remove(); $('#ctl00_ContentBody_EncryptionKey').remove(); } // Make it easier to copy the gccode if (IsSettingEnabled('makeCopyFriendly')) { $('#ctl00_ContentBody_CoordInfoLinkControl1_uxCoordInfoLinkPanel'). html('

    ' + gccode + '

    ' + '
    '); $('#ctl00_ContentBody_CoordInfoLinkControl1_uxCoordInfoLinkPanel').css('font-weight', 'inherit').css('margin-right', '39px'); $('#ctl00_ContentBody_CoordInfoLinkControl1_uxCoordInfoLinkPanel div').css('margin', '0 0 5px 0'); $('#ctl00_ContentBody_CoordInfoLinkControl1_uxCoordInfoLinkPanel div p').css('font-weight', 'bold'); } // Add PGC Map links if (IsSettingEnabled('addPgcMapLinks')) { coordinates = $('#ctl00_ContentBody_MapLinks_MapLinks li a').attr('href'), latitude = coordinates.replace(/.*lat=([^&]*)&lng=.*/, "$1"), longitude = coordinates.replace(/.*&lng=(.*)$/, "$1"); // var mapUrl = pgcUrl + 'Maps/mapcompare/?profile_name=' + gccomUsername + // '&nonefound=on&ownfound=on&location=' + latitude + ',' + longitude + // '&max_distance=5&submit=Filter'; var mapUrl = pgcUrl + 'LiveMap/#c=' + latitude + ',' + longitude + ';z=14'; // $('#ctl00_ContentBody_CoordInfoLinkControl1_uxCoordInfoLinkPanel').append( // '
    Project-GC map (incl found)
    ' // ); $('#ctl00_ContentBody_CoordInfoLinkControl1_uxCoordInfoLinkPanel').append( '
    Project-GC Live map
    ' ); } // Remove the UTM coordinates // $('#ctl00_ContentBody_CacheInformationTable div.LocationData div.span-9 p.NoBottomSpacing br').remove(); if (IsSettingEnabled('removeUTM')) { $('#ctl00_ContentBody_LocationSubPanel').html(''); // And move the "N 248.3 km from your home location" $('#ctl00_ContentBody_LocationSubPanel').after($('#lblDistFromHome')); } // Remove ads // PGC can't really do this officially // $('#ctl00_ContentBody_uxBanManWidget').remove(); // Remove disclaimer if (IsSettingEnabled('removeDisclaimer')) { $('#ctl00_divContentMain div.span-17 div.Note.Disclaimer').remove(); } // Collapse download links // http://www.w3schools.com/charsets/ref_utf_geometric.asp (x25BA, x25BC) if (IsSettingEnabled('collapseDownloads')) { $('

    Print and Downloads

    ').insertAfter('#ctl00_ContentBody_CacheInformationTable div.LocationData'); $('#ctl00_divContentMain div.DownloadLinks, #DownloadLinksToggle .arrow.open').hide(); } // Resolve the coordinates into an address if (IsSettingEnabled('addAddress')) { coordinates = $('#ctl00_ContentBody_MapLinks_MapLinks li a').attr('href'), latitude = coordinates.replace(/.*lat=([^&]*)&lng=.*/, "$1"), longitude = coordinates.replace(/.*&lng=(.*)$/, "$1"), url = 'http://maps.googleapis.com/maps/api/geocode/json?latlng=' + latitude + ',' + longitude + '&sensor=false'; GM_xmlhttpRequest({ method: "GET", url: url, onload: function(response) { var result = JSON.parse(response.responseText); if (result.status !== 'OK') { return false; } var formattedAddress = result.results[0].formatted_address; $('#ctl00_ContentBody_LocationSubPanel').append(formattedAddress + '
    '); } }); } // Add number of finds per type to the top if (IsSettingEnabled('cloneLogsPerType') && typeof $('#ctl00_ContentBody_lblFindCounts').html() !== 'undefined') { $('#ctl00_ContentBody_CacheInformationTable').before('
    ' + $('#ctl00_ContentBody_lblFindCounts').html() + '
    '); } // Add link to PGC gallery if (subscription && IsSettingEnabled('addPgcGalleryLinks')) { var html = ' '; $('.CacheDetailNavigation ul li:first').append(html); } // Add map links for each bookmarklist if (IsSettingEnabled('addMapBookmarkListLinks')) { $('ul.BookmarkList li').each(function() { var guid = $(this).children(':nth-child(1)').attr('href').replace(/.*\?guid=(.*)/, "$1"); var owner = $(this).children(':nth-child(3)').text(); // Add the map link url = 'http://project-gc.com/Tools/MapBookmarklist?owner_name=' + encodeURIComponent(owner) + '&guid=' + encodeURIComponent(guid); $(this).children(':nth-child(1)').append(' '); // Add gallery link for the bookmark list url = 'http://project-gc.com/Tools/Gallery?bml_owner=' + encodeURIComponent(owner) + '&bml_guid=' + encodeURIComponent(guid) + '&submit=Filter'; $(this).children(':nth-child(1)').append(' '); // Add profile stats link to the owner url = 'http://project-gc.com/ProfileStats/' + encodeURIComponent(owner); $(this).children(':nth-child(3)').append(' '); }); } // Decrypt the hint if (IsSettingEnabled('decryptHints')) { unsafeWindow.dht(); } // VGPS form if (IsSettingEnabled('showVGPS')) { GM_xmlhttpRequest({ method: "GET", url: pgcApiUrl + 'GetExistingVGPSLists?gccode=' + gccode, onload: function(response) { var result = JSON.parse(response.responseText), vgpsLists = result.data.lists, selected = result.data.selected, existsIn = result.data.existsIn, selectedContent, existsContent, html = '
  • Add to VGPS
    ', listId; html += ''; if (existsIn.indexOf(String(selected)) == -1) { html += ' '; html += ' '; } else { html += ' '; html += ' '; } html += '
  • '; $('div.CacheDetailNavigation ul:first').append(html); $('#comboVGPS').change(function() { selected = $(this).find(':selected').val(); if (existsIn.indexOf(String(selected)) == -1) { $('#btnAddToVGPS').css('display', ''); $('#btnRemoveFromVGPS').css('display', 'none'); } else { $('#btnAddToVGPS').css('display', 'none'); $('#btnRemoveFromVGPS').css('display', ''); } }); $('#btnAddToVGPS').click(function(event) { event.preventDefault(); addToVGPS(); }); $('#btnRemoveFromVGPS').click(function(event) { event.preventDefault(); removeFromVGPS(); }); } }); } } function Page_Logbook() { // Since everything in the logbook is ajax, we need to wait for the elements waitForKeyElements('#AllLogs tr', Logbook); waitForKeyElements('#PersonalLogs tr', Logbook); waitForKeyElements('#FriendLogs tr', Logbook); } function Logbook(jNode) { // Add Profile stats and gallery links after each user if (IsSettingEnabled('profileStatsLinks')) { var profileNameElm = $(jNode).find('p.logOwnerProfileName strong a'); var profileName = profileNameElm.html(); if (typeof profileName !== 'undefined') { profileName = profileNameElm.append('') .append(''); } } // Save to latest logs if (latestLogs.length < 5) { var node = $(jNode).find('div.HalfLeft.LogType strong img[src]'), logType = {}; if (node.length === 0) return false; logType = { 'src': node.attr('src'), 'alt': node.attr('alt'), 'title': node.attr('title') }; logType.id = +logType.src.replace(/.*logtypes\/(\d+)\.png/, "$1"); // First entry is undefined, due to ajax if (logType.src) { latestLogs.push('' + logType.alt + ''); // 2 = found, 3 = dnf, 4 = note, 5 = archive, 22 = disable, 24 = publish, 45 = nm, 46 = owner maintenance, 68 = reviewer note if ($.inArray(logType.id, [3, 5, 22, 45, 68]) !== -1) { latestLogsAlert = true; } } // Show latest logs // TODO : Fix this code => latestLogs.length === 5 but it's < 5 higher... if (IsSettingEnabled('addLatestLogs') && latestLogs.length === 5) { var images = latestLogs.join(''); $('#ctl00_ContentBody_size p').removeClass('AlignCenter').addClass('NoBottomSpacing'); if (latestLogsAlert) { $('#ctl00_ContentBody_size').append('

    Latest logs: ' + images + '

    '); } else { $('#ctl00_ContentBody_size').append('

    Latest logs: ' + images + '

    '); } } } } function Page_Map() { if (IsSettingEnabled('showVGPS')) { setTimeout(function() { $('#map_canvas div.leaflet-popup-pane').bind('DOMSubtreeModified', function() { if ($('#pgc_vgps').length === 0) { var gccode = $('#gmCacheInfo div.code').text(); $('#gmCacheInfo div.links').after('
    '); GM_xmlhttpRequest({ method: "GET", url: pgcApiUrl + 'GetExistingVGPSLists?gccode=' + gccode, onload: function(response) { var result = JSON.parse(response.responseText), vgpsLists = result.data.lists, selected = result.data.selected, existsIn = result.data.existsIn, selectedContent, existsContent, html, listId; html = ''; html += ''; if (existsIn.indexOf(String(selected)) == -1) { html += ' '; html += ' '; } else { html += ' '; html += ' '; } $('#pgc_vgps').html(html); $('#btnAddToVGPS').click(function(event) { event.preventDefault(); addToVGPS(gccode); }); $('#btnRemoveFromVGPS').click(function(event) { event.preventDefault(); removeFromVGPS(gccode); }); } }); } }); }, 500); } } }());