Сприпт на языке PHP получения информации с LDAP аналогичный по логике работы CRM битрикс24

На работе была ситуация, системный администратор поправил некоторые поля(например должность сотрудника) в LDAP, а после обновления информации с использованием импорта пользователей из LDAP в Битрикс информация не обновилась. Поскольку в битрикс в интерфейсе импорта пользователей из LDAP не увидел возможности посмотреть какая именно информация приходит(может в битрикс и есть такая возможность, но на момент публикации этой статьи я о этом ещё не знаю) из LDAP, поэтому решил написать скрипт на PHP который будет обращаться к LDAP используя последовательность и содержание запросов которые использует Bitrix, для этого залогировал соответствующие места в кода файла для того чтобы посмотреть параметры которые передаются соответствующим стандартным функциям PHP использующихся для взаимодействия с LDAP. В листинге ниже приведён скрипт который получился в результате, его можно использовать в том числе и не для битрикс.

// Подключаемся к серверу
//$conn = ldap_connect($LDAP['server'], $LDAP['port']);
var_dump($conn);
*/

$server = "10.0.100.200";
$port = "389";
if($conn = @ldap_connect($server, $port)) {
  $ldapOptTimelimit = 100;
  $ldapOptTimeout = 5;
  $ldapOptNetworkTimeout = 5;

@ldap_set_option($conn, LDAP_OPT_PROTOCOL_VERSION, 3);
  @ldap_set_option($conn, LDAP_OPT_REFERRALS, 0);
  @ldap_set_option($conn, LDAP_OPT_SIZELIMIT, 0);//Подставлялось значение COption::GetOptionInt("ldap", "group_limit", 0) которое в моём случаи вернуло int 0, которое и было подставлено
  @ldap_set_option($conn, LDAP_OPT_TIMELIMIT, $ldapOptTimelimit);
  @ldap_set_option($conn, LDAP_OPT_TIMEOUT, $ldapOptTimeout);
  @ldap_set_option($conn, LDAP_OPT_NETWORK_TIMEOUT, $ldapOptNetworkTimeout);

$login = "exappleBitrix24@domen.ru";
  $pass = "veryComplexPasswordOrNotVery";

if (@ldap_bind($conn,$login,$pass)) {
    echo "Успешное соединение";
  } else {
    echo "Ошибка";
  }

$BaseDN = "OU=SPCABLE,DC=SPCABLE,DC=RU";
  $str = "(&(&(objectClass=user)(objectCategory=PERSON)))";
  $searchAttributes = array();
  $searchControls = array(
    array(
      "oid" => "1.2.840.113556.1.4.319",
      "value" => array(
        "size" => 1000,
        "cookie" => ""
      )
    )
  );
/*
array(1) {
  [0]=>
  array(2) {
    ["oid"]=>
    string(22) "1.2.840.113556.1.4.319"
    ["value"]=>
    array(2) {
      ["size"]=>
      int(1000)
      ["cookie"]=>
      string(0) ""
    }
  }
}
*/

$sr = @ldap_search(
    $conn,
    $BaseDN,
    $str,
    $searchAttributes,
    0,
    -1,
    -1,
    LDAP_DEREF_NEVER,
    $searchControls
  );
  if ($sr) {var_dump($sr);} else {var_dump(ldap_error($conn));}

ldap_parse_result($conn,$sr,$error_code,$matched_dn,$error_message,$referrals,$controls);//Видимо ПРЕДПОЛОЖИТЕЛЬНО результаты присвоенные переменным не особо то где то используются, согласно ПРЕДПОЛОЖИТЕЛЬНО выводу ниже
  //var_dump($error_code);var_dump($matched_dn);var_dump($error_message);var_dump($referrals);var_dump($controls);

if (!function_exists("is_set")) {
    function is_set($a, $k = false) {
      if ($k === false && func_num_args() == 1) {
        return isset($a);
      }

if (is_array($a)) {
        return isset($a[$k]) || array_key_exists($k, $a);
      }

return false;
    }
  }

if (!function_exists("workAttr")) {
    function workAttr($values) {
      if(is_array($values) && $values['count']==1) {
        return $values[0];
      }

unset($values['count']);
      return $values;
    }
  }

$entry = ldap_first_entry($conn, $sr);
  $info = array();//В коде bitrix24 зачем то изначально определяется в false а затем через проверку на не массив присваивается array() до присвоения значений и то что нижнее присвоение в итерируемом участке в данном случаи вроде бы значения не оказывает, ничего ПРЕДПОЛОЖИТЕЛЬНО не мешает сразу определить в array(), в этом же блоке проверки на не массив переменной $info переменной $i присваивается значение 0, ничего ПРЕДПОЛОЖИТЕЛЬНО не мешает определить её так же рядом с присвоением первого значения $info или до первого итерируемого участка
  $i = 0;
//var_dump(ldap_get_attributes($conn, $entry));

if($entry) {

do {
      $attributes = ldap_get_attributes($conn, $entry);

for($j=0;$j<$attributes["count"];$j++) {
 $values = @ldap_get_values_len($conn,$entry,$attributes[$j]);

if($values === false) continue;

$bPhotoAttr = in_array($attributes[$j],array("thumbnailPhoto","jpegPhoto"));//вместо массива в битрикс24 подставляется значение статического свойства self::$PHOTO_ATTRIBS которое в обоих вызываемых случаях(метод QueryArray в рассматриваемом случаи вызывается 2 зраза, ПРЕДПОЛОЖИТЕЛЬНО для разных запросов, первый получает пользователей, а второй возможно что то ещё) принимает значение подставленного вместо него массива, то есть self::$PHOTO_ATTRIBS всегда равен array("thumbnailPhoto","jpegPhoto") - это проверено логом, хотя изначально предполагалось что self::$PHOTO_ATTRIBS и так всегда содержит указанный массив поскольку это статическое свойство определено в это значение в начале класса(не внутри метода)
        $info[$i][mb_strtolower($attributes[$j])] = $bPhotoAttr ? $values : workAttr($values);//Функция workAttr аналогична методу класса CLDAP, только назвал её в отличии от имени в классе с маленькой буквы буквы, функия размещена выше в данном файле, её код соответствует коду метода(за исключением других отступов)
      }

if(!is_set($info[$i], 'dn')) {
        $info[$i]['dn'] = ldap_get_dn($conn, $entry);
      }
      $i++;
    }  while($entry = ldap_next_entry($conn, $entry));
  }
}

В листинге ниже находится некоторая промежуточная версия скрипта, в нём я уже начал выводить информацию переданную о LDAP о некоторой конкретной пользовательской записи, используя порядковый номер этой записи, так же в случаи если у записи есть поля thumbnailPhoto или jpegPhoto(обе они являются массивом и содержат ключ count который видимо хранит количество элементов в записях, в моём случаи count был равен 1 и данные единственной картинки хранились в элементе соответствующего массива под ключом 0 как для thumbnailPhoto так и для jpegPhoto) картинки содержащиеся в них сохранялись в файл, а пользователю выводился тег img в атрибуте src которого указывался адрес картинки, биты же картинки в браузер в виде текста не выводятся.

<?php
/*
$LDAP = array(
 'server' => '10.0.100.200',
 'port' => '389',
 'bindDN' => NULL, // анонимное подключение,
		 // в этом параметре можно указать DN подключения
 'bindPW' => NULL, // анонимное подключение,
		 // в этом параметре можно указать пароль для DN подключения
 'groupsDN' => 'ou=Groups,dc=mycompany,dc=ru',
 'usersDN' => 'ou=Users,dc=mycompany,dc=ru'
);
 
// Подключаемся к серверу
//$conn = ldap_connect($LDAP['server'], $LDAP['port']);
var_dump($conn);
*/
 
if (isset($_GET["t"])) {
 
$server = "10.0.100.200";
$port = "389";
if($conn = @ldap_connect($server, $port)) {
 $ldapOptTimelimit = 100;
 $ldapOptTimeout = 5;
 $ldapOptNetworkTimeout = 5;
 
 @ldap_set_option($conn, LDAP_OPT_PROTOCOL_VERSION, 3);
 @ldap_set_option($conn, LDAP_OPT_REFERRALS, 0);
 @ldap_set_option($conn, LDAP_OPT_SIZELIMIT, 0);//Подставлялось значение COption::GetOptionInt("ldap", "group_limit", 0) которое в моём случаи вернуло int 0, которое и было подставлено
 @ldap_set_option($conn, LDAP_OPT_TIMELIMIT, $ldapOptTimelimit);
 @ldap_set_option($conn, LDAP_OPT_TIMEOUT, $ldapOptTimeout);
 @ldap_set_option($conn, LDAP_OPT_NETWORK_TIMEOUT, $ldapOptNetworkTimeout);
 
 $login = "exappleBitrix24@domen.ru";
 $pass = "veryComplexPasswordOrNotVery";
 
 if (@ldap_bind($conn,$login,$pass)) {
 echo "Успешное соединение";
 } else {
 echo "Ошибка";
 }
 
 $BaseDN = "OU=SPCABLE,DC=SPCABLE,DC=RU";
 $str = "(&(&(objectClass=user)(objectCategory=PERSON)))";
 $searchAttributes = array();
 $searchControls = array(
 array(
 "oid" => "1.2.840.113556.1.4.319",
 "value" => array(
 "size" => 1000,
 "cookie" => ""
 )
 )
 );
/*
array(1) {
 [0]=>
 array(2) {
 ["oid"]=>
 string(22) "1.2.840.113556.1.4.319"
 ["value"]=>
 array(2) {
 ["size"]=>
 int(1000)
 ["cookie"]=>
 string(0) ""
 }
 }
}
*/
 
 $sr = @ldap_search(
 $conn,
 $BaseDN,
 $str,
 $searchAttributes,
 0,
 -1,
 -1,
 LDAP_DEREF_NEVER,
 $searchControls
 );
 if ($sr) {var_dump($sr);} else {var_dump(ldap_error($conn));}
 
 ldap_parse_result($conn,$sr,$error_code,$matched_dn,$error_message,$referrals,$controls);//Видимо ПРЕДПОЛОЖИТЕЛЬНО результаты присвоенные переменным не особо то где то используются, согласно ПРЕДПОЛОЖИТЕЛЬНО выводу ниже
 //var_dump($error_code);var_dump($matched_dn);var_dump($error_message);var_dump($referrals);var_dump($controls);
 
 if (!function_exists("is_set")) {
 function is_set($a, $k = false) {
 if ($k === false && func_num_args() == 1) {
 return isset($a);
 }
 
 if (is_array($a)) {
 return isset($a[$k]) || array_key_exists($k, $a);
 }
 
 return false;
 }
 }
 
 if (!function_exists("workAttr")) {
 function workAttr($values) {
 if(is_array($values) && $values['count']==1) {
 return $values[0];
 }
 
 unset($values['count']);
 return $values;
 }
 }
 
 
 $entry = ldap_first_entry($conn, $sr);
 $info = array();//В коде bitrix24 зачем то изначально определяется в false а затем через проверку на не массив присваивается array() до присвоения значений и то что нижнее присвоение в итерируемом участке в данном случаи вроде бы значения не оказывает, ничего ПРЕДПОЛОЖИТЕЛЬНО не мешает сразу определить в array(), в этом же блоке проверки на не массив переменной $info переменной $i присваивается значение 0, ничего ПРЕДПОЛОЖИТЕЛЬНО не мешает определить её так же рядом с присвоением первого значения $info или до первого итерируемого участка
 $i = 0;
//var_dump(ldap_get_attributes($conn, $entry));
 
 if($entry) {
 
 do {
 $attributes = ldap_get_attributes($conn, $entry);
 
 for($j=0;$j<$attributes["count"];$j++) {
 $values = @ldap_get_values_len($conn,$entry,$attributes[$j]);
 
 if($values === false) continue;
 
 $bPhotoAttr = in_array($attributes[$j],array("thumbnailPhoto","jpegPhoto"));//вместо массива в битрикс24 подставляется значение статического свойства self::$PHOTO_ATTRIBS которое в обоих вызываемых случаях(метод QueryArray в рассматриваемом случаи вызывается 2 зраза, ПРЕДПОЛОЖИТЕЛЬНО для разных запросов, первый получает пользователей, а второй возможно что то ещё) принимает значение подставленного вместо него массива, то есть self::$PHOTO_ATTRIBS всегда равен array("thumbnailPhoto","jpegPhoto") - это проверено логом, хотя изначально предполагалось что self::$PHOTO_ATTRIBS и так всегда содержит указанный массив поскольку это статическое свойство определено в это значение в начале класса(не внутри метода)
 $info[$i][mb_strtolower($attributes[$j])] = $bPhotoAttr ? $values : workAttr($values);//Функция workAttr аналогична методу класса CLDAP, только назвал её в отличии от имени в классе с маленькой буквы буквы, функция размещена выше в данном файле, её код соответствует коду метода(за исключением других отступов)
if ($i == $_GET["t"]) {
 if (($attributes[$j] == "jpegPhoto") and (isset($info[$i][mb_strtolower($attributes[$j])][0]))) {
 $fp = fopen("photo/$i.jpg","w");
 fwrite($fp,$info[$i][mb_strtolower($attributes[$j])][0]);
//var_dump($info[$i][mb_strtolower($attributes[$j])]);
 fclose($fp);
 echo "<img src=\"photo/$i.jpg\" />\n";
 } elseif ($attributes[$j] == "thumbnailPhoto") {
 $fp = fopen("photo/thum$i.jpg","w");
 fwrite($fp,$info[$i][mb_strtolower($attributes[$j])][0]);
//var_dump($info[$i][mb_strtolower($attributes[$j])]);
 fclose($fp);
 echo "<img src=\"photo/thum$i.jpg\" />\n";
 } else {
 echo "" . $attributes[$j] . "\n";
 var_dump($info[$i][mb_strtolower($attributes[$j])]);
 }
}
 }
 
 
 if(!is_set($info[$i], 'dn')) {
 $info[$i]['dn'] = ldap_get_dn($conn, $entry);
 }
 $i++;
 } while($entry = ldap_next_entry($conn, $entry));
 }
}
}
 
//var_dump($info);

Начал переписывать цикл в приведённым выше скрипте, при этом реализовал свой алгоритм получения данных аналогичный @ldap_get_values_len, поскольку указанная функиця зачем то использует переменные $conn и $entry а так же элемент массива $attributes хотя в элементе массива $attributes есть всё необходимое для получения результата, указанный цикл и алгоритм приведён в листинге ниже. Привёл данный вариант цикла с указанным алгоритмом до написания своей функции которая будет возвращать результат аналогичный приведённому алгоритму, только без элемента массива с ключом "count".

if ($entry = ldap_first_entry($conn,$sr)) {
 $info = array();
 $i = 0;
 do {
 $attributes = ldap_get_attributes($conn,$entry);
 $keyNum = 0;
//[НАЧАЛО]Участок кода который ПРЕДПОЛОЖИТЕЛЬНО присваивает переменной $attributeAr такой же результат как если было бы выполнено присвоение @ldap_get_values_len($conn,$entry,$attributes[$keyNum])
 if (isset($attributes[$keyNum]) and ((($attrKey = $attributes[$keyNum])."") != "") and isset($attributes[$attrKey]) and isset($attributes[$attrKey]["count"]) and ($attributes[$attrKey]["count"] > 0)) {//ПРЕДПОЛОЖЕНИЕ что так называемый мной "ключ атрибута" не должен быть пустой строкой
 $attributeCount = $attributes[$attrKey]["count"];
 $attributeAr = $attributes[$attrKey];
// unset($attributeAr["count"]);//Закоментировано, поскольку функция ldap_get_values_len возвращает значение массива с ключом "count"
 $tmp = $attributeAr["count"];unset($attributeAr["count"]);$attributeAr["count"] = $tmp;unset($tmp);//Функция ldap_get_values_len возвращает элемент массива с ключом "count" последним а не первым как в полученном выше мессиве $attributeAr, текущая строка размещает элемент с ключом "count" последним в массиве
 var_dump($attributeAr);
 echo "Результат возвращаемый LDAP-функцией(@ldap_get_values_len):\n";
 var_dump(@ldap_get_values_len($conn,$entry,$attributes[$keyNum]));
exit;
 
 }
//[КОНЕЦ]Участок кода который ПРЕДПОЛОЖИТЕЛЬНО присваивает переменной $attributeAr такой же результат как если было бы выполнено присвоение @ldap_get_values_len($conn,$entry,$attributes[$keyNum])
 } while ($entry = ldap_next_entry($conn,$entry));
 }

В листинге ниже приведён код функции для замены выше описанного алгоритма в цикле.

В листинге ниже приведена функция для получения массива всех атрибутов, которые включают массивы их значений, для одной записи(entry) полученной от LDAP.

Комментарии