Compare commits
6 Commits
Author | SHA1 | Date |
---|---|---|
Jonas Letzbor | 1cc5378566 | |
Jonas Letzbor | 987bed7177 | |
Jonas Letzbor | afba495440 | |
Jonas Letzbor | 3ce008c97e | |
Jonas Letzbor | 65cfa0ec64 | |
Jonas Letzbor | 58121dabdc |
|
@ -0,0 +1,10 @@
|
||||||
|
**/.git
|
||||||
|
ncDocConverth-*
|
||||||
|
|
||||||
|
# Space for private notes
|
||||||
|
notes/
|
||||||
|
|
||||||
|
# Locally used configuration file
|
||||||
|
config.yaml
|
||||||
|
ncConverter.json
|
||||||
|
config-docker.yaml
|
|
@ -24,9 +24,16 @@ go.work
|
||||||
# Locally used configuration file
|
# Locally used configuration file
|
||||||
/config.yaml
|
/config.yaml
|
||||||
/ncConverter.json
|
/ncConverter.json
|
||||||
|
/config-docker.yaml
|
||||||
|
|
||||||
# Vite build file
|
# Vite build file
|
||||||
/.vite
|
/.vite
|
||||||
|
|
||||||
# Log files
|
# Log files
|
||||||
*.log
|
*.log
|
||||||
|
|
||||||
|
# Build binaries
|
||||||
|
/ncDocConverth-*
|
||||||
|
|
||||||
|
# Space for private notes
|
||||||
|
/notes
|
|
@ -0,0 +1,23 @@
|
||||||
|
# Build go binary
|
||||||
|
FROM docker.io/golang:1.20-alpine3.17 AS builder
|
||||||
|
|
||||||
|
ARG VERSION=0.0.0
|
||||||
|
WORKDIR /build
|
||||||
|
|
||||||
|
# To optimize the cache only copy and install the dependencies inside of the file "go.sum"
|
||||||
|
COPY go.sum go.mod ./
|
||||||
|
RUN go mod download
|
||||||
|
|
||||||
|
# Copy now all files
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Build the binary
|
||||||
|
RUN GOOS=linux GOARCH=amd64 go build -o ncDocConverth -ldflags "-X main.version=${VERSION}" ./cmd/ncDocConverth
|
||||||
|
|
||||||
|
|
||||||
|
# Image to run the binary
|
||||||
|
FROM docker.io/alpine:3.18
|
||||||
|
|
||||||
|
COPY --from=builder --chmod=0777 /build/ncDocConverth /app/ncDocConverth
|
||||||
|
|
||||||
|
CMD [ "/app/ncDocConverth", "--config", "/config/config.yaml" ]
|
|
@ -0,0 +1,203 @@
|
||||||
|
// Base class containing the git configuration
|
||||||
|
class Configuration {
|
||||||
|
|
||||||
|
// (Long) Hash value of the current commit
|
||||||
|
String commitHash;
|
||||||
|
// Name of the current Branch
|
||||||
|
String branch;
|
||||||
|
|
||||||
|
// The last available tag in the git commit history
|
||||||
|
String lastTag;
|
||||||
|
// Tag value of the current commit
|
||||||
|
String[] currentTags;
|
||||||
|
|
||||||
|
// Tag used to update the helm values
|
||||||
|
String updateTag = ""
|
||||||
|
String updateFile = ""
|
||||||
|
String updateFile2 = ""
|
||||||
|
|
||||||
|
// Tags returns the tags to apply for the build container image.
|
||||||
|
def Tags() {
|
||||||
|
ArrayList rtc = []
|
||||||
|
|
||||||
|
// Building on master branch
|
||||||
|
if (branch == "master" || branch == "main") {
|
||||||
|
// When building on the master branch always use the provided tags for the current commit
|
||||||
|
if (currentTags != null) rtc.addAll(currentTags)
|
||||||
|
|
||||||
|
// The master branch is used for "release candidate" and "production build"
|
||||||
|
currentTags.each {
|
||||||
|
if (it.contains("-rc.")) {
|
||||||
|
// Update tag "latest-rc" because a tag like "v1.10.0-rc.1" was provided
|
||||||
|
rtc << "rc-latest"
|
||||||
|
updateTag = it
|
||||||
|
updateFile = "rc"
|
||||||
|
} else {
|
||||||
|
// The tag is not a rc -> new "production" release
|
||||||
|
rtc << "latest"
|
||||||
|
updateTag = it
|
||||||
|
updateFile = "main"
|
||||||
|
// Also update the rc when "main" was updated
|
||||||
|
updateFile2 = "rc"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Also push a tag with the current commit hash
|
||||||
|
rtc << "main-" + commitHash
|
||||||
|
} else if (branch == "snapshot") {
|
||||||
|
// For security reasons the tags on the snapshot branch are not used for tagging
|
||||||
|
rtc << "snapshot-latest"
|
||||||
|
|
||||||
|
// Otherwise only push a tag with the current commit hash
|
||||||
|
rtc << "snapshot-" + commitHash
|
||||||
|
|
||||||
|
updateTag = "snapshot-" + commitHash
|
||||||
|
updateFile = "snapshot"
|
||||||
|
} else {
|
||||||
|
currentBuild.result = 'ABORTED'
|
||||||
|
error("Received not supported branch for building container image: '" + branch + "'")
|
||||||
|
}
|
||||||
|
|
||||||
|
return rtc
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns the current version of the program that should be used during building
|
||||||
|
String Version() {
|
||||||
|
if (branch == "master" || branch == "main") {
|
||||||
|
return lastTag
|
||||||
|
} else {
|
||||||
|
// Otherwiese add a "-snapshot" to the last tagged version
|
||||||
|
return "" + lastTag.replace("(?<=v\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}).*", "") + "-dev"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// Global variables
|
||||||
|
def Configuration gitConfig = new Configuration()
|
||||||
|
def String VERSION
|
||||||
|
|
||||||
|
// App used for helm identification and commit message
|
||||||
|
def String APP_NAME = "ncDocConverter"
|
||||||
|
|
||||||
|
pipeline {
|
||||||
|
|
||||||
|
agent {
|
||||||
|
// Use the kubernetes agent
|
||||||
|
kubernetes {
|
||||||
|
label 'podman-low'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
stages {
|
||||||
|
|
||||||
|
stage('Initializing variables') {
|
||||||
|
steps {
|
||||||
|
script {
|
||||||
|
gitConfig.commitHash = "${env.GIT_COMMIT}"
|
||||||
|
gitConfig.branch = "${env.GIT_BRANCH}"
|
||||||
|
|
||||||
|
currentTags = sh (
|
||||||
|
script: 'git tag --points-at HEAD',
|
||||||
|
returnStdout: true
|
||||||
|
)
|
||||||
|
if (currentTags != "") {
|
||||||
|
gitConfig.currentTags = currentTags.split("\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
gitConfig.lastTag = sh (
|
||||||
|
script: 'git describe --tags --abbrev=0',
|
||||||
|
returnStdout: true
|
||||||
|
).replace("\n", "")
|
||||||
|
|
||||||
|
// Apply the current version code
|
||||||
|
VERSION = gitConfig.Version()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
stage('Build') {
|
||||||
|
steps {
|
||||||
|
echo "Building Version '${VERSION}' and tagging it with '${gitConfig.Tags()}'"
|
||||||
|
container('podman-low') {
|
||||||
|
script {
|
||||||
|
|
||||||
|
withEnv([ "version=${VERSION}", "commit=${gitConfig.commitHash}" ]) {
|
||||||
|
sh 'buildah bud --layers --build-arg VERSION="${version}" --tag=rpjosh.de/jenkins-ncdocconverter:${commit} \
|
||||||
|
--cache-to=git.rpjosh.de/build-cache/ncdocconverter --cache-from=git.rpjosh.de/build-cache/ncdocconverter \
|
||||||
|
-f Dockerfile .'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
stage('Publish') {
|
||||||
|
steps {
|
||||||
|
echo "Publish to docker repository (git.rpjosh.de/rpdb)"
|
||||||
|
container('podman-low') {
|
||||||
|
script {
|
||||||
|
gitConfig.Tags().each {
|
||||||
|
sh "buildah push rpjosh.de/jenkins-ncdocconverter:${gitConfig.commitHash} docker://git.rpjosh.de/rpjosh-container/ncdocconverter:${it}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
stage('Deploy') {
|
||||||
|
steps {
|
||||||
|
|
||||||
|
container('podman-low') {
|
||||||
|
script {
|
||||||
|
|
||||||
|
configFileProvider([configFile(fileId: 'deployConfig', variable: 'confFile')]) {
|
||||||
|
script {
|
||||||
|
// Read the kubernets deploy configuration from the file
|
||||||
|
def config = readJSON file:"$confFile"
|
||||||
|
def String url = config.kubernetes.gitHelmValues + APP_NAME + "/" + gitConfig.updateFile + ".yaml"
|
||||||
|
def String url2 = config.kubernetes.gitHelmValues + APP_NAME + "/" + gitConfig.updateFile2 + ".yaml"
|
||||||
|
|
||||||
|
sh "echo Using git URL '${url}'"
|
||||||
|
// Get the current file content, replace the tag, and push the mmodified tag again
|
||||||
|
withCredentials([ string(credentialsId: 'GIT_API_KEY', variable: "gitApiKey") ]) {
|
||||||
|
withEnv([ "url=${url}", "url2=${url2}", "tag=${gitConfig.updateTag}", "file=${gitConfig.updateFile}", "app=${APP_NAME}" ]) {
|
||||||
|
// Exit when one command does fail in pipe
|
||||||
|
sh "set -e && set -o pipefail"
|
||||||
|
|
||||||
|
if (gitConfig.updateFile == "main") {
|
||||||
|
echo "Updating git configuration dirctory (${APP_NAME}/${gitConfig.updateFile}.yaml) with tag [${gitConfig.updateTag}]"
|
||||||
|
|
||||||
|
sh 'curl -s "https://notNeeded:${gitApiKey}@${url}" | jq -r .content | base64 --decode > tmp_values.yaml'
|
||||||
|
sh 'curl -s --fail-with-body "https://notNeeded:${gitApiKey}@${url}" -X PUT -H "Content-Type: application/json" -d \
|
||||||
|
\'{ "content": "\'"$(cat tmp_values.yaml | sed -e \'s/tag: ".*"/tag: "\'$tag\'"/g\' | base64 -w 0)"\'", "message": "[CI] Update image for \'"$app-$file"\'", \
|
||||||
|
"sha": "\'$(git hash-object tmp_values.yaml | tr -d "\\n")\'" }\' '
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
post {
|
||||||
|
success {
|
||||||
|
sh 'echo Build finished'
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clean after build
|
||||||
|
cleanup {
|
||||||
|
cleanWs()
|
||||||
|
}
|
||||||
|
|
||||||
|
failure {
|
||||||
|
emailext body: "${currentBuild.currentResult}: Job ${env.JOB_NAME} build ${env.BUILD_NUMBER}\n More info at: ${env.BUILD_URL}",
|
||||||
|
recipientProviders: [[$class: 'DevelopersRecipientProvider'], [$class: 'RequesterRecipientProvider']],
|
||||||
|
subject: "Jenkins Build ${currentBuild.currentResult}: Job ${env.JOB_NAME}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,662 @@
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are 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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
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 Affero 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
|
||||||
|
model, 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
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 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 work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
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 AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
|
@ -0,0 +1,38 @@
|
||||||
|
# Get the current version
|
||||||
|
VERSION=$(shell cat ./VERSION)
|
||||||
|
WORKDIR=$(shell pwd)
|
||||||
|
UID=$(shell echo $uid)
|
||||||
|
|
||||||
|
.PHONY: help
|
||||||
|
|
||||||
|
# Output help for every task
|
||||||
|
help:
|
||||||
|
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
|
||||||
|
.DEFAULT_GOAL := help
|
||||||
|
|
||||||
|
build: ## Build the container image (with cache)
|
||||||
|
buildah bud --layers --build-arg VERSION="$(VERSION)" \
|
||||||
|
--tag=git.rpjosh.de/ncDocConverter:v$(VERSION)-dev \
|
||||||
|
-f Dockerfile .
|
||||||
|
build-nc: ## Build the container image (without cache)
|
||||||
|
buildah bud --layers --no-cache --build-arg VERSION="$(VERSION)" \
|
||||||
|
--tag=git.rpjosh.de/ncDocConverter:v$(VERSION)-dev \
|
||||||
|
-f Dockerfile .
|
||||||
|
|
||||||
|
run: ## Run the container with
|
||||||
|
@ make stop > /dev/null 2>&1 || true
|
||||||
|
@ podman run -it --name ncDocConverter --userns=keep-id --cap-drop ALL -p 40001:40001 -e PORT=40001 \
|
||||||
|
-e DATA_FILE='./config/data.json' \
|
||||||
|
-v "$(WORKDIR)/ncConverter.json:/config/data.json" \
|
||||||
|
-v "$(WORKDIR)/config.yaml:/config/config.yaml" \
|
||||||
|
git.rpjosh.de/ncDocConverter:v$(VERSION)-dev
|
||||||
|
stop: ## Stop and removes a previous started container
|
||||||
|
@ podman stop ncDocConverter; podman rm ncDocConverter
|
||||||
|
|
||||||
|
clear-images: ## Remove all previously build images and all intermediate images created by this makefile
|
||||||
|
podman rmi $$(podman images -a | grep -e '<none>' -e '\/ncdocconverter-.*' | awk '{ print $3 }') -f
|
||||||
|
|
||||||
|
|
||||||
|
# Required secrets:
|
||||||
|
# Android Key Store (jks) file - androidKeystore
|
||||||
|
# Android Key Store password (cleartext) - androidKeystorePassword
|
|
@ -5,11 +5,13 @@ import (
|
||||||
"net/http"
|
"net/http"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"rpjosh.de/ncDocConverter/internal/models"
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
"rpjosh.de/ncDocConverter/internal/ncworker"
|
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
"git.rpjosh.de/ncDocConverter/internal/ncworker"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var version string
|
||||||
|
|
||||||
type WebApplication struct {
|
type WebApplication struct {
|
||||||
logger *logger.Logger
|
logger *logger.Logger
|
||||||
config *models.WebConfig
|
config *models.WebConfig
|
||||||
|
@ -18,7 +20,7 @@ type WebApplication struct {
|
||||||
func main() {
|
func main() {
|
||||||
defer logger.CloseFile()
|
defer logger.CloseFile()
|
||||||
|
|
||||||
config, err := models.SetConfig()
|
config, err := models.SetConfig(version)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Error(err.Error())
|
logger.Error(err.Error())
|
||||||
}
|
}
|
||||||
|
@ -51,13 +53,14 @@ func main() {
|
||||||
WriteTimeout: 10 * time.Second,
|
WriteTimeout: 10 * time.Second,
|
||||||
}
|
}
|
||||||
|
|
||||||
ncConvertUsers, err := models.ParseConvertUsers("./ncConverter.json")
|
ncConvertUsers, err := models.ParseConvertUsers(webApp.config.Server.JobFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Error("Unable to parse the file %s: %s", "dd", err)
|
logger.Error("Unable to parse the file %s: %s", "dd", err)
|
||||||
}
|
}
|
||||||
ncworker.NewScheduler(ncConvertUsers, config)
|
ncworker.NewScheduler(ncConvertUsers, config)
|
||||||
|
|
||||||
if 1 == 1 {
|
if 1 == 1 {
|
||||||
|
// Webserver for BookStack hooks currently not implemented
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -5,8 +5,8 @@ import (
|
||||||
"net/http"
|
"net/http"
|
||||||
"runtime/debug"
|
"runtime/debug"
|
||||||
|
|
||||||
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
"github.com/justinas/nosurf"
|
"github.com/justinas/nosurf"
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func secureHeaders(next http.Handler) http.Handler {
|
func secureHeaders(next http.Handler) http.Handler {
|
||||||
|
|
|
@ -3,9 +3,9 @@ package main
|
||||||
import (
|
import (
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
|
"git.rpjosh.de/ncDocConverter/internal/api"
|
||||||
"github.com/go-chi/chi/v5"
|
"github.com/go-chi/chi/v5"
|
||||||
"github.com/go-chi/chi/v5/middleware"
|
"github.com/go-chi/chi/v5/middleware"
|
||||||
"rpjosh.de/ncDocConverter/internal/api"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func (app *WebApplication) routes() http.Handler {
|
func (app *WebApplication) routes() http.Handler {
|
||||||
|
|
|
@ -9,6 +9,9 @@ server:
|
||||||
# Afterward the program does exit -> The "execution" field in the jobs are going to be ignored
|
# Afterward the program does exit -> The "execution" field in the jobs are going to be ignored
|
||||||
oneShot: false
|
oneShot: false
|
||||||
|
|
||||||
|
# Location of the file with the job configurations
|
||||||
|
jobFile: "./ncConverter.json"
|
||||||
|
|
||||||
logging:
|
logging:
|
||||||
# Minimum log Level for printing to the console (debug, info, warning, error, fatal)
|
# Minimum log Level for printing to the console (debug, info, warning, error, fatal)
|
||||||
printLogLevel: info
|
printLogLevel: info
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
// NOTE: This is not a valid JSON file.
|
||||||
|
// Remove all comments and rename the file from '.hjson' to '.json'
|
||||||
{
|
{
|
||||||
"nextcloudUsers": [
|
"nextcloudUsers": [
|
||||||
{
|
{
|
||||||
// Nextcloud user and instance to save the converted files
|
// Nextcloud user and instance to save the converted files
|
||||||
"nextcloudUrl": "https://cloud.rpjosh.de",
|
"nextcloudUrl": "https://cloud.myDomain.de",
|
||||||
"username": "exchange",
|
"username": "myUser",
|
||||||
"password": "Zj9cQ-eF3n6-R6DSt-8sJXf-kYseJ",
|
"password": "A41cP-eR3n6-OIP13-8sQ1f-kYqp3",
|
||||||
|
|
||||||
// OnlyOffice (docx, xlsx, ...) convertion to pdf
|
// OnlyOffice (docx, xlsx, ...) convertion to pdf
|
||||||
"jobs": [
|
"jobs": [
|
||||||
|
@ -27,9 +29,9 @@
|
||||||
|
|
||||||
// Conversion from bookStack to pdf/html
|
// Conversion from bookStack to pdf/html
|
||||||
"bookStack": {
|
"bookStack": {
|
||||||
"url": "https://wiki.rpjosh.de",
|
"url": "https://wiki.myDomain.de",
|
||||||
"username": "test@rpjosh.de",
|
"username": "test@rpjosh.de",
|
||||||
"apiToken": "typCf2LoSQDHicpeeAZQCDZwAq7BvVdl:PcKMZVDrIwEJeKIKyaD7w0cf20JCjpZz",
|
"apiToken": "typfe29famd983amdk12a93:ave550l3fqu72cays51o84da71fvlqvtia6x19wZz",
|
||||||
|
|
||||||
"jobs": [
|
"jobs": [
|
||||||
{
|
{
|
||||||
|
|
|
@ -1,21 +1,46 @@
|
||||||
{
|
{
|
||||||
"users": [
|
"nextcloudUsers": [
|
||||||
{
|
{
|
||||||
"authUser": "Unique Username (from ",
|
|
||||||
"nextcloudUrl": "https://cloud.myDomain.de",
|
"nextcloudUrl": "https://cloud.myDomain.de",
|
||||||
"username": "MyUsername",
|
"username": "myUser",
|
||||||
"password": "App Password",
|
"password": "A41cP-eR3n6-OIP13-8sQ1f-kYqp3",
|
||||||
|
|
||||||
"jobs": [
|
"jobs": [
|
||||||
{
|
{
|
||||||
"jobName": "",
|
"jobName": "Convert my books",
|
||||||
"sourceDir": "Arbeit/",
|
"sourceDir": "api/",
|
||||||
"destinationDir": "Ebooks/",
|
"destinationDir": "ebooks/",
|
||||||
|
|
||||||
"keepFolders": true,
|
"keepFolders": true,
|
||||||
"recursive": true,
|
"recursive": true,
|
||||||
"execution": [ "01:00", "15:00" ]
|
"execution": "45 23 * * 6"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
"bookStack": {
|
||||||
|
"url": "https://wiki.myDomain.de",
|
||||||
|
"username": "test@myDomain.de",
|
||||||
|
"apiToken": "typfe29famd983amdk12a93:ave550l3fqu72cays51o84da71fvlqvtia6x19wZz",
|
||||||
|
|
||||||
|
"jobs": [
|
||||||
|
{
|
||||||
|
"jobName": "Convert my favorite books",
|
||||||
|
|
||||||
|
"shelves": [ "Work", "Linux" ],
|
||||||
|
"shelveRegex": "",
|
||||||
|
|
||||||
|
"books": [],
|
||||||
|
"booksRegex": "",
|
||||||
|
|
||||||
|
"includeBooksWithoutShelve": false,
|
||||||
|
"destinationDir": "ebooks/wiki/",
|
||||||
|
"format": "html",
|
||||||
|
"keepStructure": true,
|
||||||
|
"execution": "45 23 * * 6",
|
||||||
|
"cache": 3
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
16
go.mod
16
go.mod
|
@ -1,15 +1,19 @@
|
||||||
module rpjosh.de/ncDocConverter
|
module git.rpjosh.de/ncDocConverter
|
||||||
|
|
||||||
go 1.18
|
go 1.18
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/go-chi/chi/v5 v5.0.8 // indirect
|
github.com/go-chi/chi/v5 v5.0.8
|
||||||
github.com/go-co-op/gocron v1.18.0 // indirect
|
github.com/go-co-op/gocron v1.18.0
|
||||||
github.com/go-yaml/yaml v2.1.0+incompatible // indirect
|
github.com/justinas/nosurf v1.1.1
|
||||||
github.com/justinas/nosurf v1.1.1 // indirect
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
git.rpjosh.de/RPJosh/go-logger v1.2.0 // indirect
|
||||||
github.com/robfig/cron/v3 v3.0.1 // indirect
|
github.com/robfig/cron/v3 v3.0.1 // indirect
|
||||||
golang.org/x/sync v0.1.0 // indirect
|
golang.org/x/sync v0.1.0 // indirect
|
||||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
golang.org/x/sys v0.11.0 // indirect
|
||||||
)
|
)
|
||||||
|
|
||||||
// https://zhwt.github.io/yaml-to-go/
|
// https://zhwt.github.io/yaml-to-go/
|
||||||
|
|
4
go.sum
4
go.sum
|
@ -1,3 +1,5 @@
|
||||||
|
git.rpjosh.de/RPJosh/go-logger v1.2.0 h1:Xvd4RDUYbf+pQH7dvCOYomymDGXBFDnN6K7C49QsZPw=
|
||||||
|
git.rpjosh.de/RPJosh/go-logger v1.2.0/go.mod h1:iD3KaRyOIkYMj7E+xFMn5uDVCzW1lSJQopz1Fl1+BSM=
|
||||||
github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8=
|
github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8=
|
||||||
github.com/go-chi/chi/v5 v5.0.7/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
|
github.com/go-chi/chi/v5 v5.0.7/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
|
||||||
github.com/go-chi/chi/v5 v5.0.8 h1:lD+NLqFcAi1ovnVZpsnObHGW4xb4J8lNmoYVfECH1Y0=
|
github.com/go-chi/chi/v5 v5.0.8 h1:lD+NLqFcAi1ovnVZpsnObHGW4xb4J8lNmoYVfECH1Y0=
|
||||||
|
@ -16,6 +18,8 @@ golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cO
|
||||||
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
|
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
|
||||||
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
|
golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM=
|
||||||
|
golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
|
|
|
@ -0,0 +1,11 @@
|
||||||
|
apiVersion: v2
|
||||||
|
name: ncdocconverter
|
||||||
|
description: A Helm chart for thetool 'ncDocConverter'
|
||||||
|
|
||||||
|
type: application
|
||||||
|
|
||||||
|
# Helm chart version
|
||||||
|
version: 0.1.0
|
||||||
|
|
||||||
|
# Application version
|
||||||
|
appVersion: "1.0.0"
|
|
@ -0,0 +1,31 @@
|
||||||
|
{{/*
|
||||||
|
Expand the name of the chart.
|
||||||
|
*/}}
|
||||||
|
{{- define ".name" -}}
|
||||||
|
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
{{/*
|
||||||
|
Create a default fully qualified app name.
|
||||||
|
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
|
||||||
|
If release name contains chart name it will be used as a full name.
|
||||||
|
*/}}
|
||||||
|
{{- define ".fullname" -}}
|
||||||
|
{{- if .Values.fullnameOverride }}
|
||||||
|
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
|
||||||
|
{{- else }}
|
||||||
|
{{- $name := default .Chart.Name .Values.nameOverride }}
|
||||||
|
{{- if contains $name .Release.Name }}
|
||||||
|
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
|
||||||
|
{{- else }}
|
||||||
|
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
{{/*
|
||||||
|
Create chart name and version as used by the chart label.
|
||||||
|
*/}}
|
||||||
|
{{- define ".chart" -}}
|
||||||
|
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
|
||||||
|
{{- end }}
|
|
@ -0,0 +1,9 @@
|
||||||
|
apiVersion: v1
|
||||||
|
kind: ConfigMap
|
||||||
|
metadata:
|
||||||
|
name: {{ include ".fullname" . }}-config
|
||||||
|
data:
|
||||||
|
config.yaml: |
|
||||||
|
server:
|
||||||
|
oneShot: false
|
||||||
|
jobFile: /config/data.json
|
|
@ -0,0 +1,65 @@
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: {{ include ".fullname" . }}
|
||||||
|
labels:
|
||||||
|
app: {{ include ".fullname" . }}
|
||||||
|
spec:
|
||||||
|
replicas: 1
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app: {{ include ".fullname" . }}
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
app: {{ include ".fullname" . }}
|
||||||
|
spec:
|
||||||
|
{{- with .Values.imagePullSecrets }}
|
||||||
|
imagePullSecrets:
|
||||||
|
{{- toYaml . | nindent 8 }}
|
||||||
|
{{- end }}
|
||||||
|
containers:
|
||||||
|
- name: {{ include ".fullname" . }}
|
||||||
|
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
|
||||||
|
imagePullPolicy: {{ .Values.image.pullPolicy }}
|
||||||
|
|
||||||
|
# Limit rights
|
||||||
|
securityContext:
|
||||||
|
allowPrivilegeEscalation: false
|
||||||
|
capabilities: {}
|
||||||
|
privileged: false
|
||||||
|
readOnlyRootFilesystem: false
|
||||||
|
runAsNonRoot: true
|
||||||
|
runAsUser: 1111
|
||||||
|
|
||||||
|
volumeMounts:
|
||||||
|
- name: config-volume
|
||||||
|
mountPath: /config/config.yaml
|
||||||
|
readOnly: true
|
||||||
|
subPath: config.yaml
|
||||||
|
- name: secrets
|
||||||
|
mountPath: /config/data.json
|
||||||
|
readOnly: true
|
||||||
|
subPath: data.json
|
||||||
|
|
||||||
|
env:
|
||||||
|
# Aggregator settings
|
||||||
|
- name: LOGGER_PRINTLEVEL
|
||||||
|
value: {{ .Values.config.logLevel }}
|
||||||
|
|
||||||
|
# Limit provided ressources
|
||||||
|
resources:
|
||||||
|
{{- toYaml .Values.resources | nindent 10 }}
|
||||||
|
volumes:
|
||||||
|
- name: config-volume
|
||||||
|
configMap:
|
||||||
|
name: {{ include ".fullname" . }}-config
|
||||||
|
items:
|
||||||
|
- key: config.yaml
|
||||||
|
path: config.yaml
|
||||||
|
- name: secrets
|
||||||
|
secret:
|
||||||
|
secretName: {{ .Values.dataSecret }}
|
||||||
|
items:
|
||||||
|
- key: data.json
|
||||||
|
path: data.json
|
|
@ -0,0 +1,30 @@
|
||||||
|
# Overrides the full name of the chart
|
||||||
|
fullnameOverride: ""
|
||||||
|
|
||||||
|
# Limit provided ressources
|
||||||
|
resources:
|
||||||
|
requests:
|
||||||
|
memory: "30Mi"
|
||||||
|
cpu: "20m"
|
||||||
|
limits:
|
||||||
|
memory: "60Mi"
|
||||||
|
cpu: "70m"
|
||||||
|
|
||||||
|
|
||||||
|
image:
|
||||||
|
# Repository to download the image from
|
||||||
|
repository: git.rpjosh.de/rpjosh-container/ncDocConverter
|
||||||
|
pullPolicy: IfNotPresent
|
||||||
|
# Overrides the image tag whose default is the chart appVersion
|
||||||
|
tag: ""
|
||||||
|
|
||||||
|
# Secret to use during fetching the image
|
||||||
|
imagePullSecrets: []
|
||||||
|
|
||||||
|
# Configuration options for the app
|
||||||
|
config:
|
||||||
|
# Minimum log level for printing to the console. Possible options are debug,info,warn,error
|
||||||
|
logLevel: info
|
||||||
|
|
||||||
|
# The secret name with the 'ncConverter.json' file as 'data.json' entry
|
||||||
|
dataSecret: ''
|
|
@ -3,8 +3,8 @@ package api
|
||||||
import (
|
import (
|
||||||
"github.com/go-chi/chi/v5"
|
"github.com/go-chi/chi/v5"
|
||||||
|
|
||||||
"rpjosh.de/ncDocConverter/internal/models"
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Api struct {
|
type Api struct {
|
||||||
|
|
|
@ -2,10 +2,12 @@ package models
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"flag"
|
"flag"
|
||||||
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
|
"git.rpjosh.de/ncDocConverter/pkg/utils"
|
||||||
yaml "gopkg.in/yaml.v3"
|
yaml "gopkg.in/yaml.v3"
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type WebConfig struct {
|
type WebConfig struct {
|
||||||
|
@ -17,6 +19,8 @@ type Server struct {
|
||||||
Address string `yaml:"address"`
|
Address string `yaml:"address"`
|
||||||
Certificate string `yaml:"certificate"`
|
Certificate string `yaml:"certificate"`
|
||||||
OneShot bool `yaml:"oneShot"`
|
OneShot bool `yaml:"oneShot"`
|
||||||
|
JobFile string `yaml:"jobFile"`
|
||||||
|
Version string
|
||||||
}
|
}
|
||||||
|
|
||||||
type Logging struct {
|
type Logging struct {
|
||||||
|
@ -47,6 +51,7 @@ func getDefaultConfig() *WebConfig {
|
||||||
return &WebConfig{
|
return &WebConfig{
|
||||||
Server: Server{
|
Server: Server{
|
||||||
Address: ":4000",
|
Address: ":4000",
|
||||||
|
JobFile: utils.GetEnvString("DATA_FILE", "./ncConverter.json"),
|
||||||
},
|
},
|
||||||
Logging: Logging{
|
Logging: Logging{
|
||||||
PrintLogLevel: "info",
|
PrintLogLevel: "info",
|
||||||
|
@ -56,7 +61,7 @@ func getDefaultConfig() *WebConfig {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Applies the cli and the configuration options from the config files
|
// Applies the cli and the configuration options from the config files
|
||||||
func SetConfig() (*WebConfig, error) {
|
func SetConfig(version string) (*WebConfig, error) {
|
||||||
configPath := "./config.yaml"
|
configPath := "./config.yaml"
|
||||||
// the path of the configuration file is needed first to determine the "default" values
|
// the path of the configuration file is needed first to determine the "default" values
|
||||||
for i, arg := range os.Args {
|
for i, arg := range os.Args {
|
||||||
|
@ -66,6 +71,8 @@ func SetConfig() (*WebConfig, error) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
webConfig := getDefaultConfig()
|
webConfig := getDefaultConfig()
|
||||||
|
webConfig.Server.Version = version
|
||||||
|
|
||||||
webConfig, err := ParseWebConfig(webConfig, configPath)
|
webConfig, err := ParseWebConfig(webConfig, configPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Error("Unable to parse the configuration file '%s': %s", configPath, err)
|
logger.Error("Unable to parse the configuration file '%s': %s", configPath, err)
|
||||||
|
@ -77,19 +84,25 @@ func SetConfig() (*WebConfig, error) {
|
||||||
address := flag.String("address", webConfig.Server.Address, "Address and port on which the api and the web server should listen to")
|
address := flag.String("address", webConfig.Server.Address, "Address and port on which the api and the web server should listen to")
|
||||||
printLogLevel := flag.String("printLogLevel", webConfig.Logging.PrintLogLevel, "Minimum log level to log (debug, info, warning, error, fatal)")
|
printLogLevel := flag.String("printLogLevel", webConfig.Logging.PrintLogLevel, "Minimum log level to log (debug, info, warning, error, fatal)")
|
||||||
oneShot := flag.Bool("oneShot", webConfig.Server.OneShot, "All jobs are executed immediately and the program exists afterwards")
|
oneShot := flag.Bool("oneShot", webConfig.Server.OneShot, "All jobs are executed immediately and the program exists afterwards")
|
||||||
|
printVersion := flag.Bool("version", false, "Prints the version of the program")
|
||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
webConfig.Server.Address = *address
|
webConfig.Server.Address = *address
|
||||||
webConfig.Logging.PrintLogLevel = *printLogLevel
|
webConfig.Logging.PrintLogLevel = *printLogLevel
|
||||||
webConfig.Server.OneShot = *oneShot
|
webConfig.Server.OneShot = *oneShot
|
||||||
|
|
||||||
defaultLogger := logger.Logger{
|
if *printVersion {
|
||||||
|
fmt.Println(webConfig.Server.Version)
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
defaultLogger := logger.GetLoggerFromEnv(&logger.Logger{
|
||||||
PrintLevel: logger.GetLevelByName(webConfig.Logging.PrintLogLevel),
|
PrintLevel: logger.GetLevelByName(webConfig.Logging.PrintLogLevel),
|
||||||
LogLevel: logger.GetLevelByName(webConfig.Logging.WriteLogLevel),
|
LogLevel: logger.GetLevelByName(webConfig.Logging.WriteLogLevel),
|
||||||
LogFilePath: webConfig.Logging.LogFilePath,
|
LogFilePath: webConfig.Logging.LogFilePath,
|
||||||
PrintSource: true,
|
PrintSource: true,
|
||||||
}
|
})
|
||||||
logger.SetGlobalLogger(&defaultLogger)
|
logger.SetGlobalLogger(defaultLogger)
|
||||||
|
|
||||||
return webConfig, err
|
return webConfig, err
|
||||||
}
|
}
|
||||||
|
|
|
@ -12,10 +12,10 @@ import (
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"rpjosh.de/ncDocConverter/internal/models"
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
"rpjosh.de/ncDocConverter/internal/nextcloud"
|
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
"git.rpjosh.de/ncDocConverter/internal/nextcloud"
|
||||||
"rpjosh.de/ncDocConverter/pkg/utils"
|
"git.rpjosh.de/ncDocConverter/pkg/utils"
|
||||||
)
|
)
|
||||||
|
|
||||||
type BsJob struct {
|
type BsJob struct {
|
||||||
|
|
|
@ -8,9 +8,9 @@ import (
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
|
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||||
"github.com/go-co-op/gocron"
|
"github.com/go-co-op/gocron"
|
||||||
"rpjosh.de/ncDocConverter/internal/models"
|
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type NcConvertScheduler struct {
|
type NcConvertScheduler struct {
|
||||||
|
@ -87,7 +87,7 @@ func (s NcConvertScheduler) ScheduleExecutions() {
|
||||||
|
|
||||||
// Schedule Nextcloud jobs
|
// Schedule Nextcloud jobs
|
||||||
for i, job := range user.ConvertJobs {
|
for i, job := range user.ConvertJobs {
|
||||||
convJob := NewNcJob(&s.users.Users[ui].ConvertJobs[i], &s.users.Users[i])
|
convJob := NewNcJob(&s.users.Users[ui].ConvertJobs[i], &s.users.Users[ui])
|
||||||
|
|
||||||
_, err := s.scheduler.Cron(job.Execution).DoWithJobDetails(s.executeJob, convJob)
|
_, err := s.scheduler.Cron(job.Execution).DoWithJobDetails(s.executeJob, convJob)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@ -98,7 +98,7 @@ func (s NcConvertScheduler) ScheduleExecutions() {
|
||||||
// Schedule boockstack jobs
|
// Schedule boockstack jobs
|
||||||
if user.BookStack.URL != "" {
|
if user.BookStack.URL != "" {
|
||||||
for i, job := range user.BookStack.Jobs {
|
for i, job := range user.BookStack.Jobs {
|
||||||
bsJob := NewBsJob(&s.users.Users[ui].BookStack.Jobs[i], &s.users.Users[i])
|
bsJob := NewBsJob(&s.users.Users[ui].BookStack.Jobs[i], &s.users.Users[ui])
|
||||||
|
|
||||||
_, err := s.scheduler.Cron(job.Execution).DoWithJobDetails(s.executeJob, bsJob)
|
_, err := s.scheduler.Cron(job.Execution).DoWithJobDetails(s.executeJob, bsJob)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -9,10 +9,10 @@ import (
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"rpjosh.de/ncDocConverter/internal/models"
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
"rpjosh.de/ncDocConverter/internal/nextcloud"
|
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
"git.rpjosh.de/ncDocConverter/internal/nextcloud"
|
||||||
"rpjosh.de/ncDocConverter/pkg/utils"
|
"git.rpjosh.de/ncDocConverter/pkg/utils"
|
||||||
)
|
)
|
||||||
|
|
||||||
type convertJob struct {
|
type convertJob struct {
|
||||||
|
@ -96,7 +96,7 @@ func (job *convertJob) ExecuteJob() {
|
||||||
wg.Add(len(destinationMap))
|
wg.Add(len(destinationMap))
|
||||||
for _, dest := range destinationMap {
|
for _, dest := range destinationMap {
|
||||||
go func(file *nextcloud.NcFile) {
|
go func(file *nextcloud.NcFile) {
|
||||||
err := nextcloud.DeleteFile(job.ncUser, dest.Path)
|
err := nextcloud.DeleteFile(job.ncUser, file.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Error(utils.FirstCharToUppercase(err.Error()))
|
logger.Error(utils.FirstCharToUppercase(err.Error()))
|
||||||
}
|
}
|
||||||
|
@ -118,7 +118,6 @@ func (job *convertJob) ExecuteJob() {
|
||||||
// Convert the files
|
// Convert the files
|
||||||
wg.Add(len(filesToConvert))
|
wg.Add(len(filesToConvert))
|
||||||
for _, file := range filesToConvert {
|
for _, file := range filesToConvert {
|
||||||
logger.Info("Path: %s", file.source.Path)
|
|
||||||
go func(cvt convertQueu) {
|
go func(cvt convertQueu) {
|
||||||
job.convertFile(cvt.source.Path, cvt.source.Fileid, cvt.destination)
|
job.convertFile(cvt.source.Path, cvt.source.Fileid, cvt.destination)
|
||||||
wg.Done()
|
wg.Done()
|
||||||
|
@ -176,7 +175,6 @@ func (job *convertJob) convertFile(sourceFile string, sourceid int, destinationF
|
||||||
logger.Error("Failed to access the convert api: %s", err)
|
logger.Error("Failed to access the convert api: %s", err)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer res.Body.Close()
|
|
||||||
|
|
||||||
if res.StatusCode != 200 {
|
if res.StatusCode != 200 {
|
||||||
body, _ := io.ReadAll(res.Body)
|
body, _ := io.ReadAll(res.Body)
|
||||||
|
@ -184,23 +182,9 @@ func (job *convertJob) convertFile(sourceFile string, sourceid int, destinationF
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
uploadClient := http.Client{Timeout: 10 * time.Second}
|
if err := nextcloud.UploadFile(job.ncUser, destinationFile, res.Body); err != nil {
|
||||||
uploadReq, err := http.NewRequest(http.MethodPut, job.ncUser.NextcloudBaseUrl+"/remote.php/dav/files/"+job.ncUser.Username+"/"+destinationFile, res.Body)
|
logger.Error("Failed to upload file %q to nextcloud: %s", destinationFile, err)
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
logger.Error("%s", err)
|
|
||||||
}
|
|
||||||
uploadReq.SetBasicAuth(job.ncUser.Username, job.ncUser.Password)
|
|
||||||
uploadReq.Header.Set("Content-Type", "application/binary")
|
|
||||||
|
|
||||||
res, err = uploadClient.Do(uploadReq)
|
|
||||||
if err != nil {
|
|
||||||
logger.Error("%s", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if res.StatusCode != 204 && res.StatusCode != 201 {
|
|
||||||
logger.Error("Failed to create file %s (#%d)", destinationFile, res.StatusCode)
|
|
||||||
}
|
|
||||||
// Status Code 201
|
|
||||||
res.Body.Close()
|
res.Body.Close()
|
||||||
}
|
}
|
||||||
|
|
|
@ -13,9 +13,9 @@ import (
|
||||||
"text/template"
|
"text/template"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"rpjosh.de/ncDocConverter/internal/models"
|
"git.rpjosh.de/RPJosh/go-logger"
|
||||||
"rpjosh.de/ncDocConverter/pkg/logger"
|
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||||
"rpjosh.de/ncDocConverter/web"
|
"git.rpjosh.de/ncDocConverter/web"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The internal representation of a nextcloud file
|
// The internal representation of a nextcloud file
|
||||||
|
@ -179,6 +179,9 @@ func ParseSearchResult(result *searchResult, prefix string, sourceDir string) ma
|
||||||
// Delets a file with the given path.
|
// Delets a file with the given path.
|
||||||
// The path has to start at the root level: Ebook/myFolder/file.txt
|
// The path has to start at the root level: Ebook/myFolder/file.txt
|
||||||
func DeleteFile(ncUser *models.NextcloudUser, filePath string) error {
|
func DeleteFile(ncUser *models.NextcloudUser, filePath string) error {
|
||||||
|
return deleteFile(ncUser, filePath, true)
|
||||||
|
}
|
||||||
|
func deleteFile(ncUser *models.NextcloudUser, filePath string, retry bool) error {
|
||||||
client := http.Client{Timeout: 5 * time.Second}
|
client := http.Client{Timeout: 5 * time.Second}
|
||||||
|
|
||||||
req := getRequest(http.MethodDelete, "files/"+ncUser.Username+"/"+filePath, nil, ncUser)
|
req := getRequest(http.MethodDelete, "files/"+ncUser.Username+"/"+filePath, nil, ncUser)
|
||||||
|
@ -192,6 +195,13 @@ func DeleteFile(ncUser *models.NextcloudUser, filePath string) error {
|
||||||
return fmt.Errorf("failed to delete file %s (%d)", filePath, res.StatusCode)
|
return fmt.Errorf("failed to delete file %s (%d)", filePath, res.StatusCode)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// If the server is locked try to delete it again
|
||||||
|
if res.StatusCode == 423 && retry {
|
||||||
|
logger.Debug("Trying to delete the file again (it was locked previously)")
|
||||||
|
time.Sleep(10 * time.Millisecond)
|
||||||
|
return deleteFile(ncUser, filePath, false)
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -222,8 +232,12 @@ func CreateFoldersRecursively(ncUser *models.NextcloudUser, destinationFile stri
|
||||||
// Uploads a file to the nextcloud server.
|
// Uploads a file to the nextcloud server.
|
||||||
// It will be saved to the destination as a relative path to the nextcloud root (ebook/file.txt).
|
// It will be saved to the destination as a relative path to the nextcloud root (ebook/file.txt).
|
||||||
func UploadFile(ncUser *models.NextcloudUser, destination string, content io.ReadCloser) error {
|
func UploadFile(ncUser *models.NextcloudUser, destination string, content io.ReadCloser) error {
|
||||||
client := http.Client{Timeout: 5 * time.Second}
|
client := http.Client{Timeout: 10 * time.Second}
|
||||||
req := getRequest(http.MethodPut, "files/"+ncUser.Username+"/"+destination, content, ncUser)
|
cnt, err := io.ReadAll(content)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to read body: %s", err)
|
||||||
|
}
|
||||||
|
req := getRequest(http.MethodPut, "files/"+ncUser.Username+"/"+destination, bytes.NewBuffer(cnt), ncUser)
|
||||||
|
|
||||||
res, err := client.Do(req)
|
res, err := client.Do(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -1,198 +0,0 @@
|
||||||
package logger
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"log"
|
|
||||||
"os"
|
|
||||||
"runtime"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Level of the log message
|
|
||||||
type Level uint8
|
|
||||||
|
|
||||||
const (
|
|
||||||
LevelDebug Level = iota
|
|
||||||
LevelInfo
|
|
||||||
LevelWarning
|
|
||||||
LevelError
|
|
||||||
LevelFatal
|
|
||||||
)
|
|
||||||
|
|
||||||
type Logger struct {
|
|
||||||
PrintLevel Level
|
|
||||||
LogLevel Level
|
|
||||||
LogFilePath string
|
|
||||||
PrintSource bool
|
|
||||||
|
|
||||||
consoleLogger *log.Logger
|
|
||||||
consoleLoggerErr *log.Logger
|
|
||||||
fileLogger *log.Logger
|
|
||||||
logFile *os.File
|
|
||||||
}
|
|
||||||
|
|
||||||
var dLogger Logger
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
dLogger = Logger{
|
|
||||||
PrintLevel: LevelDebug,
|
|
||||||
LogLevel: LevelInfo,
|
|
||||||
LogFilePath: "",
|
|
||||||
PrintSource: false,
|
|
||||||
}
|
|
||||||
|
|
||||||
dLogger.setup()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l Logger) Log(level Level, message string, parameters ...any) {
|
|
||||||
// this function is needed that runtime.Caller(2) is always correct (even on direct call)
|
|
||||||
l.log(level, message, parameters...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l Logger) log(level Level, message string, parameters ...any) {
|
|
||||||
pc, file, line, ok := runtime.Caller(3)
|
|
||||||
if !ok {
|
|
||||||
file = "#unknown"
|
|
||||||
line = 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// get the name of the level
|
|
||||||
var levelName string
|
|
||||||
switch level {
|
|
||||||
case LevelDebug:
|
|
||||||
levelName = "DEBUG"
|
|
||||||
case LevelInfo:
|
|
||||||
levelName = "INFO "
|
|
||||||
case LevelWarning:
|
|
||||||
levelName = "WARN "
|
|
||||||
case LevelError:
|
|
||||||
levelName = "ERROR"
|
|
||||||
case LevelFatal:
|
|
||||||
levelName = "FATAL"
|
|
||||||
}
|
|
||||||
|
|
||||||
if levelName == "" {
|
|
||||||
message = fmt.Sprintf("Invalid level value given: %d. Original message: ", level) + message
|
|
||||||
levelName = "WARN "
|
|
||||||
level = LevelWarning
|
|
||||||
}
|
|
||||||
|
|
||||||
printMessage := "[" + levelName + "] " + time.Now().Local().Format("2006-01-02 15:04:05") +
|
|
||||||
getSourceMessage(file, line, pc, l) +
|
|
||||||
fmt.Sprintf(message, parameters...)
|
|
||||||
|
|
||||||
if l.LogLevel <= level && l.fileLogger != nil {
|
|
||||||
l.fileLogger.Println(printMessage)
|
|
||||||
l.logFile.Sync()
|
|
||||||
|
|
||||||
if level == LevelFatal {
|
|
||||||
l.CloseFile()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if l.PrintLevel <= level {
|
|
||||||
if level == LevelError {
|
|
||||||
l.consoleLoggerErr.Println(printMessage)
|
|
||||||
} else if level == LevelFatal {
|
|
||||||
l.consoleLoggerErr.Fatal(printMessage)
|
|
||||||
} else {
|
|
||||||
l.consoleLogger.Println(printMessage)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
func getSourceMessage(file string, line int, pc uintptr, l Logger) string {
|
|
||||||
if !l.PrintSource {
|
|
||||||
return " - "
|
|
||||||
}
|
|
||||||
|
|
||||||
fileName := file[strings.LastIndex(file, "/")+1:] + ":" + strconv.Itoa(line)
|
|
||||||
|
|
||||||
return " (" + fileName + ") - "
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l *Logger) setup() {
|
|
||||||
// log.Ldate|log.Ltime|log.Lshortfile
|
|
||||||
l.consoleLogger = log.New(os.Stdout, "", 0)
|
|
||||||
l.consoleLoggerErr = log.New(os.Stderr, "", 0)
|
|
||||||
|
|
||||||
if strings.TrimSpace(l.LogFilePath) != "" {
|
|
||||||
file, err := os.OpenFile(l.LogFilePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
|
|
||||||
if err == nil {
|
|
||||||
l.fileLogger = log.New(file, "", 0)
|
|
||||||
l.logFile = file
|
|
||||||
} else {
|
|
||||||
l.Log(LevelError, fmt.Sprintf("Cannot access the log file '%s'\n%s", l.LogFilePath, err.Error()))
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
l.fileLogger = nil
|
|
||||||
if l.logFile != nil {
|
|
||||||
l.logFile.Close()
|
|
||||||
l.logFile = nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l *Logger) CloseFile() {
|
|
||||||
if l.logFile != nil {
|
|
||||||
l.logFile.Close()
|
|
||||||
l.logFile = nil
|
|
||||||
l.fileLogger = nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func SetGlobalLogger(l *Logger) {
|
|
||||||
dLogger = *l
|
|
||||||
dLogger.setup()
|
|
||||||
}
|
|
||||||
func GetGlobalLogger() *Logger {
|
|
||||||
return &dLogger
|
|
||||||
}
|
|
||||||
|
|
||||||
func Debug(message string, parameters ...any) {
|
|
||||||
dLogger.Log(LevelDebug, message, parameters...)
|
|
||||||
}
|
|
||||||
func Info(message string, parameters ...any) {
|
|
||||||
dLogger.Log(LevelInfo, message, parameters...)
|
|
||||||
}
|
|
||||||
func Warning(message string, parameters ...any) {
|
|
||||||
dLogger.Log(LevelWarning, message, parameters...)
|
|
||||||
}
|
|
||||||
func Error(message string, parameters ...any) {
|
|
||||||
dLogger.Log(LevelError, message, parameters...)
|
|
||||||
}
|
|
||||||
func Fatal(message string, parameters ...any) {
|
|
||||||
dLogger.Log(LevelFatal, message, parameters...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func CloseFile() {
|
|
||||||
dLogger.CloseFile()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Tries to convert the given level name to the corresponding level code.
|
|
||||||
// Allowed values are: 'debug', 'info', 'warn', 'warning', 'error', 'panic' and 'fatal'
|
|
||||||
// If an incorrect level name was given an warning is logged and info will be returned
|
|
||||||
func GetLevelByName(levelName string) Level {
|
|
||||||
levelName = strings.ToLower(levelName)
|
|
||||||
switch levelName {
|
|
||||||
case "debug":
|
|
||||||
return LevelDebug
|
|
||||||
case "info":
|
|
||||||
return LevelInfo
|
|
||||||
case "warn", "warning":
|
|
||||||
return LevelWarning
|
|
||||||
case "error":
|
|
||||||
return LevelError
|
|
||||||
case "panic", "fatal":
|
|
||||||
return LevelFatal
|
|
||||||
|
|
||||||
default:
|
|
||||||
{
|
|
||||||
Warning("Unable to parse the level name '%s'. Expected 'debug', 'info', 'warn', 'error' or 'fatal'", levelName)
|
|
||||||
return LevelInfo
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
|
@ -1,6 +1,7 @@
|
||||||
package utils
|
package utils
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"os"
|
||||||
"reflect"
|
"reflect"
|
||||||
"unicode"
|
"unicode"
|
||||||
)
|
)
|
||||||
|
@ -36,3 +37,15 @@ func Copy(source interface{}, destin interface{}) {
|
||||||
reflect.ValueOf(destin).Elem().Set(x)
|
reflect.ValueOf(destin).Elem().Set(x)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetEnvString tries to get an environment variable from the system
|
||||||
|
// as a string value. If the env was not found the given default value
|
||||||
|
// will be returned
|
||||||
|
func GetEnvString(name string, defaultValue string) string {
|
||||||
|
val := defaultValue
|
||||||
|
if strVal, isSet := os.LookupEnv(name); isSet {
|
||||||
|
val = strVal
|
||||||
|
}
|
||||||
|
|
||||||
|
return val
|
||||||
|
}
|
||||||
|
|
|
@ -10,6 +10,9 @@ if "%~1"=="-FIXED_CTRL_C" (
|
||||||
GOTO :EOF
|
GOTO :EOF
|
||||||
)
|
)
|
||||||
|
|
||||||
SET PATH=%PATH%;C:\Windows\System32
|
SET PATH=%PATH%;C:\Windows\System3
|
||||||
set GOTMPDIR=C:\MYCOMP
|
|
||||||
nodemon --delay 1s -e go,html --ignore web/app/ --signal SIGKILL --exec go run ./cmd/ncDocConverth || exit 1
|
set /p version=< VERSION
|
||||||
|
|
||||||
|
.\web\app\node_modules\.bin\nodemon --delay 1s -e go,html,yaml --signal SIGKILL --ignore web/app/ --quiet ^
|
||||||
|
--exec "echo [Restarting] && go run -ldflags ""-X main.version=%VERSION%"" ./cmd/ncDocConverth" -- %args% || "exit 1"
|
|
@ -1,3 +1,7 @@
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
nodemon --delay 1s -e go,html,yaml --ignore web/app/ --signal SIGTERM --exec 'go run ./cmd/ncDocConverth || exit 1'
|
GREEN='\033[0;32m'
|
||||||
|
NC='\033[0m'
|
||||||
|
|
||||||
|
nodemon --delay 1s -e go,html,yaml --ignore web/app/ --signal SIGTERM --quiet --exec \
|
||||||
|
'echo "\n'"$GREEN"'[Restarting]'"$NC"'" && go run -ldflags "-X main.version="$(cat VERSION)"" ./cmd/ncDocConverth' -- "$@" "|| exit 1"
|
Loading…
Reference in New Issue