poslop/PC-Contact-Sync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

formatting

Browse Source
This commit is contained in:
poslop
2026-04-23 15:05:06 -05:00
parent 034d05eb81
commit 5768f75f29
2 changed files with 259 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files
directory.php
+33 -14
View File
@@ -1,5 +1,6 @@
#!/usr/bin/php -q #!/usr/bin/php -q
<?php <?php
/** /**
* Generate Polycom-compatible global directory XML (000000000000-directory.xml) * Generate Polycom-compatible global directory XML (000000000000-directory.xml)
* from PBXact/FreePBX extensions. * from PBXact/FreePBX extensions.
@@ -14,11 +15,11 @@
*/ */
$bootstrap_settings['freepbx_auth'] = false; $bootstrap_settings['freepbx_auth'] = false;
require_once('/etc/freepbx.conf'); require_once '/etc/freepbx.conf';
$provision_dir = '/tftpboot'; // <-- adjust if needed $provision_dir = '/tftpboot'; // <-- adjust if needed
$out_file = $provision_dir . '/000000000000-directory.xml'; $out_file = $provision_dir . '/000000000000-directory.xml';
$do_notify = in_array('--notify', $argv, true); $do_notify = in_array('--notify', $argv, true);
$db = FreePBX::Database(); $db = FreePBX::Database();
$rows = []; $rows = [];
@@ -39,17 +40,18 @@ try {
/** Fall back to PJSIP ps_endpoints (id is ext; parse callerid "Name <1001>") */ /** Fall back to PJSIP ps_endpoints (id is ext; parse callerid "Name <1001>") */
if (!$rows) { if (!$rows) {
$stmt = $db->prepare(" $stmt = $db->prepare('
SELECT id AS extension, callerid SELECT id AS extension, callerid
FROM ps_endpoints FROM ps_endpoints
ORDER BY CAST(id AS UNSIGNED) ORDER BY CAST(id AS UNSIGNED)
"); ');
$stmt->execute(); $stmt->execute();
$tmp = $stmt->fetchAll(PDO::FETCH_ASSOC); $tmp = $stmt->fetchAll(PDO::FETCH_ASSOC);
foreach ($tmp as $r) { foreach ($tmp as $r) {
$ext = trim((string)$r['extension']); $ext = trim((string) $r['extension']);
if (!preg_match('/^[0-9]+$/', $ext)) continue; // only numeric extensions if (!preg_match('/^[0-9]+$/', $ext))
$cid = trim((string)($r['callerid'] ?? '')); continue; // only numeric extensions
$cid = trim((string) ($r['callerid'] ?? ''));
// Try to parse descriptive name from callerid // Try to parse descriptive name from callerid
$name = 'Ext ' . $ext; $name = 'Ext ' . $ext;
if ($cid !== '') { if ($cid !== '') {
@@ -79,9 +81,10 @@ $root = $xml->createElement('directory');
$xml->appendChild($root); $xml->appendChild($root);
foreach ($rows as $r) { foreach ($rows as $r) {
$name = trim((string)($r['name'] ?? '')); $name = trim((string) ($r['name'] ?? ''));
$ext = trim((string)($r['extension'] ?? '')); $ext = trim((string) ($r['extension'] ?? ''));
if ($ext === '') continue; if ($ext === '')
continue;
// Split name into fn/ln if possible // Split name into fn/ln if possible
$fn = $name; $fn = $name;
@@ -128,7 +131,23 @@ if ($do_notify) {
$asteriskBin = '/usr/sbin/asterisk'; $asteriskBin = '/usr/sbin/asterisk';
$excludedEndpoints = [ $excludedEndpoints = [
'101', '102', '103', '104', '105', '106', '107', '108', '109', '110', '111', '112', '113', '114', '900', 'Voyant', '<Endpoint dpma_endpoint' '101',
'102',
'103',
'104',
'105',
'106',
'107',
'108',
'109',
'110',
'111',
'112',
'113',
'114',
'900',
'Voyant',
'<Endpoint dpma_endpoint',
]; ];
// Get all endpoints from Asterisk CLI // Get all endpoints from Asterisk CLI
@@ -158,7 +177,7 @@ if ($do_notify) {
$notifyCmd = sprintf( $notifyCmd = sprintf(
'%s -rx "pjsip send notify polycom-check-cfg endpoint %s"', '%s -rx "pjsip send notify polycom-check-cfg endpoint %s"',
escapeshellarg($asteriskBin), escapeshellarg($asteriskBin),
escapeshellarg($ep) escapeshellarg($ep),
); );
exec($notifyCmd); exec($notifyCmd);
} }
sidecar.php
+226 -214
View File
@@ -4,183 +4,188 @@
$PROVISION_DIR = '/tftpboot'; $PROVISION_DIR = '/tftpboot';
$bootstrap_settings['freepbx_auth'] = false; $bootstrap_settings['freepbx_auth'] = false;
require_once('/etc/freepbx.conf'); require_once '/etc/freepbx.conf';
$DB = FreePBX::Database(); $DB = FreePBX::Database();
$CONFIG_PATH = "./config.json"; $CONFIG_PATH = './config.json';
$CONFIG = read_config_json_file($CONFIG_PATH); $CONFIG = read_config_json_file($CONFIG_PATH);
$TARGET_EXTENSIONS = read_config_json("target_extensions"); $TARGET_EXTENSIONS = read_config_json('target_extensions');
$LIST_FILTER_TYPE = read_config_json_string("list_filter_type"); $LIST_FILTER_TYPE = read_config_json_string('list_filter_type');
$EXTENSION_FILTER_LIST = read_config_json("extension_filter_list"); $EXTENSION_FILTER_LIST = read_config_json('extension_filter_list');
$BLACKLISTED_TERMS = read_config_json("blacklisted_terms"); $BLACKLISTED_TERMS = read_config_json('blacklisted_terms');
$PREPEND_EXTENSIONS = read_config_json_object_list("prepend_extensions"); $PREPEND_EXTENSIONS = read_config_json_object_list('prepend_extensions');
function main(): void { function main(): void
global $TARGET_EXTENSIONS; {
global $PROVISION_DIR; global $TARGET_EXTENSIONS;
global $PROVISION_DIR;
$argv = $_SERVER['argv'] ?? []; $argv = $_SERVER['argv'] ?? [];
$do_notify = in_array('--notify', $argv, true); $do_notify = in_array('--notify', $argv, true);
$pbdb = pull_db(); $pbdb = pull_db();
blacklist_terms($pbdb); blacklist_terms($pbdb);
filter_extensions($pbdb); filter_extensions($pbdb);
prepend_contact_list($pbdb); prepend_contact_list($pbdb);
$mac_list = pull_mac_list();
$mac_list = pull_mac_list(); foreach ($TARGET_EXTENSIONS as $ext) {
$mac = strtolower($mac_list[$ext]) ?? null;
foreach ($TARGET_EXTENSIONS as $ext) { if (!$mac) {
$mac = strtolower($mac_list[$ext]) ?? null; echo "Mac for $ext not found\n";
continue;
}
if (!$mac) { echo "Mac for $ext not found\n"; continue; } $file = $PROVISION_DIR . '/' . $mac . '-features.cfg';
$file = $PROVISION_DIR . '/' . $mac . '-features.cfg'; $xml = pull_xml_file($file);
$attendants = remove_attendants($xml);
write_attendants($attendants, $pbdb);
write_to_file($file, $xml);
}
$xml = pull_xml_file($file); if ($do_notify) {
$attendants = remove_attendants($xml); notify($pbdb);
write_attendants($attendants, $pbdb); }
write_to_file($file, $xml);
}
if ($do_notify) {
notify($pbdb);
}
} }
function pull_db(): array { function pull_db(): array
global $DB; {
$pbdb = []; global $DB;
$pbdb = [];
try { try {
$stmt = $DB->prepare(" $stmt = $DB->prepare("
SELECT name, extension SELECT name, extension
FROM users FROM users
WHERE extension REGEXP '^[0-9]+$' WHERE extension REGEXP '^[0-9]+$'
ORDER BY CAST(extension AS UNSIGNED) ORDER BY CAST(extension AS UNSIGNED)
"); ");
$stmt->execute(); $stmt->execute();
$pbdb = $stmt->fetchAll(PDO::FETCH_ASSOC); $pbdb = $stmt->fetchAll(PDO::FETCH_ASSOC);
} catch (Exception $e) { } catch (Exception $e) {
} }
if (!$pbdb) { if (!$pbdb) {
fwrite(STDERR, "No extensions found (users/ps_endpoints returned no pbdb).\n"); fwrite(STDERR, "No extensions found (users/ps_endpoints returned no pbdb).\n");
exit(1); exit(1);
} }
usort($pbdb, function ($a, $b) { usort($pbdb, function ($a, $b) {
return strcasecmp($a['name'], $b['name']); return strcasecmp($a['name'], $b['name']);
}); });
return $pbdb; return $pbdb;
}
function filter_extensions(array &$pbdb) {
global $LIST_FILTER_TYPE;
if ($LIST_FILTER_TYPE == "whitelist") {
whitelist_extension_filter($pbdb);
} elseif ($LIST_FILTER_TYPE == "blacklist") {
blacklist_extension_filter($pbdb);
} else {
fwrite(STDERR, "Filter type invalid: $LIST_FILTER_TYPE");
fwrite(STDERR, "Use either whitelist or blacklist");
}
} }
function blacklist_terms(array &$pbdb) { function filter_extensions(array &$pbdb)
global $BLACKLISTED_TERMS; {
global $LIST_FILTER_TYPE;
$pbdb = array_values(array_filter($pbdb, function ($item) use ($BLACKLISTED_TERMS) {
if (!is_array($item) || !isset($item['name'])) {
return true;
}
$name = ltrim($item['name']); if ($LIST_FILTER_TYPE == 'whitelist') {
whitelist_extension_filter($pbdb);
foreach ($BLACKLISTED_TERMS as $term) { } elseif ($LIST_FILTER_TYPE == 'blacklist') {
if (stripos($name, $term) === 0) { blacklist_extension_filter($pbdb);
return false; } else {
} fwrite(STDERR, "Filter type invalid: $LIST_FILTER_TYPE");
} fwrite(STDERR, 'Use either whitelist or blacklist');
return true; }
}));
} }
function whitelist_extension_filter(array &$pbdb) { function blacklist_terms(array &$pbdb)
global $EXTENSION_FILTER_LIST; {
global $BLACKLISTED_TERMS;
$allowed = array_fill_keys(
array_map('trim', array_map('strval', $EXTENSION_FILTER_LIST)),
true
);
$pbdb = array_values(array_filter($pbdb, function ($item) use ($allowed) { $pbdb = array_values(array_filter($pbdb, function ($item) use ($BLACKLISTED_TERMS) {
if (!is_array($item) || !isset($item['extension'])) { if (!is_array($item) || !isset($item['name'])) {
return false; return true;
} }
$ext = trim((string)$item['extension']); $name = ltrim($item['name']);
return isset($allowed[$ext]);
})); foreach ($BLACKLISTED_TERMS as $term) {
if (stripos($name, $term) === 0) {
return false;
}
}
return true;
}));
} }
function blacklist_extension_filter(array &$pbdb) { function whitelist_extension_filter(array &$pbdb)
global $EXTENSION_FILTER_LIST; {
global $EXTENSION_FILTER_LIST;
$blocked = array_fill_keys( $allowed = array_fill_keys(array_map('trim', array_map('strval', $EXTENSION_FILTER_LIST)), true);
array_map('trim', array_map('strval', $EXTENSION_FILTER_LIST)),
true
);
$pbdb = array_values(array_filter($pbdb, function ($item) use ($blocked) { $pbdb = array_values(array_filter($pbdb, function ($item) use ($allowed) {
if (!is_array($item) || !isset($item['extension'])) { if (!is_array($item) || !isset($item['extension'])) {
return true; return false;
} }
$ext = trim((string)$item['extension']); $ext = trim((string) $item['extension']);
return !isset($blocked[$ext]); return isset($allowed[$ext]);
})); }));
} }
function prepend_contact_list(array &$pbdb) { function blacklist_extension_filter(array &$pbdb)
global $PREPEND_EXTENSIONS; {
array_unshift($pbdb, ...$PREPEND_EXTENSIONS); global $EXTENSION_FILTER_LIST;
$blocked = array_fill_keys(array_map('trim', array_map('strval', $EXTENSION_FILTER_LIST)), true);
$pbdb = array_values(array_filter($pbdb, function ($item) use ($blocked) {
if (!is_array($item) || !isset($item['extension'])) {
return true;
}
$ext = trim((string) $item['extension']);
return !isset($blocked[$ext]);
}));
} }
function pull_mac_list(): array { function prepend_contact_list(array &$pbdb)
global $DB; {
$mac_db = []; global $PREPEND_EXTENSIONS;
array_unshift($pbdb, ...$PREPEND_EXTENSIONS);
}
try { function pull_mac_list(): array
$stmt = $DB->prepare(" {
global $DB;
$mac_db = [];
try {
$stmt = $DB->prepare("
SELECT mac, SUBSTRING_INDEX(ext, '-', 1) AS ext SELECT mac, SUBSTRING_INDEX(ext, '-', 1) AS ext
FROM endpoint_extensions FROM endpoint_extensions
ORDER BY CAST(ext AS UNSIGNED) ORDER BY CAST(ext AS UNSIGNED)
"); ");
$stmt->execute(); $stmt->execute();
$mac_db = $stmt->fetchAll(PDO::FETCH_ASSOC); $mac_db = $stmt->fetchAll(PDO::FETCH_ASSOC);
} catch (Exception $e) { } catch (Exception $e) {
echo $e; echo $e;
} }
return array_column($mac_db, 'mac', 'ext'); return array_column($mac_db, 'mac', 'ext');
} }
function read_config_json_file(string $path): array
function read_config_json_file(string $path): array { {
$json = file_get_contents($path); $json = file_get_contents($path);
$data = json_decode($json, true); $data = json_decode($json, true);
if ($data === null && json_last_error() !== JSON_ERROR_NONE) { if ($data === null && json_last_error() !== JSON_ERROR_NONE) {
throw new RuntimeException("JSON decode error: " . json_last_error_msg()); throw new RuntimeException('JSON decode error: ' . json_last_error_msg());
} }
return $data; return $data;
} }
function read_config_json(string $key): array { function read_config_json(string $key): array
{
global $CONFIG; global $CONFIG;
$value = $CONFIG[$key] ?? []; $value = $CONFIG[$key] ?? [];
@@ -194,145 +199,152 @@ function read_config_json(string $key): array {
$items = array_values(array_filter($items, fn($v) => is_scalar($v))); $items = array_values(array_filter($items, fn($v) => is_scalar($v)));
$items = array_map( $items = array_map(fn($v) => strtolower(trim((string) $v)), $items);
fn($v) => strtolower(trim((string)$v)),
$items
);
return array_values(array_filter($items, fn($v) => $v !== '')); return array_values(array_filter($items, fn($v) => $v !== ''));
} }
function read_config_json_string(string $key): string { function read_config_json_string(string $key): string
{
global $CONFIG; global $CONFIG;
$value = $CONFIG[$key] ?? ''; $value = $CONFIG[$key] ?? '';
return strtolower(trim((string)$value)); return strtolower(trim((string) $value));
} }
function read_config_json_object_list(string $key): array { function read_config_json_object_list(string $key): array
{
global $CONFIG; global $CONFIG;
$value = $CONFIG[$key] ?? []; $value = $CONFIG[$key] ?? [];
if (!is_array($value)) return []; if (!is_array($value))
return [];
$out = []; $out = [];
foreach ($value as $row) { foreach ($value as $row) {
if (is_array($row) && isset($row['name'], $row['extension'])) { if (is_array($row) && isset($row['name'], $row['extension'])) {
$out[] = [ $out[] = [
'name' => (string)$row['name'], 'name' => (string) $row['name'],
'extension' => (string)$row['extension'], 'extension' => (string) $row['extension'],
]; ];
} }
} }
return $out; return $out;
} }
function pull_xml_file(string $file): DOMDocument { function pull_xml_file(string $file): DOMDocument
if (!file_exists($file)) { {
$file = '/tftpboot/000000000000-features.cfg'; if (!file_exists($file)) {
} $file = '/tftpboot/000000000000-features.cfg';
$xmlString = file_get_contents($file); }
if ($xmlString === false) { $xmlString = file_get_contents($file);
throw new RuntimeException("Unable to read file: {$file}"); if ($xmlString === false) {
} throw new RuntimeException("Unable to read file: {$file}");
}
$xmlString = preg_replace('/^\xEF\xBB\xBF/', '', $xmlString); // BOM $xmlString = preg_replace('/^\xEF\xBB\xBF/', '', $xmlString); // BOM
$xmlString = ltrim($xmlString); $xmlString = ltrim($xmlString);
$firstAngle = strpos($xmlString, '<'); $firstAngle = strpos($xmlString, '<');
if ($firstAngle !== false && $firstAngle > 0) { if ($firstAngle !== false && $firstAngle > 0) {
$xmlString = substr($xmlString, $firstAngle); $xmlString = substr($xmlString, $firstAngle);
} }
$xml = new DOMDocument('1.0', 'UTF-8'); $xml = new DOMDocument('1.0', 'UTF-8');
$xml->preserveWhiteSpace = true; $xml->preserveWhiteSpace = true;
$xml->formatOutput = true; $xml->formatOutput = true;
$xml->xmlStandalone = true; $xml->xmlStandalone = true;
if (!$xml->loadXML($xmlString)) { if (!$xml->loadXML($xmlString)) {
$errs = libxml_get_errors(); $errs = libxml_get_errors();
libxml_clear_errors(); libxml_clear_errors();
$msg = "Failed to parse XML.\n"; $msg = "Failed to parse XML.\n";
foreach ($errs as $e) { foreach ($errs as $e) {
$msg .= "[level {$e->level}] {$e->message} at line {$e->line}\n"; $msg .= "[level {$e->level}] {$e->message} at line {$e->line}\n";
} }
throw new RuntimeException($msg); throw new RuntimeException($msg);
} }
return $xml; return $xml;
} }
function remove_attendants(DOMDocument $xml): DOMElement { function remove_attendants(DOMDocument $xml): DOMElement
$xpath = new DOMXPath($xml); {
$attendantNodes = $xpath->query('/polycomConfig/attendant'); $xpath = new DOMXPath($xml);
if ($attendantNodes->length === 0) { $attendantNodes = $xpath->query('/polycomConfig/attendant');
throw new RuntimeException("No <attendant> element found at /polycomConfig/attendant"); if ($attendantNodes->length === 0) {
} throw new RuntimeException('No <attendant> element found at /polycomConfig/attendant');
$attendant = $attendantNodes->item(0); }
$attendant = $attendantNodes->item(0);
$toRemove = []; $toRemove = [];
foreach ($attendant->attributes as $attr) { foreach ($attendant->attributes as $attr) {
if (strpos($attr->nodeName, 'attendant.resourceList.') === 0) { if (strpos($attr->nodeName, 'attendant.resourceList.') === 0) {
$toRemove[] = $attr->nodeName; $toRemove[] = $attr->nodeName;
} }
} }
foreach ($toRemove as $name) { foreach ($toRemove as $name) {
$attendant->removeAttribute($name); $attendant->removeAttribute($name);
} }
return $attendant; return $attendant;
} }
function write_attendants(DOMElement $attendant, array $pbdb): void { function write_attendants(DOMElement $attendant, array $pbdb): void
$index = 1; {
foreach ($pbdb as $r) { $index = 1;
$label = trim((string)($r['name'] ?? '')); foreach ($pbdb as $r) {
$address = trim((string)($r['extension'] ?? '')); $label = trim((string) ($r['name'] ?? ''));
$type = trim((string)("normal")); $address = trim((string) ($r['extension'] ?? ''));
$type = trim((string) 'normal');
$attendant->setAttribute("attendant.resourceList.{$index}.address", $address); $attendant->setAttribute("attendant.resourceList.{$index}.address", $address);
$attendant->setAttribute("attendant.resourceList.{$index}.label", $label); $attendant->setAttribute("attendant.resourceList.{$index}.label", $label);
$attendant->setAttribute("attendant.resourceList.{$index}.type", $type); $attendant->setAttribute("attendant.resourceList.{$index}.type", $type);
$index++; $index++;
} }
} }
function write_to_file(string $file, DOMDocument $xml): void { function write_to_file(string $file, DOMDocument $xml): void
global $PROVISION_DIR; {
if (!is_dir($PROVISION_DIR)) { global $PROVISION_DIR;
fwrite(STDERR, "Provisioning directory not found: $PROVISION_DIR\n"); if (!is_dir($PROVISION_DIR)) {
exit(2); fwrite(STDERR, "Provisioning directory not found: $PROVISION_DIR\n");
} exit(2);
}
$tmpfile = $file . '.tmp'; $tmpfile = $file . '.tmp';
if ($xml->save($tmpfile) === false) { if ($xml->save($tmpfile) === false) {
fwrite(STDERR, "Failed to write temporary file $tmpfile\n"); fwrite(STDERR, "Failed to write temporary file $tmpfile\n");
exit(3); exit(3);
} }
if (!@rename($tmpfile, $file)) { if (!@rename($tmpfile, $file)) {
@unlink($tmpfile); @unlink($tmpfile);
fwrite(STDERR, "Failed to move $tmpfile to $file (permissions?)\n"); fwrite(STDERR, "Failed to move $tmpfile to $file (permissions?)\n");
exit(4); exit(4);
} }
if (!chown($file, 'asterisk')) { if (!chown($file, 'asterisk')) {
error_log("chown failed for $file"); error_log("chown failed for $file");
} }
if (!chgrp($file, 'asterisk')) { if (!chgrp($file, 'asterisk')) {
error_log("chgrp failed for $file"); error_log("chgrp failed for $file");
} }
echo "Wrote $file \n"; echo "Wrote $file \n";
} }
function notify(array $pbdb): void { function notify(array $pbdb): void
{
$notified = 0; $notified = 0;
foreach ($pbdb as $r) { foreach ($pbdb as $r) {
$ext = trim((string)$r['extension']); $ext = trim((string) $r['extension']);
if ($ext === '') continue; if ($ext === '')
$cmd = "asterisk -rx \"pjsip send notify polycom-check-cfg endpoint " . escapeshellarg($ext) . "\""; continue;
$cmd = 'asterisk -rx "pjsip send notify polycom-check-cfg endpoint ' . escapeshellarg($ext) . '"';
exec($cmd, $o, $rc); exec($cmd, $o, $rc);
if ($rc === 0) $notified++; if ($rc === 0)
$notified++;
} }
echo "Sent check-sync to $notified endpoints\n"; echo "Sent check-sync to $notified endpoints\n";
} }