alchemy-media 0.7.6 → 0.9.0-alpha

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.9.0-alpha.1 (2024-02-15)
+
+* Upgrade to Alchemy v1.4.0
+
+## 0.8.0 (2023-10-17)
+
+* Upgrade `@11ways/exiv2` to v0.7.0
+
 ## 0.7.6 (2023-10-05)
 
 * Let `Media#imageUrl()` helper handle image instructions that start with a slash

package/bootstrap.js

@@ -1,150 +1,7 @@
-var path      = alchemy.use('path'),
-    Veronica  = alchemy.use('veronica'),
-    fs        = alchemy.use('fs');
-
-// Define the default options
-var options = {
-
-	// The path to use in the url
-	url: '/media/image',
-
-	// Where to store the files
-	path: path.resolve(PATH_ROOT, 'files'),
-
-	// Which hash function to use
-	hash: 'sha1',
-
-	// Enable webp
-	webp: true,
-
-	// Temporary map for intermediate file changes
-	scratch: path.resolve(PATH_TEMP, 'scratch'),
-
-	// The cache map for resized images & thumbnails
-	cache: path.resolve(PATH_TEMP, 'imagecache'),
-
-	// Path to fontawesome pro
-	fontawesome_pro: null,
-};
-
-// Inject the user-overridden options
-alchemy.plugins.media = Object.assign(options, alchemy.plugins.media);
-
-// Find the paths to these binaries
-options.convert = alchemy.findPathToBinarySync('convert', options.convert);
-options.exiv2 = alchemy.findPathToBinarySync('exiv2', options.exiv2);
-options.cwebp = alchemy.findPathToBinarySync('cwebp', options.cwebp);
-
-// Make sure these folders exist
-alchemy.createDir(options.scratch);
-alchemy.createDir(options.cache);
-
-// Create routes
-Router.add({
-	name             : 'MediaFile#serveStatic',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : /\/media\/static\/(.*)*/,
-});
-
-Router.add({
-	name             : 'MediaFile#image',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : options.url + '/{id}',
-});
-
-// The prefix is added at the end of the route so it does not
-// change the user's active_prefix
-Router.add({
-	name             : 'MediaFile#data',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/data/{prefix}/{id}',
-});
-
-Router.add({
-	name             : 'MediaFile#info',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/info',
-});
-
-Router.add({
-	name             : 'MediaFile#recordsource',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/recordsource',
-	permission       : 'media.recordsource',
-});
-
-// Allow dummy extensions
-Router.add({
-	name             : 'Media#fileextension',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/file/{id}.{extension}',
-	handler          : 'MediaFile#file'
-});
-
-// Allow direct file downloads
-Router.add({
-	name             : 'MediaFile#file',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/file/{id}',
-});
-
-Router.add({
-	name             : 'MediaFile#downloadFile',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/download/{id}',
-});
-
-Router.add({
-	name             : 'MediaFile#thumbnail',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/thumbnail/{id}',
-});
-
-Router.add({
-	name             : 'MediaFile#placeholder',
-	methods          : ['get'],
-	can_be_postponed : false,
-	paths            : '/media/placeholder',
-});
-
-Router.add({
-	name             : 'MediaFile#upload',
-	methods          : ['post'],
-	can_be_postponed : false,
-	paths            : '/media/upload',
-});
-
-Router.add({
-	name             : 'MediaFile#uploadsingle',
-	methods          : ['post'],
-	can_be_postponed : false,
-	paths            : '/media/uploadsingle',
-});
-
-var profiles = alchemy.shared('Media.profiles');
-
-// Create a new veronica instance
-options.veronica = new Veronica({
-	cwebp: options.cwebp,
-	temp: options.scratch,
-	cache: options.cache
-});
+const profiles = alchemy.shared('Media.profiles');
 
 alchemy.hawkejs.addRawHtml(`<script>document.cookie = 'mediaResolution=' + encodeURIComponent(JSON.stringify({width:Math.max(screen.availWidth||0, window.outerWidth||0) || 1024,height:Math.max(screen.availHeight||0, window.outerHeight||0) || 768,dpr:window.devicePixelRatio}))</script>`);
 
-if (options.fontawesome_pro) {
-	alchemy.exposeStatic('fontawesome_pro', options.fontawesome_pro);
-}
-
 /**
  * Register a profile under the given name
  *
@@ -155,11 +12,11 @@ if (options.fontawesome_pro) {
  * @param    {String}   name
  * @param    {Object}   settings
  */
-options.addProfile = function addProfile(name, settings) {
+Plugin.addProfile = function addProfile(name, settings) {
 	profiles[name] = settings;
 };
 
 // Add the thumbnail profile
-options.addProfile('thumbnail', {width: 100, height: 100});
-options.addProfile('pickerThumb', {width: 250, height: 250});
-options.addProfile('chimera-gallery', {width: 400, height: 400});
+Plugin.addProfile('thumbnail', {width: 100, height: 100});
+Plugin.addProfile('pickerThumb', {width: 250, height: 250});
+Plugin.addProfile('chimera-gallery', {width: 400, height: 400});

package/config/routes.js

@@ -0,0 +1,92 @@
+let url_prefix = '/media/image';
+
+// Create routes
+Plugin.addRoute({
+	name             : 'MediaFile#serveStatic',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : /\/media\/static\/(.*)*/,
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#image',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : url_prefix + '/{id}',
+});
+
+// The prefix is added at the end of the route so it does not
+// change the user's active_prefix
+Plugin.addRoute({
+	name             : 'MediaFile#data',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/data/{prefix}/{id}',
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#info',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/info',
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#recordsource',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/recordsource',
+	permission       : 'media.recordsource',
+});
+
+// Allow dummy extensions
+Plugin.addRoute({
+	name             : 'Media#fileextension',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/file/{id}.{extension}',
+	handler          : 'MediaFile#file'
+});
+
+// Allow direct file downloads
+Plugin.addRoute({
+	name             : 'MediaFile#file',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/file/{id}',
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#downloadFile',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/download/{id}',
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#thumbnail',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/thumbnail/{id}',
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#placeholder',
+	methods          : ['get'],
+	can_be_postponed : false,
+	paths            : '/media/placeholder',
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#upload',
+	methods          : ['post'],
+	can_be_postponed : false,
+	paths            : '/media/upload',
+});
+
+Plugin.addRoute({
+	name             : 'MediaFile#uploadsingle',
+	methods          : ['post'],
+	can_be_postponed : false,
+	paths            : '/media/uploadsingle',
+});

package/config/settings.js

@@ -0,0 +1,111 @@
+const libpath = require('path');
+
+// system.plugins.media
+const MEDIA_PLUGIN_GROUP = Plugin.getSettingsGroup();
+
+MEDIA_PLUGIN_GROUP.addSetting('translatable', {
+	type        : 'boolean',
+	default     : false,
+	description : 'Should file title & alt fields be translatable?',
+});
+
+MEDIA_PLUGIN_GROUP.addSetting('file_hash_algorithm', {
+	type        : 'string',
+	default     : 'sha1',
+	description : 'The default file hash method',
+});
+
+MEDIA_PLUGIN_GROUP.addSetting('enable_webp', {
+	type        : 'boolean',
+	default     : true,
+	description : 'Serve webp images when possible',
+});
+
+MEDIA_PLUGIN_GROUP.addSetting('file_storage_path', {
+	type        : 'string',
+	default     : libpath.resolve(PATH_ROOT, 'files'),
+	description : 'Where to store uploaded files',
+});
+
+MEDIA_PLUGIN_GROUP.addSetting('scratch_path', {
+	type        : 'string',
+	default     : libpath.resolve(PATH_TEMP, 'scratch'),
+	description : 'Temporary map for intermediate file changes',
+	action      : (value, value_instance) => {
+
+		if (value) {
+			alchemy.createDir(value);
+		}
+
+		createVeronicaInstance();
+	},
+});
+
+MEDIA_PLUGIN_GROUP.addSetting('cache_path', {
+	type        : 'string',
+	default     : libpath.resolve(PATH_TEMP, 'imagecache'),
+	description : 'The cache map for resized images & thumbnails',
+	action      : (value, value_instance) => {
+
+		if (value) {
+			alchemy.createDir(value);
+		}
+
+		createVeronicaInstance();
+	},
+});
+
+MEDIA_PLUGIN_GROUP.addSetting('fontawesome_pro', {
+	type        : 'string',
+	default     : null,
+	description : 'The URL to fontawesome pro',
+	action      : (value, value_instance) => {
+		alchemy.exposeStatic('fontawesome_pro', value);
+	},
+});
+
+MEDIA_PLUGIN_GROUP.addSetting('max_page_width', {
+	type        : 'integer',
+	default     : null,
+	description : 'Limit the maximum allowed page width, used for image resizing',
+});
+
+const BINARIES = MEDIA_PLUGIN_GROUP.createGroup('binaries');
+
+BINARIES.addSetting('convert', {
+	type        : 'string',
+	default     : alchemy.findPathToBinarySync('convert'),
+	description : 'The path to the `convert` binary',
+});
+
+BINARIES.addSetting('exiv2', {
+	type        : 'string',
+	default     : alchemy.findPathToBinarySync('exiv2'),
+	description : 'The path to the `exiv2` binary',
+});
+
+BINARIES.addSetting('cwebp', {
+	type        : 'string',
+	default     : alchemy.findPathToBinarySync('cwebp'),
+	description : 'The path to the `cwebp` binary',
+	action      : createVeronicaInstance,
+});
+
+/**
+ * Recreate the Veronica instance
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.9.0
+ * @version  0.9.0
+ */
+function createVeronicaInstance() {
+
+	let Veronica = alchemy.use('veronica');
+	const media = alchemy.settings.plugins.media;
+
+	alchemy.plugins.media.veronica = new Veronica({
+		cwebp  : media.binaries.cwebp,
+		temp   : media.scratch_path,
+		cache  : media.cache_path,
+	});
+}

package/lib/media_types/image_media_type.js

@@ -19,10 +19,6 @@ var exiv2    = alchemy.use('@11ways/exiv2'),
  */
 const ImageMedia = Function.inherits('Alchemy.MediaType', 'ImageMediaType');
 
-ImageMedia.setProperty('exivPath', alchemy.plugins.media.exiv2);
-ImageMedia.setProperty('hashType', alchemy.plugins.media.hash);
-ImageMedia.setProperty('veronica', alchemy.plugins.media.veronica);
-
 ImageMedia.setProperty('typeMap', {
 	images: {
 		regex: /^image\//,
@@ -30,6 +26,45 @@ ImageMedia.setProperty('typeMap', {
 	}
 });
 
+/**
+ * Add a property getter to the exiv binary
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.9.0
+ * @version  0.9.0
+ *
+ * @type     {string}
+ */
+ImageMedia.setProperty(function exiv_path() {
+	return alchemy.settings.plugins.media.binaries.exiv2;
+});
+
+/**
+ * Add a property getter to the cwebp binary
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.9.0
+ * @version  0.9.0
+ *
+ * @type     {string}
+ */
+ImageMedia.setProperty(function cwebp_path() {
+	return alchemy.settings.plugins.media.binaries.cwebp;
+});
+
+/**
+ * Get the hash algorithm
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.9.0
+ * @version  0.9.0
+ *
+ * @type     {string}
+ */
+ImageMedia.setProperty(function hashType() {
+	return alchemy.settings.plugins.media.file_hash_algorithm;
+});
+
 /**
  * Generate a thumbnail of this type
  *
@@ -163,8 +198,8 @@ function getResizedDimension(query, type, resolution, dpr) {
 		}
 
 		// It's called "max_page_width", but height can also be checked against this
-		if (base_size > alchemy.plugins.media.max_page_width) {
-			base_size = alchemy.plugins.media.max_page_width;
+		if (base_size > alchemy.settings.plugins.media.max_page_width) {
+			base_size = alchemy.settings.plugins.media.max_page_width;
 		}
 
 		size = (base_size * percentage) / 100;
@@ -307,7 +342,9 @@ ImageMedia.setMethod(function serve(conduit, record, options) {
 
 	if (resizeOptions) {
 
-		if (this.supportsWebp(conduit) && alchemy.plugins.media.cwebp) {
+		const cwebp_path = this.cwebp_path;
+
+		if (this.supportsWebp(conduit) && cwebp_path) {
 			resizeOptions.type = 'webp';
 		}
 
@@ -440,11 +477,13 @@ ImageMedia.setMethod(function getSize(conduit, filePath, options, callback) {
 
 	tempPath = PATH_TEMP + '/' + alchemy.ObjectId() + '.webp';
 
-	if (!alchemy.plugins.media.cwebp) {
+	const cwebp_path = this.cwebp_path;
+
+	if (!cwebp_path) {
 		return callback(new Error('Unable to get size: cwebp not found'));
 	}
 
-	child.exec(alchemy.plugins.media.cwebp + ' ' + [resizeOptions, '-q 80', filePath, '-o', tempPath].join(' '), function(err, out) {
+	child.exec(cwebp_path + ' ' + [resizeOptions, '-q 80', filePath, '-o', tempPath].join(' '), function(err, out) {
 
 		if (err) {
 			return callback(err);
@@ -560,7 +599,7 @@ ImageMedia.setMethod(function getMetadata(filePath, base, info, extra, callback)
 				return getInfo();
 			}
 
-			child.execFile(that.exivPath, ['rm', tempFile], function afterStrip(err) {
+			child.execFile(that.exiv_path, ['rm', tempFile], function afterStrip(err) {
 
 				if (err) {
 					log.error('Error stripping metadata ', {err: err});
@@ -600,11 +639,11 @@ ImageMedia.setMethod(function getMetadata(filePath, base, info, extra, callback)
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  0.4.2
+ * @version  0.9.0
  */
 ImageMedia.setMethod(function resize(source, target, width, height, callback) {
 
-	var convertBin = alchemy.plugins.media.convert;
+	let convertBin = alchemy.settings.plugins.media.convert;
 
 	child.execFile(convertBin, [source, '-resize', width + 'x' + height, target], function(err) {
 		callback(err);
@@ -616,7 +655,7 @@ ImageMedia.setMethod(function resize(source, target, width, height, callback) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  0.2.0
+ * @version  0.9.0
  *
  * @param    {String}   filePath   The path of the file to inspect
  * @param    {Function} callback
@@ -624,7 +663,7 @@ ImageMedia.setMethod(function resize(source, target, width, height, callback) {
 ImageMedia.setMethod(function getImageInfo(filePath, callback) {
 
 	// Run exiv on the given file
-	child.execFile(this.exivPath, ['-pt', filePath], function afterStrip(err, out) {
+	child.execFile(this.exiv_path, ['-pt', filePath], function afterStrip(err, out) {
 
 		var output,
 		    lines,

package/lib/media_types/media_type.js

@@ -22,8 +22,6 @@ MediaType = Function.inherits('Alchemy.Base', function MediaType(options) {
 
 	typeName = this.constructor.name.replace(/MediaType$/, '');
 
-	this.veronica = alchemy.plugins.media.veronica;
-
 	this.title = typeName || 'Media';
 	this.typeName = this.title.underscore();
 	this.options = options || {};
@@ -55,25 +53,38 @@ MediaType.makeAbstractClass();
  */
 MediaType.startNewGroup();
 
+/**
+ * Get the veronica instance
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.9.0
+ * @version  0.9.0
+ *
+ * @type     {Veronica}
+ */
+MediaType.setProperty(function veronica() {
+	return alchemy.plugins.media.veronica;
+});
+
 /**
  * See if we can use webp
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  0.4.0
+ * @version  0.9.0
  *
  * @param   {Conduit}   conduit
  */
 MediaType.setMethod(function supportsWebp(conduit) {
 
-	var result   = false,
+	let result   = false,
 	    has_webp_support,
 	    uaString,
 	    agent,
 	    is;
 
 	// If webp has been disabled, return false
-	if (!alchemy.plugins.media.webp) {
+	if (!alchemy.settings.plugins.media.enable_webp) {
 		return false;
 	}
 

package/model/media_file_model.js

@@ -53,12 +53,12 @@ MediaFile.constitute(function addFields() {
 	this.addField('extra', 'Object');
 
 	this.addField('title', 'String', {
-		translatable : alchemy.plugins.media.translatable,
+		translatable : alchemy.settings.plugins.media.translatable,
 		description  : 'The title of the file (will be used in the title attribute)',
 	});
 
 	this.addField('alt', 'String', {
-		translatable : alchemy.plugins.media.translatable,
+		translatable : alchemy.settings.plugins.media.translatable,
 		description  : 'The alternative information of the file (will be used in the alt attribute)',
 	});
 

package/model/media_raw_model.js

@@ -41,10 +41,34 @@ MediaRaw.constitute(function addFields() {
 	this.addField('extra', 'Object');
 });
 
-MediaRaw.setProperty('basePath', alchemy.plugins.media.path);
-MediaRaw.setProperty('hash', alchemy.plugins.media.hash);
 MediaRaw.setProperty('types', alchemy.getClassGroup('media_type'));
 
+/**
+ * Get the hash algorithm
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.9.0
+ * @version  0.9.0
+ *
+ * @type     {string}
+ */
+MediaRaw.setProperty(function hashType() {
+	return alchemy.settings.plugins.media.file_hash_algorithm;
+});
+
+/**
+ * Get the base path
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.9.0
+ * @version  0.9.0
+ *
+ * @type     {string}
+ */
+MediaRaw.setProperty(function basePath() {
+	return alchemy.settings.plugins.media.file_storage_path;
+});
+
 /**
  * Path to this file
  *
@@ -239,13 +263,11 @@ MediaRaw.setMethod(function addFile(file, options, callback) {
 
 	alchemy.getFileInfo(file, {hash: this.hashType}, function gotFileInfo(err, info) {
 
-		var type;
-
 		if (err) {
 			return callback(err);
 		}
 
-		type = that.MediaType.determineType(info.mimetype, options);
+		let type = that.MediaType.determineType(info.mimetype, options);
 
 		type.normalize(file, info, function afterNormalize(err, rawPath, rawInfo, rawExtra, extra) {
 

package/package.json

@@ -1,21 +1,21 @@
 {
 	"name": "alchemy-media",
 	"description": "The media plugin for Alchemy",
-	"version": "0.7.6",
+	"version": "0.9.0-alpha",
 	"repository": {
 		"type" : "git",
 		"url"  : "https://github.com/11ways/alchemy-media.git"
 	},
 	"dependencies": {
-		"@11ways/exiv2" : "~0.6.4",
+		"@11ways/exiv2" : "~0.7.0",
 		"gm"            : "~1.23.1",
 		"veronica"      : "~0.2.2"
 	},
 	"peerDependencies": {
-		"alchemymvc" : ">=1.3.0"
+		"alchemymvc" : ">=1.4.0||>=1.4.0-alpha"
 	},
 	"license": "MIT",
 	"engines": {
-		"node" : ">=14.0.0"
+		"node" : ">=16.20.1"
 	}
 }