/*
* The MIT License
*
* Copyright (c) 2004-2011, Oracle Corporation, Andrew Bayer, Anton Kozak, Nikita Levyankov
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.plugins.git.browser;
import hudson.Extension;
import hudson.model.Descriptor;
import hudson.plugins.git.GitChangeSet;
import hudson.plugins.git.GitChangeSet.Path;
import hudson.scm.EditType;
import hudson.scm.RepositoryBrowser;
import hudson.util.FormValidation;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import javax.servlet.ServletException;
import net.sf.json.JSONObject;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
/**
* Git Browser URLs
*/
public class GithubWeb extends GitRepositoryBrowser {
private static final long serialVersionUID = 1L;
private final URL url;
@DataBoundConstructor
public GithubWeb(String url) throws MalformedURLException {
this.url = normalizeToEndWithSlash(new URL(url));
}
public URL getUrl() {
return url;
}
@Override
public URL getChangeSetLink(GitChangeSet changeSet) throws IOException {
return new URL(url, url.getPath() + "commit/" + changeSet.getId().toString());
}
/**
* Creates a link to the file diff.
* http://[GitHib URL]/commit/573670a3bb1f3b939e87f1dee3e99b6bfe281fcb#diff-N
*
* @param path affected file path
* @return diff link
* @throws IOException
*/
@Override
public URL getDiffLink(Path path) throws IOException {
if (path.getEditType() != EditType.EDIT || path.getSrc() == null || path.getDst() == null
|| path.getChangeSet().getParentCommit() == null) {
return null;
}
return getDiffLinkRegardlessOfEditType(path);
}
/**
* Return a diff link regardless of the edit type by appending the index of the pathname in the changeset.
*
* @param path
* @return
* @throws IOException
*/
private URL getDiffLinkRegardlessOfEditType(Path path) throws IOException {
final GitChangeSet changeSet = path.getChangeSet();
final ArrayList<String> affectedPaths = new ArrayList<String>(changeSet.getAffectedPaths());
// Github seems to sort the output alphabetically by the path.
Collections.sort(affectedPaths);
final String pathAsString = path.getPath();
final int i = Collections.binarySearch(affectedPaths, pathAsString);
assert i >= 0;
return new URL(getChangeSetLink(changeSet), "#diff-" + String.valueOf(i));
}
/**
* Creates a link to the file.
* http://[GitHib URL]/blob/573670a3bb1f3b939e87f1dee3e99b6bfe281fcb/src/main/java/hudson/plugins/git/browser/GithubWeb.java
* Github seems to have no URL for deleted files, so just return
* a difflink instead.
*
* @param path file
* @return file link
* @throws IOException
*/
@Override
public URL getFileLink(Path path) throws IOException {
if (path.getEditType().equals(EditType.DELETE)) {
return getDiffLinkRegardlessOfEditType(path);
} else {
final String spec = "blob/" + path.getChangeSet().getId() + "/" + path.getPath();
return new URL(url, url.getPath() + spec);
}
}
@Extension
public static class GithubWebDescriptor extends Descriptor<RepositoryBrowser<?>> {
public String getDisplayName() {
return "githubweb";
}
@Override
public GithubWeb newInstance(StaplerRequest req, JSONObject jsonObject) throws FormException {
return req.bindParameters(GithubWeb.class, "githubweb.");
}
public FormValidation doCheckUrl(@QueryParameter(fixEmpty = true) final String url)
throws IOException, ServletException {
return new GitUrlChecker(url, "github").check();
}
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
GithubWeb githubWeb = (GithubWeb) o;
if (url != null ? !url.equals(githubWeb.url) : githubWeb.url != null) {
return false;
}
return true;
}
@Override
public int hashCode() {
return url != null ? url.hashCode() : 0;
}
}