feat: initialize and move in two modules
This commit is contained in:
commit
2003507822
167
.clang-format
Normal file
167
.clang-format
Normal file
@ -0,0 +1,167 @@
|
||||
---
|
||||
Language: Cpp
|
||||
AccessModifierOffset: -1
|
||||
AlignAfterOpenBracket: Align
|
||||
AlignConsecutiveMacros: false
|
||||
AlignConsecutiveAssignments: false
|
||||
AlignConsecutiveDeclarations: false
|
||||
AlignEscapedNewlines: Left
|
||||
AlignOperands: true
|
||||
AlignTrailingComments: true
|
||||
AllowAllArgumentsOnNextLine: true
|
||||
AllowAllConstructorInitializersOnNextLine: true
|
||||
AllowAllParametersOfDeclarationOnNextLine: true
|
||||
AllowShortBlocksOnASingleLine: Never
|
||||
AllowShortCaseLabelsOnASingleLine: false
|
||||
AllowShortFunctionsOnASingleLine: All
|
||||
AllowShortLambdasOnASingleLine: All
|
||||
AllowShortIfStatementsOnASingleLine: WithoutElse
|
||||
AllowShortLoopsOnASingleLine: true
|
||||
AlwaysBreakAfterDefinitionReturnType: None
|
||||
AlwaysBreakAfterReturnType: None
|
||||
AlwaysBreakBeforeMultilineStrings: true
|
||||
AlwaysBreakTemplateDeclarations: Yes
|
||||
BinPackArguments: true
|
||||
BinPackParameters: true
|
||||
BraceWrapping:
|
||||
AfterCaseLabel: false
|
||||
AfterClass: false
|
||||
AfterControlStatement: false
|
||||
AfterEnum: false
|
||||
AfterFunction: false
|
||||
AfterNamespace: false
|
||||
AfterObjCDeclaration: false
|
||||
AfterStruct: false
|
||||
AfterUnion: false
|
||||
AfterExternBlock: false
|
||||
BeforeCatch: false
|
||||
BeforeElse: false
|
||||
IndentBraces: false
|
||||
SplitEmptyFunction: true
|
||||
SplitEmptyRecord: true
|
||||
SplitEmptyNamespace: true
|
||||
BreakBeforeBinaryOperators: None
|
||||
BreakBeforeBraces: Attach
|
||||
BreakBeforeInheritanceComma: false
|
||||
BreakInheritanceList: BeforeColon
|
||||
BreakBeforeTernaryOperators: true
|
||||
BreakConstructorInitializersBeforeComma: false
|
||||
BreakConstructorInitializers: BeforeColon
|
||||
BreakAfterJavaFieldAnnotations: false
|
||||
BreakStringLiterals: true
|
||||
ColumnLimit: 80
|
||||
CommentPragmas: '^ IWYU pragma:'
|
||||
CompactNamespaces: false
|
||||
ConstructorInitializerAllOnOneLineOrOnePerLine: true
|
||||
ConstructorInitializerIndentWidth: 4
|
||||
ContinuationIndentWidth: 4
|
||||
Cpp11BracedListStyle: true
|
||||
DeriveLineEnding: true
|
||||
DerivePointerAlignment: true
|
||||
DisableFormat: false
|
||||
ExperimentalAutoDetectBinPacking: false
|
||||
FixNamespaceComments: true
|
||||
ForEachMacros:
|
||||
- foreach
|
||||
- Q_FOREACH
|
||||
- BOOST_FOREACH
|
||||
IncludeBlocks: Regroup
|
||||
IncludeCategories:
|
||||
- Regex: '^<ext/.*\.h>'
|
||||
Priority: 2
|
||||
SortPriority: 0
|
||||
- Regex: '^<.*\.h>'
|
||||
Priority: 1
|
||||
SortPriority: 0
|
||||
- Regex: '^<.*'
|
||||
Priority: 2
|
||||
SortPriority: 0
|
||||
- Regex: '.*'
|
||||
Priority: 3
|
||||
SortPriority: 0
|
||||
IncludeIsMainRegex: '([-_](test|unittest))?$'
|
||||
IncludeIsMainSourceRegex: ''
|
||||
IndentCaseLabels: true
|
||||
IndentGotoLabels: true
|
||||
IndentPPDirectives: None
|
||||
IndentWidth: 2
|
||||
IndentWrappedFunctionNames: false
|
||||
JavaScriptQuotes: Leave
|
||||
JavaScriptWrapImports: true
|
||||
KeepEmptyLinesAtTheStartOfBlocks: false
|
||||
MacroBlockBegin: ''
|
||||
MacroBlockEnd: ''
|
||||
MaxEmptyLinesToKeep: 1
|
||||
NamespaceIndentation: None
|
||||
ObjCBinPackProtocolList: Never
|
||||
ObjCBlockIndentWidth: 2
|
||||
ObjCSpaceAfterProperty: false
|
||||
ObjCSpaceBeforeProtocolList: true
|
||||
PenaltyBreakAssignment: 2
|
||||
PenaltyBreakBeforeFirstCallParameter: 1
|
||||
PenaltyBreakComment: 300
|
||||
PenaltyBreakFirstLessLess: 120
|
||||
PenaltyBreakString: 1000
|
||||
PenaltyBreakTemplateDeclaration: 10
|
||||
PenaltyExcessCharacter: 1000000
|
||||
PenaltyReturnTypeOnItsOwnLine: 200
|
||||
PointerAlignment: Left
|
||||
RawStringFormats:
|
||||
- Language: Cpp
|
||||
Delimiters:
|
||||
- cc
|
||||
- CC
|
||||
- cpp
|
||||
- Cpp
|
||||
- CPP
|
||||
- 'c++'
|
||||
- 'C++'
|
||||
CanonicalDelimiter: ''
|
||||
BasedOnStyle: google
|
||||
- Language: TextProto
|
||||
Delimiters:
|
||||
- pb
|
||||
- PB
|
||||
- proto
|
||||
- PROTO
|
||||
EnclosingFunctions:
|
||||
- EqualsProto
|
||||
- EquivToProto
|
||||
- PARSE_PARTIAL_TEXT_PROTO
|
||||
- PARSE_TEST_PROTO
|
||||
- PARSE_TEXT_PROTO
|
||||
- ParseTextOrDie
|
||||
- ParseTextProtoOrDie
|
||||
CanonicalDelimiter: ''
|
||||
BasedOnStyle: google
|
||||
ReflowComments: true
|
||||
SortIncludes: true
|
||||
SortUsingDeclarations: true
|
||||
SpaceAfterCStyleCast: false
|
||||
SpaceAfterLogicalNot: false
|
||||
SpaceAfterTemplateKeyword: true
|
||||
SpaceBeforeAssignmentOperators: true
|
||||
SpaceBeforeCpp11BracedList: false
|
||||
SpaceBeforeCtorInitializerColon: true
|
||||
SpaceBeforeInheritanceColon: true
|
||||
SpaceBeforeParens: ControlStatements
|
||||
SpaceBeforeRangeBasedForLoopColon: true
|
||||
SpaceInEmptyBlock: false
|
||||
SpaceInEmptyParentheses: false
|
||||
SpacesBeforeTrailingComments: 2
|
||||
SpacesInAngles: false
|
||||
SpacesInConditionalStatement: false
|
||||
SpacesInContainerLiterals: true
|
||||
SpacesInCStyleCastParentheses: false
|
||||
SpacesInParentheses: false
|
||||
SpacesInSquareBrackets: false
|
||||
SpaceBeforeSquareBrackets: false
|
||||
Standard: Auto
|
||||
StatementMacros:
|
||||
- Q_UNUSED
|
||||
- QT_REQUIRE_VERSION
|
||||
TabWidth: 8
|
||||
UseCRLF: false
|
||||
UseTab: Never
|
||||
...
|
||||
|
73
.clang-tidy
Normal file
73
.clang-tidy
Normal file
@ -0,0 +1,73 @@
|
||||
# Copyright 2019 Google LLC
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
---
|
||||
# Configure clang-tidy for this project.
|
||||
|
||||
FormatStyle: file
|
||||
|
||||
Checks: >
|
||||
-*,
|
||||
bugprone-*,
|
||||
google-*,
|
||||
misc-*,
|
||||
modernize-*,
|
||||
performance-*,
|
||||
portability-*,
|
||||
readability-*,
|
||||
-google-readability-namespace-comments,
|
||||
-google-runtime-int,
|
||||
-google-runtime-references,
|
||||
-misc-non-private-member-variables-in-classes,
|
||||
-readability-named-parameter,
|
||||
-readability-braces-around-statements,
|
||||
-readability-magic-numbers,
|
||||
-readability-named-parameter,
|
||||
-readability-identifier-length,
|
||||
-bugprone-easily-swappable-parameters,
|
||||
-readability-redundant-access-specifiers,
|
||||
-readability-identifier-length
|
||||
|
||||
CheckOptions:
|
||||
- { key: readability-identifier-naming.NamespaceCase, value: CamelCase }
|
||||
- { key: readability-identifier-naming.ClassCase, value: CamelCase }
|
||||
- { key: readability-identifier-naming.StructCase, value: CamelCase }
|
||||
- {
|
||||
key: readability-identifier-naming.TemplateParameterCase,
|
||||
value: CamelCase,
|
||||
}
|
||||
- { key: readability-identifier-naming.FunctionCase, value: CamelCase }
|
||||
- { key: readability-identifier-naming.VariableCase, value: lower_case }
|
||||
- { key: readability-identifier-naming.PrivateMethodCase, value: lower_case }
|
||||
- { key: readability-identifier-naming.ProtectedMethodCase, value: camelBack }
|
||||
- { key: readability-identifier-naming.PublicMethodCase, value: CamelCase }
|
||||
- { key: readability-identifier-naming.PrivateMemberSuffix, value: _ }
|
||||
- { key: readability-identifier-naming.ProtectedMemberSuffix, value: _ }
|
||||
- {
|
||||
key: readability-identifier-naming.MacroDefinitionCase,
|
||||
value: UPPER_CASE,
|
||||
}
|
||||
- { key: readability-identifier-naming.EnumConstantCase, value: UPPER_CASE }
|
||||
- { key: readability-identifier-naming.EnumConstantPrefix, value: k }
|
||||
- {
|
||||
key: readability-identifier-naming.ConstexprVariableCase,
|
||||
value: CamelCase,
|
||||
}
|
||||
- { key: readability-identifier-naming.ConstexprVariablePrefix, value: k }
|
||||
- { key: readability-identifier-naming.GlobalConstantCase, value: CamelCase }
|
||||
- { key: readability-identifier-naming.GlobalConstantPrefix, value: k }
|
||||
- { key: readability-identifier-naming.MemberConstantCase, value: CamelCase }
|
||||
- { key: readability-identifier-naming.MemberConstantPrefix, value: k }
|
||||
- { key: readability-identifier-naming.StaticConstantCase, value: CamelCase }
|
||||
- { key: readability-identifier-naming.StaticConstantPrefix, value: k }
|
128
.gitignore
vendored
Normal file
128
.gitignore
vendored
Normal file
@ -0,0 +1,128 @@
|
||||
# Project
|
||||
sdk/*
|
||||
!sdk/README
|
||||
|
||||
|
||||
# gettext
|
||||
*.mo
|
||||
|
||||
#Vscode
|
||||
.vscode/*
|
||||
|
||||
#CLion
|
||||
.idea/*
|
||||
|
||||
# macOS
|
||||
.DS_Store
|
||||
|
||||
# Clangd
|
||||
.cache/
|
||||
|
||||
|
||||
# C++
|
||||
|
||||
# Prerequisites
|
||||
*.d
|
||||
|
||||
# Compiled Object files
|
||||
*.slo
|
||||
*.lo
|
||||
*.o
|
||||
*.obj
|
||||
|
||||
# Precompiled Headers
|
||||
*.gch
|
||||
*.pch
|
||||
|
||||
# Compiled Dynamic libraries
|
||||
*.so
|
||||
*.dylib
|
||||
# *.dll
|
||||
|
||||
# Fortran module files
|
||||
*.mod
|
||||
*.smod
|
||||
|
||||
# Compiled Static libraries
|
||||
*.lai
|
||||
*.la
|
||||
*.a
|
||||
*.lib
|
||||
|
||||
# Executables
|
||||
# *.exe
|
||||
*.out
|
||||
*.app
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# CMake
|
||||
|
||||
# CLion
|
||||
cmake-build-debug/
|
||||
cmake-build-release/
|
||||
|
||||
# Unix
|
||||
build/
|
||||
|
||||
# General
|
||||
CMakeLists.txt.user
|
||||
CMakeCache.txt
|
||||
CMakeFiles
|
||||
CMakeScripts
|
||||
Testing
|
||||
Makefile
|
||||
cmake_install.cmake
|
||||
install_manifest.txt
|
||||
compile_commands.json
|
||||
CTestTestfile.cmake
|
||||
_deps
|
||||
|
||||
|
||||
|
||||
|
||||
# Qt
|
||||
|
||||
# Qt-es
|
||||
object_script.*.Release
|
||||
object_script.*.Debug
|
||||
*_plugin_import.cpp
|
||||
/.qmake.cache
|
||||
/.qmake.stash
|
||||
*.pro.user
|
||||
*.pro.user.*
|
||||
*.qbs.user
|
||||
*.qbs.user.*
|
||||
*.moc
|
||||
moc_*.cpp
|
||||
moc_*.h
|
||||
qrc_*.cpp
|
||||
ui_*.h
|
||||
*.qmlc
|
||||
*.jsc
|
||||
Makefile*
|
||||
*build-*
|
||||
*.qm
|
||||
*.prl
|
||||
|
||||
# Qt unit tests
|
||||
target_wrapper.*
|
||||
|
||||
# QtCreator
|
||||
*.autosave
|
||||
|
||||
|
||||
|
||||
|
||||
#Flatpak
|
||||
.flatpak-builder
|
||||
.flatpak-builder/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#VSCode
|
||||
.vscode
|
3
.gitmodules
vendored
Normal file
3
.gitmodules
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
[submodule "third_party/spdlog"]
|
||||
path = third_party/spdlog
|
||||
url = https://github.com/gabime/spdlog.git
|
94
CMakeLists.txt
Normal file
94
CMakeLists.txt
Normal file
@ -0,0 +1,94 @@
|
||||
# Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
#
|
||||
# This file is part of GpgFrontend.
|
||||
#
|
||||
# GpgFrontend is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# GpgFrontend 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# The initial version of the source code is inherited from
|
||||
# the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
#
|
||||
# All the source code of GpgFrontend was modified and released by
|
||||
# Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
cmake_minimum_required(VERSION 3.16)
|
||||
|
||||
message(STATUS "Current Generator: ${CMAKE_GENERATOR}")
|
||||
set(CMAKE_USER_MAKE_RULES_OVERRIDE "${CMAKE_SOURCE_DIR}/cmake/FlagsOverrides.cmake")
|
||||
|
||||
# define project
|
||||
project(GpgFrontendModules
|
||||
VERSION 2.1.3
|
||||
DESCRIPTION "Modules of GpgFrontend"
|
||||
HOMEPAGE_URL "https://gpgfrontend.bktus.com"
|
||||
LANGUAGES CXX)
|
||||
|
||||
# includes
|
||||
include(GenerateExportHeader)
|
||||
|
||||
# Using Standard C++-17 (Consider compatibility)
|
||||
set(CMAKE_CXX_STANDARD 17)
|
||||
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
||||
set(CMAKE_CXX_EXTENSIONS OFF)
|
||||
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
|
||||
|
||||
# CMake
|
||||
set(CMAKE_INCLUDE_CURRENT_DIR ON)
|
||||
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
|
||||
|
||||
option(GPGFRONTEND_MODULES_QT5_BUILD "Swith to Qt5 building mode" OFF)
|
||||
|
||||
# show cmake version
|
||||
message(STATUS "GpgFrontend Moudles Build Configuration Started CMAKE Version ${CMAKE_VERSION}")
|
||||
|
||||
set(SDK_VERSION "${CMAKE_PROJECT_VERSION}")
|
||||
set(SDK_PATH "${CMAKE_SOURCE_DIR}/sdk/${SDK_VERSION}")
|
||||
set(SDK_INCLUDE_PATH "${SDK_PATH}/include")
|
||||
set(SDK_LIB_PATH "${SDK_PATH}/lib")
|
||||
|
||||
message(STATUS "SDK Path: ${SDK_PATH}")
|
||||
|
||||
include_directories(
|
||||
${CMAKE_SOURCE_DIR}/include
|
||||
${SDK_INCLUDE_PATH}
|
||||
)
|
||||
|
||||
link_directories(
|
||||
${SDK_LIB_PATH}
|
||||
)
|
||||
|
||||
# Introduce Qt
|
||||
# Support Qt version: 6.x
|
||||
if(GPGFRONTEND_QT5_BUILD)
|
||||
# Introduce Qt
|
||||
# Support Qt version: 5.15.x
|
||||
find_package(Qt5 5.15 COMPONENTS Core Widgets PrintSupport Network LinguistTools REQUIRED)
|
||||
else()
|
||||
# Introduce Qt
|
||||
# Support Qt version: 6.x
|
||||
find_package(Qt6 6 COMPONENTS Core Widgets PrintSupport Network LinguistTools REQUIRED)
|
||||
endif()
|
||||
|
||||
# Qt configuration
|
||||
set(CMAKE_AUTOMOC ON)
|
||||
set(CMAKE_AUTORCC ON)
|
||||
set(CMAKE_AUTOUIC ON)
|
||||
set(CMAKE_AUTORCC_OPTIONS "--compress;9")
|
||||
|
||||
# third_party
|
||||
add_subdirectory(third_party)
|
||||
|
||||
# source code
|
||||
add_subdirectory(src)
|
675
COPYING
Normal file
675
COPYING
Normal file
@ -0,0 +1,675 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, 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
|
||||
them 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 prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
dirModel, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If 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 convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU 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
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state 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 program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program 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 General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
8
README.md
Normal file
8
README.md
Normal file
@ -0,0 +1,8 @@
|
||||
# GpgFrontend Modules
|
||||
|
||||
This repository holds project files related to the development of the
|
||||
GpgFrontend module. A new module is developed by creating a new folder, under
|
||||
src.
|
||||
|
||||
These modules will be automatically compiled and released with each GpgFrontend
|
||||
release.
|
11
cmake/FlagsOverrides.cmake
Normal file
11
cmake/FlagsOverrides.cmake
Normal file
@ -0,0 +1,11 @@
|
||||
SET (CMAKE_C_FLAGS "-Wall -std=c11")
|
||||
SET (CMAKE_C_FLAGS_DEBUG "-g -fsanitize=address -fsanitize-recover=address")
|
||||
SET (CMAKE_C_FLAGS_MINSIZERE "-Os -DNDEBUG")
|
||||
SET (CMAKE_C_FLAGS_RELEASE "-O3 -DNDEBUG")
|
||||
SET (CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -g")
|
||||
|
||||
SET (CMAKE_CXX_FLAGS "-Wall -std=c++17")
|
||||
SET (CMAKE_CXX_FLAGS_DEBUG "-g -fsanitize=address -fsanitize-recover=address")
|
||||
SET (CMAKE_CXX_FLAGS_MINSIZEREL "-Os -DNDEBUG")
|
||||
SET (CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG")
|
||||
SET (CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O2 -g")
|
71
include/LogFormatter.h
Normal file
71
include/LogFormatter.h
Normal file
@ -0,0 +1,71 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
// spdlog library configuration
|
||||
#undef SPDLOG_ACTIVE_LEVEL
|
||||
#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE
|
||||
#include <spdlog/spdlog.h>
|
||||
|
||||
#include <QString>
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QString> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QString& qstr, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
QByteArray const utf8_array = qstr.toUtf8();
|
||||
return fmt::format_to(ctx.out(), "{}", utf8_array.constData());
|
||||
}
|
||||
};
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QByteArray> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QByteArray& qarray, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
return fmt::format_to(ctx.out(), "{}", qarray.constData());
|
||||
}
|
||||
};
|
1
sdk/README
Normal file
1
sdk/README
Normal file
@ -0,0 +1 @@
|
||||
Name the SDK folder according to the corresponding version number and place it in this directory.
|
28
src/CMakeLists.txt
Normal file
28
src/CMakeLists.txt
Normal file
@ -0,0 +1,28 @@
|
||||
# Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
#
|
||||
# This file is part of GpgFrontend.
|
||||
#
|
||||
# GpgFrontend is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# GpgFrontend 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# The initial version of the source code is inherited from
|
||||
# the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
#
|
||||
# All the source code of GpgFrontend was modified and released by
|
||||
# Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# modules
|
||||
add_subdirectory(ver_check)
|
||||
add_subdirectory(gpg_info)
|
65
src/gpg_info/CMakeLists.txt
Normal file
65
src/gpg_info/CMakeLists.txt
Normal file
@ -0,0 +1,65 @@
|
||||
# Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
#
|
||||
# This file is part of GpgFrontend.
|
||||
#
|
||||
# GpgFrontend is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# GpgFrontend 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# The initial version of the source code is inherited from
|
||||
# the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
#
|
||||
# All the source code of GpgFrontend was modified and released by
|
||||
# Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# com.bktus.gpgfrontend.module.integrated.gnupg_info_gathering
|
||||
|
||||
aux_source_directory(. INTEGRATED_MODULE_SOURCE)
|
||||
|
||||
# define libgpgfrontend_module
|
||||
add_library(mod_gpg_info SHARED ${INTEGRATED_MODULE_SOURCE})
|
||||
set(_export_file "${CMAKE_CURRENT_SOURCE_DIR}/GFModuleExport.h")
|
||||
generate_export_header(mod_gpg_info
|
||||
BASE_NAME "GF_MODULE"
|
||||
EXPORT_FILE_NAME "${_export_file}")
|
||||
|
||||
target_include_directories(mod_gpg_info PRIVATE
|
||||
${CMAKE_SOURCE_DIR}/third_party/spdlog/include)
|
||||
|
||||
# set output directory
|
||||
set_target_properties(mod_gpg_info PROPERTIES
|
||||
LIBRARY_OUTPUT_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
|
||||
RUNTIME_OUTPUT_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
|
||||
|
||||
# install dir
|
||||
install(TARGETS mod_gpg_info
|
||||
LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}")
|
||||
|
||||
# link sdk
|
||||
target_link_libraries(mod_gpg_info PRIVATE
|
||||
gpgfrontend_module_sdk)
|
||||
|
||||
if(GPGFRONTEND_QT5_BUILD)
|
||||
# link Qt core
|
||||
target_link_libraries(mod_gpg_info PRIVATE Qt5::Core)
|
||||
else()
|
||||
# link Qt core
|
||||
target_link_libraries(mod_gpg_info PRIVATE Qt6::Core)
|
||||
endif()
|
||||
|
||||
# property
|
||||
set_property(TARGET mod_gpg_info PROPERTY AUTOMOC ON)
|
||||
|
||||
# using std c++ 17
|
||||
target_compile_features(mod_gpg_info PRIVATE cxx_std_17)
|
42
src/gpg_info/GFModuleExport.h
Normal file
42
src/gpg_info/GFModuleExport.h
Normal file
@ -0,0 +1,42 @@
|
||||
|
||||
#ifndef GF_MODULE_EXPORT_H
|
||||
#define GF_MODULE_EXPORT_H
|
||||
|
||||
#ifdef GF_MODULE_STATIC_DEFINE
|
||||
# define GF_MODULE_EXPORT
|
||||
# define GF_MODULE_NO_EXPORT
|
||||
#else
|
||||
# ifndef GF_MODULE_EXPORT
|
||||
# ifdef mod_gpg_info_EXPORTS
|
||||
/* We are building this library */
|
||||
# define GF_MODULE_EXPORT __attribute__((visibility("default")))
|
||||
# else
|
||||
/* We are using this library */
|
||||
# define GF_MODULE_EXPORT __attribute__((visibility("default")))
|
||||
# endif
|
||||
# endif
|
||||
|
||||
# ifndef GF_MODULE_NO_EXPORT
|
||||
# define GF_MODULE_NO_EXPORT __attribute__((visibility("hidden")))
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#ifndef GF_MODULE_DEPRECATED
|
||||
# define GF_MODULE_DEPRECATED __attribute__ ((__deprecated__))
|
||||
#endif
|
||||
|
||||
#ifndef GF_MODULE_DEPRECATED_EXPORT
|
||||
# define GF_MODULE_DEPRECATED_EXPORT GF_MODULE_EXPORT GF_MODULE_DEPRECATED
|
||||
#endif
|
||||
|
||||
#ifndef GF_MODULE_DEPRECATED_NO_EXPORT
|
||||
# define GF_MODULE_DEPRECATED_NO_EXPORT GF_MODULE_NO_EXPORT GF_MODULE_DEPRECATED
|
||||
#endif
|
||||
|
||||
#if 0 /* DEFINE_NO_DEPRECATED */
|
||||
# ifndef GF_MODULE_NO_DEPRECATED
|
||||
# define GF_MODULE_NO_DEPRECATED
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#endif /* GF_MODULE_EXPORT_H */
|
526
src/gpg_info/GnuPGInfoGatheringModule.cpp
Normal file
526
src/gpg_info/GnuPGInfoGatheringModule.cpp
Normal file
@ -0,0 +1,526 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#include "GnuPGInfoGatheringModule.h"
|
||||
|
||||
#include <GFSDKBasic.h>
|
||||
#include <GFSDKBuildInfo.h>
|
||||
#include <GFSDKLog.h>
|
||||
#include <spdlog/spdlog.h>
|
||||
|
||||
// qt
|
||||
#include <QCryptographicHash>
|
||||
#include <QFileInfo>
|
||||
#include <QJsonDocument>
|
||||
#include <QString>
|
||||
|
||||
// c++
|
||||
#include <optional>
|
||||
|
||||
#include "GpgInfo.h"
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QString> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context &ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QString &qstr, FormatContext &ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
QByteArray utf8_array = qstr.toUtf8();
|
||||
return fmt::format_to(ctx.out(), "{}", utf8_array.constData());
|
||||
}
|
||||
};
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QByteArray> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context &ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QByteArray &qarray, FormatContext &ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
return fmt::format_to(ctx.out(), "{}", qarray.constData());
|
||||
}
|
||||
};
|
||||
|
||||
extern auto CalculateBinaryChacksum(const QString &path)
|
||||
-> std::optional<QString>;
|
||||
|
||||
extern void GetGpgComponentInfos(void *, int, const char *, const char *);
|
||||
|
||||
extern void GetGpgDirectoryInfos(void *, int, const char *, const char *);
|
||||
|
||||
extern void GetGpgOptionInfos(void *, int, const char *, const char *);
|
||||
|
||||
using Context = struct {
|
||||
QString gpgme_version;
|
||||
QString gpgconf_path;
|
||||
GpgComponentInfo component_info;
|
||||
};
|
||||
|
||||
auto GFGetModuleGFSDKVersion() -> const char * {
|
||||
return GFModuleStrDup(GF_SDK_VERSION_STR);
|
||||
}
|
||||
|
||||
auto GFGetModuleQtEnvVersion() -> const char * {
|
||||
return GFModuleStrDup(QT_VERSION_STR);
|
||||
}
|
||||
|
||||
auto GFGetModuleID() -> const char * {
|
||||
return GFModuleStrDup("com.bktus.gpgfrontend.module.gnupg_info_gathering");
|
||||
}
|
||||
|
||||
auto GFGetModuleVersion() -> const char * { return GFModuleStrDup("1.0.0"); }
|
||||
|
||||
auto GFGetModuleMetaData() -> GFModuleMetaData * {
|
||||
auto *p_meta = static_cast<GFModuleMetaData *>(
|
||||
GFAllocateMemory(sizeof(GFModuleMetaData)));
|
||||
auto *h_meta = p_meta;
|
||||
|
||||
p_meta->key = "Name";
|
||||
p_meta->value = "GatherGnupgInfo";
|
||||
p_meta->next = static_cast<GFModuleMetaData *>(
|
||||
GFAllocateMemory(sizeof(GFModuleMetaData)));
|
||||
p_meta = p_meta->next;
|
||||
|
||||
p_meta->key = "Description";
|
||||
p_meta->value = "Try gathering gnupg informations";
|
||||
p_meta->next = static_cast<GFModuleMetaData *>(
|
||||
GFAllocateMemory(sizeof(GFModuleMetaData)));
|
||||
p_meta = p_meta->next;
|
||||
|
||||
p_meta->key = "Author";
|
||||
p_meta->value = "Saturneric";
|
||||
p_meta->next = nullptr;
|
||||
return h_meta;
|
||||
}
|
||||
|
||||
auto GFRegisterModule() -> int {
|
||||
GFModuleLogDebug("gnupg info gathering module registering");
|
||||
return 0;
|
||||
}
|
||||
|
||||
auto GFActiveModule() -> int {
|
||||
GFModuleLogDebug("gnupg info gathering module activating");
|
||||
GFModuleListenEvent(GFGetModuleID(),
|
||||
GFModuleStrDup("REQUEST_GATHERING_GNUPG_INFO"));
|
||||
return 0;
|
||||
}
|
||||
|
||||
auto GFExecuteModule(GFModuleEvent *event) -> int {
|
||||
GFModuleLogDebug(
|
||||
fmt::format("gnupg info gathering module executing, event id: {}",
|
||||
event->id)
|
||||
.c_str());
|
||||
|
||||
GFModuleLogDebug("start to load extra info at module gnupginfogathering...");
|
||||
|
||||
const auto *const gpgme_version = GFModuleRetrieveRTValueOrDefault(
|
||||
GFModuleStrDup("core"), GFModuleStrDup("gpgme.version"),
|
||||
GFModuleStrDup("0.0.0"));
|
||||
GFModuleLogDebug(
|
||||
fmt::format("got gpgme version from rt: {}", gpgme_version).c_str());
|
||||
|
||||
const auto *const gpgconf_path = GFModuleRetrieveRTValueOrDefault(
|
||||
GFModuleStrDup("core"), GFModuleStrDup("gpgme.ctx.gpgconf_path"),
|
||||
GFModuleStrDup(""));
|
||||
GFModuleLogDebug(
|
||||
fmt::format("got gpgconf path from rt: {}", gpgconf_path).c_str());
|
||||
|
||||
auto context = Context{gpgme_version, gpgconf_path};
|
||||
|
||||
// get all components
|
||||
const char *argv[] = {GFModuleStrDup("--list-components")};
|
||||
GFExecuteCommandSync(gpgconf_path, 1, argv, GetGpgComponentInfos, &context);
|
||||
GFModuleLogDebug("load gnupg component info done.");
|
||||
|
||||
#ifdef QT5_BUILD
|
||||
QVector<GFCommandExecuteContext> exec_contexts;
|
||||
#else
|
||||
QList<GFCommandExecuteContext> exec_contexts;
|
||||
#endif
|
||||
|
||||
const char **argv_0 =
|
||||
static_cast<const char **>(GFAllocateMemory(sizeof(const char *)));
|
||||
argv_0[0] = GFModuleStrDup("--list-dirs");
|
||||
|
||||
exec_contexts.push_back(
|
||||
{gpgconf_path, 1, argv_0, GetGpgDirectoryInfos, nullptr});
|
||||
|
||||
char **components_c_array;
|
||||
int ret = GFModuleListRTChildKeys(
|
||||
GFGetModuleID(), GFModuleStrDup("gnupg.components"), &components_c_array);
|
||||
if (components_c_array == nullptr || ret == 0) return -1;
|
||||
|
||||
QStringList components;
|
||||
auto *p_a = components_c_array;
|
||||
for (int i = 0; i < ret; i++) components.append(QString::fromUtf8(p_a[i]));
|
||||
|
||||
for (const auto &component : components) {
|
||||
const auto *component_info_json = GFModuleRetrieveRTValueOrDefault(
|
||||
GFGetModuleID(),
|
||||
GFModuleStrDup(QString("gnupg.components.%1").arg(component).toUtf8()),
|
||||
nullptr);
|
||||
|
||||
if (component_info_json == nullptr) continue;
|
||||
|
||||
auto jsonlized_component_info =
|
||||
QJsonDocument::fromJson(component_info_json);
|
||||
assert(jsonlized_component_info.isObject());
|
||||
|
||||
auto component_info = GpgComponentInfo(jsonlized_component_info.object());
|
||||
GFModuleLogDebug(fmt::format("gpgconf check options ready, "
|
||||
"component: {}",
|
||||
component_info.name)
|
||||
.c_str());
|
||||
|
||||
if (component_info.name == "gpgme" || component_info.name == "gpgconf") {
|
||||
continue;
|
||||
}
|
||||
|
||||
auto *context = new (GFAllocateMemory(sizeof(Context)))
|
||||
Context{gpgme_version, gpgconf_path, component_info};
|
||||
|
||||
const char **argv_0 =
|
||||
static_cast<const char **>(GFAllocateMemory(sizeof(const char *) * 2));
|
||||
argv_0[0] = GFModuleStrDup("--list-options"),
|
||||
argv_0[1] = GFModuleStrDup(component_info.name.toUtf8());
|
||||
exec_contexts.push_back(
|
||||
{gpgconf_path, 2, argv_0, GetGpgOptionInfos, context});
|
||||
}
|
||||
|
||||
GFExecuteCommandBatchSync(static_cast<int32_t>(exec_contexts.size()),
|
||||
exec_contexts.constData());
|
||||
GFModuleUpsertRTValueBool(GFGetModuleID(),
|
||||
GFModuleStrDup("gnupg.gathering_done"), 1);
|
||||
|
||||
char **event_argv =
|
||||
static_cast<char **>(GFAllocateMemory(sizeof(char **) * 1));
|
||||
event_argv[0] = GFModuleStrDup("0");
|
||||
|
||||
GFModuleTriggerModuleEventCallback(event, GFGetModuleID(), 1, event_argv);
|
||||
|
||||
GFModuleLogDebug("gnupg external info gathering done");
|
||||
return 0;
|
||||
}
|
||||
|
||||
auto GFDeactiveModule() -> int { return 0; }
|
||||
|
||||
auto GFUnregisterModule() -> int {
|
||||
GFModuleLogDebug("gnupg info gathering module unregistering");
|
||||
return 0;
|
||||
}
|
||||
|
||||
auto CalculateBinaryChacksum(const QString &path) -> std::optional<QString> {
|
||||
// check file info and access rights
|
||||
QFileInfo info(path);
|
||||
if (!info.exists() || !info.isFile() || !info.isReadable()) {
|
||||
GFModuleLogError(fmt::format("get info for file {} error, exists: {}",
|
||||
info.filePath(), info.exists())
|
||||
.c_str());
|
||||
return {};
|
||||
}
|
||||
|
||||
// open and read file
|
||||
QFile f(info.filePath());
|
||||
if (!f.open(QIODevice::ReadOnly)) {
|
||||
GFModuleLogError(fmt::format("open {} to calculate checksum error: {}",
|
||||
path.toStdString(),
|
||||
f.errorString().toStdString())
|
||||
.c_str());
|
||||
return {};
|
||||
}
|
||||
|
||||
QCryptographicHash hash_sha(QCryptographicHash::Sha256);
|
||||
|
||||
// read data by chunks
|
||||
const qint64 buffer_size = 8192; // Define a suitable buffer size
|
||||
while (!f.atEnd()) {
|
||||
QByteArray const buffer = f.read(buffer_size);
|
||||
if (buffer.isEmpty()) {
|
||||
GFModuleLogError(fmt::format("error reading file {} during "
|
||||
"checksum calculation",
|
||||
path.toStdString())
|
||||
.c_str());
|
||||
return {};
|
||||
}
|
||||
hash_sha.addData(buffer);
|
||||
}
|
||||
|
||||
// close the file
|
||||
f.close();
|
||||
|
||||
// return the first 6 characters of the SHA-256 hash
|
||||
// of the file
|
||||
return QString(hash_sha.result().toHex()).left(6);
|
||||
}
|
||||
|
||||
void GetGpgComponentInfos(void *data, int exit_code, const char *out,
|
||||
const char *err) {
|
||||
auto *context = reinterpret_cast<Context *>(data);
|
||||
auto p_out = QString::fromUtf8(out);
|
||||
auto p_err = QString::fromUtf8(err);
|
||||
|
||||
GFModuleLogDebug(fmt::format("gpgconf components exit_code: {} "
|
||||
"process stdout size: {}",
|
||||
exit_code, p_out.size())
|
||||
.c_str());
|
||||
|
||||
if (exit_code != 0) {
|
||||
GFModuleLogError(fmt::format("gpgconf execute error, process "
|
||||
"stderr: {}, "
|
||||
"process stdout: {}",
|
||||
p_err, p_out)
|
||||
.c_str());
|
||||
return;
|
||||
}
|
||||
|
||||
std::vector<GpgComponentInfo> component_infos;
|
||||
GpgComponentInfo c_i_gpgme;
|
||||
c_i_gpgme.name = "gpgme";
|
||||
c_i_gpgme.desc = "GPG Made Easy";
|
||||
c_i_gpgme.version = context->gpgme_version;
|
||||
c_i_gpgme.path = "Embedded In";
|
||||
c_i_gpgme.binary_checksum = "/";
|
||||
|
||||
GpgComponentInfo c_i_gpgconf;
|
||||
c_i_gpgconf.name = "gpgconf";
|
||||
c_i_gpgconf.desc = "GPG Configure";
|
||||
c_i_gpgconf.version = "/";
|
||||
c_i_gpgconf.path = context->gpgconf_path;
|
||||
auto gpgconf_binary_checksum = CalculateBinaryChacksum(context->gpgconf_path);
|
||||
c_i_gpgconf.binary_checksum =
|
||||
(gpgconf_binary_checksum.has_value() ? gpgconf_binary_checksum.value()
|
||||
: QString("/"));
|
||||
|
||||
component_infos.push_back(c_i_gpgme);
|
||||
component_infos.push_back(c_i_gpgconf);
|
||||
|
||||
auto const jsonlized_gpgme_component_info = c_i_gpgme.Json();
|
||||
auto const jsonlized_gpgconf_component_info = c_i_gpgconf.Json();
|
||||
GFModuleUpsertRTValue(
|
||||
GFGetModuleID(), GFModuleStrDup("gnupg.components.gpgme"),
|
||||
GFModuleStrDup(QJsonDocument(jsonlized_gpgme_component_info).toJson()));
|
||||
GFModuleUpsertRTValue(
|
||||
GFGetModuleID(), GFModuleStrDup("gnupg.components.gpgconf"),
|
||||
GFModuleStrDup(QJsonDocument(jsonlized_gpgconf_component_info).toJson()));
|
||||
|
||||
auto line_split_list = p_out.split("\n");
|
||||
|
||||
for (const auto &line : line_split_list) {
|
||||
auto info_split_list = line.split(":");
|
||||
|
||||
if (info_split_list.size() != 3) continue;
|
||||
|
||||
auto component_name = info_split_list[0].trimmed();
|
||||
auto component_desc = info_split_list[1].trimmed();
|
||||
auto component_path = info_split_list[2].trimmed();
|
||||
|
||||
#ifdef WINDOWS
|
||||
// replace some special substrings on windows
|
||||
// platform
|
||||
component_path.replace("%3a", ":");
|
||||
#endif
|
||||
|
||||
auto binary_checksum = CalculateBinaryChacksum(component_path);
|
||||
|
||||
GFModuleLogDebug(
|
||||
fmt::format("gnupg component name: {} desc: "
|
||||
"{} checksum: {} path: {} ",
|
||||
component_name, component_desc,
|
||||
binary_checksum.has_value() ? binary_checksum.value() : "/",
|
||||
component_path)
|
||||
.c_str());
|
||||
|
||||
QString version = "/";
|
||||
|
||||
if (component_name == "gpg") {
|
||||
version = GFModuleRetrieveRTValueOrDefault(
|
||||
GFModuleStrDup("core"), GFModuleStrDup("gpgme.ctx.gnupg_version"),
|
||||
GFModuleStrDup("2.0.0"));
|
||||
}
|
||||
if (component_name == "gpg-agent") {
|
||||
GFModuleUpsertRTValue(GFGetModuleID(),
|
||||
GFModuleStrDup("gnupg.gpg_agent_path"),
|
||||
GFModuleStrDup(QString(component_path).toUtf8()));
|
||||
}
|
||||
if (component_name == "dirmngr") {
|
||||
GFModuleUpsertRTValue(GFGetModuleID(),
|
||||
GFModuleStrDup("gnupg.dirmngr_path"),
|
||||
GFModuleStrDup(QString(component_path).toUtf8()));
|
||||
}
|
||||
if (component_name == "keyboxd") {
|
||||
GFModuleUpsertRTValue(GFGetModuleID(),
|
||||
GFModuleStrDup("gnupg.keyboxd_path"),
|
||||
GFModuleStrDup(QString(component_path).toUtf8()));
|
||||
}
|
||||
|
||||
{
|
||||
GpgComponentInfo c_i;
|
||||
c_i.name = component_name;
|
||||
c_i.desc = component_desc;
|
||||
c_i.version = version;
|
||||
c_i.path = component_path;
|
||||
c_i.binary_checksum =
|
||||
(binary_checksum.has_value() ? binary_checksum.value()
|
||||
: QString("/"));
|
||||
|
||||
auto const jsonlized_component_info = c_i.Json();
|
||||
GFModuleUpsertRTValue(
|
||||
GFGetModuleID(),
|
||||
GFModuleStrDup(
|
||||
QString("gnupg.components.%1").arg(component_name).toUtf8()),
|
||||
GFModuleStrDup(QJsonDocument(jsonlized_component_info).toJson()));
|
||||
|
||||
component_infos.push_back(c_i);
|
||||
}
|
||||
|
||||
GFModuleLogDebug("load gnupg component info actually done.");
|
||||
}
|
||||
}
|
||||
|
||||
void GetGpgDirectoryInfos(void *, int exit_code, const char *out,
|
||||
const char *err) {
|
||||
if (exit_code != 0) return;
|
||||
|
||||
auto p_out = QString::fromUtf8(out);
|
||||
auto p_err = QString::fromUtf8(err);
|
||||
auto line_split_list = p_out.split("\n");
|
||||
|
||||
for (const auto &line : line_split_list) {
|
||||
auto info_split_list = line.split(":");
|
||||
GFModuleLogDebug(fmt::format("gpgconf direcrotries info line: "
|
||||
"{} info size: {}",
|
||||
line, info_split_list.size())
|
||||
.c_str());
|
||||
|
||||
if (info_split_list.size() != 2) continue;
|
||||
|
||||
auto configuration_name = info_split_list[0].trimmed();
|
||||
auto configuration_value = info_split_list[1].trimmed();
|
||||
|
||||
#ifdef WINDOWS
|
||||
// replace some special substrings on windows
|
||||
// platform
|
||||
configuration_value.replace("%3a", ":");
|
||||
#endif
|
||||
|
||||
// record gnupg home path
|
||||
if (configuration_name == "homedir") {
|
||||
GFModuleUpsertRTValue(GFGetModuleID(), GFModuleStrDup("gnupg.home_path"),
|
||||
GFModuleStrDup(configuration_value.toUtf8()));
|
||||
}
|
||||
|
||||
GFModuleUpsertRTValue(
|
||||
GFGetModuleID(),
|
||||
GFModuleStrDup(
|
||||
QString("gnupg.dirs.%1").arg(configuration_name).toUtf8()),
|
||||
GFModuleStrDup(configuration_value.toUtf8()));
|
||||
}
|
||||
}
|
||||
|
||||
void GetGpgOptionInfos(void *data, int exit_code, const char *out,
|
||||
const char *err) {
|
||||
if (exit_code != 0) return;
|
||||
|
||||
auto p_out = QString::fromUtf8(out);
|
||||
auto p_err = QString::fromUtf8(err);
|
||||
auto *context = reinterpret_cast<Context *>(data);
|
||||
auto component_name = context->component_info.name;
|
||||
|
||||
GFModuleLogDebug(fmt::format("gpgconf {} avaliable options "
|
||||
"exit_code: {} process stdout "
|
||||
"size: {} ",
|
||||
component_name, exit_code, p_out.size())
|
||||
.c_str());
|
||||
|
||||
std::vector<GpgOptionsInfo> options_infos;
|
||||
|
||||
auto line_split_list = p_out.split("\n");
|
||||
|
||||
for (const auto &line : line_split_list) {
|
||||
auto info_split_list = line.split(":");
|
||||
|
||||
GFModuleLogDebug(fmt::format("component {} avaliable options "
|
||||
"line: {} info size: {}",
|
||||
component_name, line, info_split_list.size())
|
||||
.c_str());
|
||||
|
||||
if (info_split_list.size() < 10) continue;
|
||||
|
||||
// The format of each line is:
|
||||
// name:flags:level:description:type:alt-type:argname:default:argdef:value
|
||||
|
||||
auto option_name = info_split_list[0].trimmed();
|
||||
auto option_flags = info_split_list[1].trimmed();
|
||||
auto option_level = info_split_list[2].trimmed();
|
||||
auto option_desc = info_split_list[3].trimmed();
|
||||
auto option_type = info_split_list[4].trimmed();
|
||||
auto option_alt_type = info_split_list[5].trimmed();
|
||||
auto option_argname = info_split_list[6].trimmed();
|
||||
auto option_default = info_split_list[7].trimmed();
|
||||
auto option_argdef = info_split_list[8].trimmed();
|
||||
auto option_value = info_split_list[9].trimmed();
|
||||
|
||||
GpgOptionsInfo info;
|
||||
info.name = option_name;
|
||||
info.flags = option_flags;
|
||||
info.level = option_level;
|
||||
info.description = option_desc;
|
||||
info.type = option_type;
|
||||
info.alt_type = option_alt_type;
|
||||
info.argname = option_argname;
|
||||
info.default_value = option_default;
|
||||
info.argdef = option_argdef;
|
||||
info.value = option_value;
|
||||
|
||||
auto const jsonlized_option_info = info.Json();
|
||||
GFModuleUpsertRTValue(
|
||||
GFGetModuleID(),
|
||||
GFModuleStrDup(QString("gnupg.components.%1.options.%2")
|
||||
.arg(component_name)
|
||||
.arg(option_name)
|
||||
.toUtf8()),
|
||||
GFModuleStrDup(QJsonDocument(jsonlized_option_info).toJson()));
|
||||
options_infos.push_back(info);
|
||||
}
|
||||
|
||||
context->~Context();
|
||||
GFFreeMemory(context);
|
||||
}
|
56
src/gpg_info/GnuPGInfoGatheringModule.h
Normal file
56
src/gpg_info/GnuPGInfoGatheringModule.h
Normal file
@ -0,0 +1,56 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <GFSDKModule.h>
|
||||
|
||||
#include "GFModuleExport.h"
|
||||
|
||||
extern "C" {
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleGFSDKVersion() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleQtEnvVersion() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleID() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleVersion() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleMetaData() -> GFModuleMetaData *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFRegisterModule() -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFActiveModule() -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFExecuteModule(GFModuleEvent *) -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFDeactiveModule() -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFUnregisterModule() -> int;
|
||||
};
|
79
src/gpg_info/GpgInfo.cpp
Normal file
79
src/gpg_info/GpgInfo.cpp
Normal file
@ -0,0 +1,79 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#include "GpgInfo.h"
|
||||
|
||||
GpgOptionsInfo::GpgOptionsInfo(const QJsonObject &j) {
|
||||
if (const auto v = j["name"]; v.isString()) name = v.toString();
|
||||
if (const auto v = j["flags"]; v.isString()) flags = v.toString();
|
||||
if (const auto v = j["level"]; v.isString()) level = v.toString();
|
||||
if (const auto v = j["description"]; v.isString()) description = v.toString();
|
||||
if (const auto v = j["type"]; v.isString()) type = v.toString();
|
||||
if (const auto v = j["alt_type"]; v.isString()) alt_type = v.toString();
|
||||
if (const auto v = j["argname"]; v.isString()) argname = v.toString();
|
||||
if (const auto v = j["default_value"]; v.isString()) {
|
||||
default_value = v.toString();
|
||||
}
|
||||
if (const auto v = j["argdef"]; v.isString()) argdef = v.toString();
|
||||
if (const auto v = j["value"]; v.isString()) value = v.toString();
|
||||
}
|
||||
|
||||
auto GpgOptionsInfo::Json() const -> QJsonObject {
|
||||
QJsonObject j;
|
||||
j["name"] = name;
|
||||
j["flags"] = flags;
|
||||
j["level"] = level;
|
||||
j["description"] = description;
|
||||
j["type"] = type;
|
||||
j["alt_type"] = alt_type;
|
||||
j["argname"] = argname;
|
||||
j["default_value"] = default_value;
|
||||
j["argdef"] = argdef;
|
||||
j["value"] = value;
|
||||
return j;
|
||||
}
|
||||
|
||||
auto GpgComponentInfo::Json() const -> QJsonObject {
|
||||
QJsonObject j;
|
||||
j["name"] = name;
|
||||
j["desc"] = desc;
|
||||
j["version"] = version;
|
||||
j["path"] = path;
|
||||
j["binary_checksum"] = binary_checksum;
|
||||
return j;
|
||||
}
|
||||
|
||||
GpgComponentInfo::GpgComponentInfo(const QJsonObject &j) {
|
||||
if (const auto v = j["name"]; v.isString()) name = v.toString();
|
||||
if (const auto v = j["desc"]; v.isString()) desc = v.toString();
|
||||
if (const auto v = j["version"]; v.isString()) version = v.toString();
|
||||
if (const auto v = j["path"]; v.isString()) path = v.toString();
|
||||
if (const auto v = j["binary_checksum"]; v.isString()) {
|
||||
binary_checksum = v.toString();
|
||||
}
|
||||
}
|
88
src/gpg_info/GpgInfo.h
Normal file
88
src/gpg_info/GpgInfo.h
Normal file
@ -0,0 +1,88 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <QJsonObject>
|
||||
#include <QString>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* @brief Use to record some info about gnupg
|
||||
*
|
||||
*/
|
||||
class GpgInfo {
|
||||
public:
|
||||
QString GnuPGHomePath; ///< value of ---homedir
|
||||
|
||||
std::map<QString, std::vector<QString>> ComponentsInfo; ///<
|
||||
std::map<QString, std::vector<QString>> ConfigurationsInfo; ///<
|
||||
std::map<QString, std::vector<QString>> OptionsInfo; ///<
|
||||
std::map<QString, std::vector<QString>> AvailableOptionsInfo; ///<
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Use to record some info about gnupg components
|
||||
*
|
||||
*/
|
||||
struct GpgComponentInfo {
|
||||
QString name;
|
||||
QString desc;
|
||||
QString version;
|
||||
QString path;
|
||||
QString binary_checksum;
|
||||
|
||||
GpgComponentInfo() = default;
|
||||
|
||||
explicit GpgComponentInfo(const QJsonObject &j);
|
||||
|
||||
[[nodiscard]] auto Json() const -> QJsonObject;
|
||||
};
|
||||
|
||||
/**
|
||||
* The format of each line is:
|
||||
* name:flags:level:description:type:alt-type:argname:default:argdef:value
|
||||
*/
|
||||
struct GpgOptionsInfo {
|
||||
QString name;
|
||||
QString flags;
|
||||
QString level;
|
||||
QString description;
|
||||
QString type;
|
||||
QString alt_type;
|
||||
QString argname;
|
||||
QString default_value;
|
||||
QString argdef;
|
||||
QString value;
|
||||
|
||||
GpgOptionsInfo() = default;
|
||||
|
||||
explicit GpgOptionsInfo(const QJsonObject &j);
|
||||
|
||||
[[nodiscard]] auto Json() const -> QJsonObject;
|
||||
};
|
68
src/gpg_info/QtLoggerFmt.h
Normal file
68
src/gpg_info/QtLoggerFmt.h
Normal file
@ -0,0 +1,68 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <spdlog/spdlog.h>
|
||||
|
||||
#include <QString>
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QString> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QString& qstr, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
QByteArray utf8_array = qstr.toUtf8();
|
||||
return fmt::format_to(ctx.out(), "{}", utf8_array.constData());
|
||||
}
|
||||
};
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QByteArray> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QByteArray& qarray, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
return fmt::format_to(ctx.out(), "{}", qarray.constData());
|
||||
}
|
||||
};
|
64
src/ver_check/CMakeLists.txt
Normal file
64
src/ver_check/CMakeLists.txt
Normal file
@ -0,0 +1,64 @@
|
||||
# Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
#
|
||||
# This file is part of GpgFrontend.
|
||||
#
|
||||
# GpgFrontend is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# GpgFrontend 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# The initial version of the source code is inherited from
|
||||
# the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
#
|
||||
# All the source code of GpgFrontend was modified and released by
|
||||
# Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# com.bktus.gpgfrontend.module.integrated.version_checking
|
||||
|
||||
aux_source_directory(. INTEGRATED_MODULE_SOURCE)
|
||||
|
||||
# define libgpgfrontend_module
|
||||
add_library(mod_ver_check SHARED ${INTEGRATED_MODULE_SOURCE})
|
||||
set(_export_file "${CMAKE_CURRENT_SOURCE_DIR}/GFModuleExport.h")
|
||||
generate_export_header(mod_ver_check
|
||||
BASE_NAME "GF_MODULE"
|
||||
EXPORT_FILE_NAME "${_export_file}")
|
||||
|
||||
target_include_directories(mod_ver_check PRIVATE
|
||||
${CMAKE_SOURCE_DIR}/third_party/spdlog/include)
|
||||
|
||||
# set output directory
|
||||
set_target_properties(mod_ver_check PROPERTIES
|
||||
LIBRARY_OUTPUT_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
|
||||
RUNTIME_OUTPUT_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
|
||||
|
||||
install(TARGETS mod_ver_check
|
||||
LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}")
|
||||
|
||||
# link sdk
|
||||
target_link_libraries(mod_ver_check PRIVATE
|
||||
gpgfrontend_module_sdk)
|
||||
|
||||
if(GPGFRONTEND_QT5_BUILD)
|
||||
# link Qt
|
||||
target_link_libraries(mod_ver_check PUBLIC Qt5::Core Qt5::Network)
|
||||
else()
|
||||
# link Qt
|
||||
target_link_libraries(mod_ver_check PUBLIC Qt6::Core Qt6::Network)
|
||||
endif()
|
||||
|
||||
# property
|
||||
set_property(TARGET mod_ver_check PROPERTY AUTOMOC ON)
|
||||
|
||||
# using std c++ 17
|
||||
target_compile_features(mod_ver_check PRIVATE cxx_std_17)
|
42
src/ver_check/GFModuleExport.h
Normal file
42
src/ver_check/GFModuleExport.h
Normal file
@ -0,0 +1,42 @@
|
||||
|
||||
#ifndef GF_MODULE_EXPORT_H
|
||||
#define GF_MODULE_EXPORT_H
|
||||
|
||||
#ifdef GF_MODULE_STATIC_DEFINE
|
||||
# define GF_MODULE_EXPORT
|
||||
# define GF_MODULE_NO_EXPORT
|
||||
#else
|
||||
# ifndef GF_MODULE_EXPORT
|
||||
# ifdef mod_ver_check_EXPORTS
|
||||
/* We are building this library */
|
||||
# define GF_MODULE_EXPORT __attribute__((visibility("default")))
|
||||
# else
|
||||
/* We are using this library */
|
||||
# define GF_MODULE_EXPORT __attribute__((visibility("default")))
|
||||
# endif
|
||||
# endif
|
||||
|
||||
# ifndef GF_MODULE_NO_EXPORT
|
||||
# define GF_MODULE_NO_EXPORT __attribute__((visibility("hidden")))
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#ifndef GF_MODULE_DEPRECATED
|
||||
# define GF_MODULE_DEPRECATED __attribute__ ((__deprecated__))
|
||||
#endif
|
||||
|
||||
#ifndef GF_MODULE_DEPRECATED_EXPORT
|
||||
# define GF_MODULE_DEPRECATED_EXPORT GF_MODULE_EXPORT GF_MODULE_DEPRECATED
|
||||
#endif
|
||||
|
||||
#ifndef GF_MODULE_DEPRECATED_NO_EXPORT
|
||||
# define GF_MODULE_DEPRECATED_NO_EXPORT GF_MODULE_NO_EXPORT GF_MODULE_DEPRECATED
|
||||
#endif
|
||||
|
||||
#if 0 /* DEFINE_NO_DEPRECATED */
|
||||
# ifndef GF_MODULE_NO_DEPRECATED
|
||||
# define GF_MODULE_NO_DEPRECATED
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#endif /* GF_MODULE_EXPORT_H */
|
68
src/ver_check/QtLoggerFmt.h
Normal file
68
src/ver_check/QtLoggerFmt.h
Normal file
@ -0,0 +1,68 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <spdlog/spdlog.h>
|
||||
|
||||
#include <QString>
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QString> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QString& qstr, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
QByteArray utf8_array = qstr.toUtf8();
|
||||
return fmt::format_to(ctx.out(), "{}", utf8_array.constData());
|
||||
}
|
||||
};
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QByteArray> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QByteArray& qarray, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
return fmt::format_to(ctx.out(), "{}", qarray.constData());
|
||||
}
|
||||
};
|
100
src/ver_check/SoftwareVersion.cpp
Normal file
100
src/ver_check/SoftwareVersion.cpp
Normal file
@ -0,0 +1,100 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#include "SoftwareVersion.h"
|
||||
|
||||
#include <GFSDKBasic.h>
|
||||
#include <GFSDKExtra.h>
|
||||
#include <GFSDKLog.h>
|
||||
#include <spdlog/spdlog.h>
|
||||
|
||||
#include <QString>
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QString> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QString& qstr, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
QByteArray utf8_array = qstr.toUtf8();
|
||||
return fmt::format_to(ctx.out(), "{}", utf8_array.constData());
|
||||
}
|
||||
};
|
||||
|
||||
template <>
|
||||
struct fmt::formatter<QByteArray> {
|
||||
// Parses format specifications.
|
||||
constexpr auto parse(format_parse_context& ctx) -> decltype(ctx.begin()) {
|
||||
return ctx.begin();
|
||||
}
|
||||
|
||||
// Formats the QString qstr and writes it to the output.
|
||||
template <typename FormatContext>
|
||||
auto format(const QByteArray& qarray, FormatContext& ctx) const
|
||||
-> decltype(ctx.out()) {
|
||||
// Convert QString to UTF-8 QString (to handle Unicode characters
|
||||
// correctly)
|
||||
return fmt::format_to(ctx.out(), "{}", qarray.constData());
|
||||
}
|
||||
};
|
||||
|
||||
auto SoftwareVersion::NeedUpgrade() const -> bool {
|
||||
GFModuleLogDebug(
|
||||
fmt::format(
|
||||
"compair version current {} latest {}, result {}", current_version,
|
||||
latest_version,
|
||||
GFCompareSoftwareVersion(GFModuleStrDup(current_version.toUtf8()),
|
||||
GFModuleStrDup(latest_version.toUtf8())))
|
||||
.c_str());
|
||||
|
||||
GFModuleLogDebug(fmt::format("load done: {}, pre-release: {}, draft: {}",
|
||||
loading_done,
|
||||
latest_prerelease_version_from_remote,
|
||||
latest_draft_from_remote)
|
||||
.c_str());
|
||||
return loading_done && !latest_prerelease_version_from_remote &&
|
||||
!latest_draft_from_remote &&
|
||||
GFCompareSoftwareVersion(GFModuleStrDup(current_version.toUtf8()),
|
||||
GFModuleStrDup(latest_version.toUtf8())) < 0;
|
||||
}
|
||||
|
||||
auto SoftwareVersion::VersionWithdrawn() const -> bool {
|
||||
return loading_done && !current_version_publish_in_remote &&
|
||||
current_version_is_a_prerelease && !current_version_is_drafted;
|
||||
}
|
||||
|
||||
auto SoftwareVersion::CurrentVersionReleased() const -> bool {
|
||||
return loading_done && current_version_publish_in_remote;
|
||||
}
|
83
src/ver_check/SoftwareVersion.h
Normal file
83
src/ver_check/SoftwareVersion.h
Normal file
@ -0,0 +1,83 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <QString>
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
*/
|
||||
struct SoftwareVersion {
|
||||
QString latest_version; ///<
|
||||
QString current_version; ///<
|
||||
bool latest_prerelease_version_from_remote = false; ///<
|
||||
bool latest_draft_from_remote = false; ///<
|
||||
bool current_version_is_a_prerelease = false; ///<
|
||||
bool current_version_is_drafted = false; ///<
|
||||
bool loading_done = false; ///<
|
||||
bool current_version_publish_in_remote = false; ///<
|
||||
QString publish_date; ///<
|
||||
QString release_note; ///<
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
* @return true
|
||||
* @return false
|
||||
*/
|
||||
[[nodiscard]] auto InfoValid() const -> bool { return loading_done; }
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
* @return true
|
||||
* @return false
|
||||
*/
|
||||
[[nodiscard]] auto NeedUpgrade() const -> bool;
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
* @return true
|
||||
* @return false
|
||||
*/
|
||||
[[nodiscard]] auto VersionWithdrawn() const -> bool;
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
* @return true
|
||||
* @return false
|
||||
*/
|
||||
[[nodiscard]] auto CurrentVersionReleased() const -> bool;
|
||||
|
||||
private:
|
||||
static auto version_compare(const QString& a, const QString& b) -> int;
|
||||
};
|
176
src/ver_check/VersionCheckTask.cpp
Normal file
176
src/ver_check/VersionCheckTask.cpp
Normal file
@ -0,0 +1,176 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#include "VersionCheckTask.h"
|
||||
|
||||
#include <GFSDKBasic.h>
|
||||
#include <GFSDKExtra.h>
|
||||
#include <GFSDKLog.h>
|
||||
|
||||
#include <QMetaType>
|
||||
#include <QtNetwork>
|
||||
|
||||
// spdlog
|
||||
#include <spdlog/spdlog.h>
|
||||
|
||||
#include "LogFormatter.h"
|
||||
|
||||
VersionCheckTask::VersionCheckTask()
|
||||
: network_manager_(new QNetworkAccessManager(this)),
|
||||
current_version_(GFProjectVersion()) {
|
||||
qRegisterMetaType<SoftwareVersion>("SoftwareVersion");
|
||||
version_.current_version = current_version_;
|
||||
}
|
||||
|
||||
auto VersionCheckTask::Run() -> int {
|
||||
GFModuleLogDebug(
|
||||
fmt::format("current project version: {}", current_version_).c_str());
|
||||
QString latest_version_url =
|
||||
"https://api.github.com/repos/saturneric/gpgfrontend/releases/latest";
|
||||
|
||||
QNetworkRequest latest_request(latest_version_url);
|
||||
latest_request.setHeader(QNetworkRequest::UserAgentHeader,
|
||||
GFHttpRequestUserAgent());
|
||||
|
||||
latest_reply_ = network_manager_->get(latest_request);
|
||||
connect(latest_reply_, &QNetworkReply::finished, this,
|
||||
&VersionCheckTask::slot_parse_latest_version_info);
|
||||
return 0;
|
||||
}
|
||||
|
||||
void VersionCheckTask::slot_parse_latest_version_info() {
|
||||
if (latest_reply_ == nullptr) {
|
||||
version_.latest_version = current_version_;
|
||||
version_.loading_done = false;
|
||||
} else if (latest_reply_->error() != QNetworkReply::NoError) {
|
||||
GFModuleLogError(fmt::format("latest version request error: ",
|
||||
latest_reply_->errorString())
|
||||
.c_str());
|
||||
version_.latest_version = current_version_;
|
||||
} else {
|
||||
latest_reply_bytes_ = latest_reply_->readAll();
|
||||
auto latest_reply_json = QJsonDocument::fromJson(latest_reply_bytes_);
|
||||
|
||||
if (latest_reply_json.isObject()) {
|
||||
QString latest_version = latest_reply_json["tag_name"].toString();
|
||||
|
||||
QRegularExpression re(R"(^[vV](\d+\.)?(\d+\.)?(\*|\d+))");
|
||||
auto version_match = re.match(latest_version);
|
||||
if (version_match.hasMatch()) {
|
||||
latest_version = version_match.captured(0);
|
||||
GFModuleLogInfo(fmt::format("latest released version from github: {}",
|
||||
latest_version)
|
||||
.c_str());
|
||||
} else {
|
||||
latest_version = current_version_;
|
||||
GFModuleLogWarn(
|
||||
fmt::format("latest version unknown, set to current version: {}",
|
||||
current_version_)
|
||||
.c_str());
|
||||
}
|
||||
|
||||
bool prerelease = latest_reply_json["prerelease"].toBool();
|
||||
bool draft = latest_reply_json["draft"].toBool();
|
||||
auto publish_date = latest_reply_json["published_at"].toString();
|
||||
auto release_note = latest_reply_json["body"].toString();
|
||||
version_.latest_version = latest_version;
|
||||
version_.latest_prerelease_version_from_remote = prerelease;
|
||||
version_.latest_draft_from_remote = draft;
|
||||
version_.publish_date = publish_date;
|
||||
version_.release_note = release_note;
|
||||
} else {
|
||||
GFModuleLogWarn(fmt::format("cannot parse data got from github: {}",
|
||||
latest_reply_bytes_)
|
||||
.c_str());
|
||||
}
|
||||
}
|
||||
|
||||
if (latest_reply_ != nullptr) {
|
||||
latest_reply_->deleteLater();
|
||||
}
|
||||
|
||||
try {
|
||||
QString current_version_url =
|
||||
"https://api.github.com/repos/saturneric/gpgfrontend/releases/tags/" +
|
||||
current_version_;
|
||||
GFModuleLogDebug(
|
||||
fmt::format("current version info query url: {}", current_version_url)
|
||||
.c_str());
|
||||
|
||||
QNetworkRequest current_request(current_version_url);
|
||||
current_request.setHeader(QNetworkRequest::UserAgentHeader,
|
||||
GFHttpRequestUserAgent());
|
||||
|
||||
current_reply_ = network_manager_->get(current_request);
|
||||
|
||||
connect(current_reply_, &QNetworkReply::finished, this,
|
||||
&VersionCheckTask::slot_parse_current_version_info);
|
||||
} catch (...) {
|
||||
GFModuleLogError("current version request create error");
|
||||
}
|
||||
}
|
||||
|
||||
void VersionCheckTask::slot_parse_current_version_info() {
|
||||
if (current_reply_ == nullptr) {
|
||||
// loading done
|
||||
version_.loading_done = false;
|
||||
|
||||
} else if (current_reply_->error() != QNetworkReply::NoError) {
|
||||
GFModuleLogError(fmt::format("current version request network error: {}",
|
||||
current_reply_->errorString())
|
||||
.c_str());
|
||||
|
||||
// loading done
|
||||
version_.loading_done = true;
|
||||
version_.current_version_publish_in_remote = false;
|
||||
} else {
|
||||
version_.current_version_publish_in_remote = true;
|
||||
current_reply_bytes_ = current_reply_->readAll();
|
||||
auto current_reply_json = QJsonDocument::fromJson(current_reply_bytes_);
|
||||
|
||||
if (current_reply_json.isObject()) {
|
||||
bool current_prerelease = current_reply_json["prerelease"].toBool();
|
||||
bool current_draft = current_reply_json["draft"].toBool();
|
||||
version_.latest_prerelease_version_from_remote = current_prerelease;
|
||||
version_.latest_draft_from_remote = current_draft;
|
||||
// loading done
|
||||
version_.loading_done = true;
|
||||
} else {
|
||||
GFModuleLogWarn(fmt::format("cannot parse data got from github: {}",
|
||||
current_reply_bytes_)
|
||||
.c_str());
|
||||
}
|
||||
}
|
||||
|
||||
GFModuleLogDebug(fmt::format("current version parse done: {}",
|
||||
version_.current_version_publish_in_remote)
|
||||
.c_str());
|
||||
|
||||
if (current_reply_ != nullptr) current_reply_->deleteLater();
|
||||
emit SignalUpgradeVersion(version_);
|
||||
}
|
89
src/ver_check/VersionCheckTask.h
Normal file
89
src/ver_check/VersionCheckTask.h
Normal file
@ -0,0 +1,89 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <QObject>
|
||||
|
||||
#include "SoftwareVersion.h"
|
||||
|
||||
class QNetworkReply;
|
||||
class QNetworkAccessManager;
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
*/
|
||||
class VersionCheckTask : public QObject {
|
||||
Q_OBJECT
|
||||
public:
|
||||
/**
|
||||
* @brief Construct a new Version Check Thread object
|
||||
*
|
||||
*/
|
||||
VersionCheckTask();
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
auto Run() -> int;
|
||||
|
||||
signals:
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
* @param version
|
||||
*/
|
||||
void SignalUpgradeVersion(SoftwareVersion version);
|
||||
|
||||
private slots:
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
*/
|
||||
void slot_parse_latest_version_info();
|
||||
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
*/
|
||||
void slot_parse_current_version_info();
|
||||
|
||||
private:
|
||||
QByteArray latest_reply_bytes_; ///<
|
||||
QByteArray current_reply_bytes_; ///<
|
||||
QNetworkReply *latest_reply_ = nullptr; ///< latest version info reply
|
||||
QNetworkReply *current_reply_ = nullptr; ///< current version info reply
|
||||
QNetworkAccessManager *network_manager_; ///<
|
||||
QString current_version_;
|
||||
SoftwareVersion version_;
|
||||
};
|
164
src/ver_check/VersionCheckingModule.cpp
Normal file
164
src/ver_check/VersionCheckingModule.cpp
Normal file
@ -0,0 +1,164 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#include "VersionCheckingModule.h"
|
||||
|
||||
#include <GFSDKBasic.h>
|
||||
#include <GFSDKBuildInfo.h>
|
||||
#include <GFSDKExtra.h>
|
||||
#include <GFSDKLog.h>
|
||||
#include <spdlog/spdlog.h>
|
||||
|
||||
#include <QMetaType>
|
||||
#include <QtNetwork>
|
||||
|
||||
#include "SoftwareVersion.h"
|
||||
#include "VersionCheckTask.h"
|
||||
|
||||
extern void VersionCheckDone(const SoftwareVersion& version);
|
||||
|
||||
auto GFGetModuleGFSDKVersion() -> const char* {
|
||||
return GFModuleStrDup(GF_SDK_VERSION_STR);
|
||||
}
|
||||
|
||||
auto GFGetModuleQtEnvVersion() -> const char* {
|
||||
return GFModuleStrDup(QT_VERSION_STR);
|
||||
}
|
||||
|
||||
auto GFGetModuleID() -> const char* {
|
||||
return GFModuleStrDup("com.bktus.gpgfrontend.module.version_checking");
|
||||
}
|
||||
|
||||
auto GFGetModuleVersion() -> const char* { return GFModuleStrDup("1.0.0"); }
|
||||
|
||||
auto GFGetModuleMetaData() -> GFModuleMetaData* {
|
||||
auto* p_meta = static_cast<GFModuleMetaData*>(
|
||||
GFAllocateMemory(sizeof(GFModuleMetaData)));
|
||||
auto* h_meta = p_meta;
|
||||
|
||||
p_meta->key = "Name";
|
||||
p_meta->value = "VersionChecking";
|
||||
p_meta->next = static_cast<GFModuleMetaData*>(
|
||||
GFAllocateMemory(sizeof(GFModuleMetaData)));
|
||||
p_meta = p_meta->next;
|
||||
|
||||
p_meta->key = "Description";
|
||||
p_meta->value = "Try checking gpgfrontend version";
|
||||
p_meta->next = static_cast<GFModuleMetaData*>(
|
||||
GFAllocateMemory(sizeof(GFModuleMetaData)));
|
||||
p_meta = p_meta->next;
|
||||
|
||||
p_meta->key = "Author";
|
||||
p_meta->value = "Saturneric";
|
||||
p_meta->next = nullptr;
|
||||
|
||||
return h_meta;
|
||||
}
|
||||
|
||||
auto GFRegisterModule() -> int {
|
||||
GFModuleLogInfo("version checking module registering");
|
||||
return 0;
|
||||
}
|
||||
|
||||
auto GFActiveModule() -> int {
|
||||
GFModuleLogInfo("version checking module activating");
|
||||
|
||||
GFModuleListenEvent(GFGetModuleID(), GFModuleStrDup("APPLICATION_LOADED"));
|
||||
GFModuleListenEvent(GFGetModuleID(),
|
||||
GFModuleStrDup("CHECK_APPLICATION_VERSION"));
|
||||
return 0;
|
||||
}
|
||||
|
||||
auto GFExecuteModule(GFModuleEvent* event) -> int {
|
||||
GFModuleLogInfo(
|
||||
fmt::format("version checking module executing, event id: {}", event->id)
|
||||
.c_str());
|
||||
|
||||
auto* task = new VersionCheckTask();
|
||||
QObject::connect(
|
||||
task, &VersionCheckTask::SignalUpgradeVersion, QThread::currentThread(),
|
||||
[event](const SoftwareVersion& version) {
|
||||
VersionCheckDone(version);
|
||||
|
||||
char** event_argv =
|
||||
static_cast<char**>(GFAllocateMemory(sizeof(char**) * 1));
|
||||
event_argv[0] = GFModuleStrDup("0");
|
||||
|
||||
GFModuleTriggerModuleEventCallback(event, GFGetModuleID(), 1,
|
||||
event_argv);
|
||||
});
|
||||
QObject::connect(task, &VersionCheckTask::SignalUpgradeVersion, task,
|
||||
&QObject::deleteLater);
|
||||
task->Run();
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
auto GFDeactiveModule() -> int { return 0; }
|
||||
|
||||
auto GFUnregisterModule() -> int { return 0; }
|
||||
|
||||
void VersionCheckDone(const SoftwareVersion& version) {
|
||||
GFModuleLogDebug("filling software information info in rt...");
|
||||
|
||||
GFModuleUpsertRTValue(GFGetModuleID(),
|
||||
GFModuleStrDup("version.current_version"),
|
||||
GFModuleStrDup(version.current_version.toUtf8()));
|
||||
GFModuleUpsertRTValue(GFGetModuleID(),
|
||||
GFModuleStrDup("version.latest_version"),
|
||||
GFModuleStrDup(version.latest_version.toUtf8()));
|
||||
GFModuleUpsertRTValueBool(
|
||||
GFGetModuleID(), GFModuleStrDup("version.current_version_is_drafted"),
|
||||
version.current_version_is_drafted ? 1 : 0);
|
||||
GFModuleUpsertRTValueBool(
|
||||
GFGetModuleID(),
|
||||
GFModuleStrDup("version.current_version_is_a_prerelease"),
|
||||
version.current_version_is_a_prerelease ? 1 : 0);
|
||||
GFModuleUpsertRTValueBool(
|
||||
GFGetModuleID(),
|
||||
GFModuleStrDup("version.current_version_publish_in_remote"),
|
||||
version.current_version_publish_in_remote ? 1 : 0);
|
||||
GFModuleUpsertRTValueBool(
|
||||
GFGetModuleID(),
|
||||
GFModuleStrDup("version.latest_prerelease_version_from_remote"),
|
||||
version.latest_prerelease_version_from_remote ? 1 : 0);
|
||||
GFModuleUpsertRTValueBool(GFGetModuleID(),
|
||||
GFModuleStrDup("version.need_upgrade"),
|
||||
version.NeedUpgrade() ? 1 : 0);
|
||||
GFModuleUpsertRTValueBool(GFGetModuleID(),
|
||||
GFModuleStrDup("version.current_version_released"),
|
||||
version.CurrentVersionReleased() ? 1 : 0);
|
||||
GFModuleUpsertRTValueBool(
|
||||
GFGetModuleID(), GFModuleStrDup("version.current_a_withdrawn_version"),
|
||||
version.VersionWithdrawn() ? 1 : 0);
|
||||
GFModuleUpsertRTValueBool(GFGetModuleID(),
|
||||
GFModuleStrDup("version.loading_done"),
|
||||
version.loading_done ? 1 : 0);
|
||||
|
||||
GFModuleLogDebug("software information filled in rt");
|
||||
}
|
56
src/ver_check/VersionCheckingModule.h
Normal file
56
src/ver_check/VersionCheckingModule.h
Normal file
@ -0,0 +1,56 @@
|
||||
/**
|
||||
* Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
*
|
||||
* This file is part of GpgFrontend.
|
||||
*
|
||||
* GpgFrontend is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* GpgFrontend 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
*
|
||||
* The initial version of the source code is inherited from
|
||||
* the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
*
|
||||
* All the source code of GpgFrontend was modified and released by
|
||||
* Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <GFSDKModule.h>
|
||||
|
||||
#include "GFModuleExport.h"
|
||||
|
||||
extern "C" {
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleGFSDKVersion() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleQtEnvVersion() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleID() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleVersion() -> const char *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFGetModuleMetaData() -> GFModuleMetaData *;
|
||||
|
||||
auto GF_MODULE_EXPORT GFRegisterModule() -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFActiveModule() -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFExecuteModule(GFModuleEvent *) -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFDeactiveModule() -> int;
|
||||
|
||||
auto GF_MODULE_EXPORT GFUnregisterModule() -> int;
|
||||
};
|
26
third_party/CMakeLists.txt
vendored
Normal file
26
third_party/CMakeLists.txt
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
# Copyright (C) 2021 Saturneric <eric@bktus.com>
|
||||
#
|
||||
# This file is part of GpgFrontend.
|
||||
#
|
||||
# GpgFrontend is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# GpgFrontend 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 General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# The initial version of the source code is inherited from
|
||||
# the gpg4usb project, which is under GPL-3.0-or-later.
|
||||
#
|
||||
# All the source code of GpgFrontend was modified and released by
|
||||
# Saturneric <eric@bktus.com> starting on May 12, 2021.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
add_subdirectory(spdlog EXCLUDE_FROM_ALL)
|
1
third_party/spdlog
vendored
Submodule
1
third_party/spdlog
vendored
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit d276069a6e916b1e1fd45885b15b72bd8ee000a7
|
Loading…
Reference in New Issue
Block a user