MinSVGCache.js

   1 /*
   2  * Copyright (C) 2018 Nick Downing <nick@ndcode.org>
   3  * SPDX-License-Identifier: MIT
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to
   7  * deal in the Software without restriction, including without limitation the
   8  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   9  * sell copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 let BuildCache = require('@ndcode/build_cache')
  25 let svgo = require('svgo')
  26 let assert = require('assert')
  27 let disk_build = require('@ndcode/disk_build')
  28 let fs = require('fs')
  29 let path = require('path')
  30 let util = require('util')
  31
  32 let fs_readFile = util.promisify(fs.readFile)
  33 let fs_writeFile = util.promisify(fs.writeFile)
  34
  35 let MinSVGCache = function(diag1, diag) {
  36   if (!this instanceof MinSVGCache)
  37     throw new Error('MinSVGCache is a constructor')
  38   BuildCache.call(this, diag)
  39   this.diag1 = diag1
  40 }
  41
  42 MinSVGCache.prototype = Object.create(BuildCache.prototype)
  43
  44 MinSVGCache.prototype.build = async function(key, result) {
  45   let render = await disk_build(
  46     key,
  47     async temp_pathname => {
  48       // we will assume directory can be stripped from path when slugifying,
  49       // it could cause problems with same-named SVGs in different directories
  50       // when displayed on same page, but this seems quite unlikely to happen
  51       let slug = path.basename(key, '.svg')
  52
  53       let render = await svgo.optimize(
  54         await fs_readFile(key, {encoding: 'utf-8'}),
  55         {
  56           path: key,
  57           multipass: true,
  58           plugins: [
  59             {name: 'cleanupAttrs'},
  60             {name: 'removeDoctype'},
  61             {name: 'removeXMLProcInst'},
  62             {name: 'removeComments'},
  63             {name: 'removeMetadata'},
  64             {name: 'removeTitle'},
  65             {name: 'removeDesc'},
  66             {name: 'removeUselessDefs'},
  67             {name: 'removeEditorsNSData'},
  68             {name: 'removeEmptyAttrs'},
  69             {name: 'removeHiddenElems'},
  70             {name: 'removeEmptyText'},
  71             {name: 'removeEmptyContainers'},
  72             //{name: 'removeViewBox'},
  73             {name: 'cleanupEnableBackground'},
  74             {name: 'convertStyleToAttrs'},
  75             {name: 'convertColors'},
  76             {name: 'convertPathData'},
  77             {name: 'convertTransform'},
  78             {name: 'removeUnknownsAndDefaults'},
  79             {name: 'removeNonInheritableGroupAttrs'},
  80             {name: 'removeUselessStrokeAndFill'},
  81             {name: 'removeUnusedNS'},
  82             {name: 'cleanupIDs', params: {prefix: slug + '_'}},
  83             {name: 'cleanupNumericValues'},
  84             {name: 'moveElemsAttrsToGroup'},
  85             {name: 'moveGroupAttrsToElems'},
  86             {name: 'collapseGroups'},
  87             //{name: 'removeRasterImages'},
  88             {name: 'mergePaths'},
  89             {name: 'convertShapeToPath'},
  90             {name: 'sortAttrs'} //,
  91             //{name: 'removeDimensions'}//,
  92             //{name: 'removeAttrs', params: {attrs: '(stroke|fill)'}}
  93           ]
  94         }
  95       )
  96       if (render.error)
  97         throw new Error(render.error)
  98
  99       return /*await*/ fs_writeFile(
 100         temp_pathname,
 101         render.data,
 102         {encoding: 'utf-8'}
 103       )
 104     },
 105     this.diag1
 106   )
 107   assert(render.deps.length === 0)
 108   result.value = await fs_readFile(render.pathname)
 109 }
 110
 111 module.exports = MinSVGCache