listen system pasteboard update

Author: WhiredPlanck

entry/src/main/ets/InputMethodExtensionAbility/FcitxInputMethodService.ets

@@ -2,9 +2,11 @@ import { InputMethodExtensionAbility } from "@kit.IMEKit";
 import type Want from "@ohos.app.ability.Want";
 import keyboardController from "./model/KeyboardController";
 import fcitx from 'libentry.so';
+import pasteboardController from "./model/pasteboard/PasteboardController";
 
 export default class FcitxInputMethodService extends InputMethodExtensionAbility {
   onCreate(want: Want): void {
+    pasteboardController.onCreate(this.context)
     keyboardController.onCreate(this.context)
     const bundle = this.context.bundleCodeDir
     const resfile = this.context.resourceDir
@@ -13,5 +15,6 @@ export default class FcitxInputMethodService extends InputMethodExtensionAbility
 
   onDestroy(): void {
     keyboardController.onDestroy()
+    pasteboardController.onDestroy()
   }
 }

entry/src/main/ets/InputMethodExtensionAbility/model/pasteboard/PasteboardController.ets

@@ -0,0 +1,34 @@
+import { Context } from '@kit.AbilityKit'
+import { BusinessError, pasteboard } from '@kit.BasicServicesKit'
+
+const systemPasteboard: pasteboard.SystemPasteboard = pasteboard.getSystemPasteboard()
+
+export class PasteboardController {
+  constructor() {
+  }
+  
+  public onCreate(context: Context): void {
+    console.debug('onCreate')
+    systemPasteboard.on('update', this.onSystemPasteboardUpdate)
+  }
+  
+  public onDestroy(): void {
+    console.debug('onDestroy')
+    systemPasteboard.off('update', this.onSystemPasteboardUpdate)
+  }
+  
+  public onSystemPasteboardUpdate(): void {
+    systemPasteboard.getData((err: BusinessError, data: pasteboard.PasteData) => {
+      if (err) {
+        console.error(`Failed to get paste data: ${err.message}`)
+        return
+      }
+      const text = data.getPrimaryText()
+      console.debug(`get primary text: ${text}`)
+    })
+  }
+}
+
+const pasteboardController = new PasteboardController()
+
+export default pasteboardController

entry/src/main/ets/ability/EntryAbility.ets

@@ -1,6 +1,7 @@
-import { AbilityConstant, ConfigurationConstant, UIAbility, Want } from '@kit.AbilityKit';
+import { abilityAccessCtrl, AbilityConstant, ConfigurationConstant, UIAbility, Want } from '@kit.AbilityKit';
 import { hilog } from '@kit.PerformanceAnalysisKit';
 import { window } from '@kit.ArkUI';
+import { PermissionUtil } from '../utils/PermissionUtil';
 
 export default class EntryAbility extends UIAbility {
   onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
@@ -21,10 +22,19 @@ export default class EntryAbility extends UIAbility {
         hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
         return;
       }
+      this.checkPasteboardPermission()
       hilog.info(0x0000, 'testTag', 'Succeeded in loading the content.');
     });
   }
 
+  private checkPasteboardPermission() {
+    if (PermissionUtil.checkAccessToken('ohos.permission.READ_PASTEBOARD') ===
+      abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED) {
+      return
+    }
+    PermissionUtil.requestPermissions(this.context, ['ohos.permission.READ_PASTEBOARD'])
+  }
+
   onWindowStageDestroy(): void {
     // Main window is destroyed, release UI related resources
     hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageDestroy');

entry/src/main/ets/utils/PermissionUtil.ets

@@ -0,0 +1,39 @@
+import { abilityAccessCtrl, bundleManager, common, PermissionRequestResult, Permissions } from '@kit.AbilityKit'
+import { BusinessError } from '@kit.BasicServicesKit'
+
+export namespace PermissionUtil {
+
+  export function checkAccessToken(permission: Permissions): abilityAccessCtrl.GrantStatus {
+    const atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager()
+    let grantStatus: abilityAccessCtrl.GrantStatus = abilityAccessCtrl.GrantStatus.PERMISSION_DENIED
+
+    let tokenId: number = 0
+    try {
+      let bundleInfo: bundleManager.BundleInfo =
+        bundleManager.getBundleInfoForSelfSync(bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION)
+      let appInfo: bundleManager.ApplicationInfo = bundleInfo.appInfo
+      tokenId = appInfo.accessTokenId
+    } catch (error) {
+      const err: BusinessError = error as BusinessError
+      console.error(`Failed to get bundle info for self. Code is ${err.code}, message is ${err.message}`)
+    }
+
+    try {
+      grantStatus = atManager.checkAccessTokenSync(tokenId, permission)
+    } catch (error) {
+      const err: BusinessError = error as BusinessError
+      console.error(`Failed to check access token. Code is ${err.code}, message is ${err.message}`)
+    }
+
+    return grantStatus
+  }
+
+  export function requestPermissions(context: common.UIAbilityContext, permissions: Permissions | Array<Permissions>,
+    requestResult?: Callback<PermissionRequestResult>): void {
+    const atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager()
+    const ps = Array.isArray(permissions) ? [...permissions] : [permissions]
+    atManager.requestPermissionsFromUser(context, ps).then((result) => {
+      if (requestResult) requestResult(result)
+    })
+  }
+}

entry/src/main/module.json5

@@ -20,6 +20,14 @@
           "abilities": ["InputMethodExtensionAbility"],
           "when": "inuse"
         }
+      },
+      {
+        "name": "ohos.permission.READ_PASTEBOARD",
+        "reason": "$string:READ_PASTEBOARD_reason",
+        "usedScene": {
+          "abilities": ["EntryAbility", "InputMethodExtensionAbility"],
+          "when": "inuse"
+        }
       }
     ],
     "abilities": [

entry/src/main/resources/base/element/string.json

@@ -15,6 +15,10 @@
     {
       "name": "INTERNET_reason",
       "value": "Used in Cloud Pinyin."
+    },
+    {
+      "name": "READ_PASTEBOARD_reason",
+      "value": "Used for autofill and pasteboard history."
     }
   ]
 }