forked from varia/varia.website
many many many Varia's websites, work in progress: https://many.vvvvvvaria.org
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
125 lines
3.3 KiB
125 lines
3.3 KiB
'''
|
|
Copyright (c) 2012 Matt Layman
|
|
|
|
Gzip cache
|
|
----------
|
|
|
|
A plugin to create .gz cache files for optimization.
|
|
'''
|
|
|
|
import logging
|
|
import os
|
|
import zlib
|
|
|
|
from pelican import signals
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# A list of file types to exclude from possible compression
|
|
EXCLUDE_TYPES = [
|
|
# Compressed types
|
|
'.bz2',
|
|
'.gz',
|
|
|
|
# Audio types
|
|
'.aac',
|
|
'.flac',
|
|
'.mp3',
|
|
'.wma',
|
|
|
|
# Image types
|
|
'.gif',
|
|
'.jpg',
|
|
'.jpeg',
|
|
'.png',
|
|
|
|
# Video types
|
|
'.avi',
|
|
'.mov',
|
|
'.mp4',
|
|
'.webm',
|
|
|
|
# Internally-compressed fonts. gzip can often shave ~50 more bytes off,
|
|
# but it's not worth it.
|
|
'.woff',
|
|
'.woff2',
|
|
]
|
|
|
|
COMPRESSION_LEVEL = 9 # Best Compression
|
|
|
|
""" According to zlib manual: 'Add 16 to
|
|
windowBits to write a simple gzip header and trailer around the
|
|
compressed data instead of a zlib wrapper. The gzip header will
|
|
have no file name, no extra data, no comment, no modification
|
|
time (set to zero), no header crc, and the operating system
|
|
will be set to 255 (unknown)'
|
|
"""
|
|
WBITS = zlib.MAX_WBITS | 16
|
|
|
|
|
|
def create_gzip_cache(pelican):
|
|
'''Create a gzip cache file for every file that a webserver would
|
|
reasonably want to cache (e.g., text type files).
|
|
|
|
:param pelican: The Pelican instance
|
|
'''
|
|
for dirpath, _, filenames in os.walk(pelican.settings['OUTPUT_PATH']):
|
|
for name in filenames:
|
|
if should_compress(name):
|
|
filepath = os.path.join(dirpath, name)
|
|
create_gzip_file(filepath, should_overwrite(pelican.settings))
|
|
|
|
|
|
def should_compress(filename):
|
|
'''Check if the filename is a type of file that should be compressed.
|
|
|
|
:param filename: A file name to check against
|
|
'''
|
|
for extension in EXCLUDE_TYPES:
|
|
if filename.endswith(extension):
|
|
return False
|
|
|
|
return True
|
|
|
|
def should_overwrite(settings):
|
|
'''Check if the gzipped files should overwrite the originals.
|
|
|
|
:param settings: The pelican instance settings
|
|
'''
|
|
return settings.get('GZIP_CACHE_OVERWRITE', False)
|
|
|
|
def create_gzip_file(filepath, overwrite):
|
|
'''Create a gzipped file in the same directory with a filepath.gz name.
|
|
|
|
:param filepath: A file to compress
|
|
:param overwrite: Whether the original file should be overwritten
|
|
'''
|
|
compressed_path = filepath + '.gz'
|
|
|
|
with open(filepath, 'rb') as uncompressed:
|
|
gzip_compress_obj = zlib.compressobj(COMPRESSION_LEVEL,
|
|
zlib.DEFLATED, WBITS)
|
|
|
|
uncompressed_data = uncompressed.read()
|
|
gzipped_data = gzip_compress_obj.compress(uncompressed_data)
|
|
gzipped_data += gzip_compress_obj.flush()
|
|
|
|
if len(gzipped_data) >= len(uncompressed_data):
|
|
logger.debug('No improvement: %s' % filepath)
|
|
return
|
|
|
|
with open(compressed_path, 'wb') as compressed:
|
|
logger.debug('Compressing: %s' % filepath)
|
|
try:
|
|
compressed.write(gzipped_data)
|
|
except Exception as ex:
|
|
logger.critical('Gzip compression failed: %s' % ex)
|
|
|
|
if overwrite:
|
|
logger.debug('Overwriting: %s with %s' % (filepath, compressed_path))
|
|
os.remove(filepath)
|
|
os.rename(compressed_path, filepath)
|
|
|
|
def register():
|
|
signals.finalized.connect(create_gzip_cache)
|
|
|
|
|