From b21288bc78316d1c7fb3e5e3acadd8f10ef4e7e1 Mon Sep 17 00:00:00 2001
From: Ian Young <ian@iay.org.uk>
Date: Mon, 7 Nov 2016 11:53:57 +0000
Subject: [PATCH] Move the MDUI statistics generator into /charting

With this change, the MDUI charting is based on the cached monthly
aggregate rather than being dependent on the current registered
metadata on the day the script happens to be run. This means it can
be run retrospectively as far back as 2012, when we started
including registrationAuthority metadata.
---
 build.xml                               | 27 -------------
 charting/mdui.pl                        | 36 +++++++++++++++++
 {build => charting}/statistics_mdui.xsl | 52 +++++++++++++------------
 3 files changed, 63 insertions(+), 52 deletions(-)
 create mode 100755 charting/mdui.pl
 rename {build => charting}/statistics_mdui.xsl (96%)

diff --git a/build.xml b/build.xml
index d3ab3ce3..6d76b786 100644
--- a/build.xml
+++ b/build.xml
@@ -2223,33 +2223,6 @@
                x="${build.dir}/list_uiinfo.xsl"/>
     </target>
 
-    <!--
-        *******************************
-        ***                         ***
-        ***   M D U I   S T A T S   ***
-        ***                         ***
-        *******************************
-    -->
-
-    <target name="mdui.stats">
-        <input addproperty="channel">
-            Please select the channel to use (e.g., us_incommon):
-        </input>
-        <if>
-            <equals arg1="${channel}" arg2="uk"/>
-            <then>
-                <CHANNEL.do verb="collect" channel="uk"/>
-                <XALAN.noout i="${mdx.dir}/uk/collected.xml"
-                       x="${build.dir}/statistics_mdui.xsl"/>
-            </then>
-            <else>
-                <CHANNEL.do verb="importRaw" channel="${channel}"/>
-                <XALAN.noout i="${mdx.dir}/${channel}/imported.xml"
-                       x="${build.dir}/statistics_mdui.xsl"/>
-            </else>
-        </if>
-    </target>
-
     <!--
         *******************************
         ***                         ***
diff --git a/charting/mdui.pl b/charting/mdui.pl
new file mode 100755
index 00000000..b6e14bd0
--- /dev/null
+++ b/charting/mdui.pl
@@ -0,0 +1,36 @@
+#!/usr/bin/env perl -w
+
+#
+# mdui.pl
+#
+use lib "../build";
+use Xalan;
+use Months;
+
+# Parse command line arguments
+use Getopt::Long;
+my $allMonths;
+my $oneYear;
+GetOptions('all' => \$allMonths, 'year' => \$oneYear);
+
+# By default, only show results for the most recent month
+if ($allMonths) {
+	# leave table intact
+} elsif ($oneYear) {
+	# reduce months table to just the last 12 entries
+	@months = @months[-12..-1];
+} else {
+	# reduce months table to one element
+	@months = @months[-1..-1];
+}
+
+# ingest files
+foreach $month (@months) {
+	print "Processing $month\n";
+
+	my $command = xalanCall . " -IN cache/$month.xml -XSL statistics_mdui.xsl";
+	# print "command is $command\n";
+	system($command); # || print "ignoring claimed failure in sub command\n";
+	# print "Xalan run on $fn\n";
+	print "\n";
+}
diff --git a/build/statistics_mdui.xsl b/charting/statistics_mdui.xsl
similarity index 96%
rename from build/statistics_mdui.xsl
rename to charting/statistics_mdui.xsl
index 793baf04..1faf2ae3 100644
--- a/build/statistics_mdui.xsl
+++ b/charting/statistics_mdui.xsl
@@ -1,17 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    
+
     statistics_mdui.xsl
-    
+
     XSL stylesheet taking a metadata aggregate and giving some statistics about MDUI
     element use as textual output.
-    
+
     Author: Ian A. Young <ian@iay.org.uk>
 
 -->
 <xsl:stylesheet
     xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
     xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"
+    xmlns:mdrpi="urn:oasis:names:tc:SAML:metadata:rpi"
     xmlns:mdui="urn:oasis:names:tc:SAML:metadata:ui"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:math="http://exslt.org/math"
@@ -22,10 +23,11 @@
     version="1.0">
 
     <xsl:output method="text" omit-xml-declaration="yes"/>
-    
+
     <xsl:template match="/md:EntitiesDescriptor">
-        
-        <xsl:variable name="entities" select="//md:EntityDescriptor"/>
+
+        <xsl:variable name="entities" select="//md:EntityDescriptor
+		[descendant::mdrpi:RegistrationInfo/@registrationAuthority='http://ukfederation.org.uk']"/>
         <xsl:variable name="idps" select="$entities[md:IDPSSODescriptor]"/>
         <xsl:variable name="sps" select="$entities[md:SPSSODescriptor]"/>
 
@@ -33,100 +35,100 @@
             <xsl:with-param name="category">Total entities</xsl:with-param>
             <xsl:with-param name="entities" select="$entities"/>
         </xsl:call-template>
-        
+
         <xsl:call-template name="entities.category">
             <xsl:with-param name="category">Identity providers</xsl:with-param>
             <xsl:with-param name="entities" select="$idps"/>
         </xsl:call-template>
-        
+
         <xsl:call-template name="entities.category">
             <xsl:with-param name="category">Service providers</xsl:with-param>
             <xsl:with-param name="entities" select="$sps"/>
         </xsl:call-template>
-        
+
     </xsl:template>
 
     <xsl:template name="entities.category">
         <xsl:param name="entities"/>
         <xsl:param name="category"/>
         <xsl:variable name="entities.count" select="count($entities)"/>
-        
+
         <xsl:value-of select="$category"/>
         <xsl:text>: </xsl:text>
         <xsl:value-of select="$entities.count"/>
         <xsl:text>&#10;</xsl:text>
-        
+
         <xsl:if test="$entities.count > 0">
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:UIInfo</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:UIInfo]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:Logo</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:Logo]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:Description</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:Description]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:DisplayName</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:DisplayName]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:Keywords</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:Keywords]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:InformationURL</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:InformationURL]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:PrivacyStatementURL</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:PrivacyStatementURL]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-                        
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:DiscoHints</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:DiscoHints]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:IPHint</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:IPHint]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:DomainHint</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:DomainHint]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
             <xsl:call-template name="mdui.element">
                 <xsl:with-param name="element">mdui:GeolocationHint</xsl:with-param>
                 <xsl:with-param name="has" select="$entities[descendant::mdui:GeolocationHint]"/>
                 <xsl:with-param name="total.count" select="$entities.count"/>
             </xsl:call-template>
-            
+
         </xsl:if>
     </xsl:template>
-    
+
     <xsl:template name="mdui.element">
         <xsl:param name="element"/>
         <xsl:param name="has"/>
@@ -142,5 +144,5 @@
             <xsl:text>)&#10;</xsl:text>
         </xsl:if>
     </xsl:template>
-    
+
 </xsl:stylesheet>