copy-android-scaffolding.mjs

#!/usr/bin/env node
import {
  copyFileSync,
  existsSync,
  mkdirSync,
  readdirSync,
  rmSync,
  readFileSync,
  statSync,
  writeFileSync,
} from 'node:fs';
import { dirname, join } from 'node:path';
import process from 'node:process';
import { fileURLToPath } from 'node:url';

const appRoot = fileURLToPath(new URL('..', import.meta.url));
const kotlinRoot = join(appRoot, 'android/kotlin');
const kotlinTestRoot = join(kotlinRoot, 'test');
const kotlinAndroidTestRoot = join(kotlinRoot, 'androidTest');
const manifestsRoot = join(appRoot, 'android/manifests');
const androidIconRoot = join(appRoot, 'src-tauri/icons/android');
const aidlRoot = join(appRoot, 'android/aidl');
const androidAssetsRoot = join(appRoot, 'android/assets');
const androidAppRoot = join(appRoot, 'src-tauri/gen/android/app');
const genRoot = join(appRoot, 'src-tauri/gen/android/app/src/main');
const kotlinDest = join(genRoot, 'java/com/openless/app');
const mainActivityPath = join(kotlinDest, 'MainActivity.kt');
const kotlinTestDest = join(androidAppRoot, 'src/test/java/com/openless/app');
const kotlinAndroidTestDest = join(androidAppRoot, 'src/androidTest/java/com/openless/app');
const androidAppGradle = join(androidAppRoot, 'build.gradle.kts');
const resDest = join(genRoot, 'res');
const resXmlDest = join(genRoot, 'res/xml');
const aidlDest = join(genRoot, 'aidl');
const assetsDest = join(genRoot, 'assets');

const KOTLIN_FILES = [
  'OpenLessAppContext.kt',
  'OpenLessNative.kt',
  'OpenLessPermissionBridge.kt',
  'MicrophonePermissionActivity.kt',
  'OpenLessAndroidPreferences.kt',
  'OpenLessCredentialCipher.kt',
  'OpenLessCredentialVault.kt',
  'OpenLessApplication.kt',
  'OpenLessOverlayService.kt',
  'OpenLessOverlayBridge.kt',
  'OpenLessAccessibilityService.kt',
  'OpenLessAccessibilitySelection.kt',
  'OpenLessAccessibilityResult.kt',
  'OpenLessAccessibilityTarget.kt',
  'OpenLessPasteVerification.kt',
  'OpenLessAccessibilityComponentIds.kt',
  'OpenLessShizukuBridge.kt',
  'OpenLessShizukuUserService.kt',
  'OpenLessShizukuUserServiceClient.kt',
  'ShizukuPermissionActivity.kt',
  'OpenLessAccessibilityCommandReceiver.kt',
  'OpenLessVocabularyReceiver.kt',
  'OverlayPermissionActivity.kt',
  'OpenLessUpdateInstaller.kt',
  'OpenLessContentReader.kt',
  'OpenLessContentWriter.kt',
  'OpenLessMigrationBundlePolicy.kt',
  'OpenLessMigrationState.kt',
  'OpenLessImeService.kt',
  'ImeLearningPolicy.kt',
  'DictationSpan.kt',
  'ImePrivacyPolicy.kt',
  'ImeDraftReplacement.kt',
  'StrokeInputController.kt',
  'StrokeInput.kt',
  'OpenLessRime.kt',
  'RimePinyinController.kt',
  'LegacyPinyinBackup.kt',
  'OpenLessSettingsExport.kt',
  'StrokePhraseRepository.kt',
  'StrokeUserFrequency.kt',
  'EnglishCandidateProvider.kt',
  'EnglishUserFrequency.kt',
  'OpenLessRuntimeService.kt',
  'OpenLessBackendWarmupActivity.kt',
  'OpenLessClipboardHistory.kt',
  'CloudNoteDelivery.kt',
  'OpenLessKeyboardSettingsActivity.kt',
  'OpenLessLocalMigrationActivity.kt',
  'OpenLessProcessRestartStats.kt',
  'OpenLessBuildInfo.kt',
];

const KOTLIN_TEST_FILES = [
  'ImeLearningPolicyTest.kt',
  'CloudNoteDeliveryTest.kt',
  'DictationSpanTest.kt',
  'ImePrivacyPolicyTest.kt',
  'ImeDraftReplacementTest.kt',
  'LatinInputModeTest.kt',
  'OpenLessContentReaderTest.kt',
  'OpenLessMigrationBundleContractTest.kt',
  'OpenLessCredentialCipherTest.kt',
  'OpenLessShizukuBridgeTest.kt',
  'OpenLessAccessibilityResultTest.kt',
  'OpenLessAccessibilitySelectionTest.kt',
  'OpenLessOverlayStateTest.kt',
  'OpenLessAccessibilityTargetTest.kt',
  'OpenLessPasteVerificationTest.kt',
  'OpenLessAccessibilityComponentIdsTest.kt',
];
const KOTLIN_ANDROID_TEST_FILES = [
  'OpenLessClipboardHistoryInstrumentedTest.kt',
  'OpenLessCredentialVaultInstrumentedTest.kt',
  'ImeLearningMigrationTest.kt',
  'OpenLessMigrationBundleInstrumentedTest.kt',
  'RimeEngineIntegrationTest.kt',
];

const XML_FILES = [
  ['res/xml/openless_accessibility_config.xml', 'openless_accessibility_config.xml'],
  ['res/xml/openless_ime_method.xml', 'openless_ime_method.xml'],
];

const GENERATED_ACCESSIBILITY_CONFIG = `<?xml version="1.0" encoding="utf-8"?>
<accessibility-service xmlns:android="http://schemas.android.com/apk/res/android"
    android:accessibilityEventTypes="typeWindowStateChanged|typeWindowsChanged"
    android:accessibilityFeedbackType="feedbackGeneric"
    android:accessibilityFlags="flagRetrieveInteractiveWindows"
    android:canRetrieveWindowContent="true"
    android:description="@string/openless_accessibility_description"
    android:notificationTimeout="100"
    android:settingsActivity="com.openless.app.MainActivity" />
`;

const GENERATED_STRINGS_SNIPPET = `
    <string name="openless_accessibility_description">OpenLess uses accessibility to detect the keyboard and paste dictation results without switching your current keyboard.</string>
    <string name="openless_ime_label">OpenLess Voice</string>
`;

export const SHIZUKU_STRINGS_BY_LOCALE = {
  values: {
    openless_shizuku_permission_rationale:
      'OpenLess needs Shizuku authorization to optionally recover accessibility when OEM settings block manual toggles.',
    openless_shizuku_permission_blocked:
      'Shizuku authorization was denied. Open Shizuku and allow OpenLess manually.',
    openless_shizuku_open_manager: 'Open Shizuku',
  },
  'values-zh-rCN': {
    openless_shizuku_permission_rationale:
      'OpenLess 需要 Shizuku 授权，以便在部分机型无法手动开启无障碍时尝试恢复。',
    openless_shizuku_permission_blocked:
      'Shizuku 授权已被拒绝。请打开 Shizuku 并手动允许 OpenLess。',
    openless_shizuku_open_manager: '打开 Shizuku',
  },
  'values-zh-rTW': {
    openless_shizuku_permission_rationale:
      'OpenLess 需要 Shizuku 授權，以便在部分機型無法手動開啟無障礙時嘗試恢復。',
    openless_shizuku_permission_blocked:
      'Shizuku 授權已被拒絕。請開啟 Shizuku 並手動允許 OpenLess。',
    openless_shizuku_open_manager: '開啟 Shizuku',
  },
  'values-ja': {
    openless_shizuku_permission_rationale:
      'OEM 設定で手動切り替えが難しい場合にアクセシビリティを復旧するため、OpenLess には Shizuku 権限が必要です。',
    openless_shizuku_permission_blocked:
      'Shizuku 権限が拒否されました。Shizuku を開いて OpenLess を手動で許可してください。',
    openless_shizuku_open_manager: 'Shizuku を開く',
  },
  'values-ko': {
    openless_shizuku_permission_rationale:
      'OEM 설정에서 접근성을 수동으로 켜기 어려울 때 복구하려면 OpenLess에 Shizuku 권한이 필요합니다.',
    openless_shizuku_permission_blocked:
      'Shizuku 권한이 거부되었습니다. Shizuku를 열어 OpenLess를 수동으로 허용하세요.',
    openless_shizuku_open_manager: 'Shizuku 열기',
  },
};

export function formatStringResource(name, value) {
  return `    <string name="${name}">${value}</string>`;
}

export function hasStringResource(xml, name) {
  return new RegExp(`<string\\s+name="${name}"`).test(xml);
}

export function mergeMissingStringResources(xml, stringsByName) {
  let content = xml;
  let changed = false;
  for (const [name, value] of Object.entries(stringsByName)) {
    if (hasStringResource(content, name)) {
      continue;
    }
    if (!content.includes('</resources>')) {
      throw new Error('strings.xml is missing </resources>');
    }
    content = content.replace('</resources>', `${formatStringResource(name, value)}\n</resources>`);
    changed = true;
  }
  return { content, changed };
}

function buildStringsSnippet(stringsByName) {
  return `\n${Object.entries(stringsByName)
    .map(([name, value]) => formatStringResource(name, value))
    .join('\n')}\n`;
}

function printHelp() {
  console.log(`Usage: node scripts/copy-android-scaffolding.mjs [options]

Copy Kotlin scaffolding and XML resources into gen/android after \`tauri android init\`.

Options:
  --dry-run   Print planned copies without writing
  --help      Show this help text
`);
}

function parseArgs(argv) {
  let dryRun = false;
  for (const arg of argv) {
    if (arg === '--help' || arg === '-h') {
      printHelp();
      process.exit(0);
    }
    if (arg === '--dry-run') {
      dryRun = true;
      continue;
    }
    throw new Error(`Unknown argument: ${arg}`);
  }
  return { dryRun };
}

function ensureDir(path, dryRun) {
  if (dryRun || existsSync(path)) {
    return;
  }
  mkdirSync(path, { recursive: true });
}

function mergeStringsXml(dryRun) {
  const stringsPath = join(genRoot, 'res/values/strings.xml');
  if (!existsSync(stringsPath)) {
    const content = `<?xml version="1.0" encoding="utf-8"?>
<resources>${GENERATED_STRINGS_SNIPPET}${buildStringsSnippet(SHIZUKU_STRINGS_BY_LOCALE.values)}
</resources>
`;
    if (dryRun) {
      console.log(`[dry-run] Would create ${stringsPath}`);
      return;
    }
    ensureDir(dirname(stringsPath), dryRun);
    writeFileSync(stringsPath, content, 'utf8');
    console.log(`Created ${stringsPath}`);
  } else {
    let existing = readFileSync(stringsPath, 'utf8');
    const generatedStrings = mergeMissingStringResources(existing, {
      openless_accessibility_description:
        'OpenLess uses accessibility to detect the keyboard and paste dictation results without switching your current keyboard.',
      openless_ime_label: 'OpenLess Voice',
    });
    const merged = mergeMissingStringResources(
      generatedStrings.content,
      SHIZUKU_STRINGS_BY_LOCALE.values,
    );
    if (!dryRun) {
      writeFileSync(stringsPath, merged.content, 'utf8');
      console.log(`Merged OpenLess strings into ${stringsPath}`);
    }
  }

  for (const [localeDir, stringsByName] of Object.entries(SHIZUKU_STRINGS_BY_LOCALE)) {
    if (localeDir === 'values') {
      continue;
    }
    mergeLocaleStringsXml(localeDir, stringsByName, dryRun);
  }
}

function mergeLocaleStringsXml(localeDir, stringsByName, dryRun) {
  const stringsPath = join(genRoot, 'res', localeDir, 'strings.xml');
  if (!existsSync(stringsPath)) {
    const content = `<?xml version="1.0" encoding="utf-8"?>
<resources>${buildStringsSnippet(stringsByName)}
</resources>
`;
    if (dryRun) {
      console.log(`[dry-run] Would create ${stringsPath}`);
      return;
    }
    ensureDir(dirname(stringsPath), dryRun);
    writeFileSync(stringsPath, content, 'utf8');
    console.log(`Created ${stringsPath}`);
    return;
  }

  const existing = readFileSync(stringsPath, 'utf8');
  const merged = mergeMissingStringResources(existing, stringsByName);
  if (!merged.changed) {
    console.log(`Shizuku strings already present in ${stringsPath}; skipping.`);
    return;
  }
  if (dryRun) {
    console.log(`[dry-run] Would merge Shizuku strings into ${stringsPath}`);
    return;
  }
  writeFileSync(stringsPath, merged.content, 'utf8');
  console.log(`Merged Shizuku strings into ${stringsPath}`);
}

function copyDirectoryContents(srcRoot, destRoot, dryRun) {
  if (!existsSync(srcRoot)) {
    throw new Error(`Missing Android icon resources: ${srcRoot}`);
  }

  ensureDir(destRoot, dryRun);
  for (const entry of readdirSync(srcRoot)) {
    const src = join(srcRoot, entry);
    const dest = join(destRoot, entry);
    if (statSync(src).isDirectory()) {
      copyDirectoryContents(src, dest, dryRun);
      continue;
    }
    if (dryRun) {
      console.log(`[dry-run] Would copy ${src} -> ${dest}`);
      continue;
    }
    ensureDir(dirname(dest), dryRun);
    copyFileSync(src, dest);
    console.log(`Copied ${dest}`);
  }
}

function copyNamedFiles(files, srcRoot, destRoot, dryRun) {
  ensureDir(destRoot, dryRun);
  for (const file of files) {
    const src = join(srcRoot, file);
    const dest = join(destRoot, file);
    if (!existsSync(src)) {
      throw new Error(`Missing scaffolding file: ${src}`);
    }
    if (dryRun) {
      console.log(`[dry-run] Would copy ${src} -> ${dest}`);
      continue;
    }
    copyFileSync(src, dest);
    console.log(`Copied ${file}`);
  }
}

function ensureInstrumentationRunner(dryRun) {
  if (!existsSync(androidAppGradle)) {
    throw new Error(`Missing generated Android Gradle file: ${androidAppGradle}`);
  }
  const existing = readFileSync(androidAppGradle, 'utf8');
  if (existing.includes('testInstrumentationRunner')) {
    console.log(`Android instrumentation runner already present in ${androidAppGradle}; skipping.`);
    return;
  }
  const defaultConfig = /^(\s*)defaultConfig\s*\{\s*$/m;
  const match = existing.match(defaultConfig);
  if (!match) {
    throw new Error(`defaultConfig block not found in ${androidAppGradle}`);
  }
  const runner =
    `${match[0]}\n${match[1]}    ` +
    'testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"';
  const updated = existing.replace(defaultConfig, runner);
  if (dryRun) {
    console.log(`[dry-run] Would add testInstrumentationRunner to ${androidAppGradle}`);
    return;
  }
  writeFileSync(androidAppGradle, updated, 'utf8');
  console.log(`Added Android instrumentation runner to ${androidAppGradle}`);
}

function ensureMainActivityOpen(dryRun) {
  if (!existsSync(mainActivityPath)) return;
  const existing = readFileSync(mainActivityPath, 'utf8');
  const updated = existing.replace(
    /(?:open\s+)*class MainActivity\s*:/,
    'open class MainActivity:',
  );
  if (updated === existing) return;
  if (dryRun) {
    console.log(`[dry-run] Would make MainActivity inheritable for background warmup`);
    return;
  }
  writeFileSync(mainActivityPath, updated, 'utf8');
  console.log(`Made MainActivity inheritable for background warmup`);
}

function main() {
  const { dryRun } = parseArgs(process.argv.slice(2));

  if (!existsSync(join(appRoot, 'src-tauri/gen/android'))) {
    throw new Error(
      `Generated Android project not found under src-tauri/gen/android.\nRun "npm run tauri -- android init --ci" first.`,
    );
  }

  ensureDir(kotlinDest, dryRun);
  ensureDir(kotlinTestDest, dryRun);
  ensureDir(kotlinAndroidTestDest, dryRun);
  ensureDir(resXmlDest, dryRun);
  if (existsSync(aidlRoot)) {
    copyDirectoryContents(aidlRoot, aidlDest, dryRun);
  }
  copyDirectoryContents(androidIconRoot, resDest, dryRun);
  if (existsSync(androidAssetsRoot)) {
    copyDirectoryContents(androidAssetsRoot, assetsDest, dryRun);
  }
  // Generated projects survive upgrades. Retire only known obsolete files so
  // an incremental build cannot keep packaging the removed pinyin engine.
  for (const name of [
    'LitePinyinController.kt',
    'LitePinyinRepository.kt',
    'LitePinyinUserFrequency.kt',
    'LitePinyinLearnedPhrases.kt',
  ]) {
    const path = join(kotlinDest, name);
    if (dryRun) console.log(`[dry-run] Would remove retired source ${path}`);
    else rmSync(path, { force: true });
  }
  for (const name of [
    'pinyin_chars.tsv',
    'pinyin_phrases.tsv',
    'pinyin_chars.LICENSE.txt',
    'pinyin_phrases.LICENSE.txt',
    'pinyin_dictionary_meta.json',
  ]) {
    const path = join(assetsDest, name);
    if (dryRun) console.log(`[dry-run] Would remove retired asset ${path}`);
    else rmSync(path, { force: true });
  }
  copyNamedFiles(KOTLIN_FILES, kotlinRoot, kotlinDest, dryRun);
  ensureMainActivityOpen(dryRun);
  copyNamedFiles(KOTLIN_TEST_FILES, kotlinTestRoot, kotlinTestDest, dryRun);
  copyNamedFiles(KOTLIN_ANDROID_TEST_FILES, kotlinAndroidTestRoot, kotlinAndroidTestDest, dryRun);
  ensureInstrumentationRunner(dryRun);

  for (const [relSrc, destName] of XML_FILES) {
    const src = join(manifestsRoot, relSrc);
    const dest = join(resXmlDest, destName);
    const content = existsSync(src) ? readFileSync(src, 'utf8') : GENERATED_ACCESSIBILITY_CONFIG;
    if (dryRun) {
      console.log(`[dry-run] Would write ${dest}`);
      continue;
    }
    writeFileSync(dest, content, 'utf8');
    console.log(`Wrote ${destName}`);
  }

  mergeStringsXml(dryRun);
}

try {
  const isDirectRun = Boolean(
    process.argv[1]?.replace(/\\/g, '/').endsWith('copy-android-scaffolding.mjs'),
  );
  if (isDirectRun) {
    main();
  }
} catch (error) {
  console.error(error instanceof Error ? error.message : error);
  process.exit(1);
}