Support to count the time spent on local files (sheepzh#65)

sheepzh · sheepzh · commit 4b430ca335b1 · 2022-03-16T16:50:43.000+08:00
diff --git a/global.d.ts b/global.d.ts
@@ -59,6 +59,11 @@ declare namespace Timer {
          * @since 0.5.0
          */
         collectSiteName: boolean
+        /**
+         * Whether to count the local files
+         * @since 0.7.0
+         */
+        countLocalFiles: boolean
     }
 
     type Option = PopupOption & AppearanceOption & StatisticsOption
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "timer",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Web timer",
   "homepage": "https://github.com/sheepzh/timer",
   "scripts": {
diff --git a/src/app/components/option/components/statistics.ts b/src/app/components/option/components/statistics.ts
@@ -26,6 +26,11 @@ const countWhenIdle = () => h(ElSwitch, {
     onChange: (newVal: boolean) => updateOptionVal('countWhenIdle', newVal)
 })
 
+const countLocalFiles = () => h(ElSwitch, {
+    modelValue: optionRef.value.countLocalFiles,
+    onChange: (newVal: boolean) => updateOptionVal("countLocalFiles", newVal)
+})
+
 const collectSiteName = () => h(ElSwitch, {
     modelValue: optionRef.value.collectSiteName,
     onChange: (newVal: boolean) => updateOptionVal('collectSiteName', newVal)
@@ -38,6 +43,12 @@ const options = () => [
         info: tooltip(msg => msg.option.statistics.idleTimeInfo)
     }, msg => msg.statistics.countWhenIdle, t(msg => msg.option.no)),
     h(ElDivider),
+    renderOptionItem({
+        input: countLocalFiles(),
+        localFileTime: tagText(msg => msg.option.statistics.localFilesTime),
+        info: tooltip(msg => msg.option.statistics.localFilesInfo)
+    }, msg => msg.statistics.countLocalFiles, t(msg => msg.option.no)),
+    h(ElDivider),
     renderOptionItem({
         input: collectSiteName(),
         siteName: tagText(msg => msg.option.statistics.siteName),
diff --git a/src/app/components/report/table/columns/host-merged-alert.ts b/src/app/components/report/table/columns/host-merged-alert.ts
@@ -11,7 +11,7 @@ import { defineComponent, h } from "vue"
 /**
  * Merged host column
  * 
- * @since 0.6.2
+ * @since 0.7.0
  */
 const _default = defineComponent({
     name: "HostMergedAlert",
diff --git a/src/app/components/whitelist/components/item-input.ts b/src/app/components/whitelist/components/item-input.ts
@@ -7,6 +7,7 @@
 
 import { t } from "@app/locale"
 import { Check, Close } from "@element-plus/icons"
+import { isRemainHost } from "@util/constant/remain-host"
 import { isValidHost } from "@util/pattern"
 import { ElButton, ElInput, ElMessage } from "element-plus"
 import { defineComponent, Ref, ref, h } from "vue"
@@ -47,7 +48,9 @@ const _default = defineComponent({
                 size: 'small',
                 icon: Check,
                 class: 'item-check-button editable-item',
-                onClick: () => isValidHost(white.value) ? ctx.emit("saved", white.value) : ElMessage.warning(invalidTxt)
+                onClick: () => (isRemainHost(white.value) || isValidHost(white.value))
+                    ? ctx.emit("saved", white.value)
+                    : ElMessage.warning(invalidTxt)
             })
         ])
     }
diff --git a/src/app/locale/components/option.ts b/src/app/locale/components/option.ts
@@ -34,6 +34,9 @@ export type OptionMessage = {
         countWhenIdle: string
         idleTime: string
         idleTimeInfo: string
+        countLocalFiles: string
+        localFilesTime: string
+        localFilesInfo: string
         collectSiteName: string
         siteNameUsage: string
         siteName: string
@@ -68,6 +71,9 @@ const _default: Messages<OptionMessage> = {
             countWhenIdle: '{input}  是否统计 {idleTime} {info}',
             idleTime: '休眠时间',
             idleTimeInfo: '长时间不操作（比如全屏观看视频），浏览器会自动进入休眠状态',
+            countLocalFiles: '{input}  是否统计使用浏览器 {localFileTime} {info}',
+            localFilesTime: '阅读本地文件的时间',
+            localFilesInfo: '支持 PDF、图片、txt 以及 json 等格式',
             collectSiteName: '{input}  访问网站主页时，是否自动收集 {siteName} {siteNameUsage}',
             siteName: '网站的名称',
             siteNameUsage: '数据只存放在本地，将代替域名用于展示，增加辨识度。当然您可以自定义每个网站的名称'
@@ -100,6 +106,9 @@ const _default: Messages<OptionMessage> = {
             countWhenIdle: '{input}  Whether to count {idleTime} {info}',
             idleTime: 'idle time',
             idleTimeInfo: 'If you do not operate for a long time (such as watching a video in full screen), the browser will automatically enter the idle state',
+            countLocalFiles: '{input}  Whether to count the time spent {localFilesTime} {info} in the browser',
+            localFilesTime: ' reading the local file ',
+            localFilesInfo: 'Contains formats such as PDF, image, txt and json',
             collectSiteName: '{input}  Whether to automatically collect the name of the website when visiting the homepage of the website',
             siteName: 'Site Name',
             siteNameUsage: 'The data only exists locally and will be used for display instead of the host to increase recognition.'
@@ -135,6 +144,9 @@ const _default: Messages<OptionMessage> = {
             countWhenIdle: '{input}  Whether to count {idleTime} {info}',
             idleTime: 'idle time',
             idleTimeInfo: 'If you do not operate for a long time (such as watching a video in full screen), the browser will automatically enter the idle state',
+            countLocalFiles: '{input}  Whether to count the time spent {localFilesTime} {info} in the browser',
+            localFilesTime: ' reading the local file ',
+            localFilesInfo: 'Contains formats such as PDF, image, txt and json',
             collectSiteName: '{input}  Whether to automatically collect the name of the website when visiting the homepage of the website',
             siteName: 'site name',
             siteNameUsage: 'The data only exists locally and will be used for display instead of the host to increase recognition.'
diff --git a/src/background/timer/collector.ts b/src/background/timer/collector.ts
@@ -5,8 +5,13 @@
  * https://opensource.org/licenses/MIT
  */
 
-import { isBrowserUrl, extractHostname } from "@util/pattern"
+import { isBrowserUrl, extractHostname, extractFileHost } from "@util/pattern"
 import CollectionContext from "./collection-context"
+import optionService from "@service/option-service"
+
+let countLocalFiles: boolean
+optionService.getAllOption().then(option => countLocalFiles = !!option.countLocalFiles)
+optionService.addOptionChangeListener((newVal => countLocalFiles = !!newVal.countLocalFiles))
 
 /**
  * The promise for window query
@@ -29,7 +34,11 @@ function handleTab(tab: chrome.tabs.Tab, isFocusWindow: boolean, context: Collec
     const url = tab.url
     if (!url) return
     if (isBrowserUrl(url)) return
-    const host = extractHostname(url).host
+    let host = extractHostname(url).host
+    if (!host && countLocalFiles) {
+        // Not host, try to detect the local files
+        host = extractFileHost(url)
+    }
     if (host) {
         context.collectHost(host)
         const isFocus = isFocusWindow && tab.active
diff --git a/src/background/version-manager/0-7-0/local-file-initializer.ts b/src/background/version-manager/0-7-0/local-file-initializer.ts
@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2022 Hengyang Zhang
+ *
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+import MergeRuleDatabase from "@db/merge-rule-database"
+import HostAliasDatabase from "@db/host-alias-database"
+import { JSON_HOST, LOCAL_HOST_PATTERN, MERGED_HOST, PDF_HOST, PIC_HOST, TXT_HOST } from "@util/constant/remain-host"
+import IVersionProcessor from "../i-version-processor"
+import { HostAliasSource } from "@entity/dao/host-alias"
+
+const storage: chrome.storage.StorageArea = chrome.storage.local
+
+const mergeRuleDatabase = new MergeRuleDatabase(storage)
+const hostAliasDatabase = new HostAliasDatabase(storage)
+
+/**
+ * Process the host of local files
+ * 
+ * @since 0.7.0
+ */
+export default class LocalFileInitializer implements IVersionProcessor {
+    since(): string {
+        return '0.7.0'
+    }
+
+    process(): void {
+        // Add merged rules
+
+        mergeRuleDatabase.add({
+            origin: LOCAL_HOST_PATTERN,
+            merged: MERGED_HOST,
+        }).then(() => console.log('Local file merge rules initialized'))
+        // Add site name
+        hostAliasDatabase.update({
+            host: PDF_HOST,
+            name: "PDF 文件",
+            source: HostAliasSource.DETECTED
+        })
+        hostAliasDatabase.update({
+            host: JSON_HOST,
+            name: "JSON 文件",
+            source: HostAliasSource.DETECTED
+        })
+        hostAliasDatabase.update({
+            host: PIC_HOST,
+            name: "图片文件",
+            source: HostAliasSource.DETECTED
+        })
+        hostAliasDatabase.update({
+            host: TXT_HOST,
+            name: "文本文件",
+            source: HostAliasSource.DETECTED
+        })
+    }
+}
diff --git a/src/background/version-manager/index.ts b/src/background/version-manager/index.ts
@@ -7,6 +7,7 @@
 
 import IVersionProcessor from "./i-version-processor"
 import HostMergeInitializer from "./0-1-2/host-merge-initializer"
+import LocalFileInitializer from "./0-7-0/local-file-initializer"
 
 /**
  * Version manager
@@ -17,7 +18,7 @@ class VersionManager {
     processorChain: IVersionProcessor[] = []
 
     constructor() {
-        this.processorChain.push(new HostMergeInitializer())
+        this.processorChain.push(new HostMergeInitializer(), new LocalFileInitializer())
         this.processorChain = this.processorChain.sort((a, b) => a.since() >= b.since() ? 1 : 0)
     }
 
diff --git a/src/util/constant/option.ts b/src/util/constant/option.ts
@@ -28,6 +28,7 @@ export function defaultAppearance(): Timer.AppearanceOption {
 export function defaultStatistics(): Timer.StatisticsOption {
     return {
         countWhenIdle: false,
-        collectSiteName: true
+        collectSiteName: true,
+        countLocalFiles: false
     }
 }
diff --git a/src/util/constant/remain-host.ts b/src/util/constant/remain-host.ts
@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2022 Hengyang Zhang
+ *
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+/**
+ * @since 0.7.0
+ */
+
+export const PDF_HOST = "__local_pdf__"
+export const JSON_HOST = "__local_json__"
+export const TXT_HOST = "__local_txt__"
+export const PIC_HOST = "__local_picture__"
+
+export const LOCAL_HOST_PATTERN = "__local_*__"
+export const MERGED_HOST = "__local_files__"
+
+export const SUFFIX_HOST_MAP = {
+    txt: TXT_HOST,
+    pdf: PDF_HOST,
+    json: JSON_HOST,
+    // Pictures
+    jpg: PIC_HOST,
+    img: PIC_HOST,
+    png: PIC_HOST,
+    jpeg: PIC_HOST,
+}
+
+const reg = /^__local_(.+)__$/
+export function isRemainHost(host: string) {
+    return reg.test(host)
+}
diff --git a/src/util/pattern.ts b/src/util/pattern.ts
@@ -5,6 +5,9 @@
  * https://opensource.org/licenses/MIT
  */
 
+import { IS_CHROME, IS_EDGE } from "./constant/environment"
+import { SUFFIX_HOST_MAP } from "./constant/remain-host"
+
 /**
  * Test whether the url belongs to the browser
  * 
@@ -87,6 +90,21 @@ export function extractHostname(url: string): HostInfo {
     return { host, protocol }
 }
 
+/**
+ * @since 0.7.0
+ */
+export function extractFileHost(url: string): string {
+    if (!url.startsWith("file://")) {
+        return undefined
+    }
+    const dotIdx = url.lastIndexOf(".")
+    if (dotIdx < 0) {
+        return undefined
+    }
+    const suffix = url.substr(dotIdx + 1)?.toLowerCase()
+    return suffix ? SUFFIX_HOST_MAP[suffix] : undefined
+}
+
 /**
  * Judge whether homepage 
  * e.g.
diff --git a/test/util/pattern.test.ts b/test/util/pattern.test.ts
@@ -40,6 +40,9 @@ test("url", () => {
     expect(extractHostname('http://localhost:8087/')).toEqual({ host: 'localhost:8087', protocol: 'http' })
     expect(extractHostname('http://localhost:8087/?123=123')).toEqual({ host: 'localhost:8087', protocol: 'http' })
     expect(extractHostname('localhost:8087/?123=123')).toEqual({ host: 'localhost:8087', protocol: '' })
+    // the url of local files in firefox
+    expect(extractHostname("file:///home/zhy/%E4%B8%8B%E8%BD%BD/%E6%88%91%E7%9A%84%E4%B8%8A%E7%BD%91%E6%97%B6%E9%97%B4_20220305_20220305.json"))
+        .toEqual({ host: "", protocol: "file" })
 })
 
 test("homepage", () => {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "timer",`
`3`		`- "version": "0.6.1",`
	`3`	`+ "version": "0.7.0",`
`4`	`4`	`"description": "Web timer",`
`5`	`5`	`"homepage": "https://github.com/sheepzh/timer",`
`6`	`6`	`"scripts": {`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import { defineComponent, h } from "vue"`
`11`	`11`	`/**`
`12`	`12`	`* Merged host column`
`13`	`13`	`*`
`14`		`- * @since 0.6.2`
	`14`	`+ * @since 0.7.0`
`15`	`15`	`*/`
`16`	`16`	`const _default = defineComponent({`
`17`	`17`	`name: "HostMergedAlert",`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ export function defaultAppearance(): Timer.AppearanceOption {`
`28`	`28`	`export function defaultStatistics(): Timer.StatisticsOption {`
`29`	`29`	`return {`
`30`	`30`	`countWhenIdle: false,`
`31`		`- collectSiteName: true`
	`31`	`+ collectSiteName: true,`
	`32`	`+ countLocalFiles: false`
`32`	`33`	`}`
`33`	`34`	`}`