org.sventon.web.ctrl.RSSController.java Source code

Introduction

Here is the source code for org.sventon.web.ctrl.RSSController.java

Source

/*
 * ====================================================================
 * Copyright (c) 2005-2012 sventon project. All rights reserved.
 *
 * This software is licensed as described in the file LICENSE, which
 * you should have received as part of this distribution. The terms
 * are also available at http://www.sventon.org.
 * If newer versions of this license are posted there, you may use a
 * newer version instead, at your option.
 * ====================================================================
 */
package org.sventon.web.ctrl;

import org.springframework.validation.BindException;
import org.springframework.web.bind.ServletRequestUtils;
import org.springframework.web.servlet.ModelAndView;
import org.sventon.AuthenticationException;
import org.sventon.NoSuchRevisionException;
import org.sventon.SVNConnection;
import org.sventon.SventonException;
import org.sventon.appl.RepositoryConfiguration;
import org.sventon.model.Credentials;
import org.sventon.model.LogEntry;
import org.sventon.rss.RssFeedGenerator;
import org.sventon.web.HttpAuthenticationHandler;
import org.sventon.web.command.RevisionRangeCommand;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * Controller used for generating RSS feeds.
 *
 * @author jesper@sventon.org
 */
public final class RSSController extends AbstractBaseController {

    /**
     * RSS mime type, default set to <tt>application/xml; charset=UTF-8</tt>.
     */
    private String mimeType = "application/xml; charset=UTF-8";

    /**
     * The feed generator.
     */
    private RssFeedGenerator rssFeedGenerator;

    /**
     * HTTP Authentication Handler.
     */
    private HttpAuthenticationHandler httpAuthenticationHandler;

    @Override
    protected ModelAndView handle(final HttpServletRequest request, final HttpServletResponse response,
            final Object cmd, final BindException errors) throws Exception {

        logger.debug("Getting RSS feed");

        final RevisionRangeCommand command = (RevisionRangeCommand) cmd;
        logger.debug(command);

        if (!application.isConfigured()) {
            handleError(response, "sventon has not been configured yet!");
            return null;
        }

        final RepositoryConfiguration configuration = application.getConfiguration(command.getName());
        if (configuration == null) {
            handleError(response, "Repository [" + command.getName() + "] does not exist!");
            return null;
        }

        addResponseHeaders(response);

        SVNConnection connection = null;

        try {
            final List<LogEntry> logEntries = new ArrayList<LogEntry>();
            connection = createRepositoryConnection(request, configuration);
            final Long headRevision = getRepositoryService().getLatestRevision(connection);
            command.setRevision(
                    getRepositoryService().translateRevision(connection, command.getRevision(), headRevision));

            logger.debug("Outputting feed for [" + command.getPath() + "]");
            logEntries.addAll(getRepositoryService().getLogEntries(connection, command.getName(),
                    command.getRevisionNumber(), command.getStopRevision().getNumber(), command.getPath(),
                    configuration.getRssItemsCount(), false, true));
            rssFeedGenerator.outputFeed(configuration, logEntries, request, response);
        } catch (AuthenticationException aex) {
            logger.info(aex.getMessage());
            httpAuthenticationHandler.sendChallenge(response);
        } catch (NoSuchRevisionException nsre) {
            logger.info(nsre.getMessage());
        } catch (SventonException svnex) {
            logger.debug(svnex.getMessage(), svnex);
            logger.error(svnex.getMessage());
            response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, "Unable to generate RSS feed");
        } finally {
            close(connection);
        }
        return null;
    }

    private SVNConnection createRepositoryConnection(final HttpServletRequest request,
            final RepositoryConfiguration configuration) throws SventonException {
        final Credentials credentials = extractCredentials(request, configuration);
        return connectionFactory.createConnection(configuration.getName(), configuration.getSVNURL(), credentials);
    }

    private void close(SVNConnection connection) {
        if (connection != null) {
            connection.closeSession();
        }
    }

    private void addResponseHeaders(HttpServletResponse response) {
        response.setContentType(mimeType);
        response.setHeader("Cache-Control", "no-cache");
    }

    private void handleError(HttpServletResponse response, String errorMessage) throws IOException {
        logger.error(errorMessage);
        response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, errorMessage);
    }

    private Credentials extractCredentials(HttpServletRequest request, RepositoryConfiguration configuration) {
        final Credentials credentialsFromUrlParameters = extractCredentialsFromRequest(request);

        final Credentials credentials;
        if (configuration.isAccessControlEnabled()) {
            if (httpAuthenticationHandler.isLoginAttempt(request)) {
                logger.debug("Basic HTTP authentication detected. Parsing credentials from request.");
                credentials = httpAuthenticationHandler.parseCredentials(request);
            } else {
                logger.debug("Parsing credentials from url");
                credentials = credentialsFromUrlParameters;
            }
        } else {
            credentials = configuration.getUserCredentials();
        }
        return credentials;
    }

    private Credentials extractCredentialsFromRequest(HttpServletRequest request) {
        return new Credentials(ServletRequestUtils.getStringParameter(request, "userName", null),
                ServletRequestUtils.getStringParameter(request, "userPassword", null));
    }

    /**
     * Sets the mime-type for the feed.
     *
     * @param mimeType The mime-type
     */
    public void setMimeType(final String mimeType) {
        this.mimeType = mimeType;
    }

    /**
     * Sets the feed generator.
     *
     * @param rssFeedGenerator The generator.
     */
    public void setRssFeedGenerator(final RssFeedGenerator rssFeedGenerator) {
        this.rssFeedGenerator = rssFeedGenerator;
    }

    /**
     * Sets the authentication handler to use.
     *
     * @param httpAuthenticationHandler Handler
     */
    public void setHttpAuthenticationHandler(final HttpAuthenticationHandler httpAuthenticationHandler) {
        this.httpAuthenticationHandler = httpAuthenticationHandler;
    }
}