PostingReplySubjectBuilder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\components\Forum\Subject;

class PostingReplySubjectBuilder
{
    private const EXPECTED_REPLY_PREFIX_END = ':';
    private const EXPECTED_NUMBER_WRAPPER_CHAR_START_PATTERN = '\\(';
    private const EXPECTED_NUMBER_WRAPPER_CHAR_END_PATTERN = '\\)';
    private const EXPECTED_NUMBER_WRAPPER_CHAR_START = '(';
    private const EXPECTED_NUMBER_WRAPPER_CHAR_END = ')';

    private static ?array $f = null;

    private string $reply_prefix;
    private string $optimized_repeated_reply_prefix;

    public function __construct(string $reply_prefix, string $optimized_repeated_reply_prefix)
    {
        $this->reply_prefix = trim($reply_prefix);
        $this->optimized_repeated_reply_prefix = trim($optimized_repeated_reply_prefix);

        if (self::$f === null) {
            self::$f = [
                'strpos' => function (string $haystack, string $needle, ?int $offset = 0) {
                    return function_exists('mb_strpos') ? mb_strpos($haystack, $needle, $offset, 'UTF-8') : strpos(
                        $haystack,
                        $needle,
                        $offset
                    );
                },
                'strrpos' => function (string $haystack, string $needle, ?int $offset = 0) {
                    return function_exists('mb_strrpos') ? mb_strrpos($haystack, $needle, $offset, 'UTF-8') : strrpos(
                        $haystack,
                        $needle,
                        $offset
                    );
                },
                'strlen' => function (string $string): int {
                    return function_exists('mb_strlen') ? mb_strlen($string, 'UTF-8') : strlen($string);
                },
                'substr' => function (string $string, int $start, ?int $length = null): string {
                    return function_exists('mb_substr') ? mb_substr($string, $start, $length, 'UTF-8') : substr(
                        $string,
                        $start,
                        $length
                    );
                }
            ];
        }
    }

    public function build(string $subject_of_parent_posting): string
    {
        $subject_of_parent_posting = trim($subject_of_parent_posting);
        $subject_of_reply = '';

        $reply_prefix = $this->reply_prefix;
        if ((self::$f['substr'])(
            $reply_prefix,
            -((self::$f['strlen'])(self::EXPECTED_REPLY_PREFIX_END))
        ) !== self::EXPECTED_REPLY_PREFIX_END) {
            $reply_prefix .= self::EXPECTED_REPLY_PREFIX_END;
        }

        $optimized_repeated_reply_prefix = $this->optimized_repeated_reply_prefix;
        if ((self::$f['substr'])(
            $optimized_repeated_reply_prefix,
            -((self::$f['strlen'])(self::EXPECTED_REPLY_PREFIX_END))
        ) !== self::EXPECTED_REPLY_PREFIX_END) {
            $optimized_repeated_reply_prefix .= self::EXPECTED_REPLY_PREFIX_END;
        }

        $optimized_repeated_reply_prefix_start = substr_replace(
            $reply_prefix,
            self::EXPECTED_NUMBER_WRAPPER_CHAR_START,
            (self::$f['strrpos'])($reply_prefix, self::EXPECTED_REPLY_PREFIX_END),
            (self::$f['strlen'])(self::EXPECTED_REPLY_PREFIX_END)
        );

        $optimized_repeated_reply_prefix_begin_pattern = preg_quote(
            (self::$f['substr'])(
                $optimized_repeated_reply_prefix_start,
                0,
                (self::$f['strrpos'])(
                    $optimized_repeated_reply_prefix_start,
                    self::EXPECTED_NUMBER_WRAPPER_CHAR_START
                )
            ),
            '/'
        );

        $optimized_repeated_reply_prefix_regex = implode('', [
            '/^',
            $optimized_repeated_reply_prefix_begin_pattern,
            '\s*?' . self::EXPECTED_NUMBER_WRAPPER_CHAR_START_PATTERN . '\s*?\d+\s*?' . self::EXPECTED_NUMBER_WRAPPER_CHAR_END_PATTERN,
            '/'
        ]);

        if (preg_match($optimized_repeated_reply_prefix_regex, $subject_of_parent_posting)) {
            // i.e. $subj_of_parent_posting = "Re(12):" or "Re (12):"
            $subject_of_reply = $this->handleSubjectStartsWithOptimizedRepetitionReplyPattern(
                $subject_of_parent_posting
            );
        } else {
            // i.e. $subj_of_parent_posting = "Re: Re: Re: ..."
            $subject_of_reply = $this->handleSubjectWithoutReplyPrefixOrRepeatedReplyPrefix(
                $subject_of_parent_posting,
                $reply_prefix,
                $optimized_repeated_reply_prefix
            );
        }

        return $subject_of_reply;
    }

    private function handleSubjectWithoutReplyPrefixOrRepeatedReplyPrefix(
        string $subject_of_parent_posting,
        string $effective_reply_prefix,
        string $effective_optimized_repeated_reply_prefix
    ): string {
        $subject_of_reply = $subject_of_parent_posting;

        $reply_prefix_start = (self::$f['substr'])(
            $effective_reply_prefix,
            0,
            -(self::$f['strlen'])(self::EXPECTED_REPLY_PREFIX_END)
        );

        $repeated_reply_prefix_regex = implode('', [
            '/^',
            '(' . preg_quote($reply_prefix_start, '/') . '\s*' . self::EXPECTED_REPLY_PREFIX_END . '\s*)+',
            '/'
        ]);

        $matches = null;
        preg_match($repeated_reply_prefix_regex, $subject_of_parent_posting, $matches);
        $number_of_repetitions = isset($matches[0]) ?
            preg_match_all(
                '/' . preg_quote($reply_prefix_start, '/') . '\s*' . self::EXPECTED_REPLY_PREFIX_END . '\s*/',
                $matches[0]
            ) : 0;

        if ($number_of_repetitions >= 1) {
            // i.e. $final_subject = "Re: Re: Re: ... " -> "Re(4):"
            $number_of_repetitions++;
            $subject_of_reply = sprintf(
                $effective_optimized_repeated_reply_prefix,
                $number_of_repetitions
            ) . ' ' . trim(str_replace($matches[0], '', $subject_of_parent_posting));
        } elseif ($number_of_repetitions === 0) {
            // the first reply to a thread
            $subject_of_reply = $effective_reply_prefix . ' ' . $subject_of_parent_posting;
        }

        return $subject_of_reply;
    }

    private function handleSubjectStartsWithOptimizedRepetitionReplyPattern(string $subject_of_parent_posting): string
    {
        $subject_of_reply = $subject_of_parent_posting;

        $wrapper_start_pos = (self::$f['strpos'])($subject_of_parent_posting, self::EXPECTED_NUMBER_WRAPPER_CHAR_START);
        $wrapper_end_pos = (self::$f['strpos'])($subject_of_parent_posting, self::EXPECTED_NUMBER_WRAPPER_CHAR_END);

        if ($wrapper_start_pos === false || $wrapper_end_pos === false || $wrapper_end_pos < $wrapper_start_pos) {
            return $subject_of_reply;
        }

        $length = $wrapper_end_pos - $wrapper_start_pos;
        $wrapper_start_pos++;

        $txt_num_replies = (self::$f['substr'])($subject_of_parent_posting, $wrapper_start_pos, $length - 1);
        if (is_numeric($txt_num_replies) && $txt_num_replies > 0) {
            $number_of_replies = ((int) trim($txt_num_replies)) + 1;
            $subject_of_reply = (self::$f['substr'])(
                $subject_of_parent_posting,
                0,
                $wrapper_start_pos
            ) . $number_of_replies . (self::$f['substr'])(
                $subject_of_parent_posting,
                $wrapper_end_pos
            );
        }

        return $subject_of_reply;
    }
}