SideBarViewBuilder.cs :  » Build-Systems » CruiseControl.NET » ThoughtWorks » CruiseControl » WebDashboard » Dashboard » C# / CSharp Open Source

using System.Collections;
using System.Collections.Generic;
using System.Web;
using ThoughtWorks.CruiseControl.Core.Reporting.Dashboard.Navigation;
using ThoughtWorks.CruiseControl.WebDashboard.IO;
using ThoughtWorks.CruiseControl.WebDashboard.MVC;
using ThoughtWorks.CruiseControl.WebDashboard.MVC.View;
using ThoughtWorks.CruiseControl.WebDashboard.Plugins.BuildReport;
using ThoughtWorks.CruiseControl.WebDashboard.ServerConnection;
using ThoughtWorks.CruiseControl.WebDashboard.Plugins.FarmReport;

namespace ThoughtWorks.CruiseControl.WebDashboard.Dashboard{
    public class SideBarViewBuilder : IConditionalGetFingerprintProvider
    {
        private readonly ICruiseRequest request;
        private readonly IBuildNameRetriever buildNameRetriever;
        private readonly IRecentBuildsViewBuilder recentBuildsViewBuilder;
        private readonly IPluginLinkCalculator pluginLinkCalculator;
        private readonly IVelocityViewGenerator velocityViewGenerator;
        private readonly ILinkListFactory linkListFactory;
        private readonly ILinkFactory linkFactory;
        private readonly IFarmService farmService;
        private readonly IFingerprintFactory fingerprintFactory;

        public SideBarViewBuilder(ICruiseRequest request, IBuildNameRetriever buildNameRetriever, IRecentBuildsViewBuilder recentBuildsViewBuilder, IPluginLinkCalculator pluginLinkCalculator, IVelocityViewGenerator velocityViewGenerator, ILinkFactory linkFactory, ILinkListFactory linkListFactory, IFarmService farmService, IFingerprintFactory fingerprintFactory)
        {
            this.request = request;
            this.buildNameRetriever = buildNameRetriever;
            this.recentBuildsViewBuilder = recentBuildsViewBuilder;
            this.pluginLinkCalculator = pluginLinkCalculator;
            this.velocityViewGenerator = velocityViewGenerator;
            this.linkListFactory = linkListFactory;
            this.linkFactory = linkFactory;
            this.farmService = farmService;
            this.fingerprintFactory = fingerprintFactory;
        }

        private IAbsoluteLink[] GetCategoryLinks(IServerSpecifier serverSpecifier)
        {
            if (serverSpecifier == null)
                return null;

            // create list of categories
            List<string> categories = new List<string>();

            foreach (ProjectStatusOnServer status in farmService
                .GetProjectStatusListAndCaptureExceptions(serverSpecifier, request.RetrieveSessionToken())
                .StatusAndServerList)
            {
                string category = status.ProjectStatus.Category;

                if (!string.IsNullOrEmpty(category) && !categories.Contains(category))
                    categories.Add(category);
            }

            // sort list if at least one element exists
            if (categories.Count == 0)
                return null;
            else
                categories.Sort();

            // use just created list to assemble wanted links
            List<GeneralAbsoluteLink> links = new List<GeneralAbsoluteLink>();
            string urlTemplate = linkFactory
                .CreateServerLink(serverSpecifier, "ViewServerReport")
                .Url + "?Category=";

            foreach (string category in categories)
                links.Add(new GeneralAbsoluteLink(category, urlTemplate + HttpUtility.UrlEncode(category)));

            return links.ToArray();
        }

        
        private IAbsoluteLink[] GetCategoryLinks(IServerSpecifier[] serverSpecifiers, ICruiseRequest request)
        {
            if (serverSpecifiers == null) return null;

            List<string> categories = new List<string>();

            foreach (IServerSpecifier serverSpecifier in serverSpecifiers)
            {
                System.Diagnostics.Debug.WriteLine(serverSpecifier.ServerName);

                foreach (ProjectStatusOnServer status in farmService
                    .GetProjectStatusListAndCaptureExceptions(serverSpecifier, request.RetrieveSessionToken())
                    .StatusAndServerList)
                {
                    string category = status.ProjectStatus.Category;
                    System.Diagnostics.Debug.WriteLine(category);


                    if (!string.IsNullOrEmpty(category) && !categories.Contains(category))
                        categories.Add(category);
                }
            }

            // sort list if at least one element exists
            if (categories.Count == 0) return null;

            categories.Sort();

            // use just created list to assemble wanted links
            List<GeneralAbsoluteLink> links = new List<GeneralAbsoluteLink>();
            string urlTemplate = linkFactory.CreateFarmLink("Dashboard", ThoughtWorks.CruiseControl.WebDashboard.Plugins.FarmReport.FarmReportFarmPlugin.ACTION_NAME).Url + "?Category=";

            foreach (string category in categories)
                links.Add(new GeneralAbsoluteLink(category, urlTemplate + HttpUtility.UrlEncode(category)));

            return links.ToArray();
        }

        public HtmlFragmentResponse Execute(ICruiseRequest request)
        {
            Hashtable velocityContext = new Hashtable();
            string velocityTemplateName;

            string serverName = request.ServerName;
            if (serverName == string.Empty)
            {
                velocityContext["links"] = pluginLinkCalculator.GetFarmPluginLinks();

                IServerSpecifier[] serverspecifiers = farmService.GetServerSpecifiers();
                velocityContext["serverlinks"] = linkListFactory.CreateServerLinkList(serverspecifiers, "ViewServerReport");

                IAbsoluteLink[] categoryLinks = GetCategoryLinks(serverspecifiers, request);
                velocityContext["showCategories"] = (categoryLinks != null) ? true : false;
                velocityContext["categorylinks"] = categoryLinks;
                velocityContext["farmLink"] = linkFactory.CreateFarmLink("Dashboard", FarmReportFarmPlugin.ACTION_NAME);
                velocityTemplateName = @"FarmSideBar.vm";
            }
            else
            {
                string projectName = request.ProjectName;
                if (projectName == string.Empty)
                {
                    IServerSpecifier serverSpecifier = request.ServerSpecifier;
                    velocityContext["links"] = pluginLinkCalculator.GetServerPluginLinks(serverSpecifier);
                    velocityContext["serverlink"] = linkFactory.CreateServerLink(serverSpecifier, "ViewServerReport");

                    IAbsoluteLink[] categoryLinks = new IAbsoluteLink[0];
                    try
                    {
                        categoryLinks = GetCategoryLinks(serverSpecifier);
                    }
                    catch
                    {
                        // Ignore any error here - this is normally because the URL is incorrect, the error will be displayed in the main content
                    }

                    velocityContext["showCategories"] = (categoryLinks != null) ? true : false;
                    velocityContext["categorylinks"] = categoryLinks;

                    velocityTemplateName = @"ServerSideBar.vm";
                }
                else
                {
                    string buildName = request.BuildName;
                    if (buildName == string.Empty)
                    {
                        IProjectSpecifier projectSpecifier = request.ProjectSpecifier;
                        velocityContext["links"] = pluginLinkCalculator.GetProjectPluginLinks(projectSpecifier);
                        velocityContext["recentBuildsTable"] = recentBuildsViewBuilder.BuildRecentBuildsTable(projectSpecifier, request.RetrieveSessionToken());
                        velocityTemplateName = @"ProjectSideBar.vm";
                    }
                    else
                    {
                        IBuildSpecifier buildSpecifier = request.BuildSpecifier;
                        velocityContext["links"] = pluginLinkCalculator.GetBuildPluginLinks(buildSpecifier);
                        velocityContext["recentBuildsTable"] = recentBuildsViewBuilder.BuildRecentBuildsTable(buildSpecifier, request.RetrieveSessionToken());
                        velocityContext["latestLink"] = linkFactory.CreateProjectLink(request.ProjectSpecifier, LatestBuildReportProjectPlugin.ACTION_NAME);
                        velocityContext["nextLink"] = linkFactory.CreateBuildLink(buildNameRetriever.GetNextBuildSpecifier(buildSpecifier, request.RetrieveSessionToken()), string.Empty, BuildReportBuildPlugin.ACTION_NAME);
                        velocityContext["previousLink"] = linkFactory.CreateBuildLink(buildNameRetriever.GetPreviousBuildSpecifier(buildSpecifier, request.RetrieveSessionToken()), string.Empty, BuildReportBuildPlugin.ACTION_NAME);
                        velocityTemplateName = @"BuildSideBar.vm";
                    }
                }
            }

            return velocityViewGenerator.GenerateView(velocityTemplateName, velocityContext);
        }

        public ConditionalGetFingerprint GetFingerprint(IRequest request)
        {
            ConditionalGetFingerprint mostRecentTemplateFingerprint =
                fingerprintFactory.BuildFromFileNames(@"FarmSideBar.vm", @"ServerSideBar.vm", @"ProjectSideBar.vm", @"BuildSideBar.vm");
            return ((IConditionalGetFingerprintProvider)recentBuildsViewBuilder).GetFingerprint(request).Combine(
                mostRecentTemplateFingerprint);
        }
    }
}