Merge lp:~edb/quam-plures/three_image_hooks into lp:quam-plures

[EdB]

This adds 3 hooks for working with images, but does not currently include any plugin that uses them. 2 came from that other app and seem useful for a watermarking plugin. The third I wanted so I could automatically resize an image after saving is successful.

'AfterFileUpload' => 'Called before an uploaded file gets saved on server.',
'AfterFileSave' => 'Called after an uploaded file gets saved on server.',
'BeforeThumbCreate' => 'This gets called before an image thumbnail gets created.',

[Yabs (yabs)]

I'll try and get chance over the next couple of days to download and test this, but from a quick skim of the code it looks like it should work.

¥

[Yabs (yabs)]

Ok, seems to work well enough, not sure I like the image options but that's just a personal choice thing and I rarely, if ever, use the cores image stuff so it's not even remotely a deal killer ;)

¥

review: Approve

=== modified file 'qp_inc/files/model/_file.class.php'
--- qp_inc/files/model/_file.class.php	2010-08-17 10:18:27 +0000
+++ qp_inc/files/model/_file.class.php	2010-12-17 16:57:56 +0000
@@ -247,6 +247,69 @@
 
 
 	/**
+	 * Create the file/folder on disk, if it does not exist yet.
+	 *
+	 * Also sets file permissions.
+	 * Also inserts meta data into DB (if file/folder was successfully created).
+	 *
+	 * @param string type ('dir'|'file')
+	 * @param string optional permissions (octal format), otherwise the default from {@link $Settings} gets used
+	 * @return boolean true if file/folder was created, false on failure
+	 */
+	function create( $type = 'file', $chmod = NULL )
+	{
+		if( $type == 'dir' )
+		{ // Create an empty directory:
+			$success = @mkdir( $this->_adfp_full_path );
+			$this->_is_dir = true; // used by chmod
+		}
+		else
+		{ // Create an empty file:
+			$success = touch( $this->_adfp_full_path );
+			$this->_is_dir = false; // used by chmod
+		}
+		$this->chmod( $chmod ); // uses $Settings for NULL
+
+		if( $success )
+		{	// The file/folder has been successfully created:
+
+			// Initializes file properties (type, size, perms...)
+			$this->load_properties();
+
+			// If there was meta data for this file in the DB:
+			// (maybe the file had existed before?)
+			// Let's recycle it! :
+			if( ! $this->load_meta() )
+			{ // No meta data could be loaded, let's make sure localization info gets recorded:
+				$this->set( 'root_type', $this->_FileRoot->type );
+				$this->set( 'root_ID', $this->_FileRoot->in_type_ID );
+				$this->set( 'path', $this->_rdfp_rel_path );
+			}
+
+			// Record to DB:
+			$this->dbsave();
+		}
+
+		return $success;
+	}
+
+
+	/**
+	 * Does the File/folder exist on disk?
+	 *
+	 * @return boolean true, if the file or dir exists; false if not
+	 */
+	function exists()
+	{
+		if( ! isset($this->_exists) )
+		{
+			$this->_exists = file_exists( $this->_adfp_full_path );
+		}
+		return $this->_exists;
+	}
+
+
+	/**
 	 * Attempt to load meta data.
 	 *
 	 * Will attempt only once and cache the result.
@@ -302,54 +365,6 @@
 
 
 	/**
-	 * Create the file/folder on disk, if it does not exist yet.
-	 *
-	 * Also sets file permissions.
-	 * Also inserts meta data into DB (if file/folder was successfully created).
-	 *
-	 * @param string type ('dir'|'file')
-	 * @param string optional permissions (octal format), otherwise the default from {@link $Settings} gets used
-	 * @return boolean true if file/folder was created, false on failure
-	 */
-	function create( $type = 'file', $chmod = NULL )
-	{
-		if( $type == 'dir' )
-		{ // Create an empty directory:
-			$success = @mkdir( $this->_adfp_full_path );
-			$this->_is_dir = true; // used by chmod
-		}
-		else
-		{ // Create an empty file:
-			$success = touch( $this->_adfp_full_path );
-			$this->_is_dir = false; // used by chmod
-		}
-		$this->chmod( $chmod ); // uses $Settings for NULL
-
-		if( $success )
-		{	// The file/folder has been successfully created:
-
-			// Initializes file properties (type, size, perms...)
-			$this->load_properties();
-
-			// If there was meta data for this file in the DB:
-			// (maybe the file had existed before?)
-			// Let's recycle it! :
-			if( ! $this->load_meta() )
-			{ // No meta data could be loaded, let's make sure localization info gets recorded:
-				$this->set( 'root_type', $this->_FileRoot->type );
-				$this->set( 'root_ID', $this->_FileRoot->in_type_ID );
-				$this->set( 'path', $this->_rdfp_rel_path );
-			}
-
-			// Record to DB:
-			$this->dbsave();
-		}
-
-		return $success;
-	}
-
-
-	/**
 	 * Initializes or refreshes file properties (type, size, perms...)
 	 */
 	function load_properties()
@@ -374,21 +389,6 @@
 
 
 	/**
-	 * Does the File/folder exist on disk?
-	 *
-	 * @return boolean true, if the file or dir exists; false if not
-	 */
-	function exists()
-	{
-		if( ! isset($this->_exists) )
-		{
-			$this->_exists = file_exists( $this->_adfp_full_path );
-		}
-		return $this->_exists;
-	}
-
-
-	/**
 	 * Is the File a directory?
 	 *
 	 * @return boolean true if the object is a directory, false if not
@@ -1789,10 +1789,20 @@
 	 * @param resource
 	 * @param string size name
 	 * @param string mimetype of thumbnail
-	 * @param string short error code
+	 * @param integer JPEG image quality
 	 */
 	function save_thumb_to_cache( $thumb_imh, $size_name, $thumb_mimetype, $thumb_quality = 90 )
 	{
+		global $Plugins;
+		
+		$Plugins->trigger_event( 'BeforeThumbCreate', array(
+			  'imh' => & $thumb_imh,
+			  'size' => & $size_name,
+			  'mimetype' => & $thumb_mimetype,
+			  'quality' => & $thumb_quality,
+			  'File' => & $this,
+		  ) );
+
 		$af_thumb_path = $this->get_af_thumb_path( $size_name, $thumb_mimetype, true );
 		if( $af_thumb_path[0] != '!' )
 		{	// We obtained a path for the thumbnail to be saved:

=== modified file 'qp_inc/files/upload.ctrl.php'
--- qp_inc/files/upload.ctrl.php	2010-08-13 16:13:00 +0000
+++ qp_inc/files/upload.ctrl.php	2010-12-17 16:57:56 +0000
@@ -56,7 +56,6 @@
 // Check permission:
 $current_User->check_perm( 'files', 'add', true );
 
-
 $AdminUI->set_path( 'files', 'upload' );
 
 // Params that may need to be passed through:
@@ -99,8 +98,8 @@
 	}
 }
 
-// I've no idea why I had this in my v247 package. I had a comment "fix the 
-// fucked up path ... maybe" but I've no idea what fucked up path needed 
+// EdB: I've no idea why I had this in my v247 package. I had a comment "fix
+// the fucked up path ... maybe" but I've no idea what fucked up path needed
 // fixing. If a path is missing a "/" one day this is probably it ;)
 if( $path == '/' ) {
 	$path = '';
@@ -175,7 +174,6 @@
 	}
 }
 
-
 // If there were errors, display them and exit (especially in case there's no valid FileRoot ($fm_FileRoot)):
 // TODO: dh> this prevents users from uploading if _any_ blog media directory is not writable.
 //           See http://forums.b2evolution.net/viewtopic.php?p=49001#49001
@@ -193,19 +191,14 @@
 	exit(0);
 }
 
-
 $Debuglog->add( 'FM root: '.var_export( $fm_FileRoot, true ), 'files' );
 $Debuglog->add( 'FM _ads_list_path: '.var_export( $ads_list_path, true ), 'files' );
 
-
 if( empty($ads_list_path) )
 { // We have no Root / list path, there was an error. Unset any action.
 	$action = '';
 }
 
-
-
-
 // Check permissions:
 if( ! $Settings->get('upload_enabled') )
 { // Upload is globally disabled
@@ -217,7 +210,6 @@
 	$Messages->add( T_('You have no permission to add/upload files.'), 'error' );
 }
 
-
 // If there were errors, display them and exit (especially in case there's no valid FileRoot ($fm_FileRoot)):
 if( $Messages->count('error') )
 {
@@ -228,7 +220,6 @@
 	exit(0);
 }
 
-
 // Quick mode means "just upload and leave mode when successful"
 param( 'upload_quickmode', 'integer', 0 );
 
@@ -361,6 +352,19 @@
 			continue;
 		}
 
+		// Trigger plugin event
+		if( $Plugins->trigger_event_first_false( 'AfterFileUpload', array(
+				  'File' => & $newFile,
+				  'name' => & $_FILES['uploadfile']['name'][$lKey],
+				  'type' => & $_FILES['uploadfile']['type'][$lKey],
+				  'tmp_name' => & $_FILES['uploadfile']['tmp_name'][$lKey],
+				  'size' => & $_FILES['uploadfile']['size'][$lKey],
+			  ) ) )
+		{
+			// Plugin returned 'false'. Abort file upload
+			continue;
+		}
+
 		// Attempt to move the uploaded file to the requested target location:
 		if( ! @move_uploaded_file( $_FILES['uploadfile']['tmp_name'][$lKey], $newFile->get_full_path() ) )
 		{
@@ -423,24 +427,26 @@
 		// get three links for img/link code or one link for files into any post
 		if( $mode == 'upload' )
 		{
-			// TODO: Add plugin hook to allow generating JS insert code(s)
+			// @todo (legacy): Add plugin hook to allow generating JS insert code(s)
 			if( $newFile->is_image() )
 			{
-				// Gets image tag and stip out table and caption
-				$img_tag = format_to_output( $newFile->get_tag( '', NULL, '', '', 'original', '', 'leftmargin' ), 'formvalue' );
-				// style="width:40%;float:left;" could be class="uploaded_image" ??
 				$success_msg .= '<br />';
 				$success_msg .= '<fieldset class="uploaded_image"><legend>'.T_('Add this Image to your Post').'</legend><ul><li>';
+				// image tag floated left
+				$img_tag = format_to_output( $newFile->get_tag( '<span class="imgwrap floatleft center">', '<br /><span class="image_legend">', '</span>', '</span>', 'original', '', 'spanimage' ), 'formvalue' );
 				$success_msg .= '<a href="#" onclick="if( window.focus && window.opener ){ window.opener.focus(); textarea_wrap_selection( window.opener.document.getElementById(\'itemform_post_content\'), \''.$img_tag.'\', \'\', 1, window.opener.document ); } return false;">['.T_('float:left').']</a> or ';
-				$img_tag = format_to_output( $newFile->get_tag( '', NULL, '', '', 'original', '', 'center'), 'formvalue' );
+				// image tag centered
+				$img_tag = format_to_output( $newFile->get_tag( '<div class="image_block">', '<div class="image_legend">', '</div>', '</div>', 'original', '', 'center'), 'formvalue' );
 				$success_msg .= '<a href="#" onclick="if( window.focus && window.opener ){ window.opener.focus(); textarea_wrap_selection( window.opener.document.getElementById(\'itemform_post_content\'), \''.$img_tag.'\', \'\', 1, window.opener.document ); } return false;">['.T_('centered').']</a> or ';
-				$img_tag = format_to_output( $newFile->get_tag( '', NULL, '', '', 'original', '', 'rightmargin' ), 'formvalue' );
+				// image tag floated right
+				$img_tag = format_to_output( $newFile->get_tag( '<span class="imgwrap floatright center">', '<br /><span class="image_legend">', '</span>', '</span>', 'original', '', 'spanimage' ), 'formvalue' );
 				$success_msg .= '<a href="#" onclick="if( window.focus && window.opener ){ window.opener.focus(); textarea_wrap_selection( window.opener.document.getElementById(\'itemform_post_content\'), \''.$img_tag.'\', \'\', 1, window.opener.document ); } return false;">['.T_('float:right)').']</a>';
 				$success_msg .= '</li></ul></fieldset>';
 				$success_msg .= '<hr class="hidden" />';
 			}
 			else
 			{
+				// not an image so it gets ... something
 				$img_tag = format_to_output( $newFile->get_tag(), 'formvalue' );
 				$success_msg .= '<ul>'
 					.'<li><a href="#" onclick="if( window.focus && window.opener ){ window.opener.focus(); textarea_wrap_selection( window.opener.document.getElementById(\'itemform_post_content\'), \''.$img_tag.'\', \'\', 1, window.opener.document ); } return false;">'.T_('Add a link to this file in your post').'</a></li>'
@@ -482,6 +488,10 @@
 		// Store File object into DB:
 		$newFile->dbsave();
 
+		$Plugins->trigger_event( 'AfterFileSave', array(
+			  'newFile' => & $newFile,
+		  ) );
+
 	}
 
 	if( $upload_quickmode && !empty($failedFiles) )
@@ -494,40 +504,34 @@
 		// header_redirect( $dispatcher.'?ctrl=files&root='.$fm_FileRoot->ID.'&path='.rawurlencode($path) );
 		header_redirect( regenerate_url( 'ctrl', 'ctrl=files', '', '&' ) );
 	}
+
 }
 
 // Update sub-menu:
 if( $current_User->check_perm( 'files', 'add' ) )
 { // Permission to upload: (no subtabs needed otherwise)
 	$AdminUI->add_menu_entries(
-			'files',
-			array(
-					'browse' => array(
-						'text' => T_('Browse'),
-						'href' => regenerate_url( 'ctrl', 'ctrl=files' ) ),
-					'upload' => array(
-						'text' => T_('Upload'),
-						'href' => regenerate_url( 'ctrl', 'ctrl=upload' ) ),
-				)
-		);
+		'files', array(
+			'browse' => array(
+				'text' => T_('Browse'),
+				'href' => regenerate_url( 'ctrl', 'ctrl=files' ) ),
+			'upload' => array(
+				'text' => T_('Upload'),
+				'href' => regenerate_url( 'ctrl', 'ctrl=upload' ) ),
+		)
+	);
 }
 
-
 // Display <html><head>...</head> section! (Note: should be done early if actions do not redirect)
 $AdminUI->disp_html_head();
 
 // Display title, menu, messages, etc. (Note: messages MUST be displayed AFTER the actions)
 $AdminUI->disp_body_top();
 
-
-/*
- * Display payload:
- */
+// Display payload:
 $AdminUI->disp_view( 'files/views/_file_upload.view.php' );
 
-
 // Display body bottom, debug info and close </html>:
 $AdminUI->disp_global_footer();
 
-
 ?>

=== modified file 'qp_inc/plugins/_plugin.class.php'
--- qp_inc/plugins/_plugin.class.php	2010-11-02 14:17:25 +0000
+++ qp_inc/plugins/_plugin.class.php	2010-12-17 16:57:56 +0000
@@ -1794,6 +1794,22 @@
 	{
 	}
 
+	/**
+	 * This gets called before an image thumbnail gets created.
+	 *
+	 * This is useful to post-process the thumbnail image (add a watermark or change colors).
+	 *
+	 * @param array Associative array of parameters
+	 *   - 'File': the related File (by reference)
+	 *   - 'imh': image resource (by reference)
+	 *   - 'size': size name (by reference)
+	 *   - 'mimetype': mimetype of thumbnail (by reference)
+	 *   - 'quality': JPEG image quality [0-100] (by reference)
+	 */
+	function BeforeThumbCreate( & $params )
+	{
+	}
+
 	// }}}
 
 
@@ -2322,6 +2338,37 @@
 		return false; // Do nothing by default
 	}
 
+
+	/**
+	 * Event handler: Called before an uploaded file gets saved on server.
+	 *
+	 * @param array Associative array of parameters
+	 *   - 'File': The "File" object (by reference).
+	 *   - 'name': file name (by reference).
+	 *   - 'type': file mimetype (by reference).
+	 *   - 'tmp_name': file location (by reference).
+	 *   - 'size': file size in bytes  (by reference).
+	 *
+	 * @return boolean 'false' to abort file upload, otherwise return 'true'
+	 */
+	function AfterFileUpload( & $params )
+	{
+		return array(); // Do nothing by default:
+	}
+
+
+	/**
+	 * Event handler: Called after an uploaded file gets saved on server.
+	 *
+	 * @param array Associative array of parameters
+	 *   - 'newFile': The new "File" object (by reference).
+	 */
+	function AfterFileSave( & $params )
+	{
+		return false; // Do nothing by default
+	}
+
+
 	/*
 	 * Event handlers }}}
 	 */

=== modified file 'qp_inc/plugins/model/_plugins_admin.class.php'
--- qp_inc/plugins/model/_plugins_admin.class.php	2010-11-02 14:17:25 +0000
+++ qp_inc/plugins/model/_plugins_admin.class.php	2010-12-17 16:57:56 +0000
@@ -171,6 +171,10 @@
 
 				'AppendHitLog' => 'Called when a hit gets logged, but before it gets recorded.',
 
+				'AfterFileUpload' => 'Called before an uploaded file gets saved on server.',
+				'AfterFileSave' => 'Called after an uploaded file gets saved on server.',
+				'BeforeThumbCreate' => 'This gets called before an image thumbnail gets created.',
+
 				'DisplayCommentToolbar' => 'Display a toolbar on the public feedback form',
 				'DisplayCommentFormButton' => 'Called in the submit button section of the frontend comment form.',
 				'DisplayCommentFormFieldset' => 'Called at the end of the frontend comment form.',