Passed
Push — master ( 7a25e0...ec01b3 )
by Pierre
15:14 queued 10s
created

Factory::buildErrorMessage()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 23
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 15
c 1
b 0
f 0
dl 0
loc 23
rs 9.7666
cc 2
nc 2
nop 1
1
<?php
2
3
/**
4
 * Pickle
5
 *
6
 *
7
 * @license
8
 *
9
 * New BSD License
10
 *
11
 * Copyright © 2015-2015, Pickle community. All rights reserved.
12
 *
13
 * Redistribution and use in source and binary forms, with or without
14
 * modification, are permitted provided that the following conditions are met:
15
 *     * Redistributions of source code must retain the above copyright
16
 *       notice, this list of conditions and the following disclaimer.
17
 *     * Redistributions in binary form must reproduce the above copyright
18
 *       notice, this list of conditions and the following disclaimer in the
19
 *       documentation and/or other materials provided with the distribution.
20
 *     * Neither the name of the Hoa nor the names of its contributors may be
21
 *       used to endorse or promote products derived from this software without
22
 *       specific prior written permission.
23
 *
24
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34
 * POSSIBILITY OF SUCH DAMAGE.
35
 */
36
37
namespace Pickle\Base\Archive;
38
39
use RuntimeException;
40
41
class Factory
42
{
43
    /**
44
     * Get the fully-qualified name of a class implementing the Zipper interface
45
     *
46
     * @throws \RuntimeException if no zipper is available.
47
     */
48
    public static function getZipperClassName(): string
49
    {
50
        if (static::isInfozipZipAvailable()) {
51
            return InfozipZipper::class;
52
        }
53
        if (static::isZipExtensionAvailable()) {
54
            return PHPZipper::class;
55
        }
56
        throw new RuntimeException(self::buildErrorMessage('zip'));
57
    }
58
59
    /**
60
     * Get the fully-qualified name of a class implementing the Unzipper interface
61
     *
62
     * @throws \RuntimeException if no zipper is available.
63
     */
64
    public static function getUnzipperClassName(): string
65
    {
66
        if (static::isInfozipUnzipAvailable()) {
67
            return InfozipUnzipper::class;
68
        }
69
        if (static::isZipExtensionAvailable()) {
70
            return PHPUnzipper::class;
71
        }
72
        throw new RuntimeException(self::buildErrorMessage('unzip'));
73
    }
74
75
    public static function isZipExtensionAvailable(): bool
76
    {
77
        return extension_loaded('zip');
78
    }
79
80
    public static function isInfozipZipAvailable(): bool
81
    {
82
        $output = [];
83
        $rc = -1;
84
        exec('zip -v 2>&1', $output, $rc);
85
        return $rc === 0 && preg_match('/info.?zip/i', $output[0] ?? '');
86
    }
87
88
    public static function isInfozipUnzipAvailable(): bool
89
    {
90
        $output = [];
91
        $rc = -1;
92
        exec('unzip -v 2>&1', $output, $rc);
93
        return $rc === 0 && preg_match('/info.?zip/i', $output[0] ?? '');
94
    }
95
96
    private static function buildErrorMessage(string $command): string
97
    {
98
        $message = <<<EOT
99
No support for ZIP files has been detected.
100
You have two options:
101
1. enable the zip PHP extension
102
2. install the {$command} system command
103
104
EOT
105
        ;
106
        if (DIRECTORY_SEPARATOR === '\\') {
107
            $message .= "You can find the Windows {$command}.exe program at the following address:\nftp://ftp.info-zip.org/pub/infozip/win32/";
108
        } else {
109
            $message .= <<<EOT
110
For example, to install the {$command} command you may try to run
111
apt-get install {$command}
112
or
113
apk add {$command}
114
EOT
115
            ;
116
        }
117
118
        return $message;
119
    }
120
}
121
122
/* vim: set tabstop=4 shiftwidth=4 expandtab: fdm=marker */
123