Sign Up
Log In
Log In
or
Sign Up
Places
All Projects
Status Monitor
Collapse sidebar
KDE:Unstable:Applications
kmbox
_service:obs_scm:kmbox-VERSIONgit.20240918T0705...
Overview
Repositories
Revisions
Requests
Users
Attributes
Meta
File _service:obs_scm:kmbox-VERSIONgit.20240918T070510~e8f0e88.obscpio of Package kmbox
07070100000000000081A400000000000000000000000166EA5F8600000071000000000000000000000000000000000000003600000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.codespellrc[codespell] skip = ./build*,.git,*.notifyrc,*.desktop,*.json,*.xml interactive = 3 ignore-words-list = accessort 07070100000001000081A400000000000000000000000166EA5F8600000067000000000000000000000000000000000000003E00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.codespellrc.license# SPDX-FileCopyrightText: 2022-2024 Laurent Montel <montel@kde.org> # SPDX-License-Identifier: CC0-1.0 07070100000002000081A400000000000000000000000166EA5F86000000A3000000000000000000000000000000000000004000000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.git-blame-ignore-revs# SPDX-License-Identifier: CC0-1.0 # SPDX-FileCopyrightText: none # clang-format f18008304349f55a7bf2f03057bfeee90a942fbc 9dc10569768a228c38b200ac76a0f5cfe55d33a7 07070100000003000081A400000000000000000000000166EA5F8600000172000000000000000000000000000000000000003400000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.gitignore# SPDX-License-Identifier: CC0-1.0 # SPDX-FileCopyrightText: none # Ignore the following files *~ *.[oa] *.diff *.kate-swp *.kdev4 .kdev_include_paths *.kdevelop.pcs *.moc *.moc.cpp *.orig *.user .*.swp .swp.* Doxyfile Makefile /build*/ .cmake/ CMakeLists.txt.user* *.unc-backup* compile_commands.json .clang-format .clangd .idea /cmake-build* .cache Testing/ /.vscode/ 07070100000004000081A400000000000000000000000166EA5F86000001E8000000000000000000000000000000000000003800000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.gitlab-ci.yml# SPDX-FileCopyrightText: 2020-2024 Laurent Montel <montel@kde.org> # SPDX-License-Identifier: CC0-1.0 include: - project: sysadmin/ci-utilities file: - /gitlab-templates/linux-qt6.yml - /gitlab-templates/freebsd-qt6.yml - /gitlab-templates/windows-qt6.yml - /gitlab-templates/reuse-lint.yml - /gitlab-templates/android-qt6.yml - /gitlab-templates/cppcheck.yml - /gitlab-templates/clang-format.yml - /gitlab-templates/alpine-qt6.yml 07070100000005000081A400000000000000000000000166EA5F8600000127000000000000000000000000000000000000003500000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.kde-ci.yml# SPDX-FileCopyrightText: None # SPDX-License-Identifier: CC0-1.0 Dependencies: - 'on': ['Linux', 'FreeBSD', 'Windows', 'Android'] 'require': 'frameworks/extra-cmake-modules': '@latest-kf6' 'pim/kmime' : '@same' Options: require-passing-tests-on: [ 'Linux', 'FreeBSD', 'Windows' ] 07070100000006000081A400000000000000000000000166EA5F8600000033000000000000000000000000000000000000003000000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.krazySKIP /tests/ EXTRA tipsandthis,defines,qenums,null 07070100000007000081A400000000000000000000000166EA5F860000003E000000000000000000000000000000000000003800000000kmbox-VERSIONgit.20240918T070510~e8f0e88/.krazy.licenseSPDX-FileCopyrightText: none SPDX-License-Identifier: CC0-1.0 07070100000008000081A400000000000000000000000166EA5F8600000C3D000000000000000000000000000000000000003800000000kmbox-VERSIONgit.20240918T070510~e8f0e88/CMakeLists.txt# SPDX-FileCopyrightText: none # SPDX-License-Identifier: BSD-3-Clause cmake_minimum_required(VERSION 3.16 FATAL_ERROR) set(PIM_VERSION "6.2.40") project(KMbox VERSION ${PIM_VERSION}) # ECM setup set(KF_MIN_VERSION "6.6.0") set(QT_REQUIRED_VERSION "6.7.0") find_package(ECM ${KF_MIN_VERSION} CONFIG REQUIRED) set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH}) include(KDEInstallDirs) include(KDECMakeSettings) include(KDECompilerSettings NO_POLICY_SCOPE) include(ECMGenerateExportHeader) include(ECMGenerateHeaders) include(ECMSetupVersion) include(FeatureSummary) include(KDEGitCommitHooks) include(KDEClangFormat) file(GLOB_RECURSE ALL_CLANG_FORMAT_SOURCE_FILES *.cpp *.h *.c) kde_clang_format(${ALL_CLANG_FORMAT_SOURCE_FILES}) include(ECMQtDeclareLoggingCategory) include(ECMDeprecationSettings) include(ECMFeatureSummary) include(ECMAddQch) set(KMBOX_LIB_VERSION ${PIM_VERSION}) set(KMIME_LIB_VERSION "6.2.40") option(BUILD_QCH "Build API documentation in QCH format (for e.g. Qt Assistant, Qt Creator & KDevelop)" OFF) add_feature_info(QCH ${BUILD_QCH} "API documentation in QCH format (for e.g. Qt Assistant, Qt Creator & KDevelop)") ecm_setup_version(PROJECT VARIABLE_PREFIX KMBOX VERSION_HEADER "${CMAKE_CURRENT_BINARY_DIR}/src/kmbox_version.h" PACKAGE_VERSION_FILE "${CMAKE_CURRENT_BINARY_DIR}/KPim6MboxConfigVersion.cmake" SOVERSION 6 ) ########### Find packages ########### find_package(KPim6Mime ${KMIME_LIB_VERSION} CONFIG REQUIRED) add_definitions(-DQT_NO_CONTEXTLESS_CONNECT) ecm_set_disabled_deprecation_versions(QT 6.7.2 KF 6.7.0) option(USE_UNITY_CMAKE_SUPPORT "Use UNITY cmake support (speedup compile time)" OFF) set(COMPILE_WITH_UNITY_CMAKE_SUPPORT OFF) if(USE_UNITY_CMAKE_SUPPORT) set(COMPILE_WITH_UNITY_CMAKE_SUPPORT ON) endif() ########### Targets ########### add_subdirectory(src) if(BUILD_TESTING) add_subdirectory(autotests) endif() ########### CMake Config Files ########### set(CMAKECONFIG_INSTALL_DIR "${KDE_INSTALL_CMAKEPACKAGEDIR}/KPim6Mbox") if(BUILD_QCH) ecm_install_qch_export( TARGETS KPim6Mbox_QCH FILE KPim6MBoxQchTargets.cmake DESTINATION "${CMAKECONFIG_INSTALL_DIR}" COMPONENT Devel ) set(PACKAGE_INCLUDE_QCHTARGETS "include(\"\${CMAKE_CURRENT_LIST_DIR}/KPim6MBoxQchTargets.cmake\")") endif() configure_package_config_file( "${CMAKE_CURRENT_SOURCE_DIR}/KPimMboxConfig.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/KPim6MboxConfig.cmake" INSTALL_DESTINATION ${CMAKECONFIG_INSTALL_DIR} ) install(FILES "${CMAKE_CURRENT_BINARY_DIR}/KPim6MboxConfig.cmake" "${CMAKE_CURRENT_BINARY_DIR}/KPim6MboxConfigVersion.cmake" DESTINATION "${CMAKECONFIG_INSTALL_DIR}" COMPONENT Devel ) install(EXPORT KPim6MboxTargets DESTINATION "${CMAKECONFIG_INSTALL_DIR}" FILE KPim6MboxTargets.cmake NAMESPACE KPim6::) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/src/kmbox_version.h DESTINATION ${KDE_INSTALL_INCLUDEDIR}/KPim6/KMbox COMPONENT Devel ) kde_configure_git_pre_commit_hook(CHECKS CLANG_FORMAT) ecm_feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGES) 07070100000009000081A400000000000000000000000166EA5F8600001AB2000000000000000000000000000000000000003B00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/CMakePresets.json{ "version": 3, "configurePresets": [ { "name": "base", "displayName": "base preset", "generator": "Ninja", "binaryDir": "${sourceDir}/build-${presetName}", "installDir": "$env{KF6}", "hidden": true, "cacheVariables": { "BUILD_QCH": "ON" } }, { "name": "dev-mold", "displayName": "Build as debug + using mold linker", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "CMAKE_EXPORT_COMPILE_COMMANDS": "ON", "CMAKE_SHARED_LINKER_FLAGS": "-fuse-ld=mold" }, "inherits": [ "base" ] }, { "name": "dev", "displayName": "Build as debug", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" }, "inherits": [ "base" ] }, { "name": "asan", "displayName": "Build with Asan support.", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "ECM_ENABLE_SANITIZERS" : "'address;undefined'" }, "inherits": [ "base" ] }, { "name": "dev-clang", "displayName": "dev-clang", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" }, "environment": { "CXX": "clang++", "CCACHE_DISABLE": "ON" }, "inherits": [ "base" ] }, { "name": "unity", "displayName": "Build with CMake unity support.", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "USE_UNITY_CMAKE_SUPPORT": "ON" }, "inherits": [ "base" ] }, { "name": "release", "displayName": "Build as release mode.", "cacheVariables": { "CMAKE_BUILD_TYPE": "Release", "BUILD_TESTING": "OFF" }, "inherits": [ "base" ] }, { "name": "profile", "displayName": "profile", "cacheVariables": { "CMAKE_BUILD_TYPE": "RelWithDebInfo" }, "inherits": [ "base" ] }, { "name": "coverage", "displayName": "coverage", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "USE_UNITY_CMAKE_SUPPORT": "OFF", "BUILD_COVERAGE": "ON" }, "inherits": [ "base" ] }, { "name": "clazy", "displayName": "clazy", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" }, "environment": { "CXX": "clazy", "CCACHE_DISABLE": "ON" }, "inherits": [ "base" ] }, { "name": "pch", "displayName": "pch", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "USE_PRECOMPILED_HEADERS": "ON", "BUILD_COVERAGE": "ON" }, "inherits": [ "base" ] }, { "name": "ftime-trace", "displayName": "ftime-trace", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", "USE_DEVELOPER_MODE": "ON", "CMAKE_C_FLAGS_INIT": "-ftime-trace", "CMAKE_CXX_FLAGS_INIT": "-ftime-trace" }, "environment": { "CC": "/usr/bin/clang", "CXX": "/usr/bin/clang++", "CCACHE_DISABLE": "ON" }, "inherits": [ "base" ] } ], "buildPresets": [ { "name": "dev", "configurePreset": "dev" }, { "name": "ftime-trace", "configurePreset": "ftime-trace" }, { "name": "dev-mold", "configurePreset": "dev-mold" }, { "name": "dev-clang", "configurePreset": "dev-clang" }, { "name": "pch", "configurePreset": "pch" }, { "name": "release", "configurePreset": "release" }, { "name": "unity", "configurePreset": "unity" }, { "name": "coverage", "configurePreset": "coverage" }, { "name": "asan", "configurePreset": "asan" }, { "name": "clazy", "configurePreset": "clazy", "environment": { "CLAZY_CHECKS" : "level0,level1,detaching-member,ifndef-define-typo,isempty-vs-count,qrequiredresult-candidates,reserve-candidates,signal-with-return-value,unneeded-cast,function-args-by-ref,function-args-by-value,returning-void-expression,no-ctor-missing-parent-argument,isempty-vs-count,qhash-with-char-pointer-key,raw-environment-function,qproperty-type-mismatch,old-style-connect,qstring-allocations,container-inside-loop,heap-allocated-small-trivial-type,inefficient-qlist,qstring-varargs,level2,detaching-member,heap-allocated-small-trivial-type,isempty-vs-count,qstring-varargs,qvariant-template-instantiation,raw-environment-function,reserve-candidates,signal-with-return-value,thread-with-slots,no-ctor-missing-parent-argument,no-missing-typeinfo", "CCACHE_DISABLE" : "ON" } } ], "testPresets": [ { "name": "dev", "configurePreset": "dev", "output": {"outputOnFailure": true}, "execution": {"noTestsAction": "error", "stopOnFailure": false} }, { "name": "asan", "configurePreset": "asan", "output": {"outputOnFailure": true}, "execution": {"noTestsAction": "error", "stopOnFailure": true} }, { "name": "unity", "configurePreset": "unity", "output": {"outputOnFailure": true}, "execution": {"noTestsAction": "error", "stopOnFailure": true} }, { "name": "coverage", "configurePreset": "coverage", "output": {"outputOnFailure": true}, "execution": {"noTestsAction": "error", "stopOnFailure": true} } ] } 0707010000000A000081A400000000000000000000000166EA5F860000006C000000000000000000000000000000000000004300000000kmbox-VERSIONgit.20240918T070510~e8f0e88/CMakePresets.json.license# SPDX-FileCopyrightText: 2021-2024 Laurent Montel <montel@kde.org> # SPDX-License-Identifier: BSD-3-Clause 0707010000000B000081A400000000000000000000000166EA5F8600000130000000000000000000000000000000000000004100000000kmbox-VERSIONgit.20240918T070510~e8f0e88/KPimMboxConfig.cmake.in# SPDX-FileCopyrightText: 2014 Christophe Giboudeaux <cgiboudeaux@gmx.com> # SPDX-License-Identifier: BSD-3-Clause @PACKAGE_INIT@ include(CMakeFindDependencyMacro) find_dependency(KPim6Mime "@KMIME_LIB_VERSION@") include("${CMAKE_CURRENT_LIST_DIR}/KPim6MboxTargets.cmake") @PACKAGE_INCLUDE_QCHTARGETS@ 0707010000000C000041ED00000000000000000000000266EA5F8600000000000000000000000000000000000000000000003200000000kmbox-VERSIONgit.20240918T070510~e8f0e88/LICENSES0707010000000D000081A400000000000000000000000166EA5F86000005C8000000000000000000000000000000000000004300000000kmbox-VERSIONgit.20240918T070510~e8f0e88/LICENSES/BSD-3-Clause.txtCopyright (c) <year> <owner>. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 0707010000000E000081A400000000000000000000000166EA5F8600001B04000000000000000000000000000000000000003E00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/LICENSES/CC0-1.0.txtCreative Commons Legal Code CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. 0707010000000F000081A400000000000000000000000166EA5F86000060C6000000000000000000000000000000000000004400000000kmbox-VERSIONgit.20240918T070510~e8f0e88/LICENSES/LGPL-2.0-only.txtGNU LIBRARY GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1991 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the library GPL. It is numbered 2 because it goes with version 2 of the ordinary GPL.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for your libraries, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library, or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link a program with the library, you must provide complete object files to the recipients so that they can relink them with the library, after making changes to the library and recompiling it. And you must show them these terms so they know their rights. Our method of protecting your rights has two steps: (1) copyright the library, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the library. Also, for each distributor's protection, we want to make certain that everyone understands that there is no warranty for this free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that companies distributing free software will individually obtain patent licenses, thus in effect transforming the program into proprietary software. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License, which was designed for utility programs. This license, the GNU Library General Public License, applies to certain designated libraries. This license is quite different from the ordinary one; be sure to read it in full, and don't assume that anything in it is the same as in the ordinary license. The reason we have a separate public license for some libraries is that they blur the distinction we usually make between modifying or adding to a program and simply using it. Linking a program with a library, without changing the library, is in some sense simply using the library, and is analogous to running a utility program or application program. However, in a textual and legal sense, the linked executable is a combined work, a derivative of the original library, and the ordinary General Public License treats it as such. Because of this blurred distinction, using the ordinary General Public License for libraries did not effectively promote software sharing, because most developers did not use the libraries. We concluded that weaker conditions might promote sharing better. However, unrestricted linking of non-free programs would deprive the users of those programs of all benefit from the free status of the libraries themselves. This Library General Public License is intended to permit developers of non-free programs to use free libraries, while preserving your freedom as a user of such programs to change the free libraries that are incorporated in them. (We have not seen how to achieve this as regards changes in header files, but we have achieved it as regards changes in the actual functions of the Library.) The hope is that this will lead to faster development of free libraries. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, while the latter only works together with the library. Note that it is possible for a library to be covered by the ordinary General Public License rather than by this special one. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. c) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. d) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Library General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. one line to give the library's name and an idea of what it does. Copyright (C) year name of author This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. signature of Ty Coon, 1 April 1990 Ty Coon, President of Vice That's all there is to it! 07070100000010000081A400000000000000000000000166EA5F86000060C6000000000000000000000000000000000000004800000000kmbox-VERSIONgit.20240918T070510~e8f0e88/LICENSES/LGPL-2.0-or-later.txtGNU LIBRARY GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1991 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the library GPL. It is numbered 2 because it goes with version 2 of the ordinary GPL.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for your libraries, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library, or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link a program with the library, you must provide complete object files to the recipients so that they can relink them with the library, after making changes to the library and recompiling it. And you must show them these terms so they know their rights. Our method of protecting your rights has two steps: (1) copyright the library, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the library. Also, for each distributor's protection, we want to make certain that everyone understands that there is no warranty for this free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that companies distributing free software will individually obtain patent licenses, thus in effect transforming the program into proprietary software. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License, which was designed for utility programs. This license, the GNU Library General Public License, applies to certain designated libraries. This license is quite different from the ordinary one; be sure to read it in full, and don't assume that anything in it is the same as in the ordinary license. The reason we have a separate public license for some libraries is that they blur the distinction we usually make between modifying or adding to a program and simply using it. Linking a program with a library, without changing the library, is in some sense simply using the library, and is analogous to running a utility program or application program. However, in a textual and legal sense, the linked executable is a combined work, a derivative of the original library, and the ordinary General Public License treats it as such. Because of this blurred distinction, using the ordinary General Public License for libraries did not effectively promote software sharing, because most developers did not use the libraries. We concluded that weaker conditions might promote sharing better. However, unrestricted linking of non-free programs would deprive the users of those programs of all benefit from the free status of the libraries themselves. This Library General Public License is intended to permit developers of non-free programs to use free libraries, while preserving your freedom as a user of such programs to change the free libraries that are incorporated in them. (We have not seen how to achieve this as regards changes in header files, but we have achieved it as regards changes in the actual functions of the Library.) The hope is that this will lead to faster development of free libraries. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, while the latter only works together with the library. Note that it is possible for a library to be covered by the ordinary General Public License rather than by this special one. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. c) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. d) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Library General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. one line to give the library's name and an idea of what it does. Copyright (C) year name of author This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. signature of Ty Coon, 1 April 1990 Ty Coon, President of Vice That's all there is to it! 07070100000011000081A400000000000000000000000166EA5F8600000075000000000000000000000000000000000000003300000000kmbox-VERSIONgit.20240918T070510~e8f0e88/README.md# KMBox # KMBox provides API to access emails in storages in the [MBox](https://tools.ietf.org/html/rfc4155) format 07070100000012000081A400000000000000000000000166EA5F860000005F000000000000000000000000000000000000003B00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/README.md.licenseSPDX-FileCopyrightText: 2016 Daniel Vrátil <dvratil@kde.org> SPDX-License-Identifier: CC0-1.0 07070100000013000041ED00000000000000000000000266EA5F8600000000000000000000000000000000000000000000003300000000kmbox-VERSIONgit.20240918T070510~e8f0e88/autotests07070100000014000081A400000000000000000000000166EA5F860000012A000000000000000000000000000000000000004200000000kmbox-VERSIONgit.20240918T070510~e8f0e88/autotests/CMakeLists.txt# SPDX-FileCopyrightText: none # SPDX-License-Identifier: BSD-3-Clause kde_enable_exceptions() include(ECMAddTests) find_package(Qt6Test CONFIG REQUIRED) ########### next target ############### ecm_add_tests(mboxtest.cpp mboxbenchmark.cpp NAME_PREFIX "mbox-" LINK_LIBRARIES KPim6Mbox Qt::Test) 07070100000015000081A400000000000000000000000166EA5F8600000B08000000000000000000000000000000000000004500000000kmbox-VERSIONgit.20240918T070510~e8f0e88/autotests/mboxbenchmark.cpp/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #include "mboxbenchmark.h" #include <QCryptographicHash> #include <QTemporaryDir> #include <QTest> QTEST_MAIN(MBoxBenchmark) #include "test-entries.h" using namespace KMBox; static const char *testDir = "libmbox-unit-test"; static const char *testFile = "test-mbox-file"; QString MBoxBenchmark::fileName() { return mTempDir->path() + QLatin1Char('/') + QLatin1StringView(testFile); } void MBoxBenchmark::initTestCase() { mTempDir = new QTemporaryDir(QDir::tempPath() + QLatin1Char('/') + QLatin1StringView(testDir)); mMail1 = KMime::Message::Ptr(new KMime::Message); mMail1->setContent(KMime::CRLFtoLF(sEntry1)); mMail1->parse(); } void MBoxBenchmark::cleanupTestCase() { mTempDir->remove(); delete mTempDir; } void MBoxBenchmark::testNoLockPerformance() { MBox mbox; mbox.setLockType(MBox::None); mbox.load(fileName()); for (int i = 0; i < 1000; ++i) { mbox.appendMessage(mMail1); } mbox.save(fileName()); QBENCHMARK { MBox mbox2; mbox2.setLockType(MBox::None); mbox2.setUnlockTimeout(5000); mbox2.load(fileName()); const auto lst = mbox2.entries(); for (const MBoxEntry &entry : lst) { auto mail = mbox2.readMessage(entry); delete mail; } } } void MBoxBenchmark::testProcfileLockPerformance() { mMail1 = KMime::Message::Ptr(new KMime::Message); mMail1->setContent(KMime::CRLFtoLF(sEntry1)); mMail1->parse(); MBox mbox; mbox.setLockType(MBox::ProcmailLockfile); mbox.load(fileName()); for (int i = 0; i < 1000; ++i) { mbox.appendMessage(mMail1); } mbox.save(fileName()); QBENCHMARK { MBox mbox2; mbox2.setLockType(MBox::ProcmailLockfile); mbox2.load(fileName()); mbox2.setUnlockTimeout(5000); // Keep the mbox locked for five seconds. const auto lst = mbox2.entries(); for (const MBoxEntry &entry : lst) { auto mail = mbox2.readMessage(entry); delete mail; } } } void MBoxBenchmark::voidTestMD5Performance() { MBox mbox; mbox.setLockType(MBox::None); mbox.load(fileName()); for (int i = 0; i < 1000; ++i) { mbox.appendMessage(mMail1); } mbox.save(fileName()); QBENCHMARK { QFile file(fileName()); QVERIFY(file.exists()); QVERIFY(file.open(QIODevice::ReadOnly)); QCryptographicHash hash(QCryptographicHash::Md5); qint64 blockSize = 512 * 1024; // Read blocks of 512K while (!file.atEnd()) { hash.addData(file.read(blockSize)); } file.close(); } } #include "moc_mboxbenchmark.cpp" 07070100000016000081A400000000000000000000000166EA5F8600000222000000000000000000000000000000000000004300000000kmbox-VERSIONgit.20240918T070510~e8f0e88/autotests/mboxbenchmark.h/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #pragma once #include <QObject> #include "mbox.h" class QTemporaryDir; class MBoxBenchmark : public QObject { Q_OBJECT private Q_SLOTS: void initTestCase(); void cleanupTestCase(); void testNoLockPerformance(); void testProcfileLockPerformance(); void voidTestMD5Performance(); private: QString fileName(); private: QTemporaryDir *mTempDir = nullptr; KMime::Message::Ptr mMail1; }; 07070100000017000081A400000000000000000000000166EA5F8600003E73000000000000000000000000000000000000004000000000kmbox-VERSIONgit.20240918T070510~e8f0e88/autotests/mboxtest.cpp/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-only */ #include "mboxtest.h" #include <QDir> #include <QFile> #include <QStandardPaths> #include <QTemporaryDir> #include <QTest> QTEST_MAIN(MboxTest) #include "test-entries.h" using namespace KMBox; static const char *testDir = "libmbox-unit-test"; static const char *testFile = "test-mbox-file"; static const char *testLockFile = "test-mbox-lock-file"; QString MboxTest::fileName() { return mTempDir->path() + QLatin1Char('/') + QLatin1StringView(testFile); } QString MboxTest::lockFileName() { return mTempDir->path() + QLatin1Char('/') + QLatin1StringView(testLockFile); } void MboxTest::removeTestFile() { QFile file(fileName()); file.remove(); QVERIFY(!file.exists()); } void MboxTest::initTestCase() { mTempDir = new QTemporaryDir(QDir::tempPath() + QLatin1Char('/') + QLatin1StringView(testDir)); QDir temp(mTempDir->path()); QVERIFY(temp.exists()); QFile mboxfile(fileName()); mboxfile.open(QIODevice::WriteOnly); mboxfile.close(); QVERIFY(mboxfile.exists()); mMail1 = KMime::Message::Ptr(new KMime::Message); mMail1->setContent(KMime::CRLFtoLF(sEntry1)); mMail1->parse(); mMail2 = KMime::Message::Ptr(new KMime::Message); mMail2->setContent(KMime::CRLFtoLF(sEntry2)); mMail2->parse(); } void MboxTest::testSetLockMethod() { MBox mbox1; if (!QStandardPaths::findExecutable(QStringLiteral("lockfile")).isEmpty()) { QVERIFY(mbox1.setLockType(MBox::ProcmailLockfile)); } else { QVERIFY(!mbox1.setLockType(MBox::ProcmailLockfile)); } if (!QStandardPaths::findExecutable(QStringLiteral("mutt_dotlock")).isEmpty()) { QVERIFY(mbox1.setLockType(MBox::MuttDotlock)); QVERIFY(mbox1.setLockType(MBox::MuttDotlockPrivileged)); } else { QVERIFY(!mbox1.setLockType(MBox::MuttDotlock)); QVERIFY(!mbox1.setLockType(MBox::MuttDotlockPrivileged)); } QVERIFY(mbox1.setLockType(MBox::None)); } void MboxTest::testLockBeforeLoad() { // Should fail because it's not known which file to lock. MBox mbox; if (!QStandardPaths::findExecutable(QStringLiteral("lockfile")).isEmpty()) { QVERIFY(mbox.setLockType(MBox::ProcmailLockfile)); QVERIFY(!mbox.lock()); } if (!QStandardPaths::findExecutable(QStringLiteral("mutt_dotlock")).isEmpty()) { QVERIFY(mbox.setLockType(MBox::MuttDotlock)); QVERIFY(!mbox.lock()); QVERIFY(mbox.setLockType(MBox::MuttDotlockPrivileged)); QVERIFY(!mbox.lock()); } QVERIFY(mbox.setLockType(MBox::None)); QVERIFY(!mbox.lock()); } void MboxTest::testProcMailLock() { // It really only makes sense to test this if the lockfile executable can be // found. MBox mbox; if (!mbox.setLockType(MBox::ProcmailLockfile)) { QEXPECT_FAIL("", "This test only works when procmail is installed.", Abort); QVERIFY(false); } QVERIFY(mbox.load(fileName())); // By default the filename is used as part of the lockfile filename. QVERIFY(!QFile(fileName() + QLatin1StringView(".lock")).exists()); QVERIFY(mbox.lock()); QVERIFY(QFile(fileName() + QLatin1StringView(".lock")).exists()); QVERIFY(mbox.unlock()); QVERIFY(!QFile(fileName() + QLatin1StringView(".lock")).exists()); mbox.setLockFile(lockFileName()); QVERIFY(!QFile(lockFileName()).exists()); QVERIFY(mbox.lock()); QVERIFY(QFile(lockFileName()).exists()); QVERIFY(mbox.unlock()); QVERIFY(!QFile(lockFileName()).exists()); } void MboxTest::testConcurrentAccess() { // tests if mbox works correctly when another program locks the file // and appends new messages MBox mbox; if (!mbox.setLockType(MBox::ProcmailLockfile)) { QEXPECT_FAIL("", "This test only works when procmail is installed.", Abort); QVERIFY(false); } ThreadFillsMBox thread(fileName()); // locks the mbox file and adds a new message thread.start(); QVERIFY(mbox.load(fileName())); MBoxEntry entry = mbox.appendMessage(mMail1); // as the thread appended sEntry1, the offset for the now appended message // must be greater QVERIFY(static_cast<int>(entry.messageOffset()) > sEntry1.length()); thread.wait(); } void MboxTest::testAppend() { removeTestFile(); QFileInfo info(fileName()); QCOMPARE(info.size(), static_cast<qint64>(0)); MBox mbox; mbox.setLockType(MBox::None); QVERIFY(mbox.load(fileName())); // First message added to an empty file should be at offset 0 QCOMPARE(mbox.entries().size(), 0); QCOMPARE(mbox.appendMessage(mMail1).messageOffset(), static_cast<quint64>(0)); QCOMPARE(mbox.entries().size(), 1); QVERIFY(mbox.entries().constFirst().separatorSize() > 0); QCOMPARE(mbox.entries().constFirst().messageSize(), static_cast<quint64>(sEntry1.size())); const MBoxEntry offsetMail2 = mbox.appendMessage(mMail2); QVERIFY(offsetMail2.messageOffset() > static_cast<quint64>(sEntry1.size())); QCOMPARE(mbox.entries().size(), 2); QVERIFY(mbox.entries().constLast().separatorSize() > 0); QCOMPARE(mbox.entries().constLast().messageSize(), static_cast<quint64>(sEntry2.size())); // check if appended entries can be read const MBoxEntry::List list = mbox.entries(); for (const MBoxEntry &msgInfo : list) { const QByteArray header = mbox.readMessageHeaders(msgInfo); QVERIFY(!header.isEmpty()); KMime::Message *message = mbox.readMessage(msgInfo); QVERIFY(message != nullptr); auto headers = new KMime::Message(); headers->setHead(KMime::CRLFtoLF(header)); headers->parse(); QCOMPARE(message->messageID()->identifier(), headers->messageID()->identifier()); QCOMPARE(message->subject()->as7BitString(), headers->subject()->as7BitString()); QCOMPARE(message->to()->as7BitString(), headers->to()->as7BitString()); QCOMPARE(message->from()->as7BitString(), headers->from()->as7BitString()); if (msgInfo.messageOffset() == 0) { QCOMPARE(message->messageID()->identifier(), mMail1->messageID()->identifier()); QCOMPARE(message->subject()->as7BitString(), mMail1->subject()->as7BitString()); QCOMPARE(message->to()->as7BitString(), mMail1->to()->as7BitString()); QCOMPARE(message->from()->as7BitString(), mMail1->from()->as7BitString()); } else if (msgInfo.messageOffset() == offsetMail2.messageOffset()) { QCOMPARE(message->messageID()->identifier(), mMail2->messageID()->identifier()); QCOMPARE(message->subject()->as7BitString(), mMail2->subject()->as7BitString()); QCOMPARE(message->to()->as7BitString(), mMail2->to()->as7BitString()); QCOMPARE(message->from()->as7BitString(), mMail2->from()->as7BitString()); } delete message; delete headers; } } void MboxTest::testSaveAndLoad() { removeTestFile(); MBox mbox; QVERIFY(mbox.setLockType(MBox::None)); QVERIFY(mbox.load(fileName())); QVERIFY(mbox.entries().isEmpty()); mbox.appendMessage(mMail1); mbox.appendMessage(mMail2); MBoxEntry::List infos1 = mbox.entries(); QCOMPARE(infos1.size(), 2); QVERIFY(mbox.save()); QVERIFY(QFileInfo::exists(fileName())); MBoxEntry::List infos2 = mbox.entries(); QCOMPARE(infos2.size(), 2); for (int i = 0; i < 2; ++i) { QCOMPARE(infos1.at(i).messageOffset(), infos2.at(i).messageOffset()); QCOMPARE(infos1.at(i).separatorSize(), infos2.at(i).separatorSize()); QCOMPARE(infos1.at(i).messageSize(), infos2.at(i).messageSize()); } MBox mbox2; QVERIFY(mbox2.setLockType(MBox::None)); QVERIFY(mbox2.load(fileName())); MBoxEntry::List infos3 = mbox2.entries(); QCOMPARE(infos3.size(), 2); for (int i = 0; i < 2; ++i) { QCOMPARE(infos3.at(i), infos2.at(i)); QCOMPARE(infos3.at(i).messageOffset(), infos1.at(i).messageOffset()); QCOMPARE(infos3.at(i).separatorSize(), infos1.at(i).separatorSize()); QCOMPARE(infos3.at(i).messageSize(), infos1.at(i).messageSize()); quint64 minSize = infos2.at(i).messageSize(); quint64 maxSize = infos2.at(i).messageSize() + 1; QVERIFY(infos3.at(i).messageSize() >= minSize); QVERIFY(infos3.at(i).messageSize() <= maxSize); } } void MboxTest::testBlankLines() { for (int i = 0; i < 5; ++i) { removeTestFile(); KMime::Message::Ptr mail = KMime::Message::Ptr(new KMime::Message); mail->setContent(KMime::CRLFtoLF(sEntry1 + QByteArray(i, '\n'))); mail->parse(); MBox mbox1; QVERIFY(mbox1.setLockType(MBox::None)); QVERIFY(mbox1.load(fileName())); mbox1.appendMessage(mail); mbox1.appendMessage(mail); mbox1.appendMessage(mail); mbox1.save(); QVERIFY(mbox1.setLockType(MBox::None)); QVERIFY(mbox1.load(fileName())); QCOMPARE(mbox1.entries().size(), 3); quint64 minSize = sEntry1.size() + i - 1; // Possibly on '\n' falls off. quint64 maxSize = sEntry1.size() + i; for (int j = 0; j < 3; ++j) { QVERIFY(mbox1.entries().at(j).messageSize() >= minSize); QVERIFY(mbox1.entries().at(j).messageSize() <= maxSize); } } } void MboxTest::testEntries() { removeTestFile(); MBox mbox1; QVERIFY(mbox1.setLockType(MBox::None)); QVERIFY(mbox1.load(fileName())); mbox1.appendMessage(mMail1); mbox1.appendMessage(mMail2); mbox1.appendMessage(mMail1); MBoxEntry::List infos = mbox1.entries(); QCOMPARE(infos.size(), 3); MBoxEntry::List deletedEntries; deletedEntries << infos.at(0); MBoxEntry::List infos2 = mbox1.entries(deletedEntries); QCOMPARE(infos2.size(), 2); QVERIFY(infos2.first() != infos.first()); QVERIFY(infos2.last() != infos.first()); deletedEntries << infos.at(1); infos2 = mbox1.entries(deletedEntries); QCOMPARE(infos2.size(), 1); QVERIFY(infos2.first() != infos.at(0)); QVERIFY(infos2.first() != infos.at(1)); deletedEntries << infos.at(2); infos2 = mbox1.entries(deletedEntries); QCOMPARE(infos2.size(), 0); QVERIFY(!deletedEntries.contains(MBoxEntry(10))); // some random offset infos2 = mbox1.entries(MBoxEntry::List() << MBoxEntry(10)); QCOMPARE(infos2.size(), 3); QCOMPARE(infos2.at(0), infos.at(0)); QCOMPARE(infos2.at(1), infos.at(1)); QCOMPARE(infos2.at(2), infos.at(2)); } void MboxTest::testPurge() { MBox mbox1; QVERIFY(mbox1.setLockType(MBox::None)); QVERIFY(mbox1.load(fileName())); mbox1.appendMessage(mMail1); mbox1.appendMessage(mMail1); mbox1.appendMessage(mMail1); QVERIFY(mbox1.save()); MBoxEntry::List list = mbox1.entries(); // First test: Delete only the first (all messages afterwards have to be moved). mbox1.purge(MBoxEntry::List() << list.first()); MBox mbox2; QVERIFY(mbox2.load(fileName())); MBoxEntry::List list2 = mbox2.entries(); QCOMPARE(list2.size(), 2); // Is a message actually gone? quint64 newOffsetSecondMessage = list.last().messageOffset() - list.at(1).messageOffset(); QCOMPARE(list2.first().messageOffset(), static_cast<quint64>(0)); QCOMPARE(list2.last().messageOffset(), newOffsetSecondMessage); // Second test: Delete the first two (the last message have to be moved). removeTestFile(); QVERIFY(mbox1.load(fileName())); mbox1.appendMessage(mMail1); mbox1.appendMessage(mMail1); mbox1.appendMessage(mMail1); QVERIFY(mbox1.save()); list = mbox1.entries(); mbox1.purge(MBoxEntry::List() << list.at(0) << list.at(1)); QVERIFY(mbox2.load(fileName())); list2 = mbox2.entries(); QCOMPARE(list2.size(), 1); // Are the messages actually gone? QCOMPARE(list2.first().messageOffset(), static_cast<quint64>(0)); // Third test: Delete all messages. removeTestFile(); QVERIFY(mbox1.load(fileName())); mbox1.appendMessage(mMail1); mbox1.appendMessage(mMail1); mbox1.appendMessage(mMail1); QVERIFY(mbox1.save()); list = mbox1.entries(); mbox1.purge(MBoxEntry::List() << list.at(0) << list.at(1) << list.at(2)); QVERIFY(mbox2.load(fileName())); list2 = mbox2.entries(); QCOMPARE(list2.size(), 0); // Are the messages actually gone? } void MboxTest::testLockTimeout() { MBox mbox; mbox.load(fileName()); mbox.setLockType(MBox::None); mbox.setUnlockTimeout(1000); QVERIFY(!mbox.locked()); mbox.lock(); QVERIFY(mbox.locked()); QTest::qWait(1500); QVERIFY(!mbox.locked()); } void MboxTest::testHeaders() { MBox mbox; QVERIFY(mbox.setLockType(MBox::None)); QVERIFY(mbox.load(fileName())); mbox.appendMessage(mMail1); mbox.appendMessage(mMail2); QVERIFY(mbox.save()); const MBoxEntry::List list = mbox.entries(); for (const MBoxEntry &msgInfo : list) { const QByteArray header = mbox.readMessageHeaders(msgInfo); QVERIFY(!header.isEmpty()); KMime::Message *message = mbox.readMessage(msgInfo); QVERIFY(message != nullptr); auto headers = new KMime::Message(); headers->setHead(KMime::CRLFtoLF(header)); headers->parse(); QCOMPARE(message->messageID()->identifier(), headers->messageID()->identifier()); QCOMPARE(message->subject()->as7BitString(), headers->subject()->as7BitString()); QCOMPARE(message->to()->as7BitString(), headers->to()->as7BitString()); QCOMPARE(message->from()->as7BitString(), headers->from()->as7BitString()); delete message; delete headers; } } void MboxTest::testReadOnlyMbox() { { // create a non-empty mbox file MBox mbox; QVERIFY(mbox.load(fileName())); mbox.appendMessage(mMail1); mbox.appendMessage(mMail2); QVERIFY(mbox.save()); } QFile::Permissions perm = QFile::permissions(fileName()); QFile::setPermissions(fileName(), QFile::ReadOwner); MBox mbox; QVERIFY(mbox.load(fileName())); QVERIFY(mbox.isReadOnly()); // this still works since we could save it to a different file MBoxEntry entry = mbox.appendMessage(mMail1); QVERIFY(!mbox.save()); // original mbox is read-only // reading back the appended message (from memory) QByteArray msg = mbox.readRawMessage(entry); QVERIFY(!msg.isEmpty()); // read first message from disk MBoxEntry::List list = mbox.entries(); msg = mbox.readRawMessage(list.at(0)); QVERIFY(!msg.isEmpty()); QVERIFY(!mbox.purge(list)); // original mbox is read-only QString tmpSaved = mTempDir->path() + QLatin1StringView("tempSaved.mbox"); QVERIFY(mbox.save(tmpSaved)); // other mbox file can be written MBox savedMbox; savedMbox.setReadOnly(); QVERIFY(savedMbox.isReadOnly()); QVERIFY(savedMbox.load(tmpSaved)); QVERIFY(!savedMbox.save()); // set back to initial permissions QFile::setPermissions(fileName(), perm); } void MboxTest::cleanupTestCase() { mTempDir->remove(); delete mTempDir; } //--------------------------------------------------------------------- ThreadFillsMBox::ThreadFillsMBox(const QString &fileName) { mbox = new MBox; QVERIFY(mbox->load(fileName)); mbox->setLockType(MBox::ProcmailLockfile); mbox->lock(); } void ThreadFillsMBox::run() { QTest::qSleep(2000); QFile file(mbox->fileName()); file.open(QIODevice::WriteOnly | QIODevice::Append); QByteArray message = KMime::CRLFtoLF(sEntry1); file.write(QByteArray("From test@local.local ") + QDateTime::currentDateTime().toString(Qt::ISODate).toUtf8() + "\n"); file.write(message); file.write("\n\n"); file.close(); mbox->unlock(); delete mbox; } #include "moc_mboxtest.cpp" 07070100000018000081A400000000000000000000000166EA5F860000042C000000000000000000000000000000000000003E00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/autotests/mboxtest.h/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #pragma once #include <QObject> #include <QThread> #include "mbox.h" class QTemporaryDir; class MboxTest : public QObject { Q_OBJECT private Q_SLOTS: void initTestCase(); void testSetLockMethod(); void testLockBeforeLoad(); void testProcMailLock(); void testConcurrentAccess(); void testAppend(); void testSaveAndLoad(); void testBlankLines(); void testLockTimeout(); void cleanupTestCase(); void testEntries(); void testPurge(); void testHeaders(); void testReadOnlyMbox(); private: QString fileName(); QString lockFileName(); void removeTestFile(); private: QTemporaryDir *mTempDir = nullptr; KMime::Message::Ptr mMail1; KMime::Message::Ptr mMail2; }; class ThreadFillsMBox : public QThread { Q_OBJECT public: explicit ThreadFillsMBox(const QString &fileName); protected: void run() override; private: KMBox::MBox *mbox = nullptr; }; 07070100000019000081A400000000000000000000000166EA5F860000200C000000000000000000000000000000000000004200000000kmbox-VERSIONgit.20240918T070510~e8f0e88/autotests/test-entries.h/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #pragma once #include <QByteArray> const QByteArray sEntry1( "Return-path: <commitfilter@new.kstuff.org>\n" "Received: from smtp1.tb.mail.iss.as9143.net ([212.54.42.132])\n" " by mta2z1.tb.mail.iss.as9143.net\n" " (Sun Java(tm) System Messaging Server 6.3-7.04 (built Sep 26 2008; 32bit))\n" " with ESMTP id <0KL300ECMGTOOV10@mta2z1.tb.mail.iss.as9143.net> for\n" " broeksema@kde.org; Thu, 11 Jun 2009 23:53:48 +0200 (CEST)\n" "Received: from mx4.tb.mail.iss.as9143.net ([212.54.42.103])\n" " by smtp1.tb.mail.iss.as9143.net with esmtp (Exim 4.69)\n" " (envelope-from <commitfilter@new.kstuff.org>)\n" " id 1MEsDT-0002ap-FM for broeksema@kde.org; Thu, 11 Jun 2009 23:53:47 +0200\n" "Received: from kdeget.osuosl.org ([140.211.166.77])\n" " by mx4.tb.mail.iss.as9143.net with esmtp (Exim 4.69)\n" " (envelope-from <commitfilter@new.kstuff.org>)\n" " id 1MEsDS-00011A-Kf for broeksema@kde.org; Thu, 11 Jun 2009 23:53:47 +0200\n" "Received: from ktown.kde.org ([131.246.120.250]) by kdeget.osuosl.org with smtp\n" " (Exim 4.69)\n" " (envelope-from <kde-commits-bounces-+commitfilter=new.kstuff.org@kde.org>)\n" " id 1MEsCw-0002Hs-9n for commitfilter@new.kstuff.org; Thu,\n" " 11 Jun 2009 23:53:14 +0200\n" "Received: (qmail 22909 invoked by uid 72); Thu, 11 Jun 2009 21:53:05 +0000\n" "Received: (qmail 22893 invoked from network); Thu, 11 Jun 2009 21:53:02 +0000\n" "Received: from unknown (HELO office.kde.org) (195.135.221.67)\n" " by ktown.kde.org with SMTP; Thu, 11 Jun 2009 21:53:00 +0000\n" "Received: from svn.kde.org (localhost [127.0.0.1]) by office.kde.org (Postfix)\n" " with SMTP id 1F87C64 for <kde-commits@kde.org>; Thu,\n" " 11 Jun 2009 23:53:01 +0200 (CEST)\n" "Received: (nullmailer pid 3865 invoked by uid 50099); Thu,\n" " 11 Jun 2009 21:53:01 +0000\n" "Date: Thu, 11 Jun 2009 21:53:01 +0000\n" "From: Bertjan Broeksema <broeksema@kde.org>\n" "Subject: KDE/kdepim/akonadi/resources/mbox\n" "To: kde-commits@kde.org\n" "Reply-to: kde-commits@kde.org\n" "Message-id: <1244757181.066698.3864.nullmailer@svn.kde.org>\n" "MIME-version: 1.0\n" "Content-type: text/plain;\n" " charset=UTF-8\n" "Content-transfer-encoding: 8bit\n" "Precedence: list\n" "X-BeenThere: kde-commits@kde.org\n" "X-Spam-Checker-Version: SpamAssassin 3.2.5 (2008-06-10) on ktown.kde.org\n" "X-Commit-Directories: (0) trunk/KDE/kdepim/akonadi/resources/mbox\n" " trunk/KDE/kdepim/akonadi/resources/mbox/libmbox\n" "X-MailScanner-ID: 1MEsDS-00011A-Kf\n" "X-ZiggoMX-MailScanner: Found to be clean\n" "X-ZiggoMX-MailScanner-SpamCheck: not spam\n" "X-ZiggoMX-MailScanner-From: commitfilter@new.kstuff.org\n" "X-ZiggoSMTP-MailScanner-Information: Please contact the ISP for more information\n" "X-ZiggoSMTP-MailScanner-ID: 1MEsDT-0002ap-FM\n" "X-ZiggoSMTP-MailScanner: Found to be clean\n" "X-ZiggoSMTP-MailScanner-SpamCheck: not spam, SpamAssassin (not cached,\n" " score=2.654, required 5, BAYES_00 -2.60, FRT_PROFILE2 2.11, FRT_STOCK2 2.99,\n" " TW_FC 0.08, TW_OC 0.08)\n" "X-ZiggoSMTP-MailScanner-SpamScore: ss\n" "X-ZiggoSMTP-MailScanner-From: commitfilter@new.kstuff.org\n" "X-Mailman-Version: 2.1.9\n" "List-Post: <mailto:kde-commits@kde.org>\n" "List-Subscribe: <https://mail.kde.org/mailman/listinfo/kde-commits>,\n" " <mailto:kde-commits-request@kde.org?subject=subscribe>\n" "List-Unsubscribe: <https://mail.kde.org/mailman/listinfo/kde-commits>,\n" " <mailto:kde-commits-request@kde.org?subject=unsubscribe>\n" "List-Help: <mailto:kde-commits-request@kde.org?subject=help>\n" "List-Id: Notification of KDE commits <kde-commits.kde.org>\n" "Original-recipient: rfc822;broeksema@kde.org\n" "X-Spam-Status: No\n" "Status: R\n" "X-Status: N\n" "X-KMail-EncryptionState:\n" "X-KMail-SignatureState:\n" "X-KMail-MDN-Sent:\n" "\n" "TEST MESSAGE 1"); const QByteArray sEntry2( "Return-path: <commitfilter@new.kstuff.org>\n" "Received: from smtp1.tb.mail.iss.as9143.net ([212.54.42.132])\n" " by mta2z1.tb.mail.iss.as9143.net\n" " (Sun Java(tm) System Messaging Server 6.3-7.04 (built Sep 26 2008; 32bit))\n" " with ESMTP id <0KL300ECMGTOOV10@mta2z1.tb.mail.iss.as9143.net> for\n" " broeksema@kde.org; Thu, 11 Jun 2009 23:53:48 +0200 (CEST)\n" "Received: from mx4.tb.mail.iss.as9143.net ([212.54.42.103])\n" " by smtp1.tb.mail.iss.as9143.net with esmtp (Exim 4.69)\n" " (envelope-from <commitfilter@new.kstuff.org>)\n" " id 1MEsDT-0002ap-FM for broeksema@kde.org; Thu, 11 Jun 2009 23:53:47 +0200\n" "Received: from kdeget.osuosl.org ([140.211.166.77])\n" " by mx4.tb.mail.iss.as9143.net with esmtp (Exim 4.69)\n" " (envelope-from <commitfilter@new.kstuff.org>)\n" " id 1MEsDS-00011A-Kf for broeksema@kde.org; Thu, 11 Jun 2009 23:53:47 +0200\n" "Received: from ktown.kde.org ([131.246.120.250]) by kdeget.osuosl.org with smtp\n" " (Exim 4.69)\n" " (envelope-from <kde-commits-bounces-+commitfilter=new.kstuff.org@kde.org>)\n" " id 1MEsCw-0002Hs-9n for commitfilter@new.kstuff.org; Thu,\n" " 11 Jun 2009 23:53:14 +0200\n" "Received: (qmail 22909 invoked by uid 72); Thu, 11 Jun 2009 21:53:05 +0000\n" "Received: (qmail 22893 invoked from network); Thu, 11 Jun 2009 21:53:02 +0000\n" "Received: from unknown (HELO office.kde.org) (195.135.221.67)\n" " by ktown.kde.org with SMTP; Thu, 11 Jun 2009 21:53:00 +0000\n" "Received: from svn.kde.org (localhost [127.0.0.1]) by office.kde.org (Postfix)\n" " with SMTP id 1F87C64 for <kde-commits@kde.org>; Thu,\n" " 11 Jun 2009 23:53:01 +0200 (CEST)\n" "Received: (nullmailer pid 3865 invoked by uid 50099); Thu,\n" " 11 Jun 2009 21:53:01 +0000\n" "Date: Thu, 11 Jun 2009 21:53:01 +0000\n" "From: Jaap Aap <jaap@aap.nl>\n" "Subject: KDE/kdepim/akonadi/resources/mbox\n" "To: kde-commits@kde.org\n" "Reply-to: kde-commits@kde.org\n" "Message-id: <1244757181.066698.3864.nullmailer@svn.kde.org>\n" "MIME-version: 1.0\n" "Content-type: text/plain;\n" " charset=UTF-8\n" "Content-transfer-encoding: 8bit\n" "Precedence: list\n" "X-BeenThere: kde-commits@kde.org\n" "X-Spam-Checker-Version: SpamAssassin 3.2.5 (2008-06-10) on ktown.kde.org\n" "X-Commit-Directories: (0) trunk/KDE/kdepim/akonadi/resources/mbox\n" " trunk/KDE/kdepim/akonadi/resources/mbox/libmbox\n" "X-MailScanner-ID: 1MEsDS-00011A-Kf\n" "X-ZiggoMX-MailScanner: Found to be clean\n" "X-ZiggoMX-MailScanner-SpamCheck: not spam\n" "X-ZiggoMX-MailScanner-From: commitfilter@new.kstuff.org\n" "X-ZiggoSMTP-MailScanner-Information: Please contact the ISP for more information\n" "X-ZiggoSMTP-MailScanner-ID: 1MEsDT-0002ap-FM\n" "X-ZiggoSMTP-MailScanner: Found to be clean\n" "X-ZiggoSMTP-MailScanner-SpamCheck: not spam, SpamAssassin (not cached,\n" " score=2.654, required 5, BAYES_00 -2.60, FRT_PROFILE2 2.11, FRT_STOCK2 2.99,\n" " TW_FC 0.08, TW_OC 0.08)\n" "X-ZiggoSMTP-MailScanner-SpamScore: ss\n" "X-ZiggoSMTP-MailScanner-From: commitfilter@new.kstuff.org\n" "X-Mailman-Version: 2.1.9\n" "List-Post: <mailto:kde-commits@kde.org>\n" "List-Subscribe: <https://mail.kde.org/mailman/listinfo/kde-commits>,\n" " <mailto:kde-commits-request@kde.org?subject=subscribe>\n" "List-Unsubscribe: <https://mail.kde.org/mailman/listinfo/kde-commits>,\n" " <mailto:kde-commits-request@kde.org?subject=unsubscribe>\n" "List-Help: <mailto:kde-commits-request@kde.org?subject=help>\n" "List-Id: Notification of KDE commits <kde-commits.kde.org>\n" "Original-recipient: rfc822;broeksema@kde.org\n" "X-Spam-Status: No\n" "Status: R\n" "X-Status: N\n" "X-KMail-EncryptionState:\n" "X-KMail-SignatureState:\n" "X-KMail-MDN-Sent:\n" "\n" "This is another test message.\n" "\n" "Cheers,\n" "\n" "Bertjan"); 0707010000001A000081A400000000000000000000000166EA5F8600000146000000000000000000000000000000000000003700000000kmbox-VERSIONgit.20240918T070510~e8f0e88/metainfo.yamlmaintainer: description: MBox library support tier: 3 type: functional platforms: - name: Linux - name: FreeBSD - name: Windows - name: macOS - name: Android portingAid: false deprecated: false release: false libraries: - cmake: "KPim6::Mbox" cmakename: KPim6Mbox public_lib: true group: kdepim 0707010000001B000081A400000000000000000000000166EA5F860000003E000000000000000000000000000000000000003F00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/metainfo.yaml.licenseSPDX-FileCopyrightText: none SPDX-License-Identifier: CC0-1.0 0707010000001C000081A400000000000000000000000166EA5F8600000222000000000000000000000000000000000000004000000000kmbox-VERSIONgit.20240918T070510~e8f0e88/readme-build-ftime.txt# Analyzing Build Performance For debug build time: We need ClangBuildAnalyzer ` git clone https://github.com/aras-p/ClangBuildAnalyzer mkdir build cd build cmake -DCMAKE_INSTALL_PREFIX=<path> ../ make install ` ## Command line cmake -preset ftime-trace ClangBuildAnalyzer --start $PWD/build-ftime-trace cmake --build --preset ftime-trace ClangBuildAnalyzer --stop $PWD/build-ftime-trace build-ftime.txt ClangBuildAnalyzer --analyze build-ftime.txt > analyze-build-ftime.txt see https://aras-p.info/blog/2019/09/28/Clang-Build-Analyzer/ 0707010000001D000081A400000000000000000000000166EA5F860000005F000000000000000000000000000000000000004800000000kmbox-VERSIONgit.20240918T070510~e8f0e88/readme-build-ftime.txt.licenseSPDX-FileCopyrightText: 2016 Daniel Vrátil <dvratil@kde.org> SPDX-License-Identifier: CC0-1.0 0707010000001E000081A400000000000000000000000166EA5F86000001BF000000000000000000000000000000000000003900000000kmbox-VERSIONgit.20240918T070510~e8f0e88/sanitizers.supp# SPDX-FileCopyrightText: 2021-2024 Laurent Montel <montel@kde.org> # SPDX-License-Identifier: CC0-1.0 # Suppression file for ASAN/LSAN leak:libspeechd leak:getdelim leak:g_malloc leak:libfontconfig leak:libdbus leak:QEasingCurve:: leak:QtSharedPointer::ExternalRefCountData::getAndRef leak:QArrayData::allocate leak:QObject::QObject leak:QObjectPrivate::addConnection leak:QObjectPrivate::connectImpl leak:QPropertyAnimation::QPropertyAnimation 0707010000001F000041ED00000000000000000000000266EA5F8600000000000000000000000000000000000000000000002D00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src07070100000020000081A400000000000000000000000166EA5F86000009AE000000000000000000000000000000000000003C00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/CMakeLists.txt# SPDX-FileCopyrightText: none # SPDX-License-Identifier: BSD-3-Clause add_library(KPim6Mbox) add_library(KPim6::Mbox ALIAS KPim6Mbox) target_sources(KPim6Mbox PRIVATE mboxentry.cpp mbox_p.cpp mbox.cpp mboxentry.h mbox.h mbox_p.h mboxentry_p.h ) ecm_qt_declare_logging_category(KPim6Mbox HEADER kmbox_debug.h IDENTIFIER KMBOX_LOG CATEGORY_NAME org.kde.pim.kmbox OLD_CATEGORY_NAMES log_kmbox DESCRIPTION "kmbox (pim lib)" EXPORT KMBOX) if(COMPILE_WITH_UNITY_CMAKE_SUPPORT) set_target_properties(KPim6Mbox PROPERTIES UNITY_BUILD ON) endif() ecm_generate_export_header(KPim6Mbox BASE_NAME kmbox VERSION ${KMBOX_VERSION} DEPRECATED_BASE_VERSION 0 USE_VERSION_HEADER ) target_include_directories(KPim6Mbox INTERFACE "$<INSTALL_INTERFACE:${KDE_INSTALL_INCLUDEDIR}/KPim6/KMbox>") target_include_directories(KPim6Mbox PUBLIC "$<BUILD_INTERFACE:${KMbox_SOURCE_DIR}/src;${KMbox_BINARY_DIR}/src>") target_link_libraries(KPim6Mbox PUBLIC KPim6::Mime ) set_target_properties(KPim6Mbox PROPERTIES VERSION ${KMBOX_VERSION} SOVERSION ${KMBOX_SOVERSION} EXPORT_NAME Mbox ) install(TARGETS KPim6Mbox EXPORT KPim6MboxTargets ${KDE_INSTALL_TARGETS_DEFAULT_ARGS}) ########### Generate Headers ############### ecm_generate_headers(KMbox_CamelCase_HEADERS HEADER_NAMES MBox MBoxEntry PREFIX KMbox REQUIRED_HEADERS KMbox_HEADERS ) install(FILES ${KMbox_CamelCase_HEADERS} DESTINATION ${KDE_INSTALL_INCLUDEDIR}/KPim6/KMbox/KMbox/ COMPONENT Devel ) install(FILES ${KMbox_BINARY_DIR}/src/kmbox_export.h ${KMbox_HEADERS} DESTINATION ${KDE_INSTALL_INCLUDEDIR}/KPim6/KMbox/kmbox COMPONENT Devel ) ecm_qt_install_logging_categories(EXPORT KMBOX FILE kmbox.categories DESTINATION ${KDE_INSTALL_LOGGINGCATEGORIESDIR}) if(BUILD_QCH) ecm_add_qch( KPim6Mbox_QCH NAME KMbox BASE_NAME KPim6Mbox VERSION ${PIM_VERSION} ORG_DOMAIN org.kde SOURCES # using only public headers, to cover only public API ${KMbox_HEADERS} MD_MAINPAGE "${CMAKE_SOURCE_DIR}/README.md" #IMAGE_DIRS "${CMAKE_SOURCE_DIR}/docs/pics" LINK_QCHS Qt6Core_QCH INCLUDE_DIRS ${CMAKE_CURRENT_BINARY_DIR} BLANK_MACROS KMBOX_EXPORT TAGFILE_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} QCH_INSTALL_DESTINATION ${KDE_INSTALL_QTQCHDIR} COMPONENT Devel ) endif() 07070100000021000081A400000000000000000000000166EA5F86000050DA000000000000000000000000000000000000003600000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/mbox.cpp/* SPDX-FileCopyrightText: 1996-1998 Stefan Taferner <taferner@kde.org> SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later NOTE: Most of the code inside here is an slightly adjusted version of kdepim/kmail/kmfoldermbox.cpp. This is why I added a line for Stefan Taferner. Bertjan Broeksema, april 2009 */ #include "mbox.h" #include "mbox_p.h" #include "mboxentry_p.h" #include "kmbox_debug.h" #include <QStandardPaths> #include <QUrl> #include <QBuffer> #include <QProcess> using namespace KMBox; /// public methods. MBox::MBox() : d(new MBoxPrivate(this)) { // Set some sane defaults d->mFileLocked = false; d->mLockType = None; d->mUnlockTimer.setInterval(0); d->mUnlockTimer.setSingleShot(true); } MBox::~MBox() { if (d->mFileLocked) { unlock(); } d->close(); } // Appended entries works as follows: When an mbox file is loaded from disk, // d->mInitialMboxFileSize is set to the file size at that moment. New entries // are stored in memory (d->mAppendedEntries). The initial file size and the size // of the buffer determine the offset for the next message to append. MBoxEntry MBox::appendMessage(const KMime::Message::Ptr &entry) { // It doesn't make sense to add entries when we don't have an reference file. Q_ASSERT(!d->mMboxFile.fileName().isEmpty()); const QByteArray rawEntry = MBoxPrivate::escapeFrom(entry->encodedContent()); if (rawEntry.size() <= 0) { qCDebug(KMBOX_LOG) << "Message added to folder `" << d->mMboxFile.fileName() << "' contains no data. Ignoring it."; return MBoxEntry(); } int nextOffset = d->mAppendedEntries.size(); // Offset of the appended message // Make sure the byte array is large enough to check for an end character. // Then check if the required newlines are there. if (nextOffset < 1 && d->mMboxFile.size() > 0) { // Empty, add one empty line d->mAppendedEntries.append("\n"); ++nextOffset; } else if (nextOffset == 1 && d->mAppendedEntries.at(0) != '\n') { // This should actually not happen, but catch it anyway. if (d->mMboxFile.size() < 0) { d->mAppendedEntries.append("\n"); ++nextOffset; } } else if (nextOffset >= 2) { if (d->mAppendedEntries.at(nextOffset - 1) != '\n') { if (d->mAppendedEntries.at(nextOffset) != '\n') { d->mAppendedEntries.append("\n\n"); nextOffset += 2; } else { d->mAppendedEntries.append("\n"); ++nextOffset; } } } const QByteArray separator = MBoxPrivate::mboxMessageSeparator(rawEntry); d->mAppendedEntries.append(separator); d->mAppendedEntries.append(rawEntry); if (rawEntry[rawEntry.size() - 1] != '\n') { d->mAppendedEntries.append("\n\n"); } else { d->mAppendedEntries.append("\n"); } MBoxEntry resultEntry; resultEntry.d->mOffset = d->mInitialMboxFileSize + nextOffset; resultEntry.d->mMessageSize = rawEntry.size(); resultEntry.d->mSeparatorSize = separator.size(); d->mEntries << resultEntry; return resultEntry; } MBoxEntry::List MBox::entries(const MBoxEntry::List &deletedEntries) const { if (deletedEntries.isEmpty()) { // fast path return d->mEntries; } MBoxEntry::List result; result.reserve(d->mEntries.size()); for (const MBoxEntry &entry : std::as_const(d->mEntries)) { if (!deletedEntries.contains(entry)) { result << entry; } } return result; } QString MBox::fileName() const { return d->mMboxFile.fileName(); } bool MBox::load(const QString &fileName) { if (d->mFileLocked) { return false; } d->initLoad(fileName); if (!lock()) { qCDebug(KMBOX_LOG) << "Failed to lock"; return false; } d->mInitialMboxFileSize = d->mMboxFile.size(); // AFTER the file has been locked QByteArray line; QByteArray prevSeparator; quint64 offs = 0; // The offset of the next message to read. while (!d->mMboxFile.atEnd()) { quint64 pos = d->mMboxFile.pos(); line = d->mMboxFile.readLine(); // if atEnd, use mail only if there was a separator line at all, // otherwise it's not a valid mbox if (d->isMBoxSeparator(line) || (d->mMboxFile.atEnd() && (prevSeparator.size() != 0))) { // if we are the at the file end, update pos to not forget the last line if (d->mMboxFile.atEnd()) { pos = d->mMboxFile.pos(); } // Found the separator or at end of file, the message starts at offs quint64 msgSize = pos - offs; if (pos > 0) { // This is not the separator of the first mail in the file. If pos == 0 // than we matched the separator of the first mail in the file. MBoxEntry entry; entry.d->mOffset = offs; entry.d->mSeparatorSize = prevSeparator.size(); entry.d->mMessageSize = msgSize - 1; // Don't add the separator size and the newline up to the message size. entry.d->mMessageSize -= prevSeparator.size() + 1; d->mEntries << entry; } if (d->isMBoxSeparator(line)) { prevSeparator = line; } offs += msgSize; // Mark the beginning of the next message. } } // FIXME: What if unlock fails? // if no separator was found, the file is still valid if it is empty const bool val = unlock() && (!prevSeparator.isEmpty() || (d->mMboxFile.size() == 0)); return val; } bool MBox::lock() { if (d->mMboxFile.fileName().isEmpty()) { return false; // We cannot lock if there is no file loaded. } // We can't load another file when the mbox currently is locked so if d->mFileLocked // is true atm just return true. if (locked()) { return true; } if (d->mLockType == None) { d->mFileLocked = true; if (d->open()) { d->startTimerIfNeeded(); return true; } d->mFileLocked = false; return false; } QStringList args; int rc = 0; switch (d->mLockType) { case ProcmailLockfile: args << QStringLiteral("-l20") << QStringLiteral("-r5"); if (!d->mLockFileName.isEmpty()) { args << QString::fromLocal8Bit(QFile::encodeName(d->mLockFileName)); } else { args << QString::fromLocal8Bit(QFile::encodeName(d->mMboxFile.fileName() + QLatin1StringView(".lock"))); } rc = QProcess::execute(QStringLiteral("lockfile"), args); if (rc != 0) { qCDebug(KMBOX_LOG) << "lockfile -l20 -r5 " << d->mMboxFile.fileName() << ": Failed (" << rc << ") switching to read only mode"; d->mReadOnly = true; // In case the MBox object was created read/write we // set it to read only when locking failed. } else { d->mFileLocked = true; } break; case MuttDotlock: args << QString::fromLocal8Bit(QFile::encodeName(d->mMboxFile.fileName())); rc = QProcess::execute(QStringLiteral("mutt_dotlock"), args); if (rc != 0) { qCDebug(KMBOX_LOG) << "mutt_dotlock " << d->mMboxFile.fileName() << ": Failed (" << rc << ") switching to read only mode"; d->mReadOnly = true; // In case the MBox object was created read/write we // set it to read only when locking failed. } else { d->mFileLocked = true; } break; case MuttDotlockPrivileged: args << QStringLiteral("-p") << QString::fromLocal8Bit(QFile::encodeName(d->mMboxFile.fileName())); rc = QProcess::execute(QStringLiteral("mutt_dotlock"), args); if (rc != 0) { qCDebug(KMBOX_LOG) << "mutt_dotlock -p " << d->mMboxFile.fileName() << ":" << ": Failed (" << rc << ") switching to read only mode"; d->mReadOnly = true; } else { d->mFileLocked = true; } break; case None: d->mFileLocked = true; break; default: break; } if (d->mFileLocked) { if (!d->open()) { const bool unlocked = unlock(); Q_ASSERT(unlocked); // If this fails we're in trouble. Q_UNUSED(unlocked) } } d->startTimerIfNeeded(); return d->mFileLocked; } bool MBox::locked() const { return d->mFileLocked; } static bool lessThanByOffset(const MBoxEntry &left, const MBoxEntry &right) { return left.messageOffset() < right.messageOffset(); } bool MBox::purge(const MBoxEntry::List &deletedEntries, QList<MBoxEntry::Pair> *movedEntries) { if (d->mMboxFile.fileName().isEmpty() || d->mReadOnly) { return false; // No file loaded yet or it's readOnly } if (deletedEntries.isEmpty()) { return true; // Nothing to do. } if (!lock()) { return false; } for (const MBoxEntry &entry : std::as_const(deletedEntries)) { d->mMboxFile.seek(entry.messageOffset()); const QByteArray line = d->mMboxFile.readLine(); if (!d->isMBoxSeparator(line)) { qCDebug(KMBOX_LOG) << "Found invalid separator at:" << entry.messageOffset(); unlock(); return false; // The file is messed up or the index is incorrect. } } // All entries are deleted, so just resize the file to a size of 0. if (deletedEntries.size() == d->mEntries.size()) { d->mEntries.clear(); d->mMboxFile.resize(0); qCDebug(KMBOX_LOG) << "Purge completed successfully, unlocking the file."; return unlock(); } std::sort(d->mEntries.begin(), d->mEntries.end(), lessThanByOffset); quint64 writeOffset = 0; bool writeOffSetInitialized = false; MBoxEntry::List resultingEntryList; QList<MBoxEntry::Pair> tmpMovedEntries; quint64 origFileSize = d->mMboxFile.size(); QListIterator<MBoxEntry> i(d->mEntries); while (i.hasNext()) { MBoxEntry entry = i.next(); if (deletedEntries.contains(entry) && !writeOffSetInitialized) { writeOffset = entry.messageOffset(); writeOffSetInitialized = true; } else if (writeOffSetInitialized && writeOffset < entry.messageOffset() && !deletedEntries.contains(entry)) { // The current message doesn't have to be deleted, but must be moved. // First determine the size of the entry that must be moved. quint64 entrySize = 0; if (i.hasNext()) { entrySize = i.next().messageOffset() - entry.messageOffset(); i.previous(); // Go back to make sure that we also handle the next entry. } else { entrySize = origFileSize - entry.messageOffset(); } Q_ASSERT(entrySize > 0); // MBox entries really cannot have a size <= 0; // we map the whole area of the file starting at the writeOffset up to the // message that have to be moved into memory. This includes eventually the // messages that are the deleted between the first deleted message // encountered and the message that has to be moved. quint64 mapSize = entry.messageOffset() + entrySize - writeOffset; // Now map writeOffSet + mapSize into mem. uchar *memArea = d->mMboxFile.map(writeOffset, mapSize); // Now read the entry that must be moved to writeOffset. quint64 startOffset = entry.messageOffset() - writeOffset; memmove(memArea, memArea + startOffset, entrySize); d->mMboxFile.unmap(memArea); MBoxEntry resultEntry; resultEntry.d->mOffset = writeOffset; resultEntry.d->mSeparatorSize = entry.separatorSize(); resultEntry.d->mMessageSize = entry.messageSize(); resultingEntryList << resultEntry; tmpMovedEntries << MBoxEntry::Pair(MBoxEntry(entry.messageOffset()), MBoxEntry(resultEntry.messageOffset())); writeOffset += entrySize; } else if (!deletedEntries.contains(entry)) { // Unmoved and not deleted entry, can only ocure before the first deleted // entry. Q_ASSERT(!writeOffSetInitialized); resultingEntryList << entry; } } // Chop off remaining entry bits. d->mMboxFile.resize(writeOffset); d->mEntries = resultingEntryList; qCDebug(KMBOX_LOG) << "Purge completed successfully, unlocking the file."; if (movedEntries) { *movedEntries = tmpMovedEntries; } return unlock(); // FIXME: What if this fails? It will return false but the // file has changed. } QByteArray MBox::readRawMessage(const MBoxEntry &entry) { const bool wasLocked = locked(); if (!wasLocked) { if (!lock()) { return QByteArray(); } } // TODO: Add error handling in case locking failed. quint64 offset = entry.messageOffset(); Q_ASSERT(d->mFileLocked); Q_ASSERT(d->mMboxFile.isOpen()); Q_ASSERT((d->mInitialMboxFileSize + d->mAppendedEntries.size()) > offset); QByteArray message; if (offset < d->mInitialMboxFileSize) { d->mMboxFile.seek(offset); QByteArray line = d->mMboxFile.readLine(); if (!d->isMBoxSeparator(line)) { qCDebug(KMBOX_LOG) << "[MBox::readEntry] Invalid entry at:" << offset; if (!wasLocked) { unlock(); } return QByteArray(); // The file is messed up or the index is incorrect. } line = d->mMboxFile.readLine(); while (!d->isMBoxSeparator(line)) { message += line; if (d->mMboxFile.atEnd()) { break; } line = d->mMboxFile.readLine(); } } else { offset -= d->mInitialMboxFileSize; if (offset > static_cast<quint64>(d->mAppendedEntries.size())) { if (!wasLocked) { unlock(); } return QByteArray(); } QBuffer buffer(&(d->mAppendedEntries)); buffer.open(QIODevice::ReadOnly); buffer.seek(offset); QByteArray line = buffer.readLine(); if (!d->isMBoxSeparator(line)) { qCDebug(KMBOX_LOG) << "[MBox::readEntry] Invalid appended entry at:" << offset; if (!wasLocked) { unlock(); } return QByteArray(); // The file is messed up or the index is incorrect. } line = buffer.readLine(); while (!d->isMBoxSeparator(line) && !buffer.atEnd()) { message += line; line = buffer.readLine(); } } // Remove the last '\n' added by writeEntry. if (message.endsWith('\n')) { message.chop(1); } MBoxPrivate::unescapeFrom(message.data(), message.size()); if (!wasLocked) { if (!d->startTimerIfNeeded()) { const bool unlocked = unlock(); Q_ASSERT(unlocked); Q_UNUSED(unlocked) } } return message; } KMime::Message *MBox::readMessage(const MBoxEntry &entry) { const QByteArray message = readRawMessage(entry); if (message.isEmpty()) { return nullptr; } auto mail = new KMime::Message(); mail->setContent(KMime::CRLFtoLF(message)); mail->parse(); return mail; } QByteArray MBox::readMessageHeaders(const MBoxEntry &entry) { const bool wasLocked = d->mFileLocked; if (!wasLocked) { if (!lock()) { qCDebug(KMBOX_LOG) << "Failed to lock"; return QByteArray(); } } const quint64 offset = entry.messageOffset(); Q_ASSERT(d->mFileLocked); Q_ASSERT(d->mMboxFile.isOpen()); Q_ASSERT((d->mInitialMboxFileSize + d->mAppendedEntries.size()) > offset); QByteArray headers; if (offset < d->mInitialMboxFileSize) { d->mMboxFile.seek(offset); QByteArray line = d->mMboxFile.readLine(); while (line[0] != '\n' && !d->mMboxFile.atEnd()) { headers += line; line = d->mMboxFile.readLine(); } } else { QBuffer buffer(&(d->mAppendedEntries)); buffer.open(QIODevice::ReadOnly); buffer.seek(offset - d->mInitialMboxFileSize); QByteArray line = buffer.readLine(); while (line[0] != '\n' && !buffer.atEnd()) { headers += line; line = buffer.readLine(); } } if (!wasLocked) { unlock(); } return headers; } bool MBox::save(const QString &fileName) { if (!fileName.isEmpty() && QUrl::fromUserInput(fileName).toLocalFile() != d->mMboxFile.fileName()) { if (!d->mMboxFile.copy(fileName)) { return false; } else { // if the original file was read-only, also the copied file is read-only // Let's make it writable now QFile::setPermissions(fileName, d->mMboxFile.permissions() | QFile::WriteOwner); } if (d->mAppendedEntries.isEmpty()) { return true; // Nothing to do } QFile otherFile(fileName); Q_ASSERT(otherFile.exists()); if (!otherFile.open(QIODevice::ReadWrite)) { return false; } otherFile.seek(d->mMboxFile.size()); otherFile.write(d->mAppendedEntries); // Don't clear mAppendedEntries and don't update mInitialFileSize. These // are still valid for the original file. return true; } if (d->mReadOnly) { return false; } if (d->mAppendedEntries.isEmpty()) { return true; // Nothing to do. } if (!lock()) { return false; } Q_ASSERT(d->mMboxFile.isOpen()); d->mMboxFile.seek(d->mMboxFile.size()); d->mMboxFile.write(d->mAppendedEntries); d->mAppendedEntries.clear(); d->mInitialMboxFileSize = d->mMboxFile.size(); return unlock(); } bool MBox::setLockType(LockType ltype) { if (d->mFileLocked) { qCDebug(KMBOX_LOG) << "File is currently locked."; return false; // Don't change the method if the file is currently locked. } switch (ltype) { case ProcmailLockfile: if (QStandardPaths::findExecutable(QStringLiteral("lockfile")).isEmpty()) { qCDebug(KMBOX_LOG) << "Could not find the lockfile executable"; return false; } break; case MuttDotlock: // fall through case MuttDotlockPrivileged: if (QStandardPaths::findExecutable(QStringLiteral("mutt_dotlock")).isEmpty()) { qCDebug(KMBOX_LOG) << "Could not find the mutt_dotlock executable"; return false; } break; default: break; // We assume fcntl available and lock_none doesn't need a check. } d->mLockType = ltype; return true; } void MBox::setLockFile(const QString &lockFile) { d->mLockFileName = lockFile; } void MBox::setUnlockTimeout(int msec) { d->mUnlockTimer.setInterval(msec); } bool MBox::unlock() { if (d->mLockType == None && !d->mFileLocked) { d->mFileLocked = false; d->mMboxFile.close(); return true; } int rc = 0; QStringList args; switch (d->mLockType) { case ProcmailLockfile: // QFile::remove returns true on success so negate the result. if (!d->mLockFileName.isEmpty()) { rc = !QFile(d->mLockFileName).remove(); } else { rc = !QFile(d->mMboxFile.fileName() + QLatin1StringView(".lock")).remove(); } break; case MuttDotlock: args << QStringLiteral("-u") << QString::fromLocal8Bit(QFile::encodeName(d->mMboxFile.fileName())); rc = QProcess::execute(QStringLiteral("mutt_dotlock"), args); break; case MuttDotlockPrivileged: args << QStringLiteral("-u") << QStringLiteral("-p") << QString::fromLocal8Bit(QFile::encodeName(d->mMboxFile.fileName())); rc = QProcess::execute(QStringLiteral("mutt_dotlock"), args); break; case None: // Fall through. default: break; } if (rc == 0) { // Unlocking succeeded d->mFileLocked = false; } d->mMboxFile.close(); return !d->mFileLocked; } void MBox::setReadOnly(bool ro) { d->mReadOnly = ro; } bool MBox::isReadOnly() const { return d->mReadOnly; } 07070100000022000081A400000000000000000000000166EA5F8600002388000000000000000000000000000000000000003400000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/mbox.h/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #pragma once #include "kmbox_export.h" #include "mboxentry.h" #include <memory> #include <KMime/Message> namespace KMBox { class MBoxPrivate; /** * @short A class to access mail storages in MBox format. * * @author Bertjan Broeksema <broeksema@kde.org> * @since 4.6 */ class KMBOX_EXPORT MBox { public: /** * Describes the type of locking that will be used. */ enum LockType { ProcmailLockfile, MuttDotlock, MuttDotlockPrivileged, None }; /** * Creates a new mbox object. */ MBox(); /** * Destroys the mbox object. * * The file will be unlocked if it is still open. */ ~MBox(); /** * Appends @p message to the MBox and returns the corresponding mbox entry for it. * You must load a mbox file by making a call to load( const QString& ) before * appending entries. * The returned mbox entry is <em>only</em> valid for that particular file. * * @param message The message to append to the mbox. * @return the corresponding mbox entry for the message in the file or an invalid mbox entry * if the message was not added. */ [[nodiscard]] MBoxEntry appendMessage(const KMime::Message::Ptr &message); /** * Retrieve the mbox entry objects for all emails from the file except the * @p deleteEntries. * The @p deletedEntries should be a list of mbox entries with offsets of deleted messages. * @param deletedEntries list of mbox entries that have been deleted and need not be retrieved * Note: One <em>must</em> call load() before calling this method. */ [[nodiscard]] MBoxEntry::List entries(const MBoxEntry::List &deletedEntries = MBoxEntry::List()) const; /** * Returns the file name that was passed to the last call to load(). */ [[nodiscard]] QString fileName() const; /** * Loads the raw mbox data from disk into the current MBox object. Messages * already present are <em>not</em> preserved. This method does not load the * full messages into memory but only the offsets of the messages and their * sizes. If the file currently is locked this method will do nothing and * return false. Appended messages that are not written yet will get lost. * * @param fileName the name of the mbox on disk. * @return true, if successful, false on error. * * @see save( const QString & ) */ [[nodiscard]] bool load(const QString &fileName); /** * Locks the mbox file using the configured lock method. This can be used * for consecutive calls to readMessage and readMessageHeaders. Calling lock() * before these calls prevents the mbox file being locked for every call. * * NOTE: Even when the lock method is None the mbox is internally marked as * locked. This means that it must be unlocked before calling load(). * * @return true if locked successful, false on error. * * @see setLockType( LockType ), unlock() */ [[nodiscard]] bool lock(); /** * Returns whether or not the mbox currently is locked. */ [[nodiscard]] bool locked() const; /** * Removes all messages for the given mbox entries from the current reference file * (the file that is loaded with load( const QString & ). * This method will first check if all lines at the offsets are actually * separator lines if this is not then no message will be deleted to prevent * corruption. * * @param deletedEntries The mbox entries of the messages that should be removed from * the file. * @param movedEntries Optional list for storing pairs of mbox entries that got moved * within the file due to the deletions. * The @c first member of the pair is the entry with the original offsets * the @c second member is the entry with the new (current) offset * * @return true if all offsets refer to a mbox separator line and a file was * loaded, false otherwise. If the latter, the physical file has * not changed. */ [[nodiscard]] bool purge(const MBoxEntry::List &deletedEntries, QList<MBoxEntry::Pair> *movedEntries = nullptr); /** * Reads the entire message from the file for the given mbox @p entry. If the * mbox file is not locked this method will lock the file before reading and * unlock it after reading. If the file already is locked, it will not * unlock the file after reading the entry. * * @param entry The entry in the mbox file. * @return Message for the given entry or 0 if the file could not be locked * or the entry offset > fileSize. * * @see lock(), unlock() */ KMime::Message *readMessage(const MBoxEntry &entry); /** * Reads the headers of the message for the given mbox @p entry. If the * mbox file is not locked this method will lock the file before reading and * unlock it after reading. If the file already is locked, it will not * unlock the file after reading the entry. * * @param entry The entry in the mbox file. * @return QByteArray containing the raw message header data. * * @see lock(), unlock() */ [[nodiscard]] QByteArray readMessageHeaders(const MBoxEntry &entry); /** * Reads the entire message from the file for the given mbox @p entry. If the * mbox file is not locked this method will lock the file before reading and * unlock it after reading. If the file already is locked, it will not * unlock the file after reading the entry. * * @param entry The entry in the mbox file. * @return QByteArray containing the raw message data. * * @see lock(), unlock() */ [[nodiscard]] QByteArray readRawMessage(const MBoxEntry &entry); /** * Writes the mbox to disk. If the fileName is empty only appended messages * will be written to the file that was passed to load( const QString & ). * Otherwise the contents of the file that was loaded with load is copied to * @p fileName first. * * @param fileName the name of the file * @return true if the save was successful; false otherwise. * * @see load( const QString & ) */ [[nodiscard]] bool save(const QString &fileName = QString()); /** * Sets the locktype that should be used for locking the mbox file. If the * new LockType cannot be used (e.g. the lockfile executable could not be * found) the LockType will not be changed. * @param ltype the locktype to set * This method will not do anything if the mbox object is currently locked * to make sure that it doesn't leave a locked file for one of the lockfile * / mutt_dotlock methods. */ [[nodiscard]] bool setLockType(LockType ltype); /** * Sets the lockfile that should be used by the procmail or the KDE lock * file method. If this method is not called and one of the before mentioned * lock methods is used the name of the lock file will be equal to * MBOXFILENAME.lock. * @param lockFile the lockfile to set */ void setLockFile(const QString &lockFile); /** * By default the unlock method will directly unlock the file. However this * is expensive in case of many consecutive calls to readEntry. Setting the * time out to a non zero value will keep the lock open until the timeout has * passed. On each read the timer will be reset. * @param msec the time out to set for file lock */ void setUnlockTimeout(int msec); /** * Unlock the mbox file. * * @return true if the unlock was successful, false otherwise. * * @see lock() */ [[nodiscard]] bool unlock(); /** * Set the access mode of the mbox file to read only. * * If this is set to true, the mbox file can only be read from disk. * When the mbox file given in load() can not be opened in readWrite mode, * but can be opened in readOnly mode, this flag is automatically set to true. * You can still append messages, which are stored in memory * until save() is called, but the mbox can not be saved/purged to itself. * However it is possible to save it to a different file. * @param ro the readOnly flag to use * * @see save( const QString & ) * * @since 4.14.5 */ void setReadOnly(bool ro = true); /** * Returns if the current access mode is set to readOnly. * * The access mode can either be set explicitly with setReadOnly() or * implicitly by calling load() on a readOnly file. * * @since 4.14.5 */ [[nodiscard]] bool isReadOnly() const; private: //@cond PRIVATE Q_DISABLE_COPY(MBox) std::unique_ptr<class MBoxPrivate> const d; //@endcond }; } 07070100000023000081A400000000000000000000000166EA5F86000014A3000000000000000000000000000000000000003800000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/mbox_p.cpp/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #include "mbox_p.h" #include "kmbox_debug.h" #include <QLocale> #include <QUrl> using namespace KMBox; const QRegularExpression MBoxPrivate::mSeparatorMatcher(QStringLiteral("^From .*[0-9][0-9]:[0-9][0-9]")); MBoxPrivate::MBoxPrivate(MBox *mbox) : mMBox(mbox) , mLockType(MBox::None) { connect(&mUnlockTimer, &QTimer::timeout, this, &MBoxPrivate::unlockMBox); } MBoxPrivate::~MBoxPrivate() { if (mMboxFile.isOpen()) { mMboxFile.close(); } } bool MBoxPrivate::open() { if (mMboxFile.isOpen()) { return true; // already open } QIODevice::OpenMode mode = mReadOnly ? QIODevice::ReadOnly : QIODevice::ReadWrite; if (!mMboxFile.open(mode)) { // messages file // failed to open readWrite -> try to open readOnly if (!mMboxFile.open(QIODevice::ReadOnly)) { qCDebug(KMBOX_LOG) << "Cannot open mbox file `" << mMboxFile.fileName() << "' FileError:" << mMboxFile.errorString(); return false; } else { mReadOnly = true; } } return true; } void MBoxPrivate::close() { if (mMboxFile.isOpen()) { mMboxFile.close(); } mFileLocked = false; } void MBoxPrivate::initLoad(const QString &fileName) { QUrl url = QUrl::fromLocalFile(fileName); mMboxFile.setFileName(url.toLocalFile()); mAppendedEntries.clear(); mEntries.clear(); } bool MBoxPrivate::startTimerIfNeeded() { if (mUnlockTimer.interval() > 0) { mUnlockTimer.start(); return true; } return false; } void MBoxPrivate::unlockMBox() { mMBox->unlock(); } QByteArray MBoxPrivate::mboxMessageSeparator(const QByteArray &msg) { KMime::Message mail; QByteArray body; QByteArray header; KMime::HeaderParsing::extractHeaderAndBody(KMime::CRLFtoLF(msg), header, body); body.clear(); mail.setHead(header); mail.parse(); QByteArray separator = "From "; KMime::Headers::From *from = mail.from(false); if (!from || from->addresses().isEmpty()) { separator += "unknown@unknown.invalid"; } else { separator += from->addresses().at(0) + ' '; } // format dateTime according to the mbox "standard" RFC4155 KMime::Headers::Date *date = mail.date(false); QDateTime dateTime; if (!date || date->isEmpty()) { dateTime = QDateTime::currentDateTimeUtc(); } else { dateTime = date->dateTime().toUTC(); } separator += QLocale::c().toString(dateTime, QStringLiteral("ddd MMM dd HH:mm:ss yyyy")).toUtf8() + '\n'; return separator; } #define STRDIM(x) (sizeof(x) / sizeof(*x) - 1) QByteArray MBoxPrivate::escapeFrom(const QByteArray &str) { const unsigned int strLen = str.length(); if (strLen <= STRDIM("From ")) { return str; } // worst case: \nFrom_\nFrom_\nFrom_... => grows to 7/6 QByteArray result(int(strLen + 5) / 6 * 7 + 1, '\0'); const char *s = str.data(); const char *const e = s + strLen - STRDIM("From "); char *d = result.data(); bool onlyAnglesAfterLF = false; // don't match ^From_ while (s < e) { switch (*s) { case '\n': onlyAnglesAfterLF = true; break; case '>': break; case 'F': if (onlyAnglesAfterLF && qstrncmp(s + 1, "rom ", STRDIM("rom ")) == 0) { *d++ = '>'; } // fall through [[fallthrough]]; default: onlyAnglesAfterLF = false; break; } *d++ = *s++; } while (s < str.data() + strLen) { *d++ = *s++; } result.truncate(d - result.data()); return result; } // performs (\n|^)>{n}From_ -> \1>{n-1}From_ conversion void MBoxPrivate::unescapeFrom(char *str, size_t strLen) { if (!str) { return; } if (strLen <= STRDIM(">From ")) { return; } // yes, *d++ = *s++ is a no-op as long as d == s (until after the // first >From_), but writes are cheap compared to reads and the // data is already in the cache from the read, so special-casing // might even be slower... const char *s = str; char *d = str; const char *const e = str + strLen - STRDIM(">From "); while (s < e) { if (*s == '\n' && *(s + 1) == '>') { // we can do the lookahead, // since e is 6 chars from the end! *d++ = *s++; // == '\n' *d++ = *s++; // == '>' while (s < e && *s == '>') { *d++ = *s++; } if (qstrncmp(s, "From ", STRDIM("From ")) == 0) { --d; } } *d++ = *s++; // yes, s might be e here, but e is not the end :-) } // copy the rest: while (s < str + strLen) { *d++ = *s++; } if (d < s) { // only NUL-terminate if it's shorter *d = 0; } } bool MBoxPrivate::isMBoxSeparator(const QByteArray &line) const { if (!line.startsWith("From ")) { // krazy:exclude=strings return false; } return mSeparatorMatcher.match(QLatin1StringView(line)).hasMatch(); } #undef STRDIM #include "moc_mbox_p.cpp" 07070100000024000081A400000000000000000000000166EA5F8600000545000000000000000000000000000000000000003600000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/mbox_p.h/* SPDX-FileCopyrightText: 2009 Bertjan Broeksema <broeksema@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #pragma once #include "mbox.h" #include <QFile> #include <QObject> #include <QRegularExpression> #include <QTimer> namespace KMBox { class MBoxPrivate : public QObject { Q_OBJECT public: MBoxPrivate(MBox *mbox); ~MBoxPrivate() override; void close(); void initLoad(const QString &fileName); [[nodiscard]] bool open(); [[nodiscard]] bool startTimerIfNeeded(); [[nodiscard]] bool isMBoxSeparator(const QByteArray &line) const; public Q_SLOTS: void unlockMBox(); public: QByteArray mAppendedEntries; MBoxEntry::List mEntries; quint64 mInitialMboxFileSize = 0; QString mLockFileName; MBox *const mMBox; QFile mMboxFile; QTimer mUnlockTimer; static const QRegularExpression mSeparatorMatcher; MBox::LockType mLockType; bool mFileLocked = false; bool mReadOnly = false; public: /// Static helper methods static QByteArray escapeFrom(const QByteArray &msg); /** * Generates a mbox message separator line for given message. */ static QByteArray mboxMessageSeparator(const QByteArray &msg); /** * Unescapes the raw message read from the file. */ static void unescapeFrom(char *msg, size_t size); }; } 07070100000025000081A400000000000000000000000166EA5F860000043A000000000000000000000000000000000000003B00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/mboxentry.cpp/* SPDX-FileCopyrightText: 2010 Tobias Koenig <tokoe@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #include "mboxentry.h" #include "mboxentry_p.h" using namespace KMBox; MBoxEntry::MBoxEntry() : d(new MBoxEntryPrivate) { } MBoxEntry::MBoxEntry(quint64 offset) : d(new MBoxEntryPrivate) { d->mOffset = offset; } MBoxEntry::MBoxEntry(const MBoxEntry &other) : d(other.d) { } MBoxEntry::~MBoxEntry() { } MBoxEntry &MBoxEntry::operator=(const MBoxEntry &other) { if (this != &other) { d = other.d; } return *this; } bool MBoxEntry::operator==(const MBoxEntry &other) const { return d->mOffset == other.d->mOffset; } bool MBoxEntry::operator!=(const MBoxEntry &other) const { return !(other == *this); } bool MBoxEntry::isValid() const { return (d->mOffset != 0) && (d->mMessageSize != 0); } quint64 MBoxEntry::messageOffset() const { return d->mOffset; } quint64 MBoxEntry::messageSize() const { return d->mMessageSize; } quint64 MBoxEntry::separatorSize() const { return d->mSeparatorSize; } 07070100000026000081A400000000000000000000000166EA5F86000008D9000000000000000000000000000000000000003900000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/mboxentry.h/* SPDX-FileCopyrightText: 2010 Tobias Koenig <tokoe@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #pragma once #include "kmbox_export.h" #include <QList> #include <QPair> #include <QSharedDataPointer> namespace KMBox { class MBoxEntryPrivate; /** * @short A class that encapsulates an entry of a MBox. * * @author Tobias Koenig <tokoe@kde.org> * @since 4.6 */ class KMBOX_EXPORT MBoxEntry { public: /** * Describes a list of mbox entry objects. */ using List = QList<MBoxEntry>; /** * Describes a pair of mbox entry objects. */ using Pair = QPair<MBoxEntry, MBoxEntry>; /** * Creates an invalid mbox entry object. */ MBoxEntry(); /** * Creates an mbox entry object. * * @param offset The offset of the message the object references. */ explicit MBoxEntry(quint64 offset); /** * Creates an mbox entry object from an @p other object. */ MBoxEntry(const MBoxEntry &other); /** * Destroys the mbox entry object. */ ~MBoxEntry(); /** * Replaces this mbox entry object with an @p other object. */ MBoxEntry &operator=(const MBoxEntry &other); /** * Returns whether this mbox entry object is equal to an @p other. */ bool operator==(const MBoxEntry &other) const; /** * Returns whether this mbox entry object is not equal to an @p other. */ bool operator!=(const MBoxEntry &other) const; /** * Returns whether this is a valid mbox entry object. */ [[nodiscard]] bool isValid() const; /** * Returns the offset of the message that is referenced by this * mbox entry object. */ [[nodiscard]] quint64 messageOffset() const; /** * Returns the size of the message that is referenced by this * mbox entry object. */ [[nodiscard]] quint64 messageSize() const; /** * Returns the separator size of the message that is referenced by this * mbox entry object. */ [[nodiscard]] quint64 separatorSize() const; private: //@cond PRIVATE friend class MBox; QSharedDataPointer<MBoxEntryPrivate> d; //@endcond }; } Q_DECLARE_TYPEINFO(KMBox::MBoxEntry, Q_RELOCATABLE_TYPE); 07070100000027000081A400000000000000000000000166EA5F860000023D000000000000000000000000000000000000003B00000000kmbox-VERSIONgit.20240918T070510~e8f0e88/src/mboxentry_p.h/* SPDX-FileCopyrightText: 2010 Tobias Koenig <tokoe@kde.org> SPDX-License-Identifier: LGPL-2.0-or-later */ #pragma once #include <QSharedData> namespace KMBox { class MBoxEntryPrivate : public QSharedData { public: MBoxEntryPrivate() { } MBoxEntryPrivate(const MBoxEntryPrivate &other) : QSharedData(other) , mOffset(other.mOffset) , mMessageSize(other.mMessageSize) , mSeparatorSize(other.mSeparatorSize) { } quint64 mOffset = 0; quint64 mMessageSize = 0; quint64 mSeparatorSize = 0; }; } 07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!294 blocks
Locations
Projects
Search
Status Monitor
Help
OpenBuildService.org
Documentation
API Documentation
Code of Conduct
Contact
Support
@OBShq
Terms
openSUSE Build Service is sponsored by
The Open Build Service is an
openSUSE project
.
Sign Up
Log In
Places
Places
All Projects
Status Monitor