ReportingService.cs

/* Software License Agreement (BSD License)
 * 
 * Copyright (c) 2010-2011, Rustici Software, LLC
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL Rustici Software, LLC BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Xml;

namespace RusticiSoftware.HostedEngine.Client
{
    /// <summary>
    /// Client-side proxy for the "rustici.reporting.*" Hosted SCORM Engine web
    /// service methods.  
    /// </summary>
    public class ReportingService
    {
        private Configuration configuration = null;
        private ScormEngineService manager = null;

        /// <summary>
        /// Main constructor that provides necessary configuration information
        /// </summary>
        /// <param name="configuration">Application Configuration Data</param>
        public ReportingService(Configuration configuration, ScormEngineService manager)
        {
            this.configuration = configuration;
            this.manager = manager;
        }

        public String GetReportageServiceUrl()
        {
            return this.configuration.ScormEngineServiceUrl.Replace("EngineWebServices", "");
        }

        public String GetReportageAuth(ReportageNavPermission navPermission, bool isAdmin)
        {
            ServiceRequest request = new ServiceRequest(configuration);
            request.Parameters.Add("navpermission", navPermission.ToString().ToLower());
            request.Parameters.Add("admin", isAdmin.ToString().ToLower());
            XmlDocument response = request.CallService("rustici.reporting.getReportageAuth");
            XmlNode authNode = response.GetElementsByTagName("auth")[0];
            return authNode.InnerText;
        }
        
        /// <summary>
        /// Calling this method returns a URL which will authenticate and launch a Reportage session, starting
        /// at the specified Reportage URL entry point.
        /// </summary>
        /// <returns>A URL from which the export data can be downloaded</returns>
        public String GetReportUrl(String reportageAuth, String reportUrl)
        {
            ServiceRequest request = new ServiceRequest(configuration);
    	    //Relative path, auto add the right server name
    	    string fullReportUrl = reportUrl;
            if (reportUrl.StartsWith("/Reportage"))
            {
                fullReportUrl = "http://" + request.Server + reportUrl;
            }
            request.Parameters.Add("auth", reportageAuth);
            request.Parameters.Add("reporturl", fullReportUrl);
    	    return request.ConstructUrl("rustici.reporting.launchReport");
        }

        public String LaunchReportageUrl()
        {
            string reportAuth = this.GetReportageAuth(ReportageNavPermission.FREENAV, true);

            string reportUrl = this.GetReportageServiceUrl() + "Reportage/reportage.php?appId=" + this.configuration.AppId;
            
            return this.GetReportUrl(reportAuth,reportUrl);
        }


    }
}