Changeset 11366

Timestamp:

02/13/11 16:32:26 (2 years ago)

Author:

p_lindheimer

Message:

closes #4812 adds some common device defaults for fields that are likely to be changed

Files:

• freepbx/branches/2.9/libfreepbx.install.php (modified) (1 diff)
• modules/branches/2.9/core/functions.inc.php (modified) (18 diffs)

freepbx/branches/2.9/libfreepbx.install.php

@@ -1658 +1658 @@
-  $freepbx_conf->define_conf_setting('BRAND_CSS_CUSTOM',$set);
-
+  //
+  // CATEGORY: Device Setting Defaults
+  //
+  $set['category'] = 'New Device Defaults';
+  $set['level'] = 0;
+
+// ALWAYS_SHOW_DEVICE_DETAILS
+  $set['value'] = false;
+  $set['options'] = '';
+  $set['name'] = 'Show all Device Setting on Add';
+  $set['description'] = 'When adding a new extension/device, setting this to true will show most available device settings that are displayed when you edit the same extension/device. Otherwise, just a few basic settings are displayed.';
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_BOOL;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 10;
+  $freepbx_conf->define_conf_setting('ALWAYS_SHOW_DEVICE_DETAILS',$set);
+
+  // DEVICE_SIP_CANREINVITE
+  $set['value'] = 'yes';
+  $set['options'] = array('no', 'yes', 'nonat', 'update');
+  $set['name'] = 'SIP canrenivite (directmedia)';
+  $set['description'] = 'Default setting for SIP canreinvite (same as directmedia). See Asterisk documentation for details.';
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_SELECT;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 20;
+  $freepbx_conf->define_conf_setting('DEVICE_SIP_CANREINVITE',$set);
+
+  // DEVICE_SIP_TRUSTRPID
+  $set['value'] = 'yes';
+  $set['options'] = array('no', 'yes');
+  $set['name'] = 'SIP trustrpid';
+  $set['description'] = 'Default setting for SIP trustrpid. See Asterisk documentation for details.';
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_SELECT;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 30;
+  $freepbx_conf->define_conf_setting('DEVICE_SIP_TRUSTRPID',$set);
+
+  // DEVICE_SIP_SENDRPID
+  $set['value'] = 'no';
+  $set['options'] = array('no', 'yes', 'pai');
+  $set['name'] = 'SIP trustrpid';
+  $set['description'] = "Default setting for SIP sendrpid. A value of 'yes' is equivalent to 'rpid' and will send the 'Remote-Pary-ID' header. A value of 'pai' is only valid starting with Asterisk 1.8 and will send the 'P-Asserted-Identity' header. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_SELECT;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 40;
+  $freepbx_conf->define_conf_setting('DEVICE_SIP_SENDRPID',$set);
+
+  // DEVICE_SIP_NAT
+  $set['value'] = 'yes';
+  $set['options'] = array('no', 'yes', 'never', 'route');
+  $set['name'] = 'SIP nat';
+  $set['description'] = "Default setting for SIP nat. A 'yes' will attempt to handle nat, also works for local (uses the network ports and address instead of the reported ports), 'no' follows the protocol, 'never' tries to block it, no RFC3581, 'route' ignores the rport information. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_SELECT;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 50;
+  $freepbx_conf->define_conf_setting('DEVICE_SIP_NAT',$set);
+
+  // DEVICE_SIP_ENCRYPTION
+  $set['value'] = 'no';
+  $set['options'] = array('no', 'yes');
+  $set['name'] = 'SIP encryption';
+  $set['description'] = "Default setting for SIP encryption. Whether to offer SRTP encrypted media (and only SRTP encrypted media) on outgoing calls to a peer. Calls will fail with HANGUPCAUSE=58 if the peer does not support SRTP. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_SELECT;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 60;
+  $freepbx_conf->define_conf_setting('DEVICE_SIP_ENCRYPTION',$set);
+
+  // DEVICE_SIP_QUALIFYFREQ
+  $set['value'] = 60;
+  $set['options'] = array(15, 86400);
+  $set['name'] = 'SIP qualifyfreq';
+  $set['description'] = "Default setting for SIP qualifyfreq. Only valid for Asterisk 1.6 and above. Frequency that 'qualify' OPTIONS messages will be sent to the device. Can help to keep NAT holes open but not dependable for remote client firewalls. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_INT;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 70;
+  $freepbx_conf->define_conf_setting('DEVICE_SIP_QUALIFYFREQ',$set);
+
+  // DEVICE_QUALIFY
+  $set['value'] = 'yes';
+  $set['options'] = '';
+  $set['name'] = 'SIP and IAX qualify';
+  $set['description'] = "Default setting for SIP and IAX qualify. Whether to send periodic OPTIONS messages (for SIP) or otherwise monitor the channel, and at what point to consider the channel unavailable. A value of 'yes' is equivalent to 2000, time in msec. Can help to keep NAT holes open with SIP but not dependable for remote client firewalls. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_TEXT;
+  $set['emptyok'] = 0;
+  $set['sortorder'] = 80;
+  $freepbx_conf->define_conf_setting('DEVICE_QUALIFY',$set);
+
+  // DEVICE_DISALLOW
+  $set['value'] = '';
+  $set['options'] = '';
+  $set['name'] = 'SIP and IAX disallow';
+  $set['description'] = "Default setting for SIP and IAX disallow (for codecs). Codecs to disallow, can help to reset from the general settings by setting a value of 'all' and then specifically including allowed codecs with the 'allow' directive. Values van be separated with '&' e.g. 'g729&g722'. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_TEXT;
+  $set['emptyok'] = 1;
+  $set['sortorder'] = 90;
+  $freepbx_conf->define_conf_setting('DEVICE_DISALLOW',$set);
+
+  // DEVICE_ALLOW
+  $set['value'] = '';
+  $set['options'] = '';
+  $set['name'] = 'SIP and IAX allow';
+  $set['description'] = "Default setting for SIP and IAX allow (for codecs). Codecs to allow in addition to those set in general settings unless explicitly 'disallowed' for the device. Values van be separated with '&' e.g. 'ulaw&g729&g729' where the preference order is preserved. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_TEXT;
+  $set['emptyok'] = 1;
+  $set['sortorder'] = 90;
+  $freepbx_conf->define_conf_setting('DEVICE_ALLOW',$set);
+
+  // DEVICE_CALLGROUP
+  $set['value'] = '';
+  $set['options'] = '';
+  $set['name'] = 'SIP & DAHDI callgroup';
+  $set['description'] = "Default setting for SIP, DAHDI (and Zap) callgroup. Callgroup(s) that the device is part of, can be one or more callgroups, e.g. '1,3-5' would be in groups 1,3,4,5. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_TEXT;
+  $set['emptyok'] = 1;
+  $set['sortorder'] = 100;
+  $freepbx_conf->define_conf_setting('DEVICE_CALLGROUP',$set);
+
+  // DEVICE_PICKUPGROUP
+  $set['value'] = '';
+  $set['options'] = '';
+  $set['name'] = 'SIP & DAHDI pickupgroup';
+  $set['description'] = "Default setting for SIP, DAHDI (and Zap) pickupgroup. Pickupgroups(s) that the device can pickup calls from, can be one or more groups, e.g. '1,3-5' would be in groups 1,3,4,5. Device does not have to be in a group to be able to pickup calls from that group. See Asterisk documentation for details.";
+  $set['readonly'] = 0;
+  $set['type'] = CONF_TYPE_TEXT;
+  $set['emptyok'] = 1;
+  $set['sortorder'] = 110;
+  $freepbx_conf->define_conf_setting('DEVICE_PICKUPGROUP',$set);
-
-  // The following settings are used in various modules prior to 2.9. If they are found in amportal.conf then we

modules/branches/2.9/core/functions.inc.php

@@ -4080 +4080 @@
-function core_devices_addsip($account) {
-  global $db;
+  global $amp_conf;
-
-  $flag = 2;
@@ -4101 +4102 @@
-    $sipfields[] = array($account,'accountcode',$db->escapeSimple((isset($_REQUEST['accountcode']))?$_REQUEST['accountcode']:''),$flag++);
-    $sipfields[] =array($account,'secret',$db->escapeSimple((isset($_REQUEST['secret']))?$_REQUEST['secret']:''),$flag++);
-'no'
-'no'
-'no'
+$amp_conf['DEVICE_SIP_CANREINVITE']
+$amp_conf['DEVICE_SIP_TRUSTRPID']
+$amp_conf['DEVICE_SIP_SENDRPID']
-    $sipfields[] = array($account,'context',$db->escapeSimple((isset($_REQUEST['context']))?$_REQUEST['context']:'from-internal'),$flag++);
-    $sipfields[] = array($account,'dtmfmode',$db->escapeSimple((isset($_REQUEST['dtmfmode']))?$_REQUEST['dtmfmode']:''),$flag++);
@@ -4110 +4111 @@
-    $sipfields[] = array($account,'mailbox',$db->escapeSimple((isset($_REQUEST['mailbox']) && !empty($_REQUEST['mailbox']))?$_REQUEST['mailbox']:$account.'@device'),$flag++);
-    $sipfields[] = array($account,'username',$db->escapeSimple((isset($_REQUEST['username']))?$_REQUEST['username']:$account),$flag++);
-'yes'
+
-    $sipfields[] = array($account,'port',$db->escapeSimple((isset($_REQUEST['port']))?$_REQUEST['port']:'5060'),$flag++);
-'yes'
+$amp_conf['DEVICE_QUALIFY']
-    if (version_compare($amp_conf['ASTVERSION'],'1.6','ge')) {
-'60'
+$amp_conf['DEVICE_SIP_QUALIFYFREQ']
-    }
-    if (version_compare($amp_conf['ASTVERSION'],'1.8','ge')) {
-      $sipfields[] = array($account,'transport',$db->escapeSimple((isset($_REQUEST['transport']))?$_REQUEST['transport']:'udp'),$flag++);
-'no'
+$amp_conf['DEVICE_SIP_ENCRYPTION']
-    }
-''
-''
+$amp_conf['DEVICE_CALLGROUP']
+$amp_conf['DEVICE_PICKUPGROUP']
-    $sipfields[] = array($account,'deny',$db->escapeSimple((isset($_REQUEST['deny']))?$_REQUEST['deny']:''),$flag++);
-    $sipfields[] = array($account,'permit',$db->escapeSimple((isset($_REQUEST['permit']))?$_REQUEST['permit']:''),$flag++);
-''
-''
+$amp_conf['DEVICE_DISALLOW']
+$amp_conf['DEVICE_ALLOW']
-
-    $vmexten = isset($_REQUEST['vmexten'])?$db->escapeSimple(trim($_REQUEST['vmexten'])):'';
@@ -4173 +4174 @@
-function core_devices_addiax2($account) {
-  global $db;
+  global $amp_conf;
-
-  $flag = 2;
@@ -4198 +4200 @@
-      array($account,'username',$db->escapeSimple(($_REQUEST['username'])?$_REQUEST['username']:$account),$flag++),
-      array($account,'port',$db->escapeSimple(($_REQUEST['port'])?$_REQUEST['port']:'4569'),$flag++),
-'yes'
+$amp_conf['DEVICE_QUALIFY']
-      array($account,'deny',$db->escapeSimple((isset($_REQUEST['deny']))?$_REQUEST['deny']:''),$flag++),
-      array($account,'permit',$db->escapeSimple((isset($_REQUEST['permit']))?$_REQUEST['permit']:''),$flag++),      
-''
-''
+$amp_conf['DEVICE_DISALLOW']
+$amp_conf['DEVICE_ALLOW']
-      array($account,'accountcode',$db->escapeSimple(($_REQUEST['accountcode'])?$_REQUEST['accountcode']:''),$flag++),
-      array($account,'requirecalltoken',$db->escapeSimple(($_REQUEST['requirecalltoken'])?$_REQUEST['requirecalltoken']:''),$flag++)
@@ -4252 +4254 @@
-function core_devices_addzap($account) {
-  global $db;
+  global $amp_conf;
-    
-  foreach ($_REQUEST as $req=>$data) {
@@ -4281 +4284 @@
-      array($account,'callprogress',$db->escapeSimple(($_REQUEST['callprogress'])?$_REQUEST['callprogress']:'no')),
-      array($account,'accountcode',$db->escapeSimple((isset($_REQUEST['accountcode']))?$_REQUEST['accountcode']:'')),
-''
-''
+$amp_conf['DEVICE_CALLGROUP']
+$amp_conf['DEVICE_PICKUPGROUP']
-      array($account,'channel',$db->escapeSimple(($_REQUEST['channel'])?$_REQUEST['channel']:''))
-    );
@@ -4304 +4307 @@
-function core_devices_adddahdi($account) {
-  global $db;
+  global $amp_conf;
-    
-  foreach ($_REQUEST as $req=>$data) {
@@ -4333 +4337 @@
-      array($account,'callprogress',$db->escapeSimple(($_REQUEST['callprogress'])?$_REQUEST['callprogress']:'no')),
-      array($account,'accountcode',$db->escapeSimple((isset($_REQUEST['accountcode']))?$_REQUEST['accountcode']:'')),
-''
-''
+$amp_conf['DEVICE_CALLGROUP']
+$amp_conf['DEVICE_PICKUPGROUP']
-      array($account,'channel',$db->escapeSimple(($_REQUEST['channel'])?$_REQUEST['channel']:''))
-    );
@@ -6435 +6439 @@
-    $tmparr['accountcode'] = array('value' => '', 'tt' => $tt, 'level' => 1);
-    $tt = _("Callgroup(s) that this device is part of, can be one or more callgroups, e.g. '1,3-5' would be in groups 1,3,4,5.");
-''
+$amp_conf['DEVICE_CALLGROUP']
-    $tt = _("Pickupgroups(s) that this device can pickup calls from, can be one or more groups, e.g. '1,3-5' would be in groups 1,3,4,5. Device does not have to be in a group to be able to pickup calls from that group.");
-''
+$amp_conf['DEVICE_PICKUPGROUP']
-    $tt = _("Mailbox for this device. This should not be changed unless you know what you are doing.");
-    $tmparr['mailbox'] = array('value' => '', 'tt' => $tt, 'level' => 2);
@@ -6491 +6495 @@
-    $tmparr['accountcode'] = array('value' => '', 'tt' => $tt, 'level' => 1);
-    $tt = _("Callgroup(s) that this device is part of, can be one or more callgroups, e.g. '1,3-5' would be in groups 1,3,4,5.");
-''
+$amp_conf['DEVICE_CALLGROUP']
-    $tt = _("Pickupgroups(s) that this device can pickup calls from, can be one or more groups, e.g. '1,3-5' would be in groups 1,3,4,5. Device does not have to be in a group to be able to pickup calls from that group.");
-''
+$amp_conf['DEVICE_PICKUPGROUP']
-    $tt = _("Mailbox for this device. This should not be changed unless you know what you are doing.");
-    $tmparr['mailbox'] = array('value' => '', 'tt' => $tt, 'level' => 2);
@@ -6528 +6532 @@
-    $tmparr['port'] = array('value' => '4569', 'tt' => $tt, 'level' => 1);
-    $tt = _("Setting to yes (equivalent to 2000 msec) will send an OPTIONS packet to the endpoint periodically (default every minute). Used to monitor the health of the endpoint. If delays are longer then the qualify time, the endpoint will be taken offline and conisdered unreachable. Can be set to a value which is the msec threshhold. Setting to no will turn this off. Can also be helpful to keep NAT pinholes open.");
-'yes'
+$amp_conf['DEVICE_QUALIFY']
-    $tt = _("Disallowed codecs. Set this to all to remove all codecs defined in the general settings and then specify specific codecs separated by '&' on the 'allow' setting, or just disallow specific codecs separated by '&'.");
-''
+$amp_conf['DEVICE_DISALLOW']
-    $tt = _("Allow specific codecs, separated by the '&' sign and in priority order. E.g. 'ulaw&g729'. Codecs allowed in the general settings will also be allowed unless removed with the 'disallow' directive.");
-''
+$amp_conf['DEVICE_ALLOW']
-    $tt = _("How to dial this device, this should not be changed unless you know what you are doing.");
-    $tmparr['dial'] = array('value' => '', 'tt' => $tt, 'level' => 2);
@@ -6568 +6572 @@
-    $tt = _("The DTMF signalling mode used by this device, usually rfc2833 for most phones.");
-    $tmparr['dtmfmode'] = array('value' => 'rfc2833', 'tt' => $tt, 'select' => $select, 'level' => 0, 'jsvalidation' => 'isEmpty()', 'failvalidationmsg' => $msgInvalidDTMFMODE );
+  // $amp_conf['DEVICE_SIP_CANREINVITE']
+  // $amp_conf['DEVICE_SIP_TRUSTRPID']
+  // $amp_conf['DEVICE_SIP_SENDRPID']
+  // $amp_conf['DEVICE_SIP_NAT']
+  // $amp_conf['DEVICE_SIP_ENCRYPTION']
+  // $amp_conf['DEVICE_SIP_QUALIFYFREQ']
+  // $amp_conf['DEVICE_QUALIFY']
+  // $amp_conf['DEVICE_DISALLOW']
+  // $amp_conf['DEVICE_ALLOW']
+  // $amp_conf['DEVICE_CALLGROUP']
+  // $amp_conf['DEVICE_PICKUPGROUP']
-
-    unset($select);
@@ -6575 +6590 @@
-    $select[] = array('value' => 'nonat', 'text' => 'nonat');
-    $select[] = array('value' => 'update', 'text' => 'update');
-'no'
+$amp_conf['DEVICE_SIP_CANREINVITE']
-
-    $tt = _("Asterisk context this device will send calls to. Only change this is you know what you are doing.");
@@ -6587 +6602 @@
-    $select[] = array('value' => 'yes', 'text' => _('Yes'));
-    $tt = _("Whether Asterisk should trust the RPID settings from this device. Usually should be yes for CONNECTEDLINE() functionality to work if supported by the endpoint.");
-'no'
+$amp_conf['DEVICE_SIP_TRUSTRPID']
-
-    unset($select);
@@ -6597 +6612 @@
-    }
-    $tt = _("Whether Asterisk should send RPID (or PAI) info to the device. Usually should be enabled to the settings used by your device for CONNECTEDLINE() functionality to work if supported by the endpoint.");
-'no'
+$amp_conf['DEVICE_SIP_SENDRPID']
-
-    unset($select);
@@ -6612 +6627 @@
-    $select[] = array('value' => 'route', 'text' => _('route - NAT no rport'));
-    $tt = _("NAT setting, see Asterisk documentation for details. Yes usually works for both internal and external devices. Set to No if the device will always be internal.");
-'yes'
+$amp_conf['DEVICE_SIP_NAT']
-
-    $tt = _("Endpoint port number to use, usually 5060. Some 2 ports devices such as ATA may used 5061 for the second port.");
-    $tmparr['port'] = array('value' => '5060', 'tt' => $tt, 'level' => 1);
-    $tt = _("Setting to yes (equivalent to 2000 msec) will send an OPTIONS packet to the endpoint periodically (default every minute). Used to monitor the health of the endpoint. If delays are longer then the qualify time, the endpoint will be taken offline and conisdered unreachable. Can be set to a value which is the msec threshhold. Setting to no will turn this off. Can also be helpful to keep NAT pinholes open.");
-'yes'
+$amp_conf['DEVICE_QUALIFY']
-    if (version_compare($amp_conf['ASTVERSION'],'1.6','ge')) {
-      $tt = _("Frequency in seconds to send qualify messages to the endpoint.");
-'60'
+$amp_conf['DEVICE_SIP_QUALIFYFREQ']
-    }
-    if (version_compare($amp_conf['ASTVERSION'],'1.8','ge')) {
@@ -6633 +6648 @@
-      $select[] = array('value' => 'yes', 'text' => _('Yes'));
-      $tt = _("Whether to offer SRTP encrypted media (and only SRTP encrypted media) on outgoing calls to a peer. Calls will fail with HANGUPCAUSE=58 if the peer does not support SRTP. Defaults to no.");
-'no'
+$amp_conf['DEVICE_SIP_ENCRYPTION']
-    }
-
-    $tt = _("Callgroup(s) that this device is part of, can be one or more callgroups, e.g. '1,3-5' would be in groups 1,3,4,5.");
-''
+$amp_conf['DEVICE_CALLGROUP']
-    $tt = _("Pickupgroups(s) that this device can pickup calls from, can be one or more groups, e.g. '1,3-5' would be in groups 1,3,4,5. Device does not have to be in a group to be able to pickup calls from that group.");
-''
+$amp_conf['DEVICE_PICKUPGROUP']
-    $tt = _("Disallowed codecs. Set this to all to remove all codecs defined in the general settings and then specify specific codecs separated by '&' on the 'allow' setting, or just disallow specific codecs separated by '&'.");
-''
+$amp_conf['DEVICE_DISALLOW']
-    $tt = _("Allow specific codecs, separated by the '&' sign and in priority order. E.g. 'ulaw&g729'. Codecs allowed in the general settings will also be allowed unless removed with the 'disallow' directive.");
-''
+$amp_conf['DEVICE_ALLOW']
-    $tt = _("How to dial this device, this should not be changed unless you know what you are doing.");
-    $tmparr['dial'] = array('value' => '', 'tt' => $tt, 'level' => 2);