VendorByCu Class Reference

Public Member Functions
	__construct ()
	VendorByCuReport ()
	IsDownload ()
	isSuccessResult ($result)
	set ($prop, $value)

Protected Member Functions
	InitDownloadFlag ()
	DownloadCsv ($content)
	GetMasterData ()
	GetTvClients ()
	GetCuLocalData ()
	LocalDataSql ()
	GetExternalTrustedData ($server, $ids)
	setCurlCookies ($server)
	MergeClientsToCuData ($server, $external_data)
	isRealServer ($server, $cu)
	CuExistsInData ($cu)
	VendorExistsInData ($cu, $vendor)
	OutputReportHeader ()
	CsvHeader ()
	HtmlHeader ()
	OutputReportBody ()
	CsvBody ()
	OutputCsvDataRow ($cu)
	setCsvCellContent ($vendor_id, $cu)
	HtmlBody ()
	OutputHtmlDataRow ($cu, $toggle)
	GetCuEditLink ($cu)
	SetServerProtocol ()
	SetCellAttributes ($cu, $vendor_id)
	OutputReportFooter ()

Protected Attributes
	$dbh
	$SYS_TYPE_UPG_TEST
	$SYS_TYPE_CLOSED
	$download = false
	$dev_oauth = null
	$cu_index = 'hcuadm/cuindex.prg'
	$cu_trusted_url = 'homecu.net/hcuadm/CuVendorListApi.prg'
	$trusted_master = 'cutrustedmaster'
	$cu_admin = 'cuadmin'
	$cu_info = 'cuinfo'
	$cu_data = []
	$trusted_vendors = []
	$external_servers = ['my', 'www3', 'www5', 'www6']

Detailed Description

Class VendorByCu Copyright 07/2019 HomeCu LLC

Outputs a basic report showing what vendors are used by which credit unions. Aid in migration tool.

Usage:

$obj = new VendorByCu(); echo $obj ->set('dbh', $dbh) ->set('SYS_TYPE_UPG_TEST', $SYS_TYPE_UPG_TEST) ->set('SYS_TYPE_CLOSED', $SYS_TYPE_CLOSED) ->VendorByCuReport();

Odyssey uses Google Oauth. TO TEST LOCALLY get your my.homecu.net auth cookie and in your code that calls this class add

->set('dev_oauth', 'your homecu_dev_oauth2_proxy cookie value')

. . . or all your my.homecu.net CU's will show no trusted vendors.

Parameters

object	$dbh	database resource
int	$SYS_TYPE_UPG_TEST
int	$SYS_TYPE_CLOSED

Returns

string HTML

Definition at line 31 of file VendorByCu.i.

Constructor & Destructor Documentation

__construct()

VendorByCu::__construct

(

)

All we're doing in the constructor is setting the download property if it exists in $_GET.

Returns

void

Exceptions

Exception

Definition at line 77 of file VendorByCu.i.

  {
    $this->InitDownloadFlag();
  }

Member Function Documentation

CsvBody()

VendorByCu::CsvBody ( )

protected

Output the body for CSV download.

Returns

string

Definition at line 454 of file VendorByCu.i.

  {
    $body = null;

    foreach ($this->cu_data as $cu => $trusted_array) {
      $body .= $this->OutputCsvDataRow($cu);
    }

    return $body;
  }

CsvHeader()

VendorByCu::CsvHeader ( )

protected

Helper for OutputReportHeader(), prepare the text header for download.

Returns

string

Definition at line 395 of file VendorByCu.i.

  {
    $header = '"Credit Union"' . ',';

    foreach ($this->trusted_vendors as $vendor_id => $name) {
      $header .= '"' . $vendor_id . '",';
    }

    return rtrim($header, "\t") . PHP_EOL;
  }

CuExistsInData()

VendorByCu::CuExistsInData (   $cu )

protected

Helper for MergeClientsToCuData(). Does this CU exist in $this->cu_data? @TODO Hmm, might we need to use this to create a new node?

Parameters

string

$cu

Returns

bool

Definition at line 357 of file VendorByCu.i.

  {
    return array_key_exists($cu, $this->cu_data);
  }

DownloadCsv()

VendorByCu::DownloadCsv (   $content )

protected

Output the data for download.

Parameters

$content

Returns

string

Definition at line 134 of file VendorByCu.i.

  {
    $length = strlen($content) + 1;
    header("Content-type: bad/type");
    header("Content-length: " . $length);
    header("Content-Disposition: attachment; filename=\"vendor-by-cu-". date('Y-m-d') . ".csv\"");
    return $content;
  }

GetCuEditLink()

VendorByCu::GetCuEditLink (   $cu )

protected

Set a link from the HTML display to CU info.

Parameters

string

$cu

Returns

string

Definition at line 554 of file VendorByCu.i.

  {
    if (! (
      isset($this->cu_data[$cu]['vendor'])  &&
      isset($this->cu_data[$cu]['server'])
    )) {
      return '#';
    }

    return $this->SetServerProtocol() . "?action=fetch&rowid=$cu"
          . "&vc={$this->cu_data[$cu]['vendor']}"
          . "&wc={$this->cu_data[$cu]['server']}";
  }

GetCuLocalData()

VendorByCu::GetCuLocalData ( )

protected

Get the CU data from info; we need the CU Id from cuadmin and and the trusted vendor data from cu trusted vendors. Join admin and vendors on info to get all CU's.

Returns

$this

Exceptions

Exception

Definition at line 189 of file VendorByCu.i.

  {
    try {
      $res = db_query($this->LocalDataSql(), $this->dbh);

      while ($row = db_fetch_assoc($res)) {

        // Why the white space in DB values?
        $cu = trim($row['cu']);

        if (! isset($this->cu_data[$cu]['vendor'])) {
          $this->cu_data[$cu]['vendor'] = trim($row['vendor']);
          $this->cu_data[$cu]['server'] = trim($row['www_server']);
          $this->cu_data[$cu]['in_setup'] = $row['in_setup'];
        }
      }
    } catch (Exception $e) {
      throw new Exception("Exception getting CU data: {$e->getMessage()} " . db_last_error());
    }

    return $this;
  }

GetExternalTrustedData()

VendorByCu::GetExternalTrustedData (   $server,   $ids  )

protected

Using the array of trusted ID's, query a server for the associated CU's.

Parameters

string	$server
array	$ids

Returns

array

Definition at line 240 of file VendorByCu.i.

  {
    $params = http_build_query(['Cu' => '', 'trustedids' => json_encode($ids)]);
    $protocol = ($server == 'localhost')? 'http' : 'https';
    $cmd = "$protocol://$server.{$this->cu_trusted_url}";

    $ch = curl_init($cmd);
    curl_setopt($ch,CURLOPT_COOKIE, $this->setCurlCookies($server));
    curl_setopt($ch,CURLOPT_USERPWD,"nobody:no1home");
    curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);
    curl_setopt($ch,CURLOPT_POST, true);
    curl_setopt($ch,CURLOPT_POSTFIELDS, $params);
    //curl_setopt($ch, CURLOPT_VERBOSE, true);

    $rawresp = curl_exec($ch);

    return HCU_JsonDecode($rawresp, true);
  }

GetMasterData()

VendorByCu::GetMasterData ( )

protected

Get the master data record. any DB query, count excepted, should always be an array.

Returns

$this

Exceptions

Exception

Definition at line 149 of file VendorByCu.i.

  {
    $sql = "select * from {$this->trusted_master} order by trustedvendor";
    try {
      $res = db_query($sql, $this->dbh);
    } catch (Exception $e) {
      throw new Exception("Exception getting master data: {$e->getMessage()} " . pg_last_error($this->dbh));
    }

    while ($row = db_fetch_assoc($res)) {
      $this->trusted_vendors[$row['trustedid']] = $row['trustedvendor'];
    }

    return $this;
  }

GetTvClients()

VendorByCu::GetTvClients ( )

protected

Query each of $this->external_servers at the CuVendorListApi.prg URL for which T.V.'s are associated with which CU's. Set into the existing trusted vendors array.

Returns

$this

Definition at line 170 of file VendorByCu.i.

  {
    $trusted_arr = array_keys($this->trusted_vendors);

    foreach ($this->external_servers as $server) {

      $ext = $this->GetExternalTrustedData($server, $trusted_arr);
      $this->MergeClientsToCuData($server, $ext);
    }

    return $this;
  }

HtmlBody()

VendorByCu::HtmlBody ( )

protected

Helper for OutputReportBody(), return the body for HTML output.

Returns

string

Definition at line 508 of file VendorByCu.i.

  {
    $body   = null;
    $toggle = 'odd';

    foreach ($this->cu_data as $cu => $vendors_array) {
      $toggle = ($toggle == 'even')? 'odd' : 'even';

      $body .= $this->OutputHtmlDataRow($cu, $toggle);
    }

    return $body;
  }

HtmlHeader()

VendorByCu::HtmlHeader ( )

protected

Helper for OutputReportHeader(), prepare the HTML output header.

Returns

string

Definition at line 410 of file VendorByCu.i.

  {
      $id = 1;

    // looks bad if we print "Credit Union" in first col, no reason to overstate the obvious.
    $header = "
    <p style=\"text-align:center\"><strong><em>If the CU does not have trusted vendors listed,
    there are no trusted vendors set up in their Trusted Details.</em></strong></p>
    <table id=\"report-by-vendor-table\">
      <tr>
        <th id=\"tv-hd-$id\" class=\"cu-name\">&nbsp;</th>
    ";

    foreach ($this->trusted_vendors as $vendor_id => $name) {

      $id++;
      $title = (! empty($name))? $name : str_replace('_', ' ', $vendor_id);

      $header .= "
        <th id=\"tv-hd-$id\" class=\"rotate\" title=\"$title\"><div><span>"
        . str_replace('_', ' ', $vendor_id) . "</span></div></th>";
    }

    $header .= '
      </tr>
    ';

    return $header;
  }

InitDownloadFlag()

VendorByCu::InitDownloadFlag ( )

protected

If they've clicked download, set the flag.

Returns

$this

Definition at line 120 of file VendorByCu.i.

  {
    if (isset($_GET['download'])) {
      $this->download = true;
    }

    return $this;
  }

IsDownload()

VendorByCu::IsDownload

(

)

Because of this tightly coupled system that mixes logic and output, we need a pubic method to avoid HTML being printed if we are trying to download.

Returns

bool

Definition at line 111 of file VendorByCu.i.

  {
    return $this->download === true;
  }

isRealServer()

VendorByCu::isRealServer (   $server,   $cu  )

protected

When querying external servers, there may be old implementations of the current CU. The local record will always tell us what the real server is. Use to ignore others.

Parameters

string	$server
string	$cu

Returns

bool

Definition at line 323 of file VendorByCu.i.

  {
    if ($server == 'my') {
      $server .= '.homecu.net';
    }

    if (isset($this->cu_data[$cu]['server'])) {
      return $this->cu_data[$cu]['server'] == $server;
    }

    return false;
  }

isSuccessResult()

VendorByCu::isSuccessResult

(

$result

)

Helper for MergeClientsToCuData(), make sure the array members we need are all present.

Parameters

array

$result

Returns

bool

Definition at line 341 of file VendorByCu.i.

  {
    return
      array_key_exists('status', $result) &&
      array_key_exists('Response', $result['status']) &&
      ($result['status']['Response'] == true) &&
      array_key_exists('data', $result) &&
      is_array($result['data']);
  }

LocalDataSql()

VendorByCu::LocalDataSql ( )

protected

Helper for GetCuLocalData().

Returns

string

Definition at line 216 of file VendorByCu.i.

  {
    return "select"
    ." coalesce ("
    . " {$this->cu_admin}.cu,"
    . " upper({$this->cu_info}.user_name),"
    . " 'none'"
    . " ) as cu,"
    . "((coalesce({$this->cu_info}.system_options, 0) & {$this->SYS_TYPE_UPG_TEST}) <> 0)::int as in_setup,"
    . " {$this->cu_info}.vendor as vendor,"
    . " {$this->cu_info}.www_server as www_server"
    . " from {$this->cu_info}"
    . " left join {$this->cu_admin}"
    . " on upper({$this->cu_admin}.user_name) = upper({$this->cu_info}.user_name)"
    . " where {$this->cu_info}.system_options & {$this->SYS_TYPE_CLOSED} = 0"
    . " order by {$this->cu_info}.user_name asc";
  }

MergeClientsToCuData()

VendorByCu::MergeClientsToCuData (   $server,   $external_data  )

protected

What it says, merge external server results into $this->cu_data.

Parameters

string	$server
array	$external_data

Returns

$this

Definition at line 290 of file VendorByCu.i.

  {
    if (! $this->isSuccessResult($external_data)) {
      return $this;
    }

    foreach ($external_data['data'] as $key => $vendor_arr) {

      // Funky key value, but it allows us to not have to walk the array. See comments.
      list ($cu, $vendor) = explode('|', $key);

      if (
        ! $this->isRealServer($server, $cu) ||
        ! $this->CuExistsInData($cu) ||
          $this->VendorExistsInData($cu, strtoupper($vendor))
        ) {
        continue;
      }

      // Store as all upper and then do strtoupper on output so we always have a match.
      $this->cu_data[$cu]['trustedid'][] = strtoupper($vendor);
    }

    return $this;
  }

OutputCsvDataRow()

VendorByCu::OutputCsvDataRow (   $cu )

protected

Output a row of data for download.

Parameters

string

$cu

Returns

string|null

Definition at line 470 of file VendorByCu.i.

  {
    $row = '"' . $cu . '",';

    foreach ($this->trusted_vendors as $vendor_id => $name) {

      $used = $this->setCsvCellContent($vendor_id, $cu);
      $row .= '"' . $used . '",';
    }

    $row = rtrim($row, ',') . PHP_EOL;

    return $row;
  }

OutputHtmlDataRow()

VendorByCu::OutputHtmlDataRow (   $cu,   $toggle  )

protected

Output a row of data from tr to /tr.

Parameters

string	$cu
string	$toggle	even|odd

Returns

string|null

Definition at line 528 of file VendorByCu.i.

  {
    $link = $this->GetCuEditLink($cu);

    $row = "
    <tr class=\"$toggle\">
      <td><a href=\"$link\">$cu</a></td>";

    foreach ($this->trusted_vendors as $vendor_id => $name) {

      list ($class, $txt, $usage) = $this->SetCellAttributes($cu, $vendor_id);
      $row .= "<td class=\"$class\" title=\"$vendor_id $usage by $cu\">$txt</td>";
    }

    $row .= '
     </tr>
    ';

    return $row;
  }

OutputReportBody()

VendorByCu::OutputReportBody ( )

protected

Output the body HTML.

Exceptions

Exception

Returns

string

Definition at line 445 of file VendorByCu.i.

  {
    return ($this->IsDownload())? $this->CsvBody() : $this->HtmlBody();
  }

OutputReportFooter()

VendorByCu::OutputReportFooter ( )

protected

Simple single responsibility or, do we want footer data and row here?

Returns

string|null;

Definition at line 608 of file VendorByCu.i.

  {

    if ($this->IsDownload()) {
      return null;
    }

    $count = count($this->trusted_vendors) + 1;

    return '
    <tr>
      <td id="vendor-by-cu-footer" colspan="' . $count . '">
        <a href="?download" target="_blank">Download</a>
      </td>
    </tr>
    </table>
    ';
  }

OutputReportHeader()

VendorByCu::OutputReportHeader ( )

protected

Walk the trusted vendors and output the report head.

Returns

string

Definition at line 386 of file VendorByCu.i.

  {
    return ($this->IsDownload())? $this->CsvHeader() : $this->HtmlHeader();
  }

set()

VendorByCu::set	(		$prop,
			$value
	)

Typical setter

Parameters

string	$prop
mixed	$value

Returns

$this

Definition at line 633 of file VendorByCu.i.

  {
    $this->{$prop} = $value;
    return $this;
  }

SetCellAttributes()

VendorByCu::SetCellAttributes (   $cu,   $vendor_id  )

protected

Helper for outputDataRow.

Parameters

string	$cu
string	$vendor_id

Returns

array

Definition at line 590 of file VendorByCu.i.

  {
    if (
      isset($this->cu_data[$cu]['trustedid']) &&
      is_array($this->cu_data[$cu]['trustedid']) &&
      in_array(strtoupper($vendor_id), $this->cu_data[$cu]['trustedid'])
    ) {
      return ['used', '✔', 'used'];
    }

    return ['not-used',  'x', 'not used'];

  }

setCsvCellContent()

VendorByCu::setCsvCellContent (   $vendor_id,   $cu  )

protected

Helper for OutputCsvDataRow(), make the cell content.

Parameters

string	$vendor_id
string	$cu

Returns

string YES|-

Definition at line 491 of file VendorByCu.i.

  {
    if (
      isset($this->cu_data[$cu]['trustedid']) &&
      is_array($this->cu_data[$cu]['trustedid']) &&
      in_array(strtoupper($vendor_id), $this->cu_data[$cu]['trustedid'])
    ) {
      return 'YES';
    }

    return '-';
  }

setCurlCookies()

VendorByCu::setCurlCookies (   $server )

protected

Allows a dev cookie to test locally via the setter, see comments at head.

Parameters

string

$server

Returns

string

Definition at line 264 of file VendorByCu.i.

  {
    $cookies = "HCUTicket={$_COOKIE['HCUTicket']};";

    if ($server == 'my') {

      if ($this->dev_oauth) {
        $cookies .= ";homecu_dev_oauth2_proxy={$this->dev_oauth}";
        return $cookies;
      }

      if (isset($_COOKIE['homecu_dev_oauth2_proxy'])) {
        $cookies .= ";homecu_dev_oauth2_proxy={$_COOKIE['homecu_dev_oauth2_proxy']}";
        return $cookies;
      }
    }

    return $cookies;
  }

SetServerProtocol()

VendorByCu::SetServerProtocol ( )

protected

Going to try this without HB_ENV. If it causes problems, we'll inject it.

Returns

string

Definition at line 572 of file VendorByCu.i.

  {
    $protocol = (
      ($_SERVER['REQUEST_SCHEME'] != 'https') &&
      (getenv('HTTP_X_FORWARDED_PROTO') != 'https')
    ) ?
    'http' : 'https';

    return $protocol . '://' . strtolower($_SERVER['HTTP_HOST']) . '/' . $this->cu_index;

  }

VendorByCuReport()

VendorByCu::VendorByCuReport

(

)

Entry point.

Exceptions

Exception

Returns

string (HTML) or csv (download)

Definition at line 87 of file VendorByCu.i.

  {
    $this
      ->GetMasterData()
      ->GetCuLocalData()
      ->GetTvClients();

    $content =
      $this->OutputReportHeader() .
      $this->OutputReportBody() .
      $this->OutputReportFooter();

    if ($this->IsDownload()) {
      return $this->DownloadCsv($content);
    }

    return $content;
  }

VendorExistsInData()

VendorByCu::VendorExistsInData (   $cu,   $vendor  )

protected

Helper for MergeClientsToCuData(). Vendor already in the cu_data array? The external query may return duplicates, and we've already ensured the cu_data trustedid member is an array.

Parameters

string	$cu
string	$vendor

Returns

bool

Definition at line 370 of file VendorByCu.i.

  {
    if (
      isset($this->cu_data[$cu]['trustedid']) &&
      is_array($this->cu_data[$cu]['trustedid'])
    ) {
      return in_array($vendor, $this->cu_data[$cu]['trustedid']);
    }

    return false;
  }

---

The documentation for this class was generated from the following file:

• app/web/monitor/library/VendorByCu.i