Merge pull request #774 from swaschkut/main

version 2.1.15 - bugfixes

CHANGELOG.txt

@@ -1,6 +1,17 @@
 CHANGELOG
 
-2.1.14
+2.1.15
+UTIL:
+
+BUGFIX:
+* type=address/service 'filter=(object is.unused/is.unused.recursive) | overwritten objects used at higher DG level are now also used
+* bugfix to create correct XML file Increament for prettyXML - so that it is identical to Panorama / Firewall created config
+* README.md - fix broken links
+
+GENERAL:
+
+
+2.1.14 (20230829)
 UTIL:
 type=rule actions=display | introduction of argument actions=display:hitcount,ApplicationSeen
 

README.md

@@ -13,7 +13,7 @@ INSTALLATION
 The recommended installation of PAN-OS-PHP is via Docker.
 Please install Docker Desktop if needed.
 
-[README docker](https://github.com/PaloAltoNetworks/pan-os-php/READMEdocker.md)
+[README docker](https://github.com/PaloAltoNetworks/pan-os-php/blob/main/READMEdocker.md)
 
 [WIKI docker](https://github.com/PaloAltoNetworks/pan-os-php/wiki/docker)
 
@@ -33,7 +33,7 @@ Old detailed information
 
 File tree:
 * **/lib/** contains library files source code
-* **/utils/** contains ready to run scripts, more information in [utils/README](https://github.com/PaloAltoNetworks/pan-os-php/utils/README.md)
+* **/utils/** contains ready to run scripts, more information in [utils/README](https://github.com/PaloAltoNetworks/pan-os-php/blob/main/utils/README.md)
 * **/doc/index.html**  has all classes documentations
 * **/example-xxx.php** are examples about using this library
 
@@ -49,7 +49,7 @@ Usage (create custom Scripts)
 
 With less than 20 lines of code, you should be able to solve most of your needs. Brief overview:
 
-[README customScripting](https://github.com/PaloAltoNetworks/pan-os-php/READMEcustomScripting.md)
+[README customScripting](https://github.com/PaloAltoNetworks/pan-os-php/blob/main/READMEcustomScripting.md)
 
 
 UTIL (predefined Scripts)
@@ -59,7 +59,7 @@ UTIL (predefined Scripts)
 
 Use around 50 different predefined entry parts [e.g. address / service / tag / rule / ...] with 100 of actions and filters to easily improve your Palo Alto Networks Firewall and Panorama configuration
 
-[README util](https://github.com/PaloAltoNetworks/pan-os-php/READMEutil.md)
+[README util](https://github.com/PaloAltoNetworks/pan-os-php/blob/main/READMEutil.md)
 
 
 
@@ -68,6 +68,6 @@ Docker build
 
 There are Dockerfiles available with OS: Ubuntu20/22 and CentOS 7/8
 
-[README docker](https://github.com/PaloAltoNetworks/pan-os-php/READMEdocker.md)
+[README docker](https://github.com/PaloAltoNetworks/pan-os-php/blob/main/READMEdocker.md)
 
 [WIKI docker](https://github.com/PaloAltoNetworks/pan-os-php/wiki/docker)

lib/device-and-system-classes/FawkesConf.php

@@ -524,7 +524,7 @@ public function save_to_file($fileName, $printMessage = TRUE, $lineReturn = TRUE
 
         //Todo: swaschkut check
         //$indentingXmlIncreament was 2 per default for Panroama
-        $xml = &DH::dom_to_xml($this->xmlroot, $indentingXml, $lineReturn, -1, $indentingXmlIncreament);
+        $xml = &DH::dom_to_xml($this->xmlroot, $indentingXml, $lineReturn, -1, $indentingXmlIncreament + 1);
 
         $path_parts = pathinfo($fileName);
         if (!is_dir($path_parts['dirname']))

lib/device-and-system-classes/PANConf.php

@@ -702,7 +702,7 @@ public function save_to_file($fileName, $printMessage = TRUE, $lineReturn = TRUE
         if( $printMessage )
             PH::print_stdout( "Now saving PANConf to file '$fileName'...");
 
-        $xml = &DH::dom_to_xml($this->xmlroot, $indentingXml, $lineReturn, -1, $indentingXmlIncreament);
+        $xml = &DH::dom_to_xml($this->xmlroot, $indentingXml, $lineReturn, -1, $indentingXmlIncreament + 1);
 
         $path_parts = pathinfo($fileName);
         if (!is_dir($path_parts['dirname']))

lib/device-and-system-classes/PanoramaConf.php

@@ -1387,7 +1387,7 @@ public function save_to_file($fileName, $printMessage = TRUE, $lineReturn = TRUE
 
         //Todo: swaschkut check
         //$indentingXmlIncreament was 2 per default for Panroama
-        $xml = &DH::dom_to_xml($this->xmlroot, $indentingXml, $lineReturn, -1, $indentingXmlIncreament);
+        $xml = &DH::dom_to_xml($this->xmlroot, $indentingXml, $lineReturn, -1, $indentingXmlIncreament + 1);
 
         $path_parts = pathinfo($fileName);
         if (!is_dir($path_parts['dirname']))

lib/misc-classes/PH.php

@@ -182,7 +182,7 @@ function __construct($argv, $argc)
 
     private static $library_version_major = 2;
     private static $library_version_sub = 1;
-    private static $library_version_bugfix = 14;
+    private static $library_version_bugfix = 15;
 
     //BASIC AUTH PAN-OS 7.1
     public static $softwareupdate_key = "658d787f293e631196dac9fb29490f1cc1bb3827";

lib/misc-classes/filters/filters-Address.php

@@ -20,7 +20,10 @@
 );
 RQuery::$defaultFilters['address']['object']['operators']['is.unused'] = array(
     'Function' => function (AddressRQueryContext $context) {
-        return $context->object->countReferences() == 0;
+        $object = $context->object;
+
+        return $object->objectIsUnused();
+        #return $context->object->countReferences() == 0;
     },
     'arg' => FALSE,
     'ci' => array(
@@ -33,7 +36,6 @@
         $object = $context->object;
 
         return $object->objectIsUnusedRecursive();
-
     },
     'arg' => FALSE,
     'ci' => array(

lib/misc-classes/filters/filters-Service.php

@@ -20,7 +20,10 @@
 );
 RQuery::$defaultFilters['service']['object']['operators']['is.unused'] = array(
     'Function' => function (ServiceRQueryContext $context) {
-        return $context->object->countReferences() == 0;
+        $object = $context->object;
+
+        return $object->objectIsUnused();
+        #return $context->object->countReferences() == 0;
     },
     'arg' => FALSE,
     'ci' => array(

lib/misc-classes/trait/ReferenceableObject.php

@@ -509,6 +509,31 @@ public function name()
         return $this->name;
     }
 
+    public function objectIsUnused()
+    {
+        $className = "";
+
+        if( get_class($this) == 'Service' || get_class($this) == 'ServiceGroup' )
+            $className = 'ServiceGroup';
+        elseif( get_class($this) == 'Address' || get_class($this) == 'AddressGroup' )
+            $className = 'AddressGroup';
+        else
+            return null;
+
+        /** @var Address|AddressGroup|Service|ServiceGroup $this */
+        if( $this->countReferences() == 0 )
+        {
+            //- check if higher DG has same name and only if it is also unused return TRUE
+            $tmp_obj = $this->owner->find( $this->name() );
+            if( $tmp_obj === null || $tmp_obj->countReferences() == 0 )
+                return TRUE;
+            else
+                return FALSE;
+        }
+
+        return FALSE;
+    }
+
     public function objectIsUnusedRecursive()
     {
         $className = "";
@@ -520,9 +545,16 @@ public function objectIsUnusedRecursive()
         else
             return null;
 
-        /** @var Service|ServiceGroup $ref */
+        /** @var Address|AddressGroup|Service|ServiceGroup $this */
         if( $this->countReferences() == 0 )
-            return TRUE;
+        {
+            //- check if higher DG has same name and only if it is also unused return TRUE
+            $tmp_obj = $this->owner->find( $this->name() );
+            if( $tmp_obj === null || $tmp_obj->countReferences() == 0 )
+                return TRUE;
+            else
+                return FALSE;
+        }
 
         $groups = $this->findReferencesWithClass($className);
 
@@ -540,7 +572,5 @@ public function objectIsUnusedRecursive()
         }
 
         return TRUE;
-
     }
-
 }