added more info to media Metadata, and cleaned up itemDTO object.

This commit is contained in:
ArabCoders 2024-12-27 19:58:21 +03:00
parent 6851e1d911
commit 6b930bb388
10 changed files with 129 additions and 62 deletions

3
.vscode/launch.json vendored
View file

@ -37,7 +37,8 @@
"YTP_LOG_LEVEL": "DEBUG", "YTP_LOG_LEVEL": "DEBUG",
"YTP_DEBUG": "true", "YTP_DEBUG": "true",
"YTP_YTDL_DEBUG": "true", "YTP_YTDL_DEBUG": "true",
"YTP_MAX_WORKERS": "2" "YTP_MAX_WORKERS": "2",
"YTP_IGNORE_UI": "true",
} }
}, },
{ {

View file

@ -135,6 +135,12 @@ class DownloadQueue:
LOG.exception(e) LOG.exception(e)
return {"status": "error", "msg": str(e)} return {"status": "error", "msg": str(e)}
extras: dict = {}
fields: tuple = ("uploader", "channel", "thumbnail")
for field in fields:
if entry.get(field, None):
extras[field] = entry.get(field)
dl = ItemDTO( dl = ItemDTO(
id=entry.get("id"), id=entry.get("id"),
title=entry.get("title"), title=entry.get("title"),
@ -153,6 +159,7 @@ class DownloadQueue:
is_live=is_live, is_live=is_live,
live_in=live_in, live_in=live_in,
options=options, options=options,
extras=extras,
) )
for property, value in entry.items(): for property, value in entry.items():

View file

@ -123,7 +123,12 @@ class HttpAPI(common):
preloaded += 2 preloaded += 2
if preloaded < 1: if preloaded < 1:
raise ValueError(f"Could not find the frontend UI static assets. '{staticDir}'.") message = f"Could not find the frontend UI static assets. '{staticDir}'."
if self.config.ignore_ui:
LOG.warning(message)
return
raise ValueError(message)
LOG.info(f"Preloaded '{preloaded}' static files.") LOG.info(f"Preloaded '{preloaded}' static files.")
@ -301,9 +306,7 @@ class HttpAPI(common):
remove_file: bool = bool(post.get("remove_file", True)) remove_file: bool = bool(post.get("remove_file", True))
return web.json_response( return web.json_response(
data=await ( data=await (self.queue.cancel(ids) if where == "queue" else self.queue.clear(ids, remove_file=remove_file)),
self.queue.cancel(ids) if where == "queue" else self.queue.clear(ids, remove_file=remove_file)
),
status=web.HTTPOk.status_code, status=web.HTTPOk.status_code,
dumps=self.encoder.encode, dumps=self.encoder.encode,
) )

View file

@ -36,6 +36,7 @@ class ItemDTO:
live_in: str | None = None live_in: str | None = None
file_size: int | None = None file_size: int | None = None
options: dict = field(default_factory=dict) options: dict = field(default_factory=dict)
extras: dict = field(default_factory=dict)
# yt-dlp injected fields. # yt-dlp injected fields.
tmpfilename: str | None = None tmpfilename: str | None = None
@ -48,5 +49,21 @@ class ItemDTO:
speed: str | None = None speed: str | None = None
eta: str | None = None eta: str | None = None
def serialize(self) -> dict:
deprecated: tuple = (
"thumbnail",
"quality",
"format",
)
if self.thumbnail and "thumbnail" not in self.extras:
self.extras["thumbnail"] = self.thumbnail
dump = self.__dict__.copy()
for f in deprecated:
dump.pop(f)
return dump
def json(self) -> str: def json(self) -> str:
return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True, indent=4) return json.dumps(self.serialize(), default=lambda o: o.__dict__, sort_keys=True, indent=4)

View file

@ -4,7 +4,6 @@ import json
import logging import logging
import os import os
import pathlib import pathlib
import posixpath
import re import re
import socket import socket
import uuid import uuid

View file

@ -64,6 +64,7 @@ class Config:
new_version_available: bool = False new_version_available: bool = False
ytdlp_version: str = YTDLP_VERSION ytdlp_version: str = YTDLP_VERSION
started: int = 0 started: int = 0
ignore_ui: bool = False
presets: list = [ presets: list = [
{"name": "default", "format": "default", "postprocessors": [], "args": {}}, {"name": "default", "format": "default", "postprocessors": [], "args": {}},
{ {
@ -142,6 +143,7 @@ class Config:
"allow_manifestless", "allow_manifestless",
"access_log", "access_log",
"remove_files", "remove_files",
"ignore_ui",
) )
_frontend_vars: tuple = ( _frontend_vars: tuple = (

View file

@ -9,6 +9,9 @@ class Encoder(json.JSONEncoder):
""" """
def default(self, o): def default(self, o):
if isinstance(o, object) and hasattr(o, "serialize"):
return o.serialize()
if isinstance(o, object) and hasattr(o, "__dict__"): if isinstance(o, object) and hasattr(o, "__dict__"):
return o.__dict__ return o.__dict__

View file

@ -101,13 +101,14 @@
<figure class="image is-3by1"> <figure class="image is-3by1">
<span v-if="'finished' === item.status" @click="playVideo(item)" class="play-overlay"> <span v-if="'finished' === item.status" @click="playVideo(item)" class="play-overlay">
<div class="play-icon"></div> <div class="play-icon"></div>
<img :src="config.app.url_host + config.app.url_prefix + 'thumbnail?url=' + encodePath(item.thumbnail)" <img
:alt="item.title" v-if="item.thumbnail" /> :src="config.app.url_host + config.app.url_prefix + 'thumbnail?url=' + encodePath(item.extras.thumbnail)"
:alt="item.title" v-if="item.extras?.thumbnail" />
<img v-else src="/images/placeholder.png" :alt="item.title" /> <img v-else src="/images/placeholder.png" :alt="item.title" />
</span> </span>
<NuxtLink v-else target="_blank" :href="item.url" v-tooltip="`Open: ${item.title} link`"> <NuxtLink v-else target="_blank" :href="item.url" v-tooltip="`Open: ${item.title} link`">
<img :alt="item.title" v-if="item.thumbnail" <img :alt="item.title" v-if="item.extras?.thumbnail"
:src="config.app.url_host + config.app.url_prefix + 'thumbnail?url=' + encodePath(item.thumbnail)" /> :src="config.app.url_host + config.app.url_prefix + 'thumbnail?url=' + encodePath(item.extras.thumbnail)" />
<img v-else src="/images/placeholder.png" :alt="item.title" /> <img v-else src="/images/placeholder.png" :alt="item.title" />
</NuxtLink> </NuxtLink>
</figure> </figure>
@ -233,7 +234,8 @@
<div class="modal-background"></div> <div class="modal-background"></div>
<div class="modal-content"> <div class="modal-content">
<VideoPlayer type="default" :link="video_link" :isMuted="false" autoplay="true" :isControls="true" <VideoPlayer type="default" :link="video_link" :isMuted="false" autoplay="true" :isControls="true"
:title="video_title" class="is-fullwidth" @closeModel="video_link = ''; video_title = ''" /> :title="video_title" :thumbnail="video_thumbnail" :artist="video_artist" class="is-fullwidth"
@closeModel="video_link = ''; video_title = ''; video_thumbnail = ''; video_artist = '';" />
</div> </div>
<button class="modal-close is-large" aria-label="close" @click="video_link = ''"></button> <button class="modal-close is-large" aria-label="close" @click="video_link = ''"></button>
</div> </div>
@ -250,38 +252,51 @@ const config = useConfigStore()
const stateStore = useStateStore() const stateStore = useStateStore()
const socket = useSocketStore() const socket = useSocketStore()
const selectedElms = ref([]); const selectedElms = ref([])
const masterSelectAll = ref(false); const masterSelectAll = ref(false)
const showCompleted = useStorage('showCompleted', true) const showCompleted = useStorage('showCompleted', true)
const hideThumbnail = useStorage('hideThumbnailHistory', false) const hideThumbnail = useStorage('hideThumbnailHistory', false)
const direction = useStorage('sortCompleted', 'desc') const direction = useStorage('sortCompleted', 'desc')
const video_link = ref('') const video_link = ref('')
const video_title = ref('') const video_title = ref('')
const video_thumbnail = ref('')
const video_artist = ref('')
const playVideo = item => { const playVideo = item => {
video_link.value = makeDownload(config, item, 'm3u8'); video_thumbnail.value = '';
video_title.value = item.title; video_artist.value = '';
video_link.value = makeDownload(config, item, 'm3u8')
video_title.value = item.title
if (item.extras?.thumbnail) {
video_thumbnail.value = config.app.url_host + config.app.url_prefix + 'thumbnail?url=' + encodePath(item.extras.thumbnail)
}
if (item.extras?.channel) {
video_artist.value = item.extras.channel
}
if (!video_artist.value && item.extras?.uploader) {
video_artist.value = item.extras.uploader
}
} }
watch(masterSelectAll, (value) => { watch(masterSelectAll, (value) => {
for (const key in stateStore.history) { for (const key in stateStore.history) {
const element = stateStore.history[key]; const element = stateStore.history[key]
if (value) { if (value) {
selectedElms.value.push(element._id); selectedElms.value.push(element._id)
} else { } else {
selectedElms.value = []; selectedElms.value = []
} }
} }
}) })
const sortCompleted = computed(() => { const sortCompleted = computed(() => {
const thisDirection = direction.value; const thisDirection = direction.value
return Object.values(stateStore.history).sort((a, b) => { return Object.values(stateStore.history).sort((a, b) => {
if ('asc' === thisDirection) { if ('asc' === thisDirection) {
return new Date(a.datetime) - new Date(b.datetime); return new Date(a.datetime) - new Date(b.datetime)
} }
return new Date(b.datetime) - new Date(a.datetime); return new Date(b.datetime) - new Date(a.datetime)
}) })
}) })
@ -293,80 +308,80 @@ const showMessage = (item) => {
return false return false
} }
return item.msg.length > 0; return item.msg.length > 0
} }
const hasIncomplete = computed(() => { const hasIncomplete = computed(() => {
if (Object.keys(stateStore.history)?.length < 0) { if (Object.keys(stateStore.history)?.length < 0) {
return false; return false
} }
for (const key in stateStore.history) { for (const key in stateStore.history) {
const element = stateStore.history[key]; const element = stateStore.history[key]
if (element.status !== 'finished') { if (element.status !== 'finished') {
return true; return true
} }
} }
return false; return false
}) })
const hasCompleted = computed(() => { const hasCompleted = computed(() => {
if (Object.keys(stateStore.history)?.length < 0) { if (Object.keys(stateStore.history)?.length < 0) {
return false; return false
} }
for (const key in stateStore.history) { for (const key in stateStore.history) {
const element = stateStore.history[key]; const element = stateStore.history[key]
if (element.status === 'finished') { if (element.status === 'finished') {
return true; return true
} }
} }
return false; return false
}) })
const deleteSelectedItems = () => { const deleteSelectedItems = () => {
if (selectedElms.value.length < 1) { if (selectedElms.value.length < 1) {
toast.error('No items selected.'); toast.error('No items selected.')
return; return
} }
let msg = `Are you sure you want to delete '${selectedElms.value.length}' items?` let msg = `Are you sure you want to delete '${selectedElms.value.length}' items?`
if (true === config.app.remove_files) { if (true === config.app.remove_files) {
msg += '\nThis will delete the files from the server if they exist.'; msg += '\nThis will delete the files from the server if they exist.'
} }
if (false === confirm(msg)) { if (false === confirm(msg)) {
return; return
} }
for (const key in selectedElms.value) { for (const key in selectedElms.value) {
const item = stateStore.history[selectedElms.value[key]]; const item = stateStore.history[selectedElms.value[key]]
if ('finished' === item.status) { if ('finished' === item.status) {
socket.emit('archive_item', item); socket.emit('archive_item', item)
} }
socket.emit('item_delete', { socket.emit('item_delete', {
id: item._id, id: item._id,
remove_file: config.app.remove_files, remove_file: config.app.remove_files,
}); })
} }
} }
const clearCompleted = () => { const clearCompleted = () => {
let msg = 'Are you sure you want to clear all completed downloads?'; let msg = 'Are you sure you want to clear all completed downloads?'
if (false === confirm(msg)) { if (false === confirm(msg)) {
return; return
} }
for (const key in stateStore.history) { for (const key in stateStore.history) {
if ('finished' === ag(stateStore.get('history', key, {}), 'status')) { if ('finished' === ag(stateStore.get('history', key, {}), 'status')) {
socket.emit('item_delete', { id: stateStore.history[key]._id, remove_file: false, }); socket.emit('item_delete', { id: stateStore.history[key]._id, remove_file: false, })
} }
} }
} }
const clearIncomplete = () => { const clearIncomplete = () => {
if (false === confirm('Are you sure you want to clear all in-complete downloads?')) { if (false === confirm('Are you sure you want to clear all in-complete downloads?')) {
return; return
} }
for (const key in stateStore.history) { for (const key in stateStore.history) {
@ -374,40 +389,40 @@ const clearIncomplete = () => {
socket.emit('item_delete', { socket.emit('item_delete', {
id: stateStore.history[key]._id, id: stateStore.history[key]._id,
remove_file: false, remove_file: false,
}); })
} }
} }
} }
const setIcon = item => { const setIcon = item => {
if (item.status === 'finished' && item.is_live) { if (item.status === 'finished' && item.is_live) {
return 'fa-solid fa-globe'; return 'fa-solid fa-globe'
} }
if (item.status === 'finished') { if (item.status === 'finished') {
return 'fa-solid fa-circle-check'; return 'fa-solid fa-circle-check'
} }
if (item.status === 'error') { if (item.status === 'error') {
return 'fa-solid fa-circle-xmark'; return 'fa-solid fa-circle-xmark'
} }
if (item.status === 'canceled') { if (item.status === 'canceled') {
return 'fa-solid fa-eject'; return 'fa-solid fa-eject'
} }
return 'fa-solid fa-circle'; return 'fa-solid fa-circle'
} }
const requeueIncomplete = () => { const requeueIncomplete = () => {
if (false === confirm('Are you sure you want to re-queue all incomplete downloads?')) { if (false === confirm('Are you sure you want to re-queue all incomplete downloads?')) {
return false; return false
} }
for (const key in stateStore.history) { for (const key in stateStore.history) {
const item = stateStore.get('history', key, {}); const item = stateStore.get('history', key, {})
if ('finished' === item.status) { if ('finished' === item.status) {
continue; continue
} }
reQueueItem(item) reQueueItem(item)
} }
@ -417,12 +432,12 @@ const archiveItem = item => {
if (!confirm(`Archive '${item.title ?? item.id ?? item.url ?? '??'}'?`)) { if (!confirm(`Archive '${item.title ?? item.id ?? item.url ?? '??'}'?`)) {
return return
} }
socket.emit('archive_item', item); socket.emit('archive_item', item)
socket.emit('item_delete', { id: item._id, remove_file: false }); socket.emit('item_delete', { id: item._id, remove_file: false })
} }
const removeItem = item => { const removeItem = item => {
const msg = `Remove '${item.title ?? item.id ?? item.url ?? '??'}'?\n this will delete the file from the server.`; const msg = `Remove '${item.title ?? item.id ?? item.url ?? '??'}'?\n this will delete the file from the server.`
if (config.app.remove_files && !confirm(msg)) { if (config.app.remove_files && !confirm(msg)) {
return false return false
} }
@ -430,7 +445,7 @@ const removeItem = item => {
socket.emit('item_delete', { socket.emit('item_delete', {
id: item._id, id: item._id,
remove_file: config.app.remove_files remove_file: config.app.remove_files
}); })
} }
const reQueueItem = item => { const reQueueItem = item => {
@ -442,6 +457,6 @@ const reQueueItem = item => {
ytdlp_config: item.ytdlp_config, ytdlp_config: item.ytdlp_config,
ytdlp_cookies: item.ytdlp_cookies, ytdlp_cookies: item.ytdlp_cookies,
output_template: item.output_template, output_template: item.output_template,
}); })
} }
</script> </script>

View file

@ -50,9 +50,9 @@
</div> </div>
</header> </header>
<div v-if="false === hideThumbnail" class="card-image"> <div v-if="false === hideThumbnail" class="card-image">
<figure class="image is-3by1" v-if="item.thumbnail"> <figure class="image is-3by1" v-if="item.extras?.thumbnail">
<NuxtLink v-tooltip="item.title" :href="item.url" target="_blank"> <NuxtLink v-tooltip="item.title" :href="item.url" target="_blank">
<img :src="config.app.url_host + config.app.url_prefix + 'thumbnail?url=' + encodePath(item.thumbnail)" <img :src="config.app.url_host + config.app.url_prefix + 'thumbnail?url=' + encodePath(item.extras.thumbnail)"
:alt="item.title" /> :alt="item.title" />
</NuxtLink> </NuxtLink>
</figure> </figure>

View file

@ -43,6 +43,14 @@ const props = defineProps({
type: String, type: String,
default: '' default: ''
}, },
thumbnail: {
type: String,
default: ''
},
artist: {
type: String,
default: ''
},
isControls: { isControls: {
type: Boolean, type: Boolean,
default: true default: true
@ -85,10 +93,24 @@ onUnmounted(() => {
if (props.title) { if (props.title) {
window.document.title = 'YTPTube' window.document.title = 'YTPTube'
} }
}) })
const prepareVideoPlayer = () => { const prepareVideoPlayer = () => {
let mediaMetadata = {
title: props.title,
};
if (props.thumbnail) {
mediaMetadata['artwork'] = [
{ src: props.thumbnail, sizes: '1920x1080', type: 'image/jpeg' },
]
}
if (props.artist) {
mediaMetadata['artist'] = props.artist
}
console.log(mediaMetadata)
player = new Plyr(video.value, { player = new Plyr(video.value, {
debug: false, debug: false,
clickToPlay: true, clickToPlay: true,
@ -106,9 +128,7 @@ const prepareVideoPlayer = () => {
key: 'plyr' key: 'plyr'
}, },
title: props.title, title: props.title,
mediaMetadata: { mediaMetadata: mediaMetadata,
title: props.title
},
captions: { captions: {
update: true, update: true,
} }