Added support to minify images.

xgvargas · xgvargas · commit a1b1f5389c32 · 2014-01-19T00:30:45.000-02:00
diff --git a/README.md b/README.md
@@ -10,13 +10,15 @@ Example with a django project
 
 During development I simply use django tags like *{% url ... %}* and *{% static ... %}* on my .js and .css files to define dynamic url to views and images of my project. At this point the .js and .css are placed into the templates directory of my app so I can *{% include ... %}* it to my .html templates and have the tags rendered to final urls. Of course the js and css will appear inline with the HTML content. For development I think this is fine.
 
-On deploy you usually what all your javascript and styling to be in a external file.
+On deploy you usually want all your javascript and styling to be in a single external file.
 
 Here is how this script can help you with that:
 
 On my base.html template I usually have something like this:
 
 ```html
+<head>
+...
 {% if not debug %}
   <script src="{% static 'js/ceco.min.js' %}"></script>
 {% else %}
@@ -29,6 +31,8 @@ On my base.html template I usually have something like this:
     {% include 'message/message.js' %}
   </script>
 {% endif %}
+...
+</head>
 ```
 
 Then simply put this script on the same directory as manager.py. Edit the script to adjust your paths to settings.py and to every JS and CSS you whant to merge/minify. Like:
@@ -59,7 +63,7 @@ merger = {
     }
 ```
 
-Here we define a path to the django project and the settings.py file to use while rendering the template tags. *You only need to define those if you have tags inside .js or .css, if you don't then simply ignore both*
+Here we define a path to the django project and the settings.py file to use while rendering the template tags. *You only need to define those if you have tags inside .js or .css, if you don't then simply ignore both*.
 
 In this case we have two blocks, *my js* and *my css*.
 
@@ -92,8 +96,15 @@ $python manage.py collectstatic
 $touch /path/to/yourwsgi.wsgi
 ```
 
-Ok, this can change on your server but that the overall idea...
+Ok, this can change on your server but that's the overall idea...
 
+Also you can use the option *--images* to optimise **all** *.PNG* and *.JPG* present on the directory tree starting where you executed this script (usualy your django project root). Like:
+
+```bash
+$python jscssmin.py --images
+```
+
+This will save a copy of all original images with *".original"* appended to its name and a smaller (hopefully), version will be saved with the original name. This script will ignore every file that already have a *.original* version present. To force this script to process every single file again use the option *--images-full*.
 
 Non django project
 ------------------
@@ -105,18 +116,32 @@ Using as a minifier module
 
 In another python script:
 ```python
-from jscssmin import jsMin, cssMin
+import  jscssmin
 
+#minify JS from text to file
 fulljstext = '<script>full code....</script>'
+jscssmin.jsMin(fulljstext, 'path/to/min/code.js')
+
+#minify CSS from text to file
 fullcsstext = '<style>full styles...</style>'
+jscssmin.cssMin(fullcsstext, 'path/to/min/style.css')
+
+#minify a JPG image
+jscssmin.jpgMin('path/to/image.jpg')
 
-jsMin(fulljstext, 'path/to/min/code.js')
-cssMin(fullcsstext, 'path/to/min/style.css')
+#minify a PNG image
+jscssmin.pngMin('path/to/image.png')
 ```
 
+All four functions used above are only helper to call some online minifer api. See below. This script does not minify JS or CSS by itself, so you need to be online to execute this with success.
+
 Minifier
 --------
 
-This script uses the api provided by http://cssminifier.com and http://javascript-minifier.com/ to minify CSS and JS data. Thanks [@andychilton] for this api.
+This script uses some online api provided by [@andychilton] for all minify action:
++ http://javascript-minifier.com
++ http://cssminifier.com
++ http://pngcrush.com
++ http://jpgoptimiser.com
 
-[@andychilton]: http://twitter.com/andychilton 
+[@andychilton]: http://twitter.com/andychilton
diff --git a/jscssmin.py b/jscssmin.py
@@ -15,9 +15,9 @@
 #minified version.
 #
 merger = {
-    'config': "cecoe.settings",
+    'config': "ceco.settings",
     'path': ("/home/transweb/apps_wsgi/ceco",
-             #"more paths....",
+             #"mode paths....",
              ),
     'blocks': {'my js': {'static': ('static/js/ceco.js',
                                     'static/js/xvalidator.js',
@@ -31,19 +31,21 @@
                'my css': {'static': ("tasks/static/tasks/css/fixtypeahead.css",
                                      "message/static/message/css/message.css"
                                      ),
-                           'full': 'static/css/ceco.css',
+                           'full': '',
                            'cssmin': 'static/css/ceco.min.css'
                            },
                },
     }
 
-
 #-------------------------------------------------------------------------
 import urllib2, urllib
+import os
+import sys
+import mimetypes
+import random
+import string
 
 if merger.get('config'): #only imports django if we have a config file defined
-    import os
-    import sys
     import re
     
     for p in merger['path']: sys.path.append(p)
@@ -59,19 +61,19 @@
         sys.exit(1)    
 
 
-def _read(file):
+def _read(file, mode='r'):
     """
     Read entire file content.
     """
-    with open(file, 'r') as fh:
+    with open(file, mode) as fh:
         return fh.read()
 
 
-def _save(file, data):
+def _save(file, data, mode='w+'):
     """
     Write all data to created file. Also overwrite previous file.
     """
-    with open(file, 'w+') as fh:
+    with open(file, mode) as fh:
         fh.write(data)
 
 
@@ -154,6 +156,139 @@ def cssMin(data, file):
     return 0
 
 
+def jpgMin(file, force=False):
+    """
+    Try to optimise a JPG file.
+    
+    The original will be saved at the same place with '.original' appended to its name.
+    
+    Once a .original exists the function will ignore this file unless force is True.
+    """
+    if not os.path.isfile(file+'.original') or force:
+        data = _read(file, 'rb')
+        _save(file+'.original', data, 'w+b')
+        print 'Optmising JPG {} - {:.2f}kB'.format(file, len(data)/1024.0),
+        url = 'http://jpgoptimiser.com/optimise'
+        parts, headers = encode_multipart({}, {'input': {'filename': 'wherever.jpg', 'content': data}})
+        req = urllib2.Request(url, data=parts, headers=headers)
+        try:
+            f = urllib2.urlopen(req)
+            response = f.read()
+            f.close()
+            print ' - {:.2f} - {:.1f}%'.format(len(response)/1024.0, 100.0*len(response)/len(data))
+            _save(file, response, 'w+b')
+        except:
+            print 'Oops!! Failed :('
+            return 1
+    else:
+        print 'Ignoring file: {}'.format(file)
+    return 0
+    
+    
+def pngMin(file, force=False):
+    """
+    Try to optimise a PNG file.
+    
+    The original will be saved at the same place with '.original' appended to its name.
+    
+    Once a .original exists the function will ignore this file unless force is True.
+    """
+    if not os.path.isfile(file+'.original') or force:
+        data = _read(file, 'rb')
+        _save(file+'.original', data, 'w+b')
+        print 'Crushing PNG {} - {:.2f}kB'.format(file, len(data)/1024.0),
+        url = 'http://pngcrush.com/crush'
+        parts, headers = encode_multipart({}, {'input': {'filename': 'wherever.jpg', 'content': data}})
+        req = urllib2.Request(url, data=parts, headers=headers)
+        try:
+            f = urllib2.urlopen(req)
+            response = f.read()
+            f.close()
+            print ' - {:.2f}kB - {:.1f}%'.format(len(response)/1024.0, 100.0*len(response)/len(data))
+            _save(file, response, 'w+b')
+        except:
+            print 'Oops!! Failed :('
+            return 1
+    else:
+        print 'Ignoring file: {}'.format(file)
+    return 0
+
+
+#this codes cames from: http://code.activestate.com/recipes/578668-encode-multipart-form-data-for-uploading-files-via/
+def encode_multipart(fields, files, boundary=None):
+    r"""Encode dict of form fields and dict of files as multipart/form-data.
+    Return tuple of (body_string, headers_dict). Each value in files is a dict
+    with required keys 'filename' and 'content', and optional 'mimetype' (if
+    not specified, tries to guess mime type or uses 'application/octet-stream').
+
+    >>> body, headers = encode_multipart({'FIELD': 'VALUE'},
+    ...                                  {'FILE': {'filename': 'F.TXT', 'content': 'CONTENT'}},
+    ...                                  boundary='BOUNDARY')
+    >>> print('\n'.join(repr(l) for l in body.split('\r\n')))
+    '--BOUNDARY'
+    'Content-Disposition: form-data; name="FIELD"'
+    ''
+    'VALUE'
+    '--BOUNDARY'
+    'Content-Disposition: form-data; name="FILE"; filename="F.TXT"'
+    'Content-Type: text/plain'
+    ''
+    'CONTENT'
+    '--BOUNDARY--'
+    ''
+    >>> print(sorted(headers.items()))
+    [('Content-Length', '193'), ('Content-Type', 'multipart/form-data; boundary=BOUNDARY')]
+    >>> len(body)
+    193
+    """
+    def escape_quote(s):
+        return s.replace('"', '\\"')
+
+    if boundary is None:
+        boundary = ''.join(random.choice(string.digits + string.ascii_letters) for i in range(30))
+    lines = []
+
+    for name, value in fields.items():
+        lines.extend((
+            '--{0}'.format(boundary),
+            'Content-Disposition: form-data; name="{0}"'.format(escape_quote(name)),
+            '',
+            str(value),
+        ))
+
+    for name, value in files.items():
+        filename = value['filename']
+        if 'mimetype' in value:
+            mimetype = value['mimetype']
+        else:
+            mimetype = mimetypes.guess_type(filename)[0] or 'application/octet-stream'
+        lines.extend((
+            '--{0}'.format(boundary),
+            'Content-Disposition: form-data; name="{0}"; filename="{1}"'.format(
+                    escape_quote(name), escape_quote(filename)),
+            'Content-Type: {0}'.format(mimetype),
+            '',
+            value['content'],
+        ))
+
+    lines.extend((
+        '--{0}--'.format(boundary),
+        '',
+    ))
+    body = '\r\n'.join(lines)
+
+    headers = {
+        'Content-Type': 'multipart/form-data; boundary={0}'.format(boundary),
+        'Content-Length': str(len(body)),
+    }
+
+    return (body, headers)
+
+if __name__ == '__main__':
+    import doctest
+    doctest.testmod()
+
+
 def process(obj):
     """
     Process each block of the merger object.
@@ -176,9 +311,28 @@ def process(obj):
     if obj.get('cssmin'):
         cssMin(merged, obj['cssmin'])    
 
-
+   
 if __name__ == '__main__':
+    if len(sys.argv) > 2:
+        print """Error! Use jscssmin.py [--images|--images-full]"""
+        exit(1)
+
+    img, imgfull = False, False
+    if len(sys.argv) == 2:
+        if sys.argv[1] == '--images': img = True
+        elif sys.argv[1] == '--images-full': img, imgfull = True, True
+        else:
+            print """Error! Use jscssmin.py [--images|--images-full]"""
+            exit(1)
+    
     for k, j in merger['blocks'].items():
         print '\nProcessing block: {}'.format(k)
         process(j)
-    
+    
+    if img:
+        for root, dirs, files in os.walk(os.getcwd()):
+            for f in files:
+                if f.endswith('.jpg'):
+                    jpgMin(os.path.join(root, f), imgfull)
+                elif f.endswith('.png'):
+                    pngMin(os.path.join(root, f), imgfull)
