Version 1.1

Author: Jean-François Hivert

README.md

@@ -23,9 +23,9 @@ __Do not forget to install php7.1-curl__
 
 #### REPOSITORY
 * git clone https://github.com/cloudwatt/php-cli-shell_base
-* git checkout tags/v1.0
+* git checkout tags/v1.1
 * git clone https://github.com/cloudwatt/php-cli-shell_phpipam
-* git checkout tags/v1.0
+* git checkout tags/v1.1
 * Merge these two repositories
 
 #### CONFIGURATION FILE

configurations/.gitignore

@@ -0,0 +1 @@
+*.user.json

config.json.example configurations/config.json.exampleconfig.json.example renamed to configurations/config.json.example

@@ -1,13 +1,14 @@
 {
 	"DEFAULT": {
 		"sys": {
-			"browserCmd": "xdg-open"
+			"browserCmd": "xdg-open",
+			"secureShellCmd": "ssh"
 		}	
 	},
 
 	"IPAM": {
 		"servers": {
-			"[IPAM_SERVER_KEY]": "https://myPatchManagerServerAddress.ext",
+			"[IPAM_SERVER_KEY]": "https://myPhpIpamServerAddress.ext",
 			"myIpamKey": "https://demo.phpipam.net"
 		},
 

ipam.php.example

@@ -1,11 +1,29 @@
 <?php
-	include_once('services/ipam.php');
+	define("ROOT_DIR", __DIR__);
+	require_once('services/ipam.php');
+
+	if(!isset($configurations))
+	{
+		$configurations = array(
+			__DIR__ . '/configurations/config.json',
+			__DIR__ . '/configurations/config.user.json',
+		);
+	}
+
+	/**
+	  * Déplace le curseur d'une ligne vers le haut
+	  * Fix le saut de ligne lors de la touche entrée pour lancer le script CLI
+	  *
+	  * Permet d'harmoniser le traitement des sauts de lignes:
+	  * --> Saut de ligne avant un texte et non après!
+	  */
+	echo "\033[1A";
 
 	/**
 	  * Change [IPAM_SERVER_KEY] with the key of your PHPIAPM server in configuration file
-	  * Example: $MAIN = new Service_Ipam(__DIR__ . '/config.json', 'myIpamKey');
+	  * Example: $MAIN = new Service_Ipam($configurations, 'myIpamKey');
 	  */
-	$MAIN = new Service_Ipam(__DIR__ . '/config.json', '[IPAM_SERVER_KEY]');
+	$MAIN = new Service_Ipam($configurations, '[IPAM_SERVER_KEY]');
 
-	echo "\r\n";
+	echo PHP_EOL;
 	exit();

ipam/abstract.php

@@ -1,9 +1,9 @@
 <?php
-	include_once(__DIR__ . '/main.php');
-	include_once(__DIR__ . '/interface.php');
-	include_once(__DIR__ . '/connector/abstract.php');
-	include_once(__DIR__ . '/connector/sql.php');
-	include_once(__DIR__ . '/connector/rest.php');
+	require_once(__DIR__ . '/main.php');
+	require_once(__DIR__ . '/interface.php');
+	require_once(__DIR__ . '/connector/abstract.php');
+	require_once(__DIR__ . '/connector/sql.php');
+	require_once(__DIR__ . '/connector/rest.php');
 
 	abstract class IPAM_Abstract extends IPAM_Main implements IPAM_Interface
 	{
@@ -20,21 +20,21 @@ public function __construct(array $servers, $printInfoMessages = true)
 				$server = mb_strtoupper($server);
 
 				if(!$config->servers->key_exists($server)) {
-					throw new Exception("Unable to retreive IPAM server @ ".$server, E_USER_ERROR);
+					throw new Exception("Unable to retreive IPAM server for '".$server."' from config", E_USER_ERROR);
 				}
 				elseif(!$config->contexts->key_exists($server)) {
-					throw new Exception("Unable to retreive IPAM context @ ".$server, E_USER_ERROR);
+					throw new Exception("Unable to retreive IPAM context for '".$server."' from config", E_USER_ERROR);
 				}
 				else
 				{
 					$login = getenv('IPAM_'.$server.'_LOGIN');
 					$password = getenv('IPAM_'.$server.'_PASSWORD');
 
 					if($login === false || $password === false) {
-						throw new Exception("Unable to retreive IPAM credentials for [".$server."] from env", E_USER_ERROR);
+						throw new Exception("Unable to retreive IPAM credentials for '".$server."' from env", E_USER_ERROR);
 					}
 
-					$this->_aIPAM[$server] = new IPAM_Connector_Rest($config->servers[$server], $config->contexts[$server], $login, $password, $printInfoMessages);
+					$this->_aIPAM[$server] = new IPAM_Connector_Rest($server, $config->servers[$server], $config->contexts[$server], $login, $password, $printInfoMessages);
 				}
 			}
 
@@ -79,6 +79,7 @@ public function getVlanNamesByVlanIds(array $vlanIds, array $environments)
 			foreach($this->_aIPAM as $IPAM) {
 				$result = $IPAM->getVlanNamesByVlanIds($vlanIds, $environments);
 				$vlanNames = array_merge($vlanNames, $result);
+				// @todo array_unique ??
 			}
 
 			return $vlanNames;
@@ -121,6 +122,11 @@ public function getIpam($equipLabel = null)
 			throw new Exception('Impossible de retourner le service IPAM adapté', E_USER_ERROR);
 		}
 
+		public function getAllIpam()
+		{
+			return $this->_aIPAM;
+		}
+
 		/*public function __call($name, array $arguments)
 		{
 			if($this->_oIPAM !== null) {
@@ -158,6 +164,8 @@ public function __get($name)
 						return $this->_aIPAM['CORP'];
 					case 'dev':
 						return $this->_aIPAM['DEV'];
+					case 'all':
+						return $this->_aIPAM;
 				}
 			}
 

ipam/api/abstract.php

@@ -1,7 +1,10 @@
 <?php
 	abstract class Ipam_Api_Abstract
 	{
-		protected static $_IPAM = null;
+		protected static $_IPAM = null;			// Global IPAM (enabled)
+		protected static $_aIPAM = array();		// a = all/array/available IPAM
+
+		protected $_IPAM_ = null;				// Local IPAM (for this instance)
 
 		protected $_errorMessage = null;
 
@@ -14,6 +17,12 @@ abstract class Ipam_Api_Abstract
 
 		public function __construct($objectId = null)
 		{
+			/**
+			  * Permet de garder la référence de l'IPAM actuellement activé
+			  * pour cette instance d'Ipam_Api_Abstract
+			  */
+			$this->_IPAM_ = self::$_IPAM;
+
 			if($this->objectIdIsValid($objectId)) {
 				$this->_objectId = (int) $objectId;
 				$this->objectExists();
@@ -123,15 +132,16 @@ protected function _getSubObjects($objects, $fieldName, $name)
 			}
 		}
 
-		static protected function _searchObjects(array $objects, $fieldName, $name)
+		protected static function _searchObjects(array $objects, $fieldName, $name, $strict = false)
 		{
 			$results = array();
 			$name = preg_quote($name, '#');
 			$name = str_replace('\*', '.*', $name);
+			$name = ($strict) ? ('^('.$name.')$') : ('('.$name.')');
 
 			foreach($objects as $object)
 			{
-				if(preg_match('#('.$name.')#i', $object[$fieldName])) {
+				if(preg_match('#'.$name.'#i', $object[$fieldName])) {
 					$results[] = $object;
 				}
 			}
@@ -143,9 +153,14 @@ public function __get($name)
 		{
 			switch(mb_strtolower($name))
 			{
+				case 'name':
+				case 'label': {
+					return $this->getObjectLabel();
+				}
 				case 'ipam':
-				case '_ipam': {
-					return self::$_IPAM;
+				case '_ipam':
+				case '_ipam_': {
+					return $this->_IPAM_;
 				}
 				default: {
 					throw new Exception("This attribute '".$name."' does not exist", E_USER_ERROR);
@@ -155,16 +170,60 @@ public function __get($name)
 
 		public function __call($method, $parameters = null)
 		{
-			throw new Exception('Method '.$method.' does not exist', E_USER_ERROR);
+			throw new Exception("Method '".$method."' does not exist", E_USER_ERROR);
 		}
 
 		public function getErrorMessage()
 		{
 			return $this->_errorMessage;
 		}
 
-		public static function setIpam(IPAM_Main $IPAM)
+		public static function setIpam($IPAM)
+		{
+			if($IPAM instanceof IPAM_Main) {
+				self::$_IPAM = $IPAM;
+				return true;
+			}
+			elseif(Tools::is('array&&count>0', $IPAM))
+			{
+				$check = true;
+
+				foreach($IPAM as $_IPAM)
+				{
+					if(!($_IPAM instanceof IPAM_Main)) {
+						$check = false;
+						break;
+					}
+				}
+
+				if($check) {
+					self::$_IPAM = current($IPAM);
+					self::$_aIPAM = $IPAM;
+					return true;
+				}
+			}
+
+			throw new Exception("Unable to set IPAM object(s), it is not IPAM_Main instance or an array of it", E_USER_ERROR);
+		}
+
+		public static function getIpam()
+		{
+			return (count(self::$_aIPAM) > 0) ? (self::$_aIPAM) : (self::$_IPAM);
+		}
+
+		public static function enableIpam($key)
+		{
+			if(array_key_exists($key, self::$_aIPAM)) {
+				self::$_IPAM = self::$_aIPAM[$key];
+				return true;
+			}
+			else {
+				return false;
+			}
+		}
+
+		public static function getIpamEnabled()
 		{
-			self::$_IPAM = $IPAM;
+			return self::$_IPAM->getServerId();
 		}
 	}

ipam/api/address.php

@@ -3,6 +3,7 @@ class Ipam_Api_Address extends Ipam_Api_Abstract
 	{
 		const OBJECT_TYPE = 'address';
 		const FIELD_NAME = 'hostname';
+		const FIELD_DESC = 'description';
 
 		const TAGS = array(
 			1 => 'offline',
@@ -93,6 +94,9 @@ public function __get($name)
 			switch($name)
 			{
 				case 'ip':
+				case 'address': {
+					return $this->_getField('ip', 'string&&!empty');
+				}
 				case 'hostname':
 				case 'description':
 				case 'tag':
@@ -133,18 +137,61 @@ public function __call($method, $parameters = null)
 			return parent::__call($method, $parameters);
 		}
 
-		public static function searchIpAddresses($ip)
+		public function findIpAddresses($ip, $strict = false)
+		{
+			return self::_searchIpAddresses($ip, $this->_IPAM, $strict);
+		}
+
+		public function findAddressNames($name, $strict = false)
+		{
+			return self::_searchAddressNames($name, $this->_IPAM, $strict);
+		}
+
+		public function findAddressDescs($desc, $strict = false)
+		{
+			return self::_searchAddressDescs($desc, $this->_IPAM, $strict);
+		}
+
+		public static function searchIpAddresses($ip, $strict = false)
+		{
+			return self::_searchIpAddresses($ip, null, $strict);
+		}
+
+		public static function searchAddressNames($name, $strict = false)
 		{
-			return self::$_IPAM->searchAddresses($ip);
+			return self::_searchAddressNames($name, null, $strict);
 		}
 
-		public static function searchAddressNames($addressName)
+		public static function searchAddressDescs($desc, $strict = false)
 		{
-			return self::$_IPAM->searchAddHostname($addressName);
+			return self::_searchAddressDescs($desc, null, $strict);
 		}
 
-		public static function searchAddressDescs($addressDesc)
+		// $strict for future use
+		protected static function _searchIpAddresses($ip, IPAM_Main $IPAM = null, $strict = false)
 		{
-			return self::$_IPAM->searchAddDescription($addressDesc);
+			if($IPAM === null) {
+				$IPAM = self::$_IPAM;
+			}
+
+			return $IPAM->searchAddresses($ip);
+		}
+
+		protected static function _searchAddressNames($name, IPAM_Main $IPAM = null, $strict = false)
+		{
+			if($IPAM === null) {
+				$IPAM = self::$_IPAM;
+			}
+
+			return $IPAM->searchAddHostname($name, $strict);
+		}
+
+		protected static function _searchAddressDescs($desc, IPAM_Main $IPAM = null, $strict = false)
+		{
+			if($IPAM === null) {
+				$IPAM = self::$_IPAM;
+			}
+
+			return $IPAM->searchAddDescription($desc, $strict);
 		}
 	}