syntax highlighting problem with smarty php templates

[Unxed]

[ Impact ]

Colorer, the syntax highlighter used by FAR2L, incorrectly interprets Smarty template syntax. This leads to valid Smarty templates being displayed with syntax errors, hindering readability and development. This fix improves syntax highlighting accuracy for Smarty templates within far2l.

[ Test Plan ]

1. Install FAR2L with the updated Colorer schemes (from the PPA or after applying the patch).
2. Create file test.smarty in editor with the following content:

<script>
    $(document).ready(function() {
        $('#action-pending').on('click', function(e) {
            // ...
            window.location = '?action=pending&list=' + list;
            return false;
        });
    });
</script>

<style>
    .appeal-content {
        background-color: #eee;
        padding: 10px;
    }

    table.tablesorter tr td table tr.monitor td {
        border-bottom: 2px solid white;
        color: white;
        background-color: red;
        cursor: pointer;
    }
</style>

3. Compare the highlighting with attached reference image

Also compare the highlighting with the previous version where this snippet would show syntax errors.

[ Where problems could occur ]

The changes modify how Smarty templates are parsed. While targeted, regressions are possible, especially with more complex or edge-case Smarty syntax. Testing several complex Smarty templates is recommended to ensure no unintended highlighting issues are introduced. Also the fix is already in 24.10 and in project's ppa, no problems were reported.

[ Other Info ]

This fix addresses the issues raised in the upstream Colorer project (see links above) and has been integrated into far2l via a pull request. It significantly improves Smarty template support within far2l without requiring broad changes to the highlighting engine. This enhances the editor's usability for web developers working with Smarty templates. This change is already in 24.10 and here is a patch adopting it for 24.04.

https://github.com/elfmz/far2l/issues/531
https://github.com/colorer/Colorer-schemes/issues/75
https://github.com/elfmz/far2l/pull/2198

ProblemType: Bug
DistroRelease: Ubuntu 24.04
Package: far2l 2.6.0~beta+ds-1ubuntu0.1
ProcVersionSignature: User Name 6.8.0-31.31-generic 6.8.1
Uname: Linux 6.8.0-31-generic x86_64
ApportVersion: 2.28.1-0ubuntu2
Architecture: amd64
CasperMD5CheckMismatches: ./boot/grub/grub.cfg
CasperMD5CheckResult: fail
CurrentDesktop: ubuntu:GNOME
Date: Wed Oct 9 15:37:28 2024
InstallationDate: Installed on 2024-04-29 (163 days ago)
InstallationMedia: Ubuntu 24.04 LTS "Noble Numbat" - Release amd64 (20240424)
ProcEnviron:
 LANG=en_US.UTF-8
 PATH=(custom, no user)
 SHELL=/bin/bash
 TERM=xterm-256color
 XDG_RUNTIME_DIR=<set>
SourcePackage: far2l
UpgradeStatus: No upgrade log present (probably fresh install)

[Unxed (unxed)]

fix backported to 24.04

[Ubuntu Foundations Team Bug Bot (crichton)]

The attachment "far2l_smarty_ubuntu_2404.patch" seems to be a patch. If it isn't, please remove the "patch" flag from the attachment, remove the "patch" tag, and if you are a member of the ~ubuntu-reviewers, unsubscribe the team.

[This is an automated message performed by a Launchpad user owned by ~brian-murray, for any issues please contact him.]

[Dmitry Shachnev (mitya57)]

This commit was part of 2.6.2 release, so marking as fixed in Oracular.

https://github.com/elfmz/far2l/commit/b168e260c572fac33d3c212cafd856c1f14d1e2c

[Unxed (unxed)]

good coloring sample (with patch)

[Unxed (unxed)]

bad coloring sample (without patch)

[Steve Langasek (vorlon)]

Hello Unxed, or anyone else affected,

Accepted far2l into noble-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/far2l/2.6.0~beta+ds-1ubuntu0.3 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-noble to verification-done-noble. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-noble. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Unxed (unxed)]

Tested
2.6.0~beta+ds-1ubuntu0.3
from
https://launchpad.net/ubuntu/+source/far2l/2.6.0~beta+ds-1ubuntu0.3/+build/29170121

in 24.04.

The bug is fixed.

[Launchpad Janitor (janitor)]

This bug was fixed in the package far2l - 2.6.0~beta+ds-1ubuntu0.3

---------------
far2l (2.6.0~beta+ds-1ubuntu0.3) noble; urgency=medium

  * Backport upstream patch to fix mouse and clipboard in WSL (LP: #2083233).
  * Backport upstream patch to fix opening files from /etc in far2ledit
    (LP: #2084045).
  * Backport upstream patch to fix highlighting of smarty PHP templates
    (LP: #2084094).

 -- Dmitry Shachnev <email address hidden> Thu, 10 Oct 2024 21:52:11 +0300

[Brian Murray (brian-murray)]

The verification of the Stable Release Update for far2l has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.