Final version

Standardise some calls and add notes
This commit is contained in:
steve-lad 2021-02-11 12:46:37 +01:00 committed by Diederik de Groot
parent 09beeb449e
commit dac622c745
No known key found for this signature in database
GPG key ID: AFA728250A1BECD6
2 changed files with 75 additions and 84 deletions

View file

@ -169,7 +169,11 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
$this->xml_data = simplexml_load_file($xml_vars); $this->xml_data = simplexml_load_file($xml_vars);
$this->initVarfromXml(); // Overwrite Exist $this->initVarfromXml(); // Overwrite Exist
} }
$this->saveSccpSettings();
if (get_class($freepbx) === 'FreePBX') {
// only save settings when building a new FreePBX object
$this->saveSccpSettings();
}
} }
/* /*
@ -643,6 +647,8 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
} }
public function ajaxRequest($req, &$setting) { public function ajaxRequest($req, &$setting) {
// Called first by BMO. Must return true or request will be aborted.
// See https://wiki.freepbx.org/display/FOP/BMO+Ajax+Calls
switch ($req) { switch ($req) {
case 'backupsettings': case 'backupsettings':
case 'savesettings': case 'savesettings':
@ -671,11 +677,13 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
case 'delete_dialplan': case 'delete_dialplan':
return true; return true;
break; break;
default:
return false;
} }
return false;
} }
// !TODO!: this should go into it's only ajam.html.php file (see: dahdiconfig) // !TODO!: this should go into it's only ajax.html.php file (see: dahdiconfig)
// ajaxHandler is called after ajaxRequest returns true
public function ajaxHandler() { public function ajaxHandler() {
$request = $_REQUEST; $request = $_REQUEST;
$msg = array(); $msg = array();
@ -823,7 +831,6 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
$res = $this->updateSccpButtons($hw_list); $res = $this->updateSccpButtons($hw_list);
$msg .= $res['Response'] . ' raw: ' . $res['data'] . ' '; $msg .= $res['Response'] . ' raw: ' . $res['data'] . ' ';
return array('status' => true, 'message' => 'Update Butons Labels Complite ' . $msg, 'reload' => true); return array('status' => true, 'message' => 'Update Butons Labels Complite ' . $msg, 'reload' => true);
case 'model_add': case 'model_add':
$save_settings = array(); $save_settings = array();
$key_name = array('model', 'vendor', 'dns', 'buttons', 'loadimage', 'loadinformationid', 'nametemplate'); $key_name = array('model', 'vendor', 'dns', 'buttons', 'loadimage', 'loadinformationid', 'nametemplate');
@ -847,7 +854,7 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
return $save_settings; return $save_settings;
break; break;
case 'model_enabled': case 'model_enabled':
$model_set = '1'; $model_set = '1'; // fall through intentionally
case 'model_disabled': case 'model_disabled':
if ($request['command'] == 'model_disabled') { if ($request['command'] == 'model_disabled') {
$model_set = '0'; $model_set = '0';
@ -860,7 +867,6 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
} }
} }
return array('status' => true, 'table_reload' => true); return array('status' => true, 'table_reload' => true);
break; break;
case 'model_delete': case 'model_delete':
if (!empty($request['model'])) { if (!empty($request['model'])) {
@ -1288,7 +1294,7 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
} }
$this->dbinterface->write("sccpdevice", $save_settings, 'replace'); $this->dbinterface->write("sccpdevice", $save_settings, 'replace');
$save_buttons = $this->getPhoneButtons($get_settings, $name_dev, $hw_type); $save_buttons = $this->getPhoneButtons($get_settings, $name_dev, $hw_type);
$this->dbinterface->write("sccpbuttons", $save_buttons, $update_hw, '', $name_dev); $this->dbinterface->write("sccpbuttons", $save_buttons, $update_hw, 'add', $name_dev); //was empty so would fall through to INSERT
$this->createSccpDeviceXML($name_dev); $this->createSccpDeviceXML($name_dev);
if ($hw_id == 'new') { if ($hw_id == 'new') {
$this->srvinterface->sccpDeviceReset($name_dev); $this->srvinterface->sccpDeviceReset($name_dev);
@ -1480,9 +1486,9 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
} }
} }
$this->dbinterface->write("sccpuser", $save_settings, 'replace', 'name'); $this->dbinterface->write("sccpuser", $save_settings, 'replace', 'name');
$this->dbinterface->write("sccpbuttons", $save_buttons, 'clear', '', $name_dev); $this->dbinterface->write("sccpbuttons", $save_buttons, 'delete', '', $name_dev); //standardise to delete
return $save_buttons; return $save_buttons;
// Why is there a second return here???????
return $save_settings; return $save_settings;
} }
@ -1867,7 +1873,7 @@ class Sccp_manager extends \FreePBX_Helpers implements \BMO {
// $save_settings = array(); // $save_settings = array();
if (empty($save_value)) { if (empty($save_value)) {
$this->dbinterface->write('sccpsettings', $this->sccpvalues, 'clear'); $this->dbinterface->write('sccpsettings', $this->sccpvalues, 'replace');
} else { } else {
$this->dbinterface->write('sccpsettings', $save_value, 'update'); $this->dbinterface->write('sccpsettings', $save_value, 'update');
} }

View file

@ -56,12 +56,11 @@ class dbinterface
if (empty($data['name'])) { if (empty($data['name'])) {
$stmts = $db->prepare('SELECT * FROM sccpline ORDER BY name'); $stmts = $db->prepare('SELECT * FROM sccpline ORDER BY name');
} else { } else {
$stmts = $db->prepare('SELECT * FROM sccpline WHERE name = $data[name]'); $stmts = $db->prepare('SELECT * FROM sccpline WHERE name = :name');
$stmt->bindParam(':name', $data['name'],\PDO::PARAM_STR);
} }
break; break;
case "SccpDevice": case 'SccpDevice':
$filtered ='';
$singlerow = false;
if (empty($data['fields'])) { if (empty($data['fields'])) {
$fld = 'name, name as mac, type, button, addon, _description as description'; $fld = 'name, name as mac, type, button, addon, _description as description';
} else { } else {
@ -77,30 +76,21 @@ class dbinterface
break; break;
} }
} }
if (!empty($data['name'])) { if (!empty($data['name'])) { //either filter by name or by type
$filtered = 'name =' . $data['name']. ''; $stmt = $db->prepare('SELECT ' . $fld . ' FROM sccpdeviceconfig WHERE name = :name ORDER BY name');
$singlerow = true; $stmt->bindParam(':name', $data['name'],\PDO::PARAM_STR);
} } elseif (!empty($data['type'])) {
if (!empty($data['type'])) {
switch ($data['type']) { switch ($data['type']) {
case "cisco-sip": case "cisco-sip":
$filtered = 'TYPE LIKE \'%-sip\''; $stmts = $db->prepare('SELECT ' . $fld . ' FROM sccpdeviceconfig WHERE TYPE LIKE \'%-sip\' ORDER BY name');
break; break;
case "cisco": case "cisco": // Fall through to default intentionally
default: default:
$filtered = 'TYPE not LIKE \'%-sip\''; $stmts = $db->prepare('SELECT ' . $fld . ' FROM sccpdeviceconfig WHERE TYPE not LIKE \'%-sip\' ORDER BY name');
break; break;
} }
} } else { //no filter and no name provided - return all
if (empty($filtered)) { $stmts = $db->prepare('SELECT ' . $fld . ' FROM sccpdeviceconfig WHERE ORDER BY name');
$sql = 'SELECT ' . $fld . ' FROM sccpdeviceconfig ORDER BY name';
} else {
$sql = 'SELECT ' . $fld . ' FROM sccpdeviceconfig WHERE '. $filtered . ' ORDER BY name';
}
if ($singlerow) {
$stmt = $db->prepare($sql);
} else {
$stmts = $db->prepare($sql);
} }
break; break;
case 'HWSipDevice': case 'HWSipDevice':
@ -113,39 +103,34 @@ class dbinterface
$raw_settings = $this->getDb_model_info($get = "extension", $format_list = "model"); $raw_settings = $this->getDb_model_info($get = "extension", $format_list = "model");
break; break;
case 'get_columns_sccpdevice': case 'get_columns_sccpdevice':
$sql = 'DESCRIBE sccpdevice'; $stmts = $db->prepare('DESCRIBE sccpdevice');
$stmt = $db->prepare($sql);
break; break;
case 'get_columns_sccpuser': case 'get_columns_sccpuser':
$sql = 'DESCRIBE sccpuser'; $stmts = $db->prepare('DESCRIBE sccpuser');
$stmts = $db->prepare($sql);
break; break;
case 'get_sccpdevice_byid': case 'get_sccpdevice_byid':
$sql = 'SELECT t1.*, types.dns, types.buttons, types.loadimage, types.nametemplate as nametemplate, $stmt = $db->prepare('SELECT t1.*, types.dns, types.buttons, types.loadimage, types.nametemplate as nametemplate,
addon.buttons as addon_buttons FROM sccpdevice AS t1 addon.buttons as addon_buttons FROM sccpdevice AS t1
LEFT JOIN sccpdevmodel as types ON t1.type=types.model LEFT JOIN sccpdevmodel as types ON t1.type=types.model
LEFT JOIN sccpdevmodel as addon ON t1.addon=addon.model WHERE name =\'' . $data['id'] . '\''; LEFT JOIN sccpdevmodel as addon ON t1.addon=addon.model WHERE name = :name');
$stmt = $db->prepare($sql); $stmt->bindParam(':name', $data['id'],\PDO::PARAM_STR);
break; break;
case "get_sccpuser": case 'get_sccpuser':
$sql = 'SELECT * FROM sccpuser '; $stmt = $db->prepare('SELECT * FROM sccpuser WHERE name = :name');
if (!empty($data['id'])) { $stmt->bindParam(':name', $data['id'],\PDO::PARAM_STR);
$sql .= 'WHERE name= ' . $data['id'] . '';
}
$sql .= ' ORDER BY name';
$stmt = $db->prepare($sql);
break; break;
case 'get_sccpdevice_buttons': case 'get_sccpdevice_buttons':
$sql = ''; $sql = '';
if (!empty($data['buttontype'])) { if (!empty($data['buttontype'])) {
$sql .= 'buttontype="' . $data['buttontype'] . '" '; $sql .= 'buttontype = :buttontype';
} }
if (!empty($data['id'])) { if (!empty($data['id'])) {
$sql .= (empty($sql)) ? 'ref="' . $data['id'] . '" ' : 'and ref="' . $data['id'] . ''; $sql .= (empty($sql)) ? 'ref = :ref' : ' and ref = :ref';
} }
if (!empty($sql)) { if (!empty($sql)) {
$sql = 'SELECT * FROM sccpbuttonconfig WHERE ' .$sql. ' ORDER BY `instance`;'; $stmts = $db->prepare('SELECT * FROM sccpbuttonconfig WHERE ' .$sql. ' ORDER BY instance');
$stmts = $db->prepare($sql); $stmts->bindParam(':buttontype', $data['buttontype'],\PDO::PARAM_STR);
$stmts->bindParam(':ref', $data['id'],\PDO::PARAM_STR);
} else { } else {
$raw_settings = array(); $raw_settings = array();
} }
@ -196,13 +181,12 @@ class dbinterface
if (!empty($filter)) { if (!empty($filter)) {
if (!empty($filter['model'])) { if (!empty($filter['model'])) {
if (strpos($filter['model'], 'loadInformation')) { if (strpos($filter['model'], 'loadInformation')) {
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (loadinformationid =' . $filter['model'] . ') ORDER BY model'; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (loadinformationid =' . $filter['model'] . ') ORDER BY model');
} else { } else {
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (loadinformationid =loadInformation' . $filter['model'] . ') ORDER BY model'; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (loadinformationid = loadInformation' . $filter['model'] . ') ORDER BY model');
} }
} else { } else {
// $sql = "SELECT ".$filter['model']; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel ORDER BY model');
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel ORDER BY model';
} }
break; break;
} }
@ -210,35 +194,34 @@ class dbinterface
case 'byid': case 'byid':
if (!empty($filter)) { if (!empty($filter)) {
if (!empty($filter['model'])) { if (!empty($filter['model'])) {
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (model =' . $filter['model'] . ') ORDER BY model'; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE model = :model ORDER BY model');
$stmt->bindParam(':model', $filter['model'],\PDO::PARAM_STR);
} else { } else {
// $sql = "SELECT ".$filter['model']; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel ORDER BY model');
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel ORDER BY model';
} }
break; break;
} }
break; break;
case 'extension': case 'extension':
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns = 0) and (enabled > 0) ORDER BY model'; //check table $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns = 0) and (enabled = 1) ORDER BY model');
break; break;
case 'enabled': case 'enabled':
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE enabled > 0 ORDER BY model '; //previously this fell through to phones. //$stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE enabled = 1 ORDER BY model'); //previously this fell through to phones.
break; //break; // above includes expansion modules but was not original behaviour so commented out. Falls through to phones.
case 'phones': case 'phones':
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns > 0) and (enabled > 0) ORDER BY model '; //check table $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns > 0) and (enabled = 1) ORDER BY model ');
break; break;
case 'ciscophones': case 'ciscophones':
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns > 0) and (enabled > 0) AND vendor NOT LIKE \'%-sip\' ORDER BY model'; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns > 0) and (enabled = 1) AND vendor NOT LIKE \'%-sip\' ORDER BY model');
break; break;
case 'sipphones': case 'sipphones':
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns > 0) and (enabled > 0) AND `vendor` LIKE \'%-sip\' ORDER BY model'; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel WHERE (dns > 0) and (enabled = 1) AND `vendor` LIKE \'%-sip\' ORDER BY model');
break; break;
case 'all': // Fall through to default case 'all': // Fall through to default
default: default:
$sql = 'SELECT ' . $sel_inf . ' FROM sccpdevmodel ORDER BY model'; $stmt = $db->prepare('SELECT ' . $sel_inf . ' FROM sccpdevmodel ORDER BY model');
break; break;
} }
$stmt = $db->prepare($sql);
$stmt->execute(); $stmt->execute();
return $stmt->fetchAll(\PDO::FETCH_ASSOC); return $stmt->fetchAll(\PDO::FETCH_ASSOC);
} }
@ -252,8 +235,7 @@ class dbinterface
$delete_value = array(); $delete_value = array();
switch ($table_name) { switch ($table_name) {
case 'sccpsettings': case 'sccpsettings':
$time = -microtime(true); if ($mode == 'replace') { // Change mode name to be more transparent
if ($mode == 'clear') {
$db->prepare('TRUNCATE sccpsettings')->execute(); $db->prepare('TRUNCATE sccpsettings')->execute();
$stmt = $db->prepare('INSERT INTO sccpsettings (keyword, data, seq, type) VALUES (:keyword,:data,:seq,:type)'); $stmt = $db->prepare('INSERT INTO sccpsettings (keyword, data, seq, type) VALUES (:keyword,:data,:seq,:type)');
} else { } else {
@ -281,7 +263,7 @@ class dbinterface
} }
break; break;
case 'sccpdevmodel': // Fall through to next intentionally case 'sccpdevmodel': // Fall through to next intentionally
case 'sccpdevice': // Fall through to next intentionally case 'sccpdevice': // Fall through to next intentionally
case 'sccpuser': case 'sccpuser':
$sql_key = ""; $sql_key = "";
$sql_var = ""; $sql_var = "";
@ -292,46 +274,49 @@ class dbinterface
if ($data === $this->val_null) { if ($data === $this->val_null) {
$sql_var .= $key_v . '= NULL'; $sql_var .= $key_v . '= NULL';
} else { } else {
$sql_var .= $key_v . ' = \'' . $data . '\''; $sql_var .= $key_v . ' = \'' . $data . '\''; //quote data as normally is string
} }
if ($key_fld == $key_v) { if ($key_v === $key_fld) {
$sql_key = $key_v . ' = \'' . $data . '\''; $sql_key = $key_v . ' = \'' . $data . '\''; //quote data as normally is string
} }
} }
if (!empty($sql_var)) { if (!empty($sql_var)) {
switch ($mode) { switch ($mode) {
case 'delete': case 'delete':
$req = 'DELETE FROM '. $table_name . ' WHERE ' . $sql_key; $stmt = $db->prepare('DELETE FROM '. $table_name . ' WHERE ' . $sql_key);
break; break;
case 'update': case 'update':
$req = 'UPDATE ' . $table_name . ' SET ' . $sql_var . ' WHERE ' . $sql_key; $stmt = $db->prepare('UPDATE ' . $table_name . ' SET ' . $sql_var . ' WHERE ' . $sql_key);
break; break;
default: case 'replace':
$req = 'REPLACE INTO ' . $table_name . ' SET ' . $sql_var; $stmt = $db->prepare('REPLACE INTO ' . $table_name . ' VALUES ' . $sql_var);
break;
// no default mode - must be explicit.
} }
} }
$result = $db->prepare($req)->execute(); $result = $stmt->execute();
break; break;
case 'sccpbuttons': case 'sccpbuttons':
switch ($mode) { switch ($mode) {
case 'clear': // no break here as clear is same as delete
case 'delete': case 'delete':
$sql = 'DELETE FROM sccpbuttonconfig WHERE ref=' . $hwid . ''; $sql = 'DELETE FROM sccpbuttonconfig WHERE ref = :hwid';
$result = $db->prepare($sql)->execute(); $stmt = $db->prepare($sql);
$stmt->bindParam(':hwid', $hwid,\PDO::PARAM_STR);
$result = $stmt->execute();
break; break;
case 'replace': case 'replace':
if (!empty($save_value)) { if (!empty($save_value)) {
$sql = 'UPDATE sccpbuttonconfig SET name =? WHERE ref = ? AND reftype =? AND instance =? AND buttontype =?'; $stmt = $db->prepare('UPDATE sccpbuttonconfig SET name =? WHERE ref = ? AND reftype =? AND instance =? AND buttontype =?');
$stmt = $db->prepare($sql);
$result= $db->executeMultiple($stmt, $save_value); $result= $db->executeMultiple($stmt, $save_value);
} }
break; break;
default: case 'add':
if (!empty($save_value)) { if (!empty($save_value)) {
$sql = 'INSERT INTO sccpbuttonconfig (ref, reftype, instance, buttontype, name, options) VALUES (?,?,?,?,?,?)'; $stmt = $db->prepare('INSERT INTO sccpbuttonconfig (ref, reftype, instance, buttontype, name, options) VALUES (?,?,?,?,?,?)');
$stmt = $db->prepare($sql);
$result = $db->executeMultiple($stmt, $save_value); $result = $db->executeMultiple($stmt, $save_value);
} }
break;
// No default case - must be specific in request.
} }
} }
return $result; return $result;