web-build-optimizer /lib/compressor.class.php

Language PHP Lines 512
MD5 Hash fef9b9d5ff2f38df75998fe88dba1081 Estimated Cost $6,647 (why?)
Repository https://bitbucket.org/ardydedase/web-build-optimizer.git View Raw File View Project SPDX
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
<?php
/**
 * Abstract Compressor class
 * this class is dependent on the AWS SDK
 * 
 */
abstract class Compressor
{
    // CompressorType
    protected $_compressor_script;    
    protected $_file_type; 
    
    
    /**
     * This method will call the appropriate compress method
     * 
     * @param type $input
     * @param type $output 
     */
    public function perform_compression($input)
    {
        if(isset($input))
        {
            return $this->_compressor_script->compress($input);    
        }
        else 
        {
            echo "nothing to compress\n";
        }
        
    }
    
    /**
     * Generate hashed filename with with its "date modified" string
     * 
     * @param type $input
     * @param type $file_type
     * @param type $prefix
     * @return type 
     */
    public static function generate_filename($input, $file_type, $prefix = 'x-')
    {
        echo __METHOD__;
        echo PHP_EOL . 'input: ' . $input . PHP_EOL;
        
        $last_changed = date("F d Y H:i:s.", filemtime($input));
        
        // use the relative file path instead to easily test it.
        $relative_file_path = str_replace(Config::$resources_path, '', $input);        
        
        return $prefix . md5($relative_file_path . $last_changed) . '.' . $file_type;        
    }
    
    public static function sync_to_build()
    {        
        $source_path = Config::$source_path;
        $build_path = Config::$build_path;
        
        echo PHP_EOL . 'Synching to the target build path.' . PHP_EOL;
        // sync the required build folders, exclude folders that are not needed
        // $cmd = "sh $source_path/build_rsync.sh $source_path/. $build_path";
        $cmd = sprintf('sh %s %s/. %s', Config::$build_rsync, $source_path, $build_path);
        echo $cmd . PHP_EOL;
        $shell_output = shell_exec($cmd);
        
        echo 'shell s' . PHP_EOL;
        var_dump($shell_output);
    }
}

/**
 * JSCompressor
 */
class JSCompressor extends Compressor
{
    public function __construct()
    {
        $this->_compressor_script = new ClosureCompiler();
        
        // set the file type
        $this->_file_type = JS_FILETYPE; 
    }
}

/**
 * CSSCompressor
 */
class CSSCompressor extends Compressor
{
    public function __construct() 
    {
        $this->_compressor_script = new YUICompressor();
        $this->_file_type = CSS_FILETYPE;
    }
}

/**
 * HTMLCompressor
 */

class TemplateCompressor extends Compressor
{
    public function __construct() 
    {
        $this->_compressor_script = new HTMLCompressor();
        $this->_file_type = HTML_FILETYPE;
    }
}

/**
 * PNGCompressor
 * 
 */

class PNGCompressor extends Compressor
{
    public function __construct() 
    {
        $this->_compressor_script = new PNGOut();
        //$this->_file_type;
    }
}

/**
 * GZip Compressor
 * 
 */

class GZipCompressor extends Compressor
{
    public function __construct() 
    {
        $this->_compressor_script = new GZip();
    }
}

/**
 * CompressorScript interface makes sure that our compression classes are uniform 
 * and easier to maintain
 * 
 */
interface CompressorScript
{
    public function compress($input);
    public function prepare_input($input);
    public function prepare_output($input, $ext='');
    //public function generate_
}


class ClosureCompiler implements CompressorScript
{    
    /**
     * Compress using Google Closure Compiler.
     * 
     * @param type $input
     * @param type $output 
     */
    public function compress($input)
    {
        $output = $this->prepare_output($input);        
        $input = $this->prepare_input($input);
        
        $compressor = Config::$closure_compiler;
        $output_full_path = Config::$compressed_resources_path . '/' . JS_FILETYPE . '/' . $output;        
        
        if(file_exists($output_full_path))
        {
            echo PHP_EOL . "Skipping $output_full_path. This file was already compressed." . PHP_EOL;
            
            // do nothing if file already exists
            return $output;
        }
        
        
        $cmd = Config::$java . " -jar $compressor $input --js_output_file $output_full_path";
        $cmd = escapeshellcmd($cmd);
        
        
        echo 'executing: ' . $cmd . PHP_EOL;        
        exec($cmd, $cmd_output);
        
        // TODO: checker to verify whether the compression was successful
        
        
        return $output;

    }
    
    /**
     * Use this to pre-format/prepare the input parameters for Google Closure Compiler.
     * Different compression methods require different input params
     * 
     * 
     * @param type $input
     * @return type 
     */
    public function prepare_input($input)
    {
        echo __METHOD__ . PHP_EOL;
        
        var_dump($input);
        
        echo PHP_EOL;
        
        foreach ($input as $i) 
        {            
            $res[] = '--js ' . $i;
        }
        
        $js_input = implode(' ', $res);
        
        return $js_input;

    }
    
    public function prepare_output($input, $ext=JS_FILETYPE)
    {
        $combined_str = '';
        
        foreach ($input as $file) 
        {
            $combined_str .= Compressor::generate_filename($file, JS_FILETYPE, 'm-');
        }        
        
        return 'm-' . md5($combined_str) . '.js';
        
    }
}

class YUICompressor implements CompressorScript
{    
    /**
     * Compress using YUICompressor
     * 
     * @param type $input
     * @param type $output 
     */
    public function compress($input)
    {        
        $output = $this->prepare_output($input);
        
        $input = $this->prepare_input($input);
        
        $compressor = Config::$yui_compressor;
        $output_full_path = Config::$compressed_resources_path . '/' . CSS_FILETYPE . '/' . $output;
        
        if(file_exists($output_full_path))
        {
            echo PHP_EOL . "Skipping $output_full_path. This file was already compressed." . PHP_EOL;
            
            // do nothing if file already exists
            return $output;
        }        

        $cmd = Config::$java . " -jar $compressor $input --type css > $output_full_path";
        //$cmd = escapeshellcmd($cmd);
        echo 'executing: ' . $cmd . PHP_EOL;        

        exec($cmd, $cmd_output);            
        
        // TODO: checker to verify whether the compression was successful
        
        // when we're done, delete the temporary css file in /tmp folder        
        if (unlink($input))
        {
            return $output;
        }

    }
    
    /**
     * Use this to pre-format/prepare the input parameters for Google Closure Compiler.
     * Different compression methods require different input params
     * 
     * 
     * @param type $input
     * @return type 
     */
    public function prepare_input($input)
    {
        $combined_contents = '';
        
        foreach ($input as $file)
        {
            $combined_contents .= file_get_contents($file);
        }
        
        $temp_file = TMP . '/css-' . md5($combined_contents) . '.css';
        
        if (file_put_contents($temp_file, $combined_contents))
        {
            return $temp_file;
            
        }
        
        return false;

    }
    
    public function prepare_output($input, $ext=CSS_FILETYPE)
    {
        $combined_str = '';
        
        foreach ($input as $file) 
        {
            $combined_str .= Compressor::generate_filename($file, CSS_FILETYPE, 'm-');
        }        
        
        return 'm-' . md5($combined_str) . '.' . CSS_FILETYPE;
        
    }

}

class HTMLCompressor implements CompressorScript
{
    
    /**
     * Compress using htmlcompressor
     * http://code.google.com/p/htmlcompressor/wiki/Documentation
     * 
     * @param type $input
     * @return type $output 
     */
    public function compress($input)
    {
        // do nothing if input file doesn't exist
        if (!file_exists($input))
        {
            return false;
        }
        
        $output = $this->prepare_output($input);
        
        $input = $this->prepare_input($input);
        
        $compressor = Config::$html_compressor;
        
        $cmd = Config::$java . " -jar $compressor -o $output --type html --compress-js --compress-css --remove-intertag-spaces $input";
        
        //$cmd = escapeshellcmd($cmd);
        echo 'executing: ' . $cmd . PHP_EOL; 

        exec($cmd, $cmd_output);            
        
        return $output;
    }
    
    /**
     * Use this to pre-format/prepare the input parameters for Google Closure Compiler.
     * Different compression methods require different input params
     * 
     * 
     * @param type $input
     * @return type 
     */
    public function prepare_input($input)
    {
        return $input;

    }
    
    public function prepare_output($input, $ext='')
    {
        // do nothing here..
        return $input;
    }     
    
}

class PNGOut implements CompressorScript
{
    /**
     * Disable compression for now to save time.
     * 
     * @param type $input
     * @return string 
     */
    public function compress($input)
    {
        if (!file_exists($input))
        {
            return false;            
        }
        
        // get extension
        $ext = pathinfo($input, PATHINFO_EXTENSION);
                
        $output = $this->prepare_output($input, $ext);
        
        $input = $this->prepare_input($input);
        
        $output_full_path = Config::$compressed_resources_path . '/' . IMG_FILE . '/' . $output;                
        
        $compressed_image = IMG_FILE . '/' . $output;
        
        if (file_exists($output_full_path))
        {
            echo PHP_EOL . "Skipping $output_full_path. This file was not changed." . PHP_EOL;
            
            // do nothing if file already exists
            return $compressed_image;
        }
        
        // get the operating system and machine
        $os = php_uname('s');
        $machine = php_uname('m');
        
        // skip compression for now until we find a faster and better png compression tool
        
        /*
        // set the pngout script path based on its environment
        $pngout_subpath = ('Darwin' === $os) ? $os : "$os/$machine";
        
        $pngout = SCRIPTS_PATH . '/' . $pngout_subpath . '/' . Compressor::PNG_COMPRESSOR;
            
        echo PHP_EOL . 'Compressing: ' . $input . PHP_EOL;                
        perform compression using pngout
        exec($pngout . ' ' . $input . ' ' . $output_full_path . ' -y');         
        */

        // just copy the entire file to the output folder
        if (copy($input, $output_full_path))
        {
            return $compressed_image;
        }        
        else 
        {
            return false;
        }
        
    }
    
    /**
     * Use this to pre-format/prepare the input parameters for Google Closure Compiler.
     * Different compression methods require different input params
     * 
     * @param type $input
     * @return type 
     */
    public function prepare_input($input)
    {
        return $input;

    }        
    
    public function prepare_output($input, $ext=PNG_FILETYPE)
    {
        return Compressor::generate_filename($input, $ext, 'm-');
    }     
}

class GZip implements CompressorScript
{
    /**
     * Disable compression for now to save time.
     * 
     * @param type $input
     * @return string 
     */
    public function compress($input)
    {
        // gzip compress each file with the .gz extension on each of them
        foreach ($input as $file_to_compress)
        {   
            $cmd = GZIP . " -c $file_to_compress > $file_to_compress.gz";
            echo "running: $cmd\n";
            $shell_out = shell_exec($cmd);
            echo 'gzip result: ';
            var_dump($shell_out);
        }
        
        // remove the .gz extension and overwrite the existing files, after making sure
        // that the files were successfully gzipped
        
        foreach ($input as $compressed_file)
        {
            if (true === copy($compressed_file . ".gz", $compressed_file))
            {
                // delete the gz file if successfully copied
                if (unlink($compressed_file . ".gz"))
                {
                    echo "successfully deleted $compressed_file.gz file";
                }
                
            }
            else
            {
                echo "something went wrong while copying the file and overwriting the original: $compressed_file";
            }
        }
    }
    
    /**     
     * Different compression methods require different input params
     * Use this to pre-format/prepare the input parameters for Google Closure Compiler.
     * 
     * @param type $input
     * @return type 
     */
    public function prepare_input($input)
    {
        return $input;

    }        
    
    public function prepare_output($input, $ext=PNG_FILETYPE)
    {
        return Compressor::generate_filename($input, $ext, 'm-');
    }     
}
Back to Top