matjazp

Auto Smush

33 posts in this topic

Module: Auto Smush

https://github.com/matjazpotocnik/AutoSmush 

Optimize/compress images.

In Automatic mode images that are uploaded can be automatically optimized. Variations of images that are created on resize/crop and admin thumbnails can also be automatically optimized. In Manual mode "Optimize image" link/button will be present. This allows manual optimization of the individual image or variation. In Bulk mode all images, all variations or both can be optimized in one click. Will process images sitewide.

Two optimization "engines" are avaialable. reShmush.it is a free (at the moment) tool that provides an online way to optimize images. This tool is based on several well-known algorithms such as pngquant, jpegoptim, optipng. Image is uploaded to the reSmush.it web server, then optimized image is downloaded. There is a 5 MB file upload limit and no limit on number of uploaded images. "Local tools" is set of executables on the server for optimizing images: optipng, pngquant, pngcrush, pngout, advpng, gifsicle, jpegoptim, jpegtran. Binaries for Windows are provided with this module in windows_binaries folder, copy them somewhere on the PATH environment variable eg. to C:\Windows.

Similar modules:

JpegOptimImage by Jonathan Dart: https://processwire.com/talk/topic/6667-jpegoptimimage/ 

TinyPNG Image Compression by Roope: https://github.com/BlowbackDesign/TinyPNG 

ProcessImageMinimize by conclurer: https://processwire.com/talk/topic/5404-processimageminimize-image-compression-service-commercial/ 

Forum discusion: https://processwire.com/talk/topic/12111-crowdfunded-tinypng-integration-module/

 

Module created by Roland Toth (@tpr).

10 people like this

Share this post


Link to post
Share on other sites
30 minutes ago, matjazp said:

free (at the moment)

Thanks for this - looks great, but curious if you know if they have plans to start charging ? I didn't see anything on their website (http://www.resmush.it/) to indicate the long term plans.

Share this post


Link to post
Share on other sites

I don't know about plans. The service is up for quite a time, sure more over a year, but it's not clear who is owner of site. Site is created by French Tech, the collective name for all those working in the French startup market. There is also no privacy policy available, so who knows what happen with your uploaded images. There are other services with "free" plans, but with limitations, like file size (100kB) or number of images (eg. 500 per month). I actually don't like web services, because first you upload the image to your server, then upload to web service and then download it. That's why I use local tools on the server, but that come with a price, cpu & memory usage, but I can aford it, since I'm the sysdamin :-) 

Auto Smush is somehow different from other modules, since it does not add the method(s) to PageImage, thus you don't have to change your code and also you may uninstall (or disable) the module at any time without code modification in your templates.

2 people like this

Share this post


Link to post
Share on other sites
1 hour ago, matjazp said:

Module created by Roland Toth (@tpr).

Only started it :) Then came @matjazp and fixed a number of issues, added local tools and so on. I kinda lost interest when I made it work on my sites and do not wanted to invest more time to improve and make it ready for public. So big thanks to matjazp, and hopefully after a few iterations it will be more stable.

1 person likes this

Share this post


Link to post
Share on other sites

Great! I was looking for a module like this after https://minimize.pw/ closed the doors.

I have to test it tomorrow. I guess it works with Croppable Image 3, too, doesn’t it? Or let’s better phrase it: Does automatic mode work with all modules which extend the functionality of PW’s default image field? That would really make optimizing images a no-brainer. :-)

Share this post


Link to post
Share on other sites

It's not compatible with CI3, but I think I know why and I think I know how to fix it :-) Will report, stay tuned.

3 people like this

Share this post


Link to post
Share on other sites

Sadly I get an error when downloading the module via PW.

PW Version is 2.8

IMG_0153.PNG

Just tried with latest PW 3.0.41: Same, same... :-(

Edited by Mikel
Reproduced with other PW version

Share this post


Link to post
Share on other sites

Sorry for inconvenience! I just realised that the whole directory was missing on github. I fixed that and also upgraded AS to v1.0.2 that add support for CroppableImage3.

3 people like this

Share this post


Link to post
Share on other sites
On 11/20/2016 at 8:25 AM, matjazp said:

Sorry for inconvenience! I just realised that the whole directory was missing on github. I fixed that and also upgraded AS to v1.0.2 that add support for CroppableImage3.

That fixed it. (I was getting the same error.) Works great!

Share this post


Link to post
Share on other sites

Is there anything I have to set up to use the local optimization tools?

I'm on a shared webspace, but each customer has a separate FastCGI PHP interpreter. So it should work according to the module’s documentation. Or did I miss anything?

The error messages say “Command "jpegoptim" not found.” or the similar message for pngs.

Share this post


Link to post
Share on other sites

It looks like executable is not found because it's not within the PATH. Do php -r "print getenv('PATH');" from shell or phpinfo(); from php and check for environment variable PATH. Make sure that jpegoptim (and others) are on the path. You could also check what shell is executed: echo shell_exec("echo $0");  It's possible that it's sh and not bash  You may need to use the putenv command or determine whether your path needs to be set in /etc/profile, ~/.profile or ~/.bashrc in order for it to be picked up by the user runing php. Some versions of apache read configuration from /etc/apache2/envvars . You can set environment vars locally within a VirtualHost config using SetEnv. Or it might help if you put putenv('PATH=/your/path'); somewhere in the php, just for the test.

You could also set the path of jpegoptim (and other binaries) by modifying optimizeSettings in AutoSmush.module:

        $this->optimizeSettings = array(
            'ignore_errors'     => false, //in production could be set to true
            'jpegtran_options'  => array('-optimize', '-progressive', '-copy', ' all'),
            'jpegoptim_options' => array('--preserve', '--all-progressive', '--strip-none', '-T' . self::JPG_QUALITY_THRESHOLD),
            'optipng_options'   => array('-i0', '-o2', '-quiet', '-preserve'),
            'advpng_options'    => array('-z', '-3', '-q'),
            'jpegoptim_bin'     => '/path/to/jpegoptim', <== add this line
        );

All this is specific to the environment, so I can't give detail instructions on how to make "Local tools" to work. I'm also not a linux user, I tested tools on windows. Let me know how it goes.

2 people like this

Share this post


Link to post
Share on other sites
On 23.11.2016 at 9:28 PM, matjazp said:

Let me know how it goes.

Since my Linux knowledge is quite limited, I had to research and try a bit. Only the last option (inserting the path into the module file) worked – but only for jpegoptim. If i try to upload a png, I receive an error message telling me that the pngquant command doesn’t work, even if the module now knows the path to the binary.

To be honest, that’s too much work to investigate. I just use resmush.it as long as it works.

Share this post


Link to post
Share on other sites

jpegoptim_bin is just for jpegoptim, the other options are:

  • optipng_bin
  • pngquant_bin
  • pngcrush_bin
  • pngout_bin
  • gifsicle_bin
  • jpegtran_bin

Would it help if you could enter the paths in the module settings page?

Share this post


Link to post
Share on other sites

Of course I used the individual options.

I also tried commenting out the pngquant_bin setting, hoping that the modiule would go on trying to use the next available PNG optimizer. But it didn’t work. I got the error message that pngquant could not be found.

Share this post


Link to post
Share on other sites

Hi, sorry for the late reply. I'm using OptimizerFactory library and that's how it works. Quick workaround would be changing the source code in the library, so that only one optimizer would run. Open /site/modules/AutoSmush/image-optimizer/src/ImageOptimizer/OptimizerFactory.php and change to this:

        $this->optimizers['png'] = new ChainOptimizer(array(
            $this->optimizers['optipng'], //reversed the order so optipng is first
            $this->optimizers['pngquant'],
            $this->optimizers['pngcrush'],
            $this->optimizers['advpng']
        //));
        ), true); //if true, just first optimizer will run, if false all optimizers will run

I'll see what I can do, since others that are using this library has similar problems. Author of the library does not response to this issue, but we will find a solution. It might take some time though.

Share this post


Link to post
Share on other sites

Thanks for the explanation, @matjazp. As I said, I'm fine with being able to use resmush.it via the module, since resmush.it works like a charm, and I don’t have any images which are not sooner or later made publicly available (so there are no privacy issues).

Being independent from resmush.it would be a nice extra, but it’s not really required from my side. This would be interesting for cases where PW and Autosmush are used to build a website for a closed user group with confidential content which should not be send around between servers.

Share this post


Link to post
Share on other sites

I made some changes in v1.0.4 (just uploaded to GH). At the bottom at the module config you can see what is the path being search for local optimizers (executables) and which optimizers have been found. If optimizer is not found, then it's skipped. I extended the search path so you can put optipng, jpegoptim and gifsicle on the root of PW ($config->paths->root) on templates directory  ($config->paths->templates) and assets directory ($config->paths->assets). If you have shell access then you can install all three mentioned optimizers with apt-get install optipng jpegoptim gifsicle Hope that helps.

1 person likes this

Share this post


Link to post
Share on other sites

Thanks for the great module, but I get the following error in php7 environment. It runs smoothly in php5.

require_once(): Failed opening required '/home/admin/public_html/site/modules/AutoSmush./ImageOptimizer.php' (include_path='.:/usr/share/php')

The error is gone after I change line 5 in AutoSmush.module from

require_once /*NoCompile*/__DIR__ . './ImageOptimizer.php';

to

require_once /*NoCompile*/__DIR__ . '/ImageOptimizer.php';

(remove dot before /ImageOptimizer.php)

 

However, in Local tool optimizers info, the module cannot find any exe.(EDIT: I found that you have posted solution above. Let me try first, thanks)

EDIT: Solved by simply  apt-get install optipng jpegoptim gifsicle

2 people like this

Share this post


Link to post
Share on other sites

Just before commit to GH I added /*NoCompile*/ option introduced in lasted PW dev and somehow added dot, don't know why  :-) I hope I didn't break other things... It's working fine on windows with php 7.1, tried on linux with php 7.0 and got an error. I just pushed a fix for that. Thx for reporting.

Optimizers on linux: I can't make instructions on how to install them, since there are so many flavors of *x, but it looks like apt-get is now some sort of standard. 

Share this post


Link to post
Share on other sites
2 hours ago, matjazp said:

I hope I didn't break other things...

I did :-)

Please use the latest version from github.

1 person likes this

Share this post


Link to post
Share on other sites

I get the following error when installing from PW Modules.

Also tried to download and install direct from github.

It seems to install fine but this error is apparent when I click the Settings button on AutoSmush 1.0.5

 

Quote

Fatal error: Call to a member function add() on null in /var/www/vhosts/domain.com/httpdocs/site/modules/AutoSmush/AutoSmush.module on line 752

Error: Call to a member function add() on null (line 752 of /var/www/vhosts/domain.com/httpdocs/site/modules/AutoSmush/AutoSmush.module) 

 

Share this post


Link to post
Share on other sites
1 hour ago, Peter Knight said:

I get the following error when installing from PW Modules.

Also tried to download and install direct from github.

It seems to install fine but this error is apparent when I click the Settings button on AutoSmush 1.0.5

I think this was an error from running 2.7.3 (or similar).

Upgraded to 3.0.33 and all is working.

Share this post


Link to post
Share on other sites

Sorry for troubles. Please upgrade to 1.0.6 if that fixes it (just uploaded to github).

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!


Register a new account

Sign in

Already have an account? Sign in here.


Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      Hi,
      just stumbled over a little module that i built for my last project. it helped me to test performance of my rockdatatables module to generate 3000 random json datasets and i want to share it with you. maybe it saves some time for someone.
      https://gitlab.com/baumrock/RockDummyData/
      easy example:
      $rdd = $modules->get('RockDummyData'); for($i=0; $i<15; $i++) { // this has to be inside the for-loop to always get a new dummy $dummy = $rdd->getDummy(); echo date("d.m.Y H:i:s", $dummy->timestamp) . "<br>"; } more advanced:
      $json = new stdClass(); $json->data = array(); $rdd = $modules->get('RockDummyData'); for($i=0; $i<3000; $i++) { // this has to be inside the for-loop to always get a new dummy $dummy = $rdd->getDummy(); $obj = new stdClass(); $obj->name = $dummy->forename . ' ' . $dummy->surname; $obj->position = $dummy->job; $obj->office = $dummy->city; $obj->color = $dummy->color; $obj->start_date = new stdClass(); $obj->start_date->display = date('d.m.Y',$dummy->timestamp); $obj->start_date->sort = $dummy->timestamp; $obj->salary = rand(0,10000); $json->data[] = $obj; } echo json_encode($json); you have to store your random datasets on your own into the /data folder. there are several services for creating all kinds of random data on the web - if you know one service that allows sharing those datasets let me know and i can include common needed data into the module
    • By AndySh
      Hello!
      I need your assistance please. I purchased the module FormBuilder. Unfortunately, the module discontinued delivering customer submissions to e-mail box specified in the module settings. Direct mailing to the e-mail box works OK. The module settings stays the same and are correct, like "Send e-mail to administrator(s) is checked. The last version of FormBuilder 3.0 has been installed. Please advise how to resolve the issue becase I cannot get orders from customers anymore (((
    • By kixe
      As described in this post (https://processwire.com/talk/topic/8551-custom-urls-for-pages/?p=82742) the option 'Name Format Children' under the tab 'Family' in template settings doesn't work properly and also not as expected. I had a look inside the code and made some changes which are working properly, which offers much more options, more consistency and less code too.

      The result is the following. You have 3 Options for generating name and title, which could be combined in endless variations.
      Name is always derived from title, same like creating pages manually.
      type date: if function detects # character anywhere in the string, conversion will be: deletion of # and string will be used as format parameter for PHP date() function type field: if string is a fieldname of the parent page the value of this field will be used type string: if string doesn't fit to the 2 preceeding it will be taken as it is All parts (separated by comma) will be composed in the order of setting. You can use unlimited numbers of parts

      I made a pull request on github: https://github.com/ryancramerdesign/ProcessWire/pull/831

      Example screenshots

      Setting ...


      will result in


       
    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
       
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend