Skip to content

Commit

Permalink
style: ran prettier on changed files
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaredhendrickson13
jaredhendrickson13 committed May 21, 2024
1 parent 6a4f0de commit 2501367
Show file tree
Hide file tree
Showing 9 changed files with 356 additions and 419 deletions.
5 changes: 3 additions & 2 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Tools.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,14 @@ function generate_documentation(): bool {
'name' => 'Apache 2.0',
'url' => 'https://raw.githubusercontent.com/jaredhendrickson13/pfsense-api/master/LICENSE',
],
'description' => '## Getting Started' .
'description' =>
'## Getting Started' .
'<br>' .
'- [Authentication and Authorization](https://pfrest.org/AUTHENTICATION_AND_AUTHORIZATION/)<br>' .
'- [Working with Object IDs](https://pfrest.org/WORKING_WITH_OBJECT_IDS/)<br>' .
'- [Queries and Filters](https://pfrest.org/QUERIES_AND_FILTERS/)<br>' .
'- [Common Control Parameters](https://pfrest.org/COMMON_CONTROL_PARAMETERS/)<br>' .
'- [Working with HATEOAS](https://pfrest.org/WORKING_WITH_HATEOAS/)<br>'
'- [Working with HATEOAS](https://pfrest.org/WORKING_WITH_HATEOAS/)<br>',
],
'components' => [
'responses' => [],
Expand Down
82 changes: 57 additions & 25 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/AvailableInterface.inc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,32 @@ namespace RESTAPI\Models;
use RESTAPI\Core\Model;
use RESTAPI\Fields\StringField;

class AvailableInterface extends Model
{
class AvailableInterface extends Model {
public StringField $if;
public StringField $mac;
public StringField $dmesg;
public StringField $in_use_by;

public function __construct(mixed $id = null, mixed $parent_id = null, mixed $data = [], ...$options)
{
public function __construct(mixed $id = null, mixed $parent_id = null, mixed $data = [], ...$options) {
# Set model attributes
$this->internal_callable = 'get_all_avail_interfaces';
$this->many = true;

# Set model fields
$this->if = new StringField(
default: "",
default: '',
allow_empty: true,
allow_null: true,
help_text: 'The name of the interface.',
);
$this->mac = new StringField(
default: "",
default: '',
allow_empty: true,
allow_null: true,
help_text: 'The MAC address of the interface.',
);
$this->dmesg = new StringField(
default: "",
default: '',
allow_empty: true,
allow_null: true,
help_text: 'The description of the interface.',
Expand All @@ -56,47 +54,71 @@ class AvailableInterface extends Model
$base_ifs = get_interface_list();

# Include wireless clone interfaces
if (config_get_path('wireless/clone') && is_array(config_get_path('wireless/clone')) && count(config_get_path('wireless/clone'))) {
if (
config_get_path('wireless/clone') &&
is_array(config_get_path('wireless/clone')) &&
count(config_get_path('wireless/clone'))
) {
foreach (config_get_path('wireless/clone', []) as $clone) {
$base_ifs[$clone['cloneif']] = $clone;
$base_ifs[$clone['cloneif']]['iswlclone'] = true;
}
}

# Include VLAN interfaces
if (config_get_path('vlans/vlan') && is_array(config_get_path('vlans/vlan')) && count(config_get_path('vlans/vlan'))) {
if (
config_get_path('vlans/vlan') &&
is_array(config_get_path('vlans/vlan')) &&
count(config_get_path('vlans/vlan'))
) {
foreach (config_get_path('vlans/vlan', []) as $vlan) {
$base_ifs[$vlan['vlanif']] = $vlan;
$base_ifs[$vlan['vlanif']]['isvlan'] = true;
}
}

# Include Bridge interfaces
if (config_get_path('bridges/bridged') && is_array(config_get_path('bridges/bridged')) && count(config_get_path('bridges/bridged'))) {
if (
config_get_path('bridges/bridged') &&
is_array(config_get_path('bridges/bridged')) &&
count(config_get_path('bridges/bridged'))
) {
foreach (config_get_path('bridges/bridged', []) as $bridge) {
$base_ifs[$bridge['bridgeif']] = $bridge;
$base_ifs[$bridge['bridgeif']]['isbridge'] = true;
}
}

# Include GIF interfaces
if (config_get_path('gifs/gif') && is_array(config_get_path('gifs/gif')) && count(config_get_path('gifs/gif'))) {
if (
config_get_path('gifs/gif') &&
is_array(config_get_path('gifs/gif')) &&
count(config_get_path('gifs/gif'))
) {
foreach (config_get_path('gifs/gif', []) as $gif) {
$base_ifs[$gif['gifif']] = $gif;
$base_ifs[$gif['gifif']]['isgif'] = true;
}
}

# Include GRE interfaces
if (config_get_path('gres/gre') && is_array(config_get_path('gres/gre')) && count(config_get_path('gres/gre'))) {
if (
config_get_path('gres/gre') &&
is_array(config_get_path('gres/gre')) &&
count(config_get_path('gres/gre'))
) {
foreach (config_get_path('gres/gre', []) as $gre) {
$base_ifs[$gre['greif']] = $gre;
$base_ifs[$gre['greif']]['isgre'] = true;
}
}

# Include LAGG interfaces
if (config_get_path('laggs/lagg') && is_array(config_get_path('laggs/lagg')) && count(config_get_path('laggs/lagg'))) {
if (
config_get_path('laggs/lagg') &&
is_array(config_get_path('laggs/lagg')) &&
count(config_get_path('laggs/lagg'))
) {
foreach (config_get_path('laggs/lagg', []) as $lagg) {
$base_ifs[$lagg['laggif']] = $lagg;
$base_ifs[$lagg['laggif']]['islagg'] = true;
Expand All @@ -111,38 +133,48 @@ class AvailableInterface extends Model
}

# Include QinQ interfaces
if (config_get_path('qinqs/qinqentry') && is_array(config_get_path('qinqs/qinqentry')) && count(config_get_path('qinqs/qinqentry'))) {
if (
config_get_path('qinqs/qinqentry') &&
is_array(config_get_path('qinqs/qinqentry')) &&
count(config_get_path('qinqs/qinqentry'))
) {
foreach (config_get_path('qinqs/qinqentry', []) as $qinq) {
$base_ifs["{$qinq['vlanif']}"]['descr'] = "VLAN {$qinq['tag']} on {$qinq['if']}";
$base_ifs["{$qinq['vlanif']}"]['isqinq'] = true;
# QinQ members
$qinqifs = explode(' ', $qinq['members']);
foreach ($qinqifs as $qinqif) {
$base_ifs["{$qinq['vlanif']}.{$qinqif}"]['descr'] = "QinQ {$qinqif} on VLAN {$qinq['tag']} on {$qinq['if']}";
$base_ifs["{$qinq['vlanif']}.{$qinqif}"][
'descr'
] = "QinQ {$qinqif} on VLAN {$qinq['tag']} on {$qinq['if']}";
$base_ifs["{$qinq['vlanif']}.{$qinqif}"]['isqinq'] = true;
}
}
}

# Include PPP interfaces
if (config_get_path('ppps/ppp') && is_array(config_get_path('ppps/ppp')) && count(config_get_path('ppps/ppp'))) {
if (
config_get_path('ppps/ppp') &&
is_array(config_get_path('ppps/ppp')) &&
count(config_get_path('ppps/ppp'))
) {
foreach (config_get_path('ppps/ppp', []) as $pppid => $ppp) {
$portname = $ppp['if'];
$base_ifs[$portname] = $ppp;
$base_ifs[$portname]['isppp'] = true;
$ports_base = basename($ppp['ports']);
if (isset($ppp['descr'])) {
$base_ifs[$portname]['descr'] = strtoupper($ppp['if']). "({$ports_base}) - {$ppp['descr']}";
} else if (isset($ppp['username'])) {
$base_ifs[$portname]['descr'] = strtoupper($ppp['if']). "({$ports_base}) - {$ppp['username']}";
$base_ifs[$portname]['descr'] = strtoupper($ppp['if']) . "({$ports_base}) - {$ppp['descr']}";
} elseif (isset($ppp['username'])) {
$base_ifs[$portname]['descr'] = strtoupper($ppp['if']) . "({$ports_base}) - {$ppp['username']}";
} else {
$base_ifs[$portname]['descr'] = strtoupper($ppp['if']). "({$ports_base})";
$base_ifs[$portname]['descr'] = strtoupper($ppp['if']) . "({$ports_base})";
}
}
}

# Include OpenVPN interfaces
$ovpn_descrs = array();
$ovpn_descrs = [];
if (config_get_path('openvpn') && is_array(config_get_path('openvpn'))) {
if (config_get_path('openvpn/openvpn-server') && is_array(config_get_path('openvpn/openvpn-server'))) {
foreach (config_get_path('openvpn/openvpn-server', []) as $s) {
Expand All @@ -163,23 +195,23 @@ class AvailableInterface extends Model
# Include IPsec interfaces
$ipsec_descrs = interface_ipsec_vti_list_all();
foreach ($ipsec_descrs as $ifname => $ifdescr) {
$base_ifs[$ifname] = array('descr' => $ifdescr);
$base_ifs[$ifname] = ['descr' => $ifdescr];
}

# Loop through our array and check if interface is in use
foreach ($base_ifs as $pid => $conf) {
# Add the physical interface ID to the configuration
$base_ifs[$pid]["if"] = $pid;
$base_ifs[$pid]['if'] = $pid;

# Check if there is a configuration for this interface
$pf_id = NetworkInterface::query(if: $pid);

# Check if the pfSense interface ID was found
if ($pf_id->exists()) {
$base_ifs[$pid]["in_use_by"] = $pf_id->first()->id;;
$base_ifs[$pid]['in_use_by'] = $pf_id->first()->id;
}
}

return $base_ifs;
}
}
}
Loading

0 comments on commit 2501367

Please sign in to comment.