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

[PATHv2 6/8] gitweb: retrieve snapshot format from PATH_INFO

From
Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
Date
Oct 19, 2008, 14:24 UTC
Message-ID
<1224426270-27755-1-git-send-email-giuseppe.bilotta@gmail.com>
In-Reply-To
<1224188831-17767-6-git-send-email-giuseppe.bilotta@gmail.com>

We parse requests for $project/snapshot/$head.$sfx as equivalent to $project/snapshot/$head?sf=$sfx, where $sfx is any of the known (although not necessarily supported) snapshot formats (or its default suffix).

The filename for the resulting package preserves the requested extensions (so asking for a .tgz gives a .tgz, and asking for a .tar.gz gives a .tar.gz), although for obvious reasons it doesn't preserve the basename (git/snapshot/next.tgz returns a file names git-next.tgz).

This introduces a potential case for ambiguity if a project has a head that ends with a snapshot-like suffix (.zip, .tgz, .tar.gz, etc) and the sf CGI parameter is not present; however, gitweb only produces URLs with the sf parameter, so this is only a potential issue for hand-coded URLs for extremely unusual project.

Signed-off-by: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
---

I had second thoughts on this. Now we always look for the snapshot extension if the sf CGI parameter is missing, even if the project has a head that matches the full pseudo-refname $head.$sfx.

The reason for this is that (1) there is no ambiguity for gitweb-generated URLs (2) the only URLs that could fail are hand-made URLs for extremely unusual projects and (3) it allows us to set gitweb up to generate (unambiguous) URLs without the sf CGI parameter.

This also means that I can add 3 patches to the series, instead of just one:
* patch #6 that parses the new format
* patch #7 that generates the new URLs
* patch #8 for some code refactoring
 gitweb/gitweb.perl |   34 ++++++++++++++++++++++++++++++++++
 1 files changed, 34 insertions(+), 0 deletions(-)
diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
index 99c8c20..e9e9e60 100755
--- a/gitweb/gitweb.perl
+++ b/gitweb/gitweb.perl
@@ -609,6 +609,40 @@ sub evaluate_path_info {
 			$input_params{'hash_parent'} ||= $parentrefname;
 		}
 	}
+
+	# for the snapshot action, we allow URLs in the form
+	# $project/snapshot/$hash.ext
+	# where .ext determines the snapshot and gets removed from the
+	# passed $refname to provide the $hash.
+	#
+	# To be able to tell that $refname includes the format extension, we
+	# require the following two conditions to be satisfied:
+	# - the hash input parameter MUST have been set from the $refname part
+	#   of the URL (i.e. they must be equal)
+	# - the snapshot format MUST NOT have been defined already
+	if ($input_params{'action'} eq 'snapshot' && defined $refname &&
+		$refname eq $input_params{'hash'} &&
+		!defined $input_params{'snapshot_format'}) {
+		# We loop over the known snapshot formats, checking for
+		# extensions. Allowed extensions are both the defined suffix
+		# (which includes the initial dot already) and the snapshot
+		# format key itself, with a prepended dot
+		while (my ($fmt, %opt) = each %known_snapshot_formats) {
+			my $hash = $refname;
+			my $sfx;
+			$hash =~ s/(\Q$opt{'suffix'}\E|\Q.$fmt\E)$//;
+			next unless $sfx = $1;
+			# a valid suffix was found, so set the snapshot format
+			# and reset the hash parameter
+			$input_params{'snapshot_format'} = $fmt;
+			$input_params{'hash'} = $hash;
+			# we also set the format suffix to the one requested
+			# in the URL: this way a request for e.g. .tgz returns
+			# a .tgz instead of a .tar.gz
+			$known_snapshot_formats{$fmt}{'suffix'} = $sfx;
+			last;
+		}
+	}
 }
 evaluate_path_info();
 
-- 
1.5.6.5
Previous: Giuseppe BilottaNext: Giuseppe Bilotta
Message 8 of 26 in “[PATCHv6 0/5] gitweb: PATH_INFO enhancement”
  1. Giuseppe BilottaOct 16, 2008
  2. 1/5 gitweb: parse project/action/hash_base:filename PATH_INFOGiuseppe Bilotta, Oct 16, 2008
  3. 2/5 gitweb: generate project/action/hash URLsGiuseppe Bilotta, Oct 16, 2008
  4. 3/5 gitweb: use_pathinfo filenames start with /Giuseppe Bilotta, Oct 16, 2008
  5. 4/5 gitweb: parse parent..current syntax from PATH_INFOGiuseppe Bilotta, Oct 16, 2008
  6. 5/5 gitweb: generate parent..current URLsGiuseppe Bilotta, Oct 16, 2008
  7. 6/6 gitweb: retrieve snapshot format from PATH_INFOGiuseppe Bilotta, Oct 19, 2008
  8. 6/8 gitweb: retrieve snapshot format from PATH_INFOGiuseppe Bilotta, Oct 19, 2008
  9. 7/8 gitweb: embed snapshot format parameter in PATH_INFOGiuseppe Bilotta, Oct 19, 2008
  10. 8/8 gitweb: make the supported snapshot formats array globalGiuseppe Bilotta, Oct 19, 2008
  11. Jakub NarebskiNov 2, 2008
  12. Junio C HamanoNov 2, 2008
  13. Jakub NarebskiNov 1, 2008
  14. Giuseppe BilottaNov 1, 2008
  15. Jakub NarebskiOct 21, 2008
  16. Giuseppe BilottaOct 21, 2008
  17. Junio C HamanoOct 21, 2008
  18. Jakub NarebskiOct 20, 2008
  19. Giuseppe BilottaOct 20, 2008
  20. Jakub NarebskiOct 20, 2008
  21. Giuseppe BilottaOct 20, 2008
  22. Jakub NarebskiOct 18, 2008
  23. Giuseppe BilottaOct 18, 2008
  24. Jakub NarebskiOct 19, 2008
  25. Jakub NarebskiOct 18, 2008
  26. Jakub NarebskiOct 18, 2008

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.