diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 07:56:49 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 07:56:49 +0000 |
commit | a415c29efee45520ae252d2aa28f1083a521cd7b (patch) | |
tree | f4ade4b6668ecc0765de7e1424f7c1427ad433ff /wp-includes/js/dist/media-utils.js | |
parent | Initial commit. (diff) | |
download | wordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.tar.xz wordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.zip |
Adding upstream version 6.4.3+dfsg1.upstream/6.4.3+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'wp-includes/js/dist/media-utils.js')
-rw-r--r-- | wp-includes/js/dist/media-utils.js | 700 |
1 files changed, 700 insertions, 0 deletions
diff --git a/wp-includes/js/dist/media-utils.js b/wp-includes/js/dist/media-utils.js new file mode 100644 index 0000000..7272265 --- /dev/null +++ b/wp-includes/js/dist/media-utils.js @@ -0,0 +1,700 @@ +/******/ (function() { // webpackBootstrap +/******/ "use strict"; +/******/ // The require scope +/******/ var __webpack_require__ = {}; +/******/ +/************************************************************************/ +/******/ /* webpack/runtime/compat get default export */ +/******/ !function() { +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = function(module) { +/******/ var getter = module && module.__esModule ? +/******/ function() { return module['default']; } : +/******/ function() { return module; }; +/******/ __webpack_require__.d(getter, { a: getter }); +/******/ return getter; +/******/ }; +/******/ }(); +/******/ +/******/ /* webpack/runtime/define property getters */ +/******/ !function() { +/******/ // define getter functions for harmony exports +/******/ __webpack_require__.d = function(exports, definition) { +/******/ for(var key in definition) { +/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { +/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); +/******/ } +/******/ } +/******/ }; +/******/ }(); +/******/ +/******/ /* webpack/runtime/hasOwnProperty shorthand */ +/******/ !function() { +/******/ __webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); } +/******/ }(); +/******/ +/******/ /* webpack/runtime/make namespace object */ +/******/ !function() { +/******/ // define __esModule on exports +/******/ __webpack_require__.r = function(exports) { +/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { +/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); +/******/ } +/******/ Object.defineProperty(exports, '__esModule', { value: true }); +/******/ }; +/******/ }(); +/******/ +/************************************************************************/ +var __webpack_exports__ = {}; +// ESM COMPAT FLAG +__webpack_require__.r(__webpack_exports__); + +// EXPORTS +__webpack_require__.d(__webpack_exports__, { + MediaUpload: function() { return /* reexport */ media_upload; }, + uploadMedia: function() { return /* reexport */ uploadMedia; } +}); + +;// CONCATENATED MODULE: external ["wp","element"] +var external_wp_element_namespaceObject = window["wp"]["element"]; +;// CONCATENATED MODULE: external ["wp","i18n"] +var external_wp_i18n_namespaceObject = window["wp"]["i18n"]; +;// CONCATENATED MODULE: ./node_modules/@wordpress/media-utils/build-module/components/media-upload/index.js +/** + * WordPress dependencies + */ + + +const DEFAULT_EMPTY_GALLERY = []; + +/** + * Prepares the Featured Image toolbars and frames. + * + * @return {window.wp.media.view.MediaFrame.Select} The default media workflow. + */ +const getFeaturedImageMediaFrame = () => { + const { + wp + } = window; + return wp.media.view.MediaFrame.Select.extend({ + /** + * Enables the Set Featured Image Button. + * + * @param {Object} toolbar toolbar for featured image state + * @return {void} + */ + featuredImageToolbar(toolbar) { + this.createSelectToolbar(toolbar, { + text: wp.media.view.l10n.setFeaturedImage, + state: this.options.state + }); + }, + /** + * Handle the edit state requirements of selected media item. + * + * @return {void} + */ + editState() { + const selection = this.state('featured-image').get('selection'); + const view = new wp.media.view.EditImage({ + model: selection.single(), + controller: this + }).render(); + + // Set the view to the EditImage frame using the selected image. + this.content.set(view); + + // After bringing in the frame, load the actual editor via an ajax call. + view.loadEditor(); + }, + /** + * Create the default states. + * + * @return {void} + */ + createStates: function createStates() { + this.on('toolbar:create:featured-image', this.featuredImageToolbar, this); + this.on('content:render:edit-image', this.editState, this); + this.states.add([new wp.media.controller.FeaturedImage(), new wp.media.controller.EditImage({ + model: this.options.editImage + })]); + } + }); +}; + +/** + * Prepares the Gallery toolbars and frames. + * + * @return {window.wp.media.view.MediaFrame.Post} The default media workflow. + */ +const getGalleryDetailsMediaFrame = () => { + const { + wp + } = window; + /** + * Custom gallery details frame. + * + * @see https://github.com/xwp/wp-core-media-widgets/blob/905edbccfc2a623b73a93dac803c5335519d7837/wp-admin/js/widgets/media-gallery-widget.js + * @class GalleryDetailsMediaFrame + * @class + */ + return wp.media.view.MediaFrame.Post.extend({ + /** + * Set up gallery toolbar. + * + * @return {void} + */ + galleryToolbar() { + const editing = this.state().get('editing'); + this.toolbar.set(new wp.media.view.Toolbar({ + controller: this, + items: { + insert: { + style: 'primary', + text: editing ? wp.media.view.l10n.updateGallery : wp.media.view.l10n.insertGallery, + priority: 80, + requires: { + library: true + }, + /** + * @fires wp.media.controller.State#update + */ + click() { + const controller = this.controller, + state = controller.state(); + controller.close(); + state.trigger('update', state.get('library')); + + // Restore and reset the default state. + controller.setState(controller.options.state); + controller.reset(); + } + } + } + })); + }, + /** + * Handle the edit state requirements of selected media item. + * + * @return {void} + */ + editState() { + const selection = this.state('gallery').get('selection'); + const view = new wp.media.view.EditImage({ + model: selection.single(), + controller: this + }).render(); + + // Set the view to the EditImage frame using the selected image. + this.content.set(view); + + // After bringing in the frame, load the actual editor via an ajax call. + view.loadEditor(); + }, + /** + * Create the default states. + * + * @return {void} + */ + createStates: function createStates() { + this.on('toolbar:create:main-gallery', this.galleryToolbar, this); + this.on('content:render:edit-image', this.editState, this); + this.states.add([new wp.media.controller.Library({ + id: 'gallery', + title: wp.media.view.l10n.createGalleryTitle, + priority: 40, + toolbar: 'main-gallery', + filterable: 'uploaded', + multiple: 'add', + editable: false, + library: wp.media.query({ + type: 'image', + ...this.options.library + }) + }), new wp.media.controller.EditImage({ + model: this.options.editImage + }), new wp.media.controller.GalleryEdit({ + library: this.options.selection, + editing: this.options.editing, + menu: 'gallery', + displaySettings: false, + multiple: true + }), new wp.media.controller.GalleryAdd()]); + } + }); +}; + +// The media library image object contains numerous attributes +// we only need this set to display the image in the library. +const slimImageObject = img => { + const attrSet = ['sizes', 'mime', 'type', 'subtype', 'id', 'url', 'alt', 'link', 'caption']; + return attrSet.reduce((result, key) => { + if (img?.hasOwnProperty(key)) { + result[key] = img[key]; + } + return result; + }, {}); +}; +const getAttachmentsCollection = ids => { + const { + wp + } = window; + return wp.media.query({ + order: 'ASC', + orderby: 'post__in', + post__in: ids, + posts_per_page: -1, + query: true, + type: 'image' + }); +}; +class MediaUpload extends external_wp_element_namespaceObject.Component { + constructor({ + allowedTypes, + gallery = false, + unstableFeaturedImageFlow = false, + modalClass, + multiple = false, + title = (0,external_wp_i18n_namespaceObject.__)('Select or Upload Media') + }) { + super(...arguments); + this.openModal = this.openModal.bind(this); + this.onOpen = this.onOpen.bind(this); + this.onSelect = this.onSelect.bind(this); + this.onUpdate = this.onUpdate.bind(this); + this.onClose = this.onClose.bind(this); + const { + wp + } = window; + if (gallery) { + this.buildAndSetGalleryFrame(); + } else { + const frameConfig = { + title, + multiple + }; + if (!!allowedTypes) { + frameConfig.library = { + type: allowedTypes + }; + } + this.frame = wp.media(frameConfig); + } + if (modalClass) { + this.frame.$el.addClass(modalClass); + } + if (unstableFeaturedImageFlow) { + this.buildAndSetFeatureImageFrame(); + } + this.initializeListeners(); + } + initializeListeners() { + // When an image is selected in the media frame... + this.frame.on('select', this.onSelect); + this.frame.on('update', this.onUpdate); + this.frame.on('open', this.onOpen); + this.frame.on('close', this.onClose); + } + + /** + * Sets the Gallery frame and initializes listeners. + * + * @return {void} + */ + buildAndSetGalleryFrame() { + const { + addToGallery = false, + allowedTypes, + multiple = false, + value = DEFAULT_EMPTY_GALLERY + } = this.props; + + // If the value did not changed there is no need to rebuild the frame, + // we can continue to use the existing one. + if (value === this.lastGalleryValue) { + return; + } + const { + wp + } = window; + this.lastGalleryValue = value; + + // If a frame already existed remove it. + if (this.frame) { + this.frame.remove(); + } + let currentState; + if (addToGallery) { + currentState = 'gallery-library'; + } else { + currentState = value && value.length ? 'gallery-edit' : 'gallery'; + } + if (!this.GalleryDetailsMediaFrame) { + this.GalleryDetailsMediaFrame = getGalleryDetailsMediaFrame(); + } + const attachments = getAttachmentsCollection(value); + const selection = new wp.media.model.Selection(attachments.models, { + props: attachments.props.toJSON(), + multiple + }); + this.frame = new this.GalleryDetailsMediaFrame({ + mimeType: allowedTypes, + state: currentState, + multiple, + selection, + editing: value && value.length ? true : false + }); + wp.media.frame = this.frame; + this.initializeListeners(); + } + + /** + * Initializes the Media Library requirements for the featured image flow. + * + * @return {void} + */ + buildAndSetFeatureImageFrame() { + const { + wp + } = window; + const featuredImageFrame = getFeaturedImageMediaFrame(); + const attachments = getAttachmentsCollection(this.props.value); + const selection = new wp.media.model.Selection(attachments.models, { + props: attachments.props.toJSON() + }); + this.frame = new featuredImageFrame({ + mimeType: this.props.allowedTypes, + state: 'featured-image', + multiple: this.props.multiple, + selection, + editing: this.props.value ? true : false + }); + wp.media.frame = this.frame; + } + componentWillUnmount() { + this.frame.remove(); + } + onUpdate(selections) { + const { + onSelect, + multiple = false + } = this.props; + const state = this.frame.state(); + const selectedImages = selections || state.get('selection'); + if (!selectedImages || !selectedImages.models.length) { + return; + } + if (multiple) { + onSelect(selectedImages.models.map(model => slimImageObject(model.toJSON()))); + } else { + onSelect(slimImageObject(selectedImages.models[0].toJSON())); + } + } + onSelect() { + const { + onSelect, + multiple = false + } = this.props; + // Get media attachment details from the frame state. + const attachment = this.frame.state().get('selection').toJSON(); + onSelect(multiple ? attachment : attachment[0]); + } + onOpen() { + const { + wp + } = window; + const { + value + } = this.props; + this.updateCollection(); + + //Handle active tab in media model on model open. + if (this.props.mode) { + this.frame.content.mode(this.props.mode); + } + + // Handle both this.props.value being either (number[]) multiple ids + // (for galleries) or a (number) singular id (e.g. image block). + const hasMedia = Array.isArray(value) ? !!value?.length : !!value; + if (!hasMedia) { + return; + } + const isGallery = this.props.gallery; + const selection = this.frame.state().get('selection'); + const valueArray = Array.isArray(value) ? value : [value]; + if (!isGallery) { + valueArray.forEach(id => { + selection.add(wp.media.attachment(id)); + }); + } + + // Load the images so they are available in the media modal. + const attachments = getAttachmentsCollection(valueArray); + + // Once attachments are loaded, set the current selection. + attachments.more().done(function () { + if (isGallery && attachments?.models?.length) { + selection.add(attachments.models); + } + }); + } + onClose() { + const { + onClose + } = this.props; + if (onClose) { + onClose(); + } + } + updateCollection() { + const frameContent = this.frame.content.get(); + if (frameContent && frameContent.collection) { + const collection = frameContent.collection; + + // Clean all attachments we have in memory. + collection.toArray().forEach(model => model.trigger('destroy', model)); + + // Reset has more flag, if library had small amount of items all items may have been loaded before. + collection.mirroring._hasMore = true; + + // Request items. + collection.more(); + } + } + openModal() { + if (this.props.gallery) { + this.buildAndSetGalleryFrame(); + } + this.frame.open(); + } + render() { + return this.props.render({ + open: this.openModal + }); + } +} +/* harmony default export */ var media_upload = (MediaUpload); + +;// CONCATENATED MODULE: ./node_modules/@wordpress/media-utils/build-module/components/index.js + + +;// CONCATENATED MODULE: external ["wp","apiFetch"] +var external_wp_apiFetch_namespaceObject = window["wp"]["apiFetch"]; +var external_wp_apiFetch_default = /*#__PURE__*/__webpack_require__.n(external_wp_apiFetch_namespaceObject); +;// CONCATENATED MODULE: external ["wp","blob"] +var external_wp_blob_namespaceObject = window["wp"]["blob"]; +;// CONCATENATED MODULE: ./node_modules/@wordpress/media-utils/build-module/utils/upload-media.js +/** + * WordPress dependencies + */ + + + +const noop = () => {}; + +/** + * Browsers may use unexpected mime types, and they differ from browser to browser. + * This function computes a flexible array of mime types from the mime type structured provided by the server. + * Converts { jpg|jpeg|jpe: "image/jpeg" } into [ "image/jpeg", "image/jpg", "image/jpeg", "image/jpe" ] + * The computation of this array instead of directly using the object, + * solves the problem in chrome where mp3 files have audio/mp3 as mime type instead of audio/mpeg. + * https://bugs.chromium.org/p/chromium/issues/detail?id=227004 + * + * @param {?Object} wpMimeTypesObject Mime type object received from the server. + * Extensions are keys separated by '|' and values are mime types associated with an extension. + * + * @return {?Array} An array of mime types or the parameter passed if it was "falsy". + */ +function getMimeTypesArray(wpMimeTypesObject) { + if (!wpMimeTypesObject) { + return wpMimeTypesObject; + } + return Object.entries(wpMimeTypesObject).map(([extensionsString, mime]) => { + const [type] = mime.split('/'); + const extensions = extensionsString.split('|'); + return [mime, ...extensions.map(extension => `${type}/${extension}`)]; + }).flat(); +} + +/** + * Media Upload is used by audio, image, gallery, video, and file blocks to + * handle uploading a media file when a file upload button is activated. + * + * TODO: future enhancement to add an upload indicator. + * + * @param {Object} $0 Parameters object passed to the function. + * @param {?Array} $0.allowedTypes Array with the types of media that can be uploaded, if unset all types are allowed. + * @param {?Object} $0.additionalData Additional data to include in the request. + * @param {Array} $0.filesList List of files. + * @param {?number} $0.maxUploadFileSize Maximum upload size in bytes allowed for the site. + * @param {Function} $0.onError Function called when an error happens. + * @param {Function} $0.onFileChange Function called each time a file or a temporary representation of the file is available. + * @param {?Object} $0.wpAllowedMimeTypes List of allowed mime types and file extensions. + */ +async function uploadMedia({ + allowedTypes, + additionalData = {}, + filesList, + maxUploadFileSize, + onError = noop, + onFileChange, + wpAllowedMimeTypes = null +}) { + // Cast filesList to array. + const files = [...filesList]; + const filesSet = []; + const setAndUpdateFiles = (idx, value) => { + (0,external_wp_blob_namespaceObject.revokeBlobURL)(filesSet[idx]?.url); + filesSet[idx] = value; + onFileChange(filesSet.filter(Boolean)); + }; + + // Allowed type specified by consumer. + const isAllowedType = fileType => { + if (!allowedTypes) { + return true; + } + return allowedTypes.some(allowedType => { + // If a complete mimetype is specified verify if it matches exactly the mime type of the file. + if (allowedType.includes('/')) { + return allowedType === fileType; + } + // Otherwise a general mime type is used and we should verify if the file mimetype starts with it. + return fileType.startsWith(`${allowedType}/`); + }); + }; + + // Allowed types for the current WP_User. + const allowedMimeTypesForUser = getMimeTypesArray(wpAllowedMimeTypes); + const isAllowedMimeTypeForUser = fileType => { + return allowedMimeTypesForUser.includes(fileType); + }; + const validFiles = []; + for (const mediaFile of files) { + // Verify if user is allowed to upload this mime type. + // Defer to the server when type not detected. + if (allowedMimeTypesForUser && mediaFile.type && !isAllowedMimeTypeForUser(mediaFile.type)) { + onError({ + code: 'MIME_TYPE_NOT_ALLOWED_FOR_USER', + message: (0,external_wp_i18n_namespaceObject.sprintf)( + // translators: %s: file name. + (0,external_wp_i18n_namespaceObject.__)('%s: Sorry, you are not allowed to upload this file type.'), mediaFile.name), + file: mediaFile + }); + continue; + } + + // Check if the block supports this mime type. + // Defer to the server when type not detected. + if (mediaFile.type && !isAllowedType(mediaFile.type)) { + onError({ + code: 'MIME_TYPE_NOT_SUPPORTED', + message: (0,external_wp_i18n_namespaceObject.sprintf)( + // translators: %s: file name. + (0,external_wp_i18n_namespaceObject.__)('%s: Sorry, this file type is not supported here.'), mediaFile.name), + file: mediaFile + }); + continue; + } + + // Verify if file is greater than the maximum file upload size allowed for the site. + if (maxUploadFileSize && mediaFile.size > maxUploadFileSize) { + onError({ + code: 'SIZE_ABOVE_LIMIT', + message: (0,external_wp_i18n_namespaceObject.sprintf)( + // translators: %s: file name. + (0,external_wp_i18n_namespaceObject.__)('%s: This file exceeds the maximum upload size for this site.'), mediaFile.name), + file: mediaFile + }); + continue; + } + + // Don't allow empty files to be uploaded. + if (mediaFile.size <= 0) { + onError({ + code: 'EMPTY_FILE', + message: (0,external_wp_i18n_namespaceObject.sprintf)( + // translators: %s: file name. + (0,external_wp_i18n_namespaceObject.__)('%s: This file is empty.'), mediaFile.name), + file: mediaFile + }); + continue; + } + validFiles.push(mediaFile); + + // Set temporary URL to create placeholder media file, this is replaced + // with final file from media gallery when upload is `done` below. + filesSet.push({ + url: (0,external_wp_blob_namespaceObject.createBlobURL)(mediaFile) + }); + onFileChange(filesSet); + } + for (let idx = 0; idx < validFiles.length; ++idx) { + const mediaFile = validFiles[idx]; + try { + var _savedMedia$caption$r; + const savedMedia = await createMediaFromFile(mediaFile, additionalData); + // eslint-disable-next-line camelcase + const { + alt_text, + source_url, + ...savedMediaProps + } = savedMedia; + const mediaObject = { + ...savedMediaProps, + alt: savedMedia.alt_text, + caption: (_savedMedia$caption$r = savedMedia.caption?.raw) !== null && _savedMedia$caption$r !== void 0 ? _savedMedia$caption$r : '', + title: savedMedia.title.raw, + url: savedMedia.source_url + }; + setAndUpdateFiles(idx, mediaObject); + } catch (error) { + // Reset to empty on failure. + setAndUpdateFiles(idx, null); + let message; + if (error.message) { + message = error.message; + } else { + message = (0,external_wp_i18n_namespaceObject.sprintf)( + // translators: %s: file name + (0,external_wp_i18n_namespaceObject.__)('Error while uploading file %s to the media library.'), mediaFile.name); + } + onError({ + code: 'GENERAL', + message, + file: mediaFile + }); + } + } +} + +/** + * @param {File} file Media File to Save. + * @param {?Object} additionalData Additional data to include in the request. + * + * @return {Promise} Media Object Promise. + */ +function createMediaFromFile(file, additionalData) { + // Create upload payload. + const data = new window.FormData(); + data.append('file', file, file.name || file.type.replace('/', '.')); + if (additionalData) { + Object.entries(additionalData).forEach(([key, value]) => data.append(key, value)); + } + return external_wp_apiFetch_default()({ + path: '/wp/v2/media', + body: data, + method: 'POST' + }); +} + +;// CONCATENATED MODULE: ./node_modules/@wordpress/media-utils/build-module/utils/index.js + + +;// CONCATENATED MODULE: ./node_modules/@wordpress/media-utils/build-module/index.js + + + +(window.wp = window.wp || {}).mediaUtils = __webpack_exports__; +/******/ })() +;
\ No newline at end of file |