Version20241010111200::getDescription() - Code Metrics - Inspection of "Bump micromatch from 4.0.5 to 4.0.8" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — dependabot/npm_and_yarn/microm... ( e84ba6...f2f212 )

unknown
created 2024-10-14 18:08 UTC
Version20241010111200::getDescription() A

↳ Parent: Version20241010111200
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
<?php

declare(strict_types=1);

/* For licensing terms, see /license.txt */

namespace Chamilo\CoreBundle\Migrations\Schema\V200;

use Chamilo\CoreBundle\Migrations\AbstractMigrationChamilo;
use Chamilo\CoreBundle\Repository\ResourceNodeRepository;
use Chamilo\CourseBundle\Entity\CDocument;
use Chamilo\CourseBundle\Repository\CDocumentRepository;
use Doctrine\DBAL\Schema\Schema;
use Exception;

final class Version20241010111200 extends AbstractMigrationChamilo
{
    public function getDescription(): string
    {
        return 'Update document and link URLs in HTML content blocks and replace old legacy paths with new resource paths';
    }

    public function up(Schema $schema): void
    {
        $this->entityManager->clear();
                              clear();

        // Define the content fields to update
        $updateConfigurations = [
            ['table' => 'c_tool_intro', 'field' => 'intro_text'],
            ['table' => 'c_course_description', 'field' => 'content'],
            ['table' => 'c_quiz', 'fields' => ['description', 'text_when_finished']],
            ['table' => 'c_quiz_question', 'fields' => ['description', 'question']],
            ['table' => 'c_quiz_answer', 'fields' => ['answer', 'comment']],
            ['table' => 'c_student_publication', 'field' => 'description'],
            ['table' => 'c_student_publication_comment', 'field' => 'comment'],
            ['table' => 'c_forum_post', 'field' => 'post_text'],
            ['table' => 'c_glossary', 'field' => 'description'],
            ['table' => 'c_survey', 'fields' => ['title', 'subtitle']],
            ['table' => 'c_survey_question', 'fields' => ['survey_question', 'survey_question_comment']],
            ['table' => 'c_survey_question_option', 'field' => 'option_text'],
        ];

        $documentRepo = $this->container->get(CDocumentRepository::class);
        $documentRepo = $this->container->get(CDocumentRepository::class);

        foreach ($updateConfigurations as $config) {
           $this->updateContent($config, $documentRepo);
        }

        $this->updateDocumentLinks();
    }

    /**
     * Updates content fields with new URLs.
     */
    private function updateContent(array $config, $documentRepo): void
    {
        $fields = isset($config['field']) ? [$config['field']] : $config['fields'] ?? [];
        foreach ($fields as $field) {
            $sql = "SELECT iid, {$field} FROM {$config['table']}";
            $result = $this->connection->executeQuery($sql);
            $items = $result->fetchAllAssociative();
            foreach ($items as $item) {
                $originalText = $item[$field];
                if (is_string($originalText) && trim($originalText) !== '') {
                    $updatedText = $this->replaceOldURLs($originalText, $documentRepo);
                    if ($originalText !== $updatedText) {
                        $updateSql = "UPDATE {$config['table']} SET {$field} = :newText WHERE iid = :id";
                        $this->connection->executeQuery($updateSql, ['newText' => $updatedText, 'id' => $item['iid']]);
                    }
                }
            }
        }
    }

    /**
     * Updates HTML content in document files by replacing old URLs with new resource paths.
     */
    private function updateDocumentLinks(): void
    {
        $sql = "SELECT iid, resource_node_id FROM c_document WHERE filetype = 'file'";
        $result = $this->connection->executeQuery($sql);
        $items = $result->fetchAllAssociative();

        $documentRepo = $this->container->get(CDocumentRepository::class);
        $resourceNodeRepo = $this->container->get(ResourceNodeRepository::class);

        foreach ($items as $item) {
            /** @var CDocument $document */
            $document = $documentRepo->find($item['iid']);
            if (!$document) {
                continue;
            }

            $resourceNode = $document->getResourceNode();
            if (!$resourceNode || !$resourceNode->hasResourceFile()) {
                continue;
            }

            $resourceFile = $resourceNode->getResourceFiles()->first();
            if ($resourceFile && $resourceFile->getMimeType() === 'text/html') {
                try {
                    $content = $resourceNodeRepo->getResourceNodeFileContent($resourceNode);
                    if (is_string($content) && trim($content) !== '') {
                        $updatedContent = $this->replaceOldURLs($content, $documentRepo);
                        if ($content !== $updatedContent) {
                            $documentRepo->updateResourceFileContent($document, $updatedContent);
                            $documentRepo->update($document);
                        }
                    }
                } catch (Exception $e) {
                    // error_log("Error processing file for document ID {$item['iid']}: " . $e->getMessage());
                }
            }
        }
    }

    /**
     * Replace old URLs with new Vue.js resource paths.
     */
    private function replaceOldURLs(string $content, $documentRepo): string
    {
        // Replace document URLs
        $content = $this->replaceOldDocumentURLs($content, $documentRepo);
        // Replace link URLs
        return $this->replaceOldLinkURLs($content);
    }

    /**
     * Replace old document URLs with the new relative paths.
     */
    private function replaceOldDocumentURLs(string $content, $documentRepo): string
    {
        $pattern = '/(href|src)=["\'](https?:\/\/[^\/]+)?\/main\/document\/(document\.php|show_content\.php|showinframes\.php)\?([^"\']*)["\']/i';

        return preg_replace_callback($pattern, function ($matches) use ($documentRepo) {
            $attribute = $matches[1];
            $params = str_replace('&amp;', '&', $matches[4]);

            parse_str($params, $parsedParams);
            $documentId = $parsedParams['id'] ?? null;
            $courseId = $parsedParams['cid'] ?? null;
            $sessionId = $parsedParams['id_session'] ?? $parsedParams['sid'] ?? '0';
            $groupId = $parsedParams['gidReq'] ?? $parsedParams['gid'] ?? '0';

            if (!$courseId && isset($parsedParams['cidReq'])) {
                $courseCode = $parsedParams['cidReq'];
                $sql = 'SELECT id FROM course WHERE code = :code ORDER BY id DESC LIMIT 1';
                $stmt = $this->connection->executeQuery($sql, ['code' => $courseCode]);
                $course = $stmt->fetch();

                if ($course) {
                    $courseId = $course['id'];
                }
            }

            if ($documentId && $courseId) {
                $sql = "SELECT iid, filetype, resource_node_id FROM c_document WHERE iid = :documentId";
                $result = $this->connection->executeQuery($sql, ['documentId' => $documentId]);
                $documents = $result->fetchAllAssociative();

                if (!empty($documents)) {
                    $documentData = $documents[0];
                    if ($documentData['filetype'] === 'folder') {
                        $newUrl = $this->generateFolderUrl((int)$documentData['resource_node_id'], (int)$courseId, $sessionId, $groupId);
                    } else {
                        $document = $documentRepo->find($documentId);
                        $newUrl = $documentRepo->getResourceFileUrl($document);
                    }

                    return sprintf('%s="%s"', $attribute, $newUrl);
                }
            } elseif ($courseId) {
                $sql = "SELECT resource_node_id FROM course WHERE id = :courseId";
                $result = $this->connection->executeQuery($sql, ['courseId' => $courseId]);
                $course = $result->fetch();

                if ($course && isset($course['resource_node_id'])) {
                    $newUrl = $this->generateFolderUrl((int)$course['resource_node_id'], (int)$courseId, $sessionId, $groupId);

                    return sprintf('%s="%s"', $attribute, $newUrl);
                }
            }

            return $matches[0];
        }, $content);
    }

    /**
     * Replace old link URLs.
     */
    private function replaceOldLinkURLs(string $content): string
    {
        $pattern = '/(href|src)=["\'](https?:\/\/[^\/]+)?\/main\/link\/link\.php\?([^"\']*)["\']/i';

        return preg_replace_callback($pattern, function ($matches) {
            $attribute = $matches[1];
            $params = str_replace('&amp;', '&', $matches[3]);
            parse_str($params, $parsedParams);

            $courseId = isset($parsedParams['cid']) ? (int)$parsedParams['cid'] : null;
            $sessionId = $parsedParams['id_session'] ?? $parsedParams['sid'] ?? '0';
            $groupId = $parsedParams['gidReq'] ?? $parsedParams['gid'] ?? '0';

            if (!$courseId && isset($parsedParams['cidReq'])) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                $courseCode = $parsedParams['cidReq'];
                $courseId = $this->getCourseIdFromCode($courseCode);
            }

            if ($courseId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                $sql = "SELECT resource_node_id FROM course WHERE id = :courseId";
                $result = $this->connection->executeQuery($sql, ['courseId' => $courseId]);
                $course = $result->fetch();

                if ($course && isset($course['resource_node_id'])) {
                    $newUrl = $this->generateLinkUrl((int)$course['resource_node_id'], (int)$courseId, $sessionId, $groupId);

                    return sprintf('%s="%s"', $attribute, $newUrl);
                }
            }

            return $matches[0];
        }, $content);
    }

    /**
     * Generate the relative URL for link-type documents.
     */
    private function generateLinkUrl(int $resourceNodeId, int $courseId, string $sessionId, string $groupId): string
    {
        return sprintf("/resources/links/%d/?cid=%d&sid=%s&gid=%s", $resourceNodeId, $courseId, $sessionId, $groupId);
    }

    /**
     * Retrieves the course ID from the course code.
     * Returns null if the course is not found.
     */
    private function getCourseIdFromCode(string $courseCode): ?int
    {
        $sql = 'SELECT id FROM course WHERE code = :code ORDER BY id DESC LIMIT 1';
        $stmt = $this->connection->executeQuery($sql, ['code' => $courseCode]);
        $course = $stmt->fetch();

        return $course ? (int)$course['id'] : null;
    }

    /**
     * Generate the relative URL for folder-type documents using resource_node_id.
     */
    private function generateFolderUrl(int $resourceNodeId, int $courseId, string $sessionId, string $groupId): string
    {
        return sprintf("/resources/document/%d/?cid=%d&sid=%s&gid=%s", $resourceNodeId, $courseId, $sessionId, $groupId);
    }
}

chamilo / chamilo-lms

Push — dependabot/npm_and_yarn/microm... ( e84ba6...f2f212 )

Version20241010111200::getDescription() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
