Passed
Pull Request — 1.11.x (#4900)
by Angel Fernando Quiroz
09:12
created

ExerciseSubmitController::__invoke()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 46
Code Lines 26

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
eloc 26
dl 0
loc 46
rs 9.504
c 2
b 0
f 0
cc 3
nc 4
nop 0
1
<?php
2
3
/* For license terms, see /license.txt */
4
5
use Chamilo\CoreBundle\Entity\TrackEExercises;
6
use Chamilo\CourseBundle\Entity\CQuiz;
7
use Chamilo\CourseBundle\Entity\CQuizQuestion;
8
use Chamilo\PluginBundle\ExerciseMonitoring\Entity\Log;
9
use Doctrine\ORM\EntityManager;
10
use Symfony\Component\Filesystem\Filesystem;
11
use Symfony\Component\HttpFoundation\File\UploadedFile;
12
use Symfony\Component\HttpFoundation\Request as HttpRequest;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, HttpRequest. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
13
use Symfony\Component\HttpFoundation\Response as HttpResponse;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, HttpResponse. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
14
15
class ExerciseSubmitController
16
{
17
    private $plugin;
18
    private $request;
19
    private $em;
20
21
    public function __construct(ExerciseMonitoringPlugin $plugin, HttpRequest $request, EntityManager $em)
22
    {
23
        $this->plugin = $plugin;
24
        $this->request = $request;
25
        $this->em = $em;
26
    }
27
28
    /**
29
     * @throws \Doctrine\ORM\OptimisticLockException
30
     * @throws \Doctrine\ORM\ORMException
31
     * @throws \Doctrine\ORM\TransactionRequiredException
32
     */
33
    public function __invoke(): HttpResponse
34
    {
35
        $userDirName = $this->createDirectory();
36
37
        $existingExeId = (int) ChamiloSession::read('exe_id');
38
39
        $levelId = $this->request->request->getInt('level_id');
40
        $exerciseId = $this->request->request->getInt('exercise_id');
41
42
        $exercise = $this->em->find(CQuiz::class, $exerciseId);
43
44
        $objExercise = new Exercise();
45
        $objExercise->read($exerciseId);
46
47
        $trackingExercise = $this->em->find(TrackEExercises::class, $existingExeId);
48
49
        $newFilename = '';
50
        $level = 0;
51
52
        /** @var UploadedFile $imgSubmit */
53
        if ($imgSubmit = $this->request->files->get('snapshot')) {
54
            $newFilename = uniqid().'_submit.jpg';
55
56
            $imgSubmit->move($userDirName, $newFilename);
57
        }
58
59
        if (ONE_PER_PAGE == $objExercise->selectType()) {
60
            $question = $this->em->find(CQuizQuestion::class, $levelId);
61
            $level = $question->getIid();
62
        }
63
64
        $log = new Log();
65
        $log
66
            ->setExercise($exercise)
67
            ->setExe($trackingExercise)
68
            ->setLevel($level)
69
            ->setImageFilename($newFilename)
70
        ;
71
72
        $this->em->persist($log);
73
74
        $this->updateOrphanSnapshots($exercise, $trackingExercise);
75
76
        $this->em->flush();
77
78
        return HttpResponse::create();
79
    }
80
81
    private function createDirectory(): string
82
    {
83
        $user = api_get_user_entity(api_get_user_id());
84
85
        $pluginDirName = api_get_path(SYS_UPLOAD_PATH).'plugins/exercisemonitoring';
86
        $userDirName = $pluginDirName.'/'.$user->getId();
87
88
        $fs = new Filesystem();
89
        $fs->mkdir(
90
            [$pluginDirName, $userDirName],
91
            api_get_permissions_for_new_directories()
92
        );
93
94
        return $userDirName;
95
    }
96
97
    private function updateOrphanSnapshots(CQuiz $exercise, TrackEExercises $trackingExe)
98
    {
99
        $repo = $this->em->getRepository(Log::class);
100
101
        $fileNamesToUpdate = ChamiloSession::read($this->plugin->get_name().'_orphan_snapshots', []);
102
103
        if (empty($fileNamesToUpdate)) {
104
            return;
105
        }
106
107
        foreach ($fileNamesToUpdate as $filename) {
108
            $log = $repo->findOneBy(['imageFilename' => $filename, 'exercise' => $exercise, 'exe' => null]);
109
110
            if (!$log) {
111
                continue;
112
            }
113
114
            $log->setExe($trackingExe);
115
        }
116
117
        ChamiloSession::erase($this->plugin->get_name().'_orphan_snapshots');
118
    }
119
}
120