News:

Want to get involved in developing SMF, then why not lend a hand on our github!

Main Menu

Automatic Attachment Rotation (and Resize)

Started by dougiefresh, March 04, 2016, 07:34:59 PM

Previous topic - Next topic

dougiefresh

Link to the mod




AUTOMATIC ATTACHMENT ROTATION (AND RESIZE)
For SMF 2.0 and SMF 2.1
v6.16


By Dougiefresh and GL700Wing
Link to Mod



Introduction
This mod allows the automatic rotation and/or flipping of images ONLY IF the EXIF information contained within (if such exists) indicates that such processing is required in order to show the picture in the correct orientation.

NOTE: SMF contains an option called Re-encode potentially dangerous image attachments, which is enabled by default.  This re-encoding removes the orientation information from attachments (amongst other things), which means attachments uploaded prior to this mod being installed will NOT be able to rotated properly, as the EXIF information is missing from the re-encoded attachment file!!

IMPORTANT NOTE FOR SMF 2.0 In order to fully support the Post and PM Inline Attachments mod you must install this mod after you install that mod!!
Also, if you subsequently need to uninstall the Post and PM Inline Attachments mod you must uninstall this mod first.

IMPORTANT NOTES REGARDING GD AND IMAGICK IMAGE PROCESSING
For SMF 2.0:
o GD is used even if iMagick is enabled in cPanel unless this mod is enabled with iMagick also enabled.
o EXIF metadata will always be removed from a JPEG image that is resized/compressed even if the 'Remove EXIF data from JPEG images' option is disabled.

For SMF 2.1:
o GD is used if iMagick is not enabled in cPanel or if this mod is enabled with iMagick disabled.

Major changes introduced in v6.12
o Added support for official release of SMF 2.1.
o Removed support for SMF 2.1 RC4.

Major changes introduced in v6.10
o Support for SMF 2.1 RC4 (official release only - not GitHub releases).
o Support for ImageMagick/Imagick image processor.
o Added options for rotating images and thumbnails separately when modifying a message (and for Admins when browsing files via the Admin center).
o Added code to display a thumbnail-sized copy of each attached image (and a smaller version of the real thumbnail if it exists) when editing a message (and for Admins when browsing files via the Admin Center).

Major change introduced in v6.00
o - Support for SMF 2.0.18 and PHP 7.4.

Major change introduced in v5.0
o Option to automatically, manually or batch resize/reformat existing images using 'Attachment Settings' options (non-JPEG images will only be reformatted to JPEG if the Reformat non-JPEG images to JPEG option is enabled).

Major changes introduced in v4.0
o Option to enable/disable automatic image rotation.
o Code update to enable automatic image resizing/reformatting in posts (and PMs if the PM Attachments mod is installed).

Post Screen Changes
Beside each image attachment a dropbox will be displayed listing the following rotation options for the Image/Thumbnail, Image Only and Thumbnail Only:
o No Change
o Rotate 90o Right
o Rotate 90o Left
o Rotate 180o
o Horizontal Flip
o Vertical Flip
o Horizontal Flip, Rotate 90o Right
o Vertical Flip, Rotate 90o Right

Automatic Resizing of Existing Images
When a post is displayed, and if the Attachment Setting Resize existing images option is enabled, images in the post will be automatically resized (and reformatted to JPEG if the Attachment Setting option Reformat non-JPEG images to JPEG is enabled) using the same Attachment Setting options (ie, Reformat non-JPEG images to JPEG, JPEG quality factor and/or maximum width/height) that are applied to new image attachments in posts.  In addition, if the Attachment Setting option Create backup of original image file when resizing is also enabled the original image file will be saved to the attachments directory with the extension '.rei'.
Note: Images posted by members who belong to a membergroup that has specific JPEG quality and/or maximum width/height values configured will be resized according to the values configured for that membergroup.

Manual Resizing of Existing Images
This feature, which can be accessed via Admin => Forum => Attachments and Avatars => Browse Files => Resize Existing Images, can be used to selectively resize/reformat existing images using the same Attachment Setting options (ie, Reformat non-JPEG images to JPEG, JPEG quality factor and/or maximum width/height) that are applied to new image attachments in posts.
Note: Images posted by members who belong to a membergroup that has specific JPEG quality and/or maximum width/height values configured will be resized according to the default configured values.

Batch Resizing of Existing Images
This feature, which can be accessed via Admin => Forum => Attachments and Avatars => File Maintenance => Batch Resize Existing Images, will resize/reformat all existing images using the same Attachment Setting options (ie, Reformat non-JPEG images to JPEG, JPEG quality factor and/or maximum width/height) that are applied to new image attachments in posts.
Note: Images posted by members who belong to a membergroup that has specific JPEG quality and/or maximum width/height values configured will be resized according to the default configured values.

The forum should be configured as follows prior to commencing batch resizing:
o Admin => Configuration => Server Settings => General => Enable Maintenance Mode should be enabled.
o Admin => Configuration => Security and Moderation => General => Disable administration security should be disabled.
o Admin => Forum => Posts and Topics => Topic Settings => Number of posts per page in a topic page should be configured to between 15 and 25 via (make a note of the current value).
o Admin => Forum => Attachments and Avatars => Attachment Settings - Maximum size per attachment, Reformat non-JPEG images to JPEG, JPEG quality factor, Maximum width of attached images and Maximum height of attached images should be configured.
o Admin => Forum => Attachments and Avatars => File Maintenance => Attachment Integrity Check should be run and issues corrected.

Important notes for batch resizing:
o Non-JPEG images will only be reformatted to JPEG if the Reformat non-JPEG images to JPEG option is enabled.
o Existing 'attachments' database table will be copied to 'attachmentsPreREI' database table. *
o Original image files are saved to the 'attachmentsPreREI' directory/folder. *
o File timestamp for resized image file is set to match timestamp of original image file.
o Batch processing progress information is displayed and updated.
o The results of the batch resizing process will be displayed on completion and also written to the forum error log file.

* The 'attachmentsPreREI' database table and directory/folder can be removed after checks have been done to confirm successful resizing - this will free up additional disk space on the server.

The forum should be configured as follows after batch resizing has finished:
o Admin => Configuration => Security and Moderation => General => Disable administration security should be enabled.
o Admin => Configuration => Server Settings => General => Enable Maintenance Mode should be disabled.
o Admin => Forum => Posts and Topics => Topic Settings => Number of posts per page in a topic page should be configured to previous value.

Admin Changes
In Admin => Forum => Attachments and Avatars:
o Browse Files: There is a new column (and associated button) for rotating/flipping images - the options for rotating/flipping images are only shown for image attachments.  There is also a new horizontal tab labelled 'Resize Existing Images' that can be used for manually resizing/reformatting existing images.
o Attachment Settings: Options to enable/disable the mod, configure a specific memory limit for image rotation/resizing, configure automatic image rotation and automatic resizing of existing images, enable/disable reformatting/resizing, option to reformat non-JPEG images to JPEG and options to set JPEG quality factor and max width/height values for attached images.  Also option to configure different JPEG quality factor and max width/height values for some membergroups and to enable/disable this feature.
- **File Maintenance**: There is a new section for *Batch Resize Existing Images*.  There is also a new section for *Reset Orientation Flag*.
o File Maintenance: There is a new section for Batch Resize Existing Images.  There is also a new section for Reset Orientation Flag.

Compatibility Notes
This mod was tested on SMF 2.0.17 but should work on SMF 2.0 and up.
This mod is only compatible with the official release of SMF 2.1 RC4 (ie, not GitHub releases).
SMF 1.x is not and will not be supported.

For SMF 2.0 - These mods (not required) must be installed before this mod:
o Post and PM Inline Attachments
o Improved Attachment Error Handling

For SMF 2.0 - The following mod must be uninstalled before installing this mod:
o Resize Attachment Images

For SMF 2.0 - The following mod is no longer required (additional memory for processing images can now be configured within this mod) and should be uninstalled:
o Image Processing Memory Limit

Translators
o Dutch: @rjen
o Spanish Latin: RockLee

Special Credit
This mod relies on the phpExifRW class, which is licensed under the GNU Lesser General Public License, in order to read the EXIF information from image files.  This class makes the requirement of having EXIF support built-in, which some servers do not have, not important to the task of successfully pulling the orientation out of the image file.  The exifReader.inc file was renamed to Class-exifReader.php in order to name the file in accordance with the naming convention of SMF and included in this mod.

Test images with EXIF orientation values embedded in them are available at Galloway.me.uk, at the Image Orientation thread over at the ElkArte forum, and on GitHub - Recurser.

License
QuoteCopyright (c) 2016-2020, Douglas Orend, 2019-2022 Kathy Leslie
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer; and
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dougiefresh

Bug report and response to said bug report:
Quote from: dougiefresh on March 13, 2016, 08:26:16 PM
Quote from: dan4ever on March 11, 2016, 03:36:39 PM
@Dougiefresh

Your mod did not turn the tumbnail in my forum!!

/Dan
I read this statement again just now and I think I understand what is going on.  My mod only deals with rotating NEW attachments, pre-existing attachments are not touched....  If you are looking for functionality to deal with existing attachments, then I can add that into the mod as well.  However, such image processing is quite intensive and possibly time consuming for forums with a large number of attachments.....

Rereading the mod description, it also sounds like I need to clarify the purpose of the mod.....  ???

I would also advise you to post problems regarding specific mods into the support thread of that mod, which in this case is located here.....  It is by chance that I can across this particular bug report, and I don't look everywhere for threads regarding my 51 approved mods....  O:) :P

I've quoted these messages and placed them in the right thread for you, to make it easier for me to locate...  O:) :P

FrizzleFried

Not working... maybe the mod doesn't work with inline attachment mod?


dougiefresh

@Everybody: Regarding bug report two posts ago, I am attempting to rewrite the mod so that it also works for existing attachments.  Version 1.0 only works for NEW attachments (at least it worked during my testing....)

Quote from: FrizzleFried on March 14, 2016, 05:59:17 PM
Not working... maybe the mod doesn't work with inline attachment mod?
Honestly, I don't know if it will work with the inline attachment mod.  Hasn't been tested....

FrizzleFried

I assume I don't need to turn anything on?

How I am testing is that I am uploading an image that shows rotated on my digital camera... it also shows rotated (vertical orientation) in windows explorer... but when I upload it it appears horizontal (should be vertical).   It's remaining horizontal... I've tried both having the image appear "in-line" as well as a standard upload with no in-line adjustments made... and both show up horizontal.


dougiefresh

Uploaded v1.1 - March 14th, 2016
o Fixed several errors within the image_rotate_flip function.
o Added code to rotate/flip attachments upon download if they haven't been processed yet.
o Added code to rotate/flip attachments upon displaying topics if they haven't been processed yet.
o Branched image_rotate_flip function as AutoRotation_Process into Subs-AutoRotation.php file.
o Seperated SMF 2.0.x and SMF 2.1 install branches.




@FrizzleFried and dan4ever: Hopefully this update takes care of the problems you experienced in version 1.0....  Please note while the mod will attempt to fix the orientation on pre-existing attachments, the orientation information may already be removed due to forum processing of the image attachment prior to this mod's installation....

dan4ever

No, still not working.
And I got alot of this error:

Quote
http://www.guldforum.se/forum/index.php?topic=3302.msg29328
The database value you're trying to insert does not exist: width
Function: AutoRotation_Update
Fil: /storage/content/******/guldforum.se/public_html/forum/Sources/Subs-AutoRotation.php
Rad: 207



Quote from: dougiefresh on March 13, 2016, 08:26:16 PM
If you are looking for functionality to deal with existing attachments, then I can add that into the mod as well. 
YES, PLEASE!!!!!!!

/Dan
/Dan Olsson, Webmaster at https://www.guldforum.se

dougiefresh

Quote from: dan4ever on March 20, 2016, 08:43:10 PM
No, still not working.
And I got alot of this error:

Quote
http://www.guldforum.se/forum/index.php?topic=3302.msg29328
The database value you're trying to insert does not exist: width
Function: AutoRotation_Update
Fil: /storage/content/******/guldforum.se/public_html/forum/Sources/Subs-AutoRotation.php
Rad: 207
Damn, that looks familiar.....  I thought I took care of that error message...  (Big sigh)  Let me look into it again....

Quote from: dan4ever on March 20, 2016, 08:43:10 PM
Quote from: dougiefresh on March 13, 2016, 08:26:16 PM
If you are looking for functionality to deal with existing attachments, then I can add that into the mod as well. 
YES, PLEASE!!!!!!!
I've attempted to add functionality to deal with existing attachments in version 1.1.  It seems that SMF's re-encoding process strips out the EXIF information from the images, so it CAN'T automatically rotate and/or flip the image(s) accordingly.....  So I'm at a loss on how to proceed with those instances....

I guess I could add something in the Profile -> Show Posts -> Attachments screen....  I just don't know what at this moment....

dan4ever

Quote from: dougiefresh on March 21, 2016, 07:12:41 PM
Quote from: dan4ever on March 20, 2016, 08:43:10 PM
No, still not working.
And I got alot of this error:

Quote
http://www.guldforum.se/forum/index.php?topic=3302.msg29328
The database value you're trying to insert does not exist: width
Function: AutoRotation_Update
Fil: /storage/content/******/guldforum.se/public_html/forum/Sources/Subs-AutoRotation.php
Rad: 207
Damn, that looks familiar.....  I thought I took care of that error message...  (Big sigh)  Let me look into it again....

Quote from: dan4ever on March 20, 2016, 08:43:10 PM
Quote from: dougiefresh on March 13, 2016, 08:26:16 PM
If you are looking for functionality to deal with existing attachments, then I can add that into the mod as well. 
YES, PLEASE!!!!!!!
I've attempted to add functionality to deal with existing attachments in version 1.1.  It seems that SMF's re-encoding process strips out the EXIF information from the images, so it CAN'T automatically rotate and/or flip the image(s) accordingly.....  So I'm at a loss on how to proceed with those instances....

I guess I could add something in the Profile -> Show Posts -> Attachments screen....  I just don't know what at this moment....

Just an arrow to turn and save
/Dan Olsson, Webmaster at https://www.guldforum.se

dougiefresh

Quote from: dan4ever on March 22, 2016, 09:29:28 AM
Quote from: dougiefresh on March 21, 2016, 07:12:41 PM
I guess I could add something in the Profile -> Show Posts -> Attachments screen....  I just don't know what at this moment....
Just an arrow to turn and save
Where?  On the attachment screen or on the post screen?

dan4ever

Quote from: dougiefresh on March 22, 2016, 06:47:07 PM
Quote from: dan4ever on March 22, 2016, 09:29:28 AM
Quote from: dougiefresh on March 21, 2016, 07:12:41 PM
I guess I could add something in the Profile -> Show Posts -> Attachments screen....  I just don't know what at this moment....
Just an arrow to turn and save
Where?  On the attachment screen or on the post screen?


The best I think is on the post screen.
For the Admin, moderator and the member how post it. Not for everybody!!!


/Dan
/Dan Olsson, Webmaster at https://www.guldforum.se

dougiefresh

Quote from: dan4ever on March 24, 2016, 05:29:48 AM
Quote from: dougiefresh on March 22, 2016, 06:47:07 PM
Quote from: dan4ever on March 22, 2016, 09:29:28 AM
Quote from: dougiefresh on March 21, 2016, 07:12:41 PM
I guess I could add something in the Profile -> Show Posts -> Attachments screen....  I just don't know what at this moment....
Just an arrow to turn and save
Where?  On the attachment screen or on the post screen?
The best I think is on the post screen.
For the Admin, moderator and the member how post it. Not for everybody!!!
Do we have enough quotes here?  :P  I'll put it on the attachment list line, since it'd be easier for me to code around a known number of attachments than a variable number (due to adding additional attachments, etc).  Yeah, I know it'd mean that you have to upload, then see if the attachment is rotated correctly, but.....  I guess it'd be better than nothing (which is what SMF has right now)....

Quote from: dan4ever on March 24, 2016, 05:29:48 AM
For the Admin, moderator and the member how post it. Not for everybody!!!
Duh....  :P

dan4ever

/Dan Olsson, Webmaster at https://www.guldforum.se

dan4ever

Another idé...


Why not make this: in Admin -> Forum -> Attachments /(and)/ Thumbnails
Make an small preview of the picture on every line and ability to change/turn it.


/Dan 
/Dan Olsson, Webmaster at https://www.guldforum.se

dougiefresh

Was thinking about doing something similar at the Profile -> Show Posts -> Attachments screen.....

dougiefresh

#15
Uploaded v1.2 - March 25th, 2016
o Fixed function calls in Subs-Graphics.php so that correct parameters are used.
o Added replacement "imagerotate" function for PHP < 4.3.  Unlikely to be needed, but whatever...




:o Whoops.... O:) I finally figured out why my tests with images having a non-zero orientation were spastic....  The parameters of the function being called were half wrong...  Fixed that and the pictures are rotated correctly....  Verison 1.2 contains the updated XML ops and PHP files....

Quote from: dan4ever on March 20, 2016, 08:43:10 PM
No, still not working.
And I got alot of this error:

Quote
http://www.guldforum.se/forum/index.php?topic=3302.msg29328
The database value you're trying to insert does not exist: width
Function: AutoRotation_Update
Fil: /storage/content/******/guldforum.se/public_html/forum/Sources/Subs-AutoRotation.php
Rad: 207
Can you tell me if the error message still occurs?  I haven't gotten this error message on my localhost forum.....

dan4ever

Hi, again


Have your latest update installed but the pic are still 45% wrong.


/Dan
/Dan Olsson, Webmaster at https://www.guldforum.se

dan4ever

Quote from: dougiefresh on March 13, 2016, 08:30:35 PM

Can you tell me if the error message still occurs?  I haven't gotten this error message on my localhost forum.....

No more :)

Thanks!!!!

Quote from: dan4ever on March 25, 2016, 06:21:54 AM
Another idé...


Why not make this: in Admin -> Forum -> Attachments /(and)/ Thumbnails
Make an small preview of the picture on every line and ability to change/turn it.


/Dan 
This would be nice, and maybe to work throu al the tumbnails/attachment and change them.

/Dan
/Dan Olsson, Webmaster at https://www.guldforum.se

-Rock Lee-

Very good @dougiefresh I see now modified afternoon I looked closer :)


Regards!
¡Regresando como cual Fenix! ~ Bomber Code
Ayudas - Aportes - Tutoriales - Y mucho mas!!!

KungFuJoe

Hello...tried installing your mod, but get this Database Error at the bottom of any topic I enter:

Unknown column 'thumb.proper_rotation' in 'field list'
File: /home2/yandc/public_html/test.#####.net/Sources/Display.php

I'm running 2.0.11

I do have the resize attachments mod.

Advertisement: