';
foreach ($stats as $stat) {
$tag = !empty($stat['url']) ? 'a' : 'div';
$href = !empty($stat['url']) ? ' href="' . escapeHtml($stat['url']) . '"' : '';
$title = !empty($stat['title']) ? ' title="' . escapeHtml($stat['title']) . '"' : '';
$tone = !empty($stat['tone']) ? ' text-' . $stat['tone'] . '-emphasis' : '';
$value = $stat['value_html'] ?? escapeHtml((string) ($stat['value'] ?? ''));
$html .= "<$tag class=\"itflow-report-stat\"$href$title>"
. '' . escapeHtml($stat['label']) . ''
. '' . $value . ''
. (isset($stat['sub']) && $stat['sub'] !== '' ? '' . $stat['sub'] . '' : '')
. "";
}
return $html . '
';
}
/**
* A chart, drawn by js/reports.js. $config:
* 'type' bar | line | doughnut
* 'labels' the x axis (or the slices)
* 'series' [['label' => .., 'data' => [..], 'tone' => accent | success | danger |
* warning | info | muted | purple | #hex, 'type' => line (on a bar
* chart), 'dashed' => true, 'stack' => .., 'axis' => y2, 'ghost' => true,
* 'tones' => [a tone per bar, in place of 'tone']], ..]
* 'format' money | count | hours | percent | decimal - the axis and tooltips
* 'format2' the same, for a second axis
* 'stacked' true to stack the bars
* 'horizontal' true for bars running left to right
* 'legend' false to hide it
* 'colors' a colour (tone or #hex) per slice, for a doughnut
* 'max' the top of the value axis
* $size: '' | sm | lg | donut. A horizontal chart grows with its rows.
*/
function reportChart(array $config, $size = '', $label = '') {
global $session_company_currency;
$config['currency'] = $config['currency'] ?? $session_company_currency;
$style = '';
if (!empty($config['horizontal'])) {
$style = ' style="height: ' . max(140, count($config['labels'] ?? []) * 30 + 50) . 'px"';
}
$class = 'itflow-report-chart' . ($size !== '' ? " itflow-report-chart-$size" : '');
return '';
}
/** An empty state - an icon and a sentence. */
function reportEmpty($text, $icon = 'fa-check-circle', $tone = 'success') {
return '
' . $text . '
';
}
/*
* ---------- links into the app ----------
*
* Reports live a folder down from the rest of the agent pages, so every link
* out is absolute.
*/
function reportClientLink($client_id, $client_name, $page = 'client_overview.php') {
$client_id = intval($client_id);
if (!$client_id) {
return '
No client';
}
return '
' . escapeHtml($client_name) . '';
}
/** A client's initials tile and name, linking to it. */
function reportClientCell($client_id, $client_name, $client_abbreviation = '', $page = 'client_overview.php') {
$client_id = intval($client_id);
if (!$client_id) {
return '
No client';
}
$tone = clientInitialsTone($client_id);
$initials = escapeHtml(clientInitials((string) $client_abbreviation, (string) $client_name));
return '
'
. '' . $initials . ''
. '' . escapeHtml($client_name) . '';
}
/** A ticket's reference and subject, opening the ticket. */
function reportTicketLink($row, $with_subject = true) {
$url = '/agent/' . ticketUrl($row['ticket_id'], $row['ticket_client_id'] ?? 0);
$html = '
' . escapeHtml(ticketReference($row)) . '';
if ($with_subject && isset($row['ticket_subject'])) {
$html .= '
' . escapeHtml($row['ticket_subject']) . '';
}
return $html;
}
/** An agent's avatar and name. */
function reportAgentCell($user_id, $user_name, $user_avatar = '', $none = 'Unassigned') {
return formatAssignee($user_id, $user_name, $user_avatar, false, $none);
}
/** A ticket priority's coloured dot, as on the dashboard. */
function reportPriorityDot($priority) {
$colors = ['Urgent' => 'dark', 'High' => 'danger', 'Medium' => 'warning', 'Low' => 'info'];
return '
';
}
/*
* ---------- money by category ----------
*/
/** Rows of cat / m / v as [category id => ['total' => .., 'months' => [1 .. 12 => ..]]]. */
function reportCategoryGrid($result) {
$grid = [];
while ($row = mysqli_fetch_assoc($result)) {
$cat = intval($row['cat']);
$month = intval($row['m']);
if (!isset($grid[$cat])) {
$grid[$cat] = ['total' => 0.0, 'months' => array_fill(1, 12, 0.0)];
}
$grid[$cat]['months'][$month] += floatval($row['v']);
$grid[$cat]['total'] += floatval($row['v']);
}
return $grid;
}
/**
* Income between two dates by income category and month (pass dates inside
* one year - months are by number). A payment takes the category of the
* invoice it paid; 0 is income with no category to show.
*/
function reportIncomeByCategory($from, $to, $client_id = 0) {
global $mysqli;
$client_id = intval($client_id);
$payment_client = $client_id ? " AND invoice_client_id = $client_id" : '';
$revenue_client = $client_id ? " AND revenue_client_id = $client_id" : '';
return reportCategoryGrid(mysqli_query($mysqli, "
SELECT cat, m, SUM(v) AS v FROM (
SELECT COALESCE(invoice_category_id, 0) AS cat, MONTH(payment_date) AS m, payment_amount AS v
FROM payments LEFT JOIN invoices ON payment_invoice_id = invoice_id
WHERE payment_date >= '$from' AND payment_date < '$to' + INTERVAL 1 DAY $payment_client
UNION ALL
SELECT revenue_category_id, MONTH(revenue_date), revenue_amount
FROM revenues
WHERE " . dashboardRevenueSql() . " AND revenue_date >= '$from' AND revenue_date < '$to' + INTERVAL 1 DAY $revenue_client
) AS income
GROUP BY cat, m"));
}
/** Spending between two dates by expense category and month - vendor expenses, as the Expenses list. */
function reportExpensesByCategory($from, $to) {
global $mysqli;
return reportCategoryGrid(mysqli_query($mysqli, "
SELECT expense_category_id AS cat, MONTH(expense_date) AS m, SUM(expense_amount) AS v
FROM expenses
WHERE expense_vendor_id > 0 AND expense_date >= '$from' AND expense_date < '$to' + INTERVAL 1 DAY
GROUP BY cat, m"));
}
/**
* The categories of $type to list - every one not archived, and any archived
* one with an amount in $grid - [id => row], by name. Amounts filed under an
* id that is not one of these (deleted, or another type) move to 0, which
* lists as "No category".
*/
function reportCategoryRows($type, array &$grid) {
global $mysqli;
$type = escapeSql($type);
$ids = array_map('intval', array_keys($grid));
$with = $ids ? ' OR category_id IN (' . implode(',', $ids) . ')' : '';
$sql = mysqli_query($mysqli, "SELECT category_id, category_name, category_color, category_archived_at FROM categories
WHERE category_type = '$type' AND (category_archived_at IS NULL $with)
ORDER BY category_name ASC");
$rows = [];
while ($row = mysqli_fetch_assoc($sql)) {
$rows[intval($row['category_id'])] = $row;
}
foreach (array_keys($grid) as $cat) {
if ($cat !== 0 && !isset($rows[$cat])) {
if (!isset($grid[0])) {
$grid[0] = ['total' => 0.0, 'months' => array_fill(1, 12, 0.0)];
}
foreach ($grid[$cat]['months'] as $m => $v) {
$grid[0]['months'][$m] += $v;
}
$grid[0]['total'] += $grid[$cat]['total'];
unset($grid[$cat]);
}
}
if (isset($grid[0]) && abs($grid[0]['total']) > 0.004) {
$rows[0] = ['category_id' => 0, 'category_name' => 'No category', 'category_color' => '', 'category_archived_at' => null];
}
return $rows;
}
/** A category's amounts for a year - zeros when it has none. */
function reportGridRow(array $grid, $cat) {
return $grid[$cat] ?? ['total' => 0.0, 'months' => array_fill(1, 12, 0.0)];
}
/** Every category added together, month by month. */
function reportGridTotals(array $grid) {
$months = array_fill(1, 12, 0.0);
$total = 0.0;
foreach ($grid as $row) {
foreach ($row['months'] as $m => $v) {
$months[$m] += $v;
}
$total += $row['total'];
}
return ['total' => $total, 'months' => $months];
}
/** The months or quarters a year-of-months report shows: [index => [label, first month, last month]]. */
function reportYearColumns($view) {
if ($view === 'quarter') {
return [1 => ['Q1', 1, 3], 2 => ['Q2', 4, 6], 3 => ['Q3', 7, 9], 4 => ['Q4', 10, 12]];
}
$columns = [];
for ($m = 1; $m <= 12; $m++) {
$columns[$m] = [date('M', mktime(0, 0, 0, $m, 1)), $m, $m];
}
return $columns;
}
/** One category's amounts summed into the report's columns. */
function reportSumColumns(array $months, array $columns) {
$out = [];
foreach ($columns as $i => [$label, $first, $last]) {
$sum = 0.0;
for ($m = $first; $m <= $last; $m++) {
$sum += $months[$m] ?? 0;
}
$out[$i] = $sum;
}
return $out;
}
/** An amount in a year-of-months grid - a dash for nothing, a link to the list behind it when given. */
function reportGridAmount($amount, $url = '') {
if (abs($amount) < 0.005) {
return '
–';
}
$text = reportMoneyWhole($amount);
return $url !== '' ? '
' . $text . '' : $text;
}
/** The first and last day of a column of a year-of-months report. */
function reportColumnDates($year, $first, $last) {
$from = sprintf('%d-%02d-01', $year, $first);
return [$from, date('Y-m-t', strtotime(sprintf('%d-%02d-01', $year, $last)))];
}
/** Drop the categories with nothing in $grid (or in $also, the year before). */
function reportCategoriesWithAmounts(array $categories, array $grid, array $also = []) {
return array_filter($categories, function ($cat) use ($grid, $also) {
return abs($grid[$cat]['total'] ?? 0) >= 0.005 || abs($also[$cat]['total'] ?? 0) >= 0.005;
}, ARRAY_FILTER_USE_KEY);
}
/**
* Stacked monthly bars for the biggest categories (the rest as Other), for
* the Income and Expenses reports. Months not yet reached are left empty.
*/
function reportCategoryChartSeries(array $categories, array $grid, $months_shown, $top = 5) {
$ranked = [];
foreach ($categories as $cat => $category) {
$ranked[$cat] = $grid[$cat]['total'] ?? 0;
}
arsort($ranked);
$series = [];
$other = array_fill(1, 12, 0.0);
$i = 0;
foreach ($ranked as $cat => $total) {
if ($total <= 0) {
continue;
}
$months = $grid[$cat]['months'];
if ($i < $top) {
$data = [];
for ($m = 1; $m <= 12; $m++) {
$data[] = $m <= $months_shown ? round($months[$m], 2) : null;
}
$series[] = ['label' => html_entity_decode($categories[$cat]['category_name'], ENT_QUOTES, 'UTF-8'), 'data' => $data, 'tone' => reportPalette($i), 'stack' => 'year'];
} else {
foreach ($months as $m => $v) {
$other[$m] += $v;
}
}
$i++;
}
if (array_sum($other) > 0) {
$data = [];
for ($m = 1; $m <= 12; $m++) {
$data[] = $m <= $months_shown ? round($other[$m], 2) : null;
}
$series[] = ['label' => 'Other', 'data' => $data, 'tone' => 'faint', 'stack' => 'year'];
}
return $series;
}
/**
* A year of a category grid as a table - a row per category with each month,
* the year and its share, a totals row, and each amount opening the list it
* came from ($list: income.php or expenses.php).
*/
function reportCategoryYearTable(array $categories, array $grid, $year, $list, $total_label, $uncategorised = '') {
$columns = reportYearColumns('month');
$totals = reportGridTotals($grid);
$html = '
'
. '| Category | ';
foreach ($columns as [$label]) {
$html .= '' . $label . ' | ';
}
$html .= '' . intval($year) . ' | Share |
|---|
';
if (!$categories) {
$html .= '| Nothing in ' . intval($year) . '. |
';
}
foreach ($categories as $cat => $category) {
$row = reportGridRow($grid, $cat);
$html .= '| ' . escapeHtml($category['category_name'])
. (!empty($category['category_archived_at']) ? ' Archived' : '') . ' | ';
foreach ($columns as $i => [$label, $first, $last]) {
[$dtf, $dtt] = reportColumnDates($year, $first, $last);
$url = $cat || $uncategorised !== '' ? "/agent/$list?" . ($cat ? "category=$cat" : $uncategorised) . "&canned_date=custom&dtf=$dtf&dtt=$dtt" : '';
$html .= '' . reportGridAmount($row['months'][$i], $url) . ' | ';
}
$url = $cat || $uncategorised !== '' ? "/agent/$list?" . ($cat ? "category=$cat" : $uncategorised) . "&canned_date=custom&dtf=$year-01-01&dtt=$year-12-31" : '';
$share = reportShare($row['total'], $totals['total'], 1);
$html .= '' . reportGridAmount($row['total'], $url) . ' | '
. '' . reportPercent($share) . ' |
';
}
$html .= '| ' . escapeHtml($total_label) . ' | ';
foreach ($columns as $i => [$label, $first, $last]) {
[$dtf, $dtt] = reportColumnDates($year, $first, $last);
$html .= '' . reportGridAmount($totals['months'][$i], "/agent/$list?canned_date=custom&dtf=$dtf&dtt=$dtt") . ' | ';
}
$html .= '' . reportGridAmount($totals['total'], "/agent/$list?canned_date=custom&dtf=$year-01-01&dtt=$year-12-31") . ' | ' . ($totals['total'] ? '100%' : '') . ' |
';
return $html;
}
/** The same grid as CSV rows: category, each month, the year. */
function reportCategoryYearCsv(array $categories, array $grid, $year, $name, $total_label) {
$columns = ['name' => ['label' => 'Category']];
foreach (reportYearColumns('month') as $i => [$label]) {
$columns["m$i"] = ['label' => $label, 'type' => 'money'];
}
$columns['total'] = ['label' => (string) $year, 'type' => 'money'];
$rows = [];
foreach ($categories as $cat => $category) {
$line = reportGridRow($grid, $cat);
$row = ['name' => $category['category_name'], 'total' => $line['total']];
foreach ($line['months'] as $m => $v) {
$row["m$m"] = $v;
}
$rows[] = $row;
}
$totals = reportGridTotals($grid);
$total_row = ['name' => $total_label, 'total' => $totals['total']];
foreach ($totals['months'] as $m => $v) {
$total_row["m$m"] = $v;
}
reportCsv($name, $columns, $rows, $total_row);
}
/*
* ---------- tickets ----------
*/
/** SQL on tickets for the filters: archived left out, the clients this user may see, and the client and agent picked. */
function reportTicketSql($client_id = 0, $agent_id = 0) {
$agent_id = intval($agent_id);
return "tickets.ticket_archived_at IS NULL" . reportClientSql('tickets.ticket_client_id', $client_id)
. ($agent_id ? " AND tickets.ticket_assigned_to = $agent_id" : '');
}
/** The middle value - half are above it - or null for none. Steadier than an average when a few tickets sat open for weeks. */
function reportMedian(array $values) {
$values = array_values(array_filter($values, function ($v) {
return $v !== null;
}));
$count = count($values);
if (!$count) {
return null;
}
sort($values);
$mid = intdiv($count, 2);
return $count % 2 ? $values[$mid] : ($values[$mid - 1] + $values[$mid]) / 2;
}
/** A column of numbers from a query - for medians. */
function reportColumn($sql) {
global $mysqli;
$values = [];
$result = mysqli_query($mysqli, $sql);
while ($row = mysqli_fetch_row($result)) {
if ($row[0] !== null) {
$values[] = floatval($row[0]);
}
}
return $values;
}
/** Ticket categories by id - every one, archived included, as old tickets carry them. */
function reportTicketCategories() {
global $mysqli;
$categories = [];
$sql = mysqli_query($mysqli, "SELECT category_id, category_name FROM categories WHERE category_type = 'Ticket'");
while ($row = mysqli_fetch_assoc($sql)) {
$categories[intval($row['category_id'])] = $row['category_name'];
}
return $categories;
}
/** How long open tickets have been open - the buckets the aging report counts in, with the most days each takes. */
const REPORT_AGE_BUCKETS = [
'day' => ['Under a day', 0],
'3' => ['1–3 days', 3],
'7' => ['4–7 days', 7],
'30' => ['8–30 days', 30],
'90' => ['31–90 days', 90],
'old' => ['Over 90 days', null],
];
/** The bucket for a ticket open $days days. */
function reportAgeBucket($days) {
if ($days < 1) {
return 'day';
}
foreach (REPORT_AGE_BUCKETS as $key => [$label, $max]) {
if ($max !== null && $max > 0 && $days <= $max) {
return $key;
}
}
return 'old';
}
/**
* How tickets with an SLA did, from a WHERE on tickets: how many, and met /
* missed / still open for the response and the resolution targets. The
* percentages count only tickets whose target has been judged - one still
* waiting is neither a hit nor a miss.
*/
function reportSlaCompliance($where) {
global $mysqli;
$row = mysqli_fetch_assoc(mysqli_query($mysqli, "SELECT
COUNT(ticket_id) AS tickets,
SUM(ticket_response_sla_met = 1) AS response_met,
SUM(ticket_response_sla_met = 0) AS response_missed,
SUM(ticket_resolution_sla_met = 1) AS resolution_met,
SUM(ticket_resolution_sla_met = 0) AS resolution_missed,
SUM(ticket_resolution_sla_met IS NULL AND ticket_resolution_due_at IS NOT NULL) AS resolution_pending
FROM tickets WHERE ticket_sla_id > 0 AND $where"));
return reportSlaFigures($row);
}
/** The percentages for a row of met / missed counts (as reportSlaCompliance() selects them). */
function reportSlaFigures($row) {
$out = [];
foreach (['tickets', 'response_met', 'response_missed', 'resolution_met', 'resolution_missed', 'resolution_pending'] as $key) {
$out[$key] = intval($row[$key] ?? 0);
}
$out['response_percent'] = reportShare($out['response_met'], $out['response_met'] + $out['response_missed'], 1);
$out['resolution_percent'] = reportShare($out['resolution_met'], $out['resolution_met'] + $out['resolution_missed'], 1);
return $out;
}
/** " · 3 late" after an SLA share, or nothing when none were late. */
function reportLateHtml($late) {
$late = intval($late);
return $late ? '
· ' . reportCount($late) . ' late' : '';
}
/** The SELECT list reportSlaFigures() reads - for grouped queries. */
const REPORT_SLA_COLUMNS = "COUNT(ticket_id) AS tickets,
SUM(ticket_response_sla_met = 1) AS response_met, SUM(ticket_response_sla_met = 0) AS response_missed,
SUM(ticket_resolution_sla_met = 1) AS resolution_met, SUM(ticket_resolution_sla_met = 0) AS resolution_missed,
SUM(ticket_resolution_sla_met IS NULL AND ticket_resolution_due_at IS NOT NULL) AS resolution_pending";
/**
* Working days between two dates (up to today): the business days set in
* Admin > SLA, less closure days. Monday to Friday when none are set.
*/
function reportWorkingDays($start, $end) {
$end = min($end, date('Y-m-d'));
$settings = getSlaSettings();
$days = $settings['business_days'] ?: [1, 2, 3, 4, 5];
$holidays = getBusinessHolidays();
$count = 0;
$cursor = new DateTime($start);
$last = new DateTime($end);
for ($guard = 0; $cursor <= $last && $guard < 4000; $guard++) {
if (in_array(intval($cursor->format('N')), $days, true) && !isset($holidays[$cursor->format('Y-m-d')])) {
$count++;
}
$cursor->modify('+1 day');
}
return $count;
}
/** Hours in a working day, from the business hours set for SLAs - 8 when they are not set. */
function reportWorkdayHours() {
$settings = getSlaSettings();
$start = strtotime('1970-01-01 ' . ($settings['business_hours_start'] ?: '00:00:00') . ' UTC');
$end = strtotime('1970-01-01 ' . ($settings['business_hours_end'] ?: '00:00:00') . ' UTC');
$hours = ($end - $start) / 3600;
return $hours > 0 && $hours <= 24 ? round($hours, 2) : 8.0;
}
/**
* When tickets come in - a weekday by hour grid, darker for more. $counts
* is [ISO weekday 1-7][hour 0-23] => count.
*/
function reportHeatmap(array $counts, $noun = 'ticket') {
$max = 1;
foreach ($counts as $hours) {
$max = max($max, ...array_values($hours ?: [0]));
}
$html = '
| ';
for ($h = 0; $h < 24; $h++) {
$html .= '' . ($h % 3 === 0 ? date('ga', mktime($h, 0, 0)) : '') . ' | ';
}
$html .= '
|---|
';
for ($d = 1; $d <= 7; $d++) {
$day = date('D', strtotime("Monday this week +" . ($d - 1) . " days"));
$html .= '| ' . $day . ' | ';
for ($h = 0; $h < 24; $h++) {
$n = intval($counts[$d][$h] ?? 0);
$html .= ' | ';
}
$html .= '
|---|
';
}
return $html . '
';
}
/*
* ---------- assets, renewals and documentation ----------
*/
/** Statuses that mean the asset is gone - left out of lifecycle figures. */
const REPORT_ASSET_GONE = ['Lost', 'Stolen', 'Retired'];
/**
* Operating systems past their maker's end of support, as [pattern, name],
* matched against an asset's OS. Only versions whose support has plainly
* ended (late 2026) - long-term-servicing editions are left alone. Add to it
* as more versions reach the end.
*/
const REPORT_OS_END_OF_LIFE = [
['/\bwindows\s+(xp|vista)\b/i', 'Windows XP / Vista'],
['/\bwindows\s+(7|8(\.1)?)\b/i', 'Windows 7 / 8'],
['/\bwindows\s+10\b(?!.*\bltsc\b)/i', 'Windows 10'],
['/\bserver\s+(2000|2003|2008|2012)\b/i', 'Windows Server 2012 or older'],
['/\b(mac\s?os|os\s?x)\s*(x\s*)?(10\.\d+|11|12|13)\b/i', 'macOS 13 or older'],
['/\bcentos\b(?!\s*stream\s*(9|10))/i', 'CentOS'],
['/\bubuntu\b\D*(1\d|20)\.\d\d\b/i', 'Ubuntu 20.04 or older'],
['/\bdebian\b\D*\b([6-9]|1[01])\b/i', 'Debian 11 or older'],
];
/** The end-of-support name for an asset's OS ('Windows 10'), or '' while it is supported or unknown. */
function reportOsEndOfLife($os) {
$os = trim((string) $os);
if ($os === '') {
return '';
}
foreach (REPORT_OS_END_OF_LIFE as [$pattern, $name]) {
if (preg_match($pattern, $os)) {
return $name;
}
}
return '';
}
/**
* Assets still in use (not archived, not lost, stolen or retired) at active
* clients, with what their lifecycle needs: 'age_days' from purchase (else
* install), 'warranty' (assetWarranty()) and 'os_eol' (reportOsEndOfLife()).
* A virtual machine has no hardware to age or cover, so neither is set.
*/
function reportLifecycleAssets($client_id = 0, $type = '') {
global $mysqli;
$gone = "'" . implode("', '", REPORT_ASSET_GONE) . "'";
$type_sql = $type !== '' ? " AND asset_type = '" . escapeSql($type) . "'" : '';
$rows = [];
$sql = mysqli_query($mysqli, "SELECT asset_id, asset_name, asset_type, asset_make, asset_model, asset_os, asset_status, asset_purchase_date, asset_install_date,
asset_warranty_expire, asset_client_id, client_name, client_abbreviation, contact_name, location_name
FROM assets
JOIN clients ON asset_client_id = client_id
LEFT JOIN contacts ON asset_contact_id = contact_id
LEFT JOIN locations ON asset_location_id = location_id
WHERE asset_archived_at IS NULL AND client_archived_at IS NULL AND COALESCE(asset_status, '') NOT IN ($gone)"
. reportClientSql('asset_client_id', $client_id) . $type_sql . "
ORDER BY client_name, asset_name");
$today = new DateTime('today');
while ($row = mysqli_fetch_assoc($sql)) {
$physical = $row['asset_type'] !== 'Virtual Machine';
$row['age_date'] = null;
$row['age_days'] = null;
foreach (['asset_purchase_date', 'asset_install_date'] as $column) {
$date = $physical ? DateTime::createFromFormat('!Y-m-d', substr((string) $row[$column], 0, 10)) : false;
if ($date && $date->format('Y') > 1900) {
$row['age_date'] = $date->format('Y-m-d');
$row['age_days'] = max(0, (int) $date->diff($today)->format('%r%a'));
break;
}
}
$row['warranty'] = $physical ? assetWarranty($row['asset_warranty_expire']) : null;
$row['os_eol'] = reportOsEndOfLife($row['asset_os']);
$rows[] = $row;
}
return $rows;
}
/** An asset's type tile and name, opening its page. */
function reportAssetCell($row) {
return '
'
. ''
. '' . escapeHtml($row['asset_name']) . '';
}
/** "3.4 yrs" from days, or '' without. */
function reportYears($days, $decimals = 1) {
return $days === null ? '' : number_format($days / 365.25, $decimals) . ' yrs';
}
/** What comes up for renewal, and how each kind is shown. */
const REPORT_RENEWAL_KINDS = [
'domain' => ['label' => 'Domains', 'one' => 'Domain', 'tone' => 'accent'],
'certificate' => ['label' => 'Certificates', 'one' => 'Certificate', 'tone' => 'purple'],
'license' => ['label' => 'Licenses', 'one' => 'License', 'tone' => 'teal'],
'warranty' => ['label' => 'Warranties', 'one' => 'Warranty', 'tone' => 'orange'],
];
/** How far back a lapsed renewal still shows - older ones are on each list's Expired view. */
const REPORT_RENEWAL_LAPSED_DAYS = 90;
/**
* Domains, certificates, licenses and warranties due in the next $ahead days,
* or lapsed in the last REPORT_RENEWAL_LAPSED_DAYS, soonest first. Each row:
* kind, id, name, detail, client_id, client, abbr, date, days (negative once
* lapsed), auto (renews itself), url, tile. Archived items, archived clients
* and assets that are gone are left out.
*/
function reportRenewals($client_id, $ahead, array $kinds = []) {
global $mysqli;
$ahead = intval($ahead);
$back = REPORT_RENEWAL_LAPSED_DAYS;
$kinds = $kinds ?: array_keys(REPORT_RENEWAL_KINDS);
$window = function ($column) use ($ahead, $back) {
return "$column BETWEEN CURDATE() - INTERVAL $back DAY AND CURDATE() + INTERVAL $ahead DAY";
};
$today = new DateTime('today');
$rows = [];
$add = function ($kind, $id, $name, $detail, $row, $date, $auto, $url, $tile) use (&$rows, $today) {
$due = DateTime::createFromFormat('!Y-m-d', substr((string) $date, 0, 10));
if (!$due) {
return;
}
$rows[] = [
'kind' => $kind, 'id' => intval($id), 'name' => (string) $name, 'detail' => trim((string) $detail, " ·"),
'client_id' => intval($row['client_id']), 'client' => $row['client_name'], 'abbr' => $row['client_abbreviation'],
'date' => $due->format('Y-m-d'), 'days' => (int) $today->diff($due)->format('%r%a'), 'auto' => (bool) $auto, 'url' => $url, 'tile' => $tile,
];
};
if (in_array('domain', $kinds, true)) {
$sql = mysqli_query($mysqli, "SELECT domain_id, domain_name, domain_expire, domain_auto_renew, vendor_name, client_id, client_name, client_abbreviation
FROM domains JOIN clients ON domain_client_id = client_id LEFT JOIN vendors ON domain_registrar = vendor_id
WHERE domain_archived_at IS NULL AND client_archived_at IS NULL AND " . $window('domain_expire') . reportClientSql('domain_client_id', $client_id));
while ($row = mysqli_fetch_assoc($sql)) {
$auto = intval($row['domain_auto_renew']) === 1;
$add('domain', $row['domain_id'], $row['domain_name'], ($auto ? 'Auto-renew' : 'Manual renewal') . ($row['vendor_name'] ? ' · ' . $row['vendor_name'] : ''),
$row, $row['domain_expire'], $auto, '/agent/domains.php?client_id=' . intval($row['client_id']) . '&open=' . intval($row['domain_id']), domainTile('sm'));
}
}
if (in_array('certificate', $kinds, true)) {
$sql = mysqli_query($mysqli, "SELECT certificate_id, certificate_name, certificate_domain, certificate_issued_by, certificate_issued_at, certificate_expire, client_id, client_name, client_abbreviation
FROM certificates JOIN clients ON certificate_client_id = client_id
WHERE certificate_archived_at IS NULL AND client_archived_at IS NULL AND " . $window('certificate_expire') . reportClientSql('certificate_client_id', $client_id));
while ($row = mysqli_fetch_assoc($sql)) {
$auto = certificateShortLived($row);
$add('certificate', $row['certificate_id'], $row['certificate_name'], ($auto ? 'Short-lived, renews itself' : 'Manual renewal') . ($row['certificate_issued_by'] ? ' · ' . $row['certificate_issued_by'] : ''),
$row, $row['certificate_expire'], $auto, '/agent/certificates.php?client_id=' . intval($row['client_id']) . '&open=' . intval($row['certificate_id']), certificateTile('sm'));
}
}
if (in_array('license', $kinds, true)) {
$sql = mysqli_query($mysqli, "SELECT software_id, software_name, software_version, software_type, software_license_type, software_seats, software_expire, vendor_name, client_id, client_name, client_abbreviation
FROM software JOIN clients ON software_client_id = client_id LEFT JOIN vendors ON software_vendor_id = vendor_id
WHERE software_archived_at IS NULL AND client_archived_at IS NULL AND " . $window('software_expire') . reportClientSql('software_client_id', $client_id));
while ($row = mysqli_fetch_assoc($sql)) {
$seats = intval($row['software_seats']);
$add('license', $row['software_id'], trim($row['software_name'] . ' ' . $row['software_version']),
implode(' · ', array_filter([$row['software_license_type'], $seats ? $seats . ' seat' . ($seats === 1 ? '' : 's') : '', $row['vendor_name']])),
$row, $row['software_expire'], false, '/agent/license.php?client_id=' . intval($row['client_id']) . '&software_id=' . intval($row['software_id']), softwareTile($row['software_type'], 'sm'));
}
}
if (in_array('warranty', $kinds, true)) {
$gone = "'" . implode("', '", REPORT_ASSET_GONE) . "'";
$sql = mysqli_query($mysqli, "SELECT asset_id, asset_name, asset_type, asset_make, asset_model, asset_warranty_expire, client_id, client_name, client_abbreviation
FROM assets JOIN clients ON asset_client_id = client_id
WHERE asset_archived_at IS NULL AND client_archived_at IS NULL AND asset_type != 'Virtual Machine' AND COALESCE(asset_status, '') NOT IN ($gone)
AND " . $window('asset_warranty_expire') . reportClientSql('asset_client_id', $client_id));
while ($row = mysqli_fetch_assoc($sql)) {
$add('warranty', $row['asset_id'], $row['asset_name'], $row['asset_type'] . ' · ' . trim($row['asset_make'] . ' ' . $row['asset_model']),
$row, $row['asset_warranty_expire'], false, '/agent/asset.php?client_id=' . intval($row['client_id']) . '&asset_id=' . intval($row['asset_id']),
'
');
}
}
usort($rows, function ($a, $b) {
return $a['days'] <=> $b['days'] ?: strcasecmp($a['client'], $b['client']) ?: strcasecmp($a['name'], $b['name']);
});
return $rows;
}
/** When a renewal falls due, as a soft pill - red lapsed or within a week, amber within 30 days, blue when it renews itself. */
function reportDuePill($days, $auto = false) {
$days = intval($days);
if ($days < 0) {
$ago = -$days;
$tone = 'danger';
$icon = 'fa-calendar-times';
$text = 'Lapsed ' . ($ago === 1 ? 'yesterday' : "$ago days ago");
} else {
$text = $days === 0 ? 'Today' : ($days === 1 ? 'Tomorrow' : ($days <= 60 ? "In $days days" : 'In ' . round($days / 30.4) . ' months'));
$tone = $auto ? 'info' : ($days <= 7 ? 'danger' : ($days <= 30 ? 'warning' : 'secondary'));
$icon = $auto ? 'fa-sync-alt' : ($days <= 30 ? 'fa-hourglass-half' : 'fa-calendar');
}
return '
' . $text . '';
}
/** Placed and owned pass when at least this share of assets has a location / an owner. */
const REPORT_COVERAGE_SHARE = 80;
/**
* What documentation coverage checks: each with its label, the client page
* to add it on and, where it needs one, a line on how it passes. Credentials
* only for agents who may see them.
*/
function reportCoverageChecks() {
$share = REPORT_COVERAGE_SHARE;
$checks = [
'primary_contact' => ['label' => 'Primary contact', 'page' => 'contacts.php'],
'billing_contact' => ['label' => 'Billing contact', 'page' => 'contacts.php'],
'primary_location' => ['label' => 'Primary location', 'page' => 'locations.php'],
'assets' => ['label' => 'Assets', 'page' => 'assets.php'],
'asset_locations' => ['label' => 'Assets placed', 'page' => 'assets.php', 'title' => "At least $share% of assets have a location"],
'device_owners' => ['label' => 'Device owners', 'page' => 'assets.php', 'title' => "At least $share% of laptops, desktops, phones and tablets have a contact"],
'networks' => ['label' => 'Networks', 'page' => 'networks.php'],
'credentials' => ['label' => 'Credentials', 'page' => 'credentials.php'],
'documents' => ['label' => 'Documents', 'page' => 'files.php'],
'domains' => ['label' => 'Domains', 'page' => 'domains.php'],
'services' => ['label' => 'Services', 'page' => 'services.php'],
'licenses' => ['label' => 'Licenses', 'page' => 'software.php'],
];
if (reportPermission('module_credential') < 1) {
unset($checks['credentials']);
}
return $checks;
}
/**
* Documentation coverage for active clients (or one), keyed by client id:
* the counts behind each check, 'checks' (true passes, false is missing,
* null does not apply - no user devices to give owners), 'missing', and
* 'score', the share of the checks that apply which pass.
*/
function reportCoverage($client_id = 0) {
global $mysqli;
$checks = reportCoverageChecks();
$client_id = intval($client_id);
$clients = [];
$sql = mysqli_query($mysqli, "SELECT client_id, client_name, client_abbreviation FROM clients WHERE client_archived_at IS NULL" . reportClientSql('client_id', $client_id) . " ORDER BY client_name");
while ($row = mysqli_fetch_assoc($sql)) {
$clients[intval($row['client_id'])] = ['client_id' => intval($row['client_id']), 'client' => $row['client_name'], 'abbr' => $row['client_abbreviation'],
'contacts' => 0, 'primary' => 0, 'billing' => 0, 'locations' => 0, 'primary_loc' => 0, 'assets' => 0, 'placed' => 0, 'devices' => 0, 'owned' => 0,
'networks' => 0, 'credentials' => 0, 'documents' => 0, 'domains' => 0, 'services' => 0, 'licenses' => 0];
}
if (!$clients) {
return [];
}
$only = $client_id ? " = $client_id" : ' > 0';
$fill = function ($query, array $fields) use (&$clients, $mysqli) {
$sql = mysqli_query($mysqli, $query);
while ($row = mysqli_fetch_assoc($sql)) {
$id = intval($row['c']);
if (isset($clients[$id])) {
foreach ($fields as $field) {
$clients[$id][$field] = intval($row[$field]);
}
}
}
};
$devices = "'" . implode("', '", SERVICE_USER_DEVICE_TYPES) . "'";
$gone = "'" . implode("', '", REPORT_ASSET_GONE) . "'";
$fill("SELECT contact_client_id AS c, COUNT(*) AS contacts, SUM(contact_primary = 1) AS `primary`, SUM(contact_billing = 1) AS billing
FROM contacts WHERE contact_archived_at IS NULL AND contact_client_id $only GROUP BY contact_client_id", ['contacts', 'primary', 'billing']);
$fill("SELECT location_client_id AS c, COUNT(*) AS locations, SUM(location_primary = 1) AS primary_loc
FROM locations WHERE location_archived_at IS NULL AND location_client_id $only GROUP BY location_client_id", ['locations', 'primary_loc']);
$fill("SELECT asset_client_id AS c, COUNT(*) AS assets, SUM(asset_location_id > 0) AS placed,
SUM(asset_type IN ($devices)) AS devices, SUM(asset_type IN ($devices) AND asset_contact_id > 0) AS owned
FROM assets WHERE asset_archived_at IS NULL AND COALESCE(asset_status, '') NOT IN ($gone) AND asset_client_id $only GROUP BY asset_client_id", ['assets', 'placed', 'devices', 'owned']);
foreach (['networks' => ['networks', 'network'], 'documents' => ['documents', 'document'], 'domains' => ['domains', 'domain'], 'services' => ['services', 'service'],
'licenses' => ['software', 'software'], 'credentials' => ['credentials', 'credential']] as $field => [$table, $prefix]) {
if (isset($checks[$field])) {
$fill("SELECT {$prefix}_client_id AS c, COUNT(*) AS $field FROM $table WHERE {$prefix}_archived_at IS NULL AND {$prefix}_client_id $only GROUP BY {$prefix}_client_id", [$field]);
}
}
foreach ($clients as &$client) {
$client['placed_share'] = $client['assets'] ? $client['placed'] / $client['assets'] * 100 : null;
$client['owned_share'] = $client['devices'] ? $client['owned'] / $client['devices'] * 100 : null;
$result = [
'primary_contact' => $client['primary'] > 0,
'billing_contact' => $client['billing'] > 0,
'primary_location' => $client['primary_loc'] > 0,
'assets' => $client['assets'] > 0,
'asset_locations' => $client['placed_share'] === null ? null : $client['placed_share'] >= REPORT_COVERAGE_SHARE,
'device_owners' => $client['owned_share'] === null ? null : $client['owned_share'] >= REPORT_COVERAGE_SHARE,
'networks' => $client['networks'] > 0,
'credentials' => $client['credentials'] > 0,
'documents' => $client['documents'] > 0,
'domains' => $client['domains'] > 0,
'services' => $client['services'] > 0,
'licenses' => $client['licenses'] > 0,
];
$client['checks'] = array_intersect_key($result, $checks);
$applies = array_filter($client['checks'], function ($v) { return $v !== null; });
$client['passed'] = count(array_filter($applies));
$client['applies'] = count($applies);
$client['score'] = reportShare($client['passed'], $client['applies'], 0);
$client['missing'] = array_keys(array_filter($client['checks'], function ($v) { return $v === false; }));
}
unset($client);
return $clients;
}
/** What a client is missing, as pills that open the page to add each on. */
function reportCoverageMissingHtml($client) {
$checks = reportCoverageChecks();
if (!$client['missing']) {
return '
Nothing';
}
$html = '
';
foreach ($client['missing'] as $key) {
$html .= '' . escapeHtml($checks[$key]['label']) . '';
}
return $html . '';
}