[locations] Modularize additional column handling

Additional columns are now added through a hook,
moving specialized code where it belongs.

1 files changed, 40 insertions, 130 deletions

diff --git a/modules-available/locations/pages/locations.inc.php b/modules-available/locations/pages/locations.inc.php
index ce08e597..0eb035c8 100644
--- a/modules-available/locations/pages/locations.inc.php
+++ b/modules-available/locations/pages/locations.inc.php
@@ -93,126 +93,43 @@ class SubPage
 		$unassignedIdle = $unassignedLoad = $unassignedOverrides = 0;
 
 		$allowedLocationIds = User::getAllowedLocations("location.view");
-		foreach (array_keys($locationList) as $lid) {
-			if (!User::hasPermission('.baseconfig.view', $lid)) {
-				$locationList[$lid]['havebaseconfig'] = false;
-			}
-			if (!User::hasPermission('.sysconfig.config.view-list', $lid)) {
-				$locationList[$lid]['havesysconfig'] = false;
-			}
-			if (!User::hasPermission('.statistics.view.list', $lid)) {
-				$locationList[$lid]['havestatistics'] = false;
-			}
-			if (!User::hasPermission('.serversetup.ipxe.menu.assign', $lid)) {
-				$locationList[$lid]['haveipxe'] = false;
-			}
-			if (!in_array($lid, $allowedLocationIds)) {
-				$locationList[$lid]['show-only'] = true;
-			}
-		}
 
-		// Client statistics
-		if (Module::get('statistics') !== false) {
-			$unassigned = 0;
-			$extra = '';
-			if (in_array(0, $allowedLocationIds)) {
-				$extra = ' OR locationid IS NULL';
-			}
-			$res = Database::simpleQuery("SELECT m.locationid, Count(*) AS cnt,
-       		Sum(If(m.state = 'OCCUPIED', 1, 0)) AS used, Sum(If(m.state = 'IDLE', 1, 0)) AS idle
- 				 FROM machine m WHERE (locationid IN (:allowedLocationIds) $extra) GROUP BY locationid", compact('allowedLocationIds'));
-			foreach ($res as $row) {
-				$locId = (int)$row['locationid'];
-				if (isset($locationList[$locId])) {
-					$locationList[$locId]['clientCount'] = $row['cnt'];
-					$locationList[$locId]['clientLoad'] = round(100 * $row['used'] / $row['cnt']);
-					$locationList[$locId]['clientIdle'] = round(100 * ($row['used'] + $row['idle']) / $row['cnt']);
-				} else {
-					$unassigned += $row['cnt'];
-					$unassignedLoad += $row['used'];
-					$unassignedIdle += $row['idle'];
-				}
-			}
-			$res = Database::simpleQuery("SELECT m.locationid, Count(DISTINCT sm.machineuuid) AS cnt FROM setting_machine sm
-				INNER JOIN machine m USING (machineuuid) GROUP BY m.locationid");
-			foreach ($res as $row) {
-				$locId = (int)$row['locationid'];
-				if (isset($locationList[$locId])) {
-					$locationList[$locId]['machineVarsOverrideCount'] = $row['cnt'];
-				} else {
-					$unassignedOverrides += $row['cnt'];
-				}
-			}
-			unset($loc);
-			foreach ($locationList as &$loc) {
-				if (!in_array($loc['locationid'], $allowedLocationIds))
-					continue;
-				if (!isset($loc['clientCountSum'])) {
-					$loc['clientCountSum'] = 0;
-				}
-				if (!isset($loc['clientCount'])) {
-					$loc['clientCount'] = $loc['clientIdle'] = $loc['clientLoad'] = 0;
-				}
-				$loc['clientCountSum'] += $loc['clientCount'];
-				foreach ($loc['parents'] as $pid) {
-					if (!in_array($pid, $allowedLocationIds))
-						continue;
-					$locationList[(int)$pid]['hasChild'] = true;
-					$locationList[(int)$pid]['clientCountSum'] += $loc['clientCount'];
-				}
-			}
-			unset($loc);
-
-		}
-		// Show currently active sysconfig for each location
-		$defaultConfig = false;
-		if (Module::isAvailable('sysconfig')) {
-			$confs = SysConfig::getAll();
-			foreach ($confs as $conf) {
-				if (strlen($conf['locs']) === 0)
-					continue;
-				$confLocs = explode(',', $conf['locs']);
-				foreach ($confLocs as $locId) {
-					settype($locId, 'int');
-					if ($locId === 0) {
-						$defaultConfig = $conf['title'];
+		$plugins = [];
+		foreach (Hook::load('locations-column') as $hook) {
+			$c = @include($hook->file);
+			if ($c instanceof AbstractLocationColumn) {
+				$plugins[sprintf('%04d.%s', $c->priority(), $hook->moduleId)] = $c;
+			} elseif (is_array($c)) {
+				foreach ($c as $i => $cc) {
+					if ($cc instanceof AbstractLocationColumn) {
+						$plugins[sprintf('%04d.%d.%s', $cc->priority(), $i, $hook->moduleId)] = $cc;
 					}
-					if (!isset($locationList[$locId]))
-						continue;
-					$locationList[$locId] += array('configName' => $conf['title'], 'configClass' => 'slx-bold');
 				}
 			}
-			self::propagateFields($locationList, $defaultConfig, 'configName', 'configClass');
 		}
-		// Count overridden config vars
-		if (Module::get('baseconfig') !== false) {
-			$res = Database::simpleQuery("SELECT locationid, Count(*) AS cnt FROM `setting_location`
- 					WHERE locationid IN (:allowedLocationIds) GROUP BY locationid", compact('allowedLocationIds'));
-			foreach ($res as $row) {
-				$lid = (int)$row['locationid'];
-				if (isset($locationList[$lid])) {
-					$locationList[$lid]['overriddenVars'] = $row['cnt'];
-				}
+		ksort($plugins);
+		foreach ($locationList as $lid => &$loc) {
+			$loc['plugins'] = [];
+			foreach ($plugins as $pk => $plugin) {
+				$loc['plugins'][$pk] = [
+					'url' => $plugin->getEditUrl($lid),
+					'html' => $plugin->getColumnHtml($lid),
+				];
+			}
+			if (!in_array($lid, $allowedLocationIds)) {
+				$locationList[$lid]['show-only'] = true;
 			}
-			// Confusing because the count might be inaccurate within a branch
-			//$this->propagateFields($locationList, '', 'overriddenVars', 'overriddenClass');
 		}
-		// Show ipxe menu
-		if (Module::isAvailable('serversetup') && class_exists('IPxe')) {
-			$res = Database::simpleQuery("SELECT ml.locationid, m.title, ml.defaultentryid FROM serversetup_menu m
-				INNER JOIN serversetup_menu_location ml USING (menuid)
-				WHERE locationid IN (:allowedLocationIds) GROUP BY locationid", compact('allowedLocationIds'));
-			foreach ($res as $row) {
-				$lid = (int)$row['locationid'];
-				if (isset($locationList[$lid])) {
-					if ($row['defaultentryid'] !== null) {
-						$row['title'] .= '(*)';
-					}
-					$locationList[$lid]['customMenu'] = $row['title'];
-				}
+		unset($loc);
+		foreach ($plugins as $pk => $plugin) {
+			if ($plugin->propagateColumn()) {
+				self::propagateFields($locationList, $plugin->propagateDefaultHtml(), $pk);
 			}
-			self::propagateFields($locationList, '', 'customMenu', 'customMenuClass');
 		}
+		foreach ($locationList as &$loc) {
+			$loc['plugins'] = array_values($loc['plugins']);
+		}
+		unset($loc);
 
 		$addAllowedLocs = User::getAllowedLocations("location.add");
 		$addAllowedList = Location::getLocations(0, 0, true);
@@ -224,44 +141,37 @@ class SubPage
 		unset($loc);
 
 		// Output
-		$data = array(
+		$data = [
+			'colspan' => (2 + count($plugins)),
+			'plugins' => array_values($plugins),
 			'list' => array_values($locationList),
-			'havestatistics' => Module::get('statistics') !== false,
-			'havebaseconfig' => Module::get('baseconfig') !== false,
-			'havesysconfig' => Module::get('sysconfig') !== false,
-			'haveipxe' => Module::isAvailable('serversetup') && class_exists('IPxe'),
 			'overlapSelf' => $overlapSelf,
 			'overlapOther' => $overlapOther,
 			'mismatchMachines' => $mismatchMachines,
-			'unassignedCount' => $unassigned,
-			'unassignedLoad' => ($unassigned ? (round(($unassignedLoad / $unassigned) * 100)) : ''),
-			'unassignedIdle' => ($unassigned ? (round((($unassignedLoad + $unassignedIdle) / $unassigned) * 100)) : ''),
-			'unassignedOverrides' => $unassignedOverrides,
-			'defaultConfig' => $defaultConfig,
 			'addAllowedList' => array_values($addAllowedList),
-		);
-		// TODO: Buttons for config vars and sysconfig are currently always shown, as their availability
-		// depends on permissions in the according modules, not this one
+		];
 		Permission::addGlobalTags($data['perms'], NULL, ['subnets.edit', 'location.add']);
 		Render::addTemplate('locations', $data);
 		Module::isAvailable('js_ip'); // For CIDR magic
 	}
 
-	private static function propagateFields(&$locationList, $defaultValue, $name, $class)
+	private static function propagateFields(array &$locationList, string $defaultValue, string $plugin)
 	{
 		$depth = array();
 		foreach ($locationList as &$loc) {
 			$d = $loc['depth'];
-			if (!isset($loc[$name])) {
+			if (empty($loc['plugins'][$plugin]['html'])) {
 				// Has no explicit config assignment
 				if ($d === 0) {
-					$loc[$name] = $defaultValue;
+					$loc['plugins'][$plugin]['html'] = $defaultValue;
 				} else {
-					$loc[$name] = $depth[$d - 1];
+					$loc['plugins'][$plugin]['html'] = $depth[$d - 1];
 				}
-				$loc[$class] = 'gray';
+				$loc['plugins'][$plugin]['class'] = 'gray';
+			} elseif (empty($loc['plugins'][$plugin]['class'])) {
+				$loc['plugins'][$plugin]['class'] = 'slx-bold';
 			}
-			$depth[$d] = $loc[$name];
+			$depth[$d] = $loc['plugins'][$plugin]['html'];
 			unset($depth[$d + 1]);
 		}
 	}