miniflux/internal/ui/static/js/app.js

730 lines
23 KiB
JavaScript
Raw Normal View History

2019-07-18 05:27:39 +02:00
// OnClick attaches a listener to the elements that match the selector.
function onClick(selector, callback, noPreventDefault) {
let elements = document.querySelectorAll(selector);
elements.forEach((element) => {
element.onclick = (event) => {
if (!noPreventDefault) {
event.preventDefault();
}
callback(event);
};
});
}
function onAuxClick(selector, callback, noPreventDefault) {
let elements = document.querySelectorAll(selector);
elements.forEach((element) => {
element.onauxclick = (event) => {
if (!noPreventDefault) {
event.preventDefault();
}
callback(event);
};
});
}
// make logo element as button on mobile layout
function checkMenuToggleModeByLayout() {
const logoElement = document.querySelector(".logo");
const homePageLinkElement = document.querySelector(".logo > a")
if (!logoElement) return
const logoToggleButtonLabel = logoElement.getAttribute("data-toggle-button-label")
const navMenuElement = document.getElementById("header-menu");
const navMenuElementIsExpanded = navMenuElement.classList.contains("js-menu-show")
if (document.documentElement.clientWidth < 620) {
logoElement.setAttribute("role", "button");
logoElement.setAttribute("tabindex", "0");
logoElement.setAttribute("aria-label", logoToggleButtonLabel)
if (navMenuElementIsExpanded) {
logoElement.setAttribute("aria-expanded", "true")
} else {
logoElement.setAttribute("aria-expanded", "false")
}
homePageLinkElement.setAttribute("tabindex", "-1")
} else {
logoElement.removeAttribute("role");
logoElement.removeAttribute("tabindex");
logoElement.removeAttribute("aria-expanded");
logoElement.removeAttribute("aria-label")
homePageLinkElement.removeAttribute("tabindex");
}
}
function fixVoiceOverDetailsSummaryBug() {
const detailsElements = document.querySelectorAll("details")
detailsElements.forEach((details) => {
const summaryElement = details.querySelector("summary")
summaryElement.setAttribute("role", "button")
setSummaryAriaExpandedByDetails(details, summaryElement)
details.addEventListener("toggle", () => {
setSummaryAriaExpandedByDetails(details, summaryElement)
})
})
function setSummaryAriaExpandedByDetails(details, summary) {
if (details.open) {
summary.setAttribute("aria-expanded", "true")
} else {
summary.setAttribute("aria-expanded", "false")
}
}
}
2019-07-18 05:27:39 +02:00
// Show and hide the main menu on mobile devices.
function toggleMainMenu(event) {
if (event.type === "keydown" && !(event.key === "Enter" || event.key === " ")) {
return
}
if (event.currentTarget.getAttribute("role")) {
event.preventDefault()
}
2019-07-18 05:27:39 +02:00
let menu = document.querySelector(".header nav ul");
let menuToggleButton = document.querySelector(".logo");
2024-01-25 09:36:10 +01:00
if (menu.classList.contains("js-menu-show")) {
menu.classList.remove("js-menu-show")
menuToggleButton.setAttribute("aria-expanded", false)
2019-07-18 05:27:39 +02:00
} else {
2024-01-25 09:36:10 +01:00
menu.classList.add("js-menu-show")
menuToggleButton.setAttribute("aria-expanded", true)
2019-07-18 05:27:39 +02:00
}
}
// Handle click events for the main menu (<li> and <a>).
function onClickMainMenuListItem(event) {
let element = event.target;
if (element.tagName === "A") {
window.location.href = element.getAttribute("href");
} else {
window.location.href = element.querySelector("a").getAttribute("href");
}
}
// Change the button label when the page is loading.
function handleSubmitButtons() {
let elements = document.querySelectorAll("form");
elements.forEach((element) => {
element.onsubmit = () => {
2019-08-16 07:08:24 +02:00
let button = element.querySelector("button");
2019-07-18 05:27:39 +02:00
if (button) {
button.textContent = button.dataset.labelLoading;
2019-07-18 05:27:39 +02:00
button.disabled = true;
}
};
});
}
// Show modal dialog with the list of keyboard shortcuts.
function showKeyboardShortcuts() {
let template = document.getElementById("keyboard-shortcuts");
if (template !== null) {
ModalHandler.open(template.content, "dialog-title");
2019-07-18 05:27:39 +02:00
}
}
// Mark as read visible items of the current page.
function markPageAsRead() {
let items = DomHelper.getVisibleElements(".items .item");
let entryIDs = [];
items.forEach((element) => {
element.classList.add("item-status-read");
entryIDs.push(parseInt(element.dataset.id, 10));
});
if (entryIDs.length > 0) {
updateEntriesStatus(entryIDs, "read", () => {
// Make sure the Ajax request reach the server before we reload the page.
let element = document.querySelector(":is(a, button)[data-action=markPageAsRead]");
2019-07-18 05:27:39 +02:00
let showOnlyUnread = false;
if (element) {
2019-07-18 06:07:29 +02:00
showOnlyUnread = element.dataset.showOnlyUnread || false;
2019-07-18 05:27:39 +02:00
}
if (showOnlyUnread) {
window.location.href = window.location.href;
2019-07-18 05:27:39 +02:00
} else {
goToPage("next", true);
}
});
}
}
/**
* Handle entry status changes from the list view and entry view.
* Focus the next or the previous entry if it exists.
* @param {string} item Item to focus: "previous" or "next".
* @param {Element} element
* @param {boolean} setToRead
*/
function handleEntryStatus(item, element, setToRead) {
let toasting = !element;
let currentEntry = findEntry(element);
if (currentEntry) {
if (!setToRead || currentEntry.querySelector(":is(a, button)[data-toggle-status]").dataset.value == "unread") {
toggleEntryStatus(currentEntry, toasting);
}
if (isListView() && currentEntry.classList.contains('current-item')) {
switch (item) {
case "previous":
goToListItem(-1);
break;
case "next":
goToListItem(1);
break;
}
}
}
}
2019-07-18 05:27:39 +02:00
// Change the entry status to the opposite value.
function toggleEntryStatus(element, toasting) {
2019-07-18 05:27:39 +02:00
let entryID = parseInt(element.dataset.id, 10);
let link = element.querySelector(":is(a, button)[data-toggle-status]");
2019-07-18 05:27:39 +02:00
let currentStatus = link.dataset.value;
let newStatus = currentStatus === "read" ? "unread" : "read";
link.querySelector("span").textContent = link.dataset.labelLoading;
updateEntriesStatus([entryID], newStatus, () => {
let iconElement, label;
if (currentStatus === "read") {
iconElement = document.querySelector("template#icon-read");
label = link.dataset.labelRead;
if (toasting) {
showToast(link.dataset.toastUnread, iconElement);
}
} else {
iconElement = document.querySelector("template#icon-unread");
label = link.dataset.labelUnread;
if (toasting) {
showToast(link.dataset.toastRead, iconElement);
}
}
2019-07-18 05:27:39 +02:00
link.innerHTML = iconElement.innerHTML + '<span class="icon-label">' + label + '</span>';
link.dataset.value = newStatus;
2020-12-30 05:47:18 +01:00
if (element.classList.contains("item-status-" + currentStatus)) {
element.classList.remove("item-status-" + currentStatus);
element.classList.add("item-status-" + newStatus);
}
});
2019-07-18 05:27:39 +02:00
}
// Mark a single entry as read.
function markEntryAsRead(element) {
if (element.classList.contains("item-status-unread")) {
element.classList.remove("item-status-unread");
element.classList.add("item-status-read");
let entryID = parseInt(element.dataset.id, 10);
updateEntriesStatus([entryID], "read");
}
}
// Send the Ajax request to refresh all feeds in the background
function handleRefreshAllFeeds() {
let url = document.body.dataset.refreshAllFeedsUrl;
if (url) {
window.location.href = url;
}
}
2019-07-18 05:27:39 +02:00
// Send the Ajax request to change entries statuses.
function updateEntriesStatus(entryIDs, status, callback) {
let url = document.body.dataset.entriesStatusUrl;
let request = new RequestBuilder(url);
request.withBody({entry_ids: entryIDs, status: status});
request.withCallback((resp) => {
resp.json().then(count => {
2023-08-01 06:11:39 +02:00
if (callback) {
callback(resp);
}
2019-07-18 05:27:39 +02:00
if (status === "read") {
decrementUnreadCounter(count);
} else {
incrementUnreadCounter(count);
}
});
});
request.execute();
2019-07-18 05:27:39 +02:00
}
// Handle save entry from list view and entry view.
function handleSaveEntry(element) {
let toasting = !element;
let currentEntry = findEntry(element);
if (currentEntry) {
saveEntry(currentEntry.querySelector(":is(a, button)[data-save-entry]"), toasting);
2019-07-18 05:27:39 +02:00
}
}
// Send the Ajax request to save an entry.
function saveEntry(element, toasting) {
2019-07-18 05:27:39 +02:00
if (!element) {
return;
}
if (element.dataset.completed) {
return;
}
2020-03-22 23:18:12 +01:00
element.innerHTML = '<span class="icon-label">' + element.dataset.labelLoading + '</span>';
2019-07-18 05:27:39 +02:00
let request = new RequestBuilder(element.dataset.saveUrl);
request.withCallback(() => {
element.innerHTML = '<span class="icon-label">' + element.dataset.labelDone + '</span>';
2019-07-18 05:27:39 +02:00
element.dataset.completed = true;
if (toasting) {
2021-03-07 20:55:43 +01:00
let iconElement = document.querySelector("template#icon-save");
showToast(element.dataset.toastDone, iconElement);
}
2019-07-18 05:27:39 +02:00
});
request.execute();
}
// Handle bookmark from the list view and entry view.
function handleBookmark(element) {
let toasting = !element;
let currentEntry = findEntry(element);
if (currentEntry) {
toggleBookmark(currentEntry, toasting);
2019-07-18 05:27:39 +02:00
}
}
// Send the Ajax request and change the icon when bookmarking an entry.
function toggleBookmark(parentElement, toasting) {
let element = parentElement.querySelector(":is(a, button)[data-toggle-bookmark]");
2019-07-18 05:27:39 +02:00
if (!element) {
return;
}
2020-03-22 23:18:12 +01:00
element.innerHTML = '<span class="icon-label">' + element.dataset.labelLoading + '</span>';
2019-07-18 05:27:39 +02:00
let request = new RequestBuilder(element.dataset.bookmarkUrl);
request.withCallback(() => {
2020-12-30 05:47:18 +01:00
let currentStarStatus = element.dataset.value;
let newStarStatus = currentStarStatus === "star" ? "unstar" : "star";
2021-03-07 20:55:43 +01:00
let iconElement, label;
2020-12-30 05:47:18 +01:00
if (currentStarStatus === "star") {
2021-03-07 20:55:43 +01:00
iconElement = document.querySelector("template#icon-star");
2020-12-30 05:47:18 +01:00
label = element.dataset.labelStar;
if (toasting) {
2021-03-07 20:55:43 +01:00
showToast(element.dataset.toastUnstar, iconElement);
}
2019-07-18 05:27:39 +02:00
} else {
2021-03-07 20:55:43 +01:00
iconElement = document.querySelector("template#icon-unstar");
2020-12-30 05:47:18 +01:00
label = element.dataset.labelUnstar;
if (toasting) {
2021-03-07 20:55:43 +01:00
showToast(element.dataset.toastStar, iconElement);
}
2019-07-18 05:27:39 +02:00
}
2020-12-30 05:47:18 +01:00
2021-03-07 20:55:43 +01:00
element.innerHTML = iconElement.innerHTML + '<span class="icon-label">' + label + '</span>';
2020-12-30 05:47:18 +01:00
element.dataset.value = newStarStatus;
2019-07-18 05:27:39 +02:00
});
request.execute();
}
// Send the Ajax request to download the original web page.
function handleFetchOriginalContent() {
if (isListView()) {
return;
}
let element = document.querySelector(":is(a, button)[data-fetch-content-entry]");
2019-07-18 05:27:39 +02:00
if (!element) {
return;
}
let previousElement = element.cloneNode(true)
2020-03-22 23:18:12 +01:00
element.innerHTML = '<span class="icon-label">' + element.dataset.labelLoading + '</span>';
2019-07-18 05:27:39 +02:00
let request = new RequestBuilder(element.dataset.fetchContentUrl);
request.withCallback((response) => {
element.textContent = '';
element.appendChild(previousElement);
2019-07-18 05:27:39 +02:00
response.json().then((data) => {
if (data.hasOwnProperty("content") && data.hasOwnProperty("reading_time")) {
2019-07-18 05:27:39 +02:00
document.querySelector(".entry-content").innerHTML = data.content;
let entryReadingtimeElement = document.querySelector(".entry-reading-time");
if (entryReadingtimeElement) {
entryReadingtimeElement.innerHTML = data.reading_time;
}
2019-07-18 05:27:39 +02:00
}
});
});
request.execute();
}
function openOriginalLink(openLinkInCurrentTab) {
2019-07-18 05:27:39 +02:00
let entryLink = document.querySelector(".entry h1 a");
if (entryLink !== null) {
if (openLinkInCurrentTab) {
window.location.href = entryLink.getAttribute("href");
} else {
DomHelper.openNewTab(entryLink.getAttribute("href"));
}
2019-07-18 05:27:39 +02:00
return;
}
let currentItemOriginalLink = document.querySelector(".current-item :is(a, button)[data-original-link]");
2019-07-18 05:27:39 +02:00
if (currentItemOriginalLink !== null) {
DomHelper.openNewTab(currentItemOriginalLink.getAttribute("href"));
let currentItem = document.querySelector(".current-item");
// If we are not on the list of starred items, move to the next item
if (document.location.href != document.querySelector(':is(a, button)[data-page=starred]').href) {
goToListItem(1);
}
2019-07-18 05:27:39 +02:00
markEntryAsRead(currentItem);
}
}
2020-01-07 07:02:02 +01:00
function openCommentLink(openLinkInCurrentTab) {
if (!isListView()) {
let entryLink = document.querySelector(":is(a, button)[data-comments-link]");
2020-01-07 07:02:02 +01:00
if (entryLink !== null) {
if (openLinkInCurrentTab) {
window.location.href = entryLink.getAttribute("href");
} else {
DomHelper.openNewTab(entryLink.getAttribute("href"));
}
return;
}
} else {
let currentItemCommentsLink = document.querySelector(".current-item :is(a, button)[data-comments-link]");
2020-01-07 07:02:02 +01:00
if (currentItemCommentsLink !== null) {
DomHelper.openNewTab(currentItemCommentsLink.getAttribute("href"));
}
}
}
2019-07-18 05:27:39 +02:00
function openSelectedItem() {
let currentItemLink = document.querySelector(".current-item .item-title a");
if (currentItemLink !== null) {
window.location.href = currentItemLink.getAttribute("href");
}
}
function unsubscribeFromFeed() {
let unsubscribeLinks = document.querySelectorAll("[data-action=remove-feed]");
if (unsubscribeLinks.length === 1) {
let unsubscribeLink = unsubscribeLinks[0];
let request = new RequestBuilder(unsubscribeLink.dataset.url);
request.withCallback(() => {
if (unsubscribeLink.dataset.redirectUrl) {
window.location.href = unsubscribeLink.dataset.redirectUrl;
} else {
window.location.reload();
}
});
request.execute();
}
}
/**
* @param {string} page Page to redirect to.
* @param {boolean} fallbackSelf Refresh actual page if the page is not found.
*/
function goToPage(page, fallbackSelf) {
let element = document.querySelector(":is(a, button)[data-page=" + page + "]");
2019-07-18 05:27:39 +02:00
if (element) {
document.location.href = element.href;
} else if (fallbackSelf) {
window.location.reload();
}
}
function goToPrevious() {
if (isListView()) {
goToListItem(-1);
2019-07-18 05:27:39 +02:00
} else {
goToPage("previous");
}
}
function goToNext() {
if (isListView()) {
goToListItem(1);
2019-07-18 05:27:39 +02:00
} else {
goToPage("next");
}
}
function goToFeedOrFeeds() {
if (isEntry()) {
goToFeed();
} else {
goToPage('feeds');
}
}
function goToFeed() {
2019-07-18 05:27:39 +02:00
if (isEntry()) {
let feedAnchor = document.querySelector("span.entry-website a");
if (feedAnchor !== null) {
window.location.href = feedAnchor.href;
}
} else {
let currentItemFeed = document.querySelector(".current-item :is(a, button)[data-feed-link]");
if (currentItemFeed !== null) {
window.location.href = currentItemFeed.getAttribute("href");
}
2019-07-18 05:27:39 +02:00
}
}
/**
* @param {number} offset How many items to jump for focus.
*/
function goToListItem(offset) {
let items = DomHelper.getVisibleElements(".items .item");
if (items.length === 0) {
return;
}
if (document.querySelector(".current-item") === null) {
items[0].classList.add("current-item");
items[0].focus();
return;
}
for (let i = 0; i < items.length; i++) {
if (items[i].classList.contains("current-item")) {
items[i].classList.remove("current-item");
let item = items[(i + offset + items.length) % items.length];
item.classList.add("current-item");
DomHelper.scrollPageTo(item);
item.focus();
break;
}
}
}
function scrollToCurrentItem() {
let currentItem = document.querySelector(".current-item");
if (currentItem !== null) {
DomHelper.scrollPageTo(currentItem, true);
}
}
2019-07-18 05:27:39 +02:00
function decrementUnreadCounter(n) {
updateUnreadCounterValue((current) => {
return current - n;
});
}
function incrementUnreadCounter(n) {
updateUnreadCounterValue((current) => {
return current + n;
});
}
function updateUnreadCounterValue(callback) {
let counterElements = document.querySelectorAll("span.unread-counter");
counterElements.forEach((element) => {
let oldValue = parseInt(element.textContent, 10);
element.innerHTML = callback(oldValue);
});
if (window.location.href.endsWith('/unread')) {
let oldValue = parseInt(document.title.split('(')[1], 10);
let newValue = callback(oldValue);
document.title = document.title.replace(
/(.*?)\(\d+\)(.*?)/,
function (match, prefix, suffix, offset, string) {
return prefix + '(' + newValue + ')' + suffix;
}
);
}
}
function isEntry() {
return document.querySelector("section.entry") !== null;
}
function isListView() {
return document.querySelector(".items") !== null;
}
function findEntry(element) {
if (isListView()) {
if (element) {
return element.closest(".item")
} else {
return document.querySelector(".current-item");
}
} else {
return document.querySelector(".entry");
}
}
2019-07-18 06:07:29 +02:00
function handleConfirmationMessage(linkElement, callback) {
if (linkElement.tagName != 'A' && linkElement.tagName != "BUTTON") {
2020-06-15 04:00:41 +02:00
linkElement = linkElement.parentNode;
}
2019-07-18 06:07:29 +02:00
2020-06-15 04:00:41 +02:00
linkElement.style.display = "none";
2023-08-01 06:11:39 +02:00
2019-07-18 06:07:29 +02:00
let containerElement = linkElement.parentNode;
let questionElement = document.createElement("span");
function createLoadingElement() {
2019-07-18 06:07:29 +02:00
let loadingElement = document.createElement("span");
loadingElement.className = "loading";
loadingElement.appendChild(document.createTextNode(linkElement.dataset.labelLoading));
questionElement.remove();
containerElement.appendChild(loadingElement);
}
let yesElement = document.createElement("button");
yesElement.appendChild(document.createTextNode(linkElement.dataset.labelYes));
yesElement.onclick = (event) => {
event.preventDefault();
createLoadingElement();
2019-07-18 06:07:29 +02:00
callback(linkElement.dataset.url, linkElement.dataset.redirectUrl);
};
let noElement = document.createElement("button");
2019-07-18 06:07:29 +02:00
noElement.appendChild(document.createTextNode(linkElement.dataset.labelNo));
noElement.onclick = (event) => {
event.preventDefault();
const noActionUrl = linkElement.dataset.noActionUrl;
if (noActionUrl) {
createLoadingElement();
callback(noActionUrl, linkElement.dataset.redirectUrl);
} else {
linkElement.style.display = "inline";
questionElement.remove();
}
2019-07-18 06:07:29 +02:00
};
questionElement.className = "confirm";
questionElement.appendChild(document.createTextNode(linkElement.dataset.labelQuestion + " "));
questionElement.appendChild(yesElement);
questionElement.appendChild(document.createTextNode(", "));
questionElement.appendChild(noElement);
containerElement.appendChild(questionElement);
}
2021-03-07 20:55:43 +01:00
function showToast(label, iconElement) {
if (!label || !iconElement) {
return;
}
const toastMsgElement = document.getElementById("toast-msg");
if (toastMsgElement) {
toastMsgElement.innerHTML = iconElement.innerHTML + '<span class="icon-label">' + label + '</span>';
const toastElementWrapper = document.getElementById("toast-wrapper");
if (toastElementWrapper) {
toastElementWrapper.classList.remove('toast-animate');
setTimeout(function () {
toastElementWrapper.classList.add('toast-animate');
}, 100);
}
}
}
/** Navigate to the new subscription page. */
function goToAddSubscription() {
window.location.href = document.body.dataset.addSubscriptionUrl;
}
Add Media Player and resume to last playback position In order to ease podcast listening, the player can be put on top of the feed entry as main content. Use the `Use podcast player` option to enable that. It works on audio and video. Also, when playing audio or video, progression will be saved in order to be able to resume listening later. This position saving is done using the original attachement/enclosures player AND podcast player and do not rely on the podcast player option ti be enabled. Additionally, I made the player fill the width with the entry container to ease seeking and have a bigger video. updateEnclosures now keep existing enclosures based on URL When feeds get updated, enclosures entries are always wiped and re-created. This cause two issue - enclosure progression get lost in the process - enclosure ID changes I used the URL as identifier of an enclosure. Not perfect but hopefully should work. When an enclosure already exist, I simply do nothing and leave the entry as is in the database. If anyone is listening/watching to this enclosure during the refresh, the id stay coherent and progression saving still works. The updateEnclosures function got a bit more complex. I tried to make it the more clear I could. Some optimisation are possible but would make the function harder to read in my opinion. I'm not sure if this is often the case, but some feeds may include tracking or simply change the url each time we update the feed. In those situation, enclosures ids and progression will be lost. I have no idea how to handle this last situation. Use the size instead/alongside url to define the identity of an enclosure ? Translation: english as placeholder for every language except French Aside, I tested a video feed and fixed a few things for it. In fact, the MimeType was not working at all on my side, and found a pretty old stackoverflow discussion that suggest to use an Apple non-standard MimeType for m4v video format. I only did one substitution because I only have one feed to test. Any new video feed can make this go away or evolve depending on the situation. Real video feeds does not tend to be easy to find and test extensively this. Co-authored-by: toastal
2023-04-13 11:46:43 +02:00
/**
* save player position to allow to resume playback later
* @param {Element} playerElement
*/
function handlePlayerProgressionSave(playerElement) {
const currentPositionInSeconds = Math.floor(playerElement.currentTime); // we do not need a precise value
const lastKnownPositionInSeconds = parseInt(playerElement.dataset.lastPosition, 10);
const recordInterval = 10;
// we limit the number of update to only one by interval. Otherwise, we would have multiple update per seconds
if (currentPositionInSeconds >= (lastKnownPositionInSeconds + recordInterval) ||
currentPositionInSeconds <= (lastKnownPositionInSeconds - recordInterval)
) {
playerElement.dataset.lastPosition = currentPositionInSeconds.toString();
let request = new RequestBuilder(playerElement.dataset.saveUrl);
request.withBody({progression: currentPositionInSeconds});
request.execute();
}
}
2023-08-01 06:11:39 +02:00
/**
* handle new share entires and already shared entries
*/
function handleShare() {
let link = document.querySelector(':is(a, button)[data-share-status]');
2023-08-01 06:11:39 +02:00
let title = document.querySelector("body > main > section > header > h1 > a");
if (link.dataset.shareStatus === "shared") {
checkShareAPI(title, link.href);
}
if (link.dataset.shareStatus === "share") {
let request = new RequestBuilder(link.href);
request.withCallback((r) => {
checkShareAPI(title, r.url);
});
request.withHttpMethod("GET");
request.execute();
}
}
/**
* wrapper for Web Share API
*/
function checkShareAPI(title, url) {
if (!navigator.canShare) {
console.error("Your browser doesn't support the Web Share API.");
window.location = url;
return;
}
try {
navigator.share({
title: title,
url: url
});
window.location.reload();
} catch (err) {
console.error(err);
window.location.reload();
}
2023-11-06 18:28:25 +01:00
}
function getCsrfToken() {
let element = document.querySelector("body[data-csrf-token]");
if (element !== null) {
return element.dataset.csrfToken;
}
return "";
}