Failed Conditions
Pull Request — experimental/3.1 (#2653)
by
unknown
119:44 queued 113:38
created

OwnerStoreController::postRequestApi()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 16
Code Lines 13

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 13
nc 1
nop 3
dl 0
loc 16
ccs 0
cts 0
cp 0
crap 2
rs 9.4285
c 0
b 0
f 0
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
namespace Eccube\Controller\Admin\Store;
24
25
use Doctrine\ORM\EntityManager;
26
use Eccube\Annotation\Inject;
27
use Eccube\Application;
28
use Eccube\Common\Constant;
29
use Eccube\Controller\AbstractController;
30
use Eccube\Entity\Plugin;
31
use Eccube\Repository\PluginRepository;
32
use Eccube\Service\Composer\ComposerServiceInterface;
33
use Eccube\Service\PluginService;
34
use Eccube\Service\SystemService;
35
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
36
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
37
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
38
use Symfony\Component\HttpFoundation\RedirectResponse;
39
use Symfony\Component\HttpFoundation\Request;
40
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
41
42
/**
43
 * @Route(service=OwnerStoreController::class)
44
 */
45
class OwnerStoreController extends AbstractController
46
{
47
    /**
48
     * @Inject("config")
49
     * @var array
50
     */
51
    protected $appConfig;
52
53
    /**
54
     * @Inject(PluginRepository::class)
55
     * @var PluginRepository
56
     */
57
    protected $pluginRepository;
58
59
    /**
60
     * @Inject(PluginService::class)
61
     * @var PluginService
62
     */
63
    protected $pluginService;
64
65
    /**
66
     * @Inject("eccube.service.composer")
67
     * @var ComposerServiceInterface
68
     */
69
    protected $composerService;
70
71
    /**
72
     * @var EntityManager
73
     * @Inject("orm.em")
74
     */
75
    protected $em;
76
77
    /**
78
     * @Inject(SystemService::class)
79
     * @var SystemService
80
     */
81
    protected $systemService;
82
83
    private static $vendorName = 'ec-cube';
84
85
    /**
86
     * Owner's Store Plugin Installation Screen - Search function
87
     *
88
     * @Route("/{_admin}/store/plugin/search", name="admin_store_plugin_owners_search")
89
     * @Template("Store/plugin_search.twig")
90
     * @param Application $app
91
     * @param Request     $request
92
     * @return array
93
     */
94
    public function search(Application $app, Request $request)
0 ignored issues
show
Unused Code introduced by
The parameter $request 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...
95
    {
96
        // Acquire downloadable plug-in information from owners store
97
        $items = array();
98
        $promotionItems = array();
99
        $message = '';
100
        // Owner's store communication
101
        $url = $this->appConfig['package_repo_url'].'/search/packages.json';
102
        list($json, $info) = $this->getRequestApi($url, $app);
103
        if ($json === false) {
104
            $message = $this->getResponseErrorMessage($info);
105
        } else {
106
            $data = json_decode($json, true);
107
            if (isset($data['success']) && $data['success']) {
108
                // Check plugin installed
109
                $pluginInstalled = $this->pluginRepository->findAll();
110
                // Update_status 1 : not install/purchased 、2 : Installed、 3 : Update、4 : paid purchase
111
                foreach ($data['item'] as $item) {
112
                    // Not install/purchased
113
                    $item['update_status'] = 1;
114
                    /** @var Plugin $plugin */
115
                    foreach ($pluginInstalled as $plugin) {
116
                        if ($plugin->getSource() == $item['product_id']) {
117
                            // Installed
118
                            $item['update_status'] = 2;
119
                            if ($this->pluginService->isUpdate($plugin->getVersion(), $item['version'])) {
120
                                // Need update
121
                                $item['update_status'] = 3;
122
                            }
123
                        }
124
                    }
125
                    $items[] = $item;
126
                }
127
128
                // EC-CUBE version check
129
                foreach ($items as &$item) {
130
                    // Not applicable version
131
                    $item['version_check'] = 0;
132
                    if (in_array(Constant::VERSION, $item['eccube_version'])) {
133
                        // Match version
134
                        $item['version_check'] = 1;
135
                    }
136
                    if ($item['price'] != '0' && $item['purchased'] == '0') {
137
                        // Not purchased with paid items
138
                        $item['update_status'] = 4;
139
                    }
140
                    // Add plugin dependency
141
                    $item['depend'] = $this->pluginService->getRequirePluginName($items, $item);
142
                }
143
                unset($item);
144
145
                // Promotion item
146
                $i = 0;
147 View Code Duplication
                foreach ($items as $item) {
148
                    if ($item['promotion'] == 1) {
149
                        $promotionItems[] = $item;
150
                        unset($items[$i]);
151
                    }
152
                    $i++;
153
                }
154
            } else {
155
                $message = $app->trans('admin.plugin.authentication.fail');
156
            }
157
        }
158
159
        return [
160
            'items' => $items,
161
            'promotionItems' => $promotionItems,
162
            'message' => $message,
163
        ];
164
    }
165
166
    /**
167
     * Do confirm page
168
     *
169
     * @Route("/{_admin}/store/plugin/{id}/confirm", requirements={"id" = "\d+"}, name="admin_store_plugin_install_confirm")
170
     * @Template("Store/plugin_confirm.twig")
171
     * @param Application $app
172
     * @param Request     $request
173
     * @param string      $id
174
     * @return array
175
     */
176
    public function doConfirm(Application $app, Request $request, $id)
0 ignored issues
show
Unused Code introduced by
The parameter $request 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...
177
    {
178
        // Owner's store communication
179
        $url = $this->appConfig['package_repo_url'].'/search/packages.json';
180
        list($json, $info) = $this->getRequestApi($url, $app);
0 ignored issues
show
Unused Code introduced by
The assignment to $info is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
181
        $data = json_decode($json, true);
182
        $items = $data['item'];
183
184
        // Find plugin in api
185
        $index = array_search($id, array_column($items, 'product_id'));
186
        if ($index === false) {
187
            throw new NotFoundHttpException();
188
        }
189
190
        $pluginCode = $items[$index]['product_code'];
191
192
        $plugin = $this->pluginService->buildInfo($items, $pluginCode);
193
194
        // Prevent infinity loop: A -> B -> A.
195
        $dependents[] = $plugin;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$dependents was never initialized. Although not strictly required by PHP, it is generally a good practice to add $dependents = 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...
196
        $dependents = $this->pluginService->getDependency($items, $plugin, $dependents);
0 ignored issues
show
Bug introduced by
It seems like $plugin defined by $this->pluginService->bu...fo($items, $pluginCode) on line 192 can also be of type null; however, Eccube\Service\PluginService::getDependency() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
197
        // Unset first param
198
        unset($dependents[0]);
199
200
        return [
201
            'item' => $plugin,
202
            'dependents' => $dependents,
203
        ];
204
    }
205
206
    /**
207
     * Api Install plugin by composer connect with package repo
208
     *
209
     * @Route("/{_admin}/store/plugin/api/{pluginCode}/{eccubeVersion}/{version}" , name="admin_store_plugin_api_install")
210
     *
211
     * @param Application $app
212
     * @param Request     $request
213
     * @param string      $pluginCode
214
     * @param string      $eccubeVersion
215
     * @param string      $version
216
     * @return RedirectResponse
217
     */
218
    public function apiInstall(Application $app, Request $request, $pluginCode, $eccubeVersion, $version)
219
    {
220
        // Check plugin code
221
        $url = $this->appConfig['package_repo_url'].'/search/packages.json'.'?eccube_version='.$eccubeVersion.'&plugin_code='.$pluginCode.'&version='.$version;
222
        list($json, $info) = $this->getRequestApi($url, $app);
0 ignored issues
show
Unused Code introduced by
The assignment to $info is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
223
        $existFlg = false;
224
        $data = json_decode($json, true);
225
        if ($data && isset($data['success'])) {
226
            $success = $data['success'];
227
            if ($success == '1' && isset($data['item'])) {
228
                foreach ($data['item'] as $item) {
229
                    if ($item['product_code'] == $pluginCode) {
230
                        $existFlg = true;
231
                        break;
232
                    }
233
                }
234
            }
235
        }
236
        if ($existFlg === false) {
237
            log_info(sprintf('%s plugin not found!', $pluginCode));
238
            $app->addError('admin.plugin.not.found', 'admin');
239
240
            return $app->redirect($app->url('admin_store_plugin_owners_search'));
241
        }
242
        $dependents = array();
243
        $items = $data['item'];
244
        $plugin = $this->pluginService->buildInfo($items, $pluginCode);
245
        $dependents[] = $plugin;
246
        $dependents = $this->pluginService->getDependency($items, $plugin, $dependents);
0 ignored issues
show
Bug introduced by
It seems like $plugin defined by $this->pluginService->bu...fo($items, $pluginCode) on line 244 can also be of type null; however, Eccube\Service\PluginService::getDependency() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
247
248
        // Unset first param
249
        unset($dependents[0]);
250
        $dependentModifier = [];
251
        $packageNames = '';
252
        if (!empty($dependents)) {
253
            foreach ($dependents as $item) {
254
                $packageNames .= self::$vendorName . '/' . $item['product_code'] . ' ';
0 ignored issues
show
Coding Style introduced by
Concat operator must not be surrounded by spaces
Loading history...
255
                $pluginItem = [
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
256
                    "product_code" => $item['product_code'],
257
                    "version" => $item['version']
258
                ];
259
                array_push($dependentModifier, $pluginItem);
260
            }
261
        }
262
        $packageNames .= self::$vendorName . '/' . $pluginCode;
0 ignored issues
show
Coding Style introduced by
Concat operator must not be surrounded by spaces
Loading history...
263
        $return = $this->composerService->execRequire($packageNames);
264
        $data = array(
0 ignored issues
show
introduced by
Add a comma after each item in a multi-line array
Loading history...
265
            'code' => $pluginCode,
266
            'version' => $version,
267
            'core_version' => $eccubeVersion,
268
            'php_version' => phpversion(),
269
            'db_version' => $this->systemService->getDbversion(),
270
            'os' => php_uname('s') . ' ' . php_uname('r') . ' ' . php_uname('v'),
0 ignored issues
show
Coding Style introduced by
Concat operator must not be surrounded by spaces
Loading history...
271
            'host' => $request->getHost(),
272
            'web_server' => $request->server->get("SERVER_SOFTWARE"),
273
            'composer_version' => $this->composerService->composerVersion(),
274
            'composer_execute_mode' => $this->composerService->getMode(),
275
            'dependents' => json_encode($dependentModifier)
276
        );
277
        if ($return) {
278
            $url = $this->appConfig['package_repo_url'] . '/report';
0 ignored issues
show
Coding Style introduced by
Concat operator must not be surrounded by spaces
Loading history...
279
            $this->postRequestApi($url, $app, $data);
280
            $app->addSuccess('admin.plugin.install.complete', 'admin');
281
282
            return $app->redirect($app->url('admin_store_plugin'));
283
        }
284
        $url = $this->appConfig['package_repo_url'] . '/report/fail';
0 ignored issues
show
Coding Style introduced by
Concat operator must not be surrounded by spaces
Loading history...
285
        $this->postRequestApi($url, $app, $data);
286
        $app->addError('admin.plugin.install.fail', 'admin');
287
288
        return $app->redirect($app->url('admin_store_plugin_owners_search'));
289
    }
290
291
    /**
292
     * Do confirm page
293
     *
294
     * @Route("/{_admin}/store/plugin/delete/{id}/confirm", requirements={"id" = "\d+"}, name="admin_store_plugin_delete_confirm")
295
     * @Template("Store/plugin_confirm_uninstall.twig")
296
     * @param Application $app
297
     * @param Plugin      $Plugin
298
     * @return array|RedirectResponse
299
     */
300
    public function deleteConfirm(Application $app, Plugin $Plugin)
301
    {
302
        // Owner's store communication
303
        $url = $this->appConfig['package_repo_url'].'/search/packages.json';
304
        list($json, $info) = $this->getRequestApi($url, $app);
0 ignored issues
show
Unused Code introduced by
The assignment to $info is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
305
        $data = json_decode($json, true);
306
        $items = $data['item'];
307
308
        // The plugin depends on it
309
        $pluginCode = $Plugin->getCode();
310
        $otherDepend = $this->pluginService->findDependentPlugin($pluginCode);
311
312
        if (!empty($otherDepend)) {
313
            $DependPlugin = $this->pluginRepository->findOneBy(['code' => $otherDepend[0]]);
314
            $dependName = $otherDepend[0];
315
            if ($DependPlugin) {
316
                $dependName = $DependPlugin->getName();
317
            }
318
319
            $message = $app->trans('admin.plugin.uninstall.depend', ['%name%' => $Plugin->getName(), '%depend_name%' => $dependName]);
320
            $app->addError($message, 'admin');
321
322
            return $app->redirect($app->url('admin_store_plugin'));
323
        }
324
325
        // Check plugin in api
326
        $pluginSource = $Plugin->getSource();
327
        $index = array_search($pluginSource, array_column($items, 'product_id'));
328
        if ($index === false) {
329
            throw new NotFoundHttpException();
330
        }
331
332
        // Build info
333
        $pluginCode = $Plugin->getCode();
334
        $plugin = $this->pluginService->buildInfo($items, $pluginCode);
335
        $plugin['id'] = $Plugin->getId();
336
337
        return [
338
            'item' => $plugin,
339
        ];
340
    }
341
342
    /**
343
     * New ways to remove plugin: using composer command
344
     *
345
     * @Method("DELETE")
346
     * @Route("/{_admin}/store/plugin/api/{id}/uninstall", requirements={"id" = "\d+"}, name="admin_store_plugin_api_uninstall")
347
     * @param Application $app
348
     * @param Plugin      $Plugin
349
     * @return RedirectResponse
350
     */
351
    public function apiUninstall(Application $app, Plugin $Plugin)
352
    {
353
        $this->isTokenValid($app);
354
355
        if ($Plugin->isEnable()) {
356
            $this->pluginService->disable($Plugin);
357
        }
358
        $pluginCode = $Plugin->getCode();
359
        $packageName = self::$vendorName.'/'.$pluginCode;
360
        $return = $this->composerService->execRemove($packageName);
361
        if ($return) {
362
            $app->addSuccess('admin.plugin.uninstall.complete', 'admin');
363
        } else {
364
            $app->addError('admin.plugin.uninstall.error', 'admin');
365
        }
366
367
        return $app->redirect($app->url('admin_store_plugin'));
368
    }
369
370
    /**
371
     * API request processing
372
     *
373
     * @param string  $url
374
     * @param Application $app
375
     * @return array
376
     */
377
    private function getRequestApi($url, $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...
378
    {
379
        $curl = curl_init($url);
380
381
        // Option array
382
        $options = array(
383
            // HEADER
384
            CURLOPT_HTTPGET => true,
385
            CURLOPT_SSL_VERIFYPEER => false,
386
            CURLOPT_RETURNTRANSFER => true,
387
            CURLOPT_FAILONERROR => true,
388
            CURLOPT_CAINFO => \Composer\CaBundle\CaBundle::getSystemCaRootBundlePath(),
389
        );
390
391
        // Set option value
392
        curl_setopt_array($curl, $options);
393
        $result = curl_exec($curl);
394
        $info = curl_getinfo($curl);
395
        $message = curl_error($curl);
396
        $info['message'] = $message;
397
        curl_close($curl);
398
399
        log_info('http get_info', $info);
400
401
        return array($result, $info);
402
    }
403
404
    /**
405
     * API post request processing
406
     *
407
     * @param string  $url
408
     * @param Application $app
409
     * @param array $data
410
     * @return array
411
     */
412
    private function postRequestApi($url, $app, $data)
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...
413
    {
414
        $curl = curl_init($url);
415
        curl_setopt($curl, CURLOPT_URL, $url);
416
        curl_setopt($curl, CURLOPT_POST, 1);
417
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
418
        curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
419
        $result = curl_exec($curl);
420
        $info = curl_getinfo($curl);
421
        $message = curl_error($curl);
422
        $info['message'] = $message;
423
        curl_close($curl);
424
425
        log_info('http post_info', $info);
426
        return array($result, $info);
0 ignored issues
show
introduced by
Missing blank line before return statement
Loading history...
427
    }
428
429
    /**
430
     * Get message
431
     *
432
     * @param $info
433
     * @return string
434
     */
435 View Code Duplication
    private function getResponseErrorMessage($info)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
436
    {
437
        if (!empty($info)) {
438
            $statusCode = $info['http_code'];
439
            $message = $info['message'];
440
441
            $message = $statusCode.' : '.$message;
442
        } else {
443
            $message = "タイムアウトエラーまたはURLの指定に誤りがあります。";
444
        }
445
446
        return $message;
447
    }
448
}
449