Changeset 927 for trunk/cgi-bin/search-rpc.cgi

Timestamp:

07/12/19 16:13:35 (5 years ago)

Author:

Kris Deugau

Message:

/trunk

Fix mismatch between the web UI search and the RPC search; the RPC search

incorrectly used the leaf allocation entry, not the master VRF entry.

Extend the RPC search to allow specifying the fields to return

File:

• trunk/cgi-bin/search-rpc.cgi (modified) (2 diffs)

trunk/cgi-bin/search-rpc.cgi

@@ -256 +256 @@
   }
 
-  my $cols = "s.cidr, s.custid, s.type, s.city, s.description, s.id, s.parent_id, s.available, s.vrf, a.dispname";
-  my $sql = qq(SELECT $cols FROM searchme s JOIN alloctypes a ON s.type = a.type);
+  my $cols = "s.cidr, s.custid, s.type, s.city, s.description, s.id, s.parent_id, s.available, a.vrf, at.dispname";
+
+  # Validation and SQL field name mapping all in one!
+  my %validcols = (cidr => 's.cidr', custid => 's.custid', oldcustid => 's.oldcustid', type => 's.type', city => 's.city',
+    description => 's.description', notes => 's.notes', circuitid => 's.circuitid', vrf => 'a.vrf', vlan => 's.vlan',
+    id => 's.id', parent_id => 's.parent_id', master_id => 's.master_id', available => 's.available');
+  my @usercols;
+
+  if ($args{retfields}) {
+    # caller wants a custom set of returned fields
+    if (ref($args{retfields}) eq ref([])) {
+      # field list passed as list/array
+      foreach (@{$args{retfields}}) {
+        push @usercols, $validcols{$_} if $validcols{$_};
+      }
+    } elsif (not ref $args{retfields}) {
+      # field list passed as simple string
+      foreach (split /\s+/, $args{retfields}) {
+        push @usercols, $validcols{$_} if $validcols{$_};
+      }
+    } else {
+      # nonfatal fail.  only accepts array or string.  fall back to default list
+    }
+  }
+
+  # only replace the default set if a custom set was passed in
+  $cols = join ', ', @usercols if @usercols;
+
+  my $sql = qq(SELECT $cols FROM searchme s JOIN alloctypes at ON s.type = at.type JOIN allocations a ON s.master_id=a.id);
   my @sqlcriteria;
   for (my $i = 0; $i <= $#fields; $i++) {
@@ -436 +463 @@
 city, and description.
 
+=item fields
+
+Specify the fields to return from the search.  By default, these are returned:
+
+=over 4
+
+cidr
+custid
+type
+city
+description
+id
+parent_id
+available
+vrf
+dispname  (the "display name" for the type)
+
 =back
 
+The following are available from this interface:
+
+=over 4
+
+cidr
+custid
+oldcustid
+type
+city
+description
+notes
+circuitid
+vrf
+vlan
+id
+parent_id
+master_id
+available
+
+=back
+
+The list may be sent as a space-separated string or as an array.  Unknown field names will be ignored.
+
+=back