Completed
Pull Request — experimental/3.1 (#2517)
by Kiyotaka
34:45
created

Application::parseConfig()   B

Complexity

Conditions 5
Paths 16

Size

Total Lines 28
Code Lines 17

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 16
CRAP Score 5

Importance

Changes 0
Metric Value
cc 5
eloc 17
nc 16
nop 5
dl 0
loc 28
rs 8.439
c 0
b 0
f 0
ccs 16
cts 16
cp 1
crap 5
1
<?php
2
/*
3
 * This file is part of EC-CUBE
4
 *
5
 * Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
6
 *
7
 * http://www.lockon.co.jp/
8
 *
9
 * This program is free software; you can redistribute it and/or
10
 * modify it under the terms of the GNU General Public License
11
 * as published by the Free Software Foundation; either version 2
12
 * of the License, or (at your option) any later version.
13
 *
14
 * This program is distributed in the hope that it will be useful,
15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 * GNU General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU General Public License
20
 * along with this program; if not, write to the Free Software
21
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
 */
23
24
namespace Eccube;
25
26
use Doctrine\DBAL\Types\Type;
27
use Eccube\Doctrine\DBAL\Types\UTCDateTimeType;
28
use Eccube\Doctrine\DBAL\Types\UTCDateTimeTzType;
29
use Eccube\Doctrine\EventSubscriber\InitSubscriber;
30
use Eccube\Doctrine\ORM\Mapping\Driver\AnnotationDriver;
31
use Eccube\Entity\BaseInfo;
32
use Eccube\Plugin\ConfigManager as PluginConfigManager;
33
use Eccube\Routing\EccubeRouter;
34
use Eccube\ServiceProvider\CompatRepositoryProvider;
35
use Eccube\ServiceProvider\CompatServiceProvider;
36
use Eccube\ServiceProvider\DiServiceProvider;
37
use Eccube\ServiceProvider\EntityEventServiceProvider;
38
use Eccube\ServiceProvider\MobileDetectServiceProvider;
39
use Eccube\ServiceProvider\TwigLintServiceProvider;
40
use Sergiors\Silex\Routing\ChainUrlGenerator;
41
use Sergiors\Silex\Routing\ChainUrlMatcher;
42
use Symfony\Component\Dotenv\Dotenv;
43
use Symfony\Component\Finder\Finder;
44
use Symfony\Component\HttpFoundation\Request;
45
use Symfony\Component\HttpFoundation\Response;
46
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
47
use Symfony\Component\HttpKernel\KernelEvents;
48
49
class Application extends \Silex\Application
0 ignored issues
show
introduced by
Missing class doc comment
Loading history...
50
{
51
    use \Silex\Application\FormTrait;
52
    use \Silex\Application\UrlGeneratorTrait;
53
    use \Silex\Application\MonologTrait;
54
    use \Silex\Application\SwiftmailerTrait;
55
    use \Silex\Application\SecurityTrait;
56
    use \Silex\Application\TranslationTrait;
57
    use \Eccube\Application\ApplicationTrait;
58
    use \Eccube\Application\SecurityTrait;
59
    use \Eccube\Application\TwigTrait;
60
61
    protected static $instance;
62
63
    protected $initialized = false;
64
    protected $initializedPlugin = false;
65
    protected $testMode = false;
66
67 1091
    public static function getInstance(array $values = array())
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
68
    {
69 1091
        if (!is_object(self::$instance)) {
70 1091
            self::$instance = new Application($values);
71
        }
72
73 1091
        return self::$instance;
74
    }
75
76 1091
    public static function clearInstance()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
77
    {
78 1091
        self::$instance = null;
79
    }
80
81
    final public function __clone()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
82
    {
83
        throw new \Exception('Clone is not allowed against '.get_class($this));
84
    }
85
86 1092
    public function __construct(array $values = array())
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
87
    {
88 1092
        parent::__construct($values);
89
90 1092
        if (is_null(self::$instance)) {
91 1092
            self::$instance = $this;
92
        }
93
94
        // load config
95 1092
        $this->initConfig();
96
97
        // init monolog
98 1092
        $this->initLogger();
99
    }
100
101
    /**
102
     * Application::runが実行されているか親クラスのプロパティから判定
103
     *
104
     * @return bool
105
     */
106 1091
    public function isBooted()
107
    {
108 1091
        return $this->booted;
109
    }
110
111 1092
    public function initConfig()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
112
    {
113
        // load .env
114 1092
        $envFile = __DIR__.'/../../.env';
115 1092
        if (file_exists($envFile)) {
116
            (new Dotenv())->load($envFile);
117
        }
118
119
        // load config
120
        $this['config'] = function() {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after FUNCTION keyword; 0 found
Loading history...
121 1092
            $configAll = array();
122 1092
            $this->parseConfig('constant', $configAll)
123 1092
                ->parseConfig('path', $configAll)
124 1092
                ->parseConfig('config', $configAll)
125 1092
                ->parseConfig('database', $configAll)
126 1092
                ->parseConfig('mail', $configAll)
127 1092
                ->parseConfig('log', $configAll)
128 1092
                ->parseConfig('nav', $configAll, true)
129 1092
                ->parseConfig('doctrine_cache', $configAll)
130 1092
                ->parseConfig('http_cache', $configAll)
131 1092
                ->parseConfig('session_handler', $configAll);
132
133 1092
            return $configAll;
134
        };
135
    }
136
137 1092
    public function initLogger()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
138
    {
139 1092
        $app = $this;
140 1092
        $this->register(new ServiceProvider\LogServiceProvider($app));
0 ignored issues
show
Unused Code introduced by
The call to LogServiceProvider::__construct() has too many arguments starting with $app.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
141
    }
142
143 1091
    public function initialize()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
144
    {
145 1091
        if ($this->initialized) {
146 2
            return;
147
        }
148
149
        // init locale
150 1091
        $this->initLocale();
151
152
        // init session
153 1091
        if (!$this->isSessionStarted()) {
154 1091
            $this->initSession();
155
        }
156
157
        // init twig
158 1091
        $this->initRendering();
159
160
        // init provider
161 1091
        $this->register(new \Silex\Provider\HttpCacheServiceProvider(), array(
162 1091
            'http_cache.cache_dir' => __DIR__.'/../../app/cache/http/',
163
        ));
164 1091
        $this->register(new \Silex\Provider\HttpFragmentServiceProvider());
165 1091
        $this->register(new \Silex\Provider\FormServiceProvider());
166 1091
        $this->register(new \Silex\Provider\SerializerServiceProvider());
167 1091
        $this->register(new \Silex\Provider\ValidatorServiceProvider());
168 1091
        $this->register(new \Saxulum\Validator\Provider\SaxulumValidatorProvider());
169 1091
        $this->register(new MobileDetectServiceProvider());
170 1091
        $this->register(new TwigLintServiceProvider());
171
172
        $this->error(function (\Exception $e, Request $request, $code) {
173 23
            if ($this['debug']) {
174 23
                return;
175
            }
176
177
            switch ($code) {
178
                case 403:
179
                    $title = 'アクセスできません。';
180
                    $message = 'お探しのページはアクセスができない状況にあるか、移動もしくは削除された可能性があります。';
181
                    break;
182
                case 404:
183
                    $title = 'ページがみつかりません。';
184
                    $message = 'URLに間違いがないかご確認ください。';
185
                    break;
186
                default:
187
                    $title = 'システムエラーが発生しました。';
188
                    $message = '大変お手数ですが、サイト管理者までご連絡ください。';
189
                    break;
190
            }
191
192
            return $this->render('error.twig', array(
193
                'error_title' => $title,
194
                'error_message' => $message,
195
            ));
196 1091
        });
197
198
        // init mailer
199 1091
        $this->initMailer();
200
201 1091
        $this->register(new \Sergiors\Silex\Provider\DoctrineCacheServiceProvider());
202 1091
        $this->register(new \Sergiors\Silex\Provider\AnnotationsServiceProvider(), [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
203 1091
            'annotations.debug' => $this['debug'],
204
            'annotations.options' => [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
205 1091
                'cache_driver' => $this['debug'] ? 'array' : 'filesystem',
206 1091
                'cache_dir' => $this['debug'] ? null : __DIR__.'/../../app/cache/annotation'
207
            ]
208
        ]);
209
210
        // init doctrine orm
211 1091
        $this->initDoctrine();
212
213
        // Set up the DBAL connection now to check for a proper connection to the database.
214 1091
        $this->checkDatabaseConnection();
215
216
        // init security
217 1091
        $this->initSecurity();
218
219 1091
        $this->register(new \Sergiors\Silex\Provider\RoutingServiceProvider(), [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
220 1091
            'routing.cache_dir' => $this['debug'] ? null : __DIR__.'/../../app/cache/routing'
221
        ]);
222 1091
        $this->register(new \Sergiors\Silex\Provider\TemplatingServiceProvider());
223 1091
        $this->register(new \Sergiors\Silex\Provider\SensioFrameworkExtraServiceProvider(), [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
224 1091
            'request' => [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
225
                'auto_convert' => true
226
            ]
227
        ]);
228
        // init proxy
229 1091
        $this->initProxy();
230
231
        // init ec-cube service provider
232 1091
        $this->register(new DiServiceProvider(), [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
233
            'eccube.di.scanners' => [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
234 1091
                new \Eccube\Di\Scanner\ComponentScanner([
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
235 1091
                    $this['config']['root_dir'].'/app/Acme/Controller',
236 1091
                    $this['config']['root_dir'].'/src/Eccube/Controller'
237
                ]),
238 1091
                new \Eccube\Di\Scanner\FormTypeScanner([
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
239 1091
                    $this['config']['root_dir'].'/src/Eccube/Form/Type'
240
                ]),
241 1091
                new \Eccube\Di\Scanner\FormExtensionScanner([
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
242 1091
                    $this['config']['root_dir'].'/src/Eccube/Form/Extension'
243
                ]),
244 1091
                new \Eccube\Di\Scanner\ServiceScanner([
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
245 1091
                    $this['config']['root_dir'].'/src/Eccube/Service'
246
                ]),
247 1091
                new \Eccube\Di\Scanner\RepositoryScanner([
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
248 1091
                    $this['config']['root_dir'].'/src/Eccube/Repository'
249
                ]),
250 1091
                new \Eccube\Di\Scanner\QueryExtensionScanner([
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
251 1091
                    $this['config']['root_dir'].'/src/Eccube/Repository'
252
                ])
253
            ],
254 1091
            'eccube.di.generator.dir' => $this['config']['root_dir'].'/app/cache/provider'
255
        ]);
256
257 1091
        $this->register(new CompatRepositoryProvider());
258 1091
        $this->register(new CompatServiceProvider());
259 1091
        $this->register(new ServiceProvider\EccubeServiceProvider());
260
261 1091
        $this->register(new \Silex\Provider\ServiceControllerServiceProvider());
262 1091
        Request::enableHttpMethodParameterOverride(); // PUTやDELETEできるようにする
263
264
        // ルーティングの設定
265
        // TODO EccubeRoutingServiceProviderに移植する.
266 1091
        $app = $this;
267
        $this['eccube.router'] = $this->protect(function($resoure, $cachePrefix) use ($app) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after FUNCTION keyword; 0 found
Loading history...
268
            $options = [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
269 1091
                'debug' => $app['debug'],
270 1091
                'cache_dir' => $app['routing.cache_dir'],
271 1091
                'matcher_base_class' => $app['request_matcher_class'],
272 1091
                'matcher_class' => $app['request_matcher_class'],
273 1091
                'matcher_cache_class' => $cachePrefix.'UrlMatcher',
274 1091
                'generator_cache_class' => $cachePrefix.'UrlGenerator'
275
            ];
276 1091
            $router = new EccubeRouter(
277 1091
                $app['routing.loader'],
278 1091
                $resoure,
279 1091
                $options,
280 1091
                $app['request_context'],
281 1091
                $app['logger']
282
            );
283
284 1091
            $router->setAdminPrefix($app['config']['admin_route']);
285 1091
            $router->setUserDataPrefix($app['config']['user_data_route']);
286 1091
            $router->setRequireHttps($app['config']['force_ssl']);
287
288 1091
            return $router;
289 1091
        });
290
291
        $this['eccube.router.origin'] = function ($app) {
292 1091
            $resource = __DIR__.'/Controller';
293 1091
            $cachePrefix = 'Origin';
294
295 1091
            return $app['eccube.router']($resource, $cachePrefix);
296
        };
297
298
        $this['eccube.routers.plugin'] = function ($app) {
299
            // TODO 有効なプラグインを対象とする必要がある.
300 1091
            $dirs = Finder::create()
301 1091
                ->in($app['config']['root_dir'].'/app/Plugin')
302 1091
                ->name('Controller')
303 1091
                ->directories();
304
305 1091
            $routers = [];
306 1091
            foreach ($dirs as $dir) {
307 1091
                $realPath = $dir->getRealPath();
308 1091
                $pluginCode = basename(dirname($realPath));
309 1091
                $routers[] = $app['eccube.router']($realPath, 'Plugin'.$pluginCode);
310
            }
311
312 1091
            return $routers;
313
        };
314
315
        $this['eccube.router.extend'] = function ($app) {
316
            // TODO ディレクトリ名は暫定
317 1091
            $resource = $app['config']['root_dir'].'/app/Acme/Controller';
318 1091
            $cachePrefix = 'Extend';
319
320 1091
            $router = $app['eccube.router']($resource, $cachePrefix);
321
322 1091
            return $router;
323
        };
324
325 View Code Duplication
        $this->extend('request_matcher', function ($matcher, $app) {
326 1091
            $matchers = [];
327 1091
            $matchers[] = $app['eccube.router.extend'];
328 1091
            foreach ($app['eccube.routers.plugin'] as $router) {
329 1091
                $matchers[] = $router;
330
            };
331 1091
            $matchers[] = $app['eccube.router.origin'];
332 1091
            $matchers[] = $matcher;
333
334 1091
            return new ChainUrlMatcher($matchers, $app['request_context']);
335 1091
        });
336
337 View Code Duplication
        $this->extend('url_generator', function ($generator, $app) {
338 1091
            $generators = [];
339 1091
            $generators[] = $app['eccube.router.extend'];
340 1091
            foreach ($app['eccube.routers.plugin'] as $router) {
341 1091
                $generators[] = $router;
342
            };
343 1091
            $generators[] = $app['eccube.router.origin'];
344 1091
            $generators[] = $generator;
345
346 1091
            return new ChainUrlGenerator($generators, $app['request_context']);
347 1091
        });
348
349
        // Route CollectionにEC-CUBEで定義したルーティングを追加(debug tool barに出力するため)
350
        $this->extend('routes', function ($routes, $app) {
351 1091
            $routes->addCollection($app['eccube.router.extend']->getRouteCollection());
352 1091
            foreach ($app['eccube.routers.plugin'] as $router) {
353 1091
                $routes->addCollection($router->getRouteCollection());
354
            };
355 1091
            $routes->addCollection($app['eccube.router.origin']->getRouteCollection());
356
357 1091
            return $routes;
358 1091
        });
359
360
        // init http cache
361 1091
        $this->initCacheRequest();
362
363 1091
        $this->initialized = true;
364
    }
365
366 1091
    public function initLocale()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
367
    {
368
        // locale
369 1091
        if (!empty($this['config']['locale'])) {
370 1091
            \Locale::setDefault($this['config']['locale']);
371
        };
372
373
        // timezone
374 1091
        if (!empty($this['config']['timezone'])) {
375 1091
            date_default_timezone_set($this['config']['timezone']);
376
        }
377
378 1091
        $this->register(new \Silex\Provider\TranslationServiceProvider(), array(
379 1091
            'locale' => $this['config']['locale'],
380 1091
            'translator.cache_dir' => $this['debug'] ? null : $this['config']['root_dir'].'/app/cache/translator',
381
            'locale_fallbacks' => ['ja', 'en'],
382
        ));
383
        $this->extend('translator', function ($translator, \Silex\Application $app) {
384 1091
            $translator->addLoader('php', new \Symfony\Component\Translation\Loader\PhpFileLoader());
385
386 1091
            $file = __DIR__.'/Resource/locale/messages.'.$app['locale'].'.php';
387 1091
            if (file_exists($file)) {
388 1091
                $translator->addResource('php', $file, $app['locale']);
389 1091
                $translator->addResource('php', $file, $app['locale'], 'validators');
390
            }
391
392 1091
            return $translator;
393 1091
        });
394
    }
395
396 1091
    public function initSession()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
397
    {
398 1091
        $this->register(new \Silex\Provider\SessionServiceProvider(), array(
399 1091
            'session.storage.save_path' => $this['config']['root_dir'].'/app/cache/eccube/session',
400
            'session.storage.options' => array(
401 1091
                'name' => $this['config']['cookie_name'],
402 1091
                'cookie_path' => $this['config']['root_urlpath'] ?: '/',
403 1091
                'cookie_secure' => $this['config']['force_ssl'],
404 1091
                'cookie_lifetime' => $this['config']['cookie_lifetime'],
405
                'cookie_httponly' => true,
406
                // cookie_domainは指定しない
407
                // http://blog.tokumaru.org/2011/10/cookiedomain.html
408
            ),
409
        ));
410
411 1091
        $options = $this['config']['session_handler'];
412
413 1091
        if ($options['enabled']) {
414
            // @see http://silex.sensiolabs.org/doc/providers/session.html#custom-session-configurations
415
            $this['session.storage.handler'] = null;
416
            ini_set('session.save_handler', $options['save_handler']);
417
            ini_set('session.save_path', $options['save_path']);
418
        }
419
    }
420
421 1091
    public function initRendering()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
422
    {
423 1091
        $this->register(new \Silex\Provider\TwigServiceProvider(), array(
424 1091
            'twig.form.templates' => array('Form/form_layout.twig'),
425
        ));
426
        $this->extend('twig', function (\Twig_Environment $twig, \Silex\Application $app) {
427 1091
            $twig->addExtension(new \Eccube\Twig\Extension\EccubeExtension($app));
428 1091
            $twig->addExtension(new \Twig_Extension_StringLoader());
429
430 1091
            return $twig;
431 1091
        });
432
433
        $this->before(function (Request $request, \Silex\Application $app) {
434 315
            $app['admin'] = $app['front'] = false;
435 315
            $pathinfo = rawurldecode($request->getPathInfo());
436 315
            if (strpos($pathinfo, '/'.trim($app['config']['admin_route'], '/').'/') === 0) {
437 218
                $app['admin'] = true;
438
            } else {
439 97
                $app['front'] = true;
440
            }
441
442
            // フロント or 管理画面ごとにtwigの探索パスを切り替える.
443 315
            if ($app->isAdminRequest()) {
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Silex\Application as the method isAdminRequest() does only exist in the following sub-classes of Silex\Application: Eccube\Application, Eccube\InstallApplication. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
444 218
                if (file_exists(__DIR__.'/../../app/template/admin')) {
445 218
                    $paths[] = __DIR__.'/../../app/template/admin';
0 ignored issues
show
Coding Style Comprehensibility introduced by
$paths was never initialized. Although not strictly required by PHP, it is generally a good practice to add $paths = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
446
                }
447 218
                $paths[] = $app['config']['template_admin_realdir'];
0 ignored issues
show
Bug introduced by
The variable $paths does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
448 218
                $paths[] = __DIR__.'/../../app/Plugin';
449 218
                $cacheDir =  __DIR__.'/../../app/cache/twig/admin';
450
            } else {
451
                // モバイル端末時、smartphoneディレクトリを探索パスに追加する.
452 97
                if ($app['mobile_detect.device_type'] == \Eccube\Entity\Master\DeviceType::DEVICE_TYPE_SP) {
453
                    if (file_exists(__DIR__.'/../../app/template/smartphone')) {
454
                        $paths[] = __DIR__.'/../../app/template/smartphone';
455
                    }
456
                    $paths[] = __DIR__.'/Resource/template/smartphone';
457
                }
458
459 97
                if (file_exists($app['config']['template_realdir'])) {
460 97
                    $paths[] = $app['config']['template_realdir'];
461
                }
462 97
                $paths[] = $app['config']['template_default_realdir'];
463 97
                $paths[] = __DIR__.'/../../app/Plugin';
464 97
                $cacheDir =  __DIR__.'/../../app/cache/twig/'.$app['config']['template_code'];
465
            }
466 315
            $app['twig']->setCache($app['debug'] ? null : $cacheDir);
467 315
            $app['twig.loader']->addLoader(new \Twig_Loader_Filesystem($paths));
468
469
            // 管理画面のIP制限チェック.
470 315
            if ($app->isAdminRequest()) {
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Silex\Application as the method isAdminRequest() does only exist in the following sub-classes of Silex\Application: Eccube\Application, Eccube\InstallApplication. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
471
                // IP制限チェック
472 218
                $allowHost = $app['config']['admin_allow_host'];
473 218
                if (count($allowHost) > 0) {
474
                    if (array_search($app['request_stack']->getCurrentRequest()->getClientIp(), $allowHost) === false) {
475
                        throw new \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException();
476
                    }
477
                }
478
            }
479 1091
        }, self::EARLY_EVENT);
480
481
        // twigのグローバル変数を定義.
482
        $this->on(\Symfony\Component\HttpKernel\KernelEvents::CONTROLLER, function (\Symfony\Component\HttpKernel\Event\FilterControllerEvent $event) {
483
            // 未ログイン時にマイページや管理画面以下にアクセスするとSubRequestで実行されるため,
484
            // $event->isMasterRequest()ではなく、グローバル変数が初期化済かどうかの判定を行う
485 313
            if (isset($this['twig_global_initialized']) && $this['twig_global_initialized'] === true) {
486 71
                return;
487
            }
488
            // ショップ基本情報
489 313
            $this['twig']->addGlobal('BaseInfo', $this[BaseInfo::class]);
490
491 313
            if ($this->isAdminRequest()) {
492
                // 管理画面
493
                // 管理画面メニュー
494 218
                $menus = array('', '', '');
495 218
                $this['twig']->addGlobal('menus', $menus);
496
497 218
                $Member = $this->user();
498 218
                if (is_object($Member)) {
499
                    // ログインしていれば管理者のロールを取得
500 215
                    $AuthorityRoles = $this['eccube.repository.authority_role']->findBy(array('Authority' => $Member->getAuthority()));
501
502 215
                    $roles = array();
503 215
                    $request = $event->getRequest();
504 215
                    foreach ($AuthorityRoles as $AuthorityRole) {
505
                        // 管理画面でメニュー制御するため相対パス全てをセット
506 3
                        $roles[] = $request->getBaseUrl().'/'.$this['config']['admin_route'].$AuthorityRole->getDenyUrl();
507
                    }
508
509 218
                    $this['twig']->addGlobal('AuthorityRoles', $roles);
510
                }
511
0 ignored issues
show
Coding Style introduced by
Blank line found at end of control structure
Loading history...
512
            } else {
513
                // フロント画面
514 95
                $request = $event->getRequest();
515 95
                $route = $request->attributes->get('_route');
516
517
                // ユーザ作成画面
518 95
                if ($route === 'user_data') {
519 2
                    $params = $request->attributes->get('_route_params');
520 2
                    $route = $params['route'];
521
                    // プレビュー画面
522 93
                } elseif ($request->get('preview')) {
523
                    $route = 'preview';
524
                }
525
526
                try {
527 95
                    $device_type_id = $this['mobile_detect.device_type'];
528
529
                    // TODO デバッグ用
530 95
                    if ($request->query->has('device_type_id')) {
531
                        $device_type_id = $request->get('device_type_id', \Eccube\Entity\Master\DeviceType::DEVICE_TYPE_PC);
532
                    }
533
534 95
                    $DeviceType = $this['eccube.repository.master.device_type']
535 95
                        ->find($device_type_id);
536 95
                    $qb = $this['eccube.repository.page_layout']->createQueryBuilder('p');
537 95
                    $PageLayout = $qb->select('p, pll,l, bp, b')
538 95
                        ->leftJoin('p.PageLayoutLayouts', 'pll')
539 95
                        ->leftJoin('pll.Layout', 'l')
540 95
                        ->leftJoin('l.BlockPositions', 'bp')
541 95
                        ->leftJoin('bp.Block', 'b')
542 95
                        ->where('p.url = :route')
543 95
                        ->andWhere('l.DeviceType = :DeviceType')
544 95
                        ->orderBy('bp.block_row', 'ASC')
545 95
                        ->setParameter('route', $route)
546 95
                        ->setParameter('DeviceType', $DeviceType)
547 95
                        ->getQuery()
548 95
                        ->getSingleResult();
549 33
                } catch (\Doctrine\ORM\NoResultException $e) {
550 33
                    $PageLayout = $this['eccube.repository.page_layout']->newPageLayout($DeviceType);
0 ignored issues
show
Bug introduced by
The variable $DeviceType does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
551
                }
552
553 95
                $this['twig']->addGlobal('PageLayout', $PageLayout);
554 95
                $this['twig']->addGlobal('title', $PageLayout->getName());
555
            }
556
557 313
            $this['twig_global_initialized'] = true;
558 1091
        });
559
    }
560
561 1091
    public function initMailer()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
562
    {
563
564
        // メール送信時の文字エンコード指定(デフォルトはUTF-8)
565 1091
        if (isset($this['config']['mail']['charset_iso_2022_jp']) && is_bool($this['config']['mail']['charset_iso_2022_jp'])) {
566
            if ($this['config']['mail']['charset_iso_2022_jp'] === true) {
567
                \Swift::init(function () {
568
                    \Swift_DependencyContainer::getInstance()
569
                        ->register('mime.qpheaderencoder')
570
                        ->asAliasOf('mime.base64headerencoder');
571
                    \Swift_Preferences::getInstance()->setCharset('iso-2022-jp');
572
                });
573
            }
574
        }
575
576 1091
        $this->register(new \Silex\Provider\SwiftmailerServiceProvider());
577 1091
        $this['swiftmailer.options'] = $this['config']['mail'];
578
579 1091
        if (isset($this['config']['mail']['spool']) && is_bool($this['config']['mail']['spool'])) {
580 1091
            $this['swiftmailer.use_spool'] = $this['config']['mail']['spool'];
581
        }
582
        // デフォルトはsmtpを使用
583 1091
        $transport = $this['config']['mail']['transport'];
584 1091
        if ($transport == 'sendmail') {
585
            $this['swiftmailer.transport'] = \Swift_SendmailTransport::newInstance();
586 1091
        } elseif ($transport == 'mail') {
587
            $this['swiftmailer.transport'] = \Swift_MailTransport::newInstance();
588
        }
589
    }
590
591 1091
    public function initDoctrine()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
592
    {
593 1091
        $this->register(new EntityEventServiceProvider());
594 1091
        $this->register(new \Silex\Provider\DoctrineServiceProvider(), array(
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
595
            'dbs.options' => array(
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
596 1091
                'default' => $this['config']['database']
597
            )
598
        ));
599 1091
        $this->register(new \Saxulum\DoctrineOrmManagerRegistry\Provider\DoctrineOrmManagerRegistryProvider());
600
601 1091
        $app = $this;
602
        $this->extend('db.event_manager', function ($evm) use ($app) {
603 1091
            $initSubscriber = new InitSubscriber($app);
604 1091
            $evm->addEventSubscriber($initSubscriber);
605
606 1091
            return $evm;
607 1091
        });
608
609
        // UTCで保存
610
        // @see http://doctrine-orm.readthedocs.org/projects/doctrine-orm/en/latest/cookbook/working-with-datetime.html
611 1091
        UTCDateTimeType::setTimeZone($this['config']['timezone']);
612 1091
        UTCDateTimeTzType::setTimeZone($this['config']['timezone']);
613 1091
        Type::overrideType('datetime', UTCDateTimeType::class);
614 1091
        Type::overrideType('datetimetz', UTCDateTimeTzType::class);
615
616
        // プラグインのmetadata定義を合わせて行う.
617 1091
        $pluginConfigs = PluginConfigManager::getPluginConfigAll($this['debug']);
618 1091
        $ormMappings = array();
619 1091
        $ormMappings[] = array(
620
             'type' => 'annotation',
621
             'namespace' => 'Eccube\Entity',
622
             'path' => array(
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
623
                 __DIR__.'/Entity'
624
             ),
625
             'use_simple_annotation_reader' => false,
626
         );
627
628
        // TODO namespace は暫定
629 1091
        $ormMappings[] = array(
630
            'type' => 'annotation',
631
            'namespace' => 'Acme\Entity',
632
            'path' => array(
633
                __DIR__.'/../../app/Acme/Entity',
634
            ),
635
            'use_simple_annotation_reader' => false,
636
        );
637
638 1091
        foreach ($pluginConfigs as $code) {
639 1091
            $config = $code['config'];
640
            // Doctrine Extend
641 1091
            if (isset($config['orm.path']) && is_array($config['orm.path'])) {
642
                $paths = array();
643 View Code Duplication
                foreach ($config['orm.path'] as $path) {
644
                    $paths[] = $this['config']['plugin_realdir'].'/'.$config['code'].$path;
645
                }
646
                $ormMappings[] = array(
647
                    'type' => 'yml',
648
                    'namespace' => 'Plugin\\'.$config['code'].'\\Entity',
649
                    'path' => $paths,
650
                );
651
                $ormMappings[] = array(
652 1091
                    'type' => 'annotation',
653
                    'namespace' => 'Plugin\\'.$config['code'].'\\Entity',
654
                    'path' => $paths,
655
                    'use_simple_annotation_reader' => false,
656
                );
657
            }
658
        }
659
660
        $options = array(
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
661 1091
            'mappings' => $ormMappings
662
        );
663
664 1091
        if (!$this['debug']) {
665
            $cacheDrivers = array();
666
            if (array_key_exists('doctrine_cache', $this['config'])) {
667
                $cacheDrivers = $this['config']['doctrine_cache'];
668
            }
669
670
            if (array_key_exists('metadata_cache', $cacheDrivers)) {
671
                $options['metadata_cache'] = $cacheDrivers['metadata_cache'];
672
            }
673
            if (array_key_exists('query_cache', $cacheDrivers)) {
674
                $options['query_cache'] = $cacheDrivers['query_cache'];
675
            }
676
            if (array_key_exists('result_cache', $cacheDrivers)) {
677
                $options['result_cache'] = $cacheDrivers['result_cache'];
678
            }
679
            if (array_key_exists('hydration_cache', $cacheDrivers)) {
680
                $options['hydration_cache'] = $cacheDrivers['hydration_cache'];
681
            }
682
        }
683
684 1091
        $this->register(new \Dflydev\Provider\DoctrineOrm\DoctrineOrmServiceProvider(), array(
685 1091
            'orm.proxies_dir' => __DIR__.'/../../app/cache/doctrine/proxies',
686 1091
            'orm.em.options' => $options,
687
            'orm.custom.functions.string' => array(
688
                'NORMALIZE' => 'Eccube\Doctrine\ORM\Query\Normalize',
689
            ),
690
            'orm.custom.functions.numeric' => array(
691
                'EXTRACT' => 'Eccube\Doctrine\ORM\Query\Extract',
692
            ),
693
        ));
694
695 1091
        $this->extend(
696 1091
            'orm.em.config',
697
            function (\Doctrine\ORM\Configuration $config, \Silex\Application $app) {
698
699
                /** @var $chain \Doctrine\Common\Persistence\Mapping\Driver\MappingDriverChain */
700 1091
                $chain = $config->getMetadataDriverImpl();
701 1091
                $drivers = $chain->getDrivers();
702 1091
                foreach ($drivers as $namespace => $oldDriver) {
703 1091
                    if ('Eccube\Entity' === $namespace) {
704 1091
                        $newDriver = new AnnotationDriver(
705 1091
                            $app['annotations'],
706 1091
                            $oldDriver->getPaths());
707 1091
                        $newDriver->setFileExtension($oldDriver->getFileExtension());
708 1091
                        $newDriver->addExcludePaths($oldDriver->getExcludePaths());
709 1091
                        $newDriver->setTraitProxiesDirectory(
710 1091
                            realpath(__DIR__.'/../../app/proxy/entity'));
711 1091
                        $chain->addDriver($newDriver, $namespace);
712
                    }
713
                }
714
715 1091
                return $config;
716 1091
            }
717
        );
718
719
        $this->extend('orm.em', function (\Doctrine\ORM\EntityManager $em, \Silex\Application $app) {
720
            // save
721 1091
            $saveEventSubscriber = new \Eccube\Doctrine\EventSubscriber\SaveEventSubscriber($app);
0 ignored issues
show
Compatibility introduced by
$app of type object<Silex\Application> is not a sub-type of object<Eccube\Application>. It seems like you assume a child class of the class Silex\Application to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
722 1091
            $em->getEventManager()->addEventSubscriber($saveEventSubscriber);
723
724
            // clear cache
725 1091
            $clearCacheEventSubscriber = new \Eccube\Doctrine\EventSubscriber\ClearCacheEventSubscriber($app);
0 ignored issues
show
Compatibility introduced by
$app of type object<Silex\Application> is not a sub-type of object<Eccube\Application>. It seems like you assume a child class of the class Silex\Application to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
726 1091
            $em->getEventManager()->addEventSubscriber($clearCacheEventSubscriber);
727
728
            // filters
729 1091
            $config = $em->getConfiguration();
730 1091
            $config->addFilter("nostock_hidden", '\Eccube\Doctrine\Filter\NoStockHiddenFilter');
731 1091
            $config->addFilter("incomplete_order_status_hidden", '\Eccube\Doctrine\Filter\OrderStatusFilter');
732
733 1091
            return $em;
734 1091
        });
735
736 1091
        if (!$this['debug']) {
737
            // second level cacheの設定.
738
            $this->extend(
739
                'orm.em.config',
740
                function (\Doctrine\ORM\Configuration $config, \Silex\Application $app) {
0 ignored issues
show
Unused Code introduced by
The parameter $app is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
741
                    $config->setSecondLevelCacheEnabled();
742
                    $cacheConfig = $config->getSecondLevelCacheConfiguration();
743
                    $regionConfig = $cacheConfig->getRegionsConfiguration();
744
                    // TODO キャッシュ先は設定で切り替えられるように
745
                    $cache = $this['orm.cache.factory'](
746
                        'filesystem',
747
                        [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
748
                            'path' => __DIR__.'/../../app/cache/doctrine/second'
749
                        ]
750
                    );
751
                    $factory = new \Doctrine\ORM\Cache\DefaultCacheFactory($regionConfig, $cache);
752
                    $cacheConfig->setCacheFactory($factory);
753
754
                    return $config;
755
                }
756
            );
757
        }
758
    }
759
760 1091
    public function initSecurity()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
761
    {
762 1091
        $this->register(new \Silex\Provider\SecurityServiceProvider());
763 1091
        $this->register(new \Silex\Provider\CsrfServiceProvider());
764 1091
        $this->register(new \Silex\Provider\RememberMeServiceProvider());
765
766 1091
        $this['security.firewalls'] = array(
767 1091
            'admin' => array(
768 1091
                'pattern' => "^/{$this['config']['admin_route']}/",
769
                'form' => array(
770 1091
                    'login_path' => "/{$this['config']['admin_route']}/login",
771 1091
                    'check_path' => "/{$this['config']['admin_route']}/login_check",
772 1091
                    'username_parameter' => 'login_id',
773 1091
                    'password_parameter' => 'password',
774
                    'with_csrf' => true,
775
                    'use_forward' => true,
776
                ),
777
                'logout' => array(
778 1091
                    'logout_path' => "/{$this['config']['admin_route']}/logout",
779 1091
                    'target_url' => "/{$this['config']['admin_route']}/",
780
                ),
781 1091
                'users' => $this['orm.em']->getRepository('Eccube\Entity\Member'),
782
                'anonymous' => true,
783
            ),
784
            'customer' => array(
785 1091
                'pattern' => '^/',
786
                'form' => array(
787
                    'login_path' => '/mypage/login',
788
                    'check_path' => '/login_check',
789
                    'username_parameter' => 'login_email',
790
                    'password_parameter' => 'login_pass',
791
                    'with_csrf' => true,
792
                    'use_forward' => true,
793
                ),
794
                'logout' => array(
795
                    'logout_path' => '/logout',
796
                    'target_url' => '/',
797
                ),
798
                'remember_me' => array(
799 1091
                    'key' => sha1($this['config']['auth_magic']),
800 1091
                    'name' => $this['config']['cookie_name'].'_rememberme',
801
                    // lifetimeはデフォルトの1年間にする
802
                    // 'lifetime' => $this['config']['cookie_lifetime'],
803 1091
                    'path' => $this['config']['root_urlpath'] ?: '/',
804 1091
                    'secure' => $this['config']['force_ssl'],
805
                    'httponly' => true,
806
                    'always_remember_me' => false,
807 1091
                    'remember_me_parameter' => 'login_memory',
808
                ),
809 1091
                'users' => $this['orm.em']->getRepository('Eccube\Entity\Customer'),
810
                'anonymous' => true,
811
            ),
812
        );
813
814 1091
        $channel = null;
815
        // 強制SSL
816 1091
        if ($this['config']['force_ssl'] == \Eccube\Common\Constant::ENABLED) {
817
            $channel = "https";
818
        }
819
820 1091
        $this['security.access_rules'] = array(
821 1091
            array("^/{$this['config']['admin_route']}/login", 'IS_AUTHENTICATED_ANONYMOUSLY', $channel),
822 1091
            array("^/{$this['config']['admin_route']}/", 'ROLE_ADMIN', $channel),
823 1091
            array('^/mypage/login', 'IS_AUTHENTICATED_ANONYMOUSLY', $channel),
824 1091
            array('^/mypage/withdraw_complete', 'IS_AUTHENTICATED_ANONYMOUSLY', $channel),
825 1091
            array('^/mypage/change', 'IS_AUTHENTICATED_FULLY', $channel),
826 1091
            array('^/mypage', 'ROLE_USER', $channel),
827
        );
828
829
        $this['eccube.password_encoder'] = function ($app) {
830 1089
            return new \Eccube\Security\Core\Encoder\PasswordEncoder($app['config']);
831
        };
832
        $this['security.encoder_factory'] = function ($app) {
833 1089
            return new \Symfony\Component\Security\Core\Encoder\EncoderFactory(array(
834 1089
                'Eccube\Entity\Customer' => $app['eccube.password_encoder'],
835 1089
                'Eccube\Entity\Member' => $app['eccube.password_encoder'],
836
            ));
837
        };
838
        $this['eccube.event_listner.security'] = function ($app) {
839 1091
            return new \Eccube\EventListener\SecurityEventListener($app['orm.em']);
840
        };
841
842
        // Voterの設定
843
        $this['authority_voter'] = function ($app) {
844 1089
            return new \Eccube\Security\Voter\AuthorityVoter($app);
845
        };
846
847
        $this->extend('security.voters', function ($voters, \Silex\Application $app) {
848 1089
            $voters[] = $app['authority_voter'];
849
850 1089
            return $voters;
851 1091
        });
852
853
        $this['security.access_manager'] = function ($app) {
854 1089
            return new \Symfony\Component\Security\Core\Authorization\AccessDecisionManager($app['security.voters'], 'unanimous');
855
        };
856
857 1091
        $this->on(\Symfony\Component\Security\Http\SecurityEvents::INTERACTIVE_LOGIN, array($this['eccube.event_listner.security'], 'onInteractiveLogin'));
858
    }
859
860
    /**
861
     * ロードバランサー、プロキシサーバの設定を行う
862
     */
863 1091
    public function initProxy()
864
    {
865 1091
        $config = $this['config'];
866 1091
        if (isset($config['trusted_proxies_connection_only']) && !empty($config['trusted_proxies_connection_only'])) {
867
            $this->on(KernelEvents::REQUEST, function (GetResponseEvent $event) use ($config) {
868
                // サブリクエストのREMOTE_ADDRも動的に設定を行う必要があるため、KernelEvents::REQUESTを使用する
869
                Request::setTrustedProxies(array_merge(array($event->getRequest()->server->get('REMOTE_ADDR')), $config['trusted_proxies']));
870
            }, self::EARLY_EVENT);
871 1091 View Code Duplication
        } elseif (isset($config['trusted_proxies']) && !empty($config['trusted_proxies'])) {
872
            Request::setTrustedProxies($config['trusted_proxies']);
873
        }
874
    }
875
876 1089
    public function initializePlugin()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
877
    {
878 1089
        if ($this->initializedPlugin) {
879
            return;
880
        }
881 1089
        $this->register(new ServiceProvider\EccubePluginServiceProvider());
882
883
        // TODO Acme\ServiceProvider の初期化はここで OK?
884 1089
        if (array_key_exists('service',$this['config'])) {
0 ignored issues
show
introduced by
Add a single space after each comma delimiter
Loading history...
885
            foreach ($this['config']['service'] as $service) {
886
                $this->register(new $service);
0 ignored issues
show
introduced by
Use parentheses when instantiating classes
Loading history...
887
            }
888
        }
889 1089
        $this->initializedPlugin = true;
890
    }
891
892
    /**
893
     * PHPUnit を実行中かどうかを設定する.
894
     *
895
     * @param boolean $testMode PHPUnit を実行中の場合 true
896
     */
897 1081
    public function setTestMode($testMode)
898
    {
899 1081
        $this->testMode = $testMode;
900
    }
901
902
    /**
903
     * PHPUnit を実行中かどうか.
904
     *
905
     * @return boolean PHPUnit を実行中の場合 true
906
     */
907 315
    public function isTestMode()
908
    {
909 315
        return $this->testMode;
910
    }
911
912
    /**
913
     *
914
     * データベースの接続を確認
915
     * 成功 : trueを返却
916
     * 失敗 : \Doctrine\DBAL\DBALExceptionエラーが発生( 接続に失敗した場合 )、エラー画面を表示しdie()
917
     * 備考 : app['debug']がtrueの際は処理を行わない
918
     *
919
     * @return boolean true
920
     *
921
     */
922 1091
    protected function checkDatabaseConnection()
923
    {
924 1091
        if ($this['debug']) {
925 1091
            return;
926
        }
927
        try {
928
            $this['db']->connect();
929
        } catch (\Doctrine\DBAL\DBALException $e) {
930
            $this['monolog']->error($e->getMessage());
931
            $this['twig.path'] = array(__DIR__.'/Resource/template/exception');
932
            $html = $this['twig']->render('error.twig', array(
933
                'error_title' => 'データーベース接続エラー',
934
                'error_message' => 'データーベースを確認してください',
935
            ));
936
            $response = new Response();
937
            $response->setContent($html);
938
            $response->setStatusCode('500');
939
            $response->headers->set('Content-Type', 'text/html');
940
            $response->send();
941
            die();
0 ignored issues
show
Coding Style Compatibility introduced by
The method checkDatabaseConnection() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
942
        }
943
944
        return true;
945
    }
946
947
    /**
948
     * Config ファイルをパースし、連想配列を返します.
949
     *
950
     * $config_name.yml ファイルをパースし、連想配列を返します.
951
     * $config_name.php が存在する場合は、 PHP ファイルに記述された連想配列を使用します。
952
     *
953
     * @param string $config_name Config 名称
0 ignored issues
show
introduced by
Expected 2 spaces after parameter type; 1 found
Loading history...
954
     * @param array $configAll Config の連想配列
0 ignored issues
show
introduced by
Expected 3 spaces after parameter type; 1 found
Loading history...
introduced by
Expected 3 spaces after parameter name; 1 found
Loading history...
955
     * @param boolean $wrap_key Config の連想配列に config_name のキーを生成する場合 true, デフォルト false
0 ignored issues
show
introduced by
Expected 4 spaces after parameter name; 1 found
Loading history...
956
     * @param string $ymlPath config yaml を格納したディレクトリ
0 ignored issues
show
introduced by
Expected 2 spaces after parameter type; 1 found
Loading history...
introduced by
Expected 5 spaces after parameter name; 1 found
Loading history...
957
     * @param string $distPath config yaml dist を格納したディレクトリ
0 ignored issues
show
introduced by
Expected 2 spaces after parameter type; 1 found
Loading history...
introduced by
Expected 4 spaces after parameter name; 1 found
Loading history...
958
     * @return Application
959
     */
960 1092
    public function parseConfig($config_name, array &$configAll, $wrap_key = false, $ymlPath = null, $distPath = null)
0 ignored issues
show
introduced by
Declare public methods first, then protected ones and finally private ones
Loading history...
961
    {
962 1092
        $ymlPath = $ymlPath ? $ymlPath : __DIR__.'/../../app/config/eccube';
963 1092
        $distPath = $distPath ? $distPath : __DIR__.'/../../src/Eccube/Resource/config';
964
965 1092
        $config = [];
966 1092
        $config_php = $ymlPath.'/'.$config_name.'.php';
967 1092
        if (file_exists($config_php)) {
968 1092
            $config = require $config_php;
969
        }
970
971
        // `%ROOT_DIR%`を絶対パスに変換
972 1092
        $rootDir = realpath(__DIR__.'/../../');
973
        array_walk($config, function(&$value) use ($rootDir) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after FUNCTION keyword; 0 found
Loading history...
974 1092
            $value = str_replace('%ROOT_DIR%', $rootDir, $value);
975 1092
        });
976
977 1092
        $config_php_dist = $distPath.'/'.$config_name.'.php';
978 1092
        $config_dist = require $config_php_dist;
979
980 1092
        if ($wrap_key) {
981 1092
            $configAll = array_replace_recursive($configAll, array($config_name => $config_dist), array($config_name => $config));
982
        } else {
983 1092
            $configAll = array_replace_recursive($configAll, $config_dist, $config);
984
        }
985
986 1092
        return $this;
987
    }
988
989
    /**
990
     * セッションが開始されているかどうか.
991
     *
992
     * @return boolean セッションが開始済みの場合 true
993
     * @link http://php.net/manual/ja/function.session-status.php#113468
994
     */
995 1091
    protected function isSessionStarted()
996
    {
997 1091
        if (php_sapi_name() !== 'cli') {
998 1091
            if (version_compare(phpversion(), '5.4.0', '>=')) {
999 1091
                return session_status() === PHP_SESSION_ACTIVE ? true : false;
1000
            } else {
1001
                return session_id() === '' ? false : true;
1002
            }
1003
        }
1004
1005
        return false;
1006
    }
1007
1008
    /**
1009
     * Http Cache対応
1010
     */
1011 1091
    protected function initCacheRequest()
1012
    {
1013
        // httpキャッシュが無効の場合はイベント設定を行わない.
1014 1091
        if (!$this['config']['http_cache']['enabled']) {
1015 1091
            return;
1016
        }
1017
1018
        $app = $this;
1019
1020
        // Response Event(http cache対応、event実行は一番遅く設定)
1021
        $this->on(\Symfony\Component\HttpKernel\KernelEvents::RESPONSE, function (\Symfony\Component\HttpKernel\Event\FilterResponseEvent $event) use ($app) {
1022
1023
            if (!$event->isMasterRequest()) {
1024
                return;
1025
            }
1026
1027
            $request = $event->getRequest();
1028
            $response = $event->getResponse();
1029
1030
            $route = $request->attributes->get('_route');
1031
1032
            $etag = md5($response->getContent());
1033
1034
            if (strpos($route, 'admin') === 0) {
1035
                // 管理画面
1036
1037
                // 管理画面ではコンテンツの中身が変更された時点でキャッシュを更新し、キャッシュの適用範囲はprivateに設定
1038
                $response->setCache(array(
1039
                    'etag' => $etag,
1040
                    'private' => true,
1041
                ));
1042
1043
                if ($response->isNotModified($request)) {
1044
                    return $response;
1045
                }
1046
0 ignored issues
show
Coding Style introduced by
Blank line found at end of control structure
Loading history...
1047
            } else {
1048
                // フロント画面
1049
                $cacheRoute = $app['config']['http_cache']['route'];
1050
1051
                if (in_array($route, $cacheRoute) === true) {
1052
                    // キャッシュ対象となる画面lが含まれていた場合、キャッシュ化
1053
                    // max-ageを設定しているためExpiresは不要
1054
                    // Last-Modifiedだと比較する項目がないためETagで対応
1055
                    // max-ageを設定していた場合、contentの中身が変更されても変更されない
1056
1057
                    $age = $app['config']['http_cache']['age'];
1058
1059
                    $response->setCache(array(
1060
                        'etag' => $etag,
1061
                        'max_age' => $age,
1062
                        's_maxage' => $age,
1063
                        'public' => true,
1064
                    ));
1065
1066
                    if ($response->isNotModified($request)) {
1067
                        return $response;
1068
                    }
1069
                }
1070
            }
1071
1072
        }, -1024);
1073
    }
1074
}
1075