Jump to content
matjazp

Auto Smush

Recommended Posts

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).

  • Like 13

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.

  • Like 2

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.

  • Like 1

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.

  • Like 3

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.

  • Like 3

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.

  • Like 2

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.

  • Like 1

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

  • Like 2

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.

  • Like 1

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
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...