Merge pull request #271 from appdevforall/feat/ADFA-4900-wizard-maps-runrole

ADFA-4900: wizard maps drive a per-layer install via local_vars + run…

Author: luisguzman-adfa

controller/app/src/main/java/org/iiab/controller/install/domain/MapsRunroleCommand.java

@@ -0,0 +1,53 @@
+/*
+ * ============================================================================
+ * Name        : MapsRunroleCommand.java
+ * Author      : AppDevForAll
+ * Copyright   : Copyright (c) 2026 AppDevForAll
+ * Description : ADFA-4900. Pure builder for the maps runrole command driven by the wizard's
+ *               per-layer selection. Kept out of InstallService so it is unit-testable (no Android
+ *               deps). Translates the selection into the maps role's local_vars
+ *               (roles/maps/tasks/install_frontend.yml): satellite/terrain "none" turns the layer
+ *               off; search maps to maps_search_engine + maps_search_static_db. Every var the role's
+ *               iiab.ini step references is written so the play never hits an undefined var. Values
+ *               are validated against a fixed allowlist (D2 shell-injection guard); anything
+ *               unexpected falls back to a safe default. --reinstall forces install.yml to re-fetch
+ *               the chosen tiles (a plain runrole skips it because maps ships in the base image).
+ * ============================================================================
+ */
+package org.iiab.controller.install.domain;
+
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+public final class MapsRunroleCommand {
+    private MapsRunroleCommand() {}
+
+    private static final Set<String> VECTOR_OK = new HashSet<>(Arrays.asList("nat-z8", "osm-z11", "osm-z14"));
+    private static final Set<String> SAT_OK = new HashSet<>(Arrays.asList("none", "7", "9", "11", "13"));
+    private static final Set<String> TERRAIN_OK = new HashSet<>(Arrays.asList("none", "7", "8", "9", "10"));
+    private static final String LV = "/etc/iiab/local_vars.yml";
+
+    /** Build the sed-delete + echo (append-if-missing) + runrole command for the given selection. */
+    public static String build(String vector, String sat, String terrain, boolean searchOn) {
+        String vq = VECTOR_OK.contains(vector) ? vector : "osm-z11";
+        String s = SAT_OK.contains(sat) ? sat : "none";
+        String t = TERRAIN_OK.contains(terrain) ? terrain : "none";
+        String engine = searchOn ? "static" : "";
+        return "sed -i -E '/^[[:space:]]*maps_(install|enabled|region_downloader|vector_quality|" +
+                "satellite_zoom|terrain_zoom|search_engine|search_static_db|search_nominatim_db|" +
+                "ne6_zoom|preset_full_quality_regions)[[:space:]]*:/d' " + LV +
+                " && echo 'maps_install: True' >> " + LV +
+                " && echo 'maps_enabled: True' >> " + LV +
+                " && echo 'maps_region_downloader: True' >> " + LV +
+                " && echo 'maps_vector_quality: " + vq + "' >> " + LV +
+                " && echo 'maps_satellite_zoom: " + s + "' >> " + LV +
+                " && echo 'maps_terrain_zoom: " + t + "' >> " + LV +
+                " && echo 'maps_search_engine: \"" + engine + "\"' >> " + LV +
+                " && echo 'maps_search_static_db: pop-1k-cities' >> " + LV +
+                " && echo 'maps_search_nominatim_db: basic' >> " + LV +
+                " && echo 'maps_ne6_zoom: full' >> " + LV +
+                " && echo 'maps_preset_full_quality_regions: []' >> " + LV +
+                " && cd /opt/iiab/iiab && ./runrole --reinstall maps";
+    }
+}

controller/app/src/main/java/org/iiab/controller/install/presentation/InstallService.java

@@ -87,6 +87,15 @@ public final class InstallService extends Service {
     public static final String MODE_INSTALL = "install";
     public static final String MODE_RESET = "reset";
 
+    // ADFA-4900: per-layer maps config carried with a module queue of {"maps"}. When present, the
+    // "maps" module writes the full maps_* var set to local_vars (from the wizard selection) before
+    // runrole, instead of the generic <key>_install/_enabled echo. Values are validated against a
+    // fixed allowlist before interpolation (D2).
+    public static final String EXTRA_MAPS_VECTOR = "mapsVector";   // nat-z8 | osm-z11 | osm-z14
+    public static final String EXTRA_MAPS_SAT = "mapsSat";         // 7|9|11|13 | none
+    public static final String EXTRA_MAPS_TERRAIN = "mapsTerrain"; // 7|8|9|10 | none
+    public static final String EXTRA_MAPS_SEARCH = "mapsSearch";   // boolean: static pop-1k-cities on/off
+
     private PowerManager.WakeLock wakeLock;
     private WifiManager.WifiLock wifiLock;
 
@@ -113,6 +122,11 @@ public final class InstallService extends Service {
     private java.util.Deque<String> moduleQueue;
     private java.util.List<String> failedModules;
 
+    // ADFA-4900: wizard maps per-layer config (only set when the queue is {"maps"} from the wizard).
+    private boolean hasMapsConfig;
+    private String mapsVector, mapsSat, mapsTerrain;
+    private boolean mapsSearchOn;
+
     private File iiabRootDir;     // filesDir/rootfs
     private File debianRootfs;    // filesDir/rootfs/installed-rootfs/iiab
 
@@ -156,6 +170,13 @@ public int onStartCommand(Intent intent, int flags, int startId) {
             }
             failedModules = new java.util.ArrayList<>();
 
+            // ADFA-4900: pick up the wizard maps per-layer selection, if any.
+            mapsVector = intent.getStringExtra(EXTRA_MAPS_VECTOR);
+            mapsSat = intent.getStringExtra(EXTRA_MAPS_SAT);
+            mapsTerrain = intent.getStringExtra(EXTRA_MAPS_TERRAIN);
+            mapsSearchOn = intent.getBooleanExtra(EXTRA_MAPS_SEARCH, false);
+            hasMapsConfig = mapsVector != null && moduleQueue.contains("maps");
+
             startForeground(NOTIFICATION_ID, buildNotification(getString(R.string.install_busy_modules)));
             acquireHardwareLocks();
             persistQueue();
@@ -658,7 +679,11 @@ private void installNextModule() {
             return;
         }
 
-        String installCmd = "sed -i -E '/^[[:space:]]*" + nextModule + "_(install|enabled)[[:space:]]*:/d' /etc/iiab/local_vars.yml && " +
+        // ADFA-4900: for the wizard maps flow, write the full per-layer maps_* var set before
+        // runrole (the generic <key>_install/_enabled echo can't express quality/off/search).
+        final String installCmd = ("maps".equals(nextModule) && hasMapsConfig)
+                ? mapsInstallCmd()
+                : "sed -i -E '/^[[:space:]]*" + nextModule + "_(install|enabled)[[:space:]]*:/d' /etc/iiab/local_vars.yml && " +
                 "echo '" + nextModule + "_install: True' >> /etc/iiab/local_vars.yml && " +
                 "echo '" + nextModule + "_enabled: True' >> /etc/iiab/local_vars.yml && " +
                 "cd /opt/iiab/iiab && ./runrole " + roleName;
@@ -717,6 +742,20 @@ private void revertModuleInLocalVars(String module, Runnable then) {
         });
     }
 
+    /**
+     * ADFA-4900: build the maps runrole command from the wizard's per-layer selection. Translates
+     * the selection into the maps role's local_vars (roles/maps/tasks/install_frontend.yml):
+     * satellite/terrain "none" turns the layer off; search maps to maps_search_engine +
+     * maps_search_static_db. Every var the role's iiab.ini step references is written so the play
+     * never hits an undefined var. Values are validated against a fixed allowlist (D2); anything
+     * unexpected falls back to a safe default. Uses sed-delete + echo (append-if-missing).
+     */
+    // ADFA-4900: the maps runrole command is a pure, unit-tested builder (MapsRunroleCommand).
+    private String mapsInstallCmd() {
+        return org.iiab.controller.install.domain.MapsRunroleCommand.build(
+                mapsVector, mapsSat, mapsTerrain, mapsSearchOn);
+    }
+
     private void finishModuleQueue() {
         if (finished) return;
         finished = true;

controller/app/src/main/java/org/iiab/controller/redesign/BooksProvisioner.java

@@ -36,6 +36,14 @@ public static boolean hasPending(Context ctx) {
     /** Hand the wishlist to BooksDownloadService (requires the server to be up) and clear it.
      *  No-op if empty or a session is already running. */
     public static void drain(Context ctx) {
+        // ADFA-4900: proot (runrole) and REST downloads must not run at the same time — Ansible forks
+        // background processes and concurrent REST work is a recipe for corruption. Defer REST while a
+        // module-queue (proot) job is pending or running; a later drain pass picks it up once idle.
+        if (org.iiab.controller.install.presentation.ModuleQueueRepository.get().isRunning()
+                || MapsProvisioner.hasPending(ctx)) {
+            Log.d(TAG, "books drain deferred: proot (runrole) work is pending/running");
+            return;
+        }
         if (BooksDownloadService.isRunning() || BooksDownloadService.hasSession()) {
             Log.d(TAG, "books drain skipped: a session is already active");
             return;

controller/app/src/main/java/org/iiab/controller/redesign/LibraryHomeFragment.java

@@ -255,7 +255,8 @@ private void refreshStatuses() {
         // fail with no content installed. So gate the drain on the REST API actually answering;
         // the wishlist is untouched until then, and this poll (~3s) retries until it's ready.
         if (alive && !provisionProbing
-                && (BooksProvisioner.hasPending(requireContext()) || ZimProvisioner.hasPending(requireContext()))) {
+                && (BooksProvisioner.hasPending(requireContext()) || ZimProvisioner.hasPending(requireContext())
+                    || MapsProvisioner.hasPending(requireContext()))) {   // ADFA-4900
             provisionProbing = true;
             AppExecutors.get().io().execute(() -> {
                 final boolean ready = RestReadiness.apiReady();
@@ -269,6 +270,7 @@ private void refreshStatuses() {
                     android.util.Log.i("K2Go-Provision", "REST API ready -> draining wishlists (home fallback)");
                     if (BooksProvisioner.hasPending(requireContext())) BooksProvisioner.drain(requireContext());
                     if (ZimProvisioner.hasPending(requireContext())) ZimProvisioner.drain(requireContext());
+                    if (MapsProvisioner.hasPending(requireContext())) MapsProvisioner.drain(requireContext()); // ADFA-4900
                 });
             });
         }

controller/app/src/main/java/org/iiab/controller/redesign/MapsChooseFragment.java

@@ -77,6 +77,14 @@ private static final class Grp {
 
     private int px(int dp) { return Math.round(dp * getResources().getDisplayMetrics().density); }
 
+    // ADFA-4900: persist the user's per-layer choices so leaving and returning to the selector shows
+    // what they picked, not the system defaults. Kept SEPARATE from MapsWishlist (which is the
+    // "banked for install" order written only at Confirm) so editing pills never triggers an install.
+    private static final String SEL_PREFS = "k2go_maps_selector";
+    private android.content.SharedPreferences selPrefs() {
+        return requireContext().getApplicationContext().getSharedPreferences(SEL_PREFS, android.content.Context.MODE_PRIVATE);
+    }
+
     /** Overwrite each option's size with the packaged last-known value (maps_sizes.csv);
      *  the built-in mb stays as the fallback when a row is missing. */
     private void resolveSizes() {
@@ -118,12 +126,16 @@ public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup c
                 String[] names = new String[GROUPS.length];
                 String[] opts = new String[GROUPS.length];
                 long[] mb = new long[GROUPS.length];
+                // ADFA-4900: carry the machine level keys (null = "off") so the install can write
+                // local_vars — aligned to GROUPS order [base, satellite, terrain, search].
+                String[] levels = new String[GROUPS.length];
                 for (int gi = 0; gi < GROUPS.length; gi++) {
                     names[gi] = getString(GROUPS[gi].label);
                     opts[gi] = getString(GROUPS[gi].opts[selectedIdx[gi]].label);
                     mb[gi] = selectedMb[gi];
+                    levels[gi] = GROUPS[gi].opts[selectedIdx[gi]].level;
                 }
-                ((SetupLibraryActivity) getActivity()).openMapsConfirm(names, opts, mb);
+                ((SetupLibraryActivity) getActivity()).openMapsConfirm(names, opts, mb, levels);
             }
         });
 
@@ -134,8 +146,11 @@ public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup c
     private void buildGroups(LinearLayout host) {
         for (int gi = 0; gi < GROUPS.length; gi++) {
             final Grp g = GROUPS[gi];
-            selectedMb[gi] = g.opts[g.def].mb;
-            selectedIdx[gi] = g.def;
+            // Restore the saved choice for this group; fall back to the default the first time.
+            int savedIdx = selPrefs().getInt("sel_" + g.key, g.def);
+            if (savedIdx < 0 || savedIdx >= g.opts.length) savedIdx = g.def;
+            selectedIdx[gi] = savedIdx;
+            selectedMb[gi] = g.opts[savedIdx].mb;
 
             // Header row: icon · name (bold) · hint (muted) · [spacer] · current size (teal, right).
             LinearLayout header = new LinearLayout(requireContext());
@@ -213,13 +228,14 @@ private void buildGroups(LinearLayout host) {
                 flow.addView(pill);
                 pillViews[gi][oi] = pill;
             }
-            applyGroupSelection(gi, g.def);
+            applyGroupSelection(gi, selectedIdx[gi]);
         }
     }
 
     private void selectOpt(int gi, int oi) {
         selectedMb[gi] = GROUPS[gi].opts[oi].mb;
         selectedIdx[gi] = oi;
+        selPrefs().edit().putInt("sel_" + GROUPS[gi].key, oi).apply();   // persist on each change
         applyGroupSelection(gi, oi);
         refresh();
     }

controller/app/src/main/java/org/iiab/controller/redesign/MapsConfirmFragment.java

@@ -31,14 +31,15 @@
 
 public class MapsConfirmFragment extends Fragment {
 
-    private static final String ARG_NAMES = "names", ARG_OPTS = "opts", ARG_MB = "mb";
+    private static final String ARG_NAMES = "names", ARG_OPTS = "opts", ARG_MB = "mb", ARG_LEVELS = "levels";
 
-    public static MapsConfirmFragment newInstance(String[] names, String[] opts, long[] mb) {
+    public static MapsConfirmFragment newInstance(String[] names, String[] opts, long[] mb, String[] levels) {
         MapsConfirmFragment f = new MapsConfirmFragment();
         Bundle b = new Bundle();
         b.putStringArray(ARG_NAMES, names);
         b.putStringArray(ARG_OPTS, opts);
         b.putLongArray(ARG_MB, mb);
+        b.putStringArray(ARG_LEVELS, levels);   // ADFA-4900: per-layer machine keys (null = off)
         f.setArguments(b);
         return f;
     }
@@ -72,11 +73,19 @@ public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup c
         }
         box.addView(row(getString(R.string.k2go_maps_total), "", fmt(total), true));
 
+        final String[] levels = a != null ? a.getStringArray(ARG_LEVELS) : null;
+
+        // ADFA-4900: in the wizard (pre-install) Maps banks the selection; post-install it installs.
+        final boolean wizard = getActivity() instanceof SetupLibraryActivity
+                && ((SetupLibraryActivity) getActivity()).isMapsWizard();
+
         Button start = root.findViewById(R.id.k2go_start_btn);
-        start.setText(getString(R.string.k2go_maps_start_building, fmt(total)));
+        start.setText(getString(wizard ? R.string.k2go_maps_add_setup_fmt : R.string.k2go_maps_start_building, fmt(total)));
         start.setOnClickListener(v -> {
             if (getActivity() instanceof SetupLibraryActivity) {
-                ((SetupLibraryActivity) getActivity()).openMapsPreparing();
+                SetupLibraryActivity act = (SetupLibraryActivity) getActivity();
+                if (act.isMapsWizard()) act.mapsWizardConfirm(levels);
+                else act.openMapsPreparing(levels);
             }
         });