Skip to content

feat:Quick categories #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

feat:Quick categories #93

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
85d0764
feat: reusability for toggle settings
DanieliusAsm Apr 25, 2024
3ecbce7
show/hide rotate, hunger games logo search buttons
DanieliusAsm Apr 25, 2024
079c6f7
Merge branch 'master' into quick_categories
DanieliusAsm Apr 25, 2024
32a3abe
reduced list icon sizes
DanieliusAsm Apr 25, 2024
f52f5f7
bugfix: PUS buttons disappear when switch is used
DanieliusAsm Apr 26, 2024
fe1fc4a
food preference bugfix
DanieliusAsm Apr 28, 2024
8af1d64
2 quick categories
DanieliusAsm Apr 28, 2024
6ff619b
Update OpenFoodFactsPower.user.js
CharlesNepote Jan 10, 2025
5a57fa3
Merge branch 'master' into quick_categories
CharlesNepote Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
299 changes: 205 additions & 94 deletions OpenFoodFactsPower.user.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// @name Open Food Facts power user script
// @description Helps power users in their day to day work. Key "?" shows help. This extension is a kind of sandbox to experiment features that could be added to Open Food Facts website.
// @namespace openfoodfacts.org
// @version 2024-12-20T11:15
// @version 2025-01-10T11:31
// @include https://*.openfoodfacts.org/*
// @include https://*.openproductsfacts.org/*
// @include https://*.openbeautyfacts.org/*
Expand Down Expand Up @@ -64,7 +64,7 @@
var proPlatform = false; // TODO: to be included in isPageType()
const pageType = isPageType(); // test page type
const corsProxyURL = "";
log("2024-12-20T11:15 - mode: " + pageType);
log("2025-01-10T11:31 - mode: " + pageType);

// Disable extension if the page is an API result; https://world.openfoodfacts.org/api/v0/product/3222471092705.json
if (pageType === "api") {
Expand Down Expand Up @@ -428,6 +428,10 @@
border-radius: 0 10px 10px 0;
z-index: 200;
}
/* --------------- List buttons size --------------- */
#list_button {
font-size: 20px;
}

/* --------------- Hunger games logo search button --------------- */
.list_hunger_games_logo_search {
Expand All @@ -438,7 +442,7 @@
border-radius: 0.3em;
}

.list_hunger_games_logo_search:hover, .list_rotate_image_90:hover, .list_rotate_image_180:hover, .list_rotate_image_270:hover {
.list_hunger_games_logo_search:hover, .list_rotate_image_90:hover, .list_rotate_image_180:hover, .list_rotate_image_270:hover, .list_quick_category_1:hover, .list_quick_category_2:hover {
background-color: #aaf;
}

Expand Down Expand Up @@ -467,6 +471,35 @@
border-radius: 0.3em;
}

/* --------------- List quick category --------------- */
.list_categories_card {
position: sticky;
top: 10em;
left:0;
border-radius: 8px;
padding: 0;
background-color: #fff;
display: flex;
width: 2em;
flex-direction: column;
box-shadow: 0 4px 4px rgba(0,0,0,.25);
}

.list_quick_category_1 {
position: absolute;
top: 4em;
left: 0;
border-radius: 0.3em;
}

.list_quick_category_2 {
position: absolute;
top: 6em;
left: 0;
border-radius: 0.3em;
}


/* ---------------- /Power User Script UI -------------------------- */


Expand Down Expand Up @@ -1192,6 +1225,9 @@
<hr>
<li><input class="pus-checkbox" type="checkbox" id="pus-ingredients-font"><label for="pus-ingredients-font">Ingredients fixed-width font</label></li>
<li><input class="pus-checkbox" type="checkbox" id="pus-always-show-barcode"><label for="pus-always-show-barcode">Always show barcodes</label></li>
<li><input class="pus-checkbox" type="checkbox" id="pus-rotation-buttons"><label for="pus-rotation-buttons">Image rotation buttons</label></li>
<li><input class="pus-checkbox" type="checkbox" id="pus-hunger-games-logo-search"><label for="pus-hunger-games-logo-search">Hunger Games logo search button</label></li>
<li><input class="pus-checkbox" type="checkbox" id="pus-quick-categories"><label for="pus-quick-categories">Quick set categories</label></li>
<hr>
<li>(Shift+L): List edit mode</li>
<li>(Shift+b): Show/hide barcodes</li>
Expand All @@ -1205,13 +1241,25 @@
$("#pwe_help").click(function(){
togglePowerUserInfo(listhelp);
toggleIngredientsMonospace();
toggleAlwaysShowBarcodes();
toggleASetting('pus-always-show-barcode',toggleListBarcodes);
toggleASetting('pus-rotation-buttons',toggleRotationButtons);
toggleASetting('pus-hunger-games-logo-search',toggleHungerGamesButton);
toggleASetting('pus-quick-categories',toggleQuickCategories);
});

// detect product codes and add them as attributes
addCodesToProductList();
showListButtons();
loadAlwaysShowBarcodesFromStorage();
showListButtonsByDefault();
$( window ).on( "load", function() {
loadASettingFromStorage('pus-always-show-barcode',toggleListBarcodes);
loadASettingFromStorage('pus-rotation-buttons',toggleRotationButtons);
loadASettingFromStorage('pus-hunger-games-logo-search',toggleHungerGamesButton);
loadASettingFromStorage('pus-quick-categories',toggleQuickCategories);
});
setTimeout(function(){
listenToFoodPreferences();
}, 5000);


// Show an easier to read number of products
/*
Expand Down Expand Up @@ -1889,29 +1937,169 @@
});
}

function toggleAlwaysShowBarcodes(){
if(getLocalStorage("pus-always-show-barcode") === "always"){
$('#pus-always-show-barcode').prop("checked", true);
//2 reusable functions that can be used for toggleable setting such as "always show barcodes".
function toggleASetting(checkboxId, toggleFunctionToCall){
if(getLocalStorage(checkboxId) === "enabled"){
$('#'+checkboxId).prop("checked", true);
}

$('#pus-always-show-barcode').change(function() {
$('#'+checkboxId).change(function() {
if(this.checked){
localStorage.setItem('pus-always-show-barcode', "always");
localStorage.setItem(checkboxId, "enabled");
}else{
localStorage.setItem('pus-always-show-barcode', "never");
localStorage.setItem(checkboxId, "disabled");
}
toggleListBarcodes();
toggleFunctionToCall();
});
}

function loadAlwaysShowBarcodesFromStorage(){
$( window ).on( "load", function() {
if(getLocalStorage("pus-always-show-barcode") === "always"){
toggleListBarcodes();
function loadASettingFromStorage(checkboxId, toggleFunctionToCall){
if(getLocalStorage(checkboxId) === "enabled"){
toggleFunctionToCall();
}
}


function toggleHungerGamesButton(){
if($("a.list_hunger_games_logo_search").length){
$("a.list_hunger_games_logo_search").remove();
}else{
showListHungerGamesButtons();
}
}

function toggleQuickCategories(){
$("ul[id^='products_'].search_results li[data-code]").each(function(index, element) {
let code = $(this).attr('data-code');

$('<div id="quick_category_' + code + '" class="list_categories_card"></div>').insertBefore( $('a.list_product_a', this) );

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML Medium

DOM text
Loading
is reinterpreted as HTML without escaping meta-characters.

$('#quick_category_' + code,$(this)).append('<a class="list_quick_category_1" alt="Pets" title="Pets"><span class="material-icons" id="list_button">pets</span></a>');
$('#quick_category_' + code,$(this)).append('<a class="list_quick_category_2" alt="Beauty" title="Beauty"><span class="material-icons" id="list_button">emoji_nature</span></a>');
});
}
/**
* Show/hide rotation icons in list view
*/
function toggleRotationButtons(){
if($("a.list_rotate_image_270").length){
hideRotationButtons();
}else{
showListRotateButtons();
}
}

function hideRotationButtons(){
$("a.list_rotate_image_270").remove();
$("a.list_rotate_image_180").remove();
$("a.list_rotate_image_90").remove();
}

function showListButtonsByDefault(){
if(!getLocalStorage('pus-rotation-buttons')){
localStorage.setItem('pus-rotation-buttons', "enabled");
}
if(!getLocalStorage('pus-hunger-games-logo-search')){
localStorage.setItem('pus-hunger-games-logo-search', "enabled");
}
}

/** listens to Food preference changes, since any change there redraws the whole product list
* making the list buttons disappear
*/
function listenToFoodPreferences(){
$('#preferences_switch_in_list_of_products_switch input').change(function(){
addCodesToProductList();
loadASettingFromStorage('pus-always-show-barcode',toggleListBarcodes);
loadASettingFromStorage('pus-rotation-buttons',toggleRotationButtons);
loadASettingFromStorage('pus-hunger-games-logo-search',toggleHungerGamesButton);
loadASettingFromStorage('pus-quick-categories',null);
});
}

//shows HungerGames logo
function showListHungerGamesButtons(){
$("ul[id^='products_'].search_results li[data-code]").each(function(index, element) {
let barcode = $(this).attr('data-code');
$(this).append('<a class="list_hunger_games_logo_search" alt="Hunger games logo search" title="Hunger games logo search" href="https://hunger.openfoodfacts.org/logos/search?barcode='+barcode+'"><span class="material-icons" id="list_button">image_search</span></a>');

Check warning

Code scanning / CodeQL

DOM text reinterpreted as HTML Medium

DOM text
Loading
is reinterpreted as HTML without escaping meta-characters.
});
}

function showListRotateButtons(){
let languageCode = getSubdomainLanguageCode();

$("ul[id^='products_'].search_results li[data-code]").each(function(index, element) {
let barcode = $(this).attr('data-code');
$(this).append('<a class="list_rotate_image_270" alt="Rotate at -90°" title="Rotate at -90°"><span class="material-icons" id="list_button" style="transform: scaleX(-1);">redo</span></a>');
$(this).append('<a class="list_rotate_image_180" alt="Rotate at 180°" title="Rotate at 180°"><span class="material-icons" id="list_button">rotate_right</span></a>');
$(this).append('<a class="list_rotate_image_90" alt="Rotate at 90°" title="Rotate at 90°"><span class="material-icons" id="list_button">redo</span></a>');

var image_reference = $(".list_product_img", $(this));
$(".list_rotate_image_270",$(this)).on("click", function(){
getFrontImagesToRotate(270,barcode,languageCode);
image_reference.css('transform', 'rotate(270deg)');
});

$(".list_rotate_image_180",$(this)).on("click", function(){
getFrontImagesToRotate(180,barcode,languageCode);
image_reference.css('transform', 'rotate(180deg)');
});

$(".list_rotate_image_90",$(this)).on("click", function(){
getFrontImagesToRotate(90,barcode,languageCode);
image_reference.css('transform', 'rotate(90deg)');
});
});
}

//if 'ru-en'->ru while $("html").attr('lang'); returns en
function getSubdomainLanguageCode(){
var subdomain = window.location.href.split('.')[0].split('//')[1];
if(subdomain === 'world'){ return 'en';}
if(subdomain.length === 2){ return subdomain;}

return subdomain.split('-')[0];
}

/*gets all the front_lc images available and then compares it to the subdomain.
For example if you are on ru.openfoodfacts and a product only has front_en then that picture will be rotated
instead of creating a new rotated front_ru */
function getFrontImagesToRotate(angle,barcode,languageCode){
var _productUrl = "/api/v2/product/" + barcode + ".json?fields=images";
$.getJSON(_productUrl,function(productData){
let productImages = productData.product.images;
var frontImages = [];
if(productImages){
$.each(productImages,function(key,value){
let startsWithFront = key.toString().startsWith('front');
if(startsWithFront){
frontImages.push(key);
}
});
if(frontImages.length>0){
let includesLanguageCode = frontImages.includes("front_"+languageCode);
var front_lc = frontImages[0];

if(includesLanguageCode){
front_lc = "front_"+languageCode;
}

let image_id = productImages[front_lc].imgid;
//let angle = productImages[front_lc].angle;
rotateImage(angle,barcode,front_lc,image_id);
}

}
});
}

function rotateImage(angle,barcode,front_lc,image_id){
var _url = "/cgi/product_image_crop.pl?code=" + barcode + "&id="+front_lc+"&imgid="+image_id+"&angle="+angle;
$.getJSON(_url, function(data) {
log("rotate status:" +data.status);
});
}


/**
* Show/hide a graphical barcode on the product view
Expand Down Expand Up @@ -2013,83 +2201,6 @@
$('ul[id^="products_"].search_results .with_barcode').removeClass('with_barcode');
}

//shows HungerGames logo, rotate buttons
function showListButtons(){
let languageCode = getSubdomainLanguageCode();

$("ul[id^='products_'].search_results li[data-code]").each(function(index, element) {
let barcode = $(this).attr('data-code');
$(this).append('<a class="list_hunger_games_logo_search" alt="Hunger games logo search" title="Hunger games logo search" href="https://hunger.openfoodfacts.org/logos/search?barcode='+barcode+'"><span class="material-icons">image_search</span></a>');
$(this).append('<a class="list_rotate_image_270" alt="Rotate at -90°" title="Rotate at -90°"><span class="material-icons" style="transform: scaleX(-1);">redo</span></a>');
$(this).append('<a class="list_rotate_image_180" alt="Rotate at 180°" title="Rotate at 180°"><span class="material-icons">rotate_right</span></a>');
$(this).append('<a class="list_rotate_image_90" alt="Rotate at 90°" title="Rotate at 90°"><span class="material-icons">redo</span></a>');

var image_reference = $(".list_product_img", $(this));
$(".list_rotate_image_270",$(this)).on("click", function(){
getFrontImagesToRotate(270,barcode,languageCode);
image_reference.css('transform', 'rotate(270deg)');
});

$(".list_rotate_image_180",$(this)).on("click", function(){
getFrontImagesToRotate(180,barcode,languageCode);
image_reference.css('transform', 'rotate(180deg)');
});

$(".list_rotate_image_90",$(this)).on("click", function(){
getFrontImagesToRotate(90,barcode,languageCode);
image_reference.css('transform', 'rotate(90deg)');
});
});
}

//if 'ru-en'->ru while $("html").attr('lang'); returns en
function getSubdomainLanguageCode(){
var subdomain = window.location.href.split('.')[0].split('//')[1];
if(subdomain === 'world'){ return 'en';}
if(subdomain.length === 2){ return subdomain;}

return subdomain.split('-')[0];
}

/*gets all the front_lc images available and then compares it to the subdomain.
For example if you are on ru.openfoodfacts and a product only has front_en then that picture will be rotated
instead of creating a new rotated front_ru */
function getFrontImagesToRotate(angle,barcode,languageCode){
var _productUrl = "/api/v2/product/" + barcode + ".json?fields=images";
$.getJSON(_productUrl,function(productData){
let productImages = productData.product.images;
var frontImages = [];
if(productImages){
$.each(productImages,function(key,value){
let startsWithFront = key.toString().startsWith('front');
if(startsWithFront){
frontImages.push(key);
}
});
if(frontImages.length>0){
let includesLanguageCode = frontImages.includes("front_"+languageCode);
var front_lc = frontImages[0];

if(includesLanguageCode){
front_lc = "front_"+languageCode;
}

let image_id = productImages[front_lc].imgid;
//let angle = productImages[front_lc].angle;
rotateImage(angle,barcode,front_lc,image_id);
}

}
});
}

function rotateImage(angle,barcode,front_lc,image_id){
var _url = "/cgi/product_image_crop.pl?code=" + barcode + "&id="+front_lc+"&imgid="+image_id+"&angle="+angle;
$.getJSON(_url, function(data) {
log("rotate status:" +data.status);
});
}

/**
* The product list view has no easy way to get the barcode for each entry,
* so detect them from the link, and add an attribute to the LI tag recording the barcode for later use.
Expand Down
Loading