Add annotation with revision description

(thanks to Emilio Monti - [email protected] for idea and original code - http://www.emilmont.net/doku.php?id=java:opengrok )
license stuff fixes
only show line # button when showing a file

Author: Lubos Kosco

LICENSE.txt

@@ -2,6 +2,8 @@ Unless otherwise noted, all files in this distribution are released
 under the Common Development and Distribution License (CDDL),
 Version 1.0 only.  Exceptions are noted within the associated
 source files.
+Where we have dual MIT and GPL license we choosen MIT license.
+File NOTICE.txt contains all notices from apache licensed software we distribute.
 
 --------------------------------------------------------------------
 

NOTICE.txt

@@ -0,0 +1,32 @@
+List of notices from Apache licensed software OpenGrok uses:
+
+Apache Lucene
+Copyright 2006 The Apache Software Foundation
+
+This product includes software developed by
+The Apache Software Foundation (http://www.apache.org/).
+
+The snowball stemmers in
+  contrib/snowball/src/java/net/sf/snowball
+were developed by Martin Porter and Richard Boulton.
+The full snowball package is available from
+  http://snowball.tartarus.org/
+
+The Arabic stemmer (contrib/analyzers) comes with a default
+stopword list that is BSD-licensed created by Jacques Savoy.  The file resides in 
+contrib/analyzers/common/src/resources/org/apache/lucene/analysis/ar/stopwords.txt.
+See http://members.unine.ch/jacques.savoy/clef/index.html.
+
+The Persian analyzer (contrib/analyzers) comes with a default
+stopword list that is BSD-licensed created by Jacques Savoy.  The file resides in
+contrib/analyzers/common/src/resources/org/apache/lucene/analysis/fa/stopwords.txt.
+See http://members.unine.ch/jacques.savoy/clef/index.html.
+
+Includes lib/servlet-api-2.4.jar from  Apache Tomcat
+
+The SmartChineseAnalyzer source code (under contrib/analyzers) was
+provided by Xiaoping Gao and copyright 2009 by www.imdict.net.
+
+ICU4J, (under contrib/collation) is licensed under an MIT styles license
+(contrib/collation/lib/ICU-LICENSE.txt) and Copyright (c) 1995-2008 
+International Business Machines Corporation and others

conf/default/jquery.tooltip.css

@@ -0,0 +1,9 @@
+#tooltip {
+	position: absolute;
+	z-index: 3000;
+	border: 1px solid #111;
+	background-color: #eee;
+	padding: 5px;
+        opacity: 0.90;
+}
+#tooltip h3, #tooltip div { margin: 0; font-size: small; }

conf/offwhite/jquery.tooltip.css

@@ -0,0 +1,9 @@
+#tooltip {
+	position: absolute;
+	z-index: 3000;
+	border: 1px solid #111;
+	background-color: #eee;
+	padding: 5px;
+        opacity: 0.90;
+}
+#tooltip h3, #tooltip div { margin: 0; font-size: small; }

conf/polished/jquery.tooltip.css

@@ -0,0 +1,9 @@
+#tooltip {
+	position: absolute;
+	z-index: 3000;
+	border: 1px solid #111;
+	background-color: #eee;
+	padding: 5px;
+        opacity: 0.90;
+}
+#tooltip h3, #tooltip div { margin: 0; font-size: small; }

src/org/opensolaris/opengrok/history/Annotation.java

@@ -24,16 +24,26 @@
 
 package org.opensolaris.opengrok.history;
 
+import java.io.IOException;
+import java.io.StringWriter;
+import java.io.Writer;
 import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
 import java.util.List;
 
+import java.util.Map.Entry;
+import java.util.HashSet;
+import org.opensolaris.opengrok.web.Util;
+
 /**
  * Class representing file annotation, i.e., revision and author for the last
  * modification of each line in the file.
  */
 public class Annotation {
 
     private final List<Line> lines = new ArrayList<Line>();
+    private final HashMap<String, String> desc = new HashMap<String, String>();
     private int widestRevision;
     private int widestAuthor;
     private final String filename;
@@ -57,6 +67,20 @@ public String getRevision(int line) {
         }
     }
 
+    /**
+     * Gets all revisions that are in use, first is the lowest one (sorted using natural order)
+     *     
+     * @return list of all revisions the file has
+     */
+    public HashSet<String> getRevisions() {
+        HashSet<String> ret=new HashSet<String>();
+        for (Iterator<Line> it = this.lines.iterator(); it.hasNext();) {
+            Line ln = it.next();
+            ret.add(ln.revision);            
+        }        
+        return ret;
+    }
+
     /**
      * Gets the author who last modified the specified line.
      *
@@ -127,6 +151,14 @@ void addLine(String revision, String author, boolean enabled) {
         widestAuthor = Math.max(widestAuthor, line.author.length());
     }
 
+    void addDesc(String revision, String description) {        
+        desc.put(revision, Util.encode(description));
+    }
+
+    public String getDesc(String revision) {        
+        return desc.get(revision);
+    }
+
     /** Class representing one line in the file. */
     private static class Line {
         final String revision;
@@ -142,4 +174,34 @@ private static class Line {
     public String getFilename() {
         return filename;
     }
+
+    //TODO below might be useless, need to test with more SCMs and different commit messages
+    // to see if it will not be usefull, if title attribute of <a> loses it's breath
+    public void writeTooltipMap(Writer out) throws IOException {
+    	StringBuffer map = new StringBuffer();
+    	map.append("<script type=\"text/javascript\">\n");
+        map.append("    var desc = new Object();\n");
+        for (Entry<String, String> entry : desc.entrySet()) {
+        	map.append("desc['"+entry.getKey()+"'] = \""+entry.getValue()+"\";\n");
+        }
+        map.append("</script>\n");
+    	out.write(map.toString());
+    }
+
+    @Override
+    public String toString() {
+    	StringBuffer sb = new StringBuffer();
+    	for (Line line : lines) {
+    		sb.append(line.revision+"|"+line.author+": "+"\n");
+    	}
+    	StringWriter sw = new StringWriter();
+    	try {
+			writeTooltipMap(sw);
+		} catch (IOException e) {
+			e.printStackTrace();
+		}
+		sb.append(sw.toString());
+
+    	return sb.toString();
+    } 
 }

src/org/opensolaris/opengrok/history/HistoryGuru.java

@@ -30,6 +30,8 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.HashSet;
+import java.util.Iterator;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
@@ -122,6 +124,30 @@ public Annotation annotate(File file, String rev) throws IOException {
         Repository repos = getRepository(file);
         if (repos != null) {
             ret = repos.annotate(file, rev);
+            History hist = null;
+            boolean h=true;
+            try {
+                hist = repos.getHistory(file);
+            } catch (HistoryException ex) {
+                Logger.getLogger(HistoryGuru.class.getName()).log(Level.FINEST, "Cannot get messages for tooltip: ", ex);
+                h=false;
+            }
+            if (h) {
+             HashSet<String> revs=ret.getRevisions();
+             List<HistoryEntry> hent = hist.getHistoryEntries();
+             //if (hent.indexOf(rev)>0) {
+             // hent = hent.subList(hent.indexOf(rev), hent.size()); // !!! cannot do this because of not matching rev ids (keys)
+              //first is the most recent one, so we need the position of "rev" until the end of the list
+             //}
+             for (Iterator it = hent.iterator(); it.hasNext();) {
+                HistoryEntry he = (HistoryEntry) it.next();
+                String cmr=he.getRevision();
+                String[] brev=cmr.split(":"); //TODO this is only for mercurial, for other SCMs it might also be a problem, we need to revise how we shorten the rev # for annotate
+                if (revs.contains(brev[0])) {
+                    ret.addDesc(brev[0], "changeset: "+he.getRevision()+"\nsummary: "+he.getMessage()+"\nuser: "+he.getAuthor()+"\ndate: "+he.getDate());
+                }
+             }
+            }
         }
 
         return ret;

src/org/opensolaris/opengrok/history/MercurialRepository.java

@@ -209,13 +209,13 @@ public Annotation annotate(File file, String revision) throws IOException {
                 Matcher matcher = ANNOTATION_PATTERN.matcher(line);
                 if (matcher.find()) {
                     String author = matcher.group(1);
-                    String rev = matcher.group(2);
-                    ret.addLine(rev, author, true);
+                    String rev = matcher.group(2);                    
+                    ret.addLine(rev, author, true);                    
                 } else {
                     OpenGrokLogger.getLogger().log(Level.SEVERE, "Error: did not find annotation in line " + 
                             lineno + ": [" + line + "]");
                 }
-            }
+            }                    
         } finally {
             if (in != null) {
                 try {

src/org/opensolaris/opengrok/web/Util.java

@@ -285,6 +285,33 @@ public static String redableSize(long num) {
         }
     }
 
+    /**
+     * Converts different html special characters into their encodings used in html
+     * currently used only for tooltips of annotation revision number view
+     * @param s input text
+     * @return encoded text for use in <a title=""> tag
+     */
+    public static String encode(String s) {
+    	StringBuffer sb = new StringBuffer();
+    	for (int i = 0; i < s.length(); i++) {
+    		char c = s.charAt(i);
+
+        switch (c) {
+        		case '"': sb.append("'"); break; // \\\"
+	    		case '&': sb.append("&amp;"); break;
+	            case '>': sb.append("&gt;"); break;
+	            case '<': sb.append("&lt;"); break;
+    			case ' ': sb.append("&nbsp;"); break;
+    			case '\t': sb.append("&nbsp;&nbsp;&nbsp;&nbsp;"); break;
+    			case '\n': sb.append("<br/>"); break;
+    			case '\r': break;
+    			default: sb.append(c); break;
+    		}
+    	}
+
+    	return sb.toString();
+    } 
+
     public static void readableLine(int num, Writer out, Annotation annotation)
             throws IOException {
         String snum = String.valueOf(num);
@@ -316,6 +343,10 @@ public static void readableLine(int num, Writer out, Annotation annotation)
                 out.write(URIEncode(annotation.getFilename()));
                 out.write("?a=true&amp;r=");
                 out.write(URIEncode(r));
+                String msg=annotation.getDesc(r);
+                if (msg!=null) {
+                 out.write("\" id=\"r\" title=\""+msg+"\"");
+                }
                 out.write(closeQuotedTag);
             }
 

web/httpheader.jspf

@@ -36,6 +36,7 @@ String httpHeaderContext = request.getContextPath();
     <link rel="stylesheet" type="text/css" href="<%=httpHeaderContext%>/<%=laf%>/style.css"/>
     <link rel="stylesheet" type="text/css" href="<%=httpHeaderContext%>/<%=laf%>/print.css" media="print" />
     <link rel="stylesheet" type="text/css" href="<%=httpHeaderContext%>/<%=laf%>/jquery.autocomplete.css" />
+    <link rel="stylesheet" type="text/css" href="<%=httpHeaderContext%>/<%=laf%>/jquery.tooltip.css" />
     <link rel="alternate stylesheet" type="text/css" media="all" title="Paper White" href="<%=httpHeaderContext%>/<%=laf%>/print.css"/>
     <link rel="search" href="<%=httpHeaderContext%>/opensearch" type="application/opensearchdescription+xml" title="OpenGrok Search for current project(s)" />
     <title><%=pageTitle%></title>

web/jquery.tooltip-1.3.pack.js

@@ -16,7 +16,7 @@ information: Portions Copyright [yyyy] [name of copyright owner]
 
 CDDL HEADER END
 
-Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
+Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 Use is subject to license terms.
 --%><%@ page import = "javax.servlet.*,
 java.lang.*,
@@ -34,22 +34,10 @@ org.opensolaris.opengrok.web.*,
 org.opensolaris.opengrok.history.*
 "
 %><%@include file="mast.jsp"%><script type="text/javascript">/* <![CDATA[ */
-    function toggle_annotations() {
-   var spans = document.getElementsByTagName("span");
-
-   for (var i = 0; i < spans.length; i++) {
-      var span = spans[i];
-      if (span.className == 'blame') {
-         span.className = 'blame-hidden';
-      } else if (span.className == 'blame-hidden') {
-         span.className = 'blame';
-      }
-   }
-}
 function lntoggle() {
-       var a = document.getElementsByTagName("a");
+   var a = document.getElementsByTagName("a");
    for (var i = 0; i < a.length; i++) {
-      var el = a[i]; //fix all line #
+      var el = a[i];
       if (el.className == 'l' || el.className == 'hl') {
          el.className=el.className+'-hide';
          el.setAttribute("tmp", el.innerHTML);
@@ -61,8 +49,7 @@ function lntoggle() {
       }
    }
 }
-/* ]]> */
-</script><%
+/* ]]> */</script><%
 String rev = null;
 if(!isDir && ef != null) {
     try {
@@ -201,6 +188,7 @@ if (valid) {
 		            %><div id="src"><span class="pagetitle"><%=basename%> revision <%=rev%> </span><pre><%
                             if (g == Genre.PLAIN) {
                                 Annotation annotation = annotate ? HistoryGuru.getInstance().annotate(resourceFile, rev) : null;
+                                //annotation.writeTooltipMap(out); //not needed yet
                                 AnalyzerGuru.writeXref(a, in, out, annotation, Project.getProject(resourceFile));
                             } else if (g == Genre.IMAGE) {
 			       %><img src="<%=context%>/raw<%=path%>?r=<%=rev%>"/><%
@@ -275,7 +263,7 @@ if (valid) {
                 }
             } else if(g == Genre.PLAIN) {
                 %><div id="src"><pre><%
-                Annotation annotation = annotate ? HistoryGuru.getInstance().annotate(resourceFile, rev) : null;
+                Annotation annotation = annotate ? HistoryGuru.getInstance().annotate(resourceFile, rev) : null;                
                 AnalyzerGuru.writeXref(a, bin, out, annotation, Project.getProject(resourceFile));
                 %></pre></div><%
             } else {