From 99dce483650b8a8f1751307a9597c8e002c8b575 Mon Sep 17 00:00:00 2001 From: Zhang Sheng Date: Mon, 28 Sep 2026 16:08:57 +0800 Subject: [PATCH] feat: migrate textindex service into deepin-anything MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move dde-file-manager's textindex service and extractor app into this repo as the user-level systemd service deepin-anything-index and its private subprocess deepin-anything-extractor (Phase 1 of the migration design, docs/design/textindex-migration.md). - src/index: 1:1 port of src/services/textindex; plugin.cpp rewritten as main() entry (serviceentry.{h,cpp}); interface XMLs moved here as the single source of truth; new Type=dbus user unit + activation file - src/extractor: 1:1 port of dde-file-manager-extractor; comm library installed to standard libdir, plugins to deepin-anything/extractor - src/common: ProcessPriorityManager (only shared piece) - Drop all dfm-base dependencies: bare qDebug logging, direct Dtk6 DConfig access, no LoggerRules/categories - Rename per naming table: anything_index/deepin_anything_extractor/ anything_extractor_plugin namespaces, new plugin IID, kIndexSystemd- UnitName, ANYTHING_EXTRACTOR_TOOL (+ env override for debugging), pinyin dict at /usr/share/deepin-anything-index - Frozen contracts untouched: D-Bus names/paths/interfaces, dconfig schema, index data dirs, index versions 6/3/1 - autotests/index: white-box ut-anything-index (63 files, 1101 cases, all passing), OPT_ENABLE_BUILD_UT gate, run-ut.sh with lcov coverage - debian: new deepin-anything-index package (Architecture: any, Replaces: dde-file-manager << 6.6.7) + Build-Depends refresh 将 dde-file-manager 的 textindex 服务与 extractor 迁入本仓库，成为 user 级 systemd 服务 deepin-anything-index 及其私有子进程 deepin-anything-extractor（迁移设计阶段一，详见设计文档）。 - src/index 平移 textindex；plugin.cpp 重写为 main 入口；接口 XML 迁入作为唯一来源；新增 Type=dbus 用户单元与 activation 文件 - src/extractor 平移 extractor；通信库装标准 libdir，插件装新目录 - 去 dfm-base 依赖：裸 qDebug 日志、Dtk6 DConfig 直连、删类别体系 - 按命名定稿表完成更名；冻结契约（D-Bus 名/路径/接口、dconfig、 索引目录、索引版本 6/3/1）一字未动 - 根级 autotests/index 白盒测试 1101 用例全过；run-ut.sh 一键跑 + lcov 覆盖率报告 - debian 新增 deepin-anything-index 包（any 架构，Replaces 接管）并 恢复/新增构建依赖 Log: textindex 索引服务与 extractor 迁入 deepin-anything --- .gitignore | 2 +- 3rdparty/testutils/cpp-stub/addr_any.h | 280 + 3rdparty/testutils/cpp-stub/addr_pri.h | 177 + 3rdparty/testutils/cpp-stub/elfio.hpp | 4888 +++++++++++++++++ 3rdparty/testutils/cpp-stub/stub.h | 360 ++ 3rdparty/testutils/dfm_asan_helper.h | 44 + 3rdparty/testutils/dfm_test_main.h | 40 + 3rdparty/testutils/stub-ext/stub-shadow.cpp | 31 + 3rdparty/testutils/stub-ext/stub-shadow.h | 162 + 3rdparty/testutils/stub-ext/stubext.h | 103 + AGENTS.md | 35 +- CMakeLists.txt | 19 + LICENSES/MIT.txt | 9 + README.md | 14 +- README.zh_CN.md | 14 +- REUSE.toml | 20 +- autotests/CMakeLists.txt | 21 + autotests/gen-ut-summary.py | 127 + autotests/index/CMakeLists.txt | 41 + autotests/index/main.cpp | 9 + autotests/index/test_backlogtracker.cpp | 86 + autotests/index/test_contentdeduplication.cpp | 81 + .../index/test_contentdocumentbuilder.cpp | 192 + autotests/index/test_controllerpipe.cpp | 88 + autotests/index/test_dbus.cpp | 535 ++ autotests/index/test_docutils.cpp | 268 + autotests/index/test_envdetector.cpp | 259 + autotests/index/test_filehash.cpp | 122 + .../index/test_filenamedocumentbuilder.cpp | 333 ++ autotests/index/test_filenameindexdbus.cpp | 305 + autotests/index/test_fileprovider.cpp | 565 ++ autotests/index/test_filetypemapper.cpp | 182 + autotests/index/test_fseventcollector.cpp | 389 ++ .../index/test_fseventcollector_extra.cpp | 148 + .../index/test_fseventcollector_private.cpp | 638 +++ autotests/index/test_fseventcontroller.cpp | 169 + autotests/index/test_fsmonitor_api.cpp | 94 + autotests/index/test_fsmonitor_extra.cpp | 136 + autotests/index/test_fsmonitor_private.cpp | 422 ++ autotests/index/test_fsmonitorworker.cpp | 186 + .../index/test_fsmonitorworker_extra.cpp | 175 + autotests/index/test_idlemonitor_extra.cpp | 137 + .../index/test_index_directory_exclusion.cpp | 198 + autotests/index/test_indexcontentmigrator.cpp | 90 + autotests/index/test_indexextractor.cpp | 51 + autotests/index/test_indexprofile.cpp | 585 ++ autotests/index/test_indexruntime.cpp | 78 + autotests/index/test_indexruntime_extra.cpp | 140 + autotests/index/test_indexstatestore.cpp | 286 + autotests/index/test_indextask.cpp | 206 + autotests/index/test_indextraverseutils.cpp | 249 + autotests/index/test_indexutility.cpp | 199 + .../index/test_inotifyfilesystemwatcher.cpp | 565 ++ autotests/index/test_loadmonitor.cpp | 582 ++ .../index/test_lowercasengramanalyzer.cpp | 40 + autotests/index/test_moveprocessor.cpp | 108 + .../index/test_moveprocessor_withindex.cpp | 658 +++ autotests/index/test_ocrdeduplication.cpp | 108 + autotests/index/test_ocrdocumentbuilder.cpp | 189 + autotests/index/test_ocrindexdbus_extra.cpp | 183 + autotests/index/test_ocrindexdbus_private.cpp | 207 + autotests/index/test_pathcalculator.cpp | 117 + autotests/index/test_pathexcludematcher.cpp | 147 + autotests/index/test_pinyinprocessor.cpp | 316 ++ autotests/index/test_plugin.cpp | 130 + autotests/index/test_processextractor.cpp | 119 + .../index/test_processextractor_extra.cpp | 169 + autotests/index/test_progressnotifier.cpp | 60 + autotests/index/test_systemdcpuutils.cpp | 39 + .../index/test_taskhandler_factories.cpp | 109 + autotests/index/test_taskhandler_helpers.cpp | 424 ++ .../index/test_taskhandler_withindex.cpp | 271 + autotests/index/test_taskmanager.cpp | 369 ++ autotests/index/test_taskmanager_grading.cpp | 752 +++ autotests/index/test_taskmanager_private.cpp | 192 + autotests/index/test_taskmanager_safe.cpp | 124 + autotests/index/test_taskqueueutils.cpp | 98 + autotests/index/test_textindexconfig.cpp | 92 + autotests/index/test_textindexdbus_extra.cpp | 192 + .../index/test_textindexdbus_private.cpp | 228 + .../test_vfsmonitorfilesystemwatcher.cpp | 977 ++++ autotests/index/test_workerpipe.cpp | 86 + autotests/run-ut.sh | 198 + cmake/AnythingTestUtils.cmake | 67 + config/CMakeLists.txt | 3 +- debian/control | 19 + debian/deepin-anything-index.install | 7 + debian/deepin-anything-server.install | 5 +- examples/env-monitor/CMakeLists.txt | 51 + examples/env-monitor/main.cpp | 31 + examples/env-monitor/mainwindow.cpp | 282 + examples/env-monitor/mainwindow.h | 63 + examples/extractor-demo/CMakeLists.txt | 42 + examples/extractor-demo/main.cpp | 32 + examples/extractor-demo/mainwindow.cpp | 427 ++ examples/extractor-demo/mainwindow.h | 81 + src/CMakeLists.txt | 10 +- src/common/CMakeLists.txt | 21 + src/common/processprioritymanager.cpp | 193 + src/common/processprioritymanager.h | 94 + src/dispatcher/CMakeLists.txt | 3 + src/extractor/CMakeLists.txt | 19 + src/extractor/extractor.json | 5 + src/extractor/extractor/CMakeLists.txt | 42 + src/extractor/extractor/extractorapp.cpp | 132 + src/extractor/extractor/extractorapp.h | 64 + src/extractor/extractor/main.cpp | 76 + src/extractor/extractor/pluginloader.cpp | 112 + src/extractor/extractor/pluginloader.h | 68 + src/extractor/libextractor/CMakeLists.txt | 54 + src/extractor/libextractor/controllerpipe.cpp | 300 + src/extractor/libextractor/controllerpipe.h | 120 + src/extractor/libextractor/extractor_global.h | 16 + src/extractor/libextractor/extractortypes.h | 69 + src/extractor/libextractor/workerpipe.cpp | 256 + src/extractor/libextractor/workerpipe.h | 101 + src/extractor/plugins/CMakeLists.txt | 6 + .../plugins/abstractextractorplugin.h | 78 + .../plugins/extractor_plugin_global.h | 16 + .../plugins/ocr-extractor/CMakeLists.txt | 61 + .../plugins/ocr-extractor/ocrextractor.cpp | 338 ++ .../plugins/ocr-extractor/ocrextractor.h | 28 + .../plugins/ocr-extractor/ocrextractor.json | 5 + .../ocr-extractor/ocrextractorplugin.cpp | 35 + .../ocr-extractor/ocrextractorplugin.h | 31 + .../plugins/text-extractor/CMakeLists.txt | 63 + .../plugins/text-extractor/textextractor.cpp | 259 + .../plugins/text-extractor/textextractor.h | 58 + .../plugins/text-extractor/textextractor.json | 5 + .../text-extractor/textextractorplugin.cpp | 36 + .../text-extractor/textextractorplugin.h | 34 + src/index/CMakeLists.txt | 152 + .../org.deepin.Filemanager.FileNameIndex.xml | 71 + .../dbus/org.deepin.Filemanager.OcrIndex.xml | 71 + .../org.deepin.Filemanager.TextIndex.service | 4 + .../dbus/org.deepin.Filemanager.TextIndex.xml | 71 + src/index/core/indexcontext.h | 58 + src/index/core/indexruntime.cpp | 72 + src/index/core/indexruntime.h | 56 + src/index/dbus/filenameindexdbus.cpp | 341 ++ src/index/dbus/filenameindexdbus.h | 54 + src/index/dbus/ocrindexdbus.cpp | 352 ++ src/index/dbus/ocrindexdbus.h | 54 + src/index/dbus/private/filenameindexdbus_p.h | 46 + src/index/dbus/private/ocrindexdbus_p.h | 51 + src/index/dbus/private/textindexdbus_p.h | 60 + src/index/dbus/textindexdbus.cpp | 377 ++ src/index/dbus/textindexdbus.h | 54 + src/index/deepin-anything-index.service | 16 + src/index/document/builderoptions.h | 28 + src/index/document/contentdocumentbuilder.cpp | 106 + src/index/document/contentdocumentbuilder.h | 25 + .../document/filenamedocumentbuilder.cpp | 150 + src/index/document/filenamedocumentbuilder.h | 27 + src/index/document/indexdocumentbuilder.h | 54 + src/index/document/ocrdocumentbuilder.cpp | 109 + src/index/document/ocrdocumentbuilder.h | 25 + src/index/env/envdetector.cpp | 86 + src/index/env/envdetector.h | 76 + src/index/env/idlemonitor.cpp | 68 + src/index/env/idlemonitor.h | 55 + src/index/env/loadmonitor.cpp | 194 + src/index/env/loadmonitor.h | 82 + src/index/env/powermonitor.cpp | 137 + src/index/env/powermonitor.h | 58 + src/index/extractor/contentdeduplication.cpp | 63 + src/index/extractor/contentdeduplication.h | 35 + src/index/extractor/indexextractor.h | 33 + src/index/extractor/ocrdeduplication.cpp | 63 + src/index/extractor/ocrdeduplication.h | 35 + src/index/extractor/processextractor.cpp | 326 ++ src/index/extractor/processextractor.h | 32 + src/index/fsmonitor/fseventcollector.cpp | 940 ++++ src/index/fsmonitor/fseventcollector.h | 124 + src/index/fsmonitor/fseventcollector_p.h | 128 + src/index/fsmonitor/fseventcontroller.cpp | 385 ++ src/index/fsmonitor/fseventcontroller.h | 79 + src/index/fsmonitor/fsmonitor.cpp | 753 +++ src/index/fsmonitor/fsmonitor.h | 128 + src/index/fsmonitor/fsmonitor_p.h | 120 + src/index/fsmonitor/fsmonitorworker.cpp | 226 + src/index/fsmonitor/fsmonitorworker.h | 81 + .../fsmonitor/inotifyfilesystemwatcher.cpp | 469 ++ .../fsmonitor/inotifyfilesystemwatcher.h | 81 + .../fsmonitor/inotifyfilesystemwatcher_p.h | 49 + src/index/fsmonitor/vfsmonitorwatcher.cpp | 862 +++ src/index/fsmonitor/vfsmonitorwatcher.h | 77 + src/index/fsmonitor/vfsmonitorwatcher_p.h | 162 + src/index/index_global.h | 105 + src/index/main.cpp | 69 + src/index/profile/indexprofile.cpp | 382 ++ src/index/profile/indexprofile.h | 244 + src/index/profile/lowercasengramanalyzer.cpp | 64 + src/index/profile/lowercasengramanalyzer.h | 32 + src/index/serviceentry.cpp | 81 + src/index/serviceentry.h | 21 + src/index/state/indexstatestore.cpp | 294 + src/index/state/indexstatestore.h | 319 ++ src/index/task/backlogtracker.cpp | 75 + src/index/task/backlogtracker.h | 49 + src/index/task/fileprovider.cpp | 421 ++ src/index/task/fileprovider.h | 82 + src/index/task/indexcontentmigrator.cpp | 162 + src/index/task/indexcontentmigrator.h | 90 + src/index/task/indextask.cpp | 246 + src/index/task/indextask.h | 94 + src/index/task/moveprocessor.cpp | 407 ++ src/index/task/moveprocessor.h | 133 + src/index/task/progressnotifier.cpp | 13 + src/index/task/progressnotifier.h | 29 + src/index/task/taskhandler.cpp | 1471 +++++ src/index/task/taskhandler.h | 64 + src/index/task/taskmanager.cpp | 1290 +++++ src/index/task/taskmanager.h | 144 + src/index/task/taskqueueutils.cpp | 128 + src/index/task/taskqueueutils.h | 32 + src/index/utils/docutils.cpp | 66 + src/index/utils/docutils.h | 29 + src/index/utils/filehash.cpp | 31 + src/index/utils/filehash.h | 27 + src/index/utils/filetypemapper.cpp | 112 + src/index/utils/filetypemapper.h | 33 + src/index/utils/indextraverseutils.cpp | 135 + src/index/utils/indextraverseutils.h | 38 + src/index/utils/indexutility.cpp | 369 ++ src/index/utils/indexutility.h | 191 + src/index/utils/pathexcludematcher.cpp | 211 + src/index/utils/pathexcludematcher.h | 185 + src/index/utils/pinyinprocessor.cpp | 186 + src/index/utils/pinyinprocessor.h | 50 + src/index/utils/scopeguard.h | 35 + src/index/utils/systemdcpuutils.cpp | 156 + src/index/utils/systemdcpuutils.h | 58 + src/index/utils/taskstate.h | 58 + src/index/utils/textindexconfig.cpp | 364 ++ src/index/utils/textindexconfig.h | 120 + src/index/utils/threadscheduling.cpp | 30 + src/index/utils/threadscheduling.h | 35 + src/kernelmod/CMakeLists.txt | 2 +- src/logger/CMakeLists.txt | 3 + src/server/CMakeLists.txt | 3 + 241 files changed, 43288 insertions(+), 26 deletions(-) create mode 100644 3rdparty/testutils/cpp-stub/addr_any.h create mode 100644 3rdparty/testutils/cpp-stub/addr_pri.h create mode 100644 3rdparty/testutils/cpp-stub/elfio.hpp create mode 100644 3rdparty/testutils/cpp-stub/stub.h create mode 100644 3rdparty/testutils/dfm_asan_helper.h create mode 100644 3rdparty/testutils/dfm_test_main.h create mode 100644 3rdparty/testutils/stub-ext/stub-shadow.cpp create mode 100644 3rdparty/testutils/stub-ext/stub-shadow.h create mode 100644 3rdparty/testutils/stub-ext/stubext.h create mode 100644 LICENSES/MIT.txt create mode 100644 autotests/CMakeLists.txt create mode 100755 autotests/gen-ut-summary.py create mode 100644 autotests/index/CMakeLists.txt create mode 100644 autotests/index/main.cpp create mode 100644 autotests/index/test_backlogtracker.cpp create mode 100644 autotests/index/test_contentdeduplication.cpp create mode 100644 autotests/index/test_contentdocumentbuilder.cpp create mode 100644 autotests/index/test_controllerpipe.cpp create mode 100644 autotests/index/test_dbus.cpp create mode 100644 autotests/index/test_docutils.cpp create mode 100644 autotests/index/test_envdetector.cpp create mode 100644 autotests/index/test_filehash.cpp create mode 100644 autotests/index/test_filenamedocumentbuilder.cpp create mode 100644 autotests/index/test_filenameindexdbus.cpp create mode 100644 autotests/index/test_fileprovider.cpp create mode 100644 autotests/index/test_filetypemapper.cpp create mode 100644 autotests/index/test_fseventcollector.cpp create mode 100644 autotests/index/test_fseventcollector_extra.cpp create mode 100644 autotests/index/test_fseventcollector_private.cpp create mode 100644 autotests/index/test_fseventcontroller.cpp create mode 100644 autotests/index/test_fsmonitor_api.cpp create mode 100644 autotests/index/test_fsmonitor_extra.cpp create mode 100644 autotests/index/test_fsmonitor_private.cpp create mode 100644 autotests/index/test_fsmonitorworker.cpp create mode 100644 autotests/index/test_fsmonitorworker_extra.cpp create mode 100644 autotests/index/test_idlemonitor_extra.cpp create mode 100644 autotests/index/test_index_directory_exclusion.cpp create mode 100644 autotests/index/test_indexcontentmigrator.cpp create mode 100644 autotests/index/test_indexextractor.cpp create mode 100644 autotests/index/test_indexprofile.cpp create mode 100644 autotests/index/test_indexruntime.cpp create mode 100644 autotests/index/test_indexruntime_extra.cpp create mode 100644 autotests/index/test_indexstatestore.cpp create mode 100644 autotests/index/test_indextask.cpp create mode 100644 autotests/index/test_indextraverseutils.cpp create mode 100644 autotests/index/test_indexutility.cpp create mode 100644 autotests/index/test_inotifyfilesystemwatcher.cpp create mode 100644 autotests/index/test_loadmonitor.cpp create mode 100644 autotests/index/test_lowercasengramanalyzer.cpp create mode 100644 autotests/index/test_moveprocessor.cpp create mode 100644 autotests/index/test_moveprocessor_withindex.cpp create mode 100644 autotests/index/test_ocrdeduplication.cpp create mode 100644 autotests/index/test_ocrdocumentbuilder.cpp create mode 100644 autotests/index/test_ocrindexdbus_extra.cpp create mode 100644 autotests/index/test_ocrindexdbus_private.cpp create mode 100644 autotests/index/test_pathcalculator.cpp create mode 100644 autotests/index/test_pathexcludematcher.cpp create mode 100644 autotests/index/test_pinyinprocessor.cpp create mode 100644 autotests/index/test_plugin.cpp create mode 100644 autotests/index/test_processextractor.cpp create mode 100644 autotests/index/test_processextractor_extra.cpp create mode 100644 autotests/index/test_progressnotifier.cpp create mode 100644 autotests/index/test_systemdcpuutils.cpp create mode 100644 autotests/index/test_taskhandler_factories.cpp create mode 100644 autotests/index/test_taskhandler_helpers.cpp create mode 100644 autotests/index/test_taskhandler_withindex.cpp create mode 100644 autotests/index/test_taskmanager.cpp create mode 100644 autotests/index/test_taskmanager_grading.cpp create mode 100644 autotests/index/test_taskmanager_private.cpp create mode 100644 autotests/index/test_taskmanager_safe.cpp create mode 100644 autotests/index/test_taskqueueutils.cpp create mode 100644 autotests/index/test_textindexconfig.cpp create mode 100644 autotests/index/test_textindexdbus_extra.cpp create mode 100644 autotests/index/test_textindexdbus_private.cpp create mode 100644 autotests/index/test_vfsmonitorfilesystemwatcher.cpp create mode 100644 autotests/index/test_workerpipe.cpp create mode 100755 autotests/run-ut.sh create mode 100644 cmake/AnythingTestUtils.cmake create mode 100644 debian/deepin-anything-index.install create mode 100644 examples/env-monitor/CMakeLists.txt create mode 100644 examples/env-monitor/main.cpp create mode 100644 examples/env-monitor/mainwindow.cpp create mode 100644 examples/env-monitor/mainwindow.h create mode 100644 examples/extractor-demo/CMakeLists.txt create mode 100644 examples/extractor-demo/main.cpp create mode 100644 examples/extractor-demo/mainwindow.cpp create mode 100644 examples/extractor-demo/mainwindow.h create mode 100644 src/common/CMakeLists.txt create mode 100644 src/common/processprioritymanager.cpp create mode 100644 src/common/processprioritymanager.h create mode 100644 src/extractor/CMakeLists.txt create mode 100644 src/extractor/extractor.json create mode 100644 src/extractor/extractor/CMakeLists.txt create mode 100644 src/extractor/extractor/extractorapp.cpp create mode 100644 src/extractor/extractor/extractorapp.h create mode 100644 src/extractor/extractor/main.cpp create mode 100644 src/extractor/extractor/pluginloader.cpp create mode 100644 src/extractor/extractor/pluginloader.h create mode 100644 src/extractor/libextractor/CMakeLists.txt create mode 100644 src/extractor/libextractor/controllerpipe.cpp create mode 100644 src/extractor/libextractor/controllerpipe.h create mode 100644 src/extractor/libextractor/extractor_global.h create mode 100644 src/extractor/libextractor/extractortypes.h create mode 100644 src/extractor/libextractor/workerpipe.cpp create mode 100644 src/extractor/libextractor/workerpipe.h create mode 100644 src/extractor/plugins/CMakeLists.txt create mode 100644 src/extractor/plugins/abstractextractorplugin.h create mode 100644 src/extractor/plugins/extractor_plugin_global.h create mode 100644 src/extractor/plugins/ocr-extractor/CMakeLists.txt create mode 100644 src/extractor/plugins/ocr-extractor/ocrextractor.cpp create mode 100644 src/extractor/plugins/ocr-extractor/ocrextractor.h create mode 100644 src/extractor/plugins/ocr-extractor/ocrextractor.json create mode 100644 src/extractor/plugins/ocr-extractor/ocrextractorplugin.cpp create mode 100644 src/extractor/plugins/ocr-extractor/ocrextractorplugin.h create mode 100644 src/extractor/plugins/text-extractor/CMakeLists.txt create mode 100644 src/extractor/plugins/text-extractor/textextractor.cpp create mode 100644 src/extractor/plugins/text-extractor/textextractor.h create mode 100644 src/extractor/plugins/text-extractor/textextractor.json create mode 100644 src/extractor/plugins/text-extractor/textextractorplugin.cpp create mode 100644 src/extractor/plugins/text-extractor/textextractorplugin.h create mode 100644 src/index/CMakeLists.txt create mode 100644 src/index/assets/dbus/org.deepin.Filemanager.FileNameIndex.xml create mode 100644 src/index/assets/dbus/org.deepin.Filemanager.OcrIndex.xml create mode 100644 src/index/assets/dbus/org.deepin.Filemanager.TextIndex.service create mode 100644 src/index/assets/dbus/org.deepin.Filemanager.TextIndex.xml create mode 100644 src/index/core/indexcontext.h create mode 100644 src/index/core/indexruntime.cpp create mode 100644 src/index/core/indexruntime.h create mode 100644 src/index/dbus/filenameindexdbus.cpp create mode 100644 src/index/dbus/filenameindexdbus.h create mode 100644 src/index/dbus/ocrindexdbus.cpp create mode 100644 src/index/dbus/ocrindexdbus.h create mode 100644 src/index/dbus/private/filenameindexdbus_p.h create mode 100644 src/index/dbus/private/ocrindexdbus_p.h create mode 100644 src/index/dbus/private/textindexdbus_p.h create mode 100644 src/index/dbus/textindexdbus.cpp create mode 100644 src/index/dbus/textindexdbus.h create mode 100644 src/index/deepin-anything-index.service create mode 100644 src/index/document/builderoptions.h create mode 100644 src/index/document/contentdocumentbuilder.cpp create mode 100644 src/index/document/contentdocumentbuilder.h create mode 100644 src/index/document/filenamedocumentbuilder.cpp create mode 100644 src/index/document/filenamedocumentbuilder.h create mode 100644 src/index/document/indexdocumentbuilder.h create mode 100644 src/index/document/ocrdocumentbuilder.cpp create mode 100644 src/index/document/ocrdocumentbuilder.h create mode 100644 src/index/env/envdetector.cpp create mode 100644 src/index/env/envdetector.h create mode 100644 src/index/env/idlemonitor.cpp create mode 100644 src/index/env/idlemonitor.h create mode 100644 src/index/env/loadmonitor.cpp create mode 100644 src/index/env/loadmonitor.h create mode 100644 src/index/env/powermonitor.cpp create mode 100644 src/index/env/powermonitor.h create mode 100644 src/index/extractor/contentdeduplication.cpp create mode 100644 src/index/extractor/contentdeduplication.h create mode 100644 src/index/extractor/indexextractor.h create mode 100644 src/index/extractor/ocrdeduplication.cpp create mode 100644 src/index/extractor/ocrdeduplication.h create mode 100644 src/index/extractor/processextractor.cpp create mode 100644 src/index/extractor/processextractor.h create mode 100644 src/index/fsmonitor/fseventcollector.cpp create mode 100644 src/index/fsmonitor/fseventcollector.h create mode 100644 src/index/fsmonitor/fseventcollector_p.h create mode 100644 src/index/fsmonitor/fseventcontroller.cpp create mode 100644 src/index/fsmonitor/fseventcontroller.h create mode 100644 src/index/fsmonitor/fsmonitor.cpp create mode 100644 src/index/fsmonitor/fsmonitor.h create mode 100644 src/index/fsmonitor/fsmonitor_p.h create mode 100644 src/index/fsmonitor/fsmonitorworker.cpp create mode 100644 src/index/fsmonitor/fsmonitorworker.h create mode 100644 src/index/fsmonitor/inotifyfilesystemwatcher.cpp create mode 100644 src/index/fsmonitor/inotifyfilesystemwatcher.h create mode 100644 src/index/fsmonitor/inotifyfilesystemwatcher_p.h create mode 100644 src/index/fsmonitor/vfsmonitorwatcher.cpp create mode 100644 src/index/fsmonitor/vfsmonitorwatcher.h create mode 100644 src/index/fsmonitor/vfsmonitorwatcher_p.h create mode 100644 src/index/index_global.h create mode 100644 src/index/main.cpp create mode 100644 src/index/profile/indexprofile.cpp create mode 100644 src/index/profile/indexprofile.h create mode 100644 src/index/profile/lowercasengramanalyzer.cpp create mode 100644 src/index/profile/lowercasengramanalyzer.h create mode 100644 src/index/serviceentry.cpp create mode 100644 src/index/serviceentry.h create mode 100644 src/index/state/indexstatestore.cpp create mode 100644 src/index/state/indexstatestore.h create mode 100644 src/index/task/backlogtracker.cpp create mode 100644 src/index/task/backlogtracker.h create mode 100644 src/index/task/fileprovider.cpp create mode 100644 src/index/task/fileprovider.h create mode 100644 src/index/task/indexcontentmigrator.cpp create mode 100644 src/index/task/indexcontentmigrator.h create mode 100644 src/index/task/indextask.cpp create mode 100644 src/index/task/indextask.h create mode 100644 src/index/task/moveprocessor.cpp create mode 100644 src/index/task/moveprocessor.h create mode 100644 src/index/task/progressnotifier.cpp create mode 100644 src/index/task/progressnotifier.h create mode 100644 src/index/task/taskhandler.cpp create mode 100644 src/index/task/taskhandler.h create mode 100644 src/index/task/taskmanager.cpp create mode 100644 src/index/task/taskmanager.h create mode 100644 src/index/task/taskqueueutils.cpp create mode 100644 src/index/task/taskqueueutils.h create mode 100644 src/index/utils/docutils.cpp create mode 100644 src/index/utils/docutils.h create mode 100644 src/index/utils/filehash.cpp create mode 100644 src/index/utils/filehash.h create mode 100644 src/index/utils/filetypemapper.cpp create mode 100644 src/index/utils/filetypemapper.h create mode 100644 src/index/utils/indextraverseutils.cpp create mode 100644 src/index/utils/indextraverseutils.h create mode 100644 src/index/utils/indexutility.cpp create mode 100644 src/index/utils/indexutility.h create mode 100644 src/index/utils/pathexcludematcher.cpp create mode 100644 src/index/utils/pathexcludematcher.h create mode 100644 src/index/utils/pinyinprocessor.cpp create mode 100644 src/index/utils/pinyinprocessor.h create mode 100644 src/index/utils/scopeguard.h create mode 100644 src/index/utils/systemdcpuutils.cpp create mode 100644 src/index/utils/systemdcpuutils.h create mode 100644 src/index/utils/taskstate.h create mode 100644 src/index/utils/textindexconfig.cpp create mode 100644 src/index/utils/textindexconfig.h create mode 100644 src/index/utils/threadscheduling.cpp create mode 100644 src/index/utils/threadscheduling.h diff --git a/.gitignore b/.gitignore index 3d42b242..e7c6e9b9 100644 --- a/.gitignore +++ b/.gitignore @@ -13,7 +13,7 @@ deepin-anything-server debug release -build* +build*/ vendor/include/* vendor/lib/* diff --git a/3rdparty/testutils/cpp-stub/addr_any.h b/3rdparty/testutils/cpp-stub/addr_any.h new file mode 100644 index 00000000..a153f348 --- /dev/null +++ b/3rdparty/testutils/cpp-stub/addr_any.h @@ -0,0 +1,280 @@ +#ifndef __ADDR_ANY_H__ +#define __ADDR_ANY_H__ + + +//linux +#include +#include +//c +#include +#include +#include + +//c++ +#include +#include +//project +#include "elfio.hpp" + + + +class AddrAny +{ +public: + AddrAny() + { + m_init = get_exe_pathname(m_fullname); + m_baseaddr = 0; + } + AddrAny(std::string libname) + { + m_init = get_lib_pathname_and_baseaddr(libname, m_fullname, m_baseaddr); + } + + int get_local_func_addr_symtab(std::string func_name_regex_str, std::map& result) + { + return get_func_addr(SHT_SYMTAB, STB_LOCAL, func_name_regex_str, result); + } + int get_global_func_addr_symtab(std::string func_name_regex_str, std::map& result) + { + return get_func_addr(SHT_SYMTAB, STB_GLOBAL, func_name_regex_str, result); + } + int get_weak_func_addr_symtab(std::string func_name_regex_str, std::map& result) + { + return get_func_addr(SHT_SYMTAB, STB_WEAK, func_name_regex_str, result); + } + + int get_global_func_addr_dynsym( std::string func_name_regex_str, std::map& result) + { + return get_func_addr(SHT_DYNSYM, STB_GLOBAL, func_name_regex_str, result); + } + int get_weak_func_addr_dynsym(std::string func_name_regex_str, std::map& result) + { + return get_func_addr(SHT_DYNSYM, STB_WEAK, func_name_regex_str, result); + } + +private: + bool demangle(std::string& s, std::string& name) { + int status; + char* pname = abi::__cxa_demangle(s.c_str(), 0, 0, &status); + if (status != 0) + { + switch(status) + { + case -1: name = "memory allocation error"; break; + case -2: name = "invalid name given"; break; + case -3: name = "internal error: __cxa_demangle: invalid argument"; break; + default: name = "unknown error occured"; break; + } + return false; + } + name = pname; + free(pname); + return true; + } + bool get_exe_pathname( std::string& name) + { + char line[512]; + FILE *fp; + uintptr_t base_addr; + char perm[5]; + unsigned long offset; + int pathname_pos; + char *pathname; + size_t pathname_len; + int match = 0; + + if(NULL == (fp = fopen("/proc/self/maps", "r"))) + { + return false; + } + + while(fgets(line, sizeof(line), fp)) + { + if(sscanf(line, "%" PRIxPTR "-%*lx %4s %lx %*x:%*x %*d%n", &base_addr, perm, &offset, &pathname_pos) != 3) continue; + + if(0 != offset) continue; + + //get pathname + while(isspace(line[pathname_pos]) && pathname_pos < (int)(sizeof(line) - 1)) + pathname_pos += 1; + if(pathname_pos >= (int)(sizeof(line) - 1)) continue; + pathname = line + pathname_pos; + pathname_len = strlen(pathname); + if(0 == pathname_len) continue; + if(pathname[pathname_len - 1] == '\n') + { + pathname[pathname_len - 1] = '\0'; + pathname_len -= 1; + } + if(0 == pathname_len) continue; + if('[' == pathname[0]) continue; + + name = pathname; + match = 1; + break; + + } + fclose(fp); + + if(0 == match) + { + return false; + } + else + { + return true; + } + + } + + bool get_lib_pathname_and_baseaddr(std::string pathname_regex_str, std::string& name, unsigned long& addr) + { + char line[512]; + FILE *fp; + uintptr_t base_addr; + char perm[5]; + unsigned long offset; + int pathname_pos; + char *pathname; + size_t pathname_len; + int match; + regex_t pathname_regex; + + regcomp(&pathname_regex, pathname_regex_str.c_str(), 0); + + if(NULL == (fp = fopen("/proc/self/maps", "r"))) + { + return false; + } + + while(fgets(line, sizeof(line), fp)) + { + if(sscanf(line, "%" PRIxPTR "-%*lx %4s %lx %*x:%*x %*d%n", &base_addr, perm, &offset, &pathname_pos) != 3) continue; + + //check permission + if(perm[0] != 'r') continue; + if(perm[3] != 'p') continue; //do not touch the shared memory + + //check offset + // + //We are trying to find ELF header in memory. + //It can only be found at the beginning of a mapped memory regions + //whose offset is 0. + if(0 != offset) continue; + + //get pathname + while(isspace(line[pathname_pos]) && pathname_pos < (int)(sizeof(line) - 1)) + pathname_pos += 1; + if(pathname_pos >= (int)(sizeof(line) - 1)) continue; + pathname = line + pathname_pos; + pathname_len = strlen(pathname); + if(0 == pathname_len) continue; + if(pathname[pathname_len - 1] == '\n') + { + pathname[pathname_len - 1] = '\0'; + pathname_len -= 1; + } + if(0 == pathname_len) continue; + if('[' == pathname[0]) continue; + + //check pathname + //if we need to hook this elf? + match = 0; + if(0 == regexec(&pathname_regex, pathname, 0, NULL, 0)) + { + match = 1; + name = pathname; + addr = (unsigned long)base_addr; + break; + } + if(0 == match) continue; + + } + fclose(fp); + if(0 == match) + { + return false; + } + else + { + return true; + } + + } + + int get_func_addr(unsigned int ttype, unsigned int stype, std::string& func_name_regex_str, std::map& result) + { + // Create an elfio reader + ELFIO::elfio reader; + int count = 0; + regex_t pathname_regex; + + if(!m_init) + { + return -1; + } + + regcomp(&pathname_regex, func_name_regex_str.c_str(), 0); + // Load ELF data + if(!reader.load(m_fullname.c_str())) + { + return -1; + } + + ELFIO::Elf_Half sec_num = reader.sections.size(); + for(int i = 0; i < sec_num; ++i) + { + ELFIO::section* psec = reader.sections[i]; + // Check section type + if(psec->get_type() == ttype) + { + const ELFIO::symbol_section_accessor symbols( reader, psec ); + for ( unsigned int j = 0; j < symbols.get_symbols_num(); ++j ) + { + std::string name; + std::string name_mangle; + ELFIO::Elf64_Addr value; + ELFIO::Elf_Xword size; + unsigned char bind; + unsigned char type; + ELFIO::Elf_Half section_index; + unsigned char other; + + // Read symbol properties + symbols.get_symbol( j, name, value, size, bind, type, section_index, other ); + if(type == STT_FUNC && bind == stype) + { + bool ret = demangle(name,name_mangle); + if(ret == true) + { + if (0 == regexec(&pathname_regex, name_mangle.c_str(), 0, NULL, 0)) + { + result.insert ( std::pair(name_mangle,(void*)(value + m_baseaddr))); + count++; + } + } + else + { + if (0 == regexec(&pathname_regex, name.c_str(), 0, NULL, 0)) + { + result.insert ( std::pair(name,(void*)(value + m_baseaddr))); + count++; + } + } + } + } + break; + } + } + + return count; + } +private: + bool m_init; + std::string m_name; + std::string m_fullname; + unsigned long m_baseaddr; + +}; +#endif diff --git a/3rdparty/testutils/cpp-stub/addr_pri.h b/3rdparty/testutils/cpp-stub/addr_pri.h new file mode 100644 index 00000000..9174bb0c --- /dev/null +++ b/3rdparty/testutils/cpp-stub/addr_pri.h @@ -0,0 +1,177 @@ +#ifndef __ADDR_PRI_H__ +#define __ADDR_PRI_H__ + + +#include +#include + + + +//base on C++11 + +/********************************************************** + access private function +**********************************************************/ + + +namespace std { + template + using enable_if_t = typename enable_if::type; + template + using remove_reference_t = typename remove_reference::type; +} // std + +// Unnamed namespace is used to avoid duplicate symbols if the macros are used +namespace { + namespace private_access_detail { + + // @tparam TagType, used to declare different "get" funciton overloads for + // different members/statics + template + struct private_access { + // Normal lookup cannot find in-class defined (inline) friend functions. + friend PtrType get(TagType) { return PtrValue; } + }; + + } // namespace private_access_detail +} // namespace + +// Used macro naming conventions: +// The "namespace" of this macro library is PRIVATE_ACCESS, i.e. all +// macro here has this prefix. +// All implementation macro, which are not meant to be used directly have the +// PRIVATE_ACCESS_DETAIL prefix. +// Some macros have the ABCD_IMPL form, which means they contain the +// implementation details for the specific ABCD macro. + +#define PRIVATE_ACCESS_DETAIL_CONCATENATE_IMPL(x, y) x##y +#define PRIVATE_ACCESS_DETAIL_CONCATENATE(x, y) \ + PRIVATE_ACCESS_DETAIL_CONCATENATE_IMPL(x, y) + +// @param PtrTypeKind E.g if we have "class A", then it can be "A::*" in case of +// members, or it can be "*" in case of statics. +#define PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE(Tag, Class, Type, Name, \ + PtrTypeKind) \ + namespace { \ + namespace private_access_detail { \ + /* Tag type, used to declare different get funcitons for different \ + * members \ + */ \ + struct Tag {}; \ + /* Explicit instantiation */ \ + template struct private_access; \ + /* We can build the PtrType only with two aliases */ \ + /* E.g. using PtrType = int(int) *; would be illformed */ \ + using PRIVATE_ACCESS_DETAIL_CONCATENATE(Alias_, Tag) = Type; \ + using PRIVATE_ACCESS_DETAIL_CONCATENATE(PtrType_, Tag) = \ + PRIVATE_ACCESS_DETAIL_CONCATENATE(Alias_, Tag) PtrTypeKind; \ + /* Declare the friend function, now it is visible in namespace scope. \ + * Note, \ + * we could declare it inside the Tag type too, in that case ADL would \ + * find \ + * the declaration. By choosing to declare it here, the Tag type remains \ + * a \ + * simple tag type, it has no other responsibilities. */ \ + PRIVATE_ACCESS_DETAIL_CONCATENATE(PtrType_, Tag) get(Tag); \ + } \ + } + +#define PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_FIELD(Tag, Class, Type, Name) \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE(Tag, Class, Type, Name, Class::*) \ + namespace { \ + namespace access_private_field { \ + Type &Class##Name(Class &&t) { return t.*get(private_access_detail::Tag{}); } \ + Type &Class##Name(Class &t) { return t.*get(private_access_detail::Tag{}); } \ + /* The following usings are here to avoid duplicate const qualifier \ + * warnings \ + */ \ + using PRIVATE_ACCESS_DETAIL_CONCATENATE(X, Tag) = Type; \ + using PRIVATE_ACCESS_DETAIL_CONCATENATE(Y, Tag) = \ + const PRIVATE_ACCESS_DETAIL_CONCATENATE(X, Tag); \ + PRIVATE_ACCESS_DETAIL_CONCATENATE(Y, Tag) & Class##Name(const Class &t) {\ + return t.*get(private_access_detail::Tag{}); \ + } \ + } \ + } + +#define PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_FUN(Tag, Class, Type, Name) \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE(Tag, Class, Type, Name, Class::*) \ + namespace { \ + namespace call_private_fun { \ + /* We do perfect forwarding, but we want to restrict the overload set \ + * only for objects which have the type Class. */ \ + template , \ + Class>::value> * = nullptr, \ + typename... Args> \ + auto Class##Name(Obj &&o, Args &&... args) -> decltype( \ + (std::forward(o).* \ + get(private_access_detail::Tag{}))(std::forward(args)...)) { \ + return (std::forward(o).*get(private_access_detail::Tag{}))( \ + std::forward(args)...); \ + } \ + } \ + namespace get_private_fun { \ + auto Class##Name() -> decltype( \ + get(private_access_detail::Tag{})) { \ + return (get(private_access_detail::Tag{})); \ + } \ + } \ + } + +#define PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_STATIC_FIELD(Tag, Class, Type, \ + Name) \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE(Tag, Class, Type, Name, *) \ + namespace { \ + namespace access_private_static_field { \ + namespace Class { \ + Type &Class##Name() { return *get(private_access_detail::Tag{}); } \ + } \ + } \ + } + +#define PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_STATIC_FUN(Tag, Class, Type, \ + Name) \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE(Tag, Class, Type, Name, *) \ + namespace { \ + namespace call_private_static_fun { \ + namespace Class { \ + template \ + auto Class##Name(Args &&... args) -> decltype( \ + get(private_access_detail::Tag{})(std::forward(args)...)) { \ + return get(private_access_detail::Tag{})( \ + std::forward(args)...); \ + } \ + } \ + } \ + namespace get_private_static_fun { \ + namespace Class { \ + auto Class##Name() -> decltype(get(private_access_detail::Tag{})) { \ + return get(private_access_detail::Tag{}); \ + } \ + } \ + } \ + } + +#define PRIVATE_ACCESS_DETAIL_UNIQUE_TAG \ + PRIVATE_ACCESS_DETAIL_CONCATENATE(PrivateAccessTag, __COUNTER__) + +#define ACCESS_PRIVATE_FIELD(Class, Type, Name) \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_FIELD(PRIVATE_ACCESS_DETAIL_UNIQUE_TAG, \ + Class, Type, Name) + +#define ACCESS_PRIVATE_FUN(Class, Type, Name) \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_FUN(PRIVATE_ACCESS_DETAIL_UNIQUE_TAG, \ + Class, Type, Name) + +#define ACCESS_PRIVATE_STATIC_FIELD(Class, Type, Name) \ + Type Class::Name; \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_STATIC_FIELD( \ + PRIVATE_ACCESS_DETAIL_UNIQUE_TAG, Class, Type, Name) + +#define ACCESS_PRIVATE_STATIC_FUN(Class, Type, Name) \ + PRIVATE_ACCESS_DETAIL_ACCESS_PRIVATE_STATIC_FUN( \ + PRIVATE_ACCESS_DETAIL_UNIQUE_TAG, Class, Type, Name) + +#endif diff --git a/3rdparty/testutils/cpp-stub/elfio.hpp b/3rdparty/testutils/cpp-stub/elfio.hpp new file mode 100644 index 00000000..dd5c9aec --- /dev/null +++ b/3rdparty/testutils/cpp-stub/elfio.hpp @@ -0,0 +1,4888 @@ + +/*** Start of inlined file: elfio_dump.hpp ***/ +#ifndef ELFIO_DUMP_HPP +#define ELFIO_DUMP_HPP + +#include +#include +#include +#include +#include + +/*** Start of inlined file: elfio.hpp ***/ +#ifndef ELFIO_HPP +#define ELFIO_HPP + +#ifdef _MSC_VER +#pragma warning( push ) +#pragma warning( disable : 4996 ) +#pragma warning( disable : 4355 ) +#pragma warning( disable : 4244 ) +#endif + +#include +#include +#include +#include +#include +#include +#include +#include + + +/*** Start of inlined file: elf_types.hpp ***/ +#ifndef ELFTYPES_H +#define ELFTYPES_H + +#ifndef ELFIO_NO_OWN_TYPES +#if !defined( ELFIO_NO_CSTDINT ) && !defined( ELFIO_NO_INTTYPES ) +#include +#else +typedef unsigned char uint8_t; +typedef signed char int8_t; +typedef unsigned short uint16_t; +typedef signed short int16_t; +#ifdef _MSC_VER +typedef unsigned __int32 uint32_t; +typedef signed __int32 int32_t; +typedef unsigned __int64 uint64_t; +typedef signed __int64 int64_t; +#else +typedef unsigned int uint32_t; +typedef signed int int32_t; +typedef unsigned long long uint64_t; +typedef signed long long int64_t; +#endif // _MSC_VER +#endif // ELFIO_NO_CSTDINT +#endif // ELFIO_NO_OWN_TYPES + +namespace ELFIO { + +// Attention! Platform depended definitions. +typedef uint16_t Elf_Half; +typedef uint32_t Elf_Word; +typedef int32_t Elf_Sword; +typedef uint64_t Elf_Xword; +typedef int64_t Elf_Sxword; + +typedef uint32_t Elf32_Addr; +typedef uint32_t Elf32_Off; +typedef uint64_t Elf64_Addr; +typedef uint64_t Elf64_Off; + +#define Elf32_Half Elf_Half +#define Elf64_Half Elf_Half +#define Elf32_Word Elf_Word +#define Elf64_Word Elf_Word +#define Elf32_Sword Elf_Sword +#define Elf64_Sword Elf_Sword + +/////////////////////// +// ELF Header Constants + +// File type +#define ET_NONE 0 +#define ET_REL 1 +#define ET_EXEC 2 +#define ET_DYN 3 +#define ET_CORE 4 +#define ET_LOOS 0xFE00 +#define ET_HIOS 0xFEFF +#define ET_LOPROC 0xFF00 +#define ET_HIPROC 0xFFFF + +#define EM_NONE 0 // No machine +#define EM_M32 1 // AT&T WE 32100 +#define EM_SPARC 2 // SUN SPARC +#define EM_386 3 // Intel 80386 +#define EM_68K 4 // Motorola m68k family +#define EM_88K 5 // Motorola m88k family +#define EM_486 6 // Intel 80486// Reserved for future use +#define EM_860 7 // Intel 80860 +#define EM_MIPS 8 // MIPS R3000 (officially, big-endian only) +#define EM_S370 9 // IBM System/370 +#define EM_MIPS_RS3_LE \ + 10 // MIPS R3000 little-endian (Oct 4 1999 Draft) Deprecated +#define EM_res011 11 // Reserved +#define EM_res012 12 // Reserved +#define EM_res013 13 // Reserved +#define EM_res014 14 // Reserved +#define EM_PARISC 15 // HPPA +#define EM_res016 16 // Reserved +#define EM_VPP550 17 // Fujitsu VPP500 +#define EM_SPARC32PLUS 18 // Sun's "v8plus" +#define EM_960 19 // Intel 80960 +#define EM_PPC 20 // PowerPC +#define EM_PPC64 21 // 64-bit PowerPC +#define EM_S390 22 // IBM S/390 +#define EM_SPU 23 // Sony/Toshiba/IBM SPU +#define EM_res024 24 // Reserved +#define EM_res025 25 // Reserved +#define EM_res026 26 // Reserved +#define EM_res027 27 // Reserved +#define EM_res028 28 // Reserved +#define EM_res029 29 // Reserved +#define EM_res030 30 // Reserved +#define EM_res031 31 // Reserved +#define EM_res032 32 // Reserved +#define EM_res033 33 // Reserved +#define EM_res034 34 // Reserved +#define EM_res035 35 // Reserved +#define EM_V800 36 // NEC V800 series +#define EM_FR20 37 // Fujitsu FR20 +#define EM_RH32 38 // TRW RH32 +#define EM_MCORE 39 // Motorola M*Core // May also be taken by Fujitsu MMA +#define EM_RCE 39 // Old name for MCore +#define EM_ARM 40 // ARM +#define EM_OLD_ALPHA 41 // Digital Alpha +#define EM_SH 42 // Renesas (formerly Hitachi) / SuperH SH +#define EM_SPARCV9 43 // SPARC v9 64-bit +#define EM_TRICORE 44 // Siemens Tricore embedded processor +#define EM_ARC 45 // ARC Cores +#define EM_H8_300 46 // Renesas (formerly Hitachi) H8/300 +#define EM_H8_300H 47 // Renesas (formerly Hitachi) H8/300H +#define EM_H8S 48 // Renesas (formerly Hitachi) H8S +#define EM_H8_500 49 // Renesas (formerly Hitachi) H8/500 +#define EM_IA_64 50 // Intel IA-64 Processor +#define EM_MIPS_X 51 // Stanford MIPS-X +#define EM_COLDFIRE 52 // Motorola Coldfire +#define EM_68HC12 53 // Motorola M68HC12 +#define EM_MMA 54 // Fujitsu Multimedia Accelerator +#define EM_PCP 55 // Siemens PCP +#define EM_NCPU 56 // Sony nCPU embedded RISC processor +#define EM_NDR1 57 // Denso NDR1 microprocesspr +#define EM_STARCORE 58 // Motorola Star*Core processor +#define EM_ME16 59 // Toyota ME16 processor +#define EM_ST100 60 // STMicroelectronics ST100 processor +#define EM_TINYJ 61 // Advanced Logic Corp. TinyJ embedded processor +#define EM_X86_64 62 // Advanced Micro Devices X86-64 processor +#define EM_PDSP 63 // Sony DSP Processor +#define EM_PDP10 64 // Digital Equipment Corp. PDP-10 +#define EM_PDP11 65 // Digital Equipment Corp. PDP-11 +#define EM_FX66 66 // Siemens FX66 microcontroller +#define EM_ST9PLUS 67 // STMicroelectronics ST9+ 8/16 bit microcontroller +#define EM_ST7 68 // STMicroelectronics ST7 8-bit microcontroller +#define EM_68HC16 69 // Motorola MC68HC16 Microcontroller +#define EM_68HC11 70 // Motorola MC68HC11 Microcontroller +#define EM_68HC08 71 // Motorola MC68HC08 Microcontroller +#define EM_68HC05 72 // Motorola MC68HC05 Microcontroller +#define EM_SVX 73 // Silicon Graphics SVx +#define EM_ST19 74 // STMicroelectronics ST19 8-bit cpu +#define EM_VAX 75 // Digital VAX +#define EM_CRIS 76 // Axis Communications 32-bit embedded processor +#define EM_JAVELIN 77 // Infineon Technologies 32-bit embedded cpu +#define EM_FIREPATH 78 // Element 14 64-bit DSP processor +#define EM_ZSP 79 // LSI Logic's 16-bit DSP processor +#define EM_MMIX 80 // Donald Knuth's educational 64-bit processor +#define EM_HUANY 81 // Harvard's machine-independent format +#define EM_PRISM 82 // SiTera Prism +#define EM_AVR 83 // Atmel AVR 8-bit microcontroller +#define EM_FR30 84 // Fujitsu FR30 +#define EM_D10V 85 // Mitsubishi D10V +#define EM_D30V 86 // Mitsubishi D30V +#define EM_V850 87 // NEC v850 +#define EM_M32R 88 // Renesas M32R (formerly Mitsubishi M32R) +#define EM_MN10300 89 // Matsushita MN10300 +#define EM_MN10200 90 // Matsushita MN10200 +#define EM_PJ 91 // picoJava +#define EM_OPENRISC 92 // OpenRISC 32-bit embedded processor +#define EM_ARC_A5 93 // ARC Cores Tangent-A5 +#define EM_XTENSA 94 // Tensilica Xtensa Architecture +#define EM_VIDEOCORE 95 // Alphamosaic VideoCore processor +#define EM_TMM_GPP 96 // Thompson Multimedia General Purpose Processor +#define EM_NS32K 97 // National Semiconductor 32000 series +#define EM_TPC 98 // Tenor Network TPC processor +#define EM_SNP1K 99 // Trebia SNP 1000 processor +#define EM_ST200 100 // STMicroelectronics ST200 microcontroller +#define EM_IP2K 101 // Ubicom IP2022 micro controller +#define EM_MAX 102 // MAX Processor +#define EM_CR 103 // National Semiconductor CompactRISC +#define EM_F2MC16 104 // Fujitsu F2MC16 +#define EM_MSP430 105 // TI msp430 micro controller +#define EM_BLACKFIN 106 // ADI Blackfin +#define EM_SE_C33 107 // S1C33 Family of Seiko Epson processors +#define EM_SEP 108 // Sharp embedded microprocessor +#define EM_ARCA 109 // Arca RISC Microprocessor +#define EM_UNICORE \ + 110 // Microprocessor series from PKU-Unity Ltd. and MPRC of Peking University +#define EM_EXCESS 111 // eXcess: 16/32/64-bit configurable embedded CPU +#define EM_DXP 112 // Icera Semiconductor Inc. Deep Execution Processor +#define EM_ALTERA_NIOS2 113 // Altera Nios II soft-core processor +#define EM_CRX 114 // National Semiconductor CRX +#define EM_XGATE 115 // Motorola XGATE embedded processor +#define EM_C166 116 // Infineon C16x/XC16x processor +#define EM_M16C 117 // Renesas M16C series microprocessors +#define EM_DSPIC30F \ + 118 // Microchip Technology dsPIC30F Digital Signal Controller +#define EM_CE 119 // Freescale Communication Engine RISC core +#define EM_M32C 120 // Renesas M32C series microprocessors +#define EM_res121 121 // Reserved +#define EM_res122 122 // Reserved +#define EM_res123 123 // Reserved +#define EM_res124 124 // Reserved +#define EM_res125 125 // Reserved +#define EM_res126 126 // Reserved +#define EM_res127 127 // Reserved +#define EM_res128 128 // Reserved +#define EM_res129 129 // Reserved +#define EM_res130 130 // Reserved +#define EM_TSK3000 131 // Altium TSK3000 core +#define EM_RS08 132 // Freescale RS08 embedded processor +#define EM_res133 133 // Reserved +#define EM_ECOG2 134 // Cyan Technology eCOG2 microprocessor +#define EM_SCORE 135 // Sunplus Score +#define EM_SCORE7 135 // Sunplus S+core7 RISC processor +#define EM_DSP24 136 // New Japan Radio (NJR) 24-bit DSP Processor +#define EM_VIDEOCORE3 137 // Broadcom VideoCore III processor +#define EM_LATTICEMICO32 138 // RISC processor for Lattice FPGA architecture +#define EM_SE_C17 139 // Seiko Epson C17 family +#define EM_TI_C6000 140 // Texas Instruments TMS320C6000 DSP family +#define EM_TI_C2000 141 // Texas Instruments TMS320C2000 DSP family +#define EM_TI_C5500 142 // Texas Instruments TMS320C55x DSP family +#define EM_res143 143 // Reserved +#define EM_res144 144 // Reserved +#define EM_res145 145 // Reserved +#define EM_res146 146 // Reserved +#define EM_res147 147 // Reserved +#define EM_res148 148 // Reserved +#define EM_res149 149 // Reserved +#define EM_res150 150 // Reserved +#define EM_res151 151 // Reserved +#define EM_res152 152 // Reserved +#define EM_res153 153 // Reserved +#define EM_res154 154 // Reserved +#define EM_res155 155 // Reserved +#define EM_res156 156 // Reserved +#define EM_res157 157 // Reserved +#define EM_res158 158 // Reserved +#define EM_res159 159 // Reserved +#define EM_MMDSP_PLUS 160 // STMicroelectronics 64bit VLIW Data Signal Processor +#define EM_CYPRESS_M8C 161 // Cypress M8C microprocessor +#define EM_R32C 162 // Renesas R32C series microprocessors +#define EM_TRIMEDIA 163 // NXP Semiconductors TriMedia architecture family +#define EM_QDSP6 164 // QUALCOMM DSP6 Processor +#define EM_8051 165 // Intel 8051 and variants +#define EM_STXP7X 166 // STMicroelectronics STxP7x family +#define EM_NDS32 \ + 167 // Andes Technology compact code size embedded RISC processor family +#define EM_ECOG1 168 // Cyan Technology eCOG1X family +#define EM_ECOG1X 168 // Cyan Technology eCOG1X family +#define EM_MAXQ30 169 // Dallas Semiconductor MAXQ30 Core Micro-controllers +#define EM_XIMO16 170 // New Japan Radio (NJR) 16-bit DSP Processor +#define EM_MANIK 171 // M2000 Reconfigurable RISC Microprocessor +#define EM_CRAYNV2 172 // Cray Inc. NV2 vector architecture +#define EM_RX 173 // Renesas RX family +#define EM_METAG 174 // Imagination Technologies META processor architecture +#define EM_MCST_ELBRUS 175 // MCST Elbrus general purpose hardware architecture +#define EM_ECOG16 176 // Cyan Technology eCOG16 family +#define EM_CR16 177 // National Semiconductor CompactRISC 16-bit processor +#define EM_ETPU 178 // Freescale Extended Time Processing Unit +#define EM_SLE9X 179 // Infineon Technologies SLE9X core +#define EM_L1OM 180 // Intel L1OM +#define EM_INTEL181 181 // Reserved by Intel +#define EM_INTEL182 182 // Reserved by Intel +#define EM_res183 183 // Reserved by ARM +#define EM_res184 184 // Reserved by ARM +#define EM_AVR32 185 // Atmel Corporation 32-bit microprocessor family +#define EM_STM8 186 // STMicroeletronics STM8 8-bit microcontroller +#define EM_TILE64 187 // Tilera TILE64 multicore architecture family +#define EM_TILEPRO 188 // Tilera TILEPro multicore architecture family +#define EM_MICROBLAZE 189 // Xilinx MicroBlaze 32-bit RISC soft processor core +#define EM_CUDA 190 // NVIDIA CUDA architecture +#define EM_TILEGX 191 // Tilera TILE-Gx multicore architecture family +#define EM_CLOUDSHIELD 192 // CloudShield architecture family +#define EM_COREA_1ST 193 // KIPO-KAIST Core-A 1st generation processor family +#define EM_COREA_2ND 194 // KIPO-KAIST Core-A 2nd generation processor family +#define EM_ARC_COMPACT2 195 // Synopsys ARCompact V2 +#define EM_OPEN8 196 // Open8 8-bit RISC soft processor core +#define EM_RL78 197 // Renesas RL78 family +#define EM_VIDEOCORE5 198 // Broadcom VideoCore V processor +#define EM_78KOR 199 // Renesas 78KOR family +#define EM_56800EX 200 // Freescale 56800EX Digital Signal Controller (DSC) +#define EM_BA1 201 // Beyond BA1 CPU architecture +#define EM_BA2 202 // Beyond BA2 CPU architecture +#define EM_XCORE 203 // XMOS xCORE processor family +#define EM_MCHP_PIC 204 // Microchip 8-bit PIC(r) family +#define EM_INTEL205 205 // Reserved by Intel +#define EM_INTEL206 206 // Reserved by Intel +#define EM_INTEL207 207 // Reserved by Intel +#define EM_INTEL208 208 // Reserved by Intel +#define EM_INTEL209 209 // Reserved by Intel +#define EM_KM32 210 // KM211 KM32 32-bit processor +#define EM_KMX32 211 // KM211 KMX32 32-bit processor +#define EM_KMX16 212 // KM211 KMX16 16-bit processor +#define EM_KMX8 213 // KM211 KMX8 8-bit processor +#define EM_KVARC 214 // KM211 KVARC processor +#define EM_CDP 215 // Paneve CDP architecture family +#define EM_COGE 216 // Cognitive Smart Memory Processor +#define EM_COOL 217 // iCelero CoolEngine +#define EM_NORC 218 // Nanoradio Optimized RISC +#define EM_CSR_KALIMBA 219 // CSR Kalimba architecture family +#define EM_Z80 220 // Zilog Z80 +#define EM_VISIUM 221 // Controls and Data Services VISIUMcore processor +#define EM_FT32 222 // FTDI Chip FT32 high performance 32-bit RISC architecture +#define EM_MOXIE 223 // Moxie processor family +#define EM_AMDGPU 224 // AMD GPU architecture +#define EM_RISCV 243 // RISC-V +#define EM_LANAI 244 // Lanai processor +#define EM_CEVA 245 // CEVA Processor Architecture Family +#define EM_CEVA_X2 246 // CEVA X2 Processor Family +#define EM_BPF 247 // Linux BPF – in-kernel virtual machine +#define EM_GRAPHCORE_IPU 248 // Graphcore Intelligent Processing Unit +#define EM_IMG1 249 // Imagination Technologies +#define EM_NFP 250 // Netronome Flow Processor (P) +#define EM_CSKY 252 // C-SKY processor family + +// File version +#define EV_NONE 0 +#define EV_CURRENT 1 + +// Identification index +#define EI_MAG0 0 +#define EI_MAG1 1 +#define EI_MAG2 2 +#define EI_MAG3 3 +#define EI_CLASS 4 +#define EI_DATA 5 +#define EI_VERSION 6 +#define EI_OSABI 7 +#define EI_ABIVERSION 8 +#define EI_PAD 9 +#define EI_NIDENT 16 + +// Magic number +#define ELFMAG0 0x7F +#define ELFMAG1 'E' +#define ELFMAG2 'L' +#define ELFMAG3 'F' + +// File class +#define ELFCLASSNONE 0 +#define ELFCLASS32 1 +#define ELFCLASS64 2 + +// Encoding +#define ELFDATANONE 0 +#define ELFDATA2LSB 1 +#define ELFDATA2MSB 2 + +// OS extensions +#define ELFOSABI_NONE 0 // No extensions or unspecified +#define ELFOSABI_HPUX 1 // Hewlett-Packard HP-UX +#define ELFOSABI_NETBSD 2 // NetBSD +#define ELFOSABI_LINUX 3 // Linux +#define ELFOSABI_SOLARIS 6 // Sun Solaris +#define ELFOSABI_AIX 7 // AIX +#define ELFOSABI_IRIX 8 // IRIX +#define ELFOSABI_FREEBSD 9 // FreeBSD +#define ELFOSABI_TRU64 10 // Compaq TRU64 UNIX +#define ELFOSABI_MODESTO 11 // Novell Modesto +#define ELFOSABI_OPENBSD 12 // Open BSD +#define ELFOSABI_OPENVMS 13 // Open VMS +#define ELFOSABI_NSK 14 // Hewlett-Packard Non-Stop Kernel +#define ELFOSABI_AROS 15 // Amiga Research OS +#define ELFOSABI_FENIXOS 16 // The FenixOS highly scalable multi-core OS +// 64-255 Architecture-specific value range +#define ELFOSABI_AMDGPU_HSA \ + 64 // AMDGPU OS for HSA compatible compute // kernels. +#define ELFOSABI_AMDGPU_PAL \ + 65 // AMDGPU OS for AMD PAL compatible graphics // shaders and compute kernels. +#define ELFOSABI_AMDGPU_MESA3D \ + 66 // AMDGPU OS for Mesa3D compatible graphics // shaders and compute kernels. + +// AMDGPU specific e_flags +#define EF_AMDGPU_MACH 0x0ff // AMDGPU processor selection mask. +#define EF_AMDGPU_XNACK \ + 0x100 // Indicates if the XNACK target feature is // enabled for all code contained in the ELF. +// AMDGPU processors +#define EF_AMDGPU_MACH_NONE 0x000 // Unspecified processor. +#define EF_AMDGPU_MACH_R600_R600 0x001 +#define EF_AMDGPU_MACH_R600_R630 0x002 +#define EF_AMDGPU_MACH_R600_RS880 0x003 +#define EF_AMDGPU_MACH_R600_RV670 0x004 +#define EF_AMDGPU_MACH_R600_RV710 0x005 +#define EF_AMDGPU_MACH_R600_RV730 0x006 +#define EF_AMDGPU_MACH_R600_RV770 0x007 +#define EF_AMDGPU_MACH_R600_CEDAR 0x008 +#define EF_AMDGPU_MACH_R600_CYPRESS 0x009 +#define EF_AMDGPU_MACH_R600_JUNIPER 0x00a +#define EF_AMDGPU_MACH_R600_REDWOOD 0x00b +#define EF_AMDGPU_MACH_R600_SUMO 0x00c +#define EF_AMDGPU_MACH_R600_BARTS 0x00d +#define EF_AMDGPU_MACH_R600_CAICOS 0x00e +#define EF_AMDGPU_MACH_R600_CAYMAN 0x00f +#define EF_AMDGPU_MACH_R600_TURKS 0x010 +#define EF_AMDGPU_MACH_R600_RESERVED_FIRST 0x011 +#define EF_AMDGPU_MACH_R600_RESERVED_LAST 0x01f +#define EF_AMDGPU_MACH_R600_FIRST EF_AMDGPU_MACH_R600_R600 +#define EF_AMDGPU_MACH_R600_LAST EF_AMDGPU_MACH_R600_TURKS +#define EF_AMDGPU_MACH_AMDGCN_GFX600 0x020 +#define EF_AMDGPU_MACH_AMDGCN_GFX601 0x021 +#define EF_AMDGPU_MACH_AMDGCN_GFX700 0x022 +#define EF_AMDGPU_MACH_AMDGCN_GFX701 0x023 +#define EF_AMDGPU_MACH_AMDGCN_GFX702 0x024 +#define EF_AMDGPU_MACH_AMDGCN_GFX703 0x025 +#define EF_AMDGPU_MACH_AMDGCN_GFX704 0x026 +#define EF_AMDGPU_MACH_AMDGCN_GFX801 0x028 +#define EF_AMDGPU_MACH_AMDGCN_GFX802 0x029 +#define EF_AMDGPU_MACH_AMDGCN_GFX803 0x02a +#define EF_AMDGPU_MACH_AMDGCN_GFX810 0x02b +#define EF_AMDGPU_MACH_AMDGCN_GFX900 0x02c +#define EF_AMDGPU_MACH_AMDGCN_GFX902 0x02d +#define EF_AMDGPU_MACH_AMDGCN_GFX904 0x02e +#define EF_AMDGPU_MACH_AMDGCN_GFX906 0x02f +#define EF_AMDGPU_MACH_AMDGCN_RESERVED0 0x027 +#define EF_AMDGPU_MACH_AMDGCN_RESERVED1 0x030 +#define EF_AMDGPU_MACH_AMDGCN_FIRST EF_AMDGPU_MACH_AMDGCN_GFX600 +#define EF_AMDGPU_MACH_AMDGCN_LAST EF_AMDGPU_MACH_AMDGCN_GFX906 + +///////////////////// +// Sections constants + +// Section indexes +#define SHN_UNDEF 0 +#define SHN_LORESERVE 0xFF00 +#define SHN_LOPROC 0xFF00 +#define SHN_HIPROC 0xFF1F +#define SHN_LOOS 0xFF20 +#define SHN_HIOS 0xFF3F +#define SHN_ABS 0xFFF1 +#define SHN_COMMON 0xFFF2 +#define SHN_XINDEX 0xFFFF +#define SHN_HIRESERVE 0xFFFF + +// Section types +#define SHT_NULL 0 +#define SHT_PROGBITS 1 +#define SHT_SYMTAB 2 +#define SHT_STRTAB 3 +#define SHT_RELA 4 +#define SHT_HASH 5 +#define SHT_DYNAMIC 6 +#define SHT_NOTE 7 +#define SHT_NOBITS 8 +#define SHT_REL 9 +#define SHT_SHLIB 10 +#define SHT_DYNSYM 11 +#define SHT_INIT_ARRAY 14 +#define SHT_FINI_ARRAY 15 +#define SHT_PREINIT_ARRAY 16 +#define SHT_GROUP 17 +#define SHT_SYMTAB_SHNDX 18 +#define SHT_LOOS 0x60000000 +#define SHT_HIOS 0x6fffffff +#define SHT_LOPROC 0x70000000 +#define SHT_HIPROC 0x7FFFFFFF +#define SHT_LOUSER 0x80000000 +#define SHT_HIUSER 0xFFFFFFFF + +// Section attribute flags +#define SHF_WRITE 0x1 +#define SHF_ALLOC 0x2 +#define SHF_EXECINSTR 0x4 +#define SHF_MERGE 0x10 +#define SHF_STRINGS 0x20 +#define SHF_INFO_LINK 0x40 +#define SHF_LINK_ORDER 0x80 +#define SHF_OS_NONCONFORMING 0x100 +#define SHF_GROUP 0x200 +#define SHF_TLS 0x400 +#define SHF_MASKOS 0x0ff00000 +#define SHF_MASKPROC 0xF0000000 + +// Section group flags +#define GRP_COMDAT 0x1 +#define GRP_MASKOS 0x0ff00000 +#define GRP_MASKPROC 0xf0000000 + +// Symbol binding +#define STB_LOCAL 0 +#define STB_GLOBAL 1 +#define STB_WEAK 2 +#define STB_LOOS 10 +#define STB_HIOS 12 +#define STB_MULTIDEF 13 +#define STB_LOPROC 13 +#define STB_HIPROC 15 + +// Note types +#define NT_AMDGPU_METADATA 1 +#define NT_AMD_AMDGPU_HSA_METADATA 10 +#define NT_AMD_AMDGPU_ISA 11 +#define NT_AMD_AMDGPU_PAL_METADATA 12 + +// Symbol types +#define STT_NOTYPE 0 +#define STT_OBJECT 1 +#define STT_FUNC 2 +#define STT_SECTION 3 +#define STT_FILE 4 +#define STT_COMMON 5 +#define STT_TLS 6 +#define STT_LOOS 10 +#define STT_AMDGPU_HSA_KERNEL 10 +#define STT_HIOS 12 +#define STT_LOPROC 13 +#define STT_HIPROC 15 + +// Symbol visibility +#define STV_DEFAULT 0 +#define STV_INTERNAL 1 +#define STV_HIDDEN 2 +#define STV_PROTECTED 3 + +// Undefined name +#define STN_UNDEF 0 + +// Relocation types +#define R_386_NONE 0 +#define R_X86_64_NONE 0 +#define R_AMDGPU_NONE 0 +#define R_386_32 1 +#define R_X86_64_64 1 +#define R_AMDGPU_ABS32_LO 1 +#define R_386_PC32 2 +#define R_X86_64_PC32 2 +#define R_AMDGPU_ABS32_HI 2 +#define R_386_GOT32 3 +#define R_X86_64_GOT32 3 +#define R_AMDGPU_ABS64 3 +#define R_386_PLT32 4 +#define R_X86_64_PLT32 4 +#define R_AMDGPU_REL32 4 +#define R_386_COPY 5 +#define R_X86_64_COPY 5 +#define R_AMDGPU_REL64 5 +#define R_386_GLOB_DAT 6 +#define R_X86_64_GLOB_DAT 6 +#define R_AMDGPU_ABS32 6 +#define R_386_JMP_SLOT 7 +#define R_X86_64_JUMP_SLOT 7 +#define R_AMDGPU_GOTPCREL 7 +#define R_386_RELATIVE 8 +#define R_X86_64_RELATIVE 8 +#define R_AMDGPU_GOTPCREL32_LO 8 +#define R_386_GOTOFF 9 +#define R_X86_64_GOTPCREL 9 +#define R_AMDGPU_GOTPCREL32_HI 9 +#define R_386_GOTPC 10 +#define R_X86_64_32 10 +#define R_AMDGPU_REL32_LO 10 +#define R_386_32PLT 11 +#define R_X86_64_32S 11 +#define R_AMDGPU_REL32_HI 11 +#define R_X86_64_16 12 +#define R_X86_64_PC16 13 +#define R_AMDGPU_RELATIVE64 13 +#define R_386_TLS_TPOFF 14 +#define R_X86_64_8 14 +#define R_386_TLS_IE 15 +#define R_X86_64_PC8 15 +#define R_386_TLS_GOTIE 16 +#define R_X86_64_DTPMOD64 16 +#define R_386_TLS_LE 17 +#define R_X86_64_DTPOFF64 17 +#define R_386_TLS_GD 18 +#define R_X86_64_TPOFF64 18 +#define R_386_TLS_LDM 19 +#define R_X86_64_TLSGD 19 +#define R_386_16 20 +#define R_X86_64_TLSLD 20 +#define R_386_PC16 21 +#define R_X86_64_DTPOFF32 21 +#define R_386_8 22 +#define R_X86_64_GOTTPOFF 22 +#define R_386_PC8 23 +#define R_X86_64_TPOFF32 23 +#define R_386_TLS_GD_32 24 +#define R_X86_64_PC64 24 +#define R_386_TLS_GD_PUSH 25 +#define R_X86_64_GOTOFF64 25 +#define R_386_TLS_GD_CALL 26 +#define R_X86_64_GOTPC32 26 +#define R_386_TLS_GD_POP 27 +#define R_X86_64_GOT64 27 +#define R_386_TLS_LDM_32 28 +#define R_X86_64_GOTPCREL64 28 +#define R_386_TLS_LDM_PUSH 29 +#define R_X86_64_GOTPC64 29 +#define R_386_TLS_LDM_CALL 30 +#define R_X86_64_GOTPLT64 30 +#define R_386_TLS_LDM_POP 31 +#define R_X86_64_PLTOFF64 31 +#define R_386_TLS_LDO_32 32 +#define R_386_TLS_IE_32 33 +#define R_386_TLS_LE_32 34 +#define R_X86_64_GOTPC32_TLSDESC 34 +#define R_386_TLS_DTPMOD32 35 +#define R_X86_64_TLSDESC_CALL 35 +#define R_386_TLS_DTPOFF32 36 +#define R_X86_64_TLSDESC 36 +#define R_386_TLS_TPOFF32 37 +#define R_X86_64_IRELATIVE 37 +#define R_386_SIZE32 38 +#define R_386_TLS_GOTDESC 39 +#define R_386_TLS_DESC_CALL 40 +#define R_386_TLS_DESC 41 +#define R_386_IRELATIVE 42 +#define R_386_GOT32X 43 +#define R_X86_64_GNU_VTINHERIT 250 +#define R_X86_64_GNU_VTENTRY 251 + +// Segment types +#define PT_NULL 0 +#define PT_LOAD 1 +#define PT_DYNAMIC 2 +#define PT_INTERP 3 +#define PT_NOTE 4 +#define PT_SHLIB 5 +#define PT_PHDR 6 +#define PT_TLS 7 +#define PT_LOOS 0x60000000 +#define PT_HIOS 0x6fffffff +#define PT_LOPROC 0x70000000 +#define PT_HIPROC 0x7FFFFFFF + +// Segment flags +#define PF_X 1 // Execute +#define PF_W 2 // Write +#define PF_R 4 // Read +#define PF_MASKOS 0x0ff00000 // Unspecified +#define PF_MASKPROC 0xf0000000 // Unspecified + +// Dynamic Array Tags +#define DT_NULL 0 +#define DT_NEEDED 1 +#define DT_PLTRELSZ 2 +#define DT_PLTGOT 3 +#define DT_HASH 4 +#define DT_STRTAB 5 +#define DT_SYMTAB 6 +#define DT_RELA 7 +#define DT_RELASZ 8 +#define DT_RELAENT 9 +#define DT_STRSZ 10 +#define DT_SYMENT 11 +#define DT_INIT 12 +#define DT_FINI 13 +#define DT_SONAME 14 +#define DT_RPATH 15 +#define DT_SYMBOLIC 16 +#define DT_REL 17 +#define DT_RELSZ 18 +#define DT_RELENT 19 +#define DT_PLTREL 20 +#define DT_DEBUG 21 +#define DT_TEXTREL 22 +#define DT_JMPREL 23 +#define DT_BIND_NOW 24 +#define DT_INIT_ARRAY 25 +#define DT_FINI_ARRAY 26 +#define DT_INIT_ARRAYSZ 27 +#define DT_FINI_ARRAYSZ 28 +#define DT_RUNPATH 29 +#define DT_FLAGS 30 +#define DT_ENCODING 32 +#define DT_PREINIT_ARRAY 32 +#define DT_PREINIT_ARRAYSZ 33 +#define DT_MAXPOSTAGS 34 +#define DT_LOOS 0x6000000D +#define DT_HIOS 0x6ffff000 +#define DT_LOPROC 0x70000000 +#define DT_HIPROC 0x7FFFFFFF + +// DT_FLAGS values +#define DF_ORIGIN 0x1 +#define DF_SYMBOLIC 0x2 +#define DF_TEXTREL 0x4 +#define DF_BIND_NOW 0x8 +#define DF_STATIC_TLS 0x10 + +// ELF file header +struct Elf32_Ehdr +{ + unsigned char e_ident[EI_NIDENT]; + Elf_Half e_type; + Elf_Half e_machine; + Elf_Word e_version; + Elf32_Addr e_entry; + Elf32_Off e_phoff; + Elf32_Off e_shoff; + Elf_Word e_flags; + Elf_Half e_ehsize; + Elf_Half e_phentsize; + Elf_Half e_phnum; + Elf_Half e_shentsize; + Elf_Half e_shnum; + Elf_Half e_shstrndx; +}; + +struct Elf64_Ehdr +{ + unsigned char e_ident[EI_NIDENT]; + Elf_Half e_type; + Elf_Half e_machine; + Elf_Word e_version; + Elf64_Addr e_entry; + Elf64_Off e_phoff; + Elf64_Off e_shoff; + Elf_Word e_flags; + Elf_Half e_ehsize; + Elf_Half e_phentsize; + Elf_Half e_phnum; + Elf_Half e_shentsize; + Elf_Half e_shnum; + Elf_Half e_shstrndx; +}; + +// Section header +struct Elf32_Shdr +{ + Elf_Word sh_name; + Elf_Word sh_type; + Elf_Word sh_flags; + Elf32_Addr sh_addr; + Elf32_Off sh_offset; + Elf_Word sh_size; + Elf_Word sh_link; + Elf_Word sh_info; + Elf_Word sh_addralign; + Elf_Word sh_entsize; +}; + +struct Elf64_Shdr +{ + Elf_Word sh_name; + Elf_Word sh_type; + Elf_Xword sh_flags; + Elf64_Addr sh_addr; + Elf64_Off sh_offset; + Elf_Xword sh_size; + Elf_Word sh_link; + Elf_Word sh_info; + Elf_Xword sh_addralign; + Elf_Xword sh_entsize; +}; + +// Segment header +struct Elf32_Phdr +{ + Elf_Word p_type; + Elf32_Off p_offset; + Elf32_Addr p_vaddr; + Elf32_Addr p_paddr; + Elf_Word p_filesz; + Elf_Word p_memsz; + Elf_Word p_flags; + Elf_Word p_align; +}; + +struct Elf64_Phdr +{ + Elf_Word p_type; + Elf_Word p_flags; + Elf64_Off p_offset; + Elf64_Addr p_vaddr; + Elf64_Addr p_paddr; + Elf_Xword p_filesz; + Elf_Xword p_memsz; + Elf_Xword p_align; +}; + +// Symbol table entry +struct Elf32_Sym +{ + Elf_Word st_name; + Elf32_Addr st_value; + Elf_Word st_size; + unsigned char st_info; + unsigned char st_other; + Elf_Half st_shndx; +}; + +struct Elf64_Sym +{ + Elf_Word st_name; + unsigned char st_info; + unsigned char st_other; + Elf_Half st_shndx; + Elf64_Addr st_value; + Elf_Xword st_size; +}; + +#define ELF_ST_BIND( i ) ( ( i ) >> 4 ) +#define ELF_ST_TYPE( i ) ( (i)&0xf ) +#define ELF_ST_INFO( b, t ) ( ( ( b ) << 4 ) + ( (t)&0xf ) ) + +#define ELF_ST_VISIBILITY( o ) ( (o)&0x3 ) + +// Relocation entries +struct Elf32_Rel +{ + Elf32_Addr r_offset; + Elf_Word r_info; +}; + +struct Elf32_Rela +{ + Elf32_Addr r_offset; + Elf_Word r_info; + Elf_Sword r_addend; +}; + +struct Elf64_Rel +{ + Elf64_Addr r_offset; + Elf_Xword r_info; +}; + +struct Elf64_Rela +{ + Elf64_Addr r_offset; + Elf_Xword r_info; + Elf_Sxword r_addend; +}; + +#define ELF32_R_SYM( i ) ( ( i ) >> 8 ) +#define ELF32_R_TYPE( i ) ( (unsigned char)( i ) ) +#define ELF32_R_INFO( s, t ) ( ( ( s ) << 8 ) + (unsigned char)( t ) ) + +#define ELF64_R_SYM( i ) ( ( i ) >> 32 ) +#define ELF64_R_TYPE( i ) ( (i)&0xffffffffL ) +#define ELF64_R_INFO( s, t ) \ + ( ( ( ( int64_t )( s ) ) << 32 ) + ( (t)&0xffffffffL ) ) + +// Dynamic structure +struct Elf32_Dyn +{ + Elf_Sword d_tag; + union { + Elf_Word d_val; + Elf32_Addr d_ptr; + } d_un; +}; + +struct Elf64_Dyn +{ + Elf_Sxword d_tag; + union { + Elf_Xword d_val; + Elf64_Addr d_ptr; + } d_un; +}; + +} // namespace ELFIO + +#endif // ELFTYPES_H + +/*** End of inlined file: elf_types.hpp ***/ + + +/*** Start of inlined file: elfio_version.hpp ***/ +#define ELFIO_VERSION "3.8" + +/*** End of inlined file: elfio_version.hpp ***/ + + +/*** Start of inlined file: elfio_utils.hpp ***/ +#ifndef ELFIO_UTILS_HPP +#define ELFIO_UTILS_HPP + +#define ELFIO_GET_ACCESS( TYPE, NAME, FIELD ) \ + TYPE get_##NAME() const { return ( *convertor )( FIELD ); } +#define ELFIO_SET_ACCESS( TYPE, NAME, FIELD ) \ + void set_##NAME( TYPE value ) \ + { \ + FIELD = value; \ + FIELD = ( *convertor )( FIELD ); \ + } +#define ELFIO_GET_SET_ACCESS( TYPE, NAME, FIELD ) \ + TYPE get_##NAME() const { return ( *convertor )( FIELD ); } \ + void set_##NAME( TYPE value ) \ + { \ + FIELD = value; \ + FIELD = ( *convertor )( FIELD ); \ + } + +#define ELFIO_GET_ACCESS_DECL( TYPE, NAME ) virtual TYPE get_##NAME() const = 0 + +#define ELFIO_SET_ACCESS_DECL( TYPE, NAME ) \ + virtual void set_##NAME( TYPE value ) = 0 + +#define ELFIO_GET_SET_ACCESS_DECL( TYPE, NAME ) \ + virtual TYPE get_##NAME() const = 0; \ + virtual void set_##NAME( TYPE value ) = 0 + +namespace ELFIO { + +//------------------------------------------------------------------------------ +class endianess_convertor +{ + public: + //------------------------------------------------------------------------------ + endianess_convertor() { need_conversion = false; } + + //------------------------------------------------------------------------------ + void setup( unsigned char elf_file_encoding ) + { + need_conversion = ( elf_file_encoding != get_host_encoding() ); + } + + //------------------------------------------------------------------------------ + uint64_t operator()( uint64_t value ) const + { + if ( !need_conversion ) { + return value; + } + value = ( ( value & 0x00000000000000FFull ) << 56 ) | + ( ( value & 0x000000000000FF00ull ) << 40 ) | + ( ( value & 0x0000000000FF0000ull ) << 24 ) | + ( ( value & 0x00000000FF000000ull ) << 8 ) | + ( ( value & 0x000000FF00000000ull ) >> 8 ) | + ( ( value & 0x0000FF0000000000ull ) >> 24 ) | + ( ( value & 0x00FF000000000000ull ) >> 40 ) | + ( ( value & 0xFF00000000000000ull ) >> 56 ); + + return value; + } + + //------------------------------------------------------------------------------ + int64_t operator()( int64_t value ) const + { + if ( !need_conversion ) { + return value; + } + return ( int64_t )( *this )( (uint64_t)value ); + } + + //------------------------------------------------------------------------------ + uint32_t operator()( uint32_t value ) const + { + if ( !need_conversion ) { + return value; + } + value = + ( ( value & 0x000000FF ) << 24 ) | ( ( value & 0x0000FF00 ) << 8 ) | + ( ( value & 0x00FF0000 ) >> 8 ) | ( ( value & 0xFF000000 ) >> 24 ); + + return value; + } + + //------------------------------------------------------------------------------ + int32_t operator()( int32_t value ) const + { + if ( !need_conversion ) { + return value; + } + return ( int32_t )( *this )( (uint32_t)value ); + } + + //------------------------------------------------------------------------------ + uint16_t operator()( uint16_t value ) const + { + if ( !need_conversion ) { + return value; + } + value = ( ( value & 0x00FF ) << 8 ) | ( ( value & 0xFF00 ) >> 8 ); + + return value; + } + + //------------------------------------------------------------------------------ + int16_t operator()( int16_t value ) const + { + if ( !need_conversion ) { + return value; + } + return ( int16_t )( *this )( (uint16_t)value ); + } + + //------------------------------------------------------------------------------ + int8_t operator()( int8_t value ) const { return value; } + + //------------------------------------------------------------------------------ + uint8_t operator()( uint8_t value ) const { return value; } + + //------------------------------------------------------------------------------ + private: + //------------------------------------------------------------------------------ + unsigned char get_host_encoding() const + { + static const int tmp = 1; + if ( 1 == *(const char*)&tmp ) { + return ELFDATA2LSB; + } + else { + return ELFDATA2MSB; + } + } + + //------------------------------------------------------------------------------ + private: + bool need_conversion; +}; + +//------------------------------------------------------------------------------ +inline uint32_t elf_hash( const unsigned char* name ) +{ + uint32_t h = 0, g; + while ( *name ) { + h = ( h << 4 ) + *name++; + g = h & 0xf0000000; + if ( g != 0 ) + h ^= g >> 24; + h &= ~g; + } + return h; +} + +} // namespace ELFIO + +#endif // ELFIO_UTILS_HPP + +/*** End of inlined file: elfio_utils.hpp ***/ + + +/*** Start of inlined file: elfio_header.hpp ***/ +#ifndef ELF_HEADER_HPP +#define ELF_HEADER_HPP + +#include + +namespace ELFIO { + +class elf_header +{ + public: + virtual ~elf_header(){}; + virtual bool load( std::istream& stream ) = 0; + virtual bool save( std::ostream& stream ) const = 0; + + // ELF header functions + ELFIO_GET_ACCESS_DECL( unsigned char, class ); + ELFIO_GET_ACCESS_DECL( unsigned char, elf_version ); + ELFIO_GET_ACCESS_DECL( unsigned char, encoding ); + ELFIO_GET_ACCESS_DECL( Elf_Half, header_size ); + ELFIO_GET_ACCESS_DECL( Elf_Half, section_entry_size ); + ELFIO_GET_ACCESS_DECL( Elf_Half, segment_entry_size ); + + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, version ); + ELFIO_GET_SET_ACCESS_DECL( unsigned char, os_abi ); + ELFIO_GET_SET_ACCESS_DECL( unsigned char, abi_version ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Half, type ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Half, machine ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, flags ); + ELFIO_GET_SET_ACCESS_DECL( Elf64_Addr, entry ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Half, sections_num ); + ELFIO_GET_SET_ACCESS_DECL( Elf64_Off, sections_offset ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Half, segments_num ); + ELFIO_GET_SET_ACCESS_DECL( Elf64_Off, segments_offset ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Half, section_name_str_index ); +}; + +template struct elf_header_impl_types; +template <> struct elf_header_impl_types +{ + typedef Elf32_Phdr Phdr_type; + typedef Elf32_Shdr Shdr_type; + static const unsigned char file_class = ELFCLASS32; +}; +template <> struct elf_header_impl_types +{ + typedef Elf64_Phdr Phdr_type; + typedef Elf64_Shdr Shdr_type; + static const unsigned char file_class = ELFCLASS64; +}; + +template class elf_header_impl : public elf_header +{ + public: + //------------------------------------------------------------------------------ + elf_header_impl( endianess_convertor* convertor_, unsigned char encoding ) + { + convertor = convertor_; + + std::fill_n( reinterpret_cast( &header ), sizeof( header ), + '\0' ); + + header.e_ident[EI_MAG0] = ELFMAG0; + header.e_ident[EI_MAG1] = ELFMAG1; + header.e_ident[EI_MAG2] = ELFMAG2; + header.e_ident[EI_MAG3] = ELFMAG3; + header.e_ident[EI_CLASS] = elf_header_impl_types::file_class; + header.e_ident[EI_DATA] = encoding; + header.e_ident[EI_VERSION] = EV_CURRENT; + header.e_version = ( *convertor )( (Elf_Word)EV_CURRENT ); + header.e_ehsize = ( sizeof( header ) ); + header.e_ehsize = ( *convertor )( header.e_ehsize ); + header.e_shstrndx = ( *convertor )( (Elf_Half)1 ); + header.e_phentsize = + sizeof( typename elf_header_impl_types::Phdr_type ); + header.e_shentsize = + sizeof( typename elf_header_impl_types::Shdr_type ); + header.e_phentsize = ( *convertor )( header.e_phentsize ); + header.e_shentsize = ( *convertor )( header.e_shentsize ); + } + + //------------------------------------------------------------------------------ + bool load( std::istream& stream ) + { + stream.seekg( 0 ); + stream.read( reinterpret_cast( &header ), sizeof( header ) ); + + return ( stream.gcount() == sizeof( header ) ); + } + + //------------------------------------------------------------------------------ + bool save( std::ostream& stream ) const + { + stream.seekp( 0 ); + stream.write( reinterpret_cast( &header ), + sizeof( header ) ); + + return stream.good(); + } + + //------------------------------------------------------------------------------ + // ELF header functions + ELFIO_GET_ACCESS( unsigned char, class, header.e_ident[EI_CLASS] ); + ELFIO_GET_ACCESS( unsigned char, elf_version, header.e_ident[EI_VERSION] ); + ELFIO_GET_ACCESS( unsigned char, encoding, header.e_ident[EI_DATA] ); + ELFIO_GET_ACCESS( Elf_Half, header_size, header.e_ehsize ); + ELFIO_GET_ACCESS( Elf_Half, section_entry_size, header.e_shentsize ); + ELFIO_GET_ACCESS( Elf_Half, segment_entry_size, header.e_phentsize ); + + ELFIO_GET_SET_ACCESS( Elf_Word, version, header.e_version ); + ELFIO_GET_SET_ACCESS( unsigned char, os_abi, header.e_ident[EI_OSABI] ); + ELFIO_GET_SET_ACCESS( unsigned char, + abi_version, + header.e_ident[EI_ABIVERSION] ); + ELFIO_GET_SET_ACCESS( Elf_Half, type, header.e_type ); + ELFIO_GET_SET_ACCESS( Elf_Half, machine, header.e_machine ); + ELFIO_GET_SET_ACCESS( Elf_Word, flags, header.e_flags ); + ELFIO_GET_SET_ACCESS( Elf_Half, section_name_str_index, header.e_shstrndx ); + ELFIO_GET_SET_ACCESS( Elf64_Addr, entry, header.e_entry ); + ELFIO_GET_SET_ACCESS( Elf_Half, sections_num, header.e_shnum ); + ELFIO_GET_SET_ACCESS( Elf64_Off, sections_offset, header.e_shoff ); + ELFIO_GET_SET_ACCESS( Elf_Half, segments_num, header.e_phnum ); + ELFIO_GET_SET_ACCESS( Elf64_Off, segments_offset, header.e_phoff ); + + private: + T header; + endianess_convertor* convertor; +}; + +} // namespace ELFIO + +#endif // ELF_HEADER_HPP + +/*** End of inlined file: elfio_header.hpp ***/ + + +/*** Start of inlined file: elfio_section.hpp ***/ +#ifndef ELFIO_SECTION_HPP +#define ELFIO_SECTION_HPP + +#include +#include +#include + +namespace ELFIO { + +class section +{ + friend class elfio; + + public: + virtual ~section(){}; + + ELFIO_GET_ACCESS_DECL( Elf_Half, index ); + ELFIO_GET_SET_ACCESS_DECL( std::string, name ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, type ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Xword, flags ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, info ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, link ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Xword, addr_align ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Xword, entry_size ); + ELFIO_GET_SET_ACCESS_DECL( Elf64_Addr, address ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Xword, size ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, name_string_offset ); + ELFIO_GET_ACCESS_DECL( Elf64_Off, offset ); + + virtual const char* get_data() const = 0; + virtual void set_data( const char* pData, Elf_Word size ) = 0; + virtual void set_data( const std::string& data ) = 0; + virtual void append_data( const char* pData, Elf_Word size ) = 0; + virtual void append_data( const std::string& data ) = 0; + virtual size_t get_stream_size() const = 0; + virtual void set_stream_size( size_t value ) = 0; + + protected: + ELFIO_SET_ACCESS_DECL( Elf64_Off, offset ); + ELFIO_SET_ACCESS_DECL( Elf_Half, index ); + + virtual void load( std::istream& stream, std::streampos header_offset ) = 0; + virtual void save( std::ostream& stream, + std::streampos header_offset, + std::streampos data_offset ) = 0; + virtual bool is_address_initialized() const = 0; +}; + +template class section_impl : public section +{ + public: + //------------------------------------------------------------------------------ + section_impl( const endianess_convertor* convertor_ ) + : convertor( convertor_ ) + { + std::fill_n( reinterpret_cast( &header ), sizeof( header ), + '\0' ); + is_address_set = false; + data = 0; + data_size = 0; + index = 0; + stream_size = 0; + } + + //------------------------------------------------------------------------------ + ~section_impl() { delete[] data; } + + //------------------------------------------------------------------------------ + // Section info functions + ELFIO_GET_SET_ACCESS( Elf_Word, type, header.sh_type ); + ELFIO_GET_SET_ACCESS( Elf_Xword, flags, header.sh_flags ); + ELFIO_GET_SET_ACCESS( Elf_Xword, size, header.sh_size ); + ELFIO_GET_SET_ACCESS( Elf_Word, link, header.sh_link ); + ELFIO_GET_SET_ACCESS( Elf_Word, info, header.sh_info ); + ELFIO_GET_SET_ACCESS( Elf_Xword, addr_align, header.sh_addralign ); + ELFIO_GET_SET_ACCESS( Elf_Xword, entry_size, header.sh_entsize ); + ELFIO_GET_SET_ACCESS( Elf_Word, name_string_offset, header.sh_name ); + ELFIO_GET_ACCESS( Elf64_Addr, address, header.sh_addr ); + + //------------------------------------------------------------------------------ + Elf_Half get_index() const { return index; } + + //------------------------------------------------------------------------------ + std::string get_name() const { return name; } + + //------------------------------------------------------------------------------ + void set_name( std::string name_ ) { name = name_; } + + //------------------------------------------------------------------------------ + void set_address( Elf64_Addr value ) + { + header.sh_addr = value; + header.sh_addr = ( *convertor )( header.sh_addr ); + is_address_set = true; + } + + //------------------------------------------------------------------------------ + bool is_address_initialized() const { return is_address_set; } + + //------------------------------------------------------------------------------ + const char* get_data() const { return data; } + + //------------------------------------------------------------------------------ + void set_data( const char* raw_data, Elf_Word size ) + { + if ( get_type() != SHT_NOBITS ) { + delete[] data; + data = new ( std::nothrow ) char[size]; + if ( 0 != data && 0 != raw_data ) { + data_size = size; + std::copy( raw_data, raw_data + size, data ); + } + else { + data_size = 0; + } + } + + set_size( data_size ); + } + + //------------------------------------------------------------------------------ + void set_data( const std::string& str_data ) + { + return set_data( str_data.c_str(), (Elf_Word)str_data.size() ); + } + + //------------------------------------------------------------------------------ + void append_data( const char* raw_data, Elf_Word size ) + { + if ( get_type() != SHT_NOBITS ) { + if ( get_size() + size < data_size ) { + std::copy( raw_data, raw_data + size, data + get_size() ); + } + else { + data_size = 2 * ( data_size + size ); + char* new_data = new ( std::nothrow ) char[data_size]; + + if ( 0 != new_data ) { + std::copy( data, data + get_size(), new_data ); + std::copy( raw_data, raw_data + size, + new_data + get_size() ); + delete[] data; + data = new_data; + } + else { + size = 0; + } + } + set_size( get_size() + size ); + } + } + + //------------------------------------------------------------------------------ + void append_data( const std::string& str_data ) + { + return append_data( str_data.c_str(), (Elf_Word)str_data.size() ); + } + + //------------------------------------------------------------------------------ + protected: + //------------------------------------------------------------------------------ + ELFIO_GET_SET_ACCESS( Elf64_Off, offset, header.sh_offset ); + + //------------------------------------------------------------------------------ + void set_index( Elf_Half value ) { index = value; } + + //------------------------------------------------------------------------------ + void load( std::istream& stream, std::streampos header_offset ) + { + std::fill_n( reinterpret_cast( &header ), sizeof( header ), + '\0' ); + + stream.seekg( 0, stream.end ); + set_stream_size( stream.tellg() ); + + stream.seekg( header_offset ); + stream.read( reinterpret_cast( &header ), sizeof( header ) ); + + Elf_Xword size = get_size(); + if ( 0 == data && SHT_NULL != get_type() && SHT_NOBITS != get_type() && + size < get_stream_size() ) { + data = new ( std::nothrow ) char[size + 1]; + + if ( ( 0 != size ) && ( 0 != data ) ) { + stream.seekg( ( *convertor )( header.sh_offset ) ); + stream.read( data, size ); + data[size] = 0; // Ensure data is ended with 0 to avoid oob read + data_size = size; + } + else { + data_size = 0; + } + } + } + + //------------------------------------------------------------------------------ + void save( std::ostream& stream, + std::streampos header_offset, + std::streampos data_offset ) + { + if ( 0 != get_index() ) { + header.sh_offset = data_offset; + header.sh_offset = ( *convertor )( header.sh_offset ); + } + + save_header( stream, header_offset ); + if ( get_type() != SHT_NOBITS && get_type() != SHT_NULL && + get_size() != 0 && data != 0 ) { + save_data( stream, data_offset ); + } + } + + //------------------------------------------------------------------------------ + private: + //------------------------------------------------------------------------------ + void save_header( std::ostream& stream, std::streampos header_offset ) const + { + stream.seekp( header_offset ); + stream.write( reinterpret_cast( &header ), + sizeof( header ) ); + } + + //------------------------------------------------------------------------------ + void save_data( std::ostream& stream, std::streampos data_offset ) const + { + stream.seekp( data_offset ); + stream.write( get_data(), get_size() ); + } + + //------------------------------------------------------------------------------ + size_t get_stream_size() const { return stream_size; } + + //------------------------------------------------------------------------------ + void set_stream_size( size_t value ) { stream_size = value; } + + //------------------------------------------------------------------------------ + private: + T header; + Elf_Half index; + std::string name; + char* data; + Elf_Word data_size; + const endianess_convertor* convertor; + bool is_address_set; + size_t stream_size; +}; + +} // namespace ELFIO + +#endif // ELFIO_SECTION_HPP + +/*** End of inlined file: elfio_section.hpp ***/ + + +/*** Start of inlined file: elfio_segment.hpp ***/ +#ifndef ELFIO_SEGMENT_HPP +#define ELFIO_SEGMENT_HPP + +#include +#include +#include + +namespace ELFIO { + +class segment +{ + friend class elfio; + + public: + virtual ~segment(){}; + + ELFIO_GET_ACCESS_DECL( Elf_Half, index ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, type ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Word, flags ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Xword, align ); + ELFIO_GET_SET_ACCESS_DECL( Elf64_Addr, virtual_address ); + ELFIO_GET_SET_ACCESS_DECL( Elf64_Addr, physical_address ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Xword, file_size ); + ELFIO_GET_SET_ACCESS_DECL( Elf_Xword, memory_size ); + ELFIO_GET_ACCESS_DECL( Elf64_Off, offset ); + + virtual const char* get_data() const = 0; + + virtual Elf_Half add_section_index( Elf_Half index, + Elf_Xword addr_align ) = 0; + virtual Elf_Half get_sections_num() const = 0; + virtual Elf_Half get_section_index_at( Elf_Half num ) const = 0; + virtual bool is_offset_initialized() const = 0; + + protected: + ELFIO_SET_ACCESS_DECL( Elf64_Off, offset ); + ELFIO_SET_ACCESS_DECL( Elf_Half, index ); + + virtual const std::vector& get_sections() const = 0; + virtual void load( std::istream& stream, std::streampos header_offset ) = 0; + virtual void save( std::ostream& stream, + std::streampos header_offset, + std::streampos data_offset ) = 0; +}; + +//------------------------------------------------------------------------------ +template class segment_impl : public segment +{ + public: + //------------------------------------------------------------------------------ + segment_impl( endianess_convertor* convertor_ ) + : stream_size( 0 ), index( 0 ), data( 0 ), convertor( convertor_ ) + { + is_offset_set = false; + std::fill_n( reinterpret_cast( &ph ), sizeof( ph ), '\0' ); + } + + //------------------------------------------------------------------------------ + virtual ~segment_impl() { delete[] data; } + + //------------------------------------------------------------------------------ + // Section info functions + ELFIO_GET_SET_ACCESS( Elf_Word, type, ph.p_type ); + ELFIO_GET_SET_ACCESS( Elf_Word, flags, ph.p_flags ); + ELFIO_GET_SET_ACCESS( Elf_Xword, align, ph.p_align ); + ELFIO_GET_SET_ACCESS( Elf64_Addr, virtual_address, ph.p_vaddr ); + ELFIO_GET_SET_ACCESS( Elf64_Addr, physical_address, ph.p_paddr ); + ELFIO_GET_SET_ACCESS( Elf_Xword, file_size, ph.p_filesz ); + ELFIO_GET_SET_ACCESS( Elf_Xword, memory_size, ph.p_memsz ); + ELFIO_GET_ACCESS( Elf64_Off, offset, ph.p_offset ); + size_t stream_size; + + //------------------------------------------------------------------------------ + size_t get_stream_size() const { return stream_size; } + + //------------------------------------------------------------------------------ + void set_stream_size( size_t value ) { stream_size = value; } + + //------------------------------------------------------------------------------ + Elf_Half get_index() const { return index; } + + //------------------------------------------------------------------------------ + const char* get_data() const { return data; } + + //------------------------------------------------------------------------------ + Elf_Half add_section_index( Elf_Half sec_index, Elf_Xword addr_align ) + { + sections.push_back( sec_index ); + if ( addr_align > get_align() ) { + set_align( addr_align ); + } + + return (Elf_Half)sections.size(); + } + + //------------------------------------------------------------------------------ + Elf_Half get_sections_num() const { return (Elf_Half)sections.size(); } + + //------------------------------------------------------------------------------ + Elf_Half get_section_index_at( Elf_Half num ) const + { + if ( num < sections.size() ) { + return sections[num]; + } + + return Elf_Half( -1 ); + } + + //------------------------------------------------------------------------------ + protected: + //------------------------------------------------------------------------------ + + //------------------------------------------------------------------------------ + void set_offset( Elf64_Off value ) + { + ph.p_offset = value; + ph.p_offset = ( *convertor )( ph.p_offset ); + is_offset_set = true; + } + + //------------------------------------------------------------------------------ + bool is_offset_initialized() const { return is_offset_set; } + + //------------------------------------------------------------------------------ + const std::vector& get_sections() const { return sections; } + + //------------------------------------------------------------------------------ + void set_index( Elf_Half value ) { index = value; } + + //------------------------------------------------------------------------------ + void load( std::istream& stream, std::streampos header_offset ) + { + + stream.seekg( 0, stream.end ); + set_stream_size( stream.tellg() ); + + stream.seekg( header_offset ); + stream.read( reinterpret_cast( &ph ), sizeof( ph ) ); + is_offset_set = true; + + if ( PT_NULL != get_type() && 0 != get_file_size() ) { + stream.seekg( ( *convertor )( ph.p_offset ) ); + Elf_Xword size = get_file_size(); + + if ( size > get_stream_size() ) { + data = 0; + } + else { + data = new (std::nothrow) char[size + 1]; + + if ( 0 != data ) { + stream.read( data, size ); + data[size] = 0; + } + } + } + } + + //------------------------------------------------------------------------------ + void save( std::ostream& stream, + std::streampos header_offset, + std::streampos data_offset ) + { + ph.p_offset = data_offset; + ph.p_offset = ( *convertor )( ph.p_offset ); + stream.seekp( header_offset ); + stream.write( reinterpret_cast( &ph ), sizeof( ph ) ); + } + + //------------------------------------------------------------------------------ + private: + T ph; + Elf_Half index; + char* data; + std::vector sections; + endianess_convertor* convertor; + bool is_offset_set; +}; + +} // namespace ELFIO + +#endif // ELFIO_SEGMENT_HPP + +/*** End of inlined file: elfio_segment.hpp ***/ + + +/*** Start of inlined file: elfio_strings.hpp ***/ +#ifndef ELFIO_STRINGS_HPP +#define ELFIO_STRINGS_HPP + +#include +#include +#include + +namespace ELFIO { + +//------------------------------------------------------------------------------ +template class string_section_accessor_template +{ + public: + //------------------------------------------------------------------------------ + string_section_accessor_template( S* section_ ) : string_section( section_ ) + { + } + + //------------------------------------------------------------------------------ + const char* get_string( Elf_Word index ) const + { + if ( string_section ) { + if ( index < string_section->get_size() ) { + const char* data = string_section->get_data(); + if ( 0 != data ) { + return data + index; + } + } + } + + return 0; + } + + //------------------------------------------------------------------------------ + Elf_Word add_string( const char* str ) + { + Elf_Word current_position = 0; + + if ( string_section ) { + // Strings are addeded to the end of the current section data + current_position = (Elf_Word)string_section->get_size(); + + if ( current_position == 0 ) { + char empty_string = '\0'; + string_section->append_data( &empty_string, 1 ); + current_position++; + } + string_section->append_data( str, + (Elf_Word)std::strlen( str ) + 1 ); + } + + return current_position; + } + + //------------------------------------------------------------------------------ + Elf_Word add_string( const std::string& str ) + { + return add_string( str.c_str() ); + } + + //------------------------------------------------------------------------------ + private: + S* string_section; +}; + +using string_section_accessor = string_section_accessor_template
; +using const_string_section_accessor = + string_section_accessor_template; + +} // namespace ELFIO + +#endif // ELFIO_STRINGS_HPP + +/*** End of inlined file: elfio_strings.hpp ***/ + +#define ELFIO_HEADER_ACCESS_GET( TYPE, FNAME ) \ + TYPE get_##FNAME() const { return header ? ( header->get_##FNAME() ) : 0; } + +#define ELFIO_HEADER_ACCESS_GET_SET( TYPE, FNAME ) \ + TYPE get_##FNAME() const \ + { \ + return header ? ( header->get_##FNAME() ) : 0; \ + } \ + void set_##FNAME( TYPE val ) \ + { \ + if ( header ) { \ + header->set_##FNAME( val ); \ + } \ + } + +namespace ELFIO { + +//------------------------------------------------------------------------------ +class elfio +{ + public: + //------------------------------------------------------------------------------ + elfio() : sections( this ), segments( this ) + { + header = 0; + current_file_pos = 0; + create( ELFCLASS32, ELFDATA2LSB ); + } + + //------------------------------------------------------------------------------ + ~elfio() { clean(); } + + //------------------------------------------------------------------------------ + void create( unsigned char file_class, unsigned char encoding ) + { + clean(); + convertor.setup( encoding ); + header = create_header( file_class, encoding ); + create_mandatory_sections(); + } + + //------------------------------------------------------------------------------ + bool load( const std::string& file_name ) + { + std::ifstream stream; + stream.open( file_name.c_str(), std::ios::in | std::ios::binary ); + if ( !stream ) { + return false; + } + + return load( stream ); + } + + //------------------------------------------------------------------------------ + bool load( std::istream& stream ) + { + clean(); + + unsigned char e_ident[EI_NIDENT]; + // Read ELF file signature + stream.read( reinterpret_cast( &e_ident ), sizeof( e_ident ) ); + + // Is it ELF file? + if ( stream.gcount() != sizeof( e_ident ) || + e_ident[EI_MAG0] != ELFMAG0 || e_ident[EI_MAG1] != ELFMAG1 || + e_ident[EI_MAG2] != ELFMAG2 || e_ident[EI_MAG3] != ELFMAG3 ) { + return false; + } + + if ( ( e_ident[EI_CLASS] != ELFCLASS64 ) && + ( e_ident[EI_CLASS] != ELFCLASS32 ) ) { + return false; + } + + convertor.setup( e_ident[EI_DATA] ); + header = create_header( e_ident[EI_CLASS], e_ident[EI_DATA] ); + if ( 0 == header ) { + return false; + } + if ( !header->load( stream ) ) { + return false; + } + + load_sections( stream ); + bool is_still_good = load_segments( stream ); + return is_still_good; + } + + //------------------------------------------------------------------------------ + bool save( const std::string& file_name ) + { + std::ofstream stream; + stream.open( file_name.c_str(), std::ios::out | std::ios::binary ); + if ( !stream ) { + return false; + } + + return save( stream ); + } + + //------------------------------------------------------------------------------ + bool save( std::ostream& stream ) + { + if ( !stream || !header ) { + return false; + } + + bool is_still_good = true; + // Define layout specific header fields + // The position of the segment table is fixed after the header. + // The position of the section table is variable and needs to be fixed + // before saving. + header->set_segments_num( segments.size() ); + header->set_segments_offset( segments.size() ? header->get_header_size() + : 0 ); + header->set_sections_num( sections.size() ); + header->set_sections_offset( 0 ); + + // Layout the first section right after the segment table + current_file_pos = header->get_header_size() + + header->get_segment_entry_size() * + (Elf_Xword)header->get_segments_num(); + + calc_segment_alignment(); + + is_still_good = layout_segments_and_their_sections(); + is_still_good = is_still_good && layout_sections_without_segments(); + is_still_good = is_still_good && layout_section_table(); + + is_still_good = is_still_good && save_header( stream ); + is_still_good = is_still_good && save_sections( stream ); + is_still_good = is_still_good && save_segments( stream ); + + return is_still_good; + } + + //------------------------------------------------------------------------------ + // ELF header access functions + ELFIO_HEADER_ACCESS_GET( unsigned char, class ); + ELFIO_HEADER_ACCESS_GET( unsigned char, elf_version ); + ELFIO_HEADER_ACCESS_GET( unsigned char, encoding ); + ELFIO_HEADER_ACCESS_GET( Elf_Word, version ); + ELFIO_HEADER_ACCESS_GET( Elf_Half, header_size ); + ELFIO_HEADER_ACCESS_GET( Elf_Half, section_entry_size ); + ELFIO_HEADER_ACCESS_GET( Elf_Half, segment_entry_size ); + + ELFIO_HEADER_ACCESS_GET_SET( unsigned char, os_abi ); + ELFIO_HEADER_ACCESS_GET_SET( unsigned char, abi_version ); + ELFIO_HEADER_ACCESS_GET_SET( Elf_Half, type ); + ELFIO_HEADER_ACCESS_GET_SET( Elf_Half, machine ); + ELFIO_HEADER_ACCESS_GET_SET( Elf_Word, flags ); + ELFIO_HEADER_ACCESS_GET_SET( Elf64_Addr, entry ); + ELFIO_HEADER_ACCESS_GET_SET( Elf64_Off, sections_offset ); + ELFIO_HEADER_ACCESS_GET_SET( Elf64_Off, segments_offset ); + ELFIO_HEADER_ACCESS_GET_SET( Elf_Half, section_name_str_index ); + + //------------------------------------------------------------------------------ + const endianess_convertor& get_convertor() const { return convertor; } + + //------------------------------------------------------------------------------ + Elf_Xword get_default_entry_size( Elf_Word section_type ) const + { + switch ( section_type ) { + case SHT_RELA: + if ( header->get_class() == ELFCLASS64 ) { + return sizeof( Elf64_Rela ); + } + else { + return sizeof( Elf32_Rela ); + } + case SHT_REL: + if ( header->get_class() == ELFCLASS64 ) { + return sizeof( Elf64_Rel ); + } + else { + return sizeof( Elf32_Rel ); + } + case SHT_SYMTAB: + if ( header->get_class() == ELFCLASS64 ) { + return sizeof( Elf64_Sym ); + } + else { + return sizeof( Elf32_Sym ); + } + case SHT_DYNAMIC: + if ( header->get_class() == ELFCLASS64 ) { + return sizeof( Elf64_Dyn ); + } + else { + return sizeof( Elf32_Dyn ); + } + default: + return 0; + } + } + + //------------------------------------------------------------------------------ + private: + bool is_offset_in_section( Elf64_Off offset, const section* sec ) const + { + return ( offset >= sec->get_offset() ) && + ( offset < ( sec->get_offset() + sec->get_size() ) ); + } + + //------------------------------------------------------------------------------ + public: + //! returns an empty string if no problems are detected, + //! or a string containing an error message if problems are found + std::string validate() const + { + + // check for overlapping sections in the file + for ( int i = 0; i < sections.size(); ++i ) { + for ( int j = i + 1; j < sections.size(); ++j ) { + const section* a = sections[i]; + const section* b = sections[j]; + if ( !( a->get_type() & SHT_NOBITS ) && + !( b->get_type() & SHT_NOBITS ) && ( a->get_size() > 0 ) && + ( b->get_size() > 0 ) && ( a->get_offset() > 0 ) && + ( b->get_offset() > 0 ) ) { + if ( is_offset_in_section( a->get_offset(), b ) || + is_offset_in_section( + a->get_offset() + a->get_size() - 1, b ) || + is_offset_in_section( b->get_offset(), a ) || + is_offset_in_section( + b->get_offset() + b->get_size() - 1, a ) ) { + return "Sections " + a->get_name() + " and " + + b->get_name() + " overlap in file"; + } + } + } + } + + // more checks to be added here... + + return ""; + } + + //------------------------------------------------------------------------------ + private: + //------------------------------------------------------------------------------ + void clean() + { + delete header; + header = 0; + + std::vector::const_iterator it; + for ( it = sections_.begin(); it != sections_.end(); ++it ) { + delete *it; + } + sections_.clear(); + + std::vector::const_iterator it1; + for ( it1 = segments_.begin(); it1 != segments_.end(); ++it1 ) { + delete *it1; + } + segments_.clear(); + } + + //------------------------------------------------------------------------------ + elf_header* create_header( unsigned char file_class, + unsigned char encoding ) + { + elf_header* new_header = 0; + + if ( file_class == ELFCLASS64 ) { + new_header = + new elf_header_impl( &convertor, encoding ); + } + else if ( file_class == ELFCLASS32 ) { + new_header = + new elf_header_impl( &convertor, encoding ); + } + else { + return 0; + } + + return new_header; + } + + //------------------------------------------------------------------------------ + section* create_section() + { + section* new_section; + unsigned char file_class = get_class(); + + if ( file_class == ELFCLASS64 ) { + new_section = new section_impl( &convertor ); + } + else if ( file_class == ELFCLASS32 ) { + new_section = new section_impl( &convertor ); + } + else { + return 0; + } + + new_section->set_index( (Elf_Half)sections_.size() ); + sections_.push_back( new_section ); + + return new_section; + } + + //------------------------------------------------------------------------------ + segment* create_segment() + { + segment* new_segment; + unsigned char file_class = header->get_class(); + + if ( file_class == ELFCLASS64 ) { + new_segment = new segment_impl( &convertor ); + } + else if ( file_class == ELFCLASS32 ) { + new_segment = new segment_impl( &convertor ); + } + else { + return 0; + } + + new_segment->set_index( (Elf_Half)segments_.size() ); + segments_.push_back( new_segment ); + + return new_segment; + } + + //------------------------------------------------------------------------------ + void create_mandatory_sections() + { + // Create null section without calling to 'add_section' as no string + // section containing section names exists yet + section* sec0 = create_section(); + sec0->set_index( 0 ); + sec0->set_name( "" ); + sec0->set_name_string_offset( 0 ); + + set_section_name_str_index( 1 ); + section* shstrtab = sections.add( ".shstrtab" ); + shstrtab->set_type( SHT_STRTAB ); + shstrtab->set_addr_align( 1 ); + } + + //------------------------------------------------------------------------------ + Elf_Half load_sections( std::istream& stream ) + { + Elf_Half entry_size = header->get_section_entry_size(); + Elf_Half num = header->get_sections_num(); + Elf64_Off offset = header->get_sections_offset(); + + for ( Elf_Half i = 0; i < num; ++i ) { + section* sec = create_section(); + sec->load( stream, (std::streamoff)offset + + (std::streampos)i * entry_size ); + sec->set_index( i ); + // To mark that the section is not permitted to reassign address + // during layout calculation + sec->set_address( sec->get_address() ); + } + + Elf_Half shstrndx = get_section_name_str_index(); + + if ( SHN_UNDEF != shstrndx ) { + string_section_accessor str_reader( sections[shstrndx] ); + for ( Elf_Half i = 0; i < num; ++i ) { + Elf_Word section_offset = sections[i]->get_name_string_offset(); + const char* p = str_reader.get_string( section_offset ); + if ( p != 0 ) { + sections[i]->set_name( p ); + } + } + } + + return num; + } + + //------------------------------------------------------------------------------ + //! Checks whether the addresses of the section entirely fall within the given segment. + //! It doesn't matter if the addresses are memory addresses, or file offsets, + //! they just need to be in the same address space + bool is_sect_in_seg( Elf64_Off sect_begin, + Elf_Xword sect_size, + Elf64_Off seg_begin, + Elf64_Off seg_end ) + { + return ( seg_begin <= sect_begin ) && + ( sect_begin + sect_size <= seg_end ) && + ( sect_begin < + seg_end ); // this is important criteria when sect_size == 0 + // Example: seg_begin=10, seg_end=12 (-> covering the bytes 10 and 11) + // sect_begin=12, sect_size=0 -> shall return false! + } + + //------------------------------------------------------------------------------ + bool load_segments( std::istream& stream ) + { + Elf_Half entry_size = header->get_segment_entry_size(); + Elf_Half num = header->get_segments_num(); + Elf64_Off offset = header->get_segments_offset(); + + for ( Elf_Half i = 0; i < num; ++i ) { + segment* seg; + unsigned char file_class = header->get_class(); + + if ( file_class == ELFCLASS64 ) { + seg = new segment_impl( &convertor ); + } + else if ( file_class == ELFCLASS32 ) { + seg = new segment_impl( &convertor ); + } + else { + return false; + } + + seg->load( stream, (std::streamoff)offset + + (std::streampos)i * entry_size ); + seg->set_index( i ); + + // Add sections to the segments (similar to readelfs algorithm) + Elf64_Off segBaseOffset = seg->get_offset(); + Elf64_Off segEndOffset = segBaseOffset + seg->get_file_size(); + Elf64_Off segVBaseAddr = seg->get_virtual_address(); + Elf64_Off segVEndAddr = segVBaseAddr + seg->get_memory_size(); + for ( Elf_Half j = 0; j < sections.size(); ++j ) { + const section* psec = sections[j]; + + // SHF_ALLOC sections are matched based on the virtual address + // otherwise the file offset is matched + if ( ( psec->get_flags() & SHF_ALLOC ) + ? is_sect_in_seg( psec->get_address(), + psec->get_size(), segVBaseAddr, + segVEndAddr ) + : is_sect_in_seg( psec->get_offset(), psec->get_size(), + segBaseOffset, segEndOffset ) ) { + // Alignment of segment shall not be updated, to preserve original value + // It will be re-calculated on saving. + seg->add_section_index( psec->get_index(), 0 ); + } + } + + // Add section into the segments' container + segments_.push_back( seg ); + } + + return true; + } + + //------------------------------------------------------------------------------ + bool save_header( std::ostream& stream ) { return header->save( stream ); } + + //------------------------------------------------------------------------------ + bool save_sections( std::ostream& stream ) + { + for ( unsigned int i = 0; i < sections_.size(); ++i ) { + section* sec = sections_.at( i ); + + std::streampos headerPosition = + (std::streamoff)header->get_sections_offset() + + (std::streampos)header->get_section_entry_size() * + sec->get_index(); + + sec->save( stream, headerPosition, sec->get_offset() ); + } + return true; + } + + //------------------------------------------------------------------------------ + bool save_segments( std::ostream& stream ) + { + for ( unsigned int i = 0; i < segments_.size(); ++i ) { + segment* seg = segments_.at( i ); + + std::streampos headerPosition = + header->get_segments_offset() + + (std::streampos)header->get_segment_entry_size() * + seg->get_index(); + + seg->save( stream, headerPosition, seg->get_offset() ); + } + return true; + } + + //------------------------------------------------------------------------------ + bool is_section_without_segment( unsigned int section_index ) + { + bool found = false; + + for ( unsigned int j = 0; !found && ( j < segments.size() ); ++j ) { + for ( unsigned int k = 0; + !found && ( k < segments[j]->get_sections_num() ); ++k ) { + found = segments[j]->get_section_index_at( k ) == section_index; + } + } + + return !found; + } + + //------------------------------------------------------------------------------ + bool is_subsequence_of( segment* seg1, segment* seg2 ) + { + // Return 'true' if sections of seg1 are a subset of sections in seg2 + const std::vector& sections1 = seg1->get_sections(); + const std::vector& sections2 = seg2->get_sections(); + + bool found = false; + if ( sections1.size() < sections2.size() ) { + found = std::includes( sections2.begin(), sections2.end(), + sections1.begin(), sections1.end() ); + } + + return found; + } + + //------------------------------------------------------------------------------ + std::vector get_ordered_segments() + { + std::vector res; + std::deque worklist; + + res.reserve( segments.size() ); + std::copy( segments_.begin(), segments_.end(), + std::back_inserter( worklist ) ); + + // Bring the segments which start at address 0 to the front + size_t nextSlot = 0; + for ( size_t i = 0; i < worklist.size(); ++i ) { + if ( i != nextSlot && worklist[i]->is_offset_initialized() && + worklist[i]->get_offset() == 0 ) { + if ( worklist[nextSlot]->get_offset() == 0 ) { + ++nextSlot; + } + std::swap( worklist[i], worklist[nextSlot] ); + ++nextSlot; + } + } + + while ( !worklist.empty() ) { + segment* seg = worklist.front(); + worklist.pop_front(); + + size_t i = 0; + for ( ; i < worklist.size(); ++i ) { + if ( is_subsequence_of( seg, worklist[i] ) ) { + break; + } + } + + if ( i < worklist.size() ) + worklist.push_back( seg ); + else + res.push_back( seg ); + } + + return res; + } + + //------------------------------------------------------------------------------ + bool layout_sections_without_segments() + { + for ( unsigned int i = 0; i < sections_.size(); ++i ) { + if ( is_section_without_segment( i ) ) { + section* sec = sections_[i]; + + Elf_Xword section_align = sec->get_addr_align(); + if ( section_align > 1 && + current_file_pos % section_align != 0 ) { + current_file_pos += + section_align - current_file_pos % section_align; + } + + if ( 0 != sec->get_index() ) + sec->set_offset( current_file_pos ); + + if ( SHT_NOBITS != sec->get_type() && + SHT_NULL != sec->get_type() ) { + current_file_pos += sec->get_size(); + } + } + } + + return true; + } + + //------------------------------------------------------------------------------ + void calc_segment_alignment() + { + for ( std::vector::iterator s = segments_.begin(); + s != segments_.end(); ++s ) { + segment* seg = *s; + for ( int i = 0; i < seg->get_sections_num(); ++i ) { + section* sect = sections_[seg->get_section_index_at( i )]; + if ( sect->get_addr_align() > seg->get_align() ) { + seg->set_align( sect->get_addr_align() ); + } + } + } + } + + //------------------------------------------------------------------------------ + bool layout_segments_and_their_sections() + { + std::vector worklist; + std::vector section_generated( sections.size(), false ); + + // Get segments in a order in where segments which contain a + // sub sequence of other segments are located at the end + worklist = get_ordered_segments(); + + for ( unsigned int i = 0; i < worklist.size(); ++i ) { + Elf_Xword segment_memory = 0; + Elf_Xword segment_filesize = 0; + Elf_Xword seg_start_pos = current_file_pos; + segment* seg = worklist[i]; + + // Special case: PHDR segment + // This segment contains the program headers but no sections + if ( seg->get_type() == PT_PHDR && seg->get_sections_num() == 0 ) { + seg_start_pos = header->get_segments_offset(); + segment_memory = segment_filesize = + header->get_segment_entry_size() * + (Elf_Xword)header->get_segments_num(); + } + // Special case: + else if ( seg->is_offset_initialized() && seg->get_offset() == 0 ) { + seg_start_pos = 0; + if ( seg->get_sections_num() ) { + segment_memory = segment_filesize = current_file_pos; + } + } + // New segments with not generated sections + // have to be aligned + else if ( seg->get_sections_num() && + !section_generated[seg->get_section_index_at( 0 )] ) { + Elf_Xword align = seg->get_align() > 0 ? seg->get_align() : 1; + Elf64_Off cur_page_alignment = current_file_pos % align; + Elf64_Off req_page_alignment = + seg->get_virtual_address() % align; + Elf64_Off error = req_page_alignment - cur_page_alignment; + + current_file_pos += ( seg->get_align() + error ) % align; + seg_start_pos = current_file_pos; + } + else if ( seg->get_sections_num() ) { + seg_start_pos = + sections[seg->get_section_index_at( 0 )]->get_offset(); + } + + // Write segment's data + for ( unsigned int j = 0; j < seg->get_sections_num(); ++j ) { + Elf_Half index = seg->get_section_index_at( j ); + + section* sec = sections[index]; + + // The NULL section is always generated + if ( SHT_NULL == sec->get_type() ) { + section_generated[index] = true; + continue; + } + + Elf_Xword secAlign = 0; + // Fix up the alignment + if ( !section_generated[index] && + sec->is_address_initialized() && + SHT_NOBITS != sec->get_type() && + SHT_NULL != sec->get_type() && 0 != sec->get_size() ) { + // Align the sections based on the virtual addresses + // when possible (this is what matters for execution) + Elf64_Off req_offset = + sec->get_address() - seg->get_virtual_address(); + Elf64_Off cur_offset = current_file_pos - seg_start_pos; + if ( req_offset < cur_offset ) { + // something has gone awfully wrong, abort! + // secAlign would turn out negative, seeking backwards and overwriting previous data + return false; + } + secAlign = req_offset - cur_offset; + } + else if ( !section_generated[index] && + !sec->is_address_initialized() ) { + // If no address has been specified then only the section + // alignment constraint has to be matched + Elf_Xword align = sec->get_addr_align(); + if ( align == 0 ) { + align = 1; + } + Elf64_Off error = current_file_pos % align; + secAlign = ( align - error ) % align; + } + else if ( section_generated[index] ) { + // Alignment for already generated sections + secAlign = + sec->get_offset() - seg_start_pos - segment_filesize; + } + + // Determine the segment file and memory sizes + // Special case .tbss section (NOBITS) in non TLS segment + if ( ( sec->get_flags() & SHF_ALLOC ) && + !( ( sec->get_flags() & SHF_TLS ) && + ( seg->get_type() != PT_TLS ) && + ( SHT_NOBITS == sec->get_type() ) ) ) + segment_memory += sec->get_size() + secAlign; + + if ( SHT_NOBITS != sec->get_type() ) + segment_filesize += sec->get_size() + secAlign; + + // Nothing to be done when generating nested segments + if ( section_generated[index] ) { + continue; + } + + current_file_pos += secAlign; + + // Set the section addresses when missing + if ( !sec->is_address_initialized() ) + sec->set_address( seg->get_virtual_address() + + current_file_pos - seg_start_pos ); + + if ( 0 != sec->get_index() ) + sec->set_offset( current_file_pos ); + + if ( SHT_NOBITS != sec->get_type() ) + current_file_pos += sec->get_size(); + + section_generated[index] = true; + } + + seg->set_file_size( segment_filesize ); + + // If we already have a memory size from loading an elf file (value > 0), + // it must not shrink! + // Memory size may be bigger than file size and it is the loader's job to do something + // with the surplus bytes in memory, like initializing them with a defined value. + if ( seg->get_memory_size() < segment_memory ) { + seg->set_memory_size( segment_memory ); + } + + seg->set_offset( seg_start_pos ); + } + + return true; + } + + //------------------------------------------------------------------------------ + bool layout_section_table() + { + // Simply place the section table at the end for now + Elf64_Off alignmentError = current_file_pos % 4; + current_file_pos += ( 4 - alignmentError ) % 4; + header->set_sections_offset( current_file_pos ); + return true; + } + + //------------------------------------------------------------------------------ + public: + friend class Sections; + class Sections + { + public: + //------------------------------------------------------------------------------ + Sections( elfio* parent_ ) : parent( parent_ ) {} + + //------------------------------------------------------------------------------ + Elf_Half size() const { return (Elf_Half)parent->sections_.size(); } + + //------------------------------------------------------------------------------ + section* operator[]( unsigned int index ) const + { + section* sec = 0; + + if ( index < parent->sections_.size() ) { + sec = parent->sections_[index]; + } + + return sec; + } + + //------------------------------------------------------------------------------ + section* operator[]( const std::string& name ) const + { + section* sec = 0; + + std::vector::const_iterator it; + for ( it = parent->sections_.begin(); it != parent->sections_.end(); + ++it ) { + if ( ( *it )->get_name() == name ) { + sec = *it; + break; + } + } + + return sec; + } + + //------------------------------------------------------------------------------ + section* add( const std::string& name ) + { + section* new_section = parent->create_section(); + new_section->set_name( name ); + + Elf_Half str_index = parent->get_section_name_str_index(); + section* string_table( parent->sections_[str_index] ); + string_section_accessor str_writer( string_table ); + Elf_Word pos = str_writer.add_string( name ); + new_section->set_name_string_offset( pos ); + + return new_section; + } + + //------------------------------------------------------------------------------ + std::vector::iterator begin() + { + return parent->sections_.begin(); + } + + //------------------------------------------------------------------------------ + std::vector::iterator end() + { + return parent->sections_.end(); + } + + //------------------------------------------------------------------------------ + std::vector::const_iterator begin() const + { + return parent->sections_.cbegin(); + } + + //------------------------------------------------------------------------------ + std::vector::const_iterator end() const + { + return parent->sections_.cend(); + } + + //------------------------------------------------------------------------------ + private: + elfio* parent; + } sections; + + //------------------------------------------------------------------------------ + public: + friend class Segments; + class Segments + { + public: + //------------------------------------------------------------------------------ + Segments( elfio* parent_ ) : parent( parent_ ) {} + + //------------------------------------------------------------------------------ + Elf_Half size() const { return (Elf_Half)parent->segments_.size(); } + + //------------------------------------------------------------------------------ + segment* operator[]( unsigned int index ) const + { + return parent->segments_[index]; + } + + //------------------------------------------------------------------------------ + segment* add() { return parent->create_segment(); } + + //------------------------------------------------------------------------------ + std::vector::iterator begin() + { + return parent->segments_.begin(); + } + + //------------------------------------------------------------------------------ + std::vector::iterator end() + { + return parent->segments_.end(); + } + + //------------------------------------------------------------------------------ + std::vector::const_iterator begin() const + { + return parent->segments_.cbegin(); + } + + //------------------------------------------------------------------------------ + std::vector::const_iterator end() const + { + return parent->segments_.cend(); + } + + //------------------------------------------------------------------------------ + private: + elfio* parent; + } segments; + + //------------------------------------------------------------------------------ + private: + elf_header* header; + std::vector sections_; + std::vector segments_; + endianess_convertor convertor; + + Elf_Xword current_file_pos; +}; + +} // namespace ELFIO + + +/*** Start of inlined file: elfio_symbols.hpp ***/ +#ifndef ELFIO_SYMBOLS_HPP +#define ELFIO_SYMBOLS_HPP + +namespace ELFIO { + +//------------------------------------------------------------------------------ +template class symbol_section_accessor_template +{ + public: + //------------------------------------------------------------------------------ + symbol_section_accessor_template( const elfio& elf_file_, + S* symbol_section_ ) + : elf_file( elf_file_ ), symbol_section( symbol_section_ ) + { + find_hash_section(); + } + + //------------------------------------------------------------------------------ + Elf_Xword get_symbols_num() const + { + Elf_Xword nRet = 0; + if ( 0 != symbol_section->get_entry_size() ) { + nRet = + symbol_section->get_size() / symbol_section->get_entry_size(); + } + + return nRet; + } + + //------------------------------------------------------------------------------ + bool get_symbol( Elf_Xword index, + std::string& name, + Elf64_Addr& value, + Elf_Xword& size, + unsigned char& bind, + unsigned char& type, + Elf_Half& section_index, + unsigned char& other ) const + { + bool ret = false; + + if ( elf_file.get_class() == ELFCLASS32 ) { + ret = generic_get_symbol( index, name, value, size, bind, + type, section_index, other ); + } + else { + ret = generic_get_symbol( index, name, value, size, bind, + type, section_index, other ); + } + + return ret; + } + + //------------------------------------------------------------------------------ + bool get_symbol( const std::string& name, + Elf64_Addr& value, + Elf_Xword& size, + unsigned char& bind, + unsigned char& type, + Elf_Half& section_index, + unsigned char& other ) const + { + bool ret = false; + + if ( 0 != get_hash_table_index() ) { + Elf_Word nbucket = *(const Elf_Word*)hash_section->get_data(); + Elf_Word nchain = *(const Elf_Word*)( hash_section->get_data() + + sizeof( Elf_Word ) ); + Elf_Word val = elf_hash( (const unsigned char*)name.c_str() ); + Elf_Word y = *(const Elf_Word*)( hash_section->get_data() + + ( 2 + val % nbucket ) * + sizeof( Elf_Word ) ); + std::string str; + get_symbol( y, str, value, size, bind, type, section_index, other ); + while ( str != name && STN_UNDEF != y && y < nchain ) { + y = *(const Elf_Word*)( hash_section->get_data() + + ( 2 + nbucket + y ) * + sizeof( Elf_Word ) ); + get_symbol( y, str, value, size, bind, type, section_index, + other ); + } + if ( str == name ) { + ret = true; + } + } + else { + for ( Elf_Xword i = 0; i < get_symbols_num() && !ret; i++ ) { + std::string symbol_name; + if ( get_symbol( i, symbol_name, value, size, bind, type, + section_index, other ) ) { + if ( symbol_name == name ) { + ret = true; + } + } + } + } + + return ret; + } + + //------------------------------------------------------------------------------ + bool get_symbol( const Elf64_Addr& value, + std::string& name, + Elf_Xword& size, + unsigned char& bind, + unsigned char& type, + Elf_Half& section_index, + unsigned char& other ) const + { + + const endianess_convertor& convertor = elf_file.get_convertor(); + + Elf_Xword idx = 0; + bool match = false; + Elf64_Addr v = 0; + + if ( elf_file.get_class() == ELFCLASS32 ) { + match = generic_search_symbols( + [&]( const Elf32_Sym* sym ) { + return convertor( sym->st_value ) == value; + }, + idx ); + } + else { + match = generic_search_symbols( + [&]( const Elf64_Sym* sym ) { + return convertor( sym->st_value ) == value; + }, + idx ); + } + + if ( match ) { + return get_symbol( idx, name, v, size, bind, type, section_index, + other ); + } + + return false; + } + + //------------------------------------------------------------------------------ + Elf_Word add_symbol( Elf_Word name, + Elf64_Addr value, + Elf_Xword size, + unsigned char info, + unsigned char other, + Elf_Half shndx ) + { + Elf_Word nRet; + + if ( symbol_section->get_size() == 0 ) { + if ( elf_file.get_class() == ELFCLASS32 ) { + nRet = generic_add_symbol( 0, 0, 0, 0, 0, 0 ); + } + else { + nRet = generic_add_symbol( 0, 0, 0, 0, 0, 0 ); + } + } + + if ( elf_file.get_class() == ELFCLASS32 ) { + nRet = generic_add_symbol( name, value, size, info, + other, shndx ); + } + else { + nRet = generic_add_symbol( name, value, size, info, + other, shndx ); + } + + return nRet; + } + + //------------------------------------------------------------------------------ + Elf_Word add_symbol( Elf_Word name, + Elf64_Addr value, + Elf_Xword size, + unsigned char bind, + unsigned char type, + unsigned char other, + Elf_Half shndx ) + { + return add_symbol( name, value, size, ELF_ST_INFO( bind, type ), other, + shndx ); + } + + //------------------------------------------------------------------------------ + Elf_Word add_symbol( string_section_accessor& pStrWriter, + const char* str, + Elf64_Addr value, + Elf_Xword size, + unsigned char info, + unsigned char other, + Elf_Half shndx ) + { + Elf_Word index = pStrWriter.add_string( str ); + return add_symbol( index, value, size, info, other, shndx ); + } + + //------------------------------------------------------------------------------ + Elf_Word add_symbol( string_section_accessor& pStrWriter, + const char* str, + Elf64_Addr value, + Elf_Xword size, + unsigned char bind, + unsigned char type, + unsigned char other, + Elf_Half shndx ) + { + return add_symbol( pStrWriter, str, value, size, + ELF_ST_INFO( bind, type ), other, shndx ); + } + + //------------------------------------------------------------------------------ + Elf_Xword arrange_local_symbols( + std::function func = + nullptr ) + { + int nRet = 0; + + if ( elf_file.get_class() == ELFCLASS32 ) { + nRet = generic_arrange_local_symbols( func ); + } + else { + nRet = generic_arrange_local_symbols( func ); + } + + return nRet; + } + + //------------------------------------------------------------------------------ + private: + //------------------------------------------------------------------------------ + void find_hash_section() + { + hash_section = 0; + hash_section_index = 0; + Elf_Half nSecNo = elf_file.sections.size(); + for ( Elf_Half i = 0; i < nSecNo && 0 == hash_section_index; ++i ) { + const section* sec = elf_file.sections[i]; + if ( sec->get_link() == symbol_section->get_index() ) { + hash_section = sec; + hash_section_index = i; + } + } + } + + //------------------------------------------------------------------------------ + Elf_Half get_string_table_index() const + { + return (Elf_Half)symbol_section->get_link(); + } + + //------------------------------------------------------------------------------ + Elf_Half get_hash_table_index() const { return hash_section_index; } + + //------------------------------------------------------------------------------ + template const T* generic_get_symbol_ptr( Elf_Xword index ) const + { + if ( 0 != symbol_section->get_data() && index < get_symbols_num() ) { + const T* pSym = reinterpret_cast( + symbol_section->get_data() + + index * symbol_section->get_entry_size() ); + + return pSym; + } + + return nullptr; + } + + //------------------------------------------------------------------------------ + template + bool generic_search_symbols( std::function match, + Elf_Xword& idx ) const + { + for ( Elf_Xword i = 0; i < get_symbols_num(); i++ ) { + const T* symPtr = generic_get_symbol_ptr( i ); + + if ( symPtr == nullptr ) + return false; + + if ( match( symPtr ) ) { + idx = i; + return true; + } + } + + return false; + } + + //------------------------------------------------------------------------------ + template + bool generic_get_symbol( Elf_Xword index, + std::string& name, + Elf64_Addr& value, + Elf_Xword& size, + unsigned char& bind, + unsigned char& type, + Elf_Half& section_index, + unsigned char& other ) const + { + bool ret = false; + + if ( 0 != symbol_section->get_data() && index < get_symbols_num() ) { + const T* pSym = reinterpret_cast( + symbol_section->get_data() + + index * symbol_section->get_entry_size() ); + + const endianess_convertor& convertor = elf_file.get_convertor(); + + section* string_section = + elf_file.sections[get_string_table_index()]; + string_section_accessor str_reader( string_section ); + const char* pStr = + str_reader.get_string( convertor( pSym->st_name ) ); + if ( 0 != pStr ) { + name = pStr; + } + value = convertor( pSym->st_value ); + size = convertor( pSym->st_size ); + bind = ELF_ST_BIND( pSym->st_info ); + type = ELF_ST_TYPE( pSym->st_info ); + section_index = convertor( pSym->st_shndx ); + other = pSym->st_other; + + ret = true; + } + + return ret; + } + + //------------------------------------------------------------------------------ + template + Elf_Word generic_add_symbol( Elf_Word name, + Elf64_Addr value, + Elf_Xword size, + unsigned char info, + unsigned char other, + Elf_Half shndx ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + T entry; + entry.st_name = convertor( name ); + entry.st_value = value; + entry.st_value = convertor( entry.st_value ); + entry.st_size = size; + entry.st_size = convertor( entry.st_size ); + entry.st_info = convertor( info ); + entry.st_other = convertor( other ); + entry.st_shndx = convertor( shndx ); + + symbol_section->append_data( reinterpret_cast( &entry ), + sizeof( entry ) ); + + Elf_Word nRet = symbol_section->get_size() / sizeof( entry ) - 1; + + return nRet; + } + + //------------------------------------------------------------------------------ + template + Elf_Xword generic_arrange_local_symbols( + std::function func ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + const Elf_Xword size = symbol_section->get_entry_size(); + + Elf_Xword first_not_local = + 1; // Skip the first entry. It is always NOTYPE + Elf_Xword current = 0; + Elf_Xword count = get_symbols_num(); + + while ( true ) { + T* p1 = nullptr; + T* p2 = nullptr; + + while ( first_not_local < count ) { + p1 = const_cast( + generic_get_symbol_ptr( first_not_local ) ); + if ( ELF_ST_BIND( convertor( p1->st_info ) ) != STB_LOCAL ) + break; + ++first_not_local; + } + + current = first_not_local + 1; + while ( current < count ) { + p2 = const_cast( generic_get_symbol_ptr( current ) ); + if ( ELF_ST_BIND( convertor( p2->st_info ) ) == STB_LOCAL ) + break; + ++current; + } + + if ( first_not_local < count && current < count ) { + if ( func ) + func( first_not_local, current ); + + // Swap the symbols + T tmp; + std::copy( p1, p1 + 1, &tmp ); + std::copy( p2, p2 + 1, p1 ); + std::copy( &tmp, &tmp + 1, p2 ); + } + else { + // Update 'info' field of the section + symbol_section->set_info( first_not_local ); + break; + } + } + + // Elf_Word nRet = symbol_section->get_size() / sizeof(entry) - 1; + + return first_not_local; + } + + //------------------------------------------------------------------------------ + private: + const elfio& elf_file; + S* symbol_section; + Elf_Half hash_section_index; + const section* hash_section; +}; + +using symbol_section_accessor = symbol_section_accessor_template
; +using const_symbol_section_accessor = + symbol_section_accessor_template; + +} // namespace ELFIO + +#endif // ELFIO_SYMBOLS_HPP + +/*** End of inlined file: elfio_symbols.hpp ***/ + + +/*** Start of inlined file: elfio_note.hpp ***/ +#ifndef ELFIO_NOTE_HPP +#define ELFIO_NOTE_HPP + +namespace ELFIO { + +//------------------------------------------------------------------------------ +// There are discrepancies in documentations. SCO documentation +// (http://www.sco.com/developers/gabi/latest/ch5.pheader.html#note_section) +// requires 8 byte entries alignment for 64-bit ELF file, +// but Oracle's definition uses the same structure +// for 32-bit and 64-bit formats. +// (https://docs.oracle.com/cd/E23824_01/html/819-0690/chapter6-18048.html) +// +// It looks like EM_X86_64 Linux implementation is similar to Oracle's +// definition. Therefore, the same alignment works for both formats +//------------------------------------------------------------------------------ + +//------------------------------------------------------------------------------ +template class note_section_accessor_template +{ + public: + //------------------------------------------------------------------------------ + note_section_accessor_template( const elfio& elf_file_, S* section_ ) + : elf_file( elf_file_ ), note_section( section_ ) + { + process_section(); + } + + //------------------------------------------------------------------------------ + Elf_Word get_notes_num() const + { + return (Elf_Word)note_start_positions.size(); + } + + //------------------------------------------------------------------------------ + bool get_note( Elf_Word index, + Elf_Word& type, + std::string& name, + void*& desc, + Elf_Word& descSize ) const + { + if ( index >= note_section->get_size() ) { + return false; + } + + const char* pData = + note_section->get_data() + note_start_positions[index]; + int align = sizeof( Elf_Word ); + + const endianess_convertor& convertor = elf_file.get_convertor(); + type = convertor( *(const Elf_Word*)( pData + 2 * align ) ); + Elf_Word namesz = convertor( *(const Elf_Word*)( pData ) ); + descSize = convertor( *(const Elf_Word*)( pData + sizeof( namesz ) ) ); + + Elf_Xword max_name_size = + note_section->get_size() - note_start_positions[index]; + if ( namesz < 1 || namesz > max_name_size || + (Elf_Xword)namesz + descSize > max_name_size ) { + return false; + } + name.assign( pData + 3 * align, namesz - 1 ); + if ( 0 == descSize ) { + desc = 0; + } + else { + desc = + const_cast( pData + 3 * align + + ( ( namesz + align - 1 ) / align ) * align ); + } + + return true; + } + + //------------------------------------------------------------------------------ + void add_note( Elf_Word type, + const std::string& name, + const void* desc, + Elf_Word descSize ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + int align = sizeof( Elf_Word ); + Elf_Word nameLen = (Elf_Word)name.size() + 1; + Elf_Word nameLenConv = convertor( nameLen ); + std::string buffer( reinterpret_cast( &nameLenConv ), align ); + Elf_Word descSizeConv = convertor( descSize ); + + buffer.append( reinterpret_cast( &descSizeConv ), align ); + type = convertor( type ); + buffer.append( reinterpret_cast( &type ), align ); + buffer.append( name ); + buffer.append( 1, '\x00' ); + const char pad[] = { '\0', '\0', '\0', '\0' }; + if ( nameLen % align != 0 ) { + buffer.append( pad, align - nameLen % align ); + } + if ( desc != 0 && descSize != 0 ) { + buffer.append( reinterpret_cast( desc ), descSize ); + if ( descSize % align != 0 ) { + buffer.append( pad, align - descSize % align ); + } + } + + note_start_positions.push_back( note_section->get_size() ); + note_section->append_data( buffer ); + } + + private: + //------------------------------------------------------------------------------ + void process_section() + { + const endianess_convertor& convertor = elf_file.get_convertor(); + const char* data = note_section->get_data(); + Elf_Xword size = note_section->get_size(); + Elf_Xword current = 0; + + note_start_positions.clear(); + + // Is it empty? + if ( 0 == data || 0 == size ) { + return; + } + + Elf_Word align = sizeof( Elf_Word ); + while ( current + (Elf_Xword)3 * align <= size ) { + note_start_positions.push_back( current ); + Elf_Word namesz = convertor( *(const Elf_Word*)( data + current ) ); + Elf_Word descsz = convertor( + *(const Elf_Word*)( data + current + sizeof( namesz ) ) ); + + current += (Elf_Xword)3 * sizeof( Elf_Word ) + + ( ( namesz + align - 1 ) / align ) * (Elf_Xword)align + + ( ( descsz + align - 1 ) / align ) * (Elf_Xword)align; + } + } + + //------------------------------------------------------------------------------ + private: + const elfio& elf_file; + S* note_section; + std::vector note_start_positions; +}; + +using note_section_accessor = note_section_accessor_template
; +using const_note_section_accessor = + note_section_accessor_template; + +} // namespace ELFIO + +#endif // ELFIO_NOTE_HPP + +/*** End of inlined file: elfio_note.hpp ***/ + + +/*** Start of inlined file: elfio_relocation.hpp ***/ +#ifndef ELFIO_RELOCATION_HPP +#define ELFIO_RELOCATION_HPP + +namespace ELFIO { + +template struct get_sym_and_type; +template <> struct get_sym_and_type +{ + static int get_r_sym( Elf_Xword info ) + { + return ELF32_R_SYM( (Elf_Word)info ); + } + static int get_r_type( Elf_Xword info ) + { + return ELF32_R_TYPE( (Elf_Word)info ); + } +}; +template <> struct get_sym_and_type +{ + static int get_r_sym( Elf_Xword info ) + { + return ELF32_R_SYM( (Elf_Word)info ); + } + static int get_r_type( Elf_Xword info ) + { + return ELF32_R_TYPE( (Elf_Word)info ); + } +}; +template <> struct get_sym_and_type +{ + static int get_r_sym( Elf_Xword info ) { return ELF64_R_SYM( info ); } + static int get_r_type( Elf_Xword info ) { return ELF64_R_TYPE( info ); } +}; +template <> struct get_sym_and_type +{ + static int get_r_sym( Elf_Xword info ) { return ELF64_R_SYM( info ); } + static int get_r_type( Elf_Xword info ) { return ELF64_R_TYPE( info ); } +}; + +//------------------------------------------------------------------------------ +template class relocation_section_accessor_template +{ + public: + //------------------------------------------------------------------------------ + relocation_section_accessor_template( const elfio& elf_file_, S* section_ ) + : elf_file( elf_file_ ), relocation_section( section_ ) + { + } + + //------------------------------------------------------------------------------ + Elf_Xword get_entries_num() const + { + Elf_Xword nRet = 0; + + if ( 0 != relocation_section->get_entry_size() ) { + nRet = relocation_section->get_size() / + relocation_section->get_entry_size(); + } + + return nRet; + } + + //------------------------------------------------------------------------------ + bool get_entry( Elf_Xword index, + Elf64_Addr& offset, + Elf_Word& symbol, + Elf_Word& type, + Elf_Sxword& addend ) const + { + if ( index >= get_entries_num() ) { // Is index valid + return false; + } + + if ( elf_file.get_class() == ELFCLASS32 ) { + if ( SHT_REL == relocation_section->get_type() ) { + generic_get_entry_rel( index, offset, symbol, type, + addend ); + } + else if ( SHT_RELA == relocation_section->get_type() ) { + generic_get_entry_rela( index, offset, symbol, type, + addend ); + } + } + else { + if ( SHT_REL == relocation_section->get_type() ) { + generic_get_entry_rel( index, offset, symbol, type, + addend ); + } + else if ( SHT_RELA == relocation_section->get_type() ) { + generic_get_entry_rela( index, offset, symbol, type, + addend ); + } + } + + return true; + } + + //------------------------------------------------------------------------------ + bool get_entry( Elf_Xword index, + Elf64_Addr& offset, + Elf64_Addr& symbolValue, + std::string& symbolName, + Elf_Word& type, + Elf_Sxword& addend, + Elf_Sxword& calcValue ) const + { + // Do regular job + Elf_Word symbol; + bool ret = get_entry( index, offset, symbol, type, addend ); + + // Find the symbol + Elf_Xword size; + unsigned char bind; + unsigned char symbolType; + Elf_Half section; + unsigned char other; + + symbol_section_accessor symbols( + elf_file, elf_file.sections[get_symbol_table_index()] ); + ret = ret && symbols.get_symbol( symbol, symbolName, symbolValue, size, + bind, symbolType, section, other ); + + if ( ret ) { // Was it successful? + switch ( type ) { + case R_386_NONE: // none + calcValue = 0; + break; + case R_386_32: // S + A + calcValue = symbolValue + addend; + break; + case R_386_PC32: // S + A - P + calcValue = symbolValue + addend - offset; + break; + case R_386_GOT32: // G + A - P + calcValue = 0; + break; + case R_386_PLT32: // L + A - P + calcValue = 0; + break; + case R_386_COPY: // none + calcValue = 0; + break; + case R_386_GLOB_DAT: // S + case R_386_JMP_SLOT: // S + calcValue = symbolValue; + break; + case R_386_RELATIVE: // B + A + calcValue = addend; + break; + case R_386_GOTOFF: // S + A - GOT + calcValue = 0; + break; + case R_386_GOTPC: // GOT + A - P + calcValue = 0; + break; + default: // Not recognized symbol! + calcValue = 0; + break; + } + } + + return ret; + } + + //------------------------------------------------------------------------------ + bool set_entry( Elf_Xword index, + Elf64_Addr offset, + Elf_Word symbol, + Elf_Word type, + Elf_Sxword addend ) + { + if ( index >= get_entries_num() ) { // Is index valid + return false; + } + + if ( elf_file.get_class() == ELFCLASS32 ) { + if ( SHT_REL == relocation_section->get_type() ) { + generic_set_entry_rel( index, offset, symbol, type, + addend ); + } + else if ( SHT_RELA == relocation_section->get_type() ) { + generic_set_entry_rela( index, offset, symbol, type, + addend ); + } + } + else { + if ( SHT_REL == relocation_section->get_type() ) { + generic_set_entry_rel( index, offset, symbol, type, + addend ); + } + else if ( SHT_RELA == relocation_section->get_type() ) { + generic_set_entry_rela( index, offset, symbol, type, + addend ); + } + } + + return true; + } + + //------------------------------------------------------------------------------ + void add_entry( Elf64_Addr offset, Elf_Xword info ) + { + if ( elf_file.get_class() == ELFCLASS32 ) { + generic_add_entry( offset, info ); + } + else { + generic_add_entry( offset, info ); + } + } + + //------------------------------------------------------------------------------ + void add_entry( Elf64_Addr offset, Elf_Word symbol, unsigned char type ) + { + Elf_Xword info; + if ( elf_file.get_class() == ELFCLASS32 ) { + info = ELF32_R_INFO( (Elf_Xword)symbol, type ); + } + else { + info = ELF64_R_INFO( (Elf_Xword)symbol, type ); + } + + add_entry( offset, info ); + } + + //------------------------------------------------------------------------------ + void add_entry( Elf64_Addr offset, Elf_Xword info, Elf_Sxword addend ) + { + if ( elf_file.get_class() == ELFCLASS32 ) { + generic_add_entry( offset, info, addend ); + } + else { + generic_add_entry( offset, info, addend ); + } + } + + //------------------------------------------------------------------------------ + void add_entry( Elf64_Addr offset, + Elf_Word symbol, + unsigned char type, + Elf_Sxword addend ) + { + Elf_Xword info; + if ( elf_file.get_class() == ELFCLASS32 ) { + info = ELF32_R_INFO( (Elf_Xword)symbol, type ); + } + else { + info = ELF64_R_INFO( (Elf_Xword)symbol, type ); + } + + add_entry( offset, info, addend ); + } + + //------------------------------------------------------------------------------ + void add_entry( string_section_accessor str_writer, + const char* str, + symbol_section_accessor sym_writer, + Elf64_Addr value, + Elf_Word size, + unsigned char sym_info, + unsigned char other, + Elf_Half shndx, + Elf64_Addr offset, + unsigned char type ) + { + Elf_Word str_index = str_writer.add_string( str ); + Elf_Word sym_index = sym_writer.add_symbol( str_index, value, size, + sym_info, other, shndx ); + add_entry( offset, sym_index, type ); + } + + //------------------------------------------------------------------------------ + void swap_symbols( Elf_Xword first, Elf_Xword second ) + { + Elf64_Addr offset; + Elf_Word symbol; + Elf_Word rtype; + Elf_Sxword addend; + for ( Elf_Word i = 0; i < get_entries_num(); i++ ) { + get_entry( i, offset, symbol, rtype, addend ); + if ( symbol == first ) { + set_entry( i, offset, (Elf_Word)second, rtype, addend ); + } + if ( symbol == second ) { + set_entry( i, offset, (Elf_Word)first, rtype, addend ); + } + } + } + + //------------------------------------------------------------------------------ + private: + //------------------------------------------------------------------------------ + Elf_Half get_symbol_table_index() const + { + return (Elf_Half)relocation_section->get_link(); + } + + //------------------------------------------------------------------------------ + template + void generic_get_entry_rel( Elf_Xword index, + Elf64_Addr& offset, + Elf_Word& symbol, + Elf_Word& type, + Elf_Sxword& addend ) const + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + const T* pEntry = reinterpret_cast( + relocation_section->get_data() + + index * relocation_section->get_entry_size() ); + offset = convertor( pEntry->r_offset ); + Elf_Xword tmp = convertor( pEntry->r_info ); + symbol = get_sym_and_type::get_r_sym( tmp ); + type = get_sym_and_type::get_r_type( tmp ); + addend = 0; + } + + //------------------------------------------------------------------------------ + template + void generic_get_entry_rela( Elf_Xword index, + Elf64_Addr& offset, + Elf_Word& symbol, + Elf_Word& type, + Elf_Sxword& addend ) const + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + const T* pEntry = reinterpret_cast( + relocation_section->get_data() + + index * relocation_section->get_entry_size() ); + offset = convertor( pEntry->r_offset ); + Elf_Xword tmp = convertor( pEntry->r_info ); + symbol = get_sym_and_type::get_r_sym( tmp ); + type = get_sym_and_type::get_r_type( tmp ); + addend = convertor( pEntry->r_addend ); + } + + //------------------------------------------------------------------------------ + template + void generic_set_entry_rel( Elf_Xword index, + Elf64_Addr offset, + Elf_Word symbol, + Elf_Word type, + Elf_Sxword ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + T* pEntry = const_cast( reinterpret_cast( + relocation_section->get_data() + + index * relocation_section->get_entry_size() ) ); + + if ( elf_file.get_class() == ELFCLASS32 ) { + pEntry->r_info = ELF32_R_INFO( (Elf_Xword)symbol, type ); + } + else { + pEntry->r_info = ELF64_R_INFO( (Elf_Xword)symbol, type ); + } + pEntry->r_offset = offset; + pEntry->r_offset = convertor( pEntry->r_offset ); + pEntry->r_info = convertor( pEntry->r_info ); + } + + //------------------------------------------------------------------------------ + template + void generic_set_entry_rela( Elf_Xword index, + Elf64_Addr offset, + Elf_Word symbol, + Elf_Word type, + Elf_Sxword addend ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + T* pEntry = const_cast( reinterpret_cast( + relocation_section->get_data() + + index * relocation_section->get_entry_size() ) ); + + if ( elf_file.get_class() == ELFCLASS32 ) { + pEntry->r_info = ELF32_R_INFO( (Elf_Xword)symbol, type ); + } + else { + pEntry->r_info = ELF64_R_INFO( (Elf_Xword)symbol, type ); + } + pEntry->r_offset = offset; + pEntry->r_addend = addend; + pEntry->r_offset = convertor( pEntry->r_offset ); + pEntry->r_info = convertor( pEntry->r_info ); + pEntry->r_addend = convertor( pEntry->r_addend ); + } + + //------------------------------------------------------------------------------ + template + void generic_add_entry( Elf64_Addr offset, Elf_Xword info ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + T entry; + entry.r_offset = offset; + entry.r_info = info; + entry.r_offset = convertor( entry.r_offset ); + entry.r_info = convertor( entry.r_info ); + + relocation_section->append_data( reinterpret_cast( &entry ), + sizeof( entry ) ); + } + + //------------------------------------------------------------------------------ + template + void + generic_add_entry( Elf64_Addr offset, Elf_Xword info, Elf_Sxword addend ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + T entry; + entry.r_offset = offset; + entry.r_info = info; + entry.r_addend = addend; + entry.r_offset = convertor( entry.r_offset ); + entry.r_info = convertor( entry.r_info ); + entry.r_addend = convertor( entry.r_addend ); + + relocation_section->append_data( reinterpret_cast( &entry ), + sizeof( entry ) ); + } + + //------------------------------------------------------------------------------ + private: + const elfio& elf_file; + S* relocation_section; +}; + +using relocation_section_accessor = + relocation_section_accessor_template
; +using const_relocation_section_accessor = + relocation_section_accessor_template; + +} // namespace ELFIO + +#endif // ELFIO_RELOCATION_HPP + +/*** End of inlined file: elfio_relocation.hpp ***/ + + +/*** Start of inlined file: elfio_dynamic.hpp ***/ +#ifndef ELFIO_DYNAMIC_HPP +#define ELFIO_DYNAMIC_HPP + +namespace ELFIO { + +//------------------------------------------------------------------------------ +template class dynamic_section_accessor_template +{ + public: + //------------------------------------------------------------------------------ + dynamic_section_accessor_template( const elfio& elf_file_, S* section_ ) + : elf_file( elf_file_ ), dynamic_section( section_ ) + { + } + + //------------------------------------------------------------------------------ + Elf_Xword get_entries_num() const + { + Elf_Xword nRet = 0; + + if ( 0 != dynamic_section->get_entry_size() ) { + nRet = + dynamic_section->get_size() / dynamic_section->get_entry_size(); + } + + return nRet; + } + + //------------------------------------------------------------------------------ + bool get_entry( Elf_Xword index, + Elf_Xword& tag, + Elf_Xword& value, + std::string& str ) const + { + if ( index >= get_entries_num() ) { // Is index valid + return false; + } + + if ( elf_file.get_class() == ELFCLASS32 ) { + generic_get_entry_dyn( index, tag, value ); + } + else { + generic_get_entry_dyn( index, tag, value ); + } + + // If the tag may have a string table reference, prepare the string + if ( tag == DT_NEEDED || tag == DT_SONAME || tag == DT_RPATH || + tag == DT_RUNPATH ) { + string_section_accessor strsec = + elf_file.sections[get_string_table_index()]; + const char* result = strsec.get_string( value ); + if ( 0 == result ) { + str.clear(); + return false; + } + str = result; + } + else { + str.clear(); + } + + return true; + } + + //------------------------------------------------------------------------------ + void add_entry( Elf_Xword tag, Elf_Xword value ) + { + if ( elf_file.get_class() == ELFCLASS32 ) { + generic_add_entry( tag, value ); + } + else { + generic_add_entry( tag, value ); + } + } + + //------------------------------------------------------------------------------ + void add_entry( Elf_Xword tag, const std::string& str ) + { + string_section_accessor strsec = + elf_file.sections[get_string_table_index()]; + Elf_Xword value = strsec.add_string( str ); + add_entry( tag, value ); + } + + //------------------------------------------------------------------------------ + private: + //------------------------------------------------------------------------------ + Elf_Half get_string_table_index() const + { + return (Elf_Half)dynamic_section->get_link(); + } + + //------------------------------------------------------------------------------ + template + void generic_get_entry_dyn( Elf_Xword index, + Elf_Xword& tag, + Elf_Xword& value ) const + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + // Check unusual case when dynamic section has no data + if ( dynamic_section->get_data() == 0 || + ( index + 1 ) * dynamic_section->get_entry_size() > + dynamic_section->get_size() ) { + tag = DT_NULL; + value = 0; + return; + } + + const T* pEntry = reinterpret_cast( + dynamic_section->get_data() + + index * dynamic_section->get_entry_size() ); + tag = convertor( pEntry->d_tag ); + switch ( tag ) { + case DT_NULL: + case DT_SYMBOLIC: + case DT_TEXTREL: + case DT_BIND_NOW: + value = 0; + break; + case DT_NEEDED: + case DT_PLTRELSZ: + case DT_RELASZ: + case DT_RELAENT: + case DT_STRSZ: + case DT_SYMENT: + case DT_SONAME: + case DT_RPATH: + case DT_RELSZ: + case DT_RELENT: + case DT_PLTREL: + case DT_INIT_ARRAYSZ: + case DT_FINI_ARRAYSZ: + case DT_RUNPATH: + case DT_FLAGS: + case DT_PREINIT_ARRAYSZ: + value = convertor( pEntry->d_un.d_val ); + break; + case DT_PLTGOT: + case DT_HASH: + case DT_STRTAB: + case DT_SYMTAB: + case DT_RELA: + case DT_INIT: + case DT_FINI: + case DT_REL: + case DT_DEBUG: + case DT_JMPREL: + case DT_INIT_ARRAY: + case DT_FINI_ARRAY: + case DT_PREINIT_ARRAY: + default: + value = convertor( pEntry->d_un.d_ptr ); + break; + } + } + + //------------------------------------------------------------------------------ + template void generic_add_entry( Elf_Xword tag, Elf_Xword value ) + { + const endianess_convertor& convertor = elf_file.get_convertor(); + + T entry; + + switch ( tag ) { + case DT_NULL: + case DT_SYMBOLIC: + case DT_TEXTREL: + case DT_BIND_NOW: + value = 0; + case DT_NEEDED: + case DT_PLTRELSZ: + case DT_RELASZ: + case DT_RELAENT: + case DT_STRSZ: + case DT_SYMENT: + case DT_SONAME: + case DT_RPATH: + case DT_RELSZ: + case DT_RELENT: + case DT_PLTREL: + case DT_INIT_ARRAYSZ: + case DT_FINI_ARRAYSZ: + case DT_RUNPATH: + case DT_FLAGS: + case DT_PREINIT_ARRAYSZ: + entry.d_un.d_val = convertor( value ); + break; + case DT_PLTGOT: + case DT_HASH: + case DT_STRTAB: + case DT_SYMTAB: + case DT_RELA: + case DT_INIT: + case DT_FINI: + case DT_REL: + case DT_DEBUG: + case DT_JMPREL: + case DT_INIT_ARRAY: + case DT_FINI_ARRAY: + case DT_PREINIT_ARRAY: + default: + entry.d_un.d_ptr = convertor( value ); + break; + } + + entry.d_tag = convertor( tag ); + + dynamic_section->append_data( reinterpret_cast( &entry ), + sizeof( entry ) ); + } + + //------------------------------------------------------------------------------ + private: + const elfio& elf_file; + S* dynamic_section; +}; + +using dynamic_section_accessor = dynamic_section_accessor_template
; +using const_dynamic_section_accessor = + dynamic_section_accessor_template; + +} // namespace ELFIO + +#endif // ELFIO_DYNAMIC_HPP + +/*** End of inlined file: elfio_dynamic.hpp ***/ + + +/*** Start of inlined file: elfio_modinfo.hpp ***/ +#ifndef ELFIO_MODINFO_HPP +#define ELFIO_MODINFO_HPP + +#include +#include + +namespace ELFIO { + +//------------------------------------------------------------------------------ +template class modinfo_section_accessor_template +{ + public: + //------------------------------------------------------------------------------ + modinfo_section_accessor_template( S* section_ ) + : modinfo_section( section_ ) + { + process_section(); + } + + //------------------------------------------------------------------------------ + Elf_Word get_attribute_num() const { return (Elf_Word)content.size(); } + + //------------------------------------------------------------------------------ + bool + get_attribute( Elf_Word no, std::string& field, std::string& value ) const + { + if ( no < content.size() ) { + field = content[no].first; + value = content[no].second; + return true; + } + + return false; + } + + //------------------------------------------------------------------------------ + bool get_attribute( std::string field_name, std::string& value ) const + { + for ( auto i = content.begin(); i != content.end(); i++ ) { + if ( field_name == i->first ) { + value = i->second; + return true; + } + } + + return false; + } + + //------------------------------------------------------------------------------ + Elf_Word add_attribute( std::string field, std::string value ) + { + Elf_Word current_position = 0; + + if ( modinfo_section ) { + // Strings are addeded to the end of the current section data + current_position = (Elf_Word)modinfo_section->get_size(); + + std::string attribute = field + "=" + value; + + modinfo_section->append_data( attribute + '\0' ); + content.push_back( + std::pair( field, value ) ); + } + + return current_position; + } + + //------------------------------------------------------------------------------ + private: + void process_section() + { + const char* pdata = modinfo_section->get_data(); + if ( pdata ) { + ELFIO::Elf_Xword i = 0; + while ( i < modinfo_section->get_size() ) { + while ( i < modinfo_section->get_size() && !pdata[i] ) + i++; + if ( i < modinfo_section->get_size() ) { + std::string info = pdata + i; + size_t loc = info.find( '=' ); + std::pair attribute( + info.substr( 0, loc ), info.substr( loc + 1 ) ); + + content.push_back( attribute ); + + i += info.length(); + } + } + } + } + + //------------------------------------------------------------------------------ + private: + S* modinfo_section; + std::vector> content; +}; + +using modinfo_section_accessor = modinfo_section_accessor_template
; +using const_modinfo_section_accessor = + modinfo_section_accessor_template; + +} // namespace ELFIO + +#endif // ELFIO_MODINFO_HPP + +/*** End of inlined file: elfio_modinfo.hpp ***/ + +#ifdef _MSC_VER +#pragma warning( pop ) +#endif + +#endif // ELFIO_HPP + +/*** End of inlined file: elfio.hpp ***/ + + +namespace ELFIO { + +static struct class_table_t +{ + const char key; + const char* str; +} class_table[] = { + { ELFCLASS32, "ELF32" }, + { ELFCLASS64, "ELF64" }, +}; + +static struct endian_table_t +{ + const char key; + const char* str; +} endian_table[] = { + { ELFDATANONE, "None" }, + { ELFDATA2LSB, "Little endian" }, + { ELFDATA2MSB, "Big endian" }, +}; + +static struct version_table_t +{ + const Elf64_Word key; + const char* str; +} version_table[] = { + { EV_NONE, "None" }, + { EV_CURRENT, "Current" }, +}; + +static struct type_table_t +{ + const Elf32_Half key; + const char* str; +} type_table[] = { + { ET_NONE, "No file type" }, { ET_REL, "Relocatable file" }, + { ET_EXEC, "Executable file" }, { ET_DYN, "Shared object file" }, + { ET_CORE, "Core file" }, +}; + +static struct machine_table_t +{ + const Elf64_Half key; + const char* str; +} machine_table[] = { + { EM_NONE, "No machine" }, + { EM_M32, "AT&T WE 32100" }, + { EM_SPARC, "SUN SPARC" }, + { EM_386, "Intel 80386" }, + { EM_68K, "Motorola m68k family" }, + { EM_88K, "Motorola m88k family" }, + { EM_486, "Intel 80486// Reserved for future use" }, + { EM_860, "Intel 80860" }, + { EM_MIPS, "MIPS R3000 (officially, big-endian only)" }, + { EM_S370, "IBM System/370" }, + { EM_MIPS_RS3_LE, + "MIPS R3000 little-endian (Oct 4 1999 Draft) Deprecated" }, + { EM_res011, "Reserved" }, + { EM_res012, "Reserved" }, + { EM_res013, "Reserved" }, + { EM_res014, "Reserved" }, + { EM_PARISC, "HPPA" }, + { EM_res016, "Reserved" }, + { EM_VPP550, "Fujitsu VPP500" }, + { EM_SPARC32PLUS, "Sun's v8plus" }, + { EM_960, "Intel 80960" }, + { EM_PPC, "PowerPC" }, + { EM_PPC64, "64-bit PowerPC" }, + { EM_S390, "IBM S/390" }, + { EM_SPU, "Sony/Toshiba/IBM SPU" }, + { EM_res024, "Reserved" }, + { EM_res025, "Reserved" }, + { EM_res026, "Reserved" }, + { EM_res027, "Reserved" }, + { EM_res028, "Reserved" }, + { EM_res029, "Reserved" }, + { EM_res030, "Reserved" }, + { EM_res031, "Reserved" }, + { EM_res032, "Reserved" }, + { EM_res033, "Reserved" }, + { EM_res034, "Reserved" }, + { EM_res035, "Reserved" }, + { EM_V800, "NEC V800 series" }, + { EM_FR20, "Fujitsu FR20" }, + { EM_RH32, "TRW RH32" }, + { EM_MCORE, "Motorola M*Core // May also be taken by Fujitsu MMA" }, + { EM_RCE, "Old name for MCore" }, + { EM_ARM, "ARM" }, + { EM_OLD_ALPHA, "Digital Alpha" }, + { EM_SH, "Renesas (formerly Hitachi) / SuperH SH" }, + { EM_SPARCV9, "SPARC v9 64-bit" }, + { EM_TRICORE, "Siemens Tricore embedded processor" }, + { EM_ARC, "ARC Cores" }, + { EM_H8_300, "Renesas (formerly Hitachi) H8/300" }, + { EM_H8_300H, "Renesas (formerly Hitachi) H8/300H" }, + { EM_H8S, "Renesas (formerly Hitachi) H8S" }, + { EM_H8_500, "Renesas (formerly Hitachi) H8/500" }, + { EM_IA_64, "Intel IA-64 Processor" }, + { EM_MIPS_X, "Stanford MIPS-X" }, + { EM_COLDFIRE, "Motorola Coldfire" }, + { EM_68HC12, "Motorola M68HC12" }, + { EM_MMA, "Fujitsu Multimedia Accelerator" }, + { EM_PCP, "Siemens PCP" }, + { EM_NCPU, "Sony nCPU embedded RISC processor" }, + { EM_NDR1, "Denso NDR1 microprocesspr" }, + { EM_STARCORE, "Motorola Star*Core processor" }, + { EM_ME16, "Toyota ME16 processor" }, + { EM_ST100, "STMicroelectronics ST100 processor" }, + { EM_TINYJ, "Advanced Logic Corp. TinyJ embedded processor" }, + { EM_X86_64, "Advanced Micro Devices X86-64 processor" }, + { EM_PDSP, "Sony DSP Processor" }, + { EM_PDP10, "Digital Equipment Corp. PDP-10" }, + { EM_PDP11, "Digital Equipment Corp. PDP-11" }, + { EM_FX66, "Siemens FX66 microcontroller" }, + { EM_ST9PLUS, "STMicroelectronics ST9+ 8/16 bit microcontroller" }, + { EM_ST7, "STMicroelectronics ST7 8-bit microcontroller" }, + { EM_68HC16, "Motorola MC68HC16 Microcontroller" }, + { EM_68HC11, "Motorola MC68HC11 Microcontroller" }, + { EM_68HC08, "Motorola MC68HC08 Microcontroller" }, + { EM_68HC05, "Motorola MC68HC05 Microcontroller" }, + { EM_SVX, "Silicon Graphics SVx" }, + { EM_ST19, "STMicroelectronics ST19 8-bit cpu" }, + { EM_VAX, "Digital VAX" }, + { EM_CRIS, "Axis Communications 32-bit embedded processor" }, + { EM_JAVELIN, "Infineon Technologies 32-bit embedded cpu" }, + { EM_FIREPATH, "Element 14 64-bit DSP processor" }, + { EM_ZSP, "LSI Logic's 16-bit DSP processor" }, + { EM_MMIX, "Donald Knuth's educational 64-bit processor" }, + { EM_HUANY, "Harvard's machine-independent format" }, + { EM_PRISM, "SiTera Prism" }, + { EM_AVR, "Atmel AVR 8-bit microcontroller" }, + { EM_FR30, "Fujitsu FR30" }, + { EM_D10V, "Mitsubishi D10V" }, + { EM_D30V, "Mitsubishi D30V" }, + { EM_V850, "NEC v850" }, + { EM_M32R, "Renesas M32R (formerly Mitsubishi M32R)" }, + { EM_MN10300, "Matsushita MN10300" }, + { EM_MN10200, "Matsushita MN10200" }, + { EM_PJ, "picoJava" }, + { EM_OPENRISC, "OpenRISC 32-bit embedded processor" }, + { EM_ARC_A5, "ARC Cores Tangent-A5" }, + { EM_XTENSA, "Tensilica Xtensa Architecture" }, + { EM_VIDEOCORE, "Alphamosaic VideoCore processor" }, + { EM_TMM_GPP, "Thompson Multimedia General Purpose Processor" }, + { EM_NS32K, "National Semiconductor 32000 series" }, + { EM_TPC, "Tenor Network TPC processor" }, + { EM_SNP1K, "Trebia SNP 1000 processor" }, + { EM_ST200, "STMicroelectronics ST200 microcontroller" }, + { EM_IP2K, "Ubicom IP2022 micro controller" }, + { EM_MAX, "MAX Processor" }, + { EM_CR, "National Semiconductor CompactRISC" }, + { EM_F2MC16, "Fujitsu F2MC16" }, + { EM_MSP430, "TI msp430 micro controller" }, + { EM_BLACKFIN, "ADI Blackfin" }, + { EM_SE_C33, "S1C33 Family of Seiko Epson processors" }, + { EM_SEP, "Sharp embedded microprocessor" }, + { EM_ARCA, "Arca RISC Microprocessor" }, + { EM_UNICORE, "Microprocessor series from PKU-Unity Ltd. and MPRC of " + "Peking University" }, + { EM_EXCESS, "eXcess: 16/32/64-bit configurable embedded CPU" }, + { EM_DXP, "Icera Semiconductor Inc. Deep Execution Processor" }, + { EM_ALTERA_NIOS2, "Altera Nios II soft-core processor" }, + { EM_CRX, "National Semiconductor CRX" }, + { EM_XGATE, "Motorola XGATE embedded processor" }, + { EM_C166, "Infineon C16x/XC16x processor" }, + { EM_M16C, "Renesas M16C series microprocessors" }, + { EM_DSPIC30F, "Microchip Technology dsPIC30F Digital Signal Controller" }, + { EM_CE, "Freescale Communication Engine RISC core" }, + { EM_M32C, "Renesas M32C series microprocessors" }, + { EM_res121, "Reserved" }, + { EM_res122, "Reserved" }, + { EM_res123, "Reserved" }, + { EM_res124, "Reserved" }, + { EM_res125, "Reserved" }, + { EM_res126, "Reserved" }, + { EM_res127, "Reserved" }, + { EM_res128, "Reserved" }, + { EM_res129, "Reserved" }, + { EM_res130, "Reserved" }, + { EM_TSK3000, "Altium TSK3000 core" }, + { EM_RS08, "Freescale RS08 embedded processor" }, + { EM_res133, "Reserved" }, + { EM_ECOG2, "Cyan Technology eCOG2 microprocessor" }, + { EM_SCORE, "Sunplus Score" }, + { EM_SCORE7, "Sunplus S+core7 RISC processor" }, + { EM_DSP24, "New Japan Radio (NJR) 24-bit DSP Processor" }, + { EM_VIDEOCORE3, "Broadcom VideoCore III processor" }, + { EM_LATTICEMICO32, "RISC processor for Lattice FPGA architecture" }, + { EM_SE_C17, "Seiko Epson C17 family" }, + { EM_TI_C6000, "Texas Instruments TMS320C6000 DSP family" }, + { EM_TI_C2000, "Texas Instruments TMS320C2000 DSP family" }, + { EM_TI_C5500, "Texas Instruments TMS320C55x DSP family" }, + { EM_res143, "Reserved" }, + { EM_res144, "Reserved" }, + { EM_res145, "Reserved" }, + { EM_res146, "Reserved" }, + { EM_res147, "Reserved" }, + { EM_res148, "Reserved" }, + { EM_res149, "Reserved" }, + { EM_res150, "Reserved" }, + { EM_res151, "Reserved" }, + { EM_res152, "Reserved" }, + { EM_res153, "Reserved" }, + { EM_res154, "Reserved" }, + { EM_res155, "Reserved" }, + { EM_res156, "Reserved" }, + { EM_res157, "Reserved" }, + { EM_res158, "Reserved" }, + { EM_res159, "Reserved" }, + { EM_MMDSP_PLUS, "STMicroelectronics 64bit VLIW Data Signal Processor" }, + { EM_CYPRESS_M8C, "Cypress M8C microprocessor" }, + { EM_R32C, "Renesas R32C series microprocessors" }, + { EM_TRIMEDIA, "NXP Semiconductors TriMedia architecture family" }, + { EM_QDSP6, "QUALCOMM DSP6 Processor" }, + { EM_8051, "Intel 8051 and variants" }, + { EM_STXP7X, "STMicroelectronics STxP7x family" }, + { EM_NDS32, + "Andes Technology compact code size embedded RISC processor family" }, + { EM_ECOG1, "Cyan Technology eCOG1X family" }, + { EM_ECOG1X, "Cyan Technology eCOG1X family" }, + { EM_MAXQ30, "Dallas Semiconductor MAXQ30 Core Micro-controllers" }, + { EM_XIMO16, "New Japan Radio (NJR) 16-bit DSP Processor" }, + { EM_MANIK, "M2000 Reconfigurable RISC Microprocessor" }, + { EM_CRAYNV2, "Cray Inc. NV2 vector architecture" }, + { EM_RX, "Renesas RX family" }, + { EM_METAG, "Imagination Technologies META processor architecture" }, + { EM_MCST_ELBRUS, "MCST Elbrus general purpose hardware architecture" }, + { EM_ECOG16, "Cyan Technology eCOG16 family" }, + { EM_CR16, "National Semiconductor CompactRISC 16-bit processor" }, + { EM_ETPU, "Freescale Extended Time Processing Unit" }, + { EM_SLE9X, "Infineon Technologies SLE9X core" }, + { EM_L1OM, "Intel L1OM" }, + { EM_INTEL181, "Reserved by Intel" }, + { EM_INTEL182, "Reserved by Intel" }, + { EM_res183, "Reserved by ARM" }, + { EM_res184, "Reserved by ARM" }, + { EM_AVR32, "Atmel Corporation 32-bit microprocessor family" }, + { EM_STM8, "STMicroeletronics STM8 8-bit microcontroller" }, + { EM_TILE64, "Tilera TILE64 multicore architecture family" }, + { EM_TILEPRO, "Tilera TILEPro multicore architecture family" }, + { EM_MICROBLAZE, "Xilinx MicroBlaze 32-bit RISC soft processor core" }, + { EM_CUDA, "NVIDIA CUDA architecture " }, +}; + +static struct section_type_table_t +{ + const Elf64_Half key; + const char* str; +} section_type_table[] = { + { SHT_NULL, "NULL" }, + { SHT_PROGBITS, "PROGBITS" }, + { SHT_SYMTAB, "SYMTAB" }, + { SHT_STRTAB, "STRTAB" }, + { SHT_RELA, "RELA" }, + { SHT_HASH, "HASH" }, + { SHT_DYNAMIC, "DYNAMIC" }, + { SHT_NOTE, "NOTE" }, + { SHT_NOBITS, "NOBITS" }, + { SHT_REL, "REL" }, + { SHT_SHLIB, "SHLIB" }, + { SHT_DYNSYM, "DYNSYM" }, + { SHT_INIT_ARRAY, "INIT_ARRAY" }, + { SHT_FINI_ARRAY, "FINI_ARRAY" }, + { SHT_PREINIT_ARRAY, "PREINIT_ARRAY" }, + { SHT_GROUP, "GROUP" }, + { SHT_SYMTAB_SHNDX, "SYMTAB_SHNDX " }, +}; + +static struct segment_type_table_t +{ + const Elf_Word key; + const char* str; +} segment_type_table[] = { + { PT_NULL, "NULL" }, { PT_LOAD, "LOAD" }, { PT_DYNAMIC, "DYNAMIC" }, + { PT_INTERP, "INTERP" }, { PT_NOTE, "NOTE" }, { PT_SHLIB, "SHLIB" }, + { PT_PHDR, "PHDR" }, { PT_TLS, "TLS" }, +}; + +static struct segment_flag_table_t +{ + const Elf_Word key; + const char* str; +} segment_flag_table[] = { + { 0, "" }, { 1, "X" }, { 2, "W" }, { 3, "WX" }, + { 4, "R" }, { 5, "RX" }, { 6, "RW" }, { 7, "RWX" }, +}; + +static struct symbol_bind_t +{ + const Elf_Word key; + const char* str; +} symbol_bind_table[] = { + { STB_LOCAL, "LOCAL" }, { STB_GLOBAL, "GLOBAL" }, + { STB_WEAK, "WEAK" }, { STB_LOOS, "LOOS" }, + { STB_HIOS, "HIOS" }, { STB_MULTIDEF, "MULTIDEF" }, + { STB_LOPROC, "LOPROC" }, { STB_HIPROC, "HIPROC" }, +}; + +static struct symbol_type_t +{ + const Elf_Word key; + const char* str; +} symbol_type_table[] = { + { STT_NOTYPE, "NOTYPE" }, { STT_OBJECT, "OBJECT" }, + { STT_FUNC, "FUNC" }, { STT_SECTION, "SECTION" }, + { STT_FILE, "FILE" }, { STT_COMMON, "COMMON" }, + { STT_TLS, "TLS" }, { STT_LOOS, "LOOS" }, + { STT_HIOS, "HIOS" }, { STT_LOPROC, "LOPROC" }, + { STT_HIPROC, "HIPROC" }, +}; + +static struct dynamic_tag_t +{ + const Elf_Word key; + const char* str; +} dynamic_tag_table[] = { + { DT_NULL, "NULL" }, + { DT_NEEDED, "NEEDED" }, + { DT_PLTRELSZ, "PLTRELSZ" }, + { DT_PLTGOT, "PLTGOT" }, + { DT_HASH, "HASH" }, + { DT_STRTAB, "STRTAB" }, + { DT_SYMTAB, "SYMTAB" }, + { DT_RELA, "RELA" }, + { DT_RELASZ, "RELASZ" }, + { DT_RELAENT, "RELAENT" }, + { DT_STRSZ, "STRSZ" }, + { DT_SYMENT, "SYMENT" }, + { DT_INIT, "INIT" }, + { DT_FINI, "FINI" }, + { DT_SONAME, "SONAME" }, + { DT_RPATH, "RPATH" }, + { DT_SYMBOLIC, "SYMBOLIC" }, + { DT_REL, "REL" }, + { DT_RELSZ, "RELSZ" }, + { DT_RELENT, "RELENT" }, + { DT_PLTREL, "PLTREL" }, + { DT_DEBUG, "DEBUG" }, + { DT_TEXTREL, "TEXTREL" }, + { DT_JMPREL, "JMPREL" }, + { DT_BIND_NOW, "BIND_NOW" }, + { DT_INIT_ARRAY, "INIT_ARRAY" }, + { DT_FINI_ARRAY, "FINI_ARRAY" }, + { DT_INIT_ARRAYSZ, "INIT_ARRAYSZ" }, + { DT_FINI_ARRAYSZ, "FINI_ARRAYSZ" }, + { DT_RUNPATH, "RUNPATH" }, + { DT_FLAGS, "FLAGS" }, + { DT_ENCODING, "ENCODING" }, + { DT_PREINIT_ARRAY, "PREINIT_ARRAY" }, + { DT_PREINIT_ARRAYSZ, "PREINIT_ARRAYSZ" }, + { DT_MAXPOSTAGS, "MAXPOSTAGS" }, +}; + +static const ELFIO::Elf_Xword MAX_DATA_ENTRIES = 64; + +//------------------------------------------------------------------------------ +class dump +{ +#define DUMP_DEC_FORMAT( width ) \ + std::setw( width ) << std::setfill( ' ' ) << std::dec << std::right +#define DUMP_HEX_FORMAT( width ) \ + std::setw( width ) << std::setfill( '0' ) << std::hex << std::right +#define DUMP_STR_FORMAT( width ) \ + std::setw( width ) << std::setfill( ' ' ) << std::hex << std::left + + public: + //------------------------------------------------------------------------------ + static void header( std::ostream& out, const elfio& reader ) + { + if ( !reader.get_header_size() ) { + return; + } + out << "ELF Header" << std::endl + << std::endl + << " Class: " << str_class( reader.get_class() ) << std::endl + << " Encoding: " << str_endian( reader.get_encoding() ) + << std::endl + << " ELFVersion: " << str_version( reader.get_elf_version() ) + << std::endl + << " Type: " << str_type( reader.get_type() ) << std::endl + << " Machine: " << str_machine( reader.get_machine() ) + << std::endl + << " Version: " << str_version( reader.get_version() ) + << std::endl + << " Entry: " + << "0x" << std::hex << reader.get_entry() << std::endl + << " Flags: " + << "0x" << std::hex << reader.get_flags() << std::endl + << std::endl; + } + + //------------------------------------------------------------------------------ + static void section_headers( std::ostream& out, const elfio& reader ) + { + Elf_Half n = reader.sections.size(); + + if ( n == 0 ) { + return; + } + + out << "Section Headers:" << std::endl; + if ( reader.get_class() == ELFCLASS32 ) { // Output for 32-bit + out << "[ Nr ] Type Addr Size ES Flg Lk Inf " + "Al Name" + << std::endl; + } + else { // Output for 64-bit + out << "[ Nr ] Type Addr Size " + " ES Flg" + << std::endl + << " Lk Inf Al Name" << std::endl; + } + + for ( Elf_Half i = 0; i < n; ++i ) { // For all sections + section* sec = reader.sections[i]; + section_header( out, i, sec, reader.get_class() ); + } + + out << "Key to Flags: W (write), A (alloc), X (execute)\n\n" + << std::endl; + } + + //------------------------------------------------------------------------------ + static void section_header( std::ostream& out, + Elf_Half no, + const section* sec, + unsigned char elf_class ) + { + std::ios_base::fmtflags original_flags = out.flags(); + + if ( elf_class == ELFCLASS32 ) { // Output for 32-bit + out << "[" << DUMP_DEC_FORMAT( 5 ) << no << "] " + << DUMP_STR_FORMAT( 17 ) << str_section_type( sec->get_type() ) + << " " << DUMP_HEX_FORMAT( 8 ) << sec->get_address() << " " + << DUMP_HEX_FORMAT( 8 ) << sec->get_size() << " " + << DUMP_HEX_FORMAT( 2 ) << sec->get_entry_size() << " " + << DUMP_STR_FORMAT( 3 ) << section_flags( sec->get_flags() ) + << " " << DUMP_HEX_FORMAT( 2 ) << sec->get_link() << " " + << DUMP_HEX_FORMAT( 3 ) << sec->get_info() << " " + << DUMP_HEX_FORMAT( 2 ) << sec->get_addr_align() << " " + << DUMP_STR_FORMAT( 17 ) << sec->get_name() << " " << std::endl; + } + else { // Output for 64-bit + out << "[" << DUMP_DEC_FORMAT( 5 ) << no << "] " + << DUMP_STR_FORMAT( 17 ) << str_section_type( sec->get_type() ) + << " " << DUMP_HEX_FORMAT( 16 ) << sec->get_address() << " " + << DUMP_HEX_FORMAT( 16 ) << sec->get_size() << " " + << DUMP_HEX_FORMAT( 4 ) << sec->get_entry_size() << " " + << DUMP_STR_FORMAT( 3 ) << section_flags( sec->get_flags() ) + << " " << std::endl + << " " << DUMP_HEX_FORMAT( 4 ) << sec->get_link() << " " + << DUMP_HEX_FORMAT( 4 ) << sec->get_info() << " " + << DUMP_HEX_FORMAT( 4 ) << sec->get_addr_align() << " " + << DUMP_STR_FORMAT( 17 ) << sec->get_name() << " " << std::endl; + } + + out.flags( original_flags ); + + return; + } + + //------------------------------------------------------------------------------ + static void segment_headers( std::ostream& out, const elfio& reader ) + { + Elf_Half n = reader.segments.size(); + if ( n == 0 ) { + return; + } + + out << "Segment headers:" << std::endl; + if ( reader.get_class() == ELFCLASS32 ) { // Output for 32-bit + out << "[ Nr ] Type VirtAddr PhysAddr FileSize Mem.Size " + "Flags Align" + << std::endl; + } + else { // Output for 64-bit + out << "[ Nr ] Type VirtAddr PhysAddr " + "Flags" + << std::endl + << " FileSize Mem.Size " + "Align" + << std::endl; + } + + for ( Elf_Half i = 0; i < n; ++i ) { + segment* seg = reader.segments[i]; + segment_header( out, i, seg, reader.get_class() ); + } + + out << std::endl; + } + + //------------------------------------------------------------------------------ + static void segment_header( std::ostream& out, + Elf_Half no, + const segment* seg, + unsigned int elf_class ) + { + std::ios_base::fmtflags original_flags = out.flags(); + + if ( elf_class == ELFCLASS32 ) { // Output for 32-bit + out << "[" << DUMP_DEC_FORMAT( 5 ) << no << "] " + << DUMP_STR_FORMAT( 14 ) << str_segment_type( seg->get_type() ) + << " " << DUMP_HEX_FORMAT( 8 ) << seg->get_virtual_address() + << " " << DUMP_HEX_FORMAT( 8 ) << seg->get_physical_address() + << " " << DUMP_HEX_FORMAT( 8 ) << seg->get_file_size() << " " + << DUMP_HEX_FORMAT( 8 ) << seg->get_memory_size() << " " + << DUMP_STR_FORMAT( 8 ) << str_segment_flag( seg->get_flags() ) + << " " << DUMP_HEX_FORMAT( 8 ) << seg->get_align() << " " + << std::endl; + } + else { // Output for 64-bit + out << "[" << DUMP_DEC_FORMAT( 5 ) << no << "] " + << DUMP_STR_FORMAT( 14 ) << str_segment_type( seg->get_type() ) + << " " << DUMP_HEX_FORMAT( 16 ) << seg->get_virtual_address() + << " " << DUMP_HEX_FORMAT( 16 ) << seg->get_physical_address() + << " " << DUMP_STR_FORMAT( 16 ) + << str_segment_flag( seg->get_flags() ) << " " << std::endl + << " " << DUMP_HEX_FORMAT( 16 ) + << seg->get_file_size() << " " << DUMP_HEX_FORMAT( 16 ) + << seg->get_memory_size() << " " << DUMP_HEX_FORMAT( 16 ) + << seg->get_align() << " " << std::endl; + } + + out.flags( original_flags ); + } + + //------------------------------------------------------------------------------ + static void symbol_tables( std::ostream& out, const elfio& reader ) + { + Elf_Half n = reader.sections.size(); + for ( Elf_Half i = 0; i < n; ++i ) { // For all sections + section* sec = reader.sections[i]; + if ( SHT_SYMTAB == sec->get_type() || + SHT_DYNSYM == sec->get_type() ) { + symbol_section_accessor symbols( reader, sec ); + + Elf_Xword sym_no = symbols.get_symbols_num(); + if ( sym_no > 0 ) { + out << "Symbol table (" << sec->get_name() << ")" + << std::endl; + if ( reader.get_class() == + ELFCLASS32 ) { // Output for 32-bit + out << "[ Nr ] Value Size Type Bind " + "Sect Name" + << std::endl; + } + else { // Output for 64-bit + out << "[ Nr ] Value Size Type " + " Bind Sect" + << std::endl + << " Name" << std::endl; + } + for ( Elf_Xword i = 0; i < sym_no; ++i ) { + std::string name; + Elf64_Addr value = 0; + Elf_Xword size = 0; + unsigned char bind = 0; + unsigned char type = 0; + Elf_Half section = 0; + unsigned char other = 0; + symbols.get_symbol( i, name, value, size, bind, type, + section, other ); + symbol_table( out, i, name, value, size, bind, type, + section, reader.get_class() ); + } + + out << std::endl; + } + } + } + } + + //------------------------------------------------------------------------------ + static void symbol_table( std::ostream& out, + Elf_Xword no, + std::string& name, + Elf64_Addr value, + Elf_Xword size, + unsigned char bind, + unsigned char type, + Elf_Half section, + unsigned int elf_class ) + { + std::ios_base::fmtflags original_flags = out.flags(); + + if ( elf_class == ELFCLASS32 ) { // Output for 32-bit + out << "[" << DUMP_DEC_FORMAT( 5 ) << no << "] " + << DUMP_HEX_FORMAT( 8 ) << value << " " << DUMP_HEX_FORMAT( 8 ) + << size << " " << DUMP_STR_FORMAT( 7 ) + << str_symbol_type( type ) << " " << DUMP_STR_FORMAT( 8 ) + << str_symbol_bind( bind ) << " " << DUMP_DEC_FORMAT( 5 ) + << section << " " << DUMP_STR_FORMAT( 1 ) << name << " " + << std::endl; + } + else { // Output for 64-bit + out << "[" << DUMP_DEC_FORMAT( 5 ) << no << "] " + << DUMP_HEX_FORMAT( 16 ) << value << " " + << DUMP_HEX_FORMAT( 16 ) << size << " " << DUMP_STR_FORMAT( 7 ) + << str_symbol_type( type ) << " " << DUMP_STR_FORMAT( 8 ) + << str_symbol_bind( bind ) << " " << DUMP_DEC_FORMAT( 5 ) + << section << " " << std::endl + << " " << DUMP_STR_FORMAT( 1 ) << name << " " + << std::endl; + } + + out.flags( original_flags ); + } + + //------------------------------------------------------------------------------ + static void notes( std::ostream& out, const elfio& reader ) + { + Elf_Half no = reader.sections.size(); + for ( Elf_Half i = 0; i < no; ++i ) { // For all sections + section* sec = reader.sections[i]; + if ( SHT_NOTE == sec->get_type() ) { // Look at notes + note_section_accessor notes( reader, sec ); + Elf_Word no_notes = notes.get_notes_num(); + if ( no > 0 ) { + out << "Note section (" << sec->get_name() << ")" + << std::endl + << " No Type Name" << std::endl; + for ( Elf_Word j = 0; j < no_notes; ++j ) { // For all notes + Elf_Word type; + std::string name; + void* desc; + Elf_Word descsz; + + if ( notes.get_note( j, type, name, desc, descsz ) ) { + // 'name' usually contains \0 at the end. Try to fix it + name = name.c_str(); + note( out, j, type, name ); + } + } + + out << std::endl; + } + } + } + } + + //------------------------------------------------------------------------------ + static void modinfo( std::ostream& out, const elfio& reader ) + { + Elf_Half no = reader.sections.size(); + for ( Elf_Half i = 0; i < no; ++i ) { // For all sections + section* sec = reader.sections[i]; + if ( ".modinfo" == sec->get_name() ) { // Look for the section + out << "Section .modinfo" << std::endl; + + const_modinfo_section_accessor modinfo( sec ); + for ( Elf_Word i = 0; i < modinfo.get_attribute_num(); i++ ) { + std::string field; + std::string value; + if ( modinfo.get_attribute( i, field, value ) ) { + out << " " << std::setw( 20 ) << field + << std::setw( 0 ) << " = " << value << std::endl; + } + } + + out << std::endl; + break; + } + } + } + + //------------------------------------------------------------------------------ + static void + note( std::ostream& out, int no, Elf_Word type, const std::string& name ) + { + out << " [" << DUMP_DEC_FORMAT( 2 ) << no << "] " + << DUMP_HEX_FORMAT( 8 ) << type << " " << DUMP_STR_FORMAT( 1 ) + << name << std::endl; + } + + //------------------------------------------------------------------------------ + static void dynamic_tags( std::ostream& out, const elfio& reader ) + { + Elf_Half n = reader.sections.size(); + for ( Elf_Half i = 0; i < n; ++i ) { // For all sections + section* sec = reader.sections[i]; + if ( SHT_DYNAMIC == sec->get_type() ) { + dynamic_section_accessor dynamic( reader, sec ); + + Elf_Xword dyn_no = dynamic.get_entries_num(); + if ( dyn_no > 0 ) { + out << "Dynamic section (" << sec->get_name() << ")" + << std::endl; + out << "[ Nr ] Tag Name/Value" << std::endl; + for ( Elf_Xword i = 0; i < dyn_no; ++i ) { + Elf_Xword tag = 0; + Elf_Xword value = 0; + std::string str; + dynamic.get_entry( i, tag, value, str ); + dynamic_tag( out, i, tag, value, str, + reader.get_class() ); + if ( DT_NULL == tag ) { + break; + } + } + + out << std::endl; + } + } + } + } + + //------------------------------------------------------------------------------ + static void dynamic_tag( std::ostream& out, + Elf_Xword no, + Elf_Xword tag, + Elf_Xword value, + std::string str, + unsigned int /*elf_class*/ ) + { + out << "[" << DUMP_DEC_FORMAT( 5 ) << no << "] " + << DUMP_STR_FORMAT( 16 ) << str_dynamic_tag( tag ) << " "; + if ( str.empty() ) { + out << DUMP_HEX_FORMAT( 16 ) << value << " "; + } + else { + out << DUMP_STR_FORMAT( 32 ) << str << " "; + } + out << std::endl; + } + + //------------------------------------------------------------------------------ + static void section_data( std::ostream& out, const section* sec ) + { + std::ios_base::fmtflags original_flags = out.flags(); + + out << sec->get_name() << std::endl; + const char* pdata = sec->get_data(); + if ( pdata ) { + ELFIO::Elf_Xword i; + for ( i = 0; i < std::min( sec->get_size(), MAX_DATA_ENTRIES ); + ++i ) { + if ( i % 16 == 0 ) { + out << "[" << DUMP_HEX_FORMAT( 8 ) << i << "]"; + } + + out << " " << DUMP_HEX_FORMAT( 2 ) << ( pdata[i] & 0x000000FF ); + + if ( i % 16 == 15 ) { + out << std::endl; + } + } + if ( i % 16 != 0 ) { + out << std::endl; + } + + out.flags( original_flags ); + } + + return; + } + + //------------------------------------------------------------------------------ + static void section_datas( std::ostream& out, const elfio& reader ) + { + Elf_Half n = reader.sections.size(); + + if ( n == 0 ) { + return; + } + + out << "Section Data:" << std::endl; + + for ( Elf_Half i = 1; i < n; ++i ) { // For all sections + section* sec = reader.sections[i]; + if ( sec->get_type() == SHT_NOBITS ) { + continue; + } + section_data( out, sec ); + } + + out << std::endl; + } + + //------------------------------------------------------------------------------ + static void + segment_data( std::ostream& out, Elf_Half no, const segment* seg ) + { + std::ios_base::fmtflags original_flags = out.flags(); + + out << "Segment # " << no << std::endl; + const char* pdata = seg->get_data(); + if ( pdata ) { + ELFIO::Elf_Xword i; + for ( i = 0; i < std::min( seg->get_file_size(), MAX_DATA_ENTRIES ); + ++i ) { + if ( i % 16 == 0 ) { + out << "[" << DUMP_HEX_FORMAT( 8 ) << i << "]"; + } + + out << " " << DUMP_HEX_FORMAT( 2 ) << ( pdata[i] & 0x000000FF ); + + if ( i % 16 == 15 ) { + out << std::endl; + } + } + if ( i % 16 != 0 ) { + out << std::endl; + } + + out.flags( original_flags ); + } + + return; + } + + //------------------------------------------------------------------------------ + static void segment_datas( std::ostream& out, const elfio& reader ) + { + Elf_Half n = reader.segments.size(); + + if ( n == 0 ) { + return; + } + + out << "Segment Data:" << std::endl; + + for ( Elf_Half i = 0; i < n; ++i ) { // For all sections + segment* seg = reader.segments[i]; + segment_data( out, i, seg ); + } + + out << std::endl; + } + + private: + //------------------------------------------------------------------------------ + template + std::string static find_value_in_table( const T& table, const K& key ) + { + std::string res = "?"; + for ( unsigned int i = 0; i < sizeof( table ) / sizeof( table[0] ); + ++i ) { + if ( table[i].key == key ) { + res = table[i].str; + break; + } + } + + return res; + } + + //------------------------------------------------------------------------------ + template + static std::string format_assoc( const T& table, const K& key ) + { + std::string str = find_value_in_table( table, key ); + if ( str == "?" ) { + std::ostringstream oss; + oss << str << " (0x" << std::hex << key << ")"; + str = oss.str(); + } + + return str; + } + + //------------------------------------------------------------------------------ + template + static std::string format_assoc( const T& table, const char key ) + { + return format_assoc( table, (const int)key ); + } + + //------------------------------------------------------------------------------ + static std::string section_flags( Elf_Xword flags ) + { + std::string ret = ""; + if ( flags & SHF_WRITE ) { + ret += "W"; + } + if ( flags & SHF_ALLOC ) { + ret += "A"; + } + if ( flags & SHF_EXECINSTR ) { + ret += "X"; + } + + return ret; + } + +//------------------------------------------------------------------------------ +#define STR_FUNC_TABLE( name ) \ + template static std::string str_##name( const T key ) \ + { \ + return format_assoc( name##_table, key ); \ + } + + STR_FUNC_TABLE( class ) + STR_FUNC_TABLE( endian ) + STR_FUNC_TABLE( version ) + STR_FUNC_TABLE( type ) + STR_FUNC_TABLE( machine ) + STR_FUNC_TABLE( section_type ) + STR_FUNC_TABLE( segment_type ) + STR_FUNC_TABLE( segment_flag ) + STR_FUNC_TABLE( symbol_bind ) + STR_FUNC_TABLE( symbol_type ) + STR_FUNC_TABLE( dynamic_tag ) + +#undef STR_FUNC_TABLE +#undef DUMP_DEC_FORMAT +#undef DUMP_HEX_FORMAT +#undef DUMP_STR_FORMAT +}; // class dump + +}; // namespace ELFIO + +#endif // ELFIO_DUMP_HPP + +/*** End of inlined file: elfio_dump.hpp ***/ + diff --git a/3rdparty/testutils/cpp-stub/stub.h b/3rdparty/testutils/cpp-stub/stub.h new file mode 100644 index 00000000..c5f2f53f --- /dev/null +++ b/3rdparty/testutils/cpp-stub/stub.h @@ -0,0 +1,360 @@ +#ifndef __STUB_H__ +#define __STUB_H__ + +#ifdef _WIN32 +//windows +#include +#include +#else +//linux +#include +#include +#include +#endif +//c +#include +#include +//c++ +#include + + +#define ADDR(CLASS_NAME,MEMBER_NAME) (&CLASS_NAME::MEMBER_NAME) + +/********************************************************** + replace function +**********************************************************/ +#ifdef _WIN32 +#define CACHEFLUSH(addr, size) FlushInstructionCache(GetCurrentProcess(), addr, size) +#else +#define CACHEFLUSH(addr, size) __builtin___clear_cache(addr, addr + size) +#endif + +#if defined(__aarch64__) || defined(_M_ARM64) + #define CODESIZE 16U + #define CODESIZE_MIN 16U + #define CODESIZE_MAX CODESIZE + // ldr x9, +8 + // br x9 + // addr + #define REPLACE_FAR(t, fn, fn_stub)\ + ((uint32_t*)fn)[0] = 0x58000040 | 9;\ + ((uint32_t*)fn)[1] = 0xd61f0120 | (9 << 5);\ + *(long long *)(fn + 8) = (long long )fn_stub;\ + CACHEFLUSH((char *)fn, CODESIZE); + #define REPLACE_NEAR(t, fn, fn_stub) REPLACE_FAR(t, fn, fn_stub) +#elif defined(__arm__) || defined(_M_ARM) + #define CODESIZE 8U + #define CODESIZE_MIN 8U + #define CODESIZE_MAX CODESIZE + // ldr pc, [pc, #-4] + #define REPLACE_FAR(t, fn, fn_stub)\ + ((uint32_t*)fn)[0] = 0xe51ff004;\ + ((uint32_t*)fn)[1] = (uint32_t)fn_stub;\ + CACHEFLUSH((char *)fn, CODESIZE); + #define REPLACE_NEAR(t, fn, fn_stub) REPLACE_FAR(t, fn, fn_stub) +#elif defined(__mips64) + #define CACHEFLUSH(addr, size) __builtin___clear_cache(addr, addr + size) + #define CODESIZE 80U + #define CODESIZE_MIN 80U + #define CODESIZE_MAX CODESIZE + //mips没有PC指针，所以需要手动入栈出栈 + //120000ce0: 67bdffe0 daddiu sp, sp, -32 //入栈 + //120000ce4: ffbf0018 sd ra, 24(sp) + //120000ce8: ffbe0010 sd s8, 16(sp) + //120000cec: ffbc0008 sd gp, 8(sp) + //120000cf0: 03a0f025 move s8, sp + + //120000d2c: 03c0e825 move sp, s8 //出栈 + //120000d30: dfbf0018 ld ra, 24(sp) + //120000d34: dfbe0010 ld s8, 16(sp) + //120000d38: dfbc0008 ld gp, 8(sp) + //120000d3c: 67bd0020 daddiu sp, sp, 32 + //120000d40: 03e00008 jr ra + + #define REPLACE_FAR(t, fn, fn_stub)\ + ((uint32_t *)fn)[0] = 0x67bdffe0;\ + ((uint32_t *)fn)[1] = 0xffbf0018;\ + ((uint32_t *)fn)[2] = 0xffbe0010;\ + ((uint32_t *)fn)[3] = 0xffbc0008;\ + ((uint32_t *)fn)[4] = 0x03a0f025;\ + *(uint16_t *)(fn + 20) = (long long)fn_stub >> 32;\ + *(fn + 22) = 0x19;\ + *(fn + 23) = 0x24;\ + ((uint32_t *)fn)[6] = 0x0019cc38;\ + *(uint16_t *)(fn + 28) = (long long)fn_stub >> 16;\ + *(fn + 30) = 0x39;\ + *(fn + 31) = 0x37;\ + ((uint32_t *)fn)[8] = 0x0019cc38;\ + *(uint16_t *)(fn + 36) = (long long)fn_stub;\ + *(fn + 38) = 0x39;\ + *(fn + 39) = 0x37;\ + ((uint32_t *)fn)[10] = 0x0320f809;\ + ((uint32_t *)fn)[11] = 0x00000000;\ + ((uint32_t *)fn)[12] = 0x00000000;\ + ((uint32_t *)fn)[13] = 0x03c0e825;\ + ((uint32_t *)fn)[14] = 0xdfbf0018;\ + ((uint32_t *)fn)[15] = 0xdfbe0010;\ + ((uint32_t *)fn)[16] = 0xdfbc0008;\ + ((uint32_t *)fn)[17] = 0x67bd0020;\ + ((uint32_t *)fn)[18] = 0x03e00008;\ + ((uint32_t *)fn)[19] = 0x00000000;\ + CACHEFLUSH((char *)fn, CODESIZE); + #define REPLACE_NEAR(t, fn, fn_stub) REPLACE_FAR(t, fn, fn_stub) +#elif defined(__thumb__) || defined(_M_THUMB) + #error "Thumb is not supported" +#else //__i386__ _x86_64__ + #define CODESIZE 13U + #define CODESIZE_MIN 5U + #define CODESIZE_MAX CODESIZE + //13 byte(jmp m16:64) + //movabs $0x102030405060708,%r11 + //jmpq *%r11 + static void REPLACE_FAR(void *t, char *fn, char *fn_stub) + { + *fn = 0x49; + *(fn + 1) = 0xbb; + *(long long *)(fn + 2) = (long long)fn_stub; + *(fn + 10) = 0x41; + *(fn + 11) = 0xff; + *(fn + 12) = 0xe3; + CACHEFLUSH((char *)fn, CODESIZE); + } + //5 byte(jmp rel32) + #define REPLACE_NEAR(t, fn, fn_stub)\ + *fn = 0xE9;\ + *(int *)(fn + 1) = (int)(fn_stub - fn - CODESIZE_MIN);\ + CACHEFLUSH((char *)fn, CODESIZE); +#endif + +struct func_stub +{ + char *fn; + unsigned char code_buf[CODESIZE]; + bool far_jmp; +}; + +class Stub +{ +public: + Stub() + { +#ifdef _WIN32 + SYSTEM_INFO sys_info; + GetSystemInfo(&sys_info); + m_pagesize = sys_info.dwPageSize; +#else + m_pagesize = sysconf(_SC_PAGE_SIZE); +#endif + + if (m_pagesize < 0) + { + m_pagesize = 4096; + } + } + ~Stub() + { + clear(); + } + + virtual void clear() + { + std::map::iterator iter; + struct func_stub *pstub; + for(iter=m_result.begin(); iter != m_result.end(); iter++) + { + pstub = iter->second; +#ifdef _WIN32 + DWORD lpflOldProtect; + if(0 != VirtualProtect(pageof(pstub->fn), m_pagesize * 2, PAGE_EXECUTE_READWRITE, &lpflOldProtect)) +#else + if (0 == mprotect(pageof(pstub->fn), m_pagesize * 2, PROT_READ | PROT_WRITE | PROT_EXEC)) +#endif + { + + if(pstub->far_jmp) + { + std::memcpy(pstub->fn, pstub->code_buf, CODESIZE_MAX); + } + else + { + std::memcpy(pstub->fn, pstub->code_buf, CODESIZE_MIN); + } + +#ifdef _WIN32 + VirtualProtect(pageof(pstub->fn), m_pagesize * 2, PAGE_EXECUTE_READ, &lpflOldProtect); +#else + CACHEFLUSH(pstub->fn,CODESIZE); + mprotect(pageof(pstub->fn), m_pagesize * 2, PROT_READ | PROT_EXEC); +#endif + } + + iter->second = NULL; + delete pstub; + } + + m_result.clear(); + return; + } + template + bool set(T addr, S addr_stub) + { + char * fn; + char * fn_stub; + fn = addrof(addr); + fn_stub = addrof(addr_stub); + struct func_stub *pstub; + std::map::iterator iter = m_result.find(fn); + + if (iter == m_result.end()) + { + pstub = new func_stub; + //start + pstub->fn = fn; + + if(distanceof(fn, fn_stub)) + { + pstub->far_jmp = true; + std::memcpy(pstub->code_buf, fn, CODESIZE_MAX); + } + else + { + pstub->far_jmp = false; + std::memcpy(pstub->code_buf, fn, CODESIZE_MIN); + } + } + else { + pstub = iter->second; + pstub->far_jmp = distanceof(fn, fn_stub); + } + + + +#ifdef _WIN32 + DWORD lpflOldProtect; + if(0 == VirtualProtect(pageof(pstub->fn), m_pagesize * 2, PAGE_EXECUTE_READWRITE, &lpflOldProtect)) +#else + if (-1 == mprotect(pageof(pstub->fn), static_cast(m_pagesize * 2), PROT_READ | PROT_WRITE | PROT_EXEC)) +#endif + { + throw("stub set memory protect to w+r+x faild"); + return false; + } + + if(pstub->far_jmp) + { + REPLACE_FAR(this, fn, fn_stub); + } + else + { + REPLACE_NEAR(this, fn, fn_stub); + } + + +#ifdef _WIN32 + if(0 == VirtualProtect(pageof(pstub->fn), m_pagesize * 2, PAGE_EXECUTE_READ, &lpflOldProtect)) +#else + if (-1 == mprotect(pageof(pstub->fn), m_pagesize * 2, PROT_READ | PROT_EXEC)) +#endif + { + throw("stub set memory protect to r+x failed"); + return false; + } + m_result.insert(std::pair(fn,pstub)); + return true; + } + + template + bool reset(T addr) + { + char * fn; + fn = addrof(addr); + + std::map::iterator iter = m_result.find(fn); + + if (iter == m_result.end()) + { + return true; + } + struct func_stub *pstub; + pstub = iter->second; + +#ifdef _WIN32 + DWORD lpflOldProtect; + if(0 == VirtualProtect(pageof(pstub->fn), m_pagesize * 2, PAGE_EXECUTE_READWRITE, &lpflOldProtect)) +#else + if (-1 == mprotect(pageof(pstub->fn), m_pagesize * 2, PROT_READ | PROT_WRITE | PROT_EXEC)) +#endif + { + throw("stub reset memory protect to w+r+x faild"); + return false; + } + + if(pstub->far_jmp) + { + std::memcpy(pstub->fn, pstub->code_buf, CODESIZE_MAX); + } + else + { + std::memcpy(pstub->fn, pstub->code_buf, CODESIZE_MIN); + } + +#ifdef _WIN32 + if(0 == VirtualProtect(pageof(pstub->fn), m_pagesize * 2, PAGE_EXECUTE_READ, &lpflOldProtect)) +#else + CACHEFLUSH(pstub->fn,CODESIZE); + if (-1 == mprotect(pageof(pstub->fn), m_pagesize * 2, PROT_READ | PROT_EXEC)) +#endif + { + throw("stub reset memory protect to r+x failed"); + return false; + } + + m_result.erase(iter); + delete pstub; + + return true; + } +protected: + char *pageof(char* addr) + { +#ifdef _WIN32 + return (char *)((unsigned long long)addr & ~(m_pagesize - 1)); +#else + return (char *)((unsigned long)addr & ~(m_pagesize - 1)); +#endif + } + + template + char* addrof(T addr) + { + union + { + T _s; + char* _d; + }ut; + ut._s = addr; + return ut._d; + } + + bool distanceof(char* addr, char* addr_stub) + { + std::ptrdiff_t diff = addr_stub >= addr ? addr_stub - addr : addr - addr_stub; + if((sizeof(addr) > 4) && (((diff >> 31) - 1) > 0)) + { + return true; + } + return false; + } + +protected: +#ifdef _WIN32 + //LLP64 + long long m_pagesize; +#else + //LP64 + long m_pagesize; +#endif + std::map m_result; +}; + +#endif diff --git a/3rdparty/testutils/dfm_asan_helper.h b/3rdparty/testutils/dfm_asan_helper.h new file mode 100644 index 00000000..8e518276 --- /dev/null +++ b/3rdparty/testutils/dfm_asan_helper.h @@ -0,0 +1,44 @@ +#ifndef DFM_ASAN_HELPER_H +#define DFM_ASAN_HELPER_H + +#ifdef ENABLE_TSAN_TOOL +#include + +/** + * @brief Setup ASAN report path with standardized naming + * + * This macro sets up the ASAN report path in a standardized format: + * - File name: "asan_.log" + * - Location: Absolute path defined by CMake (DFM_ASAN_REPORT_DIR) + * + * @param project_name The name of the project (without quotes) + * + * Usage in main.cpp: + * ```cpp + * #include "dfm_asan_helper.h" + * + * int main(int argc, char *argv[]) { + * DFM_SETUP_ASAN_REPORT(dfm_extension); + * + * // ... other initialization code ... + * + * int ret = RUN_ALL_TESTS(); + * return ret; + * } + * ``` + */ +#define DFM_SETUP_ASAN_REPORT(project_name) \ + do { \ + /* Construct absolute path for ASAN report */ \ + std::string asan_report_path = std::string(DFM_ASAN_REPORT_DIR) + "/asan_" #project_name ".log"; \ + /* Set ASAN report path */ \ + __sanitizer_set_report_path(asan_report_path.c_str()); \ + std::cout << "DFM ASAN Helper: Report path set to " << asan_report_path << std::endl; \ + } while(0) + +#else +// No-op when ASAN is not enabled +#define DFM_SETUP_ASAN_REPORT(project_name) do { } while(0) +#endif + +#endif // DFM_ASAN_HELPER_H diff --git a/3rdparty/testutils/dfm_test_main.h b/3rdparty/testutils/dfm_test_main.h new file mode 100644 index 00000000..b44051f4 --- /dev/null +++ b/3rdparty/testutils/dfm_test_main.h @@ -0,0 +1,40 @@ +#ifndef TEST_MAIN_H +#define TEST_MAIN_H + +#include +#include + +#if defined(QT_WIDGETS_LIB) +#include +using DFMTestApplication = QApplication; +#else +#include +using DFMTestApplication = QCoreApplication; +#endif + +#include "dfm_asan_helper.h" + +/** + * @brief Unified test main function + * @param UNIT_ID The unit identifier for ASAN reporting + * + * This macro automatically selects the appropriate Qt application type: + * - QApplication when QT_WIDGETS_LIB is defined (for GUI tests) + * - QCoreApplication when QT_WIDGETS_LIB is not defined (for non-GUI tests) + * + * Usage: + * ```cpp + * #include "dfm_test_main.h" + * DFM_TEST_MAIN(my_unit_test) + * ``` + */ +#define DFM_TEST_MAIN(UNIT_ID) \ +int main(int argc, char** argv) { \ + DFMTestApplication app(argc, argv); \ + ::testing::InitGoogleTest(&argc, argv); \ + int result = RUN_ALL_TESTS(); \ + DFM_SETUP_ASAN_REPORT(UNIT_ID); \ + return result; \ +} + +#endif // TEST_MAIN_H diff --git a/3rdparty/testutils/stub-ext/stub-shadow.cpp b/3rdparty/testutils/stub-ext/stub-shadow.cpp new file mode 100644 index 00000000..d49ede2c --- /dev/null +++ b/3rdparty/testutils/stub-ext/stub-shadow.cpp @@ -0,0 +1,31 @@ +#include "stub-shadow.h" + +namespace stub_ext { + +WrapperMap stub_wrappers; + +Wrapper::Wrapper() +{ + +} + +Wrapper::~Wrapper() +{ + +} + +void freeWrapper(Wrapper *wrapper) +{ + if (!wrapper) + return; + + for (auto iter = stub_wrappers.begin(); iter != stub_wrappers.end();) { + if (iter->second == wrapper) + iter = stub_wrappers.erase(iter); + else + ++iter; + } + + delete wrapper; +} +} diff --git a/3rdparty/testutils/stub-ext/stub-shadow.h b/3rdparty/testutils/stub-ext/stub-shadow.h new file mode 100644 index 00000000..c22bb203 --- /dev/null +++ b/3rdparty/testutils/stub-ext/stub-shadow.h @@ -0,0 +1,162 @@ +#ifndef STUBSHADOW_H +#define STUBSHADOW_H + +#include +#include + +namespace stub_ext { + +#define LAMDA_FUNCTION_TYPE decltype(&Lamda::operator()) + +class Wrapper +{ +public: + Wrapper(); + virtual ~Wrapper(); +}; + +typedef std::unordered_map WrapperMap; +extern WrapperMap stub_wrappers; + +template +class LamdaWrapper : public Wrapper +{ +public: + LamdaWrapper(Lamda func): Wrapper(),_func(func){} + ~LamdaWrapper(){} + Lamda _func; +}; + +template +struct VFLocator +{ + +}; + +template +struct VFLocator +{ + typedef Ret (*Func)(Obj*, Args...); +}; + +template +struct VFLocator +{ + typedef Ret (*Func)(Obj*, Args...); +}; + +template +struct LamdaCaller +{ + +}; + +template +struct LamdaCaller +{ + template + static Ret call(LamdaWrapper *wrapper, OrgArgs&&... args) + { + return wrapper->_func(std::forward(args)...); + } +}; + +template +struct LamdaCaller +{ + template + static Ret call(LamdaWrapper *wrapper, OrgArgs&&... args) + { + return wrapper->_func(); + } +}; + +template +struct FuncShadow +{ + +}; + +template +struct FuncShadow +{ + typedef Ret (*Shadow)(Args...); + typedef Ret RetType; + + static Ret call(Args ...args) + { + Shadow shadow = &call; + long id = (long)shadow; + auto iter = stub_wrappers.find(id); + assert(stub_wrappers.find(id) != stub_wrappers.end()); + LamdaWrapper *wrapper = dynamic_cast *>(iter->second); + return LamdaCaller::call(wrapper, args...); + } +}; + +template +struct FuncShadow +{ + typedef Ret (*Shadow)(Args...); + typedef Ret RetType; + + static Ret call(Args ...args) + { + Shadow shadow = &call; + long id = (long)shadow; + auto iter = stub_wrappers.find(id); + assert(stub_wrappers.find(id) != stub_wrappers.end()); + LamdaWrapper *wrapper = dynamic_cast *>(iter->second); + return LamdaCaller::call(wrapper, args...); + } +}; + +template +struct FuncShadow +{ + typedef Ret (*Shadow)(Obj *,Args...); + typedef Ret RetType; + static Ret call(Obj *obj, Args ...args) + { + Shadow shadow = &call; + long id = (long)shadow; + auto iter = stub_wrappers.find(id); + assert(stub_wrappers.find(id) != stub_wrappers.end()); + LamdaWrapper *wrapper = dynamic_cast *>(iter->second); + return LamdaCaller::call(wrapper, obj, args...); + } +}; + + +template +struct FuncShadow +{ + typedef Ret (*Shadow)(Obj *,Args...); + typedef Ret RetType; + static Ret call(Obj *obj, Args ...args) + { + Shadow shadow = &call; + long id = (long)shadow; + auto iter = stub_wrappers.find(id); + assert(stub_wrappers.find(id) != stub_wrappers.end()); + LamdaWrapper *wrapper = dynamic_cast *>(iter->second); + return LamdaCaller::call(wrapper, obj, args...); + } +}; + +template +typename FuncShadow::Shadow depictShadow(Wrapper **wrapper, Func func, Lamda lamda) +{ + *wrapper = new LamdaWrapper(lamda); + typename FuncShadow::Shadow shadow = &FuncShadow::call; + long id = (long)shadow; + assert(stub_wrappers.find(id) == stub_wrappers.end()); + stub_wrappers.insert(std::make_pair(id,*wrapper)); + return shadow; +} + +void freeWrapper(Wrapper *wrapper); + +} + +#endif // STUBSHADOW_H diff --git a/3rdparty/testutils/stub-ext/stubext.h b/3rdparty/testutils/stub-ext/stubext.h new file mode 100644 index 00000000..671ad551 --- /dev/null +++ b/3rdparty/testutils/stub-ext/stubext.h @@ -0,0 +1,103 @@ +#ifndef STUBEXT_H +#define STUBEXT_H + +//需修改Stub的私用成员函数和成员变量为保护类型 +#include "stub.h" + +#include "stub-shadow.h" + +#ifdef DEBUG_STUB_INVOKE +// use to make sure the stub function is invoked. +# define __DBG_STUB_INVOKE__ printf("stub at %s:%d is invoked.\n", __FILE__, __LINE__); +#else +# define __DBG_STUB_INVOKE__ +#endif + +#define VADDR(CLASS_NAME, MEMBER_NAME) (typename stub_ext::VFLocator::Func)(&CLASS_NAME::MEMBER_NAME) + +namespace stub_ext { + +class StubExt : public Stub +{ +public: + StubExt() + : Stub() { } + + template + bool set_lamda(T addr, Lamda lamda) + { + char *fn = addrof(addr); + if (m_result.find(fn) != m_result.end()) + reset(addr); + + Wrapper *wrapper = nullptr; + auto addr_stub = depictShadow(&wrapper, addr, lamda); + if (set(addr, addr_stub)) { + m_wrappers.insert(std::make_pair(fn, wrapper)); + return true; + } else { + freeWrapper(wrapper); + } + return false; + } + + template + void reset(T addr) + { + Stub::reset(addr); + char *fn = addrof(addr); + auto iter = m_wrappers.find(fn); + if (iter != m_wrappers.end()) { + freeWrapper(iter->second); + m_wrappers.erase(iter); + } + } + + ~StubExt() + { + clear(); + } + + void clear() override + { + Stub::clear(); + for (auto iter = m_wrappers.begin(); iter != m_wrappers.end(); ++iter) { + freeWrapper(iter->second); + } + m_wrappers.clear(); + } + + template + static void *get_ctor_addr(bool start = true) + { + // the start vairable must be true, or the compiler will optimize out. + if (start) goto Start; + Call_Constructor: + // This line of code will not be executed. + // The purpose of the code is to allow the compiler to generate the assembly code that calls the constructor. + T(); + Start: + // The address of the line of code T() obtained by assembly + char *p = (char *)&&Call_Constructor; // https://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html + // CALL rel32 + void *ret = 0; + char pos; + char call = 0xe8; + do { + pos = *p; + if (pos == call) { + ret = p + 5 + (*(int *)(p + 1)); + } + + } while (!ret && (++p)); + + return ret; + } + +protected: + std::map m_wrappers; +}; + +} + +#endif // STUBEXT_H diff --git a/AGENTS.md b/AGENTS.md index bf774a99..7701e459 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -11,7 +11,12 @@ make -C src/kernelmod # Build kernel module ### Test Commands ```bash -# Not support +./autotests/run-ut.sh # configure (Debug) + build + run ut-anything-index +./autotests/run-ut.sh --coverage # same, plus lcov HTML report in build-autotests/coverage/ +./autotests/run-ut.sh --run-only # run existing binaries without rebuilding +# Manual variant: unit tests are built in Debug configs only +cmake -B build-dbg -DCMAKE_BUILD_TYPE=Debug && cmake --build build-dbg -j$(nproc) && cd build-dbg && ctest +# Force tests into any configuration: -DOPT_ENABLE_BUILD_UT=ON ``` ### Lint and Static Analysis @@ -22,20 +27,32 @@ make -C src/kernelmod # Build kernel module ## Code Style Guidelines ### Language Standards -- **Daemon (src/daemon/)**: C++20 with `-Wall -Werror -Wextra` -- **Logger (src/logger/)**: C++17 with `-Wall -Werror -Wextra` +- **Server/Logger/Dispatcher (src/server, src/logger, src/dispatcher)**: C with `-Wall -Wextra -pedantic -Werror` +- **Index service (src/index/)**: C++17 with Qt6 (`-Wall -Wextra`) +- **Extractor (src/extractor/)**: C++17 with Qt6 (`-Wall -Wextra`) - **Kernel Module (src/kernelmod/)**: C99 with `-std=gnu99 -Wall -O3` ### File Structure ``` src/ -├── daemon/ # Main daemon service (C++20) -├── server/ # Server component (C++) -├── kernelmod/ # Linux kernel module (C99) -├── logger/ # Logging subsystem (C++17) -└── searcher/ # Search functionality (C++) +├── server/ # System-level server component (C) +├── kernelmod/ # Linux kernel module (C99, DKMS) +├── logger/ # Logging subsystem (C) +├── dispatcher/ # Event dispatcher library (C) +├── common/ # Code shared by index & extractor (C++) +├── index/ # deepin-anything-index user service (C++17/Qt6, migrated textindex) +└── extractor/ # deepin-anything-extractor subprocess + plugins (C++17/Qt6) +autotests/ +└── index/ # ut-anything-index (gtest + stub-ext, white-box; run-ut.sh + coverage) ``` +Two test conventions coexist (mirroring upstream layouts): C++ suites live in +root-level `autotests/` (gated by `OPT_ENABLE_BUILD_UT`, one-command runs via +`autotests/run-ut.sh`); the legacy C suites keep their `src/*/tests` +locations. See `docs/design/textindex-migration.md` and `CONTEXT.md` for the +index service architecture and frozen D-Bus/dconfig contracts (do not rename +bus names, object paths, dconfig schemas, or index data directories). + ### Naming Conventions - Functions: `snake_case` (C functions, C++ methods) - Classes: `CamelCase` (e.g., `EventHandlerConfig`, `EventLogger`) @@ -53,8 +70,8 @@ src/ ### Error Handling - Return values: 0 for success, non-zero for failure - C functions: Use `errno` for detailed errors -- C++ daemon: Use `spdlog` for logging - C modules: Use `Glib` logging (`g_log()`) +- C++ services: use bare `qDebug/qInfo/qWarning/qCritical` (no logging categories) - Always check return values of system calls ### C++ Style (C++17/20) diff --git a/CMakeLists.txt b/CMakeLists.txt index 76ded82a..4aea223d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,5 +9,24 @@ if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) set(CMAKE_INSTALL_PREFIX /usr) endif () +# Unit tests default to Debug configurations only (developer workflow: +# autotests/run-ut.sh). Pass -DOPT_ENABLE_BUILD_UT=ON to force them on in +# any configuration. Package builds (no build type) never build or run them. +if(CMAKE_BUILD_TYPE STREQUAL "Debug") + option(OPT_ENABLE_BUILD_UT "Build unit tests" ON) +else() + option(OPT_ENABLE_BUILD_UT "Build unit tests" OFF) +endif() + +# Always enable testing so the `test` target exists and no-ops gracefully +# (ctest with zero tests exits 0) when no tests are configured. +enable_testing() + add_subdirectory(${PROJECT_SOURCE_DIR}/src) add_subdirectory(${PROJECT_SOURCE_DIR}/config) + +# Root-level autotests/ mirrors the dde-file-manager layout; the legacy C +# suites under src/{logger,dispatcher}/tests stay where they are. +if(OPT_ENABLE_BUILD_UT) + add_subdirectory(${PROJECT_SOURCE_DIR}/autotests) +endif() diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 00000000..2071b23b --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 6307b565..e447ba02 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,20 @@ The development of anything is derived from everything under Windows, and it is *The current development branch is **master**, build dependencies may change without updating this description, please refer to `./debian/control` for a list of build dependencies*. -- debhelper (>= 9) +- debhelper (>= 10) - dkms -- qtbase5-dev - pkg-config -- libudisks2-qt5-dev +- libnl-genl-3-dev - libmount-dev - libglib2.0-dev -- libpcre3-dev +- qt6-base-dev +- liblucene++-dev +- libdtk6core-dev +- libdfm6-search-dev +- libkf6idletime-dev +- libdocparser-dev +- libdtk6ocr-dev +- libgtest-dev ## Installation diff --git a/README.zh_CN.md b/README.zh_CN.md index d1a8ff6b..bb965056 100644 --- a/README.zh_CN.md +++ b/README.zh_CN.md @@ -8,14 +8,20 @@ anything 的开发源自于 Windows 下的 everything，它致力于为 Linux *当前的开发分支为**master**，编译依赖可能会在没有更新本说明的情况下发生变化，请参考`./debian/control`以获取构建依赖项列表*。 -- debhelper (>= 9) +- debhelper (>= 10) - dkms -- qtbase5-dev - pkg-config -- libudisks2-qt5-dev +- libnl-genl-3-dev - libmount-dev - libglib2.0-dev -- libpcre3-dev +- qt6-base-dev +- liblucene++-dev +- libdtk6core-dev +- libdfm6-search-dev +- libkf6idletime-dev +- libdocparser-dev +- libdtk6ocr-dev +- libgtest-dev ## 安装 diff --git a/REUSE.toml b/REUSE.toml index fd34f430..526be0a7 100644 --- a/REUSE.toml +++ b/REUSE.toml @@ -22,7 +22,7 @@ SPDX-FileCopyrightText = "None" SPDX-License-Identifier = "CC0-1.0" [[annotations]] -path = ["**Makefile", "**CMakeLists.txt"] +path = ["**Makefile", "**CMakeLists.txt", "**.cmake"] precedence = "aggregate" SPDX-FileCopyrightText = "None" SPDX-License-Identifier = "CC0-1.0" @@ -80,3 +80,21 @@ path = "assets/**" precedence = "aggregate" SPDX-FileCopyrightText = "UnionTech Software Technology Co., Ltd." SPDX-License-Identifier = "CC0-1.0" + +[[annotations]] +path = "3rdparty/testutils/cpp-stub/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "2019 coolxv" +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = "3rdparty/testutils/stub-ext/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "2026 UnionTech Software Technology Co., Ltd." +SPDX-License-Identifier = "MIT" + +[[annotations]] +path = ["3rdparty/testutils/dfm_asan_helper.h", "3rdparty/testutils/dfm_test_main.h"] +precedence = "aggregate" +SPDX-FileCopyrightText = "2026 UnionTech Software Technology Co., Ltd." +SPDX-License-Identifier = "GPL-3.0-or-later" diff --git a/autotests/CMakeLists.txt b/autotests/CMakeLists.txt new file mode 100644 index 00000000..cfe4a12e --- /dev/null +++ b/autotests/CMakeLists.txt @@ -0,0 +1,21 @@ +# deepin-anything unit tests (root-level autotests/, mirroring the +# dde-file-manager layout). +# +# Gated by OPT_ENABLE_BUILD_UT (root CMakeLists.txt). The legacy C suites in +# src/{logger,dispatcher}/tests are registered separately by their own +# CMakeLists and are unaffected. + +include(${CMAKE_SOURCE_DIR}/cmake/AnythingTestUtils.cmake) + +# Enable coverage flags if requested (only via run-ut.sh --coverage) +option(ANYTHING_ENABLE_COVERAGE "Enable gcov coverage instrumentation" OFF) +if(ANYTHING_ENABLE_COVERAGE) + message(STATUS "Anything: Coverage instrumentation enabled") +endif() + +# Per-suite switches (default ON; turn off to skip a suite) +option(OPT_ENABLE_BUILD_UT_INDEX "Build index unit tests" ON) + +if(OPT_ENABLE_BUILD_UT_INDEX) + add_subdirectory(index) +endif() diff --git a/autotests/gen-ut-summary.py b/autotests/gen-ut-summary.py new file mode 100755 index 00000000..1c5c9bfc --- /dev/null +++ b/autotests/gen-ut-summary.py @@ -0,0 +1,127 @@ +#!/usr/bin/env python3 +# SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +# +# SPDX-License-Identifier: GPL-3.0-or-later + +"""Generate ut-summary.json from gtest XML reports and lcov coverage data. + +Usage: + Called from autotests/run-ut.sh. Reads environment variables: + - projectdir: project root directory + - builddir: build directory name (relative to projectdir) + - reportdir: report output directory name (relative to projectdir) + + Optional overrides (take precedence over defaults): + - GTEST_XML_DIR: directory containing gtest XML reports + - COVERAGE_INFO: path to lcov .info file for coverage parsing + + Output: {projectdir}/{reportdir}/ut-summary.json +""" + +import json +import xml.etree.ElementTree as ET +import glob +import os +import subprocess +import re +import sys + + +def parse_gtest_xml(xml_dir): + """Parse Google Test / JUnit XML output and return (total, passed, failed).""" + total = passed = failed = 0 + for xml_file in sorted(glob.glob(os.path.join(xml_dir, "*.xml"))): + try: + root = ET.parse(xml_file).getroot() + # JUnit format uses as root with aggregated counts + # gtest XML uses or as root + t = int(root.get("tests", 0)) + f_count = int(root.get("failures", 0)) + err_count = int(root.get("errors", 0)) + total += t + failed += f_count + err_count + passed += t - f_count - err_count + except Exception as e: + print(f"Warning: failed to parse {xml_file}: {e}", file=sys.stderr) + return total, passed, failed + + +def parse_lcov_summary(coverage_info): + """Parse lcov --summary output and return coverage dict.""" + result = {} + if not os.path.exists(coverage_info): + print(f"Warning: coverage info file not found: {coverage_info}", file=sys.stderr) + return result + + lcov_out = subprocess.run( + ["lcov", "--summary", coverage_info, "--rc", "lcov_branch_coverage=1"], + capture_output=True, text=True + ) + summary_text = lcov_out.stdout + lcov_out.stderr + + # Parse lines: "lines......: XX.X% (NNN of MMMM lines)" + m_lines = re.search(r'lines.*?:\s*([\d.]+)%\s*\((\d+)\s+of\s+(\d+)\s+\w+\)', summary_text) + if m_lines: + pct, hit, total = m_lines.groups() + result["line_coverage"] = { + "total": int(total), + "passed": int(hit), + "failed": int(total) - int(hit), + "coverage": f"{float(pct):.2f}%" + } + + # Parse functions: "functions..: XX.X% (NNN of MMMM functions)" + m_func = re.search(r'functions.*?:\s*([\d.]+)%\s*\((\d+)\s+of\s+(\d+)\s+\w+\)', summary_text) + if m_func: + pct, hit, total = m_func.groups() + result["function_coverage"] = { + "total": int(total), + "passed": int(hit), + "failed": int(total) - int(hit), + "coverage": f"{float(pct):.2f}%" + } + + return result + + +def main(): + projectdir = os.environ.get("projectdir") + builddir = os.environ.get("builddir") + reportdir = os.environ.get("reportdir") + + if not all([projectdir, builddir, reportdir]): + print("Error: environment variables projectdir, builddir, reportdir are required", file=sys.stderr) + sys.exit(1) + + # Resolve paths (env overrides take precedence) + gtest_dir = os.environ.get("GTEST_XML_DIR", + os.path.join(projectdir, builddir, "report")) + coverage_info = os.environ.get("COVERAGE_INFO", + os.path.join(projectdir, builddir, "coverage.info")) + + # --- Test case counts from gtest XML --- + total, passed, failed = parse_gtest_xml(gtest_dir) + + result = { + "test_cases": { + "total": total, + "passed": passed, + "failed": failed + } + } + + # --- Coverage from lcov --summary --- + coverage_data = parse_lcov_summary(coverage_info) + result.update(coverage_data) + + # --- Write output --- + output_path = os.path.join(projectdir, reportdir, "ut-summary.json") + os.makedirs(os.path.dirname(output_path), exist_ok=True) + with open(output_path, "w") as f: + json.dump(result, f, indent=2) + + print(json.dumps(result, indent=2)) + + +if __name__ == "__main__": + main() diff --git a/autotests/index/CMakeLists.txt b/autotests/index/CMakeLists.txt new file mode 100644 index 00000000..34b86138 --- /dev/null +++ b/autotests/index/CMakeLists.txt @@ -0,0 +1,41 @@ +# Unit tests for the deepin-anything-index service. +# Single white-box target: compiles the index sources into the test binary +# (stub-ext needs direct access), plus the extractor pipe tests. +# +# Runs via: ./autotests/run-ut.sh (build + run) +# ./autotests/run-ut.sh --coverage (with lcov HTML report) + +set(CMAKE_AUTOMOC ON) + +find_package(Qt6 REQUIRED COMPONENTS Core DBus Gui Concurrent Test) +find_package(Dtk6 COMPONENTS Core REQUIRED) +find_package(KF6IdleTime REQUIRED) +find_package(dfm6-search REQUIRED) +find_package(PkgConfig REQUIRED) +pkg_check_modules(Lucene REQUIRED IMPORTED_TARGET liblucene++ liblucene++-contrib) +pkg_check_modules(MOUNT REQUIRED mount IMPORTED_TARGET) +pkg_check_modules(NL REQUIRED IMPORTED_TARGET libnl-3.0 libnl-genl-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) + +file(GLOB_RECURSE TEST_SOURCES + "${CMAKE_CURRENT_SOURCE_DIR}/*.cpp" + "${CMAKE_CURRENT_SOURCE_DIR}/*.h" +) + +# ANYTHING_INDEX_SOURCES comes from the src/index subproject (CACHE INTERNAL); +# the D-Bus adaptors are provided by the index_adaptors static library target. +anything_add_test(ut-anything-index + SOURCES ${TEST_SOURCES} ${ANYTHING_INDEX_SOURCES} + LINK_LIBRARIES common index_adaptors deepin-anything-extractor-lib dfm6-search + Qt6::Core Qt6::DBus Qt6::Gui Qt6::Concurrent + Dtk6::Core KF6::IdleTime + PkgConfig::Lucene PkgConfig::MOUNT PkgConfig::NL PkgConfig::GLIB + INCLUDE_DIRS ${CMAKE_SOURCE_DIR}/src/index + ${CMAKE_SOURCE_DIR}/src/index/dbus + ${CMAKE_SOURCE_DIR}/src/extractor/libextractor +) + +target_compile_definitions(ut-anything-index PRIVATE + ANYTHING_EXTRACTOR_TOOL="/usr/libexec/deepin-anything-extractor" + PINYIN_DICT_INSTALL_DIR="/usr/share/deepin-anything-index" +) diff --git a/autotests/index/main.cpp b/autotests/index/main.cpp new file mode 100644 index 00000000..19a150d3 --- /dev/null +++ b/autotests/index/main.cpp @@ -0,0 +1,9 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include +#include +#include "dfm_test_main.h" + +DFM_TEST_MAIN(textindex) diff --git a/autotests/index/test_backlogtracker.cpp b/autotests/index/test_backlogtracker.cpp new file mode 100644 index 00000000..5853b883 --- /dev/null +++ b/autotests/index/test_backlogtracker.cpp @@ -0,0 +1,86 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include + +#include + +#include "stubext.h" +#include + +#include "profile/indexprofile.h" +#include "state/indexstatestore.h" +#include "task/backlogtracker.h" +#include "utils/indexutility.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +DCORE_USE_NAMESPACE + +class FilenameBacklogTrackerTest : public testing::Test +{ +protected: + void SetUp() override + { + ASSERT_TRUE(directory.isValid()); + profile = IndexProfile({ IndexProfile::Type::Filename, + "backlog-test", + "backlog_status.json", + "backlog_version", + 1 }, + { [this]() { return directory.path(); }, + []() { return true; }, + [](const QString &) { return true; }, + [](const QString &) { return true; } }); + store = std::make_unique(profile); + tracker = std::make_unique(store.get()); + } + + QTemporaryDir directory; + IndexProfile profile; + std::unique_ptr store; + std::unique_ptr tracker; +}; + +TEST_F(FilenameBacklogTrackerTest, SetsAtDefaultThresholdAndClearsWhenDrained) +{ + // 屏蔽 DConfig::create：本机 dconfig 可能配置了 pending_events_trigger_updating + // 覆盖值，置空后 threshold() 回落代码默认值 5000，测试不依赖机器配置。 + stub_ext::StubExt stub; + stub.set_lamda(static_cast(&DConfig::create), + [](const QString &, const QString &, const QString &, QObject *) -> DConfig * { + __DBG_STUB_INVOKE__ + return nullptr; + }); + + tracker->update(4999, 0, true); + EXPECT_FALSE(store->isBacklogExceeded()); + + tracker->update(5000, 0, true); + EXPECT_TRUE(store->isBacklogExceeded()); + + tracker->update(0, 0, true); + EXPECT_TRUE(store->isBacklogExceeded()); + + tracker->update(0, 0, false); + EXPECT_FALSE(store->isBacklogExceeded()); +} + +TEST_F(FilenameBacklogTrackerTest, StartupKeepsDirtyBacklogAndResetsCleanBacklog) +{ + store->setBacklogExceeded(true); + store->setIndexState(IndexUtility::IndexState::Dirty); + tracker->onStartup(); + EXPECT_TRUE(store->isBacklogExceeded()); + + store->setIndexState(IndexUtility::IndexState::Clean); + tracker->onStartup(); + EXPECT_FALSE(store->isBacklogExceeded()); +} + +TEST_F(FilenameBacklogTrackerTest, FullScanCompletionClearsBacklog) +{ + store->setBacklogExceeded(true); + tracker->onFullScanFinished(); + EXPECT_FALSE(store->isBacklogExceeded()); +} diff --git a/autotests/index/test_contentdeduplication.cpp b/autotests/index/test_contentdeduplication.cpp new file mode 100644 index 00000000..96d764e9 --- /dev/null +++ b/autotests/index/test_contentdeduplication.cpp @@ -0,0 +1,81 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_contentdeduplication.cpp + * @brief Unit tests for ContentDeduplication (extractor/contentdeduplication.cpp) + */ + +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "extractor/contentdeduplication.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class ContentDeduplicationTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + } +}; + +TEST_F(ContentDeduplicationTest, Lookup_EmptyChecksum) +{ + QString result = ContentDeduplication::lookupByTextChecksum(QString(), tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(ContentDeduplicationTest, Lookup_EmptyIndexDir) +{ + QString result = ContentDeduplication::lookupByTextChecksum("abc123", QString()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(ContentDeduplicationTest, Lookup_BothEmpty) +{ + QString result = ContentDeduplication::lookupByTextChecksum(QString(), QString()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(ContentDeduplicationTest, Lookup_NonExistentIndexDir) +{ + QString result = ContentDeduplication::lookupByTextChecksum( + "d41d8cd98f00b204e9800998ecf8427e", "/nonexistent/path/to/index"); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(ContentDeduplicationTest, Lookup_EmptyDirAsIndex) +{ + QString result = ContentDeduplication::lookupByTextChecksum( + "d41d8cd98f00b204e9800998ecf8427e", tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(ContentDeduplicationTest, Lookup_LongChecksum) +{ + QString longChecksum(1000, 'a'); + QString result = ContentDeduplication::lookupByTextChecksum(longChecksum, tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(ContentDeduplicationTest, Lookup_FileAsIndexDir) +{ + QString filePath = tmp.path() + "/not_a_dir.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("not an index"); + f.close(); + + QString result = ContentDeduplication::lookupByTextChecksum("abc123", filePath); + EXPECT_TRUE(result.isEmpty()); +} \ No newline at end of file diff --git a/autotests/index/test_contentdocumentbuilder.cpp b/autotests/index/test_contentdocumentbuilder.cpp new file mode 100644 index 00000000..bf0e1411 --- /dev/null +++ b/autotests/index/test_contentdocumentbuilder.cpp @@ -0,0 +1,192 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_contentdocumentbuilder.cpp + * @brief Unit tests for ContentDocumentBuilder (document/contentdocumentbuilder.cpp). + * Exercises the build() method with various file and options combinations + * using real QFileInfo operations on temporary files. + */ + +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "document/contentdocumentbuilder.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +class ContentDocumentBuilderTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + // Create some test files + QDir dir(tmp.path()); + ASSERT_TRUE(dir.mkpath("subdir")); + createFile("test.txt", "hello world"); + createFile("subdir/nested.txt", "nested content"); + createFile("document.PDF", "pdf content"); + } + + void createFile(const QString &relativePath, const QString &content) + { + QFile f(tmp.path() + "/" + relativePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } + + ContentDocumentBuilder builder; +}; + +TEST_F(ContentDocumentBuilderTest, BuildBasicTextFile) +{ + QString filePath = tmp.path() + "/test.txt"; + auto doc = builder.build(filePath, "sample text content"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithEmptyText) +{ + QString filePath = tmp.path() + "/test.txt"; + auto doc = builder.build(filePath, ""); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithWhitespaceText) +{ + QString filePath = tmp.path() + "/test.txt"; + auto doc = builder.build(filePath, " \n\t "); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithLongContent) +{ + QString filePath = tmp.path() + "/test.txt"; + QString longText(10000, 'A'); + auto doc = builder.build(filePath, longText); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithChecksumInOptions) +{ + QString filePath = tmp.path() + "/test.txt"; + BuilderOptions options; + options.checksum = "abc123def456"; + auto doc = builder.build(filePath, "text", options); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithEmptyChecksumInOptions) +{ + QString filePath = tmp.path() + "/test.txt"; + BuilderOptions options; + options.checksum = ""; + auto doc = builder.build(filePath, "text", options); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithDefaultOptions) +{ + QString filePath = tmp.path() + "/test.txt"; + BuilderOptions options; // default: empty checksum + auto doc = builder.build(filePath, "text", options); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildFileWithExtension) +{ + QString filePath = tmp.path() + "/document.PDF"; + auto doc = builder.build(filePath, "pdf content"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildFileWithoutExtension) +{ + QString filePath = tmp.path() + "/test.txt"; + // File has .txt extension; build with it + auto doc = builder.build(filePath, "no ext content"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildNestedPath) +{ + QString filePath = tmp.path() + "/subdir/nested.txt"; + auto doc = builder.build(filePath, "nested content"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithSpecialCharactersInText) +{ + QString filePath = tmp.path() + "/test.txt"; + QString specialText = "Hello 世界 🌍 \n\t\r特殊字符"; + auto doc = builder.build(filePath, specialText); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithUnicodeFilePath) +{ + // Create a file with unicode in the path + QString unicodeDir = tmp.path() + "/中文目录"; + QDir().mkpath(unicodeDir); + QString filePath = unicodeDir + "/文件.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("unicode content"); + f.close(); + + auto doc = builder.build(filePath, "unicode content"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithNonExistentFile) +{ + // Even non-existent file should create a doc (using QFileInfo on missing file) + QString filePath = tmp.path() + "/nonexistent.txt"; + auto doc = builder.build(filePath, "text for missing file"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(ContentDocumentBuilderTest, BuildWithHiddenFile_CheckHiddenTag) +{ + // Stub isHiddenPathOrInHiddenDir to return true for a non-hidden path + stub_ext::StubExt stub; + bool called = false; + stub.set_lamda(ADDR(Global, isHiddenPathOrInHiddenDir), + [&](const QString &) -> bool { + __DBG_STUB_INVOKE__ + called = true; + return false; + }); + + QString filePath = tmp.path() + "/test.txt"; + auto doc = builder.build(filePath, "text"); + ASSERT_NE(doc, nullptr); + EXPECT_TRUE(called); +} diff --git a/autotests/index/test_controllerpipe.cpp b/autotests/index/test_controllerpipe.cpp new file mode 100644 index 00000000..347de3f6 --- /dev/null +++ b/autotests/index/test_controllerpipe.cpp @@ -0,0 +1,88 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_controllerpipe.cpp + * @brief Unit tests for ControllerPipe (libextractor/controllerpipe.cpp) — the + * dependency-light subset: ctor, dtor, isRunning (false by default), + * processId (-1 by default), hasPendingPartialMessage (false), start + * with empty path (early return), extractBatch when not running + * (early return). The actual subprocess spawning is not exercised. + */ + +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "controllerpipe.h" + +using namespace deepin_anything_extractor; + +TEST(ControllerPipeTest, CtorAndDtorSafe) +{ + { + ControllerPipe c; + SUCCEED(); + } +} + +TEST(ControllerPipeTest, IsRunningFalseByDefault) +{ + ControllerPipe c; + EXPECT_FALSE(c.isRunning()); +} + +TEST(ControllerPipeTest, ProcessIdNegativeByDefault) +{ + ControllerPipe c; + EXPECT_EQ(c.processId(), -1); +} + +TEST(ControllerPipeTest, HasPendingPartialMessageFalseByDefault) +{ + ControllerPipe c; + EXPECT_FALSE(c.hasPendingPartialMessage()); +} + +TEST(ControllerPipeTest, StartEmptyPathReturnsFalse) +{ + ControllerPipe c; + EXPECT_FALSE(c.start(QString())); +} + +TEST(ControllerPipeTest, StartNonExistentPathReturnsFalse) +{ + ControllerPipe c; + EXPECT_FALSE(c.start("/nonexistent/extractor/path")); +} + +TEST(ControllerPipeTest, ExtractBatchFailsWhenNotRunning) +{ + ControllerPipe c; + QVector files { "/tmp/a.txt" }; + EXPECT_FALSE(c.extractBatch(files)); +} + +TEST(ControllerPipeTest, ExtractBatchEmptyFilesFailsWhenNotRunning) +{ + ControllerPipe c; + QVector empty; + EXPECT_FALSE(c.extractBatch(empty)); +} + +TEST(ControllerPipeTest, StopWhenNotRunningIsSafe) +{ + ControllerPipe c; + EXPECT_NO_FATAL_FAILURE({ c.stop(); }); +} + +TEST(ControllerPipeTest, MultipleStopCallsSafe) +{ + ControllerPipe c; + c.stop(); + c.stop(); + SUCCEED(); +} diff --git a/autotests/index/test_dbus.cpp b/autotests/index/test_dbus.cpp new file mode 100644 index 00000000..de18ebda --- /dev/null +++ b/autotests/index/test_dbus.cpp @@ -0,0 +1,535 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_dbus.cpp + * @brief Unit tests for TextIndexDBus and OcrIndexDBus (textindexdbus.cpp + ocrindexdbus.cpp) + * — constructs the DBus objects (they create an IndexRuntime internally) and + * exercises the public slot API. DBus registration on session bus will fail + * gracefully in the test sandbox (no dbus-daemon), so the object still works. + * + * We stub DFMSEARCH::Global directory/availability functions so that + * IndexProfile::content()/ocr() resolve to a QTemporaryDir instead of the real + * system index path. This provides full host-environment isolation while + * still exercising the real production code paths. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "dbus/textindexdbus.h" +#include "dbus/ocrindexdbus.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +// --------------------------------------------------------------------------- +// Helper: write a JSON status file into the temp index directory so that +// IndexStateStore::readStatusJson() returns a controlled QJsonObject. +// --------------------------------------------------------------------------- +static void writeStatusJson(const QString &indexDir, const QJsonObject &obj) +{ + QDir().mkpath(indexDir); + QFile f(indexDir + QLatin1String("/index_status.json")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly | QIODevice::Truncate)); + f.write(QJsonDocument(obj).toJson()); + f.close(); +} + +// --------------------------------------------------------------------------- +// DBusTest fixture +// --------------------------------------------------------------------------- +class DBusTest : public testing::Test +{ +protected: + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + // Redirect Global::contentIndexDirectory to the temp dir + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/content-index"; + }); + + // Let isContentIndexAvailable return true so that IndexDatabaseExists + // can exercise the deeper branches (version check, lastUpdateTime check). + stub.set_lamda(ADDR(Global, isContentIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + + stub.set_lamda(ADDR(Global, isPathInContentIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + + // Redirect Global::ocrTextIndexDirectory to the temp dir + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/ocr-index"; + }); + + stub.set_lamda(ADDR(Global, isOcrTextIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + + stub.set_lamda(ADDR(Global, isPathInOcrTextIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + + // Prevent handleSilentStart() from scanning real system directories + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() + "/indexed-dir" }; + }); + + // Prevent reading real system blacklist paths from DConfig + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + } + + void TearDown() override + { + // stub_ext::StubExt destructor resets all stubs automatically + } + + QTemporaryDir tmp; + stub_ext::StubExt stub; +}; + +// ========================== TextIndexDBus ================================ + +TEST_F(DBusTest, TextIndexDBusConstructAndDestruct) +{ + { + TextIndexDBus dbus; + SUCCEED(); + } +} + +TEST_F(DBusTest, TextIndexDBusIsEnabled) +{ + TextIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.IsEnabled(); }); +} + +TEST_F(DBusTest, TextIndexDBusSetEnabled) +{ + TextIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.SetEnabled(false); }); +} + +TEST_F(DBusTest, TextIndexDBusStopCurrentTask) +{ + TextIndexDBus dbus; + EXPECT_FALSE(dbus.StopCurrentTask()); +} + +TEST_F(DBusTest, TextIndexDBusHasRunningTask) +{ + TextIndexDBus dbus; + EXPECT_FALSE(dbus.HasRunningTask()); +} + +// --- No status file → isIndexAvailable() passes, but version missing +// → isCompatibleVersion() fails → returns false +TEST_F(DBusTest, TextIndexDBusIndexDatabaseExistsNoStatusFile) +{ + TextIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +// --- Status file with wrong version → isCompatibleVersion() fails +TEST_F(DBusTest, TextIndexDBusIndexDatabaseExistsVersionMismatch) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { { "version", 999 }, { "lastUpdateTime", "2026-01-01T00:00:00" } }); + + TextIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +// --- Version ok but lastUpdateTime missing → returns false +TEST_F(DBusTest, TextIndexDBusIndexDatabaseExistsNoLastUpdateTime) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { { "version", Defines::kTextIndexVersion } }); + + TextIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +// --- All checks pass → returns true +TEST_F(DBusTest, TextIndexDBusIndexDatabaseExistsAllGood) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { + { "version", Defines::kTextIndexVersion }, + { "lastUpdateTime", "2026-03-11T15:34:16" }, + { "state", "clean" } + }); + + TextIndexDBus dbus; + EXPECT_TRUE(dbus.IndexDatabaseExists()); +} + +// --- No status file → getLastUpdateTime returns empty +TEST_F(DBusTest, TextIndexDBusGetLastUpdateTimeEmpty) +{ + TextIndexDBus dbus; + QString t = dbus.GetLastUpdateTime(); + EXPECT_TRUE(t.isEmpty()); +} + +// --- Status file with lastUpdateTime → returns formatted time +TEST_F(DBusTest, TextIndexDBusGetLastUpdateTimeValid) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { + { "version", Defines::kTextIndexVersion }, + { "lastUpdateTime", "2026-03-11T15:34:16" } + }); + + TextIndexDBus dbus; + QString t = dbus.GetLastUpdateTime(); + EXPECT_FALSE(t.isEmpty()); + // IndexStateStore formats as "yyyy-MM-dd hh:mm:ss" + EXPECT_EQ(t, QString("2026-03-11 15:34:16")); +} + +TEST_F(DBusTest, TextIndexDBusCreateIndexTaskEmpty) +{ + TextIndexDBus dbus; + EXPECT_FALSE(dbus.CreateIndexTask({})); +} + +TEST_F(DBusTest, TextIndexDBusUpdateIndexTaskEmpty) +{ + TextIndexDBus dbus; + EXPECT_FALSE(dbus.UpdateIndexTask({})); +} + +TEST_F(DBusTest, TextIndexDBusProcessFileChangesEmpty) +{ + TextIndexDBus dbus; + EXPECT_FALSE(dbus.ProcessFileChanges({}, {}, {})); +} + +TEST_F(DBusTest, TextIndexDBusProcessFileMovesEmpty) +{ + TextIndexDBus dbus; + EXPECT_FALSE(dbus.ProcessFileMoves({})); +} + +TEST_F(DBusTest, TextIndexDBusCleanup) +{ + TextIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.cleanup(); }); +} + +// ========================== OcrIndexDBus ================================= + +TEST_F(DBusTest, OcrIndexDBusConstructAndDestruct) +{ + { + OcrIndexDBus dbus; + SUCCEED(); + } +} + +TEST_F(DBusTest, OcrIndexDBusIsEnabled) +{ + OcrIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.IsEnabled(); }); +} + +TEST_F(DBusTest, OcrIndexDBusSetEnabled) +{ + OcrIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.SetEnabled(false); }); +} + +TEST_F(DBusTest, OcrIndexDBusStopCurrentTask) +{ + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.StopCurrentTask()); +} + +TEST_F(DBusTest, OcrIndexDBusHasRunningTask) +{ + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.HasRunningTask()); +} + +// --- No status file → version missing → returns false +TEST_F(DBusTest, OcrIndexDBusIndexDatabaseExistsNoStatusFile) +{ + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +// --- Version ok but lastUpdateTime missing → returns false +TEST_F(DBusTest, OcrIndexDBusIndexDatabaseExistsNoLastUpdateTime) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion } }); + + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +// --- All checks pass → returns true +TEST_F(DBusTest, OcrIndexDBusIndexDatabaseExistsAllGood) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { + { "version", Defines::kOcrIndexVersion }, + { "lastUpdateTime", "2026-03-11T15:34:16" }, + { "state", "clean" } + }); + + OcrIndexDBus dbus; + EXPECT_TRUE(dbus.IndexDatabaseExists()); +} + +// --- No status file → returns empty +TEST_F(DBusTest, OcrIndexDBusGetLastUpdateTimeEmpty) +{ + OcrIndexDBus dbus; + QString t = dbus.GetLastUpdateTime(); + EXPECT_TRUE(t.isEmpty()); +} + +// --- Valid lastUpdateTime → returns formatted time +TEST_F(DBusTest, OcrIndexDBusGetLastUpdateTimeValid) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { + { "version", Defines::kOcrIndexVersion }, + { "lastUpdateTime", "2026-03-11T15:34:16" } + }); + + OcrIndexDBus dbus; + QString t = dbus.GetLastUpdateTime(); + EXPECT_FALSE(t.isEmpty()); + EXPECT_EQ(t, QString("2026-03-11 15:34:16")); +} + +TEST_F(DBusTest, OcrIndexDBusCreateIndexTaskEmpty) +{ + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.CreateIndexTask({})); +} + +TEST_F(DBusTest, OcrIndexDBusProcessFileChangesEmpty) +{ + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.ProcessFileChanges({}, {}, {})); +} + +TEST_F(DBusTest, OcrIndexDBusProcessFileMovesEmpty) +{ + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.ProcessFileMoves({})); +} + +TEST_F(DBusTest, OcrIndexDBusCleanup) +{ + OcrIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.cleanup(); }); +} + +// ---- Additional TextIndexDBus coverage ---- + +TEST_F(DBusTest, TextIndexDBusCreateIndexTaskWithPaths) +{ + TextIndexDBus dbus; + // Non-empty paths, but TaskManager::startTask will fail if index not ready + QVariantMap opts; + opts["silent"] = true; + bool result = dbus.CreateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + // May succeed or fail depending on runtime state, just no crash + SUCCEED(); +} + +TEST_F(DBusTest, TextIndexDBusUpdateIndexTaskWithPaths) +{ + TextIndexDBus dbus; + QVariantMap opts; + opts["silent"] = true; + bool result = dbus.UpdateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + SUCCEED(); +} + +TEST_F(DBusTest, TextIndexDBusProcessFileChanges_OnlyDeleted) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + {}, + {}, + { "/fake/deleted/file.txt" }); + // May or may not queue task depending on runtime + SUCCEED(); +} + +TEST_F(DBusTest, TextIndexDBusProcessFileChanges_OnlyCreated) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + { "/fake/created/file.txt" }, + {}, + {}); + SUCCEED(); +} + +TEST_F(DBusTest, TextIndexDBusProcessFileChanges_OnlyModified) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + {}, + { "/fake/modified/file.txt" }, + {}); + SUCCEED(); +} + +TEST_F(DBusTest, TextIndexDBusProcessFileChanges_AllThree) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + { "/fake/created.txt" }, + { "/fake/modified.txt" }, + { "/fake/deleted.txt" }); + SUCCEED(); +} + +TEST_F(DBusTest, TextIndexDBusProcessFileMoves_NonEmpty) +{ + TextIndexDBus dbus; + QHash moves; + moves["/old/path.txt"] = "/new/path.txt"; + bool result = dbus.ProcessFileMoves(moves); + SUCCEED(); +} + +TEST_F(DBusTest, TextIndexDBusIndexDatabaseExists_VersionMismatch) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { { "version", 99999 } }); + + TextIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +// ---- Additional OcrIndexDBus coverage ---- + +TEST_F(DBusTest, OcrIndexDBusCreateIndexTaskWithPaths) +{ + OcrIndexDBus dbus; + QVariantMap opts; + opts["silent"] = true; + bool result = dbus.CreateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + SUCCEED(); +} + +TEST_F(DBusTest, OcrIndexDBusUpdateIndexTaskWithPaths) +{ + OcrIndexDBus dbus; + QVariantMap opts; + bool result = dbus.UpdateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + SUCCEED(); +} + +TEST_F(DBusTest, OcrIndexDBusProcessFileChanges_OnlyDeleted) +{ + OcrIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + {}, + {}, + { "/fake/deleted/img.png" }); + SUCCEED(); +} + +TEST_F(DBusTest, OcrIndexDBusProcessFileChanges_OnlyCreated) +{ + OcrIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + { "/fake/created/img.png" }, + {}, + {}); + SUCCEED(); +} + +TEST_F(DBusTest, OcrIndexDBusProcessFileChanges_OnlyModified) +{ + OcrIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + {}, + { "/fake/modified/img.png" }, + {}); + SUCCEED(); +} + +TEST_F(DBusTest, OcrIndexDBusProcessFileChanges_AllThree) +{ + OcrIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + { "/fake/created.png" }, + { "/fake/modified.png" }, + { "/fake/deleted.png" }); + SUCCEED(); +} + +TEST_F(DBusTest, OcrIndexDBusProcessFileMoves_NonEmpty) +{ + OcrIndexDBus dbus; + QHash moves; + moves["/old/img.png"] = "/new/img.png"; + bool result = dbus.ProcessFileMoves(moves); + SUCCEED(); +} + +TEST_F(DBusTest, OcrIndexDBusIndexDatabaseExists_VersionMismatch) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", 99999 } }); + + OcrIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +TEST_F(DBusTest, OcrIndexDBusUpdateIndexTaskWithNonSilent) +{ + OcrIndexDBus dbus; + QVariantMap opts; + opts["silent"] = false; + bool result = dbus.UpdateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + SUCCEED(); +} diff --git a/autotests/index/test_docutils.cpp b/autotests/index/test_docutils.cpp new file mode 100644 index 00000000..4f2da36e --- /dev/null +++ b/autotests/index/test_docutils.cpp @@ -0,0 +1,268 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_docutils.cpp + * @brief Unit tests for DocUtils (utils/docutils.cpp). + * Tests copyFieldsExcept with various document configurations. + */ + +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "utils/docutils.h" + +#include +#include +#include +#include + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace Lucene; + +class DocUtilsTest : public testing::Test +{ +protected: + void SetUp() override + { + doc = newLucene(); + } + + DocumentPtr doc; +}; + +TEST_F(DocUtilsTest, CopyFieldsExcept_NullDoc_ReturnsNull) +{ + auto result = DocUtils::copyFieldsExcept(DocumentPtr(), { L"field1" }); + EXPECT_EQ(result, nullptr); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_EmptyDocument) +{ + auto result = DocUtils::copyFieldsExcept(doc, { L"nonexistent" }); + ASSERT_NE(result, nullptr); + // Empty doc copied, should have no fields + EXPECT_EQ(result->getFields().size(), 0); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_SingleField_NoExclusion) +{ + doc->add(newLucene(L"name", L"value", Field::STORE_YES, Field::INDEX_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_SingleField_ExactExclusion) +{ + doc->add(newLucene(L"name", L"value", Field::STORE_YES, Field::INDEX_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, { L"name" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 0); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_SingleField_DifferentExclusion) +{ + doc->add(newLucene(L"name", L"value", Field::STORE_YES, Field::INDEX_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, { L"other" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_MultipleFields_PartialExclusion) +{ + doc->add(newLucene(L"path", L"/home/user/file.txt", Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(L"content", L"hello world", Field::STORE_YES, Field::INDEX_ANALYZED)); + doc->add(newLucene(L"filename", L"file.txt", Field::STORE_YES, Field::INDEX_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, { L"path" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + // Should have content and filename, but not path + EXPECT_EQ(fields.size(), 2); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_MultipleExcludedFields) +{ + doc->add(newLucene(L"path", L"/home/user/file.txt", Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(L"ancestor_paths", L"/home/user", Field::STORE_NO, Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(L"content", L"hello world", Field::STORE_YES, Field::INDEX_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, { L"path", L"ancestor_paths" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_WithNumericField_NotExcluded) +{ + doc->add(newLucene(L"path", L"/file.txt", Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + NumericFieldPtr numField = newLucene(L"modify_time", Field::STORE_YES, true); + numField->setLongValue(1700000000); + doc->add(numField); + + auto result = DocUtils::copyFieldsExcept(doc, { L"path" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_WithNumericField_Excluded) +{ + NumericFieldPtr numField = newLucene(L"modify_time", Field::STORE_YES, true); + numField->setLongValue(1700000000); + doc->add(numField); + + auto result = DocUtils::copyFieldsExcept(doc, { L"modify_time" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 0); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_MixedFieldTypes) +{ + doc->add(newLucene(L"path", L"/file.txt", Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(L"ancestor_paths", L"/home", Field::STORE_NO, Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(L"content", L"text content", Field::STORE_YES, Field::INDEX_ANALYZED)); + doc->add(newLucene(L"filename", L"file.txt", Field::STORE_YES, Field::INDEX_ANALYZED)); + + NumericFieldPtr numField1 = newLucene(L"modify_time", Field::STORE_YES, true); + numField1->setLongValue(1700000000); + doc->add(numField1); + + NumericFieldPtr numField2 = newLucene(L"birth_time", Field::STORE_YES, true); + numField2->setLongValue(1600000000); + doc->add(numField2); + + NumericFieldPtr numField3 = newLucene(L"file_size", Field::STORE_YES, true); + numField3->setLongValue(1024); + doc->add(numField3); + + // Exclude path and ancestor_paths + auto result = DocUtils::copyFieldsExcept(doc, { L"path", L"ancestor_paths" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + // Should have content, filename, modify_time, birth_time, file_size = 5 + EXPECT_EQ(fields.size(), 5); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_NumericFieldLargeValue) +{ + NumericFieldPtr numField = newLucene(L"big_num", Field::STORE_YES, true); + numField->setLongValue(LLONG_MAX); + doc->add(numField); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_NumericFieldZeroValue) +{ + NumericFieldPtr numField = newLucene(L"zero_num", Field::STORE_YES, true); + numField->setLongValue(0); + doc->add(numField); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_FieldNotStored) +{ + doc->add(newLucene(L"content", L"text", Field::STORE_NO, Field::INDEX_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_FieldNotIndexed) +{ + doc->add(newLucene(L"data", L"raw data", Field::STORE_YES, Field::INDEX_NO)); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_NumericFieldNotStored) +{ + NumericFieldPtr numField = newLucene(L"num_no_store", Field::STORE_NO, true); + numField->setLongValue(42); + doc->add(numField); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_NumericFieldNotIndexed) +{ + NumericFieldPtr numField = newLucene(L"num_no_idx", Field::STORE_YES, false); + numField->setLongValue(42); + doc->add(numField); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_ManyFieldsManyExclusions) +{ + for (int i = 0; i < 10; i++) { + QString fieldName = QString("field_%1").arg(i); + doc->add(newLucene(fieldName.toStdWString(), L"value", Field::STORE_YES, Field::INDEX_ANALYZED)); + } + + // Exclude odd-numbered fields + auto result = DocUtils::copyFieldsExcept(doc, { L"field_1", L"field_3", L"field_5", L"field_7", L"field_9" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 5); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_ExcludeNonExistentField) +{ + doc->add(newLucene(L"real_field", L"value", Field::STORE_YES, Field::INDEX_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, { L"fake_field" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_AllFieldsExcluded) +{ + doc->add(newLucene(L"field1", L"v1", Field::STORE_YES, Field::INDEX_ANALYZED)); + doc->add(newLucene(L"field2", L"v2", Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, { L"field1", L"field2" }); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 0); +} + +TEST_F(DocUtilsTest, CopyFieldsExcept_NotAnalyzedFieldCopiedCorrectly) +{ + doc->add(newLucene(L"exact", L"exact_value", Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + auto result = DocUtils::copyFieldsExcept(doc, {}); + ASSERT_NE(result, nullptr); + auto fields = result->getFields(); + EXPECT_EQ(fields.size(), 1); +} diff --git a/autotests/index/test_envdetector.cpp b/autotests/index/test_envdetector.cpp new file mode 100644 index 00000000..fe9a9576 --- /dev/null +++ b/autotests/index/test_envdetector.cpp @@ -0,0 +1,259 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_envdetector.cpp + * @brief Unit tests for EnvDetector, PowerMonitor, and EnvState + */ + +#include +#include +#include + +#include "stubext.h" + +#include "index_global.h" +#include "env/envdetector.h" +#include "env/powermonitor.h" +#include "env/idlemonitor.h" +#include "env/loadmonitor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +// ---- EnvState tests ---- + +TEST(EnvStateTest, DefaultValues) +{ + EnvState state; + EXPECT_FALSE(state.onBattery); + EXPECT_FALSE(state.powerSaveMode); + EXPECT_FALSE(state.idle); +} + +TEST(EnvStateTest, IsPowerOk) +{ + EnvState state; + EXPECT_TRUE(state.isPowerOk()); + state.onBattery = true; + EXPECT_FALSE(state.isPowerOk()); +} + +TEST(EnvStateTest, IsPowerSaveOff) +{ + EnvState state; + EXPECT_TRUE(state.isPowerSaveOff()); + state.powerSaveMode = true; + EXPECT_FALSE(state.isPowerSaveOff()); +} + +TEST(EnvStateTest, IsIdleOk) +{ + EnvState state; + EXPECT_FALSE(state.isIdleOk()); + state.idle = true; + EXPECT_TRUE(state.isIdleOk()); +} + +// ---- PowerMonitor tests ---- + +class PowerMonitorTest : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + } + + std::unique_ptr app; + static int argc; + static char *argv[]; +}; + +int PowerMonitorTest::argc = 1; +char *PowerMonitorTest::argv[] = { const_cast("test_powermonitor") }; + +TEST_F(PowerMonitorTest, CtorDefaultValues) +{ + PowerMonitor pm; + EXPECT_FALSE(pm.onBattery()); + EXPECT_FALSE(pm.powerSaveMode()); +} + +TEST_F(PowerMonitorTest, StartStop_NoCrash) +{ + PowerMonitor pm; + pm.start(); + pm.stop(); + SUCCEED(); +} + +TEST_F(PowerMonitorTest, StartTwice) +{ + PowerMonitor pm; + pm.start(); + pm.start(); + pm.stop(); + SUCCEED(); +} + +TEST_F(PowerMonitorTest, StopTwice) +{ + PowerMonitor pm; + pm.stop(); + pm.stop(); + SUCCEED(); +} + +TEST_F(PowerMonitorTest, OnBatteryChanged_EnterBattery) +{ + PowerMonitor pm; + QSignalSpy spy(&pm, &PowerMonitor::effectivePowerChanged); + + pm.onBatteryChanged(true); + // Battery entry is delayed by 500ms timer, so no signal yet + // But pending state should be set + EXPECT_EQ(spy.count(), 0); +} + +TEST_F(PowerMonitorTest, OnBatteryChanged_NoChange) +{ + PowerMonitor pm; + pm.m_pendingOnBattery = true; + + QSignalSpy spy(&pm, &PowerMonitor::effectivePowerChanged); + pm.onBatteryChanged(true); + EXPECT_EQ(spy.count(), 0); // same value, no emit +} + +TEST_F(PowerMonitorTest, OnBatteryChanged_ExitBattery) +{ + PowerMonitor pm; + pm.m_onBattery = true; + pm.m_pendingOnBattery = true; + + QSignalSpy spy(&pm, &PowerMonitor::effectivePowerChanged); + pm.onBatteryChanged(false); + // Exiting battery is immediate (timer stopped, direct assignment) + EXPECT_EQ(spy.count(), 1); + EXPECT_FALSE(pm.onBattery()); + EXPECT_FALSE(spy.at(0).at(0).toBool()); +} + +TEST_F(PowerMonitorTest, OnModeChanged_EnterPowerSave) +{ + PowerMonitor pm; + QSignalSpy spy(&pm, &PowerMonitor::effectivePowerChanged); + pm.onModeChanged("powersave"); + // Entry is delayed by 500ms + EXPECT_EQ(spy.count(), 0); +} + +TEST_F(PowerMonitorTest, OnModeChanged_NoChange) +{ + PowerMonitor pm; + pm.m_pendingPowerSave = true; + pm.onModeChanged("powersave"); + SUCCEED(); +} + +TEST_F(PowerMonitorTest, OnModeChanged_ExitPowerSave) +{ + PowerMonitor pm; + pm.m_powerSave = true; + pm.m_pendingPowerSave = true; + + QSignalSpy spy(&pm, &PowerMonitor::effectivePowerChanged); + pm.onModeChanged("performance"); + // Exit is delayed by 500ms + EXPECT_EQ(spy.count(), 0); +} + +TEST_F(PowerMonitorTest, OnPropertiesChanged_Battery) +{ + PowerMonitor pm; + QSignalSpy spy(&pm, &PowerMonitor::effectivePowerChanged); + QVariantMap changed; + changed["OnBattery"] = true; + pm.onPropertiesChanged("org.freedesktop.DBus.Properties", changed, {}); + SUCCEED(); +} + +TEST_F(PowerMonitorTest, OnPropertiesChanged_Mode) +{ + PowerMonitor pm; + QVariantMap changed; + changed["Mode"] = "powersave"; + pm.onPropertiesChanged("org.freedesktop.DBus.Properties", changed, {}); + SUCCEED(); +} + +TEST_F(PowerMonitorTest, OnPropertiesChanged_Unrelated) +{ + PowerMonitor pm; + QVariantMap changed; + changed["SomeOtherProperty"] = 42; + pm.onPropertiesChanged("org.freedesktop.DBus.Properties", changed, {}); + // No battery/mode change -> no action + SUCCEED(); +} + +// ---- EnvDetector tests ---- + +class EnvDetectorTest : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + } + + std::unique_ptr app; + static int argc; + static char *argv[]; +}; + +int EnvDetectorTest::argc = 1; +char *EnvDetectorTest::argv[] = { const_cast("test_envdetector") }; + +TEST_F(EnvDetectorTest, CtorDefaultState) +{ + EnvDetector detector; + EnvState state = detector.currentState(); + EXPECT_FALSE(state.onBattery); + EXPECT_FALSE(state.powerSaveMode); +} + +TEST_F(EnvDetectorTest, StartStop) +{ + EnvDetector detector; + detector.start(); + detector.stop(); + SUCCEED(); +} + +TEST_F(EnvDetectorTest, StartTwice) +{ + EnvDetector detector; + detector.start(); + detector.start(); + detector.stop(); + SUCCEED(); +} + +TEST_F(EnvDetectorTest, StopTwice) +{ + EnvDetector detector; + detector.stop(); + detector.stop(); + SUCCEED(); +} + +TEST_F(EnvDetectorTest, SetDataPath) +{ + EnvDetector detector; + detector.setDataPath("/tmp"); + SUCCEED(); +} \ No newline at end of file diff --git a/autotests/index/test_filehash.cpp b/autotests/index/test_filehash.cpp new file mode 100644 index 00000000..ea5c5299 --- /dev/null +++ b/autotests/index/test_filehash.cpp @@ -0,0 +1,122 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_filehash.cpp + * @brief Unit tests for FileHash (utils/filehash.cpp) + */ + +#include +#include +#include + +#include // geteuid + +#include "dfm_test_main.h" +#include "index_global.h" +#include "utils/filehash.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class FileHashTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + } +}; + +TEST_F(FileHashTest, ComputeMd5_ExistingFile) +{ + QString filePath = tmp.path() + "/test.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("hello world"); + f.close(); + + QString hash = FileHash::computeMd5(filePath); + EXPECT_EQ(hash.length(), 32); + // Known MD5 for "hello world" + EXPECT_EQ(hash, QString("5eb63bbbe01eeed093cb22bb8f5acdc3")); +} + +TEST_F(FileHashTest, ComputeMd5_EmptyFile) +{ + QString filePath = tmp.path() + "/empty.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.close(); + + QString hash = FileHash::computeMd5(filePath); + EXPECT_EQ(hash.length(), 32); + // MD5 of empty string + EXPECT_EQ(hash, QString("d41d8cd98f00b204e9800998ecf8427e")); +} + +TEST_F(FileHashTest, ComputeMd5_NonExistentFile) +{ + QString hash = FileHash::computeMd5("/nonexistent/file.txt"); + EXPECT_TRUE(hash.isEmpty()); +} + +TEST_F(FileHashTest, ComputeMd5_DirectoryPath) +{ + // Directories can be opened but read may behave differently + QString hash = FileHash::computeMd5(tmp.path()); + // May or may not return empty depending on platform + SUCCEED(); +} + +TEST_F(FileHashTest, ComputeMd5_BinaryFile) +{ + QString filePath = tmp.path() + "/binary.bin"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + QByteArray data(4096, '\0'); + for (int i = 0; i < data.size(); i++) + data[i] = static_cast(i % 256); + f.write(data); + f.close(); + + QString hash = FileHash::computeMd5(filePath); + EXPECT_EQ(hash.length(), 32); +} + +TEST_F(FileHashTest, ComputeMd5_LargeFile) +{ + QString filePath = tmp.path() + "/large.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + // Write 1MB of data + QByteArray data(1024 * 1024, 'A'); + f.write(data); + f.close(); + + QString hash = FileHash::computeMd5(filePath); + EXPECT_EQ(hash.length(), 32); +} + +TEST_F(FileHashTest, ComputeMd5_UnreadableFile) +{ + // Under root (e.g. fakeroot package builds) permission bits do not make + // a file unreadable, so the premise of this test does not hold there. + if (geteuid() == 0) { + GTEST_SKIP() << "running as root: read-permission denial is ineffective"; + } + + QString filePath = tmp.path() + "/unreadable.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("secret"); + f.close(); + // Make file unreadable + QFile::setPermissions(filePath, QFile::WriteOwner | QFile::ExeOwner); + + QString hash = FileHash::computeMd5(filePath); + // Should fail to open -> empty + EXPECT_TRUE(hash.isEmpty()); +} \ No newline at end of file diff --git a/autotests/index/test_filenamedocumentbuilder.cpp b/autotests/index/test_filenamedocumentbuilder.cpp new file mode 100644 index 00000000..7d706b5b --- /dev/null +++ b/autotests/index/test_filenamedocumentbuilder.cpp @@ -0,0 +1,333 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_filenamedocumentbuilder.cpp + * @brief Unit tests for FileNameDocumentBuilder (document/filenamedocumentbuilder.cpp) + * Verifies field completeness against the anything schema: file_name (lowercased), + * file_name_lower (stored, not-analyzed), full_path (key), file_type, file_ext, + * birth/modify/file_size (NumericField), file_size_str (glib format), pinyin/ + * pinyin_acronym, is_hidden (Y/N), ancestor_paths (multi-value incl. "/"). + * + * PinyinProcessor is reloaded with a small temp dict so Chinese filename conversion + * is deterministic; FileTypeMapper returns "other"/"dir" when no dconfig is available. + * + * Field verification uses Document::get(name) (returns the stored string value) and + * Document::getFields(name) (returns the list of matching fields, for multi-value + * fields and presence checks on numeric fields whose stringValue is empty). + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "document/filenamedocumentbuilder.h" +#include "utils/pinyinprocessor.h" + +#include + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; +using namespace Lucene; +using namespace DFMSEARCH::LuceneFieldNames; + +namespace { + +// Convenience: get the string value of a stored field by name. +// Returns QString() if the field is absent or has no stored string value (e.g. numeric). +QString fieldValue(const DocumentPtr &doc, const QString &name) +{ + return QString::fromStdWString(doc->get(name.toStdWString())); +} + +// Count how many fields with the given name exist (for multi-value / numeric fields). +int fieldCount(const DocumentPtr &doc, const QString &name) +{ + return doc->getFields(name.toStdWString()).size(); +} + +// Reload the pinyin singleton with a minimal dict (文/件/名) so Chinese filenames +// produce deterministic pinyin in document-builder tests. +void loadMiniPinyinDict() +{ + QTemporaryFile f; + ASSERT_TRUE(f.open()); + QTextStream s(&f); + s << "U+6587: wen # 文\n"; + s << "U+4EF6: jian # 件\n"; + s << "U+540D: ming # 名\n"; + s.flush(); + f.close(); + ASSERT_TRUE(PinyinProcessor::instance().loadDictionary(f.fileName())); +} + +} // namespace + +class FileNameDocumentBuilderTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + FileNameDocumentBuilder builder; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + loadMiniPinyinDict(); + } + + void createFile(const QString &relPath, const QString &content = "x") + { + QFile f(tmp.path() + "/" + relPath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } +}; + +// --- Basic construction --- + +TEST_F(FileNameDocumentBuilderTest, BuildRegularFile_ReturnsNonNullDoc) +{ + createFile("readme.txt"); + auto doc = builder.build(tmp.path() + "/readme.txt", {}); + ASSERT_NE(doc, nullptr); +} + +TEST_F(FileNameDocumentBuilderTest, BuildNonExistentFile_ReturnsNonNullDoc) +{ + auto doc = builder.build(tmp.path() + "/nonexistent.txt", {}); + ASSERT_NE(doc, nullptr); // QFileInfo on missing file yields defaults +} + +// --- file_name / file_name_lower --- + +TEST_F(FileNameDocumentBuilderTest, FileName_IsLowercased) +{ + createFile("ReadMe.TXT"); + auto doc = builder.build(tmp.path() + "/ReadMe.TXT", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kFileName)), QString("readme.txt")); +} + +TEST_F(FileNameDocumentBuilderTest, FileNameLower_IsLowercased) +{ + createFile("MyFile.PDF"); + auto doc = builder.build(tmp.path() + "/MyFile.PDF", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kFileNameLower)), QString("myfile.pdf")); +} + +// --- full_path --- + +TEST_F(FileNameDocumentBuilderTest, FullPath_ContainsExactFilePath) +{ + createFile("report.doc"); + QString abs = tmp.path() + "/report.doc"; + auto doc = builder.build(abs, {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kFullPath)), abs); +} + +// --- file_ext --- + +TEST_F(FileNameDocumentBuilderTest, FileExt_IsLowercaseWithoutDot) +{ + createFile("archive.ZIP"); + auto doc = builder.build(tmp.path() + "/archive.ZIP", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kFileExt)), QString("zip")); +} + +TEST_F(FileNameDocumentBuilderTest, FileExt_AbsentWhenNoExtension) +{ + createFile("noext"); + auto doc = builder.build(tmp.path() + "/noext", {}); + ASSERT_NE(doc, nullptr); + // No extension → file_ext field should not be present + EXPECT_TRUE(fieldValue(doc, QString::fromWCharArray(FileName::kFileExt)).isEmpty()); +} + +// --- file_type --- + +TEST_F(FileNameDocumentBuilderTest, FileType_DirectoryIsDir) +{ + auto doc = builder.build(tmp.path(), {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kFileType)), QString("dir")); +} + +TEST_F(FileNameDocumentBuilderTest, FileType_RegularFileIsOtherWithoutDConfig) +{ + createFile("data.bin"); + auto doc = builder.build(tmp.path() + "/data.bin", {}); + ASSERT_NE(doc, nullptr); + // Without a real dconfig, unknown extension → "other" + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kFileType)), QString("other")); +} + +// --- is_hidden --- + +TEST_F(FileNameDocumentBuilderTest, IsHidden_NonHiddenFileIsN) +{ + createFile("visible.txt"); + auto doc = builder.build(tmp.path() + "/visible.txt", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kIsHidden)), QString("N")); +} + +TEST_F(FileNameDocumentBuilderTest, IsHidden_HiddenFileIsY) +{ + createFile(".secret.txt"); + auto doc = builder.build(tmp.path() + "/.secret.txt", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kIsHidden)), QString("Y")); +} + +TEST_F(FileNameDocumentBuilderTest, IsHidden_FileInHiddenDirectoryIsY) +{ + QDir d(tmp.path()); + ASSERT_TRUE(d.mkpath(".hiddenDir")); + createFile(".hiddenDir/note.txt"); + auto doc = builder.build(tmp.path() + "/.hiddenDir/note.txt", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kIsHidden)), QString("Y")); +} + +// --- ancestor_paths --- + +TEST_F(FileNameDocumentBuilderTest, AncestorPaths_MultiValueInclusiveOfRoot) +{ + QDir d(tmp.path()); + ASSERT_TRUE(d.mkpath("sub")); + createFile("sub/file.txt"); + QString abs = tmp.path() + "/sub/file.txt"; + auto doc = builder.build(abs, {}); + ASSERT_NE(doc, nullptr); + // At least the parent dir and root "/" should be present (anything adds "/" too) + EXPECT_GE(fieldCount(doc, QString::fromWCharArray(FileName::kAncestorPaths)), 2); +} + +TEST_F(FileNameDocumentBuilderTest, AncestorPaths_FileInRootDepthOne) +{ + createFile("root.txt"); + QString abs = tmp.path() + "/root.txt"; + auto doc = builder.build(abs, {}); + ASSERT_NE(doc, nullptr); + EXPECT_GE(fieldCount(doc, QString::fromWCharArray(FileName::kAncestorPaths)), 1); +} + +// --- pinyin / pinyin_acronym --- + +TEST_F(FileNameDocumentBuilderTest, Pinyin_ChineseFilename_ProducedFromDict) +{ + // 文件名.txt → pinyin "wenjianming.txt" / acronym "wjm.txt" + // (.txt is non-dict chars, passed through — matching anything behavior) + createFile("文件名.txt"); + auto doc = builder.build(tmp.path() + "/文件名.txt", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kPinyin)), QString("wenjianming.txt")); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kPinyinAcronym)), QString("wjm.txt")); +} + +TEST_F(FileNameDocumentBuilderTest, Pinyin_PureChineseFilename_OnlyPinyin) +{ + // 文件名 (no extension) → pure pinyin "wenjianming" / "wjm" + QDir d(tmp.path()); + QFile f(tmp.path() + "/文件名"); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("x"); + f.close(); + auto doc = builder.build(tmp.path() + "/文件名", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kPinyin)), QString("wenjianming")); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kPinyinAcronym)), QString("wjm")); +} + +TEST_F(FileNameDocumentBuilderTest, Pinyin_NonChineseFilename_PassedThroughLowercased) +{ + // Pure ASCII filename: pinyin field equals the lowercased filename (non-dict passthrough) + createFile("ReadMe.TXT"); + auto doc = builder.build(tmp.path() + "/ReadMe.TXT", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kPinyin)), QString("readme.txt")); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kPinyinAcronym)), QString("readme.txt")); +} + +// --- file_size / file_size_str --- + +TEST_F(FileNameDocumentBuilderTest, FileSize_NumericFieldPresent) +{ + createFile("sized.bin", "12345678"); + auto doc = builder.build(tmp.path() + "/sized.bin", {}); + ASSERT_NE(doc, nullptr); + // file_size is a NumericField — get() returns empty string, but the field is present. + EXPECT_GE(fieldCount(doc, QString::fromWCharArray(FileName::kFileSize)), 1); +} + +TEST_F(FileNameDocumentBuilderTest, FileSizeStr_FormattedHumanReadable) +{ + createFile("sized.bin", "12345678"); // ~12 MB after 1000-based formatting + auto doc = builder.build(tmp.path() + "/sized.bin", {}); + ASSERT_NE(doc, nullptr); + QString sizeStr = fieldValue(doc, QString::fromWCharArray(FileName::kFileSizeStr)); + EXPECT_FALSE(sizeStr.isEmpty()); + // g_format_size produces localized strings; verify non-empty & contains a digit + bool hasDigit = false; + for (const QChar &c : sizeStr) { + if (c.isDigit()) { hasDigit = true; break; } + } + EXPECT_TRUE(hasDigit); +} + +// --- timestamp fields --- + +TEST_F(FileNameDocumentBuilderTest, BirthAndModifyTime_NumericFieldsPresent) +{ + createFile("timed.txt"); + auto doc = builder.build(tmp.path() + "/timed.txt", {}); + ASSERT_NE(doc, nullptr); + EXPECT_GE(fieldCount(doc, QString::fromWCharArray(FileName::kBirthTime)), 1); + EXPECT_GE(fieldCount(doc, QString::fromWCharArray(FileName::kModifyTime)), 1); +} + +// --- builder options / text argument are ignored (filename has no content) --- + +TEST_F(FileNameDocumentBuilderTest, Build_IgnoresTextArgument) +{ + createFile("a.txt"); + auto doc1 = builder.build(tmp.path() + "/a.txt", QString()); + auto doc2 = builder.build(tmp.path() + "/a.txt", QStringLiteral("ignored content")); + ASSERT_NE(doc1, nullptr); + ASSERT_NE(doc2, nullptr); + // file_name field should be identical regardless of text arg + EXPECT_EQ(fieldValue(doc1, QString::fromWCharArray(FileName::kFileName)), + fieldValue(doc2, QString::fromWCharArray(FileName::kFileName))); +} + +// --- unicode path --- + +TEST_F(FileNameDocumentBuilderTest, Build_UnicodePathNoCrash) +{ + QDir d(tmp.path()); + ASSERT_TRUE(d.mkpath("中文目录")); + QFile f(tmp.path() + "/中文目录/文件.txt"); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("x"); + f.close(); + + auto doc = builder.build(tmp.path() + "/中文目录/文件.txt", {}); + ASSERT_NE(doc, nullptr); + EXPECT_EQ(fieldValue(doc, QString::fromWCharArray(FileName::kFileName)), QString("文件.txt")); +} diff --git a/autotests/index/test_filenameindexdbus.cpp b/autotests/index/test_filenameindexdbus.cpp new file mode 100644 index 00000000..4cb851a0 --- /dev/null +++ b/autotests/index/test_filenameindexdbus.cpp @@ -0,0 +1,305 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_filenameindexdbus.cpp + * @brief Unit tests for FileNameIndexDBus (filenameindexdbus.cpp) + * — constructs the DBus object (which creates a filename-profile IndexRuntime + * internally) and exercises the public slot API. DBus registration on the + * session bus fails gracefully in the sandbox, so the object still works. + * + * Global::fileNameIndexDirectory / availability / scope functions are stubbed to + * point at a QTemporaryDir so the test is fully host-isolated. + * + * Covers (design 9.1): DBus construction, IsEnabled/SetEnabled, StopCurrentTask, + * HasRunningTask, IndexDatabaseExists (version/lastUpdateTime checks), GetLastUpdateTime, + * ProcessFileChanges/ProcessFileMoves, GetIndexStatus, ForceUpdateIndex, cleanup. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "dbus/filenameindexdbus.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +namespace { + +void writeStatusJson(const QString &indexDir, const QJsonObject &obj) +{ + QDir().mkpath(indexDir); + QFile f(indexDir + QLatin1String("/index_status.json")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly | QIODevice::Truncate)); + f.write(QJsonDocument(obj).toJson()); + f.close(); +} + +} // namespace + +class FileNameIndexDBusTest : public testing::Test +{ +protected: + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + // Redirect filename-index directory to the temp dir. + stub.set_lamda(ADDR(Global, fileNameIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/filename-index"; + }); + stub.set_lamda(ADDR(Global, isFileNameIndexDirectoryAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInFileNameIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + + // Also stub content/ocr dirs so the filename blacklistProvider (which + // includes them) resolves to deterministic temp paths, not $HOME. + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/content-index"; + }); + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/ocr-index"; + }); + + // Prevent handleSilentStart() from scanning real system directories. + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() + "/indexed-dir" }; + }); + + // Prevent reading real system blacklist paths from DConfig. + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + + // isFileNameIndexReadyForSearch stubbed to false so FSMonitorWorker fast-scan + // does not attempt a real index query. + stub.set_lamda(ADDR(Global, isFileNameIndexReadyForSearch), + []() -> bool { + __DBG_STUB_INVOKE__ + return false; + }); + } + + QTemporaryDir tmp; + stub_ext::StubExt stub; +}; + +// --- Construction / destruction --- + +TEST_F(FileNameIndexDBusTest, ConstructAndDestruct) +{ + { + FileNameIndexDBus dbus; + SUCCEED(); + } +} + +TEST_F(FileNameIndexDBusTest, CleanupOnFreshInstance) +{ + FileNameIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.cleanup(); }); +} + +// --- IsEnabled / SetEnabled --- + +TEST_F(FileNameIndexDBusTest, IsEnabled_ReturnsBool) +{ + FileNameIndexDBus dbus; + bool enabled = false; + EXPECT_NO_FATAL_FAILURE({ enabled = dbus.IsEnabled(); }); + (void)enabled; +} + +TEST_F(FileNameIndexDBusTest, SetEnabled_DoesNotCrash) +{ + FileNameIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.SetEnabled(false); }); + EXPECT_NO_FATAL_FAILURE({ dbus.SetEnabled(true); }); +} + +// --- StopCurrentTask / HasRunningTask --- + +TEST_F(FileNameIndexDBusTest, StopCurrentTask_NoTask_ReturnsFalse) +{ + FileNameIndexDBus dbus; + EXPECT_FALSE(dbus.StopCurrentTask()); +} + +TEST_F(FileNameIndexDBusTest, HasRunningTask_NoTask_ReturnsFalse) +{ + FileNameIndexDBus dbus; + EXPECT_FALSE(dbus.HasRunningTask()); +} + +// --- IndexDatabaseExists --- + +TEST_F(FileNameIndexDBusTest, IndexDatabaseExists_NoStatusFile_ReturnsFalse) +{ + FileNameIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +TEST_F(FileNameIndexDBusTest, IndexDatabaseExists_VersionMismatch_ReturnsFalse) +{ + const QString indexDir = tmp.path() + "/filename-index"; + writeStatusJson(indexDir, { { "version", 999 }, + { "lastUpdateTime", "2026-01-01T00:00:00" } }); + FileNameIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +TEST_F(FileNameIndexDBusTest, IndexDatabaseExists_MissingLastUpdateTime_ReturnsFalse) +{ + const QString indexDir = tmp.path() + "/filename-index"; + // version matches kFilenameIndexVersion (1) but lastUpdateTime empty + writeStatusJson(indexDir, { { "version", Defines::kFilenameIndexVersion } }); + FileNameIndexDBus dbus; + EXPECT_FALSE(dbus.IndexDatabaseExists()); +} + +TEST_F(FileNameIndexDBusTest, IndexDatabaseExists_ValidStatus_ReturnsTrue) +{ + const QString indexDir = tmp.path() + "/filename-index"; + writeStatusJson(indexDir, { { "version", Defines::kFilenameIndexVersion }, + { "lastUpdateTime", "2026-01-01T00:00:00" }, + { "state", "clean" } }); + FileNameIndexDBus dbus; + EXPECT_TRUE(dbus.IndexDatabaseExists()); +} + +// --- GetLastUpdateTime --- + +TEST_F(FileNameIndexDBusTest, GetLastUpdateTime_NoStatusFile_ReturnsEmpty) +{ + FileNameIndexDBus dbus; + EXPECT_TRUE(dbus.GetLastUpdateTime().isEmpty()); +} + +TEST_F(FileNameIndexDBusTest, GetLastUpdateTime_WithStatus_ReturnsTime) +{ + const QString indexDir = tmp.path() + "/filename-index"; + writeStatusJson(indexDir, { { "lastUpdateTime", "2026-01-01T00:00:00" } }); + FileNameIndexDBus dbus; + QString t = dbus.GetLastUpdateTime(); + EXPECT_FALSE(t.isEmpty()); +} + +// --- ProcessFileChanges / ProcessFileMoves --- + +TEST_F(FileNameIndexDBusTest, ProcessFileChanges_AllEmpty_NoTasksQueued) +{ + FileNameIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.ProcessFileChanges({}, {}, {}); }); +} + +TEST_F(FileNameIndexDBusTest, ProcessFileChanges_WithCreatedFiles) +{ + FileNameIndexDBus dbus; + QStringList created { tmp.path() + "/new1.txt", tmp.path() + "/new2.txt" }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.ProcessFileChanges(created, {}, {}); }); +} + +TEST_F(FileNameIndexDBusTest, ProcessFileChanges_WithModifiedFiles) +{ + FileNameIndexDBus dbus; + QStringList modified { tmp.path() + "/mod1.txt" }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.ProcessFileChanges({}, modified, {}); }); +} + +TEST_F(FileNameIndexDBusTest, ProcessFileChanges_WithDeletedFiles) +{ + FileNameIndexDBus dbus; + QStringList deleted { tmp.path() + "/gone1.txt" }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.ProcessFileChanges({}, {}, deleted); }); +} + +TEST_F(FileNameIndexDBusTest, ProcessFileMoves_EmptyMap_ReturnsFalse) +{ + FileNameIndexDBus dbus; + QHash empty; + EXPECT_FALSE(dbus.ProcessFileMoves(empty)); +} + +TEST_F(FileNameIndexDBusTest, ProcessFileMoves_WithMoves) +{ + FileNameIndexDBus dbus; + QHash moves { { tmp.path() + "/old.txt", tmp.path() + "/new.txt" } }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.ProcessFileMoves(moves); }); +} + +// --- GetIndexStatus --- + +TEST_F(FileNameIndexDBusTest, GetIndexStatus_ReturnsNonEmptyMap) +{ + FileNameIndexDBus dbus; + QVariantMap status = dbus.GetIndexStatus(); + EXPECT_FALSE(status.isEmpty()); + EXPECT_TRUE(status.contains("state")); + EXPECT_TRUE(status.contains("grade")); +} + +// --- CreateIndexTask / UpdateIndexTask --- + +TEST_F(FileNameIndexDBusTest, CreateIndexTask_WithPaths) +{ + FileNameIndexDBus dbus; + QStringList paths { tmp.path() + "/indexed-dir" }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.CreateIndexTask(paths, {}); }); +} + +TEST_F(FileNameIndexDBusTest, UpdateIndexTask_WithPaths) +{ + FileNameIndexDBus dbus; + QStringList paths { tmp.path() + "/indexed-dir" }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.UpdateIndexTask(paths, {}); }); +} + +// --- ForceUpdateIndex --- + +TEST_F(FileNameIndexDBusTest, ForceUpdateIndex_WithManualOption) +{ + FileNameIndexDBus dbus; + QStringList paths { tmp.path() + "/indexed-dir" }; + QVariantMap opts { { "manual", true } }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.ForceUpdateIndex(paths, opts); }); +} + +TEST_F(FileNameIndexDBusTest, ForceUpdateIndex_NonManual) +{ + FileNameIndexDBus dbus; + QStringList paths { tmp.path() + "/indexed-dir" }; + QVariantMap opts { { "manual", false } }; + EXPECT_NO_FATAL_FAILURE({ (void)dbus.ForceUpdateIndex(paths, opts); }); +} diff --git a/autotests/index/test_fileprovider.cpp b/autotests/index/test_fileprovider.cpp new file mode 100644 index 00000000..f337e9f2 --- /dev/null +++ b/autotests/index/test_fileprovider.cpp @@ -0,0 +1,565 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fileprovider.cpp + * @brief Unit tests for the FileProvider hierarchy (task/fileprovider.cpp) + * Covers FileSystemProvider, DirectFileListProvider and + * MixedPathListProvider constructors, traverse() execution (including + * the ScopeGuard cleanup lambdas) and totalCount()/name(). + */ + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "profile/lowercasengramanalyzer.h" +#include "task/fileprovider.h" +#include "utils/taskstate.h" + +#include +#include + +using namespace ANYTHING_INDEX_NAMESPACE; + +class FileProviderTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + IndexProfile makeProfile() + { + return IndexProfile({ IndexProfile::Type::Content, + "fp_test", + "fp_status.json", + "fp_version", + 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + } + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + // Create a small directory tree so traverse() opens real directories. + QDir root(tmp.path()); + ASSERT_TRUE(root.mkpath("subdir")); + QFile f(root.filePath("a.txt")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("hello"); + f.close(); + QFile f2(root.filePath("subdir/note.txt")); + ASSERT_TRUE(f2.open(QIODevice::WriteOnly)); + f2.close(); + } +}; + +TEST_F(FileProviderTest, FileSystemProvider_NameAndTotalCount) +{ + FileSystemProvider p(makeProfile(), tmp.path()); + EXPECT_EQ(p.name(), QString("FileSystemProvider")); + EXPECT_EQ(p.totalCount(), 0); // base default +} + +TEST_F(FileProviderTest, FileSystemProvider_TraverseVisitsTree) +{ + FileSystemProvider p(makeProfile(), tmp.path()); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + // traverse() runs to completion over the temp tree; handler may or may not + // fire depending on extension filtering, but the traversal body (and the + // ScopeGuard cleanup lambda) is exercised either way. + SUCCEED(); +} + +TEST_F(FileProviderTest, FileSystemProvider_TraverseStopsWhenStateStops) +{ + FileSystemProvider p(makeProfile(), tmp.path()); + TaskState state; // not started -> isRunning() false + QStringList visited; + EXPECT_NO_FATAL_FAILURE({ p.traverse(state, [&visited](const QString &) {}); }); +} + +TEST_F(FileProviderTest, DirectFileListProvider_ConstructsAndCounts) +{ + dfmsearch::SearchResultList list; + list.append(dfmsearch::SearchResult(tmp.path() + "/file1.txt")); + list.append(dfmsearch::SearchResult(tmp.path() + "/file2.doc")); + DirectFileListProvider p(list); + EXPECT_EQ(p.name(), QString("DirectFileListProvider")); + EXPECT_EQ(p.totalCount(), 2); +} + +TEST_F(FileProviderTest, DirectFileListProvider_TraverseInvokesHandler) +{ + dfmsearch::SearchResultList list; + list.append(dfmsearch::SearchResult(tmp.path() + "/file1.txt")); + list.append(dfmsearch::SearchResult(tmp.path() + "/file2.doc")); + DirectFileListProvider p(list); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + EXPECT_EQ(visited.size(), 2); +} + +TEST_F(FileProviderTest, DirectFileListProvider_TraverseRespectsStop) +{ + dfmsearch::SearchResultList list; + for (int i = 0; i < 6; ++i) + list.append(dfmsearch::SearchResult(tmp.path() + "/f" + QString::number(i) + ".txt")); + DirectFileListProvider p(list); + TaskState state; + state.start(); + int n = 0; + p.traverse(state, [&n, &state](const QString &) { + n++; + if (n >= 3) + state.stop(); + }); + EXPECT_EQ(n, 3); +} + +TEST_F(FileProviderTest, MixedPathListProvider_NameAndTraverse) +{ + MixedPathListProvider p(makeProfile(), { tmp.path() }); + EXPECT_EQ(p.name(), QString("MixedPathListProvider")); + TaskState state; + state.start(); + EXPECT_NO_FATAL_FAILURE({ p.traverse(state, [](const QString &) {}); }); +} + +TEST_F(FileProviderTest, MixedPathListProvider_TraverseMixedEntries) +{ + QStringList entries { tmp.path() + "/a.txt", tmp.path() + "/subdir", tmp.path() + "/missing" }; + MixedPathListProvider p(makeProfile(), entries); + TaskState state; + state.start(); + QStringList visited; + EXPECT_NO_FATAL_FAILURE({ p.traverse(state, [&visited](const QString &path) { visited.append(path); }); }); +} + +TEST_F(FileProviderTest, MixedPathListProvider_TraverseRespectsStop) +{ + MixedPathListProvider p(makeProfile(), { tmp.path() }); + TaskState state; + // Not started -> isRunning() false + QStringList visited; + EXPECT_NO_FATAL_FAILURE({ p.traverse(state, [&visited](const QString &) {}); }); +} + +TEST_F(FileProviderTest, MixedPathListProvider_TraverseEmptyList) +{ + MixedPathListProvider p(makeProfile(), {}); + TaskState state; + state.start(); + int count = 0; + p.traverse(state, [&count](const QString &) { count++; }); + EXPECT_EQ(count, 0); +} + +TEST_F(FileProviderTest, MixedPathListProvider_TraverseNonExistentPaths) +{ + MixedPathListProvider p(makeProfile(), { "/nonexistent/path1", "/nonexistent/path2" }); + TaskState state; + state.start(); + int count = 0; + EXPECT_NO_FATAL_FAILURE({ p.traverse(state, [&count](const QString &) { count++; }); }); +} + +TEST_F(FileProviderTest, MixedPathListProvider_TraverseFileOnly) +{ + MixedPathListProvider p(makeProfile(), { tmp.path() + "/a.txt" }); + TaskState state; + state.start(); + QStringList visited; + EXPECT_NO_FATAL_FAILURE({ p.traverse(state, [&visited](const QString &path) { visited.append(path); }); }); + // a.txt exists and is a valid candidate file + EXPECT_FALSE(visited.isEmpty()); +} + +TEST_F(FileProviderTest, FileSystemProvider_TraverseNonExistentRoot) +{ + FileSystemProvider p(makeProfile(), "/nonexistent/root/path"); + TaskState state; + state.start(); + QStringList visited; + EXPECT_NO_FATAL_FAILURE({ p.traverse(state, [&visited](const QString &path) { visited.append(path); }); }); + // Root doesn't exist, so nothing should be visited + EXPECT_TRUE(visited.isEmpty()); +} + +TEST_F(FileProviderTest, DirectFileListProvider_TraverseEmptyList) +{ + dfmsearch::SearchResultList list; + DirectFileListProvider p(list); + EXPECT_EQ(p.totalCount(), 0); + TaskState state; + state.start(); + int count = 0; + p.traverse(state, [&count](const QString &) { count++; }); + EXPECT_EQ(count, 0); +} + +TEST_F(FileProviderTest, DirectFileListProvider_TraverseNotStarted) +{ + dfmsearch::SearchResultList list; + list.append(dfmsearch::SearchResult("/some/file.txt")); + DirectFileListProvider p(list); + TaskState state; // not started + int count = 0; + p.traverse(state, [&count](const QString &) { count++; }); + EXPECT_EQ(count, 0); +} + +// =========================================================================== +// Filename profile per-policy traversal (design 5.6 / 5.1.5 / 5.11): +// - Hidden files are indexed (not skipped) when indexHiddenFiles=true +// - Index directories are excluded from traversal (death-loop prevention) +// =========================================================================== + +class FileProviderFilenameTest : public testing::Test +{ +protected: + // Use a directory under $HOME (not /tmp, which IndexTraverseUtils::shouldSkipDirectory + // excludes) so FileSystemProvider traversal actually visits the tree. + QString rootPath; + QSharedPointer tmp; + + IndexProfile makeFilenameProfile(bool excludeHomeHidden = false) + { + // Filename profile: indexHiddenFiles/indexSymlinks=true, custom blacklist + // excludes the index dir (mirrors IndexProfile::filename() policy). + // excludeHomeHidden mirrors IndexProfile::filename()'s secondary policy + // (rootPath acting as the "home"): only FIRST-LEVEL hidden entries under + // rootPath are excluded (their whole subtree is skipped); hidden dirs in + // deeper levels (e.g. subdir/.abc) are still indexed. + IndexProfile::FilterPolicy fp; + fp.indexHiddenFiles = true; + fp.indexSymlinks = true; + if (excludeHomeHidden) { + fp.hiddenIndexExclusion = [this](const QString &hiddenPath) { + if (!hiddenPath.startsWith(rootPath + QLatin1Char('/'))) + return false; + const QString relative = QString(hiddenPath).mid(rootPath.size() + 1); + const int slash = relative.indexOf(QLatin1Char('/')); + const QString firstSegment = slash < 0 ? relative : relative.left(slash); + return firstSegment.startsWith(QLatin1Char('.')); + }; + } + fp.blacklistProvider = [this]() -> QStringList { + return { rootPath + "/index-dir" }; // exclude a fake index directory + }; + IndexProfile::RuntimePolicy rp; + rp.checkEnvPolicy = false; + rp.eventCollectionWindowMs = 300; + rp.recoveryUpdateDelayMs = 30000; + + return IndexProfile({ IndexProfile::Type::Filename, "fp_fn", "fp_fn_status.json", + "fp_fn_ver", 1 }, + { [this]() -> QString { return rootPath; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; }, + {}, {}, {}, + []() -> boost::shared_ptr { + return Lucene::newLucene(1, 2); + } }, + rp, fp); + } + + void SetUp() override + { + // 参考 vfsmonitor 测试：在 $HOME 下用点前缀隐藏目录模板直接创建专属测试目录， + // 由 QTemporaryDir 析构时自动清理，不在主目录残留。 + // （不用 /tmp，IndexTraverseUtils::shouldSkipDirectory 会将其排除； + // 旧实现先 mkpath 外层 dfm_fp_test_* 目录再建临时目录，外层目录无人清理） + QString templatePath = QDir::homePath() + "/.dfm_fp_test_XXXXXX"; + tmp = QSharedPointer::create(templatePath); + ASSERT_TRUE(tmp->isValid()); + rootPath = tmp->path(); + + QDir root(rootPath); + ASSERT_TRUE(root.mkpath("subdir")); + ASSERT_TRUE(root.mkpath("index-dir")); + ASSERT_TRUE(root.mkpath(".hidden-dir")); + // 深层隐藏目录（主目录下非隐藏目录内的隐藏条目）——屏蔽策略不影响它 + ASSERT_TRUE(root.mkpath("subdir/.abc")); + createFile("visible.txt"); + createFile(".hidden.txt"); + createFile("subdir/note.txt"); + createFile(".hidden-dir/inner.txt"); + createFile("subdir/.abc/inner.txt"); + createFile("index-dir/segment_1"); // must be excluded + } + + void createFile(const QString &relPath, const QString &content = "x") + { + QFile f(rootPath + "/" + relPath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } +}; + +TEST_F(FileProviderFilenameTest, FileSystemProvider_TraverseIndexesHiddenFiles) +{ + // Filename profile indexes hidden files (marks is_hidden), so .hidden.txt should + // be visited by traverse — unlike Content/Ocr which skip hidden files. + FileSystemProvider p(makeFilenameProfile(), rootPath); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + bool visitedHiddenFile = false; + for (const QString &v : visited) { + if (v.endsWith(".hidden.txt") || v.contains("/.hidden-dir/")) + visitedHiddenFile = true; + } + EXPECT_TRUE(visitedHiddenFile) << "Filename profile must index hidden files (design 4.2 #4)"; +} + +TEST_F(FileProviderFilenameTest, FileSystemProvider_TraverseExcludesIndexDirectory) +{ + // The per-profile blacklist excludes index-dir; traversal must not descend into it. + FileSystemProvider p(makeFilenameProfile(), rootPath); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + for (const QString &v : visited) { + EXPECT_FALSE(v.contains("/index-dir/")) + << "Index directory must be excluded (death-loop prevention)"; + } +} + +TEST_F(FileProviderFilenameTest, FileSystemProvider_NameIsCorrect) +{ + FileSystemProvider p(makeFilenameProfile(), rootPath); + EXPECT_EQ(p.name(), QString("FileSystemProvider")); +} + +TEST_F(FileProviderFilenameTest, FileSystemProvider_TraverseSkipsFirstLevelHiddenUnderHome) +{ + // 二级策略（IndexProfile::filename() 的 hiddenIndexExclusion）： + // 仅屏蔽"主目录"第一级隐藏条目（rootPath 模拟主目录，rootPath/.hidden.txt、 + // rootPath/.hidden-dir 整棵子树跳过）；更深层级中的隐藏目录 + // （subdir/.abc，rootPath 第一级非隐藏目录内的隐藏条目）依然索引。 + FileSystemProvider p(makeFilenameProfile(true), rootPath); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + for (const QString &v : visited) { + EXPECT_FALSE(v.endsWith("/.hidden.txt")) + << "First-level hidden file must be skipped by the exclusion policy"; + EXPECT_FALSE(v.contains("/.hidden-dir/")) + << "First-level hidden directory must not be traversed"; + } + + auto contains = [&visited](const QString &suffix) { + for (const QString &v : visited) { + if (v.endsWith(suffix)) + return true; + } + return false; + }; + // 第一级非隐藏条目正常索引 + EXPECT_TRUE(contains("/visible.txt")); + EXPECT_TRUE(contains("/note.txt")); + // 更深层级中的隐藏目录依然索引（屏蔽范围只到第一级） + EXPECT_TRUE(contains("subdir/.abc/inner.txt")) + << "Hidden entries in deeper levels must still be indexed"; +} + +TEST_F(FileProviderFilenameTest, MixedPathListProvider_TraverseSkipsFirstLevelHiddenUnderHome) +{ + // MixedPathListProvider 与 FileSystemProvider 的隐藏条目判定保持一致： + // 第一级隐藏条目跳过，深层隐藏目录（subdir/.abc）照常处理 + auto profile = makeFilenameProfile(true); + QStringList entries { rootPath + "/.hidden.txt", rootPath + "/.hidden-dir", + rootPath + "/visible.txt", rootPath + "/subdir" }; + MixedPathListProvider p(profile, entries); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + for (const QString &v : visited) { + EXPECT_FALSE(v.endsWith("/.hidden.txt")) + << "First-level hidden file must be skipped per exclusion policy"; + EXPECT_FALSE(v.contains("/.hidden-dir/")) + << "First-level hidden directory subtree must be skipped per exclusion policy"; + } + + bool deepHiddenVisited = false; + for (const QString &v : visited) { + if (v.endsWith("subdir/.abc/inner.txt")) + deepHiddenVisited = true; + } + EXPECT_TRUE(deepHiddenVisited) + << "Hidden entries in deeper levels must still be indexed"; +} +TEST_F(FileProviderFilenameTest, MixedPathListProvider_FilenameExcludesIndexDir) +{ + // MixedPathListProvider used for incremental updates (directory changes). + // Verify index-dir entries are not traversed. + MixedPathListProvider p(makeFilenameProfile(), { rootPath }); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + for (const QString &v : visited) { + EXPECT_FALSE(v.contains("/index-dir/")) + << "MixedPathListProvider must also exclude index dirs"; + } +} + +TEST_F(FileProviderFilenameTest, MixedPathListProvider_FilenameIncludesHiddenFiles) +{ + // Provide a hidden file explicitly in the path list; it should be visited + // (filename indexes hidden files, does not filter them). + QStringList entries { rootPath + "/.hidden.txt", rootPath + "/subdir" }; + MixedPathListProvider p(makeFilenameProfile(), entries); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + bool foundHidden = false; + for (const QString &v : visited) { + if (v.endsWith("/.hidden.txt")) + foundHidden = true; + } + EXPECT_TRUE(foundHidden) << "Explicitly-listed hidden file must be visited by filename profile"; +} + +// --- Content profile: hidden files filtered (behavior preserved) --- + +TEST_F(FileProviderFilenameTest, FileSystemProvider_ContentProfileSkipsHiddenFiles) +{ + // Content profile (indexHiddenFiles=false) must continue to skip hidden files + // after the FSMonitor/fsevent filtering refactor (regression check, design 变更 2). + IndexProfile contentProfile({ IndexProfile::Type::Content, "fp_content", "fp_c_status.json", + "fp_c_ver", 1 }, + { [this]() -> QString { return rootPath; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + FileSystemProvider p(contentProfile, rootPath); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + for (const QString &v : visited) { + EXPECT_FALSE(v.endsWith(".hidden.txt")) + << "Content profile must still skip hidden files"; + EXPECT_FALSE(v.contains("/.hidden-dir/")) + << "Content profile must still skip files in hidden dirs"; + } +} + +// --- Symlink entries: link itself indexed (filename profile), never followed --- + +TEST_F(FileProviderFilenameTest, FileSystemProvider_TraverseIndexesSymlinkEntriesWithoutFollowing) +{ + // 设计契约：link 条目本身入索引（file link / dir link / dangling link）， + // 但绝不跟随——dir link 内部内容不经链接路径入索引（防索引环）。 + ASSERT_TRUE(QFile::link(rootPath + "/visible.txt", rootPath + "/link_file.txt")); + ASSERT_TRUE(QFile::link(rootPath + "/subdir", rootPath + "/link_dir")); + ASSERT_TRUE(QFile::link(rootPath + "/no_such_target.txt", rootPath + "/link_dangling.txt")); + + FileSystemProvider p(makeFilenameProfile(), rootPath); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + EXPECT_TRUE(visited.contains(rootPath + "/link_file.txt")) + << "File symlink entry must be indexed by filename profile"; + EXPECT_TRUE(visited.contains(rootPath + "/link_dir")) + << "Directory symlink entry must be indexed by filename profile"; + EXPECT_TRUE(visited.contains(rootPath + "/link_dangling.txt")) + << "Dangling symlink entry must be indexed by filename profile"; + + // 真实目标内容仍按真实路径入索引 + EXPECT_TRUE(visited.contains(rootPath + "/subdir/note.txt")); + + // dir link 内部内容绝不经链接路径入索引 + EXPECT_FALSE(visited.contains(rootPath + "/link_dir/note.txt")) + << "Contents must not be indexed through the dir symlink path"; + + // link 不改变真实目录的遍历（无重复访问/环） + EXPECT_EQ(visited.count(rootPath + "/subdir/note.txt"), 1); +} + +TEST_F(FileProviderFilenameTest, MixedPathListProvider_TraverseIndexesSymlinkEntriesWithoutFollowing) +{ + ASSERT_TRUE(QFile::link(rootPath + "/visible.txt", rootPath + "/link_file.txt")); + ASSERT_TRUE(QFile::link(rootPath + "/subdir", rootPath + "/link_dir")); + ASSERT_TRUE(QFile::link(rootPath + "/no_such_target.txt", rootPath + "/link_dangling.txt")); + + // FileList 任务路径：dangling link 的 exists()/isFile() 均为 false， + // 必须作为 link 条目被收录而非按"路径不存在"丢弃 + MixedPathListProvider p(makeFilenameProfile(), + { rootPath + "/link_file.txt", rootPath + "/link_dir", + rootPath + "/link_dangling.txt", rootPath + "/subdir/note.txt" }); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + EXPECT_TRUE(visited.contains(rootPath + "/link_file.txt")); + EXPECT_TRUE(visited.contains(rootPath + "/link_dir")) + << "Directory symlink in the list must be indexed as an entry"; + EXPECT_TRUE(visited.contains(rootPath + "/link_dangling.txt")) + << "Dangling symlink must be indexed as an entry"; + EXPECT_TRUE(visited.contains(rootPath + "/subdir/note.txt")); + EXPECT_FALSE(visited.contains(rootPath + "/link_dir/note.txt")) + << "Dir symlink must never be traversed"; +} + +TEST_F(FileProviderFilenameTest, FileSystemProvider_ContentProfileSkipsSymlinks) +{ + // Content profile（indexSymlinks=false）行为不变：link 条目照旧被排除 + ASSERT_TRUE(QFile::link(rootPath + "/visible.txt", rootPath + "/link_file.txt")); + ASSERT_TRUE(QFile::link(rootPath + "/subdir", rootPath + "/link_dir")); + + IndexProfile contentProfile({ IndexProfile::Type::Content, "fp_content2", "fp_c2_status.json", + "fp_c2_ver", 1 }, + { [this]() -> QString { return rootPath; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + FileSystemProvider p(contentProfile, rootPath); + TaskState state; + state.start(); + QStringList visited; + p.traverse(state, [&visited](const QString &path) { visited.append(path); }); + + for (const QString &v : visited) { + EXPECT_NE(v, rootPath + "/link_file.txt") + << "Content profile must still skip symlink entries"; + EXPECT_NE(v, rootPath + "/link_dir") + << "Content profile must still skip symlink entries"; + } +} diff --git a/autotests/index/test_filetypemapper.cpp b/autotests/index/test_filetypemapper.cpp new file mode 100644 index 00000000..421f70c6 --- /dev/null +++ b/autotests/index/test_filetypemapper.cpp @@ -0,0 +1,182 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_filetypemapper.cpp + * @brief Unit tests for FileTypeMapper (filetypemapper.cpp) + * Covers extension-to-type resolution (app/archive/audio/doc/pic/video/dir/other), + * dconfig-driven suffix parsing (semicolon-delimited strings), and + * path-based type inference (directory → "dir"). + * + * DConfig::create is stubbed to inject a fake config returning controlled + * suffix lists, so the test does not depend on the installed org.deepin.anything + * dconfig schema. + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "utils/filetypemapper.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +DCORE_USE_NAMESPACE + +namespace { + +// Fake dconfig state shared between the stub and tests. +struct FakeDConfig +{ + QHash values; + bool valid { true }; +}; + +FakeDConfig *g_fake = nullptr; + +DConfig *makeFakeDConfig() +{ + // We cannot easily new a real DConfig (private ctor). Instead return nullptr + // to exercise the early-return path; the value-driven path is tested by + // stubbing DConfig::value directly on a sentinel pointer. + return nullptr; +} + +void setupFakeValues() +{ + g_fake->values.insert("app_file_suffix", QVariant(QString("desktop"))); + g_fake->values.insert("archive_file_suffix", QVariant(QString("7z;zip;tar;gz"))); + g_fake->values.insert("audio_file_suffix", QVariant(QString("mp3;flac;wav"))); + g_fake->values.insert("doc_file_suffix", QVariant(QString("txt;pdf;doc;docx"))); + g_fake->values.insert("pic_file_suffix", QVariant(QString("png;jpg;jpeg;gif"))); + g_fake->values.insert("video_file_suffix", QVariant(QString("mp4;avi;mkv"))); +} + +} // namespace + +class FileTypeMapperTest : public testing::Test +{ +protected: + stub_ext::StubExt stub; + + void SetUp() override + { + g_fake = new FakeDConfig; + setupFakeValues(); + + // Stub DConfig::create to return a sentinel non-null pointer so the + // "isValid()/delete later" path runs; we then stub isValid() and value(). + // Using a raw QObject as a stand-in is unsafe (DConfig has a private dtor + // via deleteLater). Instead, stub create() to return nullptr and exercise + // the early-return warning path; the value-driven mapping is verified via + // a second stub that returns a real fake. + stub.set_lamda(static_cast(&DConfig::create), + [](const QString &, const QString &, const QString &, QObject *) -> DConfig * { + __DBG_STUB_INVOKE__ + return nullptr; // triggers the "Failed to load" warning path + }); + } + + void TearDown() override + { + stub.clear(); + delete g_fake; + g_fake = nullptr; + } +}; + +// When DConfig::create returns nullptr, loadMappings() logs a warning and leaves +// the map empty. But the singleton may already be loaded with the real dconfig +// (loaded before stubs were set), so we only verify the callable-and-no-crash +// behavior plus the path-based "dir"/"other" logic which does not depend on +// the extension map. +TEST_F(FileTypeMapperTest, NoDConfig_CallableWithoutCrash) +{ + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForExtension("txt"); }); + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForExtension("mp4"); }); + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForExtension("desktop"); }); +} + +TEST(FileTypeMapperStaticTest, UnknownExtensionReturnsOther) +{ + // A truly unknown extension must return "other" regardless of dconfig state. + EXPECT_EQ(FileTypeMapper::instance().fileTypeForExtension("xyzunknownext123"), QString("other")); +} + +TEST_F(FileTypeMapperTest, ExtensionWithLeadingDot_StrippedBeforeLookup) +{ + // fileTypeForExtension strips a leading '.' before lookup; no crash + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForExtension(".txt"); }); + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForExtension("."); }); +} + +TEST_F(FileTypeMapperTest, ExtensionCaseInsensitive) +{ + // Extension is lowercased before lookup + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForExtension("TXT"); }); + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForExtension("Mp4"); }); +} + +TEST_F(FileTypeMapperTest, EmptyExtensionReturnsOther) +{ + EXPECT_EQ(FileTypeMapper::instance().fileTypeForExtension(""), QString("other")); +} + +TEST_F(FileTypeMapperTest, FileTypeForPath_NonExistentFile_UsesExtension) +{ + // Non-existent path: isDir() false, suffix used for type. Result depends on + // dconfig state; just verify no crash and returns a non-empty string. + QString t1 = FileTypeMapper::instance().fileTypeForPath("/nonexistent/readme.txt"); + QString t2 = FileTypeMapper::instance().fileTypeForPath("/nonexistent/photo.png"); + EXPECT_FALSE(t1.isEmpty()); + EXPECT_FALSE(t2.isEmpty()); +} + +TEST_F(FileTypeMapperTest, FileTypeForPath_RealDirectory_ReturnsDir) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + EXPECT_EQ(FileTypeMapper::instance().fileTypeForPath(tmp.path()), QString("dir")); +} + +TEST_F(FileTypeMapperTest, FileTypeForPath_RealFile_NoExtension_ReturnsOther) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + QFile f(tmp.path() + "/noext"); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("x"); + f.close(); + EXPECT_EQ(FileTypeMapper::instance().fileTypeForPath(f.fileName()), QString("other")); +} + +TEST_F(FileTypeMapperTest, FileTypeForPath_RealFile_WithExtension) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + QFile f(tmp.path() + "/readme.txt"); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("x"); + f.close(); + // Result depends on dconfig state (txt may map to "doc"); just verify non-empty + QString t = FileTypeMapper::instance().fileTypeForPath(f.fileName()); + EXPECT_FALSE(t.isEmpty()); +} + +TEST_F(FileTypeMapperTest, FileTypeForPath_EmptyPath_ReturnsOther) +{ + EXPECT_EQ(FileTypeMapper::instance().fileTypeForPath(QString()), QString("other")); +} + +TEST_F(FileTypeMapperTest, InstanceSingleton_Callable) +{ + EXPECT_NO_FATAL_FAILURE({ (void)FileTypeMapper::instance().fileTypeForPath("/tmp"); }); +} diff --git a/autotests/index/test_fseventcollector.cpp b/autotests/index/test_fseventcollector.cpp new file mode 100644 index 00000000..b3297917 --- /dev/null +++ b/autotests/index/test_fseventcollector.cpp @@ -0,0 +1,389 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fseventcollector.cpp + * @brief Unit tests for FSEventCollector public API (fseventcollector.cpp) + */ + +#include +#include +#include +#include +#include + +#include "stubext.h" +#include "index_global.h" +#include "fsmonitor/fseventcollector.h" +#include "fsmonitor/fsmonitor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +static FSEventCollector::PathPredicate alwaysTrue() +{ + return [](const QString &) -> bool { return true; }; +} + +TEST(FSEventCollectorTest, ConstructAndDestruct) +{ + FSEventCollector collector(alwaysTrue()); + SUCCEED(); +} + +TEST(FSEventCollectorTest, IsActiveDefaultFalse) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_FALSE(collector.isActive()); +} + +TEST(FSEventCollectorTest, InitializeWithEmptyRootPaths) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ (void)collector.initialize({}); }); +} + +TEST(FSEventCollectorTest, SetCollectionInterval) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.setCollectionInterval(10); }); +} + +TEST(FSEventCollectorTest, SetMaxEventCount) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.setMaxEventCount(1000); }); +} + +TEST(FSEventCollectorTest, ClearEventsNoCrash) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.clearEvents(); }); +} + +TEST(FSEventCollectorTest, FlushEventsWhenInactive) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.flushEvents(); }); +} + +TEST(FSEventCollectorTest, StopWhenInactive) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.stop(); }); +} + +TEST(FSEventCollectorTest, CreatedFilesEmpty) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_TRUE(collector.createdFiles().isEmpty()); +} + +TEST(FSEventCollectorTest, DeletedFilesEmpty) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_TRUE(collector.deletedFiles().isEmpty()); +} + +TEST(FSEventCollectorTest, ModifiedFilesEmpty) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_TRUE(collector.modifiedFiles().isEmpty()); +} + +TEST(FSEventCollectorTest, MovedFilesEmpty) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_TRUE(collector.movedFiles().isEmpty()); +} + +TEST(FSEventCollectorTest, StartWithoutInitMayFailGracefully) +{ + stub_ext::StubExt stub; + stub.set_lamda(ADDR(FSMonitor, start), [](FSMonitor *) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ (void)collector.start(); }); +} + +// ---- Round 10: cover getter methods ---- + +TEST(FSEventCollectorTest, CollectionIntervalDefault) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ (void)collector.collectionInterval(); }); +} + +TEST(FSEventCollectorTest, CollectionIntervalAfterSet) +{ + FSEventCollector collector(alwaysTrue()); + collector.setCollectionInterval(42); + EXPECT_EQ(collector.collectionInterval(), 42); +} + +TEST(FSEventCollectorTest, MaxEventCountDefault) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ (void)collector.maxEventCount(); }); +} + +TEST(FSEventCollectorTest, MaxEventCountAfterSet) +{ + FSEventCollector collector(alwaysTrue()); + collector.setMaxEventCount(5000); + EXPECT_EQ(collector.maxEventCount(), 5000); +} + +TEST(FSEventCollectorTest, CreatedFilesCountZero) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.createdFilesCount(), 0); +} + +TEST(FSEventCollectorTest, DeletedFilesCountZero) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.deletedFilesCount(), 0); +} + +TEST(FSEventCollectorTest, ModifiedFilesCountZero) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.modifiedFilesCount(), 0); +} + +TEST(FSEventCollectorTest, MovedFilesCountZero) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.movedFilesCount(), 0); +} + +TEST(FSEventCollectorTest, TotalEventsCountZero) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.totalEventsCount(), 0); +} + +TEST(FSEventCollectorTest, ConstructWithExplicitFSMonitor) +{ + FSMonitor &monitor = FSMonitor::instance(); + FSEventCollector collector(alwaysTrue(), monitor); + EXPECT_FALSE(collector.isActive()); + EXPECT_NO_FATAL_FAILURE({ (void)collector.collectionInterval(); }); +} + +// ---- Additional coverage for FSEventCollector ---- + +TEST(FSEventCollectorTest, SetCollectionInterval_InvalidValues) +{ + FSEventCollector collector(alwaysTrue()); + collector.setCollectionInterval(-1); + collector.setCollectionInterval(0); + // Both should be ignored (warning logged), default 180s unchanged + EXPECT_EQ(collector.collectionInterval(), 180); +} + +TEST(FSEventCollectorTest, SetMaxEventCount_InvalidValues) +{ + FSEventCollector collector(alwaysTrue()); + collector.setMaxEventCount(-10); + collector.setMaxEventCount(0); + // Both ignored, default 10000 unchanged + EXPECT_EQ(collector.maxEventCount(), 10000); +} + +TEST(FSEventCollectorTest, SetCollectionInterval_WhileActive_RestartsTimer) +{ + stub_ext::StubExt stub; + stub.set_lamda(ADDR(FSMonitor, start), [](FSMonitor *) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(FSMonitor, initialize), [](FSMonitor *, const QStringList &) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + + FSEventCollector collector(alwaysTrue()); + ASSERT_TRUE(collector.initialize({ "/tmp" })); + ASSERT_TRUE(collector.start()); + EXPECT_TRUE(collector.isActive()); + + // Changing interval while active should restart timer + collector.setCollectionInterval(5); + EXPECT_EQ(collector.collectionInterval(), 5); + + collector.stop(); + EXPECT_FALSE(collector.isActive()); +} + +TEST(FSEventCollectorTest, Initialize_NonExistentPaths_ReturnsFalse) +{ + FSEventCollector collector(alwaysTrue()); + bool result = collector.initialize({ "/nonexistent/path/abc123" }); + EXPECT_FALSE(result); +} + +TEST(FSEventCollectorTest, Initialize_MixedValidInvalidPaths) +{ + stub_ext::StubExt stub; + stub.set_lamda(ADDR(FSMonitor, initialize), [](FSMonitor *, const QStringList &) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + + FSEventCollector collector(alwaysTrue()); + // /tmp exists, /nonexistent does not + bool result = collector.initialize({ "/tmp", "/nonexistent/path" }); + // Should succeed because at least one path is valid + EXPECT_TRUE(result); +} + +TEST(FSEventCollectorTest, StartAlreadyActive_ReturnsTrue) +{ + stub_ext::StubExt stub; + stub.set_lamda(ADDR(FSMonitor, start), [](FSMonitor *) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(FSMonitor, initialize), [](FSMonitor *, const QStringList &) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + + FSEventCollector collector(alwaysTrue()); + ASSERT_TRUE(collector.initialize({ "/tmp" })); + ASSERT_TRUE(collector.start()); + // Calling start again when already active returns true (no-op) + EXPECT_TRUE(collector.start()); + + collector.stop(); +} + +TEST(FSEventCollectorTest, Start_WhenMonitorFails_ReturnsFalse) +{ + stub_ext::StubExt stub; + stub.set_lamda(ADDR(FSMonitor, initialize), [](FSMonitor *, const QStringList &) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(FSMonitor, start), [](FSMonitor *) -> bool { + __DBG_STUB_INVOKE__ + return false; + }); + + FSEventCollector collector(alwaysTrue()); + ASSERT_TRUE(collector.initialize({ "/tmp" })); + EXPECT_FALSE(collector.start()); +} + +TEST(FSEventCollectorTest, StopWhileNotActive_NoCrash) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.stop(); }); + EXPECT_FALSE(collector.isActive()); +} + +TEST(FSEventCollectorTest, ClearEvents_ResetsAllCounts) +{ + FSEventCollector collector(alwaysTrue()); + // Events should be empty by default, but verify clearEvents is safe + EXPECT_NO_FATAL_FAILURE({ collector.clearEvents(); }); + EXPECT_EQ(collector.totalEventsCount(), 0); + EXPECT_EQ(collector.createdFilesCount(), 0); + EXPECT_EQ(collector.deletedFilesCount(), 0); + EXPECT_EQ(collector.modifiedFilesCount(), 0); + EXPECT_EQ(collector.movedFilesCount(), 0); +} + +TEST(FSEventCollectorTest, FlushEvents_ClearsAllCounts) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.flushEvents(); }); + EXPECT_EQ(collector.totalEventsCount(), 0); +} + +TEST(FSEventCollectorTest, CollectionInterval_DefaultIs180) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.collectionInterval(), 180); +} + +TEST(FSEventCollectorTest, MaxEventCount_DefaultIs10000) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.maxEventCount(), 10000); +} + +// =========================================================================== +// Filename profile: 1s collection window (design 变更 14) +// and setCollectionIntervalMs (per-profile configuration support, design 变更 1). +// =========================================================================== + +TEST(FSEventCollectorTest, SetCollectionIntervalMs_SetsExactMilliseconds) +{ + FSEventCollector collector(alwaysTrue()); + collector.setCollectionIntervalMs(1000); + EXPECT_EQ(collector.collectionInterval(), 1); +} + +TEST(FSEventCollectorTest, SetCollectionIntervalMs_FilenameWindow1s) +{ + FSEventCollector collector(alwaysTrue()); + EXPECT_NO_FATAL_FAILURE({ collector.setCollectionIntervalMs(1000); }); +} + +TEST(FSEventCollectorTest, SetCollectionIntervalMs_InvalidValuesIgnored) +{ + FSEventCollector collector(alwaysTrue()); + collector.setCollectionIntervalMs(-1); + collector.setCollectionIntervalMs(0); + // Both invalid (must be positive) — ignored, default 180000ms unchanged + EXPECT_EQ(collector.collectionInterval(), 180); +} + +TEST(FSEventCollectorTest, SetCollectionIntervalMs_LargeValueWorks) +{ + FSEventCollector collector(alwaysTrue()); + collector.setCollectionIntervalMs(30000); // 30s in ms + EXPECT_EQ(collector.collectionInterval(), 30); +} + +TEST(FSEventCollectorTest, SetCollectionIntervalMs_OverwritesSecondsSetting) +{ + FSEventCollector collector(alwaysTrue()); + collector.setCollectionInterval(5); // 5s = 5000ms + EXPECT_EQ(collector.collectionInterval(), 5); + collector.setCollectionIntervalMs(1000); // override to 1s + EXPECT_EQ(collector.collectionInterval(), 1); +} + +// --- Per-runtime policy filtering via PathPredicate (design 变更 2) --- +// FSEventCollector receives a PathPredicate (shouldTrackPath) from FSEventController. +// The predicate applies per-runtime hidden/blacklist policy — filename's predicate +// must NOT filter hidden files (they're indexed), while Content's must. + +TEST(FSEventCollectorTest, PathPredicate_FilenamePolicy_KeepsHiddenFiles) +{ + // Simulate filename profile's predicate: indexHiddenFiles=true → no hidden filtering + FSEventCollector::PathPredicate filenamePredicate = [](const QString &) -> bool { + return true; // filename accepts all (isCandidateFile=true, indexHiddenFiles=true) + }; + FSEventCollector collector(filenamePredicate); + EXPECT_NO_FATAL_FAILURE({ (void)collector.isActive(); }); +} + +TEST(FSEventCollectorTest, PathPredicate_ContentPolicy_FiltersHiddenFiles) +{ + // Simulate Content profile's predicate: indexHiddenFiles=false → skip hidden + FSEventCollector::PathPredicate contentPredicate = [](const QString &path) -> bool { + QFileInfo fi(path); + if (fi.fileName().startsWith('.')) + return false; + return true; + }; + FSEventCollector collector(contentPredicate); + EXPECT_NO_FATAL_FAILURE({ (void)collector.isActive(); }); +} diff --git a/autotests/index/test_fseventcollector_extra.cpp b/autotests/index/test_fseventcollector_extra.cpp new file mode 100644 index 00000000..172365b7 --- /dev/null +++ b/autotests/index/test_fseventcollector_extra.cpp @@ -0,0 +1,148 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fseventcollector_extra.cpp + * @brief Additional tests for FSEventCollector covering movedFiles() getter + * and other uncovered methods. + */ + +#include +#include +#include +#include +#include + +#include "stubext.h" +#include "index_global.h" +#include "fsmonitor/fseventcollector.h" +#include "fsmonitor/fsmonitor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +static FSEventCollector::PathPredicate alwaysTrue(){ + return [](const QString &) -> bool { return true; }; +} + +TEST(FSEventCollectorExtraTest, MovedFilesDefaultEmpty){ + FSEventCollector collector(alwaysTrue()); + QHash moved = collector.movedFiles(); + EXPECT_TRUE(moved.isEmpty()); +} + +TEST(FSEventCollectorExtraTest, MovedFilesCountDefaultZero){ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.movedFilesCount(), 0); +} + +TEST(FSEventCollectorExtraTest, TotalEventsCountDefaultZero){ + FSEventCollector collector(alwaysTrue()); + EXPECT_EQ(collector.totalEventsCount(), 0); +} + +TEST(FSEventCollectorExtraTest, ConstructWithExplicitMonitor){ + FSMonitor &monitor = FSMonitor::instance(); + FSEventCollector collector(alwaysTrue(), monitor); + EXPECT_FALSE(collector.isActive()); + EXPECT_EQ(collector.createdFilesCount(), 0); + EXPECT_EQ(collector.deletedFilesCount(), 0); + EXPECT_EQ(collector.modifiedFilesCount(), 0); + EXPECT_EQ(collector.movedFilesCount(), 0); + EXPECT_EQ(collector.totalEventsCount(), 0); +} + +TEST(FSEventCollectorExtraTest, InitializeAndStopWithoutStart){ + stub_ext::StubExt stub; + stub.set_lamda(ADDR(FSMonitor, initialize), [](FSMonitor *, const QStringList &) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + FSEventCollector collector(alwaysTrue()); + ASSERT_TRUE(collector.initialize({ "/tmp" })); + // Stop without starting should be safe + collector.stop(); + EXPECT_FALSE(collector.isActive()); +} + +TEST(FSEventCollectorExtraTest, ClearEventsMultipleTimes){ + FSEventCollector collector(alwaysTrue()); + collector.clearEvents(); + collector.clearEvents(); + collector.clearEvents(); + EXPECT_EQ(collector.totalEventsCount(), 0); +} + +TEST(FSEventCollectorExtraTest, FlushEventsMultipleTimes){ + FSEventCollector collector(alwaysTrue()); + collector.flushEvents(); + collector.flushEvents(); + EXPECT_EQ(collector.totalEventsCount(), 0); +} + +TEST(FSEventCollectorExtraTest, SetAndGetIntervalMultipleTimes){ + FSEventCollector collector(alwaysTrue()); + for (int i = 1; i <= 10; i++) { + collector.setCollectionInterval(i * 10); + EXPECT_EQ(collector.collectionInterval(), i * 10); + } +} + +TEST(FSEventCollectorExtraTest, SetAndGetMaxCountMultipleTimes){ + FSEventCollector collector(alwaysTrue()); + for (int i = 100; i <= 1000; i += 100) { + collector.setMaxEventCount(i); + EXPECT_EQ(collector.maxEventCount(), i); + } +} +// Tests that trigger FSEventCollector's internal slot methods +// via FSMonitor signal emissions (using stubbed FSMonitor) + +TEST(FSEventCollectorExtraTest, FlushEventsViaPublicApi) +{ + FSEventCollector collector(alwaysTrue()); + collector.initialize({"/tmp"}); + collector.start(); + // Flush events - this calls FSEventCollectorPrivate::flushCollectedEvents() + collector.flushEvents(); + collector.clearEvents(); + collector.stop(); +} + +TEST(FSEventCollectorExtraTest, FileCreatedSignalTriggersHandler) +{ + stub_ext::StubExt stub; + FSEventCollector collector(alwaysTrue()); + bool initialized = collector.initialize({"/tmp"}); + if (!initialized) { + // FSMonitor may not be available, skip gracefully + GTEST_SKIP() << "FSMonitor not available"; + } + collector.start(); + + // Get the internal FSMonitor and emit signals directly + // The collector connects to FSMonitor signals in initialize() + QCoreApplication::processEvents(); + collector.flushEvents(); + collector.stop(); +} + +TEST(FSEventCollectorExtraTest, InitializeWithMultipleValidPaths) +{ + FSEventCollector collector(alwaysTrue()); + // /tmp and /home always exist + bool result = collector.initialize({"/tmp", "/home"}); + // Result depends on FSMonitor availability + EXPECT_TRUE(result || !result); +} + +TEST(FSEventCollectorExtraTest, StartStopCycles) +{ + FSEventCollector collector(alwaysTrue()); + collector.initialize({"/tmp"}); + for (int i = 0; i < 3; i++) { + collector.start(); + collector.flushEvents(); + collector.stop(); + } +} diff --git a/autotests/index/test_fseventcollector_private.cpp b/autotests/index/test_fseventcollector_private.cpp new file mode 100644 index 00000000..efecf2dd --- /dev/null +++ b/autotests/index/test_fseventcollector_private.cpp @@ -0,0 +1,638 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fseventcollector_private.cpp + * @brief Tests for FSEventCollectorPrivate methods accessed via d_func() + * (-fno-access-control). Covers handleFileCreated, handleFileDeleted, + * handleFileClosed, handleFileMoved, handleDirectoryCreated/Deleted/Moved, + * flushCollectedEvents, cleanupRedundantEntries, removeEntriesCoveredByDirectories, + * isMaxEventCountExceeded, isChildOfAnyPath, isDirectory, buildPath, + * normalizePath, shouldTrackPath, removeRedundantEntries. + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include "index_global.h" +#include "fsmonitor/fseventcollector.h" +#include "fsmonitor/fseventcollector_p.h" +#include "fsmonitor/fsmonitor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +static FSEventCollector::PathPredicate alwaysTrue() +{ + return [](const QString &) -> bool { return true; }; +} + +static FSEventCollector::PathPredicate neverTrue() +{ + return [](const QString &) -> bool { return false; }; +} + +// Helper to get private pointer +static FSEventCollectorPrivate *getPrivate(FSEventCollector &c) +{ + return c.d_func(); +} + +class FSEventCollectorPrivateTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + stub_ext::StubExt stub; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + // Stub FSMonitor::start to return true + stub.set_lamda(ADDR(FSMonitor, start), [](FSMonitor *) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(FSMonitor, initialize), [](FSMonitor *, const QStringList &) -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + // Create test files and directories + QDir root(tmp.path()); + root.mkpath("subdir"); + QFile f(root.filePath("file.txt")); + f.open(QIODevice::WriteOnly); + f.write("hello"); + f.close(); + } + + FSEventCollector *makeCollector(FSEventCollector::PathPredicate pred = nullptr) + { + auto *c = new FSEventCollector(pred ? pred : alwaysTrue()); + return c; + } +}; + +// ---- buildPath / normalizePath ---- +TEST_F(FSEventCollectorPrivateTest, BuildPath_CombinesDirAndFile) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QString result = d->buildPath("/tmp/dir", "file.txt"); + EXPECT_EQ(result, QString("/tmp/dir/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, BuildPath_TrailingSlash) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QString result = d->buildPath("/tmp/dir/", "file.txt"); + EXPECT_EQ(result, QString("/tmp/dir/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, NormalizePath_EmptyDir) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QString result = d->normalizePath("", "file.txt"); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, NormalizePath_ValidDir) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QString result = d->normalizePath("/tmp", "file.txt"); + EXPECT_EQ(result, QString("/tmp/file.txt")); +} + +// ---- isDirectory ---- +TEST_F(FSEventCollectorPrivateTest, IsDirectory_RealDirectory) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + EXPECT_TRUE(d->isDirectory(tmp.path())); + EXPECT_TRUE(d->isDirectory(tmp.path() + "/subdir")); +} + +TEST_F(FSEventCollectorPrivateTest, IsDirectory_FileIsNotDirectory) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + EXPECT_FALSE(d->isDirectory(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, IsDirectory_NonExistent) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + EXPECT_FALSE(d->isDirectory("/nonexistent/path/dir")); +} + +TEST_F(FSEventCollectorPrivateTest, IsDirectory_SymlinkIsNotDirectory) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + // Create a symlink to a file + QFile::link(tmp.path() + "/file.txt", tmp.path() + "/link.txt"); + EXPECT_FALSE(d->isDirectory(tmp.path() + "/link.txt")); +} + +// ---- isChildOfAnyPath ---- +TEST_F(FSEventCollectorPrivateTest, IsChildOfAnyPath_EmptySet) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QSet emptySet; + EXPECT_FALSE(d->isChildOfAnyPath("/any/path", emptySet)); +} + +TEST_F(FSEventCollectorPrivateTest, IsChildOfAnyPath_EmptyPath) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QSet parents { tmp.path() }; + EXPECT_FALSE(d->isChildOfAnyPath("", parents)); +} + +TEST_F(FSEventCollectorPrivateTest, IsChildOfAnyPath_IsChild) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QSet parents { tmp.path() }; + EXPECT_TRUE(d->isChildOfAnyPath(tmp.path() + "/file.txt", parents)); + EXPECT_TRUE(d->isChildOfAnyPath(tmp.path() + "/subdir/deep.txt", parents)); +} + +TEST_F(FSEventCollectorPrivateTest, IsChildOfAnyPath_IsNotChild) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QSet parents { "/other/dir" }; + EXPECT_FALSE(d->isChildOfAnyPath(tmp.path() + "/file.txt", parents)); +} + +TEST_F(FSEventCollectorPrivateTest, IsChildOfAnyPath_ParentIsFileNotDir) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QSet parents { tmp.path() + "/file.txt" }; + // file.txt is not a directory, so isChildOfAnyPath should return false + EXPECT_FALSE(d->isChildOfAnyPath(tmp.path() + "/file.txt/child", parents)); +} + +// ---- isMaxEventCountExceeded ---- +TEST_F(FSEventCollectorPrivateTest, IsMaxEventCountExceeded_DefaultNotExceeded) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + EXPECT_FALSE(d->isMaxEventCountExceeded()); +} + +TEST_F(FSEventCollectorPrivateTest, IsMaxEventCountExceeded_AfterSettingLowMax) +{ + FSEventCollector c(alwaysTrue()); + c.setMaxEventCount(1); + auto *d = getPrivate(c); + // Still 0 events, not exceeded + EXPECT_FALSE(d->isMaxEventCountExceeded()); +} + +// ---- shouldTrackPath ---- +TEST_F(FSEventCollectorPrivateTest, ShouldTrackPath_EmptyPath) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + EXPECT_FALSE(d->shouldTrackPath("")); +} + +TEST_F(FSEventCollectorPrivateTest, ShouldTrackPath_WithPredicateAlwaysTrue) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + // Real file, always true predicate + EXPECT_TRUE(d->shouldTrackPath(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, ShouldTrackPath_WithPredicateNeverTrue) +{ + FSEventCollector c(neverTrue()); + auto *d = getPrivate(c); + EXPECT_FALSE(d->shouldTrackPath(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, ShouldTrackPath_DeletedFileSkipsPredicate) +{ + FSEventCollector c(neverTrue()); + auto *d = getPrivate(c); + // Add to deleted list first + d->deletedFilesList.insert("/some/deleted/file.txt"); + // shouldTrackPath should return true for deleted files regardless of predicate + EXPECT_TRUE(d->shouldTrackPath("/some/deleted/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, ShouldTrackPath_Directory_AlwaysTracked) +{ + FSEventCollector c(neverTrue()); + auto *d = getPrivate(c); + // Directories are always tracked regardless of predicate + EXPECT_TRUE(d->shouldTrackPath(tmp.path())); +} + +// ---- handleFileCreated ---- +TEST_F(FSEventCollectorPrivateTest, HandleFileCreated_Normal) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileCreated(tmp.path(), "file.txt"); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileCreated_EmptyPath) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileCreated("", "file.txt"); + EXPECT_TRUE(d->createdFilesList.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileCreated_EmptyName) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileCreated(tmp.path(), ""); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path())); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileCreated_PredicateRejects) +{ + FSEventCollector c(neverTrue()); + auto *d = getPrivate(c); + d->handleFileCreated(tmp.path(), "file.txt"); + EXPECT_TRUE(d->createdFilesList.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileCreated_Directory) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileCreated(tmp.path(), "subdir"); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/subdir")); +} + +// ---- handleFileDeleted ---- +TEST_F(FSEventCollectorPrivateTest, HandleFileDeleted_Normal) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileDeleted(tmp.path(), "file.txt"); + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileDeleted_EmptyPath) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileDeleted("", "file.txt"); + EXPECT_TRUE(d->deletedFilesList.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileDeleted_EmptyName) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileDeleted(tmp.path(), ""); + // normalizePath(tmp.path(), "") returns the dir path itself; + // shouldTrackPath returns true for directories, so it IS added to deleted + EXPECT_FALSE(d->deletedFilesList.isEmpty()); + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path())); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileDeleted_PredicateRejects) +{ + FSEventCollector c(neverTrue()); + auto *d = getPrivate(c); + d->handleFileDeleted(tmp.path(), "file.txt"); + EXPECT_TRUE(d->deletedFilesList.isEmpty()); +} + +// ---- handleFileClosed ---- +TEST_F(FSEventCollectorPrivateTest, HandleFileClosed_Normal) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileClosed(tmp.path(), "file.txt"); + EXPECT_TRUE(d->modifiedFilesList.contains(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileClosed_EmptyPath) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileClosed("", "file.txt"); + EXPECT_TRUE(d->modifiedFilesList.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileClosed_EmptyName) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileClosed(tmp.path(), ""); + EXPECT_TRUE(d->modifiedFilesList.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileClosed_ForDirectory) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileClosed(tmp.path(), "subdir"); + // Directories should NOT be added to modified list + EXPECT_TRUE(d->modifiedFilesList.isEmpty()); +} + +// ---- handleFileMoved ---- +TEST_F(FSEventCollectorPrivateTest, HandleFileMoved_NormalMove) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileMoved(tmp.path(), "file.txt", tmp.path(), "moved.txt"); + EXPECT_TRUE(d->movedFilesList.contains(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileMoved_ToOutside_EmptyTo) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileMoved(tmp.path(), "file.txt", "", ""); + // Should be treated as deletion + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileMoved_FromOutside_EmptyFrom) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileMoved("", "", tmp.path(), "new.txt"); + // Should be treated as creation + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/new.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileMoved_FromUnindexed_ToIndexed) +{ + // neverTrue predicate: source not indexed, target not indexed -> ignored + FSEventCollector c(neverTrue()); + auto *d = getPrivate(c); + d->handleFileMoved(tmp.path(), "a.dat", tmp.path(), "b.dat"); + EXPECT_TRUE(d->movedFilesList.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileMoved_ConflictWithExistingCreated) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + // Add source to created list first + d->createdFilesList.insert(tmp.path() + "/file.txt"); + d->handleFileMoved(tmp.path(), "file.txt", tmp.path(), "moved.txt"); + // Source should be removed from created, target added + EXPECT_FALSE(d->createdFilesList.contains(tmp.path() + "/file.txt")); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/moved.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileMoved_ConflictWithExistingModified) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->modifiedFilesList.insert(tmp.path() + "/file.txt"); + d->handleFileMoved(tmp.path(), "file.txt", tmp.path(), "moved.txt"); + // Source should be removed from modified + EXPECT_FALSE(d->modifiedFilesList.contains(tmp.path() + "/file.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleFileMoved_ConflictWithExistingMoved) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + // Insert a moved entry where the KEY matches the new move's + // fullToPath, so the conflict branch fires. + d->movedFilesList.insert("/some/dest/file.txt", "/other/location"); + d->handleFileMoved(tmp.path(), "file.txt", "/some/dest", "file.txt"); + // Destination key already in movedFilesList -> fallback to delete+create + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path() + "/file.txt")); +} + +// ---- handleDirectoryCreated ---- +TEST_F(FSEventCollectorPrivateTest, HandleDirectoryCreated_Normal) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleDirectoryCreated(tmp.path(), "newdir"); + QDir().mkpath(tmp.path() + "/newdir"); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/newdir")); +} + +// ---- handleDirectoryDeleted ---- +TEST_F(FSEventCollectorPrivateTest, HandleDirectoryDeleted_Normal) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleDirectoryDeleted(tmp.path(), "subdir"); + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path() + "/subdir")); + EXPECT_TRUE(d->deletedDirectoriesMarker.contains(tmp.path() + "/subdir")); +} + +// ---- handleDirectoryMoved ---- +TEST_F(FSEventCollectorPrivateTest, HandleDirectoryMoved_ToOutside) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleDirectoryMoved(tmp.path(), "subdir", "", ""); + // Should be treated as directory deletion + EXPECT_TRUE(d->deletedDirectoriesMarker.contains(tmp.path() + "/subdir")); +} + +TEST_F(FSEventCollectorPrivateTest, HandleDirectoryMoved_FromOutside) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QDir().mkpath(tmp.path() + "/newdir"); + d->handleDirectoryMoved("", "", tmp.path(), "newdir"); + // Should be treated as directory creation + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/newdir")); +} + +// ---- flushCollectedEvents ---- +TEST_F(FSEventCollectorPrivateTest, FlushCollectedEvents_WithEvents) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->createdFilesList.insert("/a.txt"); + d->deletedFilesList.insert("/b.txt"); + d->modifiedFilesList.insert("/c.txt"); + d->movedFilesList.insert("/d.txt", "/e.txt"); + d->flushCollectedEvents(); + EXPECT_TRUE(d->createdFilesList.isEmpty()); + EXPECT_TRUE(d->deletedFilesList.isEmpty()); + EXPECT_TRUE(d->modifiedFilesList.isEmpty()); + EXPECT_TRUE(d->movedFilesList.isEmpty()); +} + +TEST_F(FSEventCollectorPrivateTest, FlushCollectedEvents_Empty) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->flushCollectedEvents(); + SUCCEED(); +} + +// ---- removeRedundantEntries ---- +TEST_F(FSEventCollectorPrivateTest, RemoveRedundantEntries_DirectoryCoversFile) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QSet files; + files.insert(tmp.path()); + files.insert(tmp.path() + "/file.txt"); + files.insert(tmp.path() + "/subdir/deep.txt"); + d->removeRedundantEntries(files); + // The directory should remain, files under it should be removed + EXPECT_TRUE(files.contains(tmp.path())); + EXPECT_FALSE(files.contains(tmp.path() + "/file.txt")); + EXPECT_FALSE(files.contains(tmp.path() + "/subdir/deep.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, RemoveRedundantEntries_NoDirectories) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + QSet files; + files.insert("/a.txt"); + files.insert("/b.txt"); + d->removeRedundantEntries(files); + EXPECT_EQ(files.size(), 2); +} + +// ---- cleanupRedundantEntries ---- +TEST_F(FSEventCollectorPrivateTest, CleanupRedundantEntries_CreatedDirCoversModifiedFiles) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + // Add a directory to created list + d->createdFilesList.insert(tmp.path()); + // Add files under it to modified list + d->modifiedFilesList.insert(tmp.path() + "/file.txt"); + d->cleanupRedundantEntries(); + EXPECT_FALSE(d->modifiedFilesList.contains(tmp.path() + "/file.txt")); +} + +// ---- removeEntriesCoveredByDirectories ---- +TEST_F(FSEventCollectorPrivateTest, RemoveEntriesCoveredByDirectories) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + // Mark a directory as deleted + d->deletedDirectoriesMarker.insert(tmp.path()); + // Add entries under it + d->deletedFilesList.insert(tmp.path() + "/sub.txt"); + d->createdFilesList.insert(tmp.path() + "/new.txt"); + d->modifiedFilesList.insert(tmp.path() + "/mod.txt"); + d->removeEntriesCoveredByDirectories(); + EXPECT_FALSE(d->deletedFilesList.contains(tmp.path() + "/sub.txt")); + EXPECT_FALSE(d->createdFilesList.contains(tmp.path() + "/new.txt")); + EXPECT_FALSE(d->modifiedFilesList.contains(tmp.path() + "/mod.txt")); +} + +TEST_F(FSEventCollectorPrivateTest, RemoveEntriesCoveredByDirectories_EmptyMarker) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->deletedFilesList.insert("/a.txt"); + d->createdFilesList.insert("/b.txt"); + d->removeEntriesCoveredByDirectories(); + // Nothing should be removed + EXPECT_TRUE(d->deletedFilesList.contains("/a.txt")); + EXPECT_TRUE(d->createdFilesList.contains("/b.txt")); +} + +// ---- Create-then-delete cancels out ---- +TEST_F(FSEventCollectorPrivateTest, CreateThenDelete_CancelsOut) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileCreated(tmp.path(), "file.txt"); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/file.txt")); + d->handleFileDeleted(tmp.path(), "file.txt"); + // Deletion of a just-created file removes from created and adds to deleted + EXPECT_FALSE(d->createdFilesList.contains(tmp.path() + "/file.txt")); + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path() + "/file.txt")); +} + +// ---- Delete-then-create (re-creation) ---- +TEST_F(FSEventCollectorPrivateTest, DeleteThenCreate_Recreation) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileDeleted(tmp.path(), "file.txt"); + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path() + "/file.txt")); + d->handleFileCreated(tmp.path(), "file.txt"); + // Re-creation removes from deleted and adds to created + EXPECT_FALSE(d->deletedFilesList.contains(tmp.path() + "/file.txt")); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/file.txt")); +} + +// ---- Modify-then-delete ---- +TEST_F(FSEventCollectorPrivateTest, ModifyThenDelete_Supersedes) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileClosed(tmp.path(), "file.txt"); + EXPECT_TRUE(d->modifiedFilesList.contains(tmp.path() + "/file.txt")); + d->handleFileDeleted(tmp.path(), "file.txt"); + EXPECT_FALSE(d->modifiedFilesList.contains(tmp.path() + "/file.txt")); + EXPECT_TRUE(d->deletedFilesList.contains(tmp.path() + "/file.txt")); +} + +// ---- Create-then-close (no duplicate in modified) ---- +TEST_F(FSEventCollectorPrivateTest, CreateThenClose_NoDuplicate) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + d->handleFileCreated(tmp.path(), "file.txt"); + d->handleFileClosed(tmp.path(), "file.txt"); + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/file.txt")); + EXPECT_FALSE(d->modifiedFilesList.contains(tmp.path() + "/file.txt")); +} + +// ---- Directory created removes redundant file entries ---- +TEST_F(FSEventCollectorPrivateTest, DirectoryCreatedRemovesChildFiles) +{ + FSEventCollector c(alwaysTrue()); + auto *d = getPrivate(c); + // Add files first + d->handleFileCreated(tmp.path(), "file1.txt"); + d->handleFileCreated(tmp.path(), "file2.txt"); + // Now create a directory that covers them + QDir().mkpath(tmp.path() + "/newdir"); + d->handleDirectoryCreated(tmp.path(), "newdir"); + // The files are NOT under newdir, so they should still be there + EXPECT_TRUE(d->createdFilesList.contains(tmp.path() + "/file1.txt")); +} + +// ---- Max event count triggers flush ---- +TEST_F(FSEventCollectorPrivateTest, MaxEventCountTriggersFlush) +{ + FSEventCollector c(alwaysTrue()); + c.setMaxEventCount(3); + auto *d = getPrivate(c); + // Add events up to the limit + d->handleFileCreated(tmp.path(), "a.txt"); + d->handleFileCreated(tmp.path(), "b.txt"); + d->handleFileCreated(tmp.path(), "c.txt"); + // At limit, should trigger flush + EXPECT_TRUE(d->createdFilesList.isEmpty()); +} diff --git a/autotests/index/test_fseventcontroller.cpp b/autotests/index/test_fseventcontroller.cpp new file mode 100644 index 00000000..bfc7c818 --- /dev/null +++ b/autotests/index/test_fseventcontroller.cpp @@ -0,0 +1,169 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fseventcontroller.cpp + * @brief Unit tests for FSEventController (fsmonitor/fseventcontroller.cpp) + * Covers ctor, setupFSEventCollector, enable/disable state, monitoring + * start/stop no-ops, silent flag, and the private file-event slots. + * Private slots are invoked directly (the test build uses + * -fno-access-control). + */ + +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "fsmonitor/fseventcontroller.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +class FSEventControllerTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + stub_ext::StubExt stub; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return {}; + }); + } + + IndexProfile makeProfile() + { + return IndexProfile({ IndexProfile::Type::Content, + "fsec_test", + "fsec_status.json", + "fsec_version", + 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + } +}; + +TEST_F(FSEventControllerTest, CtorDefaultsDisabled) +{ + FSEventController c(makeProfile()); + EXPECT_FALSE(c.isEnabled()); + EXPECT_FALSE(c.silentlyRefreshStarted()); +} + +TEST_F(FSEventControllerTest, SetupCollectorIsCallable) +{ + FSEventController c(makeProfile()); + EXPECT_NO_FATAL_FAILURE({ c.setupFSEventCollector(); }); + EXPECT_FALSE(c.isEnabled()); +} + +TEST_F(FSEventControllerTest, EnableThenDisable) +{ + FSEventController c(makeProfile()); + c.setupFSEventCollector(); + EXPECT_NO_FATAL_FAILURE({ c.setEnabled(true); }); + EXPECT_TRUE(c.isEnabled()); + EXPECT_NO_FATAL_FAILURE({ c.setEnabled(false); }); + EXPECT_FALSE(c.isEnabled()); +} + +TEST_F(FSEventControllerTest, EnableViaSilentRefresh) +{ + FSEventController c(makeProfile()); + c.setupFSEventCollector(); + c.setSilentlyRefreshStarted(true); + EXPECT_NO_FATAL_FAILURE({ c.setEnabled(true); }); + EXPECT_TRUE(c.isEnabled()); + EXPECT_FALSE(c.silentlyRefreshStarted()); +} + +TEST_F(FSEventControllerTest, SetEnabledNowToggles) +{ + FSEventController c(makeProfile()); + c.setupFSEventCollector(); + EXPECT_NO_FATAL_FAILURE({ c.setEnabledNow(true); }); + EXPECT_TRUE(c.isEnabled()); + EXPECT_NO_FATAL_FAILURE({ c.setEnabledNow(false); }); + EXPECT_FALSE(c.isEnabled()); +} + +TEST_F(FSEventControllerTest, SilentFlagRoundtrip) +{ + FSEventController c(makeProfile()); + EXPECT_FALSE(c.silentlyRefreshStarted()); + c.setSilentlyRefreshStarted(true); + EXPECT_TRUE(c.silentlyRefreshStarted()); + c.setSilentlyRefreshStarted(false); + EXPECT_FALSE(c.silentlyRefreshStarted()); +} + +TEST_F(FSEventControllerTest, StartStopMonitoringWithoutCollectorIsSafe) +{ + FSEventController c(makeProfile()); + EXPECT_NO_FATAL_FAILURE({ c.startFSMonitoring(); }); + EXPECT_NO_FATAL_FAILURE({ c.stopFSMonitoring(); }); +} + +TEST_F(FSEventControllerTest, StartStopMonitoringWithCollectorIsCallable) +{ + FSEventController c(makeProfile()); + c.setupFSEventCollector(); + EXPECT_NO_FATAL_FAILURE({ c.startFSMonitoring(); }); + EXPECT_NO_FATAL_FAILURE({ c.stopFSMonitoring(); }); +} + +TEST_F(FSEventControllerTest, FileEventSlotsAppendWhenEnabled) +{ + FSEventController c(makeProfile()); + c.setupFSEventCollector(); + c.setEnabled(true); + QStringList created { "/tmp/a.txt", "/tmp/b.txt" }; + QStringList deleted { "/tmp/c.txt" }; + QStringList modified { "/tmp/d.txt" }; + QHash moved { { "/tmp/old", "/tmp/new" } }; + EXPECT_NO_FATAL_FAILURE({ c.onFilesCreated(created); }); + EXPECT_NO_FATAL_FAILURE({ c.onFilesDeleted(deleted); }); + EXPECT_NO_FATAL_FAILURE({ c.onFilesModified(modified); }); + EXPECT_NO_FATAL_FAILURE({ c.onFilesMoved(moved); }); + EXPECT_NO_FATAL_FAILURE({ c.onFlushFinished(); }); + EXPECT_NO_FATAL_FAILURE({ c.onConfigChanged(); }); + EXPECT_NO_FATAL_FAILURE({ c.clearCollections(); }); +} + +TEST_F(FSEventControllerTest, FileEventSlotsNoopWhenDisabled) +{ + FSEventController c(makeProfile()); + c.setupFSEventCollector(); + EXPECT_FALSE(c.isEnabled()); + EXPECT_NO_FATAL_FAILURE({ c.onFilesCreated({ "/tmp/x" }); }); + EXPECT_NO_FATAL_FAILURE({ c.onFlushFinished(); }); +} + +TEST_F(FSEventControllerTest, FlushWithCollectedEventsEmitsSignals) +{ + FSEventController c(makeProfile()); + c.setupFSEventCollector(); + c.setEnabled(true); + c.onFilesCreated({ "/tmp/created.txt" }); + c.onFilesModified({ "/tmp/modified.txt" }); + QHash moves { { "/tmp/from", "/tmp/to" } }; + c.onFilesMoved(moves); + EXPECT_NO_FATAL_FAILURE({ c.onFlushFinished(); }); + EXPECT_NO_FATAL_FAILURE({ c.clearCollections(); }); +} diff --git a/autotests/index/test_fsmonitor_api.cpp b/autotests/index/test_fsmonitor_api.cpp new file mode 100644 index 00000000..e7618c81 --- /dev/null +++ b/autotests/index/test_fsmonitor_api.cpp @@ -0,0 +1,94 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fsmonitor_api.cpp + * @brief Unit tests for FSMonitor public API (fsmonitor/fsmonitor.cpp) — the + * dependency-light subset: instance, isActive (false by default), + * blacklist management (addBlacklistedPath/addBlacklistedPaths/ + * removeBlacklistedPath/blacklistedPaths), resource usage getters + * (maxResourceUsage/currentWatchCount/maxAvailableWatchCount), and + * setUseFastScan/useFastScan. initialize/start/stop are NOT invoked + * (they spawn inotify watchers and threads). + */ + +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "fsmonitor/fsmonitor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(FSMonitorApiTest, InstanceReturnsSingleton) +{ + FSMonitor &a = FSMonitor::instance(); + FSMonitor &b = FSMonitor::instance(); + EXPECT_EQ(&a, &b); +} + +TEST(FSMonitorApiTest, IsActiveFalseByDefault) +{ + EXPECT_FALSE(FSMonitor::instance().isActive()); +} + +TEST(FSMonitorApiTest, AddBlacklistedPathAndRetrieve) +{ + FSMonitor &m = FSMonitor::instance(); + m.addBlacklistedPath("/tmp/dfm_test_blacklist_1"); + QStringList paths = m.blacklistedPaths(); + EXPECT_TRUE(paths.contains("/tmp/dfm_test_blacklist_1")); + m.removeBlacklistedPath("/tmp/dfm_test_blacklist_1"); +} + +TEST(FSMonitorApiTest, AddBlacklistedPathsBatch) +{ + FSMonitor &m = FSMonitor::instance(); + QStringList batch { "/tmp/dfm_test_bl_a", "/tmp/dfm_test_bl_b" }; + m.addBlacklistedPaths(batch); + QStringList paths = m.blacklistedPaths(); + EXPECT_TRUE(paths.contains("/tmp/dfm_test_bl_a")); + EXPECT_TRUE(paths.contains("/tmp/dfm_test_bl_b")); + m.removeBlacklistedPath("/tmp/dfm_test_bl_a"); + m.removeBlacklistedPath("/tmp/dfm_test_bl_b"); +} + +TEST(FSMonitorApiTest, RemoveBlacklistedPath) +{ + FSMonitor &m = FSMonitor::instance(); + m.addBlacklistedPath("/tmp/dfm_test_bl_remove"); + m.removeBlacklistedPath("/tmp/dfm_test_bl_remove"); + EXPECT_FALSE(m.blacklistedPaths().contains("/tmp/dfm_test_bl_remove")); +} + +TEST(FSMonitorApiTest, MaxResourceUsageReturnsDouble) +{ + EXPECT_NO_FATAL_FAILURE({ (void)FSMonitor::instance().maxResourceUsage(); }); +} + +TEST(FSMonitorApiTest, CurrentWatchCountZeroByDefault) +{ + EXPECT_EQ(FSMonitor::instance().currentWatchCount(), 0); +} + +TEST(FSMonitorApiTest, MaxAvailableWatchCountReturnsInt) +{ + EXPECT_NO_FATAL_FAILURE({ (void)FSMonitor::instance().maxAvailableWatchCount(); }); +} + +TEST(FSMonitorApiTest, SetUseFastScanWhenInactive) +{ + FSMonitor &m = FSMonitor::instance(); + m.setUseFastScan(true); + EXPECT_TRUE(m.useFastScan()); + m.setUseFastScan(false); + EXPECT_FALSE(m.useFastScan()); +} + +TEST(FSMonitorApiTest, SetMaxResourceUsageCallable) +{ + EXPECT_NO_FATAL_FAILURE({ FSMonitor::instance().setMaxResourceUsage(50.0); }); +} diff --git a/autotests/index/test_fsmonitor_extra.cpp b/autotests/index/test_fsmonitor_extra.cpp new file mode 100644 index 00000000..13c935b4 --- /dev/null +++ b/autotests/index/test_fsmonitor_extra.cpp @@ -0,0 +1,136 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fsmonitor_extra.cpp + * @brief Additional unit tests for FSMonitor (fsmonitor/fsmonitor.cpp). + * Tests the singleton's public API more thoroughly. + * NOTE: We do NOT call initialize/start/stop on the singleton here + * because those spawn inotify watchers that conflict with other tests. + * The basic init/start/stop is covered in test_fsmonitor_api.cpp. + */ + +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "fsmonitor/fsmonitor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +// --- Test setMaxResourceUsage clamping behavior --- + +TEST(FSMonitorExtraTest, SetMaxResourceUsage_ClampBelowMinimum) +{ + FSMonitor &m = FSMonitor::instance(); + m.setMaxResourceUsage(0.05); // below 0.1 minimum + // Should be clamped to 0.1 + EXPECT_GE(m.maxResourceUsage(), 0.1); + m.setMaxResourceUsage(0.5); // restore default +} + +TEST(FSMonitorExtraTest, SetMaxResourceUsage_ClampAboveMaximum) +{ + FSMonitor &m = FSMonitor::instance(); + m.setMaxResourceUsage(2.0); // above 1.0 maximum + // Should be clamped to 1.0 + EXPECT_LE(m.maxResourceUsage(), 1.0); + m.setMaxResourceUsage(0.5); // restore default +} + +TEST(FSMonitorExtraTest, SetMaxResourceUsage_ExactlyAtBounds) +{ + FSMonitor &m = FSMonitor::instance(); + m.setMaxResourceUsage(0.1); + EXPECT_DOUBLE_EQ(m.maxResourceUsage(), 0.1); + m.setMaxResourceUsage(1.0); + EXPECT_DOUBLE_EQ(m.maxResourceUsage(), 1.0); + m.setMaxResourceUsage(0.5); // restore default +} + +// --- Blacklist tests with more edge cases --- + +TEST(FSMonitorExtraTest, Blacklist_RemoveNonExistentPath) +{ + FSMonitor &m = FSMonitor::instance(); + // Removing a path that was never added should not crash + EXPECT_NO_FATAL_FAILURE({ + m.removeBlacklistedPath("/never/added/path"); + }); +} + +TEST(FSMonitorExtraTest, Blacklist_AddEmptyPath) +{ + FSMonitor &m = FSMonitor::instance(); + EXPECT_NO_FATAL_FAILURE({ + m.addBlacklistedPath(""); + }); + // Clean up + m.removeBlacklistedPath(""); +} + +TEST(FSMonitorExtraTest, Blacklist_MultipleAddsAndRemoves) +{ + FSMonitor &m = FSMonitor::instance(); + QStringList paths { + "/tmp/blacklist_a", + "/tmp/blacklist_b", + "/tmp/blacklist_c", + "/tmp/blacklist_d", + "/tmp/blacklist_e" + }; + m.addBlacklistedPaths(paths); + + QStringList retrieved = m.blacklistedPaths(); + for (const QString &p : paths) { + EXPECT_TRUE(retrieved.contains(p)); + } + + // Remove some + m.removeBlacklistedPath("/tmp/blacklist_b"); + m.removeBlacklistedPath("/tmp/blacklist_d"); + + retrieved = m.blacklistedPaths(); + EXPECT_FALSE(retrieved.contains("/tmp/blacklist_b")); + EXPECT_FALSE(retrieved.contains("/tmp/blacklist_d")); + EXPECT_TRUE(retrieved.contains("/tmp/blacklist_a")); + EXPECT_TRUE(retrieved.contains("/tmp/blacklist_c")); + EXPECT_TRUE(retrieved.contains("/tmp/blacklist_e")); + + // Clean up + m.removeBlacklistedPath("/tmp/blacklist_a"); + m.removeBlacklistedPath("/tmp/blacklist_c"); + m.removeBlacklistedPath("/tmp/blacklist_e"); +} + +// --- Stop when not active (should not crash) --- +TEST(FSMonitorExtraTest, StopWhenNotActive) +{ + FSMonitor &m = FSMonitor::instance(); + EXPECT_NO_FATAL_FAILURE({ + m.stop(); + }); +} + +// --- Various getters --- +TEST(FSMonitorExtraTest, CurrentWatchCountDefault) +{ + // By default no watches + int count = FSMonitor::instance().currentWatchCount(); + EXPECT_GE(count, 0); +} + +TEST(FSMonitorExtraTest, MaxAvailableWatchCount) +{ + int maxCount = FSMonitor::instance().maxAvailableWatchCount(); + // May be -1 if not initialized, or positive if initialized + EXPECT_NO_FATAL_FAILURE({ (void)maxCount; }); +} + +TEST(FSMonitorExtraTest, IsActive_DefaultFalse) +{ + EXPECT_FALSE(FSMonitor::instance().isActive()); +} \ No newline at end of file diff --git a/autotests/index/test_fsmonitor_private.cpp b/autotests/index/test_fsmonitor_private.cpp new file mode 100644 index 00000000..c9ca3f80 --- /dev/null +++ b/autotests/index/test_fsmonitor_private.cpp @@ -0,0 +1,422 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fsmonitor_private.cpp + * @brief Tests for FSMonitorPrivate methods accessed via d_func() + * (-fno-access-control). Covers shouldExcludePath, isSymbolicLink, + * addWatchForDirectory, removeWatchForDirectory, isWithinWatchLimit, + * getMaxUserWatches, showHidden, isDirectory, handleFileCreated, + * handleFileDeleted, handleFileClosed, handleFileMoved, + * handleFastScanCompleted, handleDirectoriesBatch. + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include +#include "index_global.h" +#include "fsmonitor/fsmonitor.h" +#include "fsmonitor/fsmonitor_p.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class FSMonitorPrivateTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + QDir root(tmp.path()); + root.mkpath("subdir1/subdir2"); + createFile("normal.txt", "content"); + createFile(".hidden.txt", "hidden"); + } + + void createFile(const QString &name, const QString &content) + { + QFile f(tmp.path() + "/" + name); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } + + FSMonitorPrivate *getPrivate() + { + return FSMonitor::instance().d_func(); + } +}; + +// ---- isSymbolicLink ---- +TEST_F(FSMonitorPrivateTest, IsSymbolicLink_EmptyPath) +{ + auto *d = getPrivate(); + EXPECT_FALSE(d->isSymbolicLink("")); +} + +TEST_F(FSMonitorPrivateTest, IsSymbolicLink_RealFile) +{ + auto *d = getPrivate(); + EXPECT_FALSE(d->isSymbolicLink(tmp.path() + "/normal.txt")); +} + +TEST_F(FSMonitorPrivateTest, IsSymbolicLink_SymlinkFile) +{ + auto *d = getPrivate(); + QFile::link(tmp.path() + "/normal.txt", tmp.path() + "/link.txt"); + EXPECT_TRUE(d->isSymbolicLink(tmp.path() + "/link.txt")); +} + +// ---- shouldExcludePath ---- +TEST_F(FSMonitorPrivateTest, ShouldExcludePath_EmptyPath) +{ + auto *d = getPrivate(); + EXPECT_TRUE(d->shouldExcludePath("")); +} + +TEST_F(FSMonitorPrivateTest, ShouldExcludePath_SymlinkNotExcluded) +{ + // 事件分发不再排除 symlink：link 条目由各 runtime 的 pathPredicate 按 + // FilterPolicy::indexSymlinks 决定是否收录（filename=true，Content/Ocr=false）。 + // watch/worker 范围仍显式排除（见 AddWatchForDirectory_SymlinkRejected）。 + auto *d = getPrivate(); + QFile::link(tmp.path() + "/normal.txt", tmp.path() + "/link.txt"); + EXPECT_FALSE(d->shouldExcludePath(tmp.path() + "/link.txt")); +} + +TEST_F(FSMonitorPrivateTest, ShouldExcludePath_NonExistent) +{ + auto *d = getPrivate(); + // Non-existent path - not a symlink, may not be excluded + // Just verify no crash + EXPECT_NO_FATAL_FAILURE({ (void)d->shouldExcludePath("/nonexistent/path/file.txt"); }); +} + +TEST_F(FSMonitorPrivateTest, ShouldExcludePath_NormalFile) +{ + auto *d = getPrivate(); + // The default excludeMatcher might or might not exclude /tmp paths + EXPECT_NO_FATAL_FAILURE({ (void)d->shouldExcludePath(tmp.path() + "/normal.txt"); }); +} + +// =========================================================================== +// FSMonitor layered filtering (design 变更 2 — 重大架构调整) +// After the refactor, shouldExcludePath() only does STRUCTURAL filtering: +// - empty path +// Hidden-file filtering and blacklist matching are MOVED to per-runtime +// FSEventCollector::shouldTrackPath(). This is critical because filename profile +// must receive hidden-file events (to mark is_hidden), while Content/Ocr must +// drop them — a single global filter cannot serve both. +// Symbolic-link events are likewise dispatched (link entries are indexable for +// the filename profile); watch/worker scopes exclude symlinks explicitly. +// =========================================================================== + +TEST_F(FSMonitorPrivateTest, LayeredFilter_HiddenFileNotExcludedByShouldExcludePath) +{ + // After the refactor, shouldExcludePath must NOT filter hidden files. + // The .hidden.txt file created in SetUp() is hidden but not a symlink. + auto *d = getPrivate(); + EXPECT_FALSE(d->shouldExcludePath(tmp.path() + "/.hidden.txt")) + << "shouldExcludePath must not filter hidden files (design 变更 2)"; +} + +TEST_F(FSMonitorPrivateTest, LayeredFilter_FileInHiddenDirNotExcludedByShouldExcludePath) +{ + auto *d = getPrivate(); + QDir dir(tmp.path()); + ASSERT_TRUE(dir.mkpath(".secretdir")); + EXPECT_FALSE(d->shouldExcludePath(tmp.path() + "/.secretdir/file.txt")) + << "shouldExcludePath must not filter files in hidden dirs (design 变更 2)"; +} + +TEST_F(FSMonitorPrivateTest, LayeredFilter_BlacklistedPathNotExcludedByShouldExcludePath) +{ + // The global PathExcludeMatcher (TextIndexConfig folderExcludeFilters + anything) + // no longer applies in shouldExcludePath after the refactor. + auto *d = getPrivate(); + // /tmp is typically in the system exclude list (IndexTraverseUtils::shouldSkipDirectory) + // but shouldExcludePath only checks symlinks + empty — verify it doesn't apply TraverseUtils. + EXPECT_NO_FATAL_FAILURE({ (void)d->shouldExcludePath("/tmp/some/random/file.txt"); }); +} + +TEST_F(FSMonitorPrivateTest, LayeredFilter_UnionBlacklistExcludesIndexDirsForWatch) +{ + // FSMonitor::init() augments excludeMatcher with index directories + .avfs. + // addWatchForDirectory consults the union blacklist to skip watch establishment + // for index directories (resource optimization, death-loop prevention). + auto *d = getPrivate(); + // The index dirs are added to excludeMatcher at init() time. Since FSMonitor::instance() + // is already initialized, we verify the union matcher contains the index dir patterns + // by checking shouldExclude-like behavior on addWatchForDirectory. + // (addWatchForDirectory consults shouldExcludePath || excludeMatcher.shouldExclude) + QString filenameDir = DFMSEARCH::Global::fileNameIndexDirectory(); + if (!filenameDir.isEmpty() && QDir(filenameDir).exists()) { + // Real index dir exists — addWatchForDirectory should reject it via excludeMatcher + // (regardless of shouldExcludePath structural check). + EXPECT_FALSE(d->addWatchForDirectory(filenameDir + "/sub")); + } + SUCCEED() << "Union blacklist verification (index dir watch rejection)"; +} + +// ---- isWithinWatchLimit ---- +TEST_F(FSMonitorPrivateTest, IsWithinWatchLimit_NoMaxSet) +{ + auto *d = getPrivate(); + // maxWatches defaults to -1, so should return true + EXPECT_TRUE(d->isWithinWatchLimit()); +} + +TEST_F(FSMonitorPrivateTest, IsWithinWatchLimit_WithMaxSet) +{ + auto *d = getPrivate(); + d->maxWatches = 100; + d->maxUsagePercentage = 0.5; + d->watchedDirectories.clear(); + EXPECT_TRUE(d->isWithinWatchLimit()); +} + +TEST_F(FSMonitorPrivateTest, IsWithinWatchLimit_ExceedsLimit) +{ + auto *d = getPrivate(); + d->maxWatches = 10; + d->maxUsagePercentage = 0.5; + for (int i = 0; i < 10; i++) { + d->watchedDirectories.insert(QString("/watch%1").arg(i)); + } + EXPECT_FALSE(d->isWithinWatchLimit()); +} + +// ---- getMaxUserWatches ---- +TEST_F(FSMonitorPrivateTest, GetMaxUserWatches_ReadsFromProc) +{ + auto *d = getPrivate(); + int watches = d->getMaxUserWatches(); + // Should be positive on Linux, or -1 if file can't be read + EXPECT_GE(watches, -1); + if (watches > 0) { + EXPECT_GT(watches, 0); + } +} + +// ---- showHidden ---- +TEST_F(FSMonitorPrivateTest, ShowHidden_ReturnsBool) +{ + auto *d = getPrivate(); + bool hidden = d->showHidden(); + EXPECT_TRUE(hidden || !hidden); // Just verify no crash +} + +// ---- isDirectory (FSMonitorPrivate version) ---- +TEST_F(FSMonitorPrivateTest, IsDirectory_EmptyPath) +{ + auto *d = getPrivate(); + EXPECT_FALSE(d->isDirectory("", "file.txt")); +} + +TEST_F(FSMonitorPrivateTest, IsDirectory_RealDir) +{ + auto *d = getPrivate(); + EXPECT_TRUE(d->isDirectory(tmp.path(), "subdir1")); +} + +TEST_F(FSMonitorPrivateTest, IsDirectory_FileIsNotDir) +{ + auto *d = getPrivate(); + EXPECT_FALSE(d->isDirectory(tmp.path(), "normal.txt")); +} + +// ---- addWatchForDirectory ---- +TEST_F(FSMonitorPrivateTest, AddWatchForDirectory_EmptyPath) +{ + auto *d = getPrivate(); + EXPECT_FALSE(d->addWatchForDirectory("")); +} + +TEST_F(FSMonitorPrivateTest, AddWatchForDirectory_AlreadyWatched) +{ + auto *d = getPrivate(); + QString path = "/already/watched"; + d->watchedDirectories.insert(path); + EXPECT_TRUE(d->addWatchForDirectory(path)); +} + +TEST_F(FSMonitorPrivateTest, AddWatchForDirectory_SymlinkRejected) +{ + // watch 范围绝不包含 symlink（防索引环）——即使事件分发已放行 link 条目 + auto *d = getPrivate(); + QFile::link(tmp.path(), tmp.path() + "/dir_link"); + ASSERT_TRUE(QFileInfo::exists(tmp.path() + "/dir_link")); + EXPECT_FALSE(d->addWatchForDirectory(tmp.path() + "/dir_link")); +} + +// ---- removeWatchForDirectory ---- +TEST_F(FSMonitorPrivateTest, RemoveWatchForDirectory_EmptyPath) +{ + auto *d = getPrivate(); + EXPECT_NO_FATAL_FAILURE({ d->removeWatchForDirectory(""); }); +} + +TEST_F(FSMonitorPrivateTest, RemoveWatchForDirectory_NotWatched) +{ + auto *d = getPrivate(); + EXPECT_NO_FATAL_FAILURE({ d->removeWatchForDirectory("/not/watched"); }); +} + +TEST_F(FSMonitorPrivateTest, RemoveWatchForDirectory_Watched) +{ + auto *d = getPrivate(); + QString path = "/some/path"; + d->watchedDirectories.insert(path); + d->removeWatchForDirectory(path); + EXPECT_FALSE(d->watchedDirectories.contains(path)); +} + +// ---- addDirectoryRecursively ---- +TEST_F(FSMonitorPrivateTest, AddDirectoryRecursively_EmptyPath) +{ + auto *d = getPrivate(); + // active is false by default, so this is a no-op + EXPECT_NO_FATAL_FAILURE({ d->addDirectoryRecursively(""); }); +} + +TEST_F(FSMonitorPrivateTest, AddDirectoryRecursively_NotActive) +{ + auto *d = getPrivate(); + d->active = false; + EXPECT_NO_FATAL_FAILURE({ d->addDirectoryRecursively(tmp.path()); }); +} + +// ---- stopMonitoring ---- +TEST_F(FSMonitorPrivateTest, StopMonitoring_NotActive) +{ + auto *d = getPrivate(); + d->active = false; + EXPECT_NO_FATAL_FAILURE({ d->stopMonitoring(); }); + EXPECT_FALSE(d->active); +} + +// ---- startMonitoring ---- +TEST_F(FSMonitorPrivateTest, StartMonitoring_AlreadyActive) +{ + auto *d = getPrivate(); + d->active = true; + bool result = d->startMonitoring(); + EXPECT_TRUE(result); +} + +// ---- handleFastScanCompleted ---- +TEST_F(FSMonitorPrivateTest, HandleFastScanCompleted_Success) +{ + auto *d = getPrivate(); + EXPECT_NO_FATAL_FAILURE({ d->handleFastScanCompleted(true); }); +} + +TEST_F(FSMonitorPrivateTest, HandleFastScanCompleted_Failure) +{ + auto *d = getPrivate(); + EXPECT_NO_FATAL_FAILURE({ d->handleFastScanCompleted(false); }); +} + +// ---- handleDirectoriesBatch ---- +TEST_F(FSMonitorPrivateTest, HandleDirectoriesBatch_EmptyList) +{ + auto *d = getPrivate(); + EXPECT_NO_FATAL_FAILURE({ d->handleDirectoriesBatch(QStringList{}); }); +} + +TEST_F(FSMonitorPrivateTest, HandleDirectoriesBatch_SinglePath) +{ + auto *d = getPrivate(); + d->maxWatches = 10000; + EXPECT_NO_FATAL_FAILURE({ d->handleDirectoriesBatch(QStringList{tmp.path()}); }); +} + +TEST_F(FSMonitorPrivateTest, HandleDirectoriesBatch_ExceedsWatchLimit) +{ + auto *d = getPrivate(); + d->maxWatches = 1; + d->maxUsagePercentage = 0.5; + EXPECT_NO_FATAL_FAILURE({ d->handleDirectoriesBatch(QStringList{tmp.path()}); }); +} + +// ---- travelRootDirectories ---- +TEST_F(FSMonitorPrivateTest, TravelRootDirectories) +{ + auto *d = getPrivate(); + EXPECT_NO_FATAL_FAILURE({ d->travelRootDirectories(); }); +} + +// ---- handleFile* signals (private handlers) ---- +TEST_F(FSMonitorPrivateTest, HandleFileCreated_NotActive) +{ + auto *d = getPrivate(); + d->active = false; + EXPECT_NO_FATAL_FAILURE({ d->handleFileCreated("/path", "file.txt"); }); +} + +TEST_F(FSMonitorPrivateTest, HandleFileCreated_ActiveEmptyPath) +{ + auto *d = getPrivate(); + d->active = true; + EXPECT_NO_FATAL_FAILURE({ d->handleFileCreated("", "file.txt"); }); +} + +TEST_F(FSMonitorPrivateTest, HandleFileDeleted_NotActive) +{ + auto *d = getPrivate(); + d->active = false; + EXPECT_NO_FATAL_FAILURE({ d->handleFileDeleted("/path", "file.txt"); }); +} + +TEST_F(FSMonitorPrivateTest, HandleFileClosed_NotActive) +{ + auto *d = getPrivate(); + d->active = false; + EXPECT_NO_FATAL_FAILURE({ d->handleFileClosed("/path", "file.txt"); }); +} + +TEST_F(FSMonitorPrivateTest, HandleFileMoved_NotActive) +{ + auto *d = getPrivate(); + d->active = false; + EXPECT_NO_FATAL_FAILURE({ d->handleFileMoved("/from", "f.txt", "/to", "t.txt"); }); +} + +// ---- init with QStringList ---- +TEST_F(FSMonitorPrivateTest, Init_EmptyRootPaths) +{ + auto *d = getPrivate(); + bool result = d->init(QStringList{}); + EXPECT_FALSE(result); +} + +TEST_F(FSMonitorPrivateTest, Init_NonExistentPaths) +{ + auto *d = getPrivate(); + bool result = d->init(QStringList{"/nonexistent/path12345"}); + EXPECT_FALSE(result); +} + +// ---- setUseFastScan while active (should be no-op) ---- +TEST_F(FSMonitorPrivateTest, SetUseFastScan_WhileActive_NoChange) +{ + FSMonitor &m = FSMonitor::instance(); + bool origValue = m.useFastScan(); + // Simulate being active (just set the flag) + m.d_func()->active = true; + m.setUseFastScan(!origValue); + // Should be unchanged because active + EXPECT_EQ(m.useFastScan(), origValue); + m.d_func()->active = false; + // Restore + m.setUseFastScan(true); +} diff --git a/autotests/index/test_fsmonitorworker.cpp b/autotests/index/test_fsmonitorworker.cpp new file mode 100644 index 00000000..c691ef5e --- /dev/null +++ b/autotests/index/test_fsmonitorworker.cpp @@ -0,0 +1,186 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fsmonitorworker.cpp + * @brief Unit tests for FSMonitorWorker (fsmonitor/fsmonitorworker.cpp) — the + * dependency-light subset: ctor, processDirectory (which exercises the + * default exclusion-checker lambda wired up in the ctor), + * setExclusionChecker, setMaxFastScanResults and the dtor. The async + * tryFastDirectoryScan / CLI / SearchEngine paths are intentionally not + * invoked to avoid spawning subprocesses. + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "fsmonitor/fsmonitorworker.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class FSMonitorWorkerTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + QDir root(tmp.path()); + ASSERT_TRUE(root.mkpath("child")); + } +}; + +TEST_F(FSMonitorWorkerTest, CtorDefaultsFastScanNotInProgress) +{ + FSMonitorWorker w; + EXPECT_FALSE(w.isFastScanInProgress()); +} + +TEST_F(FSMonitorWorkerTest, ProcessDirectorySkipsEmptyAndNonDir) +{ + FSMonitorWorker w; + EXPECT_NO_FATAL_FAILURE({ w.processDirectory(QString()); }); + EXPECT_NO_FATAL_FAILURE({ w.processDirectory(tmp.path() + "/does-not-exist"); }); +} + +TEST_F(FSMonitorWorkerTest, ProcessDirectoryEmitsForRealDir) +{ + FSMonitorWorker w; + bool got = false; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got](const QString &) { got = true; }); + w.processDirectory(tmp.path()); + EXPECT_TRUE(got); // default exclusion lambda returns false -> emits +} + +TEST_F(FSMonitorWorkerTest, ProcessDirectoryRespectsExclusionChecker) +{ + FSMonitorWorker w; + w.setExclusionChecker([](const QString &) { return true; }); // exclude all + bool got = false; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got](const QString &) { got = true; }); + w.processDirectory(tmp.path()); + EXPECT_FALSE(got); // excluded -> no emit +} + +TEST_F(FSMonitorWorkerTest, SetExclusionCheckerIgnoresNullChecker) +{ + FSMonitorWorker w; + w.setExclusionChecker([](const QString &) { return true; }); + w.setExclusionChecker(nullptr); // null -> keep previous + bool got = false; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got](const QString &) { got = true; }); + w.processDirectory(tmp.path()); + EXPECT_FALSE(got); // still excluded +} + +TEST_F(FSMonitorWorkerTest, SetMaxFastScanResultsAcceptsPositive) +{ + FSMonitorWorker w; + w.setMaxFastScanResults(128); + EXPECT_NO_FATAL_FAILURE({ (void)w.isFastScanInProgress(); }); +} + +TEST_F(FSMonitorWorkerTest, SetMaxFastScanResultsIgnoresNonPositive) +{ + FSMonitorWorker w; + w.setMaxFastScanResults(0); + w.setMaxFastScanResults(-5); + EXPECT_NO_FATAL_FAILURE({ (void)w.isFastScanInProgress(); }); +} + +TEST_F(FSMonitorWorkerTest, ProcessDirectoryWithSubdirs) +{ + FSMonitorWorker w; + QStringList subs; + QObject::connect(&w, &FSMonitorWorker::subdirectoriesFound, &w, + [&subs](const QStringList &dirs) { subs.append(dirs); }); + w.processDirectory(tmp.path()); + // "child" should be found as a subdirectory + EXPECT_FALSE(subs.isEmpty()); +} + +TEST_F(FSMonitorWorkerTest, ProcessDirectoryExcludesSymlinkSubdirs) +{ + FSMonitorWorker w; + // Create a symlink directory + QString linkPath = tmp.path() + "/symlink_child"; + ASSERT_TRUE(QFile::link(tmp.path() + "/child", linkPath)); + + QStringList subs; + QObject::connect(&w, &FSMonitorWorker::subdirectoriesFound, &w, + [&subs](const QStringList &dirs) { subs.append(dirs); }); + w.processDirectory(tmp.path()); + // symlink_child should NOT be in subs (symlinks filtered) + for (const QString &s : subs) { + EXPECT_NE(s, linkPath); + } +} + +TEST_F(FSMonitorWorkerTest, ProcessDirectorySelectiveExclusion) +{ + FSMonitorWorker w; + w.setExclusionChecker([](const QString &path) { return path.contains("child"); }); + QStringList subs; + QObject::connect(&w, &FSMonitorWorker::subdirectoriesFound, &w, + [&subs](const QStringList &dirs) { subs.append(dirs); }); + w.processDirectory(tmp.path()); + // child should be excluded from subdirs + for (const QString &s : subs) { + EXPECT_FALSE(s.contains("child")); + } +} + +TEST_F(FSMonitorWorkerTest, TryFastDirectoryScan_WhileInProgress_Ignored) +{ + FSMonitorWorker w; + // Force fastScanInProgress to true + w.fastScanInProgress = true; + + bool completed = false; + QObject::connect(&w, &FSMonitorWorker::fastScanCompleted, &w, + [&completed](bool) { completed = true; }); + + // This should early-return with warning + w.tryFastDirectoryScan(); + + // No completion should be emitted since we didn't start a real scan + EXPECT_FALSE(completed); + EXPECT_TRUE(w.isFastScanInProgress()); + + w.fastScanInProgress = false; +} + +TEST_F(FSMonitorWorkerTest, HandleFastScanResult_EmptyResult) +{ + FSMonitorWorker w; + // We need to trigger handleFastScanResult. We can't easily call it directly + // (it's private slot), so we stub tryFastDirectoryScan's async operation. + // Instead, just verify the object works after fast scan state changes. + w.fastScanInProgress = true; + // Simulate reset (what handleFastScanResult does at end) + w.fastScanInProgress = false; + EXPECT_FALSE(w.isFastScanInProgress()); +} + +TEST_F(FSMonitorWorkerTest, Dtor_WithRunningFuture_NoCrash) +{ + // Create worker, start fast scan (it will run in background), then destroy + // The destructor waits for the future + auto *w = new FSMonitorWorker(); + // Don't actually call tryFastDirectoryScan() as it launches real subprocesses + // Just verify normal destruction works + delete w; + SUCCEED(); +} diff --git a/autotests/index/test_fsmonitorworker_extra.cpp b/autotests/index/test_fsmonitorworker_extra.cpp new file mode 100644 index 00000000..ed176cf3 --- /dev/null +++ b/autotests/index/test_fsmonitorworker_extra.cpp @@ -0,0 +1,175 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_fsmonitorworker_extra.cpp + * @brief Additional tests for FSMonitorWorker covering more code paths. + */ + +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "fsmonitor/fsmonitorworker.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class FSMonitorWorkerExtraTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + // Create a complex directory structure + QDir root(tmp.path()); + root.mkpath("level1/level2/level3"); + root.mkpath("another/deep/path"); + root.mkpath("hidden_dir"); + QFile f(tmp.path() + "/file.txt"); + f.open(QIODevice::WriteOnly); + f.write("data"); + f.close(); + } +}; + +// Test processDirectory with deep nesting +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_DeepNesting) +{ + FSMonitorWorker w; + QStringList subs; + QObject::connect(&w, &FSMonitorWorker::subdirectoriesFound, &w, + [&subs](const QStringList &dirs) { subs.append(dirs); }); + w.processDirectory(tmp.path()); + // Should find level1 and another at minimum + EXPECT_GE(subs.size(), 2); +} + +// Test processDirectory with exclusion checker that returns false for all +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_NoExclusion) +{ + FSMonitorWorker w; + w.setExclusionChecker([](const QString &) { return false; }); + + int watchCount = 0; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&watchCount](const QString &) { watchCount++; }); + + w.processDirectory(tmp.path()); + EXPECT_GT(watchCount, 0); +} + +// Test processDirectory with exclusion checker that returns true for root only +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_ExcludeRoot) +{ + FSMonitorWorker w; + QString rootPath = tmp.path(); + w.setExclusionChecker([rootPath](const QString &path) { return path == rootPath; }); + + bool got = false; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got](const QString &) { got = true; }); + w.processDirectory(rootPath); + EXPECT_FALSE(got); +} + +// Test processDirectory with file path instead of directory +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_PathIsFile) +{ + FSMonitorWorker w; + bool got = false; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got](const QString &) { got = true; }); + // Pass a file path - processDirectory should handle gracefully + w.processDirectory(tmp.path() + "/file.txt"); + // Should not emit directoryToWatch since it's a file + SUCCEED(); +} + +// Test processDirectory with path containing spaces +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_PathWithSpaces) +{ + QString dirWithSpaces = tmp.path() + "/dir with spaces"; + QDir().mkpath(dirWithSpaces); + + FSMonitorWorker w; + bool got = false; + QString capturedDir = dirWithSpaces; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got, &capturedDir](const QString &path) { + if (path == capturedDir) got = true; + }); + w.processDirectory(dirWithSpaces); + EXPECT_TRUE(got); +} + +// Test processDirectory with path containing unicode +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_PathWithUnicode) +{ + QString unicodeDir = tmp.path() + "/中文目录"; + QDir().mkpath(unicodeDir); + + FSMonitorWorker w; + bool got = false; + QString capturedDir = unicodeDir; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got, &capturedDir](const QString &path) { + if (path == capturedDir) got = true; + }); + w.processDirectory(unicodeDir); + EXPECT_TRUE(got); +} + +// Test processDirectory with exclusion returning true for subdirs +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_ExcludeSubdirs) +{ + FSMonitorWorker w; + w.setExclusionChecker([](const QString &path) { return path.contains("level"); }); + + QStringList subs; + QObject::connect(&w, &FSMonitorWorker::subdirectoriesFound, &w, + [&subs](const QStringList &dirs) { subs.append(dirs); }); + w.processDirectory(tmp.path()); + for (const QString &s : subs) { + EXPECT_FALSE(s.contains("level")); + } +} + +// Test setExclusionChecker with empty function +TEST_F(FSMonitorWorkerExtraTest, SetExclusionChecker_EmptyFunc) +{ + FSMonitorWorker w; + // Set a checker that always returns false + w.setExclusionChecker([](const QString &) { return false; }); + + bool got = false; + QObject::connect(&w, &FSMonitorWorker::directoryToWatch, &w, + [&got](const QString &) { got = true; }); + w.processDirectory(tmp.path()); + EXPECT_TRUE(got); +} + +// Test setMaxFastScanResults with various values +TEST_F(FSMonitorWorkerExtraTest, SetMaxFastScanResults_Varied) +{ + FSMonitorWorker w; + w.setMaxFastScanResults(1); + w.setMaxFastScanResults(100); + w.setMaxFastScanResults(10000); + w.setMaxFastScanResults(INT_MAX); + SUCCEED(); +} + +// Test that processDirectory handles root directory +TEST_F(FSMonitorWorkerExtraTest, ProcessDirectory_RootDir) +{ + FSMonitorWorker w; + // Process root directory - should work without crash + // (might be excluded by default checker) + EXPECT_NO_FATAL_FAILURE({ w.processDirectory("/"); }); +} diff --git a/autotests/index/test_idlemonitor_extra.cpp b/autotests/index/test_idlemonitor_extra.cpp new file mode 100644 index 00000000..407c5b4f --- /dev/null +++ b/autotests/index/test_idlemonitor_extra.cpp @@ -0,0 +1,137 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_idlemonitor.cpp + * @brief Additional unit tests for IdleMonitor (env/idlemonitor.cpp) + * Appended to improve coverage of onTimeoutReached, onResumingFromIdle, + * stop-when-not-started, start-twice, and idle() getter. + */ + +#include +#include +#include + +#include "stubext.h" + +#include "index_global.h" +#include "env/idlemonitor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class IdleMonitorExtraTest : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + monitor = std::make_unique(); + } + + void TearDown() override + { + monitor.reset(); + } + + std::unique_ptr app; + std::unique_ptr monitor; + + static int argc; + static char *argv[]; +}; + +int IdleMonitorExtraTest::argc = 1; +char *IdleMonitorExtraTest::argv[] = { const_cast("test_idlemonitor_extra") }; + +TEST_F(IdleMonitorExtraTest, IdleDefaultFalse) +{ + EXPECT_FALSE(monitor->idle()); +} + +TEST_F(IdleMonitorExtraTest, StopWhenNotStarted_NoCrash) +{ + // stop() checks m_started; when false, returns immediately + EXPECT_NO_FATAL_FAILURE({ monitor->stop(); }); + EXPECT_FALSE(monitor->idle()); +} + +TEST_F(IdleMonitorExtraTest, StartTwice_NoCrash) +{ + monitor->start(); + monitor->start(); + // Second call returns early because m_started is already true + monitor->stop(); + SUCCEED(); +} + +TEST_F(IdleMonitorExtraTest, StopTwice_NoCrash) +{ + monitor->start(); + monitor->stop(); + monitor->stop(); + EXPECT_FALSE(monitor->idle()); +} + +TEST_F(IdleMonitorExtraTest, OnTimeoutReached_SetsIdle) +{ + QSignalSpy spy(monitor.get(), &IdleMonitor::idleChanged); + // Force started so the slot does real work + monitor->m_started = true; + + monitor->onTimeoutReached(1, 30000); + + EXPECT_TRUE(monitor->idle()); + EXPECT_EQ(spy.count(), 1); + EXPECT_TRUE(spy.at(0).at(0).toBool()); + + monitor->stop(); +} + +TEST_F(IdleMonitorExtraTest, OnTimeoutReached_WhenAlreadyIdle_NoExtraSignal) +{ + QSignalSpy spy(monitor.get(), &IdleMonitor::idleChanged); + monitor->m_started = true; + monitor->m_idle = true; + + monitor->onTimeoutReached(1, 30000); + + // Already idle, setIdle not called -> no signal + EXPECT_EQ(spy.count(), 0); + + monitor->stop(); +} + +TEST_F(IdleMonitorExtraTest, OnResumingFromIdle_ClearsIdle) +{ + QSignalSpy spy(monitor.get(), &IdleMonitor::idleChanged); + monitor->m_started = true; + monitor->m_idle = true; + + monitor->onResumingFromIdle(); + + EXPECT_FALSE(monitor->idle()); + EXPECT_EQ(spy.count(), 1); + EXPECT_FALSE(spy.at(0).at(0).toBool()); + + monitor->stop(); +} + +TEST_F(IdleMonitorExtraTest, OnResumingFromIdle_WhenNotIdle_NoSignal) +{ + QSignalSpy spy(monitor.get(), &IdleMonitor::idleChanged); + monitor->m_idle = false; + + monitor->onResumingFromIdle(); + + EXPECT_EQ(spy.count(), 0); +} + +TEST_F(IdleMonitorExtraTest, DestroyWhileStarted_NoCrash) +{ + // Let the unique_ptr destructor call ~IdleMonitor while started + monitor->start(); + monitor.reset(); + SUCCEED(); +} \ No newline at end of file diff --git a/autotests/index/test_index_directory_exclusion.cpp b/autotests/index/test_index_directory_exclusion.cpp new file mode 100644 index 00000000..8f49e5bc --- /dev/null +++ b/autotests/index/test_index_directory_exclusion.cpp @@ -0,0 +1,198 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_index_directory_exclusion.cpp + * @brief Tests for the index-directory exclusion mechanism (design 5.11). + * Verifies that: + * 1. IndexProfile::filename() FilterPolicy.blacklistProvider returns a list + * including the three index directories + ".avfs". + * 2. The provider's output, when fed to PathExcludeMatcher, excludes paths + * inside the index directories (prevents the self-indexing infinite loop). + * 3. Non-index paths under $HOME are NOT excluded (regular files still indexed). + * + * This is a high-risk item (design 10.1 "索引死循环更新") — the exclusion is the + * primary defense and must be covered by a deterministic unit test. + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "utils/pathexcludematcher.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +// Stub Global::xxxIndexDirectory to return new paths so the filename profile's +// blacklistProvider (which calls these) produces deterministic results regardless +// of the installed libdfm6-search version. +struct IndexDirStubs +{ + stub_ext::StubExt stub; + QString fnDir { QDir::homePath() + "/.local/share/deepin/dde-file-manager/filename-index" }; + QString cDir { QDir::homePath() + "/.local/share/deepin/dde-file-manager/fulltext-index" }; + QString oDir { QDir::homePath() + "/.local/share/deepin/dde-file-manager/ocrtext-index" }; + + IndexDirStubs() + { + stub.set_lamda(ADDR(Global, fileNameIndexDirectory), + [this]() -> QString { __DBG_STUB_INVOKE__ return fnDir; }); + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { __DBG_STUB_INVOKE__ return cDir; }); + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + [this]() -> QString { __DBG_STUB_INVOKE__ return oDir; }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { __DBG_STUB_INVOKE__ return QStringList(); }); + } +}; + +// --- Filename profile blacklist provider content --- + +TEST(IndexDirectoryExclusionTest, FilenameBlacklistProvider_IncludesAllIndexDirs) +{ + IndexDirStubs stubs; + IndexProfile p = IndexProfile::filename(); + ASSERT_TRUE(p.filterPolicy().blacklistProvider); + QStringList bl = p.filterPolicy().blacklistProvider(); + + // The three index directories must be present (death-loop prevention). + // We compare canonicalized paths because the provider returns the exact path + // from Global::xxxIndexDirectory(), which may contain trailing differences. + auto canonicalize = [](const QString &s) { + return QDir(QFileInfo(s).absolutePath()).absolutePath(); + }; + + bool hasFilename = false, hasContent = false, hasOcr = false, hasAvfs = false; + for (const QString &entry : bl) { + if (entry.contains("filename-index")) hasFilename = true; + if (entry.contains("fulltext-index")) hasContent = true; + if (entry.contains("ocrtext-index")) hasOcr = true; + if (entry == ".avfs") hasAvfs = true; + } + EXPECT_TRUE(hasFilename) << "filename index dir must be in blacklist"; + EXPECT_TRUE(hasContent) << "content index dir must be in blacklist"; + EXPECT_TRUE(hasOcr) << "ocr index dir must be in blacklist"; + EXPECT_TRUE(hasAvfs) << ".avfs must be in blacklist"; +} + +TEST(IndexDirectoryExclusionTest, FilenameBlacklist_ExcludesIndexPath) +{ + IndexDirStubs stubs; + IndexProfile p = IndexProfile::filename(); + QStringList bl = p.filterPolicy().blacklistProvider(); + PathExcludeMatcher matcher(bl); + + // A path inside the filename index directory must be excluded. + QString filenameDir = DFMSEARCH::Global::fileNameIndexDirectory(); + ASSERT_FALSE(filenameDir.isEmpty()); + QString inner = filenameDir + "/segments_1"; + EXPECT_TRUE(matcher.shouldExclude(inner)) << "Path inside index dir must be excluded"; +} + +TEST(IndexDirectoryExclusionTest, FilenameBlacklist_ExcludesContentIndexPath) +{ + IndexDirStubs stubs; + IndexProfile p = IndexProfile::filename(); + QStringList bl = p.filterPolicy().blacklistProvider(); + PathExcludeMatcher matcher(bl); + + QString contentDir = DFMSEARCH::Global::contentIndexDirectory(); + ASSERT_FALSE(contentDir.isEmpty()); + EXPECT_TRUE(matcher.shouldExclude(contentDir + "/write.lock")); +} + +TEST(IndexDirectoryExclusionTest, FilenameBlacklist_ExcludesOcrIndexPath) +{ + IndexDirStubs stubs; + IndexProfile p = IndexProfile::filename(); + QStringList bl = p.filterPolicy().blacklistProvider(); + PathExcludeMatcher matcher(bl); + + QString ocrDir = DFMSEARCH::Global::ocrTextIndexDirectory(); + ASSERT_FALSE(ocrDir.isEmpty()); + EXPECT_TRUE(matcher.shouldExclude(ocrDir + "/_0.cfs")); +} + +TEST(IndexDirectoryExclusionTest, FilenameBlacklist_ExcludesAvfsPath) +{ + IndexDirStubs stubs; + IndexProfile p = IndexProfile::filename(); + QStringList bl = p.filterPolicy().blacklistProvider(); + PathExcludeMatcher matcher(bl); + + // ".avfs" is registered as an ExactName pattern — any path whose name component + // equals ".avfs" is excluded. + EXPECT_TRUE(matcher.shouldExclude("/home/user/.avfs/file.txt")); +} + +TEST(IndexDirectoryExclusionTest, FilenameBlacklist_DoesNotExcludeRegularHomeFile) +{ + IndexDirStubs stubs; + IndexProfile p = IndexProfile::filename(); + QStringList bl = p.filterPolicy().blacklistProvider(); + PathExcludeMatcher matcher(bl); + + // A normal home path (not inside any index dir) must NOT be excluded. + QString home = QStandardPaths::writableLocation(QStandardPaths::HomeLocation); + ASSERT_FALSE(home.isEmpty()); + QString regular = home + "/Documents/readme.txt"; + EXPECT_FALSE(matcher.shouldExclude(regular)) << "Regular home file must not be excluded"; +} + +TEST(IndexDirectoryExclusionTest, FilenameBlacklist_DoesNotExcludeTmpFile) +{ + IndexDirStubs stubs; + IndexProfile p = IndexProfile::filename(); + QStringList bl = p.filterPolicy().blacklistProvider(); + PathExcludeMatcher matcher(bl); + + EXPECT_FALSE(matcher.shouldExclude("/tmp/normal-file.txt")); + EXPECT_FALSE(matcher.shouldExclude(QStringLiteral("/usr/bin/ls"))); +} + +// --- Content/Ocr profiles: no custom blacklistProvider → use global createForIndex() --- + +TEST(IndexDirectoryExclusionTest, ContentProfile_NoCustomBlacklistProvider) +{ + IndexProfile p = IndexProfile::content(); + // Content profile does not set a custom blacklistProvider; it relies on the + // global createForIndex() matcher (TextIndexConfig folderExcludeFilters + anything). + EXPECT_FALSE(p.filterPolicy().blacklistProvider); +} + +TEST(IndexDirectoryExclusionTest, OcrProfile_NoCustomBlacklistProvider) +{ + IndexProfile p = IndexProfile::ocr(); + EXPECT_FALSE(p.filterPolicy().blacklistProvider); +} + +// --- Combined matcher (union) used by FSMonitorWorker for watch establishment --- + +TEST(IndexDirectoryExclusionTest, UnionMatcher_ExcludesAllIndexDirsAndAvfs) +{ + IndexDirStubs stubs; + // FSMonitor::init() builds a union matcher = createForIndex() + 3 index dirs + .avfs. + PathExcludeMatcher unionMatcher = PathExcludeMatcher::createForIndex(); + unionMatcher.addPattern(DFMSEARCH::Global::fileNameIndexDirectory()); + unionMatcher.addPattern(DFMSEARCH::Global::contentIndexDirectory()); + unionMatcher.addPattern(DFMSEARCH::Global::ocrTextIndexDirectory()); + unionMatcher.addPattern(QStringLiteral(".avfs")); + + EXPECT_TRUE(unionMatcher.shouldExclude(DFMSEARCH::Global::fileNameIndexDirectory() + "/x")); + EXPECT_TRUE(unionMatcher.shouldExclude(DFMSEARCH::Global::contentIndexDirectory() + "/x")); + EXPECT_TRUE(unionMatcher.shouldExclude(DFMSEARCH::Global::ocrTextIndexDirectory() + "/x")); + EXPECT_TRUE(unionMatcher.shouldExclude("/home/user/.avfs/y")); + EXPECT_FALSE(unionMatcher.shouldExclude("/home/user/Documents/readme.txt")); +} diff --git a/autotests/index/test_indexcontentmigrator.cpp b/autotests/index/test_indexcontentmigrator.cpp new file mode 100644 index 00000000..29fc0009 --- /dev/null +++ b/autotests/index/test_indexcontentmigrator.cpp @@ -0,0 +1,90 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indexcontentmigrator.cpp + * @brief Unit tests for IndexContentMigrator (task/indexcontentmigrator.cpp) + * — the dependency-light subset: default state (isActive/lookupContent/ + * cleanup as no-ops), prepare() with empty/nonexistent index dir (early + * returns false, no lucene), and hasResidue() static check. The full + * lucene open path is intentionally not exercised. + */ + +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "task/indexcontentmigrator.h" +#include "profile/indexprofile.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +static IndexProfile makeMigratorProfile() +{ + return IndexProfile({ IndexProfile::Type::Content, + "migrator_test", + "migrator_status.json", + "migrator_version", + 1 }, + { []() -> QString { return "/tmp/dfm_migrator_test"; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); +} + +TEST(IndexContentMigratorTest, DefaultNotActive) +{ + IndexContentMigrator m; + EXPECT_FALSE(m.isActive()); +} + +TEST(IndexContentMigratorTest, LookupContentWhenNotActiveReturnsNullopt) +{ + IndexContentMigrator m; + auto result = m.lookupContent("/some/file.txt"); + EXPECT_FALSE(result.has_value()); +} + +TEST(IndexContentMigratorTest, CleanupWhenNotActiveIsNoOp) +{ + IndexContentMigrator m; + EXPECT_NO_FATAL_FAILURE({ m.cleanup(); }); +} + +TEST(IndexContentMigratorTest, PrepareEmptyIndexDirReturnsFalse) +{ + IndexContentMigrator m; + EXPECT_FALSE(m.prepare(QString(), makeMigratorProfile())); + EXPECT_FALSE(m.isActive()); +} + +TEST(IndexContentMigratorTest, PrepareNonexistentIndexDirReturnsFalse) +{ + IndexContentMigrator m; + EXPECT_FALSE(m.prepare("/nonexistent/dfm/index/dir", makeMigratorProfile())); + EXPECT_FALSE(m.isActive()); +} + +TEST(IndexContentMigratorTest, HasResidueOnNonexistentDirReturnsFalse) +{ + EXPECT_FALSE(IndexContentMigrator::hasResidue("/nonexistent/dfm/index/dir")); +} + +TEST(IndexContentMigratorTest, HasResidueOnEmptyDirReturnsFalse) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + EXPECT_FALSE(IndexContentMigrator::hasResidue(tmp.path())); +} + +TEST(IndexContentMigratorTest, HasResidueDetectsOldDir) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + QDir().mkpath(tmp.path() + ".old"); + EXPECT_TRUE(IndexContentMigrator::hasResidue(tmp.path())); +} diff --git a/autotests/index/test_indexextractor.cpp b/autotests/index/test_indexextractor.cpp new file mode 100644 index 00000000..30831469 --- /dev/null +++ b/autotests/index/test_indexextractor.cpp @@ -0,0 +1,51 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indexextractor.cpp + * @brief Unit tests for IndexExtractor interface and IndexExtractionResult + */ + +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "extractor/indexextractor.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(IndexExtractionResultTest, DefaultValues) +{ + IndexExtractionResult result; + EXPECT_FALSE(result.success); + EXPECT_TRUE(result.text.isEmpty()); + EXPECT_TRUE(result.error.isEmpty()); + EXPECT_TRUE(result.checksum.isEmpty()); + EXPECT_FALSE(result.deduplicated); +} + +TEST(IndexExtractionResultTest, SuccessResult) +{ + IndexExtractionResult result; + result.success = true; + result.text = "hello world"; + result.checksum = "abc123"; + result.deduplicated = true; + + EXPECT_TRUE(result.success); + EXPECT_EQ(result.text, "hello world"); + EXPECT_EQ(result.checksum, "abc123"); + EXPECT_TRUE(result.deduplicated); +} + +TEST(IndexExtractionResultTest, ErrorResult) +{ + IndexExtractionResult result; + result.success = false; + result.error = "File not found"; + + EXPECT_FALSE(result.success); + EXPECT_TRUE(result.text.isEmpty()); + EXPECT_EQ(result.error, "File not found"); +} \ No newline at end of file diff --git a/autotests/index/test_indexprofile.cpp b/autotests/index/test_indexprofile.cpp new file mode 100644 index 00000000..3e85a522 --- /dev/null +++ b/autotests/index/test_indexprofile.cpp @@ -0,0 +1,585 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indexprofile.cpp + * @brief Unit tests for IndexProfile (indexprofile.cpp) + */ + +#include +#include +#include +#include +#include + +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "utils/textindexconfig.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +// Helper to stub Global::fileNameIndexDirectory to return a path containing +// "filename-index" (the installed libdfm6-search may still return the old +// /run/user//deepin-anything-server path). The stub is scoped to the test. +struct FilenameDirStub +{ + stub_ext::StubExt stub; + QString fnDir { QDir::homePath() + "/.local/share/deepin/dde-file-manager/filename-index" }; + FilenameDirStub() + { + stub.set_lamda(ADDR(Global, fileNameIndexDirectory), + [this]() -> QString { __DBG_STUB_INVOKE__ return fnDir; }); + stub.set_lamda(ADDR(Global, contentIndexDirectory), + []() -> QString { __DBG_STUB_INVOKE__ + return QDir::homePath() + "/.local/share/deepin/dde-file-manager/fulltext-index"; }); + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + []() -> QString { __DBG_STUB_INVOKE__ + return QDir::homePath() + "/.local/share/deepin/dde-file-manager/ocrtext-index"; }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { __DBG_STUB_INVOKE__ return QStringList(); }); + } +}; + +static IndexProfile makeProfile() +{ + return IndexProfile( + IndexProfile::Identity { IndexProfile::Type::Content, "testprofile", "test_status.json", "test_version", 1 }, + { []() -> QString { return "/tmp/dfm_test_index"; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); +} + +TEST(IndexProfileTest, TypeContent) +{ + IndexProfile p = makeProfile(); + EXPECT_EQ(p.type(), IndexProfile::Type::Content); +} + +TEST(IndexProfileTest, IdAccessor) +{ + IndexProfile p = makeProfile(); + EXPECT_EQ(p.id(), QString("testprofile")); +} + +TEST(IndexProfileTest, VersionKeyAccessor) +{ + IndexProfile p = makeProfile(); + EXPECT_EQ(p.versionKey(), QString("test_version")); +} + +TEST(IndexProfileTest, RuntimeIndexVersion) +{ + IndexProfile p = makeProfile(); + EXPECT_EQ(p.runtimeIndexVersion(), 1); +} + +TEST(IndexProfileTest, IndexDirectory) +{ + IndexProfile p = makeProfile(); + EXPECT_EQ(p.indexDirectory(), QString("/tmp/dfm_test_index")); +} + +TEST(IndexProfileTest, StatusFilePath) +{ + IndexProfile p = makeProfile(); + QString sfp = p.statusFilePath(); + EXPECT_FALSE(sfp.isEmpty()); + EXPECT_TRUE(sfp.contains("test_status.json")); +} + +TEST(IndexProfileTest, IsIndexAvailable) +{ + IndexProfile p = makeProfile(); + EXPECT_TRUE(p.isIndexAvailable()); +} + +TEST(IndexProfileTest, IsPathInScope) +{ + IndexProfile p = makeProfile(); + EXPECT_TRUE(p.isPathInScope("/any/path")); +} + +TEST(IndexProfileTest, IsCandidateFile) +{ + IndexProfile p = makeProfile(); + EXPECT_TRUE(p.isCandidateFile("/any/file.txt")); +} + +TEST(IndexProfileTest, SupportsAnything) +{ + IndexProfile p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.supportsAnything(); }); +} + +TEST(IndexProfileTest, AnythingSearchOptions) +{ + IndexProfile p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.anythingSearchOptions(); }); +} + +TEST(IndexProfileTest, ComputeChecksumUnsupported) +{ + IndexProfile p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.computeChecksum("/some/file"); }); +} + +TEST(IndexProfileTest, LookupCachedTextUnsupported) +{ + IndexProfile p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.lookupCachedText("checksum"); }); +} + +TEST(IndexProfileTest, SupportsChecksum) +{ + IndexProfile p = makeProfile(); + EXPECT_FALSE(p.supportsChecksum()); +} + +TEST(IndexProfileTest, PathFieldNonEmpty) +{ + IndexProfile p = makeProfile(); + EXPECT_NE(p.pathField(), nullptr); +} + +TEST(IndexProfileTest, ContentFieldNonEmpty) +{ + IndexProfile p = makeProfile(); + EXPECT_NE(p.contentField(), nullptr); +} + +TEST(IndexProfileTest, AncestorPathsFieldNonEmpty) +{ + IndexProfile p = makeProfile(); + EXPECT_NE(p.ancestorPathsField(), nullptr); +} + +TEST(IndexProfileTest, ModifyTimeField) +{ + IndexProfile p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.modifyTimeField(); }); +} + +TEST(IndexProfileTest, SupportsModifiedTimestampCheck) +{ + IndexProfile p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.supportsModifiedTimestampCheck(); }); +} + +TEST(IndexProfileTest, CreateAnalyzer) +{ + IndexProfile p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.createAnalyzer(); }); +} + +TEST(IndexProfileTest, MaxFileTruncationSizeMBPositive) +{ + IndexProfile p = makeProfile(); + EXPECT_GT(p.maxFileTruncationSizeMB(), 0); +} + +TEST(IndexProfileTest, ContentFactoryReturnsProfile) +{ + IndexProfile p = IndexProfile::content(); + EXPECT_EQ(p.type(), IndexProfile::Type::Content); +} + +TEST(IndexProfileTest, OcrFactoryReturnsProfile) +{ + IndexProfile p = IndexProfile::ocr(); + EXPECT_EQ(p.type(), IndexProfile::Type::Ocr); +} + +// ---- Coverage additions: more IndexProfile API ---- + +TEST(IndexProfileTest, ProfileIdAndStatusFilePath) +{ + auto p = makeProfile(); + EXPECT_FALSE(p.id().isEmpty()); + EXPECT_NO_FATAL_FAILURE({ (void)p.statusFilePath(); }); +} + +TEST(IndexProfileTest, ProfileIndexDirectoryCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.indexDirectory(); }); +} + +TEST(IndexProfileTest, ProfileVersionKeyCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.versionKey(); }); +} + +TEST(IndexProfileTest, ProfileIsIndexAvailableCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.isIndexAvailable(); }); +} + +TEST(IndexProfileTest, ProfileRuntimeIndexVersionCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.runtimeIndexVersion(); }); +} + +TEST(IndexProfileTest, ProfileSupportsAnythingCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.supportsAnything(); }); +} + +TEST(IndexProfileTest, ProfileIsPathInScopeCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.isPathInScope("/tmp"); }); +} + +TEST(IndexProfileTest, ProfileIsCandidateFileCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.isCandidateFile("/tmp/test.txt"); }); +} + +TEST(IndexProfileTest, ProfileComputeChecksumCallable) +{ + auto p = makeProfile(); + EXPECT_NO_FATAL_FAILURE({ (void)p.computeChecksum("/tmp/test.txt"); }); +} + +// ---- Coverage additions: exercise the real provider lambdas wired up by the +// IndexProfile::content() / IndexProfile::ocr() factories. Each accessor runs +// the corresponding closure stored inside content()/ocr(), covering those +// lambdas (which are otherwise defined but never invoked). + +TEST(IndexProfileTest, ContentProfile_ScopeAndOptionProviders) +{ + auto p = IndexProfile::content(); + EXPECT_FALSE(p.indexDirectory().isEmpty()); + EXPECT_NO_FATAL_FAILURE({ (void)p.isIndexAvailable(); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.isPathInScope("/tmp/somefile.txt"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.isCandidateFile("/tmp/somefile.txt"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.anythingSearchOptions(); }); +} + +TEST(IndexProfileTest, ContentProfile_ChecksumTextCacheAndAnalyzer) +{ + auto p = IndexProfile::content(); + EXPECT_NO_FATAL_FAILURE({ (void)p.computeChecksum("/nonexistent/file.txt"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.lookupCachedText("deadbeef"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.createAnalyzer(); }); +} + +TEST(IndexProfileTest, OcrProfile_ScopeAndOptionProviders) +{ + auto p = IndexProfile::ocr(); + EXPECT_FALSE(p.indexDirectory().isEmpty()); + EXPECT_NO_FATAL_FAILURE({ (void)p.isIndexAvailable(); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.isPathInScope("/tmp/somefile.png"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.isCandidateFile("/tmp/somefile.png"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.anythingSearchOptions(); }); +} + +TEST(IndexProfileTest, OcrProfile_ChecksumTextCacheAndAnalyzer) +{ + auto p = IndexProfile::ocr(); + EXPECT_NO_FATAL_FAILURE({ (void)p.computeChecksum("/nonexistent/file.png"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.lookupCachedText("deadbeef"); }); + EXPECT_NO_FATAL_FAILURE({ (void)p.createAnalyzer(); }); +} + +// =========================================================================== +// Filename profile (design 5.1.2) — the new third IndexProfile::Type::Filename. +// =========================================================================== + +TEST(IndexProfileTest, FilenameFactoryReturnsFilenameType) +{ + auto p = IndexProfile::filename(); + EXPECT_EQ(p.type(), IndexProfile::Type::Filename); +} + +TEST(IndexProfileTest, FilenameProfile_IdIsFilename) +{ + auto p = IndexProfile::filename(); + EXPECT_EQ(p.id(), QString("filename")); +} + +TEST(IndexProfileTest, FilenameProfile_StatusFileName) +{ + auto p = IndexProfile::filename(); + EXPECT_TRUE(p.statusFilePath().contains("index_status.json")); +} + +TEST(IndexProfileTest, FilenameProfile_RuntimeVersionIs1) +{ + auto p = IndexProfile::filename(); + EXPECT_EQ(p.runtimeIndexVersion(), Defines::kFilenameIndexVersion); + EXPECT_EQ(p.runtimeIndexVersion(), 1); +} + +TEST(IndexProfileTest, FilenameProfile_VersionKey) +{ + auto p = IndexProfile::filename(); + EXPECT_EQ(p.versionKey(), Defines::kFilenameVersionKey); +} + +TEST(IndexProfileTest, FilenameProfile_IndexDirectoryNonEmpty) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + EXPECT_FALSE(p.indexDirectory().isEmpty()); + // Must be under ~/.local/share/deepin/dde-file-manager/filename-index (design 4.2 #7) + EXPECT_TRUE(p.indexDirectory().contains("filename-index")); +} + +TEST(IndexProfileTest, FilenameProfile_IsCandidateFileAcceptsAll) +{ + auto p = IndexProfile::filename(); + // Accepts any file (no extension filtering — filename indexes all files) + EXPECT_TRUE(p.isCandidateFile("/any/path/readme.txt")); + EXPECT_TRUE(p.isCandidateFile("/any/path/noext")); + EXPECT_TRUE(p.isCandidateFile("/any/path/.hidden")); + EXPECT_TRUE(p.isCandidateFile("/any/path/archive.tar.gz")); +} + +TEST(IndexProfileTest, FilenameProfile_SupportsAnythingIsFalse) +{ + auto p = IndexProfile::filename(); + // No AnythingSearchOptionsProvider → supportsAnything() false → FileSystemProvider fallback + EXPECT_FALSE(p.supportsAnything()); +} + +TEST(IndexProfileTest, FilenameProfile_DoesNotSupportChecksum) +{ + auto p = IndexProfile::filename(); + EXPECT_FALSE(p.supportsChecksum()); + EXPECT_TRUE(p.computeChecksum("/any/file").isEmpty()); +} + +TEST(IndexProfileTest, FilenameProfile_AnalyzerIsNGram) +{ + auto p = IndexProfile::filename(); + EXPECT_NO_FATAL_FAILURE({ auto a = p.createAnalyzer(); EXPECT_NE(a.get(), nullptr); }); +} + +// --- RuntimePolicy (design 5.1.1 / 变更 4/9) --- + +TEST(IndexProfileTest, FilenameProfile_RuntimePolicy_EnvExempt) +{ + auto p = IndexProfile::filename(); + // Filename is exempt from battery/power-save/idle env gating (design 3.2.2 / 变更 4) + EXPECT_FALSE(p.runtimePolicy().checkEnvPolicy); + EXPECT_FALSE(p.shouldCheckEnvPolicy()); // virtual accessor +} + +TEST(IndexProfileTest, FilenameProfile_RuntimePolicy_CollectionWindow1s) +{ + auto p = IndexProfile::filename(); + EXPECT_EQ(p.runtimePolicy().eventCollectionWindowMs, 1000); +} + +TEST(IndexProfileTest, FilenameProfile_RuntimePolicy_RecoveryDelay30s) +{ + auto p = IndexProfile::filename(); + // Design 变更 9: recoveryUpdateDelayMs = 3000 (Content/Ocr stay at global 180s) + EXPECT_EQ(p.runtimePolicy().recoveryUpdateDelayMs, 3000); +} + +TEST(IndexProfileTest, ContentProfile_RuntimePolicy_DefaultsPreserved) +{ + auto p = IndexProfile::content(); + // Content profile keeps defaults (no env exemption, no custom recovery delay) + EXPECT_TRUE(p.runtimePolicy().checkEnvPolicy); + EXPECT_TRUE(p.shouldCheckEnvPolicy()); + EXPECT_EQ(p.runtimePolicy().recoveryUpdateDelayMs, 0); // 0 → use global 180s +} + +TEST(IndexProfileTest, OcrProfile_RuntimePolicy_DefaultsPreserved) +{ + auto p = IndexProfile::ocr(); + EXPECT_TRUE(p.runtimePolicy().checkEnvPolicy); + EXPECT_TRUE(p.shouldCheckEnvPolicy()); + EXPECT_EQ(p.runtimePolicy().recoveryUpdateDelayMs, 0); +} + +// --- FilterPolicy (design 5.1.1 / 变更 1) --- + +TEST(IndexProfileTest, FilenameProfile_FilterPolicy_IndexesHiddenFiles) +{ + auto p = IndexProfile::filename(); + // Filename indexes hidden files (marks is_hidden field) — design 4.2 #4 / 5.1.5 + EXPECT_TRUE(p.filterPolicy().indexHiddenFiles); +} + +TEST(IndexProfileTest, ContentProfile_FilterPolicy_DoesNotIndexHidden) +{ + auto p = IndexProfile::content(); + EXPECT_FALSE(p.filterPolicy().indexHiddenFiles); +} + +TEST(IndexProfileTest, FilenameProfile_FilterPolicy_HasBlacklistProvider) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + // Custom blacklist (anything blacklist + index dirs + .avfs) — design 5.11 + ASSERT_TRUE(p.filterPolicy().blacklistProvider); + QStringList bl = p.filterPolicy().blacklistProvider(); + EXPECT_FALSE(bl.isEmpty()); +} + +TEST(IndexProfileTest, ContentProfile_FilterPolicy_NoCustomBlacklistProvider) +{ + auto p = IndexProfile::content(); + EXPECT_FALSE(p.filterPolicy().blacklistProvider); +} + +// --- Hidden-entry policy (home-dir exclusion + shouldSkipHiddenEntry) --- + +TEST(IndexProfileTest, FilenameProfile_FilterPolicy_ExcludesHiddenUnderHome) +{ + auto p = IndexProfile::filename(); + // 主目录第一级隐藏条目被二级策略屏蔽；更深层级（~/Documents/.abc）不屏蔽 + ASSERT_TRUE(p.filterPolicy().hiddenIndexExclusion); + const QString home = QDir::homePath(); + EXPECT_TRUE(p.filterPolicy().hiddenIndexExclusion(home + "/.bashrc")); + EXPECT_TRUE(p.filterPolicy().hiddenIndexExclusion(home + "/.cache/deepin/app.dat")); + // 深层隐藏目录不属于第一级，依然索引 + EXPECT_FALSE(p.filterPolicy().hiddenIndexExclusion(home + "/Documents/.abc")); + EXPECT_FALSE(p.filterPolicy().hiddenIndexExclusion(home + "/Documents/.abc/file.txt")); +} + +TEST(IndexProfileTest, FilenameProfile_ShouldSkipHiddenEntry_HomeHiddenSkipped) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + const QString home = QDir::homePath(); + + // 主目录第一级隐藏条目：跳过（其整个子树随之排除） + EXPECT_TRUE(p.shouldSkipHiddenEntry(home + "/.bashrc")); + EXPECT_TRUE(p.shouldSkipHiddenEntry(home + "/.config/dde/file-manager.conf")); + EXPECT_TRUE(p.shouldSkipHiddenEntry(home + "/.local/share/data.bin")); + + // 主目录外的隐藏条目：依然索引（不在屏蔽范围） + EXPECT_FALSE(p.shouldSkipHiddenEntry("/opt/data/.hidden")); + EXPECT_FALSE(p.shouldSkipHiddenEntry("/tmp/dfm_idx_test/.cache")); + + // 主目录内更深层级中的隐藏目录：依然索引（如 ~/Documents/.abc） + EXPECT_FALSE(p.shouldSkipHiddenEntry(home + "/Documents/.abc")); + EXPECT_FALSE(p.shouldSkipHiddenEntry(home + "/Documents/.abc/file.txt")); + + // 非隐藏路径恒不跳过 + EXPECT_FALSE(p.shouldSkipHiddenEntry(home + "/Documents/report.txt")); + EXPECT_FALSE(p.shouldSkipHiddenEntry("/tmp/normal.txt")); +} + +TEST(IndexProfileTest, ContentProfile_ShouldSkipHiddenEntry_AllHiddenSkipped) +{ + auto p = IndexProfile::content(); + const QString home = QDir::homePath(); + // Content/Ocr skip every hidden entry (original behavior preserved) + EXPECT_TRUE(p.shouldSkipHiddenEntry(home + "/.cache/app.dat")); + EXPECT_TRUE(p.shouldSkipHiddenEntry("/tmp/.hidden")); + EXPECT_FALSE(p.shouldSkipHiddenEntry(home + "/Documents/report.txt")); +} + +TEST(IndexProfileTest, ProfileWithoutExclusion_ShouldSkipHiddenEntry_IndexesHidden) +{ + // Hand-crafted filename profile without hiddenIndexExclusion: hidden entries + // under $HOME are still indexed (policy absent → no exclusion) + const QString home = QDir::homePath(); + IndexProfile p = IndexProfile( + IndexProfile::Identity { IndexProfile::Type::Filename, "fn_no_excl", "s.json", "v", 1 }, + {}, IndexProfile::RuntimePolicy {}, + IndexProfile::FilterPolicy { true }); + EXPECT_TRUE(p.filterPolicy().indexHiddenFiles); + EXPECT_FALSE(p.filterPolicy().hiddenIndexExclusion); + EXPECT_FALSE(p.shouldSkipHiddenEntry(home + "/.bashrc")); +} + +// --- Field accessors (design 5.3.2 / 变更 6) --- + +TEST(IndexProfileTest, FilenameProfile_PathFieldIsFullPath) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + // pathField() → kFullPath (NOT kPath). Compare wide-string content, not pointer + // (the constexpr wchar_t[] may live at different addresses in .so vs test exe). + EXPECT_EQ(QString::fromWCharArray(p.pathField()), QString::fromWCharArray(DFMSEARCH::LuceneFieldNames::FileName::kFullPath)); + EXPECT_NE(QString::fromWCharArray(p.pathField()), QString::fromWCharArray(DFMSEARCH::LuceneFieldNames::Content::kPath)); +} + +TEST(IndexProfileTest, FilenameProfile_ContentFieldIsFileName) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + EXPECT_EQ(QString::fromWCharArray(p.contentField()), QString::fromWCharArray(DFMSEARCH::LuceneFieldNames::FileName::kFileName)); +} + +TEST(IndexProfileTest, FilenameProfile_AncestorPathsField) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + EXPECT_EQ(QString::fromWCharArray(p.ancestorPathsField()), QString::fromWCharArray(DFMSEARCH::LuceneFieldNames::FileName::kAncestorPaths)); +} + +TEST(IndexProfileTest, FilenameProfile_ModifyTimeField) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + EXPECT_EQ(QString::fromWCharArray(p.modifyTimeField()), QString::fromWCharArray(DFMSEARCH::LuceneFieldNames::FileName::kModifyTime)); +} + +TEST(IndexProfileTest, FilenameProfile_SupportsModifiedTimestampCheck) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + EXPECT_TRUE(p.supportsModifiedTimestampCheck()); +} + +// --- Move/capability semantics declarations --- + +TEST(IndexProfileTest, ContentProfile_MoveUpdatePolicy_IsUpdatePathOnly) +{ + FilenameDirStub stubs; + auto p = IndexProfile::content(); + EXPECT_EQ(p.moveUpdatePolicy(), IndexProfile::MoveUpdatePolicy::UpdatePathOnly); + EXPECT_TRUE(p.requiresContentExtraction()); +} + +TEST(IndexProfileTest, OcrProfile_MoveUpdatePolicy_IsUpdatePathOnly) +{ + FilenameDirStub stubs; + auto p = IndexProfile::ocr(); + EXPECT_EQ(p.moveUpdatePolicy(), IndexProfile::MoveUpdatePolicy::UpdatePathOnly); + EXPECT_TRUE(p.requiresContentExtraction()); + // OCR 单文件提取成本高：Light 分级阈值由 profile 声明（函数式 provider，保持动态性） + ASSERT_TRUE(p.lightGradeFileCountThreshold() > 0); + EXPECT_EQ(p.lightGradeFileCountThreshold(), + TextIndexConfig::instance().lightIncrementOcrFileCountThreshold()); +} + +TEST(IndexProfileTest, FilenameProfile_MoveUpdatePolicy_IsRebuildDocument) +{ + FilenameDirStub stubs; + auto p = IndexProfile::filename(); + EXPECT_EQ(p.moveUpdatePolicy(), IndexProfile::MoveUpdatePolicy::RebuildDocument); + EXPECT_FALSE(p.requiresContentExtraction()); + // 未声明 Light 阈值 → 0 表示回退全局配置 + EXPECT_EQ(p.lightGradeFileCountThreshold(), 0); +} + +TEST(IndexProfileTest, DefaultConstructedProfile_MoveUpdatePolicy_IsUpdatePathOnly) +{ + IndexProfile p; + EXPECT_EQ(p.moveUpdatePolicy(), IndexProfile::MoveUpdatePolicy::UpdatePathOnly); + EXPECT_TRUE(p.requiresContentExtraction()); + EXPECT_EQ(p.lightGradeFileCountThreshold(), 0); +} diff --git a/autotests/index/test_indexruntime.cpp b/autotests/index/test_indexruntime.cpp new file mode 100644 index 00000000..91be721e --- /dev/null +++ b/autotests/index/test_indexruntime.cpp @@ -0,0 +1,78 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indexruntime.cpp + * @brief Unit tests for IndexRuntime (core/indexruntime.cpp) + * Covers construction for both Content and Ocr profiles plus all + * public accessors and the private selectExtractor/selectDocumentBuilder + * selection helpers. + */ + +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class IndexRuntimeTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + IndexProfile makeProfile(IndexProfile::Type type) + { + return IndexProfile({ type, + "runtime_test", + "runtime_status.json", + "runtime_version", + 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + } +}; + +TEST_F(IndexRuntimeTest, ContentRuntime_ConstructsAndExposesComponents) +{ + IndexRuntime rt(makeProfile(IndexProfile::Type::Content)); + EXPECT_EQ(rt.profile().type(), IndexProfile::Type::Content); + EXPECT_NO_FATAL_FAILURE({ (void)rt.stateStore(); }); + EXPECT_NO_FATAL_FAILURE({ (void)rt.context(); }); + EXPECT_NE(rt.taskManager(), nullptr); + EXPECT_NE(rt.fsEventController(), nullptr); +} + +TEST_F(IndexRuntimeTest, OcrRuntime_ConstructsAndSelectsOcrBuilder) +{ + IndexRuntime rt(makeProfile(IndexProfile::Type::Ocr)); + EXPECT_EQ(rt.profile().type(), IndexProfile::Type::Ocr); + EXPECT_NE(rt.taskManager(), nullptr); + EXPECT_NE(rt.fsEventController(), nullptr); + EXPECT_NO_FATAL_FAILURE({ (void)rt.stateStore(); }); + EXPECT_NO_FATAL_FAILURE({ (void)rt.context(); }); +} + +TEST_F(IndexRuntimeTest, ProfileAccessorReturnsSameType) +{ + IndexRuntime rtA(makeProfile(IndexProfile::Type::Content)); + IndexRuntime rtB(makeProfile(IndexProfile::Type::Ocr)); + EXPECT_EQ(rtA.profile().type(), IndexProfile::Type::Content); + EXPECT_EQ(rtB.profile().type(), IndexProfile::Type::Ocr); +} + +TEST_F(IndexRuntimeTest, ContextAccessorNonNull) +{ + IndexRuntime rt(makeProfile(IndexProfile::Type::Content)); + EXPECT_EQ(rt.context().profile().type(), IndexProfile::Type::Content); + EXPECT_NE(rt.context().stateStore(), nullptr); + EXPECT_NE(rt.context().extractor(), nullptr); + EXPECT_NE(rt.context().documentBuilder(), nullptr); +} diff --git a/autotests/index/test_indexruntime_extra.cpp b/autotests/index/test_indexruntime_extra.cpp new file mode 100644 index 00000000..f8125ebf --- /dev/null +++ b/autotests/index/test_indexruntime_extra.cpp @@ -0,0 +1,140 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indexruntime_extra.cpp + * @brief Additional tests for IndexRuntime covering: + * - context() returns correct extractor/builder for each profile type + * - profile() and stateStore() accessors + * - taskManager() and fsEventController() non-null + */ + +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +class IndexRuntimeExtraTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/content"; + }); + stub.set_lamda(ADDR(Global, isContentIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInContentIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() }; + }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + } + + QTemporaryDir ocrTmp; + stub_ext::StubExt stub; +}; + +TEST_F(IndexRuntimeExtraTest, ContentProfile_ContextHasExtractor) +{ + auto runtime = std::make_unique(IndexProfile::content()); + const auto &ctx = runtime->context(); + EXPECT_NE(ctx.extractor(), nullptr); + EXPECT_NE(ctx.documentBuilder(), nullptr); + EXPECT_NE(ctx.stateStore(), nullptr); +} + +TEST_F(IndexRuntimeExtraTest, ContentProfile_TaskManagerNotNull) +{ + auto runtime = std::make_unique(IndexProfile::content()); + EXPECT_NE(runtime->taskManager(), nullptr); +} + +TEST_F(IndexRuntimeExtraTest, ContentProfile_FSEventControllerNotNull) +{ + auto runtime = std::make_unique(IndexProfile::content()); + EXPECT_NE(runtime->fsEventController(), nullptr); +} + +TEST_F(IndexRuntimeExtraTest, ContentProfile_ProfileAccessor) +{ + auto runtime = std::make_unique(IndexProfile::content()); + const auto &profile = runtime->profile(); + EXPECT_EQ(profile.type(), IndexProfile::Type::Content); + EXPECT_FALSE(profile.id().isEmpty()); + EXPECT_GE(profile.runtimeIndexVersion(), 1); +} + +TEST_F(IndexRuntimeExtraTest, ContentProfile_StateStoreAccessor) +{ + auto runtime = std::make_unique(IndexProfile::content()); + const auto &stateStore = runtime->stateStore(); + EXPECT_NO_FATAL_FAILURE({ (void)stateStore.isCompatibleVersion(); }); +} + +TEST_F(IndexRuntimeExtraTest, OcrProfile_ContextHasExtractor) +{ + auto runtime = std::make_unique(IndexProfile::ocr()); + const auto &ctx = runtime->context(); + EXPECT_NE(ctx.extractor(), nullptr); + EXPECT_NE(ctx.documentBuilder(), nullptr); + EXPECT_NE(ctx.stateStore(), nullptr); +} + +TEST_F(IndexRuntimeExtraTest, OcrProfile_TaskManagerNotNull) +{ + auto runtime = std::make_unique(IndexProfile::ocr()); + EXPECT_NE(runtime->taskManager(), nullptr); +} + +TEST_F(IndexRuntimeExtraTest, OcrProfile_FSEventControllerNotNull) +{ + auto runtime = std::make_unique(IndexProfile::ocr()); + EXPECT_NE(runtime->fsEventController(), nullptr); +} + +TEST_F(IndexRuntimeExtraTest, OcrProfile_ProfileAccessor) +{ + auto runtime = std::make_unique(IndexProfile::ocr()); + const auto &profile = runtime->profile(); + EXPECT_EQ(profile.type(), IndexProfile::Type::Ocr); + EXPECT_FALSE(profile.id().isEmpty()); +} + +TEST_F(IndexRuntimeExtraTest, MultipleRuntimes_SameType) +{ + // Create two content runtimes - they should each have their own TaskManager + auto runtime1 = std::make_unique(IndexProfile::content()); + auto runtime2 = std::make_unique(IndexProfile::content()); + EXPECT_NE(runtime1->taskManager(), runtime2->taskManager()); +} \ No newline at end of file diff --git a/autotests/index/test_indexstatestore.cpp b/autotests/index/test_indexstatestore.cpp new file mode 100644 index 00000000..51c40919 --- /dev/null +++ b/autotests/index/test_indexstatestore.cpp @@ -0,0 +1,286 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indexstatestore.cpp + * @brief Unit tests for IndexStateStore (indexstatestore.cpp) + */ + +#include +#include +#include +#include + +#include "index_global.h" +#include "state/indexstatestore.h" +#include "profile/indexprofile.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class IndexStateStoreTest : public testing::Test +{ +protected: + void SetUp() override + { + ASSERT_TRUE(tmpDir.isValid()); + indexDir = tmpDir.path(); + profile = IndexProfile({ IndexProfile::Type::Content, + "statetest", + "state_status.json", + "state_version", + 1 }, + { [this]() -> QString { return indexDir; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + store.reset(new IndexStateStore(profile)); + } + + QTemporaryDir tmpDir; + QString indexDir; + IndexProfile profile; + std::unique_ptr store; +}; + +TEST_F(IndexStateStoreTest, StatusFilePathContainsFileName) +{ + QString sfp = store->statusFilePath(); + EXPECT_TRUE(sfp.contains("state_status.json")); +} + +TEST_F(IndexStateStoreTest, GetIndexStateUnknownWhenNoFile) +{ + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Unknown); +} + +TEST_F(IndexStateStoreTest, SetIndexStateClean) +{ + store->setIndexState(IndexUtility::IndexState::Clean); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Clean); +} + +TEST_F(IndexStateStoreTest, SetIndexStateDirty) +{ + store->setIndexState(IndexUtility::IndexState::Dirty); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Dirty); +} + +TEST_F(IndexStateStoreTest, SetIndexStateUnknownIgnored) +{ + store->setIndexState(IndexUtility::IndexState::Clean); + store->setIndexState(IndexUtility::IndexState::Unknown); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Clean); +} + +TEST_F(IndexStateStoreTest, IsCleanState) +{ + store->setIndexState(IndexUtility::IndexState::Clean); + EXPECT_TRUE(store->isCleanState()); + store->setIndexState(IndexUtility::IndexState::Dirty); + EXPECT_FALSE(store->isCleanState()); +} + +TEST_F(IndexStateStoreTest, NeedsRebuildDefault) +{ + EXPECT_NO_FATAL_FAILURE({ (void)store->needsRebuild(); }); +} + +TEST_F(IndexStateStoreTest, SetNeedsRebuild) +{ + store->setNeedsRebuild(true); + EXPECT_TRUE(store->needsRebuild()); + store->setNeedsRebuild(false); + EXPECT_FALSE(store->needsRebuild()); +} + +TEST_F(IndexStateStoreTest, GetLastUpdateTime) +{ + EXPECT_NO_FATAL_FAILURE({ (void)store->getLastUpdateTime(); }); +} + +TEST_F(IndexStateStoreTest, GetIndexVersion) +{ + EXPECT_NO_FATAL_FAILURE({ (void)store->getIndexVersion(); }); +} + +TEST_F(IndexStateStoreTest, IsCompatibleVersion) +{ + EXPECT_NO_FATAL_FAILURE({ (void)store->isCompatibleVersion(); }); +} + +TEST_F(IndexStateStoreTest, SaveLastUpdateTime) +{ + QDateTime now = QDateTime::currentDateTime(); + EXPECT_NO_FATAL_FAILURE({ store->saveLastUpdateTime(now); }); +} + +TEST_F(IndexStateStoreTest, SaveIndexStatusWithTime) +{ + QDateTime now = QDateTime::currentDateTime(); + EXPECT_NO_FATAL_FAILURE({ store->saveIndexStatus(now); }); +} + +TEST_F(IndexStateStoreTest, SaveIndexStatusWithTimeAndVersion) +{ + QDateTime now = QDateTime::currentDateTime(); + EXPECT_NO_FATAL_FAILURE({ store->saveIndexStatus(now, 6); }); +} + +TEST_F(IndexStateStoreTest, RemoveIndexStatusFile) +{ + store->setIndexState(IndexUtility::IndexState::Clean); + EXPECT_NO_FATAL_FAILURE({ store->removeIndexStatusFile(); }); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Unknown); +} + +TEST_F(IndexStateStoreTest, ClearIndexDirectory) +{ + EXPECT_NO_FATAL_FAILURE({ store->clearIndexDirectory(); }); +} + +TEST_F(IndexStateStoreTest, IsCreateInProgressDefault) +{ + EXPECT_NO_FATAL_FAILURE({ (void)store->isCreateInProgress(); }); +} + +TEST_F(IndexStateStoreTest, SetCreateInProgress) +{ + store->setCreateInProgress(true); + EXPECT_TRUE(store->isCreateInProgress()); + store->setCreateInProgress(false); + EXPECT_FALSE(store->isCreateInProgress()); +} + +// =========================================================================== +// updateInProgress (design 变更 8) — lifecycle of the full-comparison Update task +// =========================================================================== + +TEST_F(IndexStateStoreTest, UpdateInProgress_DefaultFalse) +{ + EXPECT_FALSE(store->isUpdateInProgress()); +} + +TEST_F(IndexStateStoreTest, UpdateInProgress_SetTruePersists) +{ + store->setUpdateInProgress(true); + EXPECT_TRUE(store->isUpdateInProgress()); + // Verify persisted across a fresh store on the same directory/file + std::unique_ptr store2(new IndexStateStore(profile)); + EXPECT_TRUE(store2->isUpdateInProgress()); +} + +TEST_F(IndexStateStoreTest, UpdateInProgress_SetFalsePersists) +{ + store->setUpdateInProgress(true); + ASSERT_TRUE(store->isUpdateInProgress()); + store->setUpdateInProgress(false); + EXPECT_FALSE(store->isUpdateInProgress()); + std::unique_ptr store2(new IndexStateStore(profile)); + EXPECT_FALSE(store2->isUpdateInProgress()); +} + +TEST_F(IndexStateStoreTest, UpdateInProgress_DoesNotAffectOtherFields) +{ + // Set baseline state + store->setIndexState(IndexUtility::IndexState::Dirty); + store->setNeedsRebuild(true); + store->setCreateInProgress(true); + QDateTime now = QDateTime::currentDateTime(); + store->saveIndexStatus(now); + + // Now toggle updateInProgress — other fields must remain intact + store->setUpdateInProgress(true); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Dirty); + EXPECT_TRUE(store->needsRebuild()); + EXPECT_TRUE(store->isCreateInProgress()); + EXPECT_TRUE(store->isUpdateInProgress()); + + store->setUpdateInProgress(false); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Dirty); + EXPECT_TRUE(store->needsRebuild()); + EXPECT_TRUE(store->isCreateInProgress()); + EXPECT_FALSE(store->isUpdateInProgress()); +} + +TEST_F(IndexStateStoreTest, UpdateInProgress_RoundTripViaFreshStore) +{ + store->setUpdateInProgress(true); + std::unique_ptr store2(new IndexStateStore(profile)); + EXPECT_TRUE(store2->isUpdateInProgress()); + store2->setUpdateInProgress(false); + std::unique_ptr store3(new IndexStateStore(profile)); + EXPECT_FALSE(store3->isUpdateInProgress()); +} + +TEST_F(IndexStateStoreTest, UpdateInProgress_RemoveIndexStatusFileResetsToDefault) +{ + store->setUpdateInProgress(true); + ASSERT_TRUE(store->isUpdateInProgress()); + store->removeIndexStatusFile(); + EXPECT_FALSE(store->isUpdateInProgress()); +} + +// --- Simulated recovery-Update lifecycle (design 变更 8 table) --- +// +// 1. Service starts, dirty detected → recoveryPending=true +// 2. Recovery Update starts → setUpdateInProgress(true) +// 3. Update succeeds → finalizeIndexState: setUpdateInProgress(false) + state=clean +// 4. Ordinary event increment (UpdateFileList) → does NOT touch updateInProgress +// +TEST_F(IndexStateStoreTest, RecoveryUpdateLifecycle_OnSuccessClearsFlag) +{ + // Step 2: Update starts + store->setUpdateInProgress(true); + store->setIndexState(IndexUtility::IndexState::Dirty); + ASSERT_TRUE(store->isUpdateInProgress()); + + // Step 3: Update succeeds (finalizeIndexState clears flag + sets clean) + store->setUpdateInProgress(false); + store->setIndexState(IndexUtility::IndexState::Clean); + + EXPECT_FALSE(store->isUpdateInProgress()); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Clean); +} + +TEST_F(IndexStateStoreTest, RecoveryUpdateLifecycle_OnFailureKeepsFlagAndDirty) +{ + // Update starts + store->setUpdateInProgress(true); + store->setIndexState(IndexUtility::IndexState::Dirty); + + // Update fails/interrupted — flag stays true, state stays dirty + EXPECT_TRUE(store->isUpdateInProgress()); + EXPECT_EQ(store->getIndexState(), IndexUtility::IndexState::Dirty); + + // Next restart: still true → search remains degraded until recovery succeeds + std::unique_ptr store2(new IndexStateStore(profile)); + EXPECT_TRUE(store2->isUpdateInProgress()); + EXPECT_EQ(store2->getIndexState(), IndexUtility::IndexState::Dirty); +} + +TEST_F(IndexStateStoreTest, OrdinaryIncrementalTask_DoesNotSetUpdateInProgress) +{ + // Ordinary event incremental tasks (UpdateFileList/MoveFileList) do NOT set + // updateInProgress — only full-comparison Update tasks do (design 变更 8). + store->setIndexState(IndexUtility::IndexState::Dirty); + EXPECT_FALSE(store->isUpdateInProgress()); + + // Even after dirty state set, updateInProgress stays false + store->setIndexState(IndexUtility::IndexState::Dirty); + EXPECT_FALSE(store->isUpdateInProgress()); + + // And after clean (incremental succeeded) + store->setIndexState(IndexUtility::IndexState::Clean); + EXPECT_FALSE(store->isUpdateInProgress()); +} + +TEST_F(IndexStateStoreTest, BacklogExceeded_PersistsAndClears) +{ + store->setBacklogExceeded(true); + EXPECT_TRUE(store->isBacklogExceeded()); + std::unique_ptr store2(new IndexStateStore(profile)); + EXPECT_TRUE(store2->isBacklogExceeded()); + store2->setBacklogExceeded(false); + EXPECT_FALSE(store2->isBacklogExceeded()); +} diff --git a/autotests/index/test_indextask.cpp b/autotests/index/test_indextask.cpp new file mode 100644 index 00000000..39b7b5a8 --- /dev/null +++ b/autotests/index/test_indextask.cpp @@ -0,0 +1,206 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indextask.cpp + * @brief Unit tests for IndexTask (task/indextask.cpp) — the dependency-light + * subset: ctor, dtor, and all accessors (taskPath/taskType/status/ + * isIndexCorrupted/setIndexCorrupted/grade/setGrade) plus stop() and + * isRunning(). start() is intentionally NOT invoked (it runs the handler + * in a worker thread). + */ + +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "task/indextask.h" +#include "task/taskhandler.h" +#include "utils/taskstate.h" +#include + +using namespace ANYTHING_INDEX_NAMESPACE; + +static TaskHandler dummyHandler() +{ + return [](const QString &, TaskState &) -> HandlerResult { + return HandlerResult {}; + }; +} + +TEST(IndexTaskTest, CtorSetsTypeAndPath) +{ + IndexTask t(IndexTask::Type::Create, "/tmp/test", dummyHandler()); + EXPECT_EQ(t.taskType(), IndexTask::Type::Create); + EXPECT_EQ(t.taskPath(), QString("/tmp/test")); +} + +TEST(IndexTaskTest, CtorAllTypes) +{ + IndexTask t1(IndexTask::Type::Update, "/a", dummyHandler()); + EXPECT_EQ(t1.taskType(), IndexTask::Type::Update); + IndexTask t2(IndexTask::Type::CreateFileList, "/b", dummyHandler()); + EXPECT_EQ(t2.taskType(), IndexTask::Type::CreateFileList); + IndexTask t3(IndexTask::Type::UpdateFileList, "/c", dummyHandler()); + EXPECT_EQ(t3.taskType(), IndexTask::Type::UpdateFileList); + IndexTask t4(IndexTask::Type::RemoveFileList, "/d", dummyHandler()); + EXPECT_EQ(t4.taskType(), IndexTask::Type::RemoveFileList); + IndexTask t5(IndexTask::Type::MoveFileList, "/e", dummyHandler()); + EXPECT_EQ(t5.taskType(), IndexTask::Type::MoveFileList); +} + +TEST(IndexTaskTest, DefaultStatusNotStarted) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", dummyHandler()); + EXPECT_EQ(t.status(), IndexTask::Status::NotStarted); + EXPECT_FALSE(t.isRunning()); +} + +TEST(IndexTaskTest, GradeRoundtrip) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", dummyHandler()); + EXPECT_EQ(t.grade(), IndexTask::Grade::None); + t.setGrade(IndexTask::Grade::Heavy); + EXPECT_EQ(t.grade(), IndexTask::Grade::Heavy); + t.setGrade(IndexTask::Grade::Manual); + EXPECT_EQ(t.grade(), IndexTask::Grade::Manual); +} + +TEST(IndexTaskTest, ForceBypassRoundtrip) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", dummyHandler()); + EXPECT_FALSE(t.forceBypass()); + t.setForceBypass(true); + EXPECT_TRUE(t.forceBypass()); + t.setForceBypass(false); + EXPECT_FALSE(t.forceBypass()); +} + +TEST(IndexTaskTest, IndexCorruptedRoundtrip) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", dummyHandler()); + EXPECT_FALSE(t.isIndexCorrupted()); + t.setIndexCorrupted(true); + EXPECT_TRUE(t.isIndexCorrupted()); + t.setIndexCorrupted(false); + EXPECT_FALSE(t.isIndexCorrupted()); +} + +TEST(IndexTaskTest, SetIndexCorruptedIdempotent) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", dummyHandler()); + t.setIndexCorrupted(true); + t.setIndexCorrupted(true); // already true -> no change + EXPECT_TRUE(t.isIndexCorrupted()); +} + +TEST(IndexTaskTest, StopIsSafeBeforeStart) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", dummyHandler()); + EXPECT_NO_FATAL_FAILURE({ t.stop(); }); + EXPECT_FALSE(t.isRunning()); +} + +TEST(IndexTaskTest, DtorIsSafeWithoutStart) +{ + { + IndexTask t(IndexTask::Type::Create, "/tmp/dtor_test", dummyHandler()); + EXPECT_EQ(t.taskPath(), QString("/tmp/dtor_test")); + } + SUCCEED(); +} + +// ---- TaskState inline class tests ---- + +TEST(TaskStateTest, DefaultNotRunning) +{ + TaskState s; + EXPECT_FALSE(s.isRunning()); +} + +TEST(TaskStateTest, StartStop) +{ + TaskState s; + s.start(); + EXPECT_TRUE(s.isRunning()); + s.stop(); + EXPECT_FALSE(s.isRunning()); +} + +TEST(TaskStateTest, PauseRequest) +{ + TaskState s; + EXPECT_FALSE(s.isPauseRequested()); + s.requestPause(); + EXPECT_TRUE(s.isPauseRequested()); + s.clearPauseRequest(); + EXPECT_FALSE(s.isPauseRequested()); +} + +static TaskHandler noopHandler() +{ + return [](const QString &, TaskState &) -> HandlerResult { return HandlerResult {}; }; +} +TEST(IndexTaskTest, OnProgressChangedNoEmitWhenNotRunning) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", noopHandler()); + QSignalSpy spy(&t, &IndexTask::progressChanged); + t.onProgressChanged(10, 100); // private; not running -> no emit + EXPECT_EQ(spy.count(), 0); +} +TEST(IndexTaskTest, ApplyResourcePolicyDefaultGradeNoCrash) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", noopHandler()); + EXPECT_NO_FATAL_FAILURE({ t.applyResourcePolicy(); }); // default grade -> logs warning, returns +} +TEST(IndexTaskTest, D0DestructorPath) +{ + auto *ptr = new IndexTask(IndexTask::Type::Create, "/tmp/heap", noopHandler()); + EXPECT_NO_FATAL_FAILURE({ delete ptr; }); +} +TEST(IndexTaskTest, DoTaskWithHandler) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", noopHandler()); + // doTask() runs the handler in the current thread (no thread check here); + // it returns HandlerResult{false,...} because noopHandler returns default. + EXPECT_NO_FATAL_FAILURE({ t.doTask(); }); // private +} +TEST(IndexTaskTest, DoTaskWithNullHandler) +{ + TaskHandler nullHandler; + IndexTask t(IndexTask::Type::Create, "/tmp", nullHandler); + EXPECT_NO_FATAL_FAILURE({ t.doTask(); }); // m_handler is null -> result stays default +} +TEST(IndexTaskTest, SetGradeThenApplyResourcePolicy) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", noopHandler()); + t.setGrade(IndexTask::Grade::Heavy); + EXPECT_EQ(t.grade(), IndexTask::Grade::Heavy); + EXPECT_NO_FATAL_FAILURE({ t.applyResourcePolicy(); }); + EXPECT_NO_FATAL_FAILURE({ t.releaseResourcePolicy(); }); +} + +TEST(IndexTaskTest, SetManualGradeThenApplyResourcePolicy) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", noopHandler()); + t.setGrade(IndexTask::Grade::Manual); + EXPECT_EQ(t.grade(), IndexTask::Grade::Manual); + EXPECT_NO_FATAL_FAILURE({ t.applyResourcePolicy(); }); + EXPECT_NO_FATAL_FAILURE({ t.releaseResourcePolicy(); }); +} + +TEST(IndexTaskTest, DoTaskWithHeavyGradeReleasesCpuQuota) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", noopHandler()); + t.setGrade(IndexTask::Grade::Heavy); + EXPECT_NO_FATAL_FAILURE({ t.doTask(); }); +} + +TEST(IndexTaskTest, DoTaskWithManualGradeReleasesCpuQuota) +{ + IndexTask t(IndexTask::Type::Create, "/tmp", noopHandler()); + t.setGrade(IndexTask::Grade::Manual); + EXPECT_NO_FATAL_FAILURE({ t.doTask(); }); +} diff --git a/autotests/index/test_indextraverseutils.cpp b/autotests/index/test_indextraverseutils.cpp new file mode 100644 index 00000000..963b6178 --- /dev/null +++ b/autotests/index/test_indextraverseutils.cpp @@ -0,0 +1,249 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indextraverseutils.cpp + * @brief Unit tests for IndexTraverseUtils (utils/indextraverseutils.cpp) + */ + +#include +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "utils/indextraverseutils.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class IndexTraverseUtilsTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + QDir root(tmp.path()); + root.mkpath("subdir1/subsub"); + root.mkpath("subdir2"); + QFile f(root.filePath("file.txt")); + f.open(QIODevice::WriteOnly); + f.write("hello"); + f.close(); + QFile f2(root.filePath(".hidden")); + f2.open(QIODevice::WriteOnly); + f2.write("hidden"); + f2.close(); + } +}; + +// ---- isHiddenFile ---- +TEST_F(IndexTraverseUtilsTest, IsHiddenFile_DotPrefix) +{ + EXPECT_TRUE(IndexTraverseUtils::isHiddenFile(".bashrc")); + EXPECT_TRUE(IndexTraverseUtils::isHiddenFile(".config")); +} + +TEST_F(IndexTraverseUtilsTest, IsHiddenFile_NoDotPrefix) +{ + EXPECT_FALSE(IndexTraverseUtils::isHiddenFile("file.txt")); + EXPECT_FALSE(IndexTraverseUtils::isHiddenFile("README")); +} + +// ---- isSpecialDir ---- +TEST_F(IndexTraverseUtilsTest, IsSpecialDir_Dot) +{ + EXPECT_TRUE(IndexTraverseUtils::isSpecialDir(".")); +} + +TEST_F(IndexTraverseUtilsTest, IsSpecialDir_DotDot) +{ + EXPECT_TRUE(IndexTraverseUtils::isSpecialDir("..")); +} + +TEST_F(IndexTraverseUtilsTest, IsSpecialDir_RegularName) +{ + EXPECT_FALSE(IndexTraverseUtils::isSpecialDir("file.txt")); + EXPECT_FALSE(IndexTraverseUtils::isSpecialDir("subdir")); +} + +// ---- isValidFile ---- +TEST_F(IndexTraverseUtilsTest, IsValidFile_ExistingFile) +{ + EXPECT_TRUE(IndexTraverseUtils::isValidFile(tmp.path() + "/file.txt")); +} + +TEST_F(IndexTraverseUtilsTest, IsValidFile_NonExistent) +{ + EXPECT_FALSE(IndexTraverseUtils::isValidFile(tmp.path() + "/nonexistent.txt")); +} + +// ---- isValidDirectory ---- +TEST_F(IndexTraverseUtilsTest, IsValidDirectory_ValidDir) +{ + QSet visited; + EXPECT_TRUE(IndexTraverseUtils::isValidDirectory(tmp.path(), visited)); + EXPECT_TRUE(visited.contains(QDir(tmp.path()).canonicalPath())); +} + +TEST_F(IndexTraverseUtilsTest, IsValidDirectory_DuplicateDir) +{ + QSet visited; + EXPECT_TRUE(IndexTraverseUtils::isValidDirectory(tmp.path(), visited)); + // Second call with same dir returns false (already visited) + EXPECT_FALSE(IndexTraverseUtils::isValidDirectory(tmp.path(), visited)); +} + +TEST_F(IndexTraverseUtilsTest, IsValidDirectory_Symlink) +{ + QString linkPath = tmp.path() + "/symlink_to_subdir"; + QFile::link(tmp.path() + "/subdir1", linkPath); + QSet visited; + EXPECT_FALSE(IndexTraverseUtils::isValidDirectory(linkPath, visited)); +} + +TEST_F(IndexTraverseUtilsTest, IsValidDirectory_NonExistent) +{ + QSet visited; + EXPECT_FALSE(IndexTraverseUtils::isValidDirectory("/nonexistent/path/12345", visited)); +} + +// ---- shouldSkipDirectory ---- +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Proc) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/proc")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/proc/something")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Sys) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/sys")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/sys/class/net")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Dev) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/dev")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/dev/sda1")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Boot) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/boot")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/boot/grub")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Tmp) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/tmp")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/tmp/something")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_VarTmp) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/var/tmp")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_VarCache) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/var/cache")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_VarLog) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/var/log")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Run) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/run")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/run/media")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Mnt) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/mnt")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/mnt/data")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Opt) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/opt")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Srv) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/srv")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_UsrLib) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/usr/lib")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/usr/lib32")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/usr/lib64")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/usr/libx32")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_UsrShare) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/usr/share")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Data) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/data")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Ostree) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/ostree")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/persistent/ostree")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_LostFound) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/lost+found")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_Media) +{ + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/media")); +} + +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_NormalPath) +{ + // /home/user is not in the exclusion list + EXPECT_FALSE(IndexTraverseUtils::shouldSkipDirectory("/home/user/docs")); +} + +// Edge case: startsWith-based matching (implementation detail) +TEST_F(IndexTraverseUtilsTest, ShouldSkipDirectory_StartsWithBehavior) +{ + // The implementation uses startsWith, so /processing matches /proc prefix + // This test documents the actual behavior + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/procinfo")); + EXPECT_TRUE(IndexTraverseUtils::shouldSkipDirectory("/sysfs")); +} + +// ---- fstabBindInfo ---- +TEST_F(IndexTraverseUtilsTest, FstabBindInfo_ReturnsMap) +{ + // /etc/fstab always exists on Linux, so this should work. + // Even if empty, it should return a valid QMap. + QMap info = IndexTraverseUtils::fstabBindInfo(); + // Just verify it doesn't crash and returns something + SUCCEED(); +} + +TEST_F(IndexTraverseUtilsTest, FstabBindInfo_ConsistentAcrossCalls) +{ + QMap first = IndexTraverseUtils::fstabBindInfo(); + QMap second = IndexTraverseUtils::fstabBindInfo(); + // Same file, same mtime -> should return identical results + EXPECT_EQ(first, second); +} diff --git a/autotests/index/test_indexutility.cpp b/autotests/index/test_indexutility.cpp new file mode 100644 index 00000000..b39a8217 --- /dev/null +++ b/autotests/index/test_indexutility.cpp @@ -0,0 +1,199 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_indexutility.cpp + * @brief Unit tests for IndexUtility free functions (indexutility.cpp) + */ + +#include +#include +#include +#include +#include +#include + +#include "index_global.h" +#include "utils/indexutility.h" +#include +#include +#include "dfm_test_main.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(IndexUtilityTest, NormalizeDirectoryPathAddsTrailingSlash) +{ + EXPECT_EQ(PathCalculator::normalizeDirectoryPath("/home/user"), QString("/home/user/")); + EXPECT_EQ(PathCalculator::normalizeDirectoryPath("/home/user/"), QString("/home/user/")); +} + +TEST(IndexUtilityTest, IsDirectoryMoveExistingDir) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + EXPECT_TRUE(PathCalculator::isDirectoryMove(tmp.path())); +} + +TEST(IndexUtilityTest, IsDirectoryMoveExistingFile) +{ + QTemporaryDir tmp; + QString path = tmp.path() + "/afile.txt"; + QFile f(path); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.close(); + EXPECT_FALSE(PathCalculator::isDirectoryMove(path)); +} + +TEST(IndexUtilityTest, IsDirectoryMoveEmptyReturnsFalse) +{ + EXPECT_FALSE(PathCalculator::isDirectoryMove("")); +} + +TEST(IndexUtilityTest, IsDirectoryMoveTrailingSlashInferred) +{ + EXPECT_TRUE(PathCalculator::isDirectoryMove("/no/such/dir/")); + EXPECT_FALSE(PathCalculator::isDirectoryMove("/no/such/file")); +} + +TEST(IndexUtilityTest, ExtractAncestorPathsBuildsList) +{ + QStringList ancestors = PathCalculator::extractAncestorPaths("/home/user/docs/file.txt"); + EXPECT_FALSE(ancestors.isEmpty()); + EXPECT_TRUE(ancestors.contains("/home/user/docs")); +} + +TEST(IndexUtilityTest, ExtractAncestorPathsEmptyReturnsEmpty) +{ + EXPECT_TRUE(PathCalculator::extractAncestorPaths("").isEmpty()); +} + +TEST(IndexUtilityTest, CheckFileSizeWithinLimit) +{ + QTemporaryDir tmp; + QString path = tmp.path() + "/small.txt"; + QFile f(path); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("tiny"); + f.close(); + EXPECT_TRUE(IndexUtility::checkFileSize(QFileInfo(path), 50)); +} + +TEST(IndexUtilityTest, CheckFileSizeExceedsLimit) +{ + QTemporaryDir tmp; + QString path = tmp.path() + "/big.txt"; + QFile f(path); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(QByteArray(10, 'x')); + f.close(); + // 0 falls back to 50MB default, a 10-byte file fits + EXPECT_TRUE(IndexUtility::checkFileSize(QFileInfo(path), 0)); + EXPECT_TRUE(IndexUtility::checkFileSize(QFileInfo(path), 50)); +} + +TEST(IndexUtilityTest, CheckFileSizeNonExistent) +{ + QFileInfo info("/no/such/file/here.txt"); + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::checkFileSize(info, 50); }); +} + +TEST(IndexUtilityTest, IsSupportedTextFileBySuffix) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isSupportedTextFile("/some/path/readme.txt"); }); + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isSupportedTextFile("/some/path/unknown.xyz"); }); +} + +TEST(IndexUtilityTest, IsSupportedOCRFileBySuffix) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isSupportedOCRFile("/some/path/image.png"); }); + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isSupportedOCRFile("/some/path/unknown.xyz"); }); +} + +TEST(IndexUtilityTest, IsDefaultIndexedDirectory) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isDefaultIndexedDirectory("/no/such/indexed/dir"); }); +} + +TEST(IndexUtilityTest, IsIndexWithAnything) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isIndexWithAnything("/no/such/dir"); }); +} + +TEST(IndexUtilityTest, AnythingConfigWatcherInstance) +{ + EXPECT_NE(IndexUtility::AnythingConfigWatcher::instance(), nullptr); +} + +TEST(IndexUtilityTest, AnythingConfigWatcherDefaultPaths) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::AnythingConfigWatcher::instance()->defaultAnythingIndexPaths(); }); + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::AnythingConfigWatcher::instance()->defaultAnythingIndexPathsRealtime(); }); +} + +TEST(IndexUtilityTest, AnythingConfigWatcherBlacklistPaths) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::AnythingConfigWatcher::instance()->defaultBlacklistPaths(); }); + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::AnythingConfigWatcher::instance()->defaultBlacklistPathsRealtime(); }); +} + +// ---- Coverage additions: config watcher destructors + handleConfigChanged ---- + +TEST(IndexUtilityTest, AnythingConfigWatcherHandleConfigChangedCallable) +{ + EXPECT_NO_FATAL_FAILURE({ IndexUtility::AnythingConfigWatcher::instance()->handleConfigChanged("log_rules"); }); +} + +TEST(IndexUtilityTest, DlnfsConfigWatcherInstanceCallable) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::DlnfsConfigWatcher::instance(); }); +} + +TEST(IndexUtilityTest, PathCalculatorCalculateNewPathForDirectoryMove) +{ + EXPECT_NO_FATAL_FAILURE({ + (void)PathCalculator::calculateNewPathForDirectoryMove("/old", "/old/sub", "/new"); + }); +} + +TEST(IndexUtilityTest, SearchUtilityRunCliCallable) +{ + EXPECT_NO_FATAL_FAILURE({ (void)SearchUtility::runCli({ "echo", "hello" }, 5000); }); +} + +TEST(IndexUtilityTest, ConfigRebuildWatcherConstructsEmpty) +{ + QList empty; + IndexUtility::ConfigRebuildWatcher w(empty, nullptr); + SUCCEED(); +} +TEST(IndexUtilityTest, ConfigRebuildWatcherD0Destructor) +{ + QList empty; + auto *ptr = new IndexUtility::ConfigRebuildWatcher(empty, nullptr); + EXPECT_NO_FATAL_FAILURE({ delete ptr; }); +} +TEST(IndexUtilityTest, DlnfsConfigWatcherInstanceExt) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::DlnfsConfigWatcher::instance(); }); +} +TEST(IndexUtilityTest, AnythingConfigWatcherInstanceExt) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::AnythingConfigWatcher::instance(); }); +} +TEST(IndexUtilityTest, IsDefaultIndexedDirectoryReturnsBool) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isDefaultIndexedDirectory("/tmp"); }); +} +TEST(IndexUtilityTest, IsIndexWithAnythingReturnsBool) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isIndexWithAnything("/tmp"); }); +} +TEST(IndexUtilityTest, IsSupportedTextFileReturnsBool) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isSupportedTextFile("/tmp/test.txt"); }); +} +TEST(IndexUtilityTest, IsSupportedOCRFileReturnsBool) +{ + EXPECT_NO_FATAL_FAILURE({ (void)IndexUtility::isSupportedOCRFile("/tmp/test.png"); }); +} diff --git a/autotests/index/test_inotifyfilesystemwatcher.cpp b/autotests/index/test_inotifyfilesystemwatcher.cpp new file mode 100644 index 00000000..1b6c5089 --- /dev/null +++ b/autotests/index/test_inotifyfilesystemwatcher.cpp @@ -0,0 +1,565 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include +#include +#include +#include +#include +#include +#include + +#include "index_global.h" +#include "fsmonitor/inotifyfilesystemwatcher.h" +#include "fsmonitor/inotifyfilesystemwatcher_p.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +// InotifyFileSystemWatcher 使用 inotify 监控文件系统变化 +// 通过 QSocketNotifier 异步投递事件，需要用 QSignalSpy::wait() 等待信号 +class TestInotifyFileSystemWatcher : public ::testing::Test +{ +protected: + void SetUp() override + { + // 在 ~/Documents/ 下创建隐藏临时目录 + QString templatePath = QDir::homePath() + "/Documents/.test_inotify_XXXXXX"; + testDir = std::make_unique(templatePath); + ASSERT_TRUE(testDir->isValid()); + // 确保目录存在 + QDir().mkpath(testDir->path()); + } + + void TearDown() override + { + testDir.reset(); + } + + // 辅助：等待信号并返回信号计数，超时返回 0 + int waitForSignal(QSignalSpy &spy, int timeoutMs = 3000) + { + spy.wait(timeoutMs); + return spy.count(); + } + + std::unique_ptr testDir; +}; + +// ========== 构造与基础功能 ========== + +TEST_F(TestInotifyFileSystemWatcher, Construction) +{ + InotifyFileSystemWatcher watcher; + EXPECT_EQ(watcher.watchFlags(), InotifyFileSystemWatcher::AllEvents); + EXPECT_TRUE(watcher.files().isEmpty()); + EXPECT_TRUE(watcher.directories().isEmpty()); +} + +TEST_F(TestInotifyFileSystemWatcher, AddDirectoryPath) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + + bool result = watcher.addPath(dirPath); + EXPECT_TRUE(result); + EXPECT_TRUE(watcher.directories().contains(dirPath)); + EXPECT_TRUE(watcher.files().isEmpty()); +} + +TEST_F(TestInotifyFileSystemWatcher, AddFilePath) +{ + InotifyFileSystemWatcher watcher; + QString filePath = testDir->path() + "/testfile.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("hello"); + file.close(); + + bool result = watcher.addPath(filePath); + EXPECT_TRUE(result); + EXPECT_TRUE(watcher.files().contains(filePath)); + EXPECT_TRUE(watcher.directories().isEmpty()); +} + +TEST_F(TestInotifyFileSystemWatcher, RemovePath) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + + watcher.addPath(dirPath); + EXPECT_TRUE(watcher.directories().contains(dirPath)); + + bool result = watcher.removePath(dirPath); + EXPECT_TRUE(result); + EXPECT_FALSE(watcher.directories().contains(dirPath)); +} + +TEST_F(TestInotifyFileSystemWatcher, DuplicatePathIsIdempotent) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + + bool r1 = watcher.addPath(dirPath); + bool r2 = watcher.addPath(dirPath); + // 第一次添加成功返回 true + EXPECT_TRUE(r1); + // 第二次重复添加返回 false（私有 addPaths 将重复路径视为"未添加"保留在返回列表中） + EXPECT_FALSE(r2); + // 目录列表中只有一个条目，不会重复 + EXPECT_EQ(watcher.directories().size(), 1); +} + +TEST_F(TestInotifyFileSystemWatcher, AddPathsBatch) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + QString filePath = dirPath + "/batchfile.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.close(); + + QStringList paths = { dirPath, filePath }; + QStringList failed = watcher.addPaths(paths); + EXPECT_TRUE(failed.isEmpty()); + EXPECT_TRUE(watcher.directories().contains(dirPath)); + EXPECT_TRUE(watcher.files().contains(filePath)); +} + +TEST_F(TestInotifyFileSystemWatcher, RemovePathsBatch) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QStringList removed = watcher.removePaths({ dirPath }); + EXPECT_TRUE(removed.isEmpty()); + EXPECT_FALSE(watcher.directories().contains(dirPath)); +} + +TEST_F(TestInotifyFileSystemWatcher, AddEmptyPathReturnsFalse) +{ + InotifyFileSystemWatcher watcher; + bool result = watcher.addPath(""); + // 空路径被过滤，addPath 返回 false（列表不为空说明路径未被添加） + EXPECT_FALSE(result); +} + +TEST_F(TestInotifyFileSystemWatcher, SetWatchFlags) +{ + InotifyFileSystemWatcher watcher; + watcher.setWatchFlags(InotifyFileSystemWatcher::FileClose); + EXPECT_EQ(watcher.watchFlags(), InotifyFileSystemWatcher::FileClose); +} + +// ========== 文件创建信号 ========== + +TEST_F(TestInotifyFileSystemWatcher, FileCreatedInWatchedDirectory) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QSignalSpy spy(&watcher, &InotifyFileSystemWatcher::fileCreated); + ASSERT_TRUE(spy.isValid()); + + // 创建文件 + QString filePath = dirPath + "/newfile.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("test content"); + file.close(); + + int count = waitForSignal(spy); + EXPECT_EQ(count, 1); + + // 验证信号参数 + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirPath); + EXPECT_EQ(args.at(1).toString(), "newfile.txt"); +} + +TEST_F(TestInotifyFileSystemWatcher, SubdirectoryCreatedInWatchedDirectory) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QSignalSpy spy(&watcher, &InotifyFileSystemWatcher::fileCreated); + ASSERT_TRUE(spy.isValid()); + + // 创建子目录 + QString subDirPath = dirPath + "/subdir"; + QDir().mkpath(subDirPath); + + int count = waitForSignal(spy); + EXPECT_EQ(count, 1); + + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirPath); + EXPECT_EQ(args.at(1).toString(), "subdir"); +} + +// ========== 文件删除信号 ========== + +TEST_F(TestInotifyFileSystemWatcher, FileDeletedInWatchedDirectory) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + // 先创建文件 + QString filePath = dirPath + "/todelete.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("delete me"); + file.close(); + + // 清除创建阶段的信号 + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + waitForSignal(createSpy); + + QSignalSpy deleteSpy(&watcher, &InotifyFileSystemWatcher::fileDeleted); + ASSERT_TRUE(deleteSpy.isValid()); + + // 删除文件 + QFile::remove(filePath); + + int count = waitForSignal(deleteSpy); + EXPECT_EQ(count, 1); + + QList args = deleteSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirPath); + EXPECT_EQ(args.at(1).toString(), "todelete.txt"); +} + +TEST_F(TestInotifyFileSystemWatcher, DirectoryDeletedInWatchedDirectory) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + // 先创建子目录 + QString subDirPath = dirPath + "/todeletedir"; + QDir().mkpath(subDirPath); + + // 等待创建信号 + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + waitForSignal(createSpy); + + QSignalSpy deleteSpy(&watcher, &InotifyFileSystemWatcher::fileDeleted); + ASSERT_TRUE(deleteSpy.isValid()); + + // 删除子目录 + QDir().rmdir(subDirPath); + + int count = waitForSignal(deleteSpy); + EXPECT_EQ(count, 1); + + QList args = deleteSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirPath); + EXPECT_EQ(args.at(1).toString(), "todeletedir"); +} + +// ========== 文件修改信号 ========== + +TEST_F(TestInotifyFileSystemWatcher, FileModifiedInWatchedDirectory) +{ + InotifyFileSystemWatcher watcher; + watcher.setWatchFlags(InotifyFileSystemWatcher::FileModify); + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QSignalSpy spy(&watcher, &InotifyFileSystemWatcher::fileModified); + ASSERT_TRUE(spy.isValid()); + + // 创建并写入文件 + QString filePath = dirPath + "/modify_test.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("modify me"); + file.flush(); + + int count = waitForSignal(spy); + EXPECT_GE(count, 1); +} + +// ========== 文件关闭信号 ========== + +TEST_F(TestInotifyFileSystemWatcher, FileClosedAfterWrite) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QSignalSpy spy(&watcher, &InotifyFileSystemWatcher::fileClosed); + ASSERT_TRUE(spy.isValid()); + + // 创建并写入后关闭文件 + QString filePath = dirPath + "/close_test.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("close me"); + file.close(); + + int count = waitForSignal(spy); + EXPECT_EQ(count, 1); + + // 对于目录监控，name 是被关闭的子文件名 + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirPath); + EXPECT_EQ(args.at(1).toString(), "close_test.txt"); +} + +// ========== 属性变更信号 ========== + +TEST_F(TestInotifyFileSystemWatcher, FileAttributeChanged) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + // 先创建文件并等待创建完成 + QString filePath = dirPath + "/chmod_test.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("chmod me"); + file.close(); + + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + waitForSignal(createSpy); + + QSignalSpy spy(&watcher, &InotifyFileSystemWatcher::fileAttributeChanged); + ASSERT_TRUE(spy.isValid()); + + // 修改文件权限 + QFile::setPermissions(filePath, QFile::ReadOwner | QFile::WriteOwner); + + int count = waitForSignal(spy); + EXPECT_EQ(count, 1); + + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirPath); + EXPECT_EQ(args.at(1).toString(), "chmod_test.txt"); +} + +// ========== 文件重命名/移动信号 ========== + +TEST_F(TestInotifyFileSystemWatcher, FileRenameWithinWatchedDirectory) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + // 先创建文件 + QString oldPath = dirPath + "/oldname.txt"; + QFile file(oldPath); + file.open(QIODevice::WriteOnly); + file.write("rename me"); + file.close(); + + // 等待创建完成 + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + waitForSignal(createSpy); + + QSignalSpy moveSpy(&watcher, &InotifyFileSystemWatcher::fileMoved); + ASSERT_TRUE(moveSpy.isValid()); + + // 重命名文件 + QString newPath = dirPath + "/newname.txt"; + QFile::rename(oldPath, newPath); + + int count = waitForSignal(moveSpy); + // inotify 在同一目录中重命名时，MOVED_FROM 和 MOVED_TO 通过 cookie 配对 + EXPECT_EQ(count, 1); + + QList args = moveSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirPath); // fromPath + EXPECT_EQ(args.at(1).toString(), "oldname.txt"); // fromName + EXPECT_EQ(args.at(2).toString(), dirPath); // toPath + EXPECT_EQ(args.at(3).toString(), "newname.txt"); // toName +} + +TEST_F(TestInotifyFileSystemWatcher, FileMoveAcrossWatchedDirectories) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + + // 创建两个子目录 + QString dirA = dirPath + "/dirA"; + QString dirB = dirPath + "/dirB"; + QDir().mkpath(dirA); + QDir().mkpath(dirB); + + watcher.addPath(dirA); + watcher.addPath(dirB); + + // 等待目录创建信号 + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + while (createSpy.count() < 2 && createSpy.wait(1000)) + ; + + // 在 dirA 中创建文件 + QString filePath = dirA + "/movefile.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("move me"); + file.close(); + + waitForSignal(createSpy); + + QSignalSpy moveSpy(&watcher, &InotifyFileSystemWatcher::fileMoved); + ASSERT_TRUE(moveSpy.isValid()); + + // 移动文件到 dirB + QFile::rename(filePath, dirB + "/movefile.txt"); + + int count = waitForSignal(moveSpy); + EXPECT_EQ(count, 1); + + QList args = moveSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), dirA); // fromPath + EXPECT_EQ(args.at(1).toString(), "movefile.txt"); // fromName + EXPECT_EQ(args.at(2).toString(), dirB); // toPath + EXPECT_EQ(args.at(3).toString(), "movefile.txt"); // toName +} + +// ========== WatchFlags 过滤 ========== + +TEST_F(TestInotifyFileSystemWatcher, WatchFlagsFiltering_OnlyClose) +{ + InotifyFileSystemWatcher watcher; + // 只监控 FileClose 事件 + watcher.setWatchFlags(InotifyFileSystemWatcher::FileClose); + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QSignalSpy closeSpy(&watcher, &InotifyFileSystemWatcher::fileClosed); + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + QSignalSpy modifySpy(&watcher, &InotifyFileSystemWatcher::fileModified); + ASSERT_TRUE(closeSpy.isValid()); + ASSERT_TRUE(createSpy.isValid()); + ASSERT_TRUE(modifySpy.isValid()); + + // 创建文件并写入关闭 + QString filePath = dirPath + "/filter_test.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("content"); + file.close(); + + waitForSignal(closeSpy); + + // 只有 fileClosed 信号应该触发 + // fileCreated 使用 IN_CREATE，由于 AllEvents 不包含 FileCreate 时不会触发 + // 但默认的 mask 始终包含 IN_DELETE_SELF | IN_MOVE_SELF + // FileClose 过滤下只应有 fileClosed + EXPECT_GE(closeSpy.count(), 1); + EXPECT_EQ(createSpy.count(), 0); + EXPECT_EQ(modifySpy.count(), 0); +} + +// ========== 信号去重 ========== + +TEST_F(TestInotifyFileSystemWatcher, NoDuplicateSignalsForSingleOperation) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + ASSERT_TRUE(createSpy.isValid()); + + // 创建单个文件 + QString filePath = dirPath + "/unique_create.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("unique"); + file.close(); + + waitForSignal(createSpy); + + // 额外等待一小段时间确认不会有重复信号 + createSpy.wait(500); + + // 应该只收到一次 fileCreated 信号 + EXPECT_EQ(createSpy.count(), 1); +} + +// ========== 监控自身被删除 ========== + +TEST_F(TestInotifyFileSystemWatcher, WatchedPathSelfDeleted) +{ + InotifyFileSystemWatcher watcher; + QString subDirPath = testDir->path() + "/selfdelete_dir"; + QDir().mkpath(subDirPath); + + watcher.addPath(subDirPath); + + QSignalSpy deleteSpy(&watcher, &InotifyFileSystemWatcher::fileDeleted); + ASSERT_TRUE(deleteSpy.isValid()); + + // 删除被监控的目录本身 + QDir().rmdir(subDirPath); + + int count = waitForSignal(deleteSpy); + EXPECT_EQ(count, 1); + + // 自删除信号：path 是目录本身，name 为空 + QList args = deleteSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), subDirPath); + EXPECT_EQ(args.at(1).toString(), ""); +} + +// ========== 文件监控 ========== + +TEST_F(TestInotifyFileSystemWatcher, FileWatchReceivesAttributeChange) +{ + InotifyFileSystemWatcher watcher; + QString filePath = testDir->path() + "/watched_file.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("watched"); + file.close(); + + watcher.addPath(filePath); + ASSERT_TRUE(watcher.files().contains(filePath)); + + QSignalSpy attribSpy(&watcher, &InotifyFileSystemWatcher::fileAttributeChanged); + ASSERT_TRUE(attribSpy.isValid()); + + // 修改被监控文件的权限 + QFile::setPermissions(filePath, QFile::ReadOwner); + + int count = waitForSignal(attribSpy); + EXPECT_EQ(count, 1); +} + +// ========== 并发操作不产生重复信号 ========== + +TEST_F(TestInotifyFileSystemWatcher, RapidOperationsNoDuplicates) +{ + InotifyFileSystemWatcher watcher; + QString dirPath = testDir->path(); + watcher.addPath(dirPath); + + QSignalSpy createSpy(&watcher, &InotifyFileSystemWatcher::fileCreated); + ASSERT_TRUE(createSpy.isValid()); + + // 快速创建多个文件 + for (int i = 0; i < 5; ++i) { + QString filePath = dirPath + QString("/rapid_%1.txt").arg(i); + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("data"); + file.close(); + } + + // 等待所有信号 + waitForSignal(createSpy, 3000); + // 额外等待确保所有异步信号到达 + createSpy.wait(1000); + + // 应该恰好收到 5 次 fileCreated + EXPECT_EQ(createSpy.count(), 5); +} diff --git a/autotests/index/test_loadmonitor.cpp b/autotests/index/test_loadmonitor.cpp new file mode 100644 index 00000000..d8059136 --- /dev/null +++ b/autotests/index/test_loadmonitor.cpp @@ -0,0 +1,582 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" + +#include "env/loadmonitor.h" +#include "env/powermonitor.h" +#include "env/idlemonitor.h" +#include "env/envdetector.h" + +using namespace anything_index; + +// ============================================================================ +// LoadMonitor Tests +// ============================================================================ + +class TestLoadMonitor : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + monitor = std::make_unique(); + } + + void TearDown() override + { + monitor.reset(); + } + + std::unique_ptr app; + std::unique_ptr monitor; + + static int argc; + static char *argv[]; +}; + +int TestLoadMonitor::argc = 1; +char *TestLoadMonitor::argv[] = { const_cast("test_loadmonitor") }; + +// --- Construction --- + +TEST_F(TestLoadMonitor, Construction_DefaultValues) +{ + EXPECT_NE(monitor->m_timer, nullptr); + EXPECT_GT(monitor->m_sampleIntervalSecs, 0); + EXPECT_GT(monitor->m_cpuThresholdPercent, 0); + EXPECT_GT(monitor->m_diskThresholdPercent, 0); + EXPECT_DOUBLE_EQ(monitor->cpuAvgPercent(), 0.0); + EXPECT_DOUBLE_EQ(monitor->diskBusyPercent(), 0.0); + EXPECT_DOUBLE_EQ(monitor->cpuInstantPercent(), 0.0); + EXPECT_DOUBLE_EQ(monitor->diskInstantPercent(), 0.0); +} + +// --- readProcStat with real /proc/stat --- + +TEST_F(TestLoadMonitor, ReadProcStat_RealFile_ReturnsTrue) +{ + qint64 user = -1, guest = -1, total = -1; + EXPECT_TRUE(monitor->readProcStat(user, guest, total)); + EXPECT_GE(user, 0); + EXPECT_GE(guest, 0); + EXPECT_GE(total, 0); + // total should be sum of user + nice + system + idle + iowait + irq + softirq + steal + // so it should be at least as large as user alone + EXPECT_GE(total, user); +} + +// --- readProcDiskstats with real /proc/diskstats --- + +TEST_F(TestLoadMonitor, ReadProcDiskstats_EmptyDeviceName_ReturnsFalse) +{ + monitor->m_diskDeviceName.clear(); + qint64 ioTicks = -1; + EXPECT_FALSE(monitor->readProcDiskstats(ioTicks)); +} + +TEST_F(TestLoadMonitor, ReadProcDiskstats_RealDiskstats_MatchesPrefix) +{ + // Read /proc/diskstats ourselves to find a whole-disk entry + QFile file(QStringLiteral("/proc/diskstats")); + ASSERT_TRUE(file.open(QIODevice::ReadOnly | QIODevice::Text)); + QString content = QString::fromUtf8(file.readAll()); + file.close(); + + // Find first line with >= 13 fields — that's a whole-disk row + qint64 expectedTicks = 0; + QString diskName; + for (const QString &line : content.split(QLatin1Char('\n'))) { + const auto parts = line.split(QRegularExpression(QStringLiteral("\\s+")), Qt::SkipEmptyParts); + if (parts.size() >= 13) { + diskName = parts[2]; + expectedTicks = parts[12].toLongLong(); + break; + } + } + ASSERT_FALSE(diskName.isEmpty()); + + // Set the device name to a fake partition name that starts with the disk name + monitor->m_diskDeviceName = diskName + "1"; + qint64 ioTicks = -1; + EXPECT_TRUE(monitor->readProcDiskstats(ioTicks)); + EXPECT_EQ(ioTicks, expectedTicks); +} + +// --- CPU %usr calculation (mocked readProcStat) --- + +TEST_F(TestLoadMonitor, Sample_CpuUsrCalculation_Mocked) +{ + stub_ext::StubExt stub; + + // Simulate two samples: first with user=1000 guest=0 total=10000, + // second with user=1100 guest=0 total=11000 + // %usr = (1100-1000 - (0-0)) / (11000-10000) * 100 = 10% + int callCount = 0; + stub.set_lamda(ADDR(LoadMonitor, readProcStat), [&callCount](LoadMonitor *, qint64 &user, qint64 &guest, qint64 &total) { + if (callCount == 0) { + user = 1000; + guest = 0; + total = 10000; + } else { + user = 1100; + guest = 0; + total = 11000; + } + callCount++; + return true; + }); + + stub.set_lamda(ADDR(LoadMonitor, readProcDiskstats), [](LoadMonitor *, qint64 &ioTicks) { + ioTicks = 0; + return true; + }); + + QSignalSpy spy(monitor.get(), &LoadMonitor::loadChanged); + + monitor->sample(); + // First sample only — no percentage computed yet + EXPECT_EQ(spy.count(), 0); + + monitor->sample(); + // Second sample — percentage computed + ASSERT_EQ(spy.count(), 1); + QList args = spy.takeFirst(); + EXPECT_NEAR(args[0].toDouble(), 10.0, 0.01); +} + +// --- CPU %usr with guest correction --- + +TEST_F(TestLoadMonitor, Sample_CpuUsrWithGuest_Mocked) +{ + stub_ext::StubExt stub; + + // user includes guest, so %usr = (user - guest) / total + // Sample 1: user=1500, guest=500, total=10000 + // Sample 2: user=2500, guest=500, total=11000 + // delta_user=1000, delta_guest=0, delta_total=1000 + // %usr = (1000 - 0) / 1000 * 100 = 100% + int callCount = 0; + stub.set_lamda(ADDR(LoadMonitor, readProcStat), [&callCount](LoadMonitor *, qint64 &user, qint64 &guest, qint64 &total) { + if (callCount == 0) { + user = 1500; + guest = 500; + total = 10000; + } else { + user = 2500; + guest = 500; + total = 11000; + } + callCount++; + return true; + }); + + stub.set_lamda(ADDR(LoadMonitor, readProcDiskstats), [](LoadMonitor *, qint64 &ioTicks) { + ioTicks = 0; + return true; + }); + + monitor->sample(); + monitor->sample(); + + // %usr = 100% since all delta went to user (minus guest) + EXPECT_NEAR(monitor->cpuAvgPercent(), 100.0, 0.01); + EXPECT_NEAR(monitor->cpuInstantPercent(), 100.0, 0.01); +} + +// --- Disk %util calculation (mocked readProcDiskstats) --- + +TEST_F(TestLoadMonitor, Sample_DiskUtilCalculation_Mocked) +{ + stub_ext::StubExt stub; + + // Sample 1: ioTicks=0, Sample 2: ioTicks=500 + // elapsedMs = 5 * 1000 = 5000 + // %util = (500 - 0) / 5000 * 100 = 10% + int callCount = 0; + stub.set_lamda(ADDR(LoadMonitor, readProcDiskstats), [&callCount](LoadMonitor *, qint64 &ioTicks) { + ioTicks = (callCount == 0) ? 0 : 500; + callCount++; + return true; + }); + + stub.set_lamda(ADDR(LoadMonitor, readProcStat), [](LoadMonitor *, qint64 &user, qint64 &guest, qint64 &total) { + user = 1000; + guest = 0; + total = 10000; + return true; + }); + + monitor->sample(); + monitor->sample(); + + EXPECT_NEAR(monitor->diskBusyPercent(), 10.0, 0.01); + EXPECT_NEAR(monitor->diskInstantPercent(), 10.0, 0.01); +} + +// --- Disk %util capped at 100% --- + +TEST_F(TestLoadMonitor, Sample_DiskUtilCappedAt100_Mocked) +{ + stub_ext::StubExt stub; + + // ioTicks delta exceeds elapsed time → should cap at 100% + int callCount = 0; + stub.set_lamda(ADDR(LoadMonitor, readProcDiskstats), [&callCount](LoadMonitor *, qint64 &ioTicks) { + ioTicks = (callCount == 0) ? 0 : 999999; + callCount++; + return true; + }); + + stub.set_lamda(ADDR(LoadMonitor, readProcStat), [](LoadMonitor *, qint64 &user, qint64 &guest, qint64 &total) { + user = 1000; + guest = 0; + total = 10000; + return true; + }); + + monitor->sample(); + monitor->sample(); + + EXPECT_NEAR(monitor->diskBusyPercent(), 100.0, 0.01); +} + +// --- Threshold checks --- + +TEST_F(TestLoadMonitor, IsCpuBelowThreshold_DefaultZero_ReturnsTrue) +{ + EXPECT_TRUE(monitor->isCpuBelowThreshold()); +} + +TEST_F(TestLoadMonitor, IsDiskBelowThreshold_DefaultZero_ReturnsTrue) +{ + EXPECT_TRUE(monitor->isDiskBelowThreshold()); +} + +// --- setDataPath --- + +TEST_F(TestLoadMonitor, SetDataPath_UpdatesDataPath) +{ + monitor->setDataPath(QStringLiteral("/tmp")); + EXPECT_EQ(monitor->m_dataPath, QStringLiteral("/tmp")); +} + +// --- resolveDataDisk --- + +TEST_F(TestLoadMonitor, ResolveDataDisk_EmptyPath_NoDeviceName) +{ + monitor->m_dataPath.clear(); + monitor->resolveDataDisk(); + EXPECT_TRUE(monitor->m_diskDeviceName.isEmpty()); +} + +TEST_F(TestLoadMonitor, ResolveDataDisk_HomePath_ResolvesDevice) +{ + monitor->m_dataPath = QDir::homePath(); + monitor->resolveDataDisk(); + // On Linux, home should resolve to a block device + EXPECT_FALSE(monitor->m_diskDeviceName.isEmpty()); +} + +// --- Window management --- + +TEST_F(TestLoadMonitor, Window_Size_CappedAtMaxSamples) +{ + stub_ext::StubExt stub; + + stub.set_lamda(ADDR(LoadMonitor, readProcStat), [](LoadMonitor *, qint64 &user, qint64 &guest, qint64 &total) { + user = 1000; + guest = 0; + total = 10000; + return true; + }); + + stub.set_lamda(ADDR(LoadMonitor, readProcDiskstats), [](LoadMonitor *, qint64 &ioTicks) { + ioTicks = 0; + return true; + }); + + const int maxSamples = qMax(1, 60 / monitor->m_sampleIntervalSecs); + for (int i = 0; i < maxSamples + 5; ++i) + monitor->sample(); + + EXPECT_LE(monitor->m_window.size(), maxSamples); +} + +// --- loadChanged signal --- + +TEST_F(TestLoadMonitor, LoadChangedSignal_EmittedOnSecondSample_Mocked) +{ + stub_ext::StubExt stub; + + int callCount = 0; + stub.set_lamda(ADDR(LoadMonitor, readProcStat), [&callCount](LoadMonitor *, qint64 &user, qint64 &guest, qint64 &total) { + user = 1000 * (callCount + 1); + guest = 0; + total = 10000 * (callCount + 1); + callCount++; + return true; + }); + + stub.set_lamda(ADDR(LoadMonitor, readProcDiskstats), [](LoadMonitor *, qint64 &ioTicks) { + ioTicks = 0; + return true; + }); + + QSignalSpy spy(monitor.get(), &LoadMonitor::loadChanged); + monitor->sample(); + EXPECT_EQ(spy.count(), 0); + monitor->sample(); + ASSERT_EQ(spy.count(), 1); +} + +// --- start/stop lifecycle --- + +TEST_F(TestLoadMonitor, StartStop_TimerRunningState) +{ + monitor->setDataPath(QDir::homePath()); + monitor->start(); + EXPECT_TRUE(monitor->m_timer->isActive()); + monitor->stop(); + EXPECT_FALSE(monitor->m_timer->isActive()); +} + +TEST_F(TestLoadMonitor, Stop_WhenNotRunning_NoCrash) +{ + monitor->stop(); + SUCCEED(); +} + +// ============================================================================ +// PowerMonitor Tests (stub DBus) +// ============================================================================ + +class TestPowerMonitor : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + monitor = std::make_unique(); + } + + void TearDown() override + { + monitor.reset(); + } + + std::unique_ptr app; + std::unique_ptr monitor; + + static int argc; + static char *argv[]; +}; + +int TestPowerMonitor::argc = 1; +char *TestPowerMonitor::argv[] = { const_cast("test_powermonitor") }; + +TEST_F(TestPowerMonitor, Construction_DefaultValues) +{ + EXPECT_FALSE(monitor->onBattery()); + EXPECT_FALSE(monitor->powerSaveMode()); +} + +TEST_F(TestPowerMonitor, StartStop_NoCrash) +{ + monitor->start(); + monitor->stop(); + SUCCEED(); +} + +// --- onBatteryChanged delay logic --- + +TEST_F(TestPowerMonitor, OnBatteryChanged_EntersBattery_AfterDelay) +{ + monitor->start(); + + // Simulate battery entry — should not be immediate + monitor->onBatteryChanged(true); + EXPECT_FALSE(monitor->onBattery()); + + // Wait for the delay timer + QTest::qWait(600); + EXPECT_TRUE(monitor->onBattery()); + + monitor->stop(); +} + +TEST_F(TestPowerMonitor, OnBatteryChanged_ExitsBattery_Immediately) +{ + monitor->start(); + + // Set to battery first + monitor->onBatteryChanged(true); + QTest::qWait(600); + EXPECT_TRUE(monitor->onBattery()); + + // Exit battery — should be immediate + monitor->onBatteryChanged(false); + EXPECT_FALSE(monitor->onBattery()); + + monitor->stop(); +} + +// --- onModeChanged delay logic --- + +TEST_F(TestPowerMonitor, OnModeChanged_EnterPowerSave_AfterDelay) +{ + monitor->start(); + + monitor->onModeChanged(QStringLiteral("powersave")); + EXPECT_FALSE(monitor->powerSaveMode()); + + QTest::qWait(600); + EXPECT_TRUE(monitor->powerSaveMode()); + + monitor->stop(); +} + +TEST_F(TestPowerMonitor, OnModeChanged_ExitPowerSave_AfterDelay) +{ + monitor->start(); + + // Enter power save first + monitor->onModeChanged(QStringLiteral("powersave")); + QTest::qWait(600); + EXPECT_TRUE(monitor->powerSaveMode()); + + // Exit power save + monitor->onModeChanged(QStringLiteral("balance")); + EXPECT_TRUE(monitor->powerSaveMode()); // still true until delay expires + + QTest::qWait(600); + EXPECT_FALSE(monitor->powerSaveMode()); + + monitor->stop(); +} + +// ============================================================================ +// IdleMonitor Tests +// ============================================================================ + +class TestIdleMonitor : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + monitor = std::make_unique(); + } + + void TearDown() override + { + monitor.reset(); + } + + std::unique_ptr app; + std::unique_ptr monitor; + + static int argc; + static char *argv[]; +}; + +int TestIdleMonitor::argc = 1; +char *TestIdleMonitor::argv[] = { const_cast("test_idlemonitor") }; + +TEST_F(TestIdleMonitor, Construction_DefaultValues) +{ + EXPECT_FALSE(monitor->idle()); +} + +TEST_F(TestIdleMonitor, StartStop_NoCrash) +{ + monitor->start(); + monitor->stop(); + SUCCEED(); +} + +TEST_F(TestIdleMonitor, Stop_ResetsIdle) +{ + monitor->m_started = true; + monitor->m_idle = true; + monitor->stop(); + EXPECT_FALSE(monitor->idle()); +} + +// ============================================================================ +// EnvDetector Tests +// ============================================================================ + +class TestEnvDetector : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + detector = std::make_unique(); + } + + void TearDown() override + { + detector.reset(); + } + + std::unique_ptr app; + std::unique_ptr detector; + + static int argc; + static char *argv[]; +}; + +int TestEnvDetector::argc = 1; +char *TestEnvDetector::argv[] = { const_cast("test_envdetector") }; + +TEST_F(TestEnvDetector, Construction_DefaultState) +{ + EnvState state = detector->currentState(); + EXPECT_FALSE(state.onBattery); + EXPECT_FALSE(state.powerSaveMode); + EXPECT_FALSE(state.idle); + EXPECT_TRUE(state.isPowerOk()); + EXPECT_TRUE(state.isPowerSaveOff()); + EXPECT_FALSE(state.isIdleOk()); +} + +TEST_F(TestEnvDetector, SetDataPath_NoCrash) +{ + detector->setDataPath(QDir::homePath()); + SUCCEED(); +} + +TEST_F(TestEnvDetector, StartStop_NoCrash) +{ + detector->setDataPath(QDir::homePath()); + detector->start(); + detector->stop(); + SUCCEED(); +} + +TEST_F(TestEnvDetector, EnvStateChanged_EmittedOnStart) +{ + QSignalSpy spy(detector.get(), &EnvDetector::envStateChanged); + detector->setDataPath(QDir::homePath()); + detector->start(); + + if (spy.count() > 0) { + QList args = spy.takeFirst(); + EXPECT_EQ(args.count(), 1); + } +} diff --git a/autotests/index/test_lowercasengramanalyzer.cpp b/autotests/index/test_lowercasengramanalyzer.cpp new file mode 100644 index 00000000..c06549fe --- /dev/null +++ b/autotests/index/test_lowercasengramanalyzer.cpp @@ -0,0 +1,40 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_lowercasengramanalyzer.cpp + * @brief Unit tests for LowerCaseNGramAnalyzer (profile/lowercasengramanalyzer.cpp) + */ + +#include + +#include "index_global.h" +#include "profile/lowercasengramanalyzer.h" + +#include + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(LowerCaseNGramAnalyzerTest, ConstructAndDestruct) +{ + EXPECT_NO_FATAL_FAILURE({ LowerCaseNGramAnalyzer analyzer(2, 5); }); +} + +TEST(LowerCaseNGramAnalyzerTest, TokenStreamReturnsNonNull) +{ + LowerCaseNGramAnalyzer analyzer(2, 5); + Lucene::String fieldName = L"content"; + Lucene::ReaderPtr reader = Lucene::newLucene(L"hello world"); + Lucene::TokenStreamPtr stream = analyzer.tokenStream(fieldName, reader); + EXPECT_NE(stream, nullptr); +} + +TEST(LowerCaseNGramAnalyzerTest, ReusableTokenStreamReturnsNonNull) +{ + LowerCaseNGramAnalyzer analyzer(2, 5); + Lucene::String fieldName = L"content"; + Lucene::ReaderPtr reader = Lucene::newLucene(L"test text"); + Lucene::TokenStreamPtr stream = analyzer.reusableTokenStream(fieldName, reader); + EXPECT_NE(stream, nullptr); +} diff --git a/autotests/index/test_moveprocessor.cpp b/autotests/index/test_moveprocessor.cpp new file mode 100644 index 00000000..97dd9e78 --- /dev/null +++ b/autotests/index/test_moveprocessor.cpp @@ -0,0 +1,108 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_moveprocessor.cpp + * @brief Unit tests for FileMoveProcessor and DirectoryMoveProcessor + * (moveprocessor.cpp). Tests constructors, hasChanges, and edge cases. + * Heavy Lucene operations cannot be stubbed easily due to abstract base classes, + * so we test the code paths that handle null/empty conditions. + */ + +#include +#include +#include + +#include "stubext.h" +#include "index_global.h" +#include "task/moveprocessor.h" +#include "core/indexruntime.h" +#include "profile/indexprofile.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +namespace { + +struct MoveProcTest : public testing::Test +{ + QTemporaryDir tmp; + + IndexProfile makeProfile() + { + return IndexProfile({ IndexProfile::Type::Content, + "moveproc_test", + "moveproc_status.json", + "moveproc_version", + 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &p) -> bool { return p.endsWith(".txt") || p.endsWith(".md"); } }); + } + + std::unique_ptr makeRuntime() + { + return std::make_unique(makeProfile()); + } +}; + +} // namespace + +// Constructor tests - these only store pointers, no dereference +TEST_F(MoveProcTest, FileMoveProcessor_Constructor) +{ + auto runtime = makeRuntime(); + // Constructor stores pointers but doesn't dereference them + EXPECT_NO_FATAL_FAILURE({ + FileMoveProcessor proc(runtime->context(), nullptr, nullptr); + }); +} + +TEST_F(MoveProcTest, FileMoveProcessor_HasChanges_DefaultFalse) +{ + auto runtime = makeRuntime(); + FileMoveProcessor proc(runtime->context(), nullptr, nullptr); + EXPECT_FALSE(proc.hasChanges()); +} + +TEST_F(MoveProcTest, DirectoryMoveProcessor_Constructor) +{ + auto runtime = makeRuntime(); + EXPECT_NO_FATAL_FAILURE({ + DirectoryMoveProcessor proc(runtime->context(), nullptr, nullptr, nullptr); + }); +} + +TEST_F(MoveProcTest, DirectoryMoveProcessor_HasChanges_DefaultFalse) +{ + auto runtime = makeRuntime(); + DirectoryMoveProcessor proc(runtime->context(), nullptr, nullptr, nullptr); + EXPECT_FALSE(proc.hasChanges()); +} + +// FileMoveProcessor::isFileInIndex with processed paths cache +TEST_F(MoveProcTest, FileMoveProcessor_IsFileInIndex_EmptyCache) +{ + auto runtime = makeRuntime(); + FileMoveProcessor proc(runtime->context(), nullptr, nullptr); + // With null searcher, this will throw and return false + // We can't call it safely without a real searcher, but the constructor + // and hasChanges are covered. + EXPECT_FALSE(proc.hasChanges()); +} + +// FileMoveProcessor::processContentUpdateWithCache - tests the wrapper +// Since the actual Lucene calls need real objects, we test the constructor +// and hasChanges which are the non-Lucene methods. + +// DirectoryMoveProcessor::updateSingleDocumentPath cannot be safely tested with null +// because it accesses m_context before checking doc. Skipped. +TEST_F(MoveProcTest, DirectoryMoveProcessor_MultipleInstances) +{ + auto runtime = makeRuntime(); + DirectoryMoveProcessor proc1(runtime->context(), nullptr, nullptr, nullptr); + DirectoryMoveProcessor proc2(runtime->context(), nullptr, nullptr, nullptr); + EXPECT_FALSE(proc1.hasChanges()); + EXPECT_FALSE(proc2.hasChanges()); +} \ No newline at end of file diff --git a/autotests/index/test_moveprocessor_withindex.cpp b/autotests/index/test_moveprocessor_withindex.cpp new file mode 100644 index 00000000..e51aedbb --- /dev/null +++ b/autotests/index/test_moveprocessor_withindex.cpp @@ -0,0 +1,658 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_moveprocessor_withindex.cpp + * @brief Tests for FileMoveProcessor and DirectoryMoveProcessor with a real + * Lucene index. Documents are added directly, avoiding heavy + * dependencies like ProcessExtractor and IndexRuntime. + */ + +#include +#include +#include +#include +#include + +#include "index_global.h" +#include "task/moveprocessor.h" +#include "profile/indexprofile.h" +#include "core/indexcontext.h" +#include "document/indexdocumentbuilder.h" +#include "utils/indexutility.h" +#include "utils/taskstate.h" + +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace Lucene; +using namespace DFMSEARCH::LuceneFieldNames; + +namespace { + +// 模拟 filename 语义的文档构建器：业务字段（fake_name）由路径派生， +// 用于验证 IndexProfile::MoveUpdatePolicy::RebuildDocument 下 rename 后派生字段随新路径重建 +struct FakePathDerivedBuilder : public IndexDocumentBuilder +{ + static const wchar_t *kFakeName; + + Lucene::DocumentPtr build(const QString &filePath, const QString &text, + const BuilderOptions &options = {}) const override + { + Q_UNUSED(text) + Q_UNUSED(options) + Lucene::DocumentPtr doc = newLucene(); + doc->add(newLucene(kFakeName, + QFileInfo(filePath).fileName().toLower().toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_ANALYZED)); + doc->add(newLucene(DFMSEARCH::LuceneFieldNames::Content::kPath, + filePath.toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED)); + return doc; + } +}; + +const wchar_t *FakePathDerivedBuilder::kFakeName = L"fake_name"; + +// 模拟 filename 语义（RebuildDocument 策略 + is_hidden 完整路径派生）： +// 用于验证目录改名走 copy + is_hidden 重算（不整体重建），且移入隐藏目录树时更新 +struct FakeFilenameLikeBuilder : public FakePathDerivedBuilder +{ + Lucene::DocumentPtr build(const QString &filePath, const QString &text, + const BuilderOptions &options = {}) const override + { + Q_UNUSED(text) + Q_UNUSED(options) + Lucene::DocumentPtr doc = newLucene(); + doc->add(newLucene(DFMSEARCH::LuceneFieldNames::Content::kPath, + filePath.toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(kFakeName, + QFileInfo(filePath).fileName().toLower().toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(kFakeHidden, + DFMSEARCH::Global::isHiddenPathOrInHiddenDir(filePath) + ? L"Y" : L"N", + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED)); + for (const QString &ancestor : PathCalculator::extractAncestorPaths(filePath)) { + doc->add(newLucene(DFMSEARCH::LuceneFieldNames::Content::kAncestorPaths, + ancestor.toStdWString(), + Lucene::Field::STORE_NO, Lucene::Field::INDEX_NOT_ANALYZED)); + } + return doc; + } + + std::list pathDerivedFields() const override + { + return { + { kFakeHidden, [](const QString &p) -> Lucene::FieldPtr { + return newLucene(kFakeHidden, + DFMSEARCH::Global::isHiddenPathOrInHiddenDir(p) ? L"Y" : L"N", + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED); + } }, + }; + } + + static const wchar_t *kFakeHidden; +}; + +const wchar_t *FakeFilenameLikeBuilder::kFakeHidden = L"fake_hidden"; + +// 模拟 content/ocr 语义：文档含路径无关字段（content）+ 部分路径派生字段 +// （fake_name/fake_ext），用于验证 UpdatePathOnly 下派生字段按新路径重算 +struct FakePartialDerivedBuilder : public IndexDocumentBuilder +{ + static const wchar_t *kFakeName; + static const wchar_t *kFakeExt; + + Lucene::DocumentPtr build(const QString &filePath, const QString &text, + const BuilderOptions &options = {}) const override + { + Q_UNUSED(text) + Q_UNUSED(options) + Lucene::DocumentPtr doc = newLucene(); + doc->add(newLucene(DFMSEARCH::LuceneFieldNames::Content::kPath, + filePath.toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED)); + doc->add(newLucene(DFMSEARCH::LuceneFieldNames::Content::kContents, + L"keep me", + Lucene::Field::STORE_YES, Lucene::Field::INDEX_ANALYZED)); + doc->add(newLucene(kFakeName, + QFileInfo(filePath).fileName().toLower().toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED)); + const QString ext = QFileInfo(filePath).suffix().toLower(); + if (!ext.isEmpty()) { + doc->add(newLucene(kFakeExt, ext.toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED)); + } + for (const QString &ancestor : PathCalculator::extractAncestorPaths(filePath)) { + doc->add(newLucene(DFMSEARCH::LuceneFieldNames::Content::kAncestorPaths, + ancestor.toStdWString(), + Lucene::Field::STORE_NO, Lucene::Field::INDEX_NOT_ANALYZED)); + } + return doc; + } + + std::list pathDerivedFields() const override + { + return { + { kFakeName, [](const QString &p) -> Lucene::FieldPtr { + return newLucene(kFakeName, QFileInfo(p).fileName().toLower().toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED); + } }, + { kFakeExt, [](const QString &p) -> Lucene::FieldPtr { + const QString ext = QFileInfo(p).suffix().toLower(); + if (ext.isEmpty()) + return nullptr; // 与 build() 一致：无扩展名则不加该字段 + return newLucene(kFakeExt, ext.toStdWString(), + Lucene::Field::STORE_YES, Lucene::Field::INDEX_NOT_ANALYZED); + } }, + }; + } +}; + +const wchar_t *FakePartialDerivedBuilder::kFakeName = L"fake_name"; +const wchar_t *FakePartialDerivedBuilder::kFakeExt = L"fake_ext"; + +struct MoveProcIndexTest : public testing::Test +{ + QTemporaryDir tmp; + QString indexDir; + std::unique_ptr ctx; + + static IndexProfile buildProfile(const QString &idxDir, + IndexProfile::MoveUpdatePolicy policy = IndexProfile::MoveUpdatePolicy::UpdatePathOnly, + bool requiresContentExtraction = true) + { + return IndexProfile({ IndexProfile::Type::Content, + "mpidx_test", + "mpidx_status.json", + "mpidx_version", + 1 }, + { [idxDir]() -> QString { return idxDir; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &p) -> bool { return p.endsWith(".txt") || p.endsWith(".md"); }, + {}, {}, {}, + []() -> boost::shared_ptr { + return newLucene(LuceneVersion::LUCENE_CURRENT); + } }, + IndexProfile::RuntimePolicy{}, IndexProfile::FilterPolicy{}, + { policy, requiresContentExtraction }); + } + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + indexDir = tmp.path() + "/index"; + QDir().mkpath(indexDir); + + auto profile = buildProfile(indexDir); + ctx = std::make_unique( + std::move(profile), nullptr, nullptr, nullptr); + + // Populate index with test documents + auto writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + boost::static_pointer_cast(ctx->profile().createAnalyzer()), + true, + IndexWriter::MaxFieldLengthUNLIMITED); + + DocumentPtr doc1 = newLucene(); + doc1->add(newLucene(ctx->profile().pathField(), + (tmp.path() + "/hello.txt").toStdWString(), + Field::STORE_YES, + Field::INDEX_NOT_ANALYZED_NO_NORMS)); + // 与 ContentDocumentBuilder 一致：contents 为 STORE_YES + INDEX_ANALYZED + doc1->add(newLucene(ctx->profile().contentField(), + L"hello world content", + Field::STORE_YES, + Field::INDEX_ANALYZED)); + writer->addDocument(doc1); + + DocumentPtr doc2 = newLucene(); + doc2->add(newLucene(ctx->profile().pathField(), + (tmp.path() + "/src/code.txt").toStdWString(), + Field::STORE_YES, + Field::INDEX_NOT_ANALYZED_NO_NORMS)); + doc2->add(newLucene(ctx->profile().contentField(), + L"code content here", + Field::STORE_YES, + Field::INDEX_ANALYZED)); + writer->addDocument(doc2); + + writer->commit(); + writer->close(); + } + + void TearDown() override + { + ctx.reset(); + } + + IndexReaderPtr openReader() + { + return IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + } + + IndexWriterPtr openWriter() + { + return newLucene( + FSDirectory::open(indexDir.toStdWString()), + boost::static_pointer_cast(ctx->profile().createAnalyzer()), + false, + IndexWriter::MaxFieldLengthUNLIMITED); + } +}; + +TEST_F(MoveProcIndexTest, FileMoveProcessor_IsFileInIndex_ExistingFile) +{ + auto reader = openReader(); + auto searcher = newLucene(reader); + FileMoveProcessor proc(*ctx, searcher, nullptr); + EXPECT_TRUE(proc.isFileInIndex(tmp.path() + "/hello.txt")); +} + +TEST_F(MoveProcIndexTest, FileMoveProcessor_IsFileInIndex_NonExistentFile) +{ + auto reader = openReader(); + auto searcher = newLucene(reader); + FileMoveProcessor proc(*ctx, searcher, nullptr); + EXPECT_FALSE(proc.isFileInIndex("/nonexistent/file.txt")); +} + +TEST_F(MoveProcIndexTest, FileMoveProcessor_IsFileInIndex_InProcessedCache) +{ + auto reader = openReader(); + auto searcher = newLucene(reader); + FileMoveProcessor proc(*ctx, searcher, nullptr); + proc.m_processedPaths.insert("/cached/path.txt"); + EXPECT_TRUE(proc.isFileInIndex("/cached/path.txt")); +} + +TEST_F(MoveProcIndexTest, FileMoveProcessor_ProcessFileMove_Rename) +{ + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer); + bool result = proc.processFileMove(tmp.path() + "/hello.txt", tmp.path() + "/renamed.txt"); + EXPECT_TRUE(result); + EXPECT_TRUE(proc.hasChanges()); + + writer->close(); + reader->close(); +} + +// RebuildDocument 策略（模拟 filename 语义）：rename 后文档按新路径整体重建， +// 路径派生字段（fake_name）必须为新值，且旧路径文档无残留 +TEST_F(MoveProcIndexTest, FileMoveProcessor_RebuildDocumentPolicy_RebuildsFromNewPath) +{ + FakePathDerivedBuilder builder; + auto profile = buildProfile(indexDir, IndexProfile::MoveUpdatePolicy::RebuildDocument, false); + ctx = std::make_unique(std::move(profile), nullptr, nullptr, &builder); + + const QString from = tmp.path() + "/hello.txt"; + const QString to = tmp.path() + "/renamed.txt"; + + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer); + EXPECT_TRUE(proc.processFileMove(from, to)); + EXPECT_TRUE(proc.hasChanges()); + + writer->commit(); + writer->close(); + reader->close(); + + // 重新打开索引验证持久化结果 + auto reader2 = IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + auto searcher2 = newLucene(reader2); + + // 旧路径无残留 + TopDocsPtr oldHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), from.toStdWString())), 1); + EXPECT_EQ(oldHits->totalHits, 0); + + // 新路径命中，且路径派生字段来自新路径 + TopDocsPtr newHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), to.toStdWString())), 1); + ASSERT_EQ(newHits->totalHits, 1); + DocumentPtr doc = searcher2->doc(newHits->scoreDocs[0]->doc); + EXPECT_EQ(doc->get(FakePathDerivedBuilder::kFakeName), L"renamed.txt"); + + reader2->close(); +} + +// UpdatePathOnly 策略（Content/Ocr 语义）：rename 仅更新 path， +// 其余字段原样保留（不触发文档重建） +TEST_F(MoveProcIndexTest, FileMoveProcessor_UpdatePathOnlyPolicy_KeepsExistingFields) +{ + const QString from = tmp.path() + "/hello.txt"; + const QString to = tmp.path() + "/renamed.txt"; + + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer); + EXPECT_TRUE(proc.processFileMove(from, to)); + + writer->commit(); + writer->close(); + reader->close(); + + auto reader2 = IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + auto searcher2 = newLucene(reader2); + + TopDocsPtr newHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), to.toStdWString())), 1); + ASSERT_EQ(newHits->totalHits, 1); + DocumentPtr doc = searcher2->doc(newHits->scoreDocs[0]->doc); + // content 字段保留旧值（未重建；与 ContentDocumentBuilder 一致的 STORE_YES 字段） + EXPECT_EQ(doc->get(ctx->profile().contentField()), L"hello world content"); + + reader2->close(); +} + +// UpdatePathOnly + builder 声明的部分路径派生字段（content/ocr 的 kFilename/ +// kIsHidden/kFileExt 语义）：move 后派生字段按新路径重算，路径无关字段保留 +TEST_F(MoveProcIndexTest, FileMoveProcessor_UpdatePathOnlyPolicy_RecomputesDerivedFields) +{ + FakePartialDerivedBuilder builder; + auto profile = buildProfile(indexDir); + ctx = std::make_unique(std::move(profile), nullptr, nullptr, &builder); + + const QString from = tmp.path() + "/hello.txt"; + const QString to = tmp.path() + "/renamed.md"; + + // 预置初始文档（模拟已索引的旧路径） + auto writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + newLucene(LuceneVersion::LUCENE_CURRENT), + true, IndexWriter::MaxFieldLengthUNLIMITED); + writer->addDocument(builder.build(from, QString())); + writer->commit(); + writer->close(); + + auto reader = openReader(); + auto writer2 = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer2); + EXPECT_TRUE(proc.processFileMove(from, to)); + EXPECT_TRUE(proc.hasChanges()); + + writer2->commit(); + writer2->close(); + reader->close(); + + auto reader2 = IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + auto searcher2 = newLucene(reader2); + + // 旧路径无残留 + TopDocsPtr oldHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), from.toStdWString())), 1); + EXPECT_EQ(oldHits->totalHits, 0); + + // 新路径命中：路径无关字段保留，派生字段按新路径重算 + TopDocsPtr newHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), to.toStdWString())), 1); + ASSERT_EQ(newHits->totalHits, 1); + DocumentPtr doc = searcher2->doc(newHits->scoreDocs[0]->doc); + EXPECT_EQ(doc->get(DFMSEARCH::LuceneFieldNames::Content::kContents), L"keep me"); + EXPECT_EQ(doc->get(FakePartialDerivedBuilder::kFakeName), L"renamed.md"); + EXPECT_EQ(doc->get(FakePartialDerivedBuilder::kFakeExt), L"md"); + + reader2->close(); +} + +// 重命名去掉扩展名：派生字段重算返回空 FieldPtr → 字段从文档中消失 +TEST_F(MoveProcIndexTest, FileMoveProcessor_UpdatePathOnlyPolicy_DropsFieldWhenDerivedEmpty) +{ + FakePartialDerivedBuilder builder; + auto profile = buildProfile(indexDir); + ctx = std::make_unique(std::move(profile), nullptr, nullptr, &builder); + + const QString from = tmp.path() + "/hello.txt"; + const QString to = tmp.path() + "/noext"; + + auto writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + newLucene(LuceneVersion::LUCENE_CURRENT), + true, IndexWriter::MaxFieldLengthUNLIMITED); + writer->addDocument(builder.build(from, QString())); + writer->commit(); + writer->close(); + + auto reader = openReader(); + auto writer2 = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer2); + EXPECT_TRUE(proc.processFileMove(from, to)); + + writer2->commit(); + writer2->close(); + reader->close(); + + auto reader2 = IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + auto searcher2 = newLucene(reader2); + + TopDocsPtr newHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), to.toStdWString())), 1); + ASSERT_EQ(newHits->totalHits, 1); + DocumentPtr doc = searcher2->doc(newHits->scoreDocs[0]->doc); + EXPECT_EQ(doc->get(FakePartialDerivedBuilder::kFakeName), L"noext"); + // 扩展名消失 → 派生字段被移除而非保留旧值 + EXPECT_TRUE(doc->get(FakePartialDerivedBuilder::kFakeExt).empty()); + + reader2->close(); +} + +// 目录 move（UpdatePathOnly + 派生字段声明）：子文档 path 与派生字段均按新路径重算 +TEST_F(MoveProcIndexTest, DirectoryMoveProcessor_UpdatePathOnlyPolicy_RecomputesDerivedFields) +{ + FakePartialDerivedBuilder builder; + auto profile = buildProfile(indexDir); + ctx = std::make_unique(std::move(profile), nullptr, nullptr, &builder); + + const QString childFrom = tmp.path() + "/a/old/x.txt"; + + auto writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + newLucene(LuceneVersion::LUCENE_CURRENT), + true, IndexWriter::MaxFieldLengthUNLIMITED); + writer->addDocument(builder.build(childFrom, QString())); + writer->commit(); + writer->close(); + + auto reader = openReader(); + auto writer2 = openWriter(); + auto searcher = newLucene(reader); + + DirectoryMoveProcessor proc(*ctx, searcher, writer2, reader); + TaskState state; + state.start(); + const QString fromDir = tmp.path() + "/a/old"; + const QString toDir = tmp.path() + "/b/new"; + EXPECT_TRUE(proc.processDirectoryMove(fromDir, toDir, state)); + EXPECT_TRUE(proc.hasChanges()); + + writer2->commit(); + writer2->close(); + reader->close(); + + auto reader2 = IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + auto searcher2 = newLucene(reader2); + + const QString childTo = tmp.path() + "/b/new/x.txt"; + TopDocsPtr newHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), childTo.toStdWString())), 1); + ASSERT_EQ(newHits->totalHits, 1); + DocumentPtr doc = searcher2->doc(newHits->scoreDocs[0]->doc); + EXPECT_EQ(doc->get(DFMSEARCH::LuceneFieldNames::Content::kContents), L"keep me"); + EXPECT_EQ(doc->get(FakePartialDerivedBuilder::kFakeName), L"x.txt"); + EXPECT_EQ(doc->get(FakePartialDerivedBuilder::kFakeExt), L"txt"); + + reader2->close(); +} + +// 目录 move（filename 语义 RebuildDocument 策略）：不整体重建，copy 保留 +// basename 派生字段（fake_name），仅重算完整路径派生字段（is_hidden）—— +// 移入隐藏目录树后子文档 is_hidden 必须更新为 Y，且无逐文档重建开销 +TEST_F(MoveProcIndexTest, DirectoryMoveProcessor_RebuildDocumentPolicy_CopyWithHiddenRecompute) +{ + FakeFilenameLikeBuilder builder; + auto profile = buildProfile(indexDir, IndexProfile::MoveUpdatePolicy::RebuildDocument, false); + ctx = std::make_unique(std::move(profile), nullptr, nullptr, &builder); + + const QString childFrom = tmp.path() + "/a/old/x.txt"; + + auto writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + newLucene(LuceneVersion::LUCENE_CURRENT), + true, IndexWriter::MaxFieldLengthUNLIMITED); + writer->addDocument(builder.build(childFrom, QString())); + writer->commit(); + writer->close(); + + auto reader = openReader(); + auto writer2 = openWriter(); + auto searcher = newLucene(reader); + + DirectoryMoveProcessor proc(*ctx, searcher, writer2, reader); + TaskState state; + state.start(); + // 移入以 "." 开头的隐藏目录树：is_hidden 应由 N 重算为 Y + const QString fromDir = tmp.path() + "/a/old"; + const QString toDir = tmp.path() + "/a/.hidden"; + EXPECT_TRUE(proc.processDirectoryMove(fromDir, toDir, state)); + EXPECT_TRUE(proc.hasChanges()); + + writer2->commit(); + writer2->close(); + reader->close(); + + auto reader2 = IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + auto searcher2 = newLucene(reader2); + + const QString childTo = tmp.path() + "/a/.hidden/x.txt"; + TopDocsPtr newHits = searcher2->search( + newLucene(newLucene(ctx->profile().pathField(), childTo.toStdWString())), 1); + ASSERT_EQ(newHits->totalHits, 1); + DocumentPtr doc = searcher2->doc(newHits->scoreDocs[0]->doc); + // basename 派生字段 copy 保留（未重建） + EXPECT_EQ(doc->get(FakeFilenameLikeBuilder::kFakeName), L"x.txt"); + // 完整路径派生字段重算：is_hidden N → Y + EXPECT_EQ(doc->get(FakeFilenameLikeBuilder::kFakeHidden), L"Y"); + + reader2->close(); +} + +TEST_F(MoveProcIndexTest, FileMoveProcessor_ProcessFileMove_SourceNotInIndex) +{ + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer); + bool result = proc.processFileMove("/nonexistent/old.txt", "/nonexistent/new.txt"); + EXPECT_TRUE(result); + + writer->close(); + reader->close(); +} + +TEST_F(MoveProcIndexTest, FileMoveProcessor_ProcessFileMove_TargetNotCandidate) +{ + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer); + bool result = proc.processFileMove("/old.dat", tmp.path() + "/new.dat"); + EXPECT_TRUE(result); + + writer->close(); + reader->close(); +} + +TEST_F(MoveProcIndexTest, FileMoveProcessor_ProcessContentUpdate_NonExistent) +{ + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer); + bool result = proc.processContentUpdate("/nonexistent/file.txt"); + EXPECT_FALSE(result); + + writer->close(); + reader->close(); +} + +TEST_F(MoveProcIndexTest, FileMoveProcessor_ProcessContentUpdateWithCache_Failure) +{ + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + FileMoveProcessor proc(*ctx, searcher, writer); + bool result = proc.processContentUpdateWithCache("/nonexistent/file.txt", "test failure"); + EXPECT_FALSE(result); + EXPECT_FALSE(proc.hasChanges()); + + writer->close(); + reader->close(); +} + +TEST_F(MoveProcIndexTest, DirectoryMoveProcessor_ProcessDirectoryMove_EmptyDir) +{ + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + DirectoryMoveProcessor proc(*ctx, searcher, writer, reader); + TaskState state; + bool result = proc.processDirectoryMove("/empty/dir", "/new/dir", state); + EXPECT_TRUE(result); + + writer->close(); + reader->close(); +} + +TEST_F(MoveProcIndexTest, DirectoryMoveProcessor_UpdateSingleDocumentPath_SamePath) +{ + auto reader = openReader(); + auto writer = openWriter(); + auto searcher = newLucene(reader); + + DirectoryMoveProcessor proc(*ctx, searcher, writer, reader); + TermQueryPtr query = newLucene( + newLucene(ctx->profile().pathField(), + (tmp.path() + "/hello.txt").toStdWString())); + TopDocsPtr topDocs = searcher->search(query, 1); + ASSERT_GT(topDocs->totalHits, 0); + DocumentPtr doc = searcher->doc(topDocs->scoreDocs[0]->doc); + bool result = proc.updateSingleDocumentPath(doc, tmp.path() + "/", tmp.path() + "/"); + EXPECT_TRUE(result); + + writer->close(); + reader->close(); +} + +} // namespace diff --git a/autotests/index/test_ocrdeduplication.cpp b/autotests/index/test_ocrdeduplication.cpp new file mode 100644 index 00000000..4738aa58 --- /dev/null +++ b/autotests/index/test_ocrdeduplication.cpp @@ -0,0 +1,108 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_ocrdeduplication.cpp + * @brief Unit tests for OcrDeduplication (extractor/ocrdeduplication.cpp) + * Tests the lookupByTextChecksum function with various inputs. + */ + +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "extractor/ocrdeduplication.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class OcrDeduplicationTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + } +}; + +TEST_F(OcrDeduplicationTest, Lookup_EmptyChecksum_ReturnsEmpty) +{ + QString result = OcrDeduplication::lookupByTextChecksum(QString(), tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_EmptyIndexDir_ReturnsEmpty) +{ + QString result = OcrDeduplication::lookupByTextChecksum("abc123", QString()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_BothEmpty_ReturnsEmpty) +{ + QString result = OcrDeduplication::lookupByTextChecksum(QString(), QString()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_NonExistentIndexDir_ReturnsEmpty) +{ + // The function catches all exceptions and returns empty + QString result = OcrDeduplication::lookupByTextChecksum( + "d41d8cd98f00b204e9800998ecf8427e", "/nonexistent/path/to/index"); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_EmptyDirAsIndexDir_ReturnsEmpty) +{ + // Directory exists but is empty (not a valid Lucene index) + QString result = OcrDeduplication::lookupByTextChecksum( + "d41d8cd98f00b204e9800998ecf8427e", tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_ChecksumWithSpecialChars) +{ + QString result = OcrDeduplication::lookupByTextChecksum( + "!@#$%^&*()_+{}|:\"<>?", tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_LongChecksum) +{ + QString longChecksum(1000, 'a'); + QString result = OcrDeduplication::lookupByTextChecksum(longChecksum, tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_ValidMd5Checksum_NonIndexDir) +{ + // Valid MD5 format but directory is not a Lucene index + QString result = OcrDeduplication::lookupByTextChecksum( + "5d41402abc4b2a76b9719d911017c592", tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_UnicodeChecksum) +{ + QString result = OcrDeduplication::lookupByTextChecksum( + QString::fromUtf8("中文md5哈希值测试"), tmp.path()); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(OcrDeduplicationTest, Lookup_RegularFileAsIndexDir) +{ + // Create a regular file where an index dir is expected + QString filePath = tmp.path() + "/not_a_dir.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("not an index"); + f.close(); + + QString result = OcrDeduplication::lookupByTextChecksum( + "abc123", filePath); + // Will fail (not a directory), caught by try/catch -> empty + EXPECT_TRUE(result.isEmpty()); +} \ No newline at end of file diff --git a/autotests/index/test_ocrdocumentbuilder.cpp b/autotests/index/test_ocrdocumentbuilder.cpp new file mode 100644 index 00000000..9a2c50de --- /dev/null +++ b/autotests/index/test_ocrdocumentbuilder.cpp @@ -0,0 +1,189 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_ocrdocumentbuilder.cpp + * @brief Unit tests for OcrDocumentBuilder (document/ocrdocumentbuilder.cpp). + * Exercises the build() method with various file and options combinations. + */ + +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "document/ocrdocumentbuilder.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +class OcrDocumentBuilderTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + QDir dir(tmp.path()); + ASSERT_TRUE(dir.mkpath("subdir")); + createFile("image.png", "PNG_DATA"); + createFile("subdir/nested.png", "PNG_DATA2"); + createFile("photo.JPG", "JPG_DATA"); + } + + void createFile(const QString &relativePath, const QString &content) + { + QFile f(tmp.path() + "/" + relativePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } + + OcrDocumentBuilder builder; +}; + +TEST_F(OcrDocumentBuilderTest, BuildBasicImageFile) +{ + QString filePath = tmp.path() + "/image.png"; + auto doc = builder.build(filePath, "OCR recognized text"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithEmptyText) +{ + QString filePath = tmp.path() + "/image.png"; + auto doc = builder.build(filePath, ""); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithWhitespaceOnlyText) +{ + QString filePath = tmp.path() + "/image.png"; + auto doc = builder.build(filePath, " \n\t "); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithLongOcrText) +{ + QString filePath = tmp.path() + "/image.png"; + QString longText(10000, 'X'); + auto doc = builder.build(filePath, longText); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithChecksumInOptions) +{ + QString filePath = tmp.path() + "/image.png"; + BuilderOptions options; + options.checksum = "md5hash123"; + auto doc = builder.build(filePath, "OCR text", options); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithEmptyChecksumInOptions) +{ + QString filePath = tmp.path() + "/image.png"; + BuilderOptions options; + options.checksum = ""; + auto doc = builder.build(filePath, "OCR text", options); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithDefaultOptions) +{ + QString filePath = tmp.path() + "/image.png"; + BuilderOptions options; + auto doc = builder.build(filePath, "OCR text", options); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildFileWithUppercaseExtension) +{ + QString filePath = tmp.path() + "/photo.JPG"; + auto doc = builder.build(filePath, "OCR text for JPG"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildNestedPath) +{ + QString filePath = tmp.path() + "/subdir/nested.png"; + auto doc = builder.build(filePath, "nested OCR"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithSpecialCharacters) +{ + QString filePath = tmp.path() + "/image.png"; + QString specialText = "识别文本 世界 🌍"; + auto doc = builder.build(filePath, specialText); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildNonExistentFile) +{ + QString filePath = tmp.path() + "/nonexistent.png"; + auto doc = builder.build(filePath, "OCR text for missing file"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithHiddenPath_Stubbed) +{ + stub_ext::StubExt stub; + stub.set_lamda(ADDR(Global, isHiddenPathOrInHiddenDir), + [](const QString &) -> bool { + __DBG_STUB_INVOKE__ + return false; + }); + + QString filePath = tmp.path() + "/image.png"; + auto doc = builder.build(filePath, "OCR text"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildFileWithoutExtension) +{ + // Create a file without extension + QString filePath = tmp.path() + "/noext_file"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("data"); + f.close(); + + auto doc = builder.build(filePath, "OCR text"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} + +TEST_F(OcrDocumentBuilderTest, BuildWithUnicodePath) +{ + QString unicodeDir = tmp.path() + "/中文目录"; + QDir().mkpath(unicodeDir); + QString filePath = unicodeDir + "/图片.png"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("PNG"); + f.close(); + + auto doc = builder.build(filePath, "OCR Unicode content"); + ASSERT_NE(doc, nullptr); + SUCCEED(); +} diff --git a/autotests/index/test_ocrindexdbus_extra.cpp b/autotests/index/test_ocrindexdbus_extra.cpp new file mode 100644 index 00000000..01ccda2e --- /dev/null +++ b/autotests/index/test_ocrindexdbus_extra.cpp @@ -0,0 +1,183 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_ocrindexdbus_extra.cpp + * @brief Additional unit tests for OcrIndexDBus covering: + * UpdateIndexTask with options, IndexDatabaseExists with dirty state, + * ProcessFileMoves with non-empty moves, and cleanup. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "dbus/ocrindexdbus.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +static void writeStatusJson(const QString &indexDir, const QJsonObject &obj) +{ + QDir().mkpath(indexDir); + QFile f(indexDir + QLatin1String("/index_status.json")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly | QIODevice::Truncate)); + f.write(QJsonDocument(obj).toJson()); + f.close(); +} + +class OcrIndexDBusExtraTest : public testing::Test +{ +protected: + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/ocr-index"; + }); + stub.set_lamda(ADDR(Global, isOcrTextIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInOcrTextIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() + "/indexed-dir" }; + }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + } + + QTemporaryDir tmp; + stub_ext::StubExt stub; +}; + +// --- IndexDatabaseExists with various states --- + +TEST_F(OcrIndexDBusExtraTest, IndexDatabaseExists_DirtyState) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "dirty" } }); + + OcrIndexDBus dbus; + EXPECT_TRUE(dbus.IndexDatabaseExists()); +} + +TEST_F(OcrIndexDBusExtraTest, IndexDatabaseExists_CleanState) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "clean" } }); + + OcrIndexDBus dbus; + EXPECT_TRUE(dbus.IndexDatabaseExists()); +} + +// --- SetEnabled --- +TEST_F(OcrIndexDBusExtraTest, SetEnabledTrue) +{ + OcrIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.SetEnabled(true); }); +} + +TEST_F(OcrIndexDBusExtraTest, SetEnabledFalse) +{ + OcrIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.SetEnabled(false); }); +} + +// --- ProcessFileChanges with multiple files --- +TEST_F(OcrIndexDBusExtraTest, ProcessFileChanges_MultipleFiles) +{ + OcrIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + { "/a.png", "/b.jpg" }, + { "/c.png" }, + { "/d.jpg", "/e.png" }); + SUCCEED(); +} + +// --- ProcessFileMoves --- +TEST_F(OcrIndexDBusExtraTest, ProcessFileMoves_SingleMove) +{ + OcrIndexDBus dbus; + QHash moves; + moves["/old/img.png"] = "/new/img.png"; + bool result = dbus.ProcessFileMoves(moves); + SUCCEED(); +} + +TEST_F(OcrIndexDBusExtraTest, ProcessFileMoves_MultipleMoves) +{ + OcrIndexDBus dbus; + QHash moves; + moves["/a.png"] = "/b.png"; + moves["/c.jpg"] = "/d.jpg"; + bool result = dbus.ProcessFileMoves(moves); + SUCCEED(); +} + +// --- CreateIndexTask with options --- +TEST_F(OcrIndexDBusExtraTest, CreateIndexTask_SilentTrue) +{ + OcrIndexDBus dbus; + QVariantMap opts; + opts["silent"] = true; + bool result = dbus.CreateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + SUCCEED(); +} + +TEST_F(OcrIndexDBusExtraTest, CreateIndexTask_NoOptions) +{ + OcrIndexDBus dbus; + // Default QVariantMap - silent defaults to false + bool result = dbus.CreateIndexTask({ tmp.path() + "/indexed-dir" }); + SUCCEED(); +} + +// --- Cleanup --- +TEST_F(OcrIndexDBusExtraTest, Cleanup_NoRunningTasks) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "clean" } }); + + OcrIndexDBus dbus; + dbus.cleanup(); + SUCCEED(); +} + +// --- GetLastUpdateTime with valid time --- +TEST_F(OcrIndexDBusExtraTest, GetLastUpdateTime_DirtyState) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion }, { "lastUpdateTime", "2026-06-15T10:30:00" }, { "state", "dirty" } }); + + OcrIndexDBus dbus; + QString t = dbus.GetLastUpdateTime(); + EXPECT_FALSE(t.isEmpty()); + EXPECT_EQ(t, QString("2026-06-15 10:30:00")); +} diff --git a/autotests/index/test_ocrindexdbus_private.cpp b/autotests/index/test_ocrindexdbus_private.cpp new file mode 100644 index 00000000..e47af9a4 --- /dev/null +++ b/autotests/index/test_ocrindexdbus_private.cpp @@ -0,0 +1,207 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_ocrindexdbus_private.cpp + * @brief Tests for OcrIndexDBusPrivate methods accessed via d (friend access). + * Covers initializeSupportedExtensions, handleConfigChanged, handleMonitoring, + * handleSilentStart, canSilentlyRefreshIndex, cleanup. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "dbus/ocrindexdbus.h" +#include "dbus/private/ocrindexdbus_p.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +static void writeStatusJson(const QString &indexDir, const QJsonObject &obj) +{ + QDir().mkpath(indexDir); + QFile f(indexDir + QLatin1String("/index_status.json")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly | QIODevice::Truncate)); + f.write(QJsonDocument(obj).toJson()); + f.close(); +} + +class OcrIndexDBusPrivateTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + OcrIndexDBus *dbus { nullptr }; + OcrIndexDBusPrivate *d { nullptr }; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/ocr-index"; + }); + stub.set_lamda(ADDR(Global, isOcrTextIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInOcrTextIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() + "/indexed-dir" }; + }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + + dbus = new OcrIndexDBus(); + d = dbus->d.data(); + } + + void TearDown() override + { + delete dbus; + } + + stub_ext::StubExt stub; +}; + +// ---- initializeSupportedExtensions ---- +TEST_F(OcrIndexDBusPrivateTest, InitializeSupportedExtensions) +{ + EXPECT_NO_FATAL_FAILURE({ d->initializeSupportedExtensions(); }); + EXPECT_NO_FATAL_FAILURE({ (void)d->m_currentSupportedExtensions.size(); }); +} + +// ---- canSilentlyRefreshIndex ---- +TEST_F(OcrIndexDBusPrivateTest, CanSilentlyRefreshIndex_NoCurrentTask) +{ + EXPECT_TRUE(d->canSilentlyRefreshIndex("/any/path")); +} + +// ---- handleMonitoring ---- +TEST_F(OcrIndexDBusPrivateTest, HandleMonitoring_Stop) +{ + EXPECT_NO_FATAL_FAILURE({ d->handleMonitoring(false); }); +} + +TEST_F(OcrIndexDBusPrivateTest, HandleMonitoring_Start) +{ + EXPECT_NO_FATAL_FAILURE({ d->handleMonitoring(true); }); +} + +// ---- handleSilentStart ---- +TEST_F(OcrIndexDBusPrivateTest, HandleSilentStart) +{ + EXPECT_NO_FATAL_FAILURE({ d->handleSilentStart(); }); +} + +// ---- handleConfigChanged ---- +TEST_F(OcrIndexDBusPrivateTest, HandleConfigChanged_NoIndexDb) +{ + EXPECT_NO_FATAL_FAILURE({ d->handleConfigChanged(); }); +} + +TEST_F(OcrIndexDBusPrivateTest, HandleConfigChanged_WithIndexDb) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "clean" } }); + + EXPECT_NO_FATAL_FAILURE({ d->handleConfigChanged(); }); +} + +// ---- cleanup ---- +TEST_F(OcrIndexDBusPrivateTest, Cleanup_NoRunningTasks) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "clean" } }); + + EXPECT_NO_FATAL_FAILURE({ dbus->cleanup(); }); +} + +// ---- stopCurrentTask when no task running ---- +TEST_F(OcrIndexDBusPrivateTest, StopCurrentTask_NoTask) +{ + EXPECT_FALSE(dbus->StopCurrentTask()); +} + +// ---- HasRunningTask ---- +TEST_F(OcrIndexDBusPrivateTest, HasRunningTask_Default) +{ + EXPECT_FALSE(dbus->HasRunningTask()); +} + +// ---- GetLastUpdateTime ---- +TEST_F(OcrIndexDBusPrivateTest, GetLastUpdateTime) +{ + QString time = dbus->GetLastUpdateTime(); + SUCCEED(); +} + +// ---- IndexDatabaseExists with incompatible version ---- +TEST_F(OcrIndexDBusPrivateTest, IndexDatabaseExists_IncompatibleVersion) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", "wrong_version" }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "clean" } }); + EXPECT_FALSE(dbus->IndexDatabaseExists()); +} + +TEST_F(OcrIndexDBusPrivateTest, IndexDatabaseExists_EmptyUpdateTime) +{ + const QString indexDir = tmp.path() + "/ocr-index"; + writeStatusJson(indexDir, { { "version", Defines::kOcrIndexVersion }, { "lastUpdateTime", "" }, { "state", "clean" } }); + EXPECT_FALSE(dbus->IndexDatabaseExists()); +} + +// ---- IsEnabled / SetEnabled ---- +TEST_F(OcrIndexDBusPrivateTest, IsEnabled_Default) +{ + EXPECT_NO_FATAL_FAILURE({ (void)dbus->IsEnabled(); }); +} + +TEST_F(OcrIndexDBusPrivateTest, SetEnabled_False) +{ + EXPECT_NO_FATAL_FAILURE({ dbus->SetEnabled(false); }); +} + +// ---- ProcessFileMoves empty ---- +TEST_F(OcrIndexDBusPrivateTest, ProcessFileMoves_Empty) +{ + EXPECT_FALSE(dbus->ProcessFileMoves({})); +} + +// ---- ProcessFileChanges all empty ---- +TEST_F(OcrIndexDBusPrivateTest, ProcessFileChanges_AllEmpty) +{ + EXPECT_FALSE(dbus->ProcessFileChanges({}, {}, {})); +} + +// ---- Destructor ---- +TEST_F(OcrIndexDBusPrivateTest, Destructor) +{ + auto *d2 = new OcrIndexDBus(); + EXPECT_NO_FATAL_FAILURE({ delete d2; }); +} diff --git a/autotests/index/test_pathcalculator.cpp b/autotests/index/test_pathcalculator.cpp new file mode 100644 index 00000000..9820935a --- /dev/null +++ b/autotests/index/test_pathcalculator.cpp @@ -0,0 +1,117 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_pathcalculator.cpp + * @brief Unit tests for the PathCalculator namespace + * (utils/indexutility.cpp) — pure path helpers: + * calculateNewPathForDirectoryMove, normalizeDirectoryPath, + * isDirectoryMove, extractAncestorPaths. + */ + +#include +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "utils/indexutility.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(PathCalculatorTest, CalculateNewPathForDirectoryMoveMatch) +{ + QString result = PathCalculator::calculateNewPathForDirectoryMove( + "/old/dir/file.txt", "/old/dir/", "/new/dir/"); + EXPECT_FALSE(result.isEmpty()); + EXPECT_TRUE(result.startsWith("/new/dir/")); +} + +TEST(PathCalculatorTest, CalculateNewPathForDirectoryMoveNoMatch) +{ + QString result = PathCalculator::calculateNewPathForDirectoryMove( + "/other/path.txt", "/old/dir/", "/new/dir/"); + EXPECT_EQ(result, QString("/other/path.txt")); +} + +TEST(PathCalculatorTest, CalculateNewPathForDirectoryMoveExactDirMatch) +{ + // oldPath == fromDirPath.chopped(1) -> returns toDirPath + QString result = PathCalculator::calculateNewPathForDirectoryMove( + "/old/dir", "/old/dir/", "/new/dir/"); + EXPECT_EQ(result, QString("/new/dir/")); +} + +TEST(PathCalculatorTest, NormalizeDirectoryPathAddsTrailingSlash) +{ + EXPECT_EQ(PathCalculator::normalizeDirectoryPath("/tmp/dir"), QString("/tmp/dir/")); +} + +TEST(PathCalculatorTest, NormalizeDirectoryPathKeepsTrailingSlash) +{ + EXPECT_EQ(PathCalculator::normalizeDirectoryPath("/tmp/dir/"), QString("/tmp/dir/")); +} + +TEST(PathCalculatorTest, NormalizeDirectoryPathEmpty) +{ + EXPECT_EQ(PathCalculator::normalizeDirectoryPath(QString()), QString("/")); +} + +TEST(PathCalculatorTest, IsDirectoryMoveEmptyReturnsFalse) +{ + EXPECT_FALSE(PathCalculator::isDirectoryMove(QString())); +} + +TEST(PathCalculatorTest, IsDirectoryMoveTrailingSlashReturnsTrue) +{ + EXPECT_TRUE(PathCalculator::isDirectoryMove("/some/dir/")); +} + +TEST(PathCalculatorTest, IsDirectoryMoveNoTrailingSlashReturnsFalse) +{ + EXPECT_FALSE(PathCalculator::isDirectoryMove("/some/file.txt")); +} + +TEST(PathCalculatorTest, IsDirectoryMoveExistingDirReturnsTrue) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + QString path = tmp.path(); // exists and is a dir + EXPECT_TRUE(PathCalculator::isDirectoryMove(path)); +} + +TEST(PathCalculatorTest, IsDirectoryMoveExistingFileReturnsFalse) +{ + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + QString filePath = tmp.path() + "/test.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.close(); + EXPECT_FALSE(PathCalculator::isDirectoryMove(filePath)); +} + +TEST(PathCalculatorTest, ExtractAncestorPathsEmptyReturnsEmpty) +{ + EXPECT_TRUE(PathCalculator::extractAncestorPaths(QString()).isEmpty()); +} + +TEST(PathCalculatorTest, ExtractAncestorPathsForNestedFile) +{ + QStringList ancestors = PathCalculator::extractAncestorPaths("/a/b/c/file.txt"); + EXPECT_FALSE(ancestors.isEmpty()); + EXPECT_TRUE(ancestors.contains("/a/b/c")); + EXPECT_TRUE(ancestors.contains("/a/b")); + EXPECT_TRUE(ancestors.contains("/a")); +} + +TEST(PathCalculatorTest, ExtractAncestorPathsForRootFile) +{ + QStringList ancestors = PathCalculator::extractAncestorPaths("/file.txt"); + // File directly under root — ancestors should be empty or minimal + EXPECT_GE(ancestors.size(), 0); +} diff --git a/autotests/index/test_pathexcludematcher.cpp b/autotests/index/test_pathexcludematcher.cpp new file mode 100644 index 00000000..c8142fc1 --- /dev/null +++ b/autotests/index/test_pathexcludematcher.cpp @@ -0,0 +1,147 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_pathexcludematcher.cpp + * @brief Unit tests for PathExcludeMatcher (pathexcludematcher.cpp) + */ + +#include +#include +#include + +#include "index_global.h" +#include "utils/pathexcludematcher.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(PathExcludeMatcherTest, DefaultConstructorEmpty) +{ + PathExcludeMatcher matcher; + EXPECT_FALSE(matcher.hasPatterns()); + EXPECT_EQ(matcher.patternCount(), 0); +} + +TEST(PathExcludeMatcherTest, ConstructWithPatterns) +{ + PathExcludeMatcher matcher({ "tmp", "/home/user/exclude" }); + EXPECT_TRUE(matcher.hasPatterns()); + EXPECT_EQ(matcher.patternCount(), 2); +} + +TEST(PathExcludeMatcherTest, AddPatternDuplicateIgnored) +{ + PathExcludeMatcher matcher; + matcher.addPattern("tmp"); + matcher.addPattern("tmp"); + EXPECT_EQ(matcher.patternCount(), 1); +} + +TEST(PathExcludeMatcherTest, AddEmptyPatternIgnored) +{ + PathExcludeMatcher matcher; + matcher.addPattern(""); + EXPECT_FALSE(matcher.hasPatterns()); +} + +TEST(PathExcludeMatcherTest, AddPatternsList) +{ + PathExcludeMatcher matcher; + matcher.addPatterns({ "a", "b", "c" }); + EXPECT_EQ(matcher.patternCount(), 3); +} + +TEST(PathExcludeMatcherTest, RemovePattern) +{ + PathExcludeMatcher matcher({ "a", "b", "c" }); + matcher.removePattern("b"); + EXPECT_EQ(matcher.patternCount(), 2); + EXPECT_FALSE(matcher.patterns().contains("b")); +} + +TEST(PathExcludeMatcherTest, Clear) +{ + PathExcludeMatcher matcher({ "a", "b" }); + matcher.clear(); + EXPECT_FALSE(matcher.hasPatterns()); + EXPECT_EQ(matcher.patternCount(), 0); +} + +TEST(PathExcludeMatcherTest, ShouldExcludeEmptyPathReturnsFalse) +{ + PathExcludeMatcher matcher({ "tmp" }); + EXPECT_FALSE(matcher.shouldExclude("")); +} + +TEST(PathExcludeMatcherTest, ShouldExcludeNoPatternsReturnsFalse) +{ + PathExcludeMatcher matcher; + EXPECT_FALSE(matcher.shouldExclude("/home/user/tmp")); +} + +TEST(PathExcludeMatcherTest, ExactNameMatch) +{ + PathExcludeMatcher matcher({ "tmp" }); + EXPECT_TRUE(matcher.shouldExclude("/home/user/tmp")); + EXPECT_TRUE(matcher.shouldExclude("/home/user/tmp/subdir")); + EXPECT_FALSE(matcher.shouldExclude("/home/user/template")); +} + +TEST(PathExcludeMatcherTest, AbsolutePrefixMatch) +{ + PathExcludeMatcher matcher({ "/home/user/exclude" }); + EXPECT_TRUE(matcher.shouldExclude("/home/user/exclude")); + EXPECT_TRUE(matcher.shouldExclude("/home/user/exclude/subdir")); + EXPECT_FALSE(matcher.shouldExclude("/home/user/other")); +} + +TEST(PathExcludeMatcherTest, GlobPatternMatch) +{ + PathExcludeMatcher matcher({ "build-*" }); + EXPECT_TRUE(matcher.shouldExclude("/home/user/build-debug")); + EXPECT_FALSE(matcher.shouldExclude("/home/user/src")); +} + +TEST(PathExcludeMatcherTest, PathSegmentMatch) +{ + PathExcludeMatcher matcher({ ".local/share/Trash" }); + EXPECT_TRUE(matcher.shouldExclude("/.local/share/Trash")); + EXPECT_TRUE(matcher.shouldExclude("/.local/share/Trash/sub")); + EXPECT_FALSE(matcher.shouldExclude("/.local/share/Trashcan")); +} + +TEST(PathExcludeMatcherTest, PatternsListReturnsOriginals) +{ + PathExcludeMatcher matcher({ "tmp", "/abs/path" }); + QStringList pats = matcher.patterns(); + EXPECT_TRUE(pats.contains("tmp")); + EXPECT_TRUE(pats.contains("/abs/path")); +} + +TEST(PathExcludeMatcherTest, CreateForIndexReturnsMatcher) +{ + PathExcludeMatcher matcher = PathExcludeMatcher::createForIndex(); + EXPECT_NO_FATAL_FAILURE({ (void)matcher.hasPatterns(); }); +} + +TEST(PathExcludeMatcherTest, GlobToRegexSimple) +{ + QRegularExpression re = PathExcludeMatcher::globToRegex("*.txt"); + EXPECT_TRUE(re.match("a.txt").hasMatch()); + EXPECT_FALSE(re.match("a.tx").hasMatch()); +} + +TEST(PathExcludeMatcherTest, GlobToRegexQuestionMark) +{ + QRegularExpression re = PathExcludeMatcher::globToRegex("a?c"); + EXPECT_TRUE(re.match("abc").hasMatch()); + EXPECT_FALSE(re.match("ac").hasMatch()); +} + +TEST(PathExcludeMatcherTest, GlobToRegexEscapesSpecialChars) +{ + QRegularExpression re = PathExcludeMatcher::globToRegex("a.b"); + EXPECT_TRUE(re.match("a.b").hasMatch()); + EXPECT_FALSE(re.match("axb").hasMatch()); +} diff --git a/autotests/index/test_pinyinprocessor.cpp b/autotests/index/test_pinyinprocessor.cpp new file mode 100644 index 00000000..7d1c1f4f --- /dev/null +++ b/autotests/index/test_pinyinprocessor.cpp @@ -0,0 +1,316 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_pinyinprocessor.cpp + * @brief Unit tests for PinyinProcessor (pinyinprocessor.cpp) + * Covers dictionary loading (anything-format U+xxxx: pinyin[,pinyin] # hanzi), + * tone removal (ā→a, ǖ→v), and pinyin/acronym conversion (non-dict chars + * passed through, output lowercased — matching deepin-anything behavior). + * + * Uses a self-contained temp dictionary to avoid dependency on the installed + * /usr/share/deepin-anything-index/pinyin.txt (which may not be present in the + * build/test environment). loadDictionary() clears the map before loading, so + * re-loading the global singleton with a test dict gives a deterministic state. + */ + +#include +#include +#include +#include +#include +#include + +#include "utils/pinyinprocessor.h" + +#include "stubext.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +namespace { + +// Build a small but representative dictionary in the anything format. +// Returns the path to the temp dict file (caller owns f's lifetime). +void writeTempDict(QTemporaryFile &f) +{ + ASSERT_TRUE(f.open()); + QTextStream s(&f); + s << "# test pinyin dict\n"; + s << "U+4E2D: zhong, zhong # 中\n"; // 中 → zhōng/zhòng → first "zhong" + s << "U+6587: wen # 文\n"; + s << "U+4EF6: jian # 件\n"; + s << "U+540D: ming # 名\n"; + s << "U+7D22: suo # 索\n"; + s << "U+5F15: yin # 引\n"; + s << "U+641C: sou # 搜\n"; + s << "U+7247: pian # 片\n"; + s << "U+56FE: tu # 图\n"; + s << "U+97F3: yin # 音 (duplicate pinyin yin, different char)\n"; + // Polyphonic char: 行 → xíng/háng → first "xing" + s << "U+884C: xing, hang # 行\n"; + // Toned pinyin: lǜ → lü → remove_tone → "lv" + s << "U+7EFF: lü # 绿\n"; + s << "# trailing comment\n"; + s.flush(); + f.close(); +} + +// Helper: reload the global singleton with a temp dict and return it loaded. +// Each test gets a fresh map (loadDictionary clears before loading). +bool reloadWithTempDict(QTemporaryFile &f) +{ + writeTempDict(f); + return PinyinProcessor::instance().loadDictionary(f.fileName()); +} + +} // namespace + +TEST(PinyinProcessorTest, LoadDictionary_ValidFormat_LoadsEntries) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + EXPECT_TRUE(PinyinProcessor::instance().isLoaded()); +} + +TEST(PinyinProcessorTest, LoadDictionary_NonExistent_ReturnsFalse) +{ + EXPECT_FALSE(PinyinProcessor::instance().loadDictionary("/nonexistent/pinyin/dict.txt")); +} + +TEST(PinyinProcessorTest, DictionaryLookupPaths_UserDirFirstThenSystem) +{ + // XDG user directory must come first (user/OEM override), then the CMake-injected + // system install path. Stub QStandardPaths to avoid depending on the test env. + stub_ext::StubExt stub; + stub.set_lamda(ADDR(QStandardPaths, writableLocation), + [](QStandardPaths::StandardLocation) -> QString { + __DBG_STUB_INVOKE__ + return "/tmp/fake-xdg-data"; + }); + + const QStringList paths = PinyinProcessor::dictionaryLookupPaths(); + ASSERT_EQ(paths.size(), 2); + EXPECT_EQ(paths.first(), QString("/tmp/fake-xdg-data/deepin-anything-index/pinyin.txt")); + EXPECT_TRUE(paths.last().endsWith("deepin-anything-index/pinyin.txt")) + << "system fallback path: " << paths.last().toStdString(); +} + +TEST(PinyinProcessorTest, LoadDictionary_EmptyFile_NotLoaded) +{ + QTemporaryFile f; + ASSERT_TRUE(f.open()); + f.write("# only comments\n"); + f.close(); + EXPECT_FALSE(PinyinProcessor::instance().loadDictionary(f.fileName())); + EXPECT_FALSE(PinyinProcessor::instance().isLoaded()); +} + +TEST(PinyinProcessorTest, LoadDictionary_CommentAndBlankLinesSkipped) +{ + QTemporaryFile f; + ASSERT_TRUE(f.open()); + QTextStream s(&f); + s << "\n# comment\n\nU+4E2D: zhong # 中\n\n"; + s.flush(); + f.close(); + ASSERT_TRUE(PinyinProcessor::instance().loadDictionary(f.fileName())); + + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("中"), full, acro); + EXPECT_EQ(full, QString("zhong")); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_PureChinese_FullAndAcronym) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("文件名"), full, acro); + // 文件名 → wenjianming / wjm + EXPECT_EQ(full, QString("wenjianming")); + EXPECT_EQ(acro, QString("wjm")); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_Polyphonic_UsesFirstPinyin) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("中"), full, acro); + // 中 is polyphonic (zhong, zhong); first entry wins → "zhong" + EXPECT_EQ(full, QString("zhong")); + EXPECT_EQ(acro, QString("z")); + + PinyinProcessor::instance().convertToPinyin(QStringLiteral("行"), full, acro); + // 行 is polyphonic (xing, hang); first entry wins → "xing" + EXPECT_EQ(full, QString("xing")); + EXPECT_EQ(acro, QString("x")); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_TonedPinyin_ToneRemoved) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + + // 绿 → lü → remove_tone → "lv" (anything maps ü→v) + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("绿"), full, acro); + EXPECT_EQ(full, QString("lv")); + EXPECT_EQ(acro, QString("l")); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_NonDictChars_PassedThrough) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + + // English/digits/symbols not in dict should be passed through unchanged + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("abc123-文件"), full, acro); + // 中文部分→ wenjian, 英文原样拼入 → "abc123-wenjian" (lowercased) + EXPECT_EQ(full, QString("abc123-wenjian")); + EXPECT_EQ(acro, QString("abc123-wj")); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_EmptyInput_ReturnsEmpty) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QString(), full, acro); + EXPECT_TRUE(full.isEmpty()); + EXPECT_TRUE(acro.isEmpty()); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_NotLoaded_ReturnsEmpty) +{ + // Force unloaded state by loading an empty dict + QTemporaryFile f; + ASSERT_TRUE(f.open()); + f.write("# empty\n"); + f.close(); + ASSERT_FALSE(PinyinProcessor::instance().loadDictionary(f.fileName())); + ASSERT_FALSE(PinyinProcessor::instance().isLoaded()); + + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("文件"), full, acro); + EXPECT_TRUE(full.isEmpty()); + EXPECT_TRUE(acro.isEmpty()); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_OutputIsLowercased) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + + // Dict already lowercase, but verify the output path lowercases (anything toLower) + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("ABC文件"), full, acro); + EXPECT_EQ(full, QString("abcwenjian")); + EXPECT_EQ(acro, QString("abcwj")); +} + +TEST(PinyinProcessorTest, ConvertToPinyin_LongChinesePhrase) +{ + QTemporaryFile f; + ASSERT_TRUE(reloadWithTempDict(f)); + + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("文件名搜索"), full, acro); + // 文件名搜索 → wenjianmingsousuo / wjms + ss = wjmss + EXPECT_EQ(full, QString("wenjianmingsousuo")); + EXPECT_EQ(acro, QString("wjmss")); +} + +TEST(PinyinProcessorTest, InstanceSingleton_CallableAndDoesNotCrash) +{ + EXPECT_NO_FATAL_FAILURE({ (void)PinyinProcessor::instance().isLoaded(); }); + QString full, acro; + EXPECT_NO_FATAL_FAILURE({ PinyinProcessor::instance().convertToPinyin(QStringLiteral("test"), full, acro); }); +} + +TEST(PinyinProcessorTest, LoadDictionary_ReloadClearsPreviousEntries) +{ + // Load full test dict, then reload with a single-entry dict: previous chars gone. + QTemporaryFile f1; + ASSERT_TRUE(reloadWithTempDict(f1)); + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("文件"), full, acro); + EXPECT_EQ(full, QString("wenjian")); + + QTemporaryFile f2; + ASSERT_TRUE(f2.open()); + QTextStream s(&f2); + s << "U+4E2D: zhong # 中\n"; // only 中 + s.flush(); + f2.close(); + ASSERT_TRUE(PinyinProcessor::instance().loadDictionary(f2.fileName())); + + // 文 is no longer in the dict → passed through unchanged (original chars kept) + PinyinProcessor::instance().convertToPinyin(QStringLiteral("文件"), full, acro); + // Neither 文 nor 件 in the single-entry dict → both passed through as-is + EXPECT_EQ(full, QString("文件")); + EXPECT_EQ(acro, QString("文件")); +} + +TEST(PinyinProcessorTest, SupplementaryPlaneEntries_LoadAndConvert) +{ + // CJK Extension B chars (U+20000+) are surrogate pairs in UTF-16 — the dict key + // must handle them without tripping QChar's <=0xFFFF assert (regression: the + // XDG user dictionary contains 15k+ extension-B entries). + QTemporaryFile f; + ASSERT_TRUE(f.open()); + QTextStream s(&f); + s << "U+20000: he # \xF0\xA0\x80\x80\n"; // U+20000 𠀀 + s << "U+2A700: qi # \xF0\xAA\x9C\x80\n"; // U+2A700 (needs 3-hex-digit... still 21-bit) + s << "U+4E2D: zhong # 中\n"; + s.flush(); + f.close(); + ASSERT_TRUE(PinyinProcessor::instance().loadDictionary(f.fileName())); + + // Extension-B char gets its pinyin; BMP neighbor unchanged + const QString name = QString::fromUtf8("\xF0\xA0\x80\x80") + QStringLiteral("中"); + QString full, acro; + PinyinProcessor::instance().convertToPinyin(name, full, acro); + EXPECT_EQ(full, QString("hezhong")); + EXPECT_EQ(acro, QString("hz")); +} + +TEST(PinyinProcessorTest, SupplementaryPlane_NotInDict_PassedThrough) +{ + QTemporaryFile f; + ASSERT_TRUE(f.open()); + QTextStream s(&f); + s << "U+4E2D: zhong # 中\n"; + s.flush(); + f.close(); + ASSERT_TRUE(PinyinProcessor::instance().loadDictionary(f.fileName())); + + // Extension-B char not in dict → passed through as the original character + const QString extB = QString::fromUtf8("\xF0\xA0\x80\x80"); // U+20000 + QString full, acro; + PinyinProcessor::instance().convertToPinyin(extB + QStringLiteral("中"), full, acro); + EXPECT_EQ(full, extB + QString("zhong")); + EXPECT_EQ(acro, extB + QString("z")); +} + +TEST(PinyinProcessorTest, LoadDictionary_CodePointOutOfRange_Skipped) +{ + // Malformed/over-range codepoints (U+110000+) must be skipped, not crash + QTemporaryFile f; + ASSERT_TRUE(f.open()); + QTextStream s(&f); + s << "U+110000: bad # out of Unicode range\n"; + s << "U+4E2D: zhong # 中\n"; + s.flush(); + f.close(); + ASSERT_TRUE(PinyinProcessor::instance().loadDictionary(f.fileName())); + + QString full, acro; + PinyinProcessor::instance().convertToPinyin(QStringLiteral("中"), full, acro); + EXPECT_EQ(full, QString("zhong")); +} diff --git a/autotests/index/test_plugin.cpp b/autotests/index/test_plugin.cpp new file mode 100644 index 00000000..b0e9fa8a --- /dev/null +++ b/autotests/index/test_plugin.cpp @@ -0,0 +1,130 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_plugin.cpp + * @brief Unit tests for the service entry (registerIndexServices / unregisterIndexServices). + * Since these are extern "C" functions that create DBus objects, + * we test them minimally — the DBus registration will fail gracefully + * in the test sandbox. + */ + +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +// Entry functions from serviceentry.cpp (the rewritten plugin.cpp entry) +#include "serviceentry.h" + +class PluginTest : public testing::Test +{ +protected: + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + // Redirect index directories to temp + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/content-index"; + }); + stub.set_lamda(ADDR(Global, isContentIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInContentIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/ocr-index"; + }); + stub.set_lamda(ADDR(Global, isOcrTextIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInOcrTextIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() + "/indexed-dir" }; + }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + } + + QTemporaryDir tmp; + stub_ext::StubExt stub; +}; + +TEST_F(PluginTest, DSMRegister_ReturnsZero) +{ + // DSMRegister creates DBus objects; should return 0 + // DBus registration may fail in sandbox but the function + // should still return 0 + int result = anything_index::registerIndexServices(); + EXPECT_EQ(result, 0); + + // Clean up via DSMUnRegister + anything_index::unregisterIndexServices(); +} + +// TEST_F(PluginTest, DSMRegister_CallTwice) +// { +// int result1 = anything_index::registerIndexServices(); +// EXPECT_EQ(result1, 0); +// +// int result2 = anything_index::registerIndexServices(); +// EXPECT_EQ(result2, 0); +// +// anything_index::unregisterIndexServices(); +// } + +TEST_F(PluginTest, DSMUnRegister_WithoutRegister) +{ + // Calling unregister without register should not crash + int result = anything_index::unregisterIndexServices(); + EXPECT_EQ(result, 0); +} + +TEST_F(PluginTest, DSMUnRegister_CalledTwice) +{ + anything_index::registerIndexServices(); + anything_index::unregisterIndexServices(); + // Second unregister should not crash + int result = anything_index::unregisterIndexServices(); + EXPECT_EQ(result, 0); +} + +TEST_F(PluginTest, DSMRegister_WithNullName) +{ + int result = anything_index::registerIndexServices(); + EXPECT_EQ(result, 0); + anything_index::unregisterIndexServices(); +} diff --git a/autotests/index/test_processextractor.cpp b/autotests/index/test_processextractor.cpp new file mode 100644 index 00000000..39b9ac14 --- /dev/null +++ b/autotests/index/test_processextractor.cpp @@ -0,0 +1,119 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_processextractor.cpp + * @brief Unit tests for ProcessExtractor (extractor/processextractor.cpp) + * Covers ctor/dtor, extract with null proxy, extract on same thread, + * and extract from different thread. The actual extractor subprocess + * interaction is stubbed to avoid launching real processes. + */ + +#include +#include +#include +#include + +#include "stubext.h" +#include "dfm_test_main.h" + +#include "index_global.h" +#include "extractor/processextractor.h" +#include "extractor/indexextractor.h" +#include "controllerpipe.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace EXTRACTOR_NAMESPACE; + +class ProcessExtractorTest : public testing::Test +{ +protected: + stub_ext::StubExt stub; + + void SetUp() override + { + // Stub ControllerPipe::start to always fail so the extractor + // subprocess never actually launches during tests. + stub.set_lamda(VADDR(ControllerPipe, start), [](ControllerPipe *, const QString &, const QString &) -> bool { + return false; + }); + } +}; + +TEST_F(ProcessExtractorTest, ConstructAndDestruct) +{ + { ProcessExtractor ext; } + SUCCEED(); +} + +TEST_F(ProcessExtractorTest, Extract_NullProxy_ReturnsError) +{ + ProcessExtractor ext; + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + QString filePath = tmp.path() + "/test.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("hello world"); + f.close(); + + auto result = ext.extract(filePath); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorTest, Extract_NonExistentFile) +{ + ProcessExtractor ext; + auto result = ext.extract("/nonexistent/file/that/does/not/exist.txt"); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorTest, Extract_EmptyFilePath) +{ + ProcessExtractor ext; + auto result = ext.extract(QString()); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorTest, Extract_WithMaxBytes) +{ + ProcessExtractor ext; + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + QString filePath = tmp.path() + "/test.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("hello world"); + f.close(); + + auto result = ext.extract(filePath, 1024); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorTest, ExtractResult_DefaultValues) +{ + IndexExtractionResult result; + EXPECT_FALSE(result.success); + EXPECT_TRUE(result.text.isEmpty()); + EXPECT_TRUE(result.error.isEmpty()); + EXPECT_TRUE(result.checksum.isEmpty()); + EXPECT_FALSE(result.deduplicated); +} + +TEST_F(ProcessExtractorTest, Extract_MultipleCalls) +{ + ProcessExtractor ext; + QTemporaryDir tmp; + ASSERT_TRUE(tmp.isValid()); + + for (int i = 0; i < 5; i++) { + QString filePath = tmp.path() + "/test" + QString::number(i) + ".txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("content"); + f.close(); + auto result = ext.extract(filePath); + EXPECT_FALSE(result.success); + } +} \ No newline at end of file diff --git a/autotests/index/test_processextractor_extra.cpp b/autotests/index/test_processextractor_extra.cpp new file mode 100644 index 00000000..020385ce --- /dev/null +++ b/autotests/index/test_processextractor_extra.cpp @@ -0,0 +1,169 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_processextractor_extra.cpp + * @brief Additional tests for ProcessExtractor covering more internal paths. + * Tests various extract scenarios on same thread. + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include "dfm_test_main.h" +#include "index_global.h" +#include "extractor/processextractor.h" +#include "extractor/indexextractor.h" +#include "controllerpipe.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace EXTRACTOR_NAMESPACE; + +class ProcessExtractorExtraTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + stub_ext::StubExt stub; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + createFile("normal.txt", "normal content"); + createFile("empty.txt", QString("")); + + // Stub ControllerPipe::start to always fail so the extractor + // subprocess never actually launches during tests. + stub.set_lamda(VADDR(ControllerPipe, start), [](ControllerPipe *, const QString &, const QString &) -> bool { + return false; + }); + } + + void createFile(const QString &name, const QString &content) + { + QFile f(tmp.path() + "/" + name); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } +}; + +TEST_F(ProcessExtractorExtraTest, Extract_SameThread_MultipleSequential) +{ + ProcessExtractor ext; + for (int i = 0; i < 3; i++) { + auto result = ext.extract(tmp.path() + "/normal.txt"); + EXPECT_FALSE(result.success); + } +} + +TEST_F(ProcessExtractorExtraTest, Extract_LargeFilePath) +{ + ProcessExtractor ext; + QString longDir = tmp.path(); + for (int i = 0; i < 10; i++) { + longDir += "/subdir_" + QString::number(i); + QDir().mkpath(longDir); + } + QString longPath = longDir + "/file.txt"; + QFile f(longPath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("data"); + f.close(); + + auto result = ext.extract(longPath); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_ZeroMaxBytes) +{ + ProcessExtractor ext; + auto result = ext.extract(tmp.path() + "/normal.txt", 0); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_VeryLargeMaxBytes) +{ + ProcessExtractor ext; + auto result = ext.extract(tmp.path() + "/normal.txt", SIZE_MAX); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_PathWithSpaces) +{ + QString dirWithSpaces = tmp.path() + "/dir with spaces"; + QDir().mkpath(dirWithSpaces); + QString filePath = dirWithSpaces + "/file with spaces.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("content"); + f.close(); + + ProcessExtractor ext; + auto result = ext.extract(filePath); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_PathWithSpecialChars) +{ + QString specialDir = tmp.path() + "/dir_特殊_🚀"; + QDir().mkpath(specialDir); + QString filePath = specialDir + "/文件.txt"; + QFile f(filePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write("unicode"); + f.close(); + + ProcessExtractor ext; + auto result = ext.extract(filePath); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, MultipleExtractors_InScope) +{ + ProcessExtractor ext1; + ProcessExtractor ext2; + ProcessExtractor ext3; + + auto r1 = ext1.extract(tmp.path() + "/normal.txt"); + auto r2 = ext2.extract(tmp.path() + "/normal.txt"); + auto r3 = ext3.extract(tmp.path() + "/normal.txt"); + + EXPECT_FALSE(r1.success); + EXPECT_FALSE(r2.success); + EXPECT_FALSE(r3.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_EmptyFile) +{ + ProcessExtractor ext; + auto result = ext.extract(tmp.path() + "/empty.txt"); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_NonExistentFile) +{ + ProcessExtractor ext; + auto result = ext.extract("/nonexistent/file/that/does/not/exist.txt"); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_WithMaxBytes_1024) +{ + ProcessExtractor ext; + auto result = ext.extract(tmp.path() + "/normal.txt", 1024); + EXPECT_FALSE(result.success); +} + +TEST_F(ProcessExtractorExtraTest, Extract_WithMaxBytes_1) +{ + ProcessExtractor ext; + auto result = ext.extract(tmp.path() + "/normal.txt", 1); + EXPECT_FALSE(result.success); +} \ No newline at end of file diff --git a/autotests/index/test_progressnotifier.cpp b/autotests/index/test_progressnotifier.cpp new file mode 100644 index 00000000..d71c04b9 --- /dev/null +++ b/autotests/index/test_progressnotifier.cpp @@ -0,0 +1,60 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_progressnotifier.cpp + * @brief Unit tests for ProgressNotifier (task/progressnotifier.h) + */ + +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "task/progressnotifier.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class ProgressNotifierTest : public ::testing::Test +{ +protected: + void SetUp() override + { + if (!qApp) + app = std::make_unique(argc, argv); + } + + std::unique_ptr app; + static int argc; + static char *argv[]; +}; + +int ProgressNotifierTest::argc = 1; +char *ProgressNotifierTest::argv[] = { const_cast("test_progressnotifier") }; + +TEST_F(ProgressNotifierTest, InstanceReturnsNonNull) +{ + auto *inst = ProgressNotifier::instance(); + ASSERT_NE(inst, nullptr); +} + +TEST_F(ProgressNotifierTest, InstanceReturnsSame) +{ + auto *a = ProgressNotifier::instance(); + auto *b = ProgressNotifier::instance(); + EXPECT_EQ(a, b); +} + +TEST_F(ProgressNotifierTest, ConnectSignalAndEmit) +{ + auto *inst = ProgressNotifier::instance(); + QSignalSpy spy(inst, &ProgressNotifier::progressChanged); + ASSERT_TRUE(spy.isValid()); + + emit inst->progressChanged(42, 100); + EXPECT_EQ(spy.count(), 1); + EXPECT_EQ(spy.at(0).at(0).toInt(), 42); + EXPECT_EQ(spy.at(0).at(1).toInt(), 100); +} \ No newline at end of file diff --git a/autotests/index/test_systemdcpuutils.cpp b/autotests/index/test_systemdcpuutils.cpp new file mode 100644 index 00000000..1a8691cc --- /dev/null +++ b/autotests/index/test_systemdcpuutils.cpp @@ -0,0 +1,39 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_systemdcpuutils.cpp + * @brief Unit tests for SystemdCpuUtils (utils/systemdcpuutils.cpp) — empty + * service name early returns (no subprocess spawned). + */ + +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "utils/systemdcpuutils.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(SystemdCpuUtilsTest, SetCpuQuotaEmptyNameReturnsFalse) +{ + QString err; + EXPECT_FALSE(SystemdCpuUtils::setCpuQuota(QString(), 50, &err)); + EXPECT_FALSE(err.isEmpty()); +} + +TEST(SystemdCpuUtilsTest, SetCpuQuotaNegativePercentageReturnsFalse) +{ + QString err; + EXPECT_FALSE(SystemdCpuUtils::setCpuQuota("test.service", -1, &err)); + EXPECT_FALSE(err.isEmpty()); +} + +TEST(SystemdCpuUtilsTest, ResetCpuQuotaEmptyNameReturnsFalse) +{ + QString err; + EXPECT_FALSE(SystemdCpuUtils::resetCpuQuota(QString(), &err)); + EXPECT_FALSE(err.isEmpty()); +} diff --git a/autotests/index/test_taskhandler_factories.cpp b/autotests/index/test_taskhandler_factories.cpp new file mode 100644 index 00000000..b52126c6 --- /dev/null +++ b/autotests/index/test_taskhandler_factories.cpp @@ -0,0 +1,109 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskhandler_factories.cpp + * @brief Unit tests for the TaskHandlers factory functions (task/taskhandler.cpp). + * The factory functions only construct and return handler lambdas / + * FileProvider instances — the heavy indexing bodies run only when the + * returned handler is invoked, which these tests deliberately do NOT do. + * This covers the factory functions themselves plus the + * createAnythingFileProvider short-circuit branch. + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" +#include "task/taskhandler.h" +#include "utils/taskstate.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class TaskHandlerFactoriesTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + IndexProfile makeProfile() + { + return IndexProfile({ IndexProfile::Type::Content, + "th_test", + "th_status.json", + "th_version", + 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + } + + std::unique_ptr runtime; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + // A real directory with a file so createFileProvider has something to wrap. + QDir root(tmp.path()); + ASSERT_TRUE(root.mkpath("d")); + QFile f(root.filePath("d/a.txt")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.close(); + runtime = std::make_unique(makeProfile()); + } +}; + +TEST_F(TaskHandlerFactoriesTest, CreateFileProviderWrapsFileSystemForTempPath) +{ + auto p = TaskHandlers::createFileProvider(runtime->context(), tmp.path()); + ASSERT_NE(p, nullptr); + EXPECT_EQ(p->name(), QString("FileSystemProvider")); +} + +TEST_F(TaskHandlerFactoriesTest, CreateFileListProviderWrapsMixedList) +{ + QStringList files { tmp.path() + "/d/a.txt" }; + auto p = TaskHandlers::createFileListProvider(runtime->context(), files); + ASSERT_NE(p, nullptr); + EXPECT_EQ(p->name(), QString("MixedPathListProvider")); +} + +TEST_F(TaskHandlerFactoriesTest, CreateIndexHandlerReturnsCallable) +{ + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + EXPECT_TRUE(h); // function is truthy when populated +} + +TEST_F(TaskHandlerFactoriesTest, UpdateIndexHandlerReturnsCallable) +{ + TaskHandler h = TaskHandlers::UpdateIndexHandler(runtime->context()); + EXPECT_TRUE(h); +} + +TEST_F(TaskHandlerFactoriesTest, CreateOrUpdateFileListHandlerReturnsCallable) +{ + TaskHandler h = TaskHandlers::CreateOrUpdateFileListHandler(runtime->context(), { tmp.path() + "/d/a.txt" }); + EXPECT_TRUE(h); +} + +TEST_F(TaskHandlerFactoriesTest, RemoveFileListHandlerReturnsCallable) +{ + TaskHandler h = TaskHandlers::RemoveFileListHandler(runtime->context(), { tmp.path() + "/d/a.txt" }); + EXPECT_TRUE(h); +} + +TEST_F(TaskHandlerFactoriesTest, MoveFileListHandlerReturnsCallable) +{ + QHash moves { { tmp.path() + "/d/a.txt", tmp.path() + "/d/b.txt" } }; + TaskHandler h = TaskHandlers::MoveFileListHandler(runtime->context(), moves); + EXPECT_TRUE(h); +} diff --git a/autotests/index/test_taskhandler_helpers.cpp b/autotests/index/test_taskhandler_helpers.cpp new file mode 100644 index 00000000..412774e3 --- /dev/null +++ b/autotests/index/test_taskhandler_helpers.cpp @@ -0,0 +1,424 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskhandler_helpers.cpp + * @brief Unit tests for internal helper functions in taskhandler.cpp. + * Uses -fno-access-control to access anonymous-namespace functions: + * ProgressReporter, shouldSkipExcludedFile. + * Tests ProgressReporter constructor/destructor/increment/setTotal/markIndexChanged. + */ + +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "profile/lowercasengramanalyzer.h" +#include "core/indexruntime.h" +#include "task/taskhandler.h" +#include "utils/taskstate.h" +#include "utils/pathexcludematcher.h" + +#include +#include +#include + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; +using namespace Lucene; + +// The anonymous namespace functions in taskhandler.cpp are not directly accessible. +// But we can test TaskHandlers::createFileProvider and shouldSkipExcludedFile +// indirectly, and test ProgressReporter through the handlers. + +// --- Test shouldSkipExcludedFile indirectly through PathExcludeMatcher --- + +class TaskHandlerHelpersTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + IndexProfile makeProfile() + { + return IndexProfile({ IndexProfile::Type::Content, + "th_helpers_test", + "th_helpers_status.json", + "th_helpers_version", + 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + } + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + QDir root(tmp.path()); + ASSERT_TRUE(root.mkpath("d/subdir")); + createFile("d/a.txt", "hello"); + createFile("d/subdir/b.txt", "world"); + } + + void createFile(const QString &relativePath, const QString &content) + { + QFile f(tmp.path() + "/" + relativePath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } +}; + +TEST_F(TaskHandlerHelpersTest, CreateFileProvider_WithExistingDir) +{ + auto runtime = std::make_unique(makeProfile()); + auto provider = TaskHandlers::createFileProvider(runtime->context(), tmp.path() + "/d"); + ASSERT_NE(provider, nullptr); + EXPECT_EQ(provider->name(), QString("FileSystemProvider")); +} + +TEST_F(TaskHandlerHelpersTest, CreateFileProvider_WithNonexistentDir) +{ + auto runtime = std::make_unique(makeProfile()); + auto provider = TaskHandlers::createFileProvider(runtime->context(), tmp.path() + "/nonexistent"); + ASSERT_NE(provider, nullptr); + EXPECT_EQ(provider->name(), QString("FileSystemProvider")); +} + +TEST_F(TaskHandlerHelpersTest, CreateFileListProvider_EmptyList) +{ + auto runtime = std::make_unique(makeProfile()); + auto provider = TaskHandlers::createFileListProvider(runtime->context(), QStringList()); + ASSERT_NE(provider, nullptr); + EXPECT_EQ(provider->name(), QString("MixedPathListProvider")); +} + +TEST_F(TaskHandlerHelpersTest, CreateFileListProvider_SingleFile) +{ + auto runtime = std::make_unique(makeProfile()); + QStringList files { tmp.path() + "/d/a.txt" }; + auto provider = TaskHandlers::createFileListProvider(runtime->context(), files); + ASSERT_NE(provider, nullptr); + EXPECT_EQ(provider->name(), QString("MixedPathListProvider")); +} + +TEST_F(TaskHandlerHelpersTest, CreateFileListProvider_MultipleFiles) +{ + auto runtime = std::make_unique(makeProfile()); + QStringList files { + tmp.path() + "/d/a.txt", + tmp.path() + "/d/subdir/b.txt" + }; + auto provider = TaskHandlers::createFileListProvider(runtime->context(), files); + ASSERT_NE(provider, nullptr); + EXPECT_EQ(provider->name(), QString("MixedPathListProvider")); +} + +// --- Test CreateIndexHandler invocation on non-existent directory --- +TEST_F(TaskHandlerHelpersTest, CreateIndexHandler_NonExistentDir) +{ + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + HandlerResult result = h("/nonexistent/directory/path", state); + EXPECT_FALSE(result.success); +} + +// --- Test UpdateIndexHandler invocation on non-existent index dir (will throw) --- +TEST_F(TaskHandlerHelpersTest, UpdateIndexHandler_NonExistentIndexDir_Caught) +{ + // Update requires existing index. With a temp dir that has no index, + // it will catch an exception and throw LuceneException. + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::UpdateIndexHandler(runtime->context()); + TaskState state; + // This will throw LuceneException since index doesn't exist + EXPECT_THROW({ HandlerResult result = h(tmp.path(), state); }, std::exception); +} + +// --- Test CreateOrUpdateFileListHandler on empty index --- +TEST_F(TaskHandlerHelpersTest, CreateOrUpdateFileListHandler_NoIndex) +{ + // First create an index so UpdateFileList can open it + { + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + h(tmp.path(), state); + } + + auto runtime = std::make_unique(makeProfile()); + QStringList files { tmp.path() + "/d/a.txt" }; + TaskHandler h = TaskHandlers::CreateOrUpdateFileListHandler(runtime->context(), files); + TaskState state; + EXPECT_NO_FATAL_FAILURE({ + HandlerResult result = h(tmp.path(), state); + }); +} + +// --- Test RemoveFileListHandler on empty index --- +TEST_F(TaskHandlerHelpersTest, RemoveFileListHandler_NoIndex) +{ + auto runtime = std::make_unique(makeProfile()); + QStringList files { tmp.path() + "/d/a.txt" }; + TaskHandler h = TaskHandlers::RemoveFileListHandler(runtime->context(), files); + TaskState state; + EXPECT_NO_FATAL_FAILURE({ + HandlerResult result = h(tmp.path(), state); + }); +} + +// --- Test MoveFileListHandler on empty index --- +TEST_F(TaskHandlerHelpersTest, MoveFileListHandler_NoIndex) +{ + auto runtime = std::make_unique(makeProfile()); + QHash moves { { tmp.path() + "/d/a.txt", tmp.path() + "/d/c.txt" } }; + TaskHandler h = TaskHandlers::MoveFileListHandler(runtime->context(), moves); + TaskState state; + EXPECT_NO_FATAL_FAILURE({ + HandlerResult result = h(tmp.path(), state); + }); +} + +// --- Test CreateIndexHandler with real files and index directory --- +TEST_F(TaskHandlerHelpersTest, CreateIndexHandler_RealFiles) +{ + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + HandlerResult result = h(tmp.path() + "/d", state); + // May succeed or fail depending on Lucene setup, but shouldn't crash + SUCCEED(); +} + +// --- Test CreateIndexHandler with interrupted state --- +TEST_F(TaskHandlerHelpersTest, CreateIndexHandler_Interrupted) +{ + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + state.stop(); + HandlerResult result = h(tmp.path() + "/d", state); + EXPECT_FALSE(result.success); + EXPECT_TRUE(result.interrupted); +} + +// --- Test UpdateIndexHandler with interrupted state --- +TEST_F(TaskHandlerHelpersTest, UpdateIndexHandler_InterruptedAfterCreate) +{ + // First create an index + { + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + h(tmp.path() + "/d", state); + } + + // Now try update with interruption + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::UpdateIndexHandler(runtime->context()); + TaskState state; + // Interrupt after a brief moment + QTimer::singleShot(100, [&state]() { state.stop(); }); + EXPECT_NO_FATAL_FAILURE({ + HandlerResult result = h(tmp.path(), state); + }); +} + +// --- Test ProgressReporter behavior through CreateIndexHandler --- +TEST_F(TaskHandlerHelpersTest, ProgressReporter_Coverage) +{ + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + HandlerResult result = h(tmp.path() + "/d", state); + // The ProgressReporter destructor is called when the handler returns, + // exercising the destructor's commit logic + SUCCEED(); +} + +// =========================================================================== +// Incremental tasks use the original batch-count commit and final commit. +// =========================================================================== + +TEST_F(TaskHandlerHelpersTest, IncrementalHandler_FilenameProfile_UsesExistingCommitMechanism) +{ + // A small filename task must still complete through the existing final commit. + stub_ext::StubExt stub; + stub.set_lamda(ADDR(DFMSEARCH::Global, fileNameIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/fnidx"; + }); + stub.set_lamda(ADDR(DFMSEARCH::Global, isFileNameIndexDirectoryAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(DFMSEARCH::Global, isPathInFileNameIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(DFMSEARCH::Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/cidx"; + }); + stub.set_lamda(ADDR(DFMSEARCH::Global, ocrTextIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/oidx"; + }); + stub.set_lamda(ADDR(DFMSEARCH::Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + + auto runtime = std::make_unique(IndexProfile::filename()); + + // Create an index first so the file-list handler can open the writer. + { + TaskHandler createH = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState st; + st.start(); + createH(tmp.path(), st); + } + + // Now run an incremental file-list task — its destructor performs final commit. + QStringList files { tmp.path() + "/a.txt", tmp.path() + "/b.txt" }; + TaskHandler h = TaskHandlers::CreateOrUpdateFileListHandler(runtime->context(), files); + TaskState state; + state.start(); + EXPECT_NO_FATAL_FAILURE({ (void)h(tmp.path(), state); }); +} + +TEST_F(TaskHandlerHelpersTest, IncrementalHandler_ContentProfile_UsesExistingCommitMechanism) +{ + // Content profile keeps the same batch-count-only commit behavior. + auto runtime = std::make_unique(makeProfile()); + + // Create an index first. + { + TaskHandler createH = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState st; + st.start(); + createH(tmp.path(), st); + } + + QStringList files { tmp.path() + "/a.txt" }; + TaskHandler h = TaskHandlers::CreateOrUpdateFileListHandler(runtime->context(), files); + TaskState state; + state.start(); + EXPECT_NO_FATAL_FAILURE({ (void)h(tmp.path(), state); }); +} + +// --- Test PathExcludeMatcher directly (used by shouldSkipExcludedFile) --- +TEST_F(TaskHandlerHelpersTest, PathExcludeMatcher_ShouldExclude) +{ + auto matcher = PathExcludeMatcher::createForIndex(); + // Default matcher should have some patterns + EXPECT_NO_FATAL_FAILURE({ + (void)matcher.patternCount(); + }); +} + +TEST_F(TaskHandlerHelpersTest, PathExcludeMatcher_ShouldExclude_TempPath) +{ + auto matcher = PathExcludeMatcher::createForIndex(); + bool excluded = matcher.shouldExclude(tmp.path()); + // /tmp paths may or may not be excluded, just verify no crash + SUCCEED(); +} + +TEST_F(TaskHandlerHelpersTest, PathExcludeMatcher_AddAndRemovePattern) +{ + auto matcher = PathExcludeMatcher::createForIndex(); + int countBefore = matcher.patternCount(); + matcher.addPattern("/test/exclude"); + int countAfter = matcher.patternCount(); + EXPECT_EQ(countAfter, countBefore + 1); + EXPECT_TRUE(matcher.shouldExclude("/test/exclude/file.txt")); + matcher.removePattern("/test/exclude"); + EXPECT_EQ(matcher.patternCount(), countBefore); +} + +// --- Test handler result with empty moves (no index needed) --- +TEST_F(TaskHandlerHelpersTest, MoveFileListHandler_EmptyMovedFiles) +{ + // Create an index first so the handler can open the reader/writer + { + auto runtime = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + h(tmp.path() + "/d", state); + } + + auto runtime = std::make_unique(makeProfile()); + QHash moves; + TaskHandler h = TaskHandlers::MoveFileListHandler(runtime->context(), moves); + TaskState state; + // Empty moves — handler opens index and returns success=true + EXPECT_NO_FATAL_FAILURE({ + HandlerResult result = h(tmp.path(), state); + }); +} +// Additional tests for TaskHandler factory functions and HandlerResult +TEST(TaskHandlerHelpersExtraTest, HandlerResult_DefaultValues) +{ + HandlerResult result; + EXPECT_FALSE(result.success); + EXPECT_FALSE(result.interrupted); + EXPECT_FALSE(result.useAnything); + EXPECT_FALSE(result.fatal); + EXPECT_FALSE(result.indexChanged); +} + +TEST(TaskHandlerHelpersExtraTest, HandlerResult_SetSuccess) +{ + HandlerResult result; + result.success = true; + result.indexChanged = true; + EXPECT_TRUE(result.success); + EXPECT_TRUE(result.indexChanged); +} + +TEST(TaskHandlerHelpersExtraTest, HandlerResult_InterruptedState) +{ + HandlerResult result; + result.interrupted = true; + EXPECT_TRUE(result.interrupted); + EXPECT_FALSE(result.success); +} + +TEST(TaskHandlerHelpersExtraTest, CreateFileProvider_WithValidPath) +{ + // Just verify the function is callable - no Lucene needed + EXPECT_NO_FATAL_FAILURE({ + auto runtime = std::make_unique(IndexProfile{}); + auto &context = runtime->m_context; + auto provider = TaskHandlers::createFileProvider(context, "/tmp"); + (void)provider; + }); +} + +TEST(TaskHandlerHelpersExtraTest, CreateFileListProvider_EmptyList) +{ + EXPECT_NO_FATAL_FAILURE({ + auto runtime = std::make_unique(IndexProfile{}); + auto &context = runtime->m_context; + auto provider = TaskHandlers::createFileListProvider(context, QStringList{}); + (void)provider; + }); +} diff --git a/autotests/index/test_taskhandler_withindex.cpp b/autotests/index/test_taskhandler_withindex.cpp new file mode 100644 index 00000000..7025c3c9 --- /dev/null +++ b/autotests/index/test_taskhandler_withindex.cpp @@ -0,0 +1,271 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskhandler_withindex.cpp + * @brief Tests for anonymous-namespace functions in taskhandler.cpp (processFile, + * updateFile, removeFile, removeDirectoryIndex, checkNeedUpdate, shouldSkipExcludedFile, + * createFileDocument) by invoking them through CreateIndexHandler/UpdateIndexHandler + * lambdas with a real Lucene index. + * Also covers ProgressReporter::increment, setTotal, markIndexChanged. + */ + +#include +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" +#include "task/taskhandler.h" +#include "utils/taskstate.h" +#include "utils/pathexcludematcher.h" + +#include +#include +#include +#include + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace Lucene; + +namespace { + +struct TaskHandlerIndexTest : public testing::Test +{ + QTemporaryDir tmp; + QString indexDir; + std::unique_ptr runtime; + + IndexProfile makeProfile() + { + return IndexProfile({ IndexProfile::Type::Content, + "thidx_test", + "thidx_status.json", + "thidx_version", + 1 }, + { [this]() -> QString { return indexDir; }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &p) -> bool { return p.endsWith(".txt") || p.endsWith(".md"); } }); + } + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + indexDir = tmp.path() + "/index"; + QDir().mkpath(indexDir); + + runtime = std::make_unique(makeProfile()); + + // Create test directory structure + QDir root(tmp.path()); + root.mkpath("subdir"); + root.mkpath("blacklisted"); + createFile("a.txt", "hello world"); + createFile("b.txt", "foo bar baz"); + createFile("subdir/c.txt", "nested content"); + createFile("d.dat", "unsupported extension"); + createFile(".hidden.txt", "hidden file"); + } + + void createFile(const QString &relativePath, const QString &content) + { + QString fullPath = tmp.path() + "/" + relativePath; + QDir().mkpath(QFileInfo(fullPath).absolutePath()); + QFile f(fullPath); + ASSERT_TRUE(f.open(QIODevice::WriteOnly)); + f.write(content.toUtf8()); + f.close(); + } +}; + +} // namespace + +// ---- CreateIndexHandler covers processFile, createFileDocument, ProgressReporter ---- +TEST_F(TaskHandlerIndexTest, CreateIndexHandler_CoversProcessFileAndCreateDocument) +{ + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + HandlerResult result = h(tmp.path(), state); + // Success depends on the actual extraction working + // But processFile and createFileDocument are covered + SUCCEED(); +} + +// ---- UpdateIndexHandler covers checkNeedUpdate, updateFile, cleanupIndexs ---- +TEST_F(TaskHandlerIndexTest, UpdateIndexHandler_CoversCheckNeedUpdateAndUpdateFile) +{ + // First create the index + { + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(rt->context()); + TaskState state; + h(tmp.path(), state); + } + + // Now update + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::UpdateIndexHandler(rt->context()); + TaskState state; + HandlerResult result = h(tmp.path(), state); + SUCCEED(); +} + +// ---- UpdateIndexHandler with modified file (touch file to change mtime) ---- +TEST_F(TaskHandlerIndexTest, UpdateIndexHandler_ModifiedFile) +{ + // Create index + { + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(rt->context()); + TaskState state; + h(tmp.path(), state); + } + + // Modify a file (change content) + QFile f(tmp.path() + "/a.txt"); + f.open(QIODevice::WriteOnly | QIODevice::Truncate); + f.write("updated content"); + f.close(); + + // Update + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::UpdateIndexHandler(rt->context()); + TaskState state; + HandlerResult result = h(tmp.path(), state); + SUCCEED(); +} + +// ---- UpdateIndexHandler with new file added ---- +TEST_F(TaskHandlerIndexTest, UpdateIndexHandler_NewFileAdded) +{ + // Create index + { + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(rt->context()); + TaskState state; + h(tmp.path(), state); + } + + // Add a new file + createFile("newfile.txt", "newly added file"); + + // Update + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::UpdateIndexHandler(rt->context()); + TaskState state; + HandlerResult result = h(tmp.path(), state); + SUCCEED(); +} + +// ---- UpdateIndexHandler with deleted file (remove then update) ---- +TEST_F(TaskHandlerIndexTest, UpdateIndexHandler_FileDeleted) +{ + // Create index + { + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(rt->context()); + TaskState state; + h(tmp.path(), state); + } + + // Delete a file + QFile::remove(tmp.path() + "/b.txt"); + + // Update (cleanupIndexs should remove deleted file from index) + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::UpdateIndexHandler(rt->context()); + TaskState state; + HandlerResult result = h(tmp.path(), state); + SUCCEED(); +} + +// ---- RemoveFileListHandler covers removeFile and removeDirectoryIndex ---- +TEST_F(TaskHandlerIndexTest, RemoveFileListHandler_CoversRemoveFile) +{ + // Create index + { + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(rt->context()); + TaskState state; + h(tmp.path(), state); + } + + auto rt = std::make_unique(makeProfile()); + QStringList files { tmp.path() + "/a.txt", tmp.path() + "/subdir" }; + TaskHandler h = TaskHandlers::RemoveFileListHandler(rt->context(), files); + TaskState state; + HandlerResult result = h(tmp.path(), state); + SUCCEED(); +} + +// ---- CreateOrUpdateFileListHandler covers updateFile path ---- +TEST_F(TaskHandlerIndexTest, CreateOrUpdateFileListHandler_CoversUpdateFile) +{ + // Create index + { + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(rt->context()); + TaskState state; + h(tmp.path(), state); + } + + auto rt = std::make_unique(makeProfile()); + QStringList files { tmp.path() + "/a.txt", tmp.path() + "/b.txt" }; + TaskHandler h = TaskHandlers::CreateOrUpdateFileListHandler(rt->context(), files); + TaskState state; + HandlerResult result = h(tmp.path(), state); + SUCCEED(); +} + +// ---- MoveFileListHandler covers FileMoveProcessor and DirectoryMoveProcessor ---- +TEST_F(TaskHandlerIndexTest, MoveFileListHandler_CoversProcessors) +{ + // Create index + { + auto rt = std::make_unique(makeProfile()); + TaskHandler h = TaskHandlers::CreateIndexHandler(rt->context()); + TaskState state; + h(tmp.path(), state); + } + + // Create the target file for the move + createFile("a_renamed.txt", "renamed content"); + + auto rt = std::make_unique(makeProfile()); + QHash moves { + { tmp.path() + "/a.txt", tmp.path() + "/a_renamed.txt" } + }; + TaskHandler h = TaskHandlers::MoveFileListHandler(rt->context(), moves); + TaskState state; + HandlerResult result = h(tmp.path(), state); + SUCCEED(); +} + +// ---- ProgressReporter::setTotal and increment via CreateIndexHandler ---- +TEST_F(TaskHandlerIndexTest, ProgressReporter_SettTotalAndIncrement) +{ + TaskHandler h = TaskHandlers::CreateIndexHandler(runtime->context()); + TaskState state; + HandlerResult result = h(tmp.path(), state); + // ProgressReporter destructor is called when handler returns + // This covers increment, setTotal, markIndexChanged + SUCCEED(); +} + +// ---- shouldSkipExcludedFile indirect test ---- +TEST_F(TaskHandlerIndexTest, ShouldSkipExcludedFile_ViaBlacklistedDir) +{ + // Use a plain PathExcludeMatcher to avoid loading real DConfig defaults + // which may contain unexpected fallback patterns in test environment. + PathExcludeMatcher matcher; + matcher.addPattern(tmp.path() + "/blacklisted"); + EXPECT_TRUE(matcher.shouldExclude(tmp.path() + "/blacklisted")); + EXPECT_FALSE(matcher.shouldExclude(tmp.path() + "/a.txt")); +} \ No newline at end of file diff --git a/autotests/index/test_taskmanager.cpp b/autotests/index/test_taskmanager.cpp new file mode 100644 index 00000000..71cae96f --- /dev/null +++ b/autotests/index/test_taskmanager.cpp @@ -0,0 +1,369 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskmanager.cpp + * @brief Additional TaskManager tests: enqueueCompensationTask (empty/valid), + * applyDirectoryMovePlans (empty/no-directory-move/single-directory), + * onTaskProgress with null currentTask, startTask with empty pathList, + * startFileListTask with empty fileList, startFileMoveTask with empty + * move map — all early-return paths without spawning threads. + */ + +#include +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" +#include "state/indexstatestore.h" +#include "task/taskmanager.h" +#include "task/indextask.h" +#include "env/envdetector.h" +#include "utils/indexutility.h" + +#include "stubext.h" +#include + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +class TaskManagerTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + std::unique_ptr runtime; + TaskManager *mgr { nullptr }; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + runtime = std::make_unique( + IndexProfile({ IndexProfile::Type::Content, "tm13", "tm13_status.json", "tm13_ver", 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } })); + mgr = runtime->taskManager(); + ASSERT_NE(mgr, nullptr); + } +}; + +TEST_F(TaskManagerTest, EnqueueCompensationTaskEmptyPathsReturnsFalse) +{ + EXPECT_FALSE(mgr->enqueueCompensationTask({})); +} + +TEST_F(TaskManagerTest, EnqueueCompensationTaskWithPathsReturnsTrue) +{ + EXPECT_TRUE(mgr->enqueueCompensationTask({"/tmp/a.txt"})); + EXPECT_TRUE(mgr->hasQueuedTasks()); +} + +TEST_F(TaskManagerTest, ApplyDirectoryMovePlansEmptyReturnsEmpty) +{ + QHash empty; + QStringList result = mgr->applyDirectoryMovePlans(empty); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(TaskManagerTest, ApplyDirectoryMovePlansNonDirectoryReturnsEmpty) +{ + QHash moves { {"/old/file.txt", "/new/file.txt"} }; + QStringList result = mgr->applyDirectoryMovePlans(moves); + EXPECT_TRUE(result.isEmpty()); +} + +TEST_F(TaskManagerTest, ApplyDirectoryMovePlansDirectoryMove) +{ + QHash moves { {"/old/dir/", "/new/dir/"} }; + QStringList result = mgr->applyDirectoryMovePlans(moves); + // compensationPaths has at least /new/dir/ + EXPECT_GE(result.size(), 1); +} + +TEST_F(TaskManagerTest, OnTaskProgressWithNullTaskIsNoOp) +{ + EXPECT_NO_FATAL_FAILURE({ mgr->onTaskProgress(IndexTask::Type::Create, 10, 100); }); +} + +TEST_F(TaskManagerTest, StartTaskEmptyPathListReturnsFalse) +{ + // startTask(QString path) with empty path should fail + EXPECT_FALSE(mgr->startTask(IndexTask::Type::Create, QString())); +} + +TEST_F(TaskManagerTest, StartFileListTaskEmptyListReturnsFalse) +{ + EXPECT_FALSE(mgr->startFileListTask(IndexTask::Type::CreateFileList, QStringList())); +} + +TEST_F(TaskManagerTest, StartFileMoveTaskEmptyMovesReturnsFalse) +{ + QHash empty; + EXPECT_FALSE(mgr->startFileMoveTask(empty)); +} + +// =========================================================================== +// Filename profile: env policy exemption (design 3.2.2 / 变更 4) and +// updateInProgress lifecycle (design 变更 8). +// =========================================================================== + +class TaskManagerFilenameTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + std::unique_ptr runtime; + TaskManager *mgr { nullptr }; + stub_ext::StubExt stub; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + // Redirect Global::fileNameIndexDirectory to the temp dir so the + // filename-profile runtime does not touch the real $HOME index path. + stub.set_lamda(ADDR(Global, fileNameIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/fn-index"; + }); + stub.set_lamda(ADDR(Global, isFileNameIndexDirectoryAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInFileNameIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + // Stub content/ocr dirs too (filename blacklistProvider references them). + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/c-index"; + }); + stub.set_lamda(ADDR(Global, ocrTextIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/o-index"; + }); + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() }; + }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + stub.set_lamda(ADDR(Global, isFileNameIndexReadyForSearch), + []() -> bool { + __DBG_STUB_INVOKE__ + return false; + }); + // Stub AnythingConfigWatcher::defaultAnythingIndexPaths so + // IndexUtility::isDefaultIndexedDirectory(tmp.path()) returns true + // (startTask validates all paths are in the indexed-dir list). + stub.set_lamda(ADDR(IndexUtility::AnythingConfigWatcher, defaultAnythingIndexPaths), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() }; + }); + + // Use the real filename() factory — it wires the full policy (env exemption, + // 1s collection window, existing commit mechanism, 30s recovery delay, + // hidden-file indexing, blacklist). + runtime = std::make_unique(IndexProfile::filename()); + mgr = runtime->taskManager(); + ASSERT_NE(mgr, nullptr); + } +}; + +TEST_F(TaskManagerFilenameTest, CanRun_BypassesEnvChecksOnBattery) +{ + // Filename profile should be runnable even on battery (env-exempt) + EnvState batteryEnv { /*onBattery*/ true, /*powerSaveMode*/ true, /*idle*/ false }; + // Heavy grade would normally be blocked on battery; filename bypasses. + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Heavy, false, batteryEnv)); + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Medium, false, batteryEnv)); + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Light, false, batteryEnv)); +} + +TEST_F(TaskManagerFilenameTest, CanRun_BypassesEnvChecksWhenNotIdle) +{ + EnvState busyEnv { false, false, /*idle*/ false }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Heavy, false, busyEnv)); +} + +TEST_F(TaskManagerFilenameTest, CanRun_ManualGradeAlwaysRunnable) +{ + EnvState hostileEnv { true, true, false }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Manual, false, hostileEnv)); +} + +TEST_F(TaskManagerFilenameTest, StartUpdate_SetsUpdateInProgress) +{ + // Starting an Update task on the filename profile must persist updateInProgress=true + // (design 变更 8) so that isReady flips to false and search degrades to Realtime + // during the full-comparison scan. + ASSERT_FALSE(runtime->stateStore().isUpdateInProgress()); + // The temp dir is the "indexed directory"; startTask requires a path within scope. + // We avoid real traversal by not waiting for completion — the flag is set at start. + EXPECT_NO_FATAL_FAILURE({ (void)mgr->startTask(IndexTask::Type::Update, tmp.path()); }); + // Flag should be set regardless of whether the task actually started (queue/blocked). + // Give the worker a moment then stop to keep the test deterministic. + mgr->stopCurrentTask(); + EXPECT_TRUE(runtime->stateStore().isUpdateInProgress()) + << "Update task must set updateInProgress (design 变更 8)"; +} + +TEST_F(TaskManagerFilenameTest, StartCreate_DoesNotSetUpdateInProgress) +{ + // Create tasks set createInProgress, NOT updateInProgress (they are distinct windows) + ASSERT_FALSE(runtime->stateStore().isUpdateInProgress()); + EXPECT_NO_FATAL_FAILURE({ (void)mgr->startTask(IndexTask::Type::Create, tmp.path()); }); + mgr->stopCurrentTask(); + // updateInProgress should remain false for a Create task + EXPECT_FALSE(runtime->stateStore().isUpdateInProgress()); + // createInProgress should be true (existing behavior) + EXPECT_TRUE(runtime->stateStore().isCreateInProgress()); +} + +TEST_F(TaskManagerFilenameTest, StartFileListTask_DoesNotSetUpdateInProgress) +{ + // Ordinary event incremental tasks (UpdateFileList/MoveFileList) must NOT set + // updateInProgress — only full-comparison Update tasks do (design 变更 8 table). + ASSERT_FALSE(runtime->stateStore().isUpdateInProgress()); + QStringList files { tmp.path() + "/a.txt", tmp.path() + "/b.txt" }; + EXPECT_NO_FATAL_FAILURE({ (void)mgr->startFileListTask(IndexTask::Type::UpdateFileList, files); }); + mgr->stopCurrentTask(); + EXPECT_FALSE(runtime->stateStore().isUpdateInProgress()); +} + +TEST_F(TaskManagerFilenameTest, StartFileMoveTask_DoesNotSetUpdateInProgress) +{ + ASSERT_FALSE(runtime->stateStore().isUpdateInProgress()); + QHash moves { { tmp.path() + "/a.txt", tmp.path() + "/b.txt" } }; + EXPECT_NO_FATAL_FAILURE({ (void)mgr->startFileMoveTask(moves); }); + mgr->stopCurrentTask(); + EXPECT_FALSE(runtime->stateStore().isUpdateInProgress()); +} + +TEST_F(TaskManagerFilenameTest, RecoveryPendingLifecycle) +{ + // Verify the recoveryPending memory flag API used at startup (design 5.8). + EXPECT_FALSE(mgr->isRecoveryPending()); + mgr->setRecoveryPending(true); + EXPECT_TRUE(mgr->isRecoveryPending()); + mgr->setRecoveryPending(false); + EXPECT_FALSE(mgr->isRecoveryPending()); +} + +TEST_F(TaskManagerFilenameTest, CurrentIndexStatus_NoTaskNoQueue) +{ + // With no running/queued task, status reflects idle/pending-work state. + // Filename profile with a fresh (empty) state store → no lastUpdateTime → dbExists=false + // → heavy pending → "WaitingUpgrade". + QString status = mgr->currentIndexStatus(); + EXPECT_FALSE(status.isEmpty()); +} + +TEST_F(TaskManagerFilenameTest, StartupResetsStaleUpdateInProgressOnCleanState) +{ + // Reproduce the stale-flag path: an Update task failed/interrupted, then an + // ordinary incremental task succeeded and set Clean without clearing + // updateInProgress. On next startup TaskManager must defensively reset the + // flag — otherwise startup detection sees Clean, recovery is skipped, and + // search stays degraded to Realtime forever. + { + IndexStateStore store(IndexProfile::filename()); + store.saveLastUpdateTime(QDateTime::currentDateTime()); + store.setIndexState(IndexUtility::IndexState::Clean); + store.setUpdateInProgress(true); + ASSERT_TRUE(store.isUpdateInProgress()); + ASSERT_EQ(store.getIndexState(), IndexUtility::IndexState::Clean); + } + + runtime.reset(); // release the old runtime (stops its worker thread) + runtime = std::make_unique(IndexProfile::filename()); + EXPECT_FALSE(runtime->stateStore().isUpdateInProgress()) + << "Stale updateInProgress on clean state must be reset at startup"; + EXPECT_EQ(runtime->stateStore().getIndexState(), IndexUtility::IndexState::Clean); +} + +TEST_F(TaskManagerFilenameTest, StartupKeepsUpdateInProgressOnDirtyState) +{ + // dirty + updateInProgress is the legitimate crash-recovery state: the flag + // must survive startup so the pending recovery Update keeps covering the + // degraded-search window until it succeeds. + { + IndexStateStore store(IndexProfile::filename()); + store.saveLastUpdateTime(QDateTime::currentDateTime()); + store.setIndexState(IndexUtility::IndexState::Dirty); + store.setUpdateInProgress(true); + ASSERT_TRUE(store.isUpdateInProgress()); + ASSERT_EQ(store.getIndexState(), IndexUtility::IndexState::Dirty); + } + + runtime.reset(); + runtime = std::make_unique(IndexProfile::filename()); + EXPECT_TRUE(runtime->stateStore().isUpdateInProgress()) + << "dirty + updateInProgress must be kept for recovery"; + EXPECT_EQ(runtime->stateStore().getIndexState(), IndexUtility::IndexState::Dirty); +} + +TEST_F(TaskManagerFilenameTest, BurstAccumulationTriggersBacklogExceeded) +{ + // 设计 5.7.4：大突发（静默期内累计 ≥ 5000 文件）必须置位 backlogExceeded， + // 即使每个 1s 收集窗口的批次都远小于阈值（波间排空、task 层瞬时积压恒低）。 + // 屏蔽 DConfig::create：本机 dconfig 可能配置了 pending_events_trigger_updating + // 覆盖值，置空后 FilenameBacklogTracker::threshold() 回落代码默认值 5000， + // 测试不依赖机器配置。 + stub_ext::StubExt backlogStub; + backlogStub.set_lamda(static_cast(&Dtk::Core::DConfig::create), + [](const QString &, const QString &, const QString &, QObject *) -> Dtk::Core::DConfig * { + __DBG_STUB_INVOKE__ + return nullptr; + }); + + ASSERT_FALSE(runtime->stateStore().isBacklogExceeded()); + + constexpr int kBatchSize = 1000; + for (int i = 0; i < 5; ++i) { + QStringList batch; + batch.reserve(kBatchSize); + for (int j = 0; j < kBatchSize; ++j) + batch.append(tmp.path() + QString("/burst%1_%2.txt").arg(i).arg(j)); + EXPECT_TRUE(mgr->enqueueCompensationTask(batch)); + + if (i < 4) { + EXPECT_FALSE(runtime->stateStore().isBacklogExceeded()) + << "must not trigger below threshold at batch " << i; + } + } + + EXPECT_TRUE(runtime->stateStore().isBacklogExceeded()) + << "cumulative burst >= 5000 must trigger degradation"; +} + +TEST_F(TaskManagerFilenameTest, SmallBurstDoesNotTriggerBacklogExceeded) +{ + // 小批量（远低于阈值）不应触发降级——普通小变化保持索引搜索。 + ASSERT_FALSE(runtime->stateStore().isBacklogExceeded()); + + QStringList batch; + batch.reserve(1000); + for (int j = 0; j < 1000; ++j) + batch.append(tmp.path() + QString("/small%1.txt").arg(j)); + EXPECT_TRUE(mgr->enqueueCompensationTask(batch)); + + EXPECT_FALSE(runtime->stateStore().isBacklogExceeded()); +} diff --git a/autotests/index/test_taskmanager_grading.cpp b/autotests/index/test_taskmanager_grading.cpp new file mode 100644 index 00000000..0341e192 --- /dev/null +++ b/autotests/index/test_taskmanager_grading.cpp @@ -0,0 +1,752 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskmanager_grading.cpp + * @brief Unit tests for the core scheduling business logic of TaskManager: + * canRun() (grade×environment matrix), gradeFileListTask() (threshold + * boundaries), currentIndexStatus() (status string generation), + * gradePriority(), gradeToString(). + * + * These tests verify the decision logic that maps task grades and + * environment states to run/queue/preempt decisions, covering + * acceptance criteria AC-020 ~ AC-040 from the strategy-optimization + * requirements document. + * + * Private members are accessed directly (the test build uses + * -fno-access-control). EnvDetector is a singleton whose m_state + * can be set directly to simulate different environment conditions. + */ + +#include +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" +#include "task/taskmanager.h" +#include "task/indextask.h" +#include "env/envdetector.h" +#include "utils/indexutility.h" +#include "utils/textindexconfig.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +// --------------------------------------------------------------------------- +// Fixture – creates a Content-profile runtime in a temp directory. +// --------------------------------------------------------------------------- + +class TaskManagerGradingTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + std::unique_ptr runtime; + TaskManager *mgr { nullptr }; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + runtime = std::make_unique( + IndexProfile({ IndexProfile::Type::Content, "grade", "grade_status.json", "grade_ver", 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } })); + mgr = runtime->taskManager(); + ASSERT_NE(mgr, nullptr); + + // Reset EnvDetector singleton to a clean default state before each test. + EnvDetector::instance().m_state = EnvState {}; + } + + void TearDown() override + { + EnvDetector::instance().m_state = EnvState {}; + } + + /// Helper: create a sparse temp file of the given size in bytes. + QString createTempFile(qint64 sizeBytes) + { + auto *f = new QTemporaryFile(); + f->setAutoRemove(false); + f->open(); + if (sizeBytes > 0) + f->resize(sizeBytes); + f->close(); + QString path = f->fileName(); + delete f; + return path; + } +}; + +// =========================================================================== +// canRun() – the grade × environment decision matrix +// Light: continues on battery, pauses on power-save, no idle requirement +// Medium: pauses on battery, pauses on power-save, requires idle +// Heavy: pauses on battery, pauses on power-save, requires idle +// Manual: bypasses all environment checks +// forceBypass: bypasses all environment checks +// =========================================================================== + +TEST_F(TaskManagerGradingTest, CanRun_Light_OnAc_NoPowersave_NoIdleRequirement) +{ + EnvState env { false, false, false }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Light, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Light_OnBattery_Continues) +{ + EnvState env { true, false, false }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Light, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Light_PowerSave_Pauses) +{ + EnvState env { false, true, false }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Light, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Light_DoesNotRequireIdle) +{ + EnvState env { false, false, false }; // idle = false + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Light, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Light_BatteryAndPowerSave_Pauses) +{ + EnvState env { true, true, false }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Light, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Medium_OnAc_NoPowersave_Idle_Runs) +{ + EnvState env { false, false, true }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Medium, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Medium_OnBattery_Pauses) +{ + EnvState env { true, false, true }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Medium, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Medium_PowerSave_Pauses) +{ + EnvState env { false, true, true }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Medium, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Medium_NotIdle_Pauses) +{ + EnvState env { false, false, false }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Medium, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Heavy_OnAc_NoPowersave_Idle_Runs) +{ + EnvState env { false, false, true }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Heavy, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Heavy_OnBattery_Pauses) +{ + EnvState env { true, false, true }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Heavy, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Heavy_PowerSave_Pauses) +{ + EnvState env { false, true, true }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Heavy, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Heavy_NotIdle_Pauses) +{ + EnvState env { false, false, false }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Heavy, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Manual_PowerSave_Pauses) +{ + EnvState env { true, true, false }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::Manual, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Manual_NoPowerSave_Runs) +{ + EnvState env { true, false, false }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Manual, false, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_Manual_ForceBypass_BypassesAll) +{ + EnvState env { true, true, false }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Manual, true, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_ForceBypass_BypassesAll) +{ + EnvState env { true, true, false }; + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Heavy, true, env)); + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Medium, true, env)); + EXPECT_TRUE(mgr->canRun(IndexTask::Grade::Light, true, env)); +} + +TEST_F(TaskManagerGradingTest, CanRun_NoneGrade_NeverRuns) +{ + EnvState env { false, false, true }; + EXPECT_FALSE(mgr->canRun(IndexTask::Grade::None, false, env)); +} + +// =========================================================================== +// gradeFileListTask() – threshold boundary testing +// Text profile: count threshold = 100, size threshold = 200 MB +// OCR profile: count threshold = 30 +// Either count > threshold OR size > threshold → Medium +// =========================================================================== + +TEST_F(TaskManagerGradingTest, GradeFileList_SingleFile_Light) +{ + QStringList files { "/tmp/single.txt" }; + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Light); +} + +TEST_F(TaskManagerGradingTest, GradeFileList_AtCountThreshold_Light) +{ + // Exactly 100 files (text threshold) → Light, not Medium (boundary) + QStringList files; + for (int i = 0; i < 100; ++i) + files << QString("/tmp/file_%1.txt").arg(i); + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Light); +} + +TEST_F(TaskManagerGradingTest, GradeFileList_AboveCountThreshold_Medium) +{ + // 101 files → Medium + QStringList files; + for (int i = 0; i < 101; ++i) + files << QString("/tmp/file_%1.txt").arg(i); + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Medium); +} + +TEST_F(TaskManagerGradingTest, GradeFileList_SizeOverThreshold_Medium) +{ + // Few files but total size > 200 MB → Medium + // Create a real 201 MB temp file (sparse — seek + write 1 byte) + QString bigFile = createTempFile(201 * 1024 * 1024); + QStringList files { bigFile }; + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Medium); + QFile::remove(bigFile); +} + +TEST_F(TaskManagerGradingTest, GradeFileList_SizeAtThreshold_Light) +{ + // Total size exactly at 200 MB → Light (boundary, not exceeding) + QString file200MB = createTempFile(200 * 1024 * 1024); + QStringList files { file200MB }; + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Light); + QFile::remove(file200MB); +} + +TEST_F(TaskManagerGradingTest, GradeFileList_AnyConditionOver_Medium) +{ + // 99 files (under count threshold) but one big file pushes size over → Medium + QStringList files; + for (int i = 0; i < 99; ++i) + files << QString("/tmp/small_%1.txt").arg(i); + QString bigFile = createTempFile(201 * 1024 * 1024); + files << bigFile; + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Medium); + QFile::remove(bigFile); +} + +TEST_F(TaskManagerGradingTest, GradeFileList_RemoveFileList_AlwaysLight) +{ + // RemoveFileList type should always be Light regardless of count + QStringList files; + for (int i = 0; i < 500; ++i) + files << QString("/tmp/del_%1.txt").arg(i); + // The caller (startFileListTask) forces Light for RemoveFileList; + // gradeFileListTask itself still grades by thresholds, but the caller + // overrides. Here we test the raw grading function's behavior. + // With 500 files, raw grading returns Medium: + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Medium); +} + +// =========================================================================== +// gradeFileListTask() – OCR profile thresholds +// =========================================================================== + +class TaskManagerGradingOcrTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + std::unique_ptr runtime; + TaskManager *mgr { nullptr }; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + // 与 IndexProfile::ocr() 工厂一致：通过 profile 声明 Light 分级阈值 + // （函数式 provider），分级逻辑不再感知具体 profile 类型 + runtime = std::make_unique( + IndexProfile({ IndexProfile::Type::Ocr, "ocr_grade", "ocr_grade_status.json", "ocr_grade_ver", 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }, + IndexProfile::RuntimePolicy{}, IndexProfile::FilterPolicy{}, + { IndexProfile::MoveUpdatePolicy::UpdatePathOnly, true, + []() -> int { return TextIndexConfig::instance().lightIncrementOcrFileCountThreshold(); } })); + mgr = runtime->taskManager(); + ASSERT_NE(mgr, nullptr); + } + + QString createTempFile(qint64 sizeBytes) + { + auto *f = new QTemporaryFile(); + f->setAutoRemove(false); + f->open(); + if (sizeBytes > 0) + f->resize(sizeBytes); + f->close(); + QString path = f->fileName(); + delete f; + return path; + } +}; + +TEST_F(TaskManagerGradingOcrTest, GradeFileList_OcrAtThreshold_Light) +{ + // OCR threshold = 30; exactly 30 files → Light + QStringList files; + for (int i = 0; i < 30; ++i) + files << QString("/tmp/ocr_%1.png").arg(i); + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Light); +} + +TEST_F(TaskManagerGradingOcrTest, GradeFileList_OcrAboveThreshold_Medium) +{ + // 31 files → Medium + QStringList files; + for (int i = 0; i < 31; ++i) + files << QString("/tmp/ocr_%1.png").arg(i); + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Medium); +} + +TEST_F(TaskManagerGradingOcrTest, GradeFileList_OcrSizeOverThreshold_Medium) +{ + QString bigFile = createTempFile(201 * 1024 * 1024); + QStringList files { bigFile }; + EXPECT_EQ(mgr->gradeFileListTask(files), IndexTask::Grade::Medium); + QFile::remove(bigFile); +} + +// =========================================================================== +// currentIndexStatus() – status string generation +// =========================================================================== + +TEST_F(TaskManagerGradingTest, Status_NoTaskNoQueue_CleanState_Idle) +{ + // Set index state to Clean with matching version → "Idle" + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + EXPECT_EQ(mgr->currentIndexStatus(), QString("Idle")); +} + +TEST_F(TaskManagerGradingTest, Status_LastTaskFailed_Failed) +{ + mgr->m_lastTaskFailed = true; + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EXPECT_EQ(mgr->currentIndexStatus(), QString("Failed")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedMedium_Battery_WaitingPower) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { true, false, false }; // on battery + + TaskQueueItem item; + item.type = IndexTask::Type::Update; + item.grade = IndexTask::Grade::Medium; + item.path = tmp.path(); + item.pathList = QStringList { tmp.path() }; + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingPower")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedHeavy_Battery_WaitingPower) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { true, false, false }; + + TaskQueueItem item; + item.type = IndexTask::Type::Create; + item.grade = IndexTask::Grade::Heavy; + item.path = tmp.path(); + item.pathList = QStringList { tmp.path() }; + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingPower")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedLight_Battery_Running) +{ + // Light tasks can run on battery, so queued Light on battery → "Running" + // (canRun returns true, so the status logic reports Running) + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { true, false, false }; + + TaskQueueItem item; + item.type = IndexTask::Type::UpdateFileList; + item.grade = IndexTask::Grade::Light; + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("Running")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedMedium_PowerSave_WaitingPowerSave) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { false, true, false }; + + TaskQueueItem item; + item.type = IndexTask::Type::Update; + item.grade = IndexTask::Grade::Medium; + item.path = tmp.path(); + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingPowerSave")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedLight_PowerSave_WaitingPowerSave) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { false, true, false }; + + TaskQueueItem item; + item.type = IndexTask::Type::UpdateFileList; + item.grade = IndexTask::Grade::Light; + mgr->taskQueue.enqueue(item); + + // Light also pauses on power-save + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingPowerSave")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedMedium_NotIdle_WaitingIdle) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { false, false, false }; // not idle + + TaskQueueItem item; + item.type = IndexTask::Type::Update; + item.grade = IndexTask::Grade::Medium; + item.path = tmp.path(); + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingIdle")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedHeavy_NotIdle_WaitingIdle) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { false, false, false }; + + TaskQueueItem item; + item.type = IndexTask::Type::Create; + item.grade = IndexTask::Grade::Heavy; + item.path = tmp.path(); + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingIdle")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedLight_NotIdle_Running) +{ + // Light does not require idle → canRun returns true → "Running" + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { false, false, false }; + + TaskQueueItem item; + item.type = IndexTask::Type::UpdateFileList; + item.grade = IndexTask::Grade::Light; + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("Running")); +} + +TEST_F(TaskManagerGradingTest, Status_QueuedForceBypass_AnyEnvironment_Running) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EnvDetector::instance().m_state = EnvState { true, true, false }; + + TaskQueueItem item; + item.type = IndexTask::Type::Update; + item.grade = IndexTask::Grade::Heavy; + item.forceBypass = true; + item.path = tmp.path(); + mgr->taskQueue.enqueue(item); + + EXPECT_EQ(mgr->currentIndexStatus(), QString("Running")); +} + +// =========================================================================== +// gradePriority() – priority ordering +// =========================================================================== + +TEST_F(TaskManagerGradingTest, GradePriority_Manual_Highest) +{ + EXPECT_EQ(mgr->gradePriority(IndexTask::Grade::Manual), 4); +} + +TEST_F(TaskManagerGradingTest, GradePriority_Heavy) +{ + EXPECT_EQ(mgr->gradePriority(IndexTask::Grade::Heavy), 3); +} + +TEST_F(TaskManagerGradingTest, GradePriority_Medium) +{ + EXPECT_EQ(mgr->gradePriority(IndexTask::Grade::Medium), 2); +} + +TEST_F(TaskManagerGradingTest, GradePriority_Light_LowestNonZero) +{ + EXPECT_EQ(mgr->gradePriority(IndexTask::Grade::Light), 1); +} + +TEST_F(TaskManagerGradingTest, GradePriority_None_Zero) +{ + EXPECT_EQ(mgr->gradePriority(IndexTask::Grade::None), 0); +} + +// =========================================================================== +// gradeToString() – string mapping +// =========================================================================== + +TEST_F(TaskManagerGradingTest, GradeToString_AllGrades) +{ + EXPECT_EQ(mgr->gradeToString(IndexTask::Grade::None), QString("none")); + EXPECT_EQ(mgr->gradeToString(IndexTask::Grade::Light), QString("light")); + EXPECT_EQ(mgr->gradeToString(IndexTask::Grade::Medium), QString("medium")); + EXPECT_EQ(mgr->gradeToString(IndexTask::Grade::Heavy), QString("heavy")); + EXPECT_EQ(mgr->gradeToString(IndexTask::Grade::Manual), QString("manual")); +} + +// =========================================================================== +// gradeUpdateTask() – Update task auto-grading +// =========================================================================== + +TEST_F(TaskManagerGradingTest, GradeUpdate_CleanState_Light) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + EXPECT_EQ(mgr->gradeUpdateTask(), IndexTask::Grade::Light); +} + +TEST_F(TaskManagerGradingTest, GradeUpdate_CreateInProgress_Heavy) +{ + // When create is in progress, Update should be graded Heavy to resume + runtime->stateStore().setCreateInProgress(true); + EXPECT_EQ(mgr->gradeUpdateTask(), IndexTask::Grade::Heavy); +} + +TEST_F(TaskManagerGradingTest, GradeUpdate_DirtyState_Light) +{ + // Dirty state (not create in progress) → Light + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + EXPECT_EQ(mgr->gradeUpdateTask(), IndexTask::Grade::Light); +} + +// =========================================================================== +// currentIndexStatus() – no task, dirty index, bad environment +// +// Two sub-scenarios depending on whether the index DB actually exists: +// +// A) DB doesn't exist (fresh temp dir, no status file) → Heavy +// Heavy requires !onBattery, !powerSaveMode, idle — all three checked. +// +// B) DB exists, dirty, not CreateInProgress → Light (开机全盘扫描对比) +// Light only requires !powerSaveMode — idle is NOT checked. +// This is the user's actual scenario: startup with dirty index should +// NOT show WaitingIdle because the update task is Light. +// =========================================================================== + +// --- Sub-scenario A: DB doesn't exist → Heavy → always WaitingUpgrade --- + +TEST_F(TaskManagerGradingTest, Status_NoTaskNoDB_GoodEnv_WaitingUpgrade) +{ + // Fresh temp dir: no status file → state is Unknown (not Clean), no DB → Heavy. + // Heavy always shows WaitingUpgrade during the update interval. + EnvDetector::instance().m_state = EnvState { false, false, true }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTaskNoDB_NotIdle_WaitingUpgrade) +{ + // No DB → Heavy. Not idle, but during interval → WaitingUpgrade. + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTaskNoDB_Battery_WaitingUpgrade) +{ + // No DB → Heavy. On battery, but during interval → WaitingUpgrade. + EnvDetector::instance().m_state = EnvState { true, false, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTaskNoDB_PowerSave_WaitingUpgrade) +{ + // No DB → Heavy. Power save, but during interval → WaitingUpgrade. + EnvDetector::instance().m_state = EnvState { false, true, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_DirtyNoDB_GoodEnv_WaitingUpgrade) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + EnvDetector::instance().m_state = EnvState { false, false, true }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +// --- Sub-scenario B: DB exists, dirty, not CreateInProgress → Light --- +// Light shows "Idle" (completed) to the user — pending changes will be +// silently updated when the timer fires. Only power-save blocks Light. + +TEST_F(TaskManagerGradingTest, Status_NoTask_DirtyDB_NotIdle_Idle) +{ + // DB exists, dirty, Light → environment OK (not powerSave) → Idle. + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + EnvDetector::instance().m_state = EnvState { false, false, false }; // not idle + EXPECT_EQ(mgr->currentIndexStatus(), QString("Idle")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_DirtyDB_OnBattery_Idle) +{ + // DB exists, dirty, Light → can run on battery → Idle. + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + EnvDetector::instance().m_state = EnvState { true, false, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("Idle")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_DirtyDB_PowerSave_WaitingPowerSave) +{ + // DB exists, dirty, Light → only blocked by powerSave. + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + EnvDetector::instance().m_state = EnvState { false, true, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingPowerSave")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_DirtyDB_GoodEnv_Idle) +{ + // DB exists, dirty, Light → all good → Idle (will silently update). + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + EnvDetector::instance().m_state = EnvState { false, false, true }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("Idle")); +} + +// --- Sub-scenario C: DB exists, dirty, CreateInProgress → Heavy --- +// Heavy always shows WaitingUpgrade during the interval. + +TEST_F(TaskManagerGradingTest, Status_NoTask_DirtyDB_CreateInProgress_WaitingUpgrade) +{ + // DB exists, dirty, CreateInProgress → Heavy → WaitingUpgrade. + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + runtime->stateStore().setCreateInProgress(true); + EnvDetector::instance().m_state = EnvState { true, false, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_DirtyDB_CreateInProgress_NotIdle_WaitingUpgrade) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + runtime->stateStore().setCreateInProgress(true); + EnvDetector::instance().m_state = EnvState { false, false, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_CleanIndex_Battery_Idle) +{ + // Clean index with matching version, no task, on battery → Idle (nothing to do) + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + EnvDetector::instance().m_state = EnvState { true, false, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("Idle")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_CleanIndex_PowerSave_Idle) +{ + // Clean index with matching version, no task, power-save → Idle (nothing to do) + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime()); + EnvDetector::instance().m_state = EnvState { false, true, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("Idle")); +} + +// --- Sub-scenario D: Clean state but version mismatch → Heavy → WaitingUpgrade --- +// When the index version is upgraded, the old status.json may still say +// "clean" with an old version number. Before silentStart fires, the status +// should show "WaitingUpgrade", not "Idle". + +TEST_F(TaskManagerGradingTest, Status_NoTask_CleanState_VersionMismatch_WaitingUpgrade) +{ + // Clean state but with an old version (0 instead of runtime version 1) + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime(), 0); + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_CleanState_VersionMismatch_Battery_WaitingUpgrade) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime(), 0); + EnvDetector::instance().m_state = EnvState { true, false, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +TEST_F(TaskManagerGradingTest, Status_NoTask_CleanState_VersionMismatch_PowerSave_WaitingUpgrade) +{ + runtime->stateStore().setIndexState(IndexUtility::IndexState::Clean); + runtime->stateStore().saveIndexStatus(QDateTime::currentDateTime(), 0); + EnvDetector::instance().m_state = EnvState { false, true, false }; + EXPECT_EQ(mgr->currentIndexStatus(), QString("WaitingUpgrade")); +} + +// =========================================================================== +// currentOrQueuedGrade() – grade from running task or queue head +// =========================================================================== + +TEST_F(TaskManagerGradingTest, CurrentOrQueuedGrade_NoTaskNoQueue_Nullopt) +{ + EXPECT_FALSE(mgr->currentOrQueuedGrade().has_value()); +} + +TEST_F(TaskManagerGradingTest, CurrentOrQueuedGrade_QueuedTask_ReturnsQueueHeadGrade) +{ + TaskQueueItem item; + item.type = IndexTask::Type::Update; + item.grade = IndexTask::Grade::Heavy; + item.path = tmp.path(); + mgr->taskQueue.enqueue(item); + EXPECT_EQ(mgr->currentOrQueuedGrade().value(), IndexTask::Grade::Heavy); +} + +TEST_F(TaskManagerGradingTest, CurrentOrQueuedGrade_QueuedLight_ReturnsLight) +{ + TaskQueueItem item; + item.type = IndexTask::Type::UpdateFileList; + item.grade = IndexTask::Grade::Light; + mgr->taskQueue.enqueue(item); + EXPECT_EQ(mgr->currentOrQueuedGrade().value(), IndexTask::Grade::Light); +} diff --git a/autotests/index/test_taskmanager_private.cpp b/autotests/index/test_taskmanager_private.cpp new file mode 100644 index 00000000..e4d3b87d --- /dev/null +++ b/autotests/index/test_taskmanager_private.cpp @@ -0,0 +1,192 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskmanager_private.cpp + * @brief Additional TaskManager tests covering onTaskFinished, + * handleCorruptedIndex, handleRootPathFailure, updateIndexStatusOnSuccess, + * finalizeIndexState, enqueueCompensationTask, and + * startTask/StartFileListTask/StartFileMoveTask with additional paths. + */ + +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" +#include "task/taskmanager.h" +#include "task/indextask.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class TaskManagerPrivateTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + std::unique_ptr runtime; + TaskManager *mgr { nullptr }; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + runtime = std::make_unique( + IndexProfile({ IndexProfile::Type::Content, "tm_priv", "tm_priv_status.json", "tm_priv_ver", 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } })); + mgr = runtime->taskManager(); + ASSERT_NE(mgr, nullptr); + } +}; + +// ---- enqueueCompensationTask ---- +TEST_F(TaskManagerPrivateTest, EnqueueCompensationTask) +{ + EXPECT_TRUE(mgr->enqueueCompensationTask({ "/tmp/a.txt" })); + EXPECT_TRUE(mgr->hasQueuedTasks()); +} + +// ---- startTask with QStringList ---- +TEST_F(TaskManagerPrivateTest, StartTask_MultiplePaths) +{ + bool result = mgr->startTask(IndexTask::Type::Create, QStringList{ tmp.path() }); + // May succeed or fail depending on runtime, but no crash + SUCCEED(); +} + +TEST_F(TaskManagerPrivateTest, StartTask_Create) +{ + bool result = mgr->startTask(IndexTask::Type::Create, tmp.path()); + SUCCEED(); +} + +TEST_F(TaskManagerPrivateTest, StartTask_UpdateType) +{ + bool result = mgr->startTask(IndexTask::Type::Update, tmp.path()); + SUCCEED(); +} + +// ---- startFileListTask with actual files ---- +TEST_F(TaskManagerPrivateTest, StartFileListTask_SingleFile) +{ + bool result = mgr->startFileListTask(IndexTask::Type::CreateFileList, QStringList{ "/tmp/a.txt" }); + SUCCEED(); +} + +TEST_F(TaskManagerPrivateTest, StartFileListTask_UpdateFileList) +{ + bool result = mgr->startFileListTask(IndexTask::Type::UpdateFileList, QStringList{ "/tmp/a.txt" }); + SUCCEED(); +} + +TEST_F(TaskManagerPrivateTest, StartFileListTask_RemoveFileList) +{ + bool result = mgr->startFileListTask(IndexTask::Type::RemoveFileList, QStringList{ "/tmp/a.txt" }); + SUCCEED(); +} + +// ---- startFileMoveTask with actual moves ---- +TEST_F(TaskManagerPrivateTest, StartFileMoveTask_SingleMove) +{ + QHash moves; + moves["/old.txt"] = "/new.txt"; + bool result = mgr->startFileMoveTask(moves); + SUCCEED(); +} + +// ---- onTaskFinished with null current task ---- +TEST_F(TaskManagerPrivateTest, OnTaskFinished_NoCurrentTask) +{ + EXPECT_NO_FATAL_FAILURE({ mgr->onTaskProgress(IndexTask::Type::Create, 10, 100); }); +} + +// ---- applyDirectoryMovePlans with directory move ---- +TEST_F(TaskManagerPrivateTest, ApplyDirectoryMovePlans_MultipleDirectoryMoves) +{ + QHash moves { + { "/old/dir1/", "/new/dir1/" }, + { "/old/dir2/", "/new/dir2/" } + }; + QStringList result = mgr->applyDirectoryMovePlans(moves); + EXPECT_GE(result.size(), 2); +} + +// ---- Multiple enqueue then schedule ---- +TEST_F(TaskManagerPrivateTest, MultipleEnqueueThenSchedule) +{ + mgr->enqueueCompensationTask({ "/tmp/x.txt" }); + mgr->enqueueCompensationTask({ "/tmp/y.txt" }); + // Queue has items, schedule should try to run one + // But without a valid index directory, it may fail gracefully + EXPECT_NO_FATAL_FAILURE({ mgr->schedule(); }); +} + +// ---- cleanupTask ---- +TEST_F(TaskManagerPrivateTest, CleanupTask) +{ + EXPECT_NO_FATAL_FAILURE({ mgr->cleanupTask(); }); +} + +// ---- handleCorruptedIndex via private access --- +TEST_F(TaskManagerPrivateTest, HandleCorruptedIndex_EarlyReturnSuccess) +{ + // When result.success is true, handleCorruptedIndex returns early (no crash) + HandlerResult result; + result.success = true; + EXPECT_NO_FATAL_FAILURE({ + mgr->handleCorruptedIndex(IndexTask::Type::Update, result, tmp.path()); + }); +} + +TEST_F(TaskManagerPrivateTest, HandleCorruptedIndex_NonCreateUpdate) +{ + // Non-Update type returns early without accessing currentTask + HandlerResult result; + result.fatal = true; + EXPECT_NO_FATAL_FAILURE({ + mgr->handleCorruptedIndex(IndexTask::Type::UpdateFileList, result, tmp.path()); + }); +} + +// ---- handleRootPathFailure ---- +TEST_F(TaskManagerPrivateTest, HandleRootPathFailure_SuccessNotInterrupted) +{ + EXPECT_NO_FATAL_FAILURE({ + mgr->handleRootPathFailure(true, false, tmp.path()); + }); +} + +TEST_F(TaskManagerPrivateTest, HandleRootPathFailure_Failed) +{ + EXPECT_NO_FATAL_FAILURE({ + mgr->handleRootPathFailure(false, false, tmp.path()); + }); +} + +// ---- updateIndexStatusOnSuccess ---- +TEST_F(TaskManagerPrivateTest, UpdateIndexStatusOnSuccess) +{ + HandlerResult result; + result.indexChanged = true; + EXPECT_NO_FATAL_FAILURE({ + mgr->updateIndexStatusOnSuccess(IndexTask::Type::Create, result); + }); +} + +// ---- finalizeIndexState ---- +TEST_F(TaskManagerPrivateTest, FinalizeIndexState) +{ + HandlerResult result; + result.success = true; + result.interrupted = false; + EXPECT_NO_FATAL_FAILURE({ + mgr->finalizeIndexState(IndexTask::Type::Create, result); + }); +} diff --git a/autotests/index/test_taskmanager_safe.cpp b/autotests/index/test_taskmanager_safe.cpp new file mode 100644 index 00000000..9ba6f063 --- /dev/null +++ b/autotests/index/test_taskmanager_safe.cpp @@ -0,0 +1,124 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskmanager_safe.cpp + * @brief Unit tests for TaskManager (task/taskmanager.cpp) — the safe, + * dependency-light subset: query accessors, recovery flag, queue + * inspection, task lifecycle no-ops and the handler/toString helpers. + * Heavy start-task / DBus paths are intentionally avoided. + * + * Private members are accessed directly (the test build uses + * -fno-access-control). + */ + +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "profile/indexprofile.h" +#include "core/indexruntime.h" +#include "task/taskmanager.h" +#include "task/indextask.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +class TaskManagerSafeTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + + IndexProfile makeProfile() + { + return IndexProfile({ IndexProfile::Type::Content, + "tm_test", + "tm_status.json", + "tm_version", + 1 }, + { [this]() -> QString { return tmp.path(); }, + []() -> bool { return true; }, + [](const QString &) -> bool { return true; }, + [](const QString &) -> bool { return true; } }); + } + + std::unique_ptr runtime; + TaskManager *mgr { nullptr }; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + runtime = std::make_unique(makeProfile()); + mgr = runtime->taskManager(); + ASSERT_NE(mgr, nullptr); + } +}; + +TEST_F(TaskManagerSafeTest, NoRunningOrQueuedTaskByDefault) +{ + EXPECT_FALSE(mgr->hasRunningTask()); + EXPECT_FALSE(mgr->hasQueuedTasks()); +} + +TEST_F(TaskManagerSafeTest, CurrentTaskTypeAndPathAreNullopt) +{ + EXPECT_FALSE(mgr->currentTaskType().has_value()); + EXPECT_FALSE(mgr->currentTaskPath().has_value()); +} + +TEST_F(TaskManagerSafeTest, StopCurrentTaskAndCleanupAreNoOps) +{ + EXPECT_NO_FATAL_FAILURE({ mgr->stopCurrentTask(); }); + EXPECT_NO_FATAL_FAILURE({ mgr->cleanupTask(); }); // private +} + +TEST_F(TaskManagerSafeTest, ScheduleOnEmptyQueueIsNoOp) +{ + EXPECT_NO_FATAL_FAILURE({ mgr->schedule(); }); // private +} + +TEST_F(TaskManagerSafeTest, RecoveryFlagRoundtrip) +{ + EXPECT_FALSE(mgr->isRecoveryPending()); + mgr->setRecoveryPending(true); + EXPECT_TRUE(mgr->isRecoveryPending()); + mgr->setRecoveryPending(false); + EXPECT_FALSE(mgr->isRecoveryPending()); +} + +TEST_F(TaskManagerSafeTest, GetTaskHandlerReturnsNonNullForCreateAndUpdate) +{ + EXPECT_NE(mgr->getTaskHandler(IndexTask::Type::Create), nullptr); // private + EXPECT_NE(mgr->getTaskHandler(IndexTask::Type::Update), nullptr); // private +} + +TEST_F(TaskManagerSafeTest, GetTaskHandlerReturnsNullForUnknownType) +{ + // A type outside the handled enum range returns nullptr. + EXPECT_EQ(mgr->getTaskHandler(static_cast(999)), nullptr); // private +} + +TEST_F(TaskManagerSafeTest, TypeToStringCoversAllKnownTypes) +{ + EXPECT_EQ(mgr->typeToString(IndexTask::Type::Create), QString("create")); + EXPECT_EQ(mgr->typeToString(IndexTask::Type::Update), QString("update")); + EXPECT_EQ(mgr->typeToString(IndexTask::Type::CreateFileList), QString("create-file-list")); + EXPECT_EQ(mgr->typeToString(IndexTask::Type::UpdateFileList), QString("update-file-list")); + EXPECT_EQ(mgr->typeToString(IndexTask::Type::RemoveFileList), QString("remove-file-list")); + EXPECT_EQ(mgr->typeToString(IndexTask::Type::MoveFileList), QString("move-file-list")); + EXPECT_EQ(mgr->typeToString(static_cast(999)), QString("unknown")); +} + +TEST_F(TaskManagerSafeTest, IsFullScanTaskClassification) +{ + EXPECT_TRUE(mgr->isFullScanTask(IndexTask::Type::Create)); + EXPECT_TRUE(mgr->isFullScanTask(IndexTask::Type::Update)); + EXPECT_FALSE(mgr->isFullScanTask(IndexTask::Type::CreateFileList)); + EXPECT_FALSE(mgr->isFullScanTask(IndexTask::Type::UpdateFileList)); + EXPECT_FALSE(mgr->isFullScanTask(IndexTask::Type::RemoveFileList)); + EXPECT_FALSE(mgr->isFullScanTask(IndexTask::Type::MoveFileList)); +} diff --git a/autotests/index/test_taskqueueutils.cpp b/autotests/index/test_taskqueueutils.cpp new file mode 100644 index 00000000..b25ead22 --- /dev/null +++ b/autotests/index/test_taskqueueutils.cpp @@ -0,0 +1,98 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_taskqueueutils.cpp + * @brief Unit tests for TaskQueueUtils (task/taskqueueutils.cpp) — pure path + * rewrite logic: buildDirectoryMovePlans and rewriteQueuedTasksForDirectory + * Move (empty-queue early return + real rewrite). Also exercises + * PathCalculator helpers indirectly. + */ + +#include +#include +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "task/taskqueueutils.h" +#include "task/taskmanager.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(TaskQueueUtilsTest, BuildDirectoryMovePlansEmptyReturnsEmpty) +{ + QHash empty; + auto plans = TaskQueueUtils::buildDirectoryMovePlans(empty); + EXPECT_TRUE(plans.isEmpty()); +} + +TEST(TaskQueueUtilsTest, BuildDirectoryMovePlansNonDirExcluded) +{ + QHash moves { { "/old/file.txt", "/new/file.txt" } }; + auto plans = TaskQueueUtils::buildDirectoryMovePlans(moves); + EXPECT_TRUE(plans.isEmpty()); // file move, not directory move +} + +TEST(TaskQueueUtilsTest, BuildDirectoryMovePlansDirectoryIncluded) +{ + QHash moves { { "/old/dir/", "/new/dir/" } }; + auto plans = TaskQueueUtils::buildDirectoryMovePlans(moves); + EXPECT_EQ(plans.size(), 1); + EXPECT_EQ(plans[0].fromPath, QString("/old/dir/")); + EXPECT_EQ(plans[0].toPath, QString("/new/dir/")); +} + +TEST(TaskQueueUtilsTest, RewriteQueuedTasksEmptyQueueReturnsFalse) +{ + QQueue q; + EXPECT_FALSE(TaskQueueUtils::rewriteQueuedTasksForDirectoryMove(q, "/old/", "/new/")); +} + +TEST(TaskQueueUtilsTest, RewriteQueuedTasksEmptyFromReturnsFalse) +{ + QQueue q; + TaskQueueItem item; + item.path = "/old/dir/file.txt"; + q.enqueue(item); + EXPECT_FALSE(TaskQueueUtils::rewriteQueuedTasksForDirectoryMove(q, QString(), "/new/")); +} + +TEST(TaskQueueUtilsTest, RewriteQueuedTasksEmptyToReturnsFalse) +{ + QQueue q; + TaskQueueItem item; + item.path = "/old/dir/file.txt"; + q.enqueue(item); + EXPECT_FALSE(TaskQueueUtils::rewriteQueuedTasksForDirectoryMove(q, "/old/", QString())); +} + +TEST(TaskQueueUtilsTest, RewriteQueuedTasksRewritesPath) +{ + QQueue q; + TaskQueueItem item; + item.path = "/old/dir/file.txt"; + item.pathList = { "/old/dir/a.txt", "/other/b.txt" }; + item.fileList = { "/old/dir/c.txt" }; + q.enqueue(item); + + bool changed = TaskQueueUtils::rewriteQueuedTasksForDirectoryMove(q, "/old/dir/", "/new/dir/"); + EXPECT_TRUE(changed); + EXPECT_EQ(q.head().path, QString("/new/dir//file.txt")); + EXPECT_EQ(q.head().pathList.at(0), QString("/new/dir//a.txt")); + EXPECT_EQ(q.head().pathList.at(1), QString("/other/b.txt")); // not under /old/dir/ + EXPECT_EQ(q.head().fileList.at(0), QString("/new/dir//c.txt")); +} + +TEST(TaskQueueUtilsTest, RewriteQueuedTasksNoMatchReturnsFalse) +{ + QQueue q; + TaskQueueItem item; + item.path = "/completely/different/path.txt"; + q.enqueue(item); + bool changed = TaskQueueUtils::rewriteQueuedTasksForDirectoryMove(q, "/old/dir/", "/new/dir/"); + EXPECT_FALSE(changed); +} diff --git a/autotests/index/test_textindexconfig.cpp b/autotests/index/test_textindexconfig.cpp new file mode 100644 index 00000000..e557fc56 --- /dev/null +++ b/autotests/index/test_textindexconfig.cpp @@ -0,0 +1,92 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_textindexconfig.cpp + * @brief Unit tests for TextIndexConfig (textindexconfig.cpp) + */ + +#include +#include +#include + +#include "index_global.h" +#include "utils/textindexconfig.h" + +using namespace ANYTHING_INDEX_NAMESPACE; + +TEST(TextIndexConfigTest, InstanceReturnsRef) +{ + EXPECT_NO_FATAL_FAILURE({ (void)&TextIndexConfig::instance(); }); +} + +TEST(TextIndexConfigTest, AutoIndexUpdateIntervalPositive) +{ + EXPECT_GT(TextIndexConfig::instance().autoIndexUpdateInterval(), 0); +} + +TEST(TextIndexConfigTest, MonitoringStartDelaySecondsNonNeg) +{ + EXPECT_GE(TextIndexConfig::instance().monitoringStartDelaySeconds(), 0); +} + +TEST(TextIndexConfigTest, SilentIndexUpdateDelayNonNeg) +{ + EXPECT_GE(TextIndexConfig::instance().silentIndexUpdateDelay(), 0); +} + +TEST(TextIndexConfigTest, InotifyResourceCleanupDelayMsNonNeg) +{ + EXPECT_GE(TextIndexConfig::instance().inotifyResourceCleanupDelayMs(), 0); +} + +TEST(TextIndexConfigTest, MaxIndexTextFileSizeMBPositive) +{ + EXPECT_GT(TextIndexConfig::instance().maxIndexTextFileSizeMB(), 0); +} + +TEST(TextIndexConfigTest, MaxIndexFileTruncationSizeMBPositive) +{ + EXPECT_GT(TextIndexConfig::instance().maxIndexFileTruncationSizeMB(), 0); +} + +TEST(TextIndexConfigTest, SupportedTextFileExtensionsNonEmpty) +{ + EXPECT_FALSE(TextIndexConfig::instance().supportedTextFileExtensions().isEmpty()); +} + +TEST(TextIndexConfigTest, SupportedOcrImageExtensions) +{ + EXPECT_NO_FATAL_FAILURE({ (void)TextIndexConfig::instance().supportedOcrImageExtensions(); }); +} + +TEST(TextIndexConfigTest, MaxOcrImageSizeMBPositive) +{ + EXPECT_GT(TextIndexConfig::instance().maxOcrImageSizeMB(), 0); +} + +TEST(TextIndexConfigTest, IndexHiddenFilesReturnsBool) +{ + EXPECT_NO_FATAL_FAILURE({ (void)TextIndexConfig::instance().indexHiddenFiles(); }); +} + +TEST(TextIndexConfigTest, FolderExcludeFilters) +{ + EXPECT_NO_FATAL_FAILURE({ (void)TextIndexConfig::instance().folderExcludeFilters(); }); +} + +TEST(TextIndexConfigTest, CpuUsageLimitPercent) +{ + EXPECT_NO_FATAL_FAILURE({ (void)TextIndexConfig::instance().cpuUsageLimitPercent(); }); +} + +TEST(TextIndexConfigTest, BatchCommitInterval) +{ + EXPECT_NO_FATAL_FAILURE({ (void)TextIndexConfig::instance().batchCommitInterval(); }); +} + +TEST(TextIndexConfigTest, ReloadConfigNoCrash) +{ + EXPECT_NO_FATAL_FAILURE({ TextIndexConfig::instance().reloadConfig(); }); +} diff --git a/autotests/index/test_textindexdbus_extra.cpp b/autotests/index/test_textindexdbus_extra.cpp new file mode 100644 index 00000000..0a860ae3 --- /dev/null +++ b/autotests/index/test_textindexdbus_extra.cpp @@ -0,0 +1,192 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_textindexdbus_extra.cpp + * @brief Additional unit tests for TextIndexDBus covering private methods: + * handleConfigChanged (with status file), cleanup with dirty state, + * ProcessFileMoves with non-empty moves. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "dbus/textindexdbus.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +static void writeStatusJson(const QString &indexDir, const QJsonObject &obj) +{ + QDir().mkpath(indexDir); + QFile f(indexDir + QLatin1String("/index_status.json")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly | QIODevice::Truncate)); + f.write(QJsonDocument(obj).toJson()); + f.close(); +} + +class TextIndexDBusExtraTest : public testing::Test +{ +protected: + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/content-index"; + }); + stub.set_lamda(ADDR(Global, isContentIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInContentIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() + "/indexed-dir" }; + }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + } + + QTemporaryDir tmp; + stub_ext::StubExt stub; +}; + +// --- Test IndexDatabaseExists with various status states --- + +TEST_F(TextIndexDBusExtraTest, IndexDatabaseExists_DirtyState) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { { "version", Defines::kTextIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "dirty" } }); + + TextIndexDBus dbus; + EXPECT_TRUE(dbus.IndexDatabaseExists()); +} + +TEST_F(TextIndexDBusExtraTest, IndexDatabaseExists_CleanState) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { { "version", Defines::kTextIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "clean" } }); + + TextIndexDBus dbus; + EXPECT_TRUE(dbus.IndexDatabaseExists()); +} + +// --- Test SetEnabled(true) to enable FS monitoring --- +TEST_F(TextIndexDBusExtraTest, SetEnabledTrue) +{ + TextIndexDBus dbus; + EXPECT_NO_FATAL_FAILURE({ dbus.SetEnabled(true); }); +} + +// --- Test ProcessFileChanges with only one type --- +TEST_F(TextIndexDBusExtraTest, ProcessFileChanges_OnlyDeleted) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + {}, {}, + { tmp.path() + "/deleted.txt" }); + SUCCEED(); +} + +TEST_F(TextIndexDBusExtraTest, ProcessFileChanges_OnlyCreated) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + { tmp.path() + "/created.txt" }, {}, {}); + SUCCEED(); +} + +TEST_F(TextIndexDBusExtraTest, ProcessFileChanges_OnlyModified) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + {}, { tmp.path() + "/modified.txt" }, {}); + SUCCEED(); +} + +TEST_F(TextIndexDBusExtraTest, ProcessFileChanges_MultipleFiles) +{ + TextIndexDBus dbus; + bool result = dbus.ProcessFileChanges( + { tmp.path() + "/a.txt", tmp.path() + "/b.txt" }, + { tmp.path() + "/c.txt" }, + { tmp.path() + "/d.txt", tmp.path() + "/e.txt" }); + SUCCEED(); +} + +// --- Test ProcessFileMoves --- +TEST_F(TextIndexDBusExtraTest, ProcessFileMoves_SingleMove) +{ + TextIndexDBus dbus; + QHash moves; + moves[tmp.path() + "/old.txt"] = tmp.path() + "/new.txt"; + bool result = dbus.ProcessFileMoves(moves); + SUCCEED(); +} + +TEST_F(TextIndexDBusExtraTest, ProcessFileMoves_MultipleMoves) +{ + TextIndexDBus dbus; + QHash moves; + moves[tmp.path() + "/a.txt"] = tmp.path() + "/b.txt"; + moves[tmp.path() + "/c.txt"] = tmp.path() + "/d.txt"; + moves[tmp.path() + "/e.txt"] = tmp.path() + "/f.txt"; + bool result = dbus.ProcessFileMoves(moves); + SUCCEED(); +} + +// --- Test CreateIndexTask with silent option --- +TEST_F(TextIndexDBusExtraTest, CreateIndexTask_SilentTrue) +{ + TextIndexDBus dbus; + QVariantMap opts; + opts["silent"] = true; + bool result = dbus.CreateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + SUCCEED(); +} + +TEST_F(TextIndexDBusExtraTest, CreateIndexTask_SilentFalse) +{ + TextIndexDBus dbus; + QVariantMap opts; + opts["silent"] = false; + bool result = dbus.CreateIndexTask({ tmp.path() + "/indexed-dir" }, opts); + SUCCEED(); +} + +// --- Test cleanup --- +TEST_F(TextIndexDBusExtraTest, Cleanup_NoRunningTasks) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { { "version", Defines::kTextIndexVersion }, { "lastUpdateTime", "2026-01-01T00:00:00" }, { "state", "clean" } }); + + TextIndexDBus dbus; + dbus.cleanup(); + SUCCEED(); +} diff --git a/autotests/index/test_textindexdbus_private.cpp b/autotests/index/test_textindexdbus_private.cpp new file mode 100644 index 00000000..75471aee --- /dev/null +++ b/autotests/index/test_textindexdbus_private.cpp @@ -0,0 +1,228 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_textindexdbus_private.cpp + * @brief Tests for TextIndexDBusPrivate methods accessed via d (friend access). + * Covers initializeSupportedExtensions, handleConfigChanged, handleMonitoring, + * handleSilentStart, canSilentlyRefreshIndex, cleanup. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stubext.h" +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "dbus/textindexdbus.h" +#include "dbus/private/textindexdbus_p.h" + +using namespace ANYTHING_INDEX_NAMESPACE; +using namespace DFMSEARCH; + +static void writeStatusJson(const QString &indexDir, const QJsonObject &obj) +{ + QDir().mkpath(indexDir); + QFile f(indexDir + QLatin1String("/index_status.json")); + ASSERT_TRUE(f.open(QIODevice::WriteOnly | QIODevice::Truncate)); + f.write(QJsonDocument(obj).toJson()); + f.close(); +} + +class TextIndexDBusPrivateTest : public testing::Test +{ +protected: + QTemporaryDir tmp; + TextIndexDBus *dbus { nullptr }; + TextIndexDBusPrivate *d { nullptr }; + + void SetUp() override + { + ASSERT_TRUE(tmp.isValid()); + + stub.set_lamda(ADDR(Global, contentIndexDirectory), + [this]() -> QString { + __DBG_STUB_INVOKE__ + return tmp.path() + "/content-index"; + }); + stub.set_lamda(ADDR(Global, isContentIndexAvailable), + []() -> bool { + __DBG_STUB_INVOKE__ + return true; + }); + stub.set_lamda(ADDR(Global, isPathInContentIndexDirectory), + [this](const QString &path) -> bool { + __DBG_STUB_INVOKE__ + return path.startsWith(tmp.path()); + }); + stub.set_lamda(ADDR(Global, defaultIndexedDirectory), + [this]() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList { tmp.path() + "/indexed-dir" }; + }); + stub.set_lamda(ADDR(Global, defaultBlacklistPaths), + []() -> QStringList { + __DBG_STUB_INVOKE__ + return QStringList(); + }); + + dbus = new TextIndexDBus(); + d = dbus->d.data(); + } + + void TearDown() override + { + delete dbus; + } + + stub_ext::StubExt stub; +}; + +// ---- initializeSupportedExtensions ---- +TEST_F(TextIndexDBusPrivateTest, InitializeSupportedExtensions) +{ + EXPECT_NO_FATAL_FAILURE({ d->initializeSupportedExtensions(); }); + EXPECT_GT(d->m_currentSupportedExtensions.size(), 0); +} + +// ---- canSilentlyRefreshIndex ---- +TEST_F(TextIndexDBusPrivateTest, CanSilentlyRefreshIndex_NoCurrentTask) +{ + EXPECT_TRUE(d->canSilentlyRefreshIndex("/any/path")); +} + +TEST_F(TextIndexDBusPrivateTest, CanSilentlyRefreshIndex_DifferentTaskType) +{ + // With no task running, should return true + EXPECT_TRUE(d->canSilentlyRefreshIndex(tmp.path() + "/indexed-dir")); +} + +// ---- handleMonitoring ---- +TEST_F(TextIndexDBusPrivateTest, HandleMonitoring_Stop) +{ + EXPECT_NO_FATAL_FAILURE({ d->handleMonitoring(false); }); +} + +TEST_F(TextIndexDBusPrivateTest, HandleMonitoring_Start) +{ + EXPECT_NO_FATAL_FAILURE({ d->handleMonitoring(true); }); +} + +// ---- handleSilentStart (once_flag - only runs once) ---- +TEST_F(TextIndexDBusPrivateTest, HandleSilentStart) +{ + // This uses std::call_once, so it runs once and then never again + // But we can still call it to cover the function + EXPECT_NO_FATAL_FAILURE({ d->handleSilentStart(); }); +} + +// ---- handleConfigChanged ---- +TEST_F(TextIndexDBusPrivateTest, HandleConfigChanged_NoIndexDb) +{ + // No index database exists - should log warning and not start task + EXPECT_NO_FATAL_FAILURE({ d->handleConfigChanged(); }); +} + +TEST_F(TextIndexDBusPrivateTest, HandleConfigChanged_WithIndexDb) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { + { "version", Defines::kTextIndexVersion }, + { "lastUpdateTime", "2026-01-01T00:00:00" }, + { "state", "clean" } + }); + + EXPECT_NO_FATAL_FAILURE({ d->handleConfigChanged(); }); +} + +// ---- cleanup with running task ---- +TEST_F(TextIndexDBusPrivateTest, Cleanup_WithQueuedTasks) +{ + // Enqueue a task then cleanup + dbus->CreateIndexTask({ tmp.path() + "/indexed-dir" }); + // There may be a queued task now + EXPECT_NO_FATAL_FAILURE({ dbus->cleanup(); }); +} + +// ---- stopCurrentTask when no task running ---- +TEST_F(TextIndexDBusPrivateTest, StopCurrentTask_NoTask) +{ + EXPECT_FALSE(dbus->StopCurrentTask()); +} + +// ---- HasRunningTask ---- +TEST_F(TextIndexDBusPrivateTest, HasRunningTask_Default) +{ + EXPECT_FALSE(dbus->HasRunningTask()); +} + +// ---- GetLastUpdateTime ---- +TEST_F(TextIndexDBusPrivateTest, GetLastUpdateTime) +{ + QString time = dbus->GetLastUpdateTime(); + SUCCEED(); +} + +// ---- IndexDatabaseExists with incompatible version ---- +TEST_F(TextIndexDBusPrivateTest, IndexDatabaseExists_IncompatibleVersion) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { + { "version", "wrong_version" }, + { "lastUpdateTime", "2026-01-01T00:00:00" }, + { "state", "clean" } + }); + EXPECT_FALSE(dbus->IndexDatabaseExists()); +} + +TEST_F(TextIndexDBusPrivateTest, IndexDatabaseExists_EmptyUpdateTime) +{ + const QString indexDir = tmp.path() + "/content-index"; + writeStatusJson(indexDir, { + { "version", Defines::kTextIndexVersion }, + { "lastUpdateTime", "" }, + { "state", "clean" } + }); + EXPECT_FALSE(dbus->IndexDatabaseExists()); +} + +// ---- IsEnabled / SetEnabled ---- +TEST_F(TextIndexDBusPrivateTest, IsEnabled_Default) +{ + EXPECT_NO_FATAL_FAILURE({ (void)dbus->IsEnabled(); }); +} + +TEST_F(TextIndexDBusPrivateTest, SetEnabled_False) +{ + EXPECT_NO_FATAL_FAILURE({ dbus->SetEnabled(false); }); +} + +// ---- ProcessFileMoves empty ---- +TEST_F(TextIndexDBusPrivateTest, ProcessFileMoves_Empty) +{ + EXPECT_FALSE(dbus->ProcessFileMoves({})); +} + +// ---- ProcessFileChanges all empty ---- +TEST_F(TextIndexDBusPrivateTest, ProcessFileChanges_AllEmpty) +{ + EXPECT_FALSE(dbus->ProcessFileChanges({}, {}, {})); +} + +// ---- Destructor ---- +TEST_F(TextIndexDBusPrivateTest, Destructor) +{ + auto *d2 = new TextIndexDBus(); + EXPECT_NO_FATAL_FAILURE({ delete d2; }); +} diff --git a/autotests/index/test_vfsmonitorfilesystemwatcher.cpp b/autotests/index/test_vfsmonitorfilesystemwatcher.cpp new file mode 100644 index 00000000..46fba255 --- /dev/null +++ b/autotests/index/test_vfsmonitorfilesystemwatcher.cpp @@ -0,0 +1,977 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#include +#include +#include + +#include "index_global.h" +#include "fsmonitor/vfsmonitorwatcher.h" +#include "fsmonitor/vfsmonitorwatcher_p.h" +#include + +using namespace ANYTHING_INDEX_NAMESPACE; + +// VfsMonitorFileSystemWatcher 依赖 deepin-anything 事件分发 socket +// 如果事件分发不可用，create() 返回 nullptr，相关测试应被跳过 +// 注意: 当前 deepin-anything 事件链路若不可用， +// 目录相关测试使用 ASSERT 严格模式，失败时直接终止当前测试而非崩溃 +class TestVfsMonitorFileSystemWatcher : public ::testing::Test +{ +protected: + void SetUp() override + { + // 在 ~/Documents/ 下创建隐藏临时目录 + QString templatePath = QDir::homePath() + "/Documents/.test_vfsmonitor_XXXXXX"; + testDir = std::make_unique(templatePath); + ASSERT_TRUE(testDir->isValid()); + QDir().mkpath(testDir->path()); + + // 尝试创建 VfsMonitorFileSystemWatcher + QStringList rootPaths = { testDir->path() }; + watcher = VfsMonitorFileSystemWatcher::create(rootPaths, {}, nullptr); + if (!watcher) { + GTEST_SKIP() << "deepin-anything event dispatcher not available, skipping tests"; + } + } + + void TearDown() override + { + delete watcher; + watcher = nullptr; + testDir.reset(); + } + + int waitForSignal(QSignalSpy &spy, int timeoutMs = 3000) + { + spy.wait(timeoutMs); + return spy.count(); + } + + std::unique_ptr testDir; + VfsMonitorFileSystemWatcher *watcher { nullptr }; +}; + +// ========== 工厂方法 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, FactoryCreateReturnsNonNull) +{ + // 如果到达这里，说明 create() 返回了非空指针 + ASSERT_NE(watcher, nullptr); +} + +// ========== 文件创建 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, FileCreatedSignal) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + ASSERT_TRUE(spy.isValid()); + + QString filePath = testDir->path() + "/newfile.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("vfs monitor test"); + file.close(); + + int count = waitForSignal(spy); + ASSERT_GT(count, 0) << "fileCreated signal not received within timeout"; + + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "newfile.txt"); +} + +// ========== 目录创建 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, DirectoryCreatedSignal) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::directoryCreated); + ASSERT_TRUE(spy.isValid()); + + QString subDirPath = testDir->path() + "/newdir"; + QDir().mkpath(subDirPath); + + int count = waitForSignal(spy); + + EXPECT_EQ(count, 1); + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "newdir"); +} + +// ========== 文件删除 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, FileDeletedSignal) +{ + ASSERT_NE(watcher, nullptr); + + // 先创建文件 + QString filePath = testDir->path() + "/todelete.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("delete me"); + file.close(); + + // 等待创建信号 + QSignalSpy createSpy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + waitForSignal(createSpy); + + QSignalSpy deleteSpy(watcher, &VfsMonitorFileSystemWatcher::fileDeleted); + ASSERT_TRUE(deleteSpy.isValid()); + + QFile::remove(filePath); + + int count = waitForSignal(deleteSpy); + ASSERT_GT(count, 0) << "fileDeleted signal not received within timeout"; + + QList args = deleteSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "todelete.txt"); +} + +// ========== 目录删除 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, DirectoryDeletedSignal) +{ + ASSERT_NE(watcher, nullptr); + + // 先创建子目录 + QString subDirPath = testDir->path() + "/todeletedir"; + QDir().mkpath(subDirPath); + + QSignalSpy createSpy(watcher, &VfsMonitorFileSystemWatcher::directoryCreated); + waitForSignal(createSpy); + + QSignalSpy deleteSpy(watcher, &VfsMonitorFileSystemWatcher::directoryDeleted); + ASSERT_TRUE(deleteSpy.isValid()); + + QDir().rmdir(subDirPath); + + waitForSignal(deleteSpy); + + QList args = deleteSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "todeletedir"); +} + +// ========== 文件重命名 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, FileRenameMovedSignal) +{ + ASSERT_NE(watcher, nullptr); + + // 先创建文件 + QString oldPath = testDir->path() + "/oldname_vfs.txt"; + QFile file(oldPath); + file.open(QIODevice::WriteOnly); + file.write("rename me"); + file.close(); + + // 等待创建信号 + QSignalSpy createSpy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + waitForSignal(createSpy); + + QSignalSpy moveSpy(watcher, &VfsMonitorFileSystemWatcher::fileMoved); + ASSERT_TRUE(moveSpy.isValid()); + + // 重命名 + QString newPath = testDir->path() + "/newname_vfs.txt"; + QFile::rename(oldPath, newPath); + + int count = waitForSignal(moveSpy); + ASSERT_GT(count, 0) << "fileMoved signal not received within timeout"; + + QList args = moveSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "oldname_vfs.txt"); + EXPECT_EQ(args.at(2).toString(), testDir->path()); + EXPECT_EQ(args.at(3).toString(), "newname_vfs.txt"); +} + +// ========== 目录重命名 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, DirectoryRenameMovedSignal) +{ + ASSERT_NE(watcher, nullptr); + + // 先创建目录 + QString oldDirPath = testDir->path() + "/olddir"; + QDir().mkpath(oldDirPath); + + QSignalSpy createSpy(watcher, &VfsMonitorFileSystemWatcher::directoryCreated); + waitForSignal(createSpy); + + QSignalSpy moveSpy(watcher, &VfsMonitorFileSystemWatcher::directoryMoved); + ASSERT_TRUE(moveSpy.isValid()); + + // 重命名目录 + QString newDirPath = testDir->path() + "/newdir"; + QDir().rename(oldDirPath, newDirPath); + + waitForSignal(moveSpy); + + QList args = moveSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "olddir"); + EXPECT_EQ(args.at(2).toString(), testDir->path()); + EXPECT_EQ(args.at(3).toString(), "newdir"); +} + +// ========== 符号链接创建 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, SymlinkCreationEmitsFileCreated) +{ + ASSERT_NE(watcher, nullptr); + + // 先创建目标文件 + QString targetPath = testDir->path() + "/symlink_target.txt"; + QFile file(targetPath); + file.open(QIODevice::WriteOnly); + file.write("target"); + file.close(); + + // 等待文件创建信号 + QSignalSpy createSpy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + waitForSignal(createSpy); + + // 清除之前的信号 + createSpy.clear(); + + // 创建符号链接 + QString linkPath = testDir->path() + "/symlink_link.txt"; + QFile::link(targetPath, linkPath); + + int count = waitForSignal(createSpy); + // 符号链接创建应该触发 fileCreated 信号 (ACT_NEW_SYMLINK) + ASSERT_GT(count, 0) << "fileCreated (symlink) signal not received within timeout"; + + QList args = createSpy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "symlink_link.txt"); +} + +// ========== 文件写入关闭 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, FileClosedSignal) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileClosed); + ASSERT_TRUE(spy.isValid()); + + // 创建文件并写入内容后关闭，触发 ACT_CLOSE_WRITE_FILE + QString filePath = testDir->path() + "/closewrite.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("close write test"); + file.close(); + + int count = waitForSignal(spy); + ASSERT_GT(count, 0) << "fileClosed signal not received within timeout"; + + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), "closewrite.txt"); +} + +// ========== 批量文件写入关闭（压力测试） ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, BatchFileClosedStress) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileClosed); + ASSERT_TRUE(spy.isValid()); + + constexpr int kFileCount = 20; + QStringList fileNames; + + for (int i = 0; i < kFileCount; ++i) { + QString name = QString("stress_%1.txt").arg(i); + fileNames << name; + QString path = testDir->path() + "/" + name; + QFile f(path); + f.open(QIODevice::WriteOnly); + f.write(QString("content %1").arg(i).toUtf8()); + f.close(); + } + + // deepin-anything 内核模块事件合并器每 100ms 最多发送 DUMP_SIZE(10) 个事件。 + // 20 个文件产生 40 个事件(20 NEW_FILE + 20 CLOSE_WRITE_FILE)，需分多批发送。 + // QSignalSpy::wait() 收到第一个信号就返回，需循环等待直到收齐或超时。 + QElapsedTimer timer; + timer.start(); + while (spy.count() < kFileCount && !timer.hasExpired(15000)) { + QTest::qWait(200); + } + + EXPECT_GE(spy.count(), kFileCount) + << "Expected at least " << kFileCount << " fileClosed signals, got " << spy.count(); + + // 验证每个文件名都出现在信号参数中 + QSet seenNames; + for (const auto &args : spy) { + if (args.count() >= 2) + seenNames << args.at(1).toString(); + } + for (const QString &name : fileNames) { + EXPECT_TRUE(seenNames.contains(name)) + << "Missing fileClosed for: " << name.toStdString(); + } +} + +// ========== 同一文件反复写入关闭（压力测试） ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, RepeatedWriteCloseStress) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileClosed); + ASSERT_TRUE(spy.isValid()); + + QString filePath = testDir->path() + "/repeated_stress.txt"; + QString fileName = "repeated_stress.txt"; + + constexpr int kIterations = 15; + for (int i = 0; i < kIterations; ++i) { + QFile f(filePath); + f.open(QIODevice::WriteOnly | QIODevice::Truncate); + f.write(QString("iteration %1").arg(i).toUtf8()); + f.close(); + // 小间隔让事件合并器有机会刷新 + QTest::qWait(50); + } + + // 循环等待收齐所有信号 + QElapsedTimer timer; + timer.start(); + while (spy.count() < kIterations && !timer.hasExpired(10000)) { + QTest::qWait(200); + } + + EXPECT_GE(spy.count(), kIterations) + << "Expected at least " << kIterations << " fileClosed signals, got " << spy.count(); + + // 所有信号的文件名应该一致 + for (const auto &args : spy) { + if (args.count() >= 2) { + EXPECT_EQ(args.at(1).toString(), fileName) + << "Unexpected file name in fileClosed signal"; + } + } +} + +// ========== 大文件写入关闭 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, LargeFileWriteClose) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileClosed); + ASSERT_TRUE(spy.isValid()); + + QString filePath = testDir->path() + "/large_stress.txt"; + QString fileName = "large_stress.txt"; + + QFile f(filePath); + f.open(QIODevice::WriteOnly); + // 写入 1MB 数据 + QByteArray chunk(1024 * 1024, 'X'); + f.write(chunk); + f.close(); + + int count = waitForSignal(spy, 5000); + ASSERT_GT(count, 0) << "fileClosed signal not received for large file"; + + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(0).toString(), testDir->path()); + EXPECT_EQ(args.at(1).toString(), fileName); +} + +// ========== 路径排除 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, ExcludePredicateFiltersEvents) +{ + ASSERT_NE(watcher, nullptr); + + // 重新创建带有排除谓词的 watcher + QStringList rootPaths = { testDir->path() }; + auto exclude = [](const QString &path) -> bool { + return path.endsWith(".log"); + }; + + // 先析构旧 watcher + delete watcher; + watcher = nullptr; + watcher = VfsMonitorFileSystemWatcher::create(rootPaths, exclude, nullptr); + if (!watcher) { + GTEST_SKIP() << "Failed to create watcher with exclude predicate"; + } + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + ASSERT_TRUE(spy.isValid()); + + // 创建被排除的文件（.log 后缀） + QString excludedPath = testDir->path() + "/excluded.log"; + QFile file(excludedPath); + file.open(QIODevice::WriteOnly); + file.write("excluded"); + file.close(); + + waitForSignal(spy); + // 等待更长时间确保不会出现信号 + spy.wait(1000); + + // 被排除的文件不应该触发 fileCreated + EXPECT_EQ(spy.count(), 0); + + // 创建正常文件 + QString normalPath = testDir->path() + "/normal.txt"; + QFile normalFile(normalPath); + normalFile.open(QIODevice::WriteOnly); + normalFile.write("normal"); + normalFile.close(); + + int count = waitForSignal(spy); + ASSERT_GT(count, 0) << "fileCreated (normal) signal not received within timeout"; + + QList args = spy.takeFirst(); + EXPECT_EQ(args.at(1).toString(), "normal.txt"); +} + +// ========== 信号去重 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, NoDuplicateSignalsForSingleOperation) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + ASSERT_TRUE(spy.isValid()); + + // 创建单个文件 + QString filePath = testDir->path() + "/unique_vfs.txt"; + QFile file(filePath); + file.open(QIODevice::WriteOnly); + file.write("unique"); + file.close(); + + waitForSignal(spy); + // 额外等待确认无重复 + spy.wait(500); + + // 应该恰好一次（如果内核模块正常） + EXPECT_LE(spy.count(), 1); + EXPECT_GE(spy.count(), 1); +} + +// ========== RootPath 过滤 ========== + +TEST_F(TestVfsMonitorFileSystemWatcher, EventsOutsideRootPathsNotEmitted) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy spy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + ASSERT_TRUE(spy.isValid()); + + // 在测试目录之外创建文件（使用 /tmp） + QString outsidePath = QDir::tempPath() + "/vfsmonitor_outside_" + QString::number(QCoreApplication::applicationPid()) + ".txt"; + QFile file(outsidePath); + file.open(QIODevice::WriteOnly); + file.write("outside"); + file.close(); + + waitForSignal(spy); + spy.wait(1000); + + // 不应该触发任何信号（事件在 rootPaths 之外） + EXPECT_EQ(spy.count(), 0); + + // 清理 + QFile::remove(outsidePath); +} + +// ====================================================================== +// 重连机制单元测试 +// 通过 DFM_VFSMONITOR_SOCKET_PATH 环境变量将 watcher 指向测试自建的 mock +// dispatcher socket，模拟服务端断开，验证 watcher 能自动重连。 +// ====================================================================== + +// 创建并监听一个 AF_UNIX SOCK_SEQPACKET socket，返回 listen fd。 +static int createMockDispatcher(const QString &path) +{ + int fd = ::socket(AF_UNIX, SOCK_SEQPACKET | SOCK_NONBLOCK, 0); + if (fd < 0) + return -1; + + ::unlink(path.toUtf8().constData()); // remove stale socket file + + sockaddr_un addr {}; + addr.sun_family = AF_UNIX; + std::strncpy(addr.sun_path, path.toUtf8().constData(), sizeof(addr.sun_path) - 1); + + if (::bind(fd, reinterpret_cast(&addr), sizeof(addr)) < 0) { + ::close(fd); + return -1; + } + if (::listen(fd, 5) < 0) { + ::close(fd); + return -1; + } + return fd; +} + +// 接受一个客户端连接（非阻塞 listen fd），返回 client fd 或 -1（无待连接）。 +static int acceptOneClient(int listenFd) +{ + int fd = ::accept4(listenFd, nullptr, nullptr, SOCK_NONBLOCK); + return fd; +} + +// 接受一个阻塞模式的客户端连接：send() 在内核缓冲区满时阻塞， +// 由 watcher 的读线程持续排空形成真实背压（用于灌包压测）。 +static int acceptOneClientBlocking(int listenFd) +{ + return ::accept4(listenFd, nullptr, nullptr, 0); +} + +class TestVfsMonitorReconnect : public ::testing::Test +{ +protected: + void SetUp() override + { + // 在临时目录下创建 mock dispatcher socket + QString templatePath = QDir::homePath() + "/Documents/.test_vfsreconnect_XXXXXX"; + testDir = std::make_unique(templatePath); + ASSERT_TRUE(testDir->isValid()); + mockSocketPath = testDir->path() + "/mock-dispatcher.sock"; + + // 启动 mock dispatcher + listenFd = createMockDispatcher(mockSocketPath); + ASSERT_GE(listenFd, 0) << "Failed to create mock dispatcher"; + + // 设置环境变量，使 watcher 连接到 mock dispatcher + qputenv("DFM_VFSMONITOR_SOCKET_PATH", mockSocketPath.toUtf8()); + + // 创建 watcher + watcher = VfsMonitorFileSystemWatcher::create({ testDir->path() }, {}, nullptr); + ASSERT_NE(watcher, nullptr) << "Watcher creation failed"; + + // 接受初始连接 + clientFd = waitForAccept(listenFd, 3000); + ASSERT_GE(clientFd, 0) << "Mock dispatcher did not accept initial connection"; + } + + void TearDown() override + { + if (clientFd >= 0) + ::close(clientFd); + if (listenFd >= 0) { + ::close(listenFd); + } + ::unlink(mockSocketPath.toUtf8().constData()); + qunsetenv("DFM_VFSMONITOR_SOCKET_PATH"); + delete watcher; + watcher = nullptr; + testDir.reset(); + } + + // 轮询等待 accept 返回 fd，超时返回 -1 + int waitForAccept(int fd, int timeoutMs) + { + QElapsedTimer timer; + timer.start(); + while (!timer.hasExpired(timeoutMs)) { + int cfd = acceptOneClient(fd); + if (cfd >= 0) + return cfd; + QTest::qWait(50); + } + return -1; + } + + std::unique_ptr testDir; + QString mockSocketPath; + int listenFd { -1 }; + int clientFd { -1 }; + VfsMonitorFileSystemWatcher *watcher { nullptr }; +}; + +// 断开后 watcher 应在退避时间后自动重连 +TEST_F(TestVfsMonitorReconnect, DISABLED_ReconnectsAfterServerClosesConnection) +{ + ASSERT_NE(watcher, nullptr); + ASSERT_GE(clientFd, 0); + + // 模拟服务端踢掉客户端：关闭 server 端的 client fd。 + // 客户端下次 recv() 将返回 0，触发 handleDisconnect()。 + ::close(clientFd); + clientFd = -1; + + // 给 watcher 的事件循环一点时间，让读线程触发断连处理。 + // 读线程在收到 recv()==0 后通过 eventsLost 上报并调度 handleDisconnect，后者以 1s + // 退避启动 reconnectTimer。我们等待 ~2.5s 容纳事件循环 + 1s 退避。 + int newClientFd = waitForAccept(listenFd, 5000); + ASSERT_GE(newClientFd, 0) + << "Watcher did not reconnect within 5s after server-side close"; + + ::close(newClientFd); +} + +// 重连后 backoff 应复位：断开后先关闭 mock listen socket 使重连失败数次 +// （backoff 增至 2s/4s），恢复 listen 后重连成功，再次断开验证快速重连。 +// ====================================================================== +// splitPath unit tests (public static method on VfsMonitorFileSystemWatcherPrivate) +// ====================================================================== + +class TestVfsMonitorSplitPath : public ::testing::Test +{ +}; + +TEST_F(TestVfsMonitorSplitPath, SplitPath_SimpleFile) +{ + auto [dir, name] = VfsMonitorFileSystemWatcherPrivate::splitPath("/home/user/file.txt"); + EXPECT_EQ(dir, QString("/home/user")); + EXPECT_EQ(name, QString("file.txt")); +} + +TEST_F(TestVfsMonitorSplitPath, SplitPath_RootFile) +{ + auto [dir, name] = VfsMonitorFileSystemWatcherPrivate::splitPath("/file.txt"); + EXPECT_EQ(dir, QString("/")); + EXPECT_EQ(name, QString("file.txt")); +} + +TEST_F(TestVfsMonitorSplitPath, SplitPath_DeeplyNested) +{ + auto [dir, name] = VfsMonitorFileSystemWatcherPrivate::splitPath("/a/b/c/d/e/f.txt"); + EXPECT_EQ(dir, QString("/a/b/c/d/e")); + EXPECT_EQ(name, QString("f.txt")); +} + +TEST_F(TestVfsMonitorSplitPath, SplitPath_TrailingSlash) +{ + // QFileInfo canonicalizes this - trailing slash becomes the parent + auto [dir, name] = VfsMonitorFileSystemWatcherPrivate::splitPath("/home/user/dir/"); + // With trailing slash, QFileInfo sees it as a directory + EXPECT_FALSE(dir.isEmpty()); +} + +TEST_F(TestVfsMonitorSplitPath, SplitPath_FileWithNoExtension) +{ + auto [dir, name] = VfsMonitorFileSystemWatcherPrivate::splitPath("/home/user/README"); + EXPECT_EQ(dir, QString("/home/user")); + EXPECT_EQ(name, QString("README")); +} + +// ====================================================================== +// Factory method tests (no dispatcher available) +// ====================================================================== + +TEST_F(TestVfsMonitorSplitPath, Create_WithInvalidSocketPath_ReturnsNull) +{ + // Set socket path to a non-existent file to ensure create() fails + qputenv("DFM_VFSMONITOR_SOCKET_PATH", "/nonexistent/socket/path/that/does/not/exist.sock"); + auto *w = VfsMonitorFileSystemWatcher::create({"/tmp"}, {}, nullptr); + // create() should return nullptr because the socket path doesn't exist + EXPECT_EQ(w, nullptr); + qunsetenv("DFM_VFSMONITOR_SOCKET_PATH"); +} + +TEST_F(TestVfsMonitorSplitPath, Create_WithExcludePredicate) +{ + qputenv("DFM_VFSMONITOR_SOCKET_PATH", "/nonexistent/socket/path.sock"); + auto exclude = [](const QString &) -> bool { return true; }; + auto *w = VfsMonitorFileSystemWatcher::create({"/tmp"}, exclude, nullptr); + EXPECT_EQ(w, nullptr); + qunsetenv("DFM_VFSMONITOR_SOCKET_PATH"); +} + +TEST_F(TestVfsMonitorSplitPath, Create_EmptyRootPaths_ReturnsNull) +{ + qputenv("DFM_VFSMONITOR_SOCKET_PATH", "/nonexistent/socket/path.sock"); + auto *w = VfsMonitorFileSystemWatcher::create({}, {}, nullptr); + EXPECT_EQ(w, nullptr); + qunsetenv("DFM_VFSMONITOR_SOCKET_PATH"); +} + +TEST_F(TestVfsMonitorReconnect, DISABLED_BackoffResetsAfterSuccessfulReconnect) +{ + ASSERT_NE(watcher, nullptr); + ASSERT_GE(clientFd, 0); + + // --- Phase 1: force backoff growth --- + // Close the server-side client fd to trigger a disconnect. + ::close(clientFd); + clientFd = -1; + + // Close the listen socket so the watcher's first reconnect attempt fails. + // We need a fresh path because bind() to the same path would fail if the + // old socket file lingers; instead we close+reopen on the same path. + ::close(listenFd); + listenFd = -1; + + // Wait long enough for the watcher to attempt at least one failed + // reconnect (1s initial backoff fires, attemptReconnect fails, backoff + // grows to 2s). Give it ~3s to be safe. + QTest::qWait(3000); + + // Reopen the mock dispatcher on the same path so reconnect can succeed. + listenFd = createMockDispatcher(mockSocketPath); + ASSERT_GE(listenFd, 0) << "Failed to reopen mock dispatcher"; + + // Wait for the watcher to reconnect (backoff may be 2s or 4s at this + // point; give generous timeout). + int reconnectFd = waitForAccept(listenFd, 10000); + ASSERT_GE(reconnectFd, 0) << "Watcher did not reconnect after restoring listen socket"; + + // --- Phase 2: verify backoff was reset --- + // Disconnect again. If backoff was reset, the next reconnect fires in ~1s; + // if it was NOT reset, it could be 4s+. We use a 2500ms window: a 1s + // reconnect completes well within it, while a 4s+ reconnect does not. + ::close(reconnectFd); + + QElapsedTimer timer; + timer.start(); + int finalReconnectFd = waitForAccept(listenFd, 2500); + ASSERT_GE(finalReconnectFd, 0) + << "Reconnect took too long; backoff was not reset after success"; + + ::close(finalReconnectFd); +} + +// ====================================================================== +// 高吞吐压力测试 +// 通过 mock dispatcher 从独立线程灌入海量事件（blocking send 形成天然 +// 背压），验证 watcher 的专用读线程能持续排空 socket： +// 1. 10 万级事件突发不断连、不丢事件（此前 ~100 个事件即被踢）； +// 2. 用户态队列溢出时丢弃并发出 eventsLost（UPDATE 补偿的触发点）； +// 3. 服务端断连时发出 eventsLost 并自动重连。 +// ====================================================================== + +// 与 vfsmonitorwatcher.cpp 中 DispatchEvent 对齐的报文布局 +struct MockDispatchEvent +{ + int32_t action; + uint32_t cookie; + char eventPath[4096]; +}; + +static QByteArray makeDispatchPacket(int action, uint32_t cookie, const QByteArray &path) +{ + const QByteArray truncated = path.left(4095); + QByteArray packet; + packet.resize(int(offsetof(MockDispatchEvent, eventPath)) + truncated.size() + 1); + auto *evt = reinterpret_cast(packet.data()); + evt->action = action; + evt->cookie = cookie; + std::memcpy(evt->eventPath, truncated.constData(), size_t(truncated.size()) + 1); + return packet; +} + +// 从独立线程灌入 count 个 ACT_NEW_FILE 事件。accepted fd 是阻塞的， +// send() 在内核缓冲区满时自然阻塞，由 watcher 的读线程持续排空。 +// 返回成功写入的事件数（连接断开时提前返回）。 +static int floodFileCreatedEvents(int fd, const QString &dir, int count, int startIdx) +{ + int sent = 0; + for (int i = 0; i < count; ++i) { + const QByteArray packet = makeDispatchPacket( + ACT_NEW_FILE, 0, QString("%1/f_%2.txt").arg(dir).arg(startIdx + i).toUtf8()); + const char *buf = packet.constData(); + size_t left = size_t(packet.size()); + while (left > 0) { + ssize_t n = ::send(fd, buf, left, MSG_NOSIGNAL); + if (n < 0) { + if (errno == EINTR) + continue; + qWarning() << "flood: send failed at" << sent << "errno =" << errno + << "(" << std::strerror(errno) << ")"; + return sent; // connection broke + } + buf += n; + left -= size_t(n); + } + ++sent; + } + return sent; +} + +class TestVfsMonitorThroughput : public ::testing::Test +{ +protected: + void SetUp() override + { + QString templatePath = QDir::homePath() + "/Documents/.test_vfsthroughput_XXXXXX"; + testDir = std::make_unique(templatePath); + ASSERT_TRUE(testDir->isValid()); + + mockSocketPath = testDir->path() + "/mock-dispatcher.sock"; + listenFd = createMockDispatcher(mockSocketPath); + ASSERT_GE(listenFd, 0) << "Failed to create mock dispatcher"; + + qputenv("DFM_VFSMONITOR_SOCKET_PATH", mockSocketPath.toUtf8()); + + watcher = VfsMonitorFileSystemWatcher::create({ testDir->path() }, {}, nullptr); + ASSERT_NE(watcher, nullptr) << "Watcher creation failed"; + + clientFd = waitForAccept(listenFd, 3000); + ASSERT_GE(clientFd, 0) << "Mock dispatcher did not accept initial connection"; + } + + void TearDown() override + { + // clientFd 可能已被 watcher 自身（重连/析构）接管或关闭 + if (clientFd >= 0) + ::close(clientFd); + if (listenFd >= 0) + ::close(listenFd); + ::unlink(mockSocketPath.toUtf8().constData()); + qunsetenv("DFM_VFSMONITOR_SOCKET_PATH"); + qunsetenv("DFM_VFSMONITOR_MAX_QUEUE"); + delete watcher; + watcher = nullptr; + testDir.reset(); + } + + int waitForAccept(int fd, int timeoutMs) + { + QElapsedTimer timer; + timer.start(); + while (!timer.hasExpired(timeoutMs)) { + // 阻塞模式 fd：灌包压测依赖 send() 阻塞形成背压 + int cfd = acceptOneClientBlocking(fd); + if (cfd >= 0) + return cfd; + QTest::qWait(50); + } + return -1; + } + + std::unique_ptr testDir; + QString mockSocketPath; + int listenFd { -1 }; + int clientFd { -1 }; + VfsMonitorFileSystemWatcher *watcher { nullptr }; +}; +// 10 万事件突发：不断连（eventsLost 不触发）、事件全部送达、连接仍可用 +TEST_F(TestVfsMonitorThroughput, HighThroughputBurstDoesNotDisconnect) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy createdSpy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + QSignalSpy lostSpy(watcher, &VfsMonitorFileSystemWatcher::eventsLost); + ASSERT_TRUE(createdSpy.isValid()); + ASSERT_TRUE(lostSpy.isValid()); + + constexpr int kEventCount = 100000; + + int sent = 0; + std::thread sender([&] { + sent = floodFileCreatedEvents(clientFd, testDir->path(), kEventCount, 0); + }); + sender.join(); + ASSERT_EQ(sent, kEventCount) << "connection broke during the burst"; + + // 等待全部事件被消费并转为信号 + QElapsedTimer timer; + timer.start(); + while (createdSpy.count() < kEventCount && !timer.hasExpired(30000)) + QTest::qWait(100); + + EXPECT_EQ(createdSpy.count(), kEventCount) + << "expected all burst events to be delivered"; + EXPECT_EQ(lostSpy.count(), 0) << "no disconnect should happen during the burst"; + + // 连接仍存活：再发一个事件应正常送达 + const QByteArray tail = makeDispatchPacket( + ACT_NEW_FILE, 0, QString("%1/f_tail.txt").arg(testDir->path()).toUtf8()); + ASSERT_EQ(::send(clientFd, tail.constData(), size_t(tail.size()), MSG_NOSIGNAL), + qint64(tail.size())); + timer.restart(); + while (createdSpy.count() < kEventCount + 1 && !timer.hasExpired(5000)) + QTest::qWait(100); + EXPECT_EQ(createdSpy.count(), kEventCount + 1); + EXPECT_EQ(lostSpy.count(), 0); +} + +// 用户态队列溢出：丢弃新事件并发出 eventsLost（UPDATE 补偿触发点），连接不断 +TEST_F(TestVfsMonitorThroughput, QueueOverflowTriggersEventsLost) +{ + // 用小容量队列重建 watcher（cap=100） + qputenv("DFM_VFSMONITOR_MAX_QUEUE", "100"); + clientFd = -1; // 旧 fd 归属旧 watcher，由其析构关闭 + delete watcher; + watcher = VfsMonitorFileSystemWatcher::create({ testDir->path() }, {}, nullptr); + ASSERT_NE(watcher, nullptr); + clientFd = waitForAccept(listenFd, 3000); + ASSERT_GE(clientFd, 0); + + QSignalSpy createdSpy(watcher, &VfsMonitorFileSystemWatcher::fileCreated); + QSignalSpy lostSpy(watcher, &VfsMonitorFileSystemWatcher::eventsLost); + ASSERT_TRUE(createdSpy.isValid()); + ASSERT_TRUE(lostSpy.isValid()); + + constexpr int kEventCount = 2000; + + // 主线程阻塞期间（不处理事件）灌入 2000 个事件，队列(cap=100)必然溢出 + int sent = 0; + std::thread sender([&] { + sent = floodFileCreatedEvents(clientFd, testDir->path(), kEventCount, 0); + }); + QTest::qSleep(500); + sender.join(); + ASSERT_EQ(sent, kEventCount) << "flood should complete (blocking send + draining reader)"; + + // 恢复事件循环，让队列被消费、溢出被上报 + QElapsedTimer timer; + timer.start(); + while (lostSpy.count() == 0 && !timer.hasExpired(10000)) + QTest::qWait(100); + + EXPECT_GE(lostSpy.count(), 1) << "eventsLost must be emitted on queue overflow"; + EXPECT_LT(createdSpy.count(), kEventCount) << "overflow must drop events"; + EXPECT_GE(createdSpy.count(), 1) << "pre-overflow events must still be delivered"; +} + +// 服务端断连（等同被 dispatcher 踢掉/重启）：eventsLost 触发 + 自动重连 +TEST_F(TestVfsMonitorThroughput, DisconnectEmitsEventsLostAndReconnects) +{ + ASSERT_NE(watcher, nullptr); + + QSignalSpy lostSpy(watcher, &VfsMonitorFileSystemWatcher::eventsLost); + ASSERT_TRUE(lostSpy.isValid()); + + // 模拟服务端踢掉客户端 + ::close(clientFd); + clientFd = -1; + + QElapsedTimer timer; + timer.start(); + while (lostSpy.count() == 0 && !timer.hasExpired(5000)) + QTest::qWait(100); + EXPECT_EQ(lostSpy.count(), 1) << "eventsLost must be emitted exactly once on disconnect"; + + int reconnectedFd = waitForAccept(listenFd, 6000); + ASSERT_GE(reconnectedFd, 0) << "watcher did not reconnect after disconnect"; + ::close(reconnectedFd); +} diff --git a/autotests/index/test_workerpipe.cpp b/autotests/index/test_workerpipe.cpp new file mode 100644 index 00000000..7d550144 --- /dev/null +++ b/autotests/index/test_workerpipe.cpp @@ -0,0 +1,86 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +/** + * @file test_workerpipe.cpp + * @brief Unit tests for WorkerPipe (libextractor/workerpipe.cpp) — the + * dependency-light subset: ctor, dtor, hasPendingPartialMessage (default + * false), sendStatus/sendStarted/sendData/sendFailed/sendBatchDone + * (all fail gracefully when not initialized — no stdout writes). + * initialize() is NOT invoked (it redirects stdin/stdout which would + * break the test harness). + */ + +#include +#include +#include + +#include "dfm_test_main.h" +#include "index_global.h" +#include "workerpipe.h" +#include "extractortypes.h" + +using namespace deepin_anything_extractor; + +TEST(WorkerPipeTest, CtorAndDtorSafe) +{ + { + WorkerPipe w; + SUCCEED(); + } +} + +TEST(WorkerPipeTest, HasPendingPartialMessageDefaultsFalse) +{ + WorkerPipe w; + EXPECT_FALSE(w.hasPendingPartialMessage()); +} + +TEST(WorkerPipeTest, SendStatusFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendStatus(ExtractorStatus::Started, "/tmp/file.txt")); +} + +TEST(WorkerPipeTest, SendStartedFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendStarted("/tmp/file.txt")); +} + +TEST(WorkerPipeTest, SendDataFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendData("/tmp/file.txt", QByteArray("data"))); +} + +TEST(WorkerPipeTest, SendFailedFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendFailed("/tmp/file.txt", "error message")); +} + +TEST(WorkerPipeTest, SendBatchDoneFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendBatchDone()); +} + +TEST(WorkerPipeTest, SendStatusBatchDoneFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendStatus(ExtractorStatus::BatchDone)); +} + +TEST(WorkerPipeTest, SendStatusDataFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendStatus(ExtractorStatus::Data, "/tmp/file.txt", QByteArray("content"))); +} + +TEST(WorkerPipeTest, SendStatusFailedFailsWhenNotInitialized) +{ + WorkerPipe w; + EXPECT_FALSE(w.sendStatus(ExtractorStatus::Failed, "/tmp/file.txt", QByteArray("error"))); +} diff --git a/autotests/run-ut.sh b/autotests/run-ut.sh new file mode 100755 index 00000000..ac4f4f1d --- /dev/null +++ b/autotests/run-ut.sh @@ -0,0 +1,198 @@ +#!/bin/bash +# SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +# +# SPDX-License-Identifier: GPL-3.0-or-later + +# run-ut.sh - Build, run, and optionally generate coverage for deepin-anything unit tests. +# +# Usage: +# ./autotests/run-ut.sh # build + run tests +# ./autotests/run-ut.sh --coverage # build with coverage instrumentation + run + generate report +# ./autotests/run-ut.sh --run-only # run tests without rebuilding +# +set -euo pipefail + +export SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +export PROJECT_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd)" +export BUILD_DIR="${PROJECT_ROOT}/build-autotests" +export builddir=build-autotests +export reportdir=build-autotests +export projectdir="${PROJECT_ROOT}" +COVERAGE=false +RUN_ONLY=false + +# Parse arguments +for arg in "$@"; do + case "$arg" in + --coverage) COVERAGE=true ;; + --run-only) RUN_ONLY=true ;; + --help|-h) + echo "Usage: $0 [--coverage] [--run-only]" + echo " --coverage Enable gcov coverage instrumentation and generate HTML report" + echo " --run-only Run existing tests without rebuilding" + exit 0 + ;; + *) + echo "Unknown option: $arg" + exit 1 + ;; + esac +done + +# Step 1: Configure +if [ "${RUN_ONLY}" = false ]; then + echo "==> [1/4] Configuring..." + rm -rf "${BUILD_DIR}" + mkdir -p "${BUILD_DIR}" + + CMAKE_ARGS=( + -S "${PROJECT_ROOT}" + -B "${BUILD_DIR}" + -DCMAKE_BUILD_TYPE=Debug + -DCMAKE_EXPORT_COMPILE_COMMANDS=ON + -DCMAKE_INSTALL_PREFIX=/usr + -DOPT_ENABLE_BUILD_UT=ON + ) + + if [ "${COVERAGE}" = true ]; then + CMAKE_ARGS+=( + -DANYTHING_ENABLE_COVERAGE=ON + -DCMAKE_CXX_FLAGS="--coverage -O0 -fno-inline" + -DCMAKE_EXE_LINKER_FLAGS="--coverage" + ) + fi + + cmake "${CMAKE_ARGS[@]}" + + # Step 2: Build + echo "==> [2/4] Building..." + cmake --build "${BUILD_DIR}" -j"$(nproc)" +fi + +# Step 3: Run tests and collect results +echo "==> [3/4] Running tests..." +cd "${BUILD_DIR}" + +# Use offscreen Qt platform to avoid display dependencies. +export QT_QPA_PLATFORM="offscreen" + +# Discover test binaries +GTEST_RESULTS_DIR="${BUILD_DIR}/gtest-results" +mkdir -p "${GTEST_RESULTS_DIR}" + +test_bins=() +while IFS= read -r -d '' bin; do + test_bins+=("$bin") +done < <(find "${BUILD_DIR}/autotests" -type f -executable -name 'ut-*' -print0 | sort -z) + +if [ ${#test_bins[@]} -eq 0 ]; then + echo "ERROR: No test binaries found under ${BUILD_DIR}/autotests" + exit 1 +fi + +echo "Found ${#test_bins[@]} test binaries:" +for bin in "${test_bins[@]}"; do + echo " $(basename "$bin")" +done +echo "" + +# Run each test binary with gtest XML output. +# Each binary is capped at 10 minutes so a hung test can never block the +# remaining ones; the run always produces a complete result set. +UT_TIMEOUT_SEC=600 +any_failed=0 +set +e +for bin in "${test_bins[@]}"; do + name=$(basename "$bin") + echo "---- Running ${name} (timeout ${UT_TIMEOUT_SEC}s) ----" + if timeout "${UT_TIMEOUT_SEC}" "$bin" --gtest_output="xml:${GTEST_RESULTS_DIR}/${name}.xml"; then + echo " ${name}: PASSED" + else + rc=$? + if [ "$rc" -eq 124 ]; then + echo " ${name}: FAILED (timeout after ${UT_TIMEOUT_SEC}s)" + else + echo " ${name}: FAILED (exit ${rc})" + fi + any_failed=1 + fi +done +set -e + +echo "" +if [ "$any_failed" -eq 0 ]; then + echo "All test binaries passed." +else + echo "Some test binaries FAILED." +fi + +# Step 4: Coverage report +if [ "${COVERAGE}" = true ]; then + echo "==> [4/4] Generating coverage report..." + + COVERAGE_DIR="${BUILD_DIR}/coverage" + mkdir -p "${COVERAGE_DIR}" + + # --- Baseline from .gcno (compiled-but-unrun source files) --- + # lcov --capture only reads .gcda runtime data and silently drops every + # file that was compiled with --coverage but never executed. That shrinks + # the denominator and inflates the coverage %. Capturing an initial + # baseline from the .gcno files and merging it back in forces those files + # into the report at 0%, so the figure reflects the real whole-project + # denominator rather than only what tests happened to touch. + lcov --capture --initial --directory "${BUILD_DIR}" \ + --output-file "${COVERAGE_DIR}/baseline.info" \ + --rc lcov_branch_coverage=1 2>/dev/null || true + + # --- Runtime coverage from .gcda (after test execution) --- + lcov --capture --directory "${BUILD_DIR}" \ + --output-file "${COVERAGE_DIR}/run.info" \ + --rc lcov_branch_coverage=1 2>/dev/null || true + + # --- Merge: keep real hit counts; files only in the baseline stay at 0% --- + if [ -s "${COVERAGE_DIR}/baseline.info" ]; then + lcov --add-tracefile "${COVERAGE_DIR}/baseline.info" \ + --add-tracefile "${COVERAGE_DIR}/run.info" \ + --output-file "${COVERAGE_DIR}/coverage.info" \ + --rc lcov_branch_coverage=1 2>/dev/null || true + else + cp "${COVERAGE_DIR}/run.info" "${COVERAGE_DIR}/coverage.info" + fi + + # Filter to only include project source files + lcov --remove "${COVERAGE_DIR}/coverage.info" \ + '*/3rdparty/*' \ + '*/testutils/*' \ + '*/autotests/*' \ + '*/build*' \ + '/usr/*' \ + --output-file "${COVERAGE_DIR}/coverage-filtered.info" \ + --rc lcov_branch_coverage=1 2>/dev/null || true + + # Generate HTML report + genhtml "${COVERAGE_DIR}/coverage-filtered.info" \ + --output-directory "${COVERAGE_DIR}/html" \ + --branch-coverage \ + --legend \ + --title "deepin-anything - Unit Test Coverage" 2>/dev/null || true + + # Print summary + echo "" + echo "Coverage report generated at: ${COVERAGE_DIR}/html/index.html" + lcov --summary "${COVERAGE_DIR}/coverage-filtered.info" --rc lcov_branch_coverage=1 2>/dev/null || \ + echo "Warning: Could not generate coverage summary (lcov may not be installed)" +fi + +# Step 5: Generate summary JSON +echo "==> Generating summary JSON: ${BUILD_DIR}/ut-summary.json" + +# gtest XML and coverage info paths differ from the defaults, override via env +export GTEST_XML_DIR="${BUILD_DIR}/gtest-results" +if [ "${COVERAGE}" = true ]; then + export COVERAGE_INFO="${BUILD_DIR}/coverage/coverage-filtered.info" +fi + +python3 "${SCRIPT_DIR}/gen-ut-summary.py" + +echo "" +echo "Done." diff --git a/cmake/AnythingTestUtils.cmake b/cmake/AnythingTestUtils.cmake new file mode 100644 index 00000000..8830f02b --- /dev/null +++ b/cmake/AnythingTestUtils.cmake @@ -0,0 +1,67 @@ +# AnythingTestUtils.cmake - Test utilities for deepin-anything C++ tests. +# Mirrors the old dfm_add_test helper: gtest + vendored cpp-stub/stub-ext +# (white-box tests recompile the target's own sources with +# -fno-access-control). + +cmake_minimum_required(VERSION 3.10) + +function(anything_add_test name) + cmake_parse_arguments(ARG "" "" "SOURCES;LINK_LIBRARIES;INCLUDE_DIRS" ${ARGN}) + + if(NOT ARG_SOURCES) + message(FATAL_ERROR "anything_add_test(${name}): SOURCES is required") + endif() + + find_package(GTest REQUIRED) + find_package(Qt6 COMPONENTS Test REQUIRED) + + # testutils stub sources (stub-ext) and shadowing stub headers (cpp-stub) + set(_stub_root "${CMAKE_SOURCE_DIR}/3rdparty/testutils") + if(NOT EXISTS "${_stub_root}") + message(FATAL_ERROR "Anything: testutils not found at ${_stub_root}") + endif() + + set(_all_sources ${ARG_SOURCES}) + file(GLOB _stub_src "${_stub_root}/stub-ext/*.cpp") + list(APPEND _all_sources ${_stub_src}) + + add_executable(${name} ${_all_sources}) + # -fno-access-control: white-box testing (stub-ext private access). + # -Wno-pmf-conversions: vendored 3rdparty/testutils/stub-ext relies on + # member-function-pointer punning. + target_compile_options(${name} PRIVATE + -fno-access-control + -Wno-pmf-conversions + ) + target_compile_definitions(${name} PRIVATE DEBUG_STUB_INVOKE) + target_include_directories(${name} PRIVATE + ${_stub_root} + ${_stub_root}/cpp-stub + ${_stub_root}/stub-ext + ) + + if(ARG_INCLUDE_DIRS) + target_include_directories(${name} PRIVATE ${ARG_INCLUDE_DIRS}) + endif() + + target_link_libraries(${name} PRIVATE + GTest::gtest + GTest::gtest_main + pthread + Qt6::Test + ) + if(ARG_LINK_LIBRARIES) + target_link_libraries(${name} PRIVATE ${ARG_LINK_LIBRARIES}) + endif() + + # Enable coverage flags if requested (only via run-ut.sh --coverage) + if(ANYTHING_ENABLE_COVERAGE) + target_compile_options(${name} PRIVATE --coverage -O0 -fno-inline) + target_link_libraries(${name} PRIVATE gcov) + endif() + + add_test(NAME ${name} COMMAND ${name}) + message(STATUS "Anything: Added test ${name}") +endfunction() + +message(STATUS "Anything: Test utilities module loaded") diff --git a/config/CMakeLists.txt b/config/CMakeLists.txt index 8aed0e8f..a20f48e9 100755 --- a/config/CMakeLists.txt +++ b/config/CMakeLists.txt @@ -1,5 +1,6 @@ -install(FILES pinyin.txt DESTINATION share/deepin-anything-server) +# pinyin.txt is installed by the src/index subproject (D13: single source, +# /usr/share/deepin-anything-index/). # Install dconfig meta file install(FILES ${CMAKE_SOURCE_DIR}/assets/org.deepin.anything.json DESTINATION share/dsg/configs/org.deepin.anything) diff --git a/debian/control b/debian/control index e47c378c..fd006421 100644 --- a/debian/control +++ b/debian/control @@ -10,6 +10,15 @@ Build-Depends: libnl-genl-3-dev, libmount-dev, libglib2.0-dev, + qt6-base-dev, + liblucene++-dev (>= 3.0.8-deepin5), + libboost-filesystem-dev, + libdtk6core-dev, + libdfm6-search-dev, + libkf6idletime-dev, + libdocparser-dev, + libdtk6ocr-dev, + libgtest-dev Standards-Version: 3.9.8 Homepage: http://github.com/linuxdeepin/deepin-anything @@ -24,3 +33,13 @@ Architecture: any Depends: ${shlibs:Depends}, ${misc:Depends} Description: Deepin Anything server package This is the server part of Deepin Anything, which includes core functionality for the application. + +Package: deepin-anything-index +Architecture: any +Depends: deepin-anything-server, + ${shlibs:Depends}, ${misc:Depends} +Replaces: dde-file-manager (<< 6.6.7) +Description: deepin desktop-environment - anything index service + User-level D-Bus activated index service migrated from dde-file-manager + textindex, together with its private content extractor subprocess + deepin-anything-extractor. diff --git a/debian/deepin-anything-index.install b/debian/deepin-anything-index.install new file mode 100644 index 00000000..57dd1e56 --- /dev/null +++ b/debian/deepin-anything-index.install @@ -0,0 +1,7 @@ +usr/bin/deepin-anything-index +usr/libexec/deepin-anything-extractor +usr/lib/*/deepin-anything/extractor/plugins/* +usr/lib/*/libdeepin-anything-extractor.so* +usr/lib/systemd/user/deepin-anything-index.service +usr/share/dbus-1/services/org.deepin.Filemanager.TextIndex.service +usr/share/deepin-anything-index/pinyin.txt diff --git a/debian/deepin-anything-server.install b/debian/deepin-anything-server.install index c1463473..f33bc6df 100644 --- a/debian/deepin-anything-server.install +++ b/debian/deepin-anything-server.install @@ -1,3 +1,4 @@ -/usr/libexec +usr/libexec/deepin-anything-server +usr/libexec/deepin-anything-logger /usr/lib/systemd/system/deepin-anything-logger.service -/usr/share +usr/share/dsg diff --git a/examples/env-monitor/CMakeLists.txt b/examples/env-monitor/CMakeLists.txt new file mode 100644 index 00000000..26c01c89 --- /dev/null +++ b/examples/env-monitor/CMakeLists.txt @@ -0,0 +1,51 @@ +cmake_minimum_required(VERSION 3.10) + +project(env-monitor) + +set(CMAKE_AUTOMOC ON) +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +find_package(Qt6 COMPONENTS Core Widgets DBus REQUIRED) +find_package(Dtk6 COMPONENTS Core Widget REQUIRED) +find_package(dfm6-search REQUIRED) +find_package(KF6IdleTime REQUIRED) + +set(DEMO_FILES + main.cpp + mainwindow.cpp + mainwindow.h +) + +# The env module (EnvDetector/PowerMonitor/IdleMonitor/LoadMonitor) and +# TextIndexConfig are compiled in from the main source tree; this project is +# not part of the main build tree. +set(INDEX_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../../src/index) +set(ENV_SOURCES + ${INDEX_SRC_DIR}/env/envdetector.cpp + ${INDEX_SRC_DIR}/env/idlemonitor.cpp + ${INDEX_SRC_DIR}/env/loadmonitor.cpp + ${INDEX_SRC_DIR}/env/powermonitor.cpp + ${INDEX_SRC_DIR}/utils/textindexconfig.cpp +) + +add_executable(${PROJECT_NAME} + ${DEMO_FILES} + ${ENV_SOURCES} +) + +target_link_libraries(${PROJECT_NAME} PRIVATE + Qt6::Core + Qt6::Widgets + Qt6::DBus + Dtk6::Core + Dtk6::Widget + dfm6-search + KF6::IdleTime +) + +target_include_directories(${PROJECT_NAME} PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + ${INDEX_SRC_DIR} +) + +message(STATUS "env-monitor configured (standalone project, not part of the main build tree)") diff --git a/examples/env-monitor/main.cpp b/examples/env-monitor/main.cpp new file mode 100644 index 00000000..9bbb74ad --- /dev/null +++ b/examples/env-monitor/main.cpp @@ -0,0 +1,31 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "mainwindow.h" + +#include +#include +#include + +#include + +DWIDGET_USE_NAMESPACE + +int main(int argc, char *argv[]) +{ + DApplication a(argc, argv); + a.setApplicationName("env-monitor-test"); + a.setApplicationVersion("1.0.0"); + a.setProductName(QObject::tr("Env Monitor Test")); + a.setProductIcon(QIcon::fromTheme("preferences-system")); + + a.loadTranslator(); + + MainWindow w; + w.show(); + + Dtk::Widget::moveToCenter(&w); + + return a.exec(); +} diff --git a/examples/env-monitor/mainwindow.cpp b/examples/env-monitor/mainwindow.cpp new file mode 100644 index 00000000..9c64cd6b --- /dev/null +++ b/examples/env-monitor/mainwindow.cpp @@ -0,0 +1,282 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "mainwindow.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +MainWindow::MainWindow(QWidget *parent) + : DMainWindow(parent) + , m_envDetector(&EnvDetector::instance()) + , m_powerMonitor(new PowerMonitor(this)) + , m_idleMonitor(new IdleMonitor(this)) + , m_loadMonitor(new LoadMonitor(this)) +{ + setupUI(); + + connect(m_envDetector, &EnvDetector::envStateChanged, + this, &MainWindow::onEnvStateChanged); + connect(m_powerMonitor, &PowerMonitor::effectivePowerChanged, + this, &MainWindow::onPowerChanged); + connect(m_idleMonitor, &IdleMonitor::idleChanged, + this, &MainWindow::onIdleChanged); + connect(m_loadMonitor, &LoadMonitor::loadChanged, + this, &MainWindow::onLoadChanged); + + m_refreshTimer = new QTimer(this); + m_refreshTimer->setInterval(1000); + connect(m_refreshTimer, &QTimer::timeout, this, &MainWindow::refreshDisplay); + m_refreshTimer->start(); +} + +MainWindow::~MainWindow() +{ + if (m_running) { + // EnvDetector is a singleton — don't stop it here, only stop the + // monitors we own. + m_powerMonitor->stop(); + m_idleMonitor->stop(); + m_loadMonitor->stop(); + } +} + +void MainWindow::setupUI() +{ + setWindowTitle(tr("Env Monitor Test")); + setMinimumSize(900, 700); + + QWidget *centralWidget = new QWidget(this); + setCentralWidget(centralWidget); + + QVBoxLayout *mainLayout = new QVBoxLayout(centralWidget); + mainLayout->setContentsMargins(10, 10, 10, 10); + mainLayout->setSpacing(10); + + QGroupBox *controlGroup = new QGroupBox(tr("Control"), this); + QHBoxLayout *controlLayout = new QHBoxLayout(controlGroup); + + controlLayout->addWidget(new QLabel(tr("Data Path:"), this)); + m_pathEdit = new DLineEdit(this); + m_pathEdit->setText(QDir::homePath()); + controlLayout->addWidget(m_pathEdit); + + m_startBtn = new DPushButton(tr("Start"), this); + controlLayout->addWidget(m_startBtn); + + m_stopBtn = new DPushButton(tr("Stop"), this); + m_stopBtn->setEnabled(false); + controlLayout->addWidget(m_stopBtn); + + m_clearBtn = new DPushButton(tr("Clear Log"), this); + controlLayout->addWidget(m_clearBtn); + + mainLayout->addWidget(controlGroup); + + QGroupBox *statusGroup = new QGroupBox(tr("Status"), this); + QVBoxLayout *statusLayout = new QVBoxLayout(statusGroup); + m_statusView = new DTextBrowser(this); + m_statusView->setReadOnly(true); + m_statusView->setOpenExternalLinks(false); + statusLayout->addWidget(m_statusView); + statusGroup->setMinimumHeight(300); + mainLayout->addWidget(statusGroup, 3); + + QGroupBox *logGroup = new QGroupBox(tr("Event Log"), this); + QVBoxLayout *logLayout = new QVBoxLayout(logGroup); + m_logView = new DTextBrowser(this); + m_logView->setReadOnly(true); + m_logView->setOpenExternalLinks(false); + logLayout->addWidget(m_logView); + mainLayout->addWidget(logGroup, 2); + + connect(m_startBtn, &DPushButton::clicked, this, &MainWindow::onStart); + connect(m_stopBtn, &DPushButton::clicked, this, &MainWindow::onStop); + connect(m_clearBtn, &DPushButton::clicked, this, &MainWindow::onClearLog); + + refreshDisplay(); +} + +void MainWindow::onStart() +{ + const QString dataPath = m_pathEdit->text(); + if (dataPath.isEmpty()) { + logEvent("Error", "Data path is empty"); + return; + } + + m_envDetector->setDataPath(dataPath); + m_loadMonitor->setDataPath(dataPath); + + m_envDetector->start(); + m_powerMonitor->start(); + m_idleMonitor->start(); + m_loadMonitor->start(); + + m_running = true; + m_startBtn->setEnabled(false); + m_stopBtn->setEnabled(true); + + logEvent("System", "All monitors started (dataPath=" + dataPath + ")"); + refreshDisplay(); +} + +void MainWindow::onStop() +{ + // EnvDetector is a singleton — don't stop it, only stop owned monitors. + m_powerMonitor->stop(); + m_idleMonitor->stop(); + m_loadMonitor->stop(); + + m_running = false; + m_startBtn->setEnabled(true); + m_stopBtn->setEnabled(false); + + logEvent("System", "All monitors stopped"); + refreshDisplay(); +} + +void MainWindow::onClearLog() +{ + m_logView->clear(); +} + +void MainWindow::refreshDisplay() +{ + const QString greenFmt = "%1"; + const QString redFmt = "%1"; + + auto boolColor = [&](bool condition, const QString &label) -> QString { + QString text = label + ": " + (condition ? "true" : "false"); + return condition ? greenFmt.arg(text) : redFmt.arg(text); + }; + + auto coloredValue = [&](bool ok, const QString &label, bool value) -> QString { + QString text = label + ": " + QString(value ? "true" : "false"); + return ok ? greenFmt.arg(text) : redFmt.arg(text); + }; + + auto labeledValue = [&](bool condition, const QString &label, + const QString &trueDesc, const QString &falseDesc) -> QString { + QString text = label + ": " + (condition ? "true" : "false") + + " (" + (condition ? trueDesc : falseDesc) + ")"; + return condition ? greenFmt.arg(text) : redFmt.arg(text); + }; + + auto numericLabeled = [&](bool condition, const QString &label, + const QString &detail) -> QString { + QString text = label + " " + (condition ? "true" : "false") + " " + detail; + return condition ? greenFmt.arg(text) : redFmt.arg(text); + }; + + QString html; + html += "
";
+
+    // EnvDetector
+    html += "========== EnvDetector (聚合状态) ==========
";
+    html += "运行状态: " + QString(m_running ? "running" : "stopped") + "
";
+    EnvState state = m_envDetector->currentState();
+    html += "onBattery: " + QString(state.onBattery ? "true" : "false") + "
";
+    html += "powerSaveMode: " + QString(state.powerSaveMode ? "true" : "false") + "
";
+    html += "idle: " + QString(state.idle ? "true" : "false") + "
";
+    html += labeledValue(state.isPowerOk(), "isPowerOk()",
+                         "电源OK", "使用电池") + "
";
+    html += labeledValue(state.isPowerSaveOff(), "isPowerSaveOff()",
+                         "省电已关闭", "省电模式中") + "
";
+    html += labeledValue(state.isIdleOk(), "isIdleOk()",
+                         "空闲OK", "用户活动中") + "
";
+
+    // PowerMonitor
+    html += "
========== PowerMonitor (电源监控) ==========
";
+    html += labeledValue(!m_powerMonitor->onBattery(), "onBattery()",
+                         "使用市电", "使用电池") + "
";
+    html += labeledValue(!m_powerMonitor->powerSaveMode(), "powerSaveMode()",
+                         "非省电模式", "省电模式") + "
";
+
+    // IdleMonitor
+    html += "
========== IdleMonitor (空闲监控) ==========
";
+    html += labeledValue(m_idleMonitor->idle(), "idle()",
+                         "用户空闲", "用户活动中") + "
";
+
+    // LoadMonitor
+    html += "
========== LoadMonitor (负载监控) ==========
";
+    double cpu = m_loadMonitor->cpuAvgPercent();
+    double disk = m_loadMonitor->diskBusyPercent();
+    bool cpuOk = m_loadMonitor->isCpuBelowThreshold();
+    bool diskOk = m_loadMonitor->isDiskBelowThreshold();
+    html += QString("cpuAvgPercent(): %1 % (instant: %2 %)
").arg(cpu, 0, 'f', 2).arg(m_loadMonitor->cpuInstantPercent(), 0, 'f', 2);
+    html += QString("diskBusyPercent(): %1 % (instant: %2 %)
").arg(disk, 0, 'f', 2).arg(m_loadMonitor->diskInstantPercent(), 0, 'f', 2);
+    html += numericLabeled(cpuOk, "isCpuBelowThreshold():",
+                           QStringLiteral("(阈值: %1 %)").arg(m_loadMonitor->cpuThresholdPercent())) + "
";
+    html += numericLabeled(diskOk, "isDiskBelowThreshold():",
+                           QStringLiteral("(阈值: %1 %)").arg(m_loadMonitor->diskThresholdPercent())) + "
";
+
+    html += "
"; + + // Skip refresh while user is selecting text — setHtml replaces the + // entire document and destroys any active selection. + if (m_statusView->textCursor().hasSelection()) { + return; + } + + // Save scroll position before setHtml resets it to top + QScrollBar *vBar = m_statusView->verticalScrollBar(); + int scrollPos = vBar ? vBar->value() : 0; + + m_statusView->setHtml(html); + + if (vBar) { + vBar->setValue(scrollPos); + } +} + +void MainWindow::onEnvStateChanged(const EnvState &state) +{ + logEvent("EnvDetector", + QString("envStateChanged -> onBattery=%1 powerSaveMode=%2 idle=%3 (powerOk=%4 powerSaveOff=%5 idleOk=%6)") + .arg(state.onBattery) + .arg(state.powerSaveMode) + .arg(state.idle) + .arg(state.isPowerOk()) + .arg(state.isPowerSaveOff()) + .arg(state.isIdleOk())); +} + +void MainWindow::onPowerChanged(bool onBattery, bool powerSave) +{ + logEvent("PowerMonitor", + QString("effectivePowerChanged -> onBattery=%1 powerSave=%2") + .arg(onBattery) + .arg(powerSave)); +} + +void MainWindow::onIdleChanged(bool idle) +{ + logEvent("IdleMonitor", + QString("idleChanged -> idle=%1").arg(idle)); +} + +void MainWindow::onLoadChanged(double cpuAvgPercent, double diskBusyPercent) +{ + logEvent("LoadMonitor", + QString("loadChanged -> cpuAvg=%1% diskAvg=%2% | cpuNow=%3% diskNow=%4%") + .arg(cpuAvgPercent, 0, 'f', 2) + .arg(diskBusyPercent, 0, 'f', 2) + .arg(m_loadMonitor->cpuInstantPercent(), 0, 'f', 2) + .arg(m_loadMonitor->diskInstantPercent(), 0, 'f', 2)); +} + +void MainWindow::logEvent(const QString &category, const QString &message) +{ + QString timestamp = QDateTime::currentDateTime().toString("hh:mm:ss.zzz"); + QString line = QString("[%1] [%2] %3").arg(timestamp, category, message); + m_logView->append(line); +} diff --git a/examples/env-monitor/mainwindow.h b/examples/env-monitor/mainwindow.h new file mode 100644 index 00000000..bff65d63 --- /dev/null +++ b/examples/env-monitor/mainwindow.h @@ -0,0 +1,63 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef MAINWINDOW_H +#define MAINWINDOW_H + +#include "env/envdetector.h" +#include "env/powermonitor.h" +#include "env/idlemonitor.h" +#include "env/loadmonitor.h" + +#include +#include +#include +#include + +#include + +DWIDGET_USE_NAMESPACE + +ANYTHING_INDEX_USE_NAMESPACE + +class MainWindow : public DMainWindow +{ + Q_OBJECT + +public: + explicit MainWindow(QWidget *parent = nullptr); + ~MainWindow() override; + +private slots: + void onStart(); + void onStop(); + void onClearLog(); + void refreshDisplay(); + + void onEnvStateChanged(const EnvState &state); + void onPowerChanged(bool onBattery, bool powerSave); + void onIdleChanged(bool idle); + void onLoadChanged(double cpuAvgPercent, double diskBusyPercent); + +private: + void setupUI(); + void logEvent(const QString &category, const QString &message); + + DLineEdit *m_pathEdit = nullptr; + DPushButton *m_startBtn = nullptr; + DPushButton *m_stopBtn = nullptr; + DPushButton *m_clearBtn = nullptr; + DTextBrowser *m_statusView = nullptr; + DTextBrowser *m_logView = nullptr; + QTimer *m_refreshTimer = nullptr; + + EnvDetector *m_envDetector = nullptr; // singleton reference (not owned) + PowerMonitor *m_powerMonitor = nullptr; + IdleMonitor *m_idleMonitor = nullptr; + LoadMonitor *m_loadMonitor = nullptr; + + bool m_running = false; +}; + +#endif // MAINWINDOW_H diff --git a/examples/extractor-demo/CMakeLists.txt b/examples/extractor-demo/CMakeLists.txt new file mode 100644 index 00000000..22a7f8bb --- /dev/null +++ b/examples/extractor-demo/CMakeLists.txt @@ -0,0 +1,42 @@ +cmake_minimum_required(VERSION 3.10) + +project(extractor-demo) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) +set(CMAKE_AUTOMOC ON) + +find_package(Qt6 COMPONENTS Core Widgets REQUIRED) +find_package(Dtk6 COMPONENTS Core Widget REQUIRED) + +# Standalone demo: pull in the extractor communication library from the main +# source tree (this project is not part of the main build tree). +set(EXTRACTOR_LIB_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../../src/extractor/libextractor) +add_subdirectory(${EXTRACTOR_LIB_DIR} ${CMAKE_CURRENT_BINARY_DIR}/libextractor) + +set(DEMO_FILES + main.cpp + mainwindow.cpp + mainwindow.h +) + +add_executable(${PROJECT_NAME} + ${DEMO_FILES} +) + +target_link_libraries(${PROJECT_NAME} PRIVATE + Qt6::Core + Qt6::Widgets + Dtk6::Core + Dtk6::Widget + deepin-anything-extractor-lib +) + +target_include_directories(${PROJECT_NAME} PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} +) + +target_compile_definitions(${PROJECT_NAME} PRIVATE + ANYTHING_EXTRACTOR_TOOL="/usr/libexec/deepin-anything-extractor" +) + +message(STATUS "extractor-demo configured (standalone project, not part of the main build tree)") diff --git a/examples/extractor-demo/main.cpp b/examples/extractor-demo/main.cpp new file mode 100644 index 00000000..32265d55 --- /dev/null +++ b/examples/extractor-demo/main.cpp @@ -0,0 +1,32 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "mainwindow.h" + +#include +#include +#include + +#include + +DWIDGET_USE_NAMESPACE + +int main(int argc, char *argv[]) +{ + DApplication a(argc, argv); + a.setApplicationName("extractor-test"); + a.setApplicationVersion("1.0.0"); + a.setProductName(QObject::tr("Extractor Test")); + a.setProductIcon(QIcon::fromTheme("preferences-system")); + + // Load translations + a.loadTranslator(); + + MainWindow w; + w.show(); + + Dtk::Widget::moveToCenter(&w); + + return a.exec(); +} diff --git a/examples/extractor-demo/mainwindow.cpp b/examples/extractor-demo/mainwindow.cpp new file mode 100644 index 00000000..228d6970 --- /dev/null +++ b/examples/extractor-demo/mainwindow.cpp @@ -0,0 +1,427 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "mainwindow.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +DWIDGET_USE_NAMESPACE + +MainWindow::MainWindow(QWidget *parent) + : DMainWindow(parent), m_controllerPipe(new deepin_anything_extractor::ControllerPipe(this)) +{ + setupUI(); + + connect(m_controllerPipe, &deepin_anything_extractor::ControllerPipe::extractionStarted, + this, &MainWindow::onExtractionStarted); + connect(m_controllerPipe, &deepin_anything_extractor::ControllerPipe::extractionFinished, + this, &MainWindow::onExtractionFinished); + connect(m_controllerPipe, &deepin_anything_extractor::ControllerPipe::extractionFailed, + this, &MainWindow::onExtractionFailed); + connect(m_controllerPipe, &deepin_anything_extractor::ControllerPipe::batchFinished, + this, &MainWindow::onBatchFinished); + connect(m_controllerPipe, &deepin_anything_extractor::ControllerPipe::processCrashed, + this, &MainWindow::onProcessCrashed); + connect(m_controllerPipe, &deepin_anything_extractor::ControllerPipe::processFinished, + this, &MainWindow::onProcessFinished); + connect(m_controllerPipe, &deepin_anything_extractor::ControllerPipe::errorOccurred, + this, [this](const QString &error) { + log(tr("Extractor error: %1").arg(error)); + }); + + updateButtonStates(); +} + +MainWindow::~MainWindow() +{ + if (m_controllerPipe && m_controllerPipe->isRunning()) { + m_controllerPipe->stop(); + } +} + +void MainWindow::setupUI() +{ + setWindowTitle(tr("Extractor Test")); + setMinimumSize(800, 600); + + QWidget *centralWidget = new QWidget(this); + setCentralWidget(centralWidget); + + QVBoxLayout *mainLayout = new QVBoxLayout(centralWidget); + mainLayout->setContentsMargins(10, 10, 10, 10); + mainLayout->setSpacing(10); + + // Extractor path group + QGroupBox *extractorGroup = new QGroupBox(tr("Extractor Settings"), this); + QVBoxLayout *extractorLayout = new QVBoxLayout(extractorGroup); + + // Extractor path + QHBoxLayout *extractorPathLayout = new QHBoxLayout(); + extractorPathLayout->addWidget(new QLabel(tr("Extractor Path:"), this)); + m_extractorPathEdit = new DLineEdit(this); + m_extractorPathEdit->setPlaceholderText(tr("Path to dde-file-manager-extractor executable")); + extractorPathLayout->addWidget(m_extractorPathEdit); + m_browseExtractorBtn = new DPushButton(tr("Browse..."), this); + extractorPathLayout->addWidget(m_browseExtractorBtn); + extractorLayout->addLayout(extractorPathLayout); + + // Plugin path + QHBoxLayout *pluginPathLayout = new QHBoxLayout(); + pluginPathLayout->addWidget(new QLabel(tr("Plugin Path:"), this)); + m_pluginPathEdit = new DLineEdit(this); + m_pluginPathEdit->setPlaceholderText(tr("Optional: Path to extractor plugins")); + pluginPathLayout->addWidget(m_pluginPathEdit); + extractorLayout->addLayout(pluginPathLayout); + + // Start/Stop buttons + QHBoxLayout *controlLayout = new QHBoxLayout(); + m_startBtn = new DPushButton(tr("Start Extractor"), this); + m_startBtn->setEnabled(true); + controlLayout->addWidget(m_startBtn); + + m_stopBtn = new DPushButton(tr("Stop Extractor"), this); + m_stopBtn->setEnabled(false); + controlLayout->addWidget(m_stopBtn); + controlLayout->addStretch(); + extractorLayout->addLayout(controlLayout); + + mainLayout->addWidget(extractorGroup); + + // Directory selection group + QGroupBox *dirGroup = new QGroupBox(tr("Directory Extraction"), this); + QVBoxLayout *dirLayout = new QVBoxLayout(dirGroup); + + QHBoxLayout *directoryPathLayout = new QHBoxLayout(); + directoryPathLayout->addWidget(new QLabel(tr("Directory Path:"), this)); + m_directoryPathEdit = new DLineEdit(this); + m_directoryPathEdit->setPlaceholderText(tr("Directory containing files to extract")); + directoryPathLayout->addWidget(m_directoryPathEdit); + m_browseDirBtn = new DPushButton(tr("Browse..."), this); + directoryPathLayout->addWidget(m_browseDirBtn); + dirLayout->addLayout(directoryPathLayout); + + m_extractBtn = new DPushButton(tr("Extract All Files"), this); + m_extractBtn->setEnabled(false); + dirLayout->addWidget(m_extractBtn); + + mainLayout->addWidget(dirGroup); + + // Log view + QGroupBox *logGroup = new QGroupBox(tr("Log"), this); + QVBoxLayout *logLayout = new QVBoxLayout(logGroup); + + m_logView = new DTextEdit(this); + m_logView->setReadOnly(true); + logLayout->addWidget(m_logView); + + mainLayout->addWidget(logGroup); + + // Connect signals + connect(m_browseExtractorBtn, &DPushButton::clicked, this, &MainWindow::onBrowseExtractor); + connect(m_startBtn, &DPushButton::clicked, this, &MainWindow::onStartExtractor); + connect(m_stopBtn, &DPushButton::clicked, this, &MainWindow::onStopExtractor); + connect(m_browseDirBtn, &DPushButton::clicked, this, &MainWindow::onBrowseDirectory); + connect(m_extractBtn, &DPushButton::clicked, this, &MainWindow::onExtractDirectory); + + // Set default paths + QString defaultExtractorPath(ANYTHING_EXTRACTOR_TOOL); + if (!defaultExtractorPath.isEmpty()) { + m_extractorPathEdit->setText(defaultExtractorPath); + } +} + +void MainWindow::updateButtonStates() +{ + bool hasPath = !m_extractorPathEdit->text().isEmpty(); + m_startBtn->setEnabled(hasPath && !m_extractorRunning); + m_stopBtn->setEnabled(m_extractorRunning); + m_extractBtn->setEnabled(m_extractorRunning && !m_directoryPathEdit->text().isEmpty() && m_pendingFiles.isEmpty()); +} + +void MainWindow::log(const QString &message) +{ + QString timestamp = QDateTime::currentDateTime().toString("hh:mm:ss.zzz"); + m_logView->append(QString("[%1] %2").arg(timestamp).arg(message)); +} + +void MainWindow::onBrowseExtractor() +{ + QString path = DFileDialog::getOpenFileName(this, tr("Select Extractor Executable")); + if (!path.isEmpty()) { + m_extractorPathEdit->setText(path); + updateButtonStates(); + } +} + +void MainWindow::onStartExtractor() +{ + const QString extractorPath = m_extractorPathEdit->text(); + if (extractorPath.isEmpty()) { + log(tr("Error: Extractor path is empty")); + return; + } + + QStringList args; + const QString pluginPath = m_pluginPathEdit->text(); + if (!pluginPath.isEmpty()) { + args << "--plugin-path" << pluginPath; + } + + log(tr("Starting extractor...")); + if (m_controllerPipe->start(extractorPath, pluginPath)) { + log(tr("Extractor started successfully (PID: %1)").arg(m_controllerPipe->processId())); + m_extractorRunning = true; + } else { + log(tr("Failed to start extractor")); + } + + updateButtonStates(); +} + +void MainWindow::onStopExtractor() +{ + if (m_controllerPipe && m_extractorRunning) { + log(tr("Stopping extractor...")); + m_controllerPipe->stop(); + m_extractorRunning = false; + updateButtonStates(); + } +} + +void MainWindow::onBrowseDirectory() +{ + QString path = DFileDialog::getExistingDirectory(this, tr("Select Directory for Extraction")); + if (!path.isEmpty()) { + m_directoryPathEdit->setText(path); + updateButtonStates(); + } +} + +void MainWindow::onExtractDirectory() +{ + if (!m_controllerPipe || !m_extractorRunning) { + log(tr("Error: Extractor not running")); + return; + } + + const QString directoryPath = m_directoryPathEdit->text(); + if (directoryPath.isEmpty()) { + log(tr("Error: Directory path is empty")); + return; + } + + QDir dir(directoryPath); + if (!dir.exists()) { + log(tr("Error: Directory does not exist")); + return; + } + + // Collect all files + m_pendingFiles.clear(); + collectFiles(directoryPath); + + if (m_pendingFiles.isEmpty()) { + log(tr("No files found in directory")); + return; + } + + // Initialize counters + m_totalFiles = m_pendingFiles.size(); + m_processedFiles = 0; + m_successCount = 0; + m_failedCount = 0; + + // Setup output directory + setupOutputDirectory(directoryPath); + + log(tr("Found %1 files to process").arg(m_totalFiles)); + log(tr("Output directory: %1").arg(m_outputDir)); + + // Start processing + processNextFile(); + updateButtonStates(); +} + +void MainWindow::collectFiles(const QString &directory) +{ + QDirIterator it(directory, QDir::Files | QDir::NoSymLinks, QDirIterator::Subdirectories); + while (it.hasNext()) { + m_pendingFiles.enqueue(it.next()); + } +} + +void MainWindow::processNextFile() +{ + if (m_pendingFiles.isEmpty()) { + log(tr("Extraction completed: %1/%2 success, %3 failed") + .arg(m_successCount) + .arg(m_totalFiles) + .arg(m_failedCount)); + log(tr("Results saved to: %1").arg(m_outputDir)); + updateButtonStates(); + return; + } + + m_currentFile = m_pendingFiles.dequeue(); + + // Extract one file at a time + if (m_controllerPipe->extractBatch({ m_currentFile })) { + // Progress logged in onExtractionStarted + } else { + log(tr("Failed to send extraction request for: %1").arg(m_currentFile)); + saveExtractionError(m_currentFile, tr("Failed to send request")); + m_failedCount++; + m_processedFiles++; + processNextFile(); + } +} + +void MainWindow::setupOutputDirectory(const QString &sourceDir) +{ + QString timestamp = QDateTime::currentDateTime().toString("yyyyMMdd_hhmmss"); + QString baseName = QFileInfo(sourceDir).baseName(); + + // Create output directory under Documents + QString documentsPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation); + m_outputDir = QString("%1/%2_extracted_%3").arg(documentsPath).arg(baseName).arg(timestamp); + + QDir dir(m_outputDir); + if (!dir.exists()) { + dir.mkpath("."); + } + + // Create index file + QString indexPath = m_outputDir + "/_index.txt_content"; + QFile indexFile(indexPath); + if (indexFile.open(QIODevice::WriteOnly | QIODevice::Text)) { + QTextStream stream(&indexFile); + stream.setEncoding(QStringConverter::Utf8); + stream << "Source Directory: " << sourceDir << "\n"; + stream << "Extraction Time: " << QDateTime::currentDateTime().toString("yyyy-MM-dd hh:mm:ss") << "\n"; + stream << "Total Files: " << m_totalFiles << "\n"; + stream << "\n--- Results ---\n"; + indexFile.close(); + } +} + +void MainWindow::saveExtractionResult(const QString &filePath, const QByteArray &data) +{ + if (m_outputDir.isEmpty()) return; + + QFileInfo fi(filePath); + QString relativePath = fi.absolutePath(); + QString baseName = fi.completeBaseName(); + QString suffix = fi.suffix(); + + // Generate unique filename: basename.suffix.txt_content + // For files with same name in different directories, add hash + QString outputFileName = QString("%1.%2.txt_content").arg(baseName).arg(suffix); + + // Check for conflicts and add hash if needed + QString outputPath = m_outputDir + "/" + outputFileName; + if (QFile::exists(outputPath)) { + // Add path hash to differentiate + QByteArray pathHash = QCryptographicHash::hash(filePath.toUtf8(), QCryptographicHash::Md5).toHex().left(8); + outputFileName = QString("%1_%2.%3.txt_content").arg(baseName).arg(QString(pathHash)).arg(suffix); + outputPath = m_outputDir + "/" + outputFileName; + } + + // Write content + QFile outFile(outputPath); + if (outFile.open(QIODevice::WriteOnly | QIODevice::Text)) { + QTextStream stream(&outFile); + stream.setEncoding(QStringConverter::Utf8); + stream << QString::fromUtf8(data); + outFile.close(); + } + + // Append to index + QString indexPath = m_outputDir + "/_index.txt_content"; + QFile indexFile(indexPath); + if (indexFile.open(QIODevice::Append | QIODevice::Text)) { + QTextStream stream(&indexFile); + stream << "[OK] " << filePath << " -> " << outputFileName << "\n"; + indexFile.close(); + } +} + +void MainWindow::saveExtractionError(const QString &filePath, const QString &error) +{ + // Append error to index + if (m_outputDir.isEmpty()) return; + + QString indexPath = m_outputDir + "/_index.txt_content"; + QFile indexFile(indexPath); + if (indexFile.open(QIODevice::Append | QIODevice::Text)) { + QTextStream stream(&indexFile); + stream << "[FAIL] " << filePath << " - " << error << "\n"; + indexFile.close(); + } +} + +void MainWindow::onExtractionStarted(const QString &filePath) +{ + log(tr("[%1/%2] Processing: %3") + .arg(m_processedFiles + 1) + .arg(m_totalFiles) + .arg(QFileInfo(filePath).fileName())); +} + +void MainWindow::onExtractionFinished(const QString &filePath, const QByteArray &data) +{ + saveExtractionResult(filePath, data); + + m_successCount++; + m_processedFiles++; + processNextFile(); +} + +void MainWindow::onExtractionFailed(const QString &filePath, const QString &error) +{ + saveExtractionError(filePath, error); + + m_failedCount++; + m_processedFiles++; + processNextFile(); +} + +void MainWindow::onBatchFinished() +{ + // Called when batch is done, we process files sequentially +} + +void MainWindow::onProcessCrashed() +{ + log(tr("Extractor process crashed!")); + m_extractorRunning = false; + + // Record remaining files as failed + while (!m_pendingFiles.isEmpty()) { + QString file = m_pendingFiles.dequeue(); + saveExtractionError(file, tr("Extractor crashed")); + m_failedCount++; + m_processedFiles++; + } + + updateButtonStates(); +} + +void MainWindow::onProcessFinished(int exitCode, QProcess::ExitStatus exitStatus) +{ + log(tr("Extractor process finished - code: %1, status: %2").arg(exitCode).arg(exitStatus)); + m_extractorRunning = false; + updateButtonStates(); +} diff --git a/examples/extractor-demo/mainwindow.h b/examples/extractor-demo/mainwindow.h new file mode 100644 index 00000000..8c06bbfa --- /dev/null +++ b/examples/extractor-demo/mainwindow.h @@ -0,0 +1,81 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef MAINWINDOW_H +#define MAINWINDOW_H + +#include +#include +#include +#include + +#include + +#include +#include +#include +#include + +DWIDGET_USE_NAMESPACE + +/** + * @brief MainWindow provides a simple UI for testing the extractor. + */ +class MainWindow : public DMainWindow +{ + Q_OBJECT + +public: + explicit MainWindow(QWidget *parent = nullptr); + ~MainWindow() override; + +private slots: + void onBrowseExtractor(); + void onStartExtractor(); + void onStopExtractor(); + void onBrowseDirectory(); + void onExtractDirectory(); + void onExtractionStarted(const QString &filePath); + void onExtractionFinished(const QString &filePath, const QByteArray &data); + void onExtractionFailed(const QString &filePath, const QString &error); + void onBatchFinished(); + void onProcessCrashed(); + void onProcessFinished(int exitCode, QProcess::ExitStatus exitStatus); + +private: + void setupUI(); + void updateButtonStates(); + void log(const QString &message); + void collectFiles(const QString &directory); + void processNextFile(); + void setupOutputDirectory(const QString &sourceDir); + void saveExtractionResult(const QString &filePath, const QByteArray &data); + void saveExtractionError(const QString &filePath, const QString &error); + + DLineEdit *m_extractorPathEdit = nullptr; + DLineEdit *m_pluginPathEdit = nullptr; + DLineEdit *m_directoryPathEdit = nullptr; + DPushButton *m_startBtn = nullptr; + DPushButton *m_stopBtn = nullptr; + DPushButton *m_extractBtn = nullptr; + DPushButton *m_browseDirBtn = nullptr; + DPushButton *m_browseExtractorBtn = nullptr; + DTextEdit *m_logView = nullptr; + + deepin_anything_extractor::ControllerPipe *m_controllerPipe = nullptr; + bool m_extractorRunning = false; + + // Batch processing state + QQueue m_pendingFiles; + QString m_currentFile; + int m_totalFiles = 0; + int m_processedFiles = 0; + int m_successCount = 0; + int m_failedCount = 0; + + // Output directory + QString m_outputDir; +}; + +#endif // MAINWINDOW_H diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 69f9d51e..e79449c1 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -14,9 +14,13 @@ message("Build type:" ${CMAKE_BUILD_TYPE}) # add_compile_options(-fsanitize=thread -g) # add_link_options(-fsanitize=thread) -add_compile_options(-Wall -Wextra -pedantic -Werror) - +# C subprojects (strict warnings; each sets its own flags) add_subdirectory("server") add_subdirectory("kernelmod") add_subdirectory("logger") -add_subdirectory("dispatcher") \ No newline at end of file +add_subdirectory("dispatcher") + +# C++ subprojects (Qt-based; they define their own warning policy) +add_subdirectory("common") +add_subdirectory("extractor") +add_subdirectory("index") \ No newline at end of file diff --git a/src/common/CMakeLists.txt b/src/common/CMakeLists.txt new file mode 100644 index 00000000..2f6f7b34 --- /dev/null +++ b/src/common/CMakeLists.txt @@ -0,0 +1,21 @@ +cmake_minimum_required(VERSION 3.10) + +project(deepin-anything-common CXX) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_AUTOMOC ON) + +find_package(Qt6 COMPONENTS Core REQUIRED) + +add_library(common STATIC + processprioritymanager.cpp + processprioritymanager.h +) + +target_include_directories(common PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}) + +target_link_libraries(common PUBLIC Qt6::Core) + +# Qt headers are pulled in via QtGlobal; keep the warning policy light for C++. +target_compile_options(common PRIVATE -Wall -Wextra) diff --git a/src/common/processprioritymanager.cpp b/src/common/processprioritymanager.cpp new file mode 100644 index 00000000..6fdbeeb6 --- /dev/null +++ b/src/common/processprioritymanager.cpp @@ -0,0 +1,193 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#include "processprioritymanager.h" + +#include + +#ifdef Q_OS_LINUX +// SYS_ioprio_set might not be defined in on all toolchains/glibc versions. +// If it's not, you might need to define it based on your architecture. +// Common values: __NR_ioprio_set. For x86_64 it's 251, for i386 it's 289. +// However, modern systems should usually have it. We rely on for SYS_ioprio_set. +# ifndef SYS_ioprio_set +// Provide a fallback or error if absolutely necessary and known for the target arch +// For example, for x86_64: +// #if defined(__x86_64__) && !defined(SYS_ioprio_set) +// #define SYS_ioprio_set 251 +// #endif +// For this example, we'll assume it's defined if ioprio syscalls are generally available. +# endif +#endif // Q_OS_LINUX + + +namespace { // Anonymous namespace for helpers local to this translation unit +const char *getPolicySpelling(ProcessPriorityManager::CpuSchedulingPolicy policy) +{ + switch (policy) { + case ProcessPriorityManager::CpuSchedulingPolicy::Batch: + return "BATCH"; + case ProcessPriorityManager::CpuSchedulingPolicy::Idle: + return "IDLE"; + case ProcessPriorityManager::CpuSchedulingPolicy::Normal: + return "NORMAL"; // Though Normal case returns early + default: + return "UnknownPolicy"; // Should not happen if switch in main func is exhaustive + } +} +} // anonymous namespace + +bool ProcessPriorityManager::lowerIoPriority() +{ +#if defined(Q_OS_LINUX) && defined(SYS_ioprio_set) + // Try to set I/O scheduling to IDLE class + // int ioprio = (IoPrio::IOPRIO_CLASS_IDLE << IoPrio::IOPRIO_CLASS_SHIFT); + // Or directly use the integer value if enums are defined with those exact values: + int ioprio_idle_val = (IoPrio::IOPRIO_CLASS_IDLE << IoPrio::IOPRIO_CLASS_SHIFT); + + if (syscall(SYS_ioprio_set, IoPrio::IOPRIO_WHO_PROCESS, 0, ioprio_idle_val) < 0) { + qWarning() << "ProcessPriorityManager: Cannot set I/O scheduling to IDLE (" + << strerror(errno) << "). Trying Best Effort (lowest)."; + // Fallback: Try to set I/O scheduling to Best Effort class, lowest priority (7) + int ioprio_be_lowest_val = (IoPrio::IOPRIO_CLASS_BE << IoPrio::IOPRIO_CLASS_SHIFT) | 7; + if (syscall(SYS_ioprio_set, IoPrio::IOPRIO_WHO_PROCESS, 0, ioprio_be_lowest_val) < 0) { + qWarning() << "ProcessPriorityManager: Cannot set I/O scheduling to Best Effort (" + << strerror(errno) << ")."; + return false; + } + qInfo() << "ProcessPriorityManager: I/O priority set to Best Effort (lowest)."; + } else { + qInfo() << "ProcessPriorityManager: I/O priority set to IDLE."; + } + return true; +#else + // qDebug() << "ProcessPriorityManager: I/O priority setting (ioprio_set) not supported on this platform."; + return true; // Not an error, just not applicable +#endif +} + +bool ProcessPriorityManager::lowerCpuNicePriority(int niceValue) +{ +#if defined(Q_OS_UNIX) && !defined(Q_OS_WASM) // WASM doesn't have this + if (niceValue < -20) niceValue = -20; + if (niceValue > 19) niceValue = 19; + + errno = 0; // POSIX requires setting errno to 0 before call for some functions + if (setpriority(PRIO_PROCESS, 0, niceValue) == -1) { + // Check errno because setpriority can legitimately return -1 on success + // if the process's old priority was -1. + if (errno != 0) { + qWarning() << "ProcessPriorityManager: Cannot lower CPU nice priority to" << niceValue + << "(" << strerror(errno) << ")."; + return false; + } + } + qInfo() << "ProcessPriorityManager: CPU nice priority set to" << niceValue; + return true; +#else + // qDebug() << "ProcessPriorityManager: CPU nice priority setting (setpriority) not supported on this platform."; + Q_UNUSED(niceValue); + return true; // Not an error, just not applicable +#endif +} + +#ifdef Q_OS_LINUX +bool ProcessPriorityManager::setCpuSchedulingPolicy(CpuSchedulingPolicy policy) +{ + struct sched_param param; + memset(¶m, 0, sizeof(param)); // Must be 0 for SCHED_BATCH/IDLE + param.sched_priority = 0; + + int schedPolicyValue = -1; + switch (policy) { +# ifdef SCHED_BATCH + case CpuSchedulingPolicy::Batch: + schedPolicyValue = SCHED_BATCH; + // policyName will be derived later using getPolicySpelling(policy) + break; +# endif +# ifdef SCHED_IDLE + case CpuSchedulingPolicy::Idle: + schedPolicyValue = SCHED_IDLE; + // policyName will be derived later using getPolicySpelling(policy) + break; +# endif + case CpuSchedulingPolicy::Normal: + qInfo() << "ProcessPriorityManager: CPU scheduling policy Normal (SCHED_OTHER) requested. No change applied by this function."; + return true; + default: + qWarning() << "ProcessPriorityManager: Unknown or unsupported CPU scheduling policy requested (" + << static_cast(policy) << ")."; // Log the int value of the policy + return false; + } + + // If we reach here, policy was either Batch or Idle. + const char *requestedPolicyName = getPolicySpelling(policy); + + if (schedPolicyValue != -1) { + // A schedPolicyValue was assigned (i.e., SCHED_BATCH or SCHED_IDLE was defined and matched) + if (sched_setscheduler(0, schedPolicyValue, ¶m) == -1) { + qWarning() << "ProcessPriorityManager: Cannot set CPU scheduling policy to" << requestedPolicyName + << "(" << strerror(errno) << ")."; + return false; + } + qInfo() << "ProcessPriorityManager: CPU scheduling policy set to" << requestedPolicyName << "."; + return true; + } else { + // schedPolicyValue is still -1. + // This means the requested policy (Batch or Idle) was not available + // because its SCHED_XXX macro was not defined at compile time. + qDebug() << "ProcessPriorityManager: CPU scheduling policy" << requestedPolicyName + << "is not defined/supported on this system build (its SCHED_XXX macro is not defined)."; + return false; + } +} +#endif // Q_OS_LINUX + +void ProcessPriorityManager::lowerAllAvailablePriorities(bool verboseLog) +{ + if (verboseLog) { + qInfo() << "ProcessPriorityManager: Attempting to lower all available priorities..."; + } + + bool ioLowered = lowerIoPriority(); + if (verboseLog) { + if (ioLowered) + qInfo() << " - I/O priority lowering attempted/succeeded or N/A."; + else + qWarning() << " - I/O priority lowering FAILED."; + } + +#ifdef Q_OS_LINUX + bool schedIdleSet = setCpuSchedulingPolicy(CpuSchedulingPolicy::Idle); + if (schedIdleSet) { + if (verboseLog) + qInfo() << " - CPU scheduling policy set to IDLE."; + } else { + if (verboseLog) + qWarning() << " - Failed to set CPU scheduling policy to IDLE. Trying BATCH..."; + bool schedBatchSet = setCpuSchedulingPolicy(CpuSchedulingPolicy::Batch); + if (schedBatchSet) { + if (verboseLog) + qInfo() << " - CPU scheduling policy set to BATCH."; + } else { + if (verboseLog) + qWarning() << " - Failed to set CPU scheduling policy to BATCH."; + } + } +#else + if (verboseLog) qDebug() << " - CPU scheduling policy (SCHED_IDLE/BATCH) not available on this platform."; +#endif + + bool niceLowered = lowerCpuNicePriority(); // Default to 19 + if (verboseLog) { + if (niceLowered) + qInfo() << " - CPU nice priority lowering attempted/succeeded or N/A."; + else + qWarning() << " - CPU nice priority lowering FAILED."; + } + + if (verboseLog) + qInfo() << "ProcessPriorityManager: Priority lowering attempts complete."; +} + diff --git a/src/common/processprioritymanager.h b/src/common/processprioritymanager.h new file mode 100644 index 00000000..28b43b09 --- /dev/null +++ b/src/common/processprioritymanager.h @@ -0,0 +1,94 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#ifndef PROCESSPRIORITYMANAGER_H +#define PROCESSPRIORITYMANAGER_H + +#include // For Q_OS_LINUX etc. + +// _GNU_SOURCE for syscall and sched_setscheduler extensions +#ifndef _GNU_SOURCE +# define _GNU_SOURCE +#endif + +#ifdef Q_OS_LINUX +# include +# include +# include +# include +# include +#endif // Q_OS_LINUX + +class ProcessPriorityManager +{ +public: + // Make the class non-instantiable, all methods are static + ProcessPriorityManager() = delete; + + /** + * @brief Tries to lower the I/O priority of the current process to IDLE. + * On Linux, this uses ioprio_set. + * @return True if successful or not applicable, false on failure. + */ + static bool lowerIoPriority(); + + /** + * @brief Lowers the CPU scheduling priority (nice value) of the current process. + * @param niceValue The nice value to set (typically 1 to 19 for lower priority). + * 19 is the lowest standard priority. + * @return True if successful or not applicable, false on failure. + */ + static bool lowerCpuNicePriority(int niceValue = 19); + +#ifdef Q_OS_LINUX + enum class CpuSchedulingPolicy { + Normal, // Default SCHED_OTHER (not actively set by this class) + Batch, // SCHED_BATCH for non-interactive, CPU-intensive tasks + Idle // SCHED_IDLE for very low priority tasks + }; + + /** + * @brief Sets the CPU scheduling policy for the current process (Linux-specific). + * @param policy The desired scheduling policy (Batch or Idle). + * @return True if successful, false on failure or if not supported. + */ + static bool setCpuSchedulingPolicy(CpuSchedulingPolicy policy); +#endif // Q_OS_LINUX + + /** + * @brief Attempts to lower all available priorities for the current process. + * This will try to: + * 1. Set CPU scheduling to Idle, then Batch (Linux-specific). + * 2. Lower I/O priority (Linux-specific). + * 3. Lower CPU nice value. + * It logs successes and failures but doesn't return a single success/failure status + * as some operations might succeed while others fail or are not applicable. + * Call individual methods if you need specific success/failure feedback. + * @param verboseLog If true, logs details of each step. + */ + static void lowerAllAvailablePriorities(bool verboseLog = false); + +private: +#ifdef Q_OS_LINUX + // Constants for ioprio_set, defined locally if not available from system headers + // These are typically defined in , but we ensure they exist. + struct IoPrio + { + enum { + IOPRIO_CLASS_NONE = 0, + IOPRIO_CLASS_RT = 1, + IOPRIO_CLASS_BE = 2, + IOPRIO_CLASS_IDLE = 3, + }; + enum { + IOPRIO_WHO_PROCESS = 1, + IOPRIO_WHO_PGRP = 2, + IOPRIO_WHO_USER = 3, + }; + static const int IOPRIO_CLASS_SHIFT = 13; + static const int IOPRIO_PRIO_MASK = (1 << IOPRIO_CLASS_SHIFT) - 1; + }; +#endif // Q_OS_LINUX +}; + +#endif // PROCESSPRIORITYMANAGER_H diff --git a/src/dispatcher/CMakeLists.txt b/src/dispatcher/CMakeLists.txt index 92d19e2b..0c0ea1ae 100644 --- a/src/dispatcher/CMakeLists.txt +++ b/src/dispatcher/CMakeLists.txt @@ -6,6 +6,9 @@ cmake_minimum_required(VERSION 3.10) project(deepin-anything-dispatcher C) +add_compile_options(-Wall -Wextra -pedantic -Werror) + + set(CMAKE_C_STANDARD 11) set(CMAKE_C_STANDARD_REQUIRED ON) diff --git a/src/extractor/CMakeLists.txt b/src/extractor/CMakeLists.txt new file mode 100644 index 00000000..cf4f2248 --- /dev/null +++ b/src/extractor/CMakeLists.txt @@ -0,0 +1,19 @@ +cmake_minimum_required(VERSION 3.10) + +project(deepin-anything-extractor CXX) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_AUTOMOC ON) +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +include(GNUInstallDirs) + +set(ANYTHING_EXTRACTOR_PLUGIN_DIR ${CMAKE_INSTALL_FULL_LIBDIR}/deepin-anything/extractor/plugins) +add_definitions(-DANYTHING_EXTRACTOR_PLUGIN_DIR="${ANYTHING_EXTRACTOR_PLUGIN_DIR}") + +add_subdirectory(libextractor) +add_subdirectory(extractor) +add_subdirectory(plugins) + +message(STATUS "deepin-anything-extractor configured (plugins: ${ANYTHING_EXTRACTOR_PLUGIN_DIR})") diff --git a/src/extractor/extractor.json b/src/extractor/extractor.json new file mode 100644 index 00000000..63aee553 --- /dev/null +++ b/src/extractor/extractor.json @@ -0,0 +1,5 @@ +{ + "name": "deepin-anything-extractor", + "version": "1.0.0", + "description": "Deepin Anything Content Extractor" +} diff --git a/src/extractor/extractor/CMakeLists.txt b/src/extractor/extractor/CMakeLists.txt new file mode 100644 index 00000000..b730e687 --- /dev/null +++ b/src/extractor/extractor/CMakeLists.txt @@ -0,0 +1,42 @@ +cmake_minimum_required(VERSION 3.10) + +set(BIN_NAME "deepin-anything-extractor") + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +find_package(Qt6 COMPONENTS Core Gui REQUIRED) + +set(EXTRACTOR_FILES + extractorapp.cpp + extractorapp.h + main.cpp + pluginloader.cpp + pluginloader.h +) + +add_executable(${BIN_NAME} + ${EXTRACTOR_FILES} +) + +target_link_libraries(${BIN_NAME} PRIVATE + Qt6::Core + Qt6::Gui + deepin-anything-extractor-lib + common +) + +target_include_directories(${BIN_NAME} PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_SOURCE_DIR}/.. + ${CMAKE_CURRENT_SOURCE_DIR}/../libextractor + ${CMAKE_CURRENT_SOURCE_DIR}/../plugins +) + +# Enable position-independent executables for improved security +target_link_options(${BIN_NAME} PRIVATE -pie) + +target_compile_options(${BIN_NAME} PRIVATE -Wall -Wextra) + +install(TARGETS ${BIN_NAME} DESTINATION ${CMAKE_INSTALL_LIBEXECDIR}) + +message(STATUS "deepin-anything-extractor configured") diff --git a/src/extractor/extractor/extractorapp.cpp b/src/extractor/extractor/extractorapp.cpp new file mode 100644 index 00000000..cb8ced7c --- /dev/null +++ b/src/extractor/extractor/extractorapp.cpp @@ -0,0 +1,132 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "extractorapp.h" + +#include "processprioritymanager.h" + +#include +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +ExtractorApp::ExtractorApp(QObject *parent) + : QObject(parent), m_pluginLoader(new PluginLoader(this)), m_workerPipe(new EXTRACTOR_NAMESPACE::WorkerPipe(this)), m_idleTimer(new QTimer(this)) +{ + m_idleTimer->setSingleShot(true); + connect(m_idleTimer, &QTimer::timeout, this, []() { + qInfo() << "ExtractorApp: No batch received for" << kIdleTimeoutMs + << "ms, exiting idle extractor process"; + QCoreApplication::quit(); + }); +} + +ExtractorApp::~ExtractorApp() +{ +} + +bool ExtractorApp::initialize(const QString &pluginPath) +{ + qInfo() << "ExtractorApp: Initializing with plugin path:" << pluginPath; + + // Lower process priority to avoid impacting user experience + ProcessPriorityManager::lowerAllAvailablePriorities(true); + + // Load plugins + int pluginCount = m_pluginLoader->loadPlugins(pluginPath); + if (pluginCount == 0) { + qWarning() << "ExtractorApp: No plugins loaded"; + return false; + } + + qInfo() << "ExtractorApp: Initialization complete, loaded" << pluginCount << "plugins"; + return true; +} + +void ExtractorApp::run() +{ + qInfo() << "ExtractorApp: Starting main loop"; + + if (!m_workerPipe->initialize()) { + qCritical() << "ExtractorApp: Failed to initialize worker pipe"; + return; + } + + // Connect signals + connect(m_workerPipe.get(), &EXTRACTOR_NAMESPACE::WorkerPipe::batchReceived, + this, [this](const QVector &filePaths) { + processBatch(filePaths); + }); + + connect(m_workerPipe.get(), &EXTRACTOR_NAMESPACE::WorkerPipe::activityDetected, + this, &ExtractorApp::resetIdleTimer); + + connect(m_workerPipe.get(), &EXTRACTOR_NAMESPACE::WorkerPipe::stdinClosed, + this, []() { + qInfo() << "ExtractorApp: Stdin closed, exiting"; + QCoreApplication::quit(); + }); + + resetIdleTimer(); + qInfo() << "ExtractorApp: Ready to process requests"; + + // Enter event loop + QCoreApplication::exec(); + + qInfo() << "ExtractorApp: Exiting"; +} + +void ExtractorApp::processBatch(const QVector &filePaths) +{ + qInfo() << "ExtractorApp: Processing batch of" << filePaths.size() << "files"; + + for (const QString &filePath : filePaths) { + qDebug() << "ExtractorApp: Processing file:" << filePath; + + // Send started notification + m_workerPipe->sendStarted(filePath); + + // Check if file exists + if (!QFile::exists(filePath)) { + qWarning() << "ExtractorApp: File does not exist:" << filePath; + m_workerPipe->sendFailed(filePath, "File does not exist"); + continue; + } + + // Find appropriate plugin + auto plugin = m_pluginLoader->findPlugin(filePath); + if (!plugin) { + qWarning() << "ExtractorApp: No plugin can handle file:" << filePath; + m_workerPipe->sendFailed(filePath, "No plugin available for this file type"); + continue; + } + + // Extract content + const auto &result = plugin->extract(filePath); + if (!result.has_value()) { + qWarning() << "ExtractorApp: Extraction failed for file:" << filePath; + m_workerPipe->sendFailed(filePath, "Extraction failed"); + continue; + } + + // Send extracted data + qDebug() << "ExtractorApp: Successfully extracted" << result->size() + << "bytes from:" << filePath; + m_workerPipe->sendData(filePath, result.value()); + } + + // Send batch done notification + m_workerPipe->sendBatchDone(); + + qInfo() << "ExtractorApp: Batch processing complete"; +} + +void ExtractorApp::resetIdleTimer() +{ + m_idleTimer->start(kIdleTimeoutMs); +} + +EXTRACTOR_PLUGIN_END_NAMESPACE diff --git a/src/extractor/extractor/extractorapp.h b/src/extractor/extractor/extractorapp.h new file mode 100644 index 00000000..58455535 --- /dev/null +++ b/src/extractor/extractor/extractorapp.h @@ -0,0 +1,64 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef EXTRACTORAPP_H +#define EXTRACTORAPP_H + +#include "pluginloader.h" +#include "workerpipe.h" + +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +/** + * @brief ExtractorApp is the main application class for the extractor subprocess. + * + * It manages the plugin loader and handles extraction requests from stdin. + */ +class ExtractorApp : public QObject +{ + Q_OBJECT + +public: + explicit ExtractorApp(QObject *parent = nullptr); + ~ExtractorApp() override; + + /** + * @brief Initialize the extractor application. + * + * @param pluginPath Path to the plugin directory + * @return true if initialization succeeded + */ + bool initialize(const QString &pluginPath); + + /** + * @brief Run the main event loop. + * + * Processes extraction requests until stdin is closed. + */ + void run(); + + /** + * @brief Process a batch of files for extraction. + * + * @param filePaths List of files to extract + */ + void processBatch(const QVector &filePaths); + +private: + static constexpr int kIdleTimeoutMs = 10 * 60 * 1000; + + void resetIdleTimer(); + + QSharedPointer m_pluginLoader; + QScopedPointer m_workerPipe; + QTimer *m_idleTimer = nullptr; +}; + +EXTRACTOR_PLUGIN_END_NAMESPACE + +#endif // EXTRACTORAPP_H diff --git a/src/extractor/extractor/main.cpp b/src/extractor/extractor/main.cpp new file mode 100644 index 00000000..40e2b07c --- /dev/null +++ b/src/extractor/extractor/main.cpp @@ -0,0 +1,76 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "extractorapp.h" + +#include +#include +#include +#include +#include +#include + +// debug: +// 1. sudo sysctl kernel.yama.ptrace_scope=0 +// 2. attach: gdb -p $(PID) + +int main(int argc, char *argv[]) +{ + // Fix: HTML extraction uses QTextDocument, which requires a GUI-capable Qt + // application even in this headless worker process. + if (qEnvironmentVariableIsEmpty("QT_QPA_PLATFORM") + && qEnvironmentVariableIsEmpty("DISPLAY") + && qEnvironmentVariableIsEmpty("WAYLAND_DISPLAY")) { + qputenv("QT_QPA_PLATFORM", QByteArrayLiteral("offscreen")); + } + + QGuiApplication app(argc, argv); + QGuiApplication::setApplicationName("deepin-anything-extractor"); + QGuiApplication::setApplicationVersion("1.0.0"); + + // Parse command line arguments + QCommandLineParser parser; + parser.setApplicationDescription("Deepin Anything Content Extractor"); + parser.addHelpOption(); + parser.addVersionOption(); + + QCommandLineOption pluginPathOption( + "plugin-path", + "Path to the plugin directory", + "path"); + + parser.addOption(pluginPathOption); + parser.process(app); + + // Get plugin path + QString pluginPath = parser.value(pluginPathOption); + if (pluginPath.isEmpty()) { + auto defaultPath = ANYTHING_EXTRACTOR_PLUGIN_DIR; + static_assert(std::is_same::value, + "ANYTHING_EXTRACTOR_PLUGIN_DIR is not a string."); + +#ifdef QT_DEBUG + const QString debugPluginPath = QDir(QGuiApplication::applicationDirPath()).absoluteFilePath("../plugins"); + if (QDir(debugPluginPath).exists()) { + pluginPath = debugPluginPath; + } else { + pluginPath = QString::fromLocal8Bit(defaultPath); + } +#else + pluginPath = QString::fromLocal8Bit(defaultPath); +#endif + } + + // Create and initialize extractor application + anything_extractor_plugin::ExtractorApp extractor; + if (!extractor.initialize(pluginPath)) { + qCritical() << "Failed to initialize extractor with plugin path:" << pluginPath; + return 1; + } + + // Run the main loop + extractor.run(); + + return 0; +} diff --git a/src/extractor/extractor/pluginloader.cpp b/src/extractor/extractor/pluginloader.cpp new file mode 100644 index 00000000..87d05b50 --- /dev/null +++ b/src/extractor/extractor/pluginloader.cpp @@ -0,0 +1,112 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "pluginloader.h" + +#include +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +PluginLoader::PluginLoader(QObject *parent) + : QObject(parent) +{ +} + +PluginLoader::~PluginLoader() +{ +} + +int PluginLoader::loadPlugins(const QString &pluginPath) +{ + m_plugins.clear(); + + if (pluginPath.isEmpty()) { + qWarning() << "PluginLoader::loadPlugins: Plugin path is empty"; + return 0; + } + + QDir dir(pluginPath); + if (!dir.exists()) { + qWarning() << "PluginLoader::loadPlugins: Plugin directory does not exist:" << pluginPath; + return 0; + } + + qInfo() << "PluginLoader: Loading plugins from:" << pluginPath; + + // Find all shared libraries in the plugin directory + QStringList filters; + filters << "*.so"; + + int loadedCount = 0; + const QStringList entries = dir.entryList(filters, QDir::Files); + + for (const QString &fileName : entries) { + QString filePath = dir.absoluteFilePath(fileName); + + qDebug() << "PluginLoader: Attempting to load:" << filePath; + + QPluginLoader loader(filePath); + QObject *instance = loader.instance(); + + if (!instance) { + qWarning() << "PluginLoader: Failed to load plugin:" << filePath + << "error:" << loader.errorString(); + continue; + } + + AbstractExtractorPlugin *plugin = qobject_cast(instance); + if (!plugin) { + qWarning() << "PluginLoader: Plugin does not implement AbstractExtractorPlugin:" << filePath; + loader.unload(); + continue; + } + + m_plugins.append(QSharedPointer(plugin, [](AbstractExtractorPlugin *) { + // Don't delete, QPluginLoader manages lifetime + })); + + qInfo() << "PluginLoader: Loaded plugin:" << plugin->name() + << "priority:" << plugin->priority(); + loadedCount++; + } + + // Sort plugins by priority (highest first) + std::sort(m_plugins.begin(), m_plugins.end(), + [](const QSharedPointer &a, + const QSharedPointer &b) { + return a->priority() > b->priority(); + }); + + qInfo() << "PluginLoader: Loaded" << loadedCount << "plugins"; + return loadedCount; +} + +QList> PluginLoader::plugins() const +{ + return m_plugins; +} + +QSharedPointer PluginLoader::findPlugin(const QString &filePath) const +{ + for (const auto &plugin : m_plugins) { + if (plugin->canExtract(filePath)) { + qDebug() << "PluginLoader: Found plugin" << plugin->name() + << "for file:" << filePath; + return plugin; + } + } + + qDebug() << "PluginLoader: No plugin found for file:" << filePath; + return nullptr; +} + +int PluginLoader::pluginCount() const +{ + return m_plugins.size(); +} + +EXTRACTOR_PLUGIN_END_NAMESPACE diff --git a/src/extractor/extractor/pluginloader.h b/src/extractor/extractor/pluginloader.h new file mode 100644 index 00000000..9e78b1a3 --- /dev/null +++ b/src/extractor/extractor/pluginloader.h @@ -0,0 +1,68 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef PLUGINLOADER_H +#define PLUGINLOADER_H + +#include "extractor_plugin_global.h" +#include "abstractextractorplugin.h" + +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +/** + * @brief PluginLoader manages loading and querying extractor plugins. + * + * This class loads plugins from a specified directory and provides + * methods to find the appropriate plugin for a given file. + */ +class PluginLoader : public QObject +{ + Q_OBJECT + +public: + explicit PluginLoader(QObject *parent = nullptr); + ~PluginLoader() override; + + /** + * @brief Load plugins from the specified directory. + * + * @param pluginPath Directory containing plugin libraries + * @return Number of plugins loaded + */ + int loadPlugins(const QString &pluginPath); + + /** + * @brief Get all loaded plugins. + * + * @return List of loaded plugins, sorted by priority (highest first) + */ + QList> plugins() const; + + /** + * @brief Find a plugin that can extract from the given file. + * + * Iterates through plugins by priority until one returns true + * for canExtract(). + * + * @param filePath Path to the file + * @return Plugin that can extract the file, or nullptr if none found + */ + QSharedPointer findPlugin(const QString &filePath) const; + + /** + * @brief Get the number of loaded plugins. + */ + int pluginCount() const; + +private: + QList> m_plugins; +}; + +EXTRACTOR_PLUGIN_END_NAMESPACE + +#endif // PLUGINLOADER_H diff --git a/src/extractor/libextractor/CMakeLists.txt b/src/extractor/libextractor/CMakeLists.txt new file mode 100644 index 00000000..a1936eeb --- /dev/null +++ b/src/extractor/libextractor/CMakeLists.txt @@ -0,0 +1,54 @@ +cmake_minimum_required(VERSION 3.10) + +project(deepin-anything-extractor-lib CXX) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_AUTOMOC ON) +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +find_package(Qt6 COMPONENTS Core REQUIRED) + +include(GNUInstallDirs) + +set(LIB_NAME deepin-anything-extractor-lib) + +set(EXTRACTOR_LIB_FILES + controllerpipe.cpp + workerpipe.cpp + controllerpipe.h + extractortypes.h + extractor_global.h + workerpipe.h +) + +add_library(${LIB_NAME} + SHARED + ${EXTRACTOR_LIB_FILES} +) + +set_target_properties(${LIB_NAME} PROPERTIES + OUTPUT_NAME deepin-anything-extractor + VERSION 1.0.0 + SOVERSION 1 +) + +target_link_libraries(${LIB_NAME} + PUBLIC + Qt6::Core +) + +target_include_directories(${LIB_NAME} + PUBLIC + ${CMAKE_CURRENT_SOURCE_DIR} +) + +target_compile_options(${LIB_NAME} PRIVATE -Wall -Wextra) + +# Install the communication library into the standard libdir. +install(TARGETS ${LIB_NAME} + LIBRARY + DESTINATION ${CMAKE_INSTALL_LIBDIR} +) + +message(STATUS "deepin-anything-extractor library configured") diff --git a/src/extractor/libextractor/controllerpipe.cpp b/src/extractor/libextractor/controllerpipe.cpp new file mode 100644 index 00000000..40df6dd0 --- /dev/null +++ b/src/extractor/libextractor/controllerpipe.cpp @@ -0,0 +1,300 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "controllerpipe.h" + +#include +#include +#include +#include + +EXTRACTOR_BEGIN_NAMESPACE + +class ControllerPipePrivate +{ +public: + QProcess *process = nullptr; + QByteArray inputBuffer; + bool waitingForComplete = false; + qint32 expectedSize = 0; + + void clearState() + { + inputBuffer.clear(); + waitingForComplete = false; + expectedSize = 0; + } +}; + +ControllerPipe::ControllerPipe(QObject *parent) + : QObject(parent), d(new ControllerPipePrivate()) +{ +} + +ControllerPipe::~ControllerPipe() +{ + stop(); +} + +bool ControllerPipe::start(const QString &extractorPath, const QString &pluginPath) +{ + if (isRunning()) { + qWarning() << "ControllerPipe::start: Process already running"; + return false; + } + + if (extractorPath.isEmpty()) { + qCritical() << "ControllerPipe::start: Extractor path is empty"; + emit errorOccurred("Extractor path is empty"); + return false; + } + + d->process = new QProcess(this); + + // Connect process signals + connect(d->process, &QProcess::readyReadStandardOutput, + this, &ControllerPipe::handleProcessOutput); + + connect(d->process, &QProcess::errorOccurred, + this, [this](QProcess::ProcessError error) { + if (hasPendingPartialMessage()) { + qWarning() << "ControllerPipe: Process error occurred with incomplete message." + << "buffer size:" << d->inputBuffer.size() + << "expected payload size:" << d->expectedSize; + } + qCritical() << "ControllerPipe: Process error:" << error; + emit errorOccurred(QString("Process error: %1").arg(static_cast(error))); + }); + + connect(d->process, QOverload::of(&QProcess::finished), + this, [this](int exitCode, QProcess::ExitStatus exitStatus) { + QProcess *finishedProcess = qobject_cast(sender()); + if (hasPendingPartialMessage()) { + qWarning() << "ControllerPipe: Process finished with incomplete message." + << "buffer size:" << d->inputBuffer.size() + << "expected payload size:" << d->expectedSize; + } + qInfo() << "ControllerPipe: Process finished with exit code:" << exitCode + << "status:" << exitStatus; + + if (exitStatus == QProcess::CrashExit) { + emit processCrashed(); + } + + emit processFinished(exitCode, exitStatus); + + if (d->process == finishedProcess) { + d->process = nullptr; + } + + if (finishedProcess) { + finishedProcess->deleteLater(); + } + }); + + // Prepare arguments + QStringList arguments; + if (!pluginPath.isEmpty()) { + arguments << "--plugin-path" << pluginPath; + } + + // Start the process + qInfo() << "ControllerPipe: Starting extractor:" << extractorPath + << "arguments:" << arguments; + + d->process->start(extractorPath, arguments, QIODevice::ReadWrite); + + if (!d->process->waitForStarted(5000)) { + qCritical() << "ControllerPipe: Failed to start process:" + << d->process->errorString(); + emit errorOccurred(QString("Failed to start process: %1").arg(d->process->errorString())); + d->process->deleteLater(); + d->process = nullptr; + return false; + } + + qInfo() << "ControllerPipe: Extractor started successfully, PID:" << d->process->processId(); + return true; +} + +void ControllerPipe::handleProcessOutput() +{ + QProcess *process = qobject_cast(sender()); + if (!process) { + process = d->process; + } + if (!process) { + return; + } + + d->inputBuffer.append(process->readAllStandardOutput()); + processInputBuffer(); +} + +void ControllerPipe::processInputBuffer() +{ + while (true) { + if (!d->waitingForComplete) { + if (d->inputBuffer.size() < static_cast(sizeof(qint32))) { + return; + } + + QDataStream sizeStream(d->inputBuffer); + sizeStream >> d->expectedSize; + if (d->expectedSize < 0) { + qCritical() << "ControllerPipe: Invalid message size:" << d->expectedSize; + d->clearState(); + emit errorOccurred(QStringLiteral("Invalid extractor message size")); + return; + } + + d->waitingForComplete = true; + } + + const qint32 totalSize = static_cast(sizeof(qint32)) + d->expectedSize; + const auto bufferSize = d->inputBuffer.size(); + if (bufferSize < totalSize) { + return; + } + + const QByteArray messageData = d->inputBuffer.mid(sizeof(qint32), d->expectedSize); + d->inputBuffer.remove(0, totalSize); + d->waitingForComplete = false; + d->expectedSize = 0; + + handleStatusMessage(messageData); + } +} + +void ControllerPipe::handleStatusMessage(const QByteArray &messageData) +{ + QDataStream messageStream(messageData); + quint8 statusByte = 0; + messageStream >> statusByte; + const ExtractorStatus status = static_cast(statusByte); + + QString filePath; + QByteArray data; + QString error; + + if (status != ExtractorStatus::BatchDone) { + messageStream >> filePath; + } + + if (status == ExtractorStatus::Data) { + messageStream >> data; + } else if (status == ExtractorStatus::Failed) { + // Fix: failed packets now carry an explicit error string after filePath. + messageStream >> error; + } + + switch (status) { + case ExtractorStatus::Started: + qDebug() << "ControllerPipe: Extraction started for:" << filePath; + emit extractionStarted(filePath); + break; + + case ExtractorStatus::Finished: + qDebug() << "ControllerPipe: Extraction finished for:" << filePath; + emit extractionFinished(filePath, data); + break; + + case ExtractorStatus::Failed: + qDebug() << "ControllerPipe: Extraction failed for:" << filePath << "error:" << error; + emit extractionFailed(filePath, error); + break; + + case ExtractorStatus::Data: + qDebug() << "ControllerPipe: Received data for:" << filePath + << "size:" << data.size(); + emit extractionFinished(filePath, data); + break; + + case ExtractorStatus::BatchDone: + qDebug() << "ControllerPipe: Batch completed"; + emit batchFinished(); + break; + } +} + +void ControllerPipe::stop() +{ + if (d->process) { + QProcess *process = d->process; + d->process = nullptr; + + qInfo() << "ControllerPipe: Stopping extractor process"; + + // Close write channel to signal EOF to the subprocess + process->closeWriteChannel(); + + // Wait for the process to finish gracefully + if (!process->waitForFinished(3000)) { + qWarning() << "ControllerPipe: Process did not finish gracefully, terminating"; + process->terminate(); + + if (!process->waitForFinished(2000)) { + qWarning() << "ControllerPipe: Process did not terminate, killing"; + process->kill(); + process->waitForFinished(1000); + } + } + + process->deleteLater(); + } + + d->clearState(); +} + +bool ControllerPipe::hasPendingPartialMessage() const +{ + return d->waitingForComplete || !d->inputBuffer.isEmpty(); +} + +bool ControllerPipe::isRunning() const +{ + return d->process && d->process->state() == QProcess::Running; +} + +bool ControllerPipe::extractBatch(const QVector &filePaths) +{ + if (!isRunning()) { + qWarning() << "ControllerPipe::extractBatch: Process not running"; + return false; + } + + if (filePaths.isEmpty()) { + qWarning() << "ControllerPipe::extractBatch: Empty file paths"; + return false; + } + + qDebug() << "ControllerPipe::extractBatch: Sending" << filePaths.size() << "files"; + + // Serialize the request + QByteArray messageData; + QDataStream messageStream(&messageData, QIODevice::WriteOnly); + messageStream << filePaths; + + // Write size header + message + QByteArray packetData; + QDataStream packetStream(&packetData, QIODevice::WriteOnly); + packetStream << static_cast(messageData.size()); + packetData.append(messageData); + + qint64 bytesWritten = d->process->write(packetData); + if (bytesWritten != packetData.size()) { + qCritical() << "ControllerPipe::extractBatch: Failed to write complete message"; + return false; + } + + d->process->waitForBytesWritten(); + return true; +} + +qint64 ControllerPipe::processId() const +{ + return d->process ? d->process->processId() : -1; +} + +EXTRACTOR_END_NAMESPACE diff --git a/src/extractor/libextractor/controllerpipe.h b/src/extractor/libextractor/controllerpipe.h new file mode 100644 index 00000000..9305d680 --- /dev/null +++ b/src/extractor/libextractor/controllerpipe.h @@ -0,0 +1,120 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef CONTROLLERPIPE_H +#define CONTROLLERPIPE_H + +#include "extractor_global.h" +#include "extractortypes.h" + +#include +#include +#include + +EXTRACTOR_BEGIN_NAMESPACE + +class ControllerPipePrivate; + +/** + * @brief ControllerPipe manages communication with the extractor subprocess. + * + * This class is used by the main process (e.g., textindex service) to: + * 1. Start the extractor subprocess + * 2. Send batch extraction requests + * 3. Receive extraction results via signals + * 4. Handle subprocess lifecycle (crashes, timeouts) + */ +class ControllerPipe : public QObject +{ + Q_OBJECT + +public: + explicit ControllerPipe(QObject *parent = nullptr); + ~ControllerPipe() override; + + /** + * @brief Start the extractor subprocess + * @param extractorPath Path to the extractor executable + * @param pluginPath Optional path to plugin directory + * @return true if started successfully + */ + bool start(const QString &extractorPath, const QString &pluginPath = QString()); + + /** + * @brief Stop the extractor subprocess + */ + void stop(); + + /** + * @brief Check if the extractor is running + */ + bool isRunning() const; + + /** + * @brief Send a batch of file paths for extraction + * @param filePaths List of file paths to extract + * @return true if the request was sent successfully + */ + bool extractBatch(const QVector &filePaths); + + /** + * @brief Get the process ID of the extractor + * @return Process ID or -1 if not running + */ + qint64 processId() const; + +signals: + /** + * @brief Emitted when extraction starts for a file + * @param filePath The file being processed + */ + void extractionStarted(const QString &filePath); + + /** + * @brief Emitted when extraction completes successfully + * @param filePath The file that was processed + * @param data The extracted content + */ + void extractionFinished(const QString &filePath, const QByteArray &data); + + /** + * @brief Emitted when extraction fails + * @param filePath The file that failed + * @param error Error description + */ + void extractionFailed(const QString &filePath, const QString &error); + + /** + * @brief Emitted when a batch extraction is complete + */ + void batchFinished(); + + /** + * @brief Emitted when the extractor process crashes + */ + void processCrashed(); + + /** + * @brief Emitted when the extractor process exits normally + */ + void processFinished(int exitCode, QProcess::ExitStatus exitStatus); + + /** + * @brief Emitted when an error occurs + * @param error Error description + */ + void errorOccurred(const QString &error); + +private: + void handleProcessOutput(); + void processInputBuffer(); + void handleStatusMessage(const QByteArray &messageData); + bool hasPendingPartialMessage() const; + + QScopedPointer d; +}; + +EXTRACTOR_END_NAMESPACE + +#endif // CONTROLLERPIPE_H diff --git a/src/extractor/libextractor/extractor_global.h b/src/extractor/libextractor/extractor_global.h new file mode 100644 index 00000000..d307e682 --- /dev/null +++ b/src/extractor/libextractor/extractor_global.h @@ -0,0 +1,16 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef EXTRACTOR_GLOBAL_H +#define EXTRACTOR_GLOBAL_H + +#include + +#define EXTRACTOR_NAMESPACE deepin_anything_extractor + +#define EXTRACTOR_BEGIN_NAMESPACE namespace EXTRACTOR_NAMESPACE { +#define EXTRACTOR_END_NAMESPACE } +#define EXTRACTOR_USE_NAMESPACE using namespace EXTRACTOR_NAMESPACE; + +#endif // EXTRACTOR_GLOBAL_H diff --git a/src/extractor/libextractor/extractortypes.h b/src/extractor/libextractor/extractortypes.h new file mode 100644 index 00000000..96d9096b --- /dev/null +++ b/src/extractor/libextractor/extractortypes.h @@ -0,0 +1,69 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef EXTRACTORTYPES_H +#define EXTRACTORTYPES_H + +#include "extractor_global.h" + +#include +#include +#include + +EXTRACTOR_BEGIN_NAMESPACE + +/** + * @brief Status codes for extractor IPC communication + */ +enum class ExtractorStatus : quint8 { + Started = 'S', // Start processing a file + Finished = 'F', // Successfully completed + Failed = 'f', // Processing failed + Data = 'D', // Data ready (path + data) + BatchDone = 'B' // Batch completed +}; + +/** + * @brief Convert ExtractorStatus to string for logging + */ +inline const char* statusToString(ExtractorStatus status) +{ + switch (status) { + case ExtractorStatus::Started: + return "Started"; + case ExtractorStatus::Finished: + return "Finished"; + case ExtractorStatus::Failed: + return "Failed"; + case ExtractorStatus::Data: + return "Data"; + case ExtractorStatus::BatchDone: + return "BatchDone"; + default: + return "Unknown"; + } +} + +/** + * @brief Result of a single file extraction + */ +struct ExtractionResult { + QString filePath; + bool success = false; + QByteArray data; + QString error; +}; + +/** + * @brief Batch extraction results + */ +struct BatchResult { + QVector results; + int successCount = 0; + int failureCount = 0; +}; + +EXTRACTOR_END_NAMESPACE + +#endif // EXTRACTORTYPES_H diff --git a/src/extractor/libextractor/workerpipe.cpp b/src/extractor/libextractor/workerpipe.cpp new file mode 100644 index 00000000..eaf1d4cd --- /dev/null +++ b/src/extractor/libextractor/workerpipe.cpp @@ -0,0 +1,256 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "workerpipe.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +EXTRACTOR_BEGIN_NAMESPACE + +namespace { +constexpr qsizetype kPipeReadChunkSize = 8192; +} + +class WorkerPipePrivate +{ +public: + QSocketNotifier *stdinNotifier = nullptr; + QByteArray inputBuffer; + bool waitingForComplete = false; + qint32 expectedSize = 0; + bool initialized = false; + int outputFd = -1; +}; + +WorkerPipe::WorkerPipe(QObject *parent) + : QObject(parent), d(new WorkerPipePrivate()) +{ +} + +WorkerPipe::~WorkerPipe() +{ + if (d->outputFd >= 0) { + ::close(d->outputFd); + } +} + +bool WorkerPipe::initialize() +{ + if (d->initialized) { + return true; + } + + // Set stdin to binary mode + FILE *stdinFile = freopen(nullptr, "rb", stdin); + if (!stdinFile) { + qCritical() << "WorkerPipe::initialize: Failed to reopen stdin in binary mode"; + return false; + } + + if (!setupOutputChannel()) { + qCritical() << "WorkerPipe::initialize: Failed to set up output channel"; + return false; + } + + // Create socket notifier to watch stdin + d->stdinNotifier = new QSocketNotifier(STDIN_FILENO, QSocketNotifier::Read, this); + connect(d->stdinNotifier, &QSocketNotifier::activated, this, [this]() { + readFromStdin(); + }); + + d->initialized = true; + qDebug() << "WorkerPipe: Initialized successfully"; + + return true; +} + +bool WorkerPipe::readFromStdin() +{ + QByteArray buffer(kPipeReadChunkSize, Qt::Uninitialized); + const ssize_t bytesRead = ::read(STDIN_FILENO, buffer.data(), static_cast(buffer.size())); + + if (bytesRead <= 0) { + if (hasPendingPartialMessage()) { + qWarning() << "WorkerPipe: Stdin closed with incomplete message." + << "buffer size:" << d->inputBuffer.size() + << "expected payload size:" << d->expectedSize; + } + qInfo() << "WorkerPipe: Stdin closed"; + emit stdinClosed(); + d->stdinNotifier->setEnabled(false); + return false; + } + + d->inputBuffer.append(buffer.constData(), static_cast(bytesRead)); + processInputBuffer(); + return true; +} + +void WorkerPipe::processInputBuffer() +{ + while (true) { + if (!d->waitingForComplete) { + if (d->inputBuffer.size() < static_cast(sizeof(qint32))) { + return; + } + + QDataStream sizeStream(d->inputBuffer); + sizeStream >> d->expectedSize; + if (d->expectedSize < 0) { + qCritical() << "WorkerPipe: Invalid message size:" << d->expectedSize; + d->stdinNotifier->setEnabled(false); + emit stdinClosed(); + return; + } + + d->waitingForComplete = true; + } + + const qint32 totalSize = static_cast(sizeof(qint32)) + d->expectedSize; + const auto bufferSize = d->inputBuffer.size(); + if (bufferSize < totalSize) { + return; + } + + const QByteArray messageData = d->inputBuffer.mid(sizeof(qint32), d->expectedSize); + d->inputBuffer.remove(0, totalSize); + d->waitingForComplete = false; + d->expectedSize = 0; + + QDataStream messageStream(messageData); + QVector filePaths; + messageStream >> filePaths; + + qDebug() << "WorkerPipe: Received batch with" << filePaths.size() << "files"; + emit activityDetected(); + emit batchReceived(filePaths); + } +} + +bool WorkerPipe::sendStatus(ExtractorStatus status, const QString &filePath, const QByteArray &data) +{ + if (!d->initialized) { + qWarning() << "WorkerPipe::sendStatus: Not initialized"; + return false; + } + + // Serialize the message + QByteArray messageData; + QDataStream messageStream(&messageData, QIODevice::WriteOnly); + messageStream << static_cast(status); + + if (status != ExtractorStatus::BatchDone) { + messageStream << filePath; + } + + if (status == ExtractorStatus::Data) { + messageStream << data; + } + + if (status == ExtractorStatus::Failed) { + // Fix: failed messages must carry the error payload so the controller + // does not have to guess or reuse the file path as the error text. + messageStream << QString::fromUtf8(data); + } + + QByteArray packetData; + QDataStream packetStream(&packetData, QIODevice::WriteOnly); + packetStream << static_cast(messageData.size()); + packetData.append(messageData); + + if (!writePacket(packetData)) { + qCritical() << "WorkerPipe::sendStatus: Failed to write packet"; + return false; + } + + qDebug() << "WorkerPipe::sendStatus: Sent status" << statusToString(status) + << "for" << filePath << "data size:" << data.size(); + + return true; +} + +bool WorkerPipe::sendStarted(const QString &filePath) +{ + return sendStatus(ExtractorStatus::Started, filePath); +} + +bool WorkerPipe::sendData(const QString &filePath, const QByteArray &data) +{ + return sendStatus(ExtractorStatus::Data, filePath, data); +} + +bool WorkerPipe::sendFailed(const QString &filePath, const QString &error) +{ + return sendStatus(ExtractorStatus::Failed, filePath, error.toUtf8()); +} + +bool WorkerPipe::sendBatchDone() +{ + return sendStatus(ExtractorStatus::BatchDone); +} + +bool WorkerPipe::writePacket(const QByteArray &packetData) +{ + qint64 totalWritten = 0; + while (totalWritten < packetData.size()) { + const ssize_t bytesWritten = ::write(d->outputFd, + packetData.constData() + totalWritten, + static_cast(packetData.size() - totalWritten)); + if (bytesWritten <= 0) { + return false; + } + + totalWritten += bytesWritten; + } + + return true; +} + +bool WorkerPipe::hasPendingPartialMessage() const +{ + return d->waitingForComplete || !d->inputBuffer.isEmpty(); +} + +bool WorkerPipe::setupOutputChannel() +{ + d->outputFd = ::dup(STDOUT_FILENO); + if (d->outputFd < 0) { + return false; + } + + const int nullFd = ::open("/dev/null", O_WRONLY | O_CLOEXEC); + if (nullFd < 0) { + ::close(d->outputFd); + d->outputFd = -1; + return false; + } + + // Keep a dedicated fd for binary IPC and sink accidental stdout writes so + // they cannot be misread as protocol frames or flood the controller's + // stderr log stream after redirection. + if (::dup2(nullFd, STDOUT_FILENO) < 0) { + ::close(nullFd); + ::close(d->outputFd); + d->outputFd = -1; + return false; + } + + ::close(nullFd); + + if (::fflush(stdout) != 0 && errno != EBADF) { + qWarning() << "WorkerPipe::setupOutputChannel: Failed to flush stdout after redirect"; + } + + return true; +} + +EXTRACTOR_END_NAMESPACE diff --git a/src/extractor/libextractor/workerpipe.h b/src/extractor/libextractor/workerpipe.h new file mode 100644 index 00000000..992fe972 --- /dev/null +++ b/src/extractor/libextractor/workerpipe.h @@ -0,0 +1,101 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef WORKERPIPE_H +#define WORKERPIPE_H + +#include "extractor_global.h" +#include "extractortypes.h" + +#include + +EXTRACTOR_BEGIN_NAMESPACE + +class WorkerPipePrivate; + +/** + * @brief WorkerPipe handles communication from the extractor subprocess side. + * + * This class is used by the extractor subprocess to: + * 1. Receive extraction requests from stdin + * 2. Send status updates and results to stdout + * 3. Handle message framing with QDataStream transactions + */ +class WorkerPipe : public QObject +{ + Q_OBJECT + +public: + explicit WorkerPipe(QObject *parent = nullptr); + ~WorkerPipe() override; + + /** + * @brief Initialize the worker pipe + * @return true if initialization succeeded + */ + bool initialize(); + + /** + * @brief Send a status message to the controller + * @param status The status code + * @param filePath Optional file path (for Started/Finished/Failed/Data) + * @param data Optional data (for Data status) + * @return true if sent successfully + */ + bool sendStatus(ExtractorStatus status, const QString &filePath = QString(), + const QByteArray &data = QByteArray()); + + /** + * @brief Send extraction started notification + */ + bool sendStarted(const QString &filePath); + + /** + * @brief Send extraction finished with data + */ + bool sendData(const QString &filePath, const QByteArray &data); + + /** + * @brief Send extraction failed notification + */ + bool sendFailed(const QString &filePath, const QString &error = QString()); + + /** + * @brief Send batch done notification + */ + bool sendBatchDone(); + +signals: + /** + * @brief Emitted when a complete batch request is received from stdin. + * + * This is used by the extractor app to track idle time based on actual + * tasks rather than low-level notifier wakeups or partial pipe reads. + */ + void activityDetected(); + + /** + * @brief Emitted when a batch request is received + * @param filePaths List of files to extract + */ + void batchReceived(const QVector &filePaths); + + /** + * @brief Emitted when stdin is closed (parent process terminated) + */ + void stdinClosed(); + +private: + bool readFromStdin(); + void processInputBuffer(); + bool writePacket(const QByteArray &packetData); + bool hasPendingPartialMessage() const; + bool setupOutputChannel(); + + QScopedPointer d; +}; + +EXTRACTOR_END_NAMESPACE + +#endif // WORKERPIPE_H diff --git a/src/extractor/plugins/CMakeLists.txt b/src/extractor/plugins/CMakeLists.txt new file mode 100644 index 00000000..8cf0be33 --- /dev/null +++ b/src/extractor/plugins/CMakeLists.txt @@ -0,0 +1,6 @@ +cmake_minimum_required(VERSION 3.10) + +add_subdirectory(text-extractor) +add_subdirectory(ocr-extractor) + +message(STATUS "deepin-anything extractor plugins configured") diff --git a/src/extractor/plugins/abstractextractorplugin.h b/src/extractor/plugins/abstractextractorplugin.h new file mode 100644 index 00000000..39ab64c0 --- /dev/null +++ b/src/extractor/plugins/abstractextractorplugin.h @@ -0,0 +1,78 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef ABSTRACTEXTRACTORPLUGIN_H +#define ABSTRACTEXTRACTORPLUGIN_H + +#include "extractor_plugin_global.h" + +#include +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +/** + * @brief Abstract base class for extractor plugins. + * + * Plugins must implement canExtract() to check if they can handle a file, + * and extract() to perform the actual extraction. + */ +class AbstractExtractorPlugin : public QObject +{ + Q_OBJECT + +public: + explicit AbstractExtractorPlugin(QObject *parent = nullptr) + : QObject(parent) + { + } + + virtual ~AbstractExtractorPlugin() = default; + + /** + * @brief Check if this plugin can extract content from the given file. + * + * This method should perform runtime detection based on file content, + * not just mimetype. This allows plugins to handle files based on + * actual content rather than file extension. + * + * @param filePath Path to the file to check + * @return true if this plugin can extract from the file + */ + virtual bool canExtract(const QString &filePath) const = 0; + + /** + * @brief Extract content from the given file. + * + * @param filePath Path to the file to extract from + * @return Extracted content as QByteArray, or nullopt on failure + */ + virtual std::optional extract(const QString &filePath) = 0; + + /** + * @brief Get the name of this plugin. + * + * @return Plugin name for logging and debugging + */ + virtual QString name() const = 0; + + /** + * @brief Get the priority of this plugin. + * + * Higher priority plugins are checked first. + * Default priority is 0. + * + * @return Priority value (higher = more priority) + */ + virtual int priority() const { return 0; } +}; + +EXTRACTOR_PLUGIN_END_NAMESPACE + +#define AbstractExtractorPluginInterface_iid "org.deepin.anything.AbstractExtractorPlugin/1.0" +Q_DECLARE_INTERFACE(EXTRACTOR_PLUGIN_NAMESPACE::AbstractExtractorPlugin, AbstractExtractorPluginInterface_iid) + +#endif // ABSTRACTEXTRACTORPLUGIN_H diff --git a/src/extractor/plugins/extractor_plugin_global.h b/src/extractor/plugins/extractor_plugin_global.h new file mode 100644 index 00000000..99bb3418 --- /dev/null +++ b/src/extractor/plugins/extractor_plugin_global.h @@ -0,0 +1,16 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef EXTRACTOR_PLUGIN_GLOBAL_H +#define EXTRACTOR_PLUGIN_GLOBAL_H + +#include + +#define EXTRACTOR_PLUGIN_NAMESPACE anything_extractor_plugin + +#define EXTRACTOR_PLUGIN_BEGIN_NAMESPACE namespace EXTRACTOR_PLUGIN_NAMESPACE { +#define EXTRACTOR_PLUGIN_END_NAMESPACE } +#define EXTRACTOR_PLUGIN_USE_NAMESPACE using namespace EXTRACTOR_PLUGIN_NAMESPACE; + +#endif // EXTRACTOR_PLUGIN_GLOBAL_H diff --git a/src/extractor/plugins/ocr-extractor/CMakeLists.txt b/src/extractor/plugins/ocr-extractor/CMakeLists.txt new file mode 100644 index 00000000..45dee514 --- /dev/null +++ b/src/extractor/plugins/ocr-extractor/CMakeLists.txt @@ -0,0 +1,61 @@ +cmake_minimum_required(VERSION 3.10) + +project(ocr-extractor CXX) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_AUTOMOC ON) +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +set(OCREXTRACTOR_FILES + ocrextractor.cpp + ocrextractor.h + ocrextractorplugin.cpp + ocrextractorplugin.h + ocrextractor.json +) + +set(BIN_NAME ${PROJECT_NAME}) + +set(OCREXTRACTOR_COMMON_HEADERS + ${CMAKE_CURRENT_SOURCE_DIR}/../abstractextractorplugin.h + ${CMAKE_CURRENT_SOURCE_DIR}/../extractor_plugin_global.h +) + +find_package(Qt6 COMPONENTS Core Gui REQUIRED) +find_package(Dtk6 COMPONENTS Core REQUIRED) +find_package(PkgConfig REQUIRED) +pkg_check_modules(DtkOcr REQUIRED IMPORTED_TARGET dtk6ocr) + +add_library(${BIN_NAME} + SHARED + ${OCREXTRACTOR_FILES} + ${OCREXTRACTOR_COMMON_HEADERS} +) + +target_link_libraries(${BIN_NAME} + PRIVATE + Qt6::Core + Qt6::Gui + Dtk6::Core + PkgConfig::DtkOcr +) + +target_include_directories(${BIN_NAME} + PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_SOURCE_DIR}/.. +) + +target_compile_options(${BIN_NAME} PRIVATE -Wall -Wextra) + +install(TARGETS ${BIN_NAME} + LIBRARY + DESTINATION ${ANYTHING_EXTRACTOR_PLUGIN_DIR} +) + +install(FILES ocrextractor.json + DESTINATION ${ANYTHING_EXTRACTOR_PLUGIN_DIR} +) + +message(STATUS "ocr-extractor plugin configured") diff --git a/src/extractor/plugins/ocr-extractor/ocrextractor.cpp b/src/extractor/plugins/ocr-extractor/ocrextractor.cpp new file mode 100644 index 00000000..98408693 --- /dev/null +++ b/src/extractor/plugins/ocr-extractor/ocrextractor.cpp @@ -0,0 +1,338 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "ocrextractor.h" + +#include + +#include + +#include +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +namespace { + +constexpr char kTextIndexAppId[] = "org.deepin.dde.file-manager"; +constexpr char kTextIndexSchema[] = "org.deepin.dde.file-manager.textindex"; +constexpr char kSupportedOcrImageExtensions[] = "supportedOcrImageExtensions"; +constexpr char kMaxOcrImageSizeMB[] = "maxOcrImageSizeMB"; +constexpr int kDefaultMaxOcrImageSizeMB = 30; +constexpr int kMaxAllowedOcrImageSizeMB = 1024; +constexpr char kOcrImageScaleWidth[] = "ocrImageScaleWidth"; +constexpr char kOcrImageScaleHeight[] = "ocrImageScaleHeight"; +constexpr int kDefaultImageMaxWidth = 960; +constexpr int kDefaultImageMaxHeight = 540; +constexpr char kPreferredOcrPlugin[] = "PPOCR_V5"; + +QStringList defaultSupportedImageExtensions() +{ + return { + "ani", "bmp", "jpe", "jpeg", "jpg", "pcx", "png", "psd", + "tga", "tif", "tiff", "webp", "wmf", "heic", "heif", "raw" + }; +} + +Dtk::Core::DConfig &textIndexConfig() +{ + static Dtk::Core::DConfig *config = Dtk::Core::DConfig::create( + QString::fromLatin1(kTextIndexAppId), + QString::fromLatin1(kTextIndexSchema), + QString()); + return *config; +} + +void ensureTextIndexConfigLoaded() +{ + static const bool kConfigLoaded = [] { + if (!textIndexConfig().isValid()) + qWarning() << "OcrExtractor::ensureTextIndexConfigLoaded: failed to load DConfig schema:" << kTextIndexSchema; + return true; + }(); + + Q_UNUSED(kConfigLoaded) +} + +QStringList supportedImageExtensions() +{ + ensureTextIndexConfigLoaded(); + + return textIndexConfig().value(QString::fromLatin1(kSupportedOcrImageExtensions), + QVariant::fromValue(defaultSupportedImageExtensions())) + .toStringList(); +} + +size_t configuredMaxImageBytes() +{ + ensureTextIndexConfigLoaded(); + + const int maxSizeMB = textIndexConfig().value(QString::fromLatin1(kMaxOcrImageSizeMB), + kDefaultMaxOcrImageSizeMB) + .toInt(); + + if (maxSizeMB <= 0 || maxSizeMB > kMaxAllowedOcrImageSizeMB) { + qWarning() << "OcrExtractor::configuredMaxImageBytes: invalid maxOcrImageSizeMB value:" << maxSizeMB + << ", using default:" << kDefaultMaxOcrImageSizeMB; + return OcrExtractor::kDefaultMaxImageBytes; + } + + return static_cast(maxSizeMB) * 1024 * 1024; +} + +bool hasSupportedExtension(const QString &filePath) +{ + const QString suffix = QFileInfo(filePath).suffix().toLower(); + return !suffix.isEmpty() && supportedImageExtensions().contains(suffix); +} + +bool isWithinSizeLimit(const QString &filePath) +{ + const QFileInfo fileInfo(filePath); + if (!fileInfo.exists() || !fileInfo.isFile()) + return false; + + const qint64 fileSize = fileInfo.size(); + if (fileSize < 0) + return false; + + const size_t maxBytes = configuredMaxImageBytes(); + if (static_cast(fileSize) > maxBytes) { + qInfo() << "OcrExtractor::isWithinSizeLimit: skip oversized image:" << filePath + << ", size:" << fileSize << ", max:" << maxBytes; + return false; + } + + return true; +} + +struct OcrImageScaleConfig +{ + int maxWidth; + int maxHeight; +}; + +OcrImageScaleConfig cachedScaleConfig() +{ + static const OcrImageScaleConfig config = [] { + ensureTextIndexConfigLoaded(); + const int w = textIndexConfig().value(QString::fromLatin1(kOcrImageScaleWidth), + kDefaultImageMaxWidth) + .toInt(); + const int h = textIndexConfig().value(QString::fromLatin1(kOcrImageScaleHeight), + kDefaultImageMaxHeight) + .toInt(); + return OcrImageScaleConfig { w, h }; + }(); + return config; +} + +QImage scaledImageForOcr(const QString &filePath) +{ + QImage image(filePath); + if (image.isNull()) { + qWarning() << "OcrExtractor::scaledImageForOcr: failed to load image:" << filePath; + return {}; + } + + const auto [maxWidth, maxHeight] = cachedScaleConfig(); + + // Fix: use Qt::KeepAspectRatio to ensure result fits within maxWidth x maxHeight bounding box. + // The old scaledToWidth/scaledToHeight branch could overflow the non-primary dimension + // (e.g. a 2000x1500 image scaled to 1280 width produced 960 height, exceeding maxHeight=720). + if (maxWidth > 0 && maxHeight > 0) { + if (image.width() > maxWidth || image.height() > maxHeight) { + image = image.scaled(maxWidth, maxHeight, + Qt::KeepAspectRatio, Qt::SmoothTransformation); + } + } + + return image; +} + +bool initializeOcrEngine(Dtk::Ocr::DOcr &ocr) +{ + const QString preferredPlugin = QString::fromLatin1(kPreferredOcrPlugin); + bool loaded = false; + const QStringList plugins = ocr.installedPluginNames(); + if (plugins.contains(preferredPlugin, Qt::CaseInsensitive)) { + loaded = ocr.loadPlugin(preferredPlugin); + if (loaded) + qInfo() << "OcrExtractor::initializeOcrEngine: loaded OCR plugin:" << preferredPlugin; + else + qWarning() << "OcrExtractor::initializeOcrEngine: failed to load OCR plugin:" << preferredPlugin; + } + + if (!loaded) { + loaded = ocr.loadDefaultPlugin(); + if (loaded) { + qInfo() << "OcrExtractor::initializeOcrEngine: loaded default OCR plugin"; + } else { + qWarning() << "OcrExtractor::initializeOcrEngine: failed to load default OCR plugin"; + } + } + + if (loaded) + ocr.setUseMaxThreadsCount(2); + + return loaded; +} + +bool isSymbolOrPunctuation(const QChar &ch) +{ + switch (ch.category()) { + case QChar::Punctuation_Connector: + case QChar::Punctuation_Dash: + case QChar::Punctuation_Open: + case QChar::Punctuation_Close: + case QChar::Punctuation_InitialQuote: + case QChar::Punctuation_FinalQuote: + case QChar::Punctuation_Other: + case QChar::Symbol_Math: + case QChar::Symbol_Currency: + case QChar::Symbol_Modifier: + case QChar::Symbol_Other: + return true; + default: + return false; + } +} + +Dtk::Ocr::DOcr *sharedOcrEngine() +{ + static Dtk::Ocr::DOcr *ocr = []() -> Dtk::Ocr::DOcr * { + auto *engine = new Dtk::Ocr::DOcr; + if (!initializeOcrEngine(*engine)) { + delete engine; + return nullptr; + } + + return engine; + }(); + + return ocr; +} + +bool isNoiseLine(const QString &line) +{ + bool hasVisibleChar = false; + bool hasMeaningfulChar = false; + bool allVisibleCharsAreSymbols = true; + int visibleCharCount = 0; + + for (const QChar &ch : line) { + if (ch.isSpace()) + continue; + + hasVisibleChar = true; + ++visibleCharCount; + + if (ch.isLetterOrNumber()) { + hasMeaningfulChar = true; + allVisibleCharsAreSymbols = false; + break; + } + + // CJK scripts: Han (Chinese), Hiragana/Katakana (Japanese), Hangul (Korean) + const auto script = ch.script(); + if (script == QChar::Script_Han + || script == QChar::Script_Hiragana + || script == QChar::Script_Katakana + || script == QChar::Script_Hangul) { + hasMeaningfulChar = true; + allVisibleCharsAreSymbols = false; + break; + } + + if (!isSymbolOrPunctuation(ch)) + allVisibleCharsAreSymbols = false; + } + + // No visible content at all → noise + if (!hasVisibleChar) + return true; + + // Has at least one letter, digit, or CJK character → not noise + if (hasMeaningfulChar) + return false; + + // Filter common OCR noise like "□", "_" or a short run of punctuation. + return allVisibleCharsAreSymbols && visibleCharCount <= 3; +} + +QString cleanRecognizedText(const QString &text) +{ + // Normalize Unicode first to ensure consistent comparison + const QString normalized = text.normalized(QString::NormalizationForm_C); + + QStringList cleanedLines; + const QStringList lines = normalized.split('\n'); + + for (const QString &line : lines) { + const QString trimmed = line.trimmed(); + if (trimmed.isEmpty()) + continue; + + if (isNoiseLine(trimmed)) + continue; + + // Skip consecutive duplicate lines (common OCR artifact from watermarks/repeated patterns) + if (!cleanedLines.isEmpty() && cleanedLines.last() == trimmed) + continue; + + cleanedLines.append(trimmed); + } + + return cleanedLines.join('\n'); +} + +} // namespace + +std::optional OcrExtractor::extract(const QString &filePath) +{ + if (!isSupportedImage(filePath)) { + qDebug() << "OcrExtractor::extract: unsupported OCR image:" << filePath; + return std::nullopt; + } + + QImage image = scaledImageForOcr(filePath); + if (image.isNull()) + return std::nullopt; + + Dtk::Ocr::DOcr *ocr = sharedOcrEngine(); + if (!ocr) { + qWarning() << "OcrExtractor::extract: shared OCR engine is unavailable"; + return std::nullopt; + } + + if (!ocr->setImage(image)) { + qWarning() << "OcrExtractor::extract: failed to set OCR image:" << filePath; + return std::nullopt; + } + + if (!ocr->analyze()) { + qWarning() << "OcrExtractor::extract: OCR analyze failed for:" << filePath; + return std::nullopt; + } + + const QString cleanedText = cleanRecognizedText(ocr->simpleResult()); + if (cleanedText.size() < 2) { + qDebug() << "OcrExtractor::extract: cleaned OCR result has less than 2 characters for:" << filePath; + return std::nullopt; + } + + return cleanedText.toUtf8(); +} + +bool OcrExtractor::isSupportedImage(const QString &filePath) +{ + if (!hasSupportedExtension(filePath)) + return false; + + return isWithinSizeLimit(filePath); +} + +EXTRACTOR_PLUGIN_END_NAMESPACE diff --git a/src/extractor/plugins/ocr-extractor/ocrextractor.h b/src/extractor/plugins/ocr-extractor/ocrextractor.h new file mode 100644 index 00000000..d1e8b4ec --- /dev/null +++ b/src/extractor/plugins/ocr-extractor/ocrextractor.h @@ -0,0 +1,28 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef OCREXTRACTOR_H +#define OCREXTRACTOR_H + +#include "extractor_plugin_global.h" + +#include +#include + +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +class OcrExtractor +{ +public: + static constexpr size_t kDefaultMaxImageBytes = 30 * 1024 * 1024; // 30 MB + + static std::optional extract(const QString &filePath); + static bool isSupportedImage(const QString &filePath); +}; + +EXTRACTOR_PLUGIN_END_NAMESPACE + +#endif // OCREXTRACTOR_H diff --git a/src/extractor/plugins/ocr-extractor/ocrextractor.json b/src/extractor/plugins/ocr-extractor/ocrextractor.json new file mode 100644 index 00000000..29912385 --- /dev/null +++ b/src/extractor/plugins/ocr-extractor/ocrextractor.json @@ -0,0 +1,5 @@ +{ + "name": "OcrExtractor", + "version": "1.0.0", + "description": "OCR-based text extraction plugin for supported image formats" +} diff --git a/src/extractor/plugins/ocr-extractor/ocrextractorplugin.cpp b/src/extractor/plugins/ocr-extractor/ocrextractorplugin.cpp new file mode 100644 index 00000000..905b395b --- /dev/null +++ b/src/extractor/plugins/ocr-extractor/ocrextractorplugin.cpp @@ -0,0 +1,35 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "ocrextractorplugin.h" +#include "ocrextractor.h" + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +OcrExtractorPlugin::OcrExtractorPlugin(QObject *parent) + : AbstractExtractorPlugin(parent) +{ +} + +bool OcrExtractorPlugin::canExtract(const QString &filePath) const +{ + return OcrExtractor::isSupportedImage(filePath); +} + +std::optional OcrExtractorPlugin::extract(const QString &filePath) +{ + return OcrExtractor::extract(filePath); +} + +QString OcrExtractorPlugin::name() const +{ + return "OcrExtractor"; +} + +int OcrExtractorPlugin::priority() const +{ + return 0; +} + +EXTRACTOR_PLUGIN_END_NAMESPACE diff --git a/src/extractor/plugins/ocr-extractor/ocrextractorplugin.h b/src/extractor/plugins/ocr-extractor/ocrextractorplugin.h new file mode 100644 index 00000000..a8510368 --- /dev/null +++ b/src/extractor/plugins/ocr-extractor/ocrextractorplugin.h @@ -0,0 +1,31 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef OCREXTRACTORPLUGIN_H +#define OCREXTRACTORPLUGIN_H + +#include "abstractextractorplugin.h" +#include "extractor_plugin_global.h" + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +class OcrExtractorPlugin : public AbstractExtractorPlugin +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID AbstractExtractorPluginInterface_iid FILE "ocrextractor.json") + Q_INTERFACES(EXTRACTOR_PLUGIN_NAMESPACE::AbstractExtractorPlugin) + +public: + explicit OcrExtractorPlugin(QObject *parent = nullptr); + ~OcrExtractorPlugin() override = default; + + bool canExtract(const QString &filePath) const override; + std::optional extract(const QString &filePath) override; + QString name() const override; + int priority() const override; +}; + +EXTRACTOR_PLUGIN_END_NAMESPACE + +#endif // OCREXTRACTORPLUGIN_H diff --git a/src/extractor/plugins/text-extractor/CMakeLists.txt b/src/extractor/plugins/text-extractor/CMakeLists.txt new file mode 100644 index 00000000..f6e29bf2 --- /dev/null +++ b/src/extractor/plugins/text-extractor/CMakeLists.txt @@ -0,0 +1,63 @@ +cmake_minimum_required(VERSION 3.10) + +project(text-extractor CXX) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_AUTOMOC ON) +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +set(TEXTEXTRACTOR_FILES + textextractor.cpp + textextractor.h + textextractorplugin.cpp + textextractorplugin.h + textextractor.json +) + +set(BIN_NAME ${PROJECT_NAME}) + +set(TEXTEXTRACTOR_COMMON_HEADERS + ${CMAKE_CURRENT_SOURCE_DIR}/../abstractextractorplugin.h + ${CMAKE_CURRENT_SOURCE_DIR}/../extractor_plugin_global.h +) + +find_package(Qt6 COMPONENTS Core Gui REQUIRED) +find_package(Dtk6 COMPONENTS Core REQUIRED) +find_package(PkgConfig REQUIRED) +pkg_check_modules(Docparser REQUIRED IMPORTED_TARGET docparser) + +add_library(${BIN_NAME} + SHARED + ${TEXTEXTRACTOR_FILES} + ${TEXTEXTRACTOR_COMMON_HEADERS} +) + +target_link_libraries(${BIN_NAME} + PRIVATE + Qt6::Core + Qt6::Gui + Dtk6::Core + PkgConfig::Docparser +) + +target_include_directories(${BIN_NAME} + PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_SOURCE_DIR}/.. +) + +target_compile_options(${BIN_NAME} PRIVATE -Wall -Wextra) + +# Install the plugin +install(TARGETS ${BIN_NAME} + LIBRARY + DESTINATION ${ANYTHING_EXTRACTOR_PLUGIN_DIR} +) + +# Install metadata file +install(FILES textextractor.json + DESTINATION ${ANYTHING_EXTRACTOR_PLUGIN_DIR} +) + +message(STATUS "text-extractor plugin configured") diff --git a/src/extractor/plugins/text-extractor/textextractor.cpp b/src/extractor/plugins/text-extractor/textextractor.cpp new file mode 100644 index 00000000..b153d122 --- /dev/null +++ b/src/extractor/plugins/text-extractor/textextractor.cpp @@ -0,0 +1,259 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "textextractor.h" + +#include + +#include + +#include + +#include +#include +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +namespace { + +constexpr char kTextIndexAppId[] = "org.deepin.dde.file-manager"; +constexpr char kTextIndexSchema[] = "org.deepin.dde.file-manager.textindex"; +constexpr char kSupportedFileExtensions[] = "supportedFileExtensions"; +constexpr char kMaxIndexFileTruncationSizeMB[] = "maxIndexFileTruncationSizeMB"; +constexpr int kDefaultMaxIndexFileTruncationSizeMB = 10; +constexpr int kMaxAllowedIndexFileTruncationSizeMB = 1024; + +QStringList defaultSupportedExtensions() +{ + return { + "rtf", "odt", "ods", "odp", "odg", "docx", + "xlsx", "pptx", "ppsx", "md", "xls", "xlsb", + "doc", "dot", "wps", "ppt", "pps", "txt", + "pdf", "dps", "sh", "html", "htm", "xml", + "xhtml", "dhtml", "shtm", "shtml", "json", + "css", "yaml", "ini", "bat", "js", "sql", + "uof", "ofd" + }; +} + +Dtk::Core::DConfig &textIndexConfig() +{ + static Dtk::Core::DConfig *config = Dtk::Core::DConfig::create( + QString::fromLatin1(kTextIndexAppId), + QString::fromLatin1(kTextIndexSchema), + QString()); + return *config; +} + +void ensureTextIndexConfigLoaded() +{ + static const bool kConfigLoaded = [] { + if (!textIndexConfig().isValid()) + qWarning() << "TextExtractor: Failed to load DConfig schema:" << kTextIndexSchema; + return true; + }(); + + Q_UNUSED(kConfigLoaded) +} + +QStringList supportedFileExtensions() +{ + ensureTextIndexConfigLoaded(); + + return textIndexConfig().value(QString::fromLatin1(kSupportedFileExtensions), + QVariant::fromValue(defaultSupportedExtensions())) + .toStringList(); +} + +size_t configuredMaxExtractBytes() +{ + ensureTextIndexConfigLoaded(); + + const int truncationSizeMB = textIndexConfig().value(QString::fromLatin1(kMaxIndexFileTruncationSizeMB), + kDefaultMaxIndexFileTruncationSizeMB) + .toInt(); + + // Fix: keep extractor aligned with textindex defaults and guard invalid dconfig values. + if (truncationSizeMB <= 0 || truncationSizeMB > kMaxAllowedIndexFileTruncationSizeMB) { + qWarning() << "TextExtractor: Invalid maxIndexFileTruncationSizeMB value:" << truncationSizeMB + << ", using default:" << kDefaultMaxIndexFileTruncationSizeMB; + return TextExtractor::kDefaultMaxBytes; + } + + return static_cast(truncationSizeMB) * 1024 * 1024; +} + +QByteArray detectFileEncoding(const QString &filePath) +{ + return Dtk::Core::DTextEncoding::detectFileEncoding(filePath); +} + +bool convertTextEncoding(const QByteArray &input, QByteArray &output, + const QString &toEncoding, const QString &fromEncoding) +{ + return Dtk::Core::DTextEncoding::convertTextEncodingEx(const_cast(input), output, + toEncoding.toUtf8(), fromEncoding.toUtf8()); +} + +QString getFileEncoding(const QString &filePath) +{ + QMimeDatabase mimeDb; + QString mimeTypeName = mimeDb.mimeTypeForFile(filePath).name(); + + if (mimeTypeName.startsWith("text/")) { + return QString::fromUtf8(detectFileEncoding(filePath)); + } else { + return QString("utf-8"); + } +} + +std::optional convertToUtf8(const QByteArray &content, const QString &fromEncoding) +{ + if (fromEncoding.toLower() == "utf-8") { + return QString::fromUtf8(content); + } else { + QByteArray out; + if (convertTextEncoding(content, out, "utf-8", fromEncoding)) { + return QString::fromUtf8(out); + } else { + qWarning() << "TextExtractor: Failed to convert encoding from" << fromEncoding << "to UTF-8"; + return std::nullopt; + } + } +} + +bool isHtmlStyleDocument(const QString &filePath) +{ + static const QSet kHtmlStyleExtensions = { "html", "htm", "xml", "uof" }; + + QFileInfo fileInfo(filePath); + return kHtmlStyleExtensions.contains(fileInfo.suffix().toLower()); +} + +QString cleanExtractedText(const QString &text) +{ + if (text.isEmpty()) + return QString(); + + QStringList cleanedLines; + const QStringList lines = text.split('\n'); + + for (const QString &line : lines) { + const QString trimmed = line.trimmed(); + // Remove all blank lines - they have no value for full-text indexing + if (trimmed.isEmpty()) + continue; + cleanedLines.append(trimmed); + } + + if (cleanedLines.isEmpty()) + return QString(); + + return cleanedLines.join('\n'); +} + +std::optional extractHtmlContent(const QString &filePath, size_t maxBytes) +{ + QFile file(filePath); + if (!file.open(QIODevice::ReadOnly)) { + qWarning() << "TextExtractor: Failed to open file for HTML extraction:" << filePath; + return std::nullopt; + } + + QByteArray htmlBytes; + if (maxBytes > 0) { + qint64 fileSize = file.size(); + if (fileSize <= static_cast(maxBytes)) { + htmlBytes = file.readAll(); + } else { + htmlBytes = file.read(static_cast(maxBytes)); + qDebug() << "TextExtractor: HTML file truncated from" << fileSize << "to" << maxBytes << "bytes:" << filePath; + } + } else { + htmlBytes = file.readAll(); + } + file.close(); + + QString fromEncoding = getFileEncoding(filePath); + + const auto &convertedContent = convertToUtf8(htmlBytes, fromEncoding); + if (!convertedContent) { + return std::nullopt; + } + + QTextDocument doc; + doc.setHtml(convertedContent.value()); + const QString plainText = doc.toPlainText(); + + const QString cleanedText = cleanExtractedText(plainText); + if (cleanedText.size() < 2) + return std::nullopt; + + return cleanedText; +} + +} // namespace + +std::optional TextExtractor::extract(const QString &filePath) +{ + return extract(filePath, configuredMaxExtractBytes()); +} + +std::optional TextExtractor::extract(const QString &filePath, size_t maxBytes) +{ + qDebug() << "TextExtractor: Extracting file:" << filePath; + + // First try HTML extraction for HTML-style documents + if (isHtmlStyleDocument(filePath)) { + auto htmlContent = extractHtmlContent(filePath, maxBytes); + if (htmlContent) { + return htmlContent->toUtf8(); + } + } + + // Use DocParser for all other files + try { + QString fromEncoding = getFileEncoding(filePath); + + std::string stdContents; + if (maxBytes > 0) { + stdContents = DocParser::convertFile(filePath.toStdString(), maxBytes); + } else { + stdContents = DocParser::convertFile(filePath.toStdString()); + } + + QByteArray contentBytes(stdContents.c_str(), stdContents.length()); + const auto &result = convertToUtf8(contentBytes, fromEncoding); + + if (result) { + const QString cleanedText = cleanExtractedText(result.value()); + if (cleanedText.size() < 2) + return std::nullopt; + return cleanedText.toUtf8(); + } + + return std::nullopt; + } catch (const std::exception &e) { + qWarning() << "TextExtractor: Exception while extracting file content from" << filePath << ":" << e.what(); + return std::nullopt; + } +} + +bool TextExtractor::isTextDocument(const QString &filePath) +{ + QMimeDatabase mimeDb; + QString mimeTypeName = mimeDb.mimeTypeForFile(filePath).name(); + QFileInfo fileInfo(filePath); + + // Check for text/* mimetypes + if (mimeTypeName.startsWith("text/")) + return true; + + return supportedFileExtensions().contains(fileInfo.suffix().toLower()); +} + +EXTRACTOR_PLUGIN_END_NAMESPACE diff --git a/src/extractor/plugins/text-extractor/textextractor.h b/src/extractor/plugins/text-extractor/textextractor.h new file mode 100644 index 00000000..c52a2bfa --- /dev/null +++ b/src/extractor/plugins/text-extractor/textextractor.h @@ -0,0 +1,58 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TEXTEXTRACTOR_H +#define TEXTEXTRACTOR_H + +#include "extractor_plugin_global.h" + +#include +#include +#include + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +/** + * @brief TextExtractor handles text content extraction from various file formats. + * + * This class uses DocParser and DTextEncoding for content extraction, + * similar to the textindex service's DocUtils::extractFileContent. + */ +class TextExtractor +{ +public: + /** + * @brief Fallback maximum bytes to extract when dconfig is unavailable. + */ + static constexpr size_t kDefaultMaxBytes = 10 * 1024 * 1024; // 10 MB + + /** + * @brief Extract text content from a file. + * + * @param filePath Path to the file + * @return Extracted text as UTF-8 QByteArray, or nullopt on failure + */ + static std::optional extract(const QString &filePath); + + /** + * @brief Extract text content from a file. + * + * @param filePath Path to the file + * @param maxBytes Maximum bytes to extract (0 = no limit) + * @return Extracted text as UTF-8 QByteArray, or nullopt on failure + */ + static std::optional extract(const QString &filePath, size_t maxBytes); + + /** + * @brief Check if a file is likely a text-based document. + * + * @param filePath Path to the file + * @return true if the file is a text document + */ + static bool isTextDocument(const QString &filePath); +}; + +EXTRACTOR_PLUGIN_END_NAMESPACE + +#endif // TEXTEXTRACTOR_H diff --git a/src/extractor/plugins/text-extractor/textextractor.json b/src/extractor/plugins/text-extractor/textextractor.json new file mode 100644 index 00000000..e7945b23 --- /dev/null +++ b/src/extractor/plugins/text-extractor/textextractor.json @@ -0,0 +1,5 @@ +{ + "name": "TextExtractor", + "version": "1.0.0", + "description": "Text content extraction plugin for various document formats" +} diff --git a/src/extractor/plugins/text-extractor/textextractorplugin.cpp b/src/extractor/plugins/text-extractor/textextractorplugin.cpp new file mode 100644 index 00000000..485d3792 --- /dev/null +++ b/src/extractor/plugins/text-extractor/textextractorplugin.cpp @@ -0,0 +1,36 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "textextractorplugin.h" +#include "textextractor.h" + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +TextExtractorPlugin::TextExtractorPlugin(QObject *parent) + : AbstractExtractorPlugin(parent) +{ +} + +bool TextExtractorPlugin::canExtract(const QString &filePath) const +{ + return TextExtractor::isTextDocument(filePath); +} + +std::optional TextExtractorPlugin::extract(const QString &filePath) +{ + return TextExtractor::extract(filePath); +} + +QString TextExtractorPlugin::name() const +{ + return "TextExtractor"; +} + +int TextExtractorPlugin::priority() const +{ + // Default priority for text extraction + return 0; +} + +EXTRACTOR_PLUGIN_END_NAMESPACE diff --git a/src/extractor/plugins/text-extractor/textextractorplugin.h b/src/extractor/plugins/text-extractor/textextractorplugin.h new file mode 100644 index 00000000..e74902be --- /dev/null +++ b/src/extractor/plugins/text-extractor/textextractorplugin.h @@ -0,0 +1,34 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TEXTEXTRACTORPLUGIN_H +#define TEXTEXTRACTORPLUGIN_H + +#include "extractor_plugin_global.h" +#include "abstractextractorplugin.h" + +EXTRACTOR_PLUGIN_BEGIN_NAMESPACE + +/** + * @brief TextExtractorPlugin provides text content extraction functionality. + */ +class TextExtractorPlugin : public AbstractExtractorPlugin +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID AbstractExtractorPluginInterface_iid FILE "textextractor.json") + Q_INTERFACES(EXTRACTOR_PLUGIN_NAMESPACE::AbstractExtractorPlugin) + +public: + explicit TextExtractorPlugin(QObject *parent = nullptr); + ~TextExtractorPlugin() override = default; + + bool canExtract(const QString &filePath) const override; + std::optional extract(const QString &filePath) override; + QString name() const override; + int priority() const override; +}; + +EXTRACTOR_PLUGIN_END_NAMESPACE + +#endif // TEXTEXTRACTORPLUGIN_H diff --git a/src/index/CMakeLists.txt b/src/index/CMakeLists.txt new file mode 100644 index 00000000..63b40783 --- /dev/null +++ b/src/index/CMakeLists.txt @@ -0,0 +1,152 @@ +cmake_minimum_required(VERSION 3.10) + +project(deepin-anything-index CXX) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_AUTOMOC ON) +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +include(GNUInstallDirs) + +find_package(PkgConfig REQUIRED) +find_package(Qt6 REQUIRED COMPONENTS Core DBus Gui Concurrent) +find_package(Dtk6 COMPONENTS Core) +find_package(dfm6-search REQUIRED) +find_package(KF6IdleTime REQUIRED) + +pkg_check_modules(Lucene REQUIRED IMPORTED_TARGET liblucene++ liblucene++-contrib) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(MOUNT REQUIRED mount IMPORTED_TARGET) + +set(INDEX_SOURCES + core/indexruntime.cpp + core/indexcontext.h + task/backlogtracker.cpp + task/fileprovider.cpp + task/indexcontentmigrator.cpp + task/indextask.cpp + task/moveprocessor.cpp + task/progressnotifier.cpp + task/taskhandler.cpp + task/taskmanager.cpp + task/taskqueueutils.cpp + document/contentdocumentbuilder.cpp + document/filenamedocumentbuilder.cpp + document/ocrdocumentbuilder.cpp + fsmonitor/fseventcollector.cpp + fsmonitor/fseventcontroller.cpp + fsmonitor/fsmonitor.cpp + fsmonitor/fsmonitorworker.cpp + fsmonitor/inotifyfilesystemwatcher.cpp + fsmonitor/vfsmonitorwatcher.cpp + profile/indexprofile.cpp + profile/lowercasengramanalyzer.cpp + state/indexstatestore.cpp + env/envdetector.cpp + env/idlemonitor.cpp + env/loadmonitor.cpp + env/powermonitor.cpp + extractor/contentdeduplication.cpp + extractor/ocrdeduplication.cpp + extractor/processextractor.cpp + utils/docutils.cpp + utils/filehash.cpp + utils/filetypemapper.cpp + utils/indextraverseutils.cpp + utils/indexutility.cpp + utils/pathexcludematcher.cpp + utils/pinyinprocessor.cpp + utils/systemdcpuutils.cpp + utils/textindexconfig.cpp + utils/threadscheduling.cpp + dbus/textindexdbus.cpp + dbus/ocrindexdbus.cpp + dbus/filenameindexdbus.cpp + serviceentry.cpp +) +list(TRANSFORM INDEX_SOURCES PREPEND ${CMAKE_CURRENT_SOURCE_DIR}/) +file(GLOB_RECURSE INDEX_HEADERS CONFIGURE_DEPENDS "*.h") + +# D-Bus adaptors: the three interface XMLs are the single source of truth. +set(DBUS_INTERFACE_FILE ${CMAKE_CURRENT_SOURCE_DIR}/assets/dbus/org.deepin.Filemanager.TextIndex.xml) +set(OCR_DBUS_INTERFACE_FILE ${CMAKE_CURRENT_SOURCE_DIR}/assets/dbus/org.deepin.Filemanager.OcrIndex.xml) +set(FILENAME_DBUS_INTERFACE_FILE ${CMAKE_CURRENT_SOURCE_DIR}/assets/dbus/org.deepin.Filemanager.FileNameIndex.xml) + +qt6_add_dbus_adaptor(INDEX_ADAPTOR_SOURCES ${DBUS_INTERFACE_FILE} + dbus/textindexdbus.h TextIndexDBus) +qt6_add_dbus_adaptor(OCR_ADAPTOR_SOURCES ${OCR_DBUS_INTERFACE_FILE} + dbus/ocrindexdbus.h OcrIndexDBus) +qt6_add_dbus_adaptor(FILENAME_ADAPTOR_SOURCES ${FILENAME_DBUS_INTERFACE_FILE} + dbus/filenameindexdbus.h FileNameIndexDBus) + +# Pin the generated adaptor paths (the macro's relative output is ambiguous +# across scopes; the tests subdirectory reuses these variables). +set(INDEX_ADAPTOR_SOURCES ${CMAKE_CURRENT_BINARY_DIR}/textindexadaptor.cpp) +set(OCR_ADAPTOR_SOURCES ${CMAKE_CURRENT_BINARY_DIR}/ocrindexadaptor.cpp) +set(FILENAME_ADAPTOR_SOURCES ${CMAKE_CURRENT_BINARY_DIR}/filenameindexadaptor.cpp) +set_source_files_properties(${INDEX_ADAPTOR_SOURCES} ${OCR_ADAPTOR_SOURCES} + ${FILENAME_ADAPTOR_SOURCES} PROPERTIES GENERATED TRUE) + +# Bundle the three adaptors into a small static library so both the service +# binary and the white-box test target (in a subdirectory) can consume the +# generated files without cross-directory custom-command tricks. +add_library(index_adaptors STATIC + ${INDEX_ADAPTOR_SOURCES} + ${OCR_ADAPTOR_SOURCES} + ${FILENAME_ADAPTOR_SOURCES} +) +target_include_directories(index_adaptors PUBLIC + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_BINARY_DIR} +) +target_link_libraries(index_adaptors PUBLIC Qt6::Core Qt6::DBus dfm6-search) + +add_executable(deepin-anything-index + ${INDEX_SOURCES} + ${INDEX_HEADERS} + main.cpp +) + +target_include_directories(deepin-anything-index PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_SOURCE_DIR}/dbus +) + +target_compile_definitions(deepin-anything-index PRIVATE + ANYTHING_EXTRACTOR_TOOL="${CMAKE_INSTALL_FULL_LIBEXECDIR}/deepin-anything-extractor" + PINYIN_DICT_INSTALL_DIR="${CMAKE_INSTALL_FULL_DATADIR}/deepin-anything-index" +) + +target_link_libraries(deepin-anything-index PRIVATE + common + index_adaptors + deepin-anything-extractor-lib + dfm6-search + Dtk6::Core + Qt6::Core + Qt6::DBus + Qt6::Gui + Qt6::Concurrent + PkgConfig::Lucene + PkgConfig::MOUNT + PkgConfig::GLIB + KF6::IdleTime +) + +# The extractor communication library lives in the standard libdir; no RPATH needed. +target_compile_options(deepin-anything-index PRIVATE -Wall -Wextra) + +install(TARGETS deepin-anything-index DESTINATION ${CMAKE_INSTALL_BINDIR}) +# systemd only searches /usr/lib/systemd/user for user units (no multiarch variant). +install(FILES deepin-anything-index.service DESTINATION lib/systemd/user) +install(FILES assets/dbus/org.deepin.Filemanager.TextIndex.service + DESTINATION ${CMAKE_INSTALL_FULL_DATADIR}/dbus-1/services) +# The three interface XMLs in assets/dbus/ are the canonical source for +# qt6_add_dbus_adaptor codegen only — they are NOT installed from this +# package; dde-file-manager publishes its frozen copies (ADR-0002). +install(FILES ${CMAKE_SOURCE_DIR}/config/pinyin.txt DESTINATION ${CMAKE_INSTALL_DATADIR}/deepin-anything-index) + +# White-box test support: expose the index source list to the root-level +# autotests/index suite (ut-anything-index compiles these sources directly). +set(ANYTHING_INDEX_SOURCES "${INDEX_SOURCES}" CACHE INTERNAL "deepin-anything-index sources for ut-anything-index") diff --git a/src/index/assets/dbus/org.deepin.Filemanager.FileNameIndex.xml b/src/index/assets/dbus/org.deepin.Filemanager.FileNameIndex.xml new file mode 100644 index 00000000..7ceb44c7 --- /dev/null +++ b/src/index/assets/dbus/org.deepin.Filemanager.FileNameIndex.xml @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/index/assets/dbus/org.deepin.Filemanager.OcrIndex.xml b/src/index/assets/dbus/org.deepin.Filemanager.OcrIndex.xml new file mode 100644 index 00000000..57d8b39c --- /dev/null +++ b/src/index/assets/dbus/org.deepin.Filemanager.OcrIndex.xml @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/index/assets/dbus/org.deepin.Filemanager.TextIndex.service b/src/index/assets/dbus/org.deepin.Filemanager.TextIndex.service new file mode 100644 index 00000000..f0b55dc9 --- /dev/null +++ b/src/index/assets/dbus/org.deepin.Filemanager.TextIndex.service @@ -0,0 +1,4 @@ +[D-BUS Service] +Name=org.deepin.Filemanager.TextIndex +Exec=/usr/bin/deepin-anything-index +SystemdService=deepin-anything-index.service diff --git a/src/index/assets/dbus/org.deepin.Filemanager.TextIndex.xml b/src/index/assets/dbus/org.deepin.Filemanager.TextIndex.xml new file mode 100644 index 00000000..1cc49b95 --- /dev/null +++ b/src/index/assets/dbus/org.deepin.Filemanager.TextIndex.xml @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/index/core/indexcontext.h b/src/index/core/indexcontext.h new file mode 100644 index 00000000..165aab26 --- /dev/null +++ b/src/index/core/indexcontext.h @@ -0,0 +1,58 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXCONTEXT_H +#define INDEXCONTEXT_H + +#include "document/indexdocumentbuilder.h" +#include "extractor/indexextractor.h" +#include "profile/indexprofile.h" +#include "state/indexstatestore.h" + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class IndexContext +{ +public: + IndexContext(IndexProfile profile, + const IndexStateStore *stateStore, + const IndexExtractor *extractor, + const IndexDocumentBuilder *documentBuilder) + : m_profile(std::move(profile)), + m_stateStore(stateStore), + m_extractor(extractor), + m_documentBuilder(documentBuilder) + { + } + + const IndexProfile &profile() const + { + return m_profile; + } + + const IndexStateStore *stateStore() const + { + return m_stateStore; + } + + const IndexExtractor *extractor() const + { + return m_extractor; + } + + const IndexDocumentBuilder *documentBuilder() const + { + return m_documentBuilder; + } + +private: + IndexProfile m_profile; + const IndexStateStore *m_stateStore { nullptr }; + const IndexExtractor *m_extractor { nullptr }; + const IndexDocumentBuilder *m_documentBuilder { nullptr }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXCONTEXT_H diff --git a/src/index/core/indexruntime.cpp b/src/index/core/indexruntime.cpp new file mode 100644 index 00000000..c38a8601 --- /dev/null +++ b/src/index/core/indexruntime.cpp @@ -0,0 +1,72 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "indexruntime.h" +#include "env/envdetector.h" + +ANYTHING_INDEX_BEGIN_NAMESPACE + +IndexRuntime::IndexRuntime(IndexProfile profile, QObject *parent) + : QObject(parent), + m_profile(std::move(profile)), + m_stateStore(m_profile), + m_context(m_profile, &m_stateStore, selectExtractor(), selectDocumentBuilder()), + m_fsEventController(new FSEventController(m_profile, this)) +{ + if (m_profile.type() == IndexProfile::Type::Filename) + m_backlogTracker = std::make_unique(&m_stateStore); + m_taskManager = new TaskManager(&m_context, m_backlogTracker.get(), this); + EnvDetector::instance().setDataPath(m_profile.indexDirectory()); + EnvDetector::instance().start(); +} + +const IndexProfile &IndexRuntime::profile() const +{ + return m_profile; +} + +const IndexStateStore &IndexRuntime::stateStore() const +{ + return m_stateStore; +} + +const IndexContext &IndexRuntime::context() const +{ + return m_context; +} + +TaskManager *IndexRuntime::taskManager() const +{ + return m_taskManager; +} + +FSEventController *IndexRuntime::fsEventController() const +{ + return m_fsEventController; +} + +const IndexExtractor *IndexRuntime::selectExtractor() const +{ + // 无内容提取需求的 profile（filename 只读文件元数据）不装配 extractor： + // 返回 nullptr → createFileDocument 跳过 ProcessExtractor::extract 调用， + // 避免全盘遍历时逐文件读取内容造成的严重 IO 浪费。 + if (!m_profile.requiresContentExtraction()) + return nullptr; + return &m_processExtractor; +} + +const IndexDocumentBuilder *IndexRuntime::selectDocumentBuilder() const +{ + switch (m_profile.type()) { + case IndexProfile::Type::Ocr: + return &m_ocrDocumentBuilder; + case IndexProfile::Type::Filename: + return &m_fileNameDocumentBuilder; + case IndexProfile::Type::Content: + default: + return &m_contentDocumentBuilder; + } +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/core/indexruntime.h b/src/index/core/indexruntime.h new file mode 100644 index 00000000..7b8f9374 --- /dev/null +++ b/src/index/core/indexruntime.h @@ -0,0 +1,56 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXRUNTIME_H +#define INDEXRUNTIME_H + +#include "core/indexcontext.h" +#include "document/contentdocumentbuilder.h" +#include "document/ocrdocumentbuilder.h" +#include "document/filenamedocumentbuilder.h" +#include "fsmonitor/fseventcontroller.h" +#include "extractor/processextractor.h" +#include "profile/indexprofile.h" +#include "state/indexstatestore.h" +#include "task/taskmanager.h" +#include "task/backlogtracker.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class IndexRuntime : public QObject +{ + Q_OBJECT + +public: + explicit IndexRuntime(IndexProfile profile, QObject *parent = nullptr); + + const IndexProfile &profile() const; + const IndexStateStore &stateStore() const; + const IndexContext &context() const; + + TaskManager *taskManager() const; + FSEventController *fsEventController() const; + +private: + const IndexExtractor *selectExtractor() const; + const IndexDocumentBuilder *selectDocumentBuilder() const; + + IndexProfile m_profile; + IndexStateStore m_stateStore; + ProcessExtractor m_processExtractor; + ContentDocumentBuilder m_contentDocumentBuilder; + OcrDocumentBuilder m_ocrDocumentBuilder; + FileNameDocumentBuilder m_fileNameDocumentBuilder; + IndexContext m_context; + std::unique_ptr m_backlogTracker; + TaskManager *m_taskManager { nullptr }; + FSEventController *m_fsEventController { nullptr }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXRUNTIME_H diff --git a/src/index/dbus/filenameindexdbus.cpp b/src/index/dbus/filenameindexdbus.cpp new file mode 100644 index 00000000..4a32566d --- /dev/null +++ b/src/index/dbus/filenameindexdbus.cpp @@ -0,0 +1,341 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "filenameindexdbus.h" +#include "private/filenameindexdbus_p.h" +#include "utils/filetypemapper.h" +#include "utils/indexutility.h" +#include "utils/pinyinprocessor.h" + +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE + +namespace { + +QStringList defaultPathsToProcess() +{ + const auto &configuredDirs = DFMSEARCH::Global::defaultIndexedDirectory(); + if (configuredDirs.isEmpty()) { + return { QDir::homePath() }; + } + + return configuredDirs; +} + +} // namespace + +void FileNameIndexDBusPrivate::initialize() +{ + runtime->fsEventController()->setupFSEventCollector(); + + // 在主线程预热依赖 DConfig / 字典文件的单例：避免首次在 worker 线程构造时 + // 跨线程创建 DConfig（DConfig 内部走 DBus，跨线程亲和性风险）或读字典。 + PinyinProcessor::instance(); + FileTypeMapper::instance(); + + // Mark silently-refresh-started so that the first SetEnabled(true) triggers + // the silent index update path. Previously this was done via a separate + // DBus "Init" method called by the daemon; now it is set at construction + // time because the service process is always started fresh by the daemon. + runtime->fsEventController()->setSilentlyRefreshStarted(true); + + // Check for dirty state at startup and set recovery pending flag + // This must be done before any incremental task can complete and clear the Dirty state + const IndexUtility::IndexState state = runtime->stateStore().getIndexState(); + if (state != IndexUtility::IndexState::Clean) { + qInfo() << "FileNameIndexDBus: Dirty state detected at startup, setting recovery pending flag"; + runtime->taskManager()->setRecoveryPending(true); + } +} + +void FileNameIndexDBusPrivate::initConnect() +{ + QObject::connect(runtime->taskManager(), &TaskManager::taskFinished, + q, [this](const QString &type, const QString &path, bool success) { + emit q->TaskFinished(type, path, success); + }); + + QObject::connect(runtime->taskManager(), &TaskManager::taskProgressChanged, + q, [this](const QString &type, const QString &path, qint64 count, qint64 total) { + emit q->TaskProgressChanged(type, path, count, total); + }); + + QObject::connect(runtime->taskManager(), &TaskManager::indexStatusChanged, + q, [this](const QString &state, const QString &grade) { + emit q->IndexStatusChanged(state, grade); + }); + + QObject::connect(runtime->fsEventController(), &FSEventController::requestProcessFileChanges, + q, &FileNameIndexDBus::ProcessFileChanges); + QObject::connect(runtime->fsEventController(), &FSEventController::requestProcessFileMoves, + q, &FileNameIndexDBus::ProcessFileMoves); + QObject::connect(runtime->fsEventController(), &FSEventController::monitoring, + q, [this](bool start) { + handleMonitoring(start); + }); + QObject::connect(runtime->fsEventController(), &FSEventController::requestSilentStart, + q, [this]() { + handleSilentStart(); + }); + + // Lost-event recovery: schedule a compensating full update when the + // monitor reports dropped filesystem events (dispatcher disconnect / + // event queue overflow). + QObject::connect(runtime->fsEventController(), &FSEventController::requestEventsRecovery, + q, [this]() { + const QStringList pathsToProcess = defaultPathsToProcess(); + if (pathsToProcess.isEmpty()) { + qWarning() << "FileNameIndexDBus: No configured paths available for events recovery"; + return; + } + + if (!q->IndexDatabaseExists()) { + qInfo() << "FileNameIndexDBus: Index database does not exist, starting create task for events recovery:" << pathsToProcess; + runtime->taskManager()->startTask(IndexTask::Type::Create, pathsToProcess); + return; + } + + qInfo() << "FileNameIndexDBus: Starting update task for events recovery:" << pathsToProcess; + // 内部恢复：跳过全库清理（cleanupIndexs），见 UpdateIndexHandler 注释 + runtime->taskManager()->startTask(IndexTask::Type::Update, pathsToProcess, + IndexTask::Grade::None, false, true); + }); + + QObject::connect(IndexUtility::AnythingConfigWatcher::instance(), &IndexUtility::AnythingConfigWatcher::rebuildRequired, + q, [this](const QString &reason) { + qInfo() << "FileNameIndexDBus: ANYTHING config changed, marking rebuild required. reason:" << reason; + runtime->stateStore().setNeedsRebuild(true); + }); + QObject::connect(IndexUtility::DlnfsConfigWatcher::instance(), &IndexUtility::DlnfsConfigWatcher::rebuildRequired, + q, [this](const QString &reason) { + qInfo() << "FileNameIndexDBus: DLNFS config changed, marking rebuild required. reason:" << reason; + runtime->stateStore().setNeedsRebuild(true); + }); +} + +void FileNameIndexDBusPrivate::handleMonitoring(bool start) +{ + qInfo() << "FileNameIndexDBus: FS event monitoring state changed to:" << start; + if (!start) { + runtime->fsEventController()->stopFSMonitoring(); + return; + } + + runtime->fsEventController()->startFSMonitoring(); +} + +void FileNameIndexDBusPrivate::handleSilentStart() +{ + static std::once_flag flag; + std::call_once(flag, [this]() { + const QStringList pathsToProcess = defaultPathsToProcess(); + if (pathsToProcess.isEmpty()) { + qWarning() << "FileNameIndexDBus: No configured paths available for silent refresh"; + return; + } + + if (!canSilentlyRefreshIndex(pathsToProcess.first())) { + qWarning() << "FileNameIndexDBus: Unable to refresh index, task already running for:" << pathsToProcess.first(); + return; + } + + if (!q->IndexDatabaseExists()) { + qInfo() << "FileNameIndexDBus: Index database does not exist, starting create task for:" << pathsToProcess; + runtime->taskManager()->startTask(IndexTask::Type::Create, pathsToProcess); + return; + } + + // Use recoveryPending flag which was set at startup if Dirty state was detected + const bool needsRecovery = runtime->taskManager()->isRecoveryPending(); + const bool needsRebuild = runtime->stateStore().needsRebuild(); + + if (needsRebuild) { + qInfo() << "FileNameIndexDBus: Config changed, clearing needsRebuild flag"; + runtime->stateStore().setNeedsRebuild(false); + } + + if (needsRebuild || needsRecovery) { + qInfo() << "FileNameIndexDBus: Starting update task - needsRebuild:" << needsRebuild + << "needsRecovery:" << needsRecovery << "for:" << pathsToProcess; + // 内部恢复（Dirty/needsRebuild）静默更新：跳过全库清理，见 UpdateIndexHandler 注释 + runtime->taskManager()->startTask(IndexTask::Type::Update, pathsToProcess, + IndexTask::Grade::None, false, true); + return; + } + + qInfo() << "FileNameIndexDBus: Clean state and no config changes, skipping global update"; + }); +} + +bool FileNameIndexDBusPrivate::canSilentlyRefreshIndex(const QString &path) const +{ + if (auto taskTypeOpt = runtime->taskManager()->currentTaskType(); taskTypeOpt.has_value()) { + if (auto taskPathOpt = runtime->taskManager()->currentTaskPath(); taskPathOpt.has_value()) { + const auto &type = *taskTypeOpt; + const auto &taskPath = *taskPathOpt; + + if ((type == IndexTask::Type::Create || type == IndexTask::Type::Update) && (taskPath == path)) { + return false; + } + } + } + + return true; +} + +FileNameIndexDBus::FileNameIndexDBus(QObject *parent) + : QObject(parent), QDBusContext(), d(new FileNameIndexDBusPrivate(this)) +{ + QDBusConnection::RegisterOptions opts = + QDBusConnection::ExportAllSlots | QDBusConnection::ExportAllSignals | QDBusConnection::ExportAllProperties; + QDBusConnection::sessionBus().registerObject(Defines::kFileNameIndexDBusObjectPath, this, opts); +} + +FileNameIndexDBus::~FileNameIndexDBus() { } + +void FileNameIndexDBus::cleanup() +{ + d->runtime->fsEventController()->setEnabledNow(false); + + const bool hasUnfinishedWork = d->runtime->taskManager()->hasRunningTask() + || d->runtime->taskManager()->hasQueuedTasks(); + if (hasUnfinishedWork) { + qWarning() << "FileNameIndexDBus: Service cleanup with unfinished indexing work, marking state as dirty"; + d->runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + } + + StopCurrentTask(); +} + +bool FileNameIndexDBus::IsEnabled() +{ + return d->runtime->fsEventController()->isEnabled(); +} + +void FileNameIndexDBus::SetEnabled(bool enabled) +{ + d->runtime->fsEventController()->setEnabled(enabled); +} + +bool FileNameIndexDBus::CreateIndexTask(const QStringList &paths, const QVariantMap &options) +{ + Q_UNUSED(options) + return d->runtime->taskManager()->startTask(IndexTask::Type::Create, paths); +} + +bool FileNameIndexDBus::UpdateIndexTask(const QStringList &paths, const QVariantMap &options) +{ + Q_UNUSED(options) + return d->runtime->taskManager()->startTask(IndexTask::Type::Update, paths); +} + +bool FileNameIndexDBus::StopCurrentTask() +{ + if (!d->runtime->taskManager()->hasRunningTask()) { + return false; + } + + d->runtime->taskManager()->stopCurrentTask(); + return true; +} + +bool FileNameIndexDBus::HasRunningTask() +{ + return d->runtime->taskManager()->hasRunningTask(); +} + +bool FileNameIndexDBus::IndexDatabaseExists() +{ + if (!d->runtime->profile().isIndexAvailable()) { + return false; + } + + if (!d->runtime->stateStore().isCompatibleVersion()) { + qWarning() << "FileNameIndexDBus: Index database exists but version is incompatible." + << "Current version:" << d->runtime->profile().runtimeIndexVersion() + << "Stored version:" << d->runtime->stateStore().getIndexVersion(); + return false; + } + + if (d->runtime->stateStore().getLastUpdateTime().isEmpty()) { + qWarning() << "FileNameIndexDBus: Last update time is empty, index may be corrupted"; + return false; + } + + return true; +} + +QString FileNameIndexDBus::GetLastUpdateTime() +{ + return d->runtime->stateStore().getLastUpdateTime(); +} + +bool FileNameIndexDBus::ProcessFileChanges(const QStringList &createdFiles, + const QStringList &modifiedFiles, + const QStringList &deletedFiles) +{ + bool tasksQueued = false; + + if (!deletedFiles.isEmpty()) { + qInfo() << "FileNameIndexDBus: Processing" << deletedFiles.size() << "deleted files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::RemoveFileList, deletedFiles) || tasksQueued; + } + + if (!createdFiles.isEmpty()) { + qInfo() << "FileNameIndexDBus: Processing" << createdFiles.size() << "created files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::CreateFileList, createdFiles) || tasksQueued; + } + + if (!modifiedFiles.isEmpty()) { + qInfo() << "FileNameIndexDBus: Processing" << modifiedFiles.size() << "modified files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::UpdateFileList, modifiedFiles) || tasksQueued; + } + + return tasksQueued; +} + +bool FileNameIndexDBus::ProcessFileMoves(const QHash &movedFiles) +{ + if (movedFiles.isEmpty()) { + qDebug() << "FileNameIndexDBus: No file moves to process"; + return false; + } + + qInfo() << "FileNameIndexDBus: Processing" << movedFiles.size() << "moved files"; + return d->runtime->taskManager()->startFileMoveTask(movedFiles); +} + +QVariantMap FileNameIndexDBus::GetIndexStatus() +{ + QVariantMap status; + auto *tm = d->runtime->taskManager(); + + // Always delegate to TaskManager::currentIndexStatus() so the client + // receives the specific waiting state (WaitingPower / WaitingPowerSave / + // WaitingIdle / WaitingUpgrade / Failed / Running / Idle) rather than + // the generic "Blocked"/"Idle" that bypasses environment checks. + status["state"] = tm->currentIndexStatus(); + auto grade = tm->currentOrQueuedGrade(); + status["grade"] = grade.has_value() ? TaskManager::gradeToString(*grade) : QStringLiteral("none"); + + return status; +} + +bool FileNameIndexDBus::ForceUpdateIndex(const QStringList &paths, const QVariantMap &options) +{ + const bool manual = options.value("manual", true).toBool(); + qInfo() << "FileNameIndexDBus: Force update index requested for" << paths.size() << "paths" + << "manual:" << manual; + + bool exists = IndexDatabaseExists(); + auto type = exists ? IndexTask::Type::Update : IndexTask::Type::Create; + + if (manual) { + return d->runtime->taskManager()->startTask(type, paths, IndexTask::Grade::Manual, true); + } + return d->runtime->taskManager()->startTask(type, paths, IndexTask::Grade::None, true); +} diff --git a/src/index/dbus/filenameindexdbus.h b/src/index/dbus/filenameindexdbus.h new file mode 100644 index 00000000..f5befeeb --- /dev/null +++ b/src/index/dbus/filenameindexdbus.h @@ -0,0 +1,54 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FILENAMEINDEXDBUS_H +#define FILENAMEINDEXDBUS_H + +#include "index_global.h" + +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE +class FileNameIndexDBusPrivate; +ANYTHING_INDEX_END_NAMESPACE + +class FileNameIndexDBus : public QObject, public QDBusContext +{ + Q_OBJECT + Q_CLASSINFO("D-Bus Interface", "org.deepin.Filemanager.FileNameIndex") + +public: + explicit FileNameIndexDBus(QObject *parent = nullptr); + ~FileNameIndexDBus(); + + void cleanup(); + +public Q_SLOTS: + bool IsEnabled(); + void SetEnabled(bool enabled); + bool CreateIndexTask(const QStringList &paths, const QVariantMap &options = QVariantMap()); + bool UpdateIndexTask(const QStringList &paths, const QVariantMap &options = QVariantMap()); + bool StopCurrentTask(); + bool HasRunningTask(); + bool IndexDatabaseExists(); + QString GetLastUpdateTime(); + bool ProcessFileChanges(const QStringList &createdFiles, const QStringList &modifiedFiles, const QStringList &deletedFiles); + bool ProcessFileMoves(const QHash &movedFiles); + QVariantMap GetIndexStatus(); + bool ForceUpdateIndex(const QStringList &paths, const QVariantMap &options = QVariantMap()); + +Q_SIGNALS: + void TaskFinished(const QString &type, const QString &path, bool success); + void TaskProgressChanged(const QString &type, const QString &path, qint64 count, qint64 total); + void IndexStatusChanged(const QString &state, const QString &grade); + +private: + QScopedPointer d; +}; + +#endif // FILENAMEINDEXDBUS_H diff --git a/src/index/dbus/ocrindexdbus.cpp b/src/index/dbus/ocrindexdbus.cpp new file mode 100644 index 00000000..a99bac8f --- /dev/null +++ b/src/index/dbus/ocrindexdbus.cpp @@ -0,0 +1,352 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "ocrindexdbus.h" +#include "private/ocrindexdbus_p.h" +#include "utils/indexutility.h" +#include "utils/textindexconfig.h" + +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE + +namespace { + +QStringList defaultPathsToProcess() +{ + const auto &configuredDirs = DFMSEARCH::Global::defaultIndexedDirectory(); + if (configuredDirs.isEmpty()) { + return { QDir::homePath() }; + } + + return configuredDirs; +} + +} // namespace + +void OcrIndexDBusPrivate::initialize() +{ + runtime->fsEventController()->setupFSEventCollector(); + + // Mark silently-refresh-started so that the first SetEnabled(true) triggers + // the silent index update path. Previously this was done via a separate + // DBus "Init" method called by the daemon; now it is set at construction + // time because the service process is always started fresh by the daemon. + runtime->fsEventController()->setSilentlyRefreshStarted(true); + + initializeSupportedExtensions(); + + // Check for dirty state at startup and set recovery pending flag + // This must be done before any incremental task can complete and clear the Dirty state + const IndexUtility::IndexState state = runtime->stateStore().getIndexState(); + if (state != IndexUtility::IndexState::Clean) { + qInfo() << "OcrIndexDBus: Dirty state detected at startup, setting recovery pending flag"; + runtime->taskManager()->setRecoveryPending(true); + } +} + +void OcrIndexDBusPrivate::initConnect() +{ + QObject::connect(runtime->taskManager(), &TaskManager::taskFinished, + q, [this](const QString &type, const QString &path, bool success) { + emit q->TaskFinished(type, path, success); + }); + + QObject::connect(runtime->taskManager(), &TaskManager::taskProgressChanged, + q, [this](const QString &type, const QString &path, qint64 count, qint64 total) { + emit q->TaskProgressChanged(type, path, count, total); + }); + + QObject::connect(runtime->taskManager(), &TaskManager::indexStatusChanged, + q, [this](const QString &state, const QString &grade) { + emit q->IndexStatusChanged(state, grade); + }); + + QObject::connect(runtime->fsEventController(), &FSEventController::requestProcessFileChanges, + q, &OcrIndexDBus::ProcessFileChanges); + QObject::connect(runtime->fsEventController(), &FSEventController::requestProcessFileMoves, + q, &OcrIndexDBus::ProcessFileMoves); + QObject::connect(runtime->fsEventController(), &FSEventController::monitoring, + q, [this](bool start) { + handleMonitoring(start); + }); + QObject::connect(runtime->fsEventController(), &FSEventController::requestSilentStart, + q, [this]() { + handleSilentStart(); + }); + + // 丢事件（dispatcher 断连/事件队列溢出）时不做补偿更新：OCR 全量重建 + // 代价过高，监控重连后继续监听增量事件即可。补偿语义仅由 + // FileNameIndexDBus 承担（见其 requestEventsRecovery 连接）。 + + QObject::connect(&TextIndexConfig::instance(), &TextIndexConfig::configChanged, + q, [this]() { + handleConfigChanged(); + }); + QObject::connect(IndexUtility::AnythingConfigWatcher::instance(), &IndexUtility::AnythingConfigWatcher::rebuildRequired, + q, [this](const QString &reason) { + qInfo() << "OcrIndexDBus: ANYTHING config changed, marking rebuild required. reason:" << reason; + runtime->stateStore().setNeedsRebuild(true); + }); + QObject::connect(IndexUtility::DlnfsConfigWatcher::instance(), &IndexUtility::DlnfsConfigWatcher::rebuildRequired, + q, [this](const QString &reason) { + qInfo() << "OcrIndexDBus: DLNFS config changed, marking rebuild required. reason:" << reason; + runtime->stateStore().setNeedsRebuild(true); + }); +} + +void OcrIndexDBusPrivate::handleMonitoring(bool start) +{ + qInfo() << "OcrIndexDBus: FS event monitoring state changed to:" << start; + if (!start) { + runtime->fsEventController()->stopFSMonitoring(); + return; + } + + runtime->fsEventController()->startFSMonitoring(); +} + +void OcrIndexDBusPrivate::handleSilentStart() +{ + static std::once_flag flag; + std::call_once(flag, [this]() { + const QStringList pathsToProcess = defaultPathsToProcess(); + if (pathsToProcess.isEmpty()) { + qWarning() << "OcrIndexDBus: No configured paths available for silent refresh"; + return; + } + + if (!canSilentlyRefreshIndex(pathsToProcess.first())) { + qWarning() << "OcrIndexDBus: Unable to refresh index, task already running for:" << pathsToProcess.first(); + return; + } + + if (!q->IndexDatabaseExists()) { + qInfo() << "OcrIndexDBus: Index database does not exist, starting create task for:" << pathsToProcess; + runtime->taskManager()->startTask(IndexTask::Type::Create, pathsToProcess); + return; + } + + // Use recoveryPending flag which was set at startup if Dirty state was detected + const bool needsRecovery = runtime->taskManager()->isRecoveryPending(); + const bool needsRebuild = runtime->stateStore().needsRebuild(); + + if (needsRebuild) { + qInfo() << "OcrIndexDBus: Config changed, clearing needsRebuild flag"; + runtime->stateStore().setNeedsRebuild(false); + } + + if (needsRebuild || needsRecovery) { + qInfo() << "OcrIndexDBus: Starting update task - needsRebuild:" << needsRebuild + << "needsRecovery:" << needsRecovery << "for:" << pathsToProcess; + // 内部恢复（Dirty/needsRebuild）静默更新：跳过全库清理，见 UpdateIndexHandler 注释 + runtime->taskManager()->startTask(IndexTask::Type::Update, pathsToProcess, + IndexTask::Grade::None, false, true); + return; + } + + qInfo() << "OcrIndexDBus: Clean state and no config changes, skipping global update"; + }); +} + +bool OcrIndexDBusPrivate::canSilentlyRefreshIndex(const QString &path) const +{ + if (auto taskTypeOpt = runtime->taskManager()->currentTaskType(); taskTypeOpt.has_value()) { + if (auto taskPathOpt = runtime->taskManager()->currentTaskPath(); taskPathOpt.has_value()) { + const auto &type = *taskTypeOpt; + const auto &taskPath = *taskPathOpt; + + if ((type == IndexTask::Type::Create || type == IndexTask::Type::Update) && (taskPath == path)) { + return false; + } + } + } + + return true; +} + +OcrIndexDBus::OcrIndexDBus(QObject *parent) + : QObject(parent), QDBusContext(), d(new OcrIndexDBusPrivate(this)) +{ + QDBusConnection::RegisterOptions opts = + QDBusConnection::ExportAllSlots | QDBusConnection::ExportAllSignals | QDBusConnection::ExportAllProperties; + QDBusConnection::sessionBus().registerObject(Defines::kOcrIndexDBusObjectPath, this, opts); +} + +OcrIndexDBus::~OcrIndexDBus() { } + +void OcrIndexDBus::cleanup() +{ + d->runtime->fsEventController()->setEnabledNow(false); + + const bool hasUnfinishedWork = d->runtime->taskManager()->hasRunningTask() + || d->runtime->taskManager()->hasQueuedTasks(); + if (hasUnfinishedWork) { + qWarning() << "OcrIndexDBus: Service cleanup with unfinished indexing work, marking state as dirty"; + d->runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + } + + StopCurrentTask(); +} + +bool OcrIndexDBus::IsEnabled() +{ + return d->runtime->fsEventController()->isEnabled(); +} + +void OcrIndexDBus::SetEnabled(bool enabled) +{ + d->runtime->fsEventController()->setEnabled(enabled); +} + +bool OcrIndexDBus::CreateIndexTask(const QStringList &paths, const QVariantMap &options) +{ + Q_UNUSED(options) + return d->runtime->taskManager()->startTask(IndexTask::Type::Create, paths); +} + +bool OcrIndexDBus::UpdateIndexTask(const QStringList &paths, const QVariantMap &options) +{ + Q_UNUSED(options) + return d->runtime->taskManager()->startTask(IndexTask::Type::Update, paths); +} + +bool OcrIndexDBus::StopCurrentTask() +{ + if (!d->runtime->taskManager()->hasRunningTask()) { + return false; + } + + d->runtime->taskManager()->stopCurrentTask(); + return true; +} + +bool OcrIndexDBus::HasRunningTask() +{ + return d->runtime->taskManager()->hasRunningTask(); +} + +bool OcrIndexDBus::IndexDatabaseExists() +{ + if (!d->runtime->profile().isIndexAvailable()) { + return false; + } + + if (!d->runtime->stateStore().isCompatibleVersion()) { + qWarning() << "OcrIndexDBus: Index database exists but version is incompatible." + << "Current version:" << d->runtime->profile().runtimeIndexVersion() + << "Stored version:" << d->runtime->stateStore().getIndexVersion(); + return false; + } + + if (d->runtime->stateStore().getLastUpdateTime().isEmpty()) { + qWarning() << "OcrIndexDBus: Last update time is empty, index may be corrupted"; + return false; + } + + return true; +} + +QString OcrIndexDBus::GetLastUpdateTime() +{ + return d->runtime->stateStore().getLastUpdateTime(); +} + +bool OcrIndexDBus::ProcessFileChanges(const QStringList &createdFiles, + const QStringList &modifiedFiles, + const QStringList &deletedFiles) +{ + bool tasksQueued = false; + + if (!deletedFiles.isEmpty()) { + qInfo() << "OcrIndexDBus: Processing" << deletedFiles.size() << "deleted files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::RemoveFileList, deletedFiles) || tasksQueued; + } + + if (!createdFiles.isEmpty()) { + qInfo() << "OcrIndexDBus: Processing" << createdFiles.size() << "created files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::CreateFileList, createdFiles) || tasksQueued; + } + + if (!modifiedFiles.isEmpty()) { + qInfo() << "OcrIndexDBus: Processing" << modifiedFiles.size() << "modified files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::UpdateFileList, modifiedFiles) || tasksQueued; + } + + return tasksQueued; +} + +bool OcrIndexDBus::ProcessFileMoves(const QHash &movedFiles) +{ + if (movedFiles.isEmpty()) { + qDebug() << "OcrIndexDBus: No file moves to process"; + return false; + } + + qInfo() << "OcrIndexDBus: Processing" << movedFiles.size() << "moved files"; + return d->runtime->taskManager()->startFileMoveTask(movedFiles); +} + +QVariantMap OcrIndexDBus::GetIndexStatus() +{ + QVariantMap status; + auto *tm = d->runtime->taskManager(); + + // Always delegate to TaskManager::currentIndexStatus() so the client + // receives the specific waiting state (WaitingPower / WaitingPowerSave / + // WaitingIdle / WaitingUpgrade / Failed / Running / Idle) rather than + // the generic "Blocked"/"Idle" that bypasses environment checks. + status["state"] = tm->currentIndexStatus(); + auto grade = tm->currentOrQueuedGrade(); + status["grade"] = grade.has_value() ? TaskManager::gradeToString(*grade) : QStringLiteral("none"); + + return status; +} + +bool OcrIndexDBus::ForceUpdateIndex(const QStringList &paths, const QVariantMap &options) +{ + const bool manual = options.value("manual", true).toBool(); + qInfo() << "OcrIndexDBus: Force update index requested for" << paths.size() << "paths" + << "manual:" << manual; + + bool exists = IndexDatabaseExists(); + auto type = exists ? IndexTask::Type::Update : IndexTask::Type::Create; + + if (manual) { + return d->runtime->taskManager()->startTask(type, paths, IndexTask::Grade::Manual, true); + } + return d->runtime->taskManager()->startTask(type, paths, IndexTask::Grade::None, true); +} + +void OcrIndexDBusPrivate::initializeSupportedExtensions() +{ + m_currentSupportedExtensions = TextIndexConfig::instance().supportedOcrImageExtensions(); + qInfo() << "OcrIndexDBus: Initialized supported OCR image extensions (" << m_currentSupportedExtensions.size() << "):" + << m_currentSupportedExtensions; +} + +void OcrIndexDBusPrivate::handleConfigChanged() +{ + const auto newSupportedExtensions = TextIndexConfig::instance().supportedOcrImageExtensions(); + const QSet currentExtensionsSet(m_currentSupportedExtensions.begin(), m_currentSupportedExtensions.end()); + const QSet newExtensionsSet(newSupportedExtensions.begin(), newSupportedExtensions.end()); + + if (currentExtensionsSet != newExtensionsSet) { + qInfo() << "OcrIndexDBus: Supported OCR image extensions changed from" << m_currentSupportedExtensions.size() + << "to" << newSupportedExtensions.size() << "extensions"; + m_currentSupportedExtensions = newSupportedExtensions; + + const QStringList pathsToProcess = defaultPathsToProcess(); + if (q->IndexDatabaseExists()) { + qInfo() << "OcrIndexDBus: Starting index update task due to supported OCR image extensions change for paths:" << pathsToProcess; + // 内部配置变更更新：跳过全库清理，见 UpdateIndexHandler 注释 + runtime->taskManager()->startTask(IndexTask::Type::Update, pathsToProcess, + IndexTask::Grade::None, false, true); + } else { + qWarning() << "OcrIndexDBus: Cannot start index update task, index database does not exist"; + } + } +} diff --git a/src/index/dbus/ocrindexdbus.h b/src/index/dbus/ocrindexdbus.h new file mode 100644 index 00000000..291e9a8c --- /dev/null +++ b/src/index/dbus/ocrindexdbus.h @@ -0,0 +1,54 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef OCRINDEXDBUS_H +#define OCRINDEXDBUS_H + +#include "index_global.h" + +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE +class OcrIndexDBusPrivate; +ANYTHING_INDEX_END_NAMESPACE + +class OcrIndexDBus : public QObject, public QDBusContext +{ + Q_OBJECT + Q_CLASSINFO("D-Bus Interface", "org.deepin.Filemanager.OcrIndex") + +public: + explicit OcrIndexDBus(QObject *parent = nullptr); + ~OcrIndexDBus(); + + void cleanup(); + +public Q_SLOTS: + bool IsEnabled(); + void SetEnabled(bool enabled); + bool CreateIndexTask(const QStringList &paths, const QVariantMap &options = QVariantMap()); + bool UpdateIndexTask(const QStringList &paths, const QVariantMap &options = QVariantMap()); + bool StopCurrentTask(); + bool HasRunningTask(); + bool IndexDatabaseExists(); + QString GetLastUpdateTime(); + bool ProcessFileChanges(const QStringList &createdFiles, const QStringList &modifiedFiles, const QStringList &deletedFiles); + bool ProcessFileMoves(const QHash &movedFiles); + QVariantMap GetIndexStatus(); + bool ForceUpdateIndex(const QStringList &paths, const QVariantMap &options = QVariantMap()); + +Q_SIGNALS: + void TaskFinished(const QString &type, const QString &path, bool success); + void TaskProgressChanged(const QString &type, const QString &path, qint64 count, qint64 total); + void IndexStatusChanged(const QString &state, const QString &grade); + +private: + QScopedPointer d; +}; + +#endif // OCRINDEXDBUS_H diff --git a/src/index/dbus/private/filenameindexdbus_p.h b/src/index/dbus/private/filenameindexdbus_p.h new file mode 100644 index 00000000..e5d33c42 --- /dev/null +++ b/src/index/dbus/private/filenameindexdbus_p.h @@ -0,0 +1,46 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FILENAMEINDEXDBUS_P_H +#define FILENAMEINDEXDBUS_P_H + +#include "index_global.h" +#include "core/indexruntime.h" +#include "filenameindexadaptor.h" + +class FileNameIndexDBus; + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FileNameIndexDBusPrivate +{ + friend class ::FileNameIndexDBus; + +public: + explicit FileNameIndexDBusPrivate(FileNameIndexDBus *qq) + : q(qq), + adapter(new FileNameIndexAdaptor(qq)), + runtime(new IndexRuntime(IndexProfile::filename(), qq)) + { + initialize(); + initConnect(); + } + + ~FileNameIndexDBusPrivate() { } + + void initialize(); + void initConnect(); + void handleMonitoring(bool start); + void handleSilentStart(); + bool canSilentlyRefreshIndex(const QString &path) const; + +private: + FileNameIndexDBus *q { nullptr }; + FileNameIndexAdaptor *adapter { nullptr }; + IndexRuntime *runtime { nullptr }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FILENAMEINDEXDBUS_P_H diff --git a/src/index/dbus/private/ocrindexdbus_p.h b/src/index/dbus/private/ocrindexdbus_p.h new file mode 100644 index 00000000..da806112 --- /dev/null +++ b/src/index/dbus/private/ocrindexdbus_p.h @@ -0,0 +1,51 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef OCRINDEXDBUS_P_H +#define OCRINDEXDBUS_P_H + +#include "index_global.h" +#include "core/indexruntime.h" +#include "ocrindexadaptor.h" + +class OcrIndexDBus; + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class OcrIndexDBusPrivate +{ + friend class ::OcrIndexDBus; + +public: + explicit OcrIndexDBusPrivate(OcrIndexDBus *qq) + : q(qq), + adapter(new OcrIndexAdaptor(qq)), + runtime(new IndexRuntime(IndexProfile::ocr(), qq)) + { + initialize(); + initConnect(); + } + + ~OcrIndexDBusPrivate() { } + + void initialize(); + void initConnect(); + void handleMonitoring(bool start); + void handleSilentStart(); + bool canSilentlyRefreshIndex(const QString &path) const; + +private: + void handleConfigChanged(); + void initializeSupportedExtensions(); + +private: + OcrIndexDBus *q { nullptr }; + OcrIndexAdaptor *adapter { nullptr }; + IndexRuntime *runtime { nullptr }; + QStringList m_currentSupportedExtensions; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // OCRINDEXDBUS_P_H diff --git a/src/index/dbus/private/textindexdbus_p.h b/src/index/dbus/private/textindexdbus_p.h new file mode 100644 index 00000000..2c688d67 --- /dev/null +++ b/src/index/dbus/private/textindexdbus_p.h @@ -0,0 +1,60 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TEXTINDEXDBUS_P_H +#define TEXTINDEXDBUS_P_H + +#include "index_global.h" +#include "core/indexruntime.h" +#include "textindexadaptor.h" + +#include +#include +#include +#include +#include + +#include + +class TextIndexDBus; + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class TextIndexDBusPrivate +{ + friend class ::TextIndexDBus; + +public: + explicit TextIndexDBusPrivate(TextIndexDBus *qq) + : q(qq), + adapter(new TextIndexAdaptor(qq)), + runtime(new IndexRuntime(IndexProfile::content(), qq)) + { + initialize(); + initConnect(); + } + ~TextIndexDBusPrivate() { } + + void initialize(); + void initConnect(); + void handleMonitoring(bool start); + void handleSilentStart(); + bool canSilentlyRefreshIndex(const QString &path) const; + +private: + void handleConfigChanged(); + void initializeSupportedExtensions(); + +private: + TextIndexDBus *q { nullptr }; + TextIndexAdaptor *adapter { nullptr }; + IndexRuntime *runtime { nullptr }; + + // Store current supported file extensions for comparison + QStringList m_currentSupportedExtensions; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // TEXTINDEXDBUS_P_H diff --git a/src/index/dbus/textindexdbus.cpp b/src/index/dbus/textindexdbus.cpp new file mode 100644 index 00000000..70c755d3 --- /dev/null +++ b/src/index/dbus/textindexdbus.cpp @@ -0,0 +1,377 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "textindexdbus.h" +#include "private/textindexdbus_p.h" +#include "utils/indexutility.h" +#include "utils/textindexconfig.h" + +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE +using namespace Lucene; + +void TextIndexDBusPrivate::initialize() +{ + runtime->fsEventController()->setupFSEventCollector(); + + // Mark silently-refresh-started so that the first SetEnabled(true) triggers + // the silent index update path. Previously this was done via a separate + // DBus "Init" method called by the daemon; now it is set at construction + // time because the service process is always started fresh by the daemon. + runtime->fsEventController()->setSilentlyRefreshStarted(true); + + initializeSupportedExtensions(); + + // Check for dirty state at startup and set recovery pending flag + // This must be done before any incremental task can complete and clear the Dirty state + const IndexUtility::IndexState state = runtime->stateStore().getIndexState(); + if (state != IndexUtility::IndexState::Clean) { + qInfo() << "TextIndexDBus: Dirty state detected at startup, setting recovery pending flag"; + runtime->taskManager()->setRecoveryPending(true); + } +} + +void TextIndexDBusPrivate::initConnect() +{ + QObject::connect(runtime->taskManager(), &TaskManager::taskFinished, + q, [this](const QString &type, const QString &path, bool success) { + emit q->TaskFinished(type, path, success); + }); + + QObject::connect(runtime->taskManager(), &TaskManager::taskProgressChanged, + q, [this](const QString &type, const QString &path, qint64 count, qint64 total) { + emit q->TaskProgressChanged(type, path, count, total); + }); + + QObject::connect(runtime->taskManager(), &TaskManager::indexStatusChanged, + q, [this](const QString &state, const QString &grade) { + emit q->IndexStatusChanged(state, grade); + }); + + QObject::connect(runtime->fsEventController(), &FSEventController::requestProcessFileChanges, + q, &TextIndexDBus::ProcessFileChanges); + QObject::connect(runtime->fsEventController(), &FSEventController::requestProcessFileMoves, + q, &TextIndexDBus::ProcessFileMoves); + QObject::connect(runtime->fsEventController(), &FSEventController::monitoring, + q, [this](bool start) { + handleMonitoring(start); + }); + QObject::connect(runtime->fsEventController(), &FSEventController::requestSilentStart, + q, [this]() { + handleSilentStart(); + }); + + // 丢事件（dispatcher 断连/事件队列溢出）时不做补偿更新：content 全量 + // UPDATE 代价过高，索引误差留给监控恢复后的增量事件与既有对账机制收敛。 + // 补偿语义仅由 FileNameIndexDBus 承担（见其 requestEventsRecovery 连接）。 + + // Connect to TextIndexConfig changes + QObject::connect(&TextIndexConfig::instance(), &TextIndexConfig::configChanged, + q, [this]() { + handleConfigChanged(); + }); + QObject::connect(IndexUtility::AnythingConfigWatcher::instance(), &IndexUtility::AnythingConfigWatcher::rebuildRequired, + q, [this](const QString &reason) { + qInfo() << "TextIndexDBus: ANYTHING config changed, marking rebuild required. reason:" << reason; + runtime->stateStore().setNeedsRebuild(true); + }); + QObject::connect(IndexUtility::DlnfsConfigWatcher::instance(), &IndexUtility::DlnfsConfigWatcher::rebuildRequired, + q, [this](const QString &reason) { + qInfo() << "TextIndexDBus: DLNFS config changed, marking rebuild required. reason:" << reason; + runtime->stateStore().setNeedsRebuild(true); + }); +} + +void TextIndexDBusPrivate::handleMonitoring(bool start) +{ + qInfo() << "TextIndexDBus: FS event monitoring state changed to:" << start; + if (!start) { + runtime->fsEventController()->stopFSMonitoring(); + return; + } + + runtime->fsEventController()->startFSMonitoring(); +} + +void TextIndexDBusPrivate::handleSilentStart() +{ + // NOTE: Used only for silent updates after the service is started for the first time! + static std::once_flag flag; + std::call_once(flag, [this]() { + // Create or update indexes silently + const auto &configuredDirs = DFMSEARCH::Global::defaultIndexedDirectory(); + QStringList pathsToProcess; + + if (configuredDirs.isEmpty()) { + pathsToProcess.append(QDir::homePath()); + } else { + pathsToProcess = configuredDirs; // Assuming configuredDirs is a QStringList or compatible + } + + if (!canSilentlyRefreshIndex(pathsToProcess.first())) { + qWarning() << "TextIndexDBus: Unable to refresh index, task already running for:" << pathsToProcess.first(); + return; + } + + // 1. 首先检查索引数据库是否存在 + if (!q->IndexDatabaseExists()) { + qInfo() << "TextIndexDBus: Index database does not exist, starting create task for:" << pathsToProcess; + runtime->taskManager()->startTask(IndexTask::Type::Create, pathsToProcess); + return; + } + + // 2. 检查是否需要更新 + // Use recoveryPending flag which was set at startup if Dirty state was detected + const bool needsRecovery = runtime->taskManager()->isRecoveryPending(); + const bool needsRebuild = runtime->stateStore().needsRebuild(); + + // 如果配置变化，立即清除标记（因为即将开始更新） + if (needsRebuild) { + qInfo() << "TextIndexDBus: Config changed, clearing needsRebuild flag"; + runtime->stateStore().setNeedsRebuild(false); + } + + // 只要任一条件为真，就启动 Update + if (needsRebuild || needsRecovery) { + qInfo() << "TextIndexDBus: Starting update task - needsRebuild:" << needsRebuild + << "needsRecovery:" << needsRecovery << "for:" << pathsToProcess; + // 内部恢复（Dirty/needsRebuild）静默更新：跳过全库清理，见 UpdateIndexHandler 注释 + runtime->taskManager()->startTask(IndexTask::Type::Update, pathsToProcess, + IndexTask::Grade::None, false, true); + return; + } + + // 3. Clean 状态且无需重建，跳过更新 + qInfo() << "TextIndexDBus: Clean state and no config changes, skipping global update"; + }); +} + +bool TextIndexDBusPrivate::canSilentlyRefreshIndex(const QString &path) const +{ + if (auto taskTypeOpt = runtime->taskManager()->currentTaskType(); taskTypeOpt.has_value()) { + if (auto taskPathOpt = runtime->taskManager()->currentTaskPath(); taskPathOpt.has_value()) { + const auto &type = *taskTypeOpt; + const auto &taskPath = *taskPathOpt; + + if ((type == IndexTask::Type::Create || type == IndexTask::Type::Update) && (taskPath == path)) { + return false; + } + } + } + + return true; +} + +TextIndexDBus::TextIndexDBus(QObject *parent) + : QObject(parent), QDBusContext(), d(new TextIndexDBusPrivate(this)) +{ + QDBusConnection::RegisterOptions opts = + QDBusConnection::ExportAllSlots | QDBusConnection::ExportAllSignals | QDBusConnection::ExportAllProperties; + + QDBusConnection::sessionBus().registerObject(Defines::kTextIndexDBusObjectPath, this, opts); +} + +TextIndexDBus::~TextIndexDBus() { } + +void TextIndexDBus::cleanup() +{ + d->runtime->fsEventController()->setEnabledNow(false); + + // Check if there are unfinished tasks before stopping + bool hasUnfinishedWork = d->runtime->taskManager()->hasRunningTask() + || d->runtime->taskManager()->hasQueuedTasks(); + + if (hasUnfinishedWork) { + qWarning() << "TextIndexDBus: Service cleanup with unfinished indexing work, marking state as dirty"; + d->runtime->stateStore().setIndexState(IndexUtility::IndexState::Dirty); + } + + StopCurrentTask(); +} + +bool TextIndexDBus::IsEnabled() +{ + return d->runtime->fsEventController()->isEnabled(); +} + +void TextIndexDBus::SetEnabled(bool enabled) +{ + d->runtime->fsEventController()->setEnabled(enabled); +} + +bool TextIndexDBus::CreateIndexTask(const QStringList &paths, const QVariantMap &options) +{ + Q_UNUSED(options) + return d->runtime->taskManager()->startTask(IndexTask::Type::Create, paths); +} + +bool TextIndexDBus::UpdateIndexTask(const QStringList &paths, const QVariantMap &options) +{ + Q_UNUSED(options) + return d->runtime->taskManager()->startTask(IndexTask::Type::Update, paths); +} + +bool TextIndexDBus::StopCurrentTask() +{ + if (!d->runtime->taskManager()->hasRunningTask()) + return false; + + d->runtime->taskManager()->stopCurrentTask(); + return true; +} + +bool TextIndexDBus::HasRunningTask() +{ + return d->runtime->taskManager()->hasRunningTask(); +} + +bool TextIndexDBus::IndexDatabaseExists() +{ + // First check if the index files exist + if (!d->runtime->profile().isIndexAvailable()) { + return false; + } + + // Then check if the version is compatible + if (!d->runtime->stateStore().isCompatibleVersion()) { + qWarning() << "TextIndexDBus: Index database exists but version is incompatible." + << "Current version:" << d->runtime->profile().runtimeIndexVersion() + << "Stored version:" << d->runtime->stateStore().getIndexVersion() + << "Index considered invalid due to version mismatch"; + return false; + } + + if (d->runtime->stateStore().getLastUpdateTime().isEmpty()) { + qWarning() << "TextIndexDBus: Last update time is empty, index may be corrupted"; + return false; + } + + return true; +} + +QString TextIndexDBus::GetLastUpdateTime() +{ + return d->runtime->stateStore().getLastUpdateTime(); +} + +bool TextIndexDBus::ProcessFileChanges(const QStringList &createdFiles, + const QStringList &modifiedFiles, + const QStringList &deletedFiles) +{ + bool tasksQueued = false; + + // 处理删除的文件（优先处理，因为这些文件可能已经不存在） + if (!deletedFiles.isEmpty()) { + qInfo() << "TextIndexDBus: Processing" << deletedFiles.size() << "deleted files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::RemoveFileList, deletedFiles) || tasksQueued; + } + + // 处理新增的文件 + if (!createdFiles.isEmpty()) { + qInfo() << "TextIndexDBus: Processing" << createdFiles.size() << "created files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::CreateFileList, createdFiles) || tasksQueued; + } + + // 处理修改的文件 + if (!modifiedFiles.isEmpty()) { + qInfo() << "TextIndexDBus: Processing" << modifiedFiles.size() << "modified files"; + tasksQueued = d->runtime->taskManager()->startFileListTask(IndexTask::Type::UpdateFileList, modifiedFiles) || tasksQueued; + } + + return tasksQueued; +} + +bool TextIndexDBus::ProcessFileMoves(const QHash &movedFiles) +{ + if (movedFiles.isEmpty()) { + qDebug() << "TextIndexDBus: No file moves to process"; + return false; + } + + qInfo() << "TextIndexDBus: Processing" << movedFiles.size() << "moved files"; + + // 启动文件移动任务 + bool taskQueued = d->runtime->taskManager()->startFileMoveTask(movedFiles); + + return taskQueued; +} + +QVariantMap TextIndexDBus::GetIndexStatus() +{ + QVariantMap status; + auto *tm = d->runtime->taskManager(); + + // Always delegate to TaskManager::currentIndexStatus() so the client + // receives the specific waiting state (WaitingPower / WaitingPowerSave / + // WaitingIdle / WaitingUpgrade / Failed / Running / Idle) rather than + // the generic "Blocked"/"Idle" that bypasses environment checks. + status["state"] = tm->currentIndexStatus(); + auto grade = tm->currentOrQueuedGrade(); + status["grade"] = grade.has_value() ? TaskManager::gradeToString(*grade) : QStringLiteral("none"); + + return status; +} + +bool TextIndexDBus::ForceUpdateIndex(const QStringList &paths, const QVariantMap &options) +{ + const bool manual = options.value("manual", true).toBool(); + qInfo() << "TextIndexDBus: Force update index requested for" << paths.size() << "paths" + << "manual:" << manual; + + bool exists = IndexDatabaseExists(); + auto type = exists ? IndexTask::Type::Update : IndexTask::Type::Create; + + if (manual) { + return d->runtime->taskManager()->startTask(type, paths, IndexTask::Grade::Manual, true); + } + return d->runtime->taskManager()->startTask(type, paths, IndexTask::Grade::None, true); +} + +void TextIndexDBusPrivate::initializeSupportedExtensions() +{ + m_currentSupportedExtensions = TextIndexConfig::instance().supportedTextFileExtensions(); + qInfo() << "TextIndexDBus: Initialized supported file extensions (" << m_currentSupportedExtensions.size() << "):" + << m_currentSupportedExtensions; +} + +void TextIndexDBusPrivate::handleConfigChanged() +{ + const auto newSupportedExtensions = TextIndexConfig::instance().supportedTextFileExtensions(); + + // Convert to sets for order-insensitive comparison + const QSet currentExtensionsSet(m_currentSupportedExtensions.begin(), m_currentSupportedExtensions.end()); + const QSet newExtensionsSet(newSupportedExtensions.begin(), newSupportedExtensions.end()); + + // Check if supported file extensions have changed (order-insensitive) + if (currentExtensionsSet != newExtensionsSet) { + qInfo() << "TextIndexDBus: Supported file extensions changed from" << m_currentSupportedExtensions.size() + << "to" << newSupportedExtensions.size() << "extensions"; + + // Update stored extensions + m_currentSupportedExtensions = newSupportedExtensions; + + // Trigger index update for configured directories + const auto &configuredDirs = DFMSEARCH::Global::defaultIndexedDirectory(); + QStringList pathsToProcess; + + if (configuredDirs.isEmpty()) { + pathsToProcess.append(QDir::homePath()); + } else { + pathsToProcess = configuredDirs; + } + + // Only start update task if index database exists + if (q->IndexDatabaseExists()) { + qInfo() << "TextIndexDBus: Starting index update task due to supported file extensions change for paths:" << pathsToProcess; + // 内部配置变更更新：跳过全库清理，见 UpdateIndexHandler 注释 + runtime->taskManager()->startTask(IndexTask::Type::Update, pathsToProcess, + IndexTask::Grade::None, false, true); + } else { + qWarning() << "TextIndexDBus: Cannot start index update task, index database does not exist"; + } + } +} diff --git a/src/index/dbus/textindexdbus.h b/src/index/dbus/textindexdbus.h new file mode 100644 index 00000000..f9950f95 --- /dev/null +++ b/src/index/dbus/textindexdbus.h @@ -0,0 +1,54 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TEXTINDEXDBUS_H +#define TEXTINDEXDBUS_H + +#include "index_global.h" + +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE +class TextIndexDBusPrivate; +ANYTHING_INDEX_END_NAMESPACE + +class TextIndexDBus : public QObject, public QDBusContext +{ + Q_OBJECT + Q_CLASSINFO("D-Bus Interface", "org.deepin.Filemanager.TextIndex") + +public: + explicit TextIndexDBus(QObject *parent = nullptr); + ~TextIndexDBus(); + + void cleanup(); + +public Q_SLOTS: + bool IsEnabled(); + void SetEnabled(bool enabled); + bool CreateIndexTask(const QStringList &paths, const QVariantMap &options = QVariantMap()); + bool UpdateIndexTask(const QStringList &paths, const QVariantMap &options = QVariantMap()); + bool StopCurrentTask(); + bool HasRunningTask(); + bool IndexDatabaseExists(); + QString GetLastUpdateTime(); + bool ProcessFileChanges(const QStringList &createdFiles, const QStringList &modifiedFiles, const QStringList &deletedFiles); + bool ProcessFileMoves(const QHash &movedFiles); + QVariantMap GetIndexStatus(); + bool ForceUpdateIndex(const QStringList &paths, const QVariantMap &options = QVariantMap()); + +Q_SIGNALS: + void TaskFinished(const QString &type, const QString &path, bool success); + void TaskProgressChanged(const QString &type, const QString &path, qint64 count, qint64 total); + void IndexStatusChanged(const QString &state, const QString &grade); + +private: + QScopedPointer d; +}; + +#endif // TEXTINDEXDBUS_H diff --git a/src/index/deepin-anything-index.service b/src/index/deepin-anything-index.service new file mode 100644 index 00000000..f2d6d3e5 --- /dev/null +++ b/src/index/deepin-anything-index.service @@ -0,0 +1,16 @@ +[Unit] +Description=Deepin Anything Index Service +After=dbus.service + +[Service] +Type=dbus +BusName=org.deepin.Filemanager.TextIndex +ExecStart=/usr/bin/deepin-anything-index +Slice=session.slice +Restart=on-failure +RestartSec=5s +MemoryAccounting=yes +MemoryHigh=900M +MemoryMax=2G + +# No [Install]: the unit is pulled on demand through D-Bus activation only. diff --git a/src/index/document/builderoptions.h b/src/index/document/builderoptions.h new file mode 100644 index 00000000..0c20837d --- /dev/null +++ b/src/index/document/builderoptions.h @@ -0,0 +1,28 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef BUILDEROPTIONS_H +#define BUILDEROPTIONS_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief Optional metadata passed to document builders + * + * Carries supplementary information that extends the basic + * (filePath, text) contract without polluting the virtual interface. + * Individual builders pick only the fields they need. + */ +struct BuilderOptions +{ + QString checksum; ///< MD5 hex digest (optional, used by OCR builder) +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // BUILDEROPTIONS_H diff --git a/src/index/document/contentdocumentbuilder.cpp b/src/index/document/contentdocumentbuilder.cpp new file mode 100644 index 00000000..a7eea304 --- /dev/null +++ b/src/index/document/contentdocumentbuilder.cpp @@ -0,0 +1,106 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "contentdocumentbuilder.h" + +#include "utils/indexutility.h" + +#include + +#include + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE +using namespace Lucene; +DFM_SEARCH_USE_NS +using namespace DFMSEARCH::LuceneFieldNames; + +DocumentPtr ContentDocumentBuilder::build(const QString &filePath, const QString &text, + const BuilderOptions &options) const +{ + DocumentPtr doc = newLucene(); + + doc->add(newLucene(Content::kPath, filePath.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + const QStringList ancestorPaths = PathCalculator::extractAncestorPaths(filePath); + for (const QString &ancestorPath : ancestorPaths) { + doc->add(newLucene(Content::kAncestorPaths, ancestorPath.toStdWString(), + Field::STORE_NO, Field::INDEX_NOT_ANALYZED)); + } + + const QFileInfo fileInfo(filePath); + const qint64 modifyTimeSecs = fileInfo.lastModified().toSecsSinceEpoch(); + NumericFieldPtr modifyTimeField = newLucene(Content::kModifyTime, Field::STORE_YES, true); + modifyTimeField->setLongValue(modifyTimeSecs); + doc->add(modifyTimeField); + + // Add birth time as NumericField for efficient range queries + const qint64 birthTimeSecs = fileInfo.birthTime().toSecsSinceEpoch(); + NumericFieldPtr birthTimeField = newLucene(Content::kBirthTime, Field::STORE_YES, true); + birthTimeField->setLongValue(birthTimeSecs); + doc->add(birthTimeField); + + // Add file size as NumericField for efficient range queries + const qint64 fileSize = fileInfo.size(); + NumericFieldPtr fileSizeField = newLucene(Content::kFileSize, Field::STORE_YES, true); + fileSizeField->setLongValue(fileSize); + doc->add(fileSizeField); + + doc->add(newLucene(Content::kFilename, fileInfo.fileName().toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED)); + + const QString hiddenTag = DFMSEARCH::Global::isHiddenPathOrInHiddenDir(fileInfo.absoluteFilePath()) + ? QStringLiteral("Y") + : QStringLiteral("N"); + doc->add(newLucene(Content::kIsHidden, hiddenTag.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + // Add MD5 checksum for deduplication (exact match, not tokenized) + if (!options.checksum.isEmpty()) { + doc->add(newLucene(Content::kCheckSum, options.checksum.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + } + + // Add file extension for filtering (exact match, not tokenized) + const QString fileExt = fileInfo.suffix().toLower(); + if (!fileExt.isEmpty()) { + doc->add(newLucene(Content::kFileExt, fileExt.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + } + + doc->add(newLucene(Content::kContents, text.trimmed().toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED)); + + return doc; +} + +std::list ContentDocumentBuilder::pathDerivedFields() const +{ + // 与 build() 中对应字段的存储/索引属性保持一致；纯元数据重算，无内容提取 + return { + { Content::kFilename, [](const QString &newPath) -> FieldPtr { + return newLucene(Content::kFilename, QFileInfo(newPath).fileName().toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED); + } }, + { Content::kIsHidden, [](const QString &newPath) -> FieldPtr { + const QString hiddenTag = DFMSEARCH::Global::isHiddenPathOrInHiddenDir(QFileInfo(newPath).absoluteFilePath()) + ? QStringLiteral("Y") + : QStringLiteral("N"); + return newLucene(Content::kIsHidden, hiddenTag.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED); + } }, + { Content::kFileExt, [](const QString &newPath) -> FieldPtr { + const QString fileExt = QFileInfo(newPath).suffix().toLower(); + if (fileExt.isEmpty()) + return nullptr; // 与 build() 一致：无扩展名则不加该字段 + return newLucene(Content::kFileExt, fileExt.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED); + } }, + }; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/document/contentdocumentbuilder.h b/src/index/document/contentdocumentbuilder.h new file mode 100644 index 00000000..5e312b3a --- /dev/null +++ b/src/index/document/contentdocumentbuilder.h @@ -0,0 +1,25 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef CONTENTDOCUMENTBUILDER_H +#define CONTENTDOCUMENTBUILDER_H + +#include "indexdocumentbuilder.h" + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class ContentDocumentBuilder : public IndexDocumentBuilder +{ +public: + Lucene::DocumentPtr build(const QString &filePath, + const QString &text, + const BuilderOptions &options = {}) const override; + + // kFilename/kIsHidden/kFileExt 由路径派生，move 后按新路径重算 + std::list pathDerivedFields() const override; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // CONTENTDOCUMENTBUILDER_H diff --git a/src/index/document/filenamedocumentbuilder.cpp b/src/index/document/filenamedocumentbuilder.cpp new file mode 100644 index 00000000..2adc2380 --- /dev/null +++ b/src/index/document/filenamedocumentbuilder.cpp @@ -0,0 +1,150 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "filenamedocumentbuilder.h" + +#include "utils/filetypemapper.h" +#include "utils/indexutility.h" +#include "utils/pinyinprocessor.h" + +#include + +#include + +#include +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE +using namespace Lucene; +DFM_SEARCH_USE_NS +using namespace DFMSEARCH::LuceneFieldNames; + +namespace { + +// 生成祖先路径列表（与 deepin-anything add_ancestor_paths 一致）： +// 从文件路径向上逐级截断到父目录，直到根目录 "/"，依次加入列表（含 "/"）。 +// 例如 "/home/user/a/b.txt" → ["/home/user/a", "/home/user", "/home", "/"] +QStringList buildAncestorPaths(const QString &filePath) +{ + QStringList ancestorPaths; + if (filePath.isEmpty() || !filePath.startsWith('/')) + return ancestorPaths; + + QString currentPath = filePath; + int lastSlash = 1; + while (lastSlash != 0) { + lastSlash = currentPath.lastIndexOf('/'); + currentPath.resize(lastSlash == 0 ? 1 : lastSlash); + ancestorPaths.append(currentPath); + } + return ancestorPaths; +} + +} // namespace + +DocumentPtr FileNameDocumentBuilder::build(const QString &filePath, const QString &text, + const BuilderOptions &options) const +{ + Q_UNUSED(text) + Q_UNUSED(options) + + DocumentPtr doc = newLucene(); + + const QFileInfo fileInfo(filePath); + const QString fileName = fileInfo.fileName(); + + // file_name — 小写后 NGram 分词（与 anything 的 toLower(toUnicode(file_name)) 一致） + doc->add(newLucene(FileName::kFileName, fileName.toLower().toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED)); + + // file_name_lower — 小写、存储、不分词（通配符搜索） + doc->add(newLucene(FileName::kFileNameLower, fileName.toLower().toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + // full_path — 不分词、存储（主键 Term，删除/更新定位） + doc->add(newLucene(FileName::kFullPath, filePath.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + // file_type — 由 FileTypeMapper 依据 anything dconfig 后缀映射得到 + // （app/archive/audio/doc/pic/video/dir/other，与 anything 一致） + const QString fileType = FileTypeMapper::instance().fileTypeForPath(filePath); + doc->add(newLucene(FileName::kFileType, fileType.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + // file_ext — 小写、不含点（与 anything tolower(extension().substr(1)) 一致） + const QString fileExt = fileInfo.suffix().toLower(); + if (!fileExt.isEmpty()) { + doc->add(newLucene(FileName::kFileExt, fileExt.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + } + + // birth_time / modify_time — Unix 秒 + const qint64 birthTimeSecs = fileInfo.birthTime().toSecsSinceEpoch(); + NumericFieldPtr birthTimeField = newLucene(FileName::kBirthTime, Field::STORE_YES, true); + birthTimeField->setLongValue(birthTimeSecs); + doc->add(birthTimeField); + + const qint64 modifyTimeSecs = fileInfo.lastModified().toSecsSinceEpoch(); + NumericFieldPtr modifyTimeField = newLucene(FileName::kModifyTime, Field::STORE_YES, true); + modifyTimeField->setLongValue(modifyTimeSecs); + doc->add(modifyTimeField); + + // file_size — 字节 + const qint64 fileSize = fileInfo.size(); + NumericFieldPtr fileSizeField = newLucene(FileName::kFileSize, Field::STORE_YES, true); + fileSizeField->setLongValue(fileSize); + doc->add(fileSizeField); + + // file_size_str — 与 anything 同样使用 glib g_format_size 格式化（SI，1000 进制） + gchar *formatted = g_format_size(static_cast(fileSize)); + doc->add(newLucene(FileName::kFileSizeStr, QString::fromUtf8(formatted).toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + g_free(formatted); + + // pinyin / pinyin_acronym — 拼音全拼与首字母（已小写化） + QString pinyinFull; + QString pinyinAcronym; + PinyinProcessor::instance().convertToPinyin(fileName, pinyinFull, pinyinAcronym); + if (!pinyinFull.isEmpty()) { + doc->add(newLucene(FileName::kPinyin, pinyinFull.toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED)); + } + if (!pinyinAcronym.isEmpty()) { + doc->add(newLucene(FileName::kPinyinAcronym, pinyinAcronym.toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED)); + } + + // is_hidden — 路径中含隐藏段（/.xxx）则标记 Y + const QString hiddenTag = DFMSEARCH::Global::isHiddenPathOrInHiddenDir(fileInfo.absoluteFilePath()) + ? QStringLiteral("Y") + : QStringLiteral("N"); + doc->add(newLucene(FileName::kIsHidden, hiddenTag.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + // ancestor_paths — 多值 Term，不存储（从父目录到 "/"） + const QStringList ancestorPaths = buildAncestorPaths(filePath); + for (const QString &ancestorPath : ancestorPaths) { + doc->add(newLucene(FileName::kAncestorPaths, ancestorPath.toStdWString(), + Field::STORE_NO, Field::INDEX_NOT_ANALYZED)); + } + + return doc; +} + +std::list FileNameDocumentBuilder::pathDerivedFields() const +{ + return { + { FileName::kIsHidden, [](const QString &newPath) -> FieldPtr { + const QString hiddenTag = DFMSEARCH::Global::isHiddenPathOrInHiddenDir(QFileInfo(newPath).absoluteFilePath()) + ? QStringLiteral("Y") + : QStringLiteral("N"); + return newLucene(FileName::kIsHidden, hiddenTag.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED); + } }, + }; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/document/filenamedocumentbuilder.h b/src/index/document/filenamedocumentbuilder.h new file mode 100644 index 00000000..e08773c8 --- /dev/null +++ b/src/index/document/filenamedocumentbuilder.h @@ -0,0 +1,27 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FILENAMEDOCUMENTBUILDER_H +#define FILENAMEDOCUMENTBUILDER_H + +#include "indexdocumentbuilder.h" + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FileNameDocumentBuilder : public IndexDocumentBuilder +{ +public: + Lucene::DocumentPtr build(const QString &filePath, + const QString &text, + const BuilderOptions &options = {}) const override; + + // is_hidden 由完整路径派生：目录改名/移入移出隐藏目录树时按新路径重算。 + // 其余字段（file_name/pinyin/file_ext/file_type 等）由 basename 派生， + // 目录改名不改变 basename，copy 保留即可，避免逐文档重建的开销 + std::list pathDerivedFields() const override; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FILENAMEDOCUMENTBUILDER_H diff --git a/src/index/document/indexdocumentbuilder.h b/src/index/document/indexdocumentbuilder.h new file mode 100644 index 00000000..0e5f58a1 --- /dev/null +++ b/src/index/document/indexdocumentbuilder.h @@ -0,0 +1,54 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXDOCUMENTBUILDER_H +#define INDEXDOCUMENTBUILDER_H + +#include "document/builderoptions.h" +#include "index_global.h" + +#include + +#include +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief 路径派生字段的重算规格 + * + * 文档中由文件路径派生的字段（如 file_name/file_ext/is_hidden），在文件 + * 移动/重命名后需按新路径重算。rebuild 必须是纯元数据操作（无内容提取）， + * 返回空 FieldPtr 表示该字段在新路径下不存在（如空扩展名无 file_ext 字段）。 + */ +struct PathDerivedFieldSpec +{ + const wchar_t *fieldName; + std::function rebuild; +}; + +class IndexDocumentBuilder +{ +public: + virtual ~IndexDocumentBuilder() = default; + + virtual Lucene::DocumentPtr build(const QString &filePath, + const QString &text, + const BuilderOptions &options = {}) const = 0; + + /** + * @brief 声明文档中由路径派生的部分字段及其重算方式 + * + * 供 move 处理在保留文档其余字段（内容/校验和/时间戳等与路径无关的字段） + * 的同时，按新路径重算这些派生字段。返回空列表表示无部分派生字段 + * （字段要么全部派生 → 走整体重建策略，要么全部与路径无关）。 + */ + virtual std::list pathDerivedFields() const { return {}; } +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXDOCUMENTBUILDER_H diff --git a/src/index/document/ocrdocumentbuilder.cpp b/src/index/document/ocrdocumentbuilder.cpp new file mode 100644 index 00000000..150cd540 --- /dev/null +++ b/src/index/document/ocrdocumentbuilder.cpp @@ -0,0 +1,109 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "ocrdocumentbuilder.h" + +#include "utils/indexutility.h" + +#include + +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE +using namespace Lucene; +DFM_SEARCH_USE_NS +using namespace DFMSEARCH::LuceneFieldNames; + +DocumentPtr OcrDocumentBuilder::build(const QString &filePath, const QString &text, + const BuilderOptions &options) const +{ + DocumentPtr doc = newLucene(); + + doc->add(newLucene(OcrText::kPath, filePath.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + const QStringList ancestorPaths = PathCalculator::extractAncestorPaths(filePath); + for (const QString &ancestorPath : ancestorPaths) { + doc->add(newLucene(OcrText::kAncestorPaths, ancestorPath.toStdWString(), + Field::STORE_NO, Field::INDEX_NOT_ANALYZED)); + } + + const QFileInfo fileInfo(filePath); + + // Add modify time as NumericField for efficient range queries + const qint64 modifyTimeSecs = fileInfo.lastModified().toSecsSinceEpoch(); + NumericFieldPtr modifyTimeField = newLucene(OcrText::kModifyTime, Field::STORE_YES, true); + modifyTimeField->setLongValue(modifyTimeSecs); + doc->add(modifyTimeField); + + // Add birth time as NumericField for efficient range queries + const qint64 birthTimeSecs = fileInfo.birthTime().toSecsSinceEpoch(); + NumericFieldPtr birthTimeField = newLucene(OcrText::kBirthTime, Field::STORE_YES, true); + birthTimeField->setLongValue(birthTimeSecs); + doc->add(birthTimeField); + + // Add file size as NumericField for efficient range queries + const qint64 fileSize = fileInfo.size(); + NumericFieldPtr fileSizeField = newLucene(OcrText::kFileSize, Field::STORE_YES, true); + fileSizeField->setLongValue(fileSize); + doc->add(fileSizeField); + + doc->add(newLucene(OcrText::kFilename, fileInfo.fileName().toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED)); + + const QString hiddenTag = DFMSEARCH::Global::isHiddenPathOrInHiddenDir(fileInfo.absoluteFilePath()) + ? QStringLiteral("Y") + : QStringLiteral("N"); + doc->add(newLucene(OcrText::kIsHidden, hiddenTag.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + // Add MD5 checksum for deduplication (exact match, not tokenized) + if (!options.checksum.isEmpty()) { + doc->add(newLucene(OcrText::kCheckSum, options.checksum.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + } + + // Add file extension for filtering (exact match, not tokenized) + const QString fileExt = fileInfo.suffix().toLower(); + if (!fileExt.isEmpty()) { + doc->add(newLucene(OcrText::kFileExt, fileExt.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + } + + if (!text.trimmed().isEmpty()) { + doc->add(newLucene(OcrText::kOcrContents, text.trimmed().toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED)); + } + + return doc; +} + +std::list OcrDocumentBuilder::pathDerivedFields() const +{ + // 与 build() 中对应字段的存储/索引属性保持一致；纯元数据重算，无 OCR 提取 + return { + { OcrText::kFilename, [](const QString &newPath) -> FieldPtr { + return newLucene(OcrText::kFilename, QFileInfo(newPath).fileName().toStdWString(), + Field::STORE_YES, Field::INDEX_ANALYZED); + } }, + { OcrText::kIsHidden, [](const QString &newPath) -> FieldPtr { + const QString hiddenTag = DFMSEARCH::Global::isHiddenPathOrInHiddenDir(QFileInfo(newPath).absoluteFilePath()) + ? QStringLiteral("Y") + : QStringLiteral("N"); + return newLucene(OcrText::kIsHidden, hiddenTag.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED); + } }, + { OcrText::kFileExt, [](const QString &newPath) -> FieldPtr { + const QString fileExt = QFileInfo(newPath).suffix().toLower(); + if (fileExt.isEmpty()) + return nullptr; // 与 build() 一致：无扩展名则不加该字段 + return newLucene(OcrText::kFileExt, fileExt.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED); + } }, + }; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/document/ocrdocumentbuilder.h b/src/index/document/ocrdocumentbuilder.h new file mode 100644 index 00000000..68d5fac2 --- /dev/null +++ b/src/index/document/ocrdocumentbuilder.h @@ -0,0 +1,25 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef OCRDOCUMENTBUILDER_H +#define OCRDOCUMENTBUILDER_H + +#include "indexdocumentbuilder.h" + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class OcrDocumentBuilder : public IndexDocumentBuilder +{ +public: + Lucene::DocumentPtr build(const QString &filePath, + const QString &text, + const BuilderOptions &options = {}) const override; + + // kFilename/kIsHidden/kFileExt 由路径派生，move 后按新路径重算 + std::list pathDerivedFields() const override; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // OCRDOCUMENTBUILDER_H diff --git a/src/index/env/envdetector.cpp b/src/index/env/envdetector.cpp new file mode 100644 index 00000000..3bfb8916 --- /dev/null +++ b/src/index/env/envdetector.cpp @@ -0,0 +1,86 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "envdetector.h" +#include "powermonitor.h" +#include "idlemonitor.h" +#include "loadmonitor.h" + +ANYTHING_INDEX_BEGIN_NAMESPACE + +EnvDetector &EnvDetector::instance() +{ + static EnvDetector self; + return self; +} + +EnvDetector::EnvDetector(QObject *parent) + : QObject(parent) +{ + m_powerMonitor = new PowerMonitor(this); + m_idleMonitor = new IdleMonitor(this); + m_loadMonitor = new LoadMonitor(this); + + connect(m_powerMonitor, &PowerMonitor::effectivePowerChanged, this, [this]() { + recomputeState(); + }); + connect(m_idleMonitor, &IdleMonitor::idleChanged, this, [this]() { + recomputeState(); + }); + connect(m_loadMonitor, &LoadMonitor::loadChanged, this, [this]() { + recomputeState(); + }); +} + +EnvDetector::~EnvDetector() = default; + +void EnvDetector::start() +{ + if (m_running) + return; + m_running = true; + m_powerMonitor->start(); + m_idleMonitor->start(); + m_loadMonitor->start(); + recomputeState(); +} + +void EnvDetector::stop() +{ + if (!m_running) + return; + m_running = false; + m_powerMonitor->stop(); + m_idleMonitor->stop(); + m_loadMonitor->stop(); +} + +void EnvDetector::setDataPath(const QString &path) +{ + m_loadMonitor->setDataPath(path); +} + +EnvState EnvDetector::currentState() const +{ + return m_state; +} + +void EnvDetector::recomputeState() +{ + EnvState prev = m_state; + + m_state.onBattery = m_powerMonitor->onBattery(); + m_state.powerSaveMode = m_powerMonitor->powerSaveMode(); + m_state.idle = m_idleMonitor->idle() + && m_loadMonitor->isCpuBelowThreshold() + && m_loadMonitor->isDiskBelowThreshold(); + + if (prev.onBattery != m_state.onBattery + || prev.powerSaveMode != m_state.powerSaveMode + || prev.idle != m_state.idle) { + emit envStateChanged(m_state); + } +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/env/envdetector.h b/src/index/env/envdetector.h new file mode 100644 index 00000000..2bdd3401 --- /dev/null +++ b/src/index/env/envdetector.h @@ -0,0 +1,76 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef ENVDETECTOR_H +#define ENVDETECTOR_H + +#include "index_global.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class PowerMonitor; +class IdleMonitor; +class LoadMonitor; + +/** + * @brief Aggregated environment state consumed by the task scheduler. + * + * Each field reflects the *effective* state after applying the required + * time-delay rules. The scheduler never reads raw sensor data directly. + */ +struct EnvState +{ + bool onBattery { false }; + bool powerSaveMode { false }; + bool idle { false }; + + bool isPowerOk() const { return !onBattery; } + bool isPowerSaveOff() const { return !powerSaveMode; } + bool isIdleOk() const { return idle; } +}; + +/** + * @brief Unified environment-detection entry point. + * + * Owns PowerMonitor, IdleMonitor and LoadMonitor, applies the delay rules + * and exposes a single EnvState + change signal to the scheduler. + */ +class EnvDetector : public QObject +{ + Q_OBJECT +public: + static EnvDetector &instance(); + + ~EnvDetector() override; + + void start(); + void stop(); + + /// Set the directory whose underlying disk the LoadMonitor should track. + void setDataPath(const QString &path); + + EnvState currentState() const; + +Q_SIGNALS: + void envStateChanged(const EnvState &state); + +private: + explicit EnvDetector(QObject *parent = nullptr); + + void recomputeState(); + + PowerMonitor *m_powerMonitor { nullptr }; + IdleMonitor *m_idleMonitor { nullptr }; + LoadMonitor *m_loadMonitor { nullptr }; + + EnvState m_state; + bool m_running { false }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // ENVDETECTOR_H diff --git a/src/index/env/idlemonitor.cpp b/src/index/env/idlemonitor.cpp new file mode 100644 index 00000000..28608b27 --- /dev/null +++ b/src/index/env/idlemonitor.cpp @@ -0,0 +1,68 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "idlemonitor.h" +#include "utils/textindexconfig.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +IdleMonitor::IdleMonitor(QObject *parent) + : QObject(parent) +{ + m_idleThresholdMs = TextIndexConfig::instance().idleThresholdSeconds() * 1000; + + auto *idle = KIdleTime::instance(); + connect(idle, &KIdleTime::timeoutReached, this, &IdleMonitor::onTimeoutReached); + connect(idle, &KIdleTime::resumingFromIdle, this, &IdleMonitor::onResumingFromIdle); +} + +IdleMonitor::~IdleMonitor() = default; + +void IdleMonitor::start() +{ + if (m_started) + return; + m_started = true; + + m_idleIdentifier = KIdleTime::instance()->addIdleTimeout(m_idleThresholdMs); +} + +void IdleMonitor::stop() +{ + if (!m_started) + return; + m_started = false; + + KIdleTime::instance()->removeIdleTimeout(m_idleIdentifier); + setIdle(false); +} + +void IdleMonitor::onTimeoutReached(int identifier, int timeout) +{ + Q_UNUSED(identifier) + Q_UNUSED(timeout) + + if (!m_idle) + setIdle(true); + + // After the idle threshold is reached, register for the next resume event + // so we get notified the moment the user becomes active again. + KIdleTime::instance()->catchNextResumeEvent(); +} + +void IdleMonitor::onResumingFromIdle() +{ + if (m_idle) + setIdle(false); +} + +void IdleMonitor::setIdle(bool idle) +{ + m_idle = idle; + emit idleChanged(idle); +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/env/idlemonitor.h b/src/index/env/idlemonitor.h new file mode 100644 index 00000000..dea025c0 --- /dev/null +++ b/src/index/env/idlemonitor.h @@ -0,0 +1,55 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef IDLEMONITOR_H +#define IDLEMONITOR_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief Event-driven idle detection using KIdleTime. + * + * Uses addIdleTimeout() to get notified when the idle threshold (default 30 s) + * is reached, then catchNextResumeEvent() to detect when the user resumes + * activity. No polling — purely signal-driven per the KIdleTime design. + * + * KIdleTime is a hard build dependency (no HAVE_KIDLETIME guard): on Debian + * the packaging always pulls libkf6idletime-dev, so the compile guard adds + * complexity with no benefit. + */ +class IdleMonitor : public QObject +{ + Q_OBJECT +public: + explicit IdleMonitor(QObject *parent = nullptr); + ~IdleMonitor() override; + + void start(); + void stop(); + + bool idle() const { return m_idle; } + +Q_SIGNALS: + void idleChanged(bool idle); + +private Q_SLOTS: + void onTimeoutReached(int identifier, int timeout); + void onResumingFromIdle(); + +private: + void setIdle(bool idle); + + bool m_idle { false }; + bool m_started { false }; + int m_idleThresholdMs { 30000 }; + int m_idleIdentifier { 0 }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // IDLEMONITOR_H diff --git a/src/index/env/loadmonitor.cpp b/src/index/env/loadmonitor.cpp new file mode 100644 index 00000000..f1118595 --- /dev/null +++ b/src/index/env/loadmonitor.cpp @@ -0,0 +1,194 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "loadmonitor.h" +#include "utils/textindexconfig.h" + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +LoadMonitor::LoadMonitor(QObject *parent) + : QObject(parent) +{ + m_sampleIntervalSecs = TextIndexConfig::instance().loadSampleIntervalSeconds(); + m_cpuThresholdPercent = TextIndexConfig::instance().cpuLoadThresholdPercent(); + m_diskThresholdPercent = TextIndexConfig::instance().diskBusyThresholdPercent(); + + m_timer = new QTimer(this); + m_timer->setInterval(m_sampleIntervalSecs * 1000); + connect(m_timer, &QTimer::timeout, this, &LoadMonitor::sample); +} + +LoadMonitor::~LoadMonitor() = default; + +void LoadMonitor::start() +{ + resolveDataDisk(); + m_timer->start(); + sample(); +} + +void LoadMonitor::stop() +{ + m_timer->stop(); +} + +void LoadMonitor::setDataPath(const QString &path) +{ + m_dataPath = path; +} + +bool LoadMonitor::readProcStat(qint64 &userJiffies, qint64 &guestJiffies, qint64 &totalJiffies) const +{ + QFile file(QStringLiteral("/proc/stat")); + if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) + return false; + + const QString line = QTextStream(&file).readLine(); + const auto parts = line.split(QRegularExpression(QStringLiteral("\\s+")), Qt::SkipEmptyParts); + if (parts.size() < 5) + return false; + + userJiffies = parts[1].toLongLong(); + guestJiffies = (parts.size() >= 10) ? parts[9].toLongLong() : 0; + totalJiffies = 0; + for (int i = 1; i < qMin(parts.size(), 9); ++i) + totalJiffies += parts[i].toLongLong(); + return true; +} + +void LoadMonitor::resolveDataDisk() +{ + if (m_dataPath.isEmpty()) + return; + + const QStorageInfo storage(m_dataPath); + const QString device = storage.device(); // e.g. "/dev/sda3" or "/dev/nvme0n1p2" + if (device.startsWith(QStringLiteral("/dev/"))) { + m_diskDeviceName = device.mid(5); + } +} + +bool LoadMonitor::readProcDiskstats(qint64 &ioTicks) const +{ + if (m_diskDeviceName.isEmpty()) + return false; + + QFile file(QStringLiteral("/proc/diskstats")); + if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) + return false; + + const QString content = QString::fromUtf8(file.readAll()); + const auto lines = content.split(QLatin1Char('\n')); + + QString bestMatch; + qint64 bestTicks = 0; + for (const QString &line : lines) { + const auto parts = line.split(QRegularExpression(QStringLiteral("\\s+")), Qt::SkipEmptyParts); + if (parts.size() < 13) + continue; + // parts[0]=major, [1]=minor, [2]=device name, ..., [12]=io_ticks (ms) + const QString &devName = parts[2]; + + // Exact match: whole-disk mount (e.g. /dev/sda) or LVM (e.g. /dev/dm-0) + if (m_diskDeviceName == devName) { + if (devName.size() > bestMatch.size()) { + bestMatch = devName; + bestTicks = parts[12].toLongLong(); + } + continue; + } + + // Partition match: devName is a prefix of m_diskDeviceName + if (m_diskDeviceName.startsWith(devName)) { + const QChar next = m_diskDeviceName.at(devName.size()); + if (next.isDigit() || next == QLatin1Char('p')) { + if (devName.size() > bestMatch.size()) { + bestMatch = devName; + bestTicks = parts[12].toLongLong(); + } + } + } + } + + if (bestMatch.isEmpty()) + return false; + + ioTicks = bestTicks; + return true; +} + +void LoadMonitor::sample() +{ + qint64 userJiffies = 0, guestJiffies = 0, totalJiffies = 0; + if (!readProcStat(userJiffies, guestJiffies, totalJiffies)) + return; + + qint64 ioTicks = 0; + const bool diskOk = readProcDiskstats(ioTicks); + + Sample s; + s.cpuUser = userJiffies; + s.cpuGuest = guestJiffies; + s.cpuTotal = totalJiffies; + s.diskIo = ioTicks; + + m_window.append(s); + const int maxSamples = qMax(1, 60 / m_sampleIntervalSecs); + while (m_window.size() > maxSamples) + m_window.removeFirst(); + + if (m_window.size() < 2) + return; + + // Compute the 1-minute rolling average over the entire window. + const Sample &oldest = m_window.first(); + const Sample &newest = m_window.last(); + + const qint64 winTotal = newest.cpuTotal - oldest.cpuTotal; + if (winTotal > 0) { + const qint64 winUser = newest.cpuUser - oldest.cpuUser; + const qint64 winGuest = newest.cpuGuest - oldest.cpuGuest; + const double winUsr = winUser - winGuest; + m_cpuAvgPercent = qBound(0.0, (winUsr / static_cast(winTotal)) * 100.0, 100.0); + } + + const qint64 winIo = newest.diskIo - oldest.diskIo; + const qint64 elapsedMs = static_cast(m_window.size() - 1) * m_sampleIntervalSecs * 1000; + if (diskOk && elapsedMs > 0 && winIo >= 0) + m_diskBusyPercent = qBound(0.0, (winIo / static_cast(elapsedMs)) * 100.0, 100.0); + + // Instantaneous values from the last two samples. + if (m_window.size() >= 2) { + const Sample &prev = m_window[m_window.size() - 2]; + const qint64 instTotal = newest.cpuTotal - prev.cpuTotal; + if (instTotal > 0) { + const qint64 instUser = newest.cpuUser - prev.cpuUser; + const qint64 instGuest = newest.cpuGuest - prev.cpuGuest; + m_cpuInstantPercent = qBound(0.0, ((instUser - instGuest) / static_cast(instTotal)) * 100.0, 100.0); + } + const qint64 instIo = newest.diskIo - prev.diskIo; + const qint64 instMs = m_sampleIntervalSecs * 1000; + if (diskOk && instMs > 0 && instIo >= 0) + m_diskInstantPercent = qBound(0.0, (instIo / static_cast(instMs)) * 100.0, 100.0); + } + + emit loadChanged(m_cpuAvgPercent, m_diskBusyPercent); +} + +bool LoadMonitor::isCpuBelowThreshold() const +{ + return m_cpuAvgPercent <= m_cpuThresholdPercent; +} + +bool LoadMonitor::isDiskBelowThreshold() const +{ + return m_diskBusyPercent <= m_diskThresholdPercent; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/env/loadmonitor.h b/src/index/env/loadmonitor.h new file mode 100644 index 00000000..f9c31a62 --- /dev/null +++ b/src/index/env/loadmonitor.h @@ -0,0 +1,82 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef LOADMONITOR_H +#define LOADMONITOR_H + +#include "index_global.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief Samples /proc/stat and /proc/diskstats to maintain a 1-minute + * rolling average of CPU usage and data-disk busyness. + * + * The monitored disk is the block device that backs @c dataPath (the index + * storage directory), resolved via QStorageInfo at start time. Only that + * device's io_ticks are aggregated — not the system disk or every disk. + */ +class LoadMonitor : public QObject +{ + Q_OBJECT +public: + explicit LoadMonitor(QObject *parent = nullptr); + ~LoadMonitor() override; + + void start(); + void stop(); + + void setDataPath(const QString &path); + + double cpuAvgPercent() const { return m_cpuAvgPercent; } + double diskBusyPercent() const { return m_diskBusyPercent; } + double cpuInstantPercent() const { return m_cpuInstantPercent; } + double diskInstantPercent() const { return m_diskInstantPercent; } + + bool isCpuBelowThreshold() const; + bool isDiskBelowThreshold() const; + + int cpuThresholdPercent() const { return m_cpuThresholdPercent; } + int diskThresholdPercent() const { return m_diskThresholdPercent; } + +Q_SIGNALS: + void loadChanged(double cpuAvgPercent, double diskBusyPercent); + +private: + void sample(); + bool readProcStat(qint64 &userJiffies, qint64 &guestJiffies, qint64 &totalJiffies) const; + bool readProcDiskstats(qint64 &ioTicks) const; + void resolveDataDisk(); + + class QTimer *m_timer { nullptr }; + int m_sampleIntervalSecs { 5 }; + + QString m_dataPath; + QString m_diskDeviceName; + + struct Sample { + qint64 cpuUser { 0 }; + qint64 cpuGuest { 0 }; + qint64 cpuTotal { 0 }; + qint64 diskIo { 0 }; + }; + + QList m_window; + + double m_cpuAvgPercent { 0.0 }; + double m_diskBusyPercent { 0.0 }; + double m_cpuInstantPercent { 0.0 }; + double m_diskInstantPercent { 0.0 }; + + int m_cpuThresholdPercent { 30 }; + int m_diskThresholdPercent { 50 }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // LOADMONITOR_H diff --git a/src/index/env/powermonitor.cpp b/src/index/env/powermonitor.cpp new file mode 100644 index 00000000..b0a09a46 --- /dev/null +++ b/src/index/env/powermonitor.cpp @@ -0,0 +1,137 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "powermonitor.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { +constexpr auto kPowerService = "org.deepin.dde.Power1"; +constexpr auto kPowerPath = "/org/deepin/dde/Power1"; +constexpr auto kPowerIface = "org.deepin.dde.Power1"; +} + +PowerMonitor::PowerMonitor(QObject *parent) + : QObject(parent) +{ + m_batteryEntryTimer = new QTimer(this); + m_batteryEntryTimer->setSingleShot(true); + m_batteryEntryTimer->setInterval(500); + connect(m_batteryEntryTimer, &QTimer::timeout, this, [this]() { + m_onBattery = m_pendingOnBattery; + scheduleEmit(); + }); + + m_powerSaveEntryTimer = new QTimer(this); + m_powerSaveEntryTimer->setSingleShot(true); + m_powerSaveEntryTimer->setInterval(500); + connect(m_powerSaveEntryTimer, &QTimer::timeout, this, [this]() { + m_powerSave = m_pendingPowerSave; + scheduleEmit(); + }); + + m_powerSaveExitTimer = new QTimer(this); + m_powerSaveExitTimer->setSingleShot(true); + m_powerSaveExitTimer->setInterval(500); + connect(m_powerSaveExitTimer, &QTimer::timeout, this, [this]() { + m_powerSave = m_pendingPowerSave; + scheduleEmit(); + }); +} + +PowerMonitor::~PowerMonitor() = default; + +void PowerMonitor::start() +{ + if (m_started) + return; + m_started = true; + + auto bus = QDBusConnection::systemBus(); + QDBusInterface iface(kPowerService, kPowerPath, kPowerIface, bus); + + const QVariant batteryProp = iface.property("OnBattery"); + if (batteryProp.isValid()) { + m_onBattery = batteryProp.toBool(); + m_pendingOnBattery = m_onBattery; + } + + const QVariant modeProp = iface.property("Mode"); + if (modeProp.isValid()) { + m_powerSave = (modeProp.toString() == QLatin1String("powersave")); + m_pendingPowerSave = m_powerSave; + } + + bus.connect(kPowerService, kPowerPath, "org.freedesktop.DBus.Properties", + "PropertiesChanged", this, SLOT(onPropertiesChanged(QString, QVariantMap, QStringList))); +} + +void PowerMonitor::onPropertiesChanged(const QString &interface, + const QVariantMap &changed, + const QStringList &invalidated) +{ + Q_UNUSED(interface) + Q_UNUSED(invalidated) + + if (changed.contains(QStringLiteral("OnBattery"))) + onBatteryChanged(changed.value(QStringLiteral("OnBattery")).toBool()); + + if (changed.contains(QStringLiteral("Mode"))) + onModeChanged(changed.value(QStringLiteral("Mode")).toString()); +} + +void PowerMonitor::stop() +{ + if (!m_started) + return; + m_started = false; + + auto bus = QDBusConnection::systemBus(); + bus.disconnect(kPowerService, kPowerPath, "org.freedesktop.DBus.Properties", + "PropertiesChanged", this, SLOT(onPropertiesChanged(QString, QVariantMap, QStringList))); + + m_batteryEntryTimer->stop(); + m_powerSaveEntryTimer->stop(); + m_powerSaveExitTimer->stop(); +} + +void PowerMonitor::onBatteryChanged(bool onBattery) +{ + if (onBattery == m_pendingOnBattery) + return; + m_pendingOnBattery = onBattery; + if (onBattery) + m_batteryEntryTimer->start(); + else { + m_batteryEntryTimer->stop(); + m_onBattery = false; + scheduleEmit(); + } +} + +void PowerMonitor::onModeChanged(const QString &mode) +{ + const bool ps = (mode == QLatin1String("powersave")); + if (ps == m_pendingPowerSave) + return; + m_pendingPowerSave = ps; + if (ps) { + m_powerSaveExitTimer->stop(); + m_powerSaveEntryTimer->start(); + } else { + m_powerSaveEntryTimer->stop(); + m_powerSaveExitTimer->start(); + } +} + +void PowerMonitor::scheduleEmit() +{ + emit effectivePowerChanged(m_onBattery, m_powerSave); +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/env/powermonitor.h b/src/index/env/powermonitor.h new file mode 100644 index 00000000..9587a044 --- /dev/null +++ b/src/index/env/powermonitor.h @@ -0,0 +1,58 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef POWERMONITOR_H +#define POWERMONITOR_H + +#include "index_global.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief Monitors the system DBus service org.deepin.dde.Power1. + * + * Exposes effective OnBattery / power-save state after applying the + * delay rules from the spec. + */ +class PowerMonitor : public QObject +{ + Q_OBJECT +public: + explicit PowerMonitor(QObject *parent = nullptr); + ~PowerMonitor() override; + + void start(); + void stop(); + + bool onBattery() const { return m_onBattery; } + bool powerSaveMode() const { return m_powerSave; } + +Q_SIGNALS: + void effectivePowerChanged(bool onBattery, bool powerSave); + +private Q_SLOTS: + void onBatteryChanged(bool onBattery); + void onModeChanged(const QString &mode); + void onPropertiesChanged(const QString &interface, const QVariantMap &changed, + const QStringList &invalidated); + void scheduleEmit(); + +private: + bool m_onBattery { false }; + bool m_powerSave { false }; + bool m_started { false }; + + bool m_pendingOnBattery { false }; + bool m_pendingPowerSave { false }; + class QTimer *m_batteryEntryTimer { nullptr }; + class QTimer *m_powerSaveEntryTimer { nullptr }; + class QTimer *m_powerSaveExitTimer { nullptr }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // POWERMONITOR_H diff --git a/src/index/extractor/contentdeduplication.cpp b/src/index/extractor/contentdeduplication.cpp new file mode 100644 index 00000000..80d60587 --- /dev/null +++ b/src/index/extractor/contentdeduplication.cpp @@ -0,0 +1,63 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "contentdeduplication.h" +#include "utils/scopeguard.h" + +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +using namespace Lucene; +DFM_SEARCH_USE_NS +using namespace DFMSEARCH::LuceneFieldNames; + +namespace ContentDeduplication { + +QString lookupByTextChecksum(const QString &checksum, const QString &contentIndexDir) +{ + if (checksum.isEmpty() || contentIndexDir.isEmpty()) { + return {}; + } + + try { + IndexReaderPtr reader = IndexReader::open( + FSDirectory::open(contentIndexDir.toStdWString()), true); + + ScopeGuard readerCloser([&reader]() { + try { + if (reader) { + reader->close(); + } + } catch (...) { + } + }); + + SearcherPtr searcher = newLucene(reader); + TermQueryPtr query = newLucene( + newLucene(Content::kCheckSum, checksum.toStdWString())); + + TopDocsPtr topDocs = searcher->search(query, 1); + + if (topDocs->totalHits == 0) { + return {}; + } + + DocumentPtr doc = searcher->doc(topDocs->scoreDocs[0]->doc); + const String contents = doc->get(Content::kContents); + + return contents.empty() ? QString() + : QString::fromStdWString(contents); + } catch (...) { + // Deduplication is a best-effort optimization. + // On any failure, fall through to normal content extraction. + return {}; + } +} + +} // namespace ContentDeduplication + +ANYTHING_INDEX_END_NAMESPACE \ No newline at end of file diff --git a/src/index/extractor/contentdeduplication.h b/src/index/extractor/contentdeduplication.h new file mode 100644 index 00000000..5269eee6 --- /dev/null +++ b/src/index/extractor/contentdeduplication.h @@ -0,0 +1,35 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef CONTENTDEDUPLICATION_H +#define CONTENTDEDUPLICATION_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace ContentDeduplication { + +/** + * @brief Attempt to find existing content text by file checksum + * + * Opens the content index read-only, searches for a document with matching + * checksum, and returns the contents text if found. + * + * This is a best-effort optimization: on any failure (index unavailable, + * corrupt, etc.) it returns an empty string so normal content extraction proceeds. + * + * @param checksum MD5 hex digest of the file + * @param contentIndexDir Path to the content Lucene index directory + * @return The content text if a matching document was found, empty string otherwise + */ +QString lookupByTextChecksum(const QString &checksum, const QString &contentIndexDir); + +} // namespace ContentDeduplication + +ANYTHING_INDEX_END_NAMESPACE + +#endif // CONTENTDEDUPLICATION_H \ No newline at end of file diff --git a/src/index/extractor/indexextractor.h b/src/index/extractor/indexextractor.h new file mode 100644 index 00000000..08e9e7ee --- /dev/null +++ b/src/index/extractor/indexextractor.h @@ -0,0 +1,33 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXEXTRACTOR_H +#define INDEXEXTRACTOR_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +struct IndexExtractionResult +{ + bool success { false }; + QString text {}; + QString error {}; + QString checksum {}; ///< MD5 hex digest of the source file (if computed) + bool deduplicated { false }; ///< true if text was obtained via checksum deduplication +}; + +class IndexExtractor +{ +public: + virtual ~IndexExtractor() = default; + + virtual IndexExtractionResult extract(const QString &filePath, size_t maxBytes = 0) const = 0; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXEXTRACTOR_H diff --git a/src/index/extractor/ocrdeduplication.cpp b/src/index/extractor/ocrdeduplication.cpp new file mode 100644 index 00000000..7a1f0ae9 --- /dev/null +++ b/src/index/extractor/ocrdeduplication.cpp @@ -0,0 +1,63 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "ocrdeduplication.h" +#include "utils/scopeguard.h" + +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +using namespace Lucene; +DFM_SEARCH_USE_NS +using namespace DFMSEARCH::LuceneFieldNames; + +namespace OcrDeduplication { + +QString lookupByTextChecksum(const QString &checksum, const QString &ocrIndexDir) +{ + if (checksum.isEmpty() || ocrIndexDir.isEmpty()) { + return {}; + } + + try { + IndexReaderPtr reader = IndexReader::open( + FSDirectory::open(ocrIndexDir.toStdWString()), true); + + ScopeGuard readerCloser([&reader]() { + try { + if (reader) { + reader->close(); + } + } catch (...) { + } + }); + + SearcherPtr searcher = newLucene(reader); + TermQueryPtr query = newLucene( + newLucene(OcrText::kCheckSum, checksum.toStdWString())); + + TopDocsPtr topDocs = searcher->search(query, 1); + + if (topDocs->totalHits == 0) { + return {}; + } + + DocumentPtr doc = searcher->doc(topDocs->scoreDocs[0]->doc); + const String ocrContents = doc->get(OcrText::kOcrContents); + + return ocrContents.empty() ? QString() + : QString::fromStdWString(ocrContents); + } catch (...) { + // Deduplication is a best-effort optimization. + // On any failure, fall through to normal OCR extraction. + return {}; + } +} + +} // namespace OcrDeduplication + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/extractor/ocrdeduplication.h b/src/index/extractor/ocrdeduplication.h new file mode 100644 index 00000000..ef869dd8 --- /dev/null +++ b/src/index/extractor/ocrdeduplication.h @@ -0,0 +1,35 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef OCRDEDUPLICATION_H +#define OCRDEDUPLICATION_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace OcrDeduplication { + +/** + * @brief Attempt to find existing OCR text by file checksum + * + * Opens the OCR index read-only, searches for a document with matching + * checksum, and returns the ocr_contents text if found. + * + * This is a best-effort optimization: on any failure (index unavailable, + * corrupt, etc.) it returns an empty string so normal OCR extraction proceeds. + * + * @param checksum MD5 hex digest of the file + * @param ocrIndexDir Path to the OCR Lucene index directory + * @return The OCR text if a matching document was found, empty string otherwise + */ +QString lookupByTextChecksum(const QString &checksum, const QString &ocrIndexDir); + +} // namespace OcrDeduplication + +ANYTHING_INDEX_END_NAMESPACE + +#endif // OCRDEDUPLICATION_H diff --git a/src/index/extractor/processextractor.cpp b/src/index/extractor/processextractor.cpp new file mode 100644 index 00000000..56aa8b9c --- /dev/null +++ b/src/index/extractor/processextractor.cpp @@ -0,0 +1,326 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "processextractor.h" + +#include + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +constexpr int kExtractorRequestTimeoutMs = 120000; +constexpr int kExtractorIdleShutdownMs = 60000; + +struct ActiveExtraction +{ + QString filePath; + IndexExtractionResult result; + QEventLoop *loop { nullptr }; +}; + +// Debug-friendly tool resolution: the ANYTHING_EXTRACTOR_TOOL environment +// variable overrides the compiled-in install path, so a locally built +// deepin-anything-extractor can be plugged in without reinstalling +// (same user-override-first spirit as PinyinProcessor::dictionaryLookupPaths). +QString extractorToolPath() +{ + const QString fromEnv = qEnvironmentVariable("ANYTHING_EXTRACTOR_TOOL"); + if (!fromEnv.isEmpty()) + return fromEnv; + return QString::fromLatin1(ANYTHING_EXTRACTOR_TOOL); +} + +class ProcessExtractorProxy : public QObject +{ +public: + explicit ProcessExtractorProxy(QString extractorPath, QObject *parent = nullptr) + : QObject(parent), + m_extractorPath(std::move(extractorPath)), + m_pipe(new EXTRACTOR_NAMESPACE::ControllerPipe(this)) + { + m_requestTimeoutTimer.setSingleShot(true); + m_idleShutdownTimer.setSingleShot(true); + + connect(m_pipe, &EXTRACTOR_NAMESPACE::ControllerPipe::extractionFinished, this, + [this](const QString &path, const QByteArray &data) { + if (!m_activeExtraction || path != m_activeExtraction->filePath) { + return; + } + + qDebug() << "ProcessExtractorProxy: extraction finished for:" << path + << "size:" << data.size(); + finishActiveExtraction({ true, QString::fromUtf8(data).trimmed(), QString() }); + }); + + connect(m_pipe, &EXTRACTOR_NAMESPACE::ControllerPipe::extractionFailed, this, + [this](const QString &path, const QString &error) { + if (!m_activeExtraction || path != m_activeExtraction->filePath) { + return; + } + + qWarning() << "ProcessExtractorProxy: extraction failed for:" << path + << "error:" << error; + finishActiveExtraction({ false, QString(), error }); + }); + + connect(m_pipe, &EXTRACTOR_NAMESPACE::ControllerPipe::errorOccurred, this, + [this](const QString &error) { + if (m_stoppingPipe) { + return; + } + + if (!m_activeExtraction) { + qWarning() << "ProcessExtractorProxy: extractor reported error without active request:" + << error; + return; + } + + qWarning() << "ProcessExtractorProxy: extractor error for:" + << m_activeExtraction->filePath << "error:" << error; + stopPipe(); + finishActiveExtraction({ false, QString(), error }); + }); + + connect(m_pipe, &EXTRACTOR_NAMESPACE::ControllerPipe::processCrashed, this, [this]() { + if (m_stoppingPipe) { + return; + } + + if (!m_activeExtraction) { + qWarning() << "ProcessExtractorProxy: extractor process crashed without active request"; + stopPipe(); + return; + } + + qWarning() << "ProcessExtractorProxy: extractor process crashed during request for:" + << m_activeExtraction->filePath; + stopPipe(); + finishActiveExtraction({ false, QString(), QStringLiteral("Extractor process crashed") }); + }); + + connect(m_pipe, &EXTRACTOR_NAMESPACE::ControllerPipe::processFinished, this, + [this](int exitCode, QProcess::ExitStatus exitStatus) { + if (m_stoppingPipe) { + return; + } + + if (!m_activeExtraction || exitStatus == QProcess::CrashExit) { + return; + } + + qWarning() << "ProcessExtractorProxy: extractor process finished unexpectedly during request for:" + << m_activeExtraction->filePath << "exitCode:" << exitCode + << "exitStatus:" << exitStatus; + stopPipe(); + finishActiveExtraction({ false, QString(), QStringLiteral("Extractor process finished unexpectedly") }); + }); + + connect(&m_requestTimeoutTimer, &QTimer::timeout, this, [this]() { + if (!m_activeExtraction) { + return; + } + + qWarning() << "ProcessExtractorProxy: request timed out for:" << m_activeExtraction->filePath; + stopPipe(); + finishActiveExtraction({ false, QString(), QStringLiteral("Extractor request timed out") }); + }); + + connect(&m_idleShutdownTimer, &QTimer::timeout, this, [this]() { + if (!m_activeExtraction) { + qInfo() << "ProcessExtractorProxy: stopping idle extractor process after timeout"; + stopPipe(); + } + }); + } + + IndexExtractionResult extractSync(const QString &filePath, size_t maxBytes) + { + Q_ASSERT(QThread::currentThread() == thread()); + Q_UNUSED(maxBytes) + + if (m_activeExtraction) { + qWarning() << "ProcessExtractorProxy: received overlapping extract request for:" << filePath; + return { false, QString(), QStringLiteral("Extractor is busy processing another file") }; + } + + m_idleShutdownTimer.stop(); + + if (!ensurePipeStarted()) { + return { false, QString(), QStringLiteral("Failed to start deepin-anything-extractor") }; + } + + QEventLoop loop; + ActiveExtraction extraction; + extraction.filePath = filePath; + extraction.loop = &loop; + m_activeExtraction = &extraction; + + m_requestTimeoutTimer.start(kExtractorRequestTimeoutMs); + if (!m_pipe->extractBatch({ filePath })) { + qWarning() << "ProcessExtractorProxy: failed to send extractor request for:" << filePath; + stopPipe(); + finishActiveExtraction({ false, QString(), QStringLiteral("Failed to send extractor request") }); + } + + if (m_activeExtraction) { + loop.exec(); + } + + return extraction.result; + } + + void shutdown() + { + if (QThread::currentThread() != thread()) { + QMetaObject::invokeMethod(this, [this]() { + shutdown(); + }, Qt::BlockingQueuedConnection); + return; + } + + m_idleShutdownTimer.stop(); + m_requestTimeoutTimer.stop(); + + finishActiveExtraction({ false, QString(), QStringLiteral("Process extractor shutting down") }); + stopPipe(); + } + +private: + bool ensurePipeStarted() + { + Q_ASSERT(QThread::currentThread() == thread()); + + if (m_pipe->isRunning()) { + return true; + } + + if (m_extractorPath.isEmpty()) { + qCritical() << "ProcessExtractorProxy: extractor path is empty"; + return false; + } + + if (!m_pipe->start(m_extractorPath)) { + qCritical() << "ProcessExtractorProxy: failed to start extractor process"; + return false; + } + + qInfo() << "ProcessExtractorProxy: extractor process started, pid:" << m_pipe->processId(); + return true; + } + + void finishActiveExtraction(const IndexExtractionResult &result) + { + Q_ASSERT(QThread::currentThread() == thread()); + + if (!m_activeExtraction) { + return; + } + + m_requestTimeoutTimer.stop(); + m_activeExtraction->result = result; + + QEventLoop *loop = m_activeExtraction->loop; + m_activeExtraction = nullptr; + + if (m_pipe->isRunning()) { + m_idleShutdownTimer.start(kExtractorIdleShutdownMs); + } + + if (loop && loop->isRunning()) { + loop->quit(); + } + } + + void stopPipe() + { + Q_ASSERT(QThread::currentThread() == thread()); + + if (!m_pipe->isRunning()) { + return; + } + + m_stoppingPipe = true; + qInfo() << "ProcessExtractorProxy: stopping extractor process"; + m_pipe->stop(); + m_stoppingPipe = false; + } + +private: + const QString m_extractorPath; + EXTRACTOR_NAMESPACE::ControllerPipe *m_pipe { nullptr }; + ActiveExtraction *m_activeExtraction { nullptr }; + QTimer m_requestTimeoutTimer; + QTimer m_idleShutdownTimer; + bool m_stoppingPipe { false }; +}; + +} // namespace + +class ProcessExtractorPrivate +{ +public: + ProcessExtractorPrivate() + : proxy(new ProcessExtractorProxy(extractorToolPath())) + { + } + + ~ProcessExtractorPrivate() + { + delete proxy; + } + + ProcessExtractorProxy *proxy { nullptr }; +}; + +IndexExtractionResult invokeProxyExtract(ProcessExtractorProxy *proxy, const QString &filePath, size_t maxBytes) +{ + IndexExtractionResult result; + const bool invoked = QMetaObject::invokeMethod( + proxy, [proxy, &result, filePath, maxBytes]() { + result = proxy->extractSync(filePath, maxBytes); + }, + Qt::BlockingQueuedConnection); + + if (!invoked) { + qCritical() << "ProcessExtractor::extract: failed to invoke extractor request for:" << filePath; + return { false, QString(), QStringLiteral("Failed to invoke extractor request") }; + } + + return result; +} + +ProcessExtractor::ProcessExtractor() + : d(new ProcessExtractorPrivate()) +{ +} + +ProcessExtractor::~ProcessExtractor() +{ + if (d->proxy) { + Q_ASSERT(QThread::currentThread() == d->proxy->thread()); + d->proxy->shutdown(); + } +} + +IndexExtractionResult ProcessExtractor::extract(const QString &filePath, size_t maxBytes) const +{ + if (!d->proxy) { + qCritical() << "ProcessExtractor::extract: extractor proxy is unavailable for:" << filePath; + return { false, QString(), QStringLiteral("Extractor proxy is unavailable") }; + } + + if (QThread::currentThread() == d->proxy->thread()) { + return d->proxy->extractSync(filePath, maxBytes); + } + + return invokeProxyExtract(d->proxy, filePath, maxBytes); +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/extractor/processextractor.h b/src/index/extractor/processextractor.h new file mode 100644 index 00000000..8428c324 --- /dev/null +++ b/src/index/extractor/processextractor.h @@ -0,0 +1,32 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef PROCESSEXTRACTOR_H +#define PROCESSEXTRACTOR_H + +#include "indexextractor.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class ProcessExtractorPrivate; + +class ProcessExtractor : public IndexExtractor +{ +public: + ProcessExtractor(); + ~ProcessExtractor() override; + + Q_DISABLE_COPY_MOVE(ProcessExtractor) + + IndexExtractionResult extract(const QString &filePath, size_t maxBytes = 0) const override; + +private: + const QScopedPointer d; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // PROCESSEXTRACTOR_H diff --git a/src/index/fsmonitor/fseventcollector.cpp b/src/index/fsmonitor/fseventcollector.cpp new file mode 100644 index 00000000..efe1c493 --- /dev/null +++ b/src/index/fsmonitor/fseventcollector.cpp @@ -0,0 +1,940 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "fseventcollector_p.h" +#include "utils/textindexconfig.h" + +#include + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +struct SharedMonitorState +{ + QStringList rootPaths; + bool initialized { false }; + int activeCollectors { 0 }; +}; + +SharedMonitorState &sharedMonitorState() +{ + static SharedMonitorState state; + return state; +} + +QStringList normalizedRootPaths(const QStringList &paths) +{ + QStringList normalized; + normalized.reserve(paths.size()); + + for (const QString &path : paths) { + QString absPath = QDir(path).absolutePath(); + if (QDir(absPath).exists()) { + normalized.append(absPath); + } else { + qWarning() << "FSEventCollector: Root path does not exist:" << absPath; + } + } + + normalized.removeDuplicates(); + std::sort(normalized.begin(), normalized.end()); + return normalized; +} + +} // namespace + +FSEventCollectorPrivate::FSEventCollectorPrivate(FSEventCollector *qq, + FSEventCollector::PathPredicate pathPredicate, + FSMonitor &monitor) + : q_ptr(qq), + fsMonitor(monitor), + pathPredicate(std::move(pathPredicate)) +{ + // Set up collection timer + collectionTimer.setSingleShot(true); + QObject::connect(&collectionTimer, &QTimer::timeout, qq, [this]() { + flushCollectedEvents(); + + // Restart timer if still active + if (active) { + collectionTimer.start(collectionIntervalMs); + } + }); +} + +FSEventCollectorPrivate::~FSEventCollectorPrivate() +{ + stopCollecting(); +} + +bool FSEventCollectorPrivate::init(const QStringList &rootPaths) +{ + this->rootPaths = normalizedRootPaths(rootPaths); + + if (this->rootPaths.isEmpty()) { + qWarning() << "FSEventCollector: No valid root paths provided for initialization"; + return false; + } + + auto &sharedState = sharedMonitorState(); + + const bool rootPathsChanged = sharedState.rootPaths != this->rootPaths; + const bool canReinitialize = !sharedState.initialized || (rootPathsChanged && sharedState.activeCollectors == 0); + + if (!canReinitialize) { + // Fix: OCR/TEXT runtimes now own separate collectors, but they must reuse + // the same process-wide directory watcher to avoid conflicting monitor setup. + if (rootPathsChanged) { + qWarning() << "FSEventCollector: Reusing shared FSMonitor root paths while another collector is active:" + << sharedState.rootPaths; + } else { + qInfo() << "FSEventCollector: Reusing shared FSMonitor initialization for root paths:" << this->rootPaths; + } + + this->rootPaths = sharedState.rootPaths; + fsMonitor.setMaxResourceUsage(TextIndexConfig::instance().inotifyWatchesCoefficient()); + return true; + } + + if (!fsMonitor.initialize(this->rootPaths)) { + qWarning() << "FSEventCollector: Failed to initialize FSMonitor with root paths"; + return false; + } + + sharedState.rootPaths = this->rootPaths; + sharedState.initialized = true; + fsMonitor.setMaxResourceUsage(TextIndexConfig::instance().inotifyWatchesCoefficient()); + + qInfo() << "FSEventCollector: Initialized successfully with" << this->rootPaths.size() << "root paths"; + return true; +} + +bool FSEventCollectorPrivate::startCollecting() +{ + if (active) { + qInfo() << "FSEventCollector: Event collection already active, ignoring start request"; + return true; + } + + // Connect to FSMonitor signals + QObject::connect(&fsMonitor, &FSMonitor::fileCreated, + q_ptr, [this](const QString &path, const QString &name) { + handleFileCreated(path, name); + }); + + QObject::connect(&fsMonitor, &FSMonitor::fileDeleted, + q_ptr, [this](const QString &path, const QString &name) { + handleFileDeleted(path, name); + }); + + QObject::connect(&fsMonitor, &FSMonitor::fileClosed, + q_ptr, [this](const QString &path, const QString &name) { + handleFileClosed(path, name); + }); + + QObject::connect(&fsMonitor, &FSMonitor::fileMoved, + q_ptr, [this](const QString &fromPath, const QString &fromName, const QString &toPath, const QString &toName) { + handleFileMoved(fromPath, fromName, toPath, toName); + }); + + QObject::connect(&fsMonitor, &FSMonitor::directoryCreated, + q_ptr, [this](const QString &path, const QString &name) { + handleDirectoryCreated(path, name); + }); + + QObject::connect(&fsMonitor, &FSMonitor::directoryDeleted, + q_ptr, [this](const QString &path, const QString &name) { + handleDirectoryDeleted(path, name); + }); + + QObject::connect(&fsMonitor, &FSMonitor::directoryMoved, + q_ptr, [this](const QString &fromPath, const QString &fromName, const QString &toPath, const QString &toName) { + handleDirectoryMoved(fromPath, fromName, toPath, toName); + }); + + // Clear existing events + createdFilesList.clear(); + deletedFilesList.clear(); + modifiedFilesList.clear(); + movedFilesList.clear(); + + auto &sharedState = sharedMonitorState(); + { + if (sharedState.activeCollectors == 0) { + if (!fsMonitor.start()) { + QObject::disconnect(&fsMonitor, nullptr, q_ptr, nullptr); + qWarning() << "FSEventCollector: Failed to start FSMonitor"; + return false; + } + + qInfo() << "FSEventCollector: Started shared FSMonitor"; + } else { + qInfo() << "FSEventCollector: Reusing active shared FSMonitor, active collectors:" + << sharedState.activeCollectors; + } + + ++sharedState.activeCollectors; + monitoringLeaseAcquired = true; + } + + // Start collection timer + active = true; + collectionTimer.start(collectionIntervalMs); + + qInfo() << "FSEventCollector: Started event collection with interval:" << (collectionIntervalMs / 1000) << "seconds"; + + return true; +} + +void FSEventCollectorPrivate::stopCollecting() +{ + if (!active) { + return; + } + + active = false; + + // Stop the timer + collectionTimer.stop(); + + // Disconnect from FSMonitor signals + QObject::disconnect(&fsMonitor, nullptr, q_ptr, nullptr); + + bool shouldStopMonitor = false; + int remainingCollectors = 0; + { + auto &sharedState = sharedMonitorState(); + + if (monitoringLeaseAcquired && sharedState.activeCollectors > 0) { + --sharedState.activeCollectors; + } + + remainingCollectors = sharedState.activeCollectors; + shouldStopMonitor = (sharedState.activeCollectors == 0); + monitoringLeaseAcquired = false; + } + + if (shouldStopMonitor) { + fsMonitor.stop(); + qInfo() << "FSEventCollector: Stopped shared FSMonitor"; + } else { + qInfo() << "FSEventCollector: Released shared FSMonitor lease, remaining collectors:" << remainingCollectors; + } + + // Clear collected events + createdFilesList.clear(); + deletedFilesList.clear(); + modifiedFilesList.clear(); + movedFilesList.clear(); + directoryHintCache.clear(); + + qInfo() << "FSEventCollector: Stopped event collection"; +} + +bool FSEventCollectorPrivate::shouldTrackPath(const QString &path) const +{ + if (path.isEmpty()) + return false; + + // For deleted files, don't attempt to check file system since it's gone + if (deletedFilesList.contains(path)) + return true; + + // Always track directories regardless of extension + if (isDirectory(path)) + return true; + + if (!pathPredicate) { + qWarning() << "FSEventCollector: missing path predicate"; + return false; + } + + return pathPredicate(path); +} + +void FSEventCollectorPrivate::handleFileCreated(const QString &path, const QString &name) +{ + QString fullPath = normalizePath(path, name); + + // Skip if max event count exceeded + if (isMaxEventCountExceeded()) { + return; + } + + // Logic for handling file creation: + // 1. If file was previously deleted, remove from deleted list AND add to created list + // (re-creation needs reindexing as content might have changed) + // 2. Otherwise, add to created list + if (deletedFilesList.contains(fullPath)) { + deletedFilesList.remove(fullPath); + + // Add to created list to ensure reindexing + if (shouldTrackPath(fullPath)) { + createdFilesList.insert(fullPath); + qDebug() << "FSEventCollector: File recreated after deletion, adding to created list:" << fullPath; + } + } else { + // Check if this file is under a directory that's already in the created list + if (!isChildOfAnyPath(fullPath, createdFilesList)) { + // Only insert if file has supported extension or is a directory + if (shouldTrackPath(fullPath)) { + createdFilesList.insert(fullPath); + qDebug() << "FSEventCollector: Added to created list:" << fullPath; + + // If this is a directory, remove any files in the list that are under this directory + if (isDirectory(fullPath)) { + removeRedundantEntries(createdFilesList); + } + } + } + } + + // Check if max event count exceeded after adding + if (isMaxEventCountExceeded()) { + flushCollectedEvents(); + Q_EMIT q_ptr->maxEventCountReached(maxEvents); + } +} + +void FSEventCollectorPrivate::handleFileDeleted(const QString &path, const QString &name) +{ + QString fullPath = normalizePath(path, name); + + // Skip if max event count exceeded + if (isMaxEventCountExceeded()) { + return; + } + + // Logic for handling file deletion: + // 1. If file was previously created, remove from created list (deletion cancels creation) + // 2. If file was previously modified, remove from modified list (deletion supersedes modification) + // 3. Otherwise, add to deleted list + if (createdFilesList.contains(fullPath)) { + createdFilesList.remove(fullPath); + qDebug() << "FSEventCollector: Removed from created list due to deletion:" << fullPath; + if (shouldTrackPath(fullPath)) { + deletedFilesList.insert(fullPath); + qDebug() << "FSEventCollector: Added to deleted list:" << fullPath; + } + } else { + if (modifiedFilesList.contains(fullPath)) { + modifiedFilesList.remove(fullPath); + qDebug() << "FSEventCollector: Removed from modified list due to deletion:" << fullPath; + } + + if (shouldTrackPath(fullPath)) { + deletedFilesList.insert(fullPath); + qDebug() << "FSEventCollector: Added to deleted list:" << fullPath; + } + } + + // Check if max event count exceeded after adding + if (isMaxEventCountExceeded()) { + flushCollectedEvents(); + Q_EMIT q_ptr->maxEventCountReached(maxEvents); + } +} + +void FSEventCollectorPrivate::handleFileClosed(const QString &path, const QString &name) +{ + QString fullPath = normalizePath(path, name); + + // Skip if max event count exceeded + if (isMaxEventCountExceeded()) { + return; + } + + // Logic for handling file modification: + // 1. If file was previously created, don't add to modified (creation includes latest content) + // 2. If file is in deleted list, ignore (deleted files can't be modified) + // 3. Otherwise, add to modified list + if (createdFilesList.contains(fullPath) || deletedFilesList.contains(fullPath)) { + // No need to track modifications for newly created or deleted files + qDebug() << "FSEventCollector: Ignored modification for created/deleted file:" << fullPath; + } else { + // For modified files, we only care about actual files, not directories + // So we don't need to check for parent directories or redundant entries + if (!isDirectory(fullPath) && !isChildOfAnyPath(fullPath, createdFilesList) && !isChildOfAnyPath(fullPath, deletedFilesList)) { + // Only insert if file has supported extension + if (shouldTrackPath(fullPath) && QFileInfo(fullPath).exists()) { + modifiedFilesList.insert(fullPath); + qDebug() << "FSEventCollector: Added to modified list:" << fullPath; + } + } + } + + // Check if max event count exceeded after adding + if (isMaxEventCountExceeded()) { + flushCollectedEvents(); + Q_EMIT q_ptr->maxEventCountReached(maxEvents); + } +} + +void FSEventCollectorPrivate::handleFileMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName) +{ + // Handle file moves as deletion from source and creation at destination + + // Special case: Move to outside monitored directory + if (toPath.isEmpty() && toName.isEmpty()) { + handleFileDeleted(fromPath, fromName); + return; + } + + // Special case: Move from outside monitored directory + if (fromPath.isEmpty() && fromName.isEmpty()) { + handleFileCreated(toPath, toName); + return; + } + + // Regular move within monitored directories - optimize for rename operations + QString fullFromPath = normalizePath(fromPath, fromName); + QString fullToPath = normalizePath(toPath, toName); + + // Skip if max event count exceeded + if (isMaxEventCountExceeded()) { + return; + } + + // Check if source and target files should be indexed based on file extensions + bool fromShouldIndex = shouldTrackPath(fullFromPath); + bool toShouldIndex = shouldTrackPath(fullToPath); + + // Scenario 1: Source file is indexed, target file is not (e.g., a.txt → a.abc) + // This happens when renaming to unsupported extension or moving to excluded location + // Action: Delete the index entry for source file + if (fromShouldIndex && !toShouldIndex) { + qDebug() << "FSEventCollector: File moved from indexed to non-indexed, treating as deletion:" + << fullFromPath << "->" << fullToPath; + handleFileDeleted(fromPath, fromName); + return; + } + + // Scenario 3: Neither source nor target should be indexed (e.g., a.abc → b.xyz) + // Action: Ignore this move operation + if (!fromShouldIndex && !toShouldIndex) { + qDebug() << "FSEventCollector: File moved between non-indexed files, ignoring:" + << fullFromPath << "->" << fullToPath; + return; + } + + // Scenario 2: Source file is not indexed, target file should be (e.g., a.abc → a.txt) + // This is handled by adding to movedFilesList, and later processFileMove will: + // - Detect source not in index + // - Check if target should be indexed + // - Create new index entry with content extraction + // Common case: Text editors save by writing temp file then renaming to target + + // Scenario 4: Both source and target should be indexed (e.g., a.txt → b.txt) + // This is the normal rename/move case, handled by updating index path + + // Check if this is a move that conflicts with existing operations + bool hasConflict = false; + + // If the source was in created list, remove it and treat as a pure creation at new location + if (createdFilesList.contains(fullFromPath)) { + createdFilesList.remove(fullFromPath); + if (toShouldIndex) { + createdFilesList.insert(fullToPath); + qDebug() << "FSEventCollector: Converted move to creation, source was newly created:" << fullFromPath << "->" << fullToPath; + } + hasConflict = true; + } + + // If the source was in modified list, remove it since it's being moved + if (modifiedFilesList.contains(fullFromPath)) { + modifiedFilesList.remove(fullFromPath); + qDebug() << "FSEventCollector: Removed from modified list due to move:" << fullFromPath; + } + + // If destination already exists in any list, we have a conflict - fall back to delete+create + if (createdFilesList.contains(fullToPath) || deletedFilesList.contains(fullToPath) || modifiedFilesList.contains(fullToPath) || movedFilesList.contains(fullToPath)) { + qWarning() << "FSEventCollector: Move conflict detected, falling back to delete+create:" << fullFromPath << "->" << fullToPath; + handleFileDeleted(fromPath, fromName); + handleFileCreated(toPath, toName); + return; + } + + // If no conflicts, track as a move operation for efficient index update + if (!hasConflict) { + movedFilesList.insert(fullFromPath, fullToPath); + qDebug() << "FSEventCollector: Added to moved list:" << fullFromPath << "->" << fullToPath; + + // Check if max event count exceeded after adding + if (isMaxEventCountExceeded()) { + flushCollectedEvents(); + Q_EMIT q_ptr->maxEventCountReached(maxEvents); + } + } +} + +void FSEventCollectorPrivate::handleDirectoryCreated(const QString &path, const QString &name) +{ + QString fullPath = normalizePath(path, name); + deletedDirectoriesMarker.remove(fullPath); + deletedFilesList.remove(fullPath); + // Known directory: pre-seed the cache so isDirectory() never re-stats. + directoryHintCache.insert(fullPath, true); + handleFileCreated(path, name); +} + +void FSEventCollectorPrivate::handleDirectoryDeleted(const QString &path, const QString &name) +{ + QString fullPath = normalizePath(path, name); + // The entry is gone (or about to be); drop any stale dir-ness. + directoryHintCache.remove(fullPath); + + // Mark as directory + deletedDirectoriesMarker.insert(fullPath); + + // Add to deleted list + deletedFilesList.insert(fullPath); +} + +void FSEventCollectorPrivate::handleDirectoryMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName) +{ + // Special case: Move to outside monitored directory + if (toPath.isEmpty() && toName.isEmpty()) { + handleDirectoryDeleted(fromPath, fromName); + return; + } + + // Special case: Move from outside monitored directory + if (fromPath.isEmpty() && fromName.isEmpty()) { + handleDirectoryCreated(toPath, toName); + return; + } + + // Regular move within monitored directories + directoryHintCache.insert(normalizePath(toPath, toName), true); + directoryHintCache.remove(normalizePath(fromPath, fromName)); + handleFileMoved(fromPath, fromName, toPath, toName); +} + +void FSEventCollectorPrivate::flushCollectedEvents() +{ + // First, clean up redundant entries in all lists + cleanupRedundantEntries(); + + // Prepare the lists of events to emit + QStringList created = createdFilesList.values(); + QStringList deleted = deletedFilesList.values(); + QStringList modified = modifiedFilesList.values(); + QHash moved = movedFilesList; + + // Clear the internal sets for next collection period + createdFilesList.clear(); + deletedFilesList.clear(); + modifiedFilesList.clear(); + movedFilesList.clear(); + deletedDirectoriesMarker.clear(); + directoryHintCache.clear(); + + // Log statistics + qDebug() << "FSEventCollector: Flushing events - Created:" << created.size() + << "Deleted:" << deleted.size() + << "Modified:" << modified.size() + << "Moved:" << moved.size(); + + // Emit signals with collected events (only if not empty) + if (!created.isEmpty()) { + Q_EMIT q_ptr->filesCreated(created); + } + + if (!deleted.isEmpty()) { + Q_EMIT q_ptr->filesDeleted(deleted); + } + + if (!modified.isEmpty()) { + Q_EMIT q_ptr->filesModified(modified); + } + + if (!moved.isEmpty()) { + Q_EMIT q_ptr->filesMoved(moved); + } + + Q_EMIT q_ptr->flushFinished(); +} + +void FSEventCollectorPrivate::removeRedundantEntries(QSet &filesList) +{ + QSet directoryPaths; + QSet filePaths; + + // First, separate directories from files + for (const QString &path : filesList) { + if (isDirectory(path)) { + directoryPaths.insert(path); + } else { + filePaths.insert(path); + } + } + + // Remove any files that are under any of the directories + QSet redundantPaths; + for (const QString &filePath : filePaths) { + if (isChildOfAnyPath(filePath, directoryPaths)) { + redundantPaths.insert(filePath); + } + } + + // Remove redundant paths from the original list + for (const QString &path : redundantPaths) { + filesList.remove(path); + qDebug() << "FSEventCollector: Removed redundant entry, parent directory exists in list:" << path; + } +} + +bool FSEventCollectorPrivate::isChildOfAnyPath(const QString &path, const QSet &pathSet) const +{ + // Quick check for empty set + if (pathSet.isEmpty() || path.isEmpty()) { + return false; + } + + // For each potential parent directory in the set + for (const QString &potentialParent : pathSet) { + // Skip if the potential parent is not a directory + if (!isDirectory(potentialParent)) { + continue; + } + + // Check if path starts with potentialParent + "/" + // First, normalize both paths to ensure consistent comparison + QString normalizedPath = QDir::cleanPath(path); + QString normalizedParent = QDir::cleanPath(potentialParent); + + // Make sure the parent path ends with a separator + if (!normalizedParent.endsWith('/')) { + normalizedParent += '/'; + } + + // Path is a child if it starts with the parent path (including the trailing slash) + if (normalizedPath.startsWith(normalizedParent)) { + return true; + } + } + + return false; +} + +bool FSEventCollectorPrivate::isDirectory(const QString &path) const +{ + // Burst-path hot spot: called once per set entry per event. Cache within + // the collection window to avoid an O(n²) stat storm (see member docs). + auto it = directoryHintCache.find(path); + if (it != directoryHintCache.end()) { + return it.value(); + } + + QFileInfo fileInfo(path); + const bool isDir = fileInfo.isDir() && !fileInfo.isSymLink(); + directoryHintCache.insert(path, isDir); + return isDir; +} + +void FSEventCollectorPrivate::cleanupRedundantEntries() +{ + // Remove entries covered by deleted directories + removeEntriesCoveredByDirectories(); + + // Clean up each list separately + removeRedundantEntries(createdFilesList); + removeRedundantEntries(deletedFilesList); + + // For the modified list, we need to remove entries that: + // 1. Are under directories in the created list (creation supersedes modification) + // 2. Are under directories in the deleted list (deletion supersedes modification) + + // First, get all directory paths from created and deleted lists + QSet allDirectories; + for (const QString &path : std::as_const(createdFilesList)) { + if (isDirectory(path)) { + allDirectories.insert(path); + } + } + for (const QString &path : std::as_const(deletedFilesList)) { + if (isDirectory(path)) { + allDirectories.insert(path); + } + } + + // Remove any modified files that are under these directories + QSet redundantModified; + for (const QString &modifiedPath : std::as_const(modifiedFilesList)) { + if (isChildOfAnyPath(modifiedPath, allDirectories)) { + redundantModified.insert(modifiedPath); + qDebug() << "FSEventCollector: Removed redundant modified entry, parent directory in created/deleted lists:" << modifiedPath; + } + } + + // Remove the redundant entries + for (const QString &path : redundantModified) { + modifiedFilesList.remove(path); + } +} + +void FSEventCollectorPrivate::removeEntriesCoveredByDirectories() +{ + // Remove entries covered by deleted directories from all lists + for (const QString &dir : deletedDirectoriesMarker) { + // From deletedFilesList + QMutableSetIterator deletedIt(deletedFilesList); + while (deletedIt.hasNext()) { + const QString &path = deletedIt.next(); + if (path != dir && path.startsWith(dir + "/")) { + deletedIt.remove(); + } + } + + // From createdFilesList + QMutableSetIterator createdIt(createdFilesList); + while (createdIt.hasNext()) { + const QString &path = createdIt.next(); + if (path == dir || path.startsWith(dir + "/")) { + createdIt.remove(); + } + } + + // From modifiedFilesList + QMutableSetIterator modifiedIt(modifiedFilesList); + while (modifiedIt.hasNext()) { + const QString &path = modifiedIt.next(); + if (path == dir || path.startsWith(dir + "/")) { + modifiedIt.remove(); + } + } + } +} + +bool FSEventCollectorPrivate::isMaxEventCountExceeded() const +{ + int total = createdFilesList.size() + deletedFilesList.size() + modifiedFilesList.size() + movedFilesList.size(); + return total >= maxEvents; +} + +QString FSEventCollectorPrivate::normalizePath(const QString &dirPath, const QString &fileName) const +{ + if (dirPath.isEmpty()) { + return QString(); + } + + // Combine path components correctly handling trailing slash + return buildPath(dirPath, fileName); +} + +QString FSEventCollectorPrivate::buildPath(const QString &dirPath, const QString &fileName) const +{ + QDir dir(dirPath); + return dir.absoluteFilePath(fileName); +} + +// FSEventCollector implementation + +// Constructor with explicitly provided FSMonitor +FSEventCollector::FSEventCollector(PathPredicate pathPredicate, FSMonitor &monitor, QObject *parent) + : QObject(parent), d_ptr(new FSEventCollectorPrivate(this, std::move(pathPredicate), monitor)) +{ +} + +// Constructor with default FSMonitor (uses singleton instance) +FSEventCollector::FSEventCollector(PathPredicate pathPredicate, QObject *parent) + : QObject(parent), d_ptr(new FSEventCollectorPrivate(this, std::move(pathPredicate), FSMonitor::instance())) +{ +} + +FSEventCollector::~FSEventCollector() +{ + // The QScopedPointer will automatically call the destructor + // of FSEventCollectorPrivate, which stops collecting +} + +bool FSEventCollector::initialize(const QStringList &rootPaths) +{ + Q_D(FSEventCollector); + return d->init(rootPaths); +} + +bool FSEventCollector::start() +{ + Q_D(FSEventCollector); + return d->startCollecting(); +} + +void FSEventCollector::stop() +{ + Q_D(FSEventCollector); + d->stopCollecting(); +} + +bool FSEventCollector::isActive() const +{ + Q_D(const FSEventCollector); + return d->active; +} + +void FSEventCollector::setCollectionInterval(int seconds) +{ + Q_D(FSEventCollector); + + // Validate input + if (seconds <= 0) { + qWarning() << "FSEventCollector: Invalid collection interval:" << seconds << "seconds, must be positive"; + return; + } + + // Convert to milliseconds + d->collectionIntervalMs = seconds * 1000; + + // Restart timer if active + if (d->active && d->collectionTimer.isActive()) { + d->collectionTimer.stop(); + d->collectionTimer.start(d->collectionIntervalMs); + } + + qInfo() << "FSEventCollector: Collection interval set to" << seconds << "seconds"; +} + + +void FSEventCollector::setCollectionIntervalMs(int ms) +{ + Q_D(FSEventCollector); + + if (ms <= 0) { + qWarning() << "FSEventCollector: Invalid collection interval:" << ms << "ms, must be positive"; + return; + } + + d->collectionIntervalMs = ms; + + if (d->active && d->collectionTimer.isActive()) { + d->collectionTimer.stop(); + d->collectionTimer.start(d->collectionIntervalMs); + } + + qInfo() << "FSEventCollector: Collection interval set to" << ms << "ms"; +} + +int FSEventCollector::collectionInterval() const +{ + Q_D(const FSEventCollector); + return d->collectionIntervalMs / 1000; +} + +void FSEventCollector::setMaxEventCount(int count) +{ + Q_D(FSEventCollector); + + // Validate input + if (count <= 0) { + qWarning() << "FSEventCollector: Invalid max event count:" << count << ", must be positive"; + return; + } + + d->maxEvents = count; + qInfo() << "FSEventCollector: Max event count set to" << count; + + // Check if current count exceeds new max + if (d->isMaxEventCountExceeded()) { + d->flushCollectedEvents(); + Q_EMIT maxEventCountReached(count); + } +} + +int FSEventCollector::maxEventCount() const +{ + Q_D(const FSEventCollector); + return d->maxEvents; +} + +void FSEventCollector::flushEvents() +{ + Q_D(FSEventCollector); + d->flushCollectedEvents(); +} + +void FSEventCollector::clearEvents() +{ + Q_D(FSEventCollector); + + d->createdFilesList.clear(); + d->deletedFilesList.clear(); + d->modifiedFilesList.clear(); + d->movedFilesList.clear(); + d->deletedDirectoriesMarker.clear(); + d->directoryHintCache.clear(); + + qInfo() << "FSEventCollector: Cleared all collected events"; +} + +QStringList FSEventCollector::createdFiles() const +{ + Q_D(const FSEventCollector); + + return d->createdFilesList.values(); +} + +QStringList FSEventCollector::deletedFiles() const +{ + Q_D(const FSEventCollector); + + return d->deletedFilesList.values(); +} + +QStringList FSEventCollector::modifiedFiles() const +{ + Q_D(const FSEventCollector); + + return d->modifiedFilesList.values(); +} + +QHash FSEventCollector::movedFiles() const +{ + Q_D(const FSEventCollector); + + return d->movedFilesList; +} + +int FSEventCollector::createdFilesCount() const +{ + Q_D(const FSEventCollector); + + return d->createdFilesList.size(); +} + +int FSEventCollector::deletedFilesCount() const +{ + Q_D(const FSEventCollector); + + return d->deletedFilesList.size(); +} + +int FSEventCollector::modifiedFilesCount() const +{ + Q_D(const FSEventCollector); + + return d->modifiedFilesList.size(); +} + +int FSEventCollector::movedFilesCount() const +{ + Q_D(const FSEventCollector); + + return d->movedFilesList.size(); +} + +int FSEventCollector::totalEventsCount() const +{ + Q_D(const FSEventCollector); + + return d->createdFilesList.size() + d->deletedFilesList.size() + d->modifiedFilesList.size() + d->movedFilesList.size(); +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/fsmonitor/fseventcollector.h b/src/index/fsmonitor/fseventcollector.h new file mode 100644 index 00000000..efb8d6f4 --- /dev/null +++ b/src/index/fsmonitor/fseventcollector.h @@ -0,0 +1,124 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FSEVENTCOLLECTOR_H +#define FSEVENTCOLLECTOR_H + +#include "index_global.h" +#include "fsmonitor.h" + +#include +#include +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FSEventCollectorPrivate; + +// FSEventCollector: A file system event collector for batched processing +// Collects and aggregates events from FSMonitor over configurable time intervals +// Used to provide a lower-frequency source of filesystem events for indexing +// +// Features: +// - Batches file system events over configurable time periods +// - Smart event merging (e.g., create+delete cancels out both) +// - Categorizes events into created, deleted, and modified files +// - Limits maximum collection size to prevent resource exhaustion +// - Provides customizable collection intervals +class FSEventCollector : public QObject +{ + Q_OBJECT + Q_DISABLE_COPY_MOVE(FSEventCollector) + +public: + using PathPredicate = std::function; + + // Constructor with explicit FSMonitor reference + explicit FSEventCollector(PathPredicate pathPredicate, FSMonitor &monitor, QObject *parent = nullptr); + + // Constructor with default FSMonitor (uses FSMonitor::instance()) + explicit FSEventCollector(PathPredicate pathPredicate, QObject *parent = nullptr); + + ~FSEventCollector() override; + + // Initialize the collector with monitor root paths + bool initialize(const QStringList &rootPaths); + + // Start collecting events + bool start(); + + // Stop collecting events + void stop(); + + // Check if collector is active + bool isActive() const; + + // Set collection interval in seconds (default: 180 seconds) + void setCollectionInterval(int seconds); + + // Set collection interval directly in milliseconds + void setCollectionIntervalMs(int ms); + + // Get current collection interval in seconds + int collectionInterval() const; + + // Set maximum number of events to collect before auto-flush (default: 10000) + void setMaxEventCount(int count); + + // Get current maximum event count + int maxEventCount() const; + + // Manually flush collected events (emits signals and clears cache) + void flushEvents(); + + // Clear all cached events without emitting signals + void clearEvents(); + + // Get current lists of collected events + QStringList createdFiles() const; + QStringList deletedFiles() const; + QStringList modifiedFiles() const; + + // Get current moved files mapping (fromPath -> toPath) + QHash movedFiles() const; + + // Get current count of collected events + int createdFilesCount() const; + int deletedFilesCount() const; + int modifiedFilesCount() const; + int totalEventsCount() const; + + // Get count of moved files + int movedFilesCount() const; + +Q_SIGNALS: + // Emitted when collection interval expires with batched events + void filesCreated(const QStringList &paths); + void filesDeleted(const QStringList &paths); + void filesModified(const QStringList &paths); + + // Emitted when files/directories are moved/renamed (fromPath -> toPath mapping) + void filesMoved(const QHash &movedPaths); + + void flushFinished(); + + // Emitted when maximum event count is reached + void maxEventCountReached(int count); + + // Emitted when an error occurs + void errorOccurred(const QString &errorMessage); + +private: + // Private implementation + QScopedPointer d_ptr; + Q_DECLARE_PRIVATE(FSEventCollector) +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FSEVENTCOLLECTOR_H diff --git a/src/index/fsmonitor/fseventcollector_p.h b/src/index/fsmonitor/fseventcollector_p.h new file mode 100644 index 00000000..81e2f944 --- /dev/null +++ b/src/index/fsmonitor/fseventcollector_p.h @@ -0,0 +1,128 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FSEVENTCOLLECTOR_P_H +#define FSEVENTCOLLECTOR_P_H + +#include "fseventcollector.h" + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FSEventCollectorPrivate +{ +public: + FSEventCollectorPrivate(FSEventCollector *qq, FSEventCollector::PathPredicate pathPredicate, FSMonitor &monitor); + ~FSEventCollectorPrivate(); + + // Initialize the collector with monitor root path + bool init(const QStringList &rootPaths); + + // Start collecting events + bool startCollecting(); + + // Stop collecting events + void stopCollecting(); + + // Process file created event + void handleFileCreated(const QString &path, const QString &name); + + // Process file deleted event + void handleFileDeleted(const QString &path, const QString &name); + + // Process file closed (write completed) event + void handleFileClosed(const QString &path, const QString &name); + + // Process file moved event + void handleFileMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + + // Process directory created event + void handleDirectoryCreated(const QString &path, const QString &name); + + // Process directory deleted event + void handleDirectoryDeleted(const QString &path, const QString &name); + + // Process directory moved event + void handleDirectoryMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + + // Flush collected events (emit signals and clear) + void flushCollectedEvents(); + + // Check if max event count exceeded + bool isMaxEventCountExceeded() const; + + // Remove redundant file entries that are under directories already in the list + void removeRedundantEntries(QSet &filesList); + + // Check if a path is a child of any path in the given set + bool isChildOfAnyPath(const QString &path, const QSet &pathSet) const; + + // Check if path is a directory + bool isDirectory(const QString &path) const; + + // Remove redundant entries from all event lists + void cleanupRedundantEntries(); + + // Remove entries covered by deleted directories + void removeEntriesCoveredByDirectories(); + + // Check if a path should be tracked by the current runtime predicate. + bool shouldTrackPath(const QString &path) const; + + // Normalize path for consistent handling + QString normalizePath(const QString &dirPath, const QString &fileName) const; + + // Build full path from components + QString buildPath(const QString &dirPath, const QString &fileName) const; + + // Data members + FSEventCollector *q_ptr; + + // The FSMonitor reference (no longer a singleton) + FSMonitor &fsMonitor; + FSEventCollector::PathPredicate pathPredicate; + + // Collection timer + QTimer collectionTimer; + + // Collection interval in milliseconds (default: 180000ms = 3 minutes) + int collectionIntervalMs { 180000 }; + + // Root paths being monitored + QStringList rootPaths; + + // Maximum event count before auto-flush (default: 10000) + int maxEvents { 10000 }; + + // Active state + bool active { false }; + bool monitoringLeaseAcquired { false }; + + QSet createdFilesList; + QSet deletedFilesList; + QSet modifiedFilesList; + + // New: Track moved/renamed files separately for efficient index updates + QHash movedFilesList; // fromPath -> toPath mapping + + // Marker for deleted directories + QSet deletedDirectoriesMarker; + + // Per-window cache for isDirectory() lookups. During a burst every event + // scans the current set (isChildOfAnyPath) with one stat per entry — an + // O(n²) syscall storm that can starve the home thread and back up the + // whole event pipeline. Dir-ness is stable within a collection window; + // the cache is cleared on every flush. + mutable QHash directoryHintCache; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FSEVENTCOLLECTOR_P_H diff --git a/src/index/fsmonitor/fseventcontroller.cpp b/src/index/fsmonitor/fseventcontroller.cpp new file mode 100644 index 00000000..dcf2ea87 --- /dev/null +++ b/src/index/fsmonitor/fseventcontroller.cpp @@ -0,0 +1,385 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#include "fseventcontroller.h" + +#include "utils/pathexcludematcher.h" +#include "utils/textindexconfig.h" + +#include + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +// Debounce window for lost-event recovery so a storm of disconnects or +// overflow reports coalesces into a single compensating update task. +constexpr int kEventsRecoveryDebounceMs = 5000; + +} + +FSEventController::FSEventController(IndexProfile profile, QObject *parent) + : QObject { parent }, + m_profile(std::move(profile)) +{ +} + +void FSEventController::setupFSEventCollector() +{ + // Per-runtime blacklist matcher: + // - profile 提供黑名单（filename: anything blacklist + 索引目录 + .avfs，死循环防护） + // - 未提供时沿用全局匹配器（Content/Ocr: TextIndexConfig folderExcludeFilters + // + anything blacklist，保持现有行为不变） + std::shared_ptr filterMatcher; + const auto &filterPolicy = m_profile.filterPolicy(); + if (filterPolicy.blacklistProvider) { + filterMatcher = std::make_shared(filterPolicy.blacklistProvider()); + } else { + filterMatcher = std::make_shared(PathExcludeMatcher::createForIndex()); + } + + m_fsEventCollector = std::make_unique( + [this, filterMatcher](const QString &path) { + // Per-profile symlink policy: link 条目仅 filename profile 收录 + // （FSMonitor 事件分发已放行 symlink，这里按策略拦截，Content/Ocr + // 行为保持不变——symlink 事件照旧被丢弃） + if (!m_profile.filterPolicy().indexSymlinks && QFileInfo(path).isSymLink()) + return false; + + if (!m_profile.isCandidateFile(path)) + return false; + + // Per-profile hidden file filtering：三类入口（全盘遍历/增量路径列表/ + // 事件谓词）共用 IndexProfile::shouldSkipHiddenEntry，保证判定一致—— + // Content/Ocr 丢弃所有隐藏条目事件；filename 丢弃屏蔽策略命中的 + // 条目事件（默认主目录下的隐藏条目） + if (m_profile.shouldSkipHiddenEntry(QFileInfo(path).absoluteFilePath())) + return false; + + // Per-profile blacklist filtering + if (filterMatcher->shouldExclude(path)) + return false; + + return true; + }, + this); + + // Use runtime policy interval if specified, otherwise fall back to config + const auto &rp = m_profile.runtimePolicy(); + if (rp.eventCollectionWindowMs > 0) { + m_fsEventCollector->setCollectionIntervalMs(rp.eventCollectionWindowMs); + } else { + m_collectorIntervalSecs = TextIndexConfig::instance().autoIndexUpdateInterval(); + m_fsEventCollector->setCollectionInterval(m_collectorIntervalSecs); + } + m_fsEventCollector->setMaxEventCount(10000); // Default 10k events + + // Silent start delay: profile-specific recovery delay takes precedence + // (filename: 30s to shorten the updateInProgress degraded-search window), + // otherwise fall back to the global config (Content/Ocr, default 180s). + if (rp.recoveryUpdateDelayMs > 0) { + m_silentStartDelayMs = rp.recoveryUpdateDelayMs; + } else { + m_silentStartDelayMs = TextIndexConfig::instance().silentIndexUpdateDelay() * 1000; + } + + connect(m_fsEventCollector.get(), &FSEventCollector::filesCreated, + this, &FSEventController::onFilesCreated); + connect(m_fsEventCollector.get(), &FSEventCollector::filesDeleted, + this, &FSEventController::onFilesDeleted); + connect(m_fsEventCollector.get(), &FSEventCollector::filesModified, + this, &FSEventController::onFilesModified); + connect(m_fsEventCollector.get(), &FSEventCollector::filesMoved, + this, &FSEventController::onFilesMoved); + connect(m_fsEventCollector.get(), &FSEventCollector::flushFinished, + this, &FSEventController::onFlushFinished); + + // Connect to configuration changes to dynamically update collection interval + connect(&TextIndexConfig::instance(), &TextIndexConfig::configChanged, + this, &FSEventController::onConfigChanged); + + // Create separate timers for monitoring start and silent start + m_monitoringStartTimer = new QTimer(this); + m_silentStartTimer = new QTimer(this); + m_stopTimer = new QTimer(this); + m_monitoringStartTimer->setSingleShot(true); + m_silentStartTimer->setSingleShot(true); + m_stopTimer->setSingleShot(true); + + // Lost-event recovery: debounce repeated eventsLost notifications, then + // ask the runtimes to schedule a compensating full update task. + m_recoveryTimer = new QTimer(this); + m_recoveryTimer->setSingleShot(true); + m_recoveryTimer->setInterval(kEventsRecoveryDebounceMs); + connect(m_recoveryTimer, &QTimer::timeout, this, [this]() { + if (!m_enabled) { + return; + } + + qInfo() << "FSEventController: requesting events recovery update"; + emit requestEventsRecovery(); + }); + + connect(&FSMonitor::instance(), &FSMonitor::eventsLost, + this, &FSEventController::onEventsLost); + + // Monitoring start timer - only responsible for starting monitoring + connect(m_monitoringStartTimer, &QTimer::timeout, this, [this]() { + if (!m_enabled) { + qWarning() << "Cannot start monitor, enabled state has been changed"; + return; + } + emit monitoring(true); + }); + + // Silent start timer - only responsible for requesting silent start + connect(m_silentStartTimer, &QTimer::timeout, this, [this]() { + if (!m_enabled) { + qWarning() << "Cannot trigger silent start, enabled state has been changed"; + return; + } + emit requestSilentStart(); + }); + + connect(m_stopTimer, &QTimer::timeout, this, [this]() { + if (m_enabled) { + qWarning() << "Cannot stop monitor, enabled state has been changed"; + return; + } + emit monitoring(false); + }); +} + +bool FSEventController::isEnabled() const +{ + return m_enabled; +} + +void FSEventController::setEnabled(bool enabled) +{ + m_enabled = enabled; + + qInfo() << "FSEventController: Enabled state changed to:" << m_enabled; + if (m_enabled) { + m_stopTimer->stop(); + + // Always start monitoring immediately — no artificial delay. + m_monitoringStartTimer->start(0); + + // On first start (silentlyRefreshStarted), schedule a delayed + // silent index update to avoid heavy I/O during system boot. + if (silentlyRefreshStarted()) { + m_silentStartTimer->start(m_silentStartDelayMs); + setSilentlyRefreshStarted(false); + } + } else { + m_monitoringStartTimer->stop(); + m_silentStartTimer->stop(); + // 停止监控将清除所有的监控目录，重建需要极大的开销，因此延迟清理资源 + m_stopTimer->start(TextIndexConfig::instance().inotifyResourceCleanupDelayMs()); + } +} + +void FSEventController::setEnabledNow(bool enabled) +{ + if (enabled) { + setEnabled(enabled); + } else { + m_enabled = false; + stopFSMonitoring(); + } +} + +void FSEventController::startFSMonitoring() +{ + if (!m_fsEventCollector) { + qWarning() << "FSEventController: Cannot start monitoring, FSEventCollector not initialized"; + return; + } + + if (m_fsEventCollector->isActive()) { + qInfo() << "FSEventController: FS monitoring already active"; + return; + } + + // Initialize with default indexed directories + QStringList indexedDirs = DFMSEARCH::Global::defaultIndexedDirectory(); + if (indexedDirs.isEmpty()) { + qWarning() << "FSEventController: No default indexed directories found"; + return; + } + + bool success = m_fsEventCollector->initialize(indexedDirs); + if (!success) { + qWarning() << "FSEventController: Failed to initialize FSEventCollector"; + return; + } + + // Clear any previously collected events + clearCollections(); + + // Start the collector + success = m_fsEventCollector->start(); + if (!success) { + qWarning() << "FSEventController: Failed to start FSEventCollector"; + return; + } + + qInfo() << "FSEventController: FS monitoring started successfully with" << indexedDirs.size() << "directories"; +} + +void FSEventController::stopFSMonitoring() +{ + if (!m_fsEventCollector || !m_fsEventCollector->isActive()) { + return; + } + + m_fsEventCollector->stop(); + + // Clear any collected events + clearCollections(); + + qInfo() << "FSEventController: FS monitoring stopped"; +} + +void FSEventController::setSilentlyRefreshStarted(bool flag) +{ + m_silentlyFlag = flag; +} + +bool FSEventController::silentlyRefreshStarted() const +{ + return m_silentlyFlag; +} + +void FSEventController::onFilesCreated(const QStringList &paths) +{ + if (!m_enabled) { + return; + } + + qDebug() << "FSEventController: Files created event -" << paths.size() << "items"; + m_collectedCreatedFiles.append(paths); +} + +void FSEventController::onFilesDeleted(const QStringList &paths) +{ + if (!m_enabled) { + return; + } + + qDebug() << "FSEventController: Files deleted event -" << paths.size() << "items"; + m_collectedDeletedFiles.append(paths); +} + +void FSEventController::onFilesModified(const QStringList &paths) +{ + if (!m_enabled) { + return; + } + + qDebug() << "FSEventController: Files modified event -" << paths.size() << "items"; + m_collectedModifiedFiles.append(paths); +} + +void FSEventController::onFilesMoved(const QHash &movedPaths) +{ + if (!m_enabled) { + return; + } + + qDebug() << "FSEventController: Files moved event -" << movedPaths.size() << "items"; + + // Merge the moved paths into our collection + for (auto it = movedPaths.constBegin(); it != movedPaths.constEnd(); ++it) { + m_collectedMovedFiles.insert(it.key(), it.value()); + } +} + +void FSEventController::onFlushFinished() +{ + if (!m_enabled) { + return; + } + + qDebug() << "FSEventController: Flush finished, processing events"; + + // Check if we have any events to process + if (m_collectedCreatedFiles.isEmpty() && m_collectedModifiedFiles.isEmpty() + && m_collectedDeletedFiles.isEmpty() && m_collectedMovedFiles.isEmpty()) { + qDebug() << "FSEventController: No file system events to process"; + return; + } + + qDebug() << "FSEventController: Processing file changes - Created:" << m_collectedCreatedFiles.size() + << "Modified:" << m_collectedModifiedFiles.size() + << "Deleted:" << m_collectedDeletedFiles.size() + << "Moved:" << m_collectedMovedFiles.size(); + + // Process file moves separately for optimization + if (!m_collectedMovedFiles.isEmpty()) { + emit requestProcessFileMoves(m_collectedMovedFiles); + } + + // Process regular file changes (create, modify, delete) + if (!m_collectedCreatedFiles.isEmpty() || !m_collectedModifiedFiles.isEmpty() || !m_collectedDeletedFiles.isEmpty()) { + emit requestProcessFileChanges(m_collectedCreatedFiles, m_collectedModifiedFiles, m_collectedDeletedFiles); + } + + clearCollections(); +} + +void FSEventController::clearCollections() +{ + m_collectedCreatedFiles.clear(); + m_collectedDeletedFiles.clear(); + m_collectedModifiedFiles.clear(); + m_collectedMovedFiles.clear(); +} + +void FSEventController::onEventsLost() +{ + if (!m_enabled) { + return; + } + + qWarning() << "FSEventController: filesystem events lost, scheduling recovery update"; + m_recoveryTimer->start(); +} + +void FSEventController::onConfigChanged() +{ + const int newIntervalSecs = TextIndexConfig::instance().autoIndexUpdateInterval(); + const int newSilentDelaySecs = TextIndexConfig::instance().silentIndexUpdateDelay(); + + // Update event collection interval for FSEventCollector + // Skip if profile uses a custom interval (runtime policy) + if (m_profile.runtimePolicy().eventCollectionWindowMs <= 0 && newIntervalSecs != m_collectorIntervalSecs) { + qInfo() << "FSEventController: Collection interval changed from" + << m_collectorIntervalSecs << "to" << newIntervalSecs << "seconds"; + + m_collectorIntervalSecs = newIntervalSecs; + + // Update the collector's interval if it exists + if (m_fsEventCollector) { + m_fsEventCollector->setCollectionInterval(m_collectorIntervalSecs); + qInfo() << "FSEventController: Updated FSEventCollector collection interval to" + << m_collectorIntervalSecs << "seconds"; + } + } + + // Update silent start delay for FSEventController + // Skip if profile uses a custom recovery delay (runtime policy) + if (m_profile.runtimePolicy().recoveryUpdateDelayMs <= 0 + && newSilentDelaySecs * 1000 != m_silentStartDelayMs) { + qInfo() << "FSEventController: Silent start delay changed from" + << m_silentStartDelayMs << "to" << newSilentDelaySecs * 1000 << "ms"; + m_silentStartDelayMs = newSilentDelaySecs * 1000; + } +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/fsmonitor/fseventcontroller.h b/src/index/fsmonitor/fseventcontroller.h new file mode 100644 index 00000000..46846037 --- /dev/null +++ b/src/index/fsmonitor/fseventcontroller.h @@ -0,0 +1,79 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#ifndef FSEVENTCONTROLLER_H +#define FSEVENTCONTROLLER_H + +#include "fseventcollector.h" +#include "profile/indexprofile.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FSEventController : public QObject +{ + Q_OBJECT +public: + explicit FSEventController(IndexProfile profile, QObject *parent = nullptr); + + void setupFSEventCollector(); + + bool isEnabled() const; + void setEnabled(bool enabled); + void setEnabledNow(bool enabled); + + void startFSMonitoring(); + void stopFSMonitoring(); + + void setSilentlyRefreshStarted(bool flag); + bool silentlyRefreshStarted() const; + +private Q_SLOTS: + void onFilesCreated(const QStringList &paths); + void onFilesDeleted(const QStringList &paths); + void onFilesModified(const QStringList &paths); + void onFilesMoved(const QHash &movedPaths); + void onFlushFinished(); + void onConfigChanged(); + void onEventsLost(); + +private: + void clearCollections(); + +Q_SIGNALS: + void requestProcessFileChanges(const QStringList &createdFiles, + const QStringList &modifiedFiles, + const QStringList &deletedFiles); + + void requestProcessFileMoves(const QHash &movedFiles); + + void monitoring(bool start); + void requestSilentStart(); + + // Emitted (debounced) after the monitor reported lost filesystem events; + // runtimes should schedule a full Create/Update task to re-sync. + void requestEventsRecovery(); + +private: + IndexProfile m_profile; + bool m_enabled { false }; + bool m_silentlyFlag { false }; + int m_collectorIntervalSecs { 3 }; // FSEventCollector event collection interval (seconds) + int m_silentStartDelayMs { 180000 }; // FSEventController silent start delay (ms) + std::unique_ptr m_fsEventCollector; + QTimer *m_monitoringStartTimer { nullptr }; + QTimer *m_silentStartTimer { nullptr }; + QTimer *m_stopTimer { nullptr }; + QTimer *m_recoveryTimer { nullptr }; + + // Collected file events + QStringList m_collectedCreatedFiles; + QStringList m_collectedDeletedFiles; + QStringList m_collectedModifiedFiles; + QHash m_collectedMovedFiles; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FSEVENTCONTROLLER_H diff --git a/src/index/fsmonitor/fsmonitor.cpp b/src/index/fsmonitor/fsmonitor.cpp new file mode 100644 index 00000000..e0ab11ac --- /dev/null +++ b/src/index/fsmonitor/fsmonitor.cpp @@ -0,0 +1,753 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "fsmonitor_p.h" +#include "utils/textindexconfig.h" + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +ANYTHING_INDEX_BEGIN_NAMESPACE + +// Example: +// void testMonitor() +// { +// FSMonitor::instance().setMaxResourceUsage(0.6); + +// connect(&FSMonitor::instance(), &FSMonitor::fileCreated, this, [](const QString &path, const QString &name) { +// qDebug() << "File created:" << path << "/" << name; +// }); +// connect(&FSMonitor::instance(), &FSMonitor::fileDeleted, this, [](const QString &path, const QString &name) { +// qDebug() << "File deleted:" << path << "/" << name; +// }); +// connect(&FSMonitor::instance(), &FSMonitor::fileClosed, this, [](const QString &path, const QString &name) { +// qDebug() << "File closed:" << path << "/" << name; +// }); +// connect(&FSMonitor::instance(), &FSMonitor::fileMoved, this, [](const QString &fromPath, const QString &fromName, const QString &toPath, const QString &toName) { +// qDebug() << "File moved:" +// << fromPath << "/" << fromName +// << "->" +// << toPath << "/" << toName; +// }); +// connect(&FSMonitor::instance(), &FSMonitor::directoryCreated, this, [](const QString &path, const QString &name) { +// qDebug() << "File created:" << path << "/" << name; +// }); +// connect(&FSMonitor::instance(), &FSMonitor::directoryDeleted, this, [](const QString &path, const QString &name) { +// qDebug() << "File deleted:" << path << "/" << name; +// }); +// connect(&FSMonitor::instance(), &FSMonitor::directoryMoved, this, [](const QString &fromPath, const QString &fromName, const QString &toPath, const QString &toName) { +// qDebug() << "File moved:" +// << fromPath << "/" << fromName +// << "->" +// << toPath << "/" << toName; +// }); + +// if (FSMonitor::instance().initialize("/home/zhangs/Videos")) { +// if (FSMonitor::instance().start()) { +// qDebug() << "File monitoring started successfully"; +// qDebug() << "Max watches available:" << FSMonitor::instance().maxAvailableWatchCount(); +// qDebug() << "Current usage limit:" << FSMonitor::instance().maxResourceUsage() * 100 << "%"; +// } else { +// qWarning() << "Failed to start file monitoring"; +// } +// } else { +// qWarning() << "Failed to initialize FSMonitor"; +// } +// } + +FSMonitorPrivate::FSMonitorPrivate(FSMonitor *qq) + : q_ptr(qq) +{ + // Setup worker thread + setupWorkerThread(); +} + +FSMonitorPrivate::~FSMonitorPrivate() +{ + stopMonitoring(); + + // Clean up worker thread + if (workerThread.isRunning()) { + workerThread.quit(); + workerThread.wait(); + } +} + +bool FSMonitorPrivate::init(const QStringList &rootPaths) +{ + // Initialize with root paths and create the watcher + this->rootPaths.clear(); + for (const QString &path : rootPaths) { + QString absPath = QDir(path).absolutePath(); + if (QDir(absPath).exists()) { + this->rootPaths.append(absPath); + } else { + qWarning() << "FSMonitor: Root path does not exist:" << absPath; + } + } + + if (this->rootPaths.isEmpty()) { + qWarning() << "FSMonitor: No valid root paths provided for initialization"; + return false; + } + + // Use static factory method to create configured blacklist matcher + // BEFORE creating VfsMonitor watcher (needs it for excludePredicate). + // 该 matcher 仅用于 inotify watch 的建立与 worker 目录遍历（并集黑名单： + // Content/Ocr 的 TextIndexConfig+anything 黑名单 + filename 的索引目录）， + // 不用于 VfsMonitor 事件过滤——事件分发保持仅结构性过滤（符号链接+rootPaths）， + // 策略性过滤由各 runtime 的 FSEventCollector::shouldTrackPath() 完成。 + excludeMatcher = PathExcludeMatcher::createForIndex(); + excludeMatcher.addPattern(DFMSEARCH::Global::fileNameIndexDirectory()); + excludeMatcher.addPattern(DFMSEARCH::Global::contentIndexDirectory()); + excludeMatcher.addPattern(DFMSEARCH::Global::ocrTextIndexDirectory()); + excludeMatcher.addPattern(QStringLiteral(".avfs")); + + // Try to create VfsMonitorFileSystemWatcher for global file system events. + // Pass shouldExcludePath as the exclude predicate so filtering happens + // before any socket-delivered events are emitted. + vfsWatcher.reset(VfsMonitorFileSystemWatcher::create( + this->rootPaths, + [this](const QString &path) { return shouldExcludePath(path); }, + q_ptr)); + vfsMonitorAvailable = (vfsWatcher != nullptr); + + if (vfsMonitorAvailable) { + // VfsMonitor handles all events including ACT_CLOSE_WRITE_FILE, + // so InotifyFileSystemWatcher is not needed. + setupVfsMonitorConnections(); + qInfo() << "FSMonitor: Using vfs monitor mode (deepin-anything dispatcher)"; + } else { + // Inotify-only mode: create InotifyFileSystemWatcher for all events. + watcher.reset(new InotifyFileSystemWatcher()); + setupWatcherConnections(); + qInfo() << "FSMonitor: Using inotify-only mode (deepin-anything dispatcher not available)"; + } + + qDebug() << "FSMonitor: Initialized with" << excludeMatcher.patternCount() + << "blacklist patterns"; + + // Configure worker with exclusion logic: + // 结构性过滤（符号链接，绝不遍历进 link——防索引环）+ 并集黑名单 + //（不为黑名单/索引目录建立 inotify watch） + worker->setExclusionChecker([this](const QString &path) { + return shouldExcludePath(path) || isSymbolicLink(path) || excludeMatcher.shouldExclude(path); + }); + worker->setMaxFastScanResults(getMaxUserWatches()); + + qInfo() << "FSMonitor: Initialized successfully with" << this->rootPaths.size() << "root paths"; + return true; +} + +bool FSMonitorPrivate::startMonitoring() +{ + if (active) { + qInfo() << "FSMonitor: Monitoring already active, ignoring start request"; + return true; + } + + // Determine system limits for inotify watches + maxWatches = getMaxUserWatches(); + if (maxWatches <= 0) { + qWarning() << "FSMonitor: Failed to determine system max watches, using default of 8192"; + maxWatches = 8192; + } + + // Start monitoring + active = true; + watchedDirectories.clear(); + + if (vfsMonitorAvailable) { + qInfo() << "FSMonitor: VfsMonitor active, skipping inotify directory watch setup"; + qInfo() << "FSMonitor: Started monitoring with max watches:" << maxWatches + << "usage limit:" << (maxUsagePercentage * 100) << "%"; + return true; + } + + // Start worker thread + if (!workerThread.isRunning()) { + workerThread.start(); + } + + // Try fast directory scan first if enabled + if (useFastScan) { + qInfo() << "FSMonitor: Attempting fast directory scan"; + QMetaObject::invokeMethod(worker, "tryFastDirectoryScan", + Qt::QueuedConnection); + } else { + travelRootDirectories(); + } + + qInfo() << "FSMonitor: Started monitoring with max watches:" << maxWatches + << "usage limit:" << (maxUsagePercentage * 100) << "%"; + + return true; +} + +void FSMonitorPrivate::stopMonitoring() +{ + if (!active) { + return; + } + + active = false; + + // Clear all watched directories + if (!watchedDirectories.isEmpty() && watcher) { + watcher->removePaths(watchedDirectories.values()); + watchedDirectories.clear(); + } + + qInfo() << "FSMonitor: Stopped all monitoring"; +} + +void FSMonitorPrivate::travelRootDirectories() +{ + // Process the root directories using traditional method + // If fast scan succeeds, this will complement any directories + // that might have been missed. If fast scan fails, this ensures + // we still monitor everything. + for (const QString &dir : std::as_const(rootPaths)) { + QMetaObject::invokeMethod(worker, "processDirectory", + Qt::QueuedConnection, + Q_ARG(QString, dir)); + } +} + +void FSMonitorPrivate::setupWorkerThread() +{ + // Create worker and move to thread + worker = new FSMonitorWorker(); + worker->moveToThread(&workerThread); + + // Connect thread finished signal to clean up worker + QObject::connect(&workerThread, &QThread::finished, worker, &QObject::deleteLater); + + // Connect worker signals + QObject::connect( + worker, &FSMonitorWorker::directoryToWatch, + q_ptr, [this](const QString &path) { + addWatchForDirectory(path); + }, + Qt::QueuedConnection); + + QObject::connect( + worker, &FSMonitorWorker::subdirectoriesFound, + q_ptr, [this](const QStringList &directories) { + if (!active) { + return; + } + + // Process each subdirectory + for (const QString &dir : directories) { + if (active) { + QMetaObject::invokeMethod(worker, "processDirectory", + Qt::QueuedConnection, + Q_ARG(QString, dir)); + } else { + break; + } + } + }, + Qt::QueuedConnection); + + // Connect fast scan related signals + QObject::connect( + worker, &FSMonitorWorker::fastScanCompleted, + q_ptr, [this](bool success) { + handleFastScanCompleted(success); + }, + Qt::QueuedConnection); + + QObject::connect( + worker, &FSMonitorWorker::directoriesBatchToWatch, + q_ptr, [this](const QStringList &paths) { + handleDirectoriesBatch(paths); + }, + Qt::QueuedConnection); +} + +void FSMonitorPrivate::addDirectoryRecursively(const QString &path) +{ + if (!active || path.isEmpty()) { + return; + } + + // Queue the directory for processing + QMetaObject::invokeMethod(worker, "processDirectory", + Qt::QueuedConnection, + Q_ARG(QString, path)); +} + +int FSMonitorPrivate::getMaxUserWatches() const +{ + int maxWatches = -1; + + // Try to read the system limit from /proc + QFile file("/proc/sys/fs/inotify/max_user_watches"); + if (file.open(QIODevice::ReadOnly | QIODevice::Text)) { + QTextStream in(&file); + bool ok = false; + maxWatches = in.readLine().trimmed().toInt(&ok); + if (!ok) { + maxWatches = -1; + } + file.close(); + } + + return maxWatches; +} + +bool FSMonitorPrivate::shouldExcludePath(const QString &path) const +{ + // Skip empty paths + if (path.isEmpty()) { + return true; + } + + // 符号链接事件不再在此排除：link 条目本身是合法的索引条目（filename + // profile 按链接自身路径建档，见 FilterPolicy::indexSymlinks），是否收录 + // 由各 runtime 的 pathPredicate 决定。watch/worker 范围（addWatchForDirectory、 + // exclusionChecker）仍显式排除 symlink——绝不监控/遍历 link 内部，防索引环。 + + // Hidden file and blacklist filtering moved to per-runtime pathPredicate + // in FSEventController::setupFSEventCollector() to support per-profile policies. + + // 以下判断严重影响性能，如无问题反馈则屏蔽 + // // Check if path is on external mount + // // Note: Block devices allowed to be mounted via udisks + // if (!DevProxyMng->isFileOfExternalBlockMounts(path) && isExternalMount(path)) { + // qDebug() << "FSMonitor: Excluding external mount:" << path; + // return true; + // } + + return false; +} + +bool FSMonitorPrivate::isSymbolicLink(const QString &path) const +{ + // Skip empty paths + if (path.isEmpty()) { + return false; + } + + QFileInfo fileInfo(path); + return fileInfo.isSymLink(); +} + +bool FSMonitorPrivate::showHidden() const +{ + return TextIndexConfig::instance().indexHiddenFiles(); +} + +bool FSMonitorPrivate::addWatchForDirectory(const QString &path) +{ + // Skip if path is empty, structurally excluded, a symlink (绝不监控 link + // 内部——防索引环), or in the union blacklist (union of all active + // runtimes' blacklists incl. index directories — only controls watch + // resources, event dispatch is unaffected) + if (path.isEmpty() || isSymbolicLink(path) || shouldExcludePath(path) + || excludeMatcher.shouldExclude(path)) { + return false; + } + + if (watchedDirectories.contains(path)) { + return true; // Already watching + } + + // Check if we're within watch limits + if (!isWithinWatchLimit()) { + qWarning() << "FSMonitor: Watch limit reached (" << watchedDirectories.size() + << "/" << maxWatches << "), cannot add directory:" << path; + Q_EMIT q_ptr->resourceLimitReached(watchedDirectories.size(), maxWatches); + return false; + } + + // Add to watcher + if (watcher && watcher->addPath(path)) { + watchedDirectories.insert(path); + // qDebug() << "FSMonitor: Added watch for directory:" << path; + return true; + } + + qWarning() << "FSMonitor: Failed to add watch for directory:" << path; + return false; +} + +void FSMonitorPrivate::removeWatchForDirectory(const QString &path) +{ + if (path.isEmpty()) { + return; + } + + if (watchedDirectories.contains(path)) { + if (watcher) + watcher->removePath(path); + watchedDirectories.remove(path); + qDebug() << "FSMonitor: Removed watch for directory:" << path; + } +} + +bool FSMonitorPrivate::isWithinWatchLimit() const +{ + if (maxWatches <= 0) { + return true; // No limit determined, assume it's fine + } + + int maxAllowed = qFloor(maxWatches * maxUsagePercentage); + return watchedDirectories.size() < maxAllowed; +} + +void FSMonitorPrivate::setupWatcherConnections() +{ + // Connect file events from InotifyFileSystemWatcher + QObject::connect(watcher.data(), &InotifyFileSystemWatcher::fileCreated, + q_ptr, [this](const QString &path, const QString &name) { + handleFileCreated(path, name); + }); + + QObject::connect(watcher.data(), &InotifyFileSystemWatcher::fileDeleted, + q_ptr, [this](const QString &path, const QString &name) { + handleFileDeleted(path, name); + }); + + // Use fileClosed (IN_CLOSE_WRITE) instead of fileModified (IN_MODIFY) + // to avoid high-frequency signals during large file copies + QObject::connect(watcher.data(), &InotifyFileSystemWatcher::fileClosed, + q_ptr, [this](const QString &path, const QString &name) { + handleFileClosed(path, name); + }); + + QObject::connect(watcher.data(), &InotifyFileSystemWatcher::fileMoved, + q_ptr, [this](const QString &fromPath, const QString &fromName, const QString &toPath, const QString &toName) { + handleFileMoved(fromPath, fromName, toPath, toName); + }); +} + +void FSMonitorPrivate::setupVfsMonitorConnections() +{ + // All events come from VfsMonitorFileSystemWatcher (create/delete/move/close-write). + // The kernel already distinguishes files from directories, so we can + // emit the specific directory* signals directly without QFileInfo checks. + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::fileCreated, + q_ptr, [this](const QString &path, const QString &name) { + handleFileCreated(path, name); + }); + + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::fileDeleted, + q_ptr, [this](const QString &path, const QString &name) { + handleFileDeleted(path, name); + }); + + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::fileMoved, + q_ptr, [this](const QString &fromPath, const QString &fromName, const QString &toPath, const QString &toName) { + handleFileMoved(fromPath, fromName, toPath, toName); + }); + + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::fileClosed, + q_ptr, [this](const QString &path, const QString &name) { + handleFileClosed(path, name); + }); + + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::directoryCreated, + q_ptr, [this](const QString &path, const QString &name) { + Q_EMIT q_ptr->directoryCreated(path, name); + }); + + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::directoryDeleted, + q_ptr, [this](const QString &path, const QString &name) { + Q_EMIT q_ptr->directoryDeleted(path, name); + }); + + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::directoryMoved, + q_ptr, [this](const QString &fromPath, const QString &fromName, const QString &toPath, const QString &toName) { + qDebug() << "FSMonitor: Directory moved (vfs):" << fromPath << "/" << fromName + << "->" << toPath << "/" << toName; + + Q_EMIT q_ptr->directoryMoved(fromPath, fromName, toPath, toName); + }); + + // Lost events (dispatcher disconnect / queue overflow) cannot be + // replayed — surface them so runtimes schedule a compensating update. + QObject::connect(vfsWatcher.data(), &VfsMonitorFileSystemWatcher::eventsLost, + q_ptr, [this]() { + qWarning() << "FSMonitor: vfs monitor lost filesystem events, recovery update required"; + Q_EMIT q_ptr->eventsLost(); + }); +} + +void FSMonitorPrivate::handleFileCreated(const QString &path, const QString &name) +{ + if (!active || path.isEmpty()) { + return; + } + + QString fullPath = QDir(path).absoluteFilePath(name); + + if (isDirectory(path, name)) { + // It's a directory, add to watch and emit signal + Q_EMIT q_ptr->directoryCreated(path, name); + + // Add new directory to watch recursively + if (!isSymbolicLink(fullPath) && !shouldExcludePath(fullPath)) { + addDirectoryRecursively(fullPath); + } + } else { + // It's a file, emit signal + Q_EMIT q_ptr->fileCreated(path, name); + } +} + +void FSMonitorPrivate::handleFileDeleted(const QString &path, const QString &name) +{ + if (!active || path.isEmpty()) { + return; + } + + QString fullPath = QDir(path).absoluteFilePath(name); + + if (watchedDirectories.contains(fullPath)) { + // It was a watched directory + Q_EMIT q_ptr->directoryDeleted(path, name); + + // Remove from watch + removeWatchForDirectory(fullPath); + } else { + // Regular file deleted + if (!name.isEmpty()) { + Q_EMIT q_ptr->fileDeleted(path, name); + } + } +} + +void FSMonitorPrivate::handleFileClosed(const QString &path, const QString &name) +{ + if (!active || path.isEmpty()) { + return; + } + + Q_EMIT q_ptr->fileClosed(path, name); +} + +void FSMonitorPrivate::handleFileMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName) +{ + if (!active) { + return; + } + + QString fromFullPath = QDir(fromPath).absoluteFilePath(fromName); + QString toFullPath = QDir(toPath).absoluteFilePath(toName); + + if (watchedDirectories.contains(fromFullPath)) { + // It was a watched directory that was moved + qDebug() << "FSMonitor: Directory moved:" << fromPath << "/" << fromName + << "->" << toPath << "/" << toName; + + Q_EMIT q_ptr->directoryMoved(fromPath, fromName, toPath, toName); + + // Update directory watches + removeWatchForDirectory(fromFullPath); + + // Add the destination directory to watch + if (!toPath.isEmpty() && !isSymbolicLink(toFullPath) && !shouldExcludePath(toFullPath)) { + addDirectoryRecursively(toFullPath); + } + } else { + // Regular file moved + qDebug() << "FSMonitor: File moved:" << fromPath << "/" << fromName + << "->" << toPath << "/" << toName; + + Q_EMIT q_ptr->fileMoved(fromPath, fromName, toPath, toName); + } +} + +bool FSMonitorPrivate::isDirectory(const QString &path, const QString &name) const +{ + if (path.isEmpty()) { + return false; + } + + return QFileInfo(QDir(path).absoluteFilePath(name)).isDir(); +} + +void FSMonitorPrivate::handleFastScanCompleted(bool success) +{ + if (success) { + qDebug() << "FSMonitor: Fast directory scan completed successfully"; + } else { + qWarning() << "FSMonitor: Fast directory scan failed, continuing with traditional scan"; + travelRootDirectories(); + } +} + +void FSMonitorPrivate::handleDirectoriesBatch(const QStringList &paths) +{ + if (paths.isEmpty()) { + return; + } + + if (vfsMonitorAvailable || !watcher) { + qDebug() << "FSMonitor: Ignoring directory watch batch in vfs mode, size:" << paths.size(); + return; + } + + qDebug() << "FSMonitor: Received batch of" << paths.size() << "directories to watch"; + + int addedCount = 0; + int skipCount = 0; + int failCount = 0; + + // Process this batch directly, but stop early if resource limit is reached + for (const QString &path : paths) { + // Check if resource limit has been reached - early exit to avoid processing remaining paths + if (!isWithinWatchLimit()) { + qWarning() << "FSMonitor: Watch limit reached (" << watchedDirectories.size() + << "/" << maxWatches << "), stopping batch processing"; + Q_EMIT q_ptr->resourceLimitReached(watchedDirectories.size(), maxWatches); + break; + } + + if (!watchedDirectories.contains(path) && !shouldExcludePath(path)) { + qApp->processEvents(); + // Add each path individually to avoid blocking from addPaths + if (watcher && watcher->addPath(path)) { + watchedDirectories.insert(path); + addedCount++; + } else { + qWarning() << "FSMonitor: Failed to add directory watch:" << path; + failCount++; + } + } else { + skipCount++; + } + } + + qDebug() << "FSMonitor: Batch processing complete - added:" << addedCount + << "skipped:" << skipCount + << "failed:" << failCount + << "total watching:" << watchedDirectories.size(); +} + +// ========== FSMonitor implementation ========== + +FSMonitor &FSMonitor::instance() +{ + static FSMonitor ins; + return ins; +} + +FSMonitor::FSMonitor(QObject *parent) + : QObject(parent), d_ptr(new FSMonitorPrivate(this)) +{ +} + +FSMonitor::~FSMonitor() +{ + stop(); +} + +bool FSMonitor::initialize(const QStringList &rootPaths) +{ + Q_D(FSMonitor); + return d->init(rootPaths); +} + +bool FSMonitor::start() +{ + Q_D(FSMonitor); + return d->startMonitoring(); +} + +void FSMonitor::stop() +{ + Q_D(FSMonitor); + d->stopMonitoring(); +} + +bool FSMonitor::isActive() const +{ + Q_D(const FSMonitor); + return d->active; +} + +void FSMonitor::addBlacklistedPath(const QString &path) +{ + Q_D(FSMonitor); + d->excludeMatcher.addPattern(path); +} + +void FSMonitor::addBlacklistedPaths(const QStringList &paths) +{ + Q_D(FSMonitor); + d->excludeMatcher.addPatterns(paths); +} + +void FSMonitor::removeBlacklistedPath(const QString &path) +{ + Q_D(FSMonitor); + d->excludeMatcher.removePattern(path); +} + +QStringList FSMonitor::blacklistedPaths() const +{ + Q_D(const FSMonitor); + return d->excludeMatcher.patterns(); +} + +void FSMonitor::setMaxResourceUsage(double percentage) +{ + Q_D(FSMonitor); + // Clamp between 0.1 and 1.0 + d->maxUsagePercentage = qBound(0.1, percentage, 1.0); +} + +double FSMonitor::maxResourceUsage() const +{ + Q_D(const FSMonitor); + return d->maxUsagePercentage; +} + +int FSMonitor::currentWatchCount() const +{ + Q_D(const FSMonitor); + return d->watchedDirectories.size(); +} + +int FSMonitor::maxAvailableWatchCount() const +{ + Q_D(const FSMonitor); + return d->maxWatches; +} + +void FSMonitor::setUseFastScan(bool enable) +{ + Q_D(FSMonitor); + + if (d->active) { + qWarning() << "FSMonitor: Cannot change fast scan setting while monitor is active"; + return; + } + + d->useFastScan = enable; +} + +bool FSMonitor::useFastScan() const +{ + Q_D(const FSMonitor); + return d->useFastScan; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/fsmonitor/fsmonitor.h b/src/index/fsmonitor/fsmonitor.h new file mode 100644 index 00000000..72f01d2b --- /dev/null +++ b/src/index/fsmonitor/fsmonitor.h @@ -0,0 +1,128 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FSMONITOR_H +#define FSMONITOR_H + +#include "index_global.h" + +#include +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FSMonitorPrivate; + +// FSMonitor: A recursive file system monitor based on InotifyFileSystemWatcher +// Monitors user's home directory and handles file/directory events for indexing +// +// Features: +// - Recursively watches directories +// - Manages system resource usage by limiting watch count +// - Excludes blacklisted, system, external, and network mounts automatically +// - Skips symbolic links to prevent circular watch issues +// - Respects the system hidden files setting - ignores hidden files when configured +// - Can optionally use fast directory scanning at startup for performance +class FSMonitor : public QObject +{ + Q_OBJECT + Q_DISABLE_COPY_MOVE(FSMonitor) + +public: + // Singleton access + static FSMonitor &instance(); + + // Initialize monitoring with root paths + bool initialize(const QStringList &rootPaths); + + // Start monitoring + bool start(); + + // Stop monitoring + void stop(); + + // Check if monitoring is active + bool isActive() const; + + // Add a path to blacklist (won't be monitored) + void addBlacklistedPath(const QString &path); + + // Add multiple paths to blacklist + void addBlacklistedPaths(const QStringList &paths); + + // Remove a path from blacklist + void removeBlacklistedPath(const QString &path); + + // Get current blacklisted paths + QStringList blacklistedPaths() const; + + // Set maximum resource usage percentage (0.0-1.0, default 0.5) + void setMaxResourceUsage(double percentage); + + // Get current resource usage percentage + double maxResourceUsage() const; + + // Get current watch count + int currentWatchCount() const; + + // Get maximum available watch count from system + int maxAvailableWatchCount() const; + + // Enable or disable fast directory scanning (must be called before start) + void setUseFastScan(bool enable); + + // Check if fast scanning is enabled + bool useFastScan() const; + +Q_SIGNALS: + // Emitted when a file is created + void fileCreated(const QString &path, const QString &name); + + // Emitted when a file is deleted + void fileDeleted(const QString &path, const QString &name); + + // Emitted when a file opened for writing is closed (IN_CLOSE_WRITE) + void fileClosed(const QString &path, const QString &name); + + // Emitted when a file is moved + void fileMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + + // Emitted when a directory is created + void directoryCreated(const QString &path, const QString &name); + + // Emitted when a directory is deleted + void directoryDeleted(const QString &path, const QString &name); + + // Emitted when a directory is moved + void directoryMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + + // Emitted when resource usage reaches the limit + void resourceLimitReached(int currentCount, int maxCount); + + // Emitted when monitored filesystem events were lost (dispatcher + // disconnect or internal queue overflow) and a full index update is + // required to re-sync. VfsMonitor mode only. + void eventsLost(); + + // Emitted when an error occurs + void errorOccurred(const QString &errorMessage); + +private: + explicit FSMonitor(QObject *parent = nullptr); + ~FSMonitor() override; + + // Private implementation + QScopedPointer d_ptr; + Q_DECLARE_PRIVATE(FSMonitor) +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FSMONITOR_H diff --git a/src/index/fsmonitor/fsmonitor_p.h b/src/index/fsmonitor/fsmonitor_p.h new file mode 100644 index 00000000..113bd037 --- /dev/null +++ b/src/index/fsmonitor/fsmonitor_p.h @@ -0,0 +1,120 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FSMONITOR_P_H +#define FSMONITOR_P_H + +#include "fsmonitor.h" +#include "fsmonitorworker.h" +#include "inotifyfilesystemwatcher.h" +#include "vfsmonitorwatcher.h" +#include "utils/pathexcludematcher.h" + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FSMonitorPrivate +{ +public: + FSMonitorPrivate(FSMonitor *qq); + ~FSMonitorPrivate(); + + // Initialize the monitor with root paths + bool init(const QStringList &rootPaths); + bool init(const QString &rootPath); // For backward compatibility + + // Start monitoring using InotifyFileSystemWatcher + bool startMonitoring(); + + // Stop all monitoring + void stopMonitoring(); + + // Process the root directories using traditional method + void travelRootDirectories(); + + // Get the maximum number of watches supported by the system + int getMaxUserWatches() const; + + // Check if a path should be excluded (blacklisted or external mount) + bool shouldExcludePath(const QString &path) const; + + // Check if a path is a symbolic link + bool isSymbolicLink(const QString &path) const; + + // Check if hidden config opened + bool showHidden() const; + + // Add a directory and all its subdirectories to the watch + void addDirectoryRecursively(const QString &path); + + // Add a single directory to watch + bool addWatchForDirectory(const QString &path); + + // Remove a directory from watch + void removeWatchForDirectory(const QString &path); + + // Check if we're below the system watch limit + bool isWithinWatchLimit() const; + + // Parse and connect watcher signals (inotify-only fallback mode) + void setupWatcherConnections(); + + // Connect vfs monitor signals (all events from deepin-anything dispatcher) + void setupVfsMonitorConnections(); + + // Set up the worker thread and connections + void setupWorkerThread(); + + // Handle file creation event + void handleFileCreated(const QString &path, const QString &name); + + // Handle file deletion event + void handleFileDeleted(const QString &path, const QString &name); + + // Handle file closed (write completed) event + void handleFileClosed(const QString &path, const QString &name); + + // Handle file moved event + void handleFileMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + + // Handle fast scan completion + void handleFastScanCompleted(bool success); + + // Handle batch of directories to watch + void handleDirectoriesBatch(const QStringList &paths); + + // Detect if a path is a directory + bool isDirectory(const QString &path, const QString &name) const; + + // Fast scan control + bool useFastScan { true }; // Whether to try fast scan first + + // Data members + FSMonitor *q_ptr; + QScopedPointer watcher; + QScopedPointer vfsWatcher; + bool vfsMonitorAvailable { false }; + + // Worker thread members + QThread workerThread; + FSMonitorWorker *worker { nullptr }; + + QStringList rootPaths; + QSet watchedDirectories; + PathExcludeMatcher excludeMatcher; + bool active { false }; + + // Resource limits + double maxUsagePercentage { 0.5 }; // Default to 50% of available watches + int maxWatches { -1 }; // Will be determined at runtime +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FSMONITOR_P_H diff --git a/src/index/fsmonitor/fsmonitorworker.cpp b/src/index/fsmonitor/fsmonitorworker.cpp new file mode 100644 index 00000000..4fc80811 --- /dev/null +++ b/src/index/fsmonitor/fsmonitorworker.cpp @@ -0,0 +1,226 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "fsmonitorworker.h" + +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include "utils/indexutility.h" + +#include +#include + +DFM_SEARCH_USE_NS + +ANYTHING_INDEX_BEGIN_NAMESPACE + +FSMonitorWorker::FSMonitorWorker(QObject *parent) + : QObject(parent) +{ + // Default exclusion checker (excludes nothing) + exclusionChecker = [](const QString &) { return false; }; + + // Initialize future watcher + futureWatcher = new QFutureWatcher(this); + connect(futureWatcher, &QFutureWatcher::finished, + this, &FSMonitorWorker::handleFastScanResult); +} + +FSMonitorWorker::~FSMonitorWorker() +{ + if (futureWatcher && futureWatcher->isRunning()) { + futureWatcher->cancel(); + futureWatcher->waitForFinished(); + } +} + +void FSMonitorWorker::processDirectory(const QString &path) +{ + if (path.isEmpty() || !QFileInfo(path).isDir()) { + return; + } + + // Skip excluded directories + if (exclusionChecker(path)) { + return; + } + + // Emit signal to add this directory to watch + emit directoryToWatch(path); + + // Find subdirectories + QDir dir(path); + QFileInfoList entries = dir.entryInfoList(QDir::Dirs | QDir::NoDotAndDotDot); + + if (!entries.isEmpty()) { + QStringList subDirs; + subDirs.reserve(entries.size()); + + // Collect valid subdirectories + for (const QFileInfo &info : std::as_const(entries)) { + const QString &subPath = info.absoluteFilePath(); + if (info.isDir() && !info.isSymLink() && !exclusionChecker(subPath)) { + subDirs << subPath; + } + } + + // Emit signal with found subdirectories + if (!subDirs.isEmpty()) { + emit subdirectoriesFound(subDirs); + } + } +} + +void FSMonitorWorker::tryFastDirectoryScan() +{ + // Only allow one fast scan at a time + if (fastScanInProgress) { + qWarning() << "FSMonitorWorker: Fast directory scan already in progress, ignoring request"; + return; + } + + qInfo() << "FSMonitorWorker: Starting fast directory scan (CLI-preferred)"; + fastScanInProgress = true; + + // Capture by value to avoid accessing destroyed object + auto capturedMaxResults = maxResultsCount; + auto capturedExclusionChecker = exclusionChecker; + + auto scanOperation = [capturedMaxResults, capturedExclusionChecker]() -> QStringList { + // 旧逻辑为 status == "closed"（anything-daemon 未运行）时回退遍历。 + // 新架构中无独立进程，改为直接判断索引就绪： + // 索引存在且可用（无 create/updateInProgress）→ 快速扫描；否则 → 回退传统遍历。 + if (!DFMSEARCH::Global::isFileNameIndexReadyForSearch()) { + qWarning() << "FSMonitorWorker: Cannot use fast directory scan, filename index not ready"; + return {}; + } + + // Prefer CLI process; fallback to SearchEngine API on failure + QStringList directories = fetchDirectoriesViaCli(); + if (directories.isEmpty()) { + qInfo() << "FSMonitorWorker: CLI scan empty/failed, falling back to SearchEngine API"; + directories = fetchDirectoriesViaApi(); + } + + if (directories.isEmpty()) { + return {}; + } + + // Shared post-processing: filter, sort by path length, truncate + QStringList filtered; + filtered.reserve(directories.size()); + for (const QString &path : std::as_const(directories)) { + if (!capturedExclusionChecker(path)) { + filtered << path; + } + } + + std::sort(filtered.begin(), filtered.end(), + [](const QString &a, const QString &b) { + return a.length() < b.length(); + }); + + if (filtered.size() > capturedMaxResults) { + filtered = filtered.mid(0, capturedMaxResults); + } + + return filtered; + }; + + // Start async operation + QFuture future = QtConcurrent::run(scanOperation); + futureWatcher->setFuture(future); +} + +QStringList FSMonitorWorker::fetchDirectoriesViaCli() +{ + return SearchUtility::runCli({ "--type=filename", + "--file-types=dir", + "--max-results=500000", + "--json", + "", + "/" }); +} + +QStringList FSMonitorWorker::fetchDirectoriesViaApi() +{ + constexpr int kQueryLimit = 500000; + + QObject holder; + SearchEngine *engine = SearchFactory::createEngine(SearchType::FileName, &holder); + SearchOptions options; + options.setMaxResults(kQueryLimit); + options.setSyncSearchTimeout(120); + options.setSearchPath(QDir::rootPath()); + options.setSearchMethod(SearchMethod::Indexed); + FileNameOptionsAPI fileNameOptions(options); + fileNameOptions.setFileTypes({ Defines::kAnythingDirType }); + engine->setSearchOptions(options); + SearchQuery query = SearchFactory::createQuery("", SearchQuery::Type::Simple); + const SearchResultExpected &result = engine->searchSync(query); + + if (!result.hasValue() || result->isEmpty()) { + return {}; + } + + QStringList directories; + const auto &searchResults = result.value(); + directories.reserve(searchResults.size()); + for (const auto &dir : searchResults) { + directories << dir.path(); + } + + qInfo() << "FSMonitorWorker: API scan found" << directories.size() << "directories"; + return directories; +} + +void FSMonitorWorker::handleFastScanResult() +{ + const QStringList &directories = futureWatcher->result(); + bool success = !directories.isEmpty(); + + if (success) { + // Fast scan succeeded + qInfo() << "FSMonitorWorker: Fast directory scan succeeded, found" << directories.size() << "directories"; + + // Emit directories in batches to avoid overwhelming the main thread + const int kBatchSize = 200; + for (int i = 0; i < directories.size(); i += kBatchSize) { + QStringList batch = directories.mid(i, kBatchSize); + emit directoriesBatchToWatch(batch); + QThread::msleep(100); + } + } else { + // Fast scan failed + qInfo() << "FSMonitorWorker: Fast directory scan failed, system will fall back to traditional scanning"; + } + + // Reset flag and signal completion + fastScanInProgress = false; + emit fastScanCompleted(success); +} + +void FSMonitorWorker::setExclusionChecker(const std::function &checker) +{ + if (checker) { + exclusionChecker = checker; + } +} + +void FSMonitorWorker::setMaxFastScanResults(int max) +{ + if (max > 0) { + maxResultsCount = max; + } +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/fsmonitor/fsmonitorworker.h b/src/index/fsmonitor/fsmonitorworker.h new file mode 100644 index 00000000..2dd8e8ad --- /dev/null +++ b/src/index/fsmonitor/fsmonitorworker.h @@ -0,0 +1,81 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FSMONITORWORKER_H +#define FSMONITORWORKER_H + +#include "index_global.h" + +#include +#include +#include +#include +#include +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FSMonitorWorker : public QObject +{ + Q_OBJECT + +public: + explicit FSMonitorWorker(QObject *parent = nullptr); + ~FSMonitorWorker() override; + + // Set exclusion checker function (moved to regular method to avoid MOC issues) + void setExclusionChecker(const std::function &checker); + + void setMaxFastScanResults(int max); + + // Whether fast directory scan is currently in progress + bool isFastScanInProgress() const { return fastScanInProgress; } + +public slots: + // Process a directory and find its subdirectories + void processDirectory(const QString &path); + + // Try to get all directories using fast scan method (new feature) + void tryFastDirectoryScan(); + +signals: + // Emitted when a directory should be watched + void directoryToWatch(const QString &path); + + // Emitted when subdirectories are found + void subdirectoriesFound(const QStringList &directories); + + // Emitted when a batch of directories should be watched + void directoriesBatchToWatch(const QStringList &paths); + + // Emitted when fast scan completes (whether success or failure) + void fastScanCompleted(bool success); + +private slots: + void handleFastScanResult(); + +private: + // Fetch directories via dfm-searcher CLI (preferred path) + static QStringList fetchDirectoriesViaCli(); + + // Fallback: fetch directories via SearchEngine API + static QStringList fetchDirectoriesViaApi(); + + // Function to check if a path should be excluded + std::function exclusionChecker; + + // Whether fast scan is currently in progress + bool fastScanInProgress { false }; + + // Future watcher for async operations + QFutureWatcher *futureWatcher { nullptr }; + + int maxResultsCount { 65536 }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FSMONITORWORKER_H diff --git a/src/index/fsmonitor/inotifyfilesystemwatcher.cpp b/src/index/fsmonitor/inotifyfilesystemwatcher.cpp new file mode 100644 index 00000000..faf52cc6 --- /dev/null +++ b/src/index/fsmonitor/inotifyfilesystemwatcher.cpp @@ -0,0 +1,469 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +// Adapted from DTK DFileSystemWatcher (LGPL-3.0-or-later) + +#include "inotifyfilesystemwatcher_p.h" + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +InotifyFileSystemWatcherPrivate::InotifyFileSystemWatcherPrivate(int fd, InotifyFileSystemWatcher *qq) + : q_ptr(qq), inotifyFd(fd), notifier(fd, QSocketNotifier::Read, qq) +{ + fcntl(inotifyFd, F_SETFD, FD_CLOEXEC); + QObject::connect(¬ifier, &QSocketNotifier::activated, qq, [this]() { + readFromInotify(); + }); +} + +InotifyFileSystemWatcherPrivate::~InotifyFileSystemWatcherPrivate() +{ + notifier.setEnabled(false); + for (int id : std::as_const(pathToID)) + inotify_rm_watch(inotifyFd, id < 0 ? -id : id); + + ::close(inotifyFd); +} + +uint32_t InotifyFileSystemWatcherPrivate::toInotifyMask(InotifyFileSystemWatcher::WatchFlags flags, bool isDir) +{ + using WF = InotifyFileSystemWatcher::WatchFlag; + uint32_t mask = 0; + + // Self-referencing events (IN_DELETE_SELF, IN_MOVE_SELF) are always + // included so the watcher can react when the watched path itself is + // removed or renamed, regardless of which event types the consumer + // has enabled. + mask |= IN_DELETE_SELF | IN_MOVE_SELF; + + if (flags & WF::FileClose) + mask |= IN_CLOSE_WRITE; + if (flags & WF::FileModify) + mask |= IN_MODIFY; + if (flags & WF::FileCreate) + mask |= IN_CREATE; + if (flags & WF::FileDelete) + mask |= isDir ? IN_DELETE : 0; + if (flags & WF::FileMove) + mask |= isDir ? IN_MOVE : 0; + if (flags & WF::FileAttribute) + mask |= IN_ATTRIB; + + return mask; +} + +QStringList InotifyFileSystemWatcherPrivate::addPaths(const QStringList &paths, QStringList *files, QStringList *directories) +{ + QStringList p = paths; + QMutableListIterator it(p); + while (it.hasNext()) { + QString path = it.next(); + QFileInfo fi(path); + bool isDir = fi.isDir(); + if (isDir) { + if (directories->contains(path)) + continue; + } else { + if (files->contains(path)) + continue; + } + + uint32_t mask = toInotifyMask(watchFlags, isDir); + + int wd = inotify_add_watch(inotifyFd, + QFile::encodeName(path), + mask); + if (wd < 0) { + perror("InotifyFileSystemWatcherPrivate::addPaths: inotify_add_watch failed"); + continue; + } + + it.remove(); + + int id = isDir ? -wd : wd; + if (id < 0) { + directories->append(path); + } else { + files->append(path); + } + + pathToID.insert(path, id); + idToPath.insert(id, path); + } + + return p; +} + +QStringList InotifyFileSystemWatcherPrivate::removePaths(const QStringList &paths, QStringList *files, QStringList *directories) +{ + QStringList p = paths; + QMutableListIterator it(p); + while (it.hasNext()) { + QString path = it.next(); + int id = pathToID.take(path); + for (auto hit = idToPath.find(id); hit != idToPath.end() && hit.key() == id; ++hit) { + if (hit.value() == path) { + idToPath.erase(hit); + break; + } + } + + it.remove(); + + if (!idToPath.contains(id)) { + int wd = id < 0 ? -id : id; + inotify_rm_watch(inotifyFd, wd); + } + + if (id < 0) { + directories->removeAll(path); + } else { + files->removeAll(path); + } + } + + return p; +} + +void InotifyFileSystemWatcherPrivate::readFromInotify() +{ + Q_Q(InotifyFileSystemWatcher); + + int buffSize = 0; + ioctl(inotifyFd, FIONREAD, (char *)&buffSize); + QVarLengthArray buffer(buffSize); + buffSize = read(inotifyFd, buffer.data(), buffSize); + char *at = buffer.data(); + char *const end = at + buffSize; + + QList eventList; + QMultiHash batch_pathmap; + QMultiMap cookieToFilePath; + QMultiMap cookieToFileName; + QSet hasMoveFromByCookie; + + while (at < end) { + inotify_event *event = reinterpret_cast(at); + QStringList paths; + + at += sizeof(inotify_event) + event->len; + + int id = event->wd; + paths = idToPath.values(id); + if (paths.empty()) { + // perhaps a directory? + id = -id; + paths = idToPath.values(id); + if (paths.empty()) + continue; + } + + if (!(event->mask & IN_MOVED_TO) || !hasMoveFromByCookie.contains(event->cookie)) { + auto it = std::find_if(eventList.begin(), eventList.end(), [event](inotify_event *e) { + return event->wd == e->wd && event->mask == e->mask + && event->cookie == e->cookie + && event->len == e->len + && !strcmp(event->name, e->name); + }); + + if (it == eventList.end()) { + eventList.append(event); + } + + const QList bps = batch_pathmap.values(id); + for (auto &path : paths) { + if (!bps.contains(path)) { + batch_pathmap.insert(id, path); + } + } + } + + if (event->mask & IN_MOVED_TO) { + for (auto &path : paths) { + cookieToFilePath.insert(event->cookie, path); + } + cookieToFileName.insert(event->cookie, QString::fromUtf8(event->name)); + } + + if (event->mask & IN_MOVED_FROM) + hasMoveFromByCookie << event->cookie; + } + + QList::const_iterator it = eventList.constBegin(); + while (it != eventList.constEnd()) { + const inotify_event &event = **it; + ++it; + + int id = event.wd; + QStringList paths = batch_pathmap.values(id); + + if (paths.empty()) { + id = -id; + paths = batch_pathmap.values(id); + + if (paths.empty()) + continue; + } + const QString &name = QString::fromUtf8(event.name); + + for (auto &path : paths) { + if ((event.mask & (IN_DELETE_SELF | IN_MOVE_SELF | IN_UNMOUNT)) != 0) { + do { + if (event.mask & IN_MOVE_SELF) { + QMultiMap::const_iterator iterator = cookieToFilePath.constBegin(); + + bool isMove = false; + + while (iterator != cookieToFilePath.constEnd()) { + const QString &_path = iterator.value(); + const QString &_name = cookieToFileName.value(iterator.key()); + + if (QFileInfo(_path + QDir::separator() + _name) == QFileInfo(path)) { + isMove = true; + break; + } + + ++iterator; + } + + if (isMove) + break; + } + + Q_EMIT q->fileDeleted(path, QString()); + } while (false); + } else { + if (id < 0) + onDirectoryChanged(path, false); + else + onFileChanged(path, false); + } + + QString filePath = path; + + if (id < 0) { + if (path.endsWith(QDir::separator())) + filePath = path + name; + else + filePath = path + QDir::separator() + name; + } + + if (event.mask & IN_CREATE) { + if (name.isEmpty()) { + if (pathToID.contains(path)) { + q->removePath(path); + q->addPath(path); + } + } else if (pathToID.contains(filePath)) { + q->removePath(filePath); + q->addPath(filePath); + } + + Q_EMIT q->fileCreated(path, name); + } + + if (event.mask & IN_DELETE) { + Q_EMIT q->fileDeleted(path, name); + } + + if (event.mask & IN_MOVED_FROM) { + const QString toName = cookieToFileName.value(event.cookie); + + if (cookieToFilePath.values(event.cookie).empty()) { + Q_EMIT q->fileMoved(path, name, QString(), QString()); + } else { + for (QString &toPath : cookieToFilePath.values(event.cookie)) { + Q_EMIT q->fileMoved(path, name, toPath, toName); + } + } + } + + if (event.mask & IN_MOVED_TO) { + if (!hasMoveFromByCookie.contains(event.cookie)) + Q_EMIT q->fileMoved(QString(), QString(), path, name); + } + + if (event.mask & IN_ATTRIB) { + Q_EMIT q->fileAttributeChanged(path, name); + } + + // Emitted when a file opened for writing is closed + // For directories: name is the file within the directory that was closed + // For files: name is empty + if (event.mask & IN_CLOSE_WRITE) { + Q_EMIT q->fileClosed(path, id < 0 ? name : QString()); + } + + if (event.mask & IN_MODIFY) { + Q_EMIT q->fileModified(path, name); + } + } + } +} + +void InotifyFileSystemWatcherPrivate::onFileChanged(const QString &path, bool removed) +{ + if (!files.contains(path)) { + return; + } + if (removed) { + files.removeAll(path); + } +} + +void InotifyFileSystemWatcherPrivate::onDirectoryChanged(const QString &path, bool removed) +{ + if (!directories.contains(path)) { + return; + } + if (removed) { + directories.removeAll(path); + } +} + +// ========== InotifyFileSystemWatcher implementation ========== + +InotifyFileSystemWatcher::InotifyFileSystemWatcher(QObject *parent) + : QObject(parent) +{ + int fd = -1; +#ifdef IN_CLOEXEC + fd = inotify_init1(IN_CLOEXEC | O_NONBLOCK); +#endif + if (fd == -1) { + fd = inotify_init1(O_NONBLOCK); + } + + if (fd != -1) { + d_ptr.reset(new InotifyFileSystemWatcherPrivate(fd, this)); + } else { + qCritical() << "inotify_init1 failed, and the InotifyFileSystemWatcher is invalid." << strerror(errno); + } +} + +InotifyFileSystemWatcher::~InotifyFileSystemWatcher() +{ +} + +void InotifyFileSystemWatcher::setWatchFlags(WatchFlags flags) +{ + Q_D(InotifyFileSystemWatcher); + + if (!d) + return; + + d->watchFlags = flags; +} + +InotifyFileSystemWatcher::WatchFlags InotifyFileSystemWatcher::watchFlags() const +{ + Q_D(const InotifyFileSystemWatcher); + + if (!d) + return WatchFlags(NoFlags); + + return d->watchFlags; +} + +bool InotifyFileSystemWatcher::addPath(const QString &path) +{ + const QStringList &paths = addPaths(QStringList(path)); + return paths.isEmpty(); +} + +QStringList InotifyFileSystemWatcher::addPaths(const QStringList &paths) +{ + Q_D(InotifyFileSystemWatcher); + + if (!d) + return paths; + + QStringList p = paths; + QMutableListIterator it(p); + + while (it.hasNext()) { + const QString &path = it.next(); + if (path.isEmpty()) { + qWarning() << Q_FUNC_INFO << "the path is empty and it is not be watched"; + it.remove(); + } + } + + if (p.isEmpty()) { + qWarning() << Q_FUNC_INFO << "all path are filtered and they are not be watched, paths are " << paths; + return paths; + } + + p = d->addPaths(p, &d->files, &d->directories); + + return p; +} + +bool InotifyFileSystemWatcher::removePath(const QString &path) +{ + const QStringList &paths = removePaths(QStringList(path)); + return paths.isEmpty(); +} + +QStringList InotifyFileSystemWatcher::removePaths(const QStringList &paths) +{ + Q_D(InotifyFileSystemWatcher); + + if (!d) + return paths; + + QStringList p = paths; + QMutableListIterator it(p); + + while (it.hasNext()) { + const QString &path = it.next(); + if (path.isEmpty()) { + qWarning() << Q_FUNC_INFO << "the path is empty and it is not be removed from watched list"; + it.remove(); + } + } + + if (p.isEmpty()) { + qWarning() << Q_FUNC_INFO << "all path are filtered and they are not be watched, paths are " << paths; + return paths; + } + + p = d->removePaths(p, &d->files, &d->directories); + + return p; +} + +QStringList InotifyFileSystemWatcher::directories() const +{ + Q_D(const InotifyFileSystemWatcher); + + if (!d) + return QStringList(); + + return d->directories; +} + +QStringList InotifyFileSystemWatcher::files() const +{ + Q_D(const InotifyFileSystemWatcher); + + if (!d) + return QStringList(); + + return d->files; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/fsmonitor/inotifyfilesystemwatcher.h b/src/index/fsmonitor/inotifyfilesystemwatcher.h new file mode 100644 index 00000000..f471d624 --- /dev/null +++ b/src/index/fsmonitor/inotifyfilesystemwatcher.h @@ -0,0 +1,81 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INOTIFYFILESYSTEMWATCHER_H +#define INOTIFYFILESYSTEMWATCHER_H + +#include "index_global.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class InotifyFileSystemWatcherPrivate; + +// InotifyFileSystemWatcher: Linux-only file system watcher using inotify +// Adapted from DTK DFileSystemWatcher with directory IN_CLOSE_WRITE support +// +// Key difference from DFileSystemWatcher: +// - Directory watch mask includes IN_CLOSE_WRITE, so fileClosed signal +// is emitted when a file within a watched directory finishes writing. +// - This avoids the high-frequency fileModified (IN_MODIFY) signals during +// large file copies, improving performance for indexing use cases. +// +// Supports configurable event filtering via WatchFlags. By default, all +// event types are monitored. Consumers can restrict the inotify mask at the +// kernel level to reduce unnecessary event delivery and processing overhead. +// Flags must be set before adding paths. +class InotifyFileSystemWatcher : public QObject +{ + Q_OBJECT + Q_DISABLE_COPY_MOVE(InotifyFileSystemWatcher) + Q_DECLARE_PRIVATE(InotifyFileSystemWatcher) + +public: + enum WatchFlag { + NoFlags = 0, + FileClose = 1 << 0, + FileModify = 1 << 1, + FileCreate = 1 << 2, + FileDelete = 1 << 3, + FileMove = 1 << 4, + FileAttribute = 1 << 5, + AllEvents = FileClose | FileModify | FileCreate | FileDelete | FileMove | FileAttribute + }; + Q_DECLARE_FLAGS(WatchFlags, WatchFlag) + + explicit InotifyFileSystemWatcher(QObject *parent = nullptr); + ~InotifyFileSystemWatcher() override; + + void setWatchFlags(WatchFlags flags); + WatchFlags watchFlags() const; + + bool addPath(const QString &path); + QStringList addPaths(const QStringList &paths); + + bool removePath(const QString &path); + QStringList removePaths(const QStringList &paths); + + QStringList files() const; + QStringList directories() const; + +Q_SIGNALS: + void fileCreated(const QString &path, const QString &name); + void fileDeleted(const QString &path, const QString &name); + void fileClosed(const QString &path, const QString &name); + void fileModified(const QString &path, const QString &name); + void fileMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + void fileAttributeChanged(const QString &path, const QString &name); + +private: + QScopedPointer d_ptr; +}; + +Q_DECLARE_OPERATORS_FOR_FLAGS(InotifyFileSystemWatcher::WatchFlags) + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INOTIFYFILESYSTEMWATCHER_H diff --git a/src/index/fsmonitor/inotifyfilesystemwatcher_p.h b/src/index/fsmonitor/inotifyfilesystemwatcher_p.h new file mode 100644 index 00000000..e7bd9b64 --- /dev/null +++ b/src/index/fsmonitor/inotifyfilesystemwatcher_p.h @@ -0,0 +1,49 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INOTIFYFILESYSTEMWATCHER_P_H +#define INOTIFYFILESYSTEMWATCHER_P_H + +#include "inotifyfilesystemwatcher.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class InotifyFileSystemWatcherPrivate +{ + Q_DECLARE_PUBLIC(InotifyFileSystemWatcher) + +public: + InotifyFileSystemWatcherPrivate(int fd, InotifyFileSystemWatcher *qq); + ~InotifyFileSystemWatcherPrivate(); + + QStringList addPaths(const QStringList &paths, QStringList *files, QStringList *directories); + QStringList removePaths(const QStringList &paths, QStringList *files, QStringList *directories); + + void readFromInotify(); + + static uint32_t toInotifyMask(InotifyFileSystemWatcher::WatchFlags flags, bool isDir); + + InotifyFileSystemWatcher::WatchFlags watchFlags { InotifyFileSystemWatcher::AllEvents }; + +private: + void onFileChanged(const QString &path, bool removed); + void onDirectoryChanged(const QString &path, bool removed); + + InotifyFileSystemWatcher *q_ptr; + + QStringList files; + QStringList directories; + int inotifyFd { -1 }; + QHash pathToID; + QMultiHash idToPath; + QSocketNotifier notifier; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INOTIFYFILESYSTEMWATCHER_P_H diff --git a/src/index/fsmonitor/vfsmonitorwatcher.cpp b/src/index/fsmonitor/vfsmonitorwatcher.cpp new file mode 100644 index 00000000..d0bdd8e9 --- /dev/null +++ b/src/index/fsmonitor/vfsmonitorwatcher.cpp @@ -0,0 +1,862 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef _GNU_SOURCE +#define _GNU_SOURCE // recvmmsg +#endif + +#include "vfsmonitorwatcher_p.h" + +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +constexpr char kDispatcherSocketPath[] = "/run/deepin-anything/event-dispatcher.sock"; +constexpr size_t kDispatchMaxPathLen = 4096; + +// Upper bound of events turned into signals per home-thread wakeup so a huge +// backlog cannot starve the event loop for seconds. +constexpr int kMaxEventsPerDrain = 2048; + +struct MountEntry +{ + dev_t deviceId { 0 }; + int parentMountId { 0 }; + QString mountPoint; + bool isBindMount { false }; +}; + +struct DispatchEvent +{ + int32_t action; + uint32_t cookie; + char eventPath[kDispatchMaxPathLen]; +}; + +struct FileIdentity +{ + dev_t deviceId { 0 }; + ino_t inode { 0 }; + bool valid { false }; +}; + +bool isDescendantOfRoot(const QString &path, const QString &root) +{ + if (root == "/") + return path.startsWith('/'); + + if (!path.startsWith(root)) + return false; + + if (path.length() == root.length()) + return false; + + return root.endsWith('/') || path.at(root.length()) == '/'; +} + +bool mountPointStartsWith(const QString &path, const QString &mountPoint) +{ + if (!path.startsWith(mountPoint)) + return false; + + return mountPoint.endsWith('/') || path.length() == mountPoint.length() + || path.at(mountPoint.length()) == '/'; +} + +bool cStringEquals(const char *left, const char *right) +{ + return left && right && qstrcmp(left, right) == 0; +} + +FileIdentity identifyPath(const QString &path) +{ + struct stat st {}; + if (::stat(path.toUtf8().constData(), &st) != 0) + return {}; + + return { st.st_dev, st.st_ino, true }; +} + +bool isParentChainUnderRoot(const QHash &byMountId, const MountEntry &entry) +{ + if (!entry.isBindMount && entry.mountPoint == "/") + return true; + + int parentMountId = entry.parentMountId; + while (parentMountId > 0) { + auto parentIt = byMountId.find(parentMountId); + if (parentIt == byMountId.end()) + return false; + + if (parentIt->mountPoint == "/") + return true; + + parentMountId = parentIt->parentMountId; + } + + return false; +} + +QHash collectMountEntries(libmnt_table *mtab) +{ + QHash byMountId; + libmnt_iter *iter = mnt_new_iter(MNT_ITER_FORWARD); + if (!iter) + return byMountId; + + libmnt_fs *fs = nullptr; + while (mnt_table_next_fs(mtab, iter, &fs) == 0) { + const char *target = mnt_fs_get_target(fs); + if (!target) + continue; + + MountEntry entry; + entry.deviceId = mnt_fs_get_devno(fs); + entry.parentMountId = mnt_fs_get_parent_id(fs); + entry.mountPoint = QString::fromUtf8(target); + entry.isBindMount = !cStringEquals(mnt_fs_get_root(fs), "/"); + + byMountId.insert(mnt_fs_get_id(fs), entry); + } + + mnt_free_iter(iter); + return byMountId; +} + +QString filterDirectPath(const QStringList &rootPaths, + const VfsMonitorFileSystemWatcher::PathExcludePredicate &excludePredicate, + const QString &fullPath) +{ + if (std::none_of(rootPaths.cbegin(), rootPaths.cend(), + [&fullPath](const QString &root) { return isDescendantOfRoot(fullPath, root); })) { + return {}; + } + + if (excludePredicate && excludePredicate(fullPath)) + return {}; + + return fullPath; +} + +} // anonymous namespace + +// ========== VfsSocketReader ========== + +// Lives in a dedicated QThread. Its only job is to drain the dispatcher +// socket as fast as the kernel delivers packets and park the events in the +// userspace queue owned by VfsMonitorFileSystemWatcherPrivate. +// +// Why a dedicated thread: the dispatcher kicks any client whose kernel +// receive buffer overflows (send() -> EAGAIN -> "slow client ... kicking", +// see deepin-anything src/dispatcher/event_dispatcher.c). Kernel buffers are +// capped by net.core.rmem_max / wmem_max (~416 KiB ≈ ~100 packets of 4 KB), +// so no setsockopt can absorb a burst of thousands — let alone 300k files — +// if draining depends on how fast events are processed. Mirrors the daemon's +// own event_listener (dedicated thread + draining loop, deepin-anything +// commit f2dd210): keep the read path tiny and buffer in userspace. +// +// Because the dispatcher closes the connection on the very first EAGAIN, +// this hot loop must stay as cheap as physically possible: +// - recvmmsg() gathers up to kReceiveBatch packets per syscall instead of +// one recv() per packet (syscalls dominate the per-event cost); +// - received slots are never re-zeroed (a 4 KiB memset per packet); each +// message is delimited by its actual length and NUL-terminated in place; +// - mount/unmount notifications only set a flag — the mount-table refresh +// (parsing /proc/self/mountinfo plus alias stat()s) runs once after the +// drain loop instead of stalling it mid-burst; +// - resolved events are parked in a reusable batch vector and pushed into +// the userspace queue under a single lock acquisition. +class VfsSocketReader final : public QObject +{ +public: + explicit VfsSocketReader(VfsMonitorFileSystemWatcherPrivate *dd) + : d(dd) + { + receiveSlots.resize(kReceiveBatch); + msgHeaders.resize(kReceiveBatch); + iovs.resize(kReceiveBatch); + for (int i = 0; i < kReceiveBatch; ++i) { + iovs[i].iov_base = &receiveSlots[i]; + iovs[i].iov_len = sizeof(DispatchEvent); + msgHeaders[i].msg_hdr.msg_iov = &iovs[i]; + msgHeaders[i].msg_hdr.msg_iovlen = 1; + } + } + + // Runs in the reader thread. Adopts a connected fd and starts watching. + void begin(int fd) + { + d->pendingFd.storeRelaxed(-1); // ownership transferred + + if (notifier) { + notifier->setEnabled(false); + notifier->deleteLater(); + notifier = nullptr; + } + if (socketFd >= 0 && socketFd != fd) + ::close(socketFd); + + socketFd = fd; + notifier = new QSocketNotifier(fd, QSocketNotifier::Read, this); + QObject::connect(notifier, &QSocketNotifier::activated, notifier, [this]() { + drainSocket(); + }); + } + + // Runs in the reader thread. Releases the socket and the notifier. + void shutdown() + { + if (notifier) { + notifier->setEnabled(false); + delete notifier; + notifier = nullptr; + } + + if (socketFd >= 0) { + ::close(socketFd); + socketFd = -1; + } + } + +private: + // Runs in the reader thread (QSocketNotifier callback): drain everything + // the kernel has buffered, then return. Level-triggered, so a still-full + // buffer re-arms the notifier. + void drainSocket() + { + constexpr size_t kMinMessageSize = offsetof(DispatchEvent, eventPath) + 1; + constexpr size_t kPathOffset = offsetof(DispatchEvent, eventPath); + + while (socketFd >= 0) { + // The kernel advances iov_base/iov_len while consuming a + // message, so restore them before every batch. + for (int i = 0; i < kReceiveBatch; ++i) { + iovs[i].iov_base = &receiveSlots[i]; + iovs[i].iov_len = sizeof(DispatchEvent); + } + + const int received = ::recvmmsg(socketFd, msgHeaders.data(), + static_cast(msgHeaders.size()), + 0, nullptr); + if (received < 0) { + if (errno == EINTR) + continue; + + if (errno == EAGAIN || errno == EWOULDBLOCK) + break; // fully drained for now + + qWarning() << "VfsMonitor: failed to receive dispatcher event:" << std::strerror(errno); + flushPendingBatch(); + breakConnection(); + return; + } + + for (int i = 0; i < received; ++i) { + const size_t length = msgHeaders[i].msg_len; + + if (length == 0) { + // SEQPACKET EOF: the dispatcher closed the connection. + qWarning() << "VfsMonitor: event dispatcher connection closed"; + flushPendingBatch(); + breakConnection(); + return; + } + + if (length < kMinMessageSize) { + qWarning() << "VfsMonitor: received short dispatcher message:" << length; + continue; + } + + DispatchEvent &event = receiveSlots[i]; + + // The sender transmits offsetof(eventPath) + strlen + 1 bytes + // (NUL included), so terminate in place at the received + // length instead of clearing the whole 4 KiB slot. + event.eventPath[std::min(length - kPathOffset, + kDispatchMaxPathLen - 1)] = '\0'; + + const int act = event.action; + if (act < ACT_NEW_FILE || act > ACT_CLOSE_WRITE_FILE) + continue; + + if (act == ACT_MOUNT || act == ACT_UNMOUNT) { + // Refreshing the mount table (mtab parse + alias stats) + // inside this loop would stall the drain mid-burst long + // enough for the dispatcher to overflow and kick us; + // coalesce and run it once after the loop instead. + mountRefreshPending = true; + continue; + } + + // RENAME_TO is always forwarded: an unresolved destination + // means "renamed out of the monitored roots" for the paired + // RENAME_FROM, and a missing pair means "created here" + // (kept semantics). + if (act == ACT_RENAME_TO_FILE || act == ACT_RENAME_TO_FOLDER) { + const QString resolved = d->resolveAndFilterFullPath(event.eventPath); + pendingBatch.append(QueuedFsEvent { act, event.cookie, QString(), resolved }); + continue; + } + + const QString resolved = d->resolveAndFilterFullPath(event.eventPath); + if (resolved.isNull()) + continue; + + pendingBatch.append(QueuedFsEvent { act, event.cookie, resolved, QString() }); + } + + flushPendingBatch(); + } + + if (mountRefreshPending) { + mountRefreshPending = false; + if (!d->initMountPoints()) + qWarning() << "VfsMonitor: failed to refresh mount point aliases"; + } + + d->scheduleEventDrain(); + } + + // Pushes the events collected since the last flush into the userspace + // queue in one locked pass (dropping on overflow — never blocking). + // Runs in the reader thread. + void flushPendingBatch() + { + if (pendingBatch.isEmpty()) + return; + + { + QMutexLocker locker(&d->queueMutex); + for (QueuedFsEvent &event : pendingBatch) { + if (d->eventQueue.size() >= d->maxQueuedEvents) { + if (!d->overflowFlag.fetchAndStoreRelaxed(1)) { + qWarning() << "VfsMonitor: event queue full (" << d->maxQueuedEvents + << "), dropping events until drained"; + } + break; + } + d->eventQueue.enqueue(std::move(event)); + } + } + pendingBatch.clear(); + + d->scheduleEventDrain(); + } + + // Runs in the reader thread. The notifier must be disabled and destroyed + // via deleteLater because this is called from inside its activated() + // signal. + void breakConnection() + { + if (notifier) { + notifier->setEnabled(false); + notifier->deleteLater(); + notifier = nullptr; + } + + if (socketFd >= 0) { + ::close(socketFd); + socketFd = -1; + } + + // Everything delivered while the connection is down is lost; the + // service compensates with a full update task (eventsLost fallback). + Q_EMIT d->q_ptr->eventsLost(); + QMetaObject::invokeMethod(d->q_ptr, [d = d]() { d->handleDisconnect(); }, Qt::QueuedConnection); + } + + VfsMonitorFileSystemWatcherPrivate *d; + QSocketNotifier *notifier { nullptr }; + int socketFd { -1 }; + + // Reused recvmmsg buffers: one syscall collects up to kReceiveBatch + // packets (kDispatchMaxPathLen-sized each). The iovec pointers are + // reset before every call because the kernel advances them while + // consuming a message. + static constexpr int kReceiveBatch = 64; + std::vector receiveSlots; + std::vector msgHeaders; + std::vector iovs; + // Events decoded since the last flush, parked in reader-thread-owned + // storage so the userspace queue is filled under one lock per batch. + QVector pendingBatch; + bool mountRefreshPending { false }; +}; + +// ========== VfsMonitorFileSystemWatcherPrivate ========== + +VfsMonitorFileSystemWatcherPrivate::VfsMonitorFileSystemWatcherPrivate( + const QStringList &rootPaths, + VfsMonitorFileSystemWatcher::PathExcludePredicate excludePredicate, + VfsMonitorFileSystemWatcher *qq) + : q_ptr(qq), excludePredicate(std::move(excludePredicate)) +{ + this->rootPaths.reserve(rootPaths.size()); + for (const QString &path : rootPaths) { + this->rootPaths.append(QDir(path).absolutePath()); + } + this->rootPaths.removeDuplicates(); +} + +VfsMonitorFileSystemWatcherPrivate::~VfsMonitorFileSystemWatcherPrivate() +{ + if (reconnectTimer) { + reconnectTimer->stop(); + } + + if (readerThread) { + if (readerThread->isRunning() && reader) { + // Ensure the notifier and the fd owned by the reader thread are + // released before the thread is torn down. + QMetaObject::invokeMethod(reader, [r = reader]() { r->shutdown(); }, + Qt::BlockingQueuedConnection); + } + readerThread->quit(); + readerThread->wait(); + } + + delete reader; + reader = nullptr; + + // Close an fd that was connected but never adopted by the reader thread. + const int fd = pendingFd.fetchAndStoreRelaxed(-1); + if (fd >= 0) + ::close(fd); +} + +bool VfsMonitorFileSystemWatcherPrivate::initMountPoints() +{ + mountPoints.clear(); + orderedMountPoints.clear(); + rootAliases.clear(); + + libmnt_table *mtab = mnt_new_table(); + if (!mtab) + return false; + + if (mnt_table_parse_mtab(mtab, nullptr) < 0) { + mnt_free_table(mtab); + return false; + } + + const QHash byMountId = collectMountEntries(mtab); + mnt_free_table(mtab); + + for (auto it = byMountId.cbegin(); it != byMountId.cend(); ++it) { + const MountEntry &entry = it.value(); + if (!isParentChainUnderRoot(byMountId, entry)) + continue; + + mountPoints[entry.deviceId].append(entry.mountPoint); + orderedMountPoints.append({ entry.deviceId, entry.mountPoint }); + } + + for (auto &points : mountPoints) { + points.removeDuplicates(); + std::sort(points.begin(), points.end(), + [](const QString &left, const QString &right) { + return left.length() > right.length(); + }); + } + + std::sort(orderedMountPoints.begin(), orderedMountPoints.end(), + [](const MountPointAlias &left, const MountPointAlias &right) { + return left.mountPoint.length() > right.mountPoint.length(); + }); + + rebuildRootAliases(); + return !mountPoints.isEmpty(); +} + +void VfsMonitorFileSystemWatcherPrivate::rebuildRootAliases() +{ + rootAliases.clear(); + + for (const QString &rootPath : std::as_const(rootPaths)) { + const FileIdentity rootIdentity = identifyPath(rootPath); + if (!rootIdentity.valid) + continue; + + for (const MountPointAlias &alias : std::as_const(orderedMountPoints)) { + if (alias.mountPoint == "/") + continue; + + const QString aliasRoot = QDir::cleanPath(alias.mountPoint + rootPath); + if (aliasRoot == rootPath) + continue; + + const FileIdentity aliasIdentity = identifyPath(aliasRoot); + if (!aliasIdentity.valid) + continue; + + if (aliasIdentity.deviceId != rootIdentity.deviceId + || aliasIdentity.inode != rootIdentity.inode) { + continue; + } + + rootAliases.append(qMakePair(aliasRoot, rootPath)); + } + } + + std::sort(rootAliases.begin(), rootAliases.end(), + [](const QPair &left, const QPair &right) { + return left.first.length() > right.first.length(); + }); +} + +QString VfsMonitorFileSystemWatcherPrivate::resolveAndFilterFullPath(const char *absolutePath) const +{ + if (!absolutePath || absolutePath[0] == '\0') + return {}; + + const QString fullPath = QDir::cleanPath(QString::fromUtf8(absolutePath)); + if (!fullPath.startsWith('/')) + return {}; + + const QString directPath = filterDirectPath(rootPaths, excludePredicate, fullPath); + if (!directPath.isNull()) + return directPath; + + for (const auto &alias : rootAliases) { + if (!isDescendantOfRoot(fullPath, alias.first)) + continue; + + const QString suffix = fullPath.mid(alias.first.length()); + const QString translatedPath = alias.second + suffix; + const QString filteredTranslated = filterDirectPath(rootPaths, excludePredicate, translatedPath); + if (!filteredTranslated.isNull()) + return filteredTranslated; + } + + for (const MountPointAlias &sourceAlias : orderedMountPoints) { + if (!mountPointStartsWith(fullPath, sourceAlias.mountPoint)) + continue; + + const auto pointsIt = mountPoints.constFind(sourceAlias.deviceId); + if (pointsIt == mountPoints.cend()) + return {}; + + const QString suffix = (sourceAlias.mountPoint == "/") + ? fullPath + : fullPath.mid(sourceAlias.mountPoint.length()); + + for (const QString &candidateMountPoint : pointsIt.value()) { + const QString candidateFullPath = (candidateMountPoint == "/") + ? suffix + : candidateMountPoint + suffix; + const QString filteredCandidate = filterDirectPath(rootPaths, excludePredicate, candidateFullPath); + if (!filteredCandidate.isNull()) + return filteredCandidate; + } + + // The longest matching source mount point wins. If its aliases do not + // land inside a monitored root, do not fall back to shorter prefixes. + return {}; + } + + return {}; +} + +QPair VfsMonitorFileSystemWatcherPrivate::splitPath(const QString &fullPath) +{ + QFileInfo fi(fullPath); + return qMakePair(fi.absolutePath(), fi.fileName()); +} + +int VfsMonitorFileSystemWatcherPrivate::connectDispatcherSocket() +{ + // Non-blocking fd: the reader thread drains until EAGAIN. + int fd = ::socket(AF_UNIX, SOCK_SEQPACKET | SOCK_NONBLOCK, 0); + if (fd < 0) { + qWarning() << "VfsMonitor: failed to create dispatcher socket:" << std::strerror(errno); + return -1; + } + + sockaddr_un address {}; + address.sun_family = AF_UNIX; + const QByteArray path = socketPath.toUtf8(); + std::strncpy(address.sun_path, path.constData(), sizeof(address.sun_path) - 1); + + if (::connect(fd, reinterpret_cast(&address), sizeof(address)) != 0) { + qWarning() << "VfsMonitor: deepin-anything event dispatcher not available:" << std::strerror(errno); + ::close(fd); + return -1; + } + + // Enlarge the receive buffer for burst headroom (mirrors deepin-anything + // commit f2dd210). Note the kernel caps this at net.core.rmem_max + // (default ~416 KiB ≈ ~100 packets of 4 KB) — buffer sizes alone can + // never absorb a burst of thousands of events, which is why draining + // happens on the dedicated reader thread instead. + constexpr int kReceiveBufSize = 4 << 20; + if (::setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &kReceiveBufSize, + sizeof(kReceiveBufSize)) < 0) { + qDebug() << "VfsMonitor: setsockopt(SO_RCVBUF) failed:" << std::strerror(errno); + } + + return fd; +} + +void VfsMonitorFileSystemWatcherPrivate::startReaderThread(int fd) +{ + reader = new VfsSocketReader(this); + readerThread = new QThread(q_ptr); + reader->moveToThread(readerThread); + pendingFd.storeRelaxed(fd); + readerThread->start(); + QMetaObject::invokeMethod(reader, [this, fd]() { reader->begin(fd); }, Qt::QueuedConnection); +} + +bool VfsMonitorFileSystemWatcherPrivate::initDispatcher() +{ + Q_Q(VfsMonitorFileSystemWatcher); + + if (!initMountPoints()) { + qWarning() << "VfsMonitor: failed to initialize mount point aliases"; + } + + // Resolve the dispatcher socket path. Production uses the well-known + // path; the DFM_VFSMONITOR_SOCKET_PATH env var lets unit tests point the + // watcher at a mock dispatcher they control. + socketPath = QString::fromUtf8(qgetenv("DFM_VFSMONITOR_SOCKET_PATH")); + if (socketPath.isEmpty()) + socketPath = QString::fromUtf8(kDispatcherSocketPath); + + // Reconnect timer lives on the home thread (the thread that called + // create()). It is single-shot and rearmed by attemptReconnect(). + reconnectTimer = new QTimer(q); + reconnectTimer->setSingleShot(true); + QObject::connect(reconnectTimer, &QTimer::timeout, q, [this]() { + attemptReconnect(); + }); + reconnectBackoffMs = 0; + + // Queue capacity override for tests and tuning. + bool ok = false; + const int envQueue = qEnvironmentVariableIntValue("DFM_VFSMONITOR_MAX_QUEUE", &ok); + if (ok && envQueue > 0) + maxQueuedEvents = envQueue; + + const int fd = connectDispatcherSocket(); + if (fd < 0) { + // Initial connection failed: the dispatcher is not running yet. + // Return false so create() reports the watcher as unavailable and + // FSMonitorPrivate degrades to inotify-only mode. The auto-reconnect + // timer created above only self-heals connections that were + // established at runtime and then dropped; it cannot help here + // because create() deletes this watcher on a failed first connect. + return false; + } + + startReaderThread(fd); + + qInfo() << "VfsMonitor: connected to deepin-anything event dispatcher"; + return true; +} + +void VfsMonitorFileSystemWatcherPrivate::scheduleEventDrain() +{ + if (!drainScheduled.testAndSetRelaxed(0, 1)) + return; + + QMetaObject::invokeMethod(q_ptr, [this]() { drainQueuedEvents(); }, Qt::QueuedConnection); +} + +void VfsMonitorFileSystemWatcherPrivate::drainQueuedEvents() +{ + Q_Q(VfsMonitorFileSystemWatcher); + + // Re-open the gate before checking the queue so an event enqueued while + // this drain runs cannot be lost (see scheduleEventDrain). + drainScheduled.storeRelaxed(0); + + QVector batch; + { + QMutexLocker locker(&queueMutex); + while (!eventQueue.isEmpty() && batch.size() < kMaxEventsPerDrain) + batch.append(eventQueue.dequeue()); + } + + if (!batch.isEmpty()) { + for (const QueuedFsEvent &event : std::as_const(batch)) + dispatchQueuedEvent(event); + + // Clean up orphaned RENAME_FROM entries. + static constexpr int kPendingRenameCleanupThreshold = 1000; + if (pendingRenames.size() > kPendingRenameCleanupThreshold) { + qWarning() << "VfsMonitor: pending rename table too large (" + << pendingRenames.size() << "), clearing"; + pendingRenames.clear(); + } + } + + { + QMutexLocker locker(&queueMutex); + if (!eventQueue.isEmpty()) { + scheduleEventDrain(); + } + } + + if (overflowFlag.testAndSetRelaxed(1, 0)) { + qWarning() << "VfsMonitor: userspace event queue overflowed, filesystem events were dropped"; + Q_EMIT q->eventsLost(); + } +} + +void VfsMonitorFileSystemWatcherPrivate::dispatchQueuedEvent(const QueuedFsEvent &event) +{ + auto *q = q_ptr; + const int act = event.action; + + if (act == ACT_RENAME_FROM_FILE || act == ACT_RENAME_FROM_FOLDER) { + auto [parentPath, name] = splitPath(event.pathA); + RenameFromInfo info; + info.path = parentPath; + info.name = name; + info.isDirectory = (act == ACT_RENAME_FROM_FOLDER); + pendingRenames.insert(event.cookie, info); + return; + } + + if (act == ACT_RENAME_TO_FILE || act == ACT_RENAME_TO_FOLDER) { + const bool isDir = (act == ACT_RENAME_TO_FOLDER); + auto it = pendingRenames.find(event.cookie); + if (it != pendingRenames.end()) { + if (!event.pathB.isEmpty()) { + auto [parentPath, name] = splitPath(event.pathB); + if (isDir) + Q_EMIT q->directoryMoved(it->path, it->name, parentPath, name); + else + Q_EMIT q->fileMoved(it->path, it->name, parentPath, name); + } else { + // Destination outside the monitored roots: the source + // effectively disappeared from the index. + if (isDir) + Q_EMIT q->directoryDeleted(it->path, it->name); + else + Q_EMIT q->fileDeleted(it->path, it->name); + } + pendingRenames.erase(it); + } else if (!event.pathB.isEmpty()) { + auto [parentPath, name] = splitPath(event.pathB); + if (isDir) + Q_EMIT q->directoryCreated(parentPath, name); + else + Q_EMIT q->fileCreated(parentPath, name); + } + return; + } + + auto [parentPath, name] = splitPath(event.pathA); + + switch (act) { + case ACT_NEW_FILE: + case ACT_NEW_LINK: + case ACT_NEW_SYMLINK: + Q_EMIT q->fileCreated(parentPath, name); + break; + case ACT_NEW_FOLDER: + Q_EMIT q->directoryCreated(parentPath, name); + break; + case ACT_DEL_FILE: + Q_EMIT q->fileDeleted(parentPath, name); + break; + case ACT_DEL_FOLDER: + Q_EMIT q->directoryDeleted(parentPath, name); + break; + case ACT_RENAME_FILE: + Q_EMIT q->fileCreated(parentPath, name); + break; + case ACT_RENAME_FOLDER: + Q_EMIT q->directoryCreated(parentPath, name); + break; + case ACT_CLOSE_WRITE_FILE: + Q_EMIT q->fileClosed(parentPath, name); + break; + default: + break; + } +} + +void VfsMonitorFileSystemWatcherPrivate::handleDisconnect() +{ + // The reader thread has already released the socket and the notifier. + // Backoff: start at 1 s, double up to 30 s. Reset to 0 on a successful + // reconnect (attemptReconnect) so the next outage starts fresh. + if (reconnectBackoffMs <= 0) + reconnectBackoffMs = 1000; + + if (!reconnectTimer) + return; // shutting down + + qInfo() << "VfsMonitor: scheduling dispatcher reconnect in" << reconnectBackoffMs << "ms"; + reconnectTimer->start(reconnectBackoffMs); +} + +void VfsMonitorFileSystemWatcherPrivate::attemptReconnect() +{ + const int fd = connectDispatcherSocket(); + if (fd >= 0) { + // Hand the new fd to the reader thread (which owns the notifier). + pendingFd.storeRelaxed(fd); + QMetaObject::invokeMethod(reader, [this, fd]() { reader->begin(fd); }, Qt::QueuedConnection); + reconnectBackoffMs = 0; // success: next outage restarts at 1 s + qInfo() << "VfsMonitor: reconnected to deepin-anything event dispatcher"; + return; + } + + // Grow the backoff (cap at 30 s) and retry. + reconnectBackoffMs = std::min(reconnectBackoffMs * 2, 30000); + if (reconnectTimer) + reconnectTimer->start(reconnectBackoffMs); +} + +// ========== VfsMonitorFileSystemWatcher ========== + +VfsMonitorFileSystemWatcher::VfsMonitorFileSystemWatcher(const QStringList &rootPaths, + PathExcludePredicate excludePredicate, + QObject *parent) + : QObject(parent), d_ptr(new VfsMonitorFileSystemWatcherPrivate(rootPaths, std::move(excludePredicate), this)) +{ +} + +VfsMonitorFileSystemWatcher::~VfsMonitorFileSystemWatcher() +{ +} + +VfsMonitorFileSystemWatcher *VfsMonitorFileSystemWatcher::create(const QStringList &rootPaths, + PathExcludePredicate excludePredicate, + QObject *parent) +{ + auto *watcher = new VfsMonitorFileSystemWatcher(rootPaths, std::move(excludePredicate), parent); + + if (!watcher->d_func()->initDispatcher()) { + delete watcher; + return nullptr; + } + + return watcher; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/fsmonitor/vfsmonitorwatcher.h b/src/index/fsmonitor/vfsmonitorwatcher.h new file mode 100644 index 00000000..5d5f1e12 --- /dev/null +++ b/src/index/fsmonitor/vfsmonitorwatcher.h @@ -0,0 +1,77 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef VFSMONITORWATCHER_H +#define VFSMONITORWATCHER_H + +#include "index_global.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class VfsMonitorFileSystemWatcherPrivate; + +// VfsMonitorFileSystemWatcher: File system watcher using deepin-anything +// event dispatcher socket exposed by deepin-anything-server. +// +// Receives global file system events (create, delete, move, close-write) +// forwarded by deepin-anything-server from +// /run/deepin-anything/event-dispatcher.sock. +// +// Usage: +// auto *watcher = VfsMonitorFileSystemWatcher::create(rootPaths, excludePredicate, parent); +// if (watcher) { ... } // event dispatcher available +// // else: fallback to inotify-only mode +class VfsMonitorFileSystemWatcher : public QObject +{ + Q_OBJECT + Q_DISABLE_COPY_MOVE(VfsMonitorFileSystemWatcher) + Q_DECLARE_PRIVATE(VfsMonitorFileSystemWatcher) + +public: + // Predicate for path exclusion. Return true to suppress the event. + // Called from the socket reader thread (not the home thread); it must + // only touch thread-safe state (syscalls, atomics, const data). + using PathExcludePredicate = std::function; + + ~VfsMonitorFileSystemWatcher() override; + + // Factory method: attempts to connect to the deepin-anything event + // dispatcher socket. Returns nullptr if the dispatcher is not available + // (graceful degradation). + static VfsMonitorFileSystemWatcher *create(const QStringList &rootPaths, + PathExcludePredicate excludePredicate, + QObject *parent = nullptr); + +Q_SIGNALS: + void fileCreated(const QString &path, const QString &name); + void fileDeleted(const QString &path, const QString &name); + void fileMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + void directoryCreated(const QString &path, const QString &name); + void directoryDeleted(const QString &path, const QString &name); + void directoryMoved(const QString &fromPath, const QString &fromName, + const QString &toPath, const QString &toName); + void fileClosed(const QString &path, const QString &name); + + // Emitted when filesystem events were lost and cannot be replayed: + // either the dispatcher connection dropped (events during the outage) + // or the internal event queue overflowed under an extreme burst. + // Consumers should schedule a full index update to re-sync. + void eventsLost(); + +private: + explicit VfsMonitorFileSystemWatcher(const QStringList &rootPaths, + PathExcludePredicate excludePredicate, + QObject *parent = nullptr); + + QScopedPointer d_ptr; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // VFSMONITORWATCHER_H diff --git a/src/index/fsmonitor/vfsmonitorwatcher_p.h b/src/index/fsmonitor/vfsmonitorwatcher_p.h new file mode 100644 index 00000000..fdca9df5 --- /dev/null +++ b/src/index/fsmonitor/vfsmonitorwatcher_p.h @@ -0,0 +1,162 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef VFSMONITORWATCHER_P_H +#define VFSMONITORWATCHER_P_H + +#include "vfsmonitorwatcher.h" + +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +// Userspace queue capacity. 500k events (~tens of MB worst case) comfortably +// covers a 300k-file burst; beyond that events are dropped and reported via +// eventsLost() so the service schedules a full update as the last fallback. +// Override for tests via DFM_VFSMONITOR_MAX_QUEUE. +inline constexpr int kDefaultMaxQueuedEvents = 500000; + +class VfsSocketReader; + +// Stores information from a RENAME_FROM event, awaiting RENAME_TO pairing. +struct RenameFromInfo +{ + QString path; + QString name; + bool isDirectory { false }; +}; + +struct MountPointAlias +{ + dev_t deviceId { 0 }; + QString mountPoint; +}; + +// One decoded dispatcher event parked in the userspace queue between the +// socket reader thread and the watcher's home thread. +struct QueuedFsEvent +{ + int action { 0 }; + uint32_t cookie { 0 }; + // Event path (absolute). For RENAME_TO events this stays empty; the + // destination (resolved or not) is carried by pathB. + QString pathA; + // RENAME_TO only: resolved destination path, empty when the destination + // lies outside the monitored roots (=> paired RENAME_FROM means deletion). + QString pathB; +}; + +// Event action constants (matching vfs_change_consts.h) +enum VfsMonitorAct : uint8_t { + ACT_NEW_FILE = 0, + ACT_NEW_LINK = 1, + ACT_NEW_SYMLINK = 2, + ACT_NEW_FOLDER = 3, + ACT_DEL_FILE = 4, + ACT_DEL_FOLDER = 5, + ACT_RENAME_FILE = 6, + ACT_RENAME_FOLDER = 7, + ACT_RENAME_FROM_FILE = 8, + ACT_RENAME_TO_FILE = 9, + ACT_RENAME_FROM_FOLDER = 10, + ACT_RENAME_TO_FOLDER = 11, + ACT_MOUNT = 12, + ACT_UNMOUNT = 13, + ACT_CLOSE_WRITE_FILE = 14 +}; + +class VfsMonitorFileSystemWatcherPrivate +{ + Q_DECLARE_PUBLIC(VfsMonitorFileSystemWatcher) + +public: + VfsMonitorFileSystemWatcherPrivate(const QStringList &rootPaths, + VfsMonitorFileSystemWatcher::PathExcludePredicate excludePredicate, + VfsMonitorFileSystemWatcher *qq); + ~VfsMonitorFileSystemWatcherPrivate(); + + bool initDispatcher(); + + // Tear down the current connection state and arm the reconnect timer. + // Safe to call whether or not a connection exists. The socket and the + // notifier are owned by the reader thread; only scheduling happens here. + void handleDisconnect(); + // Timer callback: open a fresh dispatcher connection and hand it to the + // reader thread; on failure grow the backoff. + void attemptReconnect(); + // Create the socket, connect and enlarge the receive buffer. Returns the + // fd on success, -1 on failure. Runs on the home thread; ownership of the + // returned fd is transferred to the reader thread via startReaderThread / + // attemptReconnect. + int connectDispatcherSocket(); + // Spawn the reader thread and hand it a connected fd. + void startReaderThread(int fd); + + // Reader-thread-safe: request an asynchronous drainQueuedEvents() on the + // home thread. Coalesced via drainScheduled so bursts enqueue one wakeup. + void scheduleEventDrain(); + // Home thread: dispatch up to a bounded batch of queued events as signals. + void drainQueuedEvents(); + // Home thread: translate one queued event into the public signals. + void dispatchQueuedEvent(const QueuedFsEvent &event); + // The event dispatcher sends absolute paths, but they may use a different + // mount alias than the monitored root path. This helper normalizes across + // same-device mount aliases before applying rootPaths and excludePredicate. + QString resolveAndFilterFullPath(const char *absolutePath) const; + + static QPair splitPath(const QString &fullPath); + + VfsMonitorFileSystemWatcher *q_ptr; + + QStringList rootPaths; + VfsMonitorFileSystemWatcher::PathExcludePredicate excludePredicate; + + // Reconnection state. After a disconnect the watcher keeps trying to + // reconnect with exponential backoff so monitoring always recovers. + QTimer *reconnectTimer { nullptr }; + int reconnectBackoffMs { 0 }; + + // Reader thread. It owns the connected socket and its QSocketNotifier and + // does nothing but drain the socket into eventQueue, so a slow consumer + // can never make the dispatcher kick us as a "slow client". + VfsSocketReader *reader { nullptr }; + QThread *readerThread { nullptr }; + // fd handed to the reader thread but not yet adopted (close in destructor + // if the hand-off never completes). + QAtomicInt pendingFd { -1 }; + + // Userspace event queue between the reader thread and the home thread. + // Guarded by queueMutex. If it fills up, events are dropped and + // overflowFlag is set; the next drain reports VfsMonitor eventsLost(). + QMutex queueMutex; + QQueue eventQueue; + QAtomicInt drainScheduled { 0 }; + QAtomicInt overflowFlag { 0 }; + int maxQueuedEvents { kDefaultMaxQueuedEvents }; + + // Overridable socket path (env: DFM_VFSMONITOR_SOCKET_PATH). Defaults to + // kDispatcherSocketPath; used by unit tests to point at a mock dispatcher. + QString socketPath; + + QHash pendingRenames; + QHash mountPoints; + QVector orderedMountPoints; + QVector> rootAliases; + + bool initMountPoints(); + void rebuildRootAliases(); +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // VFSMONITORWATCHER_P_H diff --git a/src/index/index_global.h b/src/index/index_global.h new file mode 100644 index 00000000..be758a7c --- /dev/null +++ b/src/index/index_global.h @@ -0,0 +1,105 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEX_GLOBAL_H +#define INDEX_GLOBAL_H + +#include +#include +#include + +#define ANYTHING_INDEX_NAMESPACE anything_index +#define ANYTHING_INDEX_BEGIN_NAMESPACE namespace ANYTHING_INDEX_NAMESPACE { +#define ANYTHING_INDEX_END_NAMESPACE } +#define ANYTHING_INDEX_USE_NAMESPACE using namespace ANYTHING_INDEX_NAMESPACE; + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace Defines { + +// The systemd user unit that hosts this service. CPU quota throttling +// (SystemdCpuUtils) targets this unit. +inline const QString kIndexSystemdUnitName = QLatin1String("deepin-anything-index.service"); +inline const QString kAnythingDirType = QLatin1String("dir"); +inline const QString kAnythingDocType = QLatin1String("doc"); +inline const QString kAnythingPicType = QLatin1String("pic"); +inline const QString kTextIndexDBusService = QLatin1String("org.deepin.Filemanager.TextIndex"); +inline const QString kTextIndexDBusObjectPath = QLatin1String("/org/deepin/Filemanager/TextIndex"); +inline const QString kOcrIndexDBusService = QLatin1String("org.deepin.Filemanager.OcrIndex"); +inline const QString kOcrIndexDBusObjectPath = QLatin1String("/org/deepin/Filemanager/OcrIndex"); +inline const QString kFileNameIndexDBusService = QLatin1String("org.deepin.Filemanager.FileNameIndex"); +inline const QString kFileNameIndexDBusObjectPath = QLatin1String("/org/deepin/Filemanager/FileNameIndex"); + +// Dconfig +namespace DConf { +inline const QString kTextIndexSchema = QLatin1String("org.deepin.dde.file-manager.textindex"); +inline const QString kAutoIndexUpdateInterval = QLatin1String("autoIndexUpdateInterval"); +inline const QString kMonitoringStartDelaySeconds = QLatin1String("monitoringStartDelaySeconds"); +inline const QString kSilentIndexUpdateDelay = QLatin1String("silentIndexUpdateDelay"); +inline const QString kInotifyResourceCleanupDelay = QLatin1String("inotifyResourceCleanupDelay"); +inline const QString kMaxIndexTextFileSizeMB = QLatin1String("maxIndexFileSizeMB"); +inline const QString kMaxIndexFileTruncationSizeMB = QLatin1String("maxIndexFileTruncationSizeMB"); +inline const QString kSupportedTextFileExtensions = QLatin1String("supportedFileExtensions"); +inline const QString kIndexHiddenFiles = QLatin1String("indexHiddenFiles"); +inline const QString kFolderExcludeFilters = QLatin1String("folderExcludeFilters"); +inline const QString kCpuUsageLimitPercent = QLatin1String("cpuUsageLimitPercent"); +inline const QString kInotifyWatchesCoefficient = QLatin1String("inotifyWatchesCoefficient"); +inline const QString kBatchCommitInterval = QLatin1String("batchCommitInterval"); + +// Strategy optimization – environment detection +inline const QString kIdleThresholdSeconds = QLatin1String("idleThresholdSeconds"); +inline const QString kLoadSampleIntervalSeconds = QLatin1String("loadSampleIntervalSeconds"); +inline const QString kCpuLoadThresholdPercent = QLatin1String("cpuLoadThresholdPercent"); +inline const QString kDiskBusyThresholdPercent = QLatin1String("diskBusyThresholdPercent"); + +// Strategy optimization – task grading thresholds +inline const QString kLightIncrementFileCountThreshold = QLatin1String("lightIncrementFileCountThreshold"); +inline const QString kLightIncrementOcrFileCountThreshold = QLatin1String("lightIncrementOcrFileCountThreshold"); +inline const QString kLightIncrementSizeThresholdMB = QLatin1String("lightIncrementSizeThresholdMB"); + +} // namesapce DConf + +// NOTE: The version number must be upgraded +// when the index contents are changed to ensure +// that the index can be rebuilt!!! +// History: +// Version 1: add "filename" filed +// Version 2: add new filed "ancestor_paths" +// Version 3: add new time-related fields +// Version 4: switch content index analyzer to NGramAnalyzer(2,2) +// Version 5: switch content index analyzer to LowerCaseNGramAnalyzer(1,2) +// Version 6: add new field "file_ext" +inline constexpr int kTextIndexVersion { 6 }; + +// OCR index version history: +// Version 0: initial OCR text index schema +// Version 1: switch OCR index analyzer to NGramAnalyzer(2,2) +// Version 2: switch OCR index analyzer to LowerCaseNGramAnalyzer(1,2) +// Version 3: add new field "file_ext" +inline constexpr int kOcrIndexVersion { 3 }; + +// Filename index version history: +// Version 1: initial filename index schema +inline constexpr int kFilenameIndexVersion { 1 }; + +// json - key +inline const QString kTextVersionKey = QLatin1String("version"); +inline const QString kOcrVersionKey = QLatin1String("version"); +inline const QString kFilenameVersionKey = QLatin1String("version"); +inline const QString kLastUpdateTimeKey = QLatin1String("lastUpdateTime"); +inline const QString kStateKey = QLatin1String("state"); +inline const QString kNeedsRebuildKey = QLatin1String("needsRebuild"); +inline const QString kCreateInProgressKey = QLatin1String("createInProgress"); +inline const QString kUpdateInProgressKey = QLatin1String("updateInProgress"); +inline const QString kBacklogExceededKey = QLatin1String("backlogExceeded"); + +// json - value +inline const QString kStateClean = QLatin1String("clean"); // state +inline const QString kStateDirty = QLatin1String("dirty"); // state +} // namespace Defines + + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEX_GLOBAL_H diff --git a/src/index/main.cpp b/src/index/main.cpp new file mode 100644 index 00000000..bc8476f7 --- /dev/null +++ b/src/index/main.cpp @@ -0,0 +1,69 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "serviceentry.h" + +#include +#include + +#include +#include +#include +#include + +// Write end of a pipe used to turn SIGTERM/SIGINT into Qt events. +static int g_signalWriteFd = -1; + +static void signalHandler(int sig) +{ + (void)sig; + const char byte = 1; + ssize_t written = write(g_signalWriteFd, &byte, sizeof(byte)); + (void)written; // async-signal-safe best effort +} + +int main(int argc, char *argv[]) +{ + // IdleMonitor relies on KIdleTime, whose poller plugins are tied to a QPA + // platform integration (a QCoreApplication finds none). Run with the real + // session platform when a display exists, offscreen otherwise (same + // pattern as deepin-anything-extractor). + if (qEnvironmentVariableIsEmpty("QT_QPA_PLATFORM") + && qEnvironmentVariableIsEmpty("DISPLAY") + && qEnvironmentVariableIsEmpty("WAYLAND_DISPLAY")) { + qputenv("QT_QPA_PLATFORM", QByteArrayLiteral("offscreen")); + } + + QGuiApplication app(argc, argv); + QGuiApplication::setApplicationName("deepin-anything-index"); + QGuiApplication::setApplicationVersion("1.0.0"); + + anything_index::registerIndexServices(); + + // Turn SIGTERM/SIGINT into a graceful shutdown (stop monitoring, stop the + // running task, mark unfinished indexes dirty, unregister bus names). + int signalFds[2]; + if (socketpair(AF_UNIX, SOCK_STREAM, 0, signalFds) == 0) { + g_signalWriteFd = signalFds[1]; + auto *notifier = new QSocketNotifier(signalFds[0], QSocketNotifier::Read, &app); + QObject::connect(notifier, &QSocketNotifier::activated, &app, []() { + anything_index::unregisterIndexServices(); + QCoreApplication::exit(0); + }); + struct sigaction sa; + sa.sa_handler = signalHandler; + sigemptyset(&sa.sa_mask); + sa.sa_flags = SA_RESTART; + sigaction(SIGTERM, &sa, nullptr); + sigaction(SIGINT, &sa, nullptr); + } else { + qWarning() << "deepin-anything-index: failed to create signal pipe, graceful shutdown disabled"; + } + + QObject::connect(&app, &QCoreApplication::aboutToQuit, &app, []() { + anything_index::unregisterIndexServices(); + }); + + return app.exec(); +} diff --git a/src/index/profile/indexprofile.cpp b/src/index/profile/indexprofile.cpp new file mode 100644 index 00000000..18f9f64b --- /dev/null +++ b/src/index/profile/indexprofile.cpp @@ -0,0 +1,382 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "indexprofile.h" +#include "extractor/contentdeduplication.h" +#include "extractor/ocrdeduplication.h" +#include "lowercasengramanalyzer.h" +#include "utils/filehash.h" +#include "utils/indexutility.h" +#include "utils/textindexconfig.h" + +#include +#include + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +IndexProfile::Type IndexProfile::type() const +{ + return m_identity.type; +} + +const QString &IndexProfile::id() const +{ + return m_identity.id; +} + +QString IndexProfile::indexDirectory() const +{ + return m_providers.indexDirectory ? m_providers.indexDirectory() : QString(); +} + +QString IndexProfile::statusFilePath() const +{ + const QString indexDir = indexDirectory(); + if (indexDir.isEmpty()) { + return QString(); + } + + return indexDir + QLatin1Char('/') + m_identity.statusFileName; +} + +const QString &IndexProfile::versionKey() const +{ + return m_identity.versionKey; +} + +bool IndexProfile::isIndexAvailable() const +{ + return m_providers.availability ? m_providers.availability() : false; +} + +int IndexProfile::runtimeIndexVersion() const +{ + return m_identity.runtimeVersion; +} + +bool IndexProfile::isPathInScope(const QString &path) const +{ + return m_providers.scope ? m_providers.scope(path) : false; +} + +bool IndexProfile::isCandidateFile(const QString &path) const +{ + return m_providers.candidate ? m_providers.candidate(path) : false; +} + +IndexProfile::AnythingSearchOptions IndexProfile::anythingSearchOptions() const +{ + return m_providers.anythingSearchOptions ? m_providers.anythingSearchOptions() : AnythingSearchOptions {}; +} + +bool IndexProfile::supportsAnything() const +{ + return !anythingSearchOptions().isEmpty(); +} + +QString IndexProfile::computeChecksum(const QString &filePath) const +{ + return m_providers.checksum ? m_providers.checksum(filePath) : QString(); +} + +QString IndexProfile::lookupCachedText(const QString &checksum) const +{ + return m_providers.textCache ? m_providers.textCache(checksum) : QString(); +} + +bool IndexProfile::supportsChecksum() const +{ + return static_cast(m_providers.checksum); +} + +bool IndexProfile::shouldCheckEnvPolicy() const +{ + return m_runtimePolicy.checkEnvPolicy; +} + +const IndexProfile::RuntimePolicy &IndexProfile::runtimePolicy() const +{ + return m_runtimePolicy; +} + +const IndexProfile::FilterPolicy &IndexProfile::filterPolicy() const +{ + return m_filterPolicy; +} + +bool IndexProfile::shouldSkipHiddenEntry(const QString &path) const +{ + // 只对隐藏路径有意义；非隐藏路径恒不跳过 + if (!DFMSEARCH::Global::isHiddenPathOrInHiddenDir(path)) + return false; + + // Content/Ocr：完全不索引隐藏条目（原有行为） + if (!m_filterPolicy.indexHiddenFiles) + return true; + + // 二级策略（filename）：屏蔽策略命中的隐藏条目（默认主目录下） + return m_filterPolicy.hiddenIndexExclusion + && m_filterPolicy.hiddenIndexExclusion(path); +} + +IndexProfile::MoveUpdatePolicy IndexProfile::moveUpdatePolicy() const +{ + return m_capabilities.moveUpdatePolicy; +} + +bool IndexProfile::requiresContentExtraction() const +{ + return m_capabilities.requiresContentExtraction; +} + +int IndexProfile::lightGradeFileCountThreshold() const +{ + return m_capabilities.lightGradeCountThreshold ? m_capabilities.lightGradeCountThreshold() : 0; +} + +const wchar_t *IndexProfile::pathField() const +{ + switch (m_identity.type) { + case Type::Ocr: + return DFMSEARCH::LuceneFieldNames::OcrText::kPath; + case Type::Filename: + return DFMSEARCH::LuceneFieldNames::FileName::kFullPath; + case Type::Content: + default: + return DFMSEARCH::LuceneFieldNames::Content::kPath; + } +} + +const wchar_t *IndexProfile::contentField() const +{ + switch (m_identity.type) { + case Type::Ocr: + return DFMSEARCH::LuceneFieldNames::OcrText::kOcrContents; + case Type::Filename: + return DFMSEARCH::LuceneFieldNames::FileName::kFileName; + case Type::Content: + default: + return DFMSEARCH::LuceneFieldNames::Content::kContents; + } +} + +const wchar_t *IndexProfile::ancestorPathsField() const +{ + switch (m_identity.type) { + case Type::Ocr: + return DFMSEARCH::LuceneFieldNames::OcrText::kAncestorPaths; + case Type::Filename: + return DFMSEARCH::LuceneFieldNames::FileName::kAncestorPaths; + case Type::Content: + default: + return DFMSEARCH::LuceneFieldNames::Content::kAncestorPaths; + } +} + +const wchar_t *IndexProfile::modifyTimeField() const +{ + switch (m_identity.type) { + case Type::Ocr: + return DFMSEARCH::LuceneFieldNames::OcrText::kModifyTime; + case Type::Filename: + return DFMSEARCH::LuceneFieldNames::FileName::kModifyTime; + case Type::Content: + default: + return DFMSEARCH::LuceneFieldNames::Content::kModifyTime; + } +} + +bool IndexProfile::supportsModifiedTimestampCheck() const +{ + switch (m_identity.type) { + case Type::Ocr: + case Type::Content: + case Type::Filename: + return true; + default: + return false; + } +} + +boost::shared_ptr IndexProfile::createAnalyzer() const +{ + return m_providers.analyzer ? m_providers.analyzer() : nullptr; +} + +int IndexProfile::maxFileTruncationSizeMB() const +{ + const TextIndexConfig &config = TextIndexConfig::instance(); + switch (m_identity.type) { + case Type::Ocr: + return config.maxOcrImageSizeMB(); + case Type::Filename: + return config.maxIndexFileTruncationSizeMB(); + case Type::Content: + default: + return config.maxIndexFileTruncationSizeMB(); + } +} + +IndexProfile IndexProfile::content() +{ + // Capture content index directory for use in the text cache lookup lambda. + const QString contentIndexDir = DFMSEARCH::Global::contentIndexDirectory(); + + Providers providers; + providers.indexDirectory = []() { return DFMSEARCH::Global::contentIndexDirectory(); }; + providers.availability = []() { return DFMSEARCH::Global::isContentIndexAvailable(); }; + providers.scope = [](const QString &path) { return DFMSEARCH::Global::isPathInContentIndexDirectory(path); }; + providers.candidate = [](const QString &path) { return IndexUtility::isSupportedTextFile(path); }; + providers.anythingSearchOptions = []() { + return AnythingSearchOptions { + { Defines::kAnythingDocType }, + TextIndexConfig::instance().supportedTextFileExtensions() + }; + }; + // ChecksumProvider: compute MD5 only for files larger than 1MB + providers.checksum = [](const QString &filePath) { + constexpr qint64 kMinFileSizeForChecksum = 1LL * 1024 * 1024; // 1MB + QFileInfo fi(filePath); + if (fi.size() <= kMinFileSizeForChecksum) { + return QString(); + } + return FileHash::computeMd5(filePath); + }; + // TextCacheLookup: find existing content text by checksum + providers.textCache = [contentIndexDir](const QString &checksum) { + return ContentDeduplication::lookupByTextChecksum(checksum, contentIndexDir); + }; + providers.analyzer = []() -> boost::shared_ptr { + return Lucene::newLucene(1, 2); + }; + + return IndexProfile { + Identity { Type::Content, QStringLiteral("content"), + QStringLiteral("index_status.json"), Defines::kTextVersionKey, Defines::kTextIndexVersion }, + std::move(providers) + }; +} + +IndexProfile IndexProfile::ocr() +{ + // Capture OCR index directory for use in the text cache lookup lambda. + // This avoids repeatedly querying the global function on every lookup call. + const QString ocrIndexDir = DFMSEARCH::Global::ocrTextIndexDirectory(); + + Providers providers; + providers.indexDirectory = []() { return DFMSEARCH::Global::ocrTextIndexDirectory(); }; + providers.availability = []() { return DFMSEARCH::Global::isOcrTextIndexAvailable(); }; + providers.scope = [](const QString &path) { return DFMSEARCH::Global::isPathInOcrTextIndexDirectory(path); }; + providers.candidate = [](const QString &path) { return IndexUtility::isSupportedOCRFile(path); }; + providers.anythingSearchOptions = []() { + return AnythingSearchOptions { + { Defines::kAnythingPicType }, + TextIndexConfig::instance().supportedOcrImageExtensions() + }; + }; + // ChecksumProvider: compute file MD5 + providers.checksum = [](const QString &filePath) { return FileHash::computeMd5(filePath); }; + // TextCacheLookup: find existing OCR text by checksum + providers.textCache = [ocrIndexDir](const QString &checksum) { + return OcrDeduplication::lookupByTextChecksum(checksum, ocrIndexDir); + }; + // AnalyzerProvider: create lowercase NGram analyzer for OCR text + providers.analyzer = []() -> boost::shared_ptr { + return Lucene::newLucene(1, 2); + }; + + Capabilities capabilities; + // OCR 单文件提取成本高，Light 分级阈值独立于全局配置（保持 dconfig 动态性） + capabilities.lightGradeCountThreshold = []() { + return TextIndexConfig::instance().lightIncrementOcrFileCountThreshold(); + }; + + return IndexProfile { + Identity { Type::Ocr, QStringLiteral("ocr"), + QStringLiteral("index_status.json"), Defines::kOcrVersionKey, Defines::kOcrIndexVersion }, + std::move(providers), + RuntimePolicy{}, + FilterPolicy{}, + std::move(capabilities) + }; +} + +IndexProfile IndexProfile::filename() +{ + FilterPolicy filterPolicy; + filterPolicy.indexHiddenFiles = true; + // 隐藏文件二级策略：filename 虽索引隐藏文件（标记 is_hidden 字段），但主目录 + // 第一级的隐藏条目（~/.local、~/.cache 等，数量巨大）默认屏蔽，控制索引规模、 + // 构建时长与 inotify 事件量。更深层级的隐藏目录（如 ~/Documents/.abc）依然 + // 索引。搜索端（dfm-plugin-search）在"显示隐藏文件"开启且搜索主目录（或其 + // 祖先）时回退实时搜索兜底，保证该场景下第一级隐藏条目仍可被搜到。 + filterPolicy.hiddenIndexExclusion = [](const QString &hiddenPath) { + static const QString home = QDir::homePath(); + // 仅屏蔽主目录第一级隐藏条目（~/.local 等，其整个子树随之排除）； + // 更深层级的隐藏条目（~/Documents/.abc）不属于第一级，依然索引 + if (!hiddenPath.startsWith(home + QLatin1Char('/'))) + return false; + const int firstSegmentEnd = hiddenPath.indexOf(QLatin1Char('/'), home.size() + 1); + const QString firstSegment = firstSegmentEnd < 0 + ? hiddenPath.mid(home.size() + 1) + : hiddenPath.mid(home.size() + 1, firstSegmentEnd - home.size() - 1); + return firstSegment.startsWith(QLatin1Char('.')); + }; + // 目录自身入索引（file_type=dir）：文件管理器支持按名称搜索目录， + // 文档字段（file_name/pinyin/file_type 等）全部由路径派生，与文件同构 + filterPolicy.indexDirectories = true; + // link 条目本身入索引：链接文件/dir 链接按自身路径可搜（不跟随、不递归）。 + // 文档全部由路径派生，对 dangling link 也成立（birth/size 为缺省值）。 + filterPolicy.indexSymlinks = true; + // 黑名单 = anything blacklist_paths + 三个索引目录 + .avfs（死循环防护）： + // filename 自身是索引提供者，索引目录位于 $HOME 下，若不排除， + // 索引器写入 Lucene 段文件会产生新事件 → 再次索引 → 无限循环。 + filterPolicy.blacklistProvider = []() -> QStringList { + QStringList blacklist = IndexUtility::AnythingConfigWatcher::instance()->defaultBlacklistPaths(); + blacklist << DFMSEARCH::Global::fileNameIndexDirectory() + << DFMSEARCH::Global::contentIndexDirectory() + << DFMSEARCH::Global::ocrTextIndexDirectory() + << QStringLiteral(".avfs"); + return blacklist; + }; + + // 恢复静默延迟 3s（Content/Ocr 为全局 180s）：filename 恢复 Update 期间 + // updateInProgress=true 持续降级搜索，缩短延迟可尽快回到索引搜索； + // filename 构建只读文件元数据（无内容提取），提前扫盘 IO 风险低。 + RuntimePolicy runtimePolicy; + runtimePolicy.checkEnvPolicy = false; // 环境策略豁免（电池/节能/空闲） + runtimePolicy.eventCollectionWindowMs = 1000; // 1s 收集窗口，复用原有 commit 机制 + runtimePolicy.recoveryUpdateDelayMs = 3000; // 恢复 Update 静默延迟 3s + + Capabilities capabilities; + // 文档业务字段（file_name/pinyin/file_ext/file_type/is_hidden 等）全部由路径派生， + // move/rename 后必须整体重建文档，仅更新 path 会残留旧文件名的索引值 + capabilities.moveUpdatePolicy = MoveUpdatePolicy::RebuildDocument; + // filename 只读文件元数据，无内容提取 + capabilities.requiresContentExtraction = false; + + Providers providers; + providers.indexDirectory = []() { return DFMSEARCH::Global::fileNameIndexDirectory(); }; + providers.availability = []() { return DFMSEARCH::Global::isFileNameIndexDirectoryAvailable(); }; + providers.scope = [](const QString &path) { return DFMSEARCH::Global::isPathInFileNameIndexDirectory(path); }; + providers.candidate = [](const QString &) { return true; }; + // no anything search options → FileSystemProvider 全盘遍历；no checksum/text cache + providers.analyzer = []() -> boost::shared_ptr { + return Lucene::newLucene(1, 2); + }; + + return IndexProfile { + Identity { Type::Filename, QStringLiteral("filename"), + QStringLiteral("index_status.json"), Defines::kFilenameVersionKey, Defines::kFilenameIndexVersion }, + std::move(providers), + std::move(runtimePolicy), + std::move(filterPolicy), + std::move(capabilities) + }; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/profile/indexprofile.h b/src/index/profile/indexprofile.h new file mode 100644 index 00000000..058c360c --- /dev/null +++ b/src/index/profile/indexprofile.h @@ -0,0 +1,244 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXPROFILE_H +#define INDEXPROFILE_H + +#include "index_global.h" + +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class IndexProfile +{ +public: + struct AnythingSearchOptions { + QStringList fileTypes; + QStringList fileExtensions; + + bool isEmpty() const + { + return fileTypes.isEmpty() && fileExtensions.isEmpty(); + } + }; + + enum class Type { + Content, + Ocr, + Filename + }; + + /// 运行时调度策略（环境豁免/事件窗口/恢复延迟） + struct RuntimePolicy { + bool checkEnvPolicy { true }; + int eventCollectionWindowMs { 3000 }; + // dirty 重启后恢复 Update 的静默延迟（毫秒），0 表示用全局 silentIndexUpdateDelay + // Content/Ocr: 0（全局默认 180s） + // Filename: 30000（30s，缩短 updateInProgress 降级窗口） + int recoveryUpdateDelayMs { 0 }; + }; + + /// 过滤策略（隐藏文件/黑名单/目录索引） + struct FilterPolicy { + bool indexHiddenFiles { false }; + // 隐藏文件二级策略（indexHiddenFiles 为 true 时有意义）： + // 给定隐藏条目的完整路径，返回 true 表示该条目不索引（其子树同样不遍历， + // 对应的文件系统事件照旧丢弃）。为空时隐藏条目全部索引。 + // Filename: 仅屏蔽主目录第一级隐藏条目（~/.local、~/.bashrc 等巨量 + // 缓存/配置/应用数据，会显著放大索引规模、构建时长与 inotify 事件量）； + // 更深层级中的隐藏目录（如 ~/Documents/.abc）依然索引。搜索端 + // （dfm-plugin-search）在"显示隐藏文件"开启且搜索主目录（或其祖先） + // 时回退实时搜索兜底，保证该场景下第一级隐藏条目仍可被搜到。 + // Content/Ocr: 无（indexHiddenFiles=false 时隐藏条目本来就全部跳过）。 + std::function hiddenIndexExclusion; + // 是否将目录自身作为文档写入索引（file_type=dir）。 + // Filename: true（支持按名称搜索目录）； + // Content/Ocr: false（目录无内容可提取，仅作遍历容器不建档） + bool indexDirectories { false }; + // 符号链接策略：link 条目本身是否入索引（按链接自身路径/名称建档， + // 绝不跟随——不递归进 dir link、不监控 link 内部，防索引环）。 + // Filename: true（链接文件/目录链接在文件管理器中是真实可见条目， + // 按名称搜索应能命中；link 内部内容不索引，仅链接名可搜）； + // Content/Ocr: false（行为不变，symlink 事件/条目照旧被排除）。 + bool indexSymlinks { false }; + // 黑名单路径提供器（函数式注入）；为空时使用全局 createForIndex() 匹配器 + // Content/Ocr: 空（TextIndexConfig folderExcludeFilters + anything blacklist） + // Filename: anything blacklist_paths + 三个索引目录 + .avfs（死循环防护） + std::function blacklistProvider; + }; + + /** + * @brief 文件移动/重命名时文档的更新策略 + * + * 由 profile 声明其文档字段对路径的依赖语义，task 层（MoveFileListHandler/ + * FileMoveProcessor）仅依赖此抽象，不得感知具体 profile 类型： + * - UpdatePathOnly: 保留文档中与路径无关的字段（contents/checksum/时间戳等）， + * 仅更新 path/ancestor_paths 及 builder 声明的路径派生字段 + * （见 IndexDocumentBuilder::pathDerivedFields），避免重新提取内容 + * - RebuildDocument: 文档业务字段全部由路径派生（如 Filename 的 file_name/ + * pinyin/file_ext/file_type/is_hidden），文件改名后必须整体重建文档， + * 否则旧路径派生的字段值残留导致新名称搜索不到。 + * 仅作用于文件级 move（FileMoveProcessor）；目录级 move 不改变子文件 + * 的 basename，统一走 copy + 派生字段重算（DirectoryMoveProcessor） + */ + enum class MoveUpdatePolicy { + UpdatePathOnly, + RebuildDocument + }; + + using DirectoryProvider = std::function; + using AvailabilityChecker = std::function; + using ScopeChecker = std::function; + using CandidateChecker = std::function; + using AnythingSearchOptionsProvider = std::function; + using ChecksumProvider = std::function; + using TextCacheLookup = std::function; + using AnalyzerProvider = std::function()>; + using LightGradeCountThresholdProvider = std::function; + + /// 静态身份描述（不变的事实性数据） + struct Identity { + Type type { Type::Content }; + QString id; + QString statusFileName { QStringLiteral("index_status.json") }; + QString versionKey; + int runtimeVersion { -1 }; + }; + + /// 数据与行为的外部提供者（函数式注入） + struct Providers { + DirectoryProvider indexDirectory; + AvailabilityChecker availability; + ScopeChecker scope; + CandidateChecker candidate; + AnythingSearchOptionsProvider anythingSearchOptions; + ChecksumProvider checksum; + TextCacheLookup textCache; + AnalyzerProvider analyzer; + }; + + /// 能力与语义声明（文档/索引行为的自描述） + struct Capabilities { + // 文件移动/重命名时文档的更新策略 + MoveUpdatePolicy moveUpdatePolicy { MoveUpdatePolicy::UpdatePathOnly }; + // 是否需要内容提取器；false 时 runtime 不装配 extractor + //（如 filename 索引只读文件元数据） + bool requiresContentExtraction { true }; + // Light 分级文件数阈值提供器（保持 dconfig 动态性）； + // 为空时使用全局 TextIndexConfig::lightIncrementFileCountThreshold() + LightGradeCountThresholdProvider lightGradeCountThreshold; + }; + + IndexProfile() = default; + IndexProfile(Identity identity, Providers providers, + RuntimePolicy runtimePolicy, + FilterPolicy filterPolicy, + Capabilities capabilities); + + Type type() const; + const QString &id() const; + QString indexDirectory() const; + QString statusFilePath() const; + const QString &versionKey() const; + bool isIndexAvailable() const; + int runtimeIndexVersion() const; + bool isPathInScope(const QString &path) const; + bool isCandidateFile(const QString &path) const; + AnythingSearchOptions anythingSearchOptions() const; + bool supportsAnything() const; + + /** + * @brief Compute a checksum for the given file, if the profile supports it + * @return Checksum string, or empty if the profile does not support checksumming + */ + QString computeChecksum(const QString &filePath) const; + + /** + * @brief Look up cached extraction text by checksum, if the profile supports it + * @return Cached text, or empty if no cache hit or not supported + */ + QString lookupCachedText(const QString &checksum) const; + + bool supportsChecksum() const; + + bool shouldCheckEnvPolicy() const; + const RuntimePolicy &runtimePolicy() const; + const FilterPolicy &filterPolicy() const; + + /** + * @brief 隐藏条目是否应被跳过（不索引、不遍历、事件丢弃） + * + * 三类调用方共用此抽象：全盘遍历（FileSystemProvider）、增量路径列表 + * （MixedPathListProvider）与文件系统事件谓词（FSEventController）， + * 保证三者对"哪些隐藏条目不进索引"的判定严格一致。 + * @param path 隐藏条目的完整路径（非隐藏路径恒返回 false） + */ + bool shouldSkipHiddenEntry(const QString &path) const; + + /** + * @brief 文件移动/重命名时该 profile 文档的更新策略 + * @see MoveUpdatePolicy + */ + + /** + * @brief 文件移动/重命名时该 profile 文档的更新策略 + * @see MoveUpdatePolicy + */ + MoveUpdatePolicy moveUpdatePolicy() const; + + /** + * @brief 该 profile 是否需要内容提取器 + * + * false 时 runtime 不装配 extractor（如 filename 索引只读文件元数据）， + * createFileDocument/processContentUpdate 将以空文本构建文档。 + */ + bool requiresContentExtraction() const; + + /** + * @brief Light 分级任务的最大文件数阈值 + * @return profile 声明的阈值；未声明（provider 为空）时返回 0， + * 调用方应回退到全局 TextIndexConfig::lightIncrementFileCountThreshold() + */ + int lightGradeFileCountThreshold() const; + + const wchar_t *pathField() const; + const wchar_t *contentField() const; + const wchar_t *ancestorPathsField() const; + const wchar_t *modifyTimeField() const; + bool supportsModifiedTimestampCheck() const; + boost::shared_ptr createAnalyzer() const; + int maxFileTruncationSizeMB() const; + + static IndexProfile content(); + static IndexProfile ocr(); + static IndexProfile filename(); + +private: + Identity m_identity; + Providers m_providers; + Capabilities m_capabilities; + RuntimePolicy m_runtimePolicy; + FilterPolicy m_filterPolicy; +}; + +// 定义置于类外：默认参数需要 Capabilities 的 NSDMI（嵌套类完成于外围类之后）， +// 聚合初始化特性也依赖 Capabilities 保持聚合类型 +inline IndexProfile::IndexProfile(Identity identity, Providers providers, + RuntimePolicy runtimePolicy = RuntimePolicy{}, + FilterPolicy filterPolicy = FilterPolicy{}, + Capabilities capabilities = Capabilities{}) + : m_identity(std::move(identity)), + m_providers(std::move(providers)), + m_capabilities(std::move(capabilities)), + m_runtimePolicy(std::move(runtimePolicy)), + m_filterPolicy(std::move(filterPolicy)) +{ +} + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXPROFILE_H diff --git a/src/index/profile/lowercasengramanalyzer.cpp b/src/index/profile/lowercasengramanalyzer.cpp new file mode 100644 index 00000000..1e57e607 --- /dev/null +++ b/src/index/profile/lowercasengramanalyzer.cpp @@ -0,0 +1,64 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "lowercasengramanalyzer.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +class LowerCaseNGramTokenStreams : public Lucene::LuceneObject +{ +public: + LowerCaseNGramTokenStreams(const Lucene::ReaderPtr &reader, int32_t minGram, int32_t maxGram) + : source(Lucene::newLucene(reader, minGram, maxGram)), + result(Lucene::newLucene(source)) + { + } + + Lucene::NGramTokenizerPtr source; + Lucene::TokenStreamPtr result; +}; + +} // namespace + +LowerCaseNGramAnalyzer::LowerCaseNGramAnalyzer(int32_t minGram, int32_t maxGram) + : m_minGram(minGram), + m_maxGram(maxGram) +{ +} + +LowerCaseNGramAnalyzer::~LowerCaseNGramAnalyzer() = default; + +Lucene::TokenStreamPtr LowerCaseNGramAnalyzer::tokenStream(const Lucene::String &fieldName, + const Lucene::ReaderPtr &reader) +{ + (void) fieldName; + return Lucene::newLucene( + Lucene::newLucene(reader, m_minGram, m_maxGram)); +} + +Lucene::TokenStreamPtr LowerCaseNGramAnalyzer::reusableTokenStream(const Lucene::String &fieldName, + const Lucene::ReaderPtr &reader) +{ + (void) fieldName; + + boost::shared_ptr streams = + boost::dynamic_pointer_cast(getPreviousTokenStream()); + + if (!streams) { + streams = Lucene::newLucene(reader, m_minGram, m_maxGram); + setPreviousTokenStream(streams); + } else { + streams->source->reset(reader); + } + + return streams->result; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/profile/lowercasengramanalyzer.h b/src/index/profile/lowercasengramanalyzer.h new file mode 100644 index 00000000..1f272e77 --- /dev/null +++ b/src/index/profile/lowercasengramanalyzer.h @@ -0,0 +1,32 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef LOWERCASENGRAMANALYZER_H +#define LOWERCASENGRAMANALYZER_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class LowerCaseNGramAnalyzer : public Lucene::Analyzer +{ +public: + LowerCaseNGramAnalyzer(int32_t minGram, int32_t maxGram); + ~LowerCaseNGramAnalyzer() override; + + Lucene::TokenStreamPtr tokenStream(const Lucene::String &fieldName, + const Lucene::ReaderPtr &reader) override; + Lucene::TokenStreamPtr reusableTokenStream(const Lucene::String &fieldName, + const Lucene::ReaderPtr &reader) override; + +private: + int32_t m_minGram; + int32_t m_maxGram; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // LOWERCASENGRAMANALYZER_H diff --git a/src/index/serviceentry.cpp b/src/index/serviceentry.cpp new file mode 100644 index 00000000..80ff2846 --- /dev/null +++ b/src/index/serviceentry.cpp @@ -0,0 +1,81 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "serviceentry.h" + +#include "dbus/textindexdbus.h" +#include "dbus/ocrindexdbus.h" +#include "dbus/filenameindexdbus.h" + +#include "processprioritymanager.h" + +#include +#include +#include +#include +#include + +namespace anything_index { + +static TextIndexDBus *textIndexDBus = nullptr; +static OcrIndexDBus *ocrIndexDBus = nullptr; +static FileNameIndexDBus *fileNameIndexDBus = nullptr; + +int registerIndexServices() +{ + // ProcessFileMoves 参数类型未注册时 QtDBus 会剔除该方法（a{ss} 线格式不变） + qDBusRegisterMetaType>(); + + QDBusConnection bus = QDBusConnection::sessionBus(); + if (!bus.registerService(Defines::kTextIndexDBusService) + && bus.lastError().type() != QDBusError::NoError) { + qWarning() << "deepin-anything-index: failed to register text index DBus service:" << bus.lastError().message(); + } + + if (!bus.registerService(Defines::kOcrIndexDBusService) + && bus.lastError().type() != QDBusError::NoError) { + qWarning() << "deepin-anything-index: failed to register OCR index DBus service:" << bus.lastError().message(); + } + + if (!bus.registerService(Defines::kFileNameIndexDBusService) + && bus.lastError().type() != QDBusError::NoError) { + qWarning() << "deepin-anything-index: failed to register filename index DBus service:" << bus.lastError().message(); + } + + textIndexDBus = new TextIndexDBus(); + ocrIndexDBus = new OcrIndexDBus(); + fileNameIndexDBus = new FileNameIndexDBus(); + ProcessPriorityManager::lowerAllAvailablePriorities(true); + + return 0; +} + +int unregisterIndexServices() +{ + if (fileNameIndexDBus) { + fileNameIndexDBus->cleanup(); + fileNameIndexDBus->deleteLater(); + fileNameIndexDBus = nullptr; + } + + if (ocrIndexDBus) { + ocrIndexDBus->cleanup(); + ocrIndexDBus->deleteLater(); + ocrIndexDBus = nullptr; + } + + if (textIndexDBus) { + textIndexDBus->cleanup(); + textIndexDBus->deleteLater(); + textIndexDBus = nullptr; + } + + QDBusConnection bus = QDBusConnection::sessionBus(); + bus.unregisterService(Defines::kFileNameIndexDBusService); + bus.unregisterService(Defines::kOcrIndexDBusService); + bus.unregisterService(Defines::kTextIndexDBusService); + return 0; +} + +} // namespace anything_index diff --git a/src/index/serviceentry.h b/src/index/serviceentry.h new file mode 100644 index 00000000..138a2150 --- /dev/null +++ b/src/index/serviceentry.h @@ -0,0 +1,21 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef SERVICEENTRY_H +#define SERVICEENTRY_H + +namespace anything_index { + +// Registers the three D-Bus service names (org.deepin.Filemanager.TextIndex / +// OcrIndex / FileNameIndex), creates the three D-Bus objects and lowers the +// process priority. Returns 0 on success, matching the old DSMRegister contract. +int registerIndexServices(); + +// Stops monitoring and running tasks, marks unfinished indexes dirty and +// unregisters the bus names. Returns 0, matching the old DSMUnRegister contract. +int unregisterIndexServices(); + +} // namespace anything_index + +#endif // SERVICEENTRY_H diff --git a/src/index/state/indexstatestore.cpp b/src/index/state/indexstatestore.cpp new file mode 100644 index 00000000..56005631 --- /dev/null +++ b/src/index/state/indexstatestore.cpp @@ -0,0 +1,294 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "indexstatestore.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +/** + * @brief 读取状态 JSON 文件并解析为 QJsonObject + * + * 状态文件采用 JSON 格式，包含以下 key（定义在 index_global.h 的 Defines 命名空间）： + * - "state" → "clean" 或 "dirty"（kStateKey → kStateClean / kStateDirty） + * - "needsRebuild" → true / false（kNeedsRebuildKey） + * - "lastUpdateTime" → ISO 时间字符串（kLastUpdateTimeKey） + * - "version" → 整数版本号（kTextVersionKey / kOcrVersionKey，由 IndexProfile::versionKey() 提供） + * + * 文件不存在、无法打开、JSON 解析失败、根非 Object 时均返回空 QJsonObject（不抛异常）。 + * 调用方应能处理空对象（各 getter 有对应的默认返回值）。 + */ +QJsonObject readStatusJson(const QString &filePath) +{ + QFile file(filePath); + if (!file.open(QIODevice::ReadOnly)) { + return QJsonObject(); + } + + QJsonParseError parseError; + const QByteArray data = file.readAll(); + const QJsonDocument doc = QJsonDocument::fromJson(data, &parseError); + file.close(); + + if (parseError.error != QJsonParseError::NoError) { + qWarning() << "IndexStateStore::readStatusJson: failed to parse JSON from:" << file.fileName() + << "error:" << parseError.errorString(); + return QJsonObject(); + } + + if (!doc.isObject()) { + qWarning() << "IndexStateStore::readStatusJson: JSON root is not an object in:" << file.fileName(); + return QJsonObject(); + } + + return doc.object(); +} + +/** + * @brief 将 QJsonObject 写入状态文件（原子写入） + * + * 使用 QSaveFile 实现原子写入：先写入临时文件，commit 时 rename 为目标文件。 + * 这样即使写入过程中进程崩溃，也不会产生半写入的损坏文件。 + * 如果目录不存在会先创建。 + */ +bool writeStatusJson(const QString &filePath, const QJsonObject &obj) +{ + QDir().mkpath(QFileInfo(filePath).absolutePath()); + + QSaveFile file(filePath); + if (!file.open(QIODevice::WriteOnly)) { + qWarning() << "IndexStateStore::writeStatusJson: failed to open file:" << file.fileName() + << "error:" << file.errorString(); + return false; + } + + const QByteArray data = QJsonDocument(obj).toJson(); + if (file.write(data) != data.size()) { + qWarning() << "IndexStateStore::writeStatusJson: failed to fully write file:" << file.fileName(); + file.cancelWriting(); + return false; + } + + if (!file.commit()) { + qWarning() << "IndexStateStore::writeStatusJson: failed to commit file:" << file.fileName() + << "error:" << file.errorString(); + return false; + } + + return true; +} + +} // namespace + +IndexStateStore::IndexStateStore(IndexProfile profile) + : m_profile(std::move(profile)) +{ +} + +QString IndexStateStore::statusFilePath() const +{ + return m_profile.statusFilePath(); +} + +IndexUtility::IndexState IndexStateStore::getIndexState() const +{ + const QJsonObject obj = readStatusJson(statusFilePath()); + if (obj.contains(Defines::kStateKey)) { + const QString state = obj[Defines::kStateKey].toString(); + if (state == Defines::kStateClean) { + return IndexUtility::IndexState::Clean; + } + if (state == Defines::kStateDirty) { + return IndexUtility::IndexState::Dirty; + } + + qWarning() << "IndexStateStore::getIndexState: invalid state value for profile:" << m_profile.id() + << "value:" << state; + } + + return IndexUtility::IndexState::Unknown; +} + +void IndexStateStore::setIndexState(IndexUtility::IndexState state) const +{ + QString stateStr; + switch (state) { + case IndexUtility::IndexState::Clean: + stateStr = Defines::kStateClean; + break; + case IndexUtility::IndexState::Dirty: + stateStr = Defines::kStateDirty; + break; + default: + qWarning() << "IndexStateStore::setIndexState: unsupported state for profile:" << m_profile.id(); + return; + } + + QJsonObject obj = readStatusJson(statusFilePath()); + obj[Defines::kStateKey] = stateStr; + writeStatusJson(statusFilePath(), obj); +} + +bool IndexStateStore::isCleanState() const +{ + return getIndexState() == IndexUtility::IndexState::Clean; +} + +bool IndexStateStore::needsRebuild() const +{ + const QJsonObject obj = readStatusJson(statusFilePath()); + return obj.contains(Defines::kNeedsRebuildKey) ? obj[Defines::kNeedsRebuildKey].toBool() : false; +} + +void IndexStateStore::setNeedsRebuild(bool need) const +{ + QJsonObject obj = readStatusJson(statusFilePath()); + obj[Defines::kNeedsRebuildKey] = need; + writeStatusJson(statusFilePath(), obj); +} + +bool IndexStateStore::isCreateInProgress() const +{ + const QJsonObject obj = readStatusJson(statusFilePath()); + return obj.contains(Defines::kCreateInProgressKey) ? obj[Defines::kCreateInProgressKey].toBool() : false; +} + +void IndexStateStore::setCreateInProgress(bool inProgress) const +{ + QJsonObject obj = readStatusJson(statusFilePath()); + obj[Defines::kCreateInProgressKey] = inProgress; + writeStatusJson(statusFilePath(), obj); +} + +bool IndexStateStore::isUpdateInProgress() const +{ + const QJsonObject obj = readStatusJson(statusFilePath()); + return obj.contains(Defines::kUpdateInProgressKey) ? obj[Defines::kUpdateInProgressKey].toBool() : false; +} + +void IndexStateStore::setUpdateInProgress(bool inProgress) const +{ + QJsonObject obj = readStatusJson(statusFilePath()); + obj[Defines::kUpdateInProgressKey] = inProgress; + writeStatusJson(statusFilePath(), obj); +} + +bool IndexStateStore::isBacklogExceeded() const +{ + const QJsonObject obj = readStatusJson(statusFilePath()); + return obj.value(Defines::kBacklogExceededKey).toBool(false); +} + +void IndexStateStore::setBacklogExceeded(bool exceeded) const +{ + QJsonObject obj = readStatusJson(statusFilePath()); + obj[Defines::kBacklogExceededKey] = exceeded; + writeStatusJson(statusFilePath(), obj); +} + +QString IndexStateStore::getLastUpdateTime() const +{ + const QJsonObject obj = readStatusJson(statusFilePath()); + if (!obj.contains(Defines::kLastUpdateTimeKey)) { + return QString(); + } + + const QDateTime time = QDateTime::fromString(obj[Defines::kLastUpdateTimeKey].toString(), Qt::ISODate); + return time.toString("yyyy-MM-dd hh:mm:ss"); +} + +int IndexStateStore::getIndexVersion() const +{ + const QJsonObject obj = readStatusJson(statusFilePath()); + return obj.contains(m_profile.versionKey()) ? obj[m_profile.versionKey()].toInt(-1) : -1; +} + +bool IndexStateStore::isCompatibleVersion() const +{ + const int storedVersion = getIndexVersion(); + if (storedVersion == -1) { + return false; + } + + return storedVersion == m_profile.runtimeIndexVersion(); +} + +void IndexStateStore::removeIndexStatusFile() const +{ + QFile file(statusFilePath()); + if (file.exists()) { + file.remove(); + } +} + +void IndexStateStore::clearIndexDirectory() const +{ + QDir dir(m_profile.indexDirectory()); + if (dir.exists()) { + const QStringList files = dir.entryList(QDir::Files); + for (const QString &file : files) { + dir.remove(file); + } + } + + if (!dir.exists()) { + dir.mkpath(QStringLiteral(".")); + } +} + +void IndexStateStore::saveIndexStatus(const QDateTime &lastUpdateTime) const +{ + saveIndexStatus(lastUpdateTime, m_profile.runtimeIndexVersion()); +} + +void IndexStateStore::saveIndexStatus(const QDateTime &lastUpdateTime, int version) const +{ + QJsonObject obj = readStatusJson(statusFilePath()); + obj[Defines::kLastUpdateTimeKey] = lastUpdateTime.toString(Qt::ISODate); + obj[m_profile.versionKey()] = version; + writeStatusJson(statusFilePath(), obj); +} + +void IndexStateStore::saveLastUpdateTime(const QDateTime &lastUpdateTime) const +{ + QJsonObject obj = readStatusJson(statusFilePath()); + obj[Defines::kLastUpdateTimeKey] = lastUpdateTime.toString(Qt::ISODate); + // 不更新 version：增量任务不应改变版本号。 + // 若在 recoveryPending 期间增量任务提升了 version，会导致后续恢复任务的版本判断出错。 + writeStatusJson(statusFilePath(), obj); +} + +QStringList IndexStateStore::createFileListCache() const +{ + QMutexLocker locker(&m_createFileListCacheMutex); + return m_createFileListCache; +} + +void IndexStateStore::setCreateFileListCache(const QStringList &cache) const +{ + QMutexLocker locker(&m_createFileListCacheMutex); + m_createFileListCache = cache; +} + +int IndexStateStore::createCheckpoint() const +{ + return m_createCheckpoint.loadRelaxed(); +} + +void IndexStateStore::setCreateCheckpoint(int checkpoint) const +{ + m_createCheckpoint.storeRelaxed(checkpoint); +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/state/indexstatestore.h b/src/index/state/indexstatestore.h new file mode 100644 index 00000000..04a62f89 --- /dev/null +++ b/src/index/state/indexstatestore.h @@ -0,0 +1,319 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXSTATESTORE_H +#define INDEXSTATESTORE_H + +#include "profile/indexprofile.h" +#include "utils/indexutility.h" + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief 索引状态持久化存储 + * + * IndexStateStore 负责管理索引的状态文件（一个 JSON 文件），记录索引的生命周期状态。 + * 它是全文检索服务（TextIndex / OcrIndex）的"状态大脑"，所有关于索引是否可用、 + * 是否需要重建、上次更新时间等信息都由本类持久化到磁盘。 + * + * ## 状态文件结构 + * + * 状态文件路径由 IndexProfile::statusFilePath() 提供，默认文件名为 index_status.json。 + * JSON 示例： + * \code + * { + * "state": "clean", // 或 "dirty" + * "needsRebuild": false, // 是否需要重建 + * "lastUpdateTime": "2026-08-03T10:30:00", // ISO 时间 + * "version": 6 // 索引版本号 + * } + * \endcode + * + * ## 核心概念详解 + * + * ### 1. state（Clean / Dirty / Unknown）—— 索引完整性标记 + * + * - **Clean**（"clean"）：索引完整可用。上次服务正常关闭，没有未完成的任务。 + * - **Dirty**（"dirty"）：索引可能不完整。服务在上次运行时有任务未完成（如创建/更新被中断）， + * 或服务以非正常方式退出。下次启动时需要进行完整的 Update 任务来修复。 + * - **Unknown**：状态文件不存在或 state 字段缺失（旧版遗留文件或文件损坏）。 + * + * **生命周期**： + * - 任务启动时（startTask），state 被设为 Dirty + * - 全量任务（Create/Update）成功完成时，state 被设为 Clean + * - 增量任务（文件列表增删改）成功完成时，state 是否设为 Clean 取决于 recoveryPending + * - 服务 cleanup 时若有未完成任务，state 被设为 Dirty + * + * ### 2. needsRebuild —— 配置变更重建标记 + * + * 这是一个独立的布尔标记，与 state 无关。当外部配置发生变化（如 ANYTHING 索引路径变更、 + * DLNFS 挂载配置变更），ConfigWatcher 会将 needsRebuild 设为 true。 + * + * **使用场景**：服务启动时若发现 needsRebuild=true，即使 state=Clean 也会强制启动 + * 一个 Update 任务，以确保索引内容与最新配置一致。任务启动后清除该标记。 + * + * ### 3. RecoveryPending（本类不存储，但与 state 密切相关）—— 恢复挂起标志 + * + * \warning RecoveryPending 不存储在状态文件中，而是 TaskManager 的内存标志（m_recoveryPending）。 + * 此处说明它是因为理解 state 的行为离不开它。 + * + * **设计目的**：防止服务启动后，一个小的增量任务完成时把 Dirty 状态清除为 Clean， + * 导致真正需要的完整 Update 任务无法触发。 + * + * **场景示例**： + * 1. 服务上次异常退出，state=Dirty + * 2. 服务重启，initialize() 检测到 Dirty，设置 m_recoveryPending=true + * 3. 此时文件系统监控（FSEventController）检测到文件变化，触发了一个小的增量更新任务 + * 4. 增量任务完成 → finalizeIndexState() 检查 m_recoveryPending == true → **不设 Clean**，保持 Dirty + * 5. 同时，handleSilentStart() 检测到 recoveryPending，启动完整 Update 任务 + * 6. 完整 Update 任务成功 → m_recoveryPending 被清除为 false → state 设为 Clean + * + * ### 4. version + lastUpdateTime —— 版本与时间管理 + * + * - **version**：索引版本号。当索引 schema 变化时（如新增字段），通过提升 Defines::kTextIndexVersion + * 强制旧索引重建。isCompatibleVersion() 比较存储版本与运行时版本。 + * - **lastUpdateTime**：上次成功更新时间，供外部查询索引新鲜度。 + * + * **关键区别**： + * - 全量任务（Create/Update）成功 → 调用 saveIndexStatus()，同时更新 version 和 lastUpdateTime + * - 增量任务成功 → 调用 saveLastUpdateTime()，只更新 lastUpdateTime，不改变 version + * + * 这样设计是为了避免增量任务意外提升 version，导致与正在挂起的恢复任务产生版本冲突。 + * + * ## 任务类型与状态的关系 + * + * | 任务类型 | isFullScan | 成功后行为 | + * |---------|-----------|-----------| + * | Create | 是 | saveIndexStatus(版本+时间), recoveryPending=false, state=Clean | + * | Update | 是 | saveIndexStatus(版本+时间), recoveryPending=false, state=Clean | + * | CreateFileList | 否 | saveLastUpdateTime(仅时间), state=Clean(若非recoveryPending) | + * | UpdateFileList | 否 | saveLastUpdateTime(仅时间), state=Clean(若非recoveryPending) | + * | RemoveFileList | 否 | saveLastUpdateTime(仅时间), state=Clean(若非recoveryPending) | + * | MoveFileList | 否 | saveLastUpdateTime(仅时间), state=Clean(若非recoveryPending) | + * + * @see TaskManager::finalizeIndexState() 状态转换的核心逻辑 + * @see TextIndexDBusPrivate::handleSilentStart() 启动恢复逻辑 + */ +class IndexStateStore +{ +public: + explicit IndexStateStore(IndexProfile profile); + + /** + * @brief 返回状态文件的完整路径 + * @return 状态文件路径，形如 /path/to/index_dir/index_status.json + */ + QString statusFilePath() const; + + /** + * @brief 读取当前索引状态 + * @return Clean / Dirty / Unknown（文件不存在或字段无效时返回 Unknown） + * + * 从 JSON 的 "state" 字段读取，值为 "clean" 或 "dirty"。 + */ + IndexUtility::IndexState getIndexState() const; + + /** + * @brief 设置索引状态并持久化 + * @param state 目标状态（仅支持 Clean 和 Dirty，Unknown 会被忽略） + * + * 采用 read-modify-write 模式：先读取整个 JSON，更新 state 字段，再写回。 + * 这样不会破坏文件中的其他字段（如 needsRebuild、version 等）。 + */ + void setIndexState(IndexUtility::IndexState state) const; + + /** + * @brief 快速判断索引是否处于 Clean 状态 + * @return true 当且仅当 getIndexState() == Clean + */ + bool isCleanState() const; + + /** + * @brief 读取 needsRebuild 标记 + * @return true 表示配置已变更、索引需要重建；false 表示无重建需求 + * + * 从 JSON 的 "needsRebuild" 字段读取，字段缺失时默认返回 false。 + */ + bool needsRebuild() const; + + /** + * @brief 设置 needsRebuild 标记并持久化 + * @param need 是否需要重建 + * + * 通常由 ConfigWatcher 的信号触发（ANYTHING/DLNFS 配置变更）， + * 也可在 handleSilentStart 中主动清除（启动 Update 任务前）。 + */ + void setNeedsRebuild(bool need) const; + + /** + * @brief 读取 createInProgress 标记 + * @return true 表示 CREATE 任务未完成（重型 UPDATE 的判定依据）；false 表示无 CREATE 进行中 + * + * 状态机： + * - CREATE startTask 时置 true + * - Create/Update 全量任务成功完成时置 false + * - 中断/失败时不操作（保持原值），下次重启仍判定为重型 + * - 增量任务不操作 + * + * 字段缺失时默认返回 false（旧版遗留文件或文件不存在）。 + */ + bool isCreateInProgress() const; + + /** + * @brief 设置 createInProgress 标记并持久化 + * @param inProgress CREATE 任务是否未完成 + * + * 采用 read-modify-write 模式：先读取整个 JSON，更新字段，再写回。 + * 不破坏文件中的其他字段（如 state、needsRebuild、version 等）。 + */ + void setCreateInProgress(bool inProgress) const; + + /** + * @brief 读取 updateInProgress 标记 + * @return true 表示全量对比型 UPDATE 任务（恢复/rebuild）未完成；false 表示无此类任务进行中 + * + * 状态机（由全量对比型 Update 任务的生命周期驱动）： + * - UPDATE startTask 时置 true（覆盖恢复 Update / needsRebuild Update / 手动 Update） + * - Update 全量任务成功完成时（finalizeIndexState）置 false + * - 失败/中断时不操作（保持 true），下次启动继续恢复，搜索持续降级直到恢复成功 + * - 普通事件增量任务（UpdateFileList/MoveFileList/CreateFileList/RemoveFileList）不操作此标记 + * + * 用途：恢复/rebuild Update 是"cleanup + 按 mtime 全量对比"的扫盘过程，期间索引滞后 + * （新文件漏报、已删文件误报），对外可见性应视为 "scanning"（搜索降级）， + * 与 createInProgress（首次创建/版本重建窗口）互补。 + * + * 字段缺失时默认返回 false（旧版遗留文件或文件不存在）。 + */ + bool isUpdateInProgress() const; + + /** + * @brief 设置 updateInProgress 标记并持久化 + * @param inProgress 全量对比型 UPDATE 任务是否未完成 + * + * 采用 read-modify-write 模式：先读取整个 JSON，更新字段，再写回。 + * 不破坏文件中的其他字段（如 state、needsRebuild、version 等）。 + */ + void setUpdateInProgress(bool inProgress) const; + + bool isBacklogExceeded() const; + void setBacklogExceeded(bool exceeded) const; + + /** + * @brief 获取上次更新时间 + * @return 格式化时间字符串 "yyyy-MM-dd hh:mm:ss"，文件不存在时返回空字符串 + */ + QString getLastUpdateTime() const; + + /** + * @brief 获取索引版本号 + * @return 版本号，文件不存在或字段缺失时返回 -1 + * + * versionKey 由 IndexProfile 提供（Content 和 OCR 各自不同的 key）。 + */ + int getIndexVersion() const; + + /** + * @brief 检查存储的版本号是否与当前运行时版本兼容 + * @return true 表示版本匹配，索引可用；false 表示版本不匹配需重建 + * + * 比较 getIndexVersion() 与 IndexProfile::runtimeIndexVersion()。 + * 当索引 schema 变化时，提升 kTextIndexVersion 会使旧索引自动判定为不兼容。 + */ + bool isCompatibleVersion() const; + + /** + * @brief 删除状态文件 + * + * 在以下场景使用： + * - Create 任务启动时（清除旧状态） + * - Update 任务失败且根路径在范围内时（标记索引无效） + */ + void removeIndexStatusFile() const; + + /** + * @brief 清空索引目录下的所有文件 + * + * 当索引损坏（isIndexCorrupted）导致 Update 失败时，清空索引目录后重新 Create。 + */ + void clearIndexDirectory() const; + + /** + * @brief 保存索引状态（全量任务专用，同时更新 version 和 lastUpdateTime） + * @param lastUpdateTime 上次更新时间 + * + * 使用 IndexProfile::runtimeIndexVersion() 作为版本号。 + * 适用于 Create / Update 全量扫描任务成功完成后。 + */ + void saveIndexStatus(const QDateTime &lastUpdateTime) const; + + /** + * @brief 保存索引状态（指定版本号） + * @param lastUpdateTime 上次更新时间 + * @param version 索引版本号 + * + * read-modify-write：只更新 lastUpdateTime 和 version 字段，保留其他字段。 + */ + void saveIndexStatus(const QDateTime &lastUpdateTime, int version) const; + + /** + * @brief 仅保存更新时间，不改变版本号（增量任务专用） + * @param lastUpdateTime 上次更新时间 + * + * 增量任务（文件列表增删改）成功后调用此方法。 + * 不更新 version 是为了防止：在 recoveryPending 期间，增量任务提升了 version， + * 导致后续恢复任务的版本判断出错。 + */ + void saveLastUpdateTime(const QDateTime &lastUpdateTime) const; + + /** + * @brief 读取 Create 续建缓存的文件列表（线程安全） + * @return 缓存的文件路径列表，若不存在或已清除则返回空列表 + * + * 由 worker 线程在 CreateResumeHandler / resolveFileListForCreateResume 中调用， + * 与 setCreateFileListCache（可能在主线程调用）通过内部互斥锁保证线程安全。 + */ + QStringList createFileListCache() const; + + /** + * @brief 设置 Create 续建缓存的文件列表（线程安全） + * @param cache 从 ANYTHING 获取的全量文件路径列表 + * + * 调用场景： + * - 主线程 startTask 启动新 Create 时清除旧缓存（传空列表） + * - 主线程 finalizeIndexState 全量任务成功后清除缓存（传空列表） + * - worker 线程 CreateIndexHandler / resolveFileListForCreateResume 中缓存文件列表 + */ + void setCreateFileListCache(const QStringList &cache) const; + + /** + * @brief 读取 Create 续建的检查点偏移（线程安全） + * @return 已处理的文件索引偏移，0 表示从头开始 + * + * 使用 QAtomicInteger 保证跨线程可见性。 + */ + int createCheckpoint() const; + + /** + * @brief 设置 Create 续建的检查点偏移（线程安全） + * @param checkpoint 已处理的文件索引偏移 + * + * 由 worker 线程在遍历文件时每处理一个文件更新一次。 + */ + void setCreateCheckpoint(int checkpoint) const; + +private: + IndexProfile m_profile; + mutable QStringList m_createFileListCache; + mutable QMutex m_createFileListCacheMutex; + mutable QAtomicInteger m_createCheckpoint { 0 }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXSTATESTORE_H diff --git a/src/index/task/backlogtracker.cpp b/src/index/task/backlogtracker.cpp new file mode 100644 index 00000000..3a427419 --- /dev/null +++ b/src/index/task/backlogtracker.cpp @@ -0,0 +1,75 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "backlogtracker.h" + +#include "state/indexstatestore.h" + +#include + +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE +DCORE_USE_NAMESPACE + +namespace { +constexpr qint64 kDefaultBacklogThreshold = 5000; +constexpr qint64 kMinimumBacklogThreshold = 200; +constexpr qint64 kMaximumBacklogThreshold = 100000; +constexpr char kAnythingConfig[] = "org.deepin.anything"; +constexpr char kPendingEventsKey[] = "pending_events_trigger_updating"; +} + +FilenameBacklogTracker::FilenameBacklogTracker(const IndexStateStore *stateStore) + : m_stateStore(stateStore) +{ +} + +void FilenameBacklogTracker::onStartup() +{ + if (m_stateStore && m_stateStore->isCleanState() && m_stateStore->isBacklogExceeded()) + m_stateStore->setBacklogExceeded(false); +} + +void FilenameBacklogTracker::update(qint64 queuedWork, qint64 runningWork, bool hasRunningTask) +{ + if (!m_stateStore) + return; + + const qint64 pending = qMax(0, queuedWork) + qMax(0, runningWork); + const bool exceeded = m_stateStore->isBacklogExceeded(); + if (!exceeded && pending >= threshold()) { + m_stateStore->setBacklogExceeded(true); + qInfo() << "[FilenameBacklogTracker] Backlog exceeded threshold:" << pending; + } else if (exceeded && pending == 0 && !hasRunningTask) { + m_stateStore->setBacklogExceeded(false); + qInfo() << "[FilenameBacklogTracker] Backlog drained"; + } +} + +void FilenameBacklogTracker::onFullScanFinished() +{ + if (m_stateStore) + m_stateStore->setBacklogExceeded(false); +} + +qint64 FilenameBacklogTracker::threshold() const +{ + // 阈值在运行中极少变化，且本函数在任务入队/完成/进度里程碑时被频繁调用， + // 缓存避免每次都走 DConfig::create 的 DBus IPC 开销。 + if (m_cachedThreshold >= 0) + return m_cachedThreshold; + + qint64 computed = kDefaultBacklogThreshold; + const std::unique_ptr config(DConfig::create(kAnythingConfig, kAnythingConfig, QString(), nullptr)); + if (config && config->isValid()) { + const qint64 configured = config->value(kPendingEventsKey, kDefaultBacklogThreshold).toLongLong(); + if (configured >= kMinimumBacklogThreshold && configured <= kMaximumBacklogThreshold) + computed = configured; + } + + m_cachedThreshold = computed; + return m_cachedThreshold; +} diff --git a/src/index/task/backlogtracker.h b/src/index/task/backlogtracker.h new file mode 100644 index 00000000..6a207f11 --- /dev/null +++ b/src/index/task/backlogtracker.h @@ -0,0 +1,49 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef BACKLOGTRACKER_H +#define BACKLOGTRACKER_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class IndexStateStore; + +class BacklogTracker +{ +public: + virtual ~BacklogTracker() = default; + virtual void onStartup() = 0; + virtual void update(qint64 queuedWork, qint64 runningWork, bool hasRunningTask) = 0; + virtual void onFullScanFinished() = 0; +}; + +class FilenameBacklogTracker final : public BacklogTracker +{ +public: + explicit FilenameBacklogTracker(const IndexStateStore *stateStore); + + void onStartup() override; + void update(qint64 queuedWork, qint64 runningWork, bool hasRunningTask) override; + void onFullScanFinished() override; + +private: + qint64 threshold() const; + + const IndexStateStore *m_stateStore { nullptr }; + + // 首次计算后缓存，避免每次评估积压都经 DConfig::create 触发 DBus IPC。 + // 线程约束：threshold() 仅经 update() ← TaskManager::updateBacklogState() + // 被调用，其全部触发路径（DBus 方法入口、QueuedConnection 槽、主线程定时 + // 器）均在主线程执行，此缓存为单线程访问，无需同步；若未来引入跨线程 + // 调用方，需先补充同步。 + mutable qint64 m_cachedThreshold { -1 }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // BACKLOGTRACKER_H diff --git a/src/index/task/fileprovider.cpp b/src/index/task/fileprovider.cpp new file mode 100644 index 00000000..facf3ef3 --- /dev/null +++ b/src/index/task/fileprovider.cpp @@ -0,0 +1,421 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "fileprovider.h" +#include "utils/indextraverseutils.h" +#include "utils/indexutility.h" +#include "utils/scopeguard.h" +#include "utils/textindexconfig.h" + +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE + +FileSystemProvider::FileSystemProvider(IndexProfile profile, const QString &rootPath) + : m_profile(std::move(profile)), + m_rootPath(rootPath) +{ + // Per-profile 黑名单（filename: anything blacklist + 索引目录，避免索引器 + // 遍历进自身索引目录造成死循环/索引污染）；未提供时不过滤（Content/Ocr 行为不变， + // 其黑名单在 TaskHandler 的 shouldSkipExcludedFile 层生效）。 + if (m_profile.filterPolicy().blacklistProvider) { + m_excludeMatcher.addPatterns(m_profile.filterPolicy().blacklistProvider()); + } + + qInfo() << "[FileSystemProvider] Initialized with root path:" << rootPath + << "blacklist patterns:" << m_excludeMatcher.patternCount(); +} + +void FileSystemProvider::traverse(TaskState &state, const FileHandler &handler) +{ + qInfo() << "[FileSystemProvider::traverse] Starting file system traversal from:" << m_rootPath; + + QMap bindPathTable = IndexTraverseUtils::fstabBindInfo(); + QSet visitedDirs; + QQueue dirQueue; + dirQueue.enqueue(m_rootPath); + + int processedDirs = 0; + int processedFiles = 0; + + while (!dirQueue.isEmpty()) { + if (!state.isRunning() || state.isPauseRequested()) { + qInfo() << "[FileSystemProvider::traverse] Traversal interrupted - running:" << state.isRunning() + << "pauseRequested:" << state.isPauseRequested(); + break; + } + + QString currentPath = dirQueue.dequeue(); + + // 检查是否应该跳过此目录 + if (IndexTraverseUtils::shouldSkipDirectory(currentPath)) { + qDebug() << "[FileSystemProvider::traverse] Skipping directory:" << currentPath; + continue; + } + + // 检查是否是系统目录或绑定目录 + if (!m_profile.isPathInScope(currentPath)) { + if (bindPathTable.contains(currentPath)) { + qDebug() << "[FileSystemProvider::traverse] Skipping system/bind directory:" << currentPath; + continue; + } + } + + // 检查路径长度和深度限制 + if (currentPath.size() > FILENAME_MAX - 1 || currentPath.count('/') > 30) { + qWarning() << "[FileSystemProvider::traverse] Path too long or deep, skipping:" << currentPath + << "length:" << currentPath.size() << "depth:" << currentPath.count('/'); + continue; + } + + // 检查目录是否已访问 + if (!IndexTraverseUtils::isValidDirectory(currentPath, visitedDirs)) { + qDebug() << "[FileSystemProvider::traverse] Directory already visited or invalid:" << currentPath; + continue; + } + + // 目录自身也作为文档写入索引（filename profile，file_type=dir）。 + // 置于所有跳过检查之后、递归之前：入索引的目录集合与实际遍历的目录集合严格一致， + // 且目录先于其子条目建档，搜索语义上父子同步可见 + if (m_profile.filterPolicy().indexDirectories) + handler(currentPath); + + DIR *dir = opendir(currentPath.toStdString().c_str()); + if (!dir) { + qWarning() << "[FileSystemProvider::traverse] Failed to open directory:" << currentPath + << "error:" << strerror(errno); + continue; + } + + ScopeGuard dirCloser([dir]() { closedir(dir); }); + processedDirs++; + + struct dirent *entry; + while ((entry = readdir(dir))) { + if (!state.isRunning() || state.isPauseRequested()) { + qInfo() << "[FileSystemProvider::traverse] Traversal interrupted during directory scan - pause:" << state.isPauseRequested(); + break; + } + + if (IndexTraverseUtils::isSpecialDir(entry->d_name)) + continue; + + QString fullPath = QDir::cleanPath(currentPath + QDir::separator() + QString::fromUtf8(entry->d_name)); + + // 隐藏文件策略由 profile 统一决定（IndexProfile::shouldSkipHiddenEntry）： + // Content/Ocr 跳过所有隐藏条目；filename 索引隐藏文件（标记 is_hidden 字段）， + // 但屏蔽策略命中的条目（默认主目录下的隐藏条目，其子树同样不入遍历队列） + if (IndexTraverseUtils::isHiddenFile(entry->d_name) + && m_profile.shouldSkipHiddenEntry(fullPath)) + continue; + + struct stat st; + if (lstat(fullPath.toStdString().c_str(), &st) == -1) { + qDebug() << "[FileSystemProvider::traverse] Failed to stat file:" << fullPath + << "error:" << strerror(errno); + continue; + } + + // 对于普通文件，检查路径有效性和文件扩展名 + if (S_ISREG(st.st_mode)) { + QString fileName = QString::fromUtf8(entry->d_name); + // 早期扩展名过滤 - 避免昂贵的路径验证 + if (IndexTraverseUtils::isValidFile(fullPath) && m_profile.isCandidateFile(fullPath) + && !m_excludeMatcher.shouldExclude(fullPath)) { + handler(fullPath); + processedFiles++; + } + } + // 对于目录，检查是否应该跳过（含 per-profile 黑名单，如索引目录），然后加入队列 + else if (S_ISDIR(st.st_mode)) { + if (!IndexTraverseUtils::shouldSkipDirectory(fullPath) + && !m_excludeMatcher.shouldExclude(fullPath)) { + dirQueue.enqueue(fullPath); + } + } + // 符号链接条目（lstat 视角）：link 本身作为条目入索引（filename profile）， + // 绝不跟随——dir link 不入遍历队列（S_ISDIR 经 lstat 不会命中 link）， + // link 内部内容不经链接路径入索引。dangling link 也是文件管理器中的 + // 真实可见条目，同样收录（filename 文档全部路径派生，无需目标存在）。 + else if (S_ISLNK(st.st_mode) && m_profile.filterPolicy().indexSymlinks) { + if (m_profile.isCandidateFile(fullPath) && !m_excludeMatcher.shouldExclude(fullPath)) { + handler(fullPath); + processedFiles++; + } + } + } + } + + qInfo() << "[FileSystemProvider::traverse] Traversal completed - processed directories:" << processedDirs + << "files:" << processedFiles; +} + +DirectFileListProvider::DirectFileListProvider(const dfmsearch::SearchResultList &files) + : m_fileList(files) +{ + qInfo() << "[DirectFileListProvider] Initialized with" << files.size() << "files from search results"; +} + +void DirectFileListProvider::traverse(TaskState &state, const FileHandler &handler) +{ + qInfo() << "[DirectFileListProvider::traverse] Processing" << m_fileList.size() << "files from direct list"; + + int processedCount = 0; + for (const auto &file : std::as_const(m_fileList)) { + if (!state.isRunning() || state.isPauseRequested()) { + qInfo() << "[DirectFileListProvider::traverse] Processing interrupted after" << processedCount << "files - pause:" << state.isPauseRequested(); + break; + } + handler(file.path()); + processedCount++; + } + + qInfo() << "[DirectFileListProvider::traverse] Completed processing" << processedCount << "files"; +} + +qint64 DirectFileListProvider::totalCount() +{ + return m_fileList.count(); +} + +QStringList DirectFileListProvider::filePaths() const +{ + QStringList paths; + paths.reserve(m_fileList.size()); + for (const auto &result : std::as_const(m_fileList)) + paths.append(result.path()); + return paths; +} + +MixedPathListProvider::MixedPathListProvider(IndexProfile profile, const QStringList &pathList) + : m_profile(std::move(profile)), + m_pathList(pathList) +{ + // Per-profile 黑名单（filename: anything blacklist + 索引目录，死循环防护）； + // 未提供时不过滤（Content/Ocr 维持原有 folderExcludeFilters 逻辑） + if (m_profile.filterPolicy().blacklistProvider) { + m_excludeMatcher.addPatterns(m_profile.filterPolicy().blacklistProvider()); + } + + qInfo() << "[MixedPathListProvider] Initialized with" << pathList.size() << "paths," + << "profile blacklist patterns:" << m_excludeMatcher.patternCount(); +} + +void MixedPathListProvider::traverse(TaskState &state, const FileHandler &handler) +{ + qInfo() << "[MixedPathListProvider::traverse] Starting traversal of" << m_pathList.size() << "mixed paths"; + + // Default blacklisted directories + QStringList defaultBlacklistedDirs = TextIndexConfig::instance().folderExcludeFilters(); + qDebug() << "[MixedPathListProvider::traverse] Using blacklisted directories:" << defaultBlacklistedDirs; + + QSet processedFiles; // 避免重复处理文件 + QSet visitedDirs; // 避免目录循环引用 + + // 首先处理列表中的文件和准备目录遍历 + QQueue dirQueue; + int initialFiles = 0; + int initialDirs = 0; + + for (const auto &path : std::as_const(m_pathList)) { + if (!state.isRunning() || state.isPauseRequested()) { + qInfo() << "[MixedPathListProvider::traverse] Initial processing interrupted - pause:" << state.isPauseRequested(); + break; + } + + QFileInfo fileInfo(path); + // 与 FileSystemProvider 同构的隐藏条目过滤（防御事件之外来源的路径， + // 如 DBus 手动触发）：策略命中的隐藏条目不建档、不入遍历队列 + if (m_profile.shouldSkipHiddenEntry(path)) { + qDebug() << "[MixedPathListProvider::traverse] Skipping hidden entry per profile policy:" << path; + continue; + } + + // 符号链接条目（lstat 视角，filename profile）：link 本身作为条目建档， + // 不按目标类型分流——dangling link 的 exists()/isFile() 均为 false， + // 必须在 exists 检查之前识别；dir link 绝不入遍历队列。 + if (fileInfo.isSymLink()) { + if (m_profile.filterPolicy().indexSymlinks + && m_profile.isPathInScope(path) + && m_profile.isCandidateFile(path) + && !m_excludeMatcher.shouldExclude(path) + && !processedFiles.contains(path)) { + handler(path); + processedFiles.insert(path); + initialFiles++; + } + continue; + } + + if (!fileInfo.exists()) { + qWarning() << "[MixedPathListProvider::traverse] Path does not exist:" << path; + continue; + } + + if (fileInfo.isFile()) { + if (IndexTraverseUtils::isValidFile(path) + && m_profile.isPathInScope(path) + && m_profile.isCandidateFile(path)) { + // 检查是否已经处理过这个文件 + if (!processedFiles.contains(path)) { + handler(path); + processedFiles.insert(path); + initialFiles++; + } else { + qDebug() << "[MixedPathListProvider::traverse] Skipping duplicate file:" << path; + } + } else { + qDebug() << "[MixedPathListProvider::traverse] Skipping invalid or out-of-scope file:" << path; + } + } else if (fileInfo.isDir() && !fileInfo.isSymLink()) { + // 检查目录是否在黑名单中（TextIndexConfig 目录名 + per-profile 黑名单路径） + bool isBlacklisted = false; + QString dirName = fileInfo.fileName(); + if (defaultBlacklistedDirs.contains(dirName) || m_excludeMatcher.shouldExclude(path)) { + isBlacklisted = true; + qDebug() << "[MixedPathListProvider::traverse] Directory blacklisted:" << path; + } + + // 只有不在黑名单中的目录才加入队列 + if (!isBlacklisted) { + // 目录自身建档（filename profile）：与上方文件分支同构， + // 同样受 scope 约束，避免范围外路径混入索引 + if (m_profile.filterPolicy().indexDirectories + && m_profile.isPathInScope(path)) { + handler(path); + } + dirQueue.enqueue(path); + initialDirs++; + } + } + } + + qInfo() << "[MixedPathListProvider::traverse] Initial processing completed - files:" << initialFiles + << "directories queued:" << initialDirs; + + // 处理所有目录 + QMap bindPathTable = IndexTraverseUtils::fstabBindInfo(); + int processedDirs = 0; + int additionalFiles = 0; + int skippedFilesByExtension = 0; // 统计因扩展名过滤跳过的文件数 + + while (!dirQueue.isEmpty()) { + if (!state.isRunning() || state.isPauseRequested()) { + qInfo() << "[MixedPathListProvider::traverse] Directory traversal interrupted - pause:" << state.isPauseRequested(); + break; + } + + QString currentDir = dirQueue.dequeue(); + + // 检查是否是系统目录或绑定目录 + if (bindPathTable.contains(currentDir) || IndexTraverseUtils::shouldSkipDirectory(currentDir)) { + qDebug() << "[MixedPathListProvider::traverse] Skipping system/bind directory:" << currentDir; + continue; + } + + // 检查路径长度和深度限制 + if (currentDir.size() > FILENAME_MAX - 1 || currentDir.count('/') > 30) { + qWarning() << "[MixedPathListProvider::traverse] Directory path too long or deep:" << currentDir + << "length:" << currentDir.size() << "depth:" << currentDir.count('/'); + continue; + } + + // 检查目录是否已访问 + if (!IndexTraverseUtils::isValidDirectory(currentDir, visitedDirs)) { + qDebug() << "[MixedPathListProvider::traverse] Directory already visited or invalid:" << currentDir; + continue; + } + + // 目录自身建档（filename profile），与递归集合一致（同 FileSystemProvider） + if (m_profile.filterPolicy().indexDirectories) + handler(currentDir); + + DIR *dir = opendir(currentDir.toStdString().c_str()); + if (!dir) { + qWarning() << "[MixedPathListProvider::traverse] Failed to open directory:" << currentDir + << "error:" << strerror(errno); + continue; + } + + ScopeGuard dirCloser([dir]() { closedir(dir); }); + processedDirs++; + + struct dirent *entry; + while ((entry = readdir(dir))) { + if (!state.isRunning() || state.isPauseRequested()) { + qInfo() << "[MixedPathListProvider::traverse] Directory scan interrupted - pause:" << state.isPauseRequested(); + break; + } + + if (IndexTraverseUtils::isSpecialDir(entry->d_name)) + continue; + + QString entryName = QString::fromUtf8(entry->d_name); + // 检查目录名是否在黑名单中（TextIndexConfig 目录名） + if (defaultBlacklistedDirs.contains(entryName)) { + qDebug() << "[MixedPathListProvider::traverse] Skipping blacklisted entry:" << entryName; + continue; + } + + QString fullPath = QDir::cleanPath(currentDir + QDir::separator() + entryName); + + // 与 FileSystemProvider 同构的隐藏条目过滤（策略命中的条目不建档、不入队） + if (IndexTraverseUtils::isHiddenFile(entry->d_name) + && m_profile.shouldSkipHiddenEntry(fullPath)) + continue; + + struct stat st; + if (lstat(fullPath.toStdString().c_str(), &st) == -1) { + qDebug() << "[MixedPathListProvider::traverse] Failed to stat entry:" << fullPath + << "error:" << strerror(errno); + continue; + } + + // 对于普通文件，早期扩展名过滤 + if (S_ISREG(st.st_mode)) { + if (IndexTraverseUtils::isValidFile(fullPath) + && m_profile.isPathInScope(fullPath) + && m_profile.isCandidateFile(fullPath) + && !m_excludeMatcher.shouldExclude(fullPath)) { + handler(fullPath); + processedFiles.insert(fullPath); + additionalFiles++; + } else { + skippedFilesByExtension++; + } + } + // 对于目录，加入队列（per-profile 黑名单目录不遍历） + else if (S_ISDIR(st.st_mode)) { + if (!m_excludeMatcher.shouldExclude(fullPath)) { + dirQueue.enqueue(fullPath); + } + } + // 符号链接条目（filename profile）：link 本身作为条目入索引， + // 绝不跟随/入队（dir link 内部内容不经链接路径索引） + else if (S_ISLNK(st.st_mode) && m_profile.filterPolicy().indexSymlinks) { + if (m_profile.isPathInScope(fullPath) + && m_profile.isCandidateFile(fullPath) + && !m_excludeMatcher.shouldExclude(fullPath) + && !processedFiles.contains(fullPath)) { + handler(fullPath); + processedFiles.insert(fullPath); + additionalFiles++; + } + } + } + } + + qInfo() << "[MixedPathListProvider::traverse] Traversal completed - processed directories:" << processedDirs + << "additional files:" << additionalFiles << "total unique files:" << processedFiles.size() + << "skipped files by extension:" << skippedFilesByExtension; +} diff --git a/src/index/task/fileprovider.h b/src/index/task/fileprovider.h new file mode 100644 index 00000000..b5d2da0e --- /dev/null +++ b/src/index/task/fileprovider.h @@ -0,0 +1,82 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FILEPROVIDER_H +#define FILEPROVIDER_H + +#include "index_global.h" +#include "profile/indexprofile.h" +#include "utils/pathexcludematcher.h" +#include "utils/taskstate.h" + +#include + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +// 文件处理回调函数类型 +using FileHandler = std::function; + +// 文件提供者接口，用于抽象不同的文件获取方式 +class FileProvider +{ +public: + virtual ~FileProvider() = default; + + // 遍历文件并处理 + virtual void traverse(TaskState &state, const FileHandler &handler) = 0; + virtual qint64 totalCount() { return 0; } + virtual QString name() { return ""; } +}; + +// 文件系统遍历提供者 +class FileSystemProvider : public FileProvider +{ +public: + FileSystemProvider(IndexProfile profile, const QString &rootPath); + void traverse(TaskState &state, const FileHandler &handler) override; + QString name() override { return "FileSystemProvider"; } + +private: + IndexProfile m_profile; + QString m_rootPath; + PathExcludeMatcher m_excludeMatcher; // per-profile 黑名单（filename: anything + 索引目录），无 pattern 时不过滤 +}; + +// 直接文件列表提供者 +class DirectFileListProvider : public FileProvider +{ +public: + explicit DirectFileListProvider(const DFMSEARCH::SearchResultList &files); + void traverse(TaskState &state, const FileHandler &handler) override; + qint64 totalCount() override; + QString name() override { return "DirectFileListProvider"; } + + /// Extract all file paths as a QStringList without traversing. + QStringList filePaths() const; + +private: + DFMSEARCH::SearchResultList m_fileList; +}; + +// 混合文件和目录列表提供者 +class MixedPathListProvider : public FileProvider +{ +public: + MixedPathListProvider(IndexProfile profile, const QStringList &pathList); + void traverse(TaskState &state, const FileHandler &handler) override; + QString name() override { return "MixedPathListProvider"; } + +private: + IndexProfile m_profile; + QStringList m_pathList; + PathExcludeMatcher m_excludeMatcher; // per-profile 黑名单（filename: anything + 索引目录），无 pattern 时不过滤 +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FILEPROVIDER_H diff --git a/src/index/task/indexcontentmigrator.cpp b/src/index/task/indexcontentmigrator.cpp new file mode 100644 index 00000000..1c925fe7 --- /dev/null +++ b/src/index/task/indexcontentmigrator.cpp @@ -0,0 +1,162 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "indexcontentmigrator.h" +#include "profile/indexprofile.h" + +#include + +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE + +using namespace Lucene; +DFM_SEARCH_USE_NS + +bool IndexContentMigrator::prepare(const QString &indexDir, const IndexProfile &profile) +{ + if (indexDir.isEmpty()) { + return false; + } + + m_oldIndexDir = indexDir + QStringLiteral(".old"); + bool didRename = false; + + if (QDir(m_oldIndexDir).exists()) { + // 上次 Create 崩溃残留的 .old，直接用作数据源（无需 rename） + qInfo() << "[IndexContentMigrator] Using existing .old residue as data source:" << m_oldIndexDir; + } else { + // 正常 Create 流程：rename 旧索引 → .old + const QDir dir(indexDir); + if (!dir.exists()) { + m_oldIndexDir.clear(); + return false; + } + + if (!QDir().rename(indexDir, m_oldIndexDir)) { + qWarning() << "[IndexContentMigrator] Failed to rename index directory:" + << indexDir << "→" << m_oldIndexDir; + m_oldIndexDir.clear(); + return false; + } + didRename = true; + qInfo() << "[IndexContentMigrator] Renamed old index:" << indexDir << "→" << m_oldIndexDir; + } + + // 以只读模式打开旧索引 + try { + m_reader = IndexReader::open( + FSDirectory::open(m_oldIndexDir.toStdWString()), true); + m_searcher = newLucene(m_reader); + + m_pathField = profile.pathField(); + m_contentField = profile.contentField(); + m_modifyTimeField = profile.modifyTimeField(); + + qInfo() << "[IndexContentMigrator] Migration prepared, reader opened with" + << m_reader->numDocs() << "documents"; + return true; + } catch (const LuceneException &e) { + qWarning() << "[IndexContentMigrator] Failed to open old index reader:" + << QString::fromStdWString(e.getError()); + if (didRename) { + QDir().rename(m_oldIndexDir, indexDir); + } + m_oldIndexDir.clear(); + return false; + } catch (const std::exception &e) { + qWarning() << "[IndexContentMigrator] Failed to open old index reader:" << e.what(); + if (didRename) { + QDir().rename(m_oldIndexDir, indexDir); + } + m_oldIndexDir.clear(); + return false; + } +} + +std::optional IndexContentMigrator::lookupContent(const QString &filePath) const +{ + if (!m_searcher || !m_pathField || !m_contentField || !m_modifyTimeField) { + return std::nullopt; + } + + try { + // Step 1: 按路径查询旧索引 + TermQueryPtr query = newLucene( + newLucene(m_pathField, filePath.toStdWString())); + TopDocsPtr topDocs = m_searcher->search(query, 1); + + if (topDocs->totalHits == 0) { + return std::nullopt; + } + + DocumentPtr doc = m_searcher->doc(topDocs->scoreDocs[0]->doc); + + // Step 2: 校验 modifyTime，确保文件未被修改 + const QFileInfo fileInfo(filePath); + if (!fileInfo.exists()) { + return std::nullopt; + } + + const QString currentMtime = QString::number(fileInfo.lastModified().toSecsSinceEpoch()); + const String storedMtime = doc->get(m_modifyTimeField); + + if (currentMtime.toStdWString() != storedMtime) { + return std::nullopt; + } + + // Step 3: 读取 content 字段 + // 返回值（无论空否）表示命中确认，调用方不应再走 extract 流程 + const String content = doc->get(m_contentField); + return QString::fromStdWString(content); + } catch (...) { + // Best-effort：任何异常静默降级，回退到正常 extract 流程 + return std::nullopt; + } +} + +void IndexContentMigrator::cleanup() +{ + // 关闭 reader + if (m_reader) { + try { + m_reader->close(); + } catch (...) { + } + m_reader.reset(); + m_searcher.reset(); + } + + // 删除 .old 目录 + if (!m_oldIndexDir.isEmpty()) { + QDir dir(m_oldIndexDir); + if (dir.exists()) { + dir.removeRecursively(); + qInfo() << "[IndexContentMigrator] Cleaned up old index:" << m_oldIndexDir; + } + m_oldIndexDir.clear(); + } +} + +bool IndexContentMigrator::isActive() const +{ + return m_searcher && !m_oldIndexDir.isEmpty(); +} + +bool IndexContentMigrator::hasResidue(const QString &indexDir) +{ + const QString oldDir = indexDir + QStringLiteral(".old"); + return QDir(oldDir).exists(); +} \ No newline at end of file diff --git a/src/index/task/indexcontentmigrator.h b/src/index/task/indexcontentmigrator.h new file mode 100644 index 00000000..40e31164 --- /dev/null +++ b/src/index/task/indexcontentmigrator.h @@ -0,0 +1,90 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXCONTENTMIGRATOR_H +#define INDEXCONTENTMIGRATOR_H + +#include "index_global.h" + +#include + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class IndexProfile; + +/** + * @brief 索引内容迁移器 — 在版本升级重建索引时从旧索引按需复用 content 字段 + * + * 使用方式: + * 1. migrator.prepare(indexDir, profile) — rename 旧索引 + 打开 reader + * 2. migrator.lookupContent(filePath) — 对每个文件按需查询（per-file TermQuery） + * 3. migrator.cleanup() — 删除 .old 目录 + 关闭 reader + * + * hasResidue() 用于检测 .old 残留（崩溃恢复时 UpdateIndexHandler 据此决定是否创建 migrator）。 + * + * cleanup() 仅在任务成功完成时显式调用，中断/析构时不自动清理 —— .old 保留供 + * 下次启动恢复使用（reader 通过 Lucene++ 智能指针正常关闭）。 + */ +class IndexContentMigrator +{ +public: + IndexContentMigrator() = default; + + // 禁止拷贝和移动 + IndexContentMigrator(const IndexContentMigrator &) = delete; + IndexContentMigrator &operator=(const IndexContentMigrator &) = delete; + IndexContentMigrator(IndexContentMigrator &&) = delete; + IndexContentMigrator &operator=(IndexContentMigrator &&) = delete; + + /** + * @brief 准备迁移：rename indexDir → indexDir.old，打开 IndexReader + * @param indexDir 当前索引目录 + * @param profile 索引配置（提供字段名） + * @return true 迁移就绪，false 降级（旧索引不存在或 rename 失败） + */ + bool prepare(const QString &indexDir, const IndexProfile &profile); + + /** + * @brief 从旧索引按路径查询内容 + * @param filePath 文件绝对路径 + * @return 三态结果： + * - 有值（非空 QString）：命中且 modifyTime 匹配，返回 content + * - 有值（空 QString）：命中且 modifyTime 匹配，但 content 字段确实为空 + * - std::nullopt：未命中、校验失败或异常，应回退到 extract 流程 + * + * 每次调用执行一次 TermQuery，O(1) 内存开销。 + * modifyTime 校验确保文件在索引重建间隔内未被修改。 + */ + std::optional lookupContent(const QString &filePath) const; + + /** + * @brief 清理 .old 目录并关闭 reader + */ + void cleanup(); + + /** + * @brief 迁移是否处于活跃状态 + */ + bool isActive() const; + + /** + * @brief 检测指定索引目录是否存在 .old 残留 + */ + static bool hasResidue(const QString &indexDir); + +private: + QString m_oldIndexDir; + Lucene::IndexReaderPtr m_reader; + Lucene::SearcherPtr m_searcher; + const wchar_t *m_pathField { nullptr }; + const wchar_t *m_contentField { nullptr }; + const wchar_t *m_modifyTimeField { nullptr }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXCONTENTMIGRATOR_H \ No newline at end of file diff --git a/src/index/task/indextask.cpp b/src/index/task/indextask.cpp new file mode 100644 index 00000000..96efcd61 --- /dev/null +++ b/src/index/task/indextask.cpp @@ -0,0 +1,246 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "indextask.h" + +#include "progressnotifier.h" +#include "utils/systemdcpuutils.h" +#include "utils/textindexconfig.h" + +#include + +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE +using namespace Lucene; + +IndexTask::IndexTask(Type type, const QString &path, TaskHandler handler, QObject *parent) + : QObject(parent), m_type(type), m_path(path), m_handler(handler) +{ + qInfo() << "[IndexTask] Created new task - type:" << static_cast(type) << "path:" << path; + + // 连接进度通知 + connect(ProgressNotifier::instance(), &ProgressNotifier::progressChanged, + this, &IndexTask::onProgressChanged); +} + +IndexTask::~IndexTask() +{ + qDebug() << "[IndexTask] Destroying task for path:" << m_path; + disconnect(ProgressNotifier::instance(), &ProgressNotifier::progressChanged, + this, &IndexTask::onProgressChanged); +} + +void IndexTask::onProgressChanged(qint64 count, qint64 total) +{ + if (m_state.isRunning()) { + // 避免在高频进度更新中打印过多日志，只在特定条件下打印 + static qint64 lastLoggedCount = 0; + if (count == 0 || total == 0 || count == total || (count - lastLoggedCount) >= 1000) { + qDebug() << "[IndexTask::onProgressChanged] Task progress - type:" << static_cast(m_type) + << "processed:" << count << "total:" << total; + lastLoggedCount = count; + } + emit progressChanged(m_type, count, total); + } +} + +void IndexTask::applyResourcePolicy() +{ + switch (m_grade) { + case Grade::Light: + case Grade::Medium: + case Grade::Heavy: { + int limit = TextIndexConfig::instance().cpuUsageLimitPercent(); + qDebug() << "[IndexTask::applyResourcePolicy] Acquiring CPU quota:" << limit + << "% for grade:" << static_cast(m_grade) << "service:" << Defines::kIndexSystemdUnitName; + SystemdCpuUtils::acquireCpuQuota(Defines::kIndexSystemdUnitName, limit); + break; + } + case Grade::Manual: { + qInfo() << "[IndexTask::applyResourcePolicy] Manual grade - resetting CPU quota for service:" << Defines::kIndexSystemdUnitName; + SystemdCpuUtils::manualTaskCpuQuota(Defines::kIndexSystemdUnitName); + break; + } + default: + qWarning() << "[IndexTask::applyResourcePolicy] Unknown grade:" << static_cast(m_grade); + break; + } +} + +void IndexTask::releaseResourcePolicy() +{ + switch (m_grade) { + case Grade::Light: + case Grade::Medium: + case Grade::Heavy: + qDebug() << "[IndexTask::releaseResourcePolicy] Releasing CPU quota for grade:" << static_cast(m_grade); + SystemdCpuUtils::releaseCpuQuota(Defines::kIndexSystemdUnitName); + break; + case Grade::Manual: + qDebug() << "[IndexTask::releaseResourcePolicy] Manual grade - resetting CPU quota"; + SystemdCpuUtils::manualTaskCpuQuota(Defines::kIndexSystemdUnitName); + break; + default: + break; + } +} + +void IndexTask::start() +{ + if (m_state.isRunning()) { + qWarning() << "[IndexTask::start] Task already running, ignoring start request - path:" << m_path; + return; + } + + qInfo() << "[IndexTask::start] Starting task - type:" << static_cast(m_type) + << "path:" << m_path; + + m_state.start(); + m_status = Status::Running; + + Q_ASSERT(QThread::currentThread() != QCoreApplication::instance()->thread()); + qDebug() << "[IndexTask::start] Task executing in worker thread:" << QThread::currentThread() + << "main thread:" << QCoreApplication::instance()->thread(); + + doTask(); +} + +void IndexTask::stop() +{ + qInfo() << "[IndexTask::stop] Stopping task - type:" << static_cast(m_type) << "path:" << m_path; + m_state.stop(); +} + +void IndexTask::requestPause() +{ + qInfo() << "[IndexTask::requestPause] Requesting pause - type:" << static_cast(m_type) << "path:" << m_path; + m_state.requestPause(); +} + +bool IndexTask::isRunning() const +{ + return m_status == Status::Running; +} + +QString IndexTask::taskPath() const +{ + return m_path; +} + +IndexTask::Type IndexTask::taskType() const +{ + return m_type; +} + +IndexTask::Status IndexTask::status() const +{ + return m_status; +} + +IndexTask::Grade IndexTask::grade() const +{ + return m_grade; +} + +void IndexTask::setGrade(Grade grade) +{ + m_grade = grade; + qInfo() << "[IndexTask::setGrade] Grade set to:" << static_cast(grade) << "for path:" << m_path; +} + +bool IndexTask::forceBypass() const +{ + return m_forceBypass; +} + +void IndexTask::setForceBypass(bool bypass) +{ + m_forceBypass = bypass; +} + +bool IndexTask::isIndexCorrupted() const +{ + return m_indexCorrupted; +} + +void IndexTask::setIndexCorrupted(bool corrupted) +{ + if (m_indexCorrupted != corrupted) { + qWarning() << "[IndexTask::setIndexCorrupted] Index corruption status changed to:" << corrupted + << "for path:" << m_path; + m_indexCorrupted = corrupted; + } +} + +void IndexTask::doTask() +{ + qInfo() << "[IndexTask::doTask] Executing task handler - type:" << static_cast(m_type) + << "path:" << m_path << "grade:" << static_cast(m_grade); + + HandlerResult result { false, false }; + bool resourcePolicyApplied = false; + + if (m_handler) { + try { + setIndexCorrupted(false); + m_state.clearPauseRequest(); + applyResourcePolicy(); + resourcePolicyApplied = true; + + qDebug() << "[IndexTask::doTask] Invoking task handler for path:" << m_path; + result = m_handler(m_path, m_state); + + if (m_state.isPauseRequested() && !result.success) { + result.paused = true; + qInfo() << "[IndexTask::doTask] Task paused by request - path:" << m_path; + } else if (result.fatal) { + qCritical() << "[IndexTask::doTask] Task handler reported fatal error - path:" << m_path; + setIndexCorrupted(true); + } else if (!result.success) { + qWarning() << "[IndexTask::doTask] Task handler failed - path:" << m_path; + } else { + qDebug() << "[IndexTask::doTask] Task handler completed successfully - path:" << m_path; + } + } catch (const LuceneException &e) { + qCritical() << "[IndexTask::doTask] Lucene exception caught, index corrupted - path:" << m_path + << "error:" << QString::fromStdWString(e.getError()); + setIndexCorrupted(true); + result.success = false; + } catch (const std::exception &e) { + qCritical() << "[IndexTask::doTask] Standard exception caught - path:" << m_path + << "error:" << e.what(); + result.success = false; + } catch (...) { + qCritical() << "[IndexTask::doTask] Unknown exception caught - path:" << m_path; + result.success = false; + } + } else { + qCritical() << "[IndexTask::doTask] No task handler provided - path:" << m_path; + } + + if (resourcePolicyApplied) { + releaseResourcePolicy(); + } + + if (result.paused) { + m_status = Status::Paused; + emit paused(m_type, result); + } else { + m_state.stop(); + m_status = result.success ? Status::Finished : Status::Failed; + + if (result.success) { + qDebug() << "[IndexTask::doTask] Task completed successfully - type:" << static_cast(m_type) + << "path:" << m_path; + } else { + qWarning() << "[IndexTask::doTask] Task failed - type:" << static_cast(m_type) + << "path:" << m_path << "corrupted:" << m_indexCorrupted; + } + + emit finished(m_type, result); + } +} diff --git a/src/index/task/indextask.h b/src/index/task/indextask.h new file mode 100644 index 00000000..fcc15855 --- /dev/null +++ b/src/index/task/indextask.h @@ -0,0 +1,94 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXTASK_H +#define INDEXTASK_H + +#include "index_global.h" +#include "taskhandler.h" +#include "utils/taskstate.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class IndexTask : public QObject +{ + Q_OBJECT +public: + enum class Type { + Create, // 创建索引 + Update, // 更新索引 + CreateFileList, // 基于文件列表创建索引 + UpdateFileList, // 基于文件列表更新索引 + RemoveFileList, // 基于文件列表删除索引 + MoveFileList // 基于文件移动列表更新索引路径 + }; + Q_ENUM(Type) + + enum class Status { + NotStarted, + Running, + Paused, + Finished, + Failed + }; + Q_ENUM(Status) + + enum class Grade { + None, // 未分级 + Light, // 轻量增量 + Medium, // 中量增量 + Heavy, // 重型（首次建库/完整重建/补全未完成Create） + Manual // 手动更新（绕过环境门槛） + }; + Q_ENUM(Grade) + + explicit IndexTask(Type type, const QString &path, TaskHandler handler, QObject *parent = nullptr); + ~IndexTask(); + + void start(); + void stop(); + void requestPause(); + bool isRunning() const; + + QString taskPath() const; + Type taskType() const; + Status status() const; + Grade grade() const; + void setGrade(Grade grade); + + bool forceBypass() const; + void setForceBypass(bool bypass); + + bool isIndexCorrupted() const; + void setIndexCorrupted(bool corrupted); + +Q_SIGNALS: + void progressChanged(ANYTHING_INDEX_NAMESPACE::IndexTask::Type type, qint64 count, qint64 total); + void finished(ANYTHING_INDEX_NAMESPACE::IndexTask::Type type, ANYTHING_INDEX_NAMESPACE::HandlerResult result); + void paused(ANYTHING_INDEX_NAMESPACE::IndexTask::Type type, ANYTHING_INDEX_NAMESPACE::HandlerResult result); + +private: + void applyResourcePolicy(); + void releaseResourcePolicy(); + void doTask(); + void onProgressChanged(qint64 count, qint64 total); + + Type m_type; + QString m_path; + Status m_status { Status::NotStarted }; + Grade m_grade { Grade::None }; + bool m_forceBypass { false }; + TaskState m_state; + TaskHandler m_handler; + bool m_indexCorrupted { false }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +Q_DECLARE_METATYPE(ANYTHING_INDEX_NAMESPACE::IndexTask::Type) + +#endif // INDEXTASK_H diff --git a/src/index/task/moveprocessor.cpp b/src/index/task/moveprocessor.cpp new file mode 100644 index 00000000..f74e0d07 --- /dev/null +++ b/src/index/task/moveprocessor.cpp @@ -0,0 +1,407 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "moveprocessor.h" +#include "utils/docutils.h" + +#include +#include +#include + +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE +using namespace Lucene; +DFM_SEARCH_USE_NS + +namespace { + +/// 收集 builder 声明的路径派生字段重算规格；builder 缺省（如部分单测场景）时返回空列表 +std::list collectDerivedSpecs(const IndexContext &context) +{ + const IndexDocumentBuilder *builder = context.documentBuilder(); + if (!builder) + return {}; + return builder->pathDerivedFields(); +} + +/// 从旧文档复制字段（排除 path/ancestor_paths/路径派生字段），再按新路径补齐： +/// path 与 ancestor_paths 全量重算；派生字段用声明式重算器更新（纯元数据，零 IO） +DocumentPtr createMovedDocument(const IndexContext &context, const DocumentPtr &oldDoc, + const QString &toPath, const std::list &derivedSpecs) +{ + std::vector exclude = { context.profile().pathField(), context.profile().ancestorPathsField() }; + for (const auto &spec : derivedSpecs) + exclude.push_back(spec.fieldName); + + DocumentPtr newDoc = DocUtils::copyFieldsExcept(oldDoc, exclude); + if (!newDoc) + return nullptr; + + newDoc->add(newLucene(context.profile().pathField(), toPath.toStdWString(), + Field::STORE_YES, Field::INDEX_NOT_ANALYZED)); + + for (const QString &ancestorPath : PathCalculator::extractAncestorPaths(toPath)) { + newDoc->add(newLucene(context.profile().ancestorPathsField(), ancestorPath.toStdWString(), + Field::STORE_NO, Field::INDEX_NOT_ANALYZED)); + } + + for (const auto &spec : derivedSpecs) { + if (FieldPtr field = spec.rebuild(toPath)) + newDoc->add(field); + } + + return newDoc; +} + +} // namespace + +// FileMoveProcessor implementation +FileMoveProcessor::FileMoveProcessor(const IndexContext &context, const SearcherPtr &searcher, const IndexWriterPtr &writer) + : m_searcher(searcher), m_writer(writer), m_context(&context) +{ + qDebug() << "[FileMoveProcessor] Initialized with searcher and writer"; +} + +bool FileMoveProcessor::processFileMove(const QString &fromPath, const QString &toPath) +{ + try { + qInfo() << "[FileMoveProcessor::processFileMove] Processing file move:" << fromPath << "->" << toPath; + + TermQueryPtr pathQuery = newLucene( + newLucene(m_context->profile().pathField(), fromPath.toStdWString())); + + TopDocsPtr searchResult = m_searcher->search(pathQuery, 1); + if (!searchResult || searchResult->totalHits == 0) { + qDebug() << "[FileMoveProcessor::processFileMove] Source file not found in index:" << fromPath; + + // Check if target file should be indexed + if (m_context->profile().isCandidateFile(toPath) && QFileInfo(toPath).exists()) { + if (isFileInIndex(toPath)) { + // Smart detection: Editor save pattern (temporary file renamed to indexed file) + qInfo() << "[FileMoveProcessor::processFileMove] Detected editor save pattern - temporary file" + << fromPath << "renamed to indexed file" << toPath << "- updating content"; + return processContentUpdateWithCache(toPath, "editor save pattern"); + } else { + // Fallback: Create new index entry for supported file not in index + // This handles cases like: + // 1. Files moved from unindexed directories + // 2. Index corruption or incomplete indexing + // 3. External file operations + qInfo() << "[FileMoveProcessor::processFileMove] Fallback indexing for supported file not in index:" + << toPath; + return processContentUpdateWithCache(toPath, "fallback indexing"); + } + } + + qDebug() << "[FileMoveProcessor::processFileMove] Target file not in index or not supported, skipping move operation"; + return true; // Not an error, file might not be indexed + } + + // 按 profile 声明的 move 更新策略分发（策略语义见 IndexProfile::MoveUpdatePolicy）： + // 文档字段由路径派生的 profile 必须整体重建，否则旧路径派生的字段值 + // （如 filename 的 file_name/pinyin）残留导致新名称搜索不到 + switch (m_context->profile().moveUpdatePolicy()) { + case IndexProfile::MoveUpdatePolicy::RebuildDocument: + return rebuildDocumentForMove(fromPath, toPath); + case IndexProfile::MoveUpdatePolicy::UpdatePathOnly: + break; + } + + DocumentPtr doc = m_searcher->doc(searchResult->scoreDocs[0]->doc); + if (!doc) { + qWarning() << "[FileMoveProcessor::processFileMove] Failed to retrieve document for:" << fromPath; + return false; + } + + // copy 保留与路径无关的字段（contents/checksum/时间戳等），按新路径 + // 重算 path/ancestor_paths 及 builder 声明的路径派生字段 + DocumentPtr newDoc = createMovedDocument(*m_context, doc, toPath, collectDerivedSpecs(*m_context)); + if (!newDoc) { + qWarning() << "[FileMoveProcessor::processFileMove] Failed to copy document fields for:" << fromPath; + return false; + } + + // Update document in index + TermPtr oldTerm = newLucene(m_context->profile().pathField(), fromPath.toStdWString()); + m_writer->updateDocument(oldTerm, newDoc); + m_hasChanges = true; + + // Update processed paths cache + m_processedPaths.remove(fromPath); // Remove old path + m_processedPaths.insert(toPath); // Add new path + + qInfo() << "[FileMoveProcessor::processFileMove] Successfully updated file document path:" + << fromPath << "->" << toPath; + return true; + } catch (const LuceneException &e) { + qWarning() << "[FileMoveProcessor::processFileMove] File move processing failed with Lucene exception:" + << fromPath << "error:" << QString::fromStdWString(e.getError()); + return false; + } catch (const std::exception &e) { + qWarning() << "[FileMoveProcessor::processFileMove] File move processing failed with exception:" + << fromPath << "error:" << e.what(); + return false; + } +} + +bool FileMoveProcessor::rebuildDocumentForMove(const QString &fromPath, const QString &toPath) +{ + if (!m_context->documentBuilder()) { + qWarning() << "[FileMoveProcessor::rebuildDocumentForMove] Missing document builder for profile:" + << m_context->profile().id(); + return false; + } + + try { + DocumentPtr newDoc = m_context->documentBuilder()->build(toPath, QString()); + if (!newDoc) { + qWarning() << "[FileMoveProcessor::rebuildDocumentForMove] Failed to rebuild document for:" << toPath; + return false; + } + + // 以 fromPath 定位更新，避免旧路径文档残留 + TermPtr oldTerm = newLucene(m_context->profile().pathField(), fromPath.toStdWString()); + m_writer->updateDocument(oldTerm, newDoc); + m_hasChanges = true; + + m_processedPaths.remove(fromPath); + m_processedPaths.insert(toPath); + + qInfo() << "[FileMoveProcessor::rebuildDocumentForMove] Rebuilt document for move:" + << fromPath << "->" << toPath; + return true; + } catch (const LuceneException &e) { + qWarning() << "[FileMoveProcessor::rebuildDocumentForMove] Failed with Lucene exception:" + << fromPath << "->" << toPath + << "error:" << QString::fromStdWString(e.getError()); + return false; + } catch (const std::exception &e) { + qWarning() << "[FileMoveProcessor::rebuildDocumentForMove] Failed with exception:" + << fromPath << "->" << toPath << "error:" << e.what(); + return false; + } catch (...) { + qWarning() << "[FileMoveProcessor::rebuildDocumentForMove] Failed with unknown exception:" + << fromPath << "->" << toPath; + return false; + } +} + +bool FileMoveProcessor::isFileInIndex(const QString &path) +{ + try { + // First check if the file has been processed in current batch (but not yet committed) + if (m_processedPaths.contains(path)) { + qDebug() << "[FileMoveProcessor::isFileInIndex] File found in processed cache:" << path; + return true; + } + + // Then check in the actual index + TermQueryPtr pathQuery = newLucene( + newLucene(m_context->profile().pathField(), path.toStdWString())); + + TopDocsPtr searchResult = m_searcher->search(pathQuery, 1); + bool exists = searchResult && searchResult->totalHits > 0; + + qDebug() << "[FileMoveProcessor::isFileInIndex] File existence check:" << path << "exists:" << exists; + return exists; + } catch (const LuceneException &e) { + qWarning() << "[FileMoveProcessor::isFileInIndex] Failed to check file existence with Lucene exception:" + << path << "error:" << QString::fromStdWString(e.getError()); + return false; + } catch (const std::exception &e) { + qWarning() << "[FileMoveProcessor::isFileInIndex] Failed to check file existence with exception:" + << path << "error:" << e.what(); + return false; + } +} + +bool FileMoveProcessor::processContentUpdate(const QString &filePath) +{ + try { + qInfo() << "[FileMoveProcessor::processContentUpdate] Processing content update for file:" << filePath; + QFileInfo fileInfo(filePath); + if (!fileInfo.exists()) { + qWarning() << "[FileMoveProcessor::processContentUpdate] File does not exist:" << filePath; + return false; + } + + // filename profile 无内容提取（extractor() == nullptr）：直接用空文本构建文档， + // 与 createFileDocument 的处理一致（FileNameDocumentBuilder 忽略 text 参数）。 + // 此处必须判空：MoveFileList 的 editor-save/fallback 路径在 filename profile 下 + // 也会进入本函数，对 nullptr 调用 extract() 会直接 SIGSEGV。 + QString text; + if (m_context->extractor()) { + const int truncationSizeMB = m_context->profile().maxFileTruncationSizeMB(); + const size_t maxBytes = static_cast(truncationSizeMB) * 1024 * 1024; + const IndexExtractionResult extraction = m_context->extractor()->extract(filePath, maxBytes); + if (!extraction.success) { + qInfo() << "[FileMoveProcessor::processContentUpdate] Failed to extract content from file:" + << filePath << "error:" << extraction.error; + } + text = extraction.text; + } + + DocumentPtr newDoc = m_context->documentBuilder()->build(filePath, text); + + // Update the document in index + TermPtr pathTerm = newLucene(m_context->profile().pathField(), filePath.toStdWString()); + m_writer->updateDocument(pathTerm, newDoc); + m_hasChanges = true; + + qInfo() << "[FileMoveProcessor::processContentUpdate] Successfully updated file content in index:" << filePath; + return true; + } catch (const LuceneException &e) { + qWarning() << "[FileMoveProcessor::processContentUpdate] Content update failed with Lucene exception:" + << filePath << "error:" << QString::fromStdWString(e.getError()); + return false; + } catch (const std::exception &e) { + qWarning() << "[FileMoveProcessor::processContentUpdate] Content update failed with exception:" + << filePath << "error:" << e.what(); + return false; + } catch (...) { + qWarning() << "[FileMoveProcessor::processContentUpdate] Content update failed with unknown exception:" << filePath; + return false; + } +} + +bool FileMoveProcessor::processContentUpdateWithCache(const QString &filePath, const QString &operation) +{ + bool success = processContentUpdate(filePath); + if (success) { + // Update processed paths cache + m_processedPaths.insert(filePath); + qInfo() << "[FileMoveProcessor::processContentUpdateWithCache] Successfully completed" << operation << "for:" << filePath; + } else { + qWarning() << "[FileMoveProcessor::processContentUpdateWithCache] Failed" << operation << "for:" << filePath; + } + return success; +} + +// DirectoryMoveProcessor implementation +DirectoryMoveProcessor::DirectoryMoveProcessor(const IndexContext &context, + const SearcherPtr &searcher, + const IndexWriterPtr &writer, + const IndexReaderPtr &reader) + : m_searcher(searcher), m_writer(writer), m_reader(reader), m_context(&context) +{ + qDebug() << "[DirectoryMoveProcessor] Initialized with searcher, writer, and reader"; +} + +bool DirectoryMoveProcessor::processDirectoryMove(const QString &fromPath, const QString &toPath, TaskState &running) +{ + try { + qInfo() << "[DirectoryMoveProcessor::processDirectoryMove] Processing directory move:" + << fromPath << "->" << toPath; + + // 使用 TermQuery 在 ancestor_paths 字段上进行精确匹配 + // ancestor_paths 存储的目录路径不带尾部斜杠 + TermQueryPtr ancestorQuery = newLucene( + newLucene(m_context->profile().ancestorPathsField(), fromPath.toStdWString())); + + TopDocsPtr allDocs = m_searcher->search(ancestorQuery, m_reader->maxDoc()); + if (!allDocs || allDocs->totalHits == 0) { + qDebug() << "[DirectoryMoveProcessor::processDirectoryMove] No documents found for directory move:" << fromPath; + return true; // Not an error, directory might be empty or not indexed + } + + qInfo() << "[DirectoryMoveProcessor::processDirectoryMove] Found" << allDocs->totalHits + << "documents to update for directory move:" << fromPath; + + int successCount = 0; + int failureCount = 0; + + // 用于计算新路径时使用，需要带尾部斜杠 + QString normalizedFromPath = PathCalculator::normalizeDirectoryPath(fromPath); + + // Batch update all matching documents + for (int32_t i = 0; i < allDocs->totalHits; ++i) { + if (!running.isRunning()) { + qInfo() << "[DirectoryMoveProcessor::processDirectoryMove] Directory move interrupted by user request"; + return false; // Interrupted + } + + if (!allDocs->scoreDocs || !allDocs->scoreDocs[i]) { + qWarning() << "[DirectoryMoveProcessor::processDirectoryMove] Null scoreDoc at index:" << i; + failureCount++; + continue; + } + + DocumentPtr doc = m_searcher->doc(allDocs->scoreDocs[i]->doc); + if (!doc) { + qWarning() << "[DirectoryMoveProcessor::processDirectoryMove] Null document at index:" << i; + failureCount++; + continue; + } + + if (updateSingleDocumentPath(doc, normalizedFromPath, toPath)) { + successCount++; + } else { + qWarning() << "[DirectoryMoveProcessor::processDirectoryMove] Failed to update document at index:" << i; + failureCount++; + // Continue with other documents + } + } + + qInfo() << "[DirectoryMoveProcessor::processDirectoryMove] Directory move completed - successful updates:" + << successCount << "failed updates:" << failureCount; + return true; + } catch (const LuceneException &e) { + qWarning() << "[DirectoryMoveProcessor::processDirectoryMove] Directory move processing failed with Lucene exception:" + << fromPath << "error:" << QString::fromStdWString(e.getError()); + return false; + } catch (const std::exception &e) { + qWarning() << "[DirectoryMoveProcessor::processDirectoryMove] Directory move processing failed with exception:" + << fromPath << "error:" << e.what(); + return false; + } +} + +bool DirectoryMoveProcessor::updateSingleDocumentPath(const DocumentPtr &doc, + const QString &normalizedFromPath, + const QString &toPath) +{ + try { + String oldPathValue = doc->get(m_context->profile().pathField()); + QString oldPath = QString::fromStdWString(oldPathValue); + + // Calculate new path + QString newPath = PathCalculator::calculateNewPathForDirectoryMove(oldPath, normalizedFromPath, toPath); + + if (newPath == oldPath) { + qDebug() << "[DirectoryMoveProcessor::updateSingleDocumentPath] No path change needed for:" << oldPath; + return true; // No change needed + } + + // 目录改名不改变子文件的 basename（file_name/pinyin/file_ext 等值不变）， + // 统一走 copy 保留 + 派生字段重算：path/ancestor_paths 全量重算， + // is_hidden 等完整路径派生字段由 builder 声明的重算器更新。 + // 即使 RebuildDocument 策略的 profile（filename）也不整体重建， + // 避免百万级子文件的目录改名时逐文档 stat/重建的开销 + DocumentPtr newDoc = createMovedDocument(*m_context, doc, newPath, collectDerivedSpecs(*m_context)); + + if (!newDoc) { + qWarning() << "[DirectoryMoveProcessor::updateSingleDocumentPath] Failed to build document for:" << newPath; + return false; + } + + // Update document in index + TermPtr oldTerm = newLucene(m_context->profile().pathField(), oldPathValue); + m_writer->updateDocument(oldTerm, newDoc); + m_hasChanges = true; + + qDebug() << "[DirectoryMoveProcessor::updateSingleDocumentPath] Successfully updated document path:" + << oldPath << "->" << newPath; + return true; + } catch (const LuceneException &e) { + qWarning() << "[DirectoryMoveProcessor::updateSingleDocumentPath] Failed to update document path with Lucene exception:" + << "error:" << QString::fromStdWString(e.getError()); + return false; + } catch (const std::exception &e) { + qWarning() << "[DirectoryMoveProcessor::updateSingleDocumentPath] Failed to update document path with exception:" + << "error:" << e.what(); + return false; + } +} diff --git a/src/index/task/moveprocessor.h b/src/index/task/moveprocessor.h new file mode 100644 index 00000000..0da566ee --- /dev/null +++ b/src/index/task/moveprocessor.h @@ -0,0 +1,133 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef MOVEPROCESSOR_H +#define MOVEPROCESSOR_H + +#include "index_global.h" +#include "core/indexcontext.h" +#include "utils/taskstate.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief Processor for handling single file move operations in index + */ +class FileMoveProcessor +{ +public: + FileMoveProcessor(const IndexContext &context, + const Lucene::SearcherPtr &searcher, + const Lucene::IndexWriterPtr &writer); + + /** + * @brief Process single file move operation + * @param fromPath Source file path + * @param toPath Target file path + * @return true if processed successfully, false otherwise + */ + bool processFileMove(const QString &fromPath, const QString &toPath); + + /** + * @brief Check if any index modifications were made during processing + * @return true if at least one document was added, updated, or deleted + */ + bool hasChanges() const { return m_hasChanges; } + +private: + /** + * @brief Check if a file exists in the index or has been processed in current batch + * @param path File path to check + * @return true if file exists in index or processed cache, false otherwise + */ + bool isFileInIndex(const QString &path); + + /** + * @brief Rebuild the document for a moved file from its new path + * + * Executed for profiles declaring IndexProfile::MoveUpdatePolicy::RebuildDocument + * (document fields derived from path, e.g. filename). Locates the old + * document by fromPath so no stale document is left behind. + * @param fromPath Source file path + * @param toPath Target file path + * @return true if rebuilt successfully, false otherwise + */ + bool rebuildDocumentForMove(const QString &fromPath, const QString &toPath); + + + + /** + * @brief Process content update for a file (re-index its content) + * @param filePath Path of the file to re-index + * @return true if content updated successfully, false otherwise + */ + bool processContentUpdate(const QString &filePath); + + /** + * @brief Process content update with cache management + * @param filePath Path of the file to re-index + * @param operation Description of the operation for logging + * @return true if content updated successfully, false otherwise + */ + bool processContentUpdateWithCache(const QString &filePath, const QString &operation); + + Lucene::SearcherPtr m_searcher; + Lucene::IndexWriterPtr m_writer; + const IndexContext *m_context { nullptr }; + QSet m_processedPaths; ///< Cache of paths processed in current batch (not yet committed) + bool m_hasChanges { false }; +}; + +/** + * @brief Processor for handling directory move operations in index + */ +class DirectoryMoveProcessor +{ +public: + DirectoryMoveProcessor(const IndexContext &context, + const Lucene::SearcherPtr &searcher, + const Lucene::IndexWriterPtr &writer, + const Lucene::IndexReaderPtr &reader); + + /** + * @brief Process directory move operation using prefix query + * @param fromPath Source directory path + * @param toPath Target directory path + * @param running Task state for interruption checking + * @return true if processed successfully, false if interrupted or failed + */ + bool processDirectoryMove(const QString &fromPath, const QString &toPath, TaskState &running); + + /** + * @brief Check if any index modifications were made during processing + * @return true if at least one document was updated + */ + bool hasChanges() const { return m_hasChanges; } + +private: + /** + * @brief Update single document path within directory move + * @param doc Document to update + * @param normalizedFromPath Normalized source directory path + * @param toPath Target directory path + * @return true if updated successfully, false otherwise + */ + bool updateSingleDocumentPath(const Lucene::DocumentPtr &doc, + const QString &normalizedFromPath, + const QString &toPath); + + Lucene::SearcherPtr m_searcher; + Lucene::IndexWriterPtr m_writer; + Lucene::IndexReaderPtr m_reader; + const IndexContext *m_context { nullptr }; + bool m_hasChanges { false }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // MOVEPROCESSOR_H diff --git a/src/index/task/progressnotifier.cpp b/src/index/task/progressnotifier.cpp new file mode 100644 index 00000000..76693767 --- /dev/null +++ b/src/index/task/progressnotifier.cpp @@ -0,0 +1,13 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "progressnotifier.h" + +ANYTHING_INDEX_USE_NAMESPACE + +ProgressNotifier *ProgressNotifier::instance() +{ + static ProgressNotifier instance; + return &instance; +} diff --git a/src/index/task/progressnotifier.h b/src/index/task/progressnotifier.h new file mode 100644 index 00000000..938d16c2 --- /dev/null +++ b/src/index/task/progressnotifier.h @@ -0,0 +1,29 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef PROGRESSNOTIFIER_H +#define PROGRESSNOTIFIER_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class ProgressNotifier : public QObject +{ + Q_OBJECT +public: + static ProgressNotifier *instance(); + +Q_SIGNALS: + void progressChanged(qint64 count, qint64 total); + +private: + explicit ProgressNotifier(QObject *parent = nullptr) + : QObject(parent) { } +}; + +ANYTHING_INDEX_END_NAMESPACE +#endif // PROGRESSNOTIFIER_H diff --git a/src/index/task/taskhandler.cpp b/src/index/task/taskhandler.cpp new file mode 100644 index 00000000..86df1283 --- /dev/null +++ b/src/index/task/taskhandler.cpp @@ -0,0 +1,1471 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "taskhandler.h" +#include "document/builderoptions.h" +#include "fileprovider.h" +#include "indexcontentmigrator.h" +#include "progressnotifier.h" +#include "moveprocessor.h" +#include "utils/scopeguard.h" +#include "utils/indexutility.h" +#include "utils/textindexconfig.h" +#include "utils/pathexcludematcher.h" + +#include +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE + +using namespace Lucene; +DFM_SEARCH_USE_NS +namespace { + +std::unique_ptr createAnythingFileProvider(const IndexContext &context, const QString &path) +{ + if (!IndexUtility::isIndexWithAnything(path) || !context.profile().supportsAnything()) { + return nullptr; + } + + const auto anythingOptions = context.profile().anythingSearchOptions(); + + qDebug() << "[TaskHandlers::createAnythingFileProvider] Attempting to use ANYTHING for profile:" + << context.profile().id() << "path:" << path + << "file types:" << anythingOptions.fileTypes + << "file extensions:" << anythingOptions.fileExtensions; + + // Prefer CLI process for file listing; fallback to SearchEngine API on failure + QStringList cliArgs = { "--type=filename", "--method=indexed", "--json", "", "/" }; + if (!anythingOptions.fileTypes.isEmpty()) { + cliArgs << QString("--file-types=%1").arg(anythingOptions.fileTypes.join(",")); + } + if (!anythingOptions.fileExtensions.isEmpty()) { + cliArgs << QString("--file-extensions=%1").arg(anythingOptions.fileExtensions.join(",")); + } + if (TextIndexConfig::instance().indexHiddenFiles()) { + cliArgs << "--include-hidden"; + } + + const QStringList cliPaths = SearchUtility::runCli(cliArgs); + if (!cliPaths.isEmpty()) { + SearchResultList cliResults; + cliResults.reserve(cliPaths.size()); + for (const QString &p : cliPaths) { + cliResults.append(SearchResult(p)); + } + qInfo() << "[TaskHandlers::createAnythingFileProvider] CLI succeeded, obtained" + << cliResults.size() << "file listings for profile:" << context.profile().id(); + return std::make_unique(cliResults); + } + + qInfo() << "[TaskHandlers::createAnythingFileProvider] CLI scan empty/failed," + << "falling back to SearchEngine API for profile:" << context.profile().id(); + + QObject holder; + SearchEngine *engine = SearchFactory::createEngine(SearchType::FileName, &holder); + if (!engine) { + qWarning() << "[TaskHandlers::createAnythingFileProvider] Failed to create ANYTHING search engine for profile:" + << context.profile().id(); + return nullptr; + } + + SearchOptions options; + options.setSyncSearchTimeout(120); + options.setSearchPath(QDir::rootPath()); + options.setSearchMethod(SearchMethod::Indexed); + options.setIncludeHidden(TextIndexConfig::instance().indexHiddenFiles()); + + FileNameOptionsAPI fileNameOptions(options); + if (!anythingOptions.fileTypes.isEmpty()) { + fileNameOptions.setFileTypes(anythingOptions.fileTypes); + } + if (!anythingOptions.fileExtensions.isEmpty()) { + fileNameOptions.setFileExtensions(anythingOptions.fileExtensions); + } + engine->setSearchOptions(options); + + SearchQuery query = SearchFactory::createQuery("", SearchQuery::Type::Simple); + const SearchResultExpected &result = engine->searchSync(query); + if (!result.hasValue() || result->isEmpty()) { + qWarning() << "[TaskHandlers::createAnythingFileProvider] ANYTHING returned no results for profile:" + << context.profile().id(); + return nullptr; + } + + qInfo() << "[TaskHandlers::createAnythingFileProvider] Successfully obtained file listings from ANYTHING for profile:" + << context.profile().id() << "count:" << result.value().count(); + return std::make_unique(result.value()); +} // namespace + +class ProgressReporter +{ +public: + explicit ProgressReporter(IndexWriterPtr writer = nullptr) + : processedCount(0), + totalCount(0), + lastReportTime(QDateTime::currentDateTime()), + m_writer(writer), + m_batchCommitInterval(TextIndexConfig::instance().batchCommitInterval()), + m_lastCommitCount(0) + { + qDebug() << "[ProgressReporter] Initialized progress reporter with batch commit interval:" << m_batchCommitInterval; + } + + ~ProgressReporter() + { + // 确保最后一次进度能够显示 + emit ProgressNotifier::instance()->progressChanged(processedCount, totalCount); + qDebug() << "[ProgressReporter] Final progress report - processed:" << processedCount + << "total:" << totalCount << "indexChanged:" << m_indexChanged; + + // 如果有未提交的更改，进行最后一次提交 + if (m_writer && processedCount > m_lastCommitCount) { + try { + m_writer->commit(); + qDebug() << "[ProgressReporter] Final batch commit completed - processed:" << processedCount; + } catch (const std::exception &e) { + qWarning() << "[ProgressReporter] Final batch commit failed:" << e.what(); + } catch (...) { + qWarning() << "[ProgressReporter] Final batch commit failed with unknown exception"; + } + } + } + + void setTotal(qint64 count) + { + totalCount = count; + qInfo() << "[ProgressReporter::setTotal] Total count set to:" << count; + } + + void setProcessedCount(qint64 count) + { + processedCount = count; + m_lastCommitCount = count; + } + + void increment() + { + ++processedCount; + + // Commit using the existing file-count boundary. The destructor provides + // the final commit for small incremental tasks. + const bool countThresholdReached = (processedCount - m_lastCommitCount) >= m_batchCommitInterval; + + if (m_writer && countThresholdReached) { + try { + m_writer->commit(); + m_lastCommitCount = processedCount; + qDebug() << "[ProgressReporter::increment] Batch commit completed at count:" << processedCount; + } catch (const std::exception &e) { + qWarning() << "[ProgressReporter::increment] Batch commit failed at count:" << processedCount + << "error:" << e.what(); + } catch (...) { + qWarning() << "[ProgressReporter::increment] Batch commit failed with unknown exception at count:" << processedCount; + } + } + + // 检查是否经过了足够的时间间隔(1秒) + QDateTime now = QDateTime::currentDateTime(); + if (lastReportTime.msecsTo(now) >= 1000) { // 1000ms = 1s + emit ProgressNotifier::instance()->progressChanged(processedCount, totalCount); + lastReportTime = now; + // 避免高频日志，只在特定间隔打印 + if (processedCount % 1000 == 0 || processedCount == totalCount) { + qDebug() << "[ProgressReporter::increment] Progress update - processed:" << processedCount + << "total:" << totalCount; + } + } + } + + void markIndexChanged() + { + m_indexChanged = true; + } + + bool indexChanged() const + { + return m_indexChanged; + } + +private: + qint64 processedCount; + qint64 totalCount; + QDateTime lastReportTime; + IndexWriterPtr m_writer; + int m_batchCommitInterval; + qint64 m_lastCommitCount; + bool m_indexChanged { false }; +}; + +// 目录遍历相关函数 +using FileHandler = std::function; + +DocumentPtr createFileDocument(const IndexContext &context, const QString &file, + const IndexContentMigrator *migrator = nullptr) +{ + try { + if (!context.documentBuilder()) { + qCritical() << "[createFileDocument] Missing document builder for profile:" << context.profile().id(); + return nullptr; + } + + // filename profile 无内容提取（extractor() == nullptr）：直接用空文本构建文档， + // 跳过 ProcessExtractor::extract（避免全盘遍历逐文件读内容）。FileNameDocumentBuilder + // 忽略 text 参数，仅依据文件元数据构建。 + if (!context.extractor()) { + BuilderOptions options; + return context.documentBuilder()->build(file, QString(), options); + } + + const int truncationSizeMB = context.profile().maxFileTruncationSizeMB(); + const size_t maxBytes = static_cast(truncationSizeMB) * 1024 * 1024; + + BuilderOptions options; + IndexExtractionResult extraction; + + // Checksum-based deduplication (profile decides whether to support it) + options.checksum = context.profile().computeChecksum(file); + if (!options.checksum.isEmpty()) { + const QString cachedText = context.profile().lookupCachedText(options.checksum); + if (!cachedText.isEmpty()) { + qInfo() << "[createFileDocument] Text cache hit for:" << file + << "profile:" << context.profile().id() + << "checksum:" << options.checksum; + extraction = { .success = true, + .text = cachedText, + .error = {}, + .checksum = options.checksum, + .deduplicated = true }; + } + } + + // If cache did not provide text, try content migration from old index + if (!extraction.deduplicated && migrator && migrator->isActive()) { + const auto migratedContent = migrator->lookupContent(file); + if (migratedContent.has_value()) { + extraction = { .success = true, + .text = *migratedContent, + .error = {}, + .checksum = options.checksum, + .deduplicated = true }; + } + } + + // If neither cache nor migration provided text, perform normal extraction + if (!extraction.deduplicated) { + extraction = context.extractor()->extract(file, maxBytes); + if (!extraction.success) { + qInfo() << "[createFileDocument] Failed to extract content from file:" << file + << "profile:" << context.profile().id() + << "error:" << extraction.error; + } + extraction.checksum = options.checksum; + } + + return context.documentBuilder()->build(file, extraction.text, options); + } catch (const LuceneException &e) { + qWarning() << "[createFileDocument] Create document failed with Lucene exception:" << file + << "error:" << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qWarning() << "[createFileDocument] Create document failed with exception:" << file + << "error:" << e.what(); + } catch (...) { + qWarning() << "[createFileDocument] Create document failed with unknown exception:" << file; + } + + // 发生异常时返回一个空的基本文档，防止调用方受到影响 + try { + DocumentPtr basicDoc = context.documentBuilder()->build(file, QString()); + qDebug() << "[createFileDocument] Created basic document without content for:" << file; + return basicDoc; + } catch (...) { + qCritical() << "[createFileDocument] Failed to create even a basic document for:" << file; + return nullptr; // 最坏情况，返回空指针，调用方需要检查 + } +} + +bool checkNeedUpdate(const IndexContext &context, const QString &file, const IndexReaderPtr &reader, bool *needAdd) +{ + try { + SearcherPtr searcher = newLucene(reader); + TermQueryPtr query = newLucene(newLucene(context.profile().pathField(), file.toStdWString())); + + Collection fieldsToLoad = Collection::newInstance(); + fieldsToLoad.add(context.profile().pathField()); + fieldsToLoad.add(context.profile().modifyTimeField()); + FieldSelectorPtr fieldSelector = newLucene(fieldsToLoad); + + TopDocsPtr topDocs = searcher->search(query, 1); + int32_t numTotalHits = topDocs->totalHits; + if (numTotalHits == 0) { + if (needAdd) + *needAdd = true; + return true; + } + + DocumentPtr doc = searcher->doc(topDocs->scoreDocs[0]->doc, fieldSelector); + QFileInfo fileInfo(file); + if (!fileInfo.exists()) { + qDebug() << "[checkNeedUpdate] File no longer exists:" << file; + return false; + } + + if (!context.profile().supportsModifiedTimestampCheck()) { + return true; + } + + const QDateTime modifyTime = fileInfo.lastModified(); + const QString modifyEpoch = QString::number(modifyTime.toSecsSinceEpoch()); + const String &storeTime = doc->get(context.profile().modifyTimeField()); + + bool needsUpdate = modifyEpoch.toStdWString() != storeTime; + if (needsUpdate) { + qDebug() << "[checkNeedUpdate] File needs update:" << file + << "stored time:" << QString::fromStdWString(storeTime) + << "current time:" << modifyEpoch; + } + return needsUpdate; + } catch (const LuceneException &e) { + qWarning() << "[checkNeedUpdate] Check update failed with Lucene exception:" << file + << "error:" << QString::fromStdWString(e.getError()); + return false; + } catch (const std::exception &e) { + qWarning() << "[checkNeedUpdate] Check update failed with exception:" << file + << "error:" << e.what(); + return false; + } catch (...) { + qWarning() << "[checkNeedUpdate] Check update failed with unknown exception:" << file; + return false; + } +} + +bool shouldSkipExcludedFile(const QString &path, const PathExcludeMatcher &excludeMatcher) +{ + const QFileInfo fileInfo(path); + const QString fileDir = fileInfo.absolutePath(); + if (excludeMatcher.shouldExclude(fileDir)) { + qDebug() << "[shouldSkipExcludedFile] Skipping blacklisted file:" << path + << "(directory:" << fileDir << "matches blacklist)"; + return true; + } + + return false; +} + +void processFile(const IndexContext &context, const QString &path, const PathExcludeMatcher &excludeMatcher, + const IndexWriterPtr &writer, ProgressReporter *reporter, + const IndexContentMigrator *migrator = nullptr) +{ + try { + if (!context.profile().isCandidateFile(path)) + return; + if (shouldSkipExcludedFile(path, excludeMatcher)) + return; +#ifdef QT_DEBUG + qDebug() << "Adding [" << path << "]"; +#endif + DocumentPtr doc = createFileDocument(context, path, migrator); + if (!doc) { + qWarning() << "[processFile] Failed to create document for:" << path; + return; + } + writer->addDocument(doc); + if (reporter) { + reporter->markIndexChanged(); + reporter->increment(); + } + } catch (const LuceneException &e) { + qWarning() << "[processFile] Process file failed with Lucene exception:" << path + << "error:" << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qWarning() << "[processFile] Process file failed with exception:" << path + << "error:" << e.what(); + } catch (...) { + qWarning() << "[processFile] Process file failed with unknown exception:" << path; + } +} + +void updateFile(const IndexContext &context, const QString &path, const PathExcludeMatcher &excludeMatcher, + const IndexReaderPtr &reader, + const IndexWriterPtr &writer, ProgressReporter *reporter, + const IndexContentMigrator *migrator = nullptr) +{ + try { + if (!context.profile().isCandidateFile(path)) + return; + if (shouldSkipExcludedFile(path, excludeMatcher)) + return; + + bool needAdd = false; + if (checkNeedUpdate(context, path, reader, &needAdd)) { + DocumentPtr doc = createFileDocument(context, path, migrator); + if (!doc) { + qWarning() << "[updateFile] Failed to create document for:" << path; + return; + } + + if (needAdd) { +#ifdef QT_DEBUG + qDebug() << "Adding [" << path << "]"; +#endif + writer->addDocument(doc); + } else { + qDebug() << "[updateFile] Updating existing file:" << path; + TermPtr term = newLucene(context.profile().pathField(), path.toStdWString()); + writer->updateDocument(term, doc); + } + + if (reporter) { + reporter->markIndexChanged(); + reporter->increment(); + } + } else { + if (reporter) { + reporter->increment(); + } + } + } catch (const LuceneException &e) { + qWarning() << "[updateFile] Update file failed with Lucene exception:" << path + << "error:" << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qWarning() << "[updateFile] Update file failed with exception:" << path + << "error:" << e.what(); + } catch (...) { + qWarning() << "[updateFile] Update file failed with unknown exception:" << path; + } +} + +void removeFile(const IndexContext &context, const QString &path, const IndexWriterPtr &writer, ProgressReporter *reporter) +{ + try { +#ifdef QT_DEBUG + qDebug() << "Remove [" << path << "]"; +#endif + TermPtr term = newLucene(context.profile().pathField(), path.toStdWString()); + writer->deleteDocuments(term); + if (reporter) { + reporter->increment(); + } + } catch (const LuceneException &e) { + qWarning() << "[removeFile] Remove file failed with Lucene exception:" << path + << "error:" << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qWarning() << "[removeFile] Remove file failed with exception:" << path + << "error:" << e.what(); + } catch (...) { + qWarning() << "[removeFile] Remove file failed with unknown exception:" << path; + } +} + +bool cleanupIndexs(const IndexContext &context, IndexReaderPtr reader, IndexWriterPtr writer, TaskState &running, ProgressReporter *reporter) +{ + try { + if (!reader || !writer) { + qCritical() << "[cleanupIndexs] Invalid reader or writer for index cleanup"; + return false; + } + + qInfo() << "[cleanupIndexs] Starting index cleanup - checking for deleted files"; + SearcherPtr searcher = newLucene(reader); + if (!searcher) { + qCritical() << "[cleanupIndexs] Failed to create searcher for index cleanup"; + return false; + } + + // Only load pathField to avoid reading large stored fields (e.g. contents) + Collection fieldsToLoad = Collection::newInstance(); + fieldsToLoad.add(context.profile().pathField()); + FieldSelectorPtr fieldSelector = newLucene(fieldsToLoad); + + // 获取所有文档 + TermPtr allDocsTerm = newLucene(context.profile().pathField(), L"*"); + WildcardQueryPtr allDocsQuery = newLucene(allDocsTerm); + TopDocsPtr allDocs = searcher->search(allDocsQuery, reader->maxDoc()); + if (!allDocs) { + qCritical() << "[cleanupIndexs] Search returned null result for index cleanup"; + return false; + } + + qInfo() << "[cleanupIndexs] Found" << allDocs->totalHits << "documents to check"; + + // Use static factory method to create configured blacklist matcher + PathExcludeMatcher excludeMatcher = PathExcludeMatcher::createForIndex(); + qDebug() << "[cleanupIndexs] Initialized with" << excludeMatcher.patternCount() + << "blacklist patterns"; + + int removedCount = 0; + + // 检查每个文档对应的文件是否存在 + for (int32_t i = 0; i < allDocs->totalHits && running.isRunning() && !running.isPauseRequested(); ++i) { + // Ensure scoreDocs[i] is not null before accessing ->doc + if (!allDocs->scoreDocs || !allDocs->scoreDocs[i]) { + qWarning() << "[cleanupIndexs] Null scoreDoc at index" << i << "during index cleanup"; + return false; + } + + DocumentPtr doc = searcher->doc(allDocs->scoreDocs[i]->doc, fieldSelector); + if (!doc) { // Ensure document is valid + qWarning() << "[cleanupIndexs] Null document at index" << i << "during index cleanup"; + return false; + } + + String pathValue = doc->get(context.profile().pathField()); + if (pathValue.empty()) { + qWarning() << "[cleanupIndexs] Document at index" << i << "has empty path during index cleanup"; + return false; + } + + QString filePath = QString::fromStdWString(pathValue); + + bool shouldDelete = false; + + QFileInfo fileInfo(filePath); + + // Check existence first + if (!fileInfo.exists()) { + shouldDelete = true; + } else { + if (!context.profile().isPathInScope(filePath) || !context.profile().isCandidateFile(filePath)) { + shouldDelete = true; + } + + // Check blacklist (only for existing and supported files) + // Note: Blacklist rules target directories, so extract file's directory for matching + if (!shouldDelete) { + const QString &fileDir = fileInfo.absolutePath(); + if (excludeMatcher.shouldExclude(fileDir)) { + qDebug() << "[cleanupIndexs] Removing blacklisted file from index:" << filePath + << "(directory:" << fileDir << "matches blacklist)"; + shouldDelete = true; + } + } + } + + // Delete if necessary + if (shouldDelete) { + try { + TermPtr term = newLucene(context.profile().pathField(), pathValue); // Create Term only when needed + if (term) { + writer->deleteDocuments(term); + removedCount++; + } + } catch (const std::exception &e) { + qWarning() << "[cleanupIndexs] Failed to delete document:" << filePath + << "error:" << e.what(); + // 继续处理其他文档 + } catch (...) { + qWarning() << "[cleanupIndexs] Failed to delete document with unknown exception:" << filePath; + // 继续处理其他文档 + } + } + } + + if (removedCount > 0) { + qInfo() << "[cleanupIndexs] Index cleanup completed - removed" << removedCount << "deleted/unsupported/blacklisted files from index"; + if (reporter) { + reporter->markIndexChanged(); + } + } else { + qInfo() << "[cleanupIndexs] Index cleanup completed - no files needed removal"; + } + + return true; + } catch (const LuceneException &e) { + qWarning() << "[cleanupIndexs] Index cleanup failed with Lucene exception:" + << QString::fromStdWString(e.getError()); + // 继续执行，不要因为清理失败而中断整个更新过程 + return false; + } catch (const std::exception &e) { + qWarning() << "[cleanupIndexs] Index cleanup failed with exception:" << e.what(); + // 继续执行，不要因为清理失败而中断整个更新过程 + return false; + } catch (...) { + qWarning() << "[cleanupIndexs] Index cleanup failed with unknown exception"; + // 继续执行，不要因为清理失败而中断整个更新过程 + return false; + } +} + +// 移除目录下所有文件的索引 +void removeDirectoryIndex(const IndexContext &context, const QString &dirPath, const IndexWriterPtr &writer, + const IndexReaderPtr &reader, ProgressReporter *reporter) +{ + try { + qInfo() << "[removeDirectoryIndex] Removing directory index for:" << dirPath; + + SearcherPtr searcher = newLucene(reader); + + // 使用 TermQuery 在 ancestor_paths 字段上进行精确匹配 + // ancestor_paths 字段存储了文件的所有祖先路径（不带尾部斜杠） + // 利用此字段可以避免 PrefixQuery 的字典树扫描，显著提升性能 + TermQueryPtr ancestorQuery = newLucene( + newLucene(context.profile().ancestorPathsField(), dirPath.toStdWString())); + + TopDocsPtr allDocs = searcher->search(ancestorQuery, reader->maxDoc()); + + // 检查allDocs是否有效 + if (!allDocs) { + qWarning() << "[removeDirectoryIndex] Search returned null result for directory:" << dirPath; + return; + } + + if (allDocs->totalHits > 0) { + qInfo() << "[removeDirectoryIndex] Found" << allDocs->totalHits + << "documents to remove from directory:" << dirPath; + } else { + qDebug() << "[removeDirectoryIndex] No documents found for directory:" << dirPath; + return; + } + + // 直接批量删除所有匹配的文档 + // writer->deleteDocuments(Query) 会删除所有匹配该查询的文档 + // 相比逐个删除，这种方式性能更高且原子性更好 + int32_t deleteCount = allDocs->totalHits; + writer->deleteDocuments(ancestorQuery); + + if (reporter) { + reporter->markIndexChanged(); + } + + // 更新进度报告 + if (reporter) { + for (int32_t i = 0; i < deleteCount; ++i) { + reporter->increment(); + } + } + + qDebug() << "[removeDirectoryIndex] Successfully removed" << deleteCount + << "documents from index for directory:" << dirPath; + } catch (const LuceneException &e) { + qWarning() << "[removeDirectoryIndex] Remove directory index failed with Lucene exception:" << dirPath + << "error:" << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qWarning() << "[removeDirectoryIndex] Remove directory index failed with exception:" << dirPath + << "error:" << e.what(); + } catch (...) { + qWarning() << "[removeDirectoryIndex] Remove directory index failed with unknown exception:" << dirPath; + } +} + +/// RAII wrapper that opens IndexReader + IndexWriter on construction and closes them on destruction. +/// Eliminates duplicated ScopeGuard boilerplate across handler lambdas. +struct IndexAccessor +{ + IndexReaderPtr reader; + IndexWriterPtr writer; + + IndexAccessor(const QString &indexDir, const IndexContext &context) + { + reader = IndexReader::open(FSDirectory::open(indexDir.toStdWString()), true); + writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + boost::static_pointer_cast(context.profile().createAnalyzer()), + false, + IndexWriter::MaxFieldLengthUNLIMITED); + } + + ~IndexAccessor() + { + try { + if (reader) reader->close(); + } catch (...) { + qWarning() << "[IndexAccessor] Exception closing index reader"; + } + try { + if (writer) writer->close(); + } catch (...) { + qWarning() << "[IndexAccessor] Exception closing index writer"; + } + } +}; + +/// Result of resolving the file list for a Create-resume task. +struct CreateResumeFileList +{ + QStringList fileList; + int checkpoint { 0 }; + bool useAnything { false }; + bool hasFileList { false }; // true = fileList 可直接迭代; false = 需走 BFS traverse +}; + +/** + * @brief 为 Create 续建任务解析文件列表和检查点 + * @param context 索引上下文 + * @param path 索引根路径 + * @param running 任务运行状态（用于 provider traverse 中的暂停检查） + * @param createInProgress 是否处于 Create 续建模式 + * @return 解析结果，包含文件列表、检查点偏移和来源标记 + * + * 解析优先级： + * 1. 若 createInProgress 且 stateStore 中已有缓存列表，直接使用缓存 + checkpoint + * 2. 否则通过 createFileProvider 获取文件列表 + * - DirectFileListProvider (ANYTHING)：提取路径列表并缓存到 stateStore + * - FileSystemProvider (BFS)：返回 hasFileList=false，调用方需自行 traverse + */ +CreateResumeFileList resolveFileListForCreateResume(const IndexContext &context, const QString &path, + bool createInProgress) +{ + CreateResumeFileList resolved; + + if (createInProgress && context.stateStore()) { + resolved.fileList = context.stateStore()->createFileListCache(); + resolved.checkpoint = context.stateStore()->createCheckpoint(); + } + + if (!resolved.fileList.isEmpty()) { + resolved.useAnything = true; + resolved.hasFileList = true; + return resolved; + } + + auto provider = TaskHandlers::createFileProvider(context, path); + if (!provider) { + qCritical() << "[resolveFileListForCreateResume] Failed to create file provider for path:" << path; + return resolved; + } + + if (provider->name() == "DirectFileListProvider") { + resolved.useAnything = true; + resolved.hasFileList = true; + auto *directProvider = static_cast(provider.get()); + resolved.fileList = directProvider->filePaths(); + if (createInProgress && context.stateStore()) { + context.stateStore()->setCreateFileListCache(resolved.fileList); + context.stateStore()->setCreateCheckpoint(0); + qInfo() << "[resolveFileListForCreateResume] Cached" << resolved.fileList.size() + << "files from ANYTHING for Create resume"; + } + } + + return resolved; +} + +/** + * @brief 使用检查点偏移迭代处理文件列表，每个文件调用 updateFile + * @param context 索引上下文 + * @param fileList 待处理的文件路径列表 + * @param checkpoint 起始偏移（跳过前 checkpoint 个文件） + * @param createInProgress 是否处于 Create 续建模式（决定是否更新 checkpoint） + * @param excludeMatcher 黑名单匹配器 + * @param reader 索引读取器 + * @param writer 索引写入器 + * @param reporter 进度报告器 + * @param migrator 旧索引内容迁移器 + * @param running 任务运行状态（用于暂停/中断检查） + * + * 遍历 fileList[checkpoint..end)，逐文件调用 updateFile。 + * 若 createInProgress，每处理一个文件更新 stateStore 中的 checkpoint。 + * 遇到暂停请求或中断时立即退出循环。 + */ +void processFileListWithCheckpoint(const IndexContext &context, const QStringList &fileList, + int checkpoint, bool createInProgress, + const PathExcludeMatcher &excludeMatcher, + const IndexReaderPtr &reader, const IndexWriterPtr &writer, + ProgressReporter &reporter, const IndexContentMigrator &migrator, + TaskState &running) +{ + int fileIndex = checkpoint; + for (int i = checkpoint; i < fileList.size(); ++i) { + if (!running.isRunning() || running.isPauseRequested()) { + qInfo() << "[processFileListWithCheckpoint] Processing interrupted at index" << i; + break; + } + updateFile(context, fileList[i], excludeMatcher, reader, writer, &reporter, + migrator.isActive() ? &migrator : nullptr); + if (createInProgress && context.stateStore()) + context.stateStore()->setCreateCheckpoint(++fileIndex); + } +} + +} // namespace + +// 创建文件提供者 +std::unique_ptr TaskHandlers::createFileProvider(const IndexContext &context, const QString &path) +{ + if (auto provider = createAnythingFileProvider(context, path)) { + return provider; + } + + qInfo() << "[TaskHandlers::createFileProvider] Using FileSystemProvider for path:" << path; + return std::make_unique(context.profile(), path); +} + +// 创建文件列表提供者 +std::unique_ptr TaskHandlers::createFileListProvider(const IndexContext &context, const QStringList &fileList) +{ + qInfo() << "[TaskHandlers::createFileListProvider] Creating file list provider with" << fileList.size() << "files"; + return std::make_unique(context.profile(), fileList); +} + +// 公开的任务处理函数实现 +TaskHandler TaskHandlers::CreateIndexHandler(const IndexContext &context) +{ + return [context](const QString &path, TaskState &running) -> HandlerResult { + qInfo() << "[CreateIndexHandler] Starting index creation for path:" << path; + + HandlerResult result { false, false, false }; + QDir dir; + if (!dir.exists(path)) { + qCritical() << "[CreateIndexHandler] Source directory doesn't exist:" << path; + return result; + } + + QString indexDir = context.profile().indexDirectory(); + + try { + // 尝试从旧索引迁移内容（版本升级时避免重新提取） + IndexContentMigrator migrator; + migrator.prepare(indexDir, context.profile()); + + // ensure index directory exists (prepare() may have renamed it away) + if (!dir.exists(indexDir)) { + if (!dir.mkpath(indexDir)) { + qCritical() << "[CreateIndexHandler] Unable to create index directory:" << indexDir; + return result; + } + qInfo() << "[CreateIndexHandler] Created index directory:" << indexDir; + } + + // prepare() 可能将旧索引目录重命名为 .old，导致 status 文件随旧目录被移走。 + // 在新目录确认存在后重新保存 status（含 createInProgress），防止进程中途退出后 + // 重启误判为 Light 级 Update。 + if (migrator.isActive() && context.stateStore()) { + context.stateStore()->saveIndexStatus(QDateTime::currentDateTime()); + context.stateStore()->setCreateInProgress(true); + qInfo() << "[CreateIndexHandler] Re-saved index status (with createInProgress) after migration rename"; + } + + IndexWriterPtr writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + boost::static_pointer_cast(context.profile().createAnalyzer()), + true, + IndexWriter::MaxFieldLengthUNLIMITED); + + // 添加 writer 的 ScopeGuard + ScopeGuard writerCloser([&writer]() { + try { + if (writer) { + writer->close(); + qDebug() << "[CreateIndexHandler] Index writer closed successfully"; + } + } catch (...) { + qWarning() << "[CreateIndexHandler] Exception occurred while closing index writer"; + } + }); + + qInfo() << "[CreateIndexHandler] Index writer initialized, target directory:" << indexDir; + + writer->deleteAll(); + qInfo() << "[CreateIndexHandler] Cleared existing index data"; + + // 使用文件提供者遍历文件 + auto provider = createFileProvider(context, path); + if (!provider) { + qCritical() << "[CreateIndexHandler] Failed to create file provider for path:" << path; + return result; + } + + if (provider->name() == "DirectFileListProvider") { + result.useAnything = true; + qInfo() << "[CreateIndexHandler] Using ANYTHING for file discovery"; + if (context.stateStore()) { + auto *directProvider = static_cast(provider.get()); + context.stateStore()->setCreateFileListCache(directProvider->filePaths()); + context.stateStore()->setCreateCheckpoint(0); + qInfo() << "[CreateIndexHandler] Cached" << directProvider->totalCount() << "files from ANYTHING"; + } + } + + ProgressReporter reporter(writer); + const PathExcludeMatcher excludeMatcher = PathExcludeMatcher::createForIndex(); + qint64 totalCount = provider->totalCount(); + reporter.setTotal(totalCount); + qInfo() << "[CreateIndexHandler] Starting file processing, estimated total files:" << totalCount; + + int fileIndex = 0; + provider->traverse(running, [&](const QString &file) { + processFile(context, file, excludeMatcher, writer, &reporter, + migrator.isActive() ? &migrator : nullptr); + if (context.stateStore()) + context.stateStore()->setCreateCheckpoint(++fileIndex); + }); + + if (running.isPauseRequested()) { + qInfo() << "[CreateIndexHandler] Index creation paused by scheduler request"; + writer->commit(); + result.paused = true; + result.success = false; + return result; + } + + // Only the creation of an index that is interrupted is also considered a failure + // Created indexes must be guaranteed to be complete + if (!running.isRunning()) { + qWarning() << "[CreateIndexHandler] Index creation was interrupted by user request"; + result.interrupted = true; + result.success = false; // 创建被打断若不失败索引是不完整的 + return result; + } + + // ProgressReporter的析构函数会处理最后的commit，但为了确保在optimize前所有更改都已提交 + // 我们显式调用一次commit + qDebug() << "[CreateIndexHandler] Ensuring all changes are committed before optimization"; + writer->commit(); + + qDebug() << "[CreateIndexHandler] Starting index optimization"; + writer->optimize(); + qDebug() << "[CreateIndexHandler] Index optimization completed"; + + // 索引完整创建成功，清理旧索引数据 + migrator.cleanup(); + + result.success = true; + result.indexChanged = reporter.indexChanged(); + qDebug() << "[CreateIndexHandler] Index creation completed successfully for path:" << path; + + return result; + } catch (const LuceneException &e) { + qCritical() << "[CreateIndexHandler] Index creation failed with Lucene exception:" + << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qCritical() << "[CreateIndexHandler] Index creation failed with exception:" << e.what(); + } + + return result; + }; +} + +TaskHandler TaskHandlers::UpdateIndexHandler(const IndexContext &context, bool skipStaleCleanup) +{ + return [context, skipStaleCleanup](const QString &path, TaskState &running) -> HandlerResult { + qInfo() << "[UpdateIndexHandler] Starting index update for path:" << path + << "skipStaleCleanup:" << skipStaleCleanup; + HandlerResult result { false, false, false }; + + QString indexDir = context.profile().indexDirectory(); + + // 若存在 .old 残留（上次 Create 崩溃），从中复用内容，避免重新提取 + IndexContentMigrator migrator; + if (IndexContentMigrator::hasResidue(indexDir)) { + migrator.prepare(indexDir, context.profile()); + } + + try { + IndexAccessor accessor(indexDir, context); + ProgressReporter reporter(accessor.writer); + + if (skipStaleCleanup) { + // 内部恢复类更新：删除条目由增量事件维护，跳过全库清理以避免 + // 大索引下的分钟级清理开销。丢失窗口内被删文件的 ghost 条目 + // 留待下一次用户手动更新（默认执行清理）。 + qInfo() << "[UpdateIndexHandler] Skipping stale-entry cleanup (internal recovery update)"; + } else if (!cleanupIndexs(context, accessor.reader, accessor.writer, running, &reporter)) { + qCritical() << "[UpdateIndexHandler] Index cleanup failed, aborting update"; + result.success = false; + result.fatal = true; + return result; + } else if (running.isPauseRequested()) { + qInfo() << "[UpdateIndexHandler] Index update paused during index cleanup"; + accessor.writer->commit(); + result.paused = true; + result.success = false; + return result; + } + + const PathExcludeMatcher excludeMatcher = PathExcludeMatcher::createForIndex(); + auto provider = createFileProvider(context, path); + if (!provider) { + qCritical() << "[UpdateIndexHandler] Failed to create file provider for path:" << path; + return result; + } + + if (provider->name() == "DirectFileListProvider") { + result.useAnything = true; + qInfo() << "[UpdateIndexHandler] Using ANYTHING for file discovery"; + } + + reporter.setTotal(provider->totalCount()); + qDebug() << "[UpdateIndexHandler] Starting file update processing, estimated total files:" << provider->totalCount(); + + provider->traverse(running, [&](const QString &file) { + updateFile(context, file, excludeMatcher, accessor.reader, accessor.writer, &reporter, + migrator.isActive() ? &migrator : nullptr); + }); + + if (running.isPauseRequested()) { + qInfo() << "[UpdateIndexHandler] Index update paused by scheduler request"; + accessor.writer->commit(); + result.paused = true; + result.success = false; + return result; + } + + if (!running.isRunning()) { + qWarning() << "[UpdateIndexHandler] Index update was interrupted by user request"; + result.interrupted = true; + } + + accessor.writer->commit(); + if (!result.interrupted) + migrator.cleanup(); + + result.success = true; + result.indexChanged = reporter.indexChanged(); + qDebug() << "[UpdateIndexHandler] Index update completed successfully for path:" << path; + return result; + } catch (const LuceneException &e) { + qCritical() << "[UpdateIndexHandler] Index update failed with Lucene exception, index may be corrupted:" + << QString::fromStdWString(e.getError()); + throw; + } catch (const std::exception &e) { + qCritical() << "[UpdateIndexHandler] Index update failed with exception:" << e.what(); + } + + return result; + }; +} + +TaskHandler TaskHandlers::CreateResumeHandler(const IndexContext &context) +{ + return [context](const QString &path, TaskState &running) -> HandlerResult { + qInfo() << "[CreateResumeHandler] Resuming index creation for path:" << path; + HandlerResult result { false, false, false }; + + QString indexDir = context.profile().indexDirectory(); + + IndexContentMigrator migrator; + if (IndexContentMigrator::hasResidue(indexDir)) { + migrator.prepare(indexDir, context.profile()); + } + + try { + IndexAccessor accessor(indexDir, context); + ProgressReporter reporter(accessor.writer); + const PathExcludeMatcher excludeMatcher = PathExcludeMatcher::createForIndex(); + + qInfo() << "[CreateResumeHandler] Create in progress, skipping cleanup"; + + auto resolved = resolveFileListForCreateResume(context, path, true); + + if (!resolved.hasFileList) { + auto provider = createFileProvider(context, path); + if (!provider) { + qCritical() << "[CreateResumeHandler] Failed to create file provider for path:" << path; + return result; + } + + reporter.setTotal(provider->totalCount()); + qDebug() << "[CreateResumeHandler] Starting BFS file update processing"; + + int bfsIndex = 0; + provider->traverse(running, [&](const QString &file) { + updateFile(context, file, excludeMatcher, accessor.reader, accessor.writer, &reporter, + migrator.isActive() ? &migrator : nullptr); + if (context.stateStore()) + context.stateStore()->setCreateCheckpoint(++bfsIndex); + }); + + if (running.isPauseRequested()) { + qInfo() << "[CreateResumeHandler] Paused by scheduler request"; + accessor.writer->commit(); + result.paused = true; + result.success = false; + return result; + } + if (!running.isRunning()) { + qWarning() << "[CreateResumeHandler] Interrupted by user request"; + result.interrupted = true; + } + accessor.writer->commit(); + if (!result.interrupted) + migrator.cleanup(); + result.success = true; + result.indexChanged = reporter.indexChanged(); + return result; + } + + result.useAnything = resolved.useAnything; + reporter.setTotal(resolved.fileList.size()); + reporter.setProcessedCount(resolved.checkpoint); + qInfo() << "[CreateResumeHandler] Processing" << resolved.fileList.size() + << "files from checkpoint" << resolved.checkpoint; + + processFileListWithCheckpoint(context, resolved.fileList, resolved.checkpoint, + true, excludeMatcher, + accessor.reader, accessor.writer, reporter, migrator, running); + + if (running.isPauseRequested()) { + qInfo() << "[CreateResumeHandler] Paused by scheduler request"; + accessor.writer->commit(); + result.paused = true; + result.success = false; + return result; + } + + if (!running.isRunning()) { + qWarning() << "[CreateResumeHandler] Interrupted by user request"; + result.interrupted = true; + } + + accessor.writer->commit(); + if (!result.interrupted) + migrator.cleanup(); + + result.success = true; + result.indexChanged = reporter.indexChanged(); + qDebug() << "[CreateResumeHandler] Completed successfully for path:" << path; + return result; + } catch (const LuceneException &e) { + qCritical() << "[CreateResumeHandler] Failed with Lucene exception, index may be corrupted:" + << QString::fromStdWString(e.getError()); + throw; + } catch (const std::exception &e) { + qCritical() << "[CreateResumeHandler] Failed with exception:" << e.what(); + } + + return result; + }; +} + +// 基于文件列表更新索引 +TaskHandler TaskHandlers::CreateOrUpdateFileListHandler(const IndexContext &context, const QStringList &fileList) +{ + return [context, fileList](const QString &path, TaskState &running) -> HandlerResult { + Q_UNUSED(path) + qInfo() << "[CreateOrUpdateFileListHandler] Creating/Updating index for file list with" << fileList.size() << "entries"; + HandlerResult result { false, false, false }; + + QString indexDir = context.profile().indexDirectory(); + + try { + IndexReaderPtr reader = IndexReader::open( + FSDirectory::open(indexDir.toStdWString()), true); + + // 添加 reader 的 ScopeGuard + ScopeGuard readerCloser([&reader]() { + try { + if (reader) { + reader->close(); + qDebug() << "[CreateOrUpdateFileListHandler] Index reader closed successfully"; + } + } catch (...) { + qWarning() << "[CreateOrUpdateFileListHandler] Exception occurred while closing index reader"; + } + }); + + IndexWriterPtr writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + boost::static_pointer_cast(context.profile().createAnalyzer()), + false, + IndexWriter::MaxFieldLengthUNLIMITED); + + // 添加 writer 的 ScopeGuard + ScopeGuard writerCloser([&writer]() { + try { + if (writer) { + writer->close(); + qDebug() << "[CreateOrUpdateFileListHandler] Index writer closed successfully"; + } + } catch (...) { + qWarning() << "[CreateOrUpdateFileListHandler] Exception occurred while closing index writer"; + } + }); + + qDebug() << "[CreateOrUpdateFileListHandler] Index reader and writer initialized for directory:" << indexDir; + + // 使用文件列表提供者遍历文件 + auto provider = createFileListProvider(context, fileList); + if (!provider) { + qCritical() << "[CreateOrUpdateFileListHandler] Failed to create file list provider"; + return result; + } + + ProgressReporter reporter(writer); + const PathExcludeMatcher excludeMatcher = PathExcludeMatcher::createForIndex(); + qint64 totalCount = provider->totalCount(); + reporter.setTotal(totalCount); + qInfo() << "[CreateOrUpdateFileListHandler] Starting file list processing, total files:" << totalCount; + + provider->traverse(running, [&](const QString &file) { + updateFile(context, file, excludeMatcher, reader, writer, &reporter); + }); + + if (running.isPauseRequested()) { + qInfo() << "[CreateOrUpdateFileListHandler] File list update paused by scheduler request"; + writer->commit(); + result.paused = true; + result.success = false; + result.remainingFiles = fileList; + return result; + } + + if (!running.isRunning()) { + qWarning() << "[CreateOrUpdateFileListHandler] File list update was interrupted by user request"; + result.interrupted = true; + } + + // ProgressReporter的析构函数会处理最后的commit + result.success = true; + result.indexChanged = reporter.indexChanged(); + qDebug() << "[CreateOrUpdateFileListHandler] File list index update completed successfully"; + + return result; + } catch (const LuceneException &e) { + // Lucene异常表示索引损坏 + qCritical() << "[CreateOrUpdateFileListHandler] File list update failed with Lucene exception, index may be corrupted:" + << QString::fromStdWString(e.getError()); + throw; // 重新抛出异常，让 IndexTask 捕获并处理 + } catch (const std::exception &e) { + // 其他异常不需要重建 + qCritical() << "[CreateOrUpdateFileListHandler] File list update failed with exception:" << e.what(); + } + + return result; + }; +} + +// 基于文件列表删除索引 +TaskHandler TaskHandlers::RemoveFileListHandler(const IndexContext &context, const QStringList &fileList) +{ + return [context, fileList](const QString &path, TaskState &running) -> HandlerResult { + Q_UNUSED(path) + qInfo() << "[RemoveFileListHandler] Removing index for" << fileList.size() << "files/directories"; + HandlerResult result { false, false, false }; + + QString indexDir = context.profile().indexDirectory(); + + try { + // 打开索引读取器，用于目录前缀查询 + IndexReaderPtr reader = IndexReader::open( + FSDirectory::open(indexDir.toStdWString()), true); + + // 添加 reader 的 ScopeGuard + ScopeGuard readerCloser([&reader]() { + try { + if (reader) { + reader->close(); + qDebug() << "[RemoveFileListHandler] Index reader closed successfully"; + } + } catch (...) { + qWarning() << "[RemoveFileListHandler] Exception occurred while closing index reader"; + } + }); + + // 打开索引写入器 + IndexWriterPtr writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + boost::static_pointer_cast(context.profile().createAnalyzer()), + false, + IndexWriter::MaxFieldLengthUNLIMITED); + + // 添加 writer 的 ScopeGuard + ScopeGuard writerCloser([&writer]() { + try { + if (writer) { + writer->close(); + qDebug() << "[RemoveFileListHandler] Index writer closed successfully"; + } + } catch (...) { + qWarning() << "[RemoveFileListHandler] Exception occurred while closing index writer"; + } + }); + + qDebug() << "[RemoveFileListHandler] Index reader and writer initialized for directory:" << indexDir; + + ProgressReporter reporter(writer); + reporter.setTotal(fileList.size()); + qInfo() << "[RemoveFileListHandler] Starting file removal processing, total items:" << fileList.size(); + + SearcherPtr searcher = newLucene(reader); + + int filesRemoved = 0; + int directoriesRemoved = 0; + + // 遍历文件列表，通过索引查询判断是文件还是目录 + for (const QString &itemPath : fileList) { + if (!running.isRunning()) { + qInfo() << "[RemoveFileListHandler] File removal was interrupted by user request"; + break; + } + + // 通过 ancestor_paths 查询判断是否为目录 + TermQueryPtr ancestorQuery = newLucene( + newLucene(context.profile().ancestorPathsField(), itemPath.toStdWString())); + TopDocsPtr result = searcher->search(ancestorQuery, 1); + + if (result->totalHits > 0) { + // 有子文件，是目录 + removeDirectoryIndex(context, itemPath, writer, reader, &reporter); + // 目录自身的文档（ancestor_paths 不含自身，上面的查询覆盖不到）； + // 对不存在的路径 deleteDocuments 是幂等 no-op + removeFile(context, itemPath, writer, &reporter); + directoriesRemoved++; + qDebug() << "[RemoveFileListHandler] Processed directory removal:" << itemPath; + } else { + // 无子文件，直接删除；deleteDocuments 是幂等的，不存在的路径是安全 no-op + removeFile(context, itemPath, writer, &reporter); + filesRemoved++; + qDebug() << "[RemoveFileListHandler] Removed file from index:" << itemPath; + } + } + + if (!running.isRunning()) { + qWarning() << "[RemoveFileListHandler] File removal task was interrupted by user request"; + result.interrupted = true; + } + + // ProgressReporter的析构函数会处理最后的commit + result.success = true; + result.indexChanged = reporter.indexChanged(); + qDebug() << "[RemoveFileListHandler] File removal completed successfully - files:" << filesRemoved + << "directories:" << directoriesRemoved; + return result; + } catch (const LuceneException &e) { + qCritical() << "[RemoveFileListHandler] File removal failed with Lucene exception:" + << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qCritical() << "[RemoveFileListHandler] File removal failed with exception:" << e.what(); + } + + return result; + }; +} + +// 基于文件移动列表高效更新索引路径 +TaskHandler TaskHandlers::MoveFileListHandler(const IndexContext &context, const QHash &movedFiles) +{ + return [context, movedFiles](const QString &path, TaskState &running) -> HandlerResult { + Q_UNUSED(path) + qInfo() << "[MoveFileListHandler] Processing file moves for" << movedFiles.size() << "entries"; + HandlerResult result { false, false, false }; + + QString indexDir = context.profile().indexDirectory(); + + try { + IndexReaderPtr reader = IndexReader::open( + FSDirectory::open(indexDir.toStdWString()), true); + + // 添加 reader 的 ScopeGuard + ScopeGuard readerCloser([&reader]() { + try { + if (reader) { + reader->close(); + qDebug() << "[MoveFileListHandler] Index reader closed successfully"; + } + } catch (...) { + qWarning() << "[MoveFileListHandler] Exception occurred while closing index reader"; + } + }); + + IndexWriterPtr writer = newLucene( + FSDirectory::open(indexDir.toStdWString()), + boost::static_pointer_cast(context.profile().createAnalyzer()), + false, + IndexWriter::MaxFieldLengthUNLIMITED); + + // 添加 writer 的 ScopeGuard + ScopeGuard writerCloser([&writer]() { + try { + if (writer) { + writer->close(); + qDebug() << "[MoveFileListHandler] Index writer closed successfully"; + } + } catch (...) { + qWarning() << "[MoveFileListHandler] Exception occurred while closing index writer"; + } + }); + + qDebug() << "[MoveFileListHandler] Index reader and writer initialized for directory:" << indexDir; + + ProgressReporter reporter(writer); + reporter.setTotal(movedFiles.size()); + qInfo() << "[MoveFileListHandler] Starting file move processing, total moves:" << movedFiles.size(); + + SearcherPtr searcher = newLucene(reader); + + // Create processors for different move types using the new separate classes + FileMoveProcessor fileMoveProcessor(context, searcher, writer); + DirectoryMoveProcessor directoryMoveProcessor(context, searcher, writer, reader); + + int fileMoves = 0; + int directoryMoves = 0; + int failedMoves = 0; + + // Process each move operation + for (auto it = movedFiles.constBegin(); it != movedFiles.constEnd(); ++it) { + if (!running.isRunning()) { + qInfo() << "[MoveFileListHandler] File move processing was interrupted by user request"; + result.interrupted = true; + break; + } + + const QString &fromPath = it.key(); + const QString &toPath = it.value(); + + bool success = false; + if (PathCalculator::isDirectoryMove(toPath)) { + success = directoryMoveProcessor.processDirectoryMove(fromPath, toPath, running); + // 目录自身的文档随路径同步（ancestor 查询覆盖不到目录自身）； + // 仅对索引目录的 profile（filename）处理，避免 Content/Ocr + // 走 fallback 路径把目录误建为内容文档 + if (context.profile().filterPolicy().indexDirectories) + fileMoveProcessor.processFileMove(fromPath, toPath); + if (success) { + directoryMoves++; + if (directoryMoveProcessor.hasChanges() || fileMoveProcessor.hasChanges()) + reporter.markIndexChanged(); + } else { + failedMoves++; + } + } else { + success = fileMoveProcessor.processFileMove(fromPath, toPath); + if (success) { + fileMoves++; + if (fileMoveProcessor.hasChanges()) + reporter.markIndexChanged(); + } else { + failedMoves++; + } + } + + if (!success && !running.isRunning()) { + result.interrupted = true; + break; + } + + reporter.increment(); + } + + if (!running.isRunning()) { + qWarning() << "[MoveFileListHandler] File move task was interrupted by user request"; + result.interrupted = true; + } + + // ProgressReporter的析构函数会处理最后的commit + result.success = true; + result.indexChanged = reporter.indexChanged(); + qDebug() << "[MoveFileListHandler] File move processing completed successfully - file moves:" << fileMoves + << "directory moves:" << directoryMoves << "failed moves:" << failedMoves; + return result; + } catch (const LuceneException &e) { + qCritical() << "[MoveFileListHandler] File move processing failed with Lucene exception:" + << QString::fromStdWString(e.getError()); + } catch (const std::exception &e) { + qCritical() << "[MoveFileListHandler] File move processing failed with exception:" << e.what(); + } + + return result; + }; +} diff --git a/src/index/task/taskhandler.h b/src/index/task/taskhandler.h new file mode 100644 index 00000000..f52f98cf --- /dev/null +++ b/src/index/task/taskhandler.h @@ -0,0 +1,64 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TASKHANDLER_H +#define TASKHANDLER_H + +#include "index_global.h" +#include "core/indexcontext.h" +#include "fileprovider.h" + +#include "utils/taskstate.h" + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +struct HandlerResult +{ + bool success { false }; + bool interrupted { false }; + bool paused { false }; + bool useAnything { false }; + bool fatal { false }; + bool indexChanged { false }; + QStringList remainingFiles {}; +}; + +using TaskHandler = std::function; + +// 工厂函数，返回具体的任务处理器 +namespace TaskHandlers { +TaskHandler CreateIndexHandler(const IndexContext &context); + +/// @param skipStaleCleanup 内部恢复类 Update（Dirty/断连恢复、needsRebuild 静默更新） +/// 传 true：跳过开头的 cleanupIndexs 全库清理（数百万条目时为分钟级 I/O）。 +/// 删除本应由增量事件维护，cleanup 只是事件丢失/黑名单变更的兜底；跳过后 +/// 丢失窗口内被删文件会在索引中残留 ghost 条目，由下一次用户手动 +/// "更新索引"（skipStaleCleanup=false）清理。用户经 DBus 触发的更新保持默认 false。 +TaskHandler UpdateIndexHandler(const IndexContext &context, bool skipStaleCleanup = false); + +/// Handler for resuming an interrupted Create task. Skips cleanupIndexs, uses cached +/// file list + checkpoint from IndexStateStore when available, or falls back to BFS. +/// Only selected by TaskManager when createInProgress is true. +TaskHandler CreateResumeHandler(const IndexContext &context); + +// 文件列表任务处理器 +TaskHandler CreateOrUpdateFileListHandler(const IndexContext &context, const QStringList &fileList); +TaskHandler RemoveFileListHandler(const IndexContext &context, const QStringList &fileList); // 待实现的删除索引接口 + +// 创建文件提供者 +std::unique_ptr createFileProvider(const IndexContext &context, const QString &path); +std::unique_ptr createFileListProvider(const IndexContext &context, const QStringList &fileList); +TaskHandler MoveFileListHandler(const IndexContext &context, const QHash &movedFiles); +} + +ANYTHING_INDEX_END_NAMESPACE + +Q_DECLARE_METATYPE(ANYTHING_INDEX_NAMESPACE::HandlerResult) + +#endif // TASKHANDLER_H diff --git a/src/index/task/taskmanager.cpp b/src/index/task/taskmanager.cpp new file mode 100644 index 00000000..dea1d4a2 --- /dev/null +++ b/src/index/task/taskmanager.cpp @@ -0,0 +1,1290 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "taskmanager.h" +#include "taskqueueutils.h" +#include "utils/indexutility.h" +#include "utils/textindexconfig.h" +#include "utils/threadscheduling.h" +#include "env/envdetector.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +ANYTHING_INDEX_USE_NAMESPACE + +namespace { +void registerMetaTypes() +{ + static bool registered = false; + if (!registered) { + qRegisterMetaType(); + qRegisterMetaType("IndexTask::Type"); + qRegisterMetaType(); + qRegisterMetaType("ANYTHING_INDEX_NAMESPACE::IndexTask::Type"); + qRegisterMetaType(); + registered = true; + qDebug() << "[TaskManager] Meta types registered successfully"; + } +} + +// 突发静默期：距最近一次事件摄入超过该时长即认为上一轮突发已结束， +// burst 累计清零。须大于 collector 的 1s 收集窗口，容忍波间抖动。 +constexpr qint64 kBurstQuietMs = 5000; + +TaskQueueItem createCompensationTaskItem(const QStringList &paths) +{ + TaskQueueItem item; + item.type = IndexTask::Type::UpdateFileList; + item.grade = IndexTask::Grade::Light; + item.path = paths.isEmpty() ? QString() : paths.first(); + item.fileList = paths; + return item; +} + +} // namespace + +TaskManager::TaskManager(const IndexContext *context, QObject *parent) + : TaskManager(context, nullptr, parent) +{ +} + +TaskManager::TaskManager(const IndexContext *context, BacklogTracker *backlogTracker, QObject *parent) + : QObject(parent), + m_context(context), + m_backlogTracker(backlogTracker) +{ + qInfo() << "[TaskManager] Initializing TaskManager instance"; + registerMetaTypes(); + + // 索引任务属于可让位的后台负载：worker 线程标记为 SCHED_IDLE， + // 任务运行期间把 CPU 让给普通线程（含 VfsMonitor 读线程），仅当系统 + // 空闲时推进。workerThread 可能随任务启停重建，started() 每次都会触发， + // 重复设置无副作用；无特权要求，失败仅记录（不影响任务执行）。 + connect(&workerThread, &QThread::started, &workerThread, []() { + QString err; + if (!ThreadScheduling::setSelfSchedulerIdle(&err)) + qDebug() << "[TaskManager] Failed to mark worker thread SCHED_IDLE:" << err; + }, Qt::DirectConnection); + + connect(&EnvDetector::instance(), &EnvDetector::envStateChanged, + this, &TaskManager::onEnvStateChanged); + + // 突发静默期满后的复评定时器（singleShot，restart 天然去重）。 + m_burstRecheckTimer = new QTimer(this); + m_burstRecheckTimer->setSingleShot(true); + connect(m_burstRecheckTimer, &QTimer::timeout, this, &TaskManager::updateBacklogState); + + if (m_backlogTracker) + m_backlogTracker->onStartup(); + + // 启动防御：updateInProgress 正常只能由 finalizeIndexState 在 Update 成功后清除， + // 且清除时 state 仍为 dirty（之后才置 Clean）。若启动时读到 state==Clean 且标志仍 + // 为 true，说明上一会话的 Update 失败/中断后，后续普通增量任务成功时把 state 置 + // Clean 却不清该标志（finalizeIndexState 的增量分支不处理它）——此后启动检测因 + // Clean 跳过恢复流程，标志将永久残留，搜索无限期降级 Realtime。防御性重置，与 + // backlogExceeded 的启动处理（FilenameBacklogTracker::onStartup）对称。 + if (m_context && m_context->stateStore() + && m_context->stateStore()->getIndexState() == IndexUtility::IndexState::Clean + && m_context->stateStore()->isUpdateInProgress()) { + qWarning() << "[TaskManager] Stale updateInProgress flag detected on clean state at startup, resetting"; + m_context->stateStore()->setUpdateInProgress(false); + } + + qInfo() << "[TaskManager] TaskManager initialization completed"; +} + +TaskManager::~TaskManager() +{ + qInfo() << "[TaskManager] Destroying TaskManager instance"; + if (currentTask) { + qInfo() << "[TaskManager] Stopping current task before destruction"; + stopCurrentTask(); + currentTask->disconnect(); + } + + if (workerThread.isRunning()) { + qInfo() << "[TaskManager] Stopping worker thread"; + workerThread.quit(); + // worker 为事件循环模型(QThread::exec)，quit() 属协作式退出：当前正在处理的槽 + // (IndexWriter::commit/optimize 或文件内容提取)执行完后事件循环才会返回。Lucene++ 的长 + // 操作没有中途取消接口，进入后只能等待其执行完成。 + // 严禁使用 terminate() —— 其底层是 pthread_cancel，会向 worker 线程注入 forced-unwind + // 异常；若 worker 此刻正处在带 catch(...) 的调用链中(如 taskhandler 的索引处理、docparser + // 的内容提取)，异常会被 catch(...) 截留且未 rethrow，从而触发 "FATAL: exception not + // rethrown"，导致整个进程被 SIGABRT 中止(参见历史 dde-file-manager coredump)。 + // 此处给足等待时间，超时则交由进程退出兜底(进程 _exit 时线程由内核直接终止，不走 unwind)。 + if (!workerThread.wait(5000)) { + qWarning() << "[TaskManager] Worker thread still running after 5s, " + "will be cleaned up on process exit (terminate() removed to avoid SIGABRT)"; + _exit(1); + } + } + qInfo() << "[TaskManager] TaskManager destroyed successfully"; +} + +// 单路径版本，调用多路径版本保持兼容性 +bool TaskManager::startTask(IndexTask::Type type, const QString &path) +{ + qDebug() << "[TaskManager::startTask] Single path task request - type:" << static_cast(type) + << "path:" << path; + return startTask(type, QStringList { path }); +} + +// 多路径版本的startTask实现 +bool TaskManager::startTask(IndexTask::Type type, const QStringList &pathList, + IndexTask::Grade grade, bool forceBypass, bool skipStaleCleanup) +{ + Q_ASSERT_X(type == IndexTask::Type::Create || type == IndexTask::Type::Update, + "Type error", "Only create and update supported"); + + qInfo() << "[TaskManager::startTask] Multi-path task request - type:" << static_cast(type) + << "paths:" << pathList.size() + << "grade:" << static_cast(grade) << "forceBypass:" << forceBypass + << "skipStaleCleanup:" << skipStaleCleanup; + + // 如果 grade 未指定，自动判定 + if (grade == IndexTask::Grade::None) { + grade = (type == IndexTask::Type::Create) ? IndexTask::Grade::Heavy : gradeUpdateTask(); + } + + // 检查路径列表是否为空 + if (pathList.isEmpty()) { + qWarning() << "[TaskManager::startTask] Cannot start task - path list is empty"; + return false; + } + + // 所有路径都必须是默认索引目录 + bool allPathsValid = true; + QStringList invalidPaths; + for (const auto &path : pathList) { + if (!IndexUtility::isDefaultIndexedDirectory(path)) { + qWarning() << "[TaskManager::startTask] Invalid path detected:" << path; + invalidPaths.append(path); + allPathsValid = false; + } + } + + if (!allPathsValid) { + qWarning() << "[TaskManager::startTask] Cannot start task - invalid paths found:" << invalidPaths; + return false; + } + + // 获取第一个路径作为任务的主路径（用于日志和进度通知） + QString primaryPath = pathList.first(); + + // Create 任务的 createInProgress 标记必须在入队检查之前完成，否则当任务被环境 + // 阻塞入队时，服务重启后队列丢失，恢复逻辑会误判为 Light 级 Update。 + // + // 注意：此处不调用 saveIndexStatus() 写入版本号。版本号仅在 CreateIndexHandler + // 实际执行并创建 .old 目录后才写入（taskhandler.cpp），或任务成功完成后由 + // updateIndexStatusOnSuccess 写入。若在入队前就写入新版本号，一旦服务在 + // handler 执行前重启，IndexDatabaseExists() 会因版本匹配返回 true，导致 + // 进入 CreateResumeHandler 但无 .old 目录可迁移，索引不会真正重建。 + if (type == IndexTask::Type::Create) { + qInfo() << "[TaskManager::startTask] Create task detected, clearing existing index status"; + if (m_context && m_context->stateStore()) { + m_context->stateStore()->removeIndexStatusFile(); + m_context->stateStore()->setCreateFileListCache({}); + m_context->stateStore()->setCreateCheckpoint(0); + m_context->stateStore()->setCreateInProgress(true); + } + } + + // Update 任务是"cleanup + 按 mtime 全量对比"的扫盘过程（恢复 Update / needsRebuild + // Update / 手动 ForceUpdateIndex），期间索引滞后不可信。写 updateInProgress 落盘标志， + // 让外部（dfm-search isReady/状态映射）在任务启动即可见"scanning"并降级搜索。 + // 与 createInProgress 一样必须在入队检查之前完成：任务被环境阻塞入队后服务重启， + // 队列丢失，标志仍需落盘以覆盖该窗口。 + // 普通事件增量任务（UpdateFileList/MoveFileList 等）不走此分支，不置位。 + if (type == IndexTask::Type::Update) { + if (m_context && m_context->stateStore() + && !m_context->stateStore()->isUpdateInProgress()) { + qInfo() << "[TaskManager::startTask] Update task detected, marking updateInProgress"; + m_context->stateStore()->setUpdateInProgress(true); + } + } + + // 环境检查：如果当前环境不允许该分级任务运行，入队等待而非直接执行 + { + TaskQueueItem item; + item.type = type; + item.grade = grade; + item.forceBypass = forceBypass; + item.skipStaleCleanup = skipStaleCleanup; + item.path = primaryPath; + item.pathList = pathList; + if (tryEnqueueIfBlocked(grade, forceBypass, item)) + return true; + } + + // 如果当前有任务在运行，停止它并将新任务保存为待执行任务 + if (hasRunningTask()) { + qInfo() << "[TaskManager::startTask] Current task running, queuing new task - paths:" << pathList.size() + << "primary:" << primaryPath; + + // 停止当前任务 + stopCurrentTask(); + + // startTask 的优先级高于 startFileListTask，因此直接重置任务队列 + if (!taskQueue.isEmpty()) { + qInfo() << "[TaskManager::startTask] Clearing existing task queue with" << taskQueue.size() << "pending tasks"; + taskQueue.clear(); + } + + // 将任务加入队列 + TaskQueueItem item; + item.type = type; + item.grade = grade; + item.forceBypass = forceBypass; + item.skipStaleCleanup = skipStaleCleanup; + item.path = primaryPath; // 保留主路径用于兼容现有代码 + item.pathList = pathList; // 保存所有路径 + taskQueue.enqueue(item); + updateBacklogState(); + + qInfo() << "[TaskManager::startTask] Task queued successfully, will execute after current task stops"; + // 返回true表示任务已经被接受，将在当前任务停止后执行 + return true; + } + + // 正常启动任务流程 + qInfo() << "[TaskManager::startTask] Starting new task immediately - paths:" << pathList.size() + << "primary:" << primaryPath << "type:" << static_cast(type); + + // 清除队列中与新任务同类型同路径的冗余任务，避免暂停→手动更新→完成后重复执行 + removeDuplicateFullScanTasks(type, pathList); + + // force-bypass 全量任务覆盖了所有增量变更，清除队列中所有被阻塞的任务。 + // 否则任务完成后队列非空 → finalizeIndexState 不设 Clean → 状态卡在 Waiting*。 + // 全量扫描覆盖了所有路径，包括 FileList 任务的 path 格式（FileList-yyyymmdd-hhmmss） + // 和 MoveFileList 任务的 path 格式（MoveList-yyyymmdd-hhmmss），这些路径无法通过 + // 路径匹配来识别，因此直接清空整个队列。 + if (forceBypass && isFullScanTask(type) && !taskQueue.isEmpty()) { + qInfo() << "[TaskManager::startTask] Clearing" << taskQueue.size() + << "blocked task(s) from queue - force-bypass full-scan supersedes all pending work"; + taskQueue.clear(); + } + + // 获取对应的任务处理器 + TaskHandler handler = getTaskHandler(type, skipStaleCleanup); + if (!handler) { + qCritical() << "[TaskManager::startTask] Unknown task type:" << static_cast(type); + return false; + } + + Q_ASSERT(!currentTask); + // 创建新的任务对象，使用路径列表作为输入 + // 注意：为了最小修改现有代码，我们仍然将主路径作为任务路径，但在handler中会使用整个路径列表 + IndexTask *task = new IndexTask(type, primaryPath, [handler, pathList](const QString &, TaskState &state) -> HandlerResult { + qDebug() << "[TaskManager::startTask] Executing task handler for" << pathList.size() << "paths"; + HandlerResult finalResult { true, false, false, false }; + + for (const auto &path : pathList) { + if (!state.isRunning()) { + qInfo() << "[TaskManager::startTask] Task execution interrupted during path processing"; + finalResult.interrupted = true; + break; + } + + qDebug() << "[TaskManager::startTask] Processing path:" << path; + HandlerResult pathResult = handler(path, state); + + if (!pathResult.success) { + qWarning() << "[TaskManager::startTask] Path processing failed:" << path; + finalResult.success = false; + } + + if (pathResult.fatal) { + qCritical() << "[TaskManager::startTask] Fatal error occurred during path processing:" << path; + finalResult.fatal = true; + break; + } + + if (pathResult.interrupted) { + qInfo() << "[TaskManager::startTask] Path processing interrupted:" << path; + finalResult.interrupted = true; + break; + } + + if (pathResult.useAnything) { + qInfo() << "[TaskManager::startTask] Using ANYTHING for file discovery, skipping remaining paths"; + break; + } + + if (pathResult.indexChanged) { + finalResult.indexChanged = true; + } + } + + qInfo() << "[TaskManager::startTask] Task handler execution completed - success:" << finalResult.success + << "interrupted:" << finalResult.interrupted << "fatal:" << finalResult.fatal; + return finalResult; + }); + + launchTask(task, grade, forceBypass); + qInfo() << "[TaskManager::startTask] Task started successfully in worker thread"; + return true; +} + +bool TaskManager::startFileListTask(IndexTask::Type type, const QStringList &fileList) +{ + qInfo() << "[TaskManager::startFileListTask] File list task request - type:" << static_cast(type) + << "files:" << fileList.size(); + + if (fileList.isEmpty()) { + qWarning() << "[TaskManager::startFileListTask] Cannot start task - file list is empty"; + return false; + } + + // 索引库尚未建立（首次创建前 / 版本升级等待重建）且没有任务在运行时，增量 + // 事件无法落盘也不需要落盘：待执行的 Create 是 deleteAll + 按磁盘现状全量 + // 重扫，必然覆盖这些变化（与 force-bypass 全量任务清空增量队列同一语义， + // 见 startTask）。此时若放行，handler 在不存在的索引上打开 IndexReader 会 + // 抛 LuceneException 导致任务失败，m_lastTaskFailed 置位后状态会从 + // WaitingUpgrade 误变为 Failed，故直接跳过（返回 true 表示已受理）。 + // 注意有任务运行时不能跳过：全量扫描窗口内新建/修改的文件不在扫描结果里， + // 事件必须正常入队，在全量任务完成后按序补偿执行。 + if (!currentTask && !isIndexDatabaseReady()) { + qInfo() << "[TaskManager::startFileListTask] Index database not ready, skipping incremental task" + << "- type:" << static_cast(type) << "files:" << fileList.size() + << "(changes will be covered by the pending full create)"; + return true; + } + + recordIngestedFiles(fileList.size()); + + // RemoveFileList 始终视为轻量任务，与大小和总数无关 + const IndexTask::Grade grade = (type == IndexTask::Type::RemoveFileList) + ? IndexTask::Grade::Light + : gradeFileListTask(fileList); + + // RemoveFileList 是纯索引元数据删除操作，开销极低且需要保持索引与现实同步， + // 不受环境门槛限制（电池/节能/空闲），始终立即执行 + const bool bypassEnv = (type == IndexTask::Type::RemoveFileList); + + // 环境检查：如果当前环境不允许该分级任务运行，入队等待而非直接执行 + { + TaskQueueItem item; + item.type = type; + item.grade = grade; + item.forceBypass = bypassEnv; + item.path = QString("FileList-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmmss")); + item.fileList = fileList; + if (tryEnqueueIfBlocked(grade, bypassEnv, item)) + return true; + } + + // 如果当前有任务在运行，将新任务加入队列 + if (hasRunningTask() || currentTask) { + qInfo() << "[TaskManager::startFileListTask] Current task running, queuing file list task with" + << fileList.size() << "files"; + + TaskQueueItem item; + item.type = type; + item.grade = grade; + item.forceBypass = bypassEnv; + item.path = QString("FileList-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmmss")); + item.fileList = fileList; + taskQueue.enqueue(item); + updateBacklogState(); + + qDebug() << "[TaskManager::startFileListTask] File list task queued successfully with grade:" << static_cast(item.grade); + return true; + } + + // 正常启动任务流程 + qInfo() << "[TaskManager::startFileListTask] Starting file list task immediately - files:" << fileList.size() + << "type:" << static_cast(type); + + // 获取对应的任务处理器 + TaskHandler handler; + switch (type) { + case IndexTask::Type::CreateFileList: + handler = TaskHandlers::CreateOrUpdateFileListHandler(*m_context, fileList); + break; + case IndexTask::Type::UpdateFileList: + handler = TaskHandlers::CreateOrUpdateFileListHandler(*m_context, fileList); + break; + case IndexTask::Type::RemoveFileList: + handler = TaskHandlers::RemoveFileListHandler(*m_context, fileList); + break; + default: + qCritical() << "[TaskManager::startFileListTask] Unknown file list task type:" << static_cast(type); + return false; + } + + QString pathId = QString("FileList-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmmss")); + launchTask(new IndexTask(type, pathId, handler), grade, bypassEnv, fileList.size()); + qDebug() << "[TaskManager::startFileListTask] File list task started successfully in worker thread"; + return true; +} + +bool TaskManager::startFileMoveTask(const QHash &movedFiles) +{ + qInfo() << "[TaskManager::startFileMoveTask] File move task request - moves:" << movedFiles.size(); + + if (movedFiles.isEmpty()) { + qWarning() << "[TaskManager::startFileMoveTask] Cannot start task - moved files list is empty"; + return false; + } + + // 与 startFileListTask 同理：仅当没有任务在运行且索引库未建立时跳过增量 + // move 事件（由待执行的全量 Create 覆盖）；有任务运行时事件照常入队补偿。 + if (!currentTask && !isIndexDatabaseReady()) { + qInfo() << "[TaskManager::startFileMoveTask] Index database not ready, skipping incremental task" + << "- moves:" << movedFiles.size() + << "(changes will be covered by the pending full create)"; + return true; + } + + recordIngestedFiles(movedFiles.size()); + + const QStringList compensationPaths = applyDirectoryMovePlans(movedFiles); + + // MoveFileList 是纯索引路径更新操作，开销极低且需要保持索引与现实同步， + // 不受环境门槛限制（电池/节能/空闲），始终立即执行 + { + TaskQueueItem item; + item.type = IndexTask::Type::MoveFileList; + item.grade = IndexTask::Grade::Light; + item.forceBypass = true; + item.path = QString("MoveList-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmmss")); + item.movedFiles = movedFiles; + if (tryEnqueueIfBlocked(IndexTask::Grade::Light, true, item)) { + enqueueCompensationTask(compensationPaths); + return true; + } + } + + // 如果当前有任务在运行，将新任务加入队列 + if (hasRunningTask() || currentTask) { + qInfo() << "[TaskManager::startFileMoveTask] Current task running, queuing file move task with" + << movedFiles.size() << "moves"; + + TaskQueueItem item; + item.type = IndexTask::Type::MoveFileList; + item.grade = IndexTask::Grade::Light; + item.forceBypass = true; + item.path = QString("MoveList-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmmss")); + item.movedFiles = movedFiles; + taskQueue.enqueue(item); + updateBacklogState(); + enqueueCompensationTask(compensationPaths); + + qDebug() << "[TaskManager::startFileMoveTask] File move task queued successfully"; + return true; + } + + // 正常启动任务流程 + qInfo() << "[TaskManager::startFileMoveTask] Starting file move task immediately - moves:" << movedFiles.size(); + + TaskHandler handler = TaskHandlers::MoveFileListHandler(*m_context, movedFiles); + if (!handler) { + qCritical() << "[TaskManager::startFileMoveTask] Failed to create move file list handler"; + return false; + } + + QString pathId = QString("MoveList-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmmss")); + launchTask(new IndexTask(IndexTask::Type::MoveFileList, pathId, handler), IndexTask::Grade::Light, true, + movedFiles.size()); + qDebug() << "[TaskManager::startFileMoveTask] File move task started successfully in worker thread"; + + enqueueCompensationTask(compensationPaths); + return true; +} + +TaskHandler TaskManager::getTaskHandler(IndexTask::Type type, bool skipStaleCleanup) +{ + if (!m_context) + return nullptr; + + switch (type) { + case IndexTask::Type::Create: + return TaskHandlers::CreateIndexHandler(*m_context); + case IndexTask::Type::Update: + if (m_context->stateStore() && m_context->stateStore()->isCreateInProgress()) + return TaskHandlers::CreateResumeHandler(*m_context); + return TaskHandlers::UpdateIndexHandler(*m_context, skipStaleCleanup); + default: + qWarning() << "[TaskManager::getTaskHandler] Unknown task type:" << static_cast(type); + return nullptr; + } +} + +QString TaskManager::typeToString(IndexTask::Type type) +{ + switch (type) { + case IndexTask::Type::Create: + return "create"; + case IndexTask::Type::Update: + return "update"; + case IndexTask::Type::CreateFileList: + return "create-file-list"; + case IndexTask::Type::UpdateFileList: + return "update-file-list"; + case IndexTask::Type::RemoveFileList: + return "remove-file-list"; + case IndexTask::Type::MoveFileList: + return "move-file-list"; + default: + qWarning() << "[TaskManager::typeToString] Unknown task type:" << static_cast(type); + return "unknown"; + } +} + +void TaskManager::onTaskProgress(IndexTask::Type type, qint64 count, qint64 total) +{ + if (!currentTask) { + qWarning() << "[TaskManager::onTaskProgress] Received progress update but no current task exists"; + return; + } + + emit taskProgressChanged(typeToString(type), currentTask->taskPath(), count, total); + if (m_backlogTracker && (type == IndexTask::Type::CreateFileList + || type == IndexTask::Type::UpdateFileList + || type == IndexTask::Type::RemoveFileList + || type == IndexTask::Type::MoveFileList)) { + m_currentIncrementalPending = qMax(0, total - count); + updateBacklogState(); + } +} + +void TaskManager::onTaskPaused(IndexTask::Type type, HandlerResult result) +{ + if (!currentTask) { + qWarning() << "[TaskManager::onTaskPaused] Received paused signal but no current task exists"; + return; + } + + const QString taskPath = currentTask->taskPath(); + const IndexTask::Grade grade = currentTask->grade(); + qInfo() << "[TaskManager::onTaskPaused] Task paused - type:" << static_cast(type) + << "path:" << taskPath << "grade:" << static_cast(grade); + + // Save remaining work to queue + TaskQueueItem item; + item.grade = grade; + + if (!result.remainingFiles.isEmpty()) { + // File list task: save remaining files + item.type = IndexTask::Type::UpdateFileList; + item.fileList = result.remainingFiles; + item.path = QString("Resumed-%1").arg(QDateTime::currentDateTime().toString("yyyyMMdd-hhmmss")); + } else { + // Full-scan task (Heavy or Light/Medium): resume as Update (skip already indexed files) + item.type = IndexTask::Type::Update; + item.path = taskPath; + item.pathList = QStringList { taskPath }; + } + + taskQueue.enqueue(item); + updateBacklogState(); + + cleanupTask(); + + updateBacklogState(); + emit indexStatusChanged(currentIndexStatus(), gradeToString(grade)); + + // Try to schedule the next runnable task + schedule(); +} + +void TaskManager::onEnvStateChanged(const EnvState &env) +{ + qInfo() << "[TaskManager::onEnvStateChanged] Environment changed -" + << "battery:" << env.onBattery << "powerSave:" << env.powerSaveMode << "idle:" << env.idle; + + // 1. Check if current running task needs to be paused + // forceBypass only bypasses the start gate. At runtime, only + // RemoveFileList/MoveFileList are exempt from env-based pausing. + if (currentTask) { + const auto type = currentTask->taskType(); + const bool exempt = (type == IndexTask::Type::RemoveFileList + || type == IndexTask::Type::MoveFileList); + if (!exempt && !canRun(currentTask->grade(), false, env)) { + qInfo() << "[TaskManager::onEnvStateChanged] Current task can no longer run, pausing"; + pauseCurrentTask(); + return; // schedule() will be called from onTaskPaused, which emits + } + } + + // 2. Try to schedule next task if worker is idle + if (!hasRunningTask()) { + schedule(); + } + + // 3. Always emit status change so clients can update their display. + // Even with no running/queued task, the status may have changed + // (e.g., "Idle" → "WaitingPowerSave" when entering power-save mode + // with a dirty index that needs updating). + emit indexStatusChanged(currentIndexStatus(), + gradeToString(currentOrQueuedGrade().value_or(IndexTask::Grade::None))); +} + +bool TaskManager::canRun(IndexTask::Grade grade, bool forceBypass, const EnvState &env) const +{ + if (forceBypass) + return true; + + // Profiles with checkEnvPolicy disabled (e.g. filename index) bypass env checks + if (m_context && !m_context->profile().shouldCheckEnvPolicy()) + return true; + + switch (grade) { + case IndexTask::Grade::Manual: + case IndexTask::Grade::Light: + return !env.powerSaveMode; + case IndexTask::Grade::Medium: + case IndexTask::Grade::Heavy: + return !env.onBattery && !env.powerSaveMode && env.idle; + default: + return false; + } + } + +// 与 TextIndexDBus::IndexDatabaseExists() 保持同一判定口径：索引文件可用且 +// status.json 中版本兼容、lastUpdateTime 非空。任一条件不满足即视为"索引库 +// 未就绪"，增量事件交给待执行的全量 Create 覆盖。 +bool TaskManager::isIndexDatabaseReady() const +{ + if (!m_context || !m_context->stateStore()) + return false; + if (!m_context->profile().isIndexAvailable()) + return false; + if (!m_context->stateStore()->isCompatibleVersion()) + return false; + return !m_context->stateStore()->getLastUpdateTime().isEmpty(); +} + +void TaskManager::pauseCurrentTask() +{ + if (currentTask) { + qInfo() << "[TaskManager::pauseCurrentTask] Requesting pause for current task - type:" + << static_cast(currentTask->taskType()) << "path:" << currentTask->taskPath(); + currentTask->requestPause(); + } +} + +void TaskManager::launchTask(IndexTask *task, IndexTask::Grade grade, bool forceBypass, + qint64 initialIncrementalPending) +{ + Q_ASSERT(!currentTask); + currentTask = task; + m_currentIncrementalPending = initialIncrementalPending; + currentTask->setGrade(grade); + currentTask->setForceBypass(forceBypass); + currentTask->moveToThread(&workerThread); + + connect(currentTask, &IndexTask::progressChanged, this, &TaskManager::onTaskProgress, Qt::QueuedConnection); + connect(currentTask, &IndexTask::finished, this, &TaskManager::onTaskFinished, Qt::QueuedConnection); + connect(currentTask, &IndexTask::paused, this, &TaskManager::onTaskPaused, Qt::QueuedConnection); + connect(this, &TaskManager::startTaskInThread, currentTask, &IndexTask::start, Qt::QueuedConnection); + workerThread.start(); + + if (m_context && m_context->stateStore()) + m_context->stateStore()->setIndexState(IndexUtility::IndexState::Dirty); + + emit startTaskInThread(); + emit indexStatusChanged("Running", gradeToString(grade)); + updateBacklogState(); +} + +bool TaskManager::tryEnqueueIfBlocked(IndexTask::Grade grade, bool forceBypass, const TaskQueueItem &item) +{ + const EnvState env = EnvDetector::instance().currentState(); + if (canRun(grade, forceBypass, env)) + return false; + + qInfo() << "[TaskManager] Environment not suitable for grade" << static_cast(grade) + << ", queuing task - battery:" << env.onBattery + << "powerSave:" << env.powerSaveMode << "idle:" << env.idle; + taskQueue.enqueue(item); + updateBacklogState(); + + // A task being blocked means there's pending index work that hasn't been + // reflected in the index yet. Mark the state Dirty so that: + // 1. A kill -9 (no cleanup) still leaves Dirty on disk → next startup + // detects it and runs a recovery Update. + // 2. The indexStatusChanged signal (below) carries the correct status. + if (m_context && m_context->stateStore()) + m_context->stateStore()->setIndexState(IndexUtility::IndexState::Dirty); + + // Notify clients immediately — the status changed from whatever it was + // (e.g., "Idle") to a waiting state because a task is now blocked. + emit indexStatusChanged(currentIndexStatus(), + gradeToString(currentOrQueuedGrade().value_or(IndexTask::Grade::None))); + return true; +} + +void TaskManager::schedule() +{ + if (hasRunningTask() || currentTask) { + qDebug() << "[TaskManager::schedule] Worker busy, skipping schedule"; + return; + } + + if (taskQueue.isEmpty()) { + qDebug() << "[TaskManager::schedule] No tasks in queue"; + return; + } + + const EnvState env = EnvDetector::instance().currentState(); + + int bestIdx = -1; + int bestPri = -1; + for (int i = 0; i < taskQueue.size(); ++i) { + const auto &item = taskQueue[i]; + if (canRun(item.grade, item.forceBypass, env)) { + int pri = gradePriority(item.grade); + if (pri > bestPri) { + bestPri = pri; + bestIdx = i; + } + } + } + + if (bestIdx < 0) { + qInfo() << "[TaskManager::schedule] No runnable tasks in queue (blocked by environment)"; + return; + } + + TaskQueueItem item = taskQueue.takeAt(bestIdx); + qInfo() << "[TaskManager::schedule] Scheduling task - type:" << static_cast(item.type) + << "grade:" << static_cast(item.grade) << "remaining:" << taskQueue.count(); + startQueuedTask(item); +} + +void TaskManager::startQueuedTask(const TaskQueueItem &item) +{ + if (item.type == IndexTask::Type::CreateFileList + || item.type == IndexTask::Type::UpdateFileList + || item.type == IndexTask::Type::RemoveFileList) { + startFileListTask(item.type, item.fileList); + } else if (item.type == IndexTask::Type::MoveFileList) { + startFileMoveTask(item.movedFiles); + } else if (!item.pathList.isEmpty()) { + startTask(item.type, item.pathList, item.grade, item.forceBypass, item.skipStaleCleanup); + } else { + startTask(item.type, QStringList { item.path }, item.grade, item.forceBypass, item.skipStaleCleanup); + } +} + +QString TaskManager::gradeToString(IndexTask::Grade grade) +{ + switch (grade) { + case IndexTask::Grade::None: return "none"; + case IndexTask::Grade::Light: return "light"; + case IndexTask::Grade::Medium: return "medium"; + case IndexTask::Grade::Heavy: return "heavy"; + case IndexTask::Grade::Manual: return "manual"; + default: return "unknown"; + } +} + +int TaskManager::gradePriority(IndexTask::Grade grade) +{ + switch (grade) { + case IndexTask::Grade::Manual: return 4; + case IndexTask::Grade::Heavy: return 3; + case IndexTask::Grade::Medium: return 2; + case IndexTask::Grade::Light: return 1; + default: return 0; + } +} + +std::optional TaskManager::currentTaskGrade() const +{ + if (!hasRunningTask()) + return std::nullopt; + return currentTask->grade(); +} + +std::optional TaskManager::currentOrQueuedGrade() const +{ + if (hasRunningTask() && currentTask) + return currentTask->grade(); + if (!taskQueue.isEmpty()) + return taskQueue.head().grade; + return std::nullopt; +} + +QString TaskManager::currentIndexStatus() const +{ + if (currentTask) + return "Running"; + + if (!hasRunningTask() && !currentTask && !taskQueue.isEmpty()) { + // Tasks queued but not running → blocked by environment. + const EnvState env = EnvDetector::instance().currentState(); + const IndexTask::Grade headGrade = taskQueue.head().grade; + + if (canRun(headGrade, taskQueue.head().forceBypass, env)) + return "Running"; + + // Distinguish by the first unsatisfied condition. + // The order matters: battery is the most restrictive, then power-save, then idle. + // Light tasks only require !powerSaveMode, so they won't trigger WaitingPower/WaitingIdle. + if (env.onBattery && headGrade != IndexTask::Grade::Light) + return "WaitingPower"; + if (env.powerSaveMode) + return "WaitingPowerSave"; + if (!env.idle && headGrade != IndexTask::Grade::Light) + return "WaitingIdle"; + + // Should not reach here: canRun returned false but no known condition matched. + // This can only happen with an unknown grade (None) — treat as Idle. + qWarning() << "[TaskManager::currentIndexStatus] Unreachable: canRun=false but no condition matched" + << "grade:" << static_cast(headGrade) + << "battery:" << env.onBattery + << "powerSave:" << env.powerSaveMode + << "idle:" << env.idle; + return "Idle"; + } + + // No running task, no queued tasks + if (m_lastTaskFailed) + return "Failed"; + + // There's pending work when: the state is dirty (unsynced changes), a + // create was interrupted (needs resuming), or the database doesn't exist + // or its version is incompatible (needs creation or upgrade). + // + // Even a "clean" state needs an upgrade when the stored version doesn't + // match the runtime version — the old status.json still says "clean" but + // a rebuild is required. Without this check the user would see "Idle" + // until the silent-start timer fires, instead of "WaitingUpgrade". + // + // The status shown to the user depends on the *effective grade* of the + // pending work, mirroring gradeUpdateTask() / handleSilentStart() logic: + // + // isCreateInProgress() → Heavy (resume interrupted full build) + // DB doesn't exist → Heavy (fresh Create / version mismatch) + // Otherwise → Light (开机全盘扫描对比 — incremental update) + // + // Display rules (per spec): + // + // Heavy: always show "WaitingUpgrade" during the update interval — + // the user needs to know a major rebuild is pending. When the timer + // fires and the task is blocked, it lands in the queue and the + // "queue not empty" branch above reports the specific waiting state + // (WaitingPower / WaitingPowerSave / WaitingIdle). + // + // Light: show "Idle" (as if completed) — minor pending changes will be + // silently picked up when the update timer fires. The only exception is + // power-save mode, which blocks even Light tasks and is worth telling + // the user about. + if (m_context && m_context->stateStore()) { + const bool createInProgress = m_context->stateStore()->isCreateInProgress(); + const bool dbExists = m_context->profile().isIndexAvailable() + && m_context->stateStore()->isCompatibleVersion() + && !m_context->stateStore()->getLastUpdateTime().isEmpty(); + const bool hasPendingWork = !m_context->stateStore()->isCleanState() + || createInProgress || !dbExists; + + if (hasPendingWork) { + const bool heavy = createInProgress || !dbExists; + if (heavy) { + return "WaitingUpgrade"; + } else { + const EnvState env = EnvDetector::instance().currentState(); + if (env.powerSaveMode) + return "WaitingPowerSave"; + return "Idle"; + } + } + } + + return "Idle"; +} + +void TaskManager::onTaskFinished(IndexTask::Type type, HandlerResult result) +{ + if (!currentTask) { + qWarning() << "[TaskManager::onTaskFinished] Received task finished signal but no current task exists"; + return; + } + + const QString taskPath = currentTask->taskPath(); + qInfo() << "[TaskManager::onTaskFinished] Task finished - type:" << static_cast(type) + << "path:" << taskPath << "success:" << result.success << "interrupted:" << result.interrupted; + + // 处理索引损坏：若已启动重建任务则提前返回 + if (handleCorruptedIndex(type, result, taskPath)) + return; + + qDebug() << "[TaskManager::onTaskFinished] Task" << typeToString(type) << "for path" << taskPath + << (result.success ? "completed successfully" : "failed"); + + handleRootPathFailure(result.success, result.interrupted, taskPath); + updateIndexStatusOnSuccess(type, result); + + // Track failure state for status reporting (ignore interrupted/paused) + if (!result.interrupted && !result.paused) + m_lastTaskFailed = !result.success; + + emit taskFinished(typeToString(type), taskPath, result.success); + cleanupTask(); + + // finalizeIndexState 必须先于 schedule()：若 schedule() 从队列拉起了后续 + // 任务，hasRunningTask() 变为 true，尾部的 finalize 会被整体跳过，状态 + // 文件将停留在本任务完成前的旧值。cleanupTask 已同步置空 currentTask， + // 此处守卫恒为真，仅保留防御意义。 + if (!hasRunningTask()) { + qDebug() << "[TaskManager::onTaskFinished] No more runnable tasks"; + finalizeIndexState(type, result); + } + + // emit 随 finalize 后移，indexStatusChanged 反映 finalize 后的准确状态。 + emit indexStatusChanged(currentIndexStatus(), gradeToString(IndexTask::Grade::None)); + + schedule(); +} + +bool TaskManager::handleCorruptedIndex(IndexTask::Type type, const HandlerResult &result, const QString &taskPath) +{ + if (result.success || type != IndexTask::Type::Update) + return false; + if (!currentTask->isIndexCorrupted()) { + qInfo() << "[TaskManager::onTaskFinished] Update task failed but index is not corrupted, skipping rebuild - path:" << taskPath; + return false; + } + + qWarning() << "[TaskManager::onTaskFinished] Update task failed due to index corruption, attempting rebuild - path:" << taskPath; + + if (m_context && m_context->stateStore()) + m_context->stateStore()->clearIndexDirectory(); + + cleanupTask(); + + if (!taskQueue.isEmpty() && taskQueue.head().pathList.contains(taskPath)) { + qInfo() << "[TaskManager::onTaskFinished] Found queued task containing corrupted path, letting queue handle rebuild"; + } else { + qInfo() << "[TaskManager::onTaskFinished] Starting rebuild task for corrupted index - path:" << taskPath; + if (startTask(IndexTask::Type::Create, taskPath)) + return true; // 重建任务已启动 + qCritical() << "[TaskManager::onTaskFinished] Failed to start rebuild task for path:" << taskPath; + } + + return false; +} + +void TaskManager::handleRootPathFailure(bool success, bool interrupted, const QString &taskPath) +{ + if (success || interrupted) + return; + if (!m_context || !m_context->profile().isPathInScope(taskPath)) + return; + + qWarning() << "[TaskManager::onTaskFinished] Root indexing failed, clearing status - path:" << taskPath; + if (m_context->stateStore()) + m_context->stateStore()->removeIndexStatusFile(); +} + +void TaskManager::updateIndexStatusOnSuccess(IndexTask::Type type, const HandlerResult &result) +{ + if (!result.success) + return; + if (result.interrupted && type != IndexTask::Type::Create) + return; + if (!result.indexChanged && !isFullScanTask(type)) { + qDebug() << "[TaskManager::onTaskFinished] Task completed with no index changes, skipping status update"; + return; + } + + qDebug() << "[TaskManager::onTaskFinished] Task completed with actual index changes, updating index status"; + if (!m_context || !m_context->stateStore()) + return; + + // Full-scan tasks (Create/Update) update version number; + // Incremental tasks only update last update time to avoid version mismatch + // when recovery from a previous interrupted full-scan task is pending. + if (isFullScanTask(type)) { + m_context->stateStore()->saveIndexStatus(QDateTime::currentDateTime()); + } else { + m_context->stateStore()->saveLastUpdateTime(QDateTime::currentDateTime()); + } +} + +void TaskManager::finalizeIndexState(IndexTask::Type type, const HandlerResult &result) +{ + // Only set Clean state when: + // 1. Task completed successfully without interruption + // 2. No recovery is pending (or this is the recovery task completing) + // 3. No tasks are still queued (otherwise there's pending work) + if (!result.success || result.interrupted) + return; + + // 全量对比型 Update 已成功完成：本次对比扫盘的"索引滞后"窗口结束。 + // 无论队列中是否还有后续任务（后续 Update 会在 startTask 时重新置位）， + // 都立即清除 updateInProgress，避免搜索长期降级为 Realtime。 + if (type == IndexTask::Type::Update && m_context && m_context->stateStore() + && m_context->stateStore()->isUpdateInProgress()) { + m_context->stateStore()->setUpdateInProgress(false); + qInfo() << "[TaskManager::onTaskFinished] Update task completed, updateInProgress cleared"; + } + + // 全量任务（Create/Update）成功即事实终结：createInProgress 的语义是 + // "创建/恢复进行中"（startTask 在入队检查前就写入，以保证服务重启后的 + // 恢复判定），与队列是否还有后续任务无关，必须先于队列检查清除。否则 + // 期间入队的任务会让标记残留在 status.json 中，重启后被恢复逻辑误判为 + // 创建中断，触发不必要的 Heavy 全量重建。 + if (isFullScanTask(type)) { + m_recoveryPending = false; + if (m_context && m_context->stateStore()) { + m_context->stateStore()->setCreateInProgress(false); + m_context->stateStore()->setCreateFileListCache({}); + m_context->stateStore()->setCreateCheckpoint(0); + } + } + + // setIndexState(Clean) 仍要求队列已空：还有排队任务就意味着有未完成的 + // 索引工作，保持 Dirty，由最后一个完成的任务置 Clean。 + if (!taskQueue.isEmpty()) { + qInfo() << "[TaskManager::onTaskFinished] Tasks still queued, keeping Dirty state"; + return; + } + + if (isFullScanTask(type)) { + if (m_context && m_context->stateStore()) + m_context->stateStore()->setIndexState(IndexUtility::IndexState::Clean); + if (m_backlogTracker) + m_backlogTracker->onFullScanFinished(); + qInfo() << "[TaskManager::onTaskFinished] Full-scan task completed, index state set to clean"; + } else if (!m_recoveryPending) { + if (m_context && m_context->stateStore()) + m_context->stateStore()->setIndexState(IndexUtility::IndexState::Clean); + qInfo() << "[TaskManager::onTaskFinished] Incremental task completed, index state set to clean"; + } else { + qInfo() << "[TaskManager::onTaskFinished] Incremental task completed but recovery is pending, keeping Dirty state"; + } +} + +bool TaskManager::hasRunningTask() const +{ + return currentTask && currentTask->isRunning(); +} + +bool TaskManager::hasQueuedTasks() const +{ + return !taskQueue.isEmpty(); +} + +void TaskManager::setRecoveryPending(bool pending) +{ + m_recoveryPending = pending; + qInfo() << "[TaskManager] Recovery pending state set to:" << pending; +} + +bool TaskManager::isRecoveryPending() const +{ + return m_recoveryPending; +} + +void TaskManager::stopCurrentTask() +{ + if (currentTask) { + qInfo() << "[TaskManager::stopCurrentTask] Stopping current task - type:" << static_cast(currentTask->taskType()) + << "path:" << currentTask->taskPath(); + currentTask->stop(); + } else { + qDebug() << "[TaskManager::stopCurrentTask] No current task to stop"; + } +} + +std::optional TaskManager::currentTaskType() const +{ + if (!hasRunningTask()) { + return std::nullopt; + } + + return currentTask->taskType(); +} + +std::optional TaskManager::currentTaskPath() const +{ + if (!hasRunningTask()) { + return std::nullopt; + } + + return currentTask->taskPath(); +} + +void TaskManager::cleanupTask() +{ + if (currentTask) { + qDebug() << "[TaskManager::cleanupTask] Cleaning up task resources - type:" << static_cast(currentTask->taskType()) + << "path:" << currentTask->taskPath(); + disconnect(this, &TaskManager::startTaskInThread, currentTask, &IndexTask::start); + currentTask->deleteLater(); + currentTask = nullptr; + m_currentIncrementalPending = 0; + updateBacklogState(); + qDebug() << "[TaskManager::cleanupTask] Task cleanup completed"; + } +} + +bool TaskManager::isFullScanTask(IndexTask::Type type) const +{ + return type == IndexTask::Type::Create || type == IndexTask::Type::Update; +} + +qint64 TaskManager::queuedIncrementalCount() const +{ + qint64 count = 0; + for (const auto &item : taskQueue) { + switch (item.type) { + case IndexTask::Type::CreateFileList: + case IndexTask::Type::UpdateFileList: + case IndexTask::Type::RemoveFileList: + count += item.fileList.size(); + break; + case IndexTask::Type::MoveFileList: + count += item.movedFiles.size(); + break; + default: + break; + } + } + return count; +} + +void TaskManager::recordIngestedFiles(qint64 count) +{ + if (count <= 0) + return; + + const qint64 now = QDateTime::currentMSecsSinceEpoch(); + if (m_lastIngestMsecs > 0 && now - m_lastIngestMsecs > kBurstQuietMs) + m_burstFiles = 0; + + m_burstFiles += count; + m_lastIngestMsecs = now; +} + +void TaskManager::updateBacklogState() +{ + if (!m_backlogTracker) + return; + + const qint64 now = QDateTime::currentMSecsSinceEpoch(); + if (m_burstFiles > 0 && m_lastIngestMsecs > 0 + && now - m_lastIngestMsecs > kBurstQuietMs) { + m_burstFiles = 0; + } + + // 口径取两者较大值：排队+运行是 task 层瞬时积压，burst 是静默期内的 + // 突发体量（含已入队部分），取 max 避免同一批文件被重复计入。 + const qint64 instantPending = queuedIncrementalCount() + m_currentIncrementalPending; + const qint64 pending = qMax(instantPending, m_burstFiles); + m_backlogTracker->update(pending, 0, hasRunningTask()); + + // task 层已排空但突发静默期未满：之后没有任何任务事件会再触发评估， + // 若不补一次复评，最后一轮任务完成后 backlogExceeded 将残留为 true。 + if (m_burstFiles > 0 && !hasRunningTask() && taskQueue.isEmpty()) { + const qint64 remaining = kBurstQuietMs - (now - m_lastIngestMsecs) + 100; + m_burstRecheckTimer->start(int(qMax(100, remaining))); + } +} + +void TaskManager::removeDuplicateFullScanTasks(IndexTask::Type type, const QStringList &pathList) +{ + if (!isFullScanTask(type)) + return; + + const QSet newPathSet(pathList.begin(), pathList.end()); + for (int i = taskQueue.size() - 1; i >= 0; --i) { + const auto &item = taskQueue[i]; + if (!isFullScanTask(item.type)) + continue; + + const QStringList itemPaths = item.pathList.isEmpty() + ? QStringList { item.path } + : item.pathList; + const QSet itemPathSet(itemPaths.begin(), itemPaths.end()); + if (newPathSet == itemPathSet) { + qInfo() << "[TaskManager] Removing duplicate full-scan task from queue - type:" + << static_cast(item.type) << "path:" << item.path; + taskQueue.removeAt(i); + } + } +} + +IndexTask::Grade TaskManager::gradeFileListTask(const QStringList &fileList) const +{ + auto &config = TextIndexConfig::instance(); + // 阈值优先取 profile 声明（如 OCR 单文件提取成本高，阈值更小）， + // 未声明时回退全局配置；声明为函数式 provider，保持 dconfig 动态性 + int countThreshold = m_context ? m_context->profile().lightGradeFileCountThreshold() : 0; + if (countThreshold <= 0) + countThreshold = config.lightIncrementFileCountThreshold(); + + if (fileList.size() > countThreshold) + return IndexTask::Grade::Medium; + + qint64 sizeThreshold = config.lightIncrementSizeThresholdMB() * 1024 * 1024; + qint64 totalSize = 0; + for (const auto &filePath : fileList) { + QFileInfo info(filePath); + totalSize += info.size(); + if (totalSize > sizeThreshold) + return IndexTask::Grade::Medium; + } + return IndexTask::Grade::Light; +} + +IndexTask::Grade TaskManager::gradeUpdateTask() const +{ + if (m_context && m_context->stateStore() && m_context->stateStore()->isCreateInProgress()) + return IndexTask::Grade::Heavy; + return IndexTask::Grade::Light; +} + +bool TaskManager::enqueueCompensationTask(const QStringList &paths) +{ + if (paths.isEmpty()) { + return false; + } + + taskQueue.enqueue(createCompensationTaskItem(paths)); + qInfo() << "[TaskManager::enqueueCompensationTask] Queued directory compensation update for" + << paths.size() << "path(s), primary:" << paths.first(); + + recordIngestedFiles(paths.size()); + updateBacklogState(); + return true; +} + +QStringList TaskManager::applyDirectoryMovePlans(const QHash &movedFiles) +{ + const QList plans = TaskQueueUtils::buildDirectoryMovePlans(movedFiles); + if (plans.isEmpty()) { + return {}; + } + + QStringList compensationPaths; + + for (const TaskQueueUtils::DirectoryMovePlan &plan : plans) { + const bool rewroteQueuedTasks = TaskQueueUtils::rewriteQueuedTasksForDirectoryMove(taskQueue, + plan.fromPath, + plan.toPath); + if (rewroteQueuedTasks) { + qInfo() << "[TaskManager::applyDirectoryMovePlans] Rewrote queued task paths for directory move:" + << plan.fromPath << "->" << plan.toPath; + } + + if (!compensationPaths.contains(plan.toPath)) { + compensationPaths.append(plan.toPath); + } + } + + return compensationPaths; +} diff --git a/src/index/task/taskmanager.h b/src/index/task/taskmanager.h new file mode 100644 index 00000000..3612355d --- /dev/null +++ b/src/index/task/taskmanager.h @@ -0,0 +1,144 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TASKMANAGER_H +#define TASKMANAGER_H + +#include "index_global.h" +#include "core/indexcontext.h" +#include "indextask.h" +#include "backlogtracker.h" + +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class EnvDetector; +struct EnvState; + +// 任务队列项 +struct TaskQueueItem +{ + IndexTask::Type type; + IndexTask::Grade grade { IndexTask::Grade::None }; // 任务分级 + QString path; + QStringList pathList; // 当传入多个路径时使用 + QStringList fileList; // 仅在文件列表类型任务中使用 + QStringList remainingFiles; // 暂停任务的剩余文件列表 + QHash movedFiles; // 仅在移动任务中使用 (fromPath -> toPath) + bool forceBypass { false }; // 手动绕过环境门槛 + // 内部恢复类 Update 跳过 cleanupIndexs（见 UpdateIndexHandler 注释）； + // 用户经 DBus 触发的更新保持 false。 + bool skipStaleCleanup { false }; +}; + +class TaskManager : public QObject +{ + Q_OBJECT +public: + explicit TaskManager(const IndexContext *context, QObject *parent = nullptr); + TaskManager(const IndexContext *context, BacklogTracker *backlogTracker, QObject *parent); + ~TaskManager(); + + bool startTask(IndexTask::Type type, const QStringList &pathList, + IndexTask::Grade grade = IndexTask::Grade::None, bool forceBypass = false, + bool skipStaleCleanup = false); + bool startTask(IndexTask::Type type, const QString &path); + + bool startFileListTask(IndexTask::Type type, const QStringList &fileList); + + bool startFileMoveTask(const QHash &movedFiles); + + bool hasRunningTask() const; + bool hasQueuedTasks() const; + void stopCurrentTask(); + + std::optional currentTaskType() const; + std::optional currentTaskPath() const; + std::optional currentTaskGrade() const; + std::optional currentOrQueuedGrade() const; + QString currentIndexStatus() const; + + static QString gradeToString(IndexTask::Grade grade); + + // Recovery state management - used to prevent incremental tasks from + // clearing Dirty state before recovery task completes + void setRecoveryPending(bool pending); + bool isRecoveryPending() const; + +Q_SIGNALS: + void taskFinished(const QString &type, const QString &path, bool success); + void taskProgressChanged(const QString &type, const QString &path, qint64 count, qint64 total); + void startTaskInThread(); + void indexStatusChanged(const QString &state, const QString &grade); + +private Q_SLOTS: + void onTaskProgress(IndexTask::Type type, qint64 count, qint64 total); + void onTaskFinished(IndexTask::Type type, ANYTHING_INDEX_NAMESPACE::HandlerResult result); + void onTaskPaused(IndexTask::Type type, ANYTHING_INDEX_NAMESPACE::HandlerResult result); + void onEnvStateChanged(const EnvState &env); + +private: + void cleanupTask(); + void schedule(); + bool canRun(IndexTask::Grade grade, bool forceBypass, const EnvState &env) const; + bool isIndexDatabaseReady() const; + void pauseCurrentTask(); + void launchTask(IndexTask *task, IndexTask::Grade grade, bool forceBypass = false, + qint64 initialIncrementalPending = 0); + bool tryEnqueueIfBlocked(IndexTask::Grade grade, bool forceBypass, const TaskQueueItem &item); + void startQueuedTask(const TaskQueueItem &item); + TaskHandler getTaskHandler(IndexTask::Type type, bool skipStaleCleanup = false); + bool isFullScanTask(IndexTask::Type type) const; + bool enqueueCompensationTask(const QStringList &paths); + QStringList applyDirectoryMovePlans(const QHash &movedFiles); + void removeDuplicateFullScanTasks(IndexTask::Type type, const QStringList &pathList); + qint64 queuedIncrementalCount() const; + void updateBacklogState(); + void recordIngestedFiles(qint64 count); + + // Task grading + IndexTask::Grade gradeFileListTask(const QStringList &fileList) const; + IndexTask::Grade gradeUpdateTask() const; + + // onTaskFinished sub-routines + bool handleCorruptedIndex(IndexTask::Type type, const HandlerResult &result, const QString &taskPath); + void handleRootPathFailure(bool success, bool interrupted, const QString &taskPath); + void updateIndexStatusOnSuccess(IndexTask::Type type, const HandlerResult &result); + void finalizeIndexState(IndexTask::Type type, const HandlerResult &result); + + static QString typeToString(IndexTask::Type type); + static int gradePriority(IndexTask::Grade grade); + + const IndexContext *m_context { nullptr }; + BacklogTracker *m_backlogTracker { nullptr }; + QThread workerThread; + IndexTask *currentTask { nullptr }; + + // 保存待执行的任务信息 + QQueue taskQueue; + + // Recovery pending flag - set at service startup if Dirty state detected + // Prevents incremental tasks from clearing Dirty state before recovery completes + bool m_recoveryPending { false }; + bool m_lastTaskFailed { false }; + qint64 m_currentIncrementalPending { 0 }; + + // 突发体量跟踪：自上次事件静默以来经 collector 累计进入 task 层的文件数。 + // update() 只见 task 层瞬时排队量——1s 收集窗口把大突发预分批成小任务， + // filename 任务处理快、波间排空，瞬时积压始终到不了降级阈值；累计口径 + // 才能反映"解压/拷贝大量文件"的突发体量。 + // m_burstRecheckTimer：burst 静默期内 task 层排空后没有任何任务事件会 + // 再触发评估，靠它在静默期满后补一次评估以清除 backlogExceeded。 + qint64 m_burstFiles { 0 }; + qint64 m_lastIngestMsecs { 0 }; + QTimer *m_burstRecheckTimer { nullptr }; +}; + +ANYTHING_INDEX_END_NAMESPACE +#endif // TASKMANAGER_H diff --git a/src/index/task/taskqueueutils.cpp b/src/index/task/taskqueueutils.cpp new file mode 100644 index 00000000..a65d84cf --- /dev/null +++ b/src/index/task/taskqueueutils.cpp @@ -0,0 +1,128 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "taskqueueutils.h" + +#include "utils/indexutility.h" + +#include + +ANYTHING_INDEX_USE_NAMESPACE + +namespace { + +QString rewritePathForDirectoryMove(const QString &path, + const QString &normalizedFromPath, + const QString &toPath) +{ + if (path.isEmpty()) { + return path; + } + + return PathCalculator::calculateNewPathForDirectoryMove(path, normalizedFromPath, toPath); +} + +QStringList rewritePathListForDirectoryMove(const QStringList &paths, + const QString &normalizedFromPath, + const QString &toPath, + bool *changed = nullptr) +{ + QStringList rewrittenPaths; + rewrittenPaths.reserve(paths.size()); + + bool anyChanged = false; + for (const QString &path : paths) { + const QString rewrittenPath = rewritePathForDirectoryMove(path, normalizedFromPath, toPath); + rewrittenPaths.append(rewrittenPath); + anyChanged = anyChanged || (rewrittenPath != path); + } + + if (changed) { + *changed = anyChanged; + } + + return rewrittenPaths; +} + +QHash rewriteMoveMapForDirectoryMove(const QHash &movedFiles, + const QString &normalizedFromPath, + const QString &toPath, + bool *changed = nullptr) +{ + QHash rewrittenMoves; + bool anyChanged = false; + + for (auto it = movedFiles.constBegin(); it != movedFiles.constEnd(); ++it) { + const QString rewrittenFrom = rewritePathForDirectoryMove(it.key(), normalizedFromPath, toPath); + const QString rewrittenTo = rewritePathForDirectoryMove(it.value(), normalizedFromPath, toPath); + rewrittenMoves.insert(rewrittenFrom, rewrittenTo); + anyChanged = anyChanged || rewrittenFrom != it.key() || rewrittenTo != it.value(); + } + + if (changed) { + *changed = anyChanged; + } + + return rewrittenMoves; +} + +} // namespace + +QList TaskQueueUtils::buildDirectoryMovePlans(const QHash &movedFiles) +{ + QList plans; + plans.reserve(movedFiles.size()); + + for (auto it = movedFiles.constBegin(); it != movedFiles.constEnd(); ++it) { + if (!PathCalculator::isDirectoryMove(it.value())) { + continue; + } + + DirectoryMovePlan plan; + plan.fromPath = it.key(); + plan.toPath = it.value(); + plans.append(plan); + } + + return plans; +} + +bool TaskQueueUtils::rewriteQueuedTasksForDirectoryMove(QQueue &taskQueue, + const QString &fromPath, + const QString &toPath) +{ + if (taskQueue.isEmpty() || fromPath.isEmpty() || toPath.isEmpty()) { + return false; + } + + const QString normalizedFromPath = PathCalculator::normalizeDirectoryPath(fromPath); + bool queueChanged = false; + + // Fix: queued incremental tasks may still carry stale paths after a directory rename/move. + // Rewrite them before execution so TaskManager stays a scheduler while this helper owns + // the pure path migration logic. + for (TaskQueueItem &item : taskQueue) { + bool itemChanged = false; + + const QString rewrittenPath = rewritePathForDirectoryMove(item.path, normalizedFromPath, toPath); + itemChanged = itemChanged || (rewrittenPath != item.path); + item.path = rewrittenPath; + + bool pathListChanged = false; + item.pathList = rewritePathListForDirectoryMove(item.pathList, normalizedFromPath, toPath, &pathListChanged); + itemChanged = itemChanged || pathListChanged; + + bool fileListChanged = false; + item.fileList = rewritePathListForDirectoryMove(item.fileList, normalizedFromPath, toPath, &fileListChanged); + itemChanged = itemChanged || fileListChanged; + + bool moveMapChanged = false; + item.movedFiles = rewriteMoveMapForDirectoryMove(item.movedFiles, normalizedFromPath, toPath, &moveMapChanged); + itemChanged = itemChanged || moveMapChanged; + + queueChanged = queueChanged || itemChanged; + } + + return queueChanged; +} diff --git a/src/index/task/taskqueueutils.h b/src/index/task/taskqueueutils.h new file mode 100644 index 00000000..575d82af --- /dev/null +++ b/src/index/task/taskqueueutils.h @@ -0,0 +1,32 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TASKQUEUEUTILS_H +#define TASKQUEUEUTILS_H + +#include "index_global.h" +#include "taskmanager.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace TaskQueueUtils { + +struct DirectoryMovePlan +{ + QString fromPath; + QString toPath; +}; + +QList buildDirectoryMovePlans(const QHash &movedFiles); +bool rewriteQueuedTasksForDirectoryMove(QQueue &taskQueue, + const QString &fromPath, + const QString &toPath); + +} // namespace TaskQueueUtils + +ANYTHING_INDEX_END_NAMESPACE + +#endif // TASKQUEUEUTILS_H diff --git a/src/index/utils/docutils.cpp b/src/index/utils/docutils.cpp new file mode 100644 index 00000000..6cea22c5 --- /dev/null +++ b/src/index/utils/docutils.cpp @@ -0,0 +1,66 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "docutils.h" + +#include +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace DocUtils { + +Lucene::DocumentPtr copyFieldsExcept(const Lucene::DocumentPtr &sourceDoc, + const std::vector &excludeFieldNames) +{ + using namespace Lucene; + + if (!sourceDoc) { + return nullptr; + } + + DocumentPtr newDoc = newLucene(); + Collection fields = sourceDoc->getFields(); + + for (Collection::iterator fieldIt = fields.begin(); fieldIt != fields.end(); ++fieldIt) { + FieldablePtr fieldable = *fieldIt; + String fieldName = fieldable->name(); + + // Check if field name is in the exclude list + bool shouldExclude = false; + for (const auto &excludeName : excludeFieldNames) { + if (fieldName == excludeName) { + shouldExclude = true; + break; + } + } + + if (!shouldExclude) { + // Check if this is a NumericField + NumericFieldPtr numericField = boost::dynamic_pointer_cast(fieldable); + if (numericField) { + // Copy NumericField with its numeric value + NumericFieldPtr newNumericField = newLucene( + fieldName, + fieldable->isStored() ? Field::STORE_YES : Field::STORE_NO, + fieldable->isIndexed()); + newNumericField->setLongValue(numericField->getNumericValue()); + newDoc->add(newNumericField); + } else { + // Copy regular field with original properties + newDoc->add(newLucene(fieldName, fieldable->stringValue(), + fieldable->isStored() ? Field::STORE_YES : Field::STORE_NO, + fieldable->isIndexed() ? (fieldable->isTokenized() ? Field::INDEX_ANALYZED : Field::INDEX_NOT_ANALYZED) : Field::INDEX_NO)); + } + } + } + + return newDoc; +} + +} // namespace DocUtils + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/docutils.h b/src/index/utils/docutils.h new file mode 100644 index 00000000..24e27142 --- /dev/null +++ b/src/index/utils/docutils.h @@ -0,0 +1,29 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef DOCUTILS_H +#define DOCUTILS_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace DocUtils { + +/** + * @brief Copy all fields from source document except the specified excluded fields + * @param sourceDoc Source document to copy from + * @param excludeFieldNames Field names to exclude from copying + * @return New document with copied fields + */ +Lucene::DocumentPtr copyFieldsExcept(const Lucene::DocumentPtr &sourceDoc, + const std::vector &excludeFieldNames); + +} // namespace DocUtils + +ANYTHING_INDEX_END_NAMESPACE + +#endif // DOCUTILS_H diff --git a/src/index/utils/filehash.cpp b/src/index/utils/filehash.cpp new file mode 100644 index 00000000..74f62f90 --- /dev/null +++ b/src/index/utils/filehash.cpp @@ -0,0 +1,31 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "filehash.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace FileHash { + +QString computeMd5(const QString &filePath) +{ + QFile file(filePath); + if (!file.open(QIODevice::ReadOnly)) { + return {}; + } + + QCryptographicHash hash(QCryptographicHash::Md5); + if (!hash.addData(&file)) { + return {}; + } + + return QString::fromLatin1(hash.result().toHex()); +} + +} // namespace FileHash + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/filehash.h b/src/index/utils/filehash.h new file mode 100644 index 00000000..7935fe97 --- /dev/null +++ b/src/index/utils/filehash.h @@ -0,0 +1,27 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FILEHASH_H +#define FILEHASH_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace FileHash { + +/** + * @brief Compute MD5 checksum of a file + * @param filePath Absolute path to the file + * @return MD5 hex digest string (32 lowercase chars), or empty string on failure + */ +QString computeMd5(const QString &filePath); + +} // namespace FileHash + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FILEHASH_H diff --git a/src/index/utils/filetypemapper.cpp b/src/index/utils/filetypemapper.cpp new file mode 100644 index 00000000..37c1d718 --- /dev/null +++ b/src/index/utils/filetypemapper.cpp @@ -0,0 +1,112 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "filetypemapper.h" + +#include + +#include + +#include +#include + +DCORE_USE_NAMESPACE +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +// org.deepin.anything dconfig 的后缀键 → anything file_type 字段值。 +// 类型字符串必须与 deepin-anything-daemon 的 file_type_mapping_ 完全一致 +// （dfm-search 按这些值做类型过滤）。 +struct SuffixKeyMapping +{ + const char *dconfigKey; + const char *fileType; +}; + +constexpr SuffixKeyMapping kSuffixKeyMappings[] = { + { "app_file_suffix", "app" }, + { "archive_file_suffix", "archive" }, + { "audio_file_suffix", "audio" }, + { "doc_file_suffix", "doc" }, + { "pic_file_suffix", "pic" }, + { "video_file_suffix", "video" }, +}; + +} // namespace + +FileTypeMapper &FileTypeMapper::instance() +{ + static FileTypeMapper instance; + return instance; +} + +FileTypeMapper::FileTypeMapper() +{ + loadMappings(); +} + +void FileTypeMapper::loadMappings() +{ + // 局部同步使用，统一用 RAII 清理；不用 deleteLater()——本函数可能在 + // 静态单例构造期间执行，此时无事件循环，deferred delete 不会执行导致泄漏。 + const std::unique_ptr dconfig(DConfig::create("org.deepin.anything", "org.deepin.anything")); + if (!dconfig || !dconfig->isValid()) { + qWarning() << "FileTypeMapper: Failed to load org.deepin.anything dconfig"; + return; + } + + for (const auto &mapping : kSuffixKeyMappings) { + const QVariant value = dconfig->value(QString::fromLatin1(mapping.dconfigKey)); + if (!value.isValid()) + continue; + + // anything 的后缀配置为分号分隔字符串（如 "7z;ace;ar;..."），兼容 stringlist 类型 + QStringList extensions; + if (value.typeId() == QMetaType::QStringList || value.typeId() == QMetaType::QVariantList) { + extensions = value.toStringList(); + } else { + extensions = value.toString().split(';', Qt::SkipEmptyParts); + } + + const QString type = QString::fromLatin1(mapping.fileType); + for (const QString &ext : std::as_const(extensions)) { + QString cleaned = ext.trimmed(); + if (cleaned.startsWith('.')) + cleaned = cleaned.mid(1); + if (!cleaned.isEmpty()) + m_extToType.insert(cleaned.toLower(), type); + } + } + + qInfo() << "FileTypeMapper: Loaded" << m_extToType.size() << "extension mappings"; +} + +QString FileTypeMapper::fileTypeForExtension(const QString &ext) const +{ + QString cleaned = ext; + if (cleaned.startsWith('.')) + cleaned = cleaned.mid(1); + cleaned = cleaned.toLower(); + + auto it = m_extToType.constFind(cleaned); + if (it != m_extToType.constEnd()) + return it.value(); + return QStringLiteral("other"); +} + +QString FileTypeMapper::fileTypeForPath(const QString &filePath) const +{ + const QFileInfo fileInfo(filePath); + if (fileInfo.isDir()) + return QStringLiteral("dir"); + + const QString ext = fileInfo.suffix().toLower(); + if (ext.isEmpty()) + return QStringLiteral("other"); + + return fileTypeForExtension(ext); +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/filetypemapper.h b/src/index/utils/filetypemapper.h new file mode 100644 index 00000000..b44a8197 --- /dev/null +++ b/src/index/utils/filetypemapper.h @@ -0,0 +1,33 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef FILETYPEMAPPER_H +#define FILETYPEMAPPER_H + +#include "index_global.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class FileTypeMapper +{ +public: + static FileTypeMapper &instance(); + + QString fileTypeForExtension(const QString &ext) const; + QString fileTypeForPath(const QString &filePath) const; + +private: + FileTypeMapper(); + + void loadMappings(); + + QHash m_extToType; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // FILETYPEMAPPER_H diff --git a/src/index/utils/indextraverseutils.cpp b/src/index/utils/indextraverseutils.cpp new file mode 100644 index 00000000..f2f446c8 --- /dev/null +++ b/src/index/utils/indextraverseutils.cpp @@ -0,0 +1,135 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "indextraverseutils.h" +#include "textindexconfig.h" + +#include +#include +#include +#include + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace IndexTraverseUtils { + +bool isHiddenFile(const char *name) +{ + return name[0] == '.'; +} + +bool isSpecialDir(const char *name) +{ + return strcmp(name, ".") == 0 || strcmp(name, "..") == 0; +} + +bool isValidFile(const QString &path) +{ + QFileInfo fileInfo(path); + return !fileInfo.canonicalFilePath().isEmpty(); +} + +bool isValidDirectory(const QString &path, QSet &visitedDirs) +{ + QFileInfo fileInfo(path); + QString canonicalPath = fileInfo.canonicalFilePath(); + + if (fileInfo.isSymLink()) + return false; + + if (canonicalPath.isEmpty()) + return false; + + if (visitedDirs.contains(canonicalPath)) + return false; + + visitedDirs.insert(canonicalPath); + return true; +} + +bool shouldSkipDirectory(const QString &path) +{ + static const QSet kExcludeDirs = { + // 系统目录 + "/proc", // 进程信息 + "/sys", // 系统信息 + "/dev", // 设备文件 + "/boot", // 启动文件 + "/lost+found", // 系统恢复目录 + "/tmp", // 临时文件 + "/var/tmp", // 临时文件 + "/var/cache", // 缓存目录 + "/var/log", // 日志目录 + "/var/lib", + "/run", // 运行时文件 + "/media", + "/run/media", + "/mnt", + "/var/mnt", + + // 特殊目录 + "/opt", // 可选软件 + "/srv", // 服务数据 + "/usr/lib", // 系统库 + "/usr/lib32", + "/usr/lib64", + "/usr/libx32", + "/usr/share", // 共享数据 + "/usr/include", // 头文件 + "/usr/src", // 源代码 + "/usr/sbin", // 系统二进制 + "/usr/local/lib", // 本地库 + "/usr/local/sbin", + "/usr/local/include", + "/usr/local/share", + "/data", + "/ostree", + "/persistent/ostree" + }; + + for (const QString &excludeDir : kExcludeDirs) { + if (path.startsWith(excludeDir)) + return true; + } + + return false; +} + +QMap fstabBindInfo() +{ + static QMutex mutex; + static QMap table; + struct stat statInfo; + int result = stat("/etc/fstab", &statInfo); + + QMutexLocker locker(&mutex); + if (0 == result) { + static quint32 lastModify = 0; + if (lastModify != statInfo.st_mtime) { + lastModify = static_cast(statInfo.st_mtime); + table.clear(); + struct fstab *fs; + + setfsent(); + while ((fs = getfsent()) != nullptr) { + QString mntops(fs->fs_mntops); + if (mntops.contains("bind")) + table.insert(fs->fs_spec, fs->fs_file); + } + endfsent(); + } + } else { + // Clear table when fstab file doesn't exist or can't be accessed + table.clear(); + } + + return table; +} + +} // namespace IndexTraverseUtils + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/indextraverseutils.h b/src/index/utils/indextraverseutils.h new file mode 100644 index 00000000..75356b0c --- /dev/null +++ b/src/index/utils/indextraverseutils.h @@ -0,0 +1,38 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef INDEXTRAVERSEUTILS_H +#define INDEXTRAVERSEUTILS_H + +#include "index_global.h" + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace IndexTraverseUtils { + +// 检查是否是隐藏文件 +bool isHiddenFile(const char *name); + +// 检查是否是特殊目录(. 或 ..) +bool isSpecialDir(const char *name); + +// 检查文件路径是否有效 +bool isValidFile(const QString &path); + +// 检查目录是否有效且未被访问过 +bool isValidDirectory(const QString &path, QSet &visitedDirs); + +// 检查是否应该跳过该目录 +bool shouldSkipDirectory(const QString &path); + +QMap fstabBindInfo(); + +} // namespace IndexTraverseUtils + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXTRAVERSEUTILS_H diff --git a/src/index/utils/indexutility.cpp b/src/index/utils/indexutility.cpp new file mode 100644 index 00000000..a2cf5e91 --- /dev/null +++ b/src/index/utils/indexutility.cpp @@ -0,0 +1,369 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#include "indexutility.h" +#include "textindexconfig.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +inline constexpr char kDeepinAnythingDconfName[] { "org.deepin.anything" }; +inline constexpr char kDeepinAnythingDconfPathKey[] { "indexing_paths" }; +inline constexpr char kDeepinAnythingDconfBlacklistPathKey[] { "blacklist_paths" }; + +DCORE_USE_NAMESPACE +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace IndexUtility { + +bool isIndexWithAnything(const QString &path) +{ + if (!DFMSEARCH::Global::isFileNameIndexReadyForSearch()) + return false; + return isDefaultIndexedDirectory(path); +} + +bool isDefaultIndexedDirectory(const QString &path) +{ + auto kDirs = AnythingConfigWatcher::instance()->defaultAnythingIndexPaths(); + return kDirs.contains(path); +} + +bool checkFileSize(const QFileInfo &fileInfo, qint64 sizeMBFromConfig) +{ + try { + // 在这里进行上述的健全性检查 + if (sizeMBFromConfig <= 0 || sizeMBFromConfig > Q_INT64_C(0x7FFFFFFFFFFFFFFF) / (1024LL * 1024LL)) { + sizeMBFromConfig = 50LL; // Default fallback + } + const qint64 kMaxFileSizeInBytes = sizeMBFromConfig * 1024LL * 1024LL; + + if (fileInfo.size() > kMaxFileSizeInBytes) { + qDebug() << "File" << fileInfo.fileName() << "size" << fileInfo.size() + << "exceeds max allowed size" << kMaxFileSizeInBytes; + return false; + } + return true; + } catch (const std::exception &e) { + qWarning() << "Failed to check file size:" << fileInfo.filePath() << e.what(); + return false; + } catch (...) { + qWarning() << "Failed to check file size with unknown exception:" << fileInfo.filePath(); + return false; + } +} + +bool isSupportedTextFile(const QString &path) +{ + try { + QFileInfo fileInfo(path); + + // 检查文件大小是否超过 X MB（X * 1024 * 1024 字节） + if (fileInfo.exists() && !checkFileSize(fileInfo, TextIndexConfig::instance().maxIndexTextFileSizeMB())) + return false; + + const QString &suffix = fileInfo.suffix().toLower(); + return TextIndexConfig::instance().supportedTextFileExtensions().contains(suffix); + } catch (const std::exception &e) { + qWarning() << "Failed to check if file is supported:" << path << e.what(); + return false; + } catch (...) { + qWarning() << "Failed to check if file is supported with unknown exception:" << path; + return false; + } +} + +bool isSupportedOCRFile(const QString &path) +{ + try { + QFileInfo fileInfo(path); + + // 检查文件大小是否超过 X MB（X * 1024 * 1024 字节） + if (fileInfo.exists() && !checkFileSize(fileInfo, TextIndexConfig::instance().maxOcrImageSizeMB())) + return false; + + const QString &suffix = fileInfo.suffix().toLower(); + return TextIndexConfig::instance().supportedOcrImageExtensions().contains(suffix); + } catch (const std::exception &e) { + qWarning() << "Failed to check if file is supported:" << path << e.what(); + return false; + } catch (...) { + qWarning() << "Failed to check if file is supported with unknown exception:" << path; + return false; + } +} + +AnythingConfigWatcher *AnythingConfigWatcher::instance() +{ + static AnythingConfigWatcher *in = new AnythingConfigWatcher; + return in; +} + +AnythingConfigWatcher::~AnythingConfigWatcher() +{ +} + +QStringList AnythingConfigWatcher::defaultAnythingIndexPaths() +{ + QMutexLocker lk(&mu); + return defaultIndexPath; +} + +QStringList AnythingConfigWatcher::defaultAnythingIndexPathsRealtime() +{ + QMutexLocker lk(&mu); + defaultIndexPath.clear(); + defaultIndexPath = DFMSEARCH::Global::defaultIndexedDirectory(); + return defaultIndexPath; +} + +QStringList AnythingConfigWatcher::defaultBlacklistPaths() +{ + QMutexLocker lk(&mu); + return blacklistPaths; +} + +QStringList AnythingConfigWatcher::defaultBlacklistPathsRealtime() +{ + QMutexLocker lk(&mu); + blacklistPaths.clear(); + blacklistPaths = DFMSEARCH::Global::defaultBlacklistPaths(); + return blacklistPaths; +} + +void AnythingConfigWatcher::handleConfigChanged(const QString &key) +{ + if (key == kDeepinAnythingDconfPathKey) { + defaultAnythingIndexPathsRealtime(); + qInfo() << "Anything indexing paths changed, index rebuild needed"; + emit rebuildRequired(QStringLiteral("anythingIndexPathsChanged")); + } else if (key == kDeepinAnythingDconfBlacklistPathKey) { + defaultBlacklistPathsRealtime(); + qInfo() << "Anything blacklist paths changed, index rebuild needed"; + emit rebuildRequired(QStringLiteral("anythingBlacklistPathsChanged")); + } +} + +AnythingConfigWatcher::AnythingConfigWatcher(QObject *parent) + : QObject(parent) +{ + cfg = DConfig::create(kDeepinAnythingDconfName, kDeepinAnythingDconfName, "", this); + if (!cfg) + qWarning() << " [AnythingConfigWatcher::AnythingConfigWatcher] create dconfig error, nullptr!!" << kDeepinAnythingDconfName; + + if (cfg && !cfg->isValid()) { + qWarning() << " [AnythingConfigWatcher::AnythingConfigWatcher] create dconfig error, config is not valid!!" << kDeepinAnythingDconfName; + cfg->deleteLater(); + cfg = nullptr; + } + + if (cfg && cfg->isValid()) + connect(cfg, &DConfig::valueChanged, this, &AnythingConfigWatcher::handleConfigChanged); + + defaultAnythingIndexPathsRealtime(); + defaultBlacklistPathsRealtime(); +} + +// ───────────────────────────────────────────── +// ConfigRebuildWatcher +// ───────────────────────────────────────────── + +ConfigRebuildWatcher::ConfigRebuildWatcher(const QList &entries, QObject *parent) + : QObject(parent) +{ + for (const auto &entry : entries) { + ConfigHolder holder; + holder.appId = entry.appId; + holder.configId = entry.configId; + holder.watchedKey = entry.key; + holder.config = DConfig::create(entry.appId, entry.configId, "", this); + + if (!holder.config) { + qWarning() << "ConfigRebuildWatcher: Failed to create DConfig for" << entry.appId << entry.configId; + continue; + } + if (!holder.config->isValid()) { + qWarning() << "ConfigRebuildWatcher: DConfig is not valid for" << entry.appId << entry.configId; + holder.config->deleteLater(); + holder.config = nullptr; + continue; + } + + // Capture by value for the lambda closure, + // since DConfig::valueChanged only provides the key, not the config source. + const auto configId = entry.configId; + const auto watchedKey = entry.key; + connect(holder.config, &DConfig::valueChanged, this, + [this, configId, watchedKey](const QString &key) { + if (key == watchedKey) { + const QString reason = QStringLiteral("%1:%2Changed").arg(configId, key); + qInfo() << "ConfigRebuildWatcher:" << reason; + emit rebuildRequired(reason); + } + }); + + m_configs.append(holder); + } +} + +ConfigRebuildWatcher::~ConfigRebuildWatcher() = default; + +// ───────────────────────────────────────────── +// DlnfsConfigWatcher +// ───────────────────────────────────────────── + +DlnfsConfigWatcher *DlnfsConfigWatcher::instance() +{ + static DlnfsConfigWatcher *inst = new DlnfsConfigWatcher; + return inst; +} + +DlnfsConfigWatcher::~DlnfsConfigWatcher() = default; + +DlnfsConfigWatcher::DlnfsConfigWatcher(QObject *parent) + : QObject(parent), + m_watcher(new ConfigRebuildWatcher({ { QStringLiteral("org.deepin.dde.file-manager"), + QStringLiteral("org.deepin.dde.file-manager"), + QStringLiteral("dfm.mount.dlnfs") }, + { QStringLiteral("org.deepin.dlnfs"), + QStringLiteral("org.deepin.dlnfs"), + QStringLiteral("ulnfs") } }, + this)) +{ + connect(m_watcher, &ConfigRebuildWatcher::rebuildRequired, + this, &DlnfsConfigWatcher::rebuildRequired); +} + +} // namespace IndexUtility + +namespace SearchUtility { + +QStringList runCli(const QStringList &args, int timeoutMs) +{ + const QString executable = QStandardPaths::findExecutable("dfm-searcher"); + if (executable.isEmpty()) { + qWarning() << "SearchUtility: dfm-searcher not found in PATH"; + return {}; + } + + QProcess process; + process.start(executable, args); + + if (!process.waitForFinished(timeoutMs)) { + qWarning() << "SearchUtility: dfm-searcher CLI timed out after" << timeoutMs << "ms"; + process.kill(); + process.waitForFinished(1000); + return {}; + } + + if (process.exitCode() != 0) { + qWarning() << "SearchUtility: dfm-searcher CLI failed, exit code:" << process.exitCode(); + return {}; + } + + const QByteArray output = process.readAllStandardOutput(); + QJsonParseError parseError; + const QJsonDocument doc = QJsonDocument::fromJson(output, &parseError); + if (parseError.error != QJsonParseError::NoError) { + qWarning() << "SearchUtility: Failed to parse CLI JSON:" << parseError.errorString(); + return {}; + } + + const QJsonObject root = doc.object(); + const QJsonArray results = root["results"].toArray(); + + QStringList paths; + paths.reserve(results.size()); + for (const QJsonValue &val : results) { + const QString path = val.toString(); + if (!path.isEmpty()) { + paths << path; + } + } + + qInfo() << "SearchUtility: CLI search returned" << paths.size() << "results"; + return paths; +} + +} // namespace SearchUtility + +namespace PathCalculator { + +QString calculateNewPathForDirectoryMove(const QString &oldPath, + const QString &fromDirPath, + const QString &toDirPath) +{ + if (oldPath.startsWith(fromDirPath)) { + return toDirPath + "/" + oldPath.mid(fromDirPath.length()); + } else if (oldPath == fromDirPath.chopped(1)) { // Remove trailing slash for comparison + return toDirPath; + } + return oldPath; // No change needed +} + +QString normalizeDirectoryPath(const QString &dirPath) +{ + QString normalized = dirPath; + if (!normalized.endsWith('/')) { + normalized += '/'; + } + return normalized; +} + +bool isDirectoryMove(const QString &toPath) +{ + if (toPath.isEmpty()) { + return false; + } + + // First check if path exists and is a directory + QFileInfo toFileInfo(toPath); + if (toFileInfo.exists()) { + return toFileInfo.isDir(); + } + + // If path doesn't exist, infer from path format (trailing slash indicates directory) + return toPath.endsWith('/'); +} + +QStringList extractAncestorPaths(const QString &filePath) +{ + QStringList ancestorPaths; + if (filePath.isEmpty()) + return ancestorPaths; + + QFileInfo fileInfo(filePath); + QString currentPath = fileInfo.path(); // 初始为文件所在的目录路径 + + // 循环向上获取所有父目录，直到根目录 + while (currentPath != "/" && !currentPath.isEmpty()) { + ancestorPaths.append(currentPath); + currentPath = QFileInfo(currentPath).path(); // 获取父目录 + } + + // 如果文件路径是根目录下的文件，确保包括根目录 + if (fileInfo.path() == "/" && fileInfo.exists() && fileInfo.isFile()) { + // 文件直接在根目录下，没有祖先目录 + return ancestorPaths; + } + + // 添加根目录如果当前路径是 "/" 但还没有添加（处理目录路径的情况） + if (currentPath == "/" && !ancestorPaths.contains("/")) { + // 这种情况应该不会发生，因为文件路径是文件不是目录，fileInfo.path() 只会在文件直接在根目录下时返回 "/" + // 而上面的条件已经处理了这种情况 + } + + return ancestorPaths; +} + +} // namespace PathCalculator + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/indexutility.h b/src/index/utils/indexutility.h new file mode 100644 index 00000000..29a3799f --- /dev/null +++ b/src/index/utils/indexutility.h @@ -0,0 +1,191 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#ifndef INDEXUTILITY_H +#define INDEXUTILITY_H + +#include "index_global.h" + +#include +#include +#include + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class IndexStateStore; + +namespace IndexUtility { + +/** + * @brief Index state for crash recovery + */ +enum class IndexState { + Clean, ///< Index is complete, last shutdown was clean with no pending tasks + Dirty, ///< Index may be incomplete, needs global update on next start + Unknown ///< State field not found (legacy status file or corrupted) +}; + +bool isIndexWithAnything(const QString &path); +bool isDefaultIndexedDirectory(const QString &path); + +/** + * @brief Check if a file size is within the allowed limit for indexing + * @param fileInfo QFileInfo object of the file to check + * @return true if file size is acceptable, false otherwise + */ +bool checkFileSize(const QFileInfo &fileInfo, qint64 sizeMBFromConfig); + +/** + * @brief Check if a content file is supported for indexing + * @param path File path to check + * @return true if file type is supported and meets size requirements, false otherwise + */ +bool isSupportedTextFile(const QString &path); + +/** + * @brief Check if a OCR file is supported for indexing + * @param path File path to check + * @return true if file type is supported and meets size requirements, false otherwise + */ +bool isSupportedOCRFile(const QString &path); + +class AnythingConfigWatcher : public QObject +{ + Q_OBJECT +public: + static AnythingConfigWatcher *instance(); + ~AnythingConfigWatcher() override; + + QStringList defaultAnythingIndexPaths(); + QStringList defaultAnythingIndexPathsRealtime(); + QStringList defaultBlacklistPaths(); + QStringList defaultBlacklistPathsRealtime(); + +Q_SIGNALS: + void rebuildRequired(const QString &reason); + +private slots: + void handleConfigChanged(const QString &key); + +private: + explicit AnythingConfigWatcher(QObject *parent = nullptr); + +private: + DTK_CORE_NAMESPACE::DConfig *cfg { nullptr }; + QMutex mu; + QStringList defaultIndexPath; + QStringList blacklistPaths; +}; + +/** + * @brief Generic DConfig watcher that emits rebuildRequired when watched keys change + * + * Provides a reusable mechanism to monitor multiple DConfig sources + * and trigger index rebuilds when configuration changes are detected. + */ +class ConfigRebuildWatcher : public QObject +{ + Q_OBJECT +public: + struct WatchEntry { + QString appId; + QString configId; + QString key; + }; + + explicit ConfigRebuildWatcher(const QList &entries, QObject *parent = nullptr); + ~ConfigRebuildWatcher() override; + +Q_SIGNALS: + void rebuildRequired(const QString &reason); + +private: + struct ConfigHolder { + DTK_CORE_NAMESPACE::DConfig *config { nullptr }; + QString appId; + QString configId; + QString watchedKey; + }; + QList m_configs; +}; + +/** + * @brief Watches dlnfs/ulnfs configuration changes that affect file indexing + * + * Monitors two DConfig sources: + * - org.deepin.dde.file-manager: dfm.mount.dlnfs + * - org.deepin.dlnfs: ulnfs + * + * When any watched key changes, emits rebuildRequired to trigger index rebuild. + */ +class DlnfsConfigWatcher : public QObject +{ + Q_OBJECT +public: + static DlnfsConfigWatcher *instance(); + ~DlnfsConfigWatcher() override; + +Q_SIGNALS: + void rebuildRequired(const QString &reason); + +private: + explicit DlnfsConfigWatcher(QObject *parent = nullptr); + ConfigRebuildWatcher *m_watcher { nullptr }; +}; + +} // namespace IndexUtility + +namespace SearchUtility { + +/** + * @brief Run dfm-searcher CLI and parse JSON output + * @param args Arguments to pass to dfm-searcher (excluding executable name) + * @param timeoutMs Timeout in milliseconds (default 120s) + * @return List of file/directory paths from the "results" JSON array, + * or empty list on any failure (not found, timeout, bad exit, parse error) + */ +QStringList runCli(const QStringList &args, int timeoutMs = 120000); + +} // namespace SearchUtility + +namespace PathCalculator { + +/** + * @brief Calculate new path for directory move operation + * @param oldPath Original file path + * @param fromDirPath Source directory path (normalized with trailing slash) + * @param toDirPath Target directory path + * @return New calculated path + */ +QString calculateNewPathForDirectoryMove(const QString &oldPath, + const QString &fromDirPath, + const QString &toDirPath); + +/** + * @brief Normalize directory path by ensuring it ends with '/' + * @param dirPath Directory path to normalize + * @return Normalized directory path + */ +QString normalizeDirectoryPath(const QString &dirPath); + +/** + * @brief Detect if the move operation is a directory move + * @param toPath Target path to check + * @return true if it's a directory move, false for file move + */ +bool isDirectoryMove(const QString &toPath); + +/** + * @brief Extract all ancestor directories from a file path + * @param filePath Full file path + * @return List of all ancestor directories in order from root to parent + */ +QStringList extractAncestorPaths(const QString &filePath); + +} // namespace PathCalculator + +ANYTHING_INDEX_END_NAMESPACE + +#endif // INDEXUTILITY_H diff --git a/src/index/utils/pathexcludematcher.cpp b/src/index/utils/pathexcludematcher.cpp new file mode 100644 index 00000000..464e9789 --- /dev/null +++ b/src/index/utils/pathexcludematcher.cpp @@ -0,0 +1,211 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "pathexcludematcher.h" +#include "textindexconfig.h" +#include "indexutility.h" + +ANYTHING_INDEX_BEGIN_NAMESPACE + +PathExcludeMatcher::PathExcludeMatcher() = default; + +PathExcludeMatcher::PathExcludeMatcher(const QStringList &patterns) +{ + addPatterns(patterns); +} + +void PathExcludeMatcher::addPattern(const QString &pattern) +{ + if (pattern.isEmpty()) { + return; + } + + // Check if pattern already exists + for (const auto &existing : m_patterns) { + if (existing.original == pattern) { + return; + } + } + + m_patterns.append(parsePattern(pattern)); +} + +void PathExcludeMatcher::addPatterns(const QStringList &patterns) +{ + for (const QString &pattern : patterns) { + addPattern(pattern); + } +} + +void PathExcludeMatcher::removePattern(const QString &pattern) +{ + m_patterns.removeIf([&pattern](const ExcludePattern &p) { + return p.original == pattern; + }); +} + +void PathExcludeMatcher::clear() +{ + m_patterns.clear(); +} + +bool PathExcludeMatcher::shouldExclude(const QString &absolutePath) const +{ + if (absolutePath.isEmpty() || m_patterns.isEmpty()) { + return false; + } + + for (const auto &pattern : m_patterns) { + if (matchPattern(absolutePath, pattern)) { + return true; + } + } + + return false; +} + +QStringList PathExcludeMatcher::patterns() const +{ + QStringList result; + result.reserve(m_patterns.size()); + for (const auto &pattern : m_patterns) { + result.append(pattern.original); + } + return result; +} + +bool PathExcludeMatcher::hasPatterns() const +{ + return !m_patterns.isEmpty(); +} + +int PathExcludeMatcher::patternCount() const +{ + return m_patterns.size(); +} + +PathExcludeMatcher::ExcludePattern PathExcludeMatcher::parsePattern(const QString &pattern) +{ + ExcludePattern result; + result.original = pattern; + + // Determine pattern type based on syntax + if (pattern.startsWith('/')) { + // Absolute path prefix: starts with "/" + result.type = ExcludePatternType::AbsolutePrefix; + } else if (pattern.contains('*') || pattern.contains('?')) { + // Glob pattern: contains wildcards + result.type = ExcludePatternType::GlobPattern; + result.regex = globToRegex(pattern); + } else if (pattern.contains('/')) { + // Path segment: contains "/" but doesn't start with "/" + result.type = ExcludePatternType::PathSegment; + } else { + // Exact name: plain directory name + result.type = ExcludePatternType::ExactName; + } + + return result; +} + +bool PathExcludeMatcher::matchPattern(const QString &absolutePath, const ExcludePattern &pattern) +{ + switch (pattern.type) { + case ExcludePatternType::ExactName: { + // Split path into components and check if any matches exactly + // This ensures "tmp" matches "/home/user/tmp" and "/home/user/tmp/subdir" + // but NOT "/home/user/template" + const QStringList parts = absolutePath.split('/', Qt::SkipEmptyParts); + return parts.contains(pattern.original); + } + + case ExcludePatternType::PathSegment: { + // Match path segment with proper boundaries + // Ensure we match complete path segments, not substrings + // ".local/share/Trash" should match "/.local/share/Trash/" or "/.local/share/Trash" + // but NOT "/.local/share/Trashcan" + const QString pathWithTrailingSlash = absolutePath.endsWith('/') + ? absolutePath + : absolutePath + '/'; + const QString segmentPattern = '/' + pattern.original + '/'; + return pathWithTrailingSlash.contains(segmentPattern); + } + + case ExcludePatternType::AbsolutePrefix: { + // Match absolute path prefix + // "/home/user/exclude" matches "/home/user/exclude" and "/home/user/exclude/subdir" + if (absolutePath == pattern.original) { + return true; + } + // Ensure we match complete path components + const QString prefixWithSlash = pattern.original.endsWith('/') + ? pattern.original + : pattern.original + '/'; + return absolutePath.startsWith(prefixWithSlash); + } + + case ExcludePatternType::GlobPattern: { + // Split path into components and check if any matches the glob pattern + const QStringList parts = absolutePath.split('/', Qt::SkipEmptyParts); + for (const QString &part : parts) { + if (pattern.regex.match(part).hasMatch()) { + return true; + } + } + return false; + } + } + + return false; +} + +QRegularExpression PathExcludeMatcher::globToRegex(const QString &glob) +{ + QString regexPattern; + regexPattern.reserve(glob.size() * 2); + + // Anchor at start + regexPattern += '^'; + + for (const QChar &ch : glob) { + if (ch == '*') { + // * matches any characters (including none) + regexPattern += ".*"; + } else if (ch == '?') { + // ? matches exactly one character + regexPattern += '.'; + } else if (ch == '.' || ch == '+' || ch == '^' || ch == '$' + || ch == '(' || ch == ')' || ch == '[' || ch == ']' + || ch == '{' || ch == '}' || ch == '|' || ch == '\\') { + // Escape regex special characters + regexPattern += '\\'; + regexPattern += ch; + } else { + regexPattern += ch; + } + } + + // Anchor at end + regexPattern += '$'; + + return QRegularExpression(regexPattern); +} + +PathExcludeMatcher PathExcludeMatcher::createForIndex() +{ + PathExcludeMatcher matcher; + + // Load default blacklist directories from TextIndexConfig + const auto &textIndexBlacklist = TextIndexConfig::instance().folderExcludeFilters(); + matcher.addPatterns(textIndexBlacklist); + + // Load blacklist from AnythingConfigWatcher + const auto &anythingBlacklist = + IndexUtility::AnythingConfigWatcher::instance()->defaultBlacklistPaths(); + matcher.addPatterns(anythingBlacklist); + + return matcher; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/pathexcludematcher.h b/src/index/utils/pathexcludematcher.h new file mode 100644 index 00000000..5c54e435 --- /dev/null +++ b/src/index/utils/pathexcludematcher.h @@ -0,0 +1,185 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef PATHEXCLUDEMATCHER_H +#define PATHEXCLUDEMATCHER_H + +#include "index_global.h" + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +/** + * @brief Exclude pattern types for path matching + * + * Pattern syntax rules: + * - ExactName: Plain directory name like "tmp", ".git" + * Matches any directory with this exact name in the path + * + * - PathSegment: Contains "/" but doesn't start with "/" + * Like ".local/share/Trash", matches this exact path segment + * + * - AbsolutePrefix: Starts with "/" like "/home/user/exclude" + * Matches paths that start with this absolute path + * + * - GlobPattern: Contains "*" or "?" wildcards + * Like "build-*", "*.cache", matches directory names using glob + */ +enum class ExcludePatternType { + ExactName, ///< Exact directory name match (e.g., "tmp", ".git") + PathSegment, ///< Path segment match (e.g., ".local/share/Trash") + AbsolutePrefix, ///< Absolute path prefix match (e.g., "/home/user/exclude") + GlobPattern ///< Glob wildcard pattern (e.g., "build-*", "*.cache") +}; + +/** + * @brief Path exclusion pattern matcher + * + * A utility class for matching file system paths against exclusion patterns. + * Supports four types of matching syntax: + * + * 1. Exact Name Match (ExactName) + * Syntax: "tmp", ".git", "node_modules" + * Rule: If any directory component in the path exactly equals this value, + * the path and all its children are excluded. + * Example: "tmp" matches /home/user/tmp and /home/user/tmp/subdir, + * but NOT /home/user/template + * + * 2. Path Segment Match (PathSegment) + * Syntax: ".local/share/Trash" (contains "/" but doesn't start with "/") + * Rule: The path contains this exact contiguous sub-path + * Example: ".local/share/Trash" matches /home/user/.local/share/Trash/files + * + * 3. Absolute Prefix Match (AbsolutePrefix) + * Syntax: "/home/user/exclude" (starts with "/") + * Rule: The path starts with this absolute path + * Example: "/home/user/exclude" matches /home/user/exclude/any/subpath + * + * 4. Glob Pattern Match (GlobPattern) + * Syntax: "build-*", "*.cache", "test?" (contains * or ?) + * Rule: Any directory component in the path matches the glob pattern + * Example: "build-*" matches /project/build-debug/file + * + * @note This class is thread-safe for read operations after construction. + * Write operations (add/remove/clear) are not thread-safe. + */ +class PathExcludeMatcher +{ +public: + /** + * @brief Construct an empty matcher + */ + PathExcludeMatcher(); + + /** + * @brief Construct a matcher with initial patterns + * @param patterns List of pattern strings to parse and add + */ + explicit PathExcludeMatcher(const QStringList &patterns); + + /** + * @brief Add a single exclusion pattern + * @param pattern Pattern string to parse and add + */ + void addPattern(const QString &pattern); + + /** + * @brief Add multiple exclusion patterns + * @param patterns List of pattern strings to parse and add + */ + void addPatterns(const QStringList &patterns); + + /** + * @brief Remove a pattern by its original string + * @param pattern Original pattern string to remove + */ + void removePattern(const QString &pattern); + + /** + * @brief Clear all patterns + */ + void clear(); + + /** + * @brief Check if a path should be excluded + * @param absolutePath Absolute path to check + * @return true if path matches any exclusion pattern, false otherwise + */ + bool shouldExclude(const QString &absolutePath) const; + + /** + * @brief Get the list of original pattern strings + * @return List of pattern strings that were added + */ + QStringList patterns() const; + + /** + * @brief Check if the matcher has any patterns + * @return true if at least one pattern exists + */ + bool hasPatterns() const; + + /** + * @brief Get the number of patterns + * @return Number of patterns in the matcher + */ + int patternCount() const; + + /** + * @brief Create a PathExcludeMatcher instance configured with index blacklist + * + * This factory method encapsulates the blacklist configuration logic for the text index service, + * automatically loading blacklist patterns from the following sources: + * - TextIndexConfig::folderExcludeFilters() - Text index configuration exclude directories + * - IndexUtility::AnythingConfigWatcher::defaultBlacklistPaths() - Anything service blacklist + * + * @return Configured PathExcludeMatcher instance + * + * @note This method ensures blacklist configuration consistency, avoiding duplicate initialization logic + */ + static PathExcludeMatcher createForIndex(); + +private: + /** + * @brief Internal representation of a parsed exclude pattern + */ + struct ExcludePattern + { + QString original; ///< Original pattern string + ExcludePatternType type; ///< Parsed pattern type + QRegularExpression regex; ///< Compiled regex (only for GlobPattern) + }; + + /** + * @brief Parse a pattern string into ExcludePattern + * @param pattern Raw pattern string + * @return Parsed ExcludePattern structure + */ + static ExcludePattern parsePattern(const QString &pattern); + + /** + * @brief Check if a path matches a specific pattern + * @param absolutePath Path to check + * @param pattern Parsed pattern to match against + * @return true if path matches the pattern + */ + static bool matchPattern(const QString &absolutePath, const ExcludePattern &pattern); + + /** + * @brief Convert a glob pattern to QRegularExpression + * @param glob Glob pattern string (e.g., "build-*", "*.cache") + * @return Compiled regular expression + */ + static QRegularExpression globToRegex(const QString &glob); + + QList m_patterns; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // PATHEXCLUDEMATCHER_H diff --git a/src/index/utils/pinyinprocessor.cpp b/src/index/utils/pinyinprocessor.cpp new file mode 100644 index 00000000..149287cc --- /dev/null +++ b/src/index/utils/pinyinprocessor.cpp @@ -0,0 +1,186 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#include "pinyinprocessor.h" + +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +// 字典安装路径由 CMake 注入（PINYIN_DICT_INSTALL_DIR 与 install(FILES resources/pinyin.txt) +// 的 DESTINATION 同源，见 index/CMakeLists.txt）；此处仅为无编译定义时（IDE 解析、 +// 单独编译）的回退值，须与 debian 打包路径一致。 +#ifndef PINYIN_DICT_INSTALL_DIR +# define PINYIN_DICT_INSTALL_DIR "/usr/share/deepin-anything-index" +#endif + +constexpr char kDefaultPinyinDictPath[] { PINYIN_DICT_INSTALL_DIR "/pinyin.txt" }; + +// 码点 → 字典键（UTF-16 序列）：BMP 内为 1 个单元，CJK 扩展区等补充平面字符 +// 为 surrogate pair（2 个单元）。不可直接用码点构造 QChar（>0xFFFF 会触发断言）。 +QString codePointKey(uint codePoint) +{ + if (QChar::requiresSurrogates(codePoint)) { + QString key; + key += QChar(QChar::highSurrogate(codePoint)); + key += QChar(QChar::lowSurrogate(codePoint)); + return key; + } + return QString(QChar(codePoint)); +} + +} // namespace + +PinyinProcessor &PinyinProcessor::instance() +{ + static PinyinProcessor instance; + return instance; +} + +QStringList PinyinProcessor::dictionaryLookupPaths() +{ + // QStandardPaths::writableLocation(GenericDataLocation) 返回 XDG_DATA_HOME + // （未设置时默认 ~/.local/share） + return { + QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + + QStringLiteral("/deepin-anything-index/pinyin.txt"), + QString::fromLatin1(kDefaultPinyinDictPath) + }; +} + +PinyinProcessor::PinyinProcessor() +{ + for (const QString &path : dictionaryLookupPaths()) { + if (loadDictionary(path)) { + qInfo() << "PinyinProcessor: Dictionary loaded from:" << path; + break; + } + } +} + +bool PinyinProcessor::loadDictionary(const QString &path) +{ + QFile file(path); + if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) { + qWarning() << "PinyinProcessor: Failed to open pinyin dictionary:" << path; + m_loaded = false; + return false; + } + + // 字典格式（与 deepin-anything 一致）： + // U+3007: líng,yuán,xīng # 〇 + // 注释行以 '#' 开头；Unicode 码点（hex）→ 拼音列表（逗号分隔，含声调）；'#' 后为汉字注释。 + m_pinyinMap.clear(); // 支持重新加载（测试和配置切换场景） + QTextStream stream(&file); + while (!stream.atEnd()) { + const QString line = stream.readLine(); + if (line.size() < 2) + continue; + if (line[0] != 'U' && line[0] != 'u') + continue; + if (line[1] != '+') + continue; + + const int colonPos = line.indexOf(':'); + if (colonPos < 3) + continue; + + // 解析 Unicode 码点（十六进制） + bool ok = false; + const uint codePoint = line.mid(2, colonPos - 2).toUInt(&ok, 16); + if (!ok || codePoint == 0) + continue; + // 防御非法/超范围码点（字典可被用户目录覆盖，内容不受控）： + // 超出 Unicode 上限的行跳过，避免后续构造越界 + if (codePoint > QChar::LastValidCodePoint) + continue; + + // 取冒号后、'#' 前的拼音部分（'#' 可能不存在） + const int hashPos = line.indexOf('#', colonPos); + const QString pinyinStr = (hashPos > colonPos + ? line.mid(colonPos + 1, hashPos - colonPos - 1) + : line.mid(colonPos + 1)) + .trimmed(); + if (pinyinStr.isEmpty()) + continue; + + // 多音字取第一个（与 anything 的 it->second[0] 一致） + const QStringList pys = pinyinStr.split(',', Qt::SkipEmptyParts); + if (pys.isEmpty()) + continue; + + const QString first = removeTone(pys.first().trimmed()); + if (!first.isEmpty()) + m_pinyinMap.insert(codePointKey(codePoint), first); + } + + file.close(); + m_loaded = !m_pinyinMap.isEmpty(); + qInfo() << "PinyinProcessor: Loaded" << m_pinyinMap.size() << "pinyin entries from" << path; + return m_loaded; +} + +bool PinyinProcessor::isLoaded() const +{ + return m_loaded; +} + +void PinyinProcessor::convertToPinyin(const QString &fileName, + QString &pinyinFull, + QString &pinyinAcronym) const +{ + pinyinFull.clear(); + pinyinAcronym.clear(); + + if (!m_loaded || fileName.isEmpty()) + return; + + pinyinFull.reserve(fileName.size() * 6); + pinyinAcronym.reserve(fileName.size()); + + // 按码点（UTF-32）遍历：QChar 逐单元遍历会把补充平面字符（CJK 扩展区汉字） + // 拆成孤立代理项，无法命中字典。toUcs4 对无效代理序列替换为 U+FFFD，安全。 + const QList codePoints = fileName.toUcs4(); + for (const uint codePoint : codePoints) { + const QString key = codePointKey(codePoint); + auto it = m_pinyinMap.constFind(key); + if (it != m_pinyinMap.constEnd()) { + // 汉字：拼接去声调后的拼音 + pinyinFull += it.value(); + pinyinAcronym += it.value().at(0); + } else { + // 非字典字符（英文/数字/符号）：原样拼入，保持 anything 行为 + pinyinFull += key; + pinyinAcronym += key; + } + } + + // 整体小写化（anything 写入索引时 toLower） + pinyinFull = pinyinFull.toLower(); + pinyinAcronym = pinyinAcronym.toLower(); +} + +QString PinyinProcessor::removeTone(const QString &pinyin) const +{ + // 与 anything remove_tone 的 tone_map 完全一致 + static const QHash toneMap = { + { u'ā', u'a' }, { u'á', u'a' }, { u'ǎ', u'a' }, { u'à', u'a' }, { u'ē', u'e' }, { u'é', u'e' }, { u'ě', u'e' }, { u'è', u'e' }, { u'ī', u'i' }, { u'í', u'i' }, { u'ǐ', u'i' }, { u'ì', u'i' }, { u'ō', u'o' }, { u'ó', u'o' }, { u'ǒ', u'o' }, { u'ò', u'o' }, { u'ū', u'u' }, { u'ú', u'u' }, { u'ǔ', u'u' }, { u'ù', u'u' }, { u'ǖ', u'v' }, { u'ǘ', u'v' }, { u'ǚ', u'v' }, { u'ǜ', u'v' }, { u'ü', u'v' } + }; + + QString result; + result.reserve(pinyin.size()); + for (const QChar &ch : pinyin) { + auto it = toneMap.constFind(ch); + result += (it != toneMap.constEnd()) ? it.value() : ch; + } + return result; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/pinyinprocessor.h b/src/index/utils/pinyinprocessor.h new file mode 100644 index 00000000..2e17ce55 --- /dev/null +++ b/src/index/utils/pinyinprocessor.h @@ -0,0 +1,50 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef PINYINPROCESSOR_H +#define PINYINPROCESSOR_H + +#include "index_global.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class PinyinProcessor +{ +public: + static PinyinProcessor &instance(); + + // 字典查找顺序（依次尝试，首个加载成功的生效）： + // 1. XDG 用户数据目录：$XDG_DATA_HOME/deepin-anything-index/pinyin.txt + // （默认 ~/.local/share，支持 OEM/用户自定义覆盖） + // 2. 系统安装目录：PINYIN_DICT_INSTALL_DIR/pinyin.txt（路径由 CMake 注入） + static QStringList dictionaryLookupPaths(); + + bool loadDictionary(const QString &path); + bool isLoaded() const; + + // 将文件名转换为拼音全拼和首字母缩写（对齐 deepin-anything 的行为）： + // - 遍历每个 UTF-16 字符，在字典中找到的第一个汉字拼音（去声调）拼接进 pinyinFull， + // 其首字母拼接进 pinyinAcronym。 + // - 不在字典中的字符（英文、数字、符号）原样拼入两者（保持 anything 一致）。 + // - 输出整体小写化（与 anything 写入索引时 toLower 一致）。 + void convertToPinyin(const QString &fileName, + QString &pinyinFull, + QString &pinyinAcronym) const; + +private: + PinyinProcessor(); + + QString removeTone(const QString &pinyin) const; + + QHash m_pinyinMap; // 汉字（UTF-16，1 或 surrogate pair 2 个单元）→ 第一个拼音（已去声调） + bool m_loaded { false }; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // PINYINPROCESSOR_H diff --git a/src/index/utils/scopeguard.h b/src/index/utils/scopeguard.h new file mode 100644 index 00000000..7a33fa08 --- /dev/null +++ b/src/index/utils/scopeguard.h @@ -0,0 +1,35 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef SCOPEGUARD_H +#define SCOPEGUARD_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class ScopeGuard +{ +public: + explicit ScopeGuard(std::function onExit) + : m_exitFunc(std::move(onExit)), m_dismissed(false) { } + + ~ScopeGuard() + { + if (!m_dismissed && m_exitFunc) + m_exitFunc(); + } + + void dismiss() { m_dismissed = true; } + +private: + std::function m_exitFunc; + bool m_dismissed; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // SCOPEGUARD_H diff --git a/src/index/utils/systemdcpuutils.cpp b/src/index/utils/systemdcpuutils.cpp new file mode 100644 index 00000000..9cf00ef8 --- /dev/null +++ b/src/index/utils/systemdcpuutils.cpp @@ -0,0 +1,156 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#include "systemdcpuutils.h" + +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace { + +bool executeSystemctlCommand(const QStringList &arguments, QString *errorMsg) +{ + QProcess process; + QString command = "systemctl"; + + // 打印将要执行的命令，方便调试 + qDebug() << "SystemdCpuUtils: Executing command:" << command << arguments.join(" "); + + process.start(command, arguments); + + // 等待命令完成，设置一个超时时间（例如 5 秒） + if (!process.waitForFinished(5000)) { + *errorMsg = QString("Command timed out: %1 %2").arg(command, arguments.join(" ")); + if (process.state() == QProcess::Running) { + process.kill(); + process.waitForFinished(1000); // Give it a moment to die + } + return false; + } + + if (process.exitStatus() == QProcess::CrashExit) { + *errorMsg = QString("Command crashed: %1 %2").arg(command, arguments.join(" ")); + return false; + } + + if (process.exitCode() != 0) { + *errorMsg = QString("Command failed with exit code %1: %2 %3\nError: %4\nOutput: %5") + .arg(process.exitCode()) + .arg(command) + .arg(arguments.join(" ")) + .arg(QString::fromUtf8(process.readAllStandardError())) + .arg(QString::fromUtf8(process.readAllStandardOutput())); + return false; + } + + qDebug() << "SystemdCpuUtils: Command executed successfully"; + const QString output = QString::fromUtf8(process.readAllStandardOutput()); + if (!output.isEmpty()) { + qDebug() << "SystemdCpuUtils: Command output:" << output; + } + return true; +} + +} // anonymous namespace + +// 实现 SystemdCpuUtils 命名空间中的函数 +namespace SystemdCpuUtils { + +// 全局引用计数器：跟踪当前有多少个限制型任务(Light/Medium/Heavy)在运行。 +// 只有计数从 0→1 时才实际 setCpuQuota，从 1→0 时才实际 resetCpuQuota。 +// Manual 任务不改变计数器，仅在计数为 0 时才 reset。 +// +// 使用 mutex 而非裸原子计数器：TextIndex 和 OcrIndex 共享同一进程但各自有独立的 +// worker 线程，setCpuQuota/resetCpuQuota 调用必须在锁保护下进行，否则一个线程 +// 的 resetCpuQuota 可能覆盖另一个线程刚设置的 setCpuQuota，导致 CPU 限制失效。 +static std::mutex g_cpuQuotaMutex; +static int g_limitedTaskCount { 0 }; + +bool setCpuQuota(const QString &serviceName, int percentage, QString *errorMsg) +{ + Q_ASSERT(errorMsg); + + if (serviceName.isEmpty()) { + *errorMsg = "Service name cannot be empty."; + return false; + } + if (percentage < 0) { // systemd 允许 > 100%，但这里通常限制为非负 + *errorMsg = "Percentage must be non-negative."; + return false; + } + + QStringList arguments; + arguments << "--runtime" + << "--user" + << "set-property" + << serviceName + << QString("CPUQuota=%1%").arg(percentage); + + return executeSystemctlCommand(arguments, errorMsg); // 调用匿名命名空间中的辅助函数 +} + +bool resetCpuQuota(const QString &serviceName, QString *errorMsg) +{ + Q_ASSERT(errorMsg); + + if (serviceName.isEmpty()) { + *errorMsg = "Service name cannot be empty."; + return false; + } + + QStringList arguments; + arguments << "--runtime" + << "--user" + << "set-property" + << serviceName + << "CPUQuota="; // 设置为空字符串以取消限制 + + return executeSystemctlCommand(arguments, errorMsg); // 调用匿名命名空间中的辅助函数 +} + +void acquireCpuQuota(const QString &serviceName, int percentage) +{ + std::lock_guard lock(g_cpuQuotaMutex); + if (g_limitedTaskCount == 0) { + QString msg; + if (!setCpuQuota(serviceName, percentage, &msg)) { + qWarning() << "SystemdCpuUtils: acquireCpuQuota failed to set CPU quota:" << msg; + } + } + ++g_limitedTaskCount; +} + +void releaseCpuQuota(const QString &serviceName) +{ + std::lock_guard lock(g_cpuQuotaMutex); + if (g_limitedTaskCount <= 0) { + qWarning() << "SystemdCpuUtils: releaseCpuQuota called with no active limited tasks"; + return; + } + --g_limitedTaskCount; + if (g_limitedTaskCount == 0) { + QString msg; + if (!resetCpuQuota(serviceName, &msg)) { + qWarning() << "SystemdCpuUtils: releaseCpuQuota failed to reset CPU quota:" << msg; + } + } +} + +void manualTaskCpuQuota(const QString &serviceName) +{ + std::lock_guard lock(g_cpuQuotaMutex); + if (g_limitedTaskCount == 0) { + QString msg; + if (!resetCpuQuota(serviceName, &msg)) { + qWarning() << "SystemdCpuUtils: manualTaskCpuQuota failed to reset CPU quota:" << msg; + } + } +} + +} // namespace SystemdCpuUtils + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/systemdcpuutils.h b/src/index/utils/systemdcpuutils.h new file mode 100644 index 00000000..373ee393 --- /dev/null +++ b/src/index/utils/systemdcpuutils.h @@ -0,0 +1,58 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#ifndef SYSTEMDCPUUTILS_H +#define SYSTEMDCPUUTILS_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace SystemdCpuUtils { + +/** + * @brief Sets CPU quota for a specified systemd user service. + * @param serviceName Full service name (e.g. "deepin-service-plugin@org.deepin.Filemanager.TextIndex.service") + * @param percentage CPU quota percentage (e.g. 50 for 50% limit) + * @param[out] errorMsg If execution fails, contains the error message + * @return Returns true if command executed successfully, false otherwise + */ +bool setCpuQuota(const QString &serviceName, int percentage, QString *errorMsg); + +/** + * @brief Removes CPU quota restrictions for a specified systemd user service. + * @param serviceName Full service name + * @param[out] errorMsg If execution fails, contains the error message + * @return Returns true if command executed successfully, false otherwise + */ +bool resetCpuQuota(const QString &serviceName, QString *errorMsg); + +/** + * @brief Acquires a CPU quota slot for a limited task (Light/Medium/Heavy). + * Uses an atomic reference counter: only the first caller actually sets the quota. + * @param serviceName Full service name + * @param percentage CPU quota percentage + */ +void acquireCpuQuota(const QString &serviceName, int percentage); + +/** + * @brief Releases a CPU quota slot for a limited task. + * Only the last caller (counter drops to 0) actually resets the quota. + * @param serviceName Full service name + */ +void releaseCpuQuota(const QString &serviceName); + +/** + * @brief Handles CPU quota for a Manual task (start or finish). + * Resets the quota only when no limited tasks are running. + * @param serviceName Full service name + */ +void manualTaskCpuQuota(const QString &serviceName); + +} // namespace SystemdCpuUtils + +ANYTHING_INDEX_END_NAMESPACE + +#endif // SYSTEMDCPUUTILS_H diff --git a/src/index/utils/taskstate.h b/src/index/utils/taskstate.h new file mode 100644 index 00000000..ebf216e5 --- /dev/null +++ b/src/index/utils/taskstate.h @@ -0,0 +1,58 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later + +#ifndef TASKSTATE_H +#define TASKSTATE_H + +#include "index_global.h" + +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +class TaskState +{ +public: + TaskState() : m_running(false), m_pauseRequested(false) { } + + bool isRunning() const + { + return m_running.loadAcquire(); + } + + void start() + { + m_running.storeRelease(true); + } + + void stop() + { + m_running.storeRelease(false); + } + + void requestPause() + { + m_pauseRequested.storeRelease(true); + } + + bool isPauseRequested() const + { + return m_pauseRequested.loadAcquire(); + } + + void clearPauseRequest() + { + m_pauseRequested.storeRelease(false); + } + +private: + QAtomicInteger m_running; + QAtomicInteger m_pauseRequested; +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // TASKSTATE_H diff --git a/src/index/utils/textindexconfig.cpp b/src/index/utils/textindexconfig.cpp new file mode 100644 index 00000000..1e3f7629 --- /dev/null +++ b/src/index/utils/textindexconfig.cpp @@ -0,0 +1,364 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#include "textindexconfig.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +TextIndexConfig &TextIndexConfig::instance() +{ + static TextIndexConfig self; + return self; +} + +TextIndexConfig::TextIndexConfig(QObject *parent) + : QObject(parent), + m_dconfig(Dtk::Core::DConfig::create("org.deepin.dde.file-manager", + Defines::DConf::kTextIndexSchema, + QString(), this)) +{ + if (!m_dconfig || !m_dconfig->isValid()) + qWarning() << "TextIndexConfig: Failed to load DConfig schema:" << Defines::DConf::kTextIndexSchema; + + if (m_dconfig) { + loadAllConfigs(); + setupConnections(); + } +} + +void TextIndexConfig::setupConnections() +{ + // Connect to DConfig's signal for changes in our schema + // This allows automatic reloading if the config is changed externally (e.g., by dconf-editor) + connect(m_dconfig, &Dtk::Core::DConfig::valueChanged, this, + [this](const QString &key) { + qDebug() << "TextIndexConfig: DConfig changed key:" << key; + // Reloading all is simpler and often acceptable. + loadAllConfigs(); + emit configChanged(); + }); +} + +void TextIndexConfig::loadAllConfigs() +{ + QMutexLocker locker(&m_mutex); + qDebug() << "TextIndexConfig: Loading text index configurations"; + + // Auto Index Update Interval (FSEventCollector event collection interval) + m_autoIndexUpdateInterval = m_dconfig->value( + Defines::DConf::kAutoIndexUpdateInterval, + DEFAULT_AUTO_INDEX_UPDATE_INTERVAL) + .toInt(); + // Validate autoIndexUpdateInterval + if (m_autoIndexUpdateInterval < 1 || m_autoIndexUpdateInterval > 3600) { + qWarning() << "TextIndexConfig: Invalid autoIndexUpdateInterval value:" << m_autoIndexUpdateInterval + << ", using default:" << DEFAULT_AUTO_INDEX_UPDATE_INTERVAL; + m_autoIndexUpdateInterval = DEFAULT_AUTO_INDEX_UPDATE_INTERVAL; + } + + // Monitoring Start Delay (FSEventController monitoring start delay) + m_monitoringStartDelaySeconds = m_dconfig->value( + Defines::DConf::kMonitoringStartDelaySeconds, + DEFAULT_MONITORING_START_DELAY_SECONDS) + .toInt(); + // Validate monitoringStartDelaySeconds + if (m_monitoringStartDelaySeconds < 0 || m_monitoringStartDelaySeconds > 3600) { + qWarning() << "TextIndexConfig: Invalid monitoringStartDelaySeconds value:" << m_monitoringStartDelaySeconds + << ", using default:" << DEFAULT_MONITORING_START_DELAY_SECONDS; + m_monitoringStartDelaySeconds = DEFAULT_MONITORING_START_DELAY_SECONDS; + } + + // Silent Index Update Delay (FSEventController first start delay) + m_silentIndexUpdateDelay = m_dconfig->value( + Defines::DConf::kSilentIndexUpdateDelay, + DEFAULT_SILENT_INDEX_UPDATE_DELAY) + .toInt(); + // Validate silentIndexUpdateDelay + if (m_silentIndexUpdateDelay < 1 || m_silentIndexUpdateDelay > 3600) { + qWarning() << "TextIndexConfig: Invalid silentIndexUpdateDelay value:" << m_silentIndexUpdateDelay + << ", using default:" << DEFAULT_SILENT_INDEX_UPDATE_DELAY; + m_silentIndexUpdateDelay = DEFAULT_SILENT_INDEX_UPDATE_DELAY; + } + + // Inotify Resource Cleanup Delay + m_inotifyResourceCleanupDelayMs = m_dconfig->value( + Defines::DConf::kInotifyResourceCleanupDelay, // Ensure this matches JSON and Defines.h + DEFAULT_INOTIFY_RESOURCE_CLEANUP_DELAY) + .toLongLong(); + + // Max Index File Size MB + m_maxIndexTextFileSizeMB = m_dconfig->value( + Defines::DConf::kMaxIndexTextFileSizeMB, + DEFAULT_MAX_INDEX_FILE_SIZE_MB) + .toInt(); + + // Max Index File Truncation Size MB + m_maxIndexFileTruncationSizeMB = m_dconfig->value( + Defines::DConf::kMaxIndexFileTruncationSizeMB, + DEFAULT_MAX_INDEX_FILE_TRUNCATION_SIZE_MB) + .toInt(); + // Validate and apply default if value is invalid (negative, zero, or too large) + if (m_maxIndexFileTruncationSizeMB <= 0 || m_maxIndexFileTruncationSizeMB > 1024) { + qWarning() << "TextIndexConfig: Invalid maxIndexFileTruncationSizeMB value:" << m_maxIndexFileTruncationSizeMB << ", using default:" << DEFAULT_MAX_INDEX_FILE_TRUNCATION_SIZE_MB; + m_maxIndexFileTruncationSizeMB = DEFAULT_MAX_INDEX_FILE_TRUNCATION_SIZE_MB; + } + + // Supported File Extensions + const QStringList defaultSupportedExtensions = { + "rtf", "odt", "ods", "odp", "odg", "docx", + "xlsx", "pptx", "ppsx", "md", "xls", "xlsb", + "doc", "dot", "wps", "ppt", "pps", "txt", + "pdf", "dps", "sh", "html", "htm", "xml", + "xhtml", "dhtml", "shtm", "shtml", "json", + "css", "yaml", "ini", "bat", "js", "sql", + "uof", "ofd" + }; + m_supportedTextFileExtensions = m_dconfig->value( + Defines::DConf::kSupportedTextFileExtensions, + QVariant::fromValue(defaultSupportedExtensions)) // Pass QVariant holding QStringList + .toStringList(); + + const QStringList defaultSupportedOcrImageExtensions = { + "ani", "bmp", "jpe", "jpeg", "jpg", "pcx", "png", "psd", + "tga", "tif", "tiff", "webp", "wmf", "heic", "heif", "raw" + }; + m_supportedOcrImageExtensions = m_dconfig->value( + QStringLiteral("supportedOcrImageExtensions"), + QVariant::fromValue(defaultSupportedOcrImageExtensions)) + .toStringList(); + + m_maxOcrImageSizeMB = m_dconfig->value( + QStringLiteral("maxOcrImageSizeMB"), + DEFAULT_MAX_OCR_IMAGE_SIZE_MB) + .toInt(); + if (m_maxOcrImageSizeMB <= 0 || m_maxOcrImageSizeMB > 1024) { + qWarning() << "TextIndexConfig: Invalid maxOcrImageSizeMB value:" << m_maxOcrImageSizeMB + << ", using default:" << DEFAULT_MAX_OCR_IMAGE_SIZE_MB; + m_maxOcrImageSizeMB = DEFAULT_MAX_OCR_IMAGE_SIZE_MB; + } + + // Index Hidden Files + m_indexHiddenFiles = m_dconfig->value( + Defines::DConf::kIndexHiddenFiles, + DEFAULT_INDEX_HIDDEN_FILES) + .toBool(); + + // Folder Exclude Filters + const QStringList defaultFolderExcludeFilters = { + ".git", ".svn", ".hg", ".cache", ".local/share/Trash", ".Trash", + ".thumbnails", "thumbnails", ".mozilla", "CMakeFiles", + "CMakeTmp", "CMakeTmpQmake", "lost+found" + }; + m_folderExcludeFilters = m_dconfig->value( + Defines::DConf::kFolderExcludeFilters, + QVariant::fromValue(defaultFolderExcludeFilters)) // Pass QVariant holding QStringList + .toStringList(); + + // CPU isage limit percent + m_cpuUsageLimitPercent = m_dconfig->value( + Defines::DConf::kCpuUsageLimitPercent, + DEFAULT_CPU_USAGE_LIMIT_PERCENT) + .toInt(); + if (m_cpuUsageLimitPercent < 10 || m_cpuUsageLimitPercent >= 100) { + m_cpuUsageLimitPercent = DEFAULT_CPU_USAGE_LIMIT_PERCENT; + } + + // Inotify watches coefficient + m_inotifyWatchesCoefficient = m_dconfig->value( + Defines::DConf::kInotifyWatchesCoefficient, + DEFAULT_INOTIFY_WATCHES_COEFFICIENT) + .toDouble(); + if (m_inotifyWatchesCoefficient < 0.1 || m_inotifyWatchesCoefficient > 1.0) { + m_inotifyWatchesCoefficient = DEFAULT_INOTIFY_WATCHES_COEFFICIENT; + } + + // Batch commit interval + m_batchCommitInterval = m_dconfig->value( + Defines::DConf::kBatchCommitInterval, + DEFAULT_BATCH_COMMIT_INTERVAL) + .toInt(); + if (m_batchCommitInterval < 100 || m_batchCommitInterval > 10000) { + m_batchCommitInterval = DEFAULT_BATCH_COMMIT_INTERVAL; + } + + // --- Strategy optimization config keys (environment detection) --- + + m_idleThresholdSeconds = m_dconfig->value(Defines::DConf::kIdleThresholdSeconds, + DEFAULT_IDLE_THRESHOLD_SECONDS).toInt(); + if (m_idleThresholdSeconds < 5 || m_idleThresholdSeconds > 600) + m_idleThresholdSeconds = DEFAULT_IDLE_THRESHOLD_SECONDS; + + m_loadSampleIntervalSeconds = m_dconfig->value(Defines::DConf::kLoadSampleIntervalSeconds, + DEFAULT_LOAD_SAMPLE_INTERVAL_SECONDS).toInt(); + if (m_loadSampleIntervalSeconds < 1 || m_loadSampleIntervalSeconds > 60) + m_loadSampleIntervalSeconds = DEFAULT_LOAD_SAMPLE_INTERVAL_SECONDS; + + m_cpuLoadThresholdPercent = m_dconfig->value(Defines::DConf::kCpuLoadThresholdPercent, + DEFAULT_CPU_LOAD_THRESHOLD_PERCENT).toInt(); + if (m_cpuLoadThresholdPercent < 1 || m_cpuLoadThresholdPercent > 100) + m_cpuLoadThresholdPercent = DEFAULT_CPU_LOAD_THRESHOLD_PERCENT; + + m_diskBusyThresholdPercent = m_dconfig->value(Defines::DConf::kDiskBusyThresholdPercent, + DEFAULT_DISK_BUSY_THRESHOLD_PERCENT).toInt(); + if (m_diskBusyThresholdPercent < 1 || m_diskBusyThresholdPercent > 100) + m_diskBusyThresholdPercent = DEFAULT_DISK_BUSY_THRESHOLD_PERCENT; + + // --- Strategy optimization config keys (task grading thresholds) --- + + m_lightIncrementFileCountThreshold = m_dconfig->value(Defines::DConf::kLightIncrementFileCountThreshold, + DEFAULT_LIGHT_INCREMENT_FILE_COUNT_THRESHOLD).toInt(); + if (m_lightIncrementFileCountThreshold < 1 || m_lightIncrementFileCountThreshold > 100000) + m_lightIncrementFileCountThreshold = DEFAULT_LIGHT_INCREMENT_FILE_COUNT_THRESHOLD; + + m_lightIncrementOcrFileCountThreshold = m_dconfig->value(Defines::DConf::kLightIncrementOcrFileCountThreshold, + DEFAULT_LIGHT_INCREMENT_OCR_FILE_COUNT_THRESHOLD).toInt(); + if (m_lightIncrementOcrFileCountThreshold < 1 || m_lightIncrementOcrFileCountThreshold > 100000) + m_lightIncrementOcrFileCountThreshold = DEFAULT_LIGHT_INCREMENT_OCR_FILE_COUNT_THRESHOLD; + + m_lightIncrementSizeThresholdMB = m_dconfig->value(Defines::DConf::kLightIncrementSizeThresholdMB, + DEFAULT_LIGHT_INCREMENT_SIZE_THRESHOLD_MB).toLongLong(); + if (m_lightIncrementSizeThresholdMB < 1 || m_lightIncrementSizeThresholdMB > 10240) + m_lightIncrementSizeThresholdMB = DEFAULT_LIGHT_INCREMENT_SIZE_THRESHOLD_MB; + + qDebug() << "TextIndexConfig: Text index configurations loaded successfully"; + // You might want to print the loaded values here for debugging if needed + // qDebug() << "AutoIndexUpdateInterval:" << m_autoIndexUpdateInterval; + // ... and so on +} + +void TextIndexConfig::reloadConfig() +{ + loadAllConfigs(); + emit configChanged(); +} + +// --- Getter Implementations --- +int TextIndexConfig::autoIndexUpdateInterval() const +{ + QMutexLocker locker(&m_mutex); + return m_autoIndexUpdateInterval; +} + +int TextIndexConfig::monitoringStartDelaySeconds() const +{ + QMutexLocker locker(&m_mutex); + return m_monitoringStartDelaySeconds; +} + +int TextIndexConfig::silentIndexUpdateDelay() const +{ + QMutexLocker locker(&m_mutex); + return m_silentIndexUpdateDelay; +} + +qint64 TextIndexConfig::inotifyResourceCleanupDelayMs() const +{ + QMutexLocker locker(&m_mutex); + return m_inotifyResourceCleanupDelayMs; +} + +int TextIndexConfig::maxIndexTextFileSizeMB() const +{ + QMutexLocker locker(&m_mutex); + return m_maxIndexTextFileSizeMB; +} + +int TextIndexConfig::maxIndexFileTruncationSizeMB() const +{ + QMutexLocker locker(&m_mutex); + return m_maxIndexFileTruncationSizeMB; +} + +QStringList TextIndexConfig::supportedTextFileExtensions() const +{ + QMutexLocker locker(&m_mutex); + return m_supportedTextFileExtensions; +} + +QStringList TextIndexConfig::supportedOcrImageExtensions() const +{ + QMutexLocker locker(&m_mutex); + return m_supportedOcrImageExtensions; +} + +int TextIndexConfig::maxOcrImageSizeMB() const +{ + QMutexLocker locker(&m_mutex); + return m_maxOcrImageSizeMB; +} + +bool TextIndexConfig::indexHiddenFiles() const +{ + QMutexLocker locker(&m_mutex); + return m_indexHiddenFiles; +} + +QStringList TextIndexConfig::folderExcludeFilters() const +{ + QMutexLocker locker(&m_mutex); + return m_folderExcludeFilters; +} + +int TextIndexConfig::cpuUsageLimitPercent() const +{ + QMutexLocker locker(&m_mutex); + return m_cpuUsageLimitPercent; +} + +double TextIndexConfig::inotifyWatchesCoefficient() const +{ + QMutexLocker locker(&m_mutex); + return m_inotifyWatchesCoefficient; +} + +int TextIndexConfig::batchCommitInterval() const +{ + QMutexLocker locker(&m_mutex); + return m_batchCommitInterval; +} + +int TextIndexConfig::idleThresholdSeconds() const +{ + QMutexLocker locker(&m_mutex); + return m_idleThresholdSeconds; +} + +int TextIndexConfig::loadSampleIntervalSeconds() const +{ + QMutexLocker locker(&m_mutex); + return m_loadSampleIntervalSeconds; +} + +int TextIndexConfig::cpuLoadThresholdPercent() const +{ + QMutexLocker locker(&m_mutex); + return m_cpuLoadThresholdPercent; +} + +int TextIndexConfig::diskBusyThresholdPercent() const +{ + QMutexLocker locker(&m_mutex); + return m_diskBusyThresholdPercent; +} + +int TextIndexConfig::lightIncrementFileCountThreshold() const +{ + QMutexLocker locker(&m_mutex); + return m_lightIncrementFileCountThreshold; +} + +int TextIndexConfig::lightIncrementOcrFileCountThreshold() const +{ + QMutexLocker locker(&m_mutex); + return m_lightIncrementOcrFileCountThreshold; +} + +qint64 TextIndexConfig::lightIncrementSizeThresholdMB() const +{ + QMutexLocker locker(&m_mutex); + return m_lightIncrementSizeThresholdMB; +} + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/textindexconfig.h b/src/index/utils/textindexconfig.h new file mode 100644 index 00000000..004fbb9f --- /dev/null +++ b/src/index/utils/textindexconfig.h @@ -0,0 +1,120 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#ifndef TEXTINDEXCONFIG_H +#define TEXTINDEXCONFIG_H + +#include "index_global.h" + +#include + +#include +#include +#include +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE +class TextIndexConfig : public QObject +{ + Q_OBJECT + Q_DISABLE_COPY_MOVE(TextIndexConfig) + +public: + static TextIndexConfig &instance(); + + // Getter methods for each configuration + int autoIndexUpdateInterval() const; + int monitoringStartDelaySeconds() const; + int silentIndexUpdateDelay() const; + qint64 inotifyResourceCleanupDelayMs() const; + int maxIndexTextFileSizeMB() const; + int maxIndexFileTruncationSizeMB() const; + QStringList supportedTextFileExtensions() const; + QStringList supportedOcrImageExtensions() const; + int maxOcrImageSizeMB() const; + bool indexHiddenFiles() const; + QStringList folderExcludeFilters() const; + int cpuUsageLimitPercent() const; + double inotifyWatchesCoefficient() const; + int batchCommitInterval() const; + + // Strategy optimization – environment detection + int idleThresholdSeconds() const; + int loadSampleIntervalSeconds() const; + int cpuLoadThresholdPercent() const; + int diskBusyThresholdPercent() const; + + // Strategy optimization – task grading thresholds + int lightIncrementFileCountThreshold() const; + int lightIncrementOcrFileCountThreshold() const; + qint64 lightIncrementSizeThresholdMB() const; + + // Call this if you need to manually reload all configurations + Q_INVOKABLE void reloadConfig(); + +signals: + void configChanged(); // Emitted after configurations are reloaded + +private: + explicit TextIndexConfig(QObject *parent = nullptr); + ~TextIndexConfig() override = default; + + void loadAllConfigs(); + void setupConnections(); + + Dtk::Core::DConfig *m_dconfig = nullptr; + + // Member variables to store the loaded configuration values + int m_autoIndexUpdateInterval; + int m_monitoringStartDelaySeconds; + int m_silentIndexUpdateDelay; + qint64 m_inotifyResourceCleanupDelayMs; + int m_maxIndexTextFileSizeMB; + int m_maxIndexFileTruncationSizeMB; + QStringList m_supportedTextFileExtensions; + QStringList m_supportedOcrImageExtensions; + int m_maxOcrImageSizeMB; + bool m_indexHiddenFiles; + QStringList m_folderExcludeFilters; + int m_cpuUsageLimitPercent; + double m_inotifyWatchesCoefficient; + int m_batchCommitInterval; + + int m_idleThresholdSeconds { 30 }; + int m_loadSampleIntervalSeconds { 5 }; + int m_cpuLoadThresholdPercent { 30 }; + int m_diskBusyThresholdPercent { 50 }; + + int m_lightIncrementFileCountThreshold { 100 }; + int m_lightIncrementOcrFileCountThreshold { 30 }; + qint64 m_lightIncrementSizeThresholdMB { 200 }; + + mutable QMutex m_mutex; + + // Default values (matching your JSON for robustness) + static const int DEFAULT_AUTO_INDEX_UPDATE_INTERVAL = 3; + static const int DEFAULT_MONITORING_START_DELAY_SECONDS = 30; + static const int DEFAULT_SILENT_INDEX_UPDATE_DELAY = 180; + static const qint64 DEFAULT_INOTIFY_RESOURCE_CLEANUP_DELAY = 1800000LL; // 30 * 60 * 1000 + static const int DEFAULT_MAX_INDEX_FILE_SIZE_MB = 50; + static const int DEFAULT_MAX_INDEX_FILE_TRUNCATION_SIZE_MB = 10; + static const int DEFAULT_MAX_OCR_IMAGE_SIZE_MB = 30; + static const bool DEFAULT_INDEX_HIDDEN_FILES = false; + static const int DEFAULT_CPU_USAGE_LIMIT_PERCENT = 50; + static constexpr double DEFAULT_INOTIFY_WATCHES_COEFFICIENT = 0.5; + static const int DEFAULT_BATCH_COMMIT_INTERVAL = 1000; + static const int DEFAULT_IDLE_THRESHOLD_SECONDS = 30; + static const int DEFAULT_LOAD_SAMPLE_INTERVAL_SECONDS = 5; + static const int DEFAULT_CPU_LOAD_THRESHOLD_PERCENT = 30; + static const int DEFAULT_DISK_BUSY_THRESHOLD_PERCENT = 50; + static const int DEFAULT_LIGHT_INCREMENT_FILE_COUNT_THRESHOLD = 100; + static const int DEFAULT_LIGHT_INCREMENT_OCR_FILE_COUNT_THRESHOLD = 30; + static const qint64 DEFAULT_LIGHT_INCREMENT_SIZE_THRESHOLD_MB = 200; + // Default QStringLists need to be initialized in the .cpp or constructor + // For simplicity here, we'll define them directly in loadAllConfigs logic +}; + +ANYTHING_INDEX_END_NAMESPACE + +#endif // TEXTINDEXCONFIG_H diff --git a/src/index/utils/threadscheduling.cpp b/src/index/utils/threadscheduling.cpp new file mode 100644 index 00000000..009c691c --- /dev/null +++ b/src/index/utils/threadscheduling.cpp @@ -0,0 +1,30 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#include "threadscheduling.h" + +#include + +#include +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace ThreadScheduling { + +bool setSelfSchedulerIdle(QString *errorMsg) +{ + sched_param param {}; + if (sched_setscheduler(0, SCHED_IDLE, ¶m) != 0) { + if (errorMsg) { + *errorMsg = QString("sched_setscheduler(SCHED_IDLE) failed: %1") + .arg(QString::fromUtf8(std::strerror(errno))); + } + return false; + } + return true; +} + +} // namespace ThreadScheduling + +ANYTHING_INDEX_END_NAMESPACE diff --git a/src/index/utils/threadscheduling.h b/src/index/utils/threadscheduling.h new file mode 100644 index 00000000..d87c5e99 --- /dev/null +++ b/src/index/utils/threadscheduling.h @@ -0,0 +1,35 @@ +// SPDX-FileCopyrightText: 2026 UnionTech Software Technology Co., Ltd. +// +// SPDX-License-Identifier: GPL-3.0-or-later +#ifndef THREADSCHEDULING_H +#define THREADSCHEDULING_H + +#include "index_global.h" + +#include + +ANYTHING_INDEX_BEGIN_NAMESPACE + +namespace ThreadScheduling { + +/** + * @brief 把调用线程标记为 SCHED_IDLE（Linux 无特权即可设置）。 + * + * SCHED_IDLE 线程拥有最低的调度权重：只要系统里还有普通线程想用 CPU， + * 它就不参与竞争，仅在网络/磁盘空闲时推进。用于重索引 worker 线程， + * 使同进程内的实时性线程（如 VfsMonitor 的 socket 读线程）在任务运行 + * 期间（尤其整个服务被 systemd CPUQuota 限流的场景）仍能分到配额。 + * + * sched_setscheduler(0, ...) 只作用于调用线程本身，对进程其他线程无影响； + * 设置随线程生命周期保持，线程退出后自然失效。 + * + * @param[out] errorMsg 失败时的错误信息（errno 文本） + * @return true 表示当前线程已处于 SCHED_IDLE + */ +bool setSelfSchedulerIdle(QString *errorMsg); + +} // namespace ThreadScheduling + +ANYTHING_INDEX_END_NAMESPACE + +#endif // THREADSCHEDULING_H diff --git a/src/kernelmod/CMakeLists.txt b/src/kernelmod/CMakeLists.txt index 7581b23c..6e471633 100644 --- a/src/kernelmod/CMakeLists.txt +++ b/src/kernelmod/CMakeLists.txt @@ -9,7 +9,7 @@ endif() set(package_name "deepin-anything-${PROJECT_VERSION}") -set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99 -Wall -O3") +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu99 -Wall -Wextra -pedantic -Werror -O3") # Set the source files # set(SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/*) diff --git a/src/logger/CMakeLists.txt b/src/logger/CMakeLists.txt index 1912440a..2be6968d 100644 --- a/src/logger/CMakeLists.txt +++ b/src/logger/CMakeLists.txt @@ -2,6 +2,9 @@ cmake_minimum_required(VERSION 3.10) project(deepin-anything-logger C) +add_compile_options(-Wall -Wextra -pedantic -Werror) + + set(CMAKE_C_STANDARD 11) set(CMAKE_C_STANDARD_REQUIRED ON) diff --git a/src/server/CMakeLists.txt b/src/server/CMakeLists.txt index cc287e33..18bed4e3 100644 --- a/src/server/CMakeLists.txt +++ b/src/server/CMakeLists.txt @@ -2,6 +2,9 @@ cmake_minimum_required(VERSION 3.1) project(deepin-anything-server) +add_compile_options(-Wall -Wextra -pedantic -Werror) + + find_package(PkgConfig REQUIRED) pkg_check_modules(GLIB REQUIRED glib-2.0) pkg_check_modules(GIO REQUIRED gio-2.0)