From: Jakub Narebski <jnareb@gmail.com>
To: git@vger.kernel.org
Cc: Petr Baudis <pasky@suse.cz>, Fredrik Kuivinen <frekui@gmail.com>,
Giuseppe Bilotta <giuseppe.bilotta@gmail.com>,
Luben Tuikov <ltuikov@yahoo.com>,
Martin Koegler <mkoegler@auto.tuwien.ac.at>,
Jakub Narebski <jnareb@gmail.com>
Subject: [PATCHv2/RFC 3/3] gitweb: Create links leading to 'blame_incremental' using JavaScript
Date: Thu, 6 Aug 2009 19:11:52 +0200 [thread overview]
Message-ID: <1249578712-3862-4-git-send-email-jnareb@gmail.com> (raw)
In-Reply-To: <1249578712-3862-1-git-send-email-jnareb@gmail.com>
The new 'blame_incremental' view requires JavaScript to run. Not all
web browsers implement JavaScript (e.g. text browsers such as Lynx),
and not all users have JavaScript enabled. Therefore instead of
unconditionally link to 'blame_incremental' view, we use JavaScript to
convert those links to lead to view utilizing JavaScript, by adding
'js=1' to link.
The only JavaScript-aware/using view is currently 'blame_incremental'.
As first, it might want to have links to non-JavaScript version, and
second, it should also use window.onload, we do not add nor run
fixLinks() for such views (currently hardcoded 'blame_incremental')
Possible enhancement would be to do JavaScript redirect by setting
window.location instead of modifying $format and $action in
git_blame_common() subroutine.
This idea was originally implemented by Petr Baudis in
http://article.gmane.org/gmane.comp.version-control.git/47614
but it added <script> element with fixBlameLinks() function in page
header, to be added as onload event using 'onload' attribute of HTML
'body' element: <body onload="fixBlameLinks();">. This version adds
script at then end of page (in the page footer), and uses JavaScript
'window.onload=fixLinks();'. Also in Petr version only links marked
with 'blamelink' class were modified, and they were modified by
replacing "a=blame" by "a=blame_incremental"... which doesn't work for
path_info links, and might replace wrong part if there is "a=blame" in
project name, ref name or file name.
Slightly different solution was implemented by Martin Koegler in
http://thread.gmane.org/gmane.comp.version-control.git/47902/focus=47905
Here GitAddLinks() function was in gitweb.js file, not as contents of
<script> element. This might be a better solution (although I think
it would be better to split JavaScript file and load only parts that
are required). It was also included in page header (in <head>
element) though, which means waiting for a script to load (and run).
It was smarter in that to "fix" (modify) link, it split URL, modified
value of 'a' parameter, and then recreated modified link. It avoids
trouble with "a=blame" as substring in project name or file name, but
it doesn't work with path_info URL/link in the way it was written.
Signed-off-by: Jakub Narebski <jnareb@gmail.com>
---
This is nearly the same as previous (first) version, it only doesn't
have unrelated changes to blame.js that were included in earlier
version by mistake.
TODO list:
* Put fixLinks() function in gitweb.js, together with all code
required for 'blame_incremental' view.
* Better solution to "don't invoke for JavaScript-aware actions"
problem. Currently hardcoded 'blame_incremental'.
The problem to be solved is that we might want in views utilizing
JavaScript to have fallback links to version not using JavaScript.
TODO for future commits:
* Use 'click' event to change links to jave 'js=1' parameter appended;
this way we would check if JavaScript is enabled at the moment of
following (clicking) link, not at the moment of loading the page.
Unfortunately adding event listeners (much better solution than
providing/adding 'onclick' attribute) is different in different
browsers.
gitweb/gitweb.perl | 21 +++++++++++++++++++++
2 files changed, 23 insertions(+), 2 deletions(-)
diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
index b94ce10..32cbb20 100755
--- a/gitweb/gitweb.perl
+++ b/gitweb/gitweb.perl
@@ -3242,6 +3242,23 @@ sub git_footer_html {
insert_file($site_footer);
}
+ if ($action ne 'blame_incremental') {
+ print <<'HTML';
+<script type="text/javascript">/* <![CDATA[ */
+function fixLinks() {
+ //var allLinks = document.getElementsByTagName("a");
+ var allLinks = document.links;
+ for (var i = 0; i < allLinks.length; i++) {
+ var link = allLinks[i];
+ link.href +=
+ (link.href.indexOf('?') === -1 ? '?' : ';') + 'js=1';
+ }
+}
+window.onload = fixLinks;
+/* ]]> */</script>
+HTML
+ }
+
print "</body>\n" .
"</html>";
}
@@ -4793,6 +4810,10 @@ sub git_tag {
sub git_blame_common {
my $format = shift || 'porcelain';
+ if ($format eq 'porcelain' && $cgi->param('js')) {
+ $format = 'incremental';
+ $action = 'blame_incremental'; # for page title etc
+ }
# permissions
gitweb_check_feature('blame')
--
1.6.3.3
prev parent reply other threads:[~2009-08-06 17:12 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-08-06 17:11 [PATCH 0/3] gitweb: Incremental blame series Jakub Narebski
2009-08-06 17:11 ` [PATCH/RFC 1/3] gitweb: Add optional "time to generate page" info in footer Jakub Narebski
2009-08-06 17:11 ` [PATCHv3/RFC 2/3] gitweb: Incremental blame (proof of concept) Jakub Narebski
2009-08-12 17:08 ` [PATCHv4/RFC 2/3] gitweb: Incremental blame (WIP) Jakub Narebski
2009-08-06 17:11 ` Jakub Narebski [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1249578712-3862-4-git-send-email-jnareb@gmail.com \
--to=jnareb@gmail.com \
--cc=frekui@gmail.com \
--cc=git@vger.kernel.org \
--cc=giuseppe.bilotta@gmail.com \
--cc=ltuikov@yahoo.com \
--cc=mkoegler@auto.tuwien.ac.at \
--cc=pasky@suse.cz \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).