License Templates) - making, changing, copying,
* archiving and deleting them, making licenses from one for several clients
* at once, saying who should have one, and looking after its licenses across
* clients - their seats trued up, and billed on the clients' recurring
* invoices - and exporting them to a file and importing them from one
* (functions/software_template_transfer.php). The work is in
* functions/software_template.php; a single license
* is made from one by add_software or add_software_from_template, and
* licenses are renewed by renew_software (agent/post/software.php).
*/
defined('FROM_POST_HANDLER') || die("Direct file access is not allowed");
/* The template a request is for - or back to the list, saying it is gone. */
function softwareTemplateForRequest($software_template_id) {
$row = softwareTemplateRow($software_template_id);
if (!$row) {
flashAlert('That license template no longer exists.', 'error');
redirect('software_templates.php');
}
return $row;
}
if (isset($_POST['add_software_template']) || isset($_POST['edit_software_template'])) {
validateCSRFToken();
$editing = isset($_POST['edit_software_template']);
$software_template_id = $editing ? intval(softwareTemplateForRequest($_POST['software_template_id'] ?? 0)['software_template_id']) : 0;
$fields = softwareTemplateFields($_POST, $error);
if (!$fields) {
flashAlert(escapeHtml($error), 'error');
redirect();
}
$software_template_id = softwareTemplateSave($software_template_id, $fields);
logAudit("Software Template", $editing ? "Edit" : "Create", "$session_name " . ($editing ? 'edited' : 'created') . " license template " . escapeSql($fields['name']), 0, $software_template_id);
flashAlert("License template " . escapeHtml($fields['name']) . " " . ($editing ? 'saved' : 'created'));
// A new one opens on its page
redirect($editing ? null : "software_template.php?software_template_id=$software_template_id");
}
if (isset($_POST['make_licenses_from_template'])) {
// The same license for each client picked - the seats, dates and order reference given once for all
validateCSRFToken();
$row = softwareTemplateForRequest($_POST['software_template_id'] ?? 0);
$software_template_id = intval($row['software_template_id']);
if ($row['software_template_archived_at']) {
flashAlert('That template is archived - restore it to make licenses from it.', 'error');
redirect();
}
$client_ids = array_values(array_filter(array_map('intval', (array) ($_POST['client_ids'] ?? []))));
if (!$client_ids) {
flashAlert('Pick the clients to make one for.', 'error');
redirect();
}
$post = [
'seats' => $_POST['seats'] ?? '',
'purchase_reference' => $_POST['purchase_reference'] ?? '',
'purchase' => $_POST['purchase'] ?? '',
'expire' => $_POST['expire'] ?? '',
];
$result = softwareTemplateMakeForClients($software_template_id, $client_ids, $post, !empty($_POST['skip_existing']));
foreach ($result['made'] as $client_id => $software_id) {
if (isset($result['vendors'][$client_id])) {
$vendor_id = intval(getFieldById('software', $software_id, 'software_vendor_id'));
logAudit("Vendor", "Create", "$session_name created vendor " . escapeSql((string) getFieldById('vendors', $vendor_id, 'vendor_name')) . " from a template for license " . escapeSql($row['software_template_name']), $client_id, $vendor_id);
}
logAudit("Software", "Create", "$session_name created license " . escapeSql($row['software_template_name']) . " from template " . escapeSql($row['software_template_name']), $client_id, $software_id);
}
$made = count($result['made']);
$skipped = count($result['skipped']);
$vendors = count($result['vendors']);
flashAlert(($made ? "Made $made license" . ($made === 1 ? '' : 's') : 'Made no licenses') . " from " . escapeHtml($row['software_template_name']) . ""
. ($vendors ? ", adding vendor " . escapeHtml((string) $row['vendor_template_name']) . " for $vendors client" . ($vendors === 1 ? '' : 's') : '')
. ($skipped ? " - skipped " . ($skipped === 1 ? escapeHtml(reset($result['skipped'])) . ", which already has one" : "$skipped clients that already have one") : ''), $made ? 'success' : 'warning');
redirect("software_template.php?software_template_id=$software_template_id");
}
if (isset($_POST['save_software_template_required'])) {
// Who should have a license from it
validateCSRFToken();
$row = softwareTemplateForRequest($_POST['software_template_id'] ?? 0);
$software_template_id = intval($row['software_template_id']);
$required = intval($_POST['required'] ?? 0);
$tag_ids = array_map('intval', (array) ($_POST['tags'] ?? []));
if ($required === SOFTWARE_TEMPLATE_REQUIRED_TAGGED && !array_filter($tag_ids)) {
flashAlert('Pick the client tags - or Every client.', 'error');
redirect();
}
softwareTemplateSetRequired($software_template_id, $required, $tag_ids);
$saved = softwareTemplateRow($software_template_id);
$scope = softwareTemplateScopeText($saved['software_template_required'], softwareTemplateRequiredTags([$software_template_id])[$software_template_id]);
$said = $scope !== '' ? "required of " . lcfirst($scope) : 'not required of anyone';
logAudit("Software Template", "Edit", "$session_name set license template " . escapeSql($row['software_template_name']) . " " . escapeSql($said), 0, $software_template_id);
flashAlert("" . escapeHtml($row['software_template_name']) . " is " . escapeHtml($said));
redirect();
}
if (isset($_POST['true_up_software_template'])) {
// The seats bought on the licenses ticked set to what was given - each its own
validateCSRFToken();
$row = softwareTemplateForRequest($_POST['software_template_id'] ?? 0);
$software_template_id = intval($row['software_template_id']);
$seats = [];
foreach (array_unique(array_filter(array_map('intval', (array) ($_POST['software_ids'] ?? [])))) as $software_id) {
$seats[$software_id] = $_POST['seats'][$software_id] ?? '';
}
if (!$seats) {
flashAlert('Tick the licenses to true up.', 'error');
redirect();
}
$changes = softwareTemplateTrueUp($software_template_id, $seats);
foreach ($changes as $software_id => $change) {
logAudit("Software", "Edit", "$session_name trued up license " . escapeSql($change['name']) . " from " . softwareTemplateSeatsText($change['from']) . " to " . softwareTemplateSeatsText($change['to']), $change['client_id'], $software_id);
}
$count = count($changes);
if ($count === 1) {
$change = reset($changes);
flashAlert("" . escapeHtml($change['client_name']) . " trued up from " . softwareTemplateSeatsText($change['from']) . " to " . softwareTemplateSeatsText($change['to']));
} else {
flashAlert($count ? "Trued up $count licenses from " . escapeHtml($row['software_template_name']) . "" : 'Nothing to change - they have those seats already', $count ? 'success' : 'warning');
}
redirect();
}
if (isset($_POST['bill_software_template'])) {
// A line for the product it is sold as on each license's recurring invoice, counting its seats
validateCSRFToken();
$row = softwareTemplateForRequest($_POST['software_template_id'] ?? 0);
$software_template_id = intval($row['software_template_id']);
$software_ids = array_values(array_unique(array_filter(array_map('intval', (array) ($_POST['software_ids'] ?? [])))));
if (!$software_ids) {
flashAlert('Tick the licenses to bill.', 'error');
redirect();
}
$count = ($_POST['count'] ?? '') === 'used' ? 'used' : 'total';
// Not the ones billed already - a second line would bill them twice
$licenses = softwareTemplateLicenses($software_template_id, $row['software_template_product_id']);
$added = 0;
$skipped = 0;
$errors = [];
foreach ($software_ids as $software_id) {
if (!isset($licenses[$software_id]) || !empty($licenses[$software_id]['billing'])) {
$skipped++;
continue;
}
$recurring_invoice_id = intval($_POST['recurring'][$software_id] ?? 0);
$item_id = softwareTemplateBill($software_template_id, $software_id, $recurring_invoice_id, $count, $error);
if (!$item_id) {
$errors[$error] = true;
continue;
}
$added++;
$client_id = intval($licenses[$software_id]['software_client_id']);
$number = billingNumber('recurring', billingRow('recurring', $recurring_invoice_id, false));
$line = (string) $row['product_name'];
logAudit("Recurring Invoice", "Edit", escapeSql("$session_name added line $line to $number, counting the seats " . ($count === 'total' ? 'bought' : 'in use') . " on license {$licenses[$software_id]['software_name']}"), $client_id, $recurring_invoice_id);
}
if ($errors && !$added) {
flashAlert(escapeHtml(implode(' ', array_keys($errors))), 'error');
redirect();
}
flashAlert("Billed $added license" . ($added === 1 ? '' : 's') . " as " . escapeHtml((string) $row['product_name']) . ""
. ($skipped ? " - $skipped billed already" : '') . ($errors ? ' - ' . escapeHtml(implode(' ', array_keys($errors))) : ''), $errors ? 'warning' : 'success');
redirect();
}
if (isset($_GET['copy_software_template'])) {
validateCSRFToken();
$row = softwareTemplateForRequest($_GET['copy_software_template']);
$new_id = softwareTemplateCopy($row['software_template_id']);
$new_name = (string) softwareTemplateRow($new_id)['software_template_name'];
logAudit("Software Template", "Create", "$session_name copied license template " . escapeSql($row['software_template_name']) . " as " . escapeSql($new_name), 0, $new_id);
flashAlert("License template " . escapeHtml($row['software_template_name']) . " copied as " . escapeHtml($new_name) . "");
redirect("software_template.php?software_template_id=$new_id");
}
if (isset($_GET['archive_software_template']) || isset($_GET['restore_software_template'])) {
validateCSRFToken();
$archive = isset($_GET['archive_software_template']);
$row = softwareTemplateForRequest($archive ? $_GET['archive_software_template'] : $_GET['restore_software_template']);
$software_template_id = intval($row['software_template_id']);
// Archived, it isn't offered for new licenses; the ones made from it stay
mysqli_query($mysqli, "UPDATE software_templates SET software_template_archived_at = " . ($archive ? 'NOW()' : 'NULL') . ", software_template_updated_at = software_template_updated_at
WHERE software_template_id = $software_template_id");
logAudit("Software Template", $archive ? "Archive" : "Restore", "$session_name " . ($archive ? 'archived' : 'restored') . " license template " . escapeSql($row['software_template_name']), 0, $software_template_id);
flashAlert("License template " . escapeHtml($row['software_template_name']) . " " . ($archive ? 'archived' : 'restored'), $archive ? 'error' : 'success');
redirect();
}
if (isset($_GET['delete_software_template'])) {
validateCSRFToken();
$row = softwareTemplateForRequest($_GET['delete_software_template']);
// The licenses made from it stay, no longer linked to it
softwareTemplateDelete($row['software_template_id']);
logAudit("Software Template", "Delete", "$session_name deleted license template " . escapeSql($row['software_template_name']));
flashAlert("License template " . escapeHtml($row['software_template_name']) . " deleted", 'error');
// From its own page, back to the list
redirect(!empty($_GET['from_page']) ? 'software_templates.php' : null);
}
if (isset($_POST['export_software_templates']) || isset($_GET['export_software_template'])) {
// A file of templates to import into another ITFlow - every current one, the ones picked, or one
validateCSRFToken();
if (isset($_GET['export_software_template'])) {
$row = softwareTemplateForRequest($_GET['export_software_template']);
$export = softwareTemplatesExport([intval($row['software_template_id'])]);
} else {
$export = softwareTemplatesExport((array) ($_POST['software_template_ids'] ?? []), !empty($_POST['archived']));
}
if (!$export['templates']) {
flashAlert('There are no license templates to export.', 'error');
redirect();
}
$count = count($export['templates']);
logAudit("Software Template", "Export", "$session_name exported $count license template" . ($count === 1 ? ' ' . escapeSql($export['templates'][0]['name']) : 's'));
header('Content-Type: application/json; charset=utf-8');
header('Content-Disposition: attachment; filename="' . softwareTemplatesExportFileName($export) . '"');
header('Cache-Control: no-store');
echo json_encode($export, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
exit;
}
if (isset($_POST['import_software_templates'])) {
// Templates from a file exported by ITFlow
validateCSRFToken();
$file = $_FILES['file'] ?? null;
if ($file && in_array($file['error'], [UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE], true)) {
flashAlert('That file is bigger than this server takes in an upload - export a few at a time.', 'error');
redirect('software_templates.php');
}
if (!$file || $file['error'] !== UPLOAD_ERR_OK || !is_uploaded_file($file['tmp_name'])) {
flashAlert('Pick the file to import.', 'error');
redirect('software_templates.php');
}
if ($file['size'] > 20 * 1024 * 1024) {
flashAlert('That file is too big to be license templates.', 'error');
redirect('software_templates.php');
}
$templates = softwareTemplatesImportRead(file_get_contents($file['tmp_name']), $import_error);
if ($templates === null) {
flashAlert(escapeHtml($import_error), 'error');
redirect('software_templates.php');
}
$existing = in_array($_POST['existing'] ?? '', ['skip', 'copy', 'replace'], true) ? $_POST['existing'] : 'skip';
$counts = softwareTemplatesImport($templates, $existing);
logAudit("Software Template", "Import", "$session_name imported license templates from " . escapeSql(mb_substr((string) $file['name'], 0, 100)) . " - {$counts['added']} added, {$counts['replaced']} replaced, {$counts['skipped']} skipped"
. ($counts['vendors'] ? ", {$counts['vendors']} vendor templates added" : ''));
flashAlert(softwareTemplatesImportSummary($counts), $counts['products'] ? 'warning' : ($counts['added'] || $counts['replaced'] ? 'success' : 'info'));
redirect('software_templates.php');
}