David Karich

Module: AIOM+ (All In One Minify) for CSS, LESS, JS and HTML

Recommended Posts

Hey guys, 

first, ProcessWire is a great piece of software. Thanks for that and the great community behind that. So, i'm realy new to ProcessWire, but i will present you my first module for SEO- and performance optimizing: AIOM+ (All In One Minify).

AIOM+ (All In One Minify) for CSS, LESS, JS and HTML

AIOM+ (All In One Minify) is a module to easily improve the performance of your website. By a simple function call Stylesheets, LESS and Javascript files can be parsed, minimized and combined into one single file. This reduces the server requests, loading time and minimizes the traffic. In addition, the generated HTML source code can be minimized and all generated files can be loaded over a cookieless domain (domain sharding).

Install AIOM+

  1. Download current release (link below)
  2. Extract and copy the files for this module to /site/modules/AllInOneMinify/
  3. Login to PW backend and go to Modules > Check for new modules
  4. Install Module > AIOM+ (All In One Minify) for CSS, LESS, JS and HTML

Alternative in ProcessWire 2.4

  1. Login to PW backend and go to Modules
  2. Click tab "new" and enter Module Class Name: "AllInOneMinify"
  3. Click "Download and Install"

Features

  • Combining stylesheets / LESS files or JavaScripts
  • Minimize the combined files
  • No change to the .htaccess necessary (except for the domain sharding)
  • Server-side LESS parsing without plugins
  • HTML source code minimization
  • Cookieless domain / domain sharding
  • Automatic cache management (With changes to the source file, the cache is rebuilt)
  • Configurable via the backend
  • Automatic rewriting the paths in the stylesheet and LESS files. No changes are needed
  • Optional developer mode (combining, but no minimize and browser cache prevention)
  • Clear the cache on the backend
  • Conditional loading for CSS, LESS and JS (since Version 3.1.1)

How to use

Minimize multiple stylesheet or LESS files into one file. You can even mix stylesheet and LESS files in parsing and combining process!

<link rel="stylesheet" href="<?php echo AIOM::CSS(array('css/file-1.css', 'css/file-2.less', 'css/file-3.css', 'css/file-4.less')); ?>"> 

Minimize multiple javascript files into one file.

<script src="<?php echo AIOM::JS(array('js/file-1.js', 'js/file-2.js', 'js/file-3.js', 'js/file-4.js')); ?>"></script>

Conditional loading (same with Javascripts)

<?php $stylesheets  = array('css/reset.css',
                            'css/main.less',
                            array('loadOn'  => 'id|template=1002|1004|sitemap', // PW API selector
                                  'files'   => array('css/special.css', 'css/special-theme.less'))); ?>

<link rel="stylesheet" type="text/css" href="<?php echo AIOM::CSS($stylesheets); ?>" /> 

More Information, Documentation and Download

So, I hope you can do something with this module. :)

Dave

post-1973-0-08441200-1393031073_thumb.pn

  • Like 26

Share this post


Link to post
Share on other sites

Welcome to processwire cmp* and the forum David. And thanks for making your aiom+ module.

Looking at that module you must already be an experienced coder and so you don't need much

introduction to the how's and what's. But maybe you still may find something usefull in this channel:

http://processwire.com/talk/topic/4173-grouped-forum-posts-links-articles-tutorials-code-snippets/

(* = content management potential)

Share this post


Link to post
Share on other sites

I really like all the minify and less support. Actually I use the Spex-Module from Jonathan. With the next project I want to use AIOM+.

Looks good. I really like the idea of domain sharding built in.

 
Only one question for me is if it is an improvement to use domain sharding today. Before 2010, max 2 simultaneous connections was allowed. Today 6-8 are allowed/used. Without images you may need 1 html + 1 css + 1 js + 1 optional for Fonts = 4
 
related article: http://www.mobify.com/blog/domain-sharding-bad-news-mobile-performance/

Share this post


Link to post
Share on other sites

Yep, easily one of the most useful PW modules around. It fits great into my workflow, and now with version 3.0 and the added LESS support it gets even better. Keep up the good work!

PS Have you guys considered adding Autoprefixer support to the module (maybe as an option)? I'm not sure if this is easy to implement but it saves people the hassle of writing all kinds of vendor prefixes in their CSS, and instead just automatically takes care of this.

  • Like 2

Share this post


Link to post
Share on other sites

Thank you guys, for this great feedback. That make me happy. :)

Yep, easily one of the most useful PW modules around. It fits great into my workflow, and now with version 3.0 and the added LESS support it gets even better. Keep up the good work!

PS Have you guys considered adding Autoprefixer support to the module (maybe as an option)? I'm not sure if this is easy to implement but it saves people the hassle of writing all kinds of vendor prefixes in their CSS, and instead just automatically takes care of this.

I do not think it's the best way, to integrate Autoprefixer in AIOM+. I think it's not good when the module changes the generated code, which can be difficult to understand. Makes it difficult for the troubleshooting. But I'll be looking at Autoprefixer. Maybe I can port the code to PHP.

Currently i use LESS for that: 

.transition(@style) {
    -webkit-transition: @style;
    -moz-transition: @style;
    -o-transition: @style;
    -ms-transition: @style;
    transition: @style;
}

#element {
    .transition(all 0.2s ease);
}

Thank you very much for the module, it is one of my favorites. I have started a topic on github suggesting the use of conditional loading for files using the ID of the page.

I did not know existed the PHP official version of LESS, although I had already used to using koala (http://koala-app.com/) :)

Excellent suggestion! I'm still thinking about the syntax, but definitely write this function on the To-Do. Thank you.

Share this post


Link to post
Share on other sites

I really like all the minify and less support. Actually I use the Spex-Module from Jonathan. With the next project I want to use AIOM+.

Only one question for me is if it is an improvement to use domain sharding today. Before 2010, max 2 simultaneous connections was allowed. Today 6-8 are allowed/used. Without images you may need 1 html + 1 css + 1 js + 1 optional for Fonts = 4

related article: http://www.mobify.com/blog/domain-sharding-bad-news-mobile-performance/

I think for websites and applications that are designed for desktop systems, domain sharding is still acute and helpful. For mobile-optimized sites, it is counterproductive. 
 
The DNS overhead, is however, in my experience, not in comparison with the cookie data. For large news portals I continued domain sharding in use.
  • Like 1

Share this post


Link to post
Share on other sites

AIOM+ now in Version 3.0.1 with a little but recommended fix in the Less parser. If a large LESS file is split by the parser, the following error occurs: 

Error: Class 'Less_Exception_Parser' not found (line 8795 of /site/modules/AllInOneMinify/lib/Less/Less.php)

Issue found and submited by Ryan Pierce. Thanks.

Share this post


Link to post
Share on other sites

Hey David, really like AIOM. I would usually use Assetic for that, and I think you might want to look at integrating that code. Could save you a few headaches.  :)

Hey Pierre, 

I'm not really happy with Assetic for several reasons: 

  • Too many dependencies.
  • Java-based YUI integeration. Many shared hosting do not offer Java support.
  • Depending on the Google Closure API. I don't wanted to integrate any third party service.
  • Node.js for LESS parser, because the PHP-ported version in Asettic is outdated and is no longer developed and supported.

In summary, you could not just use AIOM+ as it is now – install and use. AIOM+ requires only PHP and is not dependent on another service or special server requirements. :)

  • Like 1

Share this post


Link to post
Share on other sites

So, just before the weekend, I've uploaded a new version (3.1.1) that supports a new feature: Conditional loading. You can now assign CSS, LESS or JS files with an API-selector a condition at which they should be loaded. For example: 

<?php $stylesheets  = array('css/reset.css',
                            'css/main.less',
                            array('loadOn'  => 'id|template=1002|1004|sitemap', // PW API selector
                                  'files'   => array('css/special.css', 'css/special-theme.less'))); ?>

<link rel="stylesheet" type="text/css" href="<?php echo AIOM::CSS($stylesheets); ?>" /> 
  • Like 10

Share this post


Link to post
Share on other sites

Hi, one quick question: Is there a way to set it up that it cleans the HTML but leaves the line breaks intact?

So I see a clean, neat website source code without spaces and comments but the code is not squeezed into one single endless line?

Share this post


Link to post
Share on other sites

Hi, one quick question: Is there a way to set it up that it cleans the HTML but leaves the line breaks intact?

So I see a clean, neat website source code without spaces and comments but the code is not squeezed into one single endless line?

Doesn't this kind of defeat the purpose of minimizing your html? If you want to look at nicely formatted source every browser nowadays has a good or decent devtools/inspector.

  • Like 2

Share this post


Link to post
Share on other sites

I do not think those extra few carriage returns matter too much.

Planning the "presentation" of source code is for psychological reasons: e.g. if 3rd parties (clients?) look at the code.

So, the "purpose" of minimizing html may vary from user to user. :-)

Share this post


Link to post
Share on other sites

What's stopping a client from opening devtools? If clients care enough to look at source code and actually base an opinion (negative or positive) on that, i think they are well aware of optimizations like minimize and they actually applaud you for that, or you could tell them: "we minimize (and concatenate) the output for optimal performance, especially on mobile". Keeping cr/lf in there seems an in-between, for no real reason. To me minimize means minimize, but to each it's own i guess.

  • Like 3

Share this post


Link to post
Share on other sites

Hi, one quick question: Is there a way to set it up that it cleans the HTML but leaves the line breaks intact?

So I see a clean, neat website source code without spaces and comments but the code is not squeezed into one single endless line?

Hi ceberlin, 
 
no, there is no option, because this ist not the target of a minimization. Every browser has an inspector or dev-tools in which you or your client can see the restructured DOM.

Share this post


Link to post
Share on other sites

Hi David,

I've been playing around with bower to manage third party libraries, bower puts files in a directory called bower_components and my first instinct was to put that directory right in "site/". In _getFileInfoArray any attempt to reference a file outside the templates directory gets thwarted, is there a security concern here?

Share this post


Link to post
Share on other sites

I read the module description and it looks like a great minify solution! Is there an overhead because of caching and cache rebuild? For example with a slow first page load or will the cache created prior to the first visitor? How do you monitor file changes?

I'll try AIOM+ soon to minify html, css and js with a new PW website :)

Share this post


Link to post
Share on other sites

Hi David,

I've been playing around with bower to manage third party libraries, bower puts files in a directory called bower_components and my first instinct was to put that directory right in "site/". In _getFileInfoArray any attempt to reference a file outside the templates directory gets thwarted, is there a security concern here?

Hi Jonathan , 

yes, in this function paths are filtered to prevent directory traversal attacks. AIOM+ loads only allowed files that are located in the template folder. I think about it, in one of the upcoming versions, introduce a whitelist for asset folder.

For a workaround change the following line (749) in AllInOneMinify.module

$_path  = str_ireplace(array('../', './', '%2e%2e%2f', '..%2F'), '', (wire('config')->paths->templates.$_file));

to 

$_path  = wire('config')->paths->templates.$_file; 

I have not tested it and I can not recommend it too.

  • Like 1

Share this post


Link to post
Share on other sites

I read the module description and it looks like a great minify solution! Is there an overhead because of caching and cache rebuild? For example with a slow first page load or will the cache created prior to the first visitor? How do you monitor file changes?

I'll try AIOM+ soon to minify html, css and js with a new PW website :)

Hi pwFoo, 

AIOM+ monitors each asset file on the modifikation time and generates a hash for the comparsion with the already cached files. If there exist no cached file, the first function call will trigger that process, but only for files, that are needed (first page load). The average overhead of an average webproject on shared hosting with 128 MB php_memory_limit are round 500 ms for generating, minimization, parsing and writing the cached files. That's at least my experience. The complete Bootstrap 3 source as LESS files is generated in under 3 seconds.

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 flydev
      PulsewayPush
      Send "push" from ProcessWire to Pulseway.
       
      Description
      PulsewayPush simply send a push to a Pulseway instance. If you are using this module, you probably installed Pulseway on your mobile device: you will receive notification on your mobile.
      To get more information about Pulseway, please visit their website.
      Note
      They have a free plan which include 10 notifications (push) each day.
       
      Usage
      Install the PulsewayPush module.
      Then call the module where you like in your module/template code :
      <?php $modules->get("PulsewayPush")->push("The title", "The notification message.", "elevated"); ?>  
      Hookable function
      ___push() ___notify() (the two function do the same thing)
       
      Download
      Github:  https://github.com/flydev-fr/PulsewayPush Modules Directory: https://modules.processwire.com/modules/pulseway-push/  
      Examples of use case
      I needed for our work a system which send notification to mobile device in case of a client request immediate support. Pulseway was choosen because it is already used to monitor our infrastructure.
      An idea, you could use the free plan to monitor your blog or website regarding the number of failed logins attempts (hooking Login/Register?), the automated tool then block the attacker's IP with firewall rules and send you a notification.
       

       
      - - - - - - - - - - - - - -
      11-22-2017: added the module to the modules directory
       
    • By netcarver
      Part 1 of a 2 part Module & Service Reveal.
      I'm currently working on a new module: ModuleReleaseNotes that was inspired by the work I originally did on making Ryan's ProcessWireUpgrades module "release" aware. In the end, I decided to ditch the approach I was originally taking and instead work on a module that hooked in to the UpgradeConfirmation dialog and the module edit page.
      Aims
      My aims for this module are as follows...
      Make discovery of a module's changes prior to an upgrade a trivial task. Make breaking changes very obvious. Make reading of a module's support documentation post-install a trivial task. Make module authors start to think about how they can improve the change discovery process for their modules. Make sure the display of information from the module support files/commit messages doesn't introduce a vulnerability. Looking at these in turn...
      Making discovery of a module's changes prior to upgrade a trivial task.
      This is done by adding a "What's changed section" to the upgrade confirmation dialog.  This section takes a best-effort approach to showing what's changed between the installed version and the updated version that's available via the module repository.
      At present, it is only able to talk to github-hosted repositories in order to ask them for the release notes, the changelog file (if present) and a list of commits between the git tag that matches the installed version and the tag matching the latest version.
      It will display the Release Notes (if the author is using the feature), else it will display the commits between the tags (if tagging is used by the module author) else it will show the changelog file (if present) else it will show the latest N commits on the master branch (N, of course, being configurable to your liking.)
      An example of the Github Release Notes pulled in for you, taken from Mike Rockett's TextformatterTypographer Module...

      An example of a tag-to-tag commit list from the same module...

      An example of a changelog - formatted to show just the changes (formatting styles will change)...

      Finally, an example of a fallback list of commits - sorry Adrian ...

       
      Making breaking changes obvious.
      This is currently done by searching for a set of configurable search strings. Later versions may be able to support breaking change detection via use of Semantic Versioning - but this may require some way of signalling the use of this versioning standard on a module-by-module basis.
      For now, then, you can customise the default set of change markers. Here I have added my own alias to the list of breaking change markers and the changes section of the changelog is styled accordingly (these will be improved)...

       
      Make reading of a module's support documentation, post-install, a trivial task.
      This is done by making some of the support files (like the README, CHANGELOG and LICENSE files) readable from the module's information/settings screen. There is an option to control the initial open/closed state of this section...

      Here is Tracy's README file from within the module settings page... 

       
      Make module authors start to think about how they can improve the change discovery process for their modules.
      There are notes in each of the sections displayed on the upgrade confirmation page that help authors use each of the features...

       
      Make sure display of external information doesn't introduce a vulnerability.
      This is an ongoing concern, and is the thing that is most likely to delay or prevent this module's release lead to this module's withdrawl should a vulnerability be found. Currently, output is formatted either via Markdown + HTML Purifier (if it was originally a Markdown file) or via htmlspecialchars() if it has come from a plaintext file.
      If you discover a vulnerability, please get in contact with me via the forum PM system.
       
      Ongoing...
      For now, I've concentrated on integration with GitHub, as most people use that platform to host their code. I know a few people are hosting their repositories with BitBucket (PWFoo comes to mind) and some with GitLab (Mike Rockett?) and I would eventually like to have adaptor implementations for these providers (and perhaps GitKraken) - but for now, GitHub rules and the other hosts are unsupported.
       
      Links
      Github: ModuleReleaseNotes
      PW Module Repository: Here
    • By FrancisChung
      Hi,
      I was wondering if anyone knew what this did? 

      If so, do you know what modules it actually impacts? Is there another log that lists the action it took?

      I'm having some weird problems with PHP duplicate declaration per link below, since this module was run.
       
       
    • By tpr
      AdminOnSteroids
      Various admin tweaks to enhance ProcessWire admin.
      http://modules.processwire.com/modules/admin-on-steroids/
      https://github.com/rolandtoth/AdminOnSteroids