Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | /**
* External dependencies
*/
import { store as blockEditorStore } from '@wordpress/block-editor';
import { usePrevious } from '@wordpress/compose';
import { store as coreStore } from '@wordpress/core-data';
import { useSelect, useDispatch } from '@wordpress/data';
import { store as editorStore } from '@wordpress/editor';
import { useEffect, useState, useCallback } from '@wordpress/element';
import { __ } from '@wordpress/i18n';
import debugFactory from 'debug';
/**
* Internal dependencies
*/
import { getVideoPressUrl } from '../../../lib/url';
import { uploadTrackForGuid, isAutogeneratedChapterFile } from '../../../lib/video-tracks';
import { WPComV2VideopressPostMetaEndpointBodyProps } from '../../../types';
import { snakeToCamel } from '../../../utils/map-object-keys-to-camel-case';
import extractVideoChapters from '../../../utils/video-chapters/extract-video-chapters';
import generateChaptersFile from '../../../utils/video-chapters/generate-chapters-file';
import validateChapters from '../../../utils/video-chapters/validate-chapters';
import { VideoBlockAttributes, VideoBlockSetAttributesProps } from '../../blocks/video/types';
import useVideoData from '../use-video-data';
import { VideoDataProps } from '../use-video-data/types';
import useMediaDataUpdate from '../use-video-data-update';
import { useVideoPosterData } from '../use-video-poster-data';
/**
* Types
*/
import type { UseSyncMedia, ArrangeTracksAttributesProps } from './types';
import type { UploadTrackDataProps } from '../../../lib/video-tracks/types';
const debug = debugFactory( 'videopress:video:use-sync-media' );
/*
* Fields list to keep in sync with block attributes.
*/
const videoFieldsToUpdate = [
'post_id',
'title',
'description',
'privacy_setting',
'rating',
'allow_download',
'display_embed',
'is_private',
'duration',
];
/*
* Map object from video field name to block attribute name.
* Only register those fields that have a different attribute name.
*/
const mapFieldsToAttributes = {
privacy_setting: 'privacySetting',
allow_download: 'allowDownload',
display_embed: 'displayEmbed',
is_private: 'isPrivate',
post_id: 'id',
};
/*
* Fields list that should invalidate the resolution of the embed (player)
* when some of them change.
*
* Keep in mind some field changes
* are handled inidrectly by the VideoPress video URL,
* for instance, `loop`, `autoplay`, `color`, etc...
*/
const invalidateEmbedResolutionFields = [
'title',
'privacy_setting',
'is_private',
'allow_download',
'display_embed',
];
/**
* Re-arrange the tracks to match the block attribute format.
* Also, check if the tracks is out of sync with the media item.
*
* @param {VideoDataProps} videoData - Video data, provided by server.
* @param {VideoBlockAttributes} attributes - Block attributes.
* @return {VideoBlockAttributes} Video block attributes.
*/
function arrangeTracksAttributes(
videoData: VideoDataProps,
attributes: VideoBlockAttributes
): ArrangeTracksAttributesProps {
if ( ! videoData?.tracks ) {
return [ [], false ];
}
const tracks = [];
let tracksOufOfSync = false;
// Checks if every video track is in sync with the block
// attributes, to add tracks to the block attributes if needed
Object.keys( videoData.tracks ).forEach( kind => {
for ( const srcLang in videoData.tracks[ kind ] ) {
const track = videoData.tracks[ kind ][ srcLang ];
const trackExistsInBlock = attributes.tracks.find( t => {
return (
t.kind === kind && t.srcLang === srcLang && t.src === track.src && t.label === track.label
);
} );
if ( ! trackExistsInBlock ) {
debug( 'Track %o is out of sync. Set tracks attr', track.src );
tracksOufOfSync = true;
}
tracks.push( {
src: track.src,
kind,
srcLang,
label: track.label,
} );
}
} );
/*
* Checks if every block attributes track is in sync with the media
* item, to remove tracks from the block attributes if needed
*/
attributes.tracks.forEach( blockTrack => {
const trackInMedia = videoData.tracks[ blockTrack.kind ]?.[ blockTrack.srcLang ];
const trackExistsInMedia =
trackInMedia &&
trackInMedia.src === blockTrack.src &&
trackInMedia.label === blockTrack.label;
if ( ! trackExistsInMedia ) {
debug( 'Block track %o is out of sync and will be removed', blockTrack.src );
tracksOufOfSync = true;
}
} );
return [ tracks, tracksOufOfSync ];
}
/**
* React hook to keep the data in-sync
* between the media item and the block attributes.
*
* @param {object} attributes - Block attributes.
* @param {Function} setAttributes - Block attributes setter.
* @return {UseSyncMedia} Hook API object.
*/
export function useSyncMedia(
attributes: VideoBlockAttributes,
setAttributes: VideoBlockSetAttributesProps
): UseSyncMedia {
const { id, guid, isPrivate } = attributes;
const { videoData, isRequestingVideoData, videoBelongToSite } = useVideoData( {
id,
guid,
skipRatingControl: true,
maybeIsPrivate: isPrivate,
} );
const [ isOverwriteChapterAllowed, setIsOverwriteChapterAllowed ] = useState( false );
const isSaving = useSelect( select => select( editorStore ).isSavingPost(), [] );
const wasSaving = usePrevious( isSaving );
const invalidateResolution = useDispatch( coreStore ).invalidateResolution;
const { __unstableMarkNextChangeAsNotPersistent } = useDispatch( blockEditorStore );
const [ initialState, setState ] = useState< VideoDataProps >( {} );
const [ error, setError ] = useState( null );
const updateInitialState = useCallback( ( data: VideoDataProps ) => {
setState( current => ( { ...current, ...data } ) );
}, [] );
/*
* Media data => Block attributes (update)
*
* Populate block attributes with the media data,
* provided by the VideoPress API (useVideoData hook),
* when the block is mounted.
*/
useEffect( () => {
if ( isRequestingVideoData ) {
return;
}
// Bail early if the video data is not available.
if (
! videoData ||
Object.keys( videoData ).filter( key => videoFieldsToUpdate.includes( key ) ).length === 0
) {
return;
}
const attributesToUpdate: VideoBlockAttributes = {};
// Build an object with video data to use for the initial state.
const initialVideoData = videoFieldsToUpdate.reduce( ( acc, key ) => {
if ( typeof videoData[ key ] === 'undefined' ) {
return acc;
}
let videoDataValue = videoData[ key ];
// Cast privacy_setting to number to match the block attribute type.
if ( 'privacy_setting' === key ) {
videoDataValue = Number( videoDataValue );
}
acc[ key ] = videoDataValue;
const attrName = mapFieldsToAttributes[ key ] || snakeToCamel( key );
if ( videoDataValue !== attributes[ attrName ] ) {
debug(
'%o is out of sync. Updating %o attr from %o to %o ',
key,
attrName,
attributes[ attrName ],
videoDataValue
);
attributesToUpdate[ attrName ] = videoDataValue;
}
return acc;
}, {} );
updateInitialState( initialVideoData );
debug( 'Initial state: ', initialVideoData );
if ( ! Object.keys( initialVideoData ).length ) {
return;
}
// Sync video tracks if needed.
const [ tracks, tracksOufOfSync ] = arrangeTracksAttributes( videoData, attributes );
if ( tracksOufOfSync ) {
attributesToUpdate.tracks = tracks;
}
if ( ! Object.keys( attributesToUpdate ).length ) {
return;
}
debug( 'Updating attributes: ', attributesToUpdate );
__unstableMarkNextChangeAsNotPersistent();
setAttributes( attributesToUpdate );
}, [ videoData, isRequestingVideoData ] );
const chapterFileUrl = attributes.tracks.filter(
track => track.kind === 'chapters' && track.srcLang === 'en'
)[ 0 ]?.src;
useEffect( () => {
( async () => {
// Check if the (default) chapter file has been autogenerated.
if ( ! chapterFileUrl ) {
debug( 'Allow overwrite chapter: File does not exist' );
setIsOverwriteChapterAllowed( true );
} else {
const chapterUrl = 'https://videos.files.wordpress.com/' + guid + '/' + chapterFileUrl;
const isAutogenerated = await isAutogeneratedChapterFile( chapterUrl, { guid, isPrivate } );
debug(
'Chapter %o detected. Overwritable: %o',
chapterFileUrl,
isAutogenerated ? 'yes' : 'no'
);
setIsOverwriteChapterAllowed( isAutogenerated );
}
} )();
}, [ chapterFileUrl ] );
const updateMediaHandler = useMediaDataUpdate( id );
const postHasBeenJustSaved = !! ( wasSaving && ! isSaving );
/*
* Video frame poster: Block attributes => Frame poster generation
*
* Store and compare the block attributes
* in order to detect changes on them.
*/
const { isGeneratingPoster } = useVideoPosterData( attributes );
/*
* Block attributes => Media data (sync)
*
* Compare the current attribute values of the block
* with the initial state,
* and sync the media data if it detects changes on it
* (via the VideoPress API) when the post saves.
*/
useEffect( () => {
if ( ! postHasBeenJustSaved ) {
return;
}
debug( '%o Post has been just saved. Syncing...', attributes?.guid );
if ( ! attributes?.id ) {
debug( '%o No media ID found. Impossible to sync. Bail early', attributes?.guid );
return;
}
/*
* Filter the attributes that have changed their values,
* based on the initial state.
*/
const dataToUpdate: WPComV2VideopressPostMetaEndpointBodyProps = videoFieldsToUpdate.reduce(
( acc, key ) => {
const attrName = mapFieldsToAttributes[ key ] || key;
const stateValue = initialState[ key ];
const attrValue = attributes[ attrName ];
if ( initialState[ key ] !== attributes[ attrName ] ) {
debug( 'Field to sync %o: %o => %o: %o', key, stateValue, attrName, attrValue );
acc[ key ] = attributes[ attrName ];
}
return acc;
},
{}
);
// When nothing to update, bail out early.
if ( ! Object.keys( dataToUpdate ).length ) {
return debug( 'No data to sync. Bail early' );
}
debug( 'Syncing data: ', dataToUpdate );
// Sync the block attributes data with the video data
updateMediaHandler( dataToUpdate )
.then( () => {
// Update local state with fresh video data.
updateInitialState( dataToUpdate );
/*
* Update isPrivate attribute:
* `is_private` is a read-only metadata field.
* The VideoPress API provides its value
* and depends on the `privacy_setting`
* and `private_enabled_for_site` fields.
*/
if ( dataToUpdate.privacy_setting ) {
const isPrivateVideo =
dataToUpdate.privacy_setting !== 2
? dataToUpdate.privacy_setting === 1
: videoData.private_enabled_for_site;
debug( 'Updating isPrivate attribute: %o', isPrivateVideo );
setAttributes( { isPrivate: isPrivateVideo } );
}
// | Video Chapters feature |
const chapters = extractVideoChapters( dataToUpdate?.description );
if (
isOverwriteChapterAllowed &&
attributes?.guid &&
dataToUpdate?.description?.length &&
validateChapters( chapters )
) {
debug( 'Autogenerated chapter detected. Processing...' );
const track: UploadTrackDataProps = {
label: __( 'English (auto-generated)', 'jetpack-videopress-pkg' ),
srcLang: 'en',
kind: 'chapters',
tmpFile: generateChaptersFile( dataToUpdate.description ),
};
debug( 'Autogenerated track: %o', track );
uploadTrackForGuid( track, attributes.guid ).then( src => {
if ( typeof src !== 'string' ) {
debug( 'auto-generated chapter track upload failed: %o', src );
return;
}
const autoGeneratedTrackIndex = attributes.tracks.findIndex(
t => t.kind === 'chapters' && t.srcLang === 'en'
);
const uploadedTrack = {
...track,
src,
};
const tracks = [ ...attributes.tracks ];
if ( autoGeneratedTrackIndex > -1 ) {
debug( 'Updating %o auto-generated track', uploadedTrack.src );
tracks[ autoGeneratedTrackIndex ] = uploadedTrack;
} else {
debug( 'Adding auto-generated %o track', uploadedTrack.src );
tracks.push( uploadedTrack );
}
// Update block track attribute
setAttributes( { tracks } );
const videoPressUrl = getVideoPressUrl( attributes.guid, attributes );
invalidateResolution( 'getEmbedPreview', [ videoPressUrl ] );
} );
} else {
const shouldInvalidateResolution = Object.keys( dataToUpdate ).filter( key =>
invalidateEmbedResolutionFields.includes( key )
);
if ( shouldInvalidateResolution?.length ) {
debug( 'Invalidate resolution because of %o', shouldInvalidateResolution.join( ', ' ) );
const videoPressUrl = getVideoPressUrl( attributes.guid, attributes );
invalidateResolution( 'getEmbedPreview', [ videoPressUrl ] );
}
}
} )
.catch( ( updateMediaError: Error ) => {
debug( '%o Error while syncing data: %o', attributes?.guid, updateMediaError );
setError( updateMediaError );
} );
}, [
postHasBeenJustSaved,
updateMediaHandler,
updateInitialState,
attributes,
initialState,
invalidateResolution,
videoFieldsToUpdate,
] );
return {
forceInitialState: updateInitialState,
videoData,
isRequestingVideoData,
videoBelongToSite,
error,
isOverwriteChapterAllowed,
isGeneratingPoster,
};
}
|