fcwtool: make new version of setuptools happy by moving code into a module directory

.gitignore

@@ -62,3 +62,243 @@ $RECYCLE.BIN/
 # .nfs files are created when an open file is removed but is still being accessed
 .nfs*
 
+### LaTeX ###
+## Core latex/pdflatex auxiliary files:
+*.aux
+*.lof
+*.log
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+
+## Intermediate documents:
+*.dvi
+*.xdv
+*-converted-to.*
+# these rules might exclude image files for figures etc.
+# *.ps
+# *.eps
+# *.pdf
+
+## Generated if empty string is given at "Please type another file name for output:"
+.pdf
+
+## Bibliography auxiliary files (bibtex/biblatex/biber):
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.run.xml
+
+## Build tool auxiliary files:
+*.fdb_latexmk
+*.synctex
+*.synctex(busy)
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+*Notes.bib
+
+## Auxiliary and intermediate files from other packages:
+# algorithms
+*.alg
+*.loa
+
+# achemso
+acs-*.bib
+
+# amsthm
+*.thm
+
+# beamer
+*.nav
+*.pre
+*.snm
+*.vrb
+
+# changes
+*.soc
+
+# cprotect
+*.cpt
+
+# elsarticle (documentclass of Elsevier journals)
+*.spl
+
+# endnotes
+*.ent
+
+# fixme
+*.lox
+
+# feynmf/feynmp
+*.mf
+*.mp
+*.t[1-9]
+*.t[1-9][0-9]
+*.tfm
+
+#(r)(e)ledmac/(r)(e)ledpar
+*.end
+*.?end
+*.[1-9]
+*.[1-9][0-9]
+*.[1-9][0-9][0-9]
+*.[1-9]R
+*.[1-9][0-9]R
+*.[1-9][0-9][0-9]R
+*.eledsec[1-9]
+*.eledsec[1-9]R
+*.eledsec[1-9][0-9]
+*.eledsec[1-9][0-9]R
+*.eledsec[1-9][0-9][0-9]
+*.eledsec[1-9][0-9][0-9]R
+
+# glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+
+# gnuplottex
+*-gnuplottex-*
+
+# gregoriotex
+*.gaux
+*.gtex
+
+# hyperref
+*.brf
+
+# knitr
+*-concordance.tex
+# TODO Comment the next line if you want to keep your tikz graphics files
+*.tikz
+*-tikzDictionary
+
+# listings
+*.lol
+
+# makeidx
+*.idx
+*.ilg
+*.ind
+*.ist
+
+# minitoc
+*.maf
+*.mlf
+*.mlt
+*.mtc[0-9]*
+*.slf[0-9]*
+*.slt[0-9]*
+*.stc[0-9]*
+
+# minted
+_minted*
+*.pyg
+
+# morewrites
+*.mw
+
+# nomencl
+*.nlo
+
+# pax
+*.pax
+
+# pdfpcnotes
+*.pdfpc
+
+# sagetex
+*.sagetex.sage
+*.sagetex.py
+*.sagetex.scmd
+
+# scrwfile
+*.wrt
+
+# sympy
+*.sout
+*.sympy
+sympy-plots-for-*.tex/
+
+# pdfcomment
+*.upa
+*.upb
+
+# pythontex
+*.pytxcode
+pythontex-files-*/
+
+# thmtools
+*.loe
+
+# TikZ & PGF
+*.dpth
+*.md5
+*.auxlock
+
+# todonotes
+*.tdo
+
+# easy-todo
+*.lod
+
+# xindy
+*.xdy
+
+# xypic precompiled matrices
+*.xyc
+
+# endfloat
+*.ttt
+*.fff
+
+# Latexian
+TSWLatexianTemp*
+
+## Editors:
+# WinEdt
+*.bak
+*.sav
+
+# Texpad
+.texpadtmp
+
+# Kile
+*.backup
+
+# KBibTeX
+*~[0-9]*
+
+# auto folder when using emacs and auctex
+/auto/*
+
+# expex forward references with \gathertags
+*-tags.tex
+
+### LaTeX Patch ###
+# glossaries
+*.glstex
+
+### Vim ###
+# swap
+.sw[a-p]
+.*.sw[a-p]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+# auto-generated tag files
+tags
+

Spickzettel/Spickzettel.tex

@@ -0,0 +1,46 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Datei: Spickzettel.tex
+%
+% Beschreibung: Einigen Studierenden ist die Beschreibung des gewünschten Forma-
+% tes der Spickzettel zu abstrakt. Sie könnten von einem Beispiel profitieren.
+% Hier ist es ...
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\documentclass[a4paper,10pt]{article}
+
+\usepackage{tikz}
+\usepackage[a4paper,left=0cm,top=0cm,right=0cm,bottom=0cm]{geometry}
+
+\newcommand{\Seitenmarkierung}{%
+	\begin{tikz}[remember picture,overlay]%
+		\node (headerBG) at (current page.north)%
+			[%
+				anchor=north,
+				% Grö0e:
+				minimum width=\paperwidth,
+				minimum height=2.225cm,
+				%
+				% Aussehen:
+				draw=gray!80!white,
+				%
+				%Text:
+				label={%
+					[anchor=south]%
+					below:%
+					{%
+						\sffamily\textcolor{gray}{%
+							Oberhalb dieser Linie nur \textbf{Nachname, Vorname} und \textbf{Matrikelnummer}%
+						}%
+					}%
+				}%
+			]%
+			{} ;%
+	\end{tikz}%
+}
+
+\begin{document}%
+	\pagenumbering{gobble}
+	\Seitenmarkierung
+	\newpage
+	\Seitenmarkierung
+\end{document}
+

fcw2pdf/fcw2pdf.sh

@@ -1,66 +0,0 @@
-#!/bin/bash
-
-# fcw2pdf.sh: a simple fcw to PDF converter script.
-# Copyright 2017 Christopher Spinrath <christopher.spinrath@tu-dortmund.de>
-
-# fcw2pdf.sh is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-
-# fcw2pdf.sh is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with fcw2pdf.sh.  If not, see <http://www.gnu.org/licenses/>.
-
-set -e
-
-INPUT_FILE=$1
-
-if [ "x$1" == "x" ]; then
-  echo "Usage: fcw2pdf.sh <input.fcw> [<output.pdf>]"
-  exit 1
-fi
-
-INPUT_BASENAME="$(basename "$INPUT_FILE" ".fcw")"
-shift
-
-OUTPUT_FILE=${1:-"${INPUT_BASENAME}.pdf"}
-
-WORKDIR="$(mktemp -d)"
-function cleanup {
-	rm -Rf "$WORKDIR"
-}
-trap cleanup EXIT
-
-cp "$INPUT_FILE" "$WORKDIR/in.zip"
-pushd "$WORKDIR" > /dev/null
-unzip "in.zip" > /dev/null
-
-#We could just go with $(ls *.svg) but then the files may be in the wrong order.
-#Hence, let's look up the files in the correct order in the manifest file.
-MANIFEST_FILE=imsmanifest.xml
-PAGE_FILE_QUERY='//resources/resource[@identifier="pages"]/file/@href'
-PAGE_FILE_QUERY_RES=$(xmllint --html --xpath "$PAGE_FILE_QUERY" "$MANIFEST_FILE" 2> /dev/null)
-
-#xmllint's return format is crap; clean it up
-PAGE_FILES=$(echo "$PAGE_FILE_QUERY_RES" | tr "[:space:]" "\n" | cut -d\" -f2 | grep -v '^$')
-
-PDF_FILES=""
-for PAGE_FILE in $PAGE_FILES; do
-	PAGE_BASENAME="$(basename "$PAGE_FILE" ".svg")"
-	PAGE_PDF="$PAGE_BASENAME.pdf"
-    PDF_FILES="$PDF_FILES $PAGE_PDF"
-	echo "Converting $PAGE_BASENAME"
-	#convert -density 90 -define pdf:fit-page=A4 "$PAGE_FILE" "$PAGE_PDF"
-    #pass input via stdin, otherwise cairosvg seems to be unable to open included image files
-	cairosvg -o "$PAGE_PDF" -  < "$PAGE_FILE"
-done
-
-pdfunite $PDF_FILES out.pdf
-
-popd > /dev/null
-cp "$WORKDIR/out.pdf" "$OUTPUT_FILE"

fcwtool/.gitignore

@@ -0,0 +1,4 @@
+*.egg-info
+*.pyc
+tests/
+dist/

fcwtool/LICENSE

@@ -0,0 +1,675 @@
+### GNU GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 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 General Public License is a free, copyleft license for
+software and other kinds of works.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom
+to share and change all versions of a program--to make sure it remains
+free software for all its users. We, the Free Software Foundation, use
+the GNU General Public License for most of our software; it applies
+also to any other work released this way by its authors. You can apply
+it to your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you
+have certain responsibilities if you distribute copies of the
+software, or if you modify it: responsibilities to respect the freedom
+of others.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the
+manufacturer can do so. This is fundamentally incompatible with the
+aim of protecting users' freedom to change the software. The
+systematic pattern of such abuse occurs in the area of products for
+individuals to use, which is precisely where it is most unacceptable.
+Therefore, we have designed this version of the GPL to prohibit the
+practice for those products. If such problems arise substantially in
+other domains, we stand ready to extend this provision to those
+domains in future versions of the GPL, as needed to protect the
+freedom of users.
+
+Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish
+to avoid the special danger that patents applied to a free program
+could make it effectively proprietary. To prevent this, the GPL
+assures that patents cannot be used to render the program non-free.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS
+
+#### 0. Definitions.
+
+"This License" refers to version 3 of the GNU General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+#### 1. Source Code.
+
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same
+work.
+
+#### 2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
+
+#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
+
+#### 4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+#### 5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these
+conditions:
+
+-   a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+-   b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under
+    section 7. This requirement modifies the requirement in section 4
+    to "keep intact all notices".
+-   c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy. This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged. This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+-   d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+#### 6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
+
+-   a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+-   b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    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. Use with the GNU Affero General Public License.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+#### 14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in
+detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU General Public
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that numbered version or
+of any later version published by the Free Software Foundation. If the
+Program does not specify a version number of the GNU General Public
+License, you may choose any version ever published by the Free
+Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions
+of the GNU General Public License can be used, that proxy's public
+statement of acceptance of a version permanently authorizes you to
+choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+#### 15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+#### 16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+#### 17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+### How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+        <one line to give the program's name and a brief idea of what it does.>
+        Copyright (C) <year>  <name of author>
+
+        This program is free software: you can redistribute it and/or modify
+        it under the terms of the GNU General Public License as published by
+        the Free Software Foundation, either version 3 of the License, or
+        (at your option) any later version.
+
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU General Public License for more details.
+
+        You should have received a copy of the GNU General Public License
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+        <program>  Copyright (C) <year>  <name of author>
+        This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+        This is free software, and you are welcome to redistribute it
+        under certain conditions; type `show c' for details.
+
+The hypothetical commands \`show w' and \`show c' should show the
+appropriate parts of the General Public License. Of course, your
+program's commands might be different; for a GUI interface, you would
+use an "about box".
+
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU GPL, see <https://www.gnu.org/licenses/>.
+
+The GNU General Public License does not permit incorporating your
+program into proprietary programs. If your program is a subroutine
+library, you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+GNU Lesser General Public License instead of this License. But first,
+please read <https://www.gnu.org/licenses/why-not-lgpl.html>.

fcwtool/fcw/__init__.py

@@ -0,0 +1,366 @@
+#!/usr/bin/env python3
+
+# fcw.py: a simple module/script collection for handling fcw files used by
+# the SMART Meeting Pro smartboard software.
+# Copyright 2019 Christopher Spinrath <christopher.spinrath@tu-dortmund.de>
+
+# fcw.py is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# fcw.py is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with fcw.py. If not, see <http://www.gnu.org/licenses/>.
+
+import click
+import enum
+import io
+import os
+import pathlib
+import re
+import shutil
+import sys
+import tempfile
+import lxml.etree
+import zipfile
+
+TEMPDIR_SUFFIX = '.fcw.unpacked'
+MANIFEST_FILE = 'imsmanifest.xml'
+METADATA_FILE = 'metadata.xml'
+
+MANIFEST_DEFAULT_NAMESPACE = 'http://www.imsglobal.org/xsd/imscp_v1p1'
+SMARTNOTEBOOK_NAMESPACE = 'http://www.smarttech.com/2006-01/notebook'
+
+MANIFEST_NAMESPACES = {
+    'default': MANIFEST_DEFAULT_NAMESPACE,
+    'lom': 'http://ltsc.ieee.org/xsd/LOM',
+    'smartgallery': 'http://www.smarttech.com/2006-01/gallery',
+    'smartnotebook': SMARTNOTEBOOK_NAMESPACE,
+}
+
+METADATA_NAMESPACES = {
+    'lom': 'http://ltsc.ieee.org/xsd/LOM',
+    'smartgallery': 'http://www.smarttech.com/2006-01/gallery',
+}
+
+FILE_TAG_NAME = '{{{}}}file'.format(MANIFEST_DEFAULT_NAMESPACE)
+
+class FCWResource(enum.Enum):
+    PAGES = 'pages'
+    IMAGES = 'images'
+    SOUNDS = 'sounds'
+    ATTACHMENTS = 'attachments'
+    FLASH = 'flash'
+    VIDEOS = 'videos'
+    ANNOTATIONMETADATA = 'annotationmetadata'
+    BRUSH = 'brush'
+
+
+class FCWFile:
+    def __init__(self, filename):
+        self._manifest = None
+        self._metadata = None
+        self._filename = filename
+        self._workdir_handler = tempfile.TemporaryDirectory(suffix = TEMPDIR_SUFFIX)
+        self._unpack()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, type, value, traceback):
+        if self._workdir_handler:
+            self._workdir_handler.cleanup()
+        return False # we don't handle exceptions here
+
+    @property
+    def workdir(self):
+        return pathlib.Path(self._workdir_handler.name)
+
+    @property
+    def filename(self):
+        return self._filename
+
+    @property
+    def manifest_filename(self):
+        return self.workdir / MANIFEST_FILE
+
+    @property
+    def metadata_filename(self):
+        return self.workdir / METADATA_FILE
+
+    @property
+    def manifest(self):
+        if not self._manifest:
+            self._manifest = lxml.etree.parse(str(self.manifest_filename))
+        return self._manifest
+
+    @property
+    def metadata(self):
+        if not self._metadata:
+            self._metadata = lxml.etree.parse(str(self.metadata_filename))
+        return self._metadata
+
+    @property
+    def manifest_version(self):
+        root = self.manifest.getroot()
+        return root.attrib['version']
+
+    @property
+    def creationdatetime(self):
+        root = self.metadata.getroot()
+        query = './/lom:lifeCycle/smartgallery:creationdatetime'
+
+        tag = root.find(query, METADATA_NAMESPACES)
+        return tag.text
+
+    @property
+    def filesource(self):
+        root = self.manifest.getroot()
+        return root.attrib["{{{}}}filesource".format(SMARTNOTEBOOK_NAMESPACE)]
+
+    def get_resources(self, identifier):
+        root = self.manifest.getroot()
+        query = './/default:resources/default:resource[@identifier="{}"]'.format(identifier.value)
+        tags = root.findall(query, MANIFEST_NAMESPACES)
+        assert len(tags) == 1, 'Failed to query resources \"{}\"'.format(identifier)
+
+        return tags[0]
+
+    def _get_file_path(self, xml_element):
+        # So far all paths were windows paths, thus we have to parse them as such
+        return pathlib.PureWindowsPath(xml_element.attrib['href'])
+
+    def get_pages(self):
+        return self.get_resource_files(FCWResource.PAGES)
+
+    def get_resource_files(self, resource_type):
+        resources = self.get_resources(resource_type)
+
+        tags = resources.findall('default:file', MANIFEST_NAMESPACES)
+        return [ self._get_file_path(t) for t in tags ]
+
+    def get_all_resource_files(self):
+        return sum([ self.get_resource_files(r) for r in FCWResource ], [])
+
+    def get_startpage(self):
+        resources = self.get_resources(FCWResource.PAGES)
+        startpage = self._get_file_path(resources)
+        
+        pages = self.get_pages()
+        index = pages.index(startpage)
+
+        return (index, startpage)
+
+    def set_startpage(self, index):
+        pages = self.get_pages()
+        new_startpage = pathlib.PureWindowsPath(pages[index])
+
+        resources = self.get_resources(FCWResource.PAGES)
+        resources.set('href', str(new_startpage))
+
+    def _get_max_page_index(self):
+        pages = self.get_pages()
+        regex = '[0-9]+' # We assume here that page files are named pageN.svg where N is a natural number
+
+        indices = ( int(re.search(regex, str(p)).group()) for p in pages )
+        return max(indices)
+
+    def append_svg(self, svg_filename):
+        next_page_index = self._get_max_page_index() + 1
+
+        # new_name has to be a WindowsPath because we write it to the manifest
+        new_name = pathlib.PureWindowsPath("page{}.svg".format(next_page_index))
+        self._append_resource_file(FCWResource.PAGES, svg_filename, new_name)
+        
+    def append_pages(self, other):
+        for page in other.get_pages():
+            old_filename = other.workdir / page
+            self.append_svg(old_filename)
+
+    def _append_resources(self, other, resource_type):
+        other_resources = other.get_resources(resource_type)
+        self_resource_files = self.get_all_resource_files()
+
+        for r in other_resources:
+            if r.tag != FILE_TAG_NAME:
+                print("WARNING: Unknown resource tag for type \"{}\" in {}.".format(resource_type.value, other.filename))
+                print("WARNING: unable to merge, the output file might be broken/unusable!")
+                continue
+            
+            href = other._get_file_path(r)
+            #TODO: in the following case more can be done, but inter-resources references
+            #      had to be adapted as well, in particular, those in pages
+            if href in self_resource_files:
+                print("WARNING: both files have a resource named \"{}\".".format(href))
+                print("WARNING: unable to merge, the output file might be broken/unusable!")
+                continue
+
+            other_filename = other.workdir / href
+            self._append_resource_file(resource_type, other_filename, href)
+
+    def _append_resource_file(self, resource_type, src_filename, href):
+        # make sure href is a WindowsPath, since we are writing it to the manifest
+        href = pathlib.PureWindowsPath(href)
+
+        new_filename = self.workdir / href
+        assert not new_filename.exists()
+
+        new_filename.parent.mkdir(parents = True, exist_ok = True)
+        shutil.copy(src_filename, new_filename)
+
+        lxml.etree.SubElement(
+            self.get_resources(resource_type),
+            FILE_TAG_NAME,
+            attrib = { 'href': str(href) },
+        )
+
+    def append(self, other):
+        self.append_pages(other)
+
+        for r in FCWResource:
+            if r == FCWResource.PAGES:
+                continue
+            self._append_resources(other, r)
+
+    def export_pdf(self, target, interactive = False):
+        from cairosvg import svg2pdf
+        from PyPDF2 import PdfFileMerger
+        from tqdm import tqdm
+
+        merger = PdfFileMerger()
+        pages = self.get_pages()
+
+        for page in tqdm(pages, disable = not interactive):
+            filename = self.workdir / page
+
+            pdf = svg2pdf(url = str(filename))
+            pdfstream = io.BytesIO(pdf)
+            merger.append(fileobj = pdfstream)
+
+        merger.write(str(target))
+
+    def save(self, filename = None):
+        if filename is None:
+            filename = self.filename
+
+        # write manifest
+        self.manifest.write(
+                str(self.manifest_filename),
+                encoding = 'UTF-8',
+                xml_declaration = True,
+                standalone = True,
+        )
+
+        self._pack(filename)
+    
+    def _pack(self, filename):
+        with zipfile.ZipFile(filename, 'w') as zf:
+            for directory, subdirectories, filenames in os.walk(self.workdir):
+                for filename in filenames:
+                    reldir = pathlib.Path(directory).relative_to(self.workdir)
+
+                    rel_filename = reldir / filename
+                    abs_filename = self.workdir / rel_filename
+
+                    zf.write(str(abs_filename), arcname = str(rel_filename))
+
+    def _unpack(self):
+        with zipfile.ZipFile(self.filename, 'r') as zf:
+            zf.extractall(self.workdir)
+
+
+@click.group()
+def _cli():
+    pass
+
+@_cli.command(name = 'topdf')
+@click.argument('input', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+@click.argument('output', required = False, type = click.Path(exists = False, writable = True, file_okay = True, dir_okay = False))
+def _fcw2pdf(input, output):
+
+    input = pathlib.Path(input)
+    if output is None:
+        if input.suffix == '.fcw':
+            output = input.with_suffix('.pdf')
+        else:
+            output = input.with_name(input.name + '.pdf')
+
+    click.echo(":: Converting {} to {}.".format(input, output))
+    with FCWFile(input) as fcw:
+        fcw.export_pdf(output, interactive = True)
+
+@_cli.command(name = 'merge')
+@click.argument('input1', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+@click.argument('input2', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+@click.argument('output', type = click.Path(exists = False, writable = True, file_okay = True, dir_okay = False))
+def _fcwmerge(input1, input2, output):
+    click.echo(":: Merging {} and {} into {}".format(input1, input2, output))
+    
+    with FCWFile(input1) as fcw1, FCWFile(input2) as fcw2:
+        fcw1.append(fcw2)
+        fcw1.save(output)
+
+#NOTE: Appending arbitrary SVG files does not work, thus the following command is disabled.
+#      It seems only a subset of the SVG spec/only some CSS classes are available in SMART Meeting Pro.
+#@__cli.command(name = 'append-svg')
+#@click.argument('input', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+#@click.argument('svgfile', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+#@click.argument('output', type = click.Path(exists = False, writable = True, file_okay = True, dir_okay = False))
+#def __fcwappendsvg(input, svgfile, output):
+#    click.echo(":: Appending {} to {} resulting in {}".format(svgfile, input, output))
+#    
+#    with FCWFile(input) as fcw:
+#        fcw.append_svg(svgfile)
+#        fcw.save(output)
+
+@_cli.command(name = 'info')
+@click.argument('input', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+def _fcwinfo(input):
+    with FCWFile(input) as fcw:
+        click.echo("Manifest version: {}".format(fcw.manifest_version))
+        click.echo("Creation datetime: {}".format(fcw.creationdatetime))
+        click.echo("Filesource: {}".format(fcw.filesource))
+        index, startpage = fcw.get_startpage()
+        click.echo("Start page index: {} (internal page name is {})".format(index, startpage))
+        click.echo()
+        click.echo("Resources:")
+        for resource in FCWResource:
+            click.echo("#{}: {}".format(resource.value, len(list(fcw.get_resources(resource)))))
+
+@_cli.command(name = 'set-startpage')
+@click.argument('input', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+@click.argument('index', type = click.INT)
+@click.argument('output', required = False, type = click.Path(exists = False, writable = True, file_okay = True, dir_okay = False))
+def _fcwsetstartpage(input, index, output):
+    print("WARNING: this function has never been tested!")
+    if output is None:
+        output = input
+
+    with FCWFile(input) as fcw:
+        fcw.set_startpage(index)
+        fcw.save(output)
+        index, newstartpage = fcw.get_startpage()
+
+        print("New startpage index is {} (internal page name is {})".format(index, newstartpage))
+
+@_cli.command(name = 'print-manifest')
+@click.argument('input', type = click.Path(exists = True, readable = True, file_okay = True, dir_okay = False))
+def _fcwmanifest(input):
+    with FCWFile(input) as fcw:
+        stream = io.BytesIO()
+        fcw.manifest.write(stream, encoding = 'utf-8', xml_declaration = True, standalone = True)
+        stream.seek(0)
+        print(stream.read().decode('utf-8'))
+
+@_cli.command(name = 'license')
+def _license():
+    progname = pathlib.Path(sys.argv[0]).name
+    click.echo("{} Copyright (C) 2019  Christopher Spinrath <christopher.spinrath@tu-dortmund.de>".format(progname))
+    click.echo("This program comes with ABSOLUTELY NO WARRANTY.")
+    click.echo("This is free software, and you are welcome to redistribute it")
+    click.echo("under certain conditions; see the LICENSE file for details.")

fcwtool/requirements.txt

@@ -0,0 +1,5 @@
+click
+lxml
+cairosvg
+PyPDF2
+tqdm

fcwtool/setup.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+
+from setuptools import setup, find_packages
+
+setup(
+    name="fcwtool",
+    version="0.1",
+    packages=find_packages(),
+
+    author="Christopher Spinrath",
+    author_email="christopher.spinrath@tu-dortmund.de",
+    description="Tools for reading and manipulating SMART Meeting Pro files",
+
+    license='GPLv3',
+
+    entry_points={
+        'console_scripts': [
+            'fcw2pdf = fcw:_fcw2pdf',
+            'fcwmerge = fcw:_fcwmerge',
+            'fcwinfo = fcw:_fcwinfo',
+            'fcwtool = fcw:_cli',
+        ],
+    },
+
+    install_requires=[
+        'click',
+        'lxml',
+        'cairosvg',
+        'PyPDF2',
+        'tqdm',
+    ],
+)

veracrypt/Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[dev-packages]
+
+[packages]
+keyring = "*"
+argparse = "*"
+
+[requires]
+python_version = "3.7"

veracrypt/Pipfile.lock

@@ -0,0 +1,44 @@
+{
+    "_meta": {
+        "hash": {
+            "sha256": "32491b4a5deb7c2757b3d9351501f0e91cd1abdd60bef1365f87dcddd29e9286"
+        },
+        "pipfile-spec": 6,
+        "requires": {
+            "python_version": "3.7"
+        },
+        "sources": [
+            {
+                "name": "pypi",
+                "url": "https://pypi.org/simple",
+                "verify_ssl": true
+            }
+        ]
+    },
+    "default": {
+        "argparse": {
+            "hashes": [
+                "sha256:62b089a55be1d8949cd2bc7e0df0bddb9e028faefc8c32038cc84862aefdd6e4",
+                "sha256:c31647edb69fd3d465a847ea3157d37bed1f95f19760b11a47aa91c04b666314"
+            ],
+            "index": "pypi",
+            "version": "==1.4.0"
+        },
+        "entrypoints": {
+            "hashes": [
+                "sha256:10ad569bb245e7e2ba425285b9fa3e8178a0dc92fc53b1e1c553805e15a8825b",
+                "sha256:d2d587dde06f99545fb13a383d2cd336a8ff1f359c5839ce3a64c917d10c029f"
+            ],
+            "version": "==0.2.3"
+        },
+        "keyring": {
+            "hashes": [
+                "sha256:6364bb8c233f28538df4928576f4e051229e0451651073ab20b315488da16a58",
+                "sha256:6e01954fd3e404820e1fade262ee661974051551ed08c899ffc5e88bb9df288e"
+            ],
+            "index": "pypi",
+            "version": "==13.2.1"
+        }
+    },
+    "develop": {}
+}

veracrypt/verausbdrive.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+
+import argparse
+import getpass
+import keyring
+import os
+import subprocess
+import sys
+
+DESCRIPTION = "Wrapper for VeraCrypt to assist in working with data on an encrypted usb drive (e.g.\ a GIT repository)."
+KEYRING_SERVICE = "de.tu-dortmund.cs.ls1.veracryptwrapper.hisdnp"
+VERA_CONTAINER_NAME_ENV_VAR = "VERA_CONTAINER_NAME"
+
+DEFAULT_DRIVE_NAME = "KINGSTON"
+DEFAULT_VERA_VOL_NAME = "NO NAME"
+#TODO determine this based on OS
+DEFAULT_MNT_PATH = "/Volumes"
+
+VERA_BINARIES = [
+        'veracrypt',
+        'VeraCrypt',
+        '/Applications/VeraCrypt.app/Contents/MacOS/VeraCrypt', #MacOS
+]
+
+VERA_PARAM_TEXT_MODE = '-t'
+VERA_PARAM_STDIN = '--stdin'
+VERA_PARAM_NON_INTERACTIVE = '--non-interactive'
+
+ARG_CONTAINER_NAME = "arg_container"
+ARG_USB_DRIVE_NAME = "arg_usbstick"
+ARG_VERA_VOL_NAME = "arg_volname"
+ARG_MOUNT_PATH = "arg_mountpath"
+ARG_UNMOUNT_USB_DRIVE = "arg_unmountusbdrive"
+ARG_RESET_PASSWORD = "arg_resetpw"
+ARG_VERA_DISMOUNT = "arg_vera_dismount"
+
+def __vera_binary():
+    binaries = [ b for b in VERA_BINARIES if os.path.exists(b) ]
+    assert binaries, "Unable to find VeraCrypt executable!"
+
+    return binaries[0]
+
+def __sync_io():
+    #Sync all I/O devices (just in case)
+    res = subprocess.run([
+        'sync'
+    ])
+    res.check_returncode()
+    
+def __store_password(username, pw):
+    keyring.set_password(KEYRING_SERVICE, username, pw)
+
+def __delete_password(username):
+    keyring.delete_password(KEYRING_SERVICE, username)
+
+def __get_password(username, reset_pw = False):
+    if reset_pw:
+        __delete_password(username)
+
+    pw = keyring.get_password(KEYRING_SERVICE, username)
+    if not pw:
+        pw = getpass.getpass()
+    return pw
+
+def __vera_exec(option_list, password = None):
+    args = [ __vera_binary(), VERA_PARAM_TEXT_MODE ]
+
+    if password:
+        args = args + [ VERA_PARAM_STDIN ]
+        password = password.encode()
+
+    return subprocess.run(args + option_list, input = password).returncode
+
+def vera_unmount(volume_path):
+    __sync_io()
+    res = __vera_exec(['-d', volume_path])
+    assert res == 0, \
+            "Failed to dismount VeraCrypt volume! VeraCrypt exited with status {}.".format(res)
+    __sync_io()
+
+#TODO the following function is MacOS specific
+def unmount_usbdrive(usbdrive_mnt_path):
+    __sync_io()
+    res = subprocess.run([
+        'diskutil',
+        'unmount',
+        usbdrive_mnt_path,
+    ])
+
+    res.check_returncode()
+
+def vera_mount(volume_path, container, identifier):
+    pw = __get_password(identifier)
+
+    res = __vera_exec([
+        VERA_PARAM_NON_INTERACTIVE,
+        '--mount', container,
+    ], pw)
+
+    assert res == 0, \
+            "Failed to mount VeraCrypt volume! VeraCrypt exited with status {}.".format(res)
+    __store_password(identifier, pw)
+
+def __parse_cmdline():
+    parser = argparse.ArgumentParser(description = DESCRIPTION)
+
+    container_name_default = os.environ.get(VERA_CONTAINER_NAME_ENV_VAR)
+    if container_name_default:
+        parser.add_argument(ARG_CONTAINER_NAME, default = container_name_default, nargs = '?',
+            help = "Path of the encrypted container file on the usb drive")
+    else:
+        parser.add_argument(ARG_CONTAINER_NAME,
+            help = "Path of the encrypted container file on the usb drive")
+
+    parser.add_argument('--mount-path', '-m', dest = ARG_MOUNT_PATH, default = DEFAULT_MNT_PATH)
+    parser.add_argument('--vera-volume-name', '-v', dest = ARG_VERA_VOL_NAME, default = DEFAULT_VERA_VOL_NAME)
+    parser.add_argument('--usb-drive-part-name', '-n', dest = ARG_USB_DRIVE_NAME, default = DEFAULT_DRIVE_NAME)
+
+    parser.add_argument('--reset-password', '-p', dest = ARG_RESET_PASSWORD, action = 'store_true')
+    parser.add_argument('--dismount', '-d', dest = ARG_VERA_DISMOUNT, action = 'store_true')
+    parser.add_argument('--unmount-usb-drive', '-u', dest = ARG_UNMOUNT_USB_DRIVE, action = 'store_true')
+
+    return vars(parser.parse_args())
+
+def __main():
+    args = __parse_cmdline()
+
+    volume_name = args[ARG_VERA_VOL_NAME]
+    mnt_path = args[ARG_MOUNT_PATH]
+    volume = os.path.join(mnt_path, volume_name)
+
+    usbdrive_name = args[ARG_USB_DRIVE_NAME]
+    usbdrive = os.path.join(mnt_path, usbdrive_name)
+
+    container_name = args[ARG_CONTAINER_NAME]
+    container = os.path.join(usbdrive, container_name)
+
+    identifier = ':'.join([
+        getpass.getuser(),
+        usbdrive_name,
+        container_name,
+    ])
+    
+    if args[ARG_RESET_PASSWORD]:
+        __delete_password(identifier)
+
+    if not os.path.exists(usbdrive):
+        print(":: USB partition mount point \"{}\" doesn't exist. Ignoring request.".format(usbdrive))
+        return
+
+    if args[ARG_VERA_DISMOUNT]:
+        if os.path.exists(volume):
+            vera_unmount(volume)
+        else:
+            print(":: VeraCrypt mount point \"{}\" doesn't exist. Skipping unmount!".format(volume))
+
+        if args[ARG_UNMOUNT_USB_DRIVE]:
+            unmount_usbdrive(usbdrive)
+        return
+
+    if os.path.exists(volume):
+        print(":: VeraCrypt mount point \"{}\" already exists! Assuming container is already mounted.".format(volume))
+        return
+
+    vera_mount(volume, container, identifier)
+
+if __name__ == '__main__':
+    __main()

veracrypt/verausbdrive.sh.example

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+########################################################
+# Configuration
+########################################################
+
+USB_DRIVE_PART_NAME="KINGSTON"
+VERA_DRIVE_NAME="NO NAME"
+VERA_CONTAINER_PATH_REL="VERSCHLUESSELT/GTIKlausuren"
+
+MOUNT_PATH="/Volumes/"
+
+PYTHON_VERA_WRAPPER_BIN=~/ls1-misc/veracrypt/verausbdrive.py
+
+########################################################
+
+set -e
+
+MY_BASEPATH="$(dirname "$PYTHON_VERA_WRAPPER_BIN")"
+MY_BINARY="$(basename "$PYTHON_VERA_WRAPPER_BIN")"
+
+pushd "$MY_BASEPATH" > /dev/null
+	pipenv run ./"$MY_BINARY" -m "$MOUNT_PATH" -v "$VERA_DRIVE_NAME" -n "$USB_DRIVE_PART_NAME" "$VERA_CONTAINER_PATH_REL" $@
+popd > /dev/null