File indexing completed on 2024-05-19 05:54:10

 /*
     SPDX-FileCopyrightText: 2007-2008 Robert Knight <robertknight@gmail.com>
     SPDX-FileCopyrightText: 2020 Tomaz Canabrava <tcanabrava@gmail.com>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #include "UrlFilter.h"
 
 using namespace Konsole;
 
 #include "UrlFilterHotspot.h"
 
 // Note:  Altering these regular expressions can have a major effect on the performance of the filters
 // used for finding URLs in the text, especially if they are very general and could match very long
 // pieces of text.
 // Please be careful when altering them.
 
 // FullUrlRegExp is implemented based on:
 // https://datatracker.ietf.org/doc/html/rfc3986
 // See above URL for what "unreserved", "pct-encoded" ...etc mean, also
 // for the regex used for each part of the url being matched against.
 //
 // It deviates from rfc3986:
 // - We only recognize URIs with authority (even if it is an empty authority)
 // - We match URI suffixes starting with 'www.'
 // - We allow IPv6 literals right after 'www.', e.g: www.[dead::beef]
 // - We _don't_ match IPvFuture addresses
 // - We allow any combination of hex digits, colons and dots as IPv6 addresses,
 //   e.g: https://[::::dead:::beef::123.666.666.666::dead::::beef::::]/foo
 // - "port" (':1234'), if present, is assumed to be non-empty
 // - We don't check the validity of percent-encoded characters
 //   (e.g. "www.example.com/foo%XXbar")
 // - We do not allow parenthesis in host.
 // - We don't recognize URIs with unbalanced parens in path, query or fragment.
 //   We do this to prevent URIs inside parentheses from getting extended to the closing
 //   parenthesis.  We still recognize unbalanced parens in userInfo, but the
 //   postfix @ should prevent most ambiguity.
 
 // All non-recursive () groups are non-capturing (by using "(?:)" notation)
 // less bookkeeping on the PCRE engine side
 
 // scheme://
 // - Must start with an ASCII letter, preceded by any non-word character,
 //   so "http" but not "mhttp"
 static const char scheme_or_www[] = "\\b(?:www\\.|[a-z][a-z0-9+\\-.]*+://";
 static const char scheme_or_www_end[] = ")";
 
 // unreserved / pct-encoded / sub-delims
 #define COMMON_1 "a-z0-9\\-._~%!$&'*+,;="
 #define BALANCED_PARENS(CHARS) "(?:[" CHARS "]++(\\((?:[" CHARS "]++|(?-1))*+\\))?+)"
 
 /* clang-format off */
 static const char userInfo[] = "(?:[" COMMON_1 ":()" "]++@)?+"; // user:password@
 #define IPv6_literal "\\[[0-9a-fA-F:.]++\\]"
 static const char host[] = "(?:[" COMMON_1 "]++|" IPv6_literal ")?+"; // www.foo.bar
 static const char port[] = "(?::[0-9]+)?+"; // :1234
 
 #define COMMON_2 "a-z0-9\\-._~%!$&'*+,;=:@/"
 static const char path[] = "(?:/" BALANCED_PARENS(COMMON_2) "*+)?+"; // /path/to/some/place
 static const char query[] = "(?:\\?" BALANCED_PARENS(COMMON_2 "?") "*+)?+"; // "?somequery=bar"
 static const char fragment[] = "(?:#" BALANCED_PARENS(COMMON_2 "?") "*+)?+"; // "#fragment"
 
 using LS1 = QLatin1String;
 
 const QRegularExpression UrlFilter::FullUrlRegExp(
     LS1(scheme_or_www)
     + LS1(userInfo)
     + LS1(scheme_or_www_end)
     + LS1(host)
     + LS1(port)
     + LS1(path)
     + LS1(query)
     + LS1(fragment)
     , QRegularExpression::CaseInsensitiveOption);
 
 
 /////////////////////////////////////////////
 
 // email address:
 // [word chars, dots or dashes]@[word chars, dots or dashes].[word chars]
 const QRegularExpression UrlFilter::EmailAddressRegExp(QStringLiteral("\\b(\\w|\\.|-|\\+)+@(\\w|\\.|-)+\\.\\w+\\b"));
 
 // matches full url or email address
 const QRegularExpression UrlFilter::CompleteUrlRegExp(
     QLatin1Char('(') + FullUrlRegExp.pattern() + QLatin1Char('|') + EmailAddressRegExp.pattern()+ QLatin1Char(')'),
     QRegularExpression::CaseInsensitiveOption);
 
 /* clang-format on */
 UrlFilter::UrlFilter()
 {
     setRegExp(CompleteUrlRegExp);
 }
 
 QSharedPointer<HotSpot> UrlFilter::newHotSpot(int startLine, int startColumn, int endLine, int endColumn, const QStringList &capturedTexts)
 {
     QStringList texts{};
 
     // remove final single quote
     // we want URLs in single quotes like the following to work correctly:
     // 'https://en.wikipedia.org/wiki/Earth's_rotation'
     for (QString s : capturedTexts) {
         QString str{s};
         if (s.right(1) == QLatin1String("'")) {
             s.chop(1);
         }
         texts << s;
     }
     if (capturedTexts[0].right(1) == QLatin1String("'")) {
         endColumn--;
     }
 
     return QSharedPointer<HotSpot>(new UrlFilterHotSpot(startLine, startColumn, endLine, endColumn, texts));
 }