Eccube\Controller\Admin\Store\TemplateController

Complexity

Total Complexity

22

Size/Duplication

Total Lines	279
Duplicated Lines	2.87 %

Coupling/Cohesion

Components	0
Dependencies	11

Test Coverage

Coverage

12.08%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	index()	8	52	7
A	download()	0	62	3
B	delete()	0	44	4
C	add()	0	100	8

<?php
/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

namespace Eccube\Controller\Admin\Store;

use Eccube\Application;
use Eccube\Controller\AbstractController;
use Eccube\Entity\Master\DeviceType;
use Eccube\Form\Type\Admin\TemplateType;
use Eccube\Util\Str;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
use Symfony\Component\Form\FormError;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Yaml\Yaml;

class TemplateController extends AbstractController

Missing class doc comment

{

    /**
     * テンプレート一覧画面
     *
     * @param Application $app
     * @param Request $request

Expected 5 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    public function index(Application $app, Request $request)
    {

        $DeviceType = $app['eccube.repository.master.device_type']
            ->find(DeviceType::DEVICE_TYPE_PC);

        $Templates = $app['eccube.repository.template']
            ->findBy(array('DeviceType' => $DeviceType));

        $form = $app->form()
            ->add('selected', HiddenType::class)
            ->getForm();

        if ('POST' === $request->getMethod()) {
            $form->handleRequest($request);
            if ($form->isValid()) {
                $Template = $app['eccube.repository.template']
                    ->find($form['selected']->getData());

                // path.(yml|php)の再構築
                $file = $app['config']['root_dir'].'/app/config/eccube/path';
                if (file_exists($file.'.php')) {

This code seems to be duplicated across your project.

                    $config = require $file.'.php';
                } elseif (file_exists($file.'.yml')) {
                    $config = Yaml::parse(file_get_contents($file.'.yml'));
                }

                $templateCode = $Template->getCode();
                $config['template_code'] = $templateCode;

The variable $config does not seem to be defined for all execution paths leading up to this point.

                $config['template_realdir'] = $config['root_dir'].'/app/template/'.$templateCode;
                $config['template_html_realdir'] = $config['public_path_realdir'].'/template/'.$templateCode;
                $config['front_urlpath'] = $config['root_urlpath'].RELATIVE_PUBLIC_DIR_PATH.'/template/'.$templateCode;
                $config['block_realdir'] =$config['template_realdir'].'/Block';

                if (file_exists($file.'.php')) {

This code seems to be duplicated across your project.

                    file_put_contents($file.'.php', sprintf('<?php return %s', var_export($config, true)).';');
                }
                if (file_exists($file.'.yml')) {
                    file_put_contents($file.'.yml', Yaml::dump($config));
                }

                $app->addSuccess('admin.content.template.save.complete', 'admin');

                return $app->redirect($app->url('admin_store_template'));
            }
        }

        return $app->render('Store/template.twig', array(
            'form' => $form->createView(),
            'Templates' => $Templates,
        ));
    }

    /**

Doc comment for parameter "$id" missing

     * テンプレート一覧からのダウンロード
     *
     * @param Application $app
     * @param Request $request

Expected 5 spaces after parameter type; 1 found

     * @param $id

Missing parameter name

     */

Missing @return tag in function comment

    public function download(Application $app, Request $request, $id)

The parameter $request is not used and could be removed.

    {
        /** @var $Template \Eccube\Entity\Template */
        $Template = $app['eccube.repository.template']->find($id);

        if (!$Template) {
            throw new NotFoundHttpException();
        }

        // 該当テンプレートのディレクトリ
        $config = $app['config'];
        $templateCode = $Template->getCode();
        $targetRealDir = $config['root_dir'] . '/app/template/' . $templateCode;

Concat operator must not be surrounded by spaces

        $targetHtmlRealDir = $config['root_dir'] . '/html/template/' . $templateCode;

Concat operator must not be surrounded by spaces

        // 一時ディレクトリ
        $uniqId = sha1(Str::random(32));
        $tmpDir = $config['template_temp_realdir'] . '/' . $uniqId;

Concat operator must not be surrounded by spaces

        $appDir = $tmpDir . '/app';

Concat operator must not be surrounded by spaces

        $htmlDir = $tmpDir . '/html';

Concat operator must not be surrounded by spaces

        // ファイル名
        $tarFile = $config['template_temp_realdir'] . '/' . $uniqId . '.tar';

Concat operator must not be surrounded by spaces

        $tarGzFile = $tarFile . '.gz';

Concat operator must not be surrounded by spaces

        $downloadFileName = $Template->getCode() . '.tar.gz';

Concat operator must not be surrounded by spaces

        // 該当テンプレートを一時ディレクトリへコピーする.
        $fs = new Filesystem();
        $fs->mkdir(array($appDir, $htmlDir));
        $fs->mirror($targetRealDir, $appDir);
        $fs->mirror($targetHtmlRealDir, $htmlDir);

        // tar.gzファイルに圧縮する.
        $phar = new \PharData($tarFile);
        $phar->buildFromDirectory($tmpDir);
        // appディレクトリがない場合は, 空ディレクトリを追加
        // @see https://github.com/EC-CUBE/ec-cube/issues/742
        if (empty($phar['app'])) {
            $phar->addEmptyDir('app');
        }
        $phar->compress(\Phar::GZ);

        // ダウンロード完了後にファイルを削除する.
        // http://stackoverflow.com/questions/15238897/removing-file-after-delivering-response-with-silex-symfony
        $app->finish(function (Request $request, Response $response, \Silex\Application $app) use (

Multi-line function declarations must define one parameter per line

            $tmpDir,
            $tarFile,
            $tarGzFile
        ) {

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 8.

            $app['monolog']->addDebug('remove temp file: ' . $tmpDir);

Concat operator must not be surrounded by spaces

            $app['monolog']->addDebug('remove temp file: ' . $tarFile);

Concat operator must not be surrounded by spaces

            $app['monolog']->addDebug('remove temp file: ' . $tarGzFile);

Concat operator must not be surrounded by spaces

            $fs = new Filesystem();
            $fs->remove($tmpDir);
            $fs->remove($tarFile);
            $fs->remove($tarGzFile);
        });

        return $app
            ->sendFile($tarGzFile)
            ->setContentDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, $downloadFileName);
    }

    public function delete(Application $app, Request $request, $id)

The parameter $request is not used and could be removed.

Missing function doc comment

    {
        $this->isTokenValid($app);

        /** @var $Template \Eccube\Entity\Template */
        $Template = $app['eccube.repository.template']->find($id);

        if (!$Template) {
            $app->deleteMessage();
            return $app->redirect($app->url('admin_store_template'));

Missing blank line before return statement

        }

        // デフォルトテンプレート
        if ($Template->isDefaultTemplate()) {
            $app->addError('admin.content.template.delete.default.error', 'admin');

            return $app->redirect($app->url('admin_store_template'));
        }

        // 設定中のテンプレート
        if ($app['config']['template_code'] === $Template->getCode()) {
            $app->addError('admin.content.template.delete.current.error', 'admin');

            return $app->redirect($app->url('admin_store_template'));
        }

        // テンプレートディレクトリの削除
        $config = $app['config'];
        $templateCode = $Template->getCode();
        $targetRealDir = $config['root_dir'] . '/app/template/' . $templateCode;

Concat operator must not be surrounded by spaces

        $targetHtmlRealDir = $config['root_dir'] . '/html/template/' . $templateCode;

Concat operator must not be surrounded by spaces

        $fs = new Filesystem();
        $fs->remove($targetRealDir);
        $fs->remove($targetHtmlRealDir);

        // テーブルからも削除
        $app['orm.em']->remove($Template);
        $app['orm.em']->flush();

        $app->addSuccess('admin.content.template.delete.complete', 'admin');

        return $app->redirect($app->url('admin_store_template'));
    }

    public function add(Application $app, Request $request)

Missing function doc comment

    {
        /** @var $Template \Eccube\Entity\Template */
        $Template = new \Eccube\Entity\Template();

        $form = $app['form.factory']
            ->createBuilder(TemplateType::class, $Template)
            ->getForm();

        if ('POST' === $request->getMethod()) {
            $form->handleRequest($request);

            if ($form->isValid()) {

                /** @var $Template \Eccube\Entity\Template */
                $tem = $app['eccube.repository.template']
                    ->findByCode($form['code']->getData());

                // テンプレートコードの重複チェック.
                if ($tem) {
                    $form['code']->addError(new FormError('すでに登録されているテンプレートコードです。'));

                    return false;
                }

                // 該当テンプレートのディレクトリ
                $config = $app['config'];
                $templateCode = $Template->getCode();
                $targetRealDir = $config['root_dir'] . '/app/template/' . $templateCode;

Concat operator must not be surrounded by spaces

                $targetHtmlRealDir = $config['root_dir'] . '/html/template/' . $templateCode;

Concat operator must not be surrounded by spaces

                // 一時ディレクトリ
                $uniqId = sha1(Str::random(32));
                $tmpDir = $config['template_temp_realdir'] . '/' . $uniqId;

Concat operator must not be surrounded by spaces

                $appDir = $tmpDir . '/app';

Concat operator must not be surrounded by spaces

                $htmlDir = $tmpDir . '/html';

Concat operator must not be surrounded by spaces

                $formFile = $form['file']->getData();
                // ファイル名
                $archive = $templateCode . '.' . $formFile->getClientOriginalExtension();

Concat operator must not be surrounded by spaces

                // ファイルを一時ディレクトリへ移動.
                $formFile->move($tmpDir, $archive);

                // 一時ディレクトリへ解凍する.
                try {
                    if ($formFile->getClientOriginalExtension() == 'zip') {
                        $zip = new \ZipArchive();
                        $zip->open($tmpDir . '/' . $archive);

Concat operator must not be surrounded by spaces

                        $zip->extractTo($tmpDir);
                        $zip->close();
                    } else {
                        $phar = new \PharData($tmpDir . '/' . $archive);

Concat operator must not be surrounded by spaces

                        $phar->extractTo($tmpDir, null, true);
                    }
                } catch (\Exception $e) {
                    $form['file']->addError(new FormError('アップロードに失敗しました。圧縮ファイルを確認してください。'));

                    return $app->render('Store/template_add.twig', array(
                        'form' => $form->createView(),
                    ));
                }

                $fs = new Filesystem();

                // appディレクトリの存在チェック.
                if (!file_exists($appDir)) {
                    $fs->mkdir($appDir);
                }

                // htmlディレクトリの存在チェック.
                if (!file_exists($htmlDir)) {
                    $fs->mkdir($htmlDir);
                }

                // 一時ディレクトリから該当テンプレートのディレクトリへコピーする.
                $fs->mirror($appDir, $targetRealDir);
                $fs->mirror($htmlDir, $targetHtmlRealDir);

                // 一時ディレクトリを削除.
                $fs->remove($tmpDir);

                $DeviceType = $app['eccube.repository.master.device_type']
                    ->find(DeviceType::DEVICE_TYPE_PC);

                $Template->setDeviceType($DeviceType);

                $app['orm.em']->persist($Template);
                $app['orm.em']->flush();

                $app->addSuccess('admin.content.template.add.complete', 'admin');

                return $app->redirect($app->url('admin_store_template'));
            }
        }

        return $app->render('Store/template_add.twig', array(
            'form' => $form->createView(),
        ));
    }

}