[NF] allow filtering of some IX-F export content

barryo · barryo · commit 3cba6f613faf · 2021-07-16T10:48:21.000+01:00
Proof of concept for @yannrobin
diff --git a/.env.example b/.env.example
@@ -193,7 +193,14 @@ GRAPHER_BACKEND_MRTG_DBTYPE="rrd"
 ## IX-F Member Export - see: https://docs.ixpmanager.org/features/ixf-export/
 
 
-IXP_API_JSONEXPORTSCHEMA_PUBLIC=true
+# IXP_API_JSONEXPORTSCHEMA_PUBLIC=true
+
+# Some variables can be excluded is required.
+# See: https://docs.ixpmanager.org/features/ixf-export/
+#
+# IXP_API_JSONEXPORTSCHEMA_EXCLUDE_SWITCH="model|software"
+
+
 
 
 #######################################################################################
diff --git a/app/Utils/Export/JsonSchema.php b/app/Utils/Export/JsonSchema.php
@@ -99,6 +99,9 @@ public function get( string $version = null, $asArray = false, $detailed = true,
         $output['ixp_list']    = $this->getIXPInfo( $version );
         $output['member_list'] = $this->getMemberInfo( $version, $detailed, $tags );
 
+        // apply filters as some IXs don't want to export all details
+        $output = $this->filter($output);
+
         if( $asArray ) {
             return $output;
         }
@@ -511,4 +514,28 @@ private function xlateMemberType( int $ixpmType ) : string
                 return 'other';
         }
     }
+
+    /**
+     * Filter details if requested by the config
+     * @param array $output
+     * @return array
+     */
+    private function filter( array $output ): array
+    {
+        // switch filters
+        if( $c = config( 'ixp_api.json_export_schema.excludes.switch' ) ) {
+            foreach( explode( '|', $c ) as $exc ) {
+                foreach( $output['ixp_list'] as $ixid => $ix ) {
+                    foreach( $ix['switch'] as $sid => $sw ) {
+                        if( isset( $output['ixp_list'][ $ixid ]['switch'][$sid][$exc] ) ) {
+                            unset( $output['ixp_list'][ $ixid ]['switch'][$sid][$exc] );
+                        }
+                    }
+                }
+            }
+        }
+
+        return $output;
+    }
+
 }
diff --git a/config/ixp_api.php b/config/ixp_api.php
@@ -38,6 +38,11 @@
 
         // or - we can set a static key here if we like:
         'access_key' => env( 'IXP_API_JSONEXPORTSCHEMA_ACCESS_KEY', false ),
+
+        // some IXs want to exclude some information:
+        'excludes' => [
+            'switch'     => env( 'IXP_API_JSONEXPORTSCHEMA_EXCLUDE_SWITCH', false ),
+        ],
     ],
 
     /*
