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
|
|
@ -21,3 +21,19 @@
|
|||
# Go workspace file
|
||||
go.work
|
||||
|
||||
# Locally used configuration file
|
||||
/config.yaml
|
||||
/ncConverter.json
|
||||
/config-docker.yaml
|
||||
|
||||
# Vite build file
|
||||
/.vite
|
||||
|
||||
# Log files
|
||||
*.log
|
||||
|
||||
# Build binaries
|
||||
/ncDocConverth-*
|
||||
|
||||
# Space for private notes
|
||||
/notes
|
|
@ -0,0 +1,10 @@
|
|||
## Ausführen
|
||||
|
||||
set GOTMPDIR=C:\MYCOMP
|
||||
go run .\cmd\web
|
||||
npm run dev
|
||||
|
||||
npm run build
|
||||
|
||||
|
||||
nodemon --watch './**/*.go' --signal SIGTERM --exec 'go' run cmd/MyProgram/main.go
|
|
@ -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
|
31
README.md
31
README.md
|
@ -1,3 +1,32 @@
|
|||
# ncDocConverter
|
||||
|
||||
A Go program able to convert Office Documents automatically to PDF / EPUB Files via OnlyOffice
|
||||
A Go program able to convert documents automatically to PDF / EPUB Files.
|
||||
|
||||
Currently, the following sources for documents are supported:
|
||||
|
||||
* Nextcloud with OnlyOffice
|
||||
* Boockstack
|
||||
|
||||
As a destination to save the converted files only **Nextcloud** is supported.
|
||||
|
||||
|
||||
## Setting it up
|
||||
|
||||
For using the
|
||||
|
||||
|
||||
### BookStack
|
||||
|
||||
For converting books of BookStack you need to create an API token for the user to access the books:
|
||||
1. Login as Admin
|
||||
2. Go to *Settings → Users*
|
||||
3. Select user for API access
|
||||
4. Scroll down to `API Tokens` and click `CREATE TOKEN`
|
||||
5. Set a name and expire date. Click `save`
|
||||
6. Copy the ID and Token. The field `apiToken` will contain the combination from `id:token`
|
||||
|
||||
Now you need also create a new role or edit an existing role.
|
||||
1. Go to *Settings → Roles*
|
||||
2. Edit and existing Role (the role which the user have) or create a new role
|
||||
3. Check the box `Access system API` and `Export content` in `System permissions`
|
||||
4. Assing View Role *(all and own)* for *Shelves, Books, Chapters and Pages*
|
||||
|
|
|
@ -0,0 +1,76 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||
"git.rpjosh.de/ncDocConverter/internal/ncworker"
|
||||
)
|
||||
|
||||
var version string
|
||||
|
||||
type WebApplication struct {
|
||||
logger *logger.Logger
|
||||
config *models.WebConfig
|
||||
}
|
||||
|
||||
func main() {
|
||||
defer logger.CloseFile()
|
||||
|
||||
config, err := models.SetConfig(version)
|
||||
if err != nil {
|
||||
logger.Error(err.Error())
|
||||
}
|
||||
|
||||
tlsConfig := &tls.Config{
|
||||
CurvePreferences: []tls.CurveID{tls.X25519, tls.CurveP256},
|
||||
MinVersion: tls.VersionTLS12,
|
||||
CipherSuites: []uint16{
|
||||
tls.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
|
||||
tls.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,
|
||||
tls.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,
|
||||
tls.TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,
|
||||
tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
|
||||
tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
|
||||
},
|
||||
}
|
||||
|
||||
webApp := WebApplication{
|
||||
logger: logger.GetGlobalLogger(),
|
||||
config: config,
|
||||
}
|
||||
|
||||
srv := &http.Server{
|
||||
Addr: config.Server.Address,
|
||||
ErrorLog: nil,
|
||||
Handler: webApp.routes(),
|
||||
TLSConfig: tlsConfig,
|
||||
IdleTimeout: time.Minute,
|
||||
ReadTimeout: 5 * time.Second,
|
||||
WriteTimeout: 10 * time.Second,
|
||||
}
|
||||
|
||||
ncConvertUsers, err := models.ParseConvertUsers(webApp.config.Server.JobFile)
|
||||
if err != nil {
|
||||
logger.Error("Unable to parse the file %s: %s", "dd", err)
|
||||
}
|
||||
ncworker.NewScheduler(ncConvertUsers, config)
|
||||
|
||||
if 1 == 1 {
|
||||
// Webserver for BookStack hooks currently not implemented
|
||||
return
|
||||
}
|
||||
|
||||
logger.Info("Server started on %s", config.Server.Address)
|
||||
var errw error
|
||||
if config.Server.Certificate == "" {
|
||||
errw = srv.ListenAndServe()
|
||||
} else {
|
||||
errw = srv.ListenAndServeTLS(config.Server.Certificate+"cert.pem", config.Server.Certificate+"key.pem")
|
||||
}
|
||||
|
||||
logger.Error("Failed to run the HTTP Server: %s", errw)
|
||||
}
|
|
@ -0,0 +1,68 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"runtime/debug"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"github.com/justinas/nosurf"
|
||||
)
|
||||
|
||||
func secureHeaders(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// Note: This is split across multiple lines for readability. You don't
|
||||
// need to do this in your own code.
|
||||
w.Header().Set("Content-Security-Policy",
|
||||
//"default-src 'self' localhost:*; style-src 'self' fonts.googleapis.com localhost:*; font-src fonts.gstatic.com")
|
||||
"default-src * 'unsafe-inline' 'unsafe-eval'; script-src * 'unsafe-inline' 'unsafe-eval'; connect-src * 'unsafe-inline'; img-src * data: blob: 'unsafe-inline'; frame-src *; style-src * 'unsafe-inline';")
|
||||
w.Header().Set("Referrer-Policy", "origin-when-cross-origin")
|
||||
w.Header().Set("X-Content-Type-Options", "nosniff")
|
||||
w.Header().Set("X-Frame-Options", "deny")
|
||||
w.Header().Set("X-XSS-Protection", "0")
|
||||
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
func (app *WebApplication) logRequest(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
logger.Info("%s - %s %s %s", r.RemoteAddr, r.Proto, r.Method, r.URL.RequestURI())
|
||||
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
func (app *WebApplication) recoverPanic(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// Create a deferred function (which will always be run in the event
|
||||
// of a panic as Go unwinds the stack).
|
||||
defer func() {
|
||||
// Use the builtin recover function to check if there has been a
|
||||
// panic or not. If there has...
|
||||
if err := recover(); err != nil {
|
||||
// Set a "Connection: close" header on the response.
|
||||
w.Header().Set("Connection", "close")
|
||||
// Call the app.serverError helper method to return a 500
|
||||
// Internal Server response.
|
||||
trace := fmt.Sprintf("%s\n%s", fmt.Errorf("%s", err).Error(), debug.Stack())
|
||||
logger.Error(trace)
|
||||
}
|
||||
}()
|
||||
|
||||
next.ServeHTTP(w, r)
|
||||
})
|
||||
}
|
||||
|
||||
// Create a NoSurf middleware function which uses a customized CSRF cookie with
|
||||
// the Secure, Path and HttpOnly attributes set.
|
||||
func noSurf(next http.Handler) http.Handler {
|
||||
csrfHandler := nosurf.New(next)
|
||||
csrfHandler.SetBaseCookie(http.Cookie{
|
||||
HttpOnly: true,
|
||||
Path: "/",
|
||||
Secure: true,
|
||||
})
|
||||
|
||||
return csrfHandler
|
||||
}
|
|
@ -0,0 +1,20 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"git.rpjosh.de/ncDocConverter/internal/api"
|
||||
"github.com/go-chi/chi/v5"
|
||||
"github.com/go-chi/chi/v5/middleware"
|
||||
)
|
||||
|
||||
func (app *WebApplication) routes() http.Handler {
|
||||
api := api.Api{Logger: app.logger, Config: app.config}
|
||||
|
||||
router := chi.NewRouter()
|
||||
router.Use(middleware.RealIP, app.recoverPanic, app.logRequest, secureHeaders)
|
||||
|
||||
api.SetupServer(router)
|
||||
|
||||
return router
|
||||
}
|
|
@ -0,0 +1,22 @@
|
|||
server:
|
||||
# Address to listen on
|
||||
address: ":4000"
|
||||
|
||||
# Path to the folder with the certificates file (cert.pem and key.pem) for using TLS
|
||||
certificate: "/etc/letsencrypt/live/"
|
||||
|
||||
# If this parameter is given, all jobs are executed immediately after starting the program.
|
||||
# Afterward the program does exit -> The "execution" field in the jobs are going to be ignored
|
||||
oneShot: false
|
||||
|
||||
# Location of the file with the job configurations
|
||||
jobFile: "./ncConverter.json"
|
||||
|
||||
logging:
|
||||
# Minimum log Level for printing to the console (debug, info, warning, error, fatal)
|
||||
printLogLevel: info
|
||||
# Minimum log level for writing into the log file (debug, info, warning, error, fatal)
|
||||
writeLogLevel: warning
|
||||
|
||||
# File path to log (empty = disabled)
|
||||
logFilePath: "/home/myUser/logs/ncDocConverter.live"
|
|
@ -0,0 +1,80 @@
|
|||
// NOTE: This is not a valid JSON file.
|
||||
// Remove all comments and rename the file from '.hjson' to '.json'
|
||||
{
|
||||
"nextcloudUsers": [
|
||||
{
|
||||
// Nextcloud user and instance to save the converted files
|
||||
"nextcloudUrl": "https://cloud.myDomain.de",
|
||||
"username": "myUser",
|
||||
"password": "A41cP-eR3n6-OIP13-8sQ1f-kYqp3",
|
||||
|
||||
// OnlyOffice (docx, xlsx, ...) convertion to pdf
|
||||
"jobs": [
|
||||
{
|
||||
"jobName": "Convert my books",
|
||||
"sourceDir": "api/",
|
||||
"destinationDir": "ebooks/",
|
||||
|
||||
// Keep folders of source
|
||||
// Otherwise all files will be saved in the destination dir
|
||||
"keepFolders": true,
|
||||
|
||||
// If the folder should be searched recursive
|
||||
"recursive": true,
|
||||
|
||||
// Execution date in the cron format
|
||||
"execution": "45 23 * * 6"
|
||||
}
|
||||
],
|
||||
|
||||
// Conversion from bookStack to pdf/html
|
||||
"bookStack": {
|
||||
"url": "https://wiki.myDomain.de",
|
||||
"username": "test@rpjosh.de",
|
||||
"apiToken": "typfe29famd983amdk12a93:ave550l3fqu72cays51o84da71fvlqvtia6x19wZz",
|
||||
|
||||
"jobs": [
|
||||
{
|
||||
"jobName": "Convert my favorite books",
|
||||
|
||||
// Shelves to filter -> convert only shelves with the names "Work" and "Linux"
|
||||
// Leave empty to convert books in all shelves
|
||||
"shelves": [ "Work", "Linux" ],
|
||||
// Regex to filter after the shelv name
|
||||
"shelveRegex": "",
|
||||
|
||||
// Books to filter (see shelves for more informations)
|
||||
"books": [],
|
||||
"booksRegex": "",
|
||||
|
||||
// If books which doesn't belong to an shelf should also be converted.
|
||||
// The will be placed in the root folder.
|
||||
// Note that the field "shelves" and "shelveRegex" doesn't work as expected
|
||||
// (Books inside this shelve won't be excluded but will be placed in the root)
|
||||
"includeBooksWithoutShelve": false,
|
||||
|
||||
// Destination folder to save the converted documents in nextcloud
|
||||
"destinationDir": "ebooks/wiki/",
|
||||
|
||||
// Export format (html or pdf)
|
||||
"format": "html",
|
||||
|
||||
// If the books should be saved inside the shelves folder
|
||||
// Otherwise all files will be saved in the destination dir
|
||||
"keepStructure": true,
|
||||
|
||||
// Execution date in the cron format
|
||||
"execution": "45 23 * * 6",
|
||||
|
||||
// The fetching of books and shelves can be ressource hungry. This value specifies the number
|
||||
// of jobs that are executed with cached data.
|
||||
// Note that new or deleted books and shelves won't be converted until the cache counter
|
||||
// expires. Changes in existing books will still be noted.
|
||||
// Specify zero to disable the cache
|
||||
"cache": 3
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
|
@ -0,0 +1,46 @@
|
|||
{
|
||||
"nextcloudUsers": [
|
||||
{
|
||||
"nextcloudUrl": "https://cloud.myDomain.de",
|
||||
"username": "myUser",
|
||||
"password": "A41cP-eR3n6-OIP13-8sQ1f-kYqp3",
|
||||
|
||||
"jobs": [
|
||||
{
|
||||
"jobName": "Convert my books",
|
||||
"sourceDir": "api/",
|
||||
"destinationDir": "ebooks/",
|
||||
|
||||
"keepFolders": true,
|
||||
"recursive": true,
|
||||
"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
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
19
go.mod
19
go.mod
|
@ -1,3 +1,20 @@
|
|||
module rpjosh.de/ncDocConverter
|
||||
module git.rpjosh.de/ncDocConverter
|
||||
|
||||
go 1.18
|
||||
|
||||
require (
|
||||
github.com/go-chi/chi/v5 v5.0.8
|
||||
github.com/go-co-op/gocron v1.18.0
|
||||
github.com/justinas/nosurf v1.1.1
|
||||
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
|
||||
golang.org/x/sync v0.1.0 // indirect
|
||||
golang.org/x/sys v0.11.0 // indirect
|
||||
)
|
||||
|
||||
// https://zhwt.github.io/yaml-to-go/
|
||||
// https://www.onlinetool.io/xmltogo/
|
||||
|
|
|
@ -0,0 +1,25 @@
|
|||
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/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/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
|
||||
github.com/go-co-op/gocron v1.18.0 h1:SxTyJ5xnSN4byCq7b10LmmszFdxQlSQJod8s3gbnXxA=
|
||||
github.com/go-co-op/gocron v1.18.0/go.mod h1:sD/a0Aadtw5CpflUJ/lpP9Vfdk979Wl1Sg33HPHg0FY=
|
||||
github.com/go-yaml/yaml v2.1.0+incompatible h1:RYi2hDdss1u4YE7GwixGzWwVo47T8UQwnTLB6vQiq+o=
|
||||
github.com/go-yaml/yaml v2.1.0+incompatible/go.mod h1:w2MrLa16VYP0jy6N7M5kHaCkaLENm+P+Tv+MfurjSw0=
|
||||
github.com/justinas/nosurf v1.1.1 h1:92Aw44hjSK4MxJeMSyDa7jwuI9GR2J/JCQiaKvXXSlk=
|
||||
github.com/justinas/nosurf v1.1.1/go.mod h1:ALpWdSbuNGy2lZWtyXdjkYv4edL23oSEgfBT1gPJ5BQ=
|
||||
github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
|
||||
github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
|
||||
github.com/studio-b12/gowebdav v0.0.0-20220128162035-c7b1ff8a5e62 h1:b2nJXyPCa9HY7giGM+kYcnQ71m14JnGdQabMPmyt++8=
|
||||
github.com/studio-b12/gowebdav v0.0.0-20220128162035-c7b1ff8a5e62/go.mod h1:bHA7t77X/QFExdeAnDzK6vKM34kEZAcE1OX4MfiwjkE=
|
||||
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ=
|
||||
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/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/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
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: ''
|
|
@ -0,0 +1,17 @@
|
|||
package api
|
||||
|
||||
import (
|
||||
"github.com/go-chi/chi/v5"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||
)
|
||||
|
||||
type Api struct {
|
||||
Logger *logger.Logger
|
||||
Config *models.WebConfig
|
||||
}
|
||||
|
||||
func (api *Api) SetupServer(router *chi.Mux) {
|
||||
api.routes(router)
|
||||
}
|
|
@ -0,0 +1,7 @@
|
|||
package api
|
||||
|
||||
import "github.com/go-chi/chi/v5"
|
||||
|
||||
func (api *Api) routes(router *chi.Mux) {
|
||||
|
||||
}
|
|
@ -0,0 +1,38 @@
|
|||
package models
|
||||
|
||||
// BookStack details to fetch books from
|
||||
type BookStack struct {
|
||||
URL string `json:"url"`
|
||||
Username string `json:"username"`
|
||||
Token string `json:"apiToken"`
|
||||
|
||||
Jobs []BookStackJob `json:"jobs"`
|
||||
}
|
||||
|
||||
// A concrete BookStacksJob
|
||||
type BookStackJob struct {
|
||||
JobName string `json:"jobName"`
|
||||
DestinationDir string `json:"destinationDir"`
|
||||
|
||||
Shelves []string `json:"shelves"`
|
||||
ShelvesRegex string `json:"shelveRegex"`
|
||||
|
||||
Books []string `json:"books"`
|
||||
BooksRegex string `json:"booksRegex"`
|
||||
|
||||
IncludeBooksWithoutShelve bool `json:"includeBooksWithoutShelve"`
|
||||
Format Format `json:"format"`
|
||||
KeepStructure bool `json:"keepStructure"`
|
||||
|
||||
Recursive string `json:"recursive"`
|
||||
Execution string `json:"execution"`
|
||||
|
||||
CacheCount int `json:"cache"`
|
||||
}
|
||||
|
||||
type Format string
|
||||
|
||||
const (
|
||||
HTML Format = "html"
|
||||
PDF Format = "pdf"
|
||||
)
|
|
@ -0,0 +1,57 @@
|
|||
package models
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
)
|
||||
|
||||
// The root nextcloud user where the files are stored
|
||||
// and the files for onlyoffice jobs are defined
|
||||
type NextcloudUser struct {
|
||||
NextcloudBaseUrl string `json:"nextcloudUrl"`
|
||||
Username string `json:"username"`
|
||||
Password string `json:"password"`
|
||||
|
||||
// OnlyOffice
|
||||
ConvertJobs []NcConvertJob `json:"jobs"`
|
||||
|
||||
// BookStack
|
||||
BookStack BookStack `json:"bookStack"`
|
||||
}
|
||||
|
||||
// A OnlyOffice docs convert job
|
||||
type NcConvertJob struct {
|
||||
JobName string `json:"jobName"`
|
||||
SourceDir string `json:"sourceDir"`
|
||||
DestinationDir string `json:"destinationDir"`
|
||||
KeepFolders string `json:"keepFolders"`
|
||||
Recursive string `json:"recursive"`
|
||||
Execution string `json:"execution"`
|
||||
}
|
||||
|
||||
type NcConvertUsers struct {
|
||||
Users []NextcloudUser `json:"nextcloudUsers"`
|
||||
}
|
||||
|
||||
// Parses the given file to the in memory struct
|
||||
func ParseConvertUsers(filePath string) (*NcConvertUsers, error) {
|
||||
|
||||
file, err := os.OpenFile(filePath, os.O_APPEND|os.O_CREATE, 0644)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to open the file '%s': %s", filePath, err)
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
byteValue, err := ioutil.ReadAll(file)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to parse 'ncConverter.json': %s", err)
|
||||
}
|
||||
|
||||
var conv NcConvertUsers
|
||||
|
||||
json.Unmarshal(byteValue, &conv)
|
||||
|
||||
return &conv, nil
|
||||
}
|
|
@ -0,0 +1,108 @@
|
|||
package models
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"git.rpjosh.de/ncDocConverter/pkg/utils"
|
||||
yaml "gopkg.in/yaml.v3"
|
||||
)
|
||||
|
||||
type WebConfig struct {
|
||||
Server Server `yaml:"server"`
|
||||
Logging Logging `yaml:"logging"`
|
||||
}
|
||||
|
||||
type Server struct {
|
||||
Address string `yaml:"address"`
|
||||
Certificate string `yaml:"certificate"`
|
||||
OneShot bool `yaml:"oneShot"`
|
||||
JobFile string `yaml:"jobFile"`
|
||||
Version string
|
||||
}
|
||||
|
||||
type Logging struct {
|
||||
PrintLogLevel string `yaml:"printLogLevel"`
|
||||
WriteLogLevel string `yaml:"writeLogLevel"`
|
||||
LogFilePath string `yaml:"logFilePath"`
|
||||
}
|
||||
|
||||
// Parses the configuration file (.yaml file) to an WebConfiguration
|
||||
func ParseWebConfig(webConfig *WebConfig, file string) (*WebConfig, error) {
|
||||
if file == "" {
|
||||
return webConfig, nil
|
||||
}
|
||||
|
||||
dat, err := os.ReadFile(file)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err := yaml.Unmarshal(dat, &webConfig); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return webConfig, nil
|
||||
}
|
||||
|
||||
func getDefaultConfig() *WebConfig {
|
||||
return &WebConfig{
|
||||
Server: Server{
|
||||
Address: ":4000",
|
||||
JobFile: utils.GetEnvString("DATA_FILE", "./ncConverter.json"),
|
||||
},
|
||||
Logging: Logging{
|
||||
PrintLogLevel: "info",
|
||||
WriteLogLevel: "warning",
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// Applies the cli and the configuration options from the config files
|
||||
func SetConfig(version string) (*WebConfig, error) {
|
||||
configPath := "./config.yaml"
|
||||
// the path of the configuration file is needed first to determine the "default" values
|
||||
for i, arg := range os.Args {
|
||||
if arg == "-config" || arg == "--config" && len(os.Args) > i {
|
||||
configPath = os.Args[i+1]
|
||||
break
|
||||
}
|
||||
}
|
||||
webConfig := getDefaultConfig()
|
||||
webConfig.Server.Version = version
|
||||
|
||||
webConfig, err := ParseWebConfig(webConfig, configPath)
|
||||
if err != nil {
|
||||
logger.Error("Unable to parse the configuration file '%s': %s", configPath, err)
|
||||
webConfig = getDefaultConfig()
|
||||
err = nil
|
||||
}
|
||||
|
||||
_ = flag.String("config", "./config.yaml", "Path to the configuration file (see configs/config.yaml) for an example")
|
||||
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)")
|
||||
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()
|
||||
webConfig.Server.Address = *address
|
||||
webConfig.Logging.PrintLogLevel = *printLogLevel
|
||||
webConfig.Server.OneShot = *oneShot
|
||||
|
||||
if *printVersion {
|
||||
fmt.Println(webConfig.Server.Version)
|
||||
os.Exit(0)
|
||||
}
|
||||
|
||||
defaultLogger := logger.GetLoggerFromEnv(&logger.Logger{
|
||||
PrintLevel: logger.GetLevelByName(webConfig.Logging.PrintLogLevel),
|
||||
LogLevel: logger.GetLevelByName(webConfig.Logging.WriteLogLevel),
|
||||
LogFilePath: webConfig.Logging.LogFilePath,
|
||||
PrintSource: true,
|
||||
})
|
||||
logger.SetGlobalLogger(defaultLogger)
|
||||
|
||||
return webConfig, err
|
||||
}
|
|
@ -0,0 +1,574 @@
|
|||
package ncworker
|
||||
|
||||
// @TODO delete folders for shelves that doesn't exist anyore
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"regexp"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||
"git.rpjosh.de/ncDocConverter/internal/nextcloud"
|
||||
"git.rpjosh.de/ncDocConverter/pkg/utils"
|
||||
)
|
||||
|
||||
type BsJob struct {
|
||||
job *models.BookStackJob
|
||||
ncUser *models.NextcloudUser
|
||||
|
||||
cacheCount int
|
||||
cacheBooks map[int]book
|
||||
cacheShelves []shelf
|
||||
// If the cache should be usedi n the current execution
|
||||
useCache bool
|
||||
}
|
||||
|
||||
type shelf struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name"`
|
||||
|
||||
// This has to be fetched extra
|
||||
books []int
|
||||
}
|
||||
type shelfDetails struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Tags []string `json:"tags"`
|
||||
Books []struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name"`
|
||||
} `json:"books"`
|
||||
}
|
||||
type shelves struct {
|
||||
Data []shelf `json:"data"`
|
||||
}
|
||||
|
||||
type book struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name"`
|
||||
|
||||
// This has to be calculated of the latest modify page of a page
|
||||
lastModified time.Time
|
||||
// If the book should be ignored to convert
|
||||
ignore bool
|
||||
|
||||
// If the book has been already converted
|
||||
converted bool
|
||||
}
|
||||
type books struct {
|
||||
Data []book `json:"data"`
|
||||
}
|
||||
type bookDetails struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Contents []struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Slug string `json:"slug"`
|
||||
BookID int `json:"book_id"`
|
||||
ChapterID int `json:"chapter_id"`
|
||||
Draft bool `json:"draft"`
|
||||
Template bool `json:"template"`
|
||||
UpdatedAt time.Time `json:"updated_at"`
|
||||
URL string `json:"url"`
|
||||
Type string `json:"type"`
|
||||
} `json:"contents"`
|
||||
Tags []string `json:"tags"`
|
||||
}
|
||||
|
||||
func NewBsJob(job *models.BookStackJob, ncUser *models.NextcloudUser) *BsJob {
|
||||
bsJob := BsJob{
|
||||
job: job,
|
||||
ncUser: ncUser,
|
||||
}
|
||||
|
||||
return &bsJob
|
||||
}
|
||||
|
||||
func (job *BsJob) ExecuteJob() {
|
||||
// Get all existing files in the destination folder
|
||||
destination, err := nextcloud.SearchInDirectory(
|
||||
job.ncUser, job.job.DestinationDir,
|
||||
[]string{
|
||||
"text/html",
|
||||
"application/pdf",
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
logger.Error("Failed to get files in destination directory '%s': %s", job.job.DestinationDir, err)
|
||||
return
|
||||
}
|
||||
|
||||
// Make a map with path as index
|
||||
prefix := "/remote.php/dav/files/" + job.ncUser.Username + "/"
|
||||
destinationMap := nextcloud.ParseSearchResult(destination, prefix, job.job.DestinationDir)
|
||||
|
||||
// Check for cache
|
||||
job.cache()
|
||||
|
||||
// Get all shelves
|
||||
shelves, err := job.getShelves()
|
||||
if err != nil {
|
||||
logger.Error("Failed to get shelves: %s", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Get all books
|
||||
books, err := job.getBooks()
|
||||
if err != nil {
|
||||
logger.Error("Failed to get books: %s", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Index books by path
|
||||
indexedBooks := job.getIndexedBooks(shelves, books)
|
||||
|
||||
// Cache data
|
||||
if job.job.CacheCount > 0 && !job.useCache {
|
||||
job.cacheCount = job.job.CacheCount
|
||||
|
||||
job.cacheShelves = *shelves
|
||||
job.cacheBooks = utils.CopyMap(*books)
|
||||
}
|
||||
|
||||
// Now finally convert the books :)
|
||||
convertCount := 0
|
||||
var wg sync.WaitGroup
|
||||
for i, b := range indexedBooks {
|
||||
// mark as converted
|
||||
indexedBooks[i].converted = true
|
||||
(*books)[b.ID] = *indexedBooks[i]
|
||||
|
||||
// check if it has to be converted again (updated) or for the first time
|
||||
des, exists := destinationMap[i]
|
||||
|
||||
if (!exists || b.lastModified.After(des.LastModified)) && !b.ignore {
|
||||
wg.Add(1)
|
||||
convertCount++
|
||||
go func(book book, path string) {
|
||||
defer wg.Done()
|
||||
job.convertBook(book, path)
|
||||
}(*b, i)
|
||||
} else if b.ignore {
|
||||
logger.Debug("Duplicate book name: %s", b.Name)
|
||||
}
|
||||
|
||||
// Ignore states that a book with a duplicate name exists → delete the orig also
|
||||
if !b.ignore {
|
||||
delete(destinationMap, i)
|
||||
}
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
// Convert remaining books
|
||||
if job.job.IncludeBooksWithoutShelve {
|
||||
for _, b := range *books {
|
||||
// check if it has to be converted again (updated) or for the first time
|
||||
des, exists := destinationMap[b.Name]
|
||||
|
||||
if !b.converted && !b.ignore && (!exists || b.lastModified.After(des.LastModified)) {
|
||||
wg.Add(1)
|
||||
convertCount++
|
||||
go func(book book, path string) {
|
||||
defer wg.Done()
|
||||
job.convertBook(book, path)
|
||||
}(b, b.Name)
|
||||
}
|
||||
delete(destinationMap, b.Name)
|
||||
}
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
// Delete the files which are not available anymore
|
||||
for _, dest := range destinationMap {
|
||||
err := nextcloud.DeleteFile(job.ncUser, dest.Path)
|
||||
if err != nil {
|
||||
logger.Error(utils.FirstCharToUppercase(err.Error()))
|
||||
}
|
||||
}
|
||||
|
||||
logger.Info("Finished BookStack job \"%s\": %d books converted", job.job.JobName, convertCount)
|
||||
}
|
||||
|
||||
// Checks and initializes the cache
|
||||
func (job *BsJob) cache() {
|
||||
if job.job.CacheCount > 0 {
|
||||
job.cacheCount--
|
||||
if job.cacheCount < 0 {
|
||||
job.useCache = false
|
||||
} else {
|
||||
job.useCache = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Return the relative path of the book to save in nextcloud
|
||||
func (job *BsJob) getPath(bookName string, shelfName string) string {
|
||||
if job.job.KeepStructure {
|
||||
return shelfName + "/" + bookName
|
||||
} else {
|
||||
return bookName
|
||||
}
|
||||
}
|
||||
|
||||
// Gets all shelves
|
||||
func (job *BsJob) getShelves() (*[]shelf, error) {
|
||||
if job.useCache {
|
||||
return &job.cacheShelves, nil
|
||||
}
|
||||
|
||||
client := http.Client{Timeout: 10 * time.Second}
|
||||
|
||||
req := job.getRequest(http.MethodGet, "shelves", nil)
|
||||
|
||||
// Add shelve filter
|
||||
q := req.URL.Query()
|
||||
for _, j := range job.job.Shelves {
|
||||
q.Add("filter[name:eq]", j)
|
||||
}
|
||||
req.URL.RawQuery = q.Encode()
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != 200 {
|
||||
return nil, fmt.Errorf("expected status code 200, got %d", res.StatusCode)
|
||||
}
|
||||
|
||||
rtc := shelves{}
|
||||
if err = json.NewDecoder(res.Body).Decode(&rtc); err != nil {
|
||||
return nil, fmt.Errorf("failed to decode response: %s", err)
|
||||
}
|
||||
|
||||
if job.job.ShelvesRegex != "" {
|
||||
reg, err := regexp.Compile(job.job.ShelvesRegex)
|
||||
// This is fatal
|
||||
logger.Fatal("Failed to parse the regex '%s': %s", job.job.ShelvesRegex, err)
|
||||
|
||||
rtc2 := shelves{}
|
||||
|
||||
for i, shelve := range rtc.Data {
|
||||
if reg.Match([]byte(shelve.Name)) {
|
||||
rtc2.Data = append(rtc2.Data, rtc.Data[i])
|
||||
} else {
|
||||
logger.Debug("Ignoring shelve %s", shelve.Name)
|
||||
}
|
||||
}
|
||||
|
||||
rtc = rtc2
|
||||
}
|
||||
|
||||
return &rtc.Data, nil
|
||||
}
|
||||
|
||||
// Returns the IDs of books which belongs to the shelf
|
||||
func (job *BsJob) getBooksInShelve(id int) ([]int, error) {
|
||||
client := http.Client{Timeout: 10 * time.Second}
|
||||
req := job.getRequest(http.MethodGet, "shelves/"+fmt.Sprintf("%d", id), nil)
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != 200 {
|
||||
return nil, fmt.Errorf("expected status code 200, got %d", res.StatusCode)
|
||||
}
|
||||
|
||||
shelfDetails := shelfDetails{}
|
||||
if err = json.NewDecoder(res.Body).Decode(&shelfDetails); err != nil {
|
||||
return nil, fmt.Errorf("failed to decode response: %s", err)
|
||||
}
|
||||
|
||||
rtc := make([]int, len(shelfDetails.Books))
|
||||
for i, details := range shelfDetails.Books {
|
||||
rtc[i] = details.ID
|
||||
}
|
||||
|
||||
return rtc, nil
|
||||
}
|
||||
|
||||
// Indexes the books by the relative path
|
||||
func (job *BsJob) getIndexedBooks(shelves *[]shelf, books *map[int]book) map[string]*book {
|
||||
// Now it has to be checked which book belongs to which shelve.
|
||||
// When cached this was already done
|
||||
if !job.useCache {
|
||||
var wg sync.WaitGroup
|
||||
for i, shelv := range *shelves {
|
||||
wg.Add(1)
|
||||
|
||||
go func(shelf shelf, index int) {
|
||||
defer wg.Done()
|
||||
|
||||
ids, err := job.getBooksInShelve(shelf.ID)
|
||||
if err != nil {
|
||||
logger.Error("Failed to get shelf details: %s", err)
|
||||
} else {
|
||||
b := make([]int, 0)
|
||||
|
||||
for _, id := range ids {
|
||||
// Check if book should be excluded → it is not contained in the book map
|
||||
book, exists := (*books)[id]
|
||||
if exists {
|
||||
b = append(b, book.ID)
|
||||
}
|
||||
}
|
||||
|
||||
(*shelves)[index].books = b
|
||||
}
|
||||
}(shelv, i)
|
||||
}
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
// A book can have the same name. This would lead to conflicts
|
||||
// if they are in the same shelve / folder.
|
||||
// In such a case the ID of the book will be appended to the name "bookName_123".
|
||||
// Because of that a map indexed by the path will be created and AFTERWARDS the file is converted
|
||||
indexedBooks := make(map[string]*book)
|
||||
for _, shelf := range *shelves {
|
||||
for _, bookId := range shelf.books {
|
||||
b := (*books)[bookId]
|
||||
bookPath := job.getPath(b.Name, shelf.Name)
|
||||
existingBook, doesExists := indexedBooks[bookPath]
|
||||
|
||||
if doesExists {
|
||||
// The book path will be appended
|
||||
newBookPath := fmt.Sprintf("%s_%d", bookPath, b.ID)
|
||||
indexedBooks[newBookPath] = &b
|
||||
|
||||
// Also add the other book with the ID
|
||||
otherNewBookPath := fmt.Sprintf("%s_%d", bookPath, existingBook.ID)
|
||||
indexedBooks[otherNewBookPath] = existingBook
|
||||
|
||||
// The original book won't be removed because otherwise a third book with the same
|
||||
// name will be inserted using its real name.
|
||||
// But because this is a pointer, a copy is needed
|
||||
var existingBookCopy book
|
||||
utils.Copy(existingBook, &existingBookCopy)
|
||||
existingBookCopy.ignore = true
|
||||
indexedBooks[bookPath] = &existingBookCopy
|
||||
} else {
|
||||
indexedBooks[bookPath] = &b
|
||||
}
|
||||
}
|
||||
|
||||
// If the structure should be keept, a folder for every shelve has to be created
|
||||
if job.job.KeepStructure && !job.useCache {
|
||||
nextcloud.CreateFoldersRecursively(job.ncUser, job.job.DestinationDir+shelf.Name+"/")
|
||||
}
|
||||
}
|
||||
|
||||
return indexedBooks
|
||||
}
|
||||
|
||||
// Gets all books and returns a map indexed by the ID of the book
|
||||
func (job *BsJob) getBooks() (*map[int]book, error) {
|
||||
if job.useCache {
|
||||
books := utils.CopyMap(job.cacheBooks)
|
||||
|
||||
// The last Change date has to be updated even in cache
|
||||
var wg sync.WaitGroup
|
||||
var mut = &sync.Mutex{}
|
||||
for i, b := range books {
|
||||
wg.Add(1)
|
||||
|
||||
go func(book book, index int) {
|
||||
defer wg.Done()
|
||||
lastModified, err := job.getLastModifiedOfBook(book.ID)
|
||||
if err != nil {
|
||||
logger.Warning("Failed to get last modified date of book %s (%d) - using old date: %s", book.Name, book.ID, err)
|
||||
return
|
||||
}
|
||||
|
||||
book.lastModified = *lastModified
|
||||
|
||||
mut.Lock()
|
||||
books[index] = book
|
||||
mut.Unlock()
|
||||
}(b, i)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
return &books, nil
|
||||
}
|
||||
|
||||
client := http.Client{Timeout: 10 * time.Second}
|
||||
req := job.getRequest(http.MethodGet, "books", nil)
|
||||
|
||||
// Add shelve filter
|
||||
q := req.URL.Query()
|
||||
for _, j := range job.job.Books {
|
||||
q.Add("filter[name:eq]", j)
|
||||
}
|
||||
req.URL.RawQuery = q.Encode()
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != 200 {
|
||||
return nil, fmt.Errorf("expected status code 200, got %d", res.StatusCode)
|
||||
}
|
||||
|
||||
booksArray := books{}
|
||||
if err = json.NewDecoder(res.Body).Decode(&booksArray); err != nil {
|
||||
return nil, fmt.Errorf("failed to decode response: %s", err)
|
||||
}
|
||||
|
||||
if job.job.BooksRegex != "" {
|
||||
reg, err := regexp.Compile(job.job.BooksRegex)
|
||||
// This is fatal
|
||||
logger.Fatal("Failed to parse the regex '%s': %s", job.job.BooksRegex, err)
|
||||
|
||||
booksArray2 := books{}
|
||||
|
||||
for i, book := range booksArray.Data {
|
||||
if reg.Match([]byte(book.Name)) {
|
||||
booksArray2.Data = append(booksArray2.Data, booksArray.Data[i])
|
||||
} else {
|
||||
logger.Debug("Ignoring shelve %s", book.Name)
|
||||
}
|
||||
}
|
||||
|
||||
booksArray = booksArray2
|
||||
}
|
||||
|
||||
// Create indexed map
|
||||
rtc := make(map[int]book)
|
||||
var wg sync.WaitGroup
|
||||
var mut = &sync.Mutex{}
|
||||
for _, b := range booksArray.Data {
|
||||
wg.Add(1)
|
||||
|
||||
go func(b book) {
|
||||
defer wg.Done()
|
||||
lastModified, err := job.getLastModifiedOfBook(b.ID)
|
||||
if err != nil {
|
||||
logger.Warning("Failed to get last modified date of book %s (%d) - skipping: %s", b.Name, b.ID, err)
|
||||
return
|
||||
}
|
||||
|
||||
if lastModified.Unix() == 0 {
|
||||
logger.Info("Skipping book %s (%d) because of no content", b.Name, b.ID)
|
||||
return
|
||||
}
|
||||
|
||||
mut.Lock()
|
||||
rtc[b.ID] = book{
|
||||
ID: b.ID,
|
||||
Name: b.Name,
|
||||
lastModified: *lastModified,
|
||||
}
|
||||
mut.Unlock()
|
||||
}(b)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
return &rtc, nil
|
||||
}
|
||||
|
||||
// Returns the last modified time of a book
|
||||
func (job *BsJob) getLastModifiedOfBook(id int) (*time.Time, error) {
|
||||
client := http.Client{Timeout: 10 * time.Second}
|
||||
req := job.getRequest(http.MethodGet, "books/"+fmt.Sprintf("%d", id), nil)
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != 200 {
|
||||
return nil, fmt.Errorf("expected status code 200, got %d", res.StatusCode)
|
||||
}
|
||||
|
||||
bd := bookDetails{}
|
||||
if err = json.NewDecoder(res.Body).Decode(&bd); err != nil {
|
||||
return nil, fmt.Errorf("failed to decode response: %s", err)
|
||||
}
|
||||
|
||||
lastMod := time.Unix(0, 0)
|
||||
for i, content := range bd.Contents {
|
||||
if content.Template || content.Draft {
|
||||
continue
|
||||
}
|
||||
|
||||
if content.UpdatedAt.After(lastMod) {
|
||||
lastMod = bd.Contents[i].UpdatedAt
|
||||
}
|
||||
}
|
||||
|
||||
return &lastMod, nil
|
||||
}
|
||||
|
||||
// Returns a new request to the bookStack API.
|
||||
// The path beginning AFTER /api/ should be given (e.g.: shelves)
|
||||
func (job *BsJob) getRequest(method string, path string, body io.Reader) *http.Request {
|
||||
req, err := http.NewRequest(method, job.ncUser.BookStack.URL+"/api/"+path, body)
|
||||
if err != nil {
|
||||
logger.Error("%s", err)
|
||||
}
|
||||
req.Header.Set("Authorization", "Token "+job.ncUser.BookStack.Token)
|
||||
|
||||
return req
|
||||
}
|
||||
|
||||
// Converts the given book and uploads it to nextcloud.
|
||||
// The path is being expected relative to the root dir of the jobs directory and does
|
||||
// not contain a file extension
|
||||
func (job *BsJob) convertBook(book book, path string) {
|
||||
fileExtension, url := job.getFileExtension()
|
||||
|
||||
client := http.Client{Timeout: 10 * time.Second}
|
||||
req := job.getRequest(http.MethodGet, fmt.Sprintf("books/%d/export/%s", book.ID, url), nil)
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
logger.Error("Failed to convert book: %s", err)
|
||||
}
|
||||
defer res.Body.Close()
|
||||
|
||||
if res.StatusCode != 200 {
|
||||
logger.Error("Failed to convert book: expected status code 200, got %d", res.StatusCode)
|
||||
return
|
||||
}
|
||||
|
||||
err = nextcloud.UploadFile(job.ncUser, job.job.DestinationDir+path+fileExtension, res.Body)
|
||||
if err != nil {
|
||||
logger.Error("Failed to upload book to nextcloud: %s", err)
|
||||
}
|
||||
}
|
||||
|
||||
func (job *BsJob) getFileExtension() (fileExtension string, url string) {
|
||||
switch strings.ToLower(string(job.job.Format)) {
|
||||
case "html":
|
||||
{
|
||||
fileExtension = ".html"
|
||||
url = "html"
|
||||
}
|
||||
case "pdf":
|
||||
{
|
||||
fileExtension = ".pdf"
|
||||
url = "pdf"
|
||||
}
|
||||
default:
|
||||
{
|
||||
logger.Fatal("Invalid format given: '%s'. Expected 'html' or 'pdf'", job.job.Format)
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
|
@ -0,0 +1,114 @@
|
|||
package ncworker
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||
"github.com/go-co-op/gocron"
|
||||
)
|
||||
|
||||
type NcConvertScheduler struct {
|
||||
users *models.NcConvertUsers
|
||||
config *models.WebConfig
|
||||
|
||||
scheduler *gocron.Scheduler
|
||||
}
|
||||
|
||||
func NewScheduler(users *models.NcConvertUsers, config *models.WebConfig) *NcConvertScheduler {
|
||||
scheduler := NcConvertScheduler{
|
||||
users: users,
|
||||
config: config,
|
||||
scheduler: gocron.NewScheduler(time.Local),
|
||||
}
|
||||
// Don't reschedule a task if it's still running
|
||||
scheduler.scheduler.SingletonMode()
|
||||
scheduler.scheduler.StartAsync()
|
||||
|
||||
if config.Server.OneShot {
|
||||
scheduler.ScheduleExecutionsOneShot()
|
||||
} else {
|
||||
scheduler.ScheduleExecutions()
|
||||
|
||||
fmt.Println("Started in schedule mode.\nType \"exit\" to leave or \"execute\" to execute all jobs")
|
||||
// Endless loop
|
||||
for {
|
||||
reader := bufio.NewReader(os.Stdin)
|
||||
text, err := reader.ReadString('\n')
|
||||
if err != nil {
|
||||
// No console input
|
||||
var wg sync.WaitGroup
|
||||
logger.Debug("No console available")
|
||||
wg.Add(1)
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
input := strings.Trim(strings.ToLower(text), "\n")
|
||||
if input == "exit" {
|
||||
break
|
||||
} else if input == "execute" {
|
||||
scheduler.scheduler.RunAll()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return &scheduler
|
||||
}
|
||||
|
||||
// Executes all jobs and exits the program afterwards
|
||||
func (scheduler NcConvertScheduler) ScheduleExecutionsOneShot() {
|
||||
for _, user := range scheduler.users.Users {
|
||||
|
||||
// Schedule Nextcloud jobs
|
||||
for _, job := range user.ConvertJobs {
|
||||
convJob := NewNcJob(&job, &user)
|
||||
convJob.ExecuteJob()
|
||||
}
|
||||
|
||||
// Schedule boockstack jobs
|
||||
if user.BookStack.URL != "" {
|
||||
for _, job := range user.BookStack.Jobs {
|
||||
bsJob := NewBsJob(&job, &user)
|
||||
bsJob.ExecuteJob()
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
// Schedules all jobs with gocron
|
||||
func (s NcConvertScheduler) ScheduleExecutions() {
|
||||
for ui, user := range s.users.Users {
|
||||
|
||||
// Schedule Nextcloud jobs
|
||||
for i, job := range user.ConvertJobs {
|
||||
convJob := NewNcJob(&s.users.Users[ui].ConvertJobs[i], &s.users.Users[ui])
|
||||
|
||||
_, err := s.scheduler.Cron(job.Execution).DoWithJobDetails(s.executeJob, convJob)
|
||||
if err != nil {
|
||||
logger.Fatal("Failed to schedule office job '%s': %s", job.JobName, err)
|
||||
}
|
||||
}
|
||||
|
||||
// Schedule boockstack jobs
|
||||
if user.BookStack.URL != "" {
|
||||
for i, job := range user.BookStack.Jobs {
|
||||
bsJob := NewBsJob(&s.users.Users[ui].BookStack.Jobs[i], &s.users.Users[ui])
|
||||
|
||||
_, err := s.scheduler.Cron(job.Execution).DoWithJobDetails(s.executeJob, bsJob)
|
||||
if err != nil {
|
||||
logger.Fatal("Failed to schedule BookStack job '%s': %s", job.JobName, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (s NcConvertScheduler) executeJob(job Job, scheduledJob gocron.Job) {
|
||||
job.ExecuteJob()
|
||||
}
|
|
@ -0,0 +1,5 @@
|
|||
package ncworker
|
||||
|
||||
type Job interface {
|
||||
ExecuteJob()
|
||||
}
|
|
@ -0,0 +1,190 @@
|
|||
package ncworker
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||
"git.rpjosh.de/ncDocConverter/internal/nextcloud"
|
||||
"git.rpjosh.de/ncDocConverter/pkg/utils"
|
||||
)
|
||||
|
||||
type convertJob struct {
|
||||
job *models.NcConvertJob
|
||||
ncUser *models.NextcloudUser
|
||||
}
|
||||
|
||||
type convertQueu struct {
|
||||
source nextcloud.NcFile
|
||||
destination string
|
||||
}
|
||||
|
||||
func NewNcJob(job *models.NcConvertJob, ncUser *models.NextcloudUser) *convertJob {
|
||||
convJob := &convertJob{
|
||||
job: job,
|
||||
ncUser: ncUser,
|
||||
}
|
||||
|
||||
return convJob
|
||||
}
|
||||
|
||||
func (job *convertJob) ExecuteJob() {
|
||||
|
||||
// Get existing directory contents
|
||||
sourceFolder, err := nextcloud.SearchInDirectory(
|
||||
job.ncUser,
|
||||
job.job.SourceDir,
|
||||
[]string{
|
||||
"application/vnd.openxmlformats-officedocument.wordprocessingml.document",
|
||||
"application/msword",
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
logger.Error("Failed to get files in source directory '%s': %s", job.job.SourceDir, err)
|
||||
return
|
||||
}
|
||||
|
||||
destinationFolder, err := nextcloud.SearchInDirectory(
|
||||
job.ncUser,
|
||||
job.job.DestinationDir,
|
||||
[]string{
|
||||
"application/pdf",
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
logger.Error("Failed to get files in destination directory '%s': %s", job.job.DestinationDir, err)
|
||||
return
|
||||
}
|
||||
|
||||
// Store all files in a map
|
||||
prefix := "/remote.php/dav/files/" + job.ncUser.Username + "/"
|
||||
sourceMap := nextcloud.ParseSearchResult(sourceFolder, prefix, job.job.SourceDir)
|
||||
destinationMap := nextcloud.ParseSearchResult(destinationFolder, prefix, job.job.DestinationDir)
|
||||
|
||||
// check which files should be converted
|
||||
var filesToConvert []convertQueu
|
||||
var directorys []string
|
||||
|
||||
for index, source := range sourceMap {
|
||||
// Check if the file exists in the destination map
|
||||
if dest, exists := destinationMap[index]; exists {
|
||||
// Compare timestamp and size
|
||||
if dest.LastModified.Before(source.LastModified) {
|
||||
filesToConvert = append(filesToConvert, convertQueu{source: source, destination: dest.Path})
|
||||
}
|
||||
delete(destinationMap, index)
|
||||
} else {
|
||||
// the directory could not be existing -> check for existance
|
||||
destinationDir := job.getDestinationDir(source.Path)
|
||||
appendIfNotExists(&directorys, destinationDir[0:strings.LastIndex(destinationDir, "/")+1])
|
||||
|
||||
filesToConvert = append(filesToConvert, convertQueu{source: source, destination: destinationDir})
|
||||
|
||||
delete(destinationMap, index)
|
||||
}
|
||||
}
|
||||
|
||||
var wg sync.WaitGroup
|
||||
|
||||
// Delete the files which are not available anymore
|
||||
wg.Add(len(destinationMap))
|
||||
for _, dest := range destinationMap {
|
||||
go func(file *nextcloud.NcFile) {
|
||||
err := nextcloud.DeleteFile(job.ncUser, file.Path)
|
||||
if err != nil {
|
||||
logger.Error(utils.FirstCharToUppercase(err.Error()))
|
||||
}
|
||||
wg.Done()
|
||||
}(&dest)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
// Create required directorys
|
||||
wg.Add(len(directorys))
|
||||
for _, dest := range directorys {
|
||||
go func(path string) {
|
||||
nextcloud.CreateFoldersRecursively(job.ncUser, path)
|
||||
wg.Done()
|
||||
}(dest)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
// Convert the files
|
||||
wg.Add(len(filesToConvert))
|
||||
for _, file := range filesToConvert {
|
||||
go func(cvt convertQueu) {
|
||||
job.convertFile(cvt.source.Path, cvt.source.Fileid, cvt.destination)
|
||||
wg.Done()
|
||||
}(file)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
logger.Info("Finished Nextcloud job \"%s\": %d documents converted", job.job.JobName, len(filesToConvert))
|
||||
}
|
||||
|
||||
// Appends the directory to the array if it isn't contained
|
||||
// by another element already
|
||||
func appendIfNotExists(dirs *[]string, directory string) {
|
||||
directoryLength := len(directory)
|
||||
for i, currentDir := range *dirs {
|
||||
currentLength := len(currentDir)
|
||||
|
||||
// the existing directory is already referenced in the current
|
||||
if directoryLength > currentLength && directory[0:currentLength] == currentDir {
|
||||
(*dirs)[i] = directory
|
||||
continue
|
||||
} else if directoryLength <= currentLength && currentDir[0:directoryLength] == directory {
|
||||
continue
|
||||
}
|
||||
}
|
||||
*dirs = append(*dirs, directory)
|
||||
}
|
||||
|
||||
func (job *convertJob) getDestinationDir(sourceFile string) string {
|
||||
sourceFile = sourceFile[len(job.job.SourceDir):]
|
||||
var extension = filepath.Ext(sourceFile)
|
||||
var name = sourceFile[0 : len(sourceFile)-len(extension)]
|
||||
|
||||
return job.job.DestinationDir + name + ".pdf"
|
||||
}
|
||||
|
||||
// Converts the source file to the destination file utilizing the onlyoffice convert api
|
||||
func (job *convertJob) convertFile(sourceFile string, sourceid int, destinationFile string) {
|
||||
logger.Debug("Converting %s (%d) to %s", sourceFile, sourceid, destinationFile)
|
||||
|
||||
client := http.Client{Timeout: 10 * time.Second}
|
||||
req, err := http.NewRequest(http.MethodGet, job.ncUser.NextcloudBaseUrl+"/apps/onlyoffice/downloadas", nil)
|
||||
if err != nil {
|
||||
logger.Error("%s", err)
|
||||
}
|
||||
req.SetBasicAuth(job.ncUser.Username, job.ncUser.Password)
|
||||
|
||||
q := req.URL.Query()
|
||||
q.Add("fileId", fmt.Sprint(sourceid))
|
||||
q.Add("toExtension", "pdf")
|
||||
req.URL.RawQuery = q.Encode()
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
logger.Error("Failed to access the convert api: %s", err)
|
||||
return
|
||||
}
|
||||
|
||||
if res.StatusCode != 200 {
|
||||
body, _ := io.ReadAll(res.Body)
|
||||
logger.Error("Failed to access the convert api (#%d). Do you have OnlyOffice installed?: %s", res.StatusCode, body)
|
||||
return
|
||||
}
|
||||
|
||||
if err := nextcloud.UploadFile(job.ncUser, destinationFile, res.Body); err != nil {
|
||||
logger.Error("Failed to upload file %q to nextcloud: %s", destinationFile, err)
|
||||
}
|
||||
|
||||
res.Body.Close()
|
||||
}
|
|
@ -0,0 +1,252 @@
|
|||
package nextcloud
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
"text/template"
|
||||
"time"
|
||||
|
||||
"git.rpjosh.de/RPJosh/go-logger"
|
||||
"git.rpjosh.de/ncDocConverter/internal/models"
|
||||
"git.rpjosh.de/ncDocConverter/web"
|
||||
)
|
||||
|
||||
// The internal representation of a nextcloud file
|
||||
type NcFile struct {
|
||||
// File extension: txt
|
||||
Extension string
|
||||
// Relative path of the file to the nextcloud root: /folder/file.txt
|
||||
Path string
|
||||
LastModified time.Time
|
||||
ContentType string
|
||||
// Size in Bytes
|
||||
Size int
|
||||
// The unique file ID of the nextcloud server
|
||||
Fileid int
|
||||
// The Webdav URL for file reference
|
||||
WebdavURL string
|
||||
}
|
||||
|
||||
type searchTemplateData struct {
|
||||
Username string
|
||||
Directory string
|
||||
ContentType []string
|
||||
}
|
||||
|
||||
type searchResult struct {
|
||||
XMLName xml.Name `xml:"multistatus"`
|
||||
Text string `xml:",chardata"`
|
||||
D string `xml:"d,attr"`
|
||||
S string `xml:"s,attr"`
|
||||
Oc string `xml:"oc,attr"`
|
||||
Nc string `xml:"nc,attr"`
|
||||
Response []searchResultResponse `xml:"response"`
|
||||
}
|
||||
type searchResultResponse struct {
|
||||
Text string `xml:",chardata"`
|
||||
Href string `xml:"href"`
|
||||
Propstat struct {
|
||||
Text string `xml:",chardata"`
|
||||
Prop struct {
|
||||
Text string `xml:",chardata"`
|
||||
Getcontenttype string `xml:"getcontenttype"`
|
||||
Getlastmodified string `xml:"getlastmodified"`
|
||||
Size string `xml:"size"`
|
||||
Fileid int `xml:"fileid"`
|
||||
} `xml:"prop"`
|
||||
Status string `xml:"status"`
|
||||
} `xml:"propstat"`
|
||||
}
|
||||
|
||||
func (r *searchResultResponse) GetLastModified() time.Time {
|
||||
// Time format: Fri, 23 Sep 2022 05:46:31 GMT
|
||||
rtc, err := time.Parse("Mon, 02 Jan 2006 15:04:05 GMT", r.Propstat.Prop.Getlastmodified)
|
||||
if err != nil {
|
||||
logger.Warning("%s", err)
|
||||
rtc = time.Unix(0, 1)
|
||||
}
|
||||
|
||||
return rtc
|
||||
}
|
||||
|
||||
// Returns a new request to the Nexcloud API.
|
||||
// The path beginning AFTER /dav/ should be given (e.g.: myUser/folder/file.txt)
|
||||
func getRequest(method string, path string, body io.Reader, ncUser *models.NextcloudUser) *http.Request {
|
||||
req, err := http.NewRequest(method, ncUser.NextcloudBaseUrl+"/remote.php/dav/"+path, body)
|
||||
if err != nil {
|
||||
logger.Error("%s", err)
|
||||
}
|
||||
req.SetBasicAuth(ncUser.Username, ncUser.Password)
|
||||
|
||||
return req
|
||||
}
|
||||
|
||||
// Searches for all files of the given content type starting in the given directory.
|
||||
func SearchInDirectory(ncUser *models.NextcloudUser, directory string, contentType []string) (*searchResult, error) {
|
||||
client := http.Client{Timeout: 5 * time.Second}
|
||||
|
||||
template, err := template.ParseFS(web.ApiTemplateFiles, "apitemplate/ncsearch.tmpl.xml")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var buf bytes.Buffer
|
||||
templateData := searchTemplateData{
|
||||
Username: ncUser.Username,
|
||||
Directory: directory,
|
||||
ContentType: contentType,
|
||||
}
|
||||
if err = template.Execute(&buf, templateData); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Status code 207
|
||||
req := getRequest("SEARCH", "", &buf, ncUser)
|
||||
req.Header.Set("Content-Type", "application/xml")
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Decody body first before checking status code to print in error message
|
||||
defer res.Body.Close()
|
||||
|
||||
resBody, err := io.ReadAll(res.Body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Create folder if not existing
|
||||
if res.StatusCode == 404 {
|
||||
logger.Info("Creating directory '%s' because it does not exist", "/"+directory)
|
||||
CreateFoldersRecursively(ncUser, "/"+directory+"notExisting.pdf")
|
||||
return &searchResult{}, nil
|
||||
}
|
||||
|
||||
if res.StatusCode != 207 {
|
||||
return nil, fmt.Errorf("status code %d: %s", res.StatusCode, resBody)
|
||||
}
|
||||
|
||||
var result searchResult
|
||||
if err = xml.Unmarshal(resBody, &result); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &result, nil
|
||||
}
|
||||
|
||||
// Parses the response from the given search format to an NcFile.
|
||||
// A map with the relative path based on the source Directory ("someFolder/file.txt")
|
||||
// and the mathing NcFile will be returned. Therefore, also the source Directory has to be given.
|
||||
//
|
||||
// To determine the path without the prefix "/remote.php/dav/user/" it has to be given.
|
||||
func ParseSearchResult(result *searchResult, prefix string, sourceDir string) map[string]NcFile {
|
||||
preCount := len(prefix)
|
||||
rtc := make(map[string]NcFile)
|
||||
|
||||
for _, file := range result.Response {
|
||||
href, _ := url.QueryUnescape(file.Href)
|
||||
path := href[preCount:]
|
||||
var extension = filepath.Ext(path)
|
||||
var name = path[0 : len(path)-len(extension)][len(sourceDir):]
|
||||
time := file.GetLastModified()
|
||||
size, err := strconv.Atoi(file.Propstat.Prop.Size)
|
||||
if err != nil {
|
||||
logger.Error("Failed to parse the file size '%s' to an integer: %s", file.Propstat.Prop.Size, err)
|
||||
continue
|
||||
}
|
||||
rtc[name] = NcFile{
|
||||
Extension: extension,
|
||||
Path: path,
|
||||
LastModified: time,
|
||||
Size: size,
|
||||
ContentType: file.Propstat.Prop.Getcontenttype,
|
||||
Fileid: file.Propstat.Prop.Fileid,
|
||||
WebdavURL: file.Href,
|
||||
}
|
||||
}
|
||||
|
||||
return rtc
|
||||
}
|
||||
|
||||
// Delets a file with the given path.
|
||||
// The path has to start at the root level: Ebook/myFolder/file.txt
|
||||
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}
|
||||
|
||||
req := getRequest(http.MethodDelete, "files/"+ncUser.Username+"/"+filePath, nil, ncUser)
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
logger.Error("%s", err)
|
||||
}
|
||||
|
||||
if res.StatusCode != 204 {
|
||||
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
|
||||
}
|
||||
|
||||
// Creates all required directorys to create the destination file recursively.
|
||||
// The path should be relative to the root: ebook/folder1/folder2/file.txt
|
||||
func CreateFoldersRecursively(ncUser *models.NextcloudUser, destinationFile string) {
|
||||
s := strings.Split(destinationFile, "/")
|
||||
folderTree := ""
|
||||
|
||||
// Webdav doesn't have a function to create directories recursively → iterate
|
||||
for _, folder := range s[:len(s)-1] {
|
||||
folderTree += folder + "/"
|
||||
|
||||
client := http.Client{Timeout: 5 * time.Second}
|
||||
req := getRequest("MKCOL", "files/"+ncUser.Username+"/"+folderTree, nil, ncUser)
|
||||
|
||||
res, err := client.Do(req)
|
||||
if err != nil {
|
||||
logger.Error("%s", err)
|
||||
}
|
||||
|
||||
if res.StatusCode != 201 && res.StatusCode != 405 {
|
||||
logger.Error("Failed to create directory '%s'", folderTree)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 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).
|
||||
func UploadFile(ncUser *models.NextcloudUser, destination string, content io.ReadCloser) error {
|
||||
client := http.Client{Timeout: 10 * time.Second}
|
||||
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)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if res.StatusCode != 201 && res.StatusCode != 204 {
|
||||
return fmt.Errorf("expected status code 201 or 204 but got %d", res.StatusCode)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
165
logger/logger.go
165
logger/logger.go
|
@ -1,165 +0,0 @@
|
|||
package logger
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"runtime"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
"os"
|
||||
)
|
||||
|
||||
// define available log levels
|
||||
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(2)
|
||||
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().UTC().Format("2006-01-02 03: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() {
|
||||
l.consoleLogger = log.New(os.Stdout, "", 0)
|
||||
l.consoleLoggerErr = log.New(os.Stderr, "", 0)
|
||||
|
||||
if (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 (dLogger.logFile != nil) {
|
||||
dLogger.logFile.Close()
|
||||
dLogger.logFile = nil
|
||||
dLogger.fileLogger = nil
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
func SetGlobalLogger(l *Logger) {
|
||||
dLogger = *l
|
||||
dLogger.setup()
|
||||
}
|
||||
|
||||
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()
|
||||
}
|
22
main.go
22
main.go
|
@ -1,22 +0,0 @@
|
|||
package main
|
||||
|
||||
import (
|
||||
"rpjosh.de/ncDocConverter/logger"
|
||||
)
|
||||
|
||||
func init() {
|
||||
defaultLogger := logger.Logger {
|
||||
PrintLevel: 0,
|
||||
LogLevel: 1,
|
||||
LogFilePath: "log.log",
|
||||
PrintSource: true,
|
||||
}
|
||||
|
||||
logger.SetGlobalLogger(&defaultLogger)
|
||||
}
|
||||
|
||||
func main() {
|
||||
defer logger.CloseFile()
|
||||
|
||||
|
||||
}
|
|
@ -0,0 +1,51 @@
|
|||
package utils
|
||||
|
||||
import (
|
||||
"os"
|
||||
"reflect"
|
||||
"unicode"
|
||||
)
|
||||
|
||||
// Makes the first character of the given string to uppercase
|
||||
func FirstCharToUppercase(text string) string {
|
||||
a := []rune(text)
|
||||
a[0] = unicode.ToLower(a[0])
|
||||
return string(a)
|
||||
}
|
||||
|
||||
// Copys a map. The structs are also cloned
|
||||
func CopyMap[T comparable, Val any](m map[T]Val) map[T]Val {
|
||||
cp := make(map[T]Val)
|
||||
for k, v := range m {
|
||||
var u Val
|
||||
Copy(&v, &u)
|
||||
cp[k] = u
|
||||
}
|
||||
|
||||
return cp
|
||||
}
|
||||
|
||||
// Copies a struct
|
||||
func Copy(source interface{}, destin interface{}) {
|
||||
x := reflect.ValueOf(source)
|
||||
if reflect.ValueOf(destin).Kind() != reflect.Ptr {
|
||||
return
|
||||
}
|
||||
if x.Kind() == reflect.Ptr {
|
||||
reflect.ValueOf(destin).Elem().Set(x.Elem())
|
||||
} else {
|
||||
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
|
||||
}
|
|
@ -0,0 +1,18 @@
|
|||
@ECHO OFF
|
||||
|
||||
:: Bypass the "Terminate Batch Job" prompt
|
||||
if "%~1"=="-FIXED_CTRL_C" (
|
||||
:: Remove the -FIXED_CTRL_C parameter
|
||||
SHIFT
|
||||
) ELSE (
|
||||
:: Run the batch with <NUL and -FIXED_CTRL_C
|
||||
CALL <NUL %0 -FIXED_CTRL_C %*
|
||||
GOTO :EOF
|
||||
)
|
||||
|
||||
SET PATH=%PATH%;C:\Windows\System3
|
||||
|
||||
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"
|
|
@ -0,0 +1,7 @@
|
|||
#!/bin/sh
|
||||
|
||||
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"
|
|
@ -0,0 +1,40 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<d:searchrequest xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
|
||||
<d:basicsearch>
|
||||
<d:select>
|
||||
<d:prop>
|
||||
<d:getcontenttype/>
|
||||
<d:getlastmodified/>
|
||||
<oc:size/>
|
||||
<oc:fileid/>
|
||||
</d:prop>
|
||||
</d:select>
|
||||
<d:from>
|
||||
<d:scope>
|
||||
<d:href>/files/{{.Username}}/{{.Directory}}</d:href>
|
||||
<d:depth></d:depth>
|
||||
</d:scope>
|
||||
</d:from>
|
||||
<d:where>
|
||||
<d:and>
|
||||
<d:or>
|
||||
{{range .ContentType}}
|
||||
<d:eq>
|
||||
<d:prop>
|
||||
<d:getcontenttype/>
|
||||
</d:prop>
|
||||
<d:literal>{{ . }}</d:literal>
|
||||
</d:eq>
|
||||
{{end}}
|
||||
</d:or>
|
||||
<d:gt>
|
||||
<d:prop>
|
||||
<oc:size/>
|
||||
</d:prop>
|
||||
<d:literal>100</d:literal>
|
||||
</d:gt>
|
||||
</d:and>
|
||||
</d:where>
|
||||
<d:orderby/>
|
||||
</d:basicsearch>
|
||||
</d:searchrequest>
|
|
@ -0,0 +1,8 @@
|
|||
package web
|
||||
|
||||
import (
|
||||
"embed"
|
||||
)
|
||||
|
||||
//go:embed "apitemplate"
|
||||
var ApiTemplateFiles embed.FS
|
Loading…
Reference in New Issue