Application.php

<?php

namespace Vanderbilt\CareerDevLibrary;

use Vanderbilt\FlightTrackerExternalModule\CareerDev;
use Vanderbilt\FlightTrackerExternalModule\FlightTrackerExternalModule;

require_once(dirname(__FILE__)."/CareerDev.php");
require_once(dirname(__FILE__)."/FlightTrackerExternalModule.php");

class Application
{
	public static function getVersion() {
		return CareerDev::getVersion();
	}

	public static function getActivePids() {
		return REDCapManagement::getActiveProjects(self::getPids());
	}

	public static function getCredentialsDir() {
		$options = [
			"/app001/credentials",
			"/Users/pearsosj/credentials",
			"/Users/scottjpearson/credentials",
		];
		foreach ($options as $dir) {
			if (file_exists($dir)) {
				return $dir;
			}
		}
		return "";
	}

	public static function getWarningEmailMinutes($pid) {
		$value = self::getSetting("warning_minutes", $pid);
		if (!$value) {
			return 15;
		} else {
			return $value;
		}
	}

	public static function isSuperUser() {
		$isSuperUser = false;
		if (method_exists("\ExternalModules\ExternalModules", "isSuperUser")) {
			$isSuperUser = \ExternalModules\ExternalModules::isSuperUser();
		}
		return ((defined("\SUPER_USER") && \SUPER_USER) || $isSuperUser);
	}

	public static function getRelevantChoices() {
		return CareerDev::getRelevantChoices();
	}

	public static function getJQueryURL(): string {
		$fileOrder = [
			APP_PATH_DOCROOT."Resources/webpack/js/bundle.js" => APP_PATH_WEBROOT."Resources/webpack/js/bundle.js",
			__DIR__."/js/jquery.min.js" => "getUrl",
		];
		foreach ($fileOrder as $file => $url) {
			if (file_exists($file)) {
				if ($url == "getUrl") {
					# this should only rarely be called => save CPU cycles by lazy instantiation
					$module = self::getModule();
					return $module->getUrl("js/jquery.min.js");
				} else {
					return $url;
				}
			}
		}
		return "";
	}

	public static function getMetadataFiles($pid): array {
		$files = [];
		if (Application::getSetting("signup_project", $pid)) {
			$files[] = __DIR__."/metadata.signup.json";
		}
		$files[] = __DIR__."/metadata.json";
		if (CareerDev::isVanderbilt()) {
			$files[] = __DIR__."/metadata.vanderbilt.json";
		}
		return $files;
	}

	public static function getPID($token) {
		return CareerDev::getPID($token);
	}

	public static function has($instrument, $pid = "") {
		return CareerDev::has($instrument, $pid);
	}

	public static function getFlightConnectorURL() {
		return "https://redcap.vumc.org/external_modules/?prefix=flight_connector&page=map&pid=172928&h=5986967536b44df5&NOAUTH";
	}

	public static function getDataTable($pid) {
		return method_exists('\REDCap', 'getDataTable') ? \REDCap::getDataTable($pid) : "redcap_data";
	}

	public static function getLogTable($pid) {
		$module = self::getModule();
		self::setPid($pid);
		if ($module && method_exists($module, "getProject") && method_exists($module->getProject(), "getLogTable")) {
			return $module->getProject()->getLogTable();
		}
		return "redcap_log_event";
	}

	public static function getApplicationColors($alphas = ["1.0"], $inHex = false) {
		$colors = [];
		foreach ($alphas as $alpha) {
			# Flight Tracker RGBs
			$colors[] = "rgba(240, 86, 93, $alpha)";
			$colors[] = "rgba(141, 198, 63, $alpha)";
			$colors[] = "rgba(87, 100, 174, $alpha)";
			$colors[] = "rgba(247, 151, 33, $alpha)";
			$colors[] = "rgba(231, 226, 71, $alpha)";
		}
		if ($inHex) {
			$hexColors = [];
			foreach ($colors as $color) {
				if (preg_match("/rgba\((\d+), (\d+), (\d+), ([\d\.]+)\)/", $color, $matches)) {
					$rr = dechex((int) $matches[1]);
					$gg = dechex((int) $matches[2]);
					$bb = dechex((int) $matches[3]);
					$alphaFrac = (float) $matches[4];
					$aa = dechex((int) round($alphaFrac * 255));
				} elseif (preg_match("/rgb\((\d+), (\d+), (\d+)\)/", $color, $matches)) {
					$rr = dechex((int) $matches[1]);
					$gg = dechex((int) $matches[2]);
					$bb = dechex((int) $matches[3]);
					$aa = '';
				} else {
					throw new \Exception("Invalid pattern $color");
				}
				$hexColors[] = strtoupper("#$rr$gg$bb$aa");
			}
			return $hexColors;
		} else {
			return $colors;
		}
	}

	public static function isVanderbilt() {
		return CareerDev::isVanderbilt();
	}

	public static function getProjectTitle($pid = null) {
		if (!$pid) {
			$pid = Sanitizer::sanitizePid($_GET['pid'] ?? "");
		}
		if ($pid) {
			return Download::projectTitle($pid);
		}
		return "";
	}

	public static function getGrantClasses() {
		return CareerDev::getGrantClasses();
	}

	public static function reportException(\Exception $e) {
		$html = "<div class='red'>Exception: ".$e->getMessage()."</div>";
		return $html;
	}

	public static function makeIcon() {
		$mime = "image/png";
		$filename = __DIR__."/img/flight_tracker_icon.png";
		$base64 = FileManagement::getBase64OfFile($filename, $mime);
		return "<link rel='icon' type='$mime' href='$base64' />";
	}

	public static function setPid($pid) {
		CareerDev::setPid($pid);
	}

	public static function unsetPid() {
		CareerDev::unsetPid();
	}

	public static function checkOrResetToken($token, $pid) {
		$allValidTokens = REDCapManagement::getToken($pid);
		if (empty($allValidTokens)) {
			throw new \Exception("No valid tokens for this project!");
		}
		if (!in_array($token, $allValidTokens)) {
			$newToken = REDCapManagement::getToken($pid, self::getUsername());
			if (!$newToken) {
				$newToken = $allValidTokens[0];
			}
			self::saveSetting("token", $newToken, $pid);
			return $newToken;
		} else {
			return $token;
		}
	}

	public static function saveSystemSetting($field, $value) {
		$module = self::getModule();
		if ($module) {
			$module->setSystemSetting($field, $value);
		} else {
			throw new \Exception("Could not find module!");
		}
	}

	public static function getSystemSetting($field) {
		$module = self::getModule();
		if ($module) {
			return $module->getSystemSetting($field) ?: "";
		} else {
			throw new \Exception("Could not find module!");
		}
	}

	# TRUE iff &record= appended to end of page
	public static function isRecordPage($link) {
		$regexes = [
			"/profile\.php/",
			"/customGrants\.php/",
			"/initial\.php/",
			"/dashboard\//",
			"/wrangler\//",
			"/publications\/view\.php/",
		];
		foreach ($regexes as $regex) {
			if (preg_match($regex, $link)) {
				return true;
			}
		}
		return false;
	}

	public static function refreshRecordSummary($token, $server, $pid, $recordId, $throwException = false) {
		CareerDev::refreshRecordSummary($token, $server, $pid, $recordId, $throwException);
	}

	public static function getProgramName() {
		return CareerDev::getProgramName();
	}

	public static function generateCSRFToken() {
		$module = self::getModule();
		if (REDCapManagement::versionGreaterThanOrEqualTo(REDCAP_VERSION, "11.1.1")) {
			return $module->getCSRFToken();
		} else {
			return "";
		}
	}

	public static function generateCSRFTokenHTML() {
		$csrfToken = self::generateCSRFToken();
		if (!$csrfToken) {
			return "";
		}
		return "<input type='hidden' id='redcap_csrf_token' name='redcap_csrf_token' value='$csrfToken' />";
	}

	public static function getUsername() {
		if (defined('USERID')) {
			return USERID;
		}
		global $userid;
		if ($userid) {
			return $userid;
		}
		$module = self::getModule();
		if ($module) {
			return $module->getUsername();
		}
		return "";
	}

	public static function getUnknown() {
		return CareerDev::getUnknown();
	}

	public static function filterOutCopiedRecords($records) {
		return CareerDev::filterOutCopiedRecords($records);
	}

	public static function getFeedbackEmail() {
		return "scott.j.pearson@vumc.org";
	}

	public static function getPatentFields($metadata) {
		$possibleFields = [
			"record_id",
			"patent_number",
			"patent_include",
			"patent_title",
			"patent_abstract",
			"patent_date",
			"patent_inventors",
			"patent_inventor_ids",
			"patent_assignees",
			"patent_assignee_ids",
			"patent_last_update",
		];
		return REDCapManagement::filterOutInvalidFields($metadata, $possibleFields);
	}

	public static function isPluginProject() {
		return false;
	}

	public static function log($mssg, $pid = false) {
		CareerDev::log($mssg, $pid);
	}

	public static function getBase64($relativeURL) {
		$relativeURL = preg_replace("/^\//", "", $relativeURL);
		$filename = __DIR__."/".$relativeURL;
		if (file_exists($filename)) {
			return FileManagement::getBase64OfFile($filename, mime_content_type($filename));
		}
		return "";
	}

	public static function getInstitutions($pid = null, $searchOnly = true) {
		return CareerDev::getInstitutions($pid, $searchOnly);
	}

	public static function getImportHTML() {
		$version = CareerDev::getVersion();
		$str = "";
		$str .= "<link rel='stylesheet' href='https://use.fontawesome.com/releases/v5.8.2/css/all.css' integrity='sha384-oS3vJWv+0UjzBfQzYUhtDYW+Pj2yciDJxpsK1OYPAYjqT085Qq/1cq5FLXAZQ7Ay' crossorigin='anonymous' />";
		$str .= "<link rel='stylesheet' href='".self::link("/css/w3.css")."' />";
		$str .= "<script src='".self::link("/js/base.js")."&$version'></script>";

		$baseUrl = $_SERVER['PHP_SELF'] ?? "";
		$isExtModPage = (
			(
				preg_match("/ExternalModules/", $baseUrl)
				|| preg_match("/external_modules/", $baseUrl)
			)
			&& preg_match("/".self::getPrefix()."/", $_SERVER['REQUEST_URI'] ?? "")
		);
		$isPluginPage = preg_match("/\/plugins\//", $baseUrl);
		$isFTPage = $isPluginPage || $isExtModPage && (preg_match("/odules\/$/", $baseUrl) || preg_match("/odules\/index.php$/", $baseUrl));
		if ($isExtModPage || $isPluginPage) {
			if ($isFTPage) {
				$str .= "<script src='".self::link("/js/jquery.min.js")."'></script>";
			}
			$str .= "<script src='".self::link("/js/jquery-ui.min.js")."'></script>";
			$str .= "<script src='".self::link("/js/autocomplete.js")."&$version'></script>";
			$str .= self::makeIcon();
			$str .= "<link rel='stylesheet' href='".self::link("/css/jquery-ui.css")."' />";
			$str .= "<link rel='stylesheet' href='".self::link("/css/career_dev.css")."&$version' />";
			$str .= "<link rel='stylesheet' href='".self::link("/css/typekit.css")."&$version' />";
		}
		$str .= "<link rel='stylesheet' href='".self::link("/css/jquery.sweet-modal.min.css")."' />";
		$str .= "<script src='".self::link("/js/jquery.sweet-modal.min.js")."'></script>";
		$str .= "<script src='".self::link("/js/html2canvas.min.js")."'></script>";
		$str .= "<script>function getCSRFToken() { return '".self::generateCSRFToken()."'; }</script>";
		return $str;
	}

	public static function getHeader($tokenName = "", $token = "", $server = "", $pid = "") {
		$pid = $pid ?: CareerDev::getPID();
		$token = $token ?: self::getSetting("token", $pid);
		$server = $server ?: self::getSetting("server", $pid);

		$tokenName = Download::shortProjectTitle($pid);
		$module = self::getModule();
		$museoSansLink = self::link("/fonts/exljbris - MuseoSans-500.otf");
		$horizontalScrollbar = CareerDev::isREDCap() ? ":root { overflow-x: scroll; }" : "";

		$str = "";
		$str .= "
<style>
/* must add fonts here or they will not show up in REDCap menus */
@font-face { font-family: 'Museo Sans'; font-style: normal; font-weight: normal; src: url('$museoSansLink'); }

.w3-dropdown-hover { display: inline-block !important; float: none !important; }
.w3-dropdown-hover button,a.w3-bar-link { font-size: 12px; }
a.w3-bar-link { display: inline-block !important; float: none !important; }
.w3-bar { font-family: 'Museo Sans', Arial, Helvetica, sans-serif; text-align: center !important; }
a.w3-button,button.w3-button { padding: 6px 4px !important; }
a.w3-button,button.w3-button.with-image { padding: 8px 4px 6px 4px !important; }
a.w3-button { color: black !important; float: none !important; }
.w3-button a,.w3-dropdown-content a { color: white !important; font-size: 13px !important; }
.topHeaderWrapper { background-color: white; height: 80px; top: 0px; width: 100%; }
.topHeader { margin: 0 auto; max-width: 1200px; }
.topBar { font-family: 'Museo Sans', Arial, Helvetica, sans-serif; padding: 0px; }
.middleBar { font-family: 'Museo Sans', Arial, Helvetica, sans-serif; font-size: 13px; padding: 0 0 0 20px; text-align: left; float: left; max-width: 600px; }
a.nounderline { text-decoration: none; }
a.nounderline:hover { text-decoration: dotted; }
img.brandLogo { height: 40px; margin: 20px; }
#overlayFT { position: fixed; display: none; width: 100%; height: 100%; top: 0; left: 0; right: 0; bottom: 0; background-color: rgba(0,0,0,0.7); z-index: 2; cursor: pointer; text-align: center; vertical-align: middle; }
.warning { color: white; }
p.centered { text-align: center; margin-left: auto; margin-right: auto; }

/* Coordinated with career_dev.css */
p.recessed { color: #888888; font-size: 11px; margin: 4px 12px 4px 12px; }
.recessed,.recessed a { color: #888888; font-size: 11px; }
p.recessed,div.recessed { margin: 2px; }
$horizontalScrollbar
</style>";

		$str .= self::getImportHTML();

		$str .= "<header class='topHeaderWrapper'>";
		$str .= "<div class='topHeader'>";
		$str .= "<div class='topBar' style='float: left; padding-left: 5px;'><a href='https://redcap.vumc.org/plugins/career_dev/consortium/'><img alt='Flight Tracker for Scholars' src='".self::link("/img/flight_tracker_logo_small.png")."'></a></div>";
		# logged in and on a record
		if (Application::getUsername() && (isset($_GET['id']) || isset($_GET['record']))) {
			$records = Download::records($token, $server);
			$recordId = Sanitizer::getSanitizedRecord($_GET['id'] ?? $_GET['record'] ?? "", $records);
			if ($recordId) {
				$csrfToken = self::generateCSRFToken();
				$url = self::link("/fetchDataNow.php");
				$str .= "<div class='middleBar'><br/>";
				$str .= "Fetch Data Now for this Scholar:";
				$fetchConfig = [
					"Summary" => "summary",
					"Publications" => "publications",
					"Grants" => "grants",
					"Patents" => "patents",
				];
				foreach ($fetchConfig as $label => $fetchType) {
					$str .= "&nbsp;&nbsp;<button onclick='fetchDataNow(\"$url\", \"$recordId\", \"$csrfToken\", \"$fetchType\"); return false;'>$label</button>";
				}
				$str .= "<br/>";
				$str .= "Restart from Scratch for this Scholar:";
				foreach ($fetchConfig as $label => $fetchType) {
					if ($fetchType != "summary") {
						$str .= "&nbsp;&nbsp;<button onclick='confirmRestartData(\"$url\", \"$recordId\", \"$csrfToken\", \"$fetchType\"); return false;'>$label</button>";
					}
				}
				$str .= "<br/>";
				$str .= "Match Without Institutions:";
				foreach ($fetchConfig as $label => $fetchType) {
					if (!in_array($fetchType, ["summary", "patents"])) {
						$fetchType .= "_name";
						$str .= "&nbsp;&nbsp;<button onclick='fetchDataNow(\"$url\", \"$recordId\", \"$csrfToken\", \"$fetchType\"); return false;'>$label</button>";
					}
				}
				$str .= "</div>";
			}
		}
		if ($base64 = $module->getBrandLogo()) {
			$str .= "<div class='topBar' style='float:right;'><img src='$base64' class='brandLogo'></div>";
		} else {
			$configLink = self::link("config.php", $pid);
			$str .= "<div class='topBar' style='float:right;'><p class='alignright darkgreytext padded nomargin bolded'>$tokenName<br/><a href='$configLink' title='Configure Application'><i class='fa fa-cog darkgreytext' style='font-size: 24px;'></i></a></p>";
		}
		$str .= "</div>";
		$str .= "</header>";

		$switches = new FeatureSwitches($token, $server, $pid);

		$navBar = new NavigationBar();
		$navBar->addFALink("home", "Home", CareerDev::getHomeLink());
		$navBar->addFAMenu("clinic-medical", "General", CareerDev::getMenu("General", $pid));
		if ($switches->isOnForProject("Grants")) {
			$navBar->addMenu("<img src='".CareerDev::link("/img/grant_small.png")."'>Grants", CareerDev::getMenu("Grants"));
		}
		if ($switches->isOnForProject("Publications")) {
			$navBar->addFAMenu("sticky-note", "Pubs", CareerDev::getMenu("Pubs", $pid));
		}
		$navBar->addFAMenu("table", "View", CareerDev::getMenu("View", $pid));
		if (!CareerDev::isCopiedProject($pid)) {
			$navBar->addFAMenu("calculator", "Wrangle", CareerDev::getMenu("Wrangler", $pid));
		}
		$navBar->addFAMenu("school", "Scholars", CareerDev::getMenu("Scholars", $pid));
		$navBar->addMenu("<img src='".CareerDev::link("/img/redcap_translucent_small.png")."'>REDCap", CareerDev::getMenu("REDCap", $pid));
		$navBar->addFAMenu("tachometer-alt", "Dashboards", CareerDev::getMenu("Dashboards", $pid));
		$navBar->addFAMenu("filter", "Cohorts / Filters", CareerDev::getMenu("Cohorts", $pid));
		$navBar->addFAMenu("chalkboard-teacher", "Mentors", CareerDev::getMenu("Mentors", $pid));
		$navBar->addFAMenu("pen", "Resources", CareerDev::getMenu("Resources", $pid));
		$navBar->addFAMenu("question-circle", "Help", CareerDev::getMenu("Help", $pid));
		$str .= $navBar->getHTML();

		return $str;
	}

	public static function getFooter() {
		$px = 300;
		$str = "";
		$str .= "<style>
body { margin-bottom: 60px; }
footer { z-index: 1000000; position: fixed; left: 0; bottom: 0; width: 100%; background-color: white; }
.bottomBar { font-family: 'Museo Sans', Arial, Helvetica, sans-serif; padding: 5px; }
</style>";
		$str .= "<footer class='bottomFooter'>";
		$str .= "<div class='bottomBar' style='float: left;'>";
		$str .= "<div class='recessed' style='width: $px"."px;'>Copyright &#9400 ".date("Y")." <a class='nounderline' href='https://vumc.org/'>Vanderbilt University Medical Center</a></div>";
		$str .= "<div class='recessed' style='width: $px"."px;'>from <a class='nounderline' href='https://edgeforscholars.org/'>Edge for Scholars</a></div>";
		$str .= "<div class='recessed' style='width: $px"."px;'><a class='nounderline' href='https://projectredcap.org/'>Powered by REDCap</a></div>";
		$str .= "</div>";    // bottomBar
		$str .= "<div class='bottomBar' style='float: right;'><span class='recessed'>funded by</span><br>";
		$str .= "<a href='https://ncats.nih.gov/ctsa'><img src='".self::link("/img/ctsa.png")."' style='height: 22px;'></a></div>";
		$str .= "</div>";    // bottomBar
		$str .= "</footer>";    // bottomFooter
		return $str;
	}

	# call REDCap's AutoLogin
	public static function keepAlive($pid) {
		if (!class_exists('\Auth')) {
			require_once APP_PATH_DOCROOT . 'Libraries/PEAR/Auth.php';
		}
		$oldPid = $_GET['pid'] ?? "";
		$_GET['pid'] = $pid;
		\Authentication::autoLogin(self::getUsername());
		if ($oldPid) {
			$_GET['pid'] = $oldPid;
		} else {
			unset($_GET['pid']);
		}
	}

	public static function isTable1Project($mypid = false) {
		if ($mypid === false) {
			$mypid = $_GET['pid'] ?? "";
		}
		return ($mypid == self::getTable1PID());
	}

	public static function getTable1Title() {
		return "Flight Tracker - NIH Training Table 1";
	}

	# gets the token for NIH Training Table 1
	public static function getTable1Token() {
		return self::getSystemSetting("table1Token");
	}

	# gets the project-id for NIH Training Table 1
	public static function getTable1PID() {
		$table1Pid = self::getSystemSetting("table1Pid");
		if ($table1Pid && REDCapManagement::isActiveProject($table1Pid)) {
			return $table1Pid;
		} else {
			$sql = "SELECT project_id FROM redcap_projects WHERE app_title = ? AND date_deleted IS NULL ORDER BY project_id LIMIT 1";
			$module = self::getModule();
			$q = $module->query($sql, [self::getTable1Title()]);
			if ($row = $q->fetch_assoc()) {
				$projectId = $row['project_id'];
				self::saveSystemSetting("table1Pid", $projectId);
				return $projectId;
			} else {
				return "";
			}
		}
	}

	public static function getTable1SurveyLink() {
		$pid = self::getTable1PID();
		if ($pid) {
			return REDCapManagement::getPublicSurveyLink($pid, "table_1_rows");
		}
		return "";
	}

	public static function makePublicSignupHTML($pid, $additionalClasses = ""): string {
		$surveyLink = REDCapManagement::getPublicSurveyLink($pid, "sign_up");
		return "<p class='centered max-width $additionalClasses'>
            <label for='signupUrl'>Public Signup Link: </label>
            <input id='signupUrl' value='$surveyLink' onclick='this.select();' readonly='readonly' style='width: 90%; max-width: 450px; margin-right: 5px; margin-left: 5px;' />
            <span class='smaller'><a href='javascript:;' onclick='copyToClipboard($(\"#signupUrl\"));'>Copy</a></span>
        </p>";
	}

	public static function getPids() {
		if (self::isVanderbilt()) {
			if (self::isExternalModule()) {
				$module = self::getModule();
				$allPids = $module ? $module->getPids() : [];
				$pids = [];
				foreach ($allPids as $pid) {
					if (!self::isTable1Project($pid) && !self::isSocialMediaProject($pid)) {
						$pids[] = $pid;
					}
				}
			} else {
				$pids = [];
				$prefix = CareerDev::getPrefix();
				$module = self::getModule();
				$sql = "
SELECT DISTINCT s.project_id AS pid
    FROM redcap_external_module_settings AS s
        INNER JOIN redcap_external_modules AS m
            ON m.external_module_id = s.external_module_id
    WHERE
        s.key = 'enabled'
      AND s.value='true'
      AND m.directory_prefix = ?";
				$q = $module->query($sql, [$prefix]);
				while ($row = $q->fetch_assoc()) {
					if ($row['pid'] && !self::isTable1Project($row['pid'])) {
						$pids[] = $row['pid'];
					}
				}
			}
		} else {
			$module = self::getModule();
			$pids = $module->getPids();
		}
		for ($i = 0; $i < count($pids); $i++) {
			$pids[$i] = (string) $pids[$i];
		}

		if (isset($_GET['match']) && is_string($_GET['match']) && preg_match("/:/", $_GET['match'])) {
			list($pid, $recordId) = explode(":", Sanitizer::sanitize($_GET['match']));
			if (!in_array($pid, $pids)) {
				return [];
			} else {
				return [$pid];
			}
		}
		return $pids;
	}

	public static function getActiveSourcePids() {
		$pids = self::getPids();
		$filteredPids = [];
		foreach ($pids as $pid) {
			if (
				REDCapManagement::isActiveProject($pid)
				&& !CareerDev::isCopiedProject($pid)
			) {
				$filteredPids[] = $pid;
			}
		}
		return $filteredPids;
	}

	public static function getMenteeAgreementLink($pid) {
		$defaultLink = self::link("mentor/intro.php", $pid, true);
		if (self::isPluginProject()) {
			if (isset($_GET['test'])) {
				echo "plugin project<br>";
			}
			global $info;
			if (isset($info['prod']) && Application::isVanderbilt()) {
				$sourcePid = $info['prod']['pid'];
				return self::link("mentor/intro.php", $sourcePid, true);
			} elseif (isset($info['localhost']) && Application::isLocalhost()) {
				$sourcePid = $info['localhost']['pid'];
				return self::link("mentor/intro.php", $sourcePid, true);
			}
			self::log("Warning! Could not find prod in info!");
		} elseif (CareerDev::isCopiedProject($pid)) {
			if ($sourcePid = CareerDev::getSourcePid($pid)) {
				return self::link("mentor/intro.php", $sourcePid, true);
			}
			self::log("Warning! Could not find sourcePid in copied project!");
		}
		return $defaultLink;
	}

	public static function isCopiedProject($tokenOrPid = "") {
		return CareerDev::isCopiedProject($tokenOrPid);
	}

	public static function getSourcePid($destPid) {
		return CareerDev::getSourcePid($destPid);
	}

	public static function getDefaultVanderbiltMenteeAgreementLink() {
		return "https://medschool.vanderbilt.edu/msci/current-trainees/resources-for-funding-research-and-grant-assistance/";
	}

	public static function getEmailName($record) {
		return CareerDev::getEmailName($record);
	}

	public static function getCitationFields($metadata) {
		return REDCapManagement::screenForFields($metadata, self::$citationFields);
	}

	public static function getCustomFields($metadata) {
		return REDCapManagement::screenForFields($metadata, self::$customFields);
	}

	public static function isSocialMediaProject($pid) {
		return Application::isVanderbilt() && ($pid == 163109);
	}

	public static function getExporterFields($metadata) {
		return REDCapManagement::screenForFields($metadata, CareerDev::$exporterFields);
	}

	public static function getServerEmail() {
		return $_SERVER['SSL_SERVER_S_DN_Email'] ?? "";
	}

	public static function isMSTP($pid = null) {
		if (!$pid) {
			$pid = CareerDev::getPid();
		}
		if (Application::isVanderbilt() && ($pid == 149668)) {    // TODO For now
			return true;
		}
		if (Application::isLocalhost() && ($pid == 17) && (self::getServerEmail() == "scott.j.pearson@vumc.org")) {
			return true;
		}
		return false;
	}

	public static function getMSTPHashFields() {
		$roles = self::getMSTPConfig();
		$fields = [];
		foreach (array_keys($roles) as $role) {
			$fields[] = self::MSTPRole2Field($role);
		}
		return $fields;
	}

	public static function MSTPRole2Field($role) {
		return "mstpidp_review_".$role."_hash";
	}

	public static function getMSTPConfig() {
		return [
			"advisor" => "Faculty College Advisor",
			"mentor" => "Research Mentor",
			"comentor" => "Research Co-Mentor"
		];
	}

	public static function getHelperInstitutions($pid) {
		$ary = [];
		if (Application::getSetting("omit_va", $pid) !== "1") {
			$ary[] = "Veterans Health Administration";
		}
		if (self::isVanderbilt()) {
			$ary[] = "Tennessee Valley Healthcare System";
		}
		return $ary;
	}

	public static function getInstitution($pid = null) {
		$insts = self::getInstitutions($pid);
		if (count($insts) > 0) {
			return $insts[0];
		}
		return "";
	}

	public static function hasComposer() {
		return file_exists(self::getComposerAutoloadLocation());
	}

	public static function isTestGroup($pid) {
		return CareerDev::isTestGroup($pid);
	}

	public static function writeHTMLToDoc($html, $filename) {
		if (self::hasComposer()) {
			require_once(self::getComposerAutoloadLocation());

			$html = str_replace("<br>", "<br/>", $html);
			$phpWord = new \PhpOffice\PhpWord\PhpWord();
			$section = $phpWord->addSection();
			\PhpOffice\PhpWord\Shared\Html::addHtml($section, $html);
			$filename = REDCapManagement::makeSafeFilename($filename);
			$phpWord->save($filename, 'Word2007', true);
		}
	}

	public static function getComposerAutoloadLocation() {
		return dirname(__FILE__)."/vendor/autoload.php";
	}

	public static function isWebBrowser() {
		return $_SERVER['REQUEST_URI'] ?? "";
	}

	public static function isLocalhost() {
		return CareerDev::isLocalhost();
	}

	public static function getModule() {
		return CareerDev::getModule();
	}

	public static function link($loc, $pid = "", $withWebroot = false) {
		return CareerDev::link($loc, $pid, $withWebroot);
	}

	public static function isExternalModule() {
		$module = self::getModule();
		if (!$module) {
			return false;
		}
		$moduleClassWithNamespaceNodes = explode("\\", get_class($module));
		$moduleClass = array_pop($moduleClassWithNamespaceNodes);
		return $moduleClass == "FlightTrackerExternalModule";
	}

	public static function getAllSettings($pid = "") {
		return CareerDev::getAllSettings($pid);
	}

	public static function increaseMemoryLimit($limit) {
		ini_set("memory_limit", $limit);
	}

	public static function increaseProcessingMax($hours) {
		require_once(APP_PATH_DOCROOT."Classes/System.php");

		\System::increaseMaxExecTime($hours * 3600);
	}

	public static function saveCurrentDate($setting, $pid) {
		CareerDev::saveCurrentDate($setting, $pid);
	}

	public static function getSettingKeys($pid) {
		if ($_GET['pid'] == $pid) {
			if ($module = self::getModule()) {
				$settings = $module->getProjectSettings($pid);
				return array_keys($settings);
			}
		} else {
			$prefix = CareerDev::getPrefix();
			$module = self::getModule();
			$sql = "SELECT DISTINCT(s.key) AS array_key
                            FROM redcap_external_module_settings AS s
                                INNER JOIN redcap_external_modules AS m
                                    ON m.external_module_id = s.external_module_id
                            WHERE m.directory_prefix = ?
                                AND s.project_id = ?";
			$q = $module->query($sql, [$prefix, $pid]);
			$keys = [];
			while ($row = $q->fetch_assoc($q)) {
				$keys[] = $row['array_key'];
			}
			return $keys;
		}
	}

	public static function getFlightTrackerModule() {
		if (self::isExternalModule()) {
			return self::getModule();
		} else {
			$prefix = CareerDev::getPrefix();
			return \ExternalModules\ExternalModules::getModuleInstance($prefix);
		}
	}

	public static function getPrefix() {
		return CareerDev::getPrefix();
	}

	public static function isServer($server) {
		return (SERVER_NAME == $server);
	}

	public static function getSetting($field, $pid = "") {
		return CareerDev::getSetting($field, $pid);
	}

	public static function isTestServer($pid) {
		if (Application::isLocalhost()) {
			return true;
		}
		if (!$pid) {
			$pids = Application::getPids();
			if (count($pids) > 1) {
				$pid = $pids[0];
			} else {
				return false;    // best guess
			}
		}
		$value = self::getSetting("server_class", $pid);
		# TODO may want to consider removing ""; also consider "dev" as an option if specified
		$testServerClasses = ["test", ""];
		return in_array($value, $testServerClasses);
	}

	public static function saveSetting($field, $value, $pid = "") {
		CareerDev::saveSetting($field, $value, $pid);
	}

	public static function getSites($all = true) {
		return CareerDev::getSites($all);
	}

	public static function getInternalKLength($pid = null) {
		return CareerDev::getInternalKLength($pid);
	}

	public static function getK12KL2Length($pid = null) {
		return CareerDev::getK12KL2Length($pid);
	}


	public static function getIndividualKLength($pid = null) {
		return CareerDev::getIndividualKLength($pid);
	}

	public static function getProjectUsers($pid) {
		return array_keys(\User::getProjectUsernames([], false, $pid));
	}

	public static function getScholarPortalLink() {
		return self::link("portal/index.php");
	}

	public static function applySecurityHeaders($pid) {
		$serverList = Application::getSetting("safe_servers", $pid);
		if (!$serverList) {
			return;
		}
		$servers = preg_split("/\s*,\s*/", $serverList);
		foreach ($servers as $server) {
			if (trim($server) !== "*") {
				header('Access-Control-Allow-Origin: https://'.$server);
				if (!preg_match("/^www\./", $server)) {
					header('Access-Control-Allow-Origin: https://www.'.$server);
				}
			}
		}

	}

	public static function str_lreplace($search, $replace, $subject) {
		$pos = strrpos($subject, $search);

		if ($pos !== false) {
			$subject = substr_replace($subject, $replace, $pos, strlen($search));
		}

		return $subject;
	}

	public static $institutionFields = [
		"record_id",
		"identifier_institution",
		"identifier_institution_source",
		"identifier_institution_sourcetype",
		"identifier_left_job_title",
		"identifier_left_date",
		"identifier_left_date_source",
		"identifier_left_date_sourcetype",
		"identifier_left_job_category",
		"promotion_institution",
		"promotion_date",
		"promotion_in_effect",
	];

	public static $summaryFields = [
		"record_id",
		"identifier_first_name",
		"identifier_last_name",
		"identifier_email",
		"identifier_email_source",
		"identifier_email_sourcetype",
		"identifier_userid",
		"identifier_institution",
		"identifier_institution_source",
		"identifier_institution_sourcetype",
		"identifier_left_job_title",
		"identifier_left_date",
		"identifier_left_date_source",
		"identifier_left_date_sourcetype",
		"identifier_left_job_category",
		"summary_degrees",
		"summary_primary_dept",
		"summary_gender",
		"summary_race_ethnicity",
		"summary_current_rank",
		"summary_dob",
		"summary_citizenship",
		"summary_urm",
		"summary_disability",
		"summary_disadvantaged",
		"summary_training_start",
		"summary_training_end",
		"summary_ever_internal_k",
		"summary_ever_individual_k_or_equiv",
		"summary_ever_k12_kl2",
		"summary_ever_r01_or_equiv",
		"summary_ever_external_k_to_r01_equiv",
		"summary_ever_last_external_k_to_r01_equiv",
		"summary_ever_first_any_k_to_r01_equiv",
		"summary_ever_last_any_k_to_r01_equiv",
		"summary_first_any_k",
		"summary_first_external_k",
		"summary_last_any_k",
		"summary_last_external_k",
		"summary_survey",
		"summary_publication_count",
		"summary_total_budgets",
		"summary_award_source_1",
		"summary_award_date_1",
		"summary_award_end_date_1",
		"summary_award_type_1",
		"summary_award_title_1",
		"summary_award_sponsorno_1",
		"summary_award_age_1",
		"summary_award_nih_mechanism_1",
		"summary_award_total_budget_1",
		"summary_award_direct_budget_1",
		"summary_award_percent_effort_1",
		"summary_award_role_1",
		"summary_award_source_2",
		"summary_award_date_2",
		"summary_award_end_date_2",
		"summary_award_type_2",
		"summary_award_title_2",
		"summary_award_sponsorno_2",
		"summary_award_age_2",
		"summary_award_nih_mechanism_2",
		"summary_award_total_budget_2",
		"summary_award_direct_budget_2",
		"summary_award_percent_effort_2",
		"summary_award_role_2",
		"summary_award_source_3",
		"summary_award_date_3",
		"summary_award_end_date_3",
		"summary_award_type_3",
		"summary_award_title_3",
		"summary_award_sponsorno_3",
		"summary_award_age_3",
		"summary_award_nih_mechanism_3",
		"summary_award_total_budget_3",
		"summary_award_direct_budget_3",
		"summary_award_percent_effort_3",
		"summary_award_role_3",
		"summary_award_source_4",
		"summary_award_date_4",
		"summary_award_end_date_4",
		"summary_award_type_4",
		"summary_award_title_4",
		"summary_award_sponsorno_4",
		"summary_award_age_4",
		"summary_award_nih_mechanism_4",
		"summary_award_total_budget_4",
		"summary_award_direct_budget_4",
		"summary_award_percent_effort_4",
		"summary_award_role_4",
		"summary_award_source_5",
		"summary_award_date_5",
		"summary_award_end_date_5",
		"summary_award_type_5",
		"summary_award_title_5",
		"summary_award_sponsorno_5",
		"summary_award_age_5",
		"summary_award_nih_mechanism_5",
		"summary_award_total_budget_5",
		"summary_award_direct_budget_5",
		"summary_award_percent_effort_5",
		"summary_award_role_5",
		"summary_award_source_6",
		"summary_award_date_6",
		"summary_award_end_date_6",
		"summary_award_type_6",
		"summary_award_title_6",
		"summary_award_sponsorno_6",
		"summary_award_age_6",
		"summary_award_nih_mechanism_6",
		"summary_award_total_budget_6",
		"summary_award_direct_budget_6",
		"summary_award_percent_effort_6",
		"summary_award_role_6",
		"summary_award_source_7",
		"summary_award_date_7",
		"summary_award_end_date_7",
		"summary_award_type_7",
		"summary_award_title_7",
		"summary_award_sponsorno_7",
		"summary_award_age_7",
		"summary_award_nih_mechanism_7",
		"summary_award_total_budget_7",
		"summary_award_total_budget_7",
		"summary_award_direct_budget_7",
		"summary_award_percent_effort_7",
		"summary_award_role_7",
		"summary_award_source_8",
		"summary_award_date_8",
		"summary_award_end_date_8",
		"summary_award_type_8",
		"summary_award_title_8",
		"summary_award_sponsorno_8",
		"summary_award_age_8",
		"summary_award_nih_mechanism_8",
		"summary_award_total_budget_8",
		"summary_award_direct_budget_8",
		"summary_award_percent_effort_8",
		"summary_award_role_8",
		"summary_award_source_9",
		"summary_award_date_9",
		"summary_award_end_date_9",
		"summary_award_type_9",
		"summary_award_title_9",
		"summary_award_sponsorno_9",
		"summary_award_age_9",
		"summary_award_nih_mechanism_9",
		"summary_award_total_budget_9",
		"summary_award_direct_budget_9",
		"summary_award_percent_effort_9",
		"summary_award_role_9",
		"summary_award_source_10",
		"summary_award_date_10",
		"summary_award_end_date_10",
		"summary_award_type_10",
		"summary_award_title_10",
		"summary_award_sponsorno_10",
		"summary_award_age_10",
		"summary_award_nih_mechanism_10",
		"summary_award_total_budget_10",
		"summary_award_direct_budget_10",
		"summary_award_percent_effort_10",
		"summary_award_role_10",
		"summary_award_source_11",
		"summary_award_date_11",
		"summary_award_end_date_11",
		"summary_award_type_11",
		"summary_award_title_11",
		"summary_award_sponsorno_11",
		"summary_award_age_11",
		"summary_award_nih_mechanism_11",
		"summary_award_total_budget_11",
		"summary_award_direct_budget_11",
		"summary_award_percent_effort_11",
		"summary_award_role_11",
		"summary_award_source_12",
		"summary_award_date_12",
		"summary_award_end_date_12",
		"summary_award_type_12",
		"summary_award_title_12",
		"summary_award_sponsorno_12",
		"summary_award_age_12",
		"summary_award_nih_mechanism_12",
		"summary_award_total_budget_12",
		"summary_award_direct_budget_12",
		"summary_award_percent_effort_12",
		"summary_award_role_12",
		"summary_award_source_13",
		"summary_award_date_13",
		"summary_award_end_date_13",
		"summary_award_type_13",
		"summary_award_title_13",
		"summary_award_sponsorno_13",
		"summary_award_age_13",
		"summary_award_nih_mechanism_13",
		"summary_award_total_budget_13",
		"summary_award_direct_budget_13",
		"summary_award_percent_effort_13",
		"summary_award_role_13",
		"summary_award_source_14",
		"summary_award_date_14",
		"summary_award_end_date_14",
		"summary_award_type_14",
		"summary_award_title_14",
		"summary_award_sponsorno_14",
		"summary_award_age_14",
		"summary_award_nih_mechanism_14",
		"summary_award_total_budget_14",
		"summary_award_direct_budget_14",
		"summary_award_percent_effort_14",
		"summary_award_role_14",
		"summary_award_source_15",
		"summary_award_date_15",
		"summary_award_end_date_15",
		"summary_award_type_15",
		"summary_award_title_15",
		"summary_award_sponsorno_15",
		"summary_award_age_15",
		"summary_award_nih_mechanism_15",
		"summary_award_total_budget_15",
		"summary_award_direct_budget_15",
		"summary_award_percent_effort_15",
		"summary_award_role_15",
		"summary_first_external_k",
		"summary_first_any_k",
		"summary_first_r01",
		"summary_first_k_to_first_r01",
		"summary_first_any_k_to_first_r01",
	];

	# intentionally missing many minor Altmetric fields
	public static $citationFields = [
		"record_id",
		"citation_pmid",
		"citation_doi",
		"citation_include",
		"citation_flagged",
		"citation_ts",
		"citation_full_citation",
		"citation_source",
		"citation_pmcid",
		"citation_authors",
		"citation_title",
		"citation_pub_types",
		"citation_mesh_terms",
		"citation_pubmed_keywords",
		"citation_journal",
		"citation_volume",
		"citation_issue",
		"citation_year",
		"citation_month",
		"citation_day",
		"citation_date",
		"citation_pages",
		"citation_affiliations",
		"citation_grants",
		"citation_abstract",
		"citation_pilot_grants",
		"citation_is_research",
		"citation_num_citations",
		"citation_citations_per_year",
		"citation_expected_per_year",
		"citation_field_citation_rate",
		"citation_nih_percentile",
		"citation_rcr",
		"citation_icite_last_update",
		"citation_altmetric_score",
		"citation_altmetric_image",
		"citation_altmetric_details_url",
		"citation_altmetric_last_update",
		"eric_id",
		"eric_link",
		"eric_include",
		"eric_author",
		"eric_description",
		"eric_isbn",
		"eric_issn",
		"eric_peerreviewed",
		"eric_publicationdateyear",
		"eric_publicationtype",
		"eric_publisher",
		"eric_subject",
		"eric_title",
		"eric_sourceid",
		"eric_source",
		"eric_sponsor",
		"eric_url",
		"eric_institution",
		"eric_iesgrantcontractnum",
		"eric_ieswwcreviewed",
		"eric_e_datemodified",
		"eric_e_fulltext",
		"eric_educationlevel",
		"eric_pilot_grants",
		"eric_last_update",
	];

	public static $customFields = [
		"record_id",
		"custom_title",
		"custom_number",
		"custom_type",
		"custom_start",
		"custom_end",
		"custom_org",
		"custom_recipient_org",
		"custom_role",
		"custom_role_other",
		"custom_start",
		"custom_end",
		"custom_costs",
		"custom_last_update",
		"custom_submission_status",
		"custom_submission_date",
		"custom_flagged",
	];

	public static $positionFields = [
		"record_id",
		"promotion_in_effect",
		"promotion_job_title",
		"promotion_job_category",
		"promotion_rank",
		"promotion_institution",
		"promotion_location",
		"promotion_department",
		"promotion_department_other",
		"promotion_division",
		"promotion_date",
	];
}