git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH/RFC 5/6] gitweb: Highlight matched part of project name when searching projects

From
Jakub Narebski <jnareb@gmail.com>
Date
Jul 29, 2011, 11:52 UTC
Message-ID
<1311940379-9608-6-git-send-email-jnareb@gmail.com>
In-Reply-To
<1311940379-9608-1-git-send-email-jnareb@gmail.com>

Use newly introduced esc_html_match_hl() to escape HTML and mark match with span element with 'match' class. Currently only 'path' part (i.e. project name) is highlighted; match might be on the project description.

The code makes use of the fact that defined $search_regexp means that there was search going on.

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
---
The esc_html_match_hl() subroutine (I really need a better name for
it) should probably be used in more places, everywhere where we do
highlight match in non-shortened text.  It is safe wrt. codes that
need HTML escaping both in non-matched and in matched part, and with
regular expression containing characters that would be escaped, for
example "foo>?" (i.e. "foo|foo>").
 gitweb/gitweb.perl |   28 +++++++++++++++++++++++++++-
 1 files changed, 27 insertions(+), 1 deletions(-)
diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
index 9c82d79..692a6bb 100755
--- a/gitweb/gitweb.perl
+++ b/gitweb/gitweb.perl
@@ -1690,6 +1690,30 @@ sub chop_and_escape_str {
 	}
 }
 
+# highlight match (if any), and escape HTML
+sub esc_html_match_hl {
+	my ($str, $regexp) = @_;
+	return esc_html($str) unless defined $regexp;
+
+	my @matches;
+	while ($str =~ /$regexp/g) {
+		push @matches, [$-[0], $+[0]];
+	}
+	return esc_html($str) unless @matches;
+
+	my $out = '';
+	my $pos = 0;
+	for my $m (@matches) {
+		$out .= esc_html(substr $str, $pos, $m->[0] - $pos);
+		$out .= $cgi->span({-class => 'match'},
+		                   esc_html(substr $str, $m->[0], $m->[1] - $m->[0]));
+		$pos = $m->[1];
+	}
+	$out .= esc_html(substr $str, $pos);
+
+	return $out;
+}
+
 ## ----------------------------------------------------------------------
 ## functions returning short strings
 
@@ -5143,7 +5167,9 @@ sub git_project_list_rows {
 			print "</td>\n";
 		}
 		print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
-		                        -class => "list"}, esc_html($pr->{'path'})) . "</td>\n" .
+		                        -class => "list"},
+		                       esc_html_match_hl($pr->{'path'}, $search_regexp)) .
+		      "</td>\n" .
 		      "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
 		                        -class => "list", -title => $pr->{'descr_long'}},
 		                        esc_html($pr->{'descr'})) . "</td>\n" .
-- 
1.7.5
Previous: Jakub NarebskiNext: Jakub Narebski
Message 6 of 8 in “gitweb: Improve project search”
  1. 0/6 gitweb: Improve project searchJakub Narebski, Jul 29, 2011
  2. 1/6 gitweb: Allow underscore in $searchtype ('st')Jakub Narebski, Jul 29, 2011
  3. 2/6 gitweb: Improve projects search formJakub Narebski, Jul 29, 2011
  4. 3/6 gitweb: Option for filling only specified info in fill_project_list_infoJakub Narebski, Jul 29, 2011
  5. 4/6 gitweb: Faster project searchJakub Narebski, Jul 29, 2011
  6. 5/6 gitweb: Highlight matched part of project name when searching projectsJakub Narebski, Jul 29, 2011
  7. 6/6 gitweb: Highlight matched part of project description when searching projectsJakub Narebski, Jul 29, 2011
  8. 7/6 gitweb: Use esc_html_match_hl in 'grep' searchJakub Narebski, Jul 30, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.