// ==UserScript==
// @name FaviconizeGoogle
// @namespace http://userscripts.org/users/89794 (joeytwiddle)
// @description Adds favicons next to Google search results. Also works for Ecosia, StartPage and Searx.
// @homepage https://greasyfork.org/en/scripts/7664-faviconizegoogle
// @downstreamURL http://userscripts.org/scripts/source/48636.user.js
// @license ISC
// @version 1.8.7
// @include /https?:\/\/((www\.)?|encrypted\.)google\.[a-z]{2,3}(\.[a-z]{2})?\/(search|webhp|\?gws_rd|\?gfe_rd)?.*/
// @include /https?:\/\/(www\.|[a-z0-9-]*\.)?startpage\.com\/.*/
// @include /https?:\/\/(www\.)?ecosia\.org\/(search|news|videos)?.*/
// @include /https?:\/\/searx\..*\/.*
// @exclude /https?:\/\/((www\.)?|encrypted\.)google\.[a-z]{2,3}(\.[a-z]{2})?\/maps[/?#]*.*/
// These are some popular searx sites which don't have 'searx' in the domain:
// @match https://spot.ecloud.global/*
// @match https://search.disroot.org/*
// @match https://search.stinpriza.org/*
// @match https://zoek.anchel.nl/*
// @match https://search.mdosch.de/*
// @match https://metasearch.nl/*
// @match https://suche.uferwerk.org/*
// @match https://search.snopyta.org/*
// @match https://www.gruble.de/*
// End popular searx sites.
// @grant GM_xmlhttpRequest
// @grant GM_addStyle
// @connect *
// ==/UserScript==
// Google's favicon service now redirects to load-balanced domains: t0, t1, t2, t3, ...
// - https://t3.gstatic.com/faviconV2?client=SOCIAL&type=FAVICON&fallback_opts=TYPE,SIZE,URL&url=http://docs.nginx.com&size=16
var placeFaviconByUrl = false; // The little green link below the article title
var placeFaviconAfter = false; // Display after the link instead of before it
var placeFaviconInsideLink = false; // Makes the favicon clickable but may also get underlined
var placeFaviconOffTheLeft = true; // Makes the favicon sit out to the left of the main column (not on startpage)
var iconSize = 1.3;
var centraliseIconVertically = iconSize < 2; // For smaller icon sizes, we center-align with the text, for larger we top-align
// With thanks to:
// - NV
// - darkred
// - SirCumference
// Some alternatives/remixes:
// - https://github.com/NV/faviconize-google.js (Chrome extension)
// - https://greasyfork.org/en/scripts/12395-google-favicons (works with Endless Google)
// - https://gist.github.com/Sir-Cumference/223d36cbec6473b0e6927e5c50c11568 (very short code, @match works with Greasemonkey)
// 2020-10-25 Added support for some of the searx sites (provided they have 'searx' in the domain).
// 2020-04-21 Re-enabled for Ecosia and StartPage, bypass CSP by fetching the images using GM_xmlhttpRequest.
// 2020-02-02 Reenabled Google again, because Google has stopped showing favicons.
// 2020-01-22 Disabled Google, because Google is now displaying favicons itself.
// 2020-01-22 Disabled Ecosia, because their CSP is blocking images
// 2018-10-14 Added support for ecosia.org!
// 2018-10-14 Disabled startpage.com, because their CSP has blocked favicons from loading.
// 2018-07-31 Dropped support for news.google.com, because it is now linking to local URLs, instead of to external websites.
// TODO: The relative positioning of the icon appears a bit off for sub-links of the main result.
// DONE: Provided more options where to place favicon: by the link or by the
// url, before or after, inside or outside the link. However in my opinion
// they all suck except the default. ;)
// Broken images would be messy, but Firefox seems to hide them after a while
// anyway. We do still see the gap from the image's padding though!
// It might be desirable to check each image actually exists/loads, or remove it.
// Is that possible, without making an http request ourselves?
// Third-party host URL detection is implemented leniently, and accordingly
// hostname extraction implemented aggressively, which results in favicons
// being given to unexpected things like bookmarklets which contain a site url.
var isEcosia = document.location.hostname === 'www.ecosia.org' || document.location.hostname === 'ecosia.org';
var isStartpage = document.location.host.match(/\bstartpage\b/);
var isSearx = document.location.host.match(/\bsearx\b/) || document.querySelector('.searx-navbar') || document.querySelector('script[src*=searx]');
//var bypassCSP = isEcosia || isStartpage;
// Enable it for all sites. I think it's more secure for us to fetch the icon by GM_xhr rather than injecting it into the page.
var bypassCSP = true && typeof GM_xmlhttpRequest !== 'undefined';
if (isEcosia) {
iconSize = iconSize * 0.6;
}
if (isStartpage) {
// This feature doesn't work on startpage!
placeFaviconOffTheLeft = false;
}
if (document.location.search.match(/&tbm=nws/)) {
// This feature doesn't work on Google News search
placeFaviconOffTheLeft = false;
// The layout is a bit too cramped for large favicons
iconSize = 0.9;
}
if ((isEcosia || isStartpage) && (window.innerWidth < 1000)) {
// At lower widths, these website collapse their layout so there is no margin on the left, in which case we don't want to float the favicon out of view.
// We dare not do this for Google, as this isn't working right now!
placeFaviconOffTheLeft = false;
}
if (!this.GM_addStyle) {
this.GM_addStyle = function(css) {
var s = document.createElement("style");
s.type = 'text/css';
s.innerHTML = css;
document.getElementsByTagName("head")[0].appendChild(s);
};
}
function findClosest (elem, className) {
// eslint-disable-next-line no-cond-assign
while (elem = elem.parentNode) {
//if (elem.tagName && elem.tagName.toLowerCase() === tagName.toLowerCase()) {
if ((' ' + elem.className + ' ').indexOf(' ' + className + ' ') >= 0) {
return elem;
}
}
return null;
}
function alreadyContainsFavicon(link) {
// Feburuary 2023: On Google Search, they now (sometimes?) show favicons
const img = link.querySelector('span > div > img[data-atf]:not([data-atf="0"])');
if (img) return true;
// On Google's News tab, they already show favicons
// We will try to detect that
const images = Array.from(link.querySelectorAll('g-img img'));
// RIP semantic web. The classes for these favicons are "rISBZc zr758c"
//const looksLikeFavicon = (img) => img.getAttribute('width') === '16' && img.getAttribute('height') === '16';
const looksLikeFavicon = (img) => img.width == 16 && img.height == 16 || img.className == "rISBZc zr758c";
return images.some(looksLikeFavicon);
}
function createFaviconFor (url) {
var host = url.replace(/^[^/]*:\/\//, '').replace(/\/.*$/, '');
// if (host == document.location.host) {
// return null;
// }
// Use protocol (http/https) of current page, to avoid mixed-content warnings/failures.
//var protocol = document.location.protocol.replace(/:$/, '');
//console.log("[FaviconizeGoogle.user.js] protocol:" ,protocol);
// We may fail to access favicons, e.g. if the site only offers http, or due to CORS restrictions.
// But it is still worth tryiing, because the fallback (google's s2) offers only low-res icons.
var urlsToTry = [
// Hitting each site directly means exposing our IP to them, even if we don't visit their site.
// I think it would be preferable to use DuckDuckGo's service, because they claim to discard our data.
// However, it doesn't provide good results for all websites. So until it improves, I don't plan to make it the default.
// TODO: We could try DDG first, but if they return their fallback icon, then we could try the other URLs.
'//' + host + '/favicon.ico',
'//' + host + '/favicon.png',
'//www.google.com/s2/favicons?domain=' + host,
'//icons.duckduckgo.com/ip3/' + host + '.ico',
];
// Google's cache will sometimes provide a favicon we would have missed, e.g. if the site uses .png instead of .ico. Thanks to NV for suggesting this, and to Google.
var img = document.createElement('IMG');
//img.src = protocol + '://'+host+'/favicon.ico';
//img.src = '//g.etfv.co/http://" + host; // As suggested by decembre
//img.src = 'http://api.byi.pw/favicon?url=' + protocol + "://" + host; // Another service suggested by decembre
//img.width = '16';
//img.height = '16';
img.className = 'favicon';
img.border = 0;
img.style.display = 'none';
var showImage = function () {
img.style.display = '';
if (typeof removeListeners === 'function') {
removeListeners();
}
};
if (bypassCSP) {
var blobToDataURL = (blob, callback) => {
var a = new FileReader();
a.onload = function(e) {
callback(e.target.result);
};
a.readAsDataURL(blob);
};
var tryNextUrlNoCors = () => {
if (urlsToTry.length === 0) {
return;
}
var url = 'https:' + urlsToTry.shift();
//console.log('url:', url);
GM_xmlhttpRequest({
method: 'GET',
url: url,
responseType: 'blob',
onload: (res) => {
//console.log('response:', res.response);
if (!res.response) {
console.warn(`No content returned for url=${url}`);
tryNextUrlNoCors();
}
blobToDataURL(res.response, (dataUrl) => {
//console.log('dataUrl:', dataUrl);
const isImage = dataUrl.startsWith('data:application/octet-stream;') || dataUrl.startsWith('data:image/');
if (isImage) {
img.src = dataUrl;
showImage();
} else {
tryNextUrlNoCors();
}
});
},
});
};
tryNextUrlNoCors();
} else {
var tryNextUrl = function () {
if (urlsToTry.length === 0) {
removeListeners();
return;
}
img.src = urlsToTry.shift();
};
var removeListeners = function () {
img.removeEventListener('load', showImage);
img.removeEventListener('error', tryNextUrl);
};
img.addEventListener('load', showImage, false);
img.addEventListener('error', tryNextUrl, false);
tryNextUrl();
}
return img;
}
function getGoogleResultsLinks () {
// var links = document.evaluate("//a[@class='l']",document,null,6,null);
// var links = filterListBy(document.links, function(x){ return x.className=='l'; } );
// var links = document.links.filter( function(x){ return x.className=='l'; } );
/*
return filterListBy(document.getElementsByTagName('a'), function (x) {
// Most pages show links with class 'l'
// But on pages where the first result has an indented block of sub-pages,
// the indented links have class 'l' but all the other links have no class but parent class 'r'
return x.className === 'l' || x.parentNode.className === 'r';
});
*/
// For Google search
// a.l
// a.fl are small one-line sub-results. Search "squeak" and see the Wikipedia result.
// a.B0IOdd are lists of images which appear underneath a section on the News tab (inside .card-section)
var links = document.querySelectorAll('.g a:not(.fl):not(.B0IOdd)');
// For news.google.com
if (links.length === 0) {
//links = document.querySelectorAll('a.article:not(.esc-thumbnail-link)');
links = document.querySelectorAll('article > a');
}
// For startpage.com
if (links.length === 0) {
//links = document.querySelectorAll('.clk > a');
links = document.querySelectorAll('.w-gl__result-title');
}
// For ecosia.org
if (links.length === 0) {
// We use .result-body to avoid getting deep links (which were producing an unwanted second large favicon)
links = document.querySelectorAll('.result-body .result-title');
}
// For searx
if (links.length === 0) {
links = document.querySelectorAll('.result_header a');
}
// Remove any links which contain only one image
links = [...links].filter(link => {
if (link.childNodes.length === 1 && link.childNodes[0].tagName === 'IMG') {
return false;
}
return true;
});
// Only keep links which are not really links (e.g. ignore 'javascript:void(0)' and anchor links)
links = [...links].filter(link => {
return (link.protocol === 'http:' || link.protocol === 'https:') && link.href.slice(0, 1) !== '#';
});
return links;
}
var marginSide = (placeFaviconAfter ? 'left' : 'right');
var leftPadding = 1.2 * iconSize + 0.6 - 0.3 * isEcosia;
// We can try to centralise the icon with the text
// Or we can top-align the icon with the text (better for larger icon sizes)
var topPadding = centraliseIconVertically ? 0.87 - iconSize / 2 : 0.35;
var extra = placeFaviconOffTheLeft ? 'position: absolute; left: -' + leftPadding + 'em; top: ' + topPadding + 'em;' : '';
if (isEcosia) {
var topMargin = 0.3 + centraliseIconVertically * iconSize / 13;
// Use margin for vertical positioning
extra += ' margin-top: ' + (-topMargin) + 'em;';
}
// If we are using placeFaviconOffTheLeft, then we don't need the paddings or alignment here
const style = ".favicon { box-sizing: content-box; margin-" + marginSide + ": 0.3em; vertical-align: middle; width: " + iconSize + "em; height: " + iconSize + "em; padding-bottom: 0.2em; " + extra + "}";
GM_addStyle(style);
// TODO: On search.disroot.org Chrome says: Refused to apply inline style because it violates the following Content Security Policy directive: "default-src 'self'"
// This happens even if I use GM_addStyle
// At present, the only workaround I can imagine is to apply the styles directly to the elements, rather than using CSS.
function updateFavicons () {
// On Google's News and Images tabs, do nothing
if (document.location.search.match(/[&?]tbm=isch\b/) || document.location.search.match(/[&?]tbm=nws\b/)) {
return;
}
var links = getGoogleResultsLinks();
// Allows it to work on any sites:
if (links.length === 0) {
links = document.getElementsByTagName("A");
}
//console.log("Got links:", links);
// for (var i=0;i<links.snapshotLength;i++) {
// var link = links.snapshotItem(i);
for (var i = 0; i < links.length; i++) {
var link = links[i];
// if (link.href.match('^javascript:') || link.href.match('^#')) {
// continue;
// }
if (alreadyContainsFavicon(link)) {
continue;
}
var targetUrl = link.getAttribute('data-href') || link.href;
//// Skip relative and same-host links:
if (targetUrl.match(/^[/]/) || targetUrl.match("://" + document.location.host)) {
continue;
}
//console.log("[faviconizegoogle.user.js] link.getAttribute(data-faviconized):" ,link.getAttribute("data-faviconized"));
if (link.getAttribute("data-faviconized")) {
// Already faviconized
//console.log("[faviconizegoogle.user.js] Skipping");
continue;
}
// Sometimes Google shows multiple results from one side, side-by-side in a table
// In this case, adding a favicon to the later links is redundant, and tends to overlap the earlier link
// So let's not do that
// Presumably this no longer works, since findClosest() works by className now
/*
var tableCell = findClosest(link, 'td');
if (tableCell && tableCell.parentNode.firstChild !== tableCell) {
// We are in a table and we are not the first cell; don't add favicon
continue;
}
*/
link.setAttribute("data-faviconized", "yes");
var img = createFaviconFor(targetUrl);
// <cite> is for google, .url is for startpage
// For Google 2022, putting the img inside the container but pushed out to the left makes it invisible. So we go up to the container, and put it just inside that
// After finding the parent '.g' we actually want the first 'div' inside it. (Not the firstChild, since that might be a favicon we created earlier!)
var targetNode =
placeFaviconByUrl && link.parentNode.parentNode.querySelector('cite, .url')
|| findClosest(link, 'g') && findClosest(link, 'g').querySelector('div')
|| link;
if (isEcosia && !placeFaviconOffTheLeft) {
// With the default `display: block` the link will break onto a separate line from the favicon, so we do this
link.style.display = 'inline-block';
link.parentNode.style.whiteSpace = 'nowrap';
}
if (isSearx && placeFaviconOffTheLeft) {
//findClosest(link, 'h4').style.position = 'relative';
link.parentNode.style.position = 'relative';
}
// Some result blocks contain multiple links.
// But now we are placing the favicon on the parent '.g' block, we don't want multiple favicons on top of each other!
// (Of course it would be more efficient if we didn't generate an <img> at all for these sub-links.)
if (targetNode.getAttribute("data-target-faviconized") || targetNode.classList.contains("favicon") || alreadyContainsFavicon(targetNode)) {
continue;
}
targetNode.setAttribute("data-target-faviconized", "yes");
//console.log(`Placing favicon %o by %o`, img, targetNode);
if (placeFaviconOffTheLeft) {
const realTargetNode = placeFaviconInsideLink ? targetNode : targetNode.parentNode;
realTargetNode.style.position = 'relative';
}
if (placeFaviconInsideLink) {
if (placeFaviconAfter) {
targetNode.appendChild(img);
} else {
targetNode.insertBefore(img, targetNode.firstChild);
}
} else {
if (placeFaviconAfter) {
targetNode.parentNode.insertBefore(img, targetNode.nextSibling);
} else {
targetNode.parentNode.insertBefore(img, targetNode);
}
}
}
}
// TODO: Use MutationObserver instead?
var last_srg = null;
var results_count = -1;
function checkForUpdate () {
// #ires was needed for the News tab, which doesn't have a .srg. Perhaps we could use ires for all tabs.
var new_srg = document.querySelector('.srg') || document.querySelector('#ires');
// startpage
new_srg = new_srg || document.querySelector('.w-gl--default');
// ecosia
new_srg = new_srg || document.querySelector('.mainline');
//console.log("[FaviconizeGoogle.user.js] last_srg:" ,last_srg);
//console.log("[faviconizegoogle.user.js] new_srg:" ,new_srg);
var new_results_count = getGoogleResultsLinks().length;
if (new_srg !== last_srg || new_results_count !== results_count) {
//console.log("Page change detected!");
updateFavicons();
last_srg = new_srg;
results_count = new_results_count;
} else {
//console.log("Pages are the same:", last_srg, new_srg);
}
setTimeout(checkForUpdate, 1000);
}
setTimeout(checkForUpdate, 100);
