Ongoing sim/server refactor

- Moved everything scenario-related to server; sim is now unaware of all that;
  Sim creation is now entirely driven by a new NewSimConfiguration struct that
  collects all of the individual things that it needs.
- Cleaned up duplicate state in sim.Sim and sim.State
- Client/server dance for Sim creation is better isolated, now handled via
  a (currently confusingly named) server.NewSimConfiguration struct that
  is passed between them.

Author: mmp

launch.go

@@ -37,9 +37,12 @@ var (
 )
 
 type NewSimConfiguration struct {
-	sim.NewSimConfiguration
+	server.NewSimConfiguration
+
+	TRACON map[string]*server.Configuration
+
+	DisplayError error
 
-	// Local use only; not sent to the server when we create one.
 	lastRemoteSimsUpdate time.Time
 	updateRemoteSimsCall *util.PendingCall
 
@@ -57,7 +60,7 @@ func MakeNewSimConfiguration(mgr *server.ConnectionManager, defaultTRACON *strin
 		selectedServer:      mgr.LocalServer,
 		defaultTRACON:       defaultTRACON,
 		tfrCache:            tfrCache,
-		NewSimConfiguration: sim.MakeNewSimConfiguration(),
+		NewSimConfiguration: server.MakeNewSimConfiguration(),
 	}
 
 	c.SetTRACON(*defaultTRACON)
@@ -110,7 +113,7 @@ func (c *NewSimConfiguration) SetTRACON(name string) {
 
 func (c *NewSimConfiguration) SetScenario(groupName, scenarioName string) {
 	var ok bool
-	var groupConfig *sim.Configuration
+	var groupConfig *server.Configuration
 	if groupConfig, ok = c.TRACON[groupName]; !ok {
 		c.lg.Errorf("%s: group not found in TRACON %s", groupName, c.TRACONName)
 		groupName = util.SortedMapKeys(c.TRACON)[0]
@@ -129,11 +132,11 @@ func (c *NewSimConfiguration) SetScenario(groupName, scenarioName string) {
 }
 
 func (c *NewSimConfiguration) UIButtonText() string {
-	return util.Select(c.NewSimType == sim.NewSimJoinRemote, "Join", "Next")
+	return util.Select(c.NewSimType == server.NewSimJoinRemote, "Join", "Next")
 }
 
 func (c *NewSimConfiguration) ShowRatesWindow() bool {
-	return c.NewSimType == sim.NewSimCreateLocal || c.NewSimType == sim.NewSimCreateRemote
+	return c.NewSimType == server.NewSimCreateLocal || c.NewSimType == server.NewSimCreateRemote
 }
 
 func (c *NewSimConfiguration) DrawUI(p platform.Platform) bool {
@@ -164,8 +167,8 @@ func (c *NewSimConfiguration) DrawUI(p platform.Platform) bool {
 			origType := c.NewSimType
 
 			imgui.TableNextColumn()
-			if imgui.RadioButtonInt("Create single-controller", &c.NewSimType, sim.NewSimCreateLocal) &&
-				origType != sim.NewSimCreateLocal {
+			if imgui.RadioButtonInt("Create single-controller", &c.NewSimType, server.NewSimCreateLocal) &&
+				origType != server.NewSimCreateLocal {
 				c.selectedServer = c.mgr.LocalServer
 				c.SetTRACON(*c.defaultTRACON)
 				c.DisplayError = nil
@@ -174,8 +177,8 @@ func (c *NewSimConfiguration) DrawUI(p platform.Platform) bool {
 			imgui.TableNextRow()
 			imgui.TableNextColumn()
 			imgui.TableNextColumn()
-			if imgui.RadioButtonInt("Create multi-controller", &c.NewSimType, sim.NewSimCreateRemote) &&
-				origType != sim.NewSimCreateRemote {
+			if imgui.RadioButtonInt("Create multi-controller", &c.NewSimType, server.NewSimCreateRemote) &&
+				origType != server.NewSimCreateRemote {
 				c.selectedServer = c.mgr.RemoteServer
 				c.SetTRACON(*c.defaultTRACON)
 				c.DisplayError = nil
@@ -186,8 +189,8 @@ func (c *NewSimConfiguration) DrawUI(p platform.Platform) bool {
 			imgui.TableNextColumn()
 
 			uiStartDisable(len(c.mgr.RemoteServer.GetRunningSims()) == 0)
-			if imgui.RadioButtonInt("Join multi-controller", &c.NewSimType, sim.NewSimJoinRemote) &&
-				origType != sim.NewSimJoinRemote {
+			if imgui.RadioButtonInt("Join multi-controller", &c.NewSimType, server.NewSimJoinRemote) &&
+				origType != server.NewSimJoinRemote {
 				c.selectedServer = c.mgr.RemoteServer
 				c.DisplayError = nil
 			}
@@ -200,11 +203,11 @@ func (c *NewSimConfiguration) DrawUI(p platform.Platform) bool {
 		imgui.Text("Unable to connect to the multi-controller vice server; " +
 			"only single-player scenarios are available.")
 		imgui.PopStyleColor()
-		c.NewSimType = sim.NewSimCreateLocal
+		c.NewSimType = server.NewSimCreateLocal
 	}
 	imgui.Separator()
 
-	if c.NewSimType == sim.NewSimCreateLocal || c.NewSimType == sim.NewSimCreateRemote {
+	if c.NewSimType == server.NewSimCreateLocal || c.NewSimType == server.NewSimCreateRemote {
 		flags := imgui.TableFlagsBordersV | imgui.TableFlagsBordersOuterH | imgui.TableFlagsRowBg |
 			imgui.TableFlagsSizingStretchProp
 		tableScale := util.Select(runtime.GOOS == "windows", p.DPIScale(), float32(1))
@@ -291,7 +294,7 @@ func (c *NewSimConfiguration) DrawUI(p platform.Platform) bool {
 		}
 
 		if imgui.BeginTableV("scenario", 2, 0, imgui.Vec2{tableScale * 500, 0}, 0.) {
-			if c.NewSimType == sim.NewSimCreateRemote {
+			if c.NewSimType == server.NewSimCreateRemote {
 				imgui.TableNextRow()
 				imgui.TableNextColumn()
 				imgui.Text("Name:")
@@ -342,7 +345,7 @@ func (c *NewSimConfiguration) DrawUI(p platform.Platform) bool {
 			}
 			uiEndDisable(!validAirport)
 
-			if c.NewSimType == sim.NewSimCreateRemote {
+			if c.NewSimType == server.NewSimCreateRemote {
 				imgui.Checkbox("Require Password", &c.RequirePassword)
 				if c.RequirePassword {
 					imgui.InputTextV("Password", &c.Password, 0, nil)
@@ -585,7 +588,7 @@ func refreshWeather() {
 }
 
 func (c *NewSimConfiguration) OkDisabled() bool {
-	return c.NewSimType == sim.NewSimCreateRemote && (c.NewSimName == "" || (c.RequirePassword && c.Password == ""))
+	return c.NewSimType == server.NewSimCreateRemote && (c.NewSimName == "" || (c.RequirePassword && c.Password == ""))
 }
 
 func (c *NewSimConfiguration) Start() error {
@@ -993,7 +996,7 @@ func (lc *LaunchControlWindow) Draw(eventStream *sim.EventStream, p platform.Pla
 		//	imgui.SetCursorPos(imgui.Vec2{imgui.CursorPosX() + imgui.ContentRegionAvail().X - float32(3*width+10),
 		imgui.SetCursorPos(imgui.Vec2{imgui.WindowWidth() - float32(7*width), imgui.CursorPosY()})
 		if lc.controlClient != nil && lc.controlClient.Connected() {
-			if lc.controlClient.SimIsPaused {
+			if lc.controlClient.State.Paused {
 				if imgui.Button(renderer.FontAwesomeIconPlayCircle) {
 					lc.controlClient.ToggleSimPause()
 				}

main.go

@@ -92,7 +92,7 @@ func main() {
 	if *lintScenarios {
 		var e util.ErrorLogger
 		scenarioGroups, _, _ :=
-			sim.LoadScenarioGroups(true, *scenarioFilename, *videoMapFilename, &e, lg)
+			server.LoadScenarioGroups(true, *scenarioFilename, *videoMapFilename, &e, lg)
 
 		videoMaps := make(map[string]interface{})
 		for _, sgs := range scenarioGroups {

pkg/panes/stars/commands.go

@@ -1641,15 +1641,15 @@ func (sp *STARSPane) executeSTARSCommand(cmd string, ctx *panes.Context) (status
 		} else if len(cmd) > 0 {
 			// Index, character id, or name
 			if i, err := strconv.Atoi(cmd); err == nil {
-				if i < 0 || i >= len(ctx.ControlClient.RadarSites) {
+				if i < 0 || i >= len(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites) {
 					status.err = ErrSTARSIllegalValue
 				} else {
-					ps.RadarSiteSelected = util.SortedMapKeys(ctx.ControlClient.RadarSites)[i]
+					ps.RadarSiteSelected = util.SortedMapKeys(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites)[i]
 					status.clear = true
 				}
 				return
 			}
-			for id, rs := range ctx.ControlClient.RadarSites {
+			for id, rs := range ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites {
 				if cmd == rs.Char || cmd == id {
 					ps.RadarSiteSelected = id
 					status.clear = true
@@ -3842,7 +3842,7 @@ func (sp *STARSPane) consumeMouseEvents(ctx *panes.Context, ghosts []*av.GhostAi
 				state.IsSelected = !state.IsSelected
 			}
 		}
-	} else if !ctx.ControlClient.SimIsPaused {
+	} else if !ctx.ControlClient.State.Paused {
 		switch sp.currentPrefs().DwellMode {
 		case DwellModeOff:
 			sp.dwellAircraft = ""

pkg/panes/stars/datablock.go

@@ -1197,7 +1197,7 @@ func (sp *STARSPane) getDatablockAlerts(ctx *panes.Context, ac *av.Aircraft, dbt
 	}
 
 	// Both FDB and PDB
-	if sp.radarMode(ctx.ControlClient.RadarSites) == RadarModeFused &&
+	if sp.radarMode(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites) == RadarModeFused &&
 		ac.TrackingController != "" && ac.PilotReportedAltitude == 0 &&
 		(ac.Mode != av.Altitude || ac.InhibitModeCAltitudeDisplay) {
 		// No altitude being reported, one way or another (off or mode

pkg/panes/stars/dcb.go

@@ -252,8 +252,8 @@ func (sp *STARSPane) drawDCB(ctx *panes.Context, transforms ScopeTransformations
 		}
 		unsupportedButton(ctx, "MODE\nFSL", buttonFull, buttonScale)
 
-		site := sp.radarSiteId(ctx.ControlClient.RadarSites)
-		if len(ctx.ControlClient.RadarSites) == 0 {
+		site := sp.radarSiteId(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites)
+		if len(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites) == 0 {
 			disabledButton(ctx, "SITE\n"+site, maybeDisable(buttonFull), buttonScale)
 		} else if selectButton(ctx, "SITE\n"+site, maybeDisable(buttonFull), buttonScale) {
 			sp.activeDCBMenu = dcbMenuSite
@@ -443,11 +443,12 @@ func (sp *STARSPane) drawDCB(ctx *panes.Context, transforms ScopeTransformations
 	}
 
 	if sp.activeDCBMenu == dcbMenuSite {
-		rewindDCBCursor(3+len(ctx.ControlClient.RadarSites)+3, buttonScale)
+		radarSites := ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites
+		rewindDCBCursor(3+len(radarSites)+3, buttonScale)
 		dcbStartCaptureMouseRegion()
 
-		for _, id := range util.SortedMapKeys(ctx.ControlClient.RadarSites) {
-			site := ctx.ControlClient.RadarSites[id]
+		for _, id := range util.SortedMapKeys(radarSites) {
+			site := radarSites[id]
 			label := " " + site.Char + " " + "\n" + id
 			selected := ps.RadarSiteSelected == id
 			if toggleButton(ctx, label, &selected, buttonFull, buttonScale) {
@@ -458,15 +459,15 @@ func (sp *STARSPane) drawDCB(ctx *panes.Context, transforms ScopeTransformations
 				}
 			}
 		}
-		multi := sp.radarMode(ctx.ControlClient.RadarSites) == RadarModeMulti
+		multi := sp.radarMode(radarSites) == RadarModeMulti
 		if toggleButton(ctx, "MULTI", &multi, buttonFull, buttonScale) && multi {
 			ps.RadarSiteSelected = ""
 			if ps.FusedRadarMode {
 				sp.discardTracks = true
 			}
 			ps.FusedRadarMode = false
 		}
-		fused := sp.radarMode(ctx.ControlClient.RadarSites) == RadarModeFused
+		fused := sp.radarMode(radarSites) == RadarModeFused
 		if toggleButton(ctx, "FUSED", &fused, buttonFull, buttonScale) && fused {
 			ps.RadarSiteSelected = ""
 			ps.FusedRadarMode = true

pkg/panes/stars/lists.go

@@ -265,7 +265,7 @@ func (sp *STARSPane) drawSSAList(ctx *panes.Context, pw [2]float32, aircraft []*
 			}
 		}
 		if filter.All || filter.Radar {
-			pw = td.AddText(sp.radarSiteId(ctx.ControlClient.RadarSites), pw, listStyle)
+			pw = td.AddText(sp.radarSiteId(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites), pw, listStyle)
 		}
 		newline()
 	}

pkg/panes/stars/prefs.go

@@ -306,8 +306,8 @@ func (p *Preferences) Reset(ss sim.State, sp *STARSPane) {
 
 	// Make the scenario's default video maps visible
 	p.VideoMapVisible = make(map[int]interface{})
-	_, defaultVideoMaps := ss.GetControllerVideoMaps()
-	for _, dm := range defaultVideoMaps {
+
+	for _, dm := range ss.ControllerDefaultVideoMaps {
 		if idx := slices.IndexFunc(sp.allVideoMaps, func(v av.VideoMap) bool { return v.Name == dm }); idx != -1 {
 			p.VideoMapVisible[sp.allVideoMaps[idx].Id] = nil
 		} else {

pkg/panes/stars/stars.go

@@ -221,8 +221,6 @@ type STARSPane struct {
 		overflights map[string]map[int]bool               // group->index
 		airspace    map[string]map[string]bool            // ctrl -> volume name
 	}
-
-	mapLibrary *av.VideoMapLibrary // just cached per session; not saved to disk.
 }
 
 type PointOutControllers struct {
@@ -462,8 +460,6 @@ func (sp *STARSPane) ResetSim(client *server.ControlClient, ss sim.State, pl pla
 	clear(sp.scopeDraw.departures)
 	clear(sp.scopeDraw.overflights)
 	clear(sp.scopeDraw.airspace)
-
-	sp.mapLibrary = nil
 }
 
 func (sp *STARSPane) makeMaps(client *server.ControlClient, ss sim.State, lg *log.Logger) {
@@ -490,9 +486,8 @@ func (sp *STARSPane) makeMaps(client *server.ControlClient, ss sim.State, lg *lo
 	}
 
 	// First grab the video maps needed for the DCB
-	ctrlMaps, _ := ss.GetControllerVideoMaps()
 	sp.allVideoMaps = util.FilterSlice(vmf.Maps, func(vm av.VideoMap) bool {
-		return slices.Contains(ctrlMaps, vm.Name)
+		return slices.Contains(ss.ControllerVideoMaps, vm.Name)
 	})
 	for _, vm := range sp.allVideoMaps {
 		usedIds[vm.Id] = nil
@@ -564,15 +559,15 @@ func (sp *STARSPane) makeMaps(client *server.ControlClient, ss sim.State, lg *lo
 
 	// Radar maps
 	radarIndex := 801
-	for _, name := range util.SortedMapKeys(ss.RadarSites) {
+	for _, name := range util.SortedMapKeys(ss.STARSFacilityAdaptation.RadarSites) {
 		sm := av.VideoMap{
 			Label:    name + "RCM",
 			Name:     name + " RADAR COVERAGE MAP",
 			Id:       radarIndex,
 			Category: VideoMapProcessingAreas,
 		}
 
-		site := ss.RadarSites[name]
+		site := ss.STARSFacilityAdaptation.RadarSites[name]
 		ld := renderer.GetLinesDrawBuilder()
 		ld.AddLatLongCircle(site.Position, ss.NmPerLongitude, float32(site.PrimaryRange), 360)
 		ld.AddLatLongCircle(site.Position, ss.NmPerLongitude, float32(site.SecondaryRange), 360)
@@ -612,7 +607,7 @@ func (sp *STARSPane) makeMaps(client *server.ControlClient, ss sim.State, lg *lo
 
 	// Start with the video maps associated with the Sim.
 	sp.dcbVideoMaps = nil
-	for _, name := range ctrlMaps {
+	for _, name := range ss.ControllerVideoMaps {
 		if idx := slices.IndexFunc(sp.allVideoMaps, func(v av.VideoMap) bool { return v.Name == name }); idx != -1 && name != "" {
 			sp.dcbVideoMaps = append(sp.dcbVideoMaps, &sp.allVideoMaps[idx])
 		} else {
@@ -622,21 +617,11 @@ func (sp *STARSPane) makeMaps(client *server.ControlClient, ss sim.State, lg *lo
 }
 
 func (sp *STARSPane) getVideoMapLibrary(ss sim.State, client *server.ControlClient) (*av.VideoMapLibrary, error) {
-	if sp.mapLibrary != nil {
-		return sp.mapLibrary, nil
-	}
-
 	filename := ss.STARSFacilityAdaptation.VideoMapFile
-	ml, err := av.HashCheckLoadVideoMap(filename, ss.VideoMapLibraryHash)
-	if err == nil {
-		sp.mapLibrary = ml
+	if ml, err := av.HashCheckLoadVideoMap(filename, ss.VideoMapLibraryHash); err == nil {
 		return ml, nil
 	} else {
-		ml, err = client.GetVideoMapLibrary(filename)
-		if err == nil {
-			sp.mapLibrary = ml
-		}
-		return ml, err
+		return client.GetVideoMapLibrary(filename)
 	}
 }
 
@@ -1214,7 +1199,7 @@ func (sp *STARSPane) radarMode(radarSites map[string]*av.RadarSite) int {
 func (sp *STARSPane) visibleAircraft(ctx *panes.Context) []*av.Aircraft {
 	var aircraft []*av.Aircraft
 	ps := sp.currentPrefs()
-	single := sp.radarMode(ctx.ControlClient.RadarSites) == RadarModeSingle
+	single := sp.radarMode(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites) == RadarModeSingle
 	now := ctx.ControlClient.SimTime
 	for callsign, state := range sp.Aircraft {
 		ac, ok := ctx.ControlClient.Aircraft[callsign]
@@ -1229,7 +1214,7 @@ func (sp *STARSPane) visibleAircraft(ctx *panes.Context) []*av.Aircraft {
 
 		visible := false
 
-		if sp.radarMode(ctx.ControlClient.RadarSites) == RadarModeFused {
+		if sp.radarMode(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites) == RadarModeFused {
 			// visible unless if it's almost on the ground
 			alt := float32(state.TrackAltitude())
 			if ctx.ControlClient.IsDeparture(ac) &&
@@ -1244,7 +1229,7 @@ func (sp *STARSPane) visibleAircraft(ctx *panes.Context) []*av.Aircraft {
 			visible = true
 		} else {
 			// Otherwise see if any of the radars can see it
-			for id, site := range ctx.ControlClient.RadarSites {
+			for id, site := range ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites {
 				if single && ps.RadarSiteSelected != id {
 					continue
 				}

pkg/panes/stars/track.go

@@ -463,7 +463,7 @@ func (sp *STARSPane) updateMSAWs(ctx *panes.Context) {
 func (sp *STARSPane) updateRadarTracks(ctx *panes.Context) {
 	// FIXME: all aircraft radar tracks are updated at the same time.
 	now := ctx.ControlClient.SimTime
-	if sp.radarMode(ctx.ControlClient.RadarSites) == RadarModeFused {
+	if sp.radarMode(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites) == RadarModeFused {
 		if now.Sub(sp.lastTrackUpdate) < 1*time.Second {
 			return
 		}
@@ -733,9 +733,9 @@ func (sp *STARSPane) drawRadarTrack(ac *av.Aircraft, state *AircraftState, headi
 
 	primaryTargetBrightness := ps.Brightness.PrimarySymbols
 	if primaryTargetBrightness > 0 {
-		switch mode := sp.radarMode(ctx.ControlClient.RadarSites); mode {
+		switch mode := sp.radarMode(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites); mode {
 		case RadarModeSingle:
-			site := ctx.ControlClient.RadarSites[ps.RadarSiteSelected]
+			site := ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites[ps.RadarSiteSelected]
 			primary, secondary, dist := site.CheckVisibility(pos, state.TrackAltitude())
 
 			// Orient the box toward the radar
@@ -772,7 +772,8 @@ func (sp *STARSPane) drawRadarTrack(ac *av.Aircraft, state *AircraftState, headi
 			ld.AddLine(line[0], line[1], primaryTargetBrightness.ScaleRGB(renderer.RGB{R: .1, G: .8, B: .1}))
 
 		case RadarModeMulti:
-			primary, secondary, _ := sp.radarVisibility(ctx.ControlClient.RadarSites, pos, state.TrackAltitude())
+			primary, secondary, _ := sp.radarVisibility(ctx.ControlClient.State.STARSFacilityAdaptation.RadarSites,
+				pos, state.TrackAltitude())
 			rot := math.Rotator2f(heading)
 
 			// blue box: x +/-9 pixels, y +/-3 pixels