2021-02-12 16:23:19 +01:00
|
|
|
import { remove } from 'fs-extra'
|
2019-04-17 10:07:00 +02:00
|
|
|
import { join } from 'path'
|
2019-12-17 09:55:33 +01:00
|
|
|
import {
|
|
|
|
AfterDestroy,
|
|
|
|
AllowNull,
|
2021-02-16 08:50:40 +01:00
|
|
|
BeforeCreate,
|
|
|
|
BeforeUpdate,
|
2019-12-17 09:55:33 +01:00
|
|
|
BelongsTo,
|
|
|
|
Column,
|
|
|
|
CreatedAt,
|
|
|
|
DataType,
|
|
|
|
Default,
|
|
|
|
ForeignKey,
|
|
|
|
Model,
|
|
|
|
Table,
|
|
|
|
UpdatedAt
|
|
|
|
} from 'sequelize-typescript'
|
2021-02-16 08:50:40 +01:00
|
|
|
import { afterCommitIfTransaction } from '@server/helpers/database-utils'
|
2021-02-18 11:28:00 +01:00
|
|
|
import { MThumbnail, MThumbnailVideo, MVideo } from '@server/types/models'
|
2021-12-16 18:04:16 +01:00
|
|
|
import { AttributesOnly } from '@shared/typescript-utils'
|
2021-02-12 16:23:19 +01:00
|
|
|
import { ThumbnailType } from '../../../shared/models/videos/thumbnail.type'
|
2019-04-17 10:07:00 +02:00
|
|
|
import { logger } from '../../helpers/logger'
|
|
|
|
import { CONFIG } from '../../initializers/config'
|
2021-02-12 16:23:19 +01:00
|
|
|
import { CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, STATIC_PATHS, WEBSERVER } from '../../initializers/constants'
|
2019-04-17 10:07:00 +02:00
|
|
|
import { VideoModel } from './video'
|
|
|
|
import { VideoPlaylistModel } from './video-playlist'
|
|
|
|
|
|
|
|
@Table({
|
|
|
|
tableName: 'thumbnail',
|
|
|
|
indexes: [
|
|
|
|
{
|
|
|
|
fields: [ 'videoId' ]
|
|
|
|
},
|
|
|
|
{
|
|
|
|
fields: [ 'videoPlaylistId' ],
|
|
|
|
unique: true
|
2021-02-12 16:23:19 +01:00
|
|
|
},
|
|
|
|
{
|
|
|
|
fields: [ 'filename', 'type' ],
|
|
|
|
unique: true
|
2019-04-17 10:07:00 +02:00
|
|
|
}
|
|
|
|
]
|
|
|
|
})
|
2021-05-12 14:09:04 +02:00
|
|
|
export class ThumbnailModel extends Model<Partial<AttributesOnly<ThumbnailModel>>> {
|
2019-04-17 10:07:00 +02:00
|
|
|
|
|
|
|
@AllowNull(false)
|
|
|
|
@Column
|
|
|
|
filename: string
|
|
|
|
|
|
|
|
@AllowNull(true)
|
|
|
|
@Default(null)
|
|
|
|
@Column
|
|
|
|
height: number
|
|
|
|
|
|
|
|
@AllowNull(true)
|
|
|
|
@Default(null)
|
|
|
|
@Column
|
|
|
|
width: number
|
|
|
|
|
|
|
|
@AllowNull(false)
|
|
|
|
@Column
|
|
|
|
type: ThumbnailType
|
|
|
|
|
|
|
|
@AllowNull(true)
|
2019-12-17 09:55:33 +01:00
|
|
|
@Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
|
2019-04-24 10:28:57 +02:00
|
|
|
fileUrl: string
|
2019-04-17 10:07:00 +02:00
|
|
|
|
2019-08-01 16:54:24 +02:00
|
|
|
@AllowNull(true)
|
|
|
|
@Column
|
|
|
|
automaticallyGenerated: boolean
|
|
|
|
|
2019-04-17 10:07:00 +02:00
|
|
|
@ForeignKey(() => VideoModel)
|
|
|
|
@Column
|
|
|
|
videoId: number
|
|
|
|
|
|
|
|
@BelongsTo(() => VideoModel, {
|
|
|
|
foreignKey: {
|
|
|
|
allowNull: true
|
|
|
|
},
|
|
|
|
onDelete: 'CASCADE'
|
|
|
|
})
|
|
|
|
Video: VideoModel
|
|
|
|
|
|
|
|
@ForeignKey(() => VideoPlaylistModel)
|
|
|
|
@Column
|
|
|
|
videoPlaylistId: number
|
|
|
|
|
|
|
|
@BelongsTo(() => VideoPlaylistModel, {
|
|
|
|
foreignKey: {
|
|
|
|
allowNull: true
|
|
|
|
},
|
|
|
|
onDelete: 'CASCADE'
|
|
|
|
})
|
|
|
|
VideoPlaylist: VideoPlaylistModel
|
|
|
|
|
|
|
|
@CreatedAt
|
|
|
|
createdAt: Date
|
|
|
|
|
|
|
|
@UpdatedAt
|
|
|
|
updatedAt: Date
|
|
|
|
|
2021-02-16 08:50:40 +01:00
|
|
|
// If this thumbnail replaced existing one, track the old name
|
|
|
|
previousThumbnailFilename: string
|
|
|
|
|
2020-01-31 16:56:52 +01:00
|
|
|
private static readonly types: { [ id in ThumbnailType ]: { label: string, directory: string, staticPath: string } } = {
|
2019-04-23 09:50:57 +02:00
|
|
|
[ThumbnailType.MINIATURE]: {
|
|
|
|
label: 'miniature',
|
2019-04-17 10:07:00 +02:00
|
|
|
directory: CONFIG.STORAGE.THUMBNAILS_DIR,
|
|
|
|
staticPath: STATIC_PATHS.THUMBNAILS
|
|
|
|
},
|
|
|
|
[ThumbnailType.PREVIEW]: {
|
|
|
|
label: 'preview',
|
|
|
|
directory: CONFIG.STORAGE.PREVIEWS_DIR,
|
2019-08-09 11:32:40 +02:00
|
|
|
staticPath: LAZY_STATIC_PATHS.PREVIEWS
|
2019-04-17 10:07:00 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-02-16 08:50:40 +01:00
|
|
|
@BeforeCreate
|
|
|
|
@BeforeUpdate
|
|
|
|
static removeOldFile (instance: ThumbnailModel, options) {
|
|
|
|
return afterCommitIfTransaction(options.transaction, () => instance.removePreviousFilenameIfNeeded())
|
|
|
|
}
|
|
|
|
|
2019-04-17 10:07:00 +02:00
|
|
|
@AfterDestroy
|
2019-08-01 16:54:24 +02:00
|
|
|
static removeFiles (instance: ThumbnailModel) {
|
2019-04-17 10:07:00 +02:00
|
|
|
logger.info('Removing %s file %s.', ThumbnailModel.types[instance.type].label, instance.filename)
|
|
|
|
|
|
|
|
// Don't block the transaction
|
|
|
|
instance.removeThumbnail()
|
2022-07-18 11:55:13 +02:00
|
|
|
.catch(err => logger.error('Cannot remove thumbnail file %s.', instance.filename, { err }))
|
2019-04-17 10:07:00 +02:00
|
|
|
}
|
|
|
|
|
2021-02-16 08:50:40 +01:00
|
|
|
static loadByFilename (filename: string, thumbnailType: ThumbnailType): Promise<MThumbnail> {
|
|
|
|
const query = {
|
|
|
|
where: {
|
|
|
|
filename,
|
|
|
|
type: thumbnailType
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return ThumbnailModel.findOne(query)
|
|
|
|
}
|
|
|
|
|
|
|
|
static loadWithVideoByFilename (filename: string, thumbnailType: ThumbnailType): Promise<MThumbnailVideo> {
|
2019-08-09 15:04:36 +02:00
|
|
|
const query = {
|
|
|
|
where: {
|
2021-02-12 16:23:19 +01:00
|
|
|
filename,
|
|
|
|
type: thumbnailType
|
|
|
|
},
|
|
|
|
include: [
|
|
|
|
{
|
|
|
|
model: VideoModel.unscoped(),
|
|
|
|
required: true
|
|
|
|
}
|
|
|
|
]
|
2019-08-09 15:04:36 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return ThumbnailModel.findOne(query)
|
|
|
|
}
|
|
|
|
|
2021-02-16 09:42:22 +01:00
|
|
|
static buildPath (type: ThumbnailType, filename: string) {
|
|
|
|
const directory = ThumbnailModel.types[type].directory
|
|
|
|
|
|
|
|
return join(directory, filename)
|
|
|
|
}
|
|
|
|
|
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 16:00:05 +02:00
|
|
|
getOriginFileUrl (video: MVideo) {
|
2020-01-30 11:53:38 +01:00
|
|
|
const staticPath = ThumbnailModel.types[this.type].staticPath + this.filename
|
2019-04-17 10:07:00 +02:00
|
|
|
|
2020-01-30 11:53:38 +01:00
|
|
|
if (video.isOwned()) return WEBSERVER.URL + staticPath
|
|
|
|
|
2021-02-18 10:15:11 +01:00
|
|
|
return this.fileUrl
|
2019-04-17 10:07:00 +02:00
|
|
|
}
|
|
|
|
|
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 16:00:05 +02:00
|
|
|
getLocalStaticPath () {
|
|
|
|
return ThumbnailModel.types[this.type].staticPath + this.filename
|
|
|
|
}
|
|
|
|
|
2019-05-16 16:55:34 +02:00
|
|
|
getPath () {
|
2021-02-16 09:42:22 +01:00
|
|
|
return ThumbnailModel.buildPath(this.type, this.filename)
|
2019-05-16 16:55:34 +02:00
|
|
|
}
|
2019-04-17 10:07:00 +02:00
|
|
|
|
2021-02-16 08:50:40 +01:00
|
|
|
getPreviousPath () {
|
2021-02-16 09:42:22 +01:00
|
|
|
return ThumbnailModel.buildPath(this.type, this.previousThumbnailFilename)
|
2021-02-16 08:50:40 +01:00
|
|
|
}
|
|
|
|
|
2019-05-16 16:55:34 +02:00
|
|
|
removeThumbnail () {
|
|
|
|
return remove(this.getPath())
|
2019-04-17 10:07:00 +02:00
|
|
|
}
|
2021-02-16 08:50:40 +01:00
|
|
|
|
|
|
|
removePreviousFilenameIfNeeded () {
|
|
|
|
if (!this.previousThumbnailFilename) return
|
|
|
|
|
|
|
|
const previousPath = this.getPreviousPath()
|
|
|
|
remove(previousPath)
|
|
|
|
.catch(err => logger.error('Cannot remove previous thumbnail file %s.', previousPath, { err }))
|
|
|
|
|
|
|
|
this.previousThumbnailFilename = undefined
|
|
|
|
}
|
2019-04-17 10:07:00 +02:00
|
|
|
}
|