OMS/tiedote.md
3
0
Fork 0
Code Issues 14 Pull Requests Projects Releases Wiki Activity

Compare commits

merge into: OMS:main
Branches Tags
OMS:main
OMS:keyring
...
pull from: OMS:keyring
Branches Tags
OMS:main
OMS:keyring

No commits in common. "main" and "keyring" have entirely different histories.
main ... keyring

23 changed files with 52 additions and 2747 deletions
Show Stats Expand all files Collapse all files

4
.guix-authorizations
View File

@ -1,4 +0,0 @@
(authorizations
(version 0)
(("A0C9 1947 734F 076F 5F08 E9FF 257D 284A 2A1D 3A32"
(name "Saku Laesvuori"))))

5
.guix-channel
View File

@ -1,5 +0,0 @@
(channel
(version 0)
(url "https://git.olarinmaensamoojat.fi/OMS/tiedote.md.git")
(directory ".guix/modules"))

580
.guix/modules/tiedote-md-package.scm
View File

@ -1,580 +0,0 @@
(define-module (tiedote-md-package)
#:use-module (guix)
#:use-module (guix build-system haskell)
#:use-module (guix download)
#:use-module (guix git-download)
#:use-module ((guix licenses) #:prefix license:)
#:use-module (guix packages)
#:use-module (gnu packages haskell)
#:use-module (gnu packages haskell-xyz)
#:use-module (gnu packages haskell-crypto)
#:use-module (gnu packages haskell-check)
#:use-module (gnu packages haskell-web)
#:use-module (gnu packages golang-web)
#:use-module (gnu packages version-control))
(define vcs-file?
(or (git-predicate (string-append (current-source-directory) "/../.."))
(const #t)))
(define-public tiedote-md
(package
(name "tiedote-md")
(version "0.0.1-git")
(source (local-file "../.." "tiedote-md-checkout"
#:recursive? #t
#:select? vcs-file?))
(build-system haskell-build-system)
(inputs (list ghc-acid-state
ghc-attoparsec
ghc-base64
ghc-cryptonite
ghc-case-insensitive
ghc-glob
ghc-purebred-email
ghc-optparse-applicative
ghc-filestore
ghc-hostname
ghc-pandoc
ghc-file-embed
ghc-safecopy
ghc-scotty
ghc-exit-codes
git
go-github-com-aymerick-douceur))
(arguments
(list
#:phases
#~(modify-phases %standard-phases
(add-after 'install 'wrap-binaries
(lambda _
(wrap-program
(string-append #$output "/bin/tiedote.md")
`("PATH" prefix (,(string-append #$(this-package-input "git") "/bin")
,(string-append #$(this-package-input "go-github-com-aymerick-douceur")
"/bin")))))))))
(home-page "https://git.olarinmaensamoojat.fi/OMS/tiedote.md")
(synopsis "Git- ja markdown-pohjainen masssasähköpostijärjestelmä OMS:lle")
(description
"Tiedote.md on massasähköpostijärjestelmä, joka käyttää
massasähköpostien hallintaan git-tietovarastossa olevia markdown-tiedostoja ja
sähköpostipohjaista käyttöliittymää. Toistaiseksi tiedote.md on kovakoodattu
käyttämään OMS:n tiedotepohjia.")
(license license:agpl3+)))
(define ghc-scotty
(package
(name "ghc-scotty")
(version "0.12")
(source (origin
(method url-fetch)
(uri (hackage-uri "scotty" version))
(sha256
(base32
"1lpggpdzgjk23mq7aa64yylds5dbm4ynhcvbarqihjxabvh7xmz1"))))
(build-system haskell-build-system)
(inputs (list ghc-aeson
ghc-base-compat-batteries
ghc-blaze-builder
ghc-case-insensitive
ghc-data-default-class
ghc-fail
ghc-http-types
ghc-monad-control
ghc-nats
ghc-network
ghc-regex-compat
ghc-transformers-base
ghc-transformers-compat
ghc-wai
ghc-wai-extra
ghc-warp))
(native-inputs (list ghc-async ghc-hspec ghc-hspec-wai ghc-lifted-base hspec-discover))
(arguments
`(#:cabal-revision ("7"
"1i8icc612w4dbmqmnf99drqpmjvhjnkmqgk9xr63amj8jkz5lp4m")))
(home-page "https://github.com/scotty-web/scotty")
(synopsis
"Haskell web framework inspired by Ruby's Sinatra, using WAI and Warp")
(description
"This package provides a Haskell web framework inspired by Ruby's Sinatra, using
WAI and Warp. . @ {-# LANGUAGE OverloadedStrings #-} . import
Web.Scotty . import Data.Monoid (mconcat) . main = scotty 3000 $   get
&#34;/:word&#34; $ do &#32;&#32;&#32;&#32;beam <- param &#34;word&#34;
&#32;&#32;&#32;&#32;html $ mconcat [&#34;&#60;h1&#62;Scotty, &#34;, beam, &#34;
me up!&#60;/h1&#62;&#34;] @ . . Scotty is the cheap and cheerful way to write
RESTful, declarative web applications. . * A page is as simple as defining the
verb, url pattern, and Text content. . * It is template-language agnostic.
Anything that returns a Text value will do. . * Conforms to WAI Application
interface. . * Uses very fast Warp webserver by default. . As for the name:
Sinatra + Warp = Scotty. . [WAI] <http://hackage.haskell.org/package/wai> .
[Warp] <http://hackage.haskell.org/package/warp>")
(license license:bsd-3)))
(define ghc-hspec-wai
(package
(name "ghc-hspec-wai")
(version "0.11.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "hspec-wai" version))
(sha256
(base32
"03wiksic5y9a2g6a86nsxrnajdgdvpv17w02h5qla0zp9zs6pa1j"))))
(build-system haskell-build-system)
(inputs (list ghc-quickcheck
ghc-base-compat
ghc-case-insensitive
ghc-hspec-core
ghc-hspec-expectations
ghc-http-types
ghc-wai
ghc-wai-extra))
(native-inputs (list ghc-hspec hspec-discover))
(home-page "https://github.com/hspec/hspec-wai#readme")
(synopsis "Experimental Hspec support for testing WAI applications")
(description "Experimental Hspec support for testing WAI applications")
(license license:expat)))
(define ghc-acid-state
(package
(name "ghc-acid-state")
(version "0.16.1.2")
(source (origin
(method url-fetch)
(uri (hackage-uri "acid-state" version))
(sha256
(base32
"1ixg62liif1g18ggxap8zdhzy261fj5d24pmb0n36gfhz18b38bx"))))
(build-system haskell-build-system)
(properties '((upstream-name . "acid-state")))
(inputs (list ghc-cereal
ghc-safecopy
ghc-filelock
ghc-network
ghc-network-bsd
ghc-th-expand-syns))
(native-inputs (list ghc-hspec ghc-hspec-discover ghc-hedgehog))
(home-page "https://github.com/acid-state/acid-state")
(synopsis "Add ACID guarantees to any serializable Haskell data structure.")
(description
"Use regular Haskell data structures as your database and get stronger ACID
guarantees than most RDBMS offer.")
(license license:public-domain)))
(define ghc-safecopy
(package
(name "ghc-safecopy")
(version "0.10.4.2")
(source (origin
(method url-fetch)
(uri (hackage-uri "safecopy" version))
(sha256
(base32
"0r2mf0p82gf8vnldx477b5ykrj1x7hyg13nqfn6gzb50japs6h3i"))))
(build-system haskell-build-system)
(properties '((upstream-name . "safecopy")))
(inputs (list ghc-cereal
ghc-generic-data
ghc-old-time
ghc-vector))
(native-inputs (list ghc-lens
ghc-lens-action
ghc-tasty
ghc-tasty-quickcheck
ghc-quickcheck-instances
ghc-quickcheck
ghc-hunit))
(arguments
`(#:cabal-revision ("6"
"0ii5cdg4l4ww81p7gd5m3z2jdqrs2hvqhwzrlz267nzxbws00x0b")))
(home-page "https://github.com/acid-state/safecopy")
(synopsis "Binary serialization with version control.")
(description "An extension to Data.Serialize with built-in version control.")
(license license:public-domain)))
(define ghc-generic-data
(package
(name "ghc-generic-data")
(version "1.0.0.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "generic-data" version))
(sha256
(base32
"0fz65k4sxn9c23rg5iv0vij2mksl5rkn6dl2f3i9d9d60b5wca9y"))))
(build-system haskell-build-system)
(properties '((upstream-name . "generic-data")))
(inputs (list ghc-ap-normalize
ghc-contravariant
ghc-show-combinators))
(native-inputs (list ghc-tasty
ghc-tasty-hunit
ghc-tasty
ghc-tasty-hunit
ghc-tasty
ghc-tasty-hunit
ghc-generic-lens
ghc-tasty
ghc-tasty-hunit
ghc-generic-lens
ghc-one-liner))
(home-page "https://github.com/Lysxia/generic-data#readme")
(synopsis "Deriving instances with GHC.Generics and related utilities")
(description
"Generic implementations of standard type classes. Operations on generic
representations to help using \"GHC.Generics\". See README.")
(license license:expat)))
(define ghc-lens-action
(package
(name "ghc-lens-action")
(version "0.2.6")
(source (origin
(method url-fetch)
(uri (hackage-uri "lens-action" version))
(sha256
(base32
"0cdprc5j6r976dmrga2zwvcr7qsv7nqy3nvncp66yyy0dk2qlwm3"))))
(build-system haskell-build-system)
(properties '((upstream-name . "lens-action")))
(inputs (list ghc-lens ghc-comonad ghc-contravariant ghc-profunctors
ghc-semigroupoids))
(arguments
`(#:cabal-revision ("2"
"0rrrv7k0fz98j99a6gzw858v5w3i378g0b7ijj30dz2am6p6rfnm")))
(home-page "http://github.com/ekmett/lens-action/")
(synopsis "Monadic Getters and Folds")
(description
"This package contains combinators and types for working with monadic getters and
folds as split off from the original lens package.")
(license license:bsd-3)))
(define ghc-ap-normalize
(package
(name "ghc-ap-normalize")
(version "0.1.0.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "ap-normalize" version))
(sha256
(base32
"1212zxc4qn6msk0w13yhrza2qjs79h78misllb4chng75jqi61l2"))))
(build-system haskell-build-system)
(properties '((upstream-name . "ap-normalize")))
(native-inputs (list ghc-inspection-testing ghc-inspection-testing))
(home-page "http://hackage.haskell.org/package/ap-normalize")
(synopsis "Self-normalizing applicative expressions")
(description
"An applicative functor transformer to normalize expressions using @@(\\<$>)@@,
@@(\\<*>)@@, and @@pure@@ into a linear list of actions. See \"ApNormalize\" to
get started.")
(license license:expat)))
(define ghc-show-combinators
(package
(name "ghc-show-combinators")
(version "0.2.0.0")
(source (origin
(method url-fetch)
(uri (hackage-uri "show-combinators" version))
(sha256
(base32
"07ds87ldl9165hj3k5h84iawc6vqlbggni3dg1nhbxww1spxn0n9"))))
(build-system haskell-build-system)
(properties '((upstream-name . "show-combinators")))
(arguments
`(#:cabal-revision ("2"
"0n3xlpm41wpw1ybmacg9s7150nx00qrdlw2rq4fzz7iw7333cyjx")))
(home-page "https://github.com/Lysxia/show-combinators#readme")
(synopsis "Combinators to write Show instances")
(description
"This package provides a minimal pretty-printing library for Show instances in
Haskell.")
(license license:expat)))
(define ghc-generic-lens
(package
(name "ghc-generic-lens")
(version "2.2.2.0")
(source (origin
(method url-fetch)
(uri (hackage-uri "generic-lens" version))
(sha256
(base32
"0s4b51s11ssmndmx9m9zbwgv9rb27ajwihsrk10hn582rp4ck3c6"))))
(build-system haskell-build-system)
(properties '((upstream-name . "generic-lens")))
(inputs (list ghc-generic-lens-core ghc-profunctors))
(native-inputs (list ghc-lens
ghc-inspection-testing
ghc-hunit
ghc-lens
ghc-hunit
ghc-lens
ghc-hunit
ghc-doctest
ghc-lens))
(home-page "https://github.com/kcsongor/generic-lens")
(synopsis "Generically derive traversals, lenses and prisms.")
(description
"This library uses GHC.Generics to derive efficient optics (traversals, lenses
and prisms) for algebraic data types in a type-directed way, with a focus on
good type inference and error messages when possible. The library exposes a
van Laarhoven interface. For an alternative interface, supporting an opaque
optic type, see @@<https://hackage.haskell.org/package/generic-optics
generic-optics>@@.")
(license license:bsd-3)))
(define ghc-one-liner
(package
(name "ghc-one-liner")
(version "2.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "one-liner" version))
(sha256
(base32
"09gdivd38disddxs42179vmgca0yzk5dfm6ygicgl5l25qbizrfh"))))
(build-system haskell-build-system)
(properties '((upstream-name . "one-liner")))
(inputs (list ghc-contravariant ghc-bifunctors ghc-profunctors ghc-tagged
ghc-linear-base))
(native-inputs (list ghc-hunit))
(arguments
`(#:cabal-revision ("1"
"1n6d74s0x91qi4fi6wv5yggjb1nvwk0ir580mkf67bca2x6f1cqn")))
(home-page "https://github.com/sjoerdvisscher/one-liner")
(synopsis "Constraint-based generics")
(description
"Write short and concise generic instances of type classes. one-liner is
particularly useful for writing default implementations of type class methods.")
(license license:bsd-3)))
(define ghc-generic-lens-core
(package
(name "ghc-generic-lens-core")
(version "2.2.1.0")
(source (origin
(method url-fetch)
(uri (hackage-uri "generic-lens-core" version))
(sha256
(base32
"08i4c9yb6z84iknrnl9f3f343121j7ilp0a679v81nsjm9xz3rlf"))))
(build-system haskell-build-system)
(properties '((upstream-name . "generic-lens-core")))
(inputs (list ghc-indexed-profunctors))
(arguments
`(#:cabal-revision ("1"
"1dbjhd6k7ypqa9f4h9v2xndgb4mjhfli3n1vjm8r8ga0kfndbqfn")))
(home-page "https://github.com/kcsongor/generic-lens")
(synopsis "Generically derive traversals, lenses and prisms.")
(description
"This library uses GHC.Generics to derive efficient optics (traversals, lenses
and prisms) for algebraic data types in a type-directed way, with a focus on
good type inference and error messages when possible. This package is the
shared internal logic of the @@<https://hackage.haskell.org/package/generic-lens
generic-lens>@@ and @@<https://hackage.haskell.org/package/generic-optics
generic-optics>@@ libraries.")
(license license:bsd-3)))
(define ghc-indexed-profunctors
(package
(name "ghc-indexed-profunctors")
(version "0.1.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "indexed-profunctors" version))
(sha256
(base32
"1cbccbvrx73drr1jf3yyw0rp1mcfv3jc1rvdcby5xxx4ja543fjs"))))
(build-system haskell-build-system)
(properties '((upstream-name . "indexed-profunctors")))
(home-page "http://hackage.haskell.org/package/indexed-profunctors")
(synopsis "Utilities for indexed profunctors")
(description
"This package contains basic definitions related to indexed profunctors. These
are primarily intended as internal utilities to support the @@optics@@ and
@@generic-lens@@ package families.")
(license license:bsd-3)))
(define ghc-linear-base
(package
(name "ghc-linear-base")
(version "0.3.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "linear-base" version))
(sha256
(base32
"1gm8bwyi39x5x29xb6nq13x9x9p30vm29s11k4pkcql70sj4pv0h"))))
(build-system haskell-build-system)
(properties '((upstream-name . "linear-base")))
(inputs (list ghc-hashable ghc-linear-generics ghc-storable-tuple ghc-vector
ghc-primitive))
(native-inputs (list ghc-inspection-testing
ghc-tasty-inspection-testing
ghc-hedgehog
ghc-tasty
ghc-tasty-hedgehog
ghc-mmorph
ghc-tasty
ghc-tasty-hedgehog
ghc-hedgehog))
(arguments
`(#:cabal-revision ("1"
"153nkw2i7n22xzfj8q2xmzsh77pr7pay8v3gc1xli491qmsc0fcd")))
(home-page "https://github.com/tweag/linear-base#README")
(synopsis "Standard library for linear types.")
(description "Please see README.md.")
(license license:expat)))
(define ghc-linear-generics
(package
(name "ghc-linear-generics")
(version "0.2.2")
(source (origin
(method url-fetch)
(uri (hackage-uri "linear-generics" version))
(sha256
(base32
"0ls571qzayky0dax9d209lw9wv344z3969daqcsncv0r5rlvlps9"))))
(build-system haskell-build-system)
(properties '((upstream-name . "linear-generics")))
(inputs (list ghc-th-abstraction-0.5))
(native-inputs (list ghc-hspec hspec-discover))
(home-page "https://github.com/linear-generics/linear-generics")
(synopsis "Generic programming library for generalised deriving.")
(description
"This package offers a version of
<https://hackage.haskell.org/package/base/docs/GHC-Generics.html GHC.Generics>
with two important improvements: 1. The @@to@@, @@from@@, @@to1@@, and
@@from1@@ methods have multiplicity-polymorphic types, allowing them to be used
with either traditional Haskell code or linearly typed code. 2. The
representations used for @@Generic1@@ are modified slightly.")
(license license:bsd-3)))
(define ghc-th-abstraction-0.5
(package
(inherit ghc-th-abstraction)
(version "0.5.0.0")
(source (origin
(method url-fetch)
(uri (hackage-uri "th-abstraction" version))
(sha256
(base32
"0r4ri85283i1jjhd94wa9nps6cd9a8mh6rr4ds1gb2hqnwxdqn42"))))))
(define ghc-filestore
(package
(name "ghc-filestore")
(version "0.6.5")
(source (origin
(method url-fetch)
(uri (hackage-uri "filestore" version))
(sha256
(base32
"0z29273vdqjsrj4vby0gp7d12wg9nkzq9zgqg18db0p5948jw1dh"))))
(build-system haskell-build-system)
(properties '((upstream-name . "filestore")))
(inputs (list ghc-utf8-string ghc-xml ghc-split ghc-diff ghc-old-locale git mercurial))
(native-inputs (list ghc-hunit))
(arguments
`(#:cabal-revision ("1"
"1v9xqm0112knv6za05qf310ldndrc0h3xhajgwjaycbzkrknz4n7")))
(home-page "http://hackage.haskell.org/package/filestore")
(synopsis "Interface for versioning file stores.")
(description
"The filestore library provides an abstract interface for a versioning file
store, and modules that instantiate this interface. Currently Git, Darcs, and
Mercurial modules are provided, and other VCSs or databases could be added.")
(license license:bsd-3)))
(define ghc-purebred-email
(package
(name "ghc-purebred-email")
(version "0.6.0.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "purebred-email" version))
(sha256
(base32
"0gdzdbxgsyps8hqd903bsyja0cr6kbklkicvma62q48wv0y7230j"))))
(build-system haskell-build-system)
(properties '((upstream-name . "purebred-email")))
(inputs (list ghc-attoparsec
ghc-case-insensitive
ghc-lens
ghc-base64-bytestring
ghc-concise
ghc-random
ghc-semigroupoids
ghc-stringsearch))
(native-inputs (list ghc-tasty
ghc-tasty-hedgehog
ghc-tasty-quickcheck
ghc-tasty-hunit
ghc-tasty-golden
ghc-hedgehog
ghc-quickcheck-instances))
(home-page "https://github.com/purebred-mua/purebred-email")
(synopsis "types and parser for email messages (including MIME)")
(description
"The purebred email library. RFC 5322, MIME, etc. See \"Data.MIME\" for usage,
examples and API documentation. . This is a general-purpose library for
processing and constructing email messages, originally written to meet the needs
of <https://github.com/purebred-mua/purebred purebred MUA>. Transmission and
delivery of mail are not part of this library, but /purebred-email/ could be a
useful building block for such systems. . Features and implemented
specifications include: . - <https://tools.ietf.org/html/rfc5322 RFC 5322>
message parsing and serialisation - MIME multipart messages
(<https://tools.ietf.org/html/rfc2046 RFC 2046>) - Convenient APIs for replying
and forward/bounce - Content transfer and charset decoding/encoding - MIME
message header extensions for non-ASCII text
(<https://tools.ietf.org/html/rfc2047 RFC 2047>) - MIME parameter value and
encoded word extensions (<https://tools.ietf.org/html/rfc2231 RFC 2231>) -
@@Content-Disposition@@ header field (<https://tools.ietf.org/html/rfc2183 RFC 2183>) - Address syntax in @@From@@ and @@Sender@@ fields
(<https://tools.ietf.org/html/rfc6854 RFC 6854>)")
(license license:agpl3+)))
(define ghc-concise
(package
(name "ghc-concise")
(version "0.1.0.1")
(source (origin
(method url-fetch)
(uri (hackage-uri "concise" version))
(sha256
(base32
"09crgc6gjfidlad6263253xx1di6wfhc9awhira21s0z7rddy9sw"))))
(build-system haskell-build-system)
(properties '((upstream-name . "concise")))
(inputs (list ghc-lens))
(native-inputs (list ghc-tasty ghc-tasty-quickcheck ghc-quickcheck
ghc-quickcheck-instances))
(home-page "https://github.com/frasertweedale/hs-concise")
(synopsis "Utilities for Control.Lens.Cons")
(description
"concise provides a handful of functions to extend what you can do with
Control.Lens.Cons.")
(license license:bsd-3)))
(define ghc-exit-codes
(package
(name "ghc-exit-codes")
(version "1.0.0")
(source (origin
(method url-fetch)
(uri (hackage-uri "exit-codes" version))
(sha256
(base32
"00cyli96zkyqhjr3lqzrislqyk72xwm2dcqvjagklidh32d4k8ja"))))
(build-system haskell-build-system)
(properties '((upstream-name . "exit-codes")))
(home-page "http://github.com/JustusAdam/exit-codes")
(synopsis "Exit codes as defined by BSD")
(description
"Expose the exit codes defined by BSD in sysexits.h to the Haskell world.")
(license license:bsd-3)))
tiedote-md

660
COPYING.md
View File

@ -1,660 +0,0 @@
### 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/>.

73
README.md
View File

@ -1,73 +0,0 @@
# Tiedote.md
Tiedote.md on yksinkertainen massasähköpostijärjestelmä, joka perustuu Gittiin,
Pandocin markdowniin ja sähköpostiin.
## Kehittäminen
Kehitysympäristön saa luotua helposti komennolla `guix shell`. Muutoksia
koodiin hallitaan Git-versionhallintatyökalulla ja muutosehdotuksia voi
[lähettää `git send-email`:n avulla](https://git-send-email.io/) osoitteeseen
<admin@mail.olarinmaensamoojat.fi> tai Gitean avulla.
## Asentaminen
Helpoin tapa asentaa tiedote.md on lisätä alla oleva kanava [Guix:n
kanavalistaan](https://guix.gnu.org/manual/en/guix.html#Specifying-Additional-Channels).
```
(channel
(name 'tiedote.md)
(url "https://git.olarinmaensamoojat.fi/OMS/tiedote.md.git")
(branch "main")
(introduction
(make-channel-introduction
"d9157e9e8aa78363d14344293d6a0bc47a8d5a7b"
(openpgp-fingerprint
"A0C9 1947 734F 076F 5F08 E9FF 257D 284A 2A1D 3A32"))))
```
Tämän jälkeen ajetun `guix pull` -komennon jälkeen tiedote.md on saatavilla
tiedote-md nimisenä pakettina kaikkialla Guixissa.
Koodin voi myös kääntää käsin Haskellin `cabal`-infrastruktuurin avulla.
## Ajaminen
Tiedote.md koostuu kahdesta osasta: palvelimesta ja sähköpostin toimittajasta.
Sähköpostin toimittaja vastaanottaa sähköpostit ja toimittaa ne palvelimelle
käsiteltäväksi. Palvelin vastaa kaikesta kirjanpidosta, sähköpostien
lähettämisestä ja Git-tietovaraston päivittämisestä, kun se saa muutoksista
ilmoituksen HTTP POST -pyyntönä (esim. Git-palvelun webhookista).
Palvelimen voi käynnistää komennolla `tiedote.md server`. Mahdolliset asetukset
saa listattua lisäämällä komentoon `--help` valitsimen. `--address`
valitsimesta tulee huomata, että osoitteessa voi käyttää vain ASCII-merkkejä
(ks. [#15](https://git.olarinmaensamoojat.fi/OMS/tiedote.md/issues/15)).
Sähköpostin lähettämiseen tarvitaan `sendmail`-yhteensopiva MTA (mail transfer
agent, sähköpostin välitysohjelma), jollaisen useimmat sähköpostipalvelimet
tarjoavat. Jos tiedote.md:n palvelimella ei ole omaa sähköpostipalvelinta, voi
tähän käyttää [`msmtp`:tä](https://marlam.de/msmtp/).
Sähköposti saapuu tiedote.md:n tietoon niin, että se annetaan komennon
`tiedote.md receive` syötteeksi (tarkista, että asetusvalitsimet vastaavat
palvelimen asetuksia). Tämä on yleensä helppo automatisoida
`.forward`-tiedostolla seuraavankaltaisella rivillä, jos tiedote.md on
palvelimella, jolle toimitetaan tiedote.md:lle tulevat sähköpostit.
```
|/path/to/tiedote.md receive
```
Muissa tapauksissa joutuu todennekäisesti kirjoittamaan skriptin, joka hakee
sähköpostit jostain muualta tai toimittaa ne esim. `ssh`:n yli
`tiedote.md receive`:lle.
## Kopiominen
Tiedote.md on [GNU AGPL -lisenssin version 3](COPYING.md), tai valintasi mukaan
minkä tahansa myöhemmän Free Software Foundationin julkaiseman version, alainen
vapaa ohjelma. Se siis kunnioittaa vapauttasi käyttää sitä mihin haluat,
muokata sitä vastaamaan paremmin tarpeitasi ja jakaa muutettuja tai
muuttamattomia versioita auttaaksesi muita.

4
Setup.hs
View File

@ -1,4 +0,0 @@
import Distribution.Simple
main :: IO ()
main = defaultMain

11
channels.scm
View File

@ -1,11 +0,0 @@
(list (channel
(name 'guix)
(url "https://git.savannah.gnu.org/git/guix.git")
(branch "master")
(commit
"a6fc564bcc32ba599fc701f340c2d59c47bb225b")
(introduction
(make-channel-introduction
"9edb3f66fd807b096b48283debdcddccfea34bad"
(openpgp-fingerprint
"BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA")))))

1
guix.scm
View File

@ -1 +0,0 @@
.guix/modules/tiedote-md-package.scm

52
saku-laesvuori.key Normal file
View File

@ -0,0 +1,52 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBGCJJvcBEADEsx42OdBcdslRop/VYmEe/KMAEo5zN7mKapZeS8ZeR3dvgxUh
3c4uIv8LoWHPbBdnslL8FhSzjxn7L11QOfLwzgdzoMqjVUJJaggvukhkjJXl5mja
Yzta5/zmUGVgruHlsqFcJcnICnOgCCZDAVjSw/rTbkd2RN1oVte0b3MCZUv7A3Xi
Z6yCrWL0yQikGIQi1CBvdTbca1aUMuhgpyaq1SCUfbe+oq4jc2mvnVsIZucDs48U
ofayLDye0GsjOo2vyPRalBq1XhA1hoQYtfdqcENyiMAumfnzJ24ou+YRd2RXPKcc
dy9FQrhL7hLwp+bewPXbrObgCiV2NyussShFe/m6C0A6RFBLSfG+dTFt4F/joWei
yJmjt6FIRpHvTEjluvpn3ApO4JmlxBlTIUBcgJJp/UQ+IUSYEOAdoOw9RGn1sNG8
uN++AvQXZZyFCMFrd1amJd6rjqVvIyc7DGyilmBF7os2p/iss+sQWdlAKuZQU6Zv
xFR3Ltl+qhYNATSuKh9z7VdSiBLCJEHam4htdduwRroh5gXjQjAaLNPDihBLV46Q
Oz3iI6gZbF3+QQy03hqXXc9W98tfd/nXgepD2S8SZPCmY3SY7JI9E98HGH7JiHeg
cpOfK9Knn5NGfH92PyOjRnowvsNHLsR1VsmlNovk5wkNfRRPg5TBRDXcMQARAQAB
tCJTYWt1IExhZXN2dW9yaSA8c2FrdUBsYWVzdnVvcmkuZmk+iQJXBBMBCgBBAhsD
BQsJCAcCBhUKCQgLAgQWAgMBAh4BAheAAhkBFiEEoMkZR3NPB29fCOn/JX0oSiod
OjIFAmJqq4oFCQUJZikACgkQJX0oSiodOjKG4hAAmhJK5M8BeSsV4lFWdps7xAwd
jKiTJ+cYSsxK830J6XRrZsVMQ7hy8fHZmQ53maF8ZJS2EnA88vL9K/PiynjKoFA6
1dRKBjFPP9/+zTUd5vAJ4bXN2YH666AXq+XKjHboS3gKbD4hT0RtlTe/kfXUP51g
6UQgvyqM6vDuJBKJWez0dF98iB2RmU90GVVfLebZaSc1WDbiMKShgggtorGzmpj9
GHuLyBYZX529vvG2K05bwJwtLajnD9oybOAhva/KSL0/Se6lCShlMekD4dvkBDrW
/pYSpRY2lDgFZC1D3StiLIA1lRFgGkNyAD7fg5Bvme18tI9ywBQuWuZYkELPt7ns
qgFw8GnKWo1SIPL1c6u/zTYCeyYtxdN0gLa4/dJOHeCwK4sA+FcJ1zd+WbWK1+LK
4Zvf8r2+eo8NJCy0lWh+0ZdOAxkgDpxCGBOKTivvBI3p9rIPQYovP/xYongtmTKH
vdwftOf3QIRbq2dD8EYCk06PCndUsVIqIUl9ilpfMxUVQoACLc8WxVm+bEStkWkK
roXmsXiIBHZ6hRaxwY/CmG2rKUaFi8/o8E46COJpTNwaAbjX9Qd9e8NTtr+qooBN
q08z0i0KHRbDdVmBIV8+VV++omB0RfFFCKXqKrA8jeXJVwzvWikcp6Im/rCD39JS
4FtzEuqmi6IoXBhs3+u5Ag0EYIkm9wEQAL3qGd774FTzLFqjJICQWYisCBst07Tf
4aVKRJEQZkKnWNOQzQltSa5nHRLVtdEvvbejK+Ci8/l2yI58PkqkbKlL9K/IRgHn
8xqxWVcirbDZq32g5SI0zSa1B296o12TJrKGBSGBcAI0NRUaSUJmGy4HvIGdf8oV
xqvNDKL4I2igf5Kj3mMOZzFjbOr17SUetF72W1w5BAqLWX32YVXnC/RHP7WRuFv7
LLpsAHOgnInQ44BF8WQdxnliJr18Pz/kyW/otMsVq4OxNMwYTiRDqBmDNPZmLHTd
thXvb41pI95Opk/th/8xc3+w1wAfcrx/vRccvfgr0nN4q4mqKAZSp4qJQocGF8xf
JGc0CurTdQwQT2yWEmoVIqoQLTJOhX8NuC9JI/U8b2riRMcAVU37pzHWxUepsbH/
rEVYbVSaSRLVKTNCOmDSvOtQ7LZBHvAoVGG7Zzoluqg0X2GqrdCyCaBdFBgWOlw8
/2q+dR6JxMXcmSDxAJuZgI2oR4bTSXPbQT5ezqSq/71g2+CKw5me4KEOoZiuAVOS
vMv05wU3/s3yJpCYK5OMsBgRaSWE7+QIQjr4+467/Bxo3mP5eIgKA6M67qT89TIK
VSALA14mCnc991fW67ib9Y4Sx9ZtHvaYL5i6tZ143ShTfsfifpyoZt0LhA8CL3Ac
W6wpqdgcIoWPABEBAAGJAjwEGAEKACYCGwwWIQSgyRlHc08Hb18I6f8lfShKKh06
MgUCYmrqzQUJBQlmLAAKCRAlfShKKh06MuTGD/4/eMW3lg87nN1lJoQQgJExpbrU
ulmyKpBhULh1cWVh1VmzLZVswZzh4qrNbd5rCNimKwL402ovvUEYGfup+YVvwtWb
VmTvf4yc1R3LUP6pc0CofZGwkw/B4WOcQF/XkrNJELFmYkiYwAGvr25KDryv2MkS
Y2NzkGppcSSu0xBYsRMb1OQyb7kExp3sYdzCVBdDn+mz5haAdYGHTCjvED71dYx4
kMdy6bZwREctnjJ8JAW/WfySlmBysZ5ipcTjBF1MripGfbMOykNVm/c11gTD3ARd
B4uFColsM4f2cihJxjFiQG4DjepC1prsMA2v0tIQ6/K4DTd0GOj2GMtbfjZqKCxE
yhpXf7lSfi/YGxA9K2XscZZGJjrNA1Bm+JE4JxjGJb8tYarpOrRLLHByT0TmEjGa
QvHZ3dNs1yMouH0vkwuAyf2bMKwI/dPqv4QwO5ICVJaiwClTSND8c2y8o3yUA6yy
s6r7ku6/Yi185mmQqOjpNUJ/iJXPlGmh3VDxn54HNL7dbjjVhGQGbGDZfCy63VOH
oO5BBurTYOXjvW0zxVBfjNoySF1Sk3gXeOI2hls+19lVRQwgOo1BrKamkVQ5D6Lr
2qGpUBmeqo9xrONheCtJd+eZ4ml+2ILUjp8aD5NXI2Pb5nouU30NhsUmXDn7ehek
+pSGh/BzjJxtn1qefg==
=wMFC
-----END PGP PUBLIC KEY BLOCK-----

114
src/Main.hs
View File

@ -1,114 +0,0 @@
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
module Main where
import Control.Applicative (optional)
import Control.Concurrent (forkIO, threadDelay)
import Control.Exception (onException)
import Control.Exception (throwIO)
import Control.Monad (void, forever)
import Data.Acid (AcidState(..), openLocalState, createCheckpoint, createArchive)
import Data.Acid.Remote (skipAuthenticationCheck, acidServerSockAddr, openRemoteStateSockAddr, skipAuthenticationPerform)
import Data.IMF (Mailbox(..), parse, mailbox)
import Data.MIME.Charset (defaultCharsets)
import Data.Text.Encoding (encodeUtf8)
import Network.HostName (getHostName)
import Network.Socket (SockAddr(SockAddrUnix))
import Options.Applicative (Parser, ReadM, auto, eitherReader, execParser, strOption, option, hsubparser, command, info, progDesc, long, short, metavar, value, showDefault, help, header, fullDesc, helper, (<**>))
import System.Directory (findExecutable)
import System.Exit (exitWith)
import System.Exit.Codes (codeTempFail)
import System.Posix.User (getRealUserID, userName, getUserEntryForID)
import Web.Scotty (scotty, post, liftAndCatchIO, defaultHandler)
import qualified Data.Text as T
import qualified Data.Text.Lazy.IO as LT
import TiedoteMD.Read (updateMessages)
import TiedoteMD.Review
import TiedoteMD.Send
import TiedoteMD.State
import TiedoteMD.Types
import TiedoteMD.Debug
serverMain :: SockAddr -> Mailbox -> FilePath -> FilePath -> Int -> Int -> IO ()
serverMain socket mail repoPath sendmailPath checkpointDelay port = do
acid <- openLocalState $ emptyState
_ <- forkIO $ acidServerSockAddr skipAuthenticationCheck socket acid
queueMessages acid
_ <- forkIO $ scotty port $ do
defaultHandler $ liftAndCatchIO . LT.putStrLn -- Don't return exceptions to clients
post "/" $ liftAndCatchIO $ void $ forkIO $ updateMessages acid repoPath
updateMessages acid repoPath
_ <- forkIO $ manageQueueingMessages acid
_ <- forkIO $ managePreviews acid mail sendmailPath
_ <- forkIO $ manageQueue acid mail sendmailPath
forever $ threadDelay (1000 * 1000 * 60 * checkpointDelay) >> createCheckpoint acid
clientMain :: SockAddr -> Mailbox -> FilePath -> IO ()
clientMain socket mail sendmailPath = do
acid <- openRemoteStateSockAddr skipAuthenticationPerform socket
`onException` exitWith codeTempFail
manageIncomingEmail acid mail sendmailPath
printStateMain :: SockAddr -> IO ()
printStateMain socket = do
acid <- openRemoteStateSockAddr skipAuthenticationPerform socket
`onException` openLocalState emptyState
`onException` exitWith codeTempFail
printState acid
archiveMain :: SockAddr -> IO ()
archiveMain socket = do
acid <- openRemoteStateSockAddr skipAuthenticationPerform socket
`onException` openLocalState emptyState
`onException` exitWith codeTempFail
createCheckpoint (acid :: AcidState State)
createArchive acid
data Config = Config { socketPath :: FilePath, mail :: Mailbox, sendmailCommand :: String, runMode :: RunMode } deriving Show
data RunMode = Server { repoPath :: FilePath, portNumber :: Int, checkpointDelay :: Int } | Receive | Print | Archive deriving Show
config :: Maybe Mailbox -> Parser Config
config mail = Config
<$> strOption (long "socket" <> short 's' <> metavar "FILE" <> value "/run/tiedote.md/acid.socket" <> showDefault <> help "Path for database socket")
<*> mailboxOption mail
<*> strOption (long "sendmail" <> short 'm' <> metavar "FILE" <> value "sendmail" <> help "Sendmail command")
<*> hsubparser (command "server" (info serverCommand (progDesc "Run the server"))
<> command "receive" (info (pure Receive) (progDesc "Receive an email"))
<> command "state" (info (pure Print) (progDesc "Print the server's current state"))
<> command "archive" (info (pure Archive) (progDesc "Archive old versions of the database")))
serverCommand :: Parser RunMode
serverCommand = Server
<$> strOption (long "repository" <> short 'r' <> metavar "DIRECTORY" <> value "/var/lib/tiedote.md/git-repo" <> showDefault <> help "Path to git repository")
<*> option auto (long "port" <> short 'p' <> metavar "PORT" <> value 3000 <> showDefault <> help "TCP port number to listen on for webhook notifications")
<*> option auto (long "checkpoint-delay" <> metavar "MINUTES" <> value (60 * 24 * 7) <> help "Number of minutes to wait between creating snapshots.")
mailboxOption :: Maybe Mailbox -> Parser Mailbox
mailboxOption mail = Mailbox
<$> optional (strOption (long "sender-name" <> metavar "NAME" <> help "Name to display as the mail's sender"))
-- XXX Data.IMF (as of purebred-email-0.6.0.2, 2023-10) doesn't expose the
-- addrSpec parser so we have to use this workaround
<*> ((\(Mailbox _ addrSpec) -> addrSpec) <$>
option readMailbox (long "address" <> short 'a' <> metavar "EMAIL" <> maybe mempty value mail <> help "Email address to send and receive mail"))
readMailbox :: ReadM Mailbox
readMailbox = eitherReader $ parse (mailbox defaultCharsets) . encodeUtf8 . T.pack
main :: IO ()
main = do
hostname <- getHostName
username <- getRealUserID >>= fmap userName . getUserEntryForID
let defaultMailbox = either (const Nothing) Just $ parse (mailbox defaultCharsets) $
encodeUtf8 $ T.pack $ username <> "@" <> hostname
args <- execParser $ info (config defaultMailbox <**> helper) (fullDesc <> header "TiedoteMD mass mailing system")
sendmailPath <- maybe (throwIO $ FileNotFoundError $ sendmailCommand args) pure =<<
findExecutable (sendmailCommand args)
case args of
Config {runMode = Receive, ..} -> clientMain (SockAddrUnix socketPath) mail sendmailPath
Config {runMode = Print, ..} -> printStateMain (SockAddrUnix socketPath)
Config {runMode = Archive, ..} -> archiveMain (SockAddrUnix socketPath)
Config {runMode = Server {..}, ..} -> serverMain (SockAddrUnix socketPath) mail repoPath sendmailPath checkpointDelay portNumber

8
src/TiedoteMD/Debug.hs
View File

@ -1,8 +0,0 @@
module TiedoteMD.Debug where
import Data.Acid (AcidState, query)
import TiedoteMD.State
printState :: AcidState State -> IO ()
printState acid = query acid GetState >>= print

57
src/TiedoteMD/Git.hs
View File

@ -1,57 +0,0 @@
{-# LANGUAGE ScopedTypeVariables #-}
module TiedoteMD.Git where
-- Most of this is stolen from filestore to implement gitPull, TODO: Upstream
import Codec.Binary.UTF8.String (encodeString)
import Control.Exception (throwIO)
import Control.Monad (liftM2, unless)
import Data.ByteString.Lazy.UTF8 (toString)
import Data.FileStore.Types (FileStoreError(..))
import System.Directory (getTemporaryDirectory, removeFile)
import System.Environment (getEnvironment)
import System.Exit (ExitCode(..))
import System.IO (openTempFile)
import System.Process (runProcess, waitForProcess)
import qualified Control.Exception as E
import qualified Data.ByteString as S
import qualified Data.ByteString.Lazy as B
gitPull :: FilePath -> IO ()
gitPull repo = do
(exit, err, _) <- runGitCommand repo "fetch" ["--force"]
unless (exit == ExitSuccess) $ throwIO $ UnknownError $ "git-fetch failed: " <> err
(exit', err', _) <- runGitCommand repo "reset" ["--hard","FETCH_HEAD"]
unless (exit' == ExitSuccess) $ throwIO $ UnknownError $ "git-reset failed: " <> err'
runGitCommand :: FilePath -> String -> [String] -> IO (ExitCode, String, B.ByteString)
runGitCommand = runGitCommandWithEnv []
runGitCommandWithEnv :: [(String, String)] -> FilePath -> String -> [String] -> IO (ExitCode, String, B.ByteString)
runGitCommandWithEnv givenEnv repo command args = do
let env = Just ([("GIT_DIFF_OPTS", "-u100000")] ++ givenEnv)
(status, err, out) <- runShellCommand repo env "git" (command : args)
return (status, toString err, out)
runShellCommand :: FilePath -- ^ Working directory
-> Maybe [(String, String)] -- ^ Environment
-> String -- ^ Command
-> [String] -- ^ Arguments
-> IO (ExitCode, B.ByteString, B.ByteString)
runShellCommand workingDir environment command optionList = do
tempPath <- E.catch getTemporaryDirectory (\(_ :: E.SomeException) -> return ".")
(outputPath, hOut) <- openTempFile tempPath "out"
(errorPath, hErr) <- openTempFile tempPath "err"
env <- liftM2 (++) environment . Just <$> getEnvironment
hProcess <- runProcess (encodeArg command) (map encodeArg optionList) (Just workingDir) env Nothing (Just hOut) (Just hErr)
status <- waitForProcess hProcess
errorOutput <- S.readFile errorPath
output <- S.readFile outputPath
removeFile errorPath
removeFile outputPath
return (status, B.fromChunks [errorOutput], B.fromChunks [output])
encodeArg :: String -> String
encodeArg = encodeString

228
src/TiedoteMD/Read.hs
View File

@ -1,228 +0,0 @@
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PackageImports #-}
{-# LANGUAGE RecordWildCards #-}
module TiedoteMD.Read where
import Control.Exception (throwIO, catch)
import Control.Monad ((>=>), join, unless)
import Control.Monad.IO.Class (liftIO, MonadIO)
import Control.Monad.Reader (ReaderT, MonadReader, runReaderT, asks)
import Control.Monad.Except (MonadError, throwError)
import Control.Monad.Trans (lift)
import Crypto.Hash (hashWith, SHA256(..))
import Data.Acid (AcidState, update)
import Data.Bifunctor (first, second)
import Data.ByteArray (convert)
import Data.ByteString (ByteString)
import "base64" Data.ByteString.Base64.URL
import Data.Default (def)
import Data.Either (rights, lefts, fromRight)
import Data.FileStore (FileStore(..), Revision(..), FileStoreError(..), gitFileStore)
import Data.List (singleton, isSuffixOf)
import Data.MIME (ContentID, makeContentID, renderContentID)
import Data.Maybe (fromMaybe)
import Data.Text.Encoding (decodeUtf8, encodeUtf8)
import Data.Time (UTCTime, zonedTimeToUTC)
import Data.Time (getCurrentTime)
import Data.Time.Format.ISO8601 (iso8601ParseM)
import System.Exit (ExitCode(..))
import System.FilePath ((</>), takeDirectory, normalise)
import System.FilePath.Glob (match, compile)
import System.IO (hClose)
import System.Process (createProcess, proc, waitForProcess, CreateProcess(..), StdStream(..))
import Text.Pandoc (Pandoc(..), PandocMonad, PandocIO, PandocError(..))
import Text.Pandoc.MediaBag (MediaItem(..), lookupMedia, mediaItems)
import Text.Pandoc.Readers (readMarkdown)
import Text.Pandoc.Walk (walkM)
import Text.Pandoc.Writers (writePlain, writeMarkdown, writeHtml5String)
import qualified Data.ByteString as BS
import qualified Data.ByteString.Lazy as LBS
import qualified Data.Map as Map
import qualified Data.Set as Set
import qualified Data.Text as T
import qualified Data.Text.IO as T
import qualified Text.Pandoc as Pandoc
import TiedoteMD.Git
import TiedoteMD.State
import TiedoteMD.Templates
import TiedoteMD.Types
updateMessages :: AcidState State -> FilePath -> IO ()
updateMessages acid repoPath =
gitPull repoPath >> readMessageFiles (gitFileStore repoPath) >>= update acid . UpdateState
readMessageFiles :: FileStore -> IO [Message]
readMessageFiles store = do
files <- index store
messages <- mapM (readMessageFile store) $ filter (".md" `isSuffixOf`) files
mapM_ (T.putStrLn . renderError) $ lefts messages
currentTime <- getCurrentTime
print currentTime
pure $ filter ((currentTime <) . sendTime) $ rights messages
-- TODO: files could be read in parallel instead of sequentially with mapM
newtype ReadM a = ReadM (ReaderT ReadMState PandocIO a)
deriving (Functor, Applicative, Monad, MonadIO, MonadReader ReadMState, MonadError PandocError)
data ReadMState = ReadMState
{ fileStoreHandle :: FileStore
, currentFile :: FilePath
}
liftPandoc :: PandocIO a -> ReadM a
liftPandoc = ReadM . lift
runReadM :: FileStore -> FilePath -> ReadM a -> IO (Either PandocError a)
runReadM store file (ReadM m) = Pandoc.runIO $ runReaderT m $ ReadMState store file
readStoreFile :: FilePath -> ReadM LBS.ByteString
readStoreFile file = do
store <- asks fileStoreHandle
errorOrFile <- liftIO $ (Right <$> retrieve store file Nothing)
`catch` \NotFound -> pure $ Left $ PandocResourceNotFound $ T.pack file
either throwError pure errorOrFile
getCurrentDirectory :: ReadM FilePath
getCurrentDirectory = takeDirectory <$> asks currentFile
getRealPath :: FilePath -> ReadM FilePath
getRealPath file = normalise . (</> file) <$> getCurrentDirectory
instance PandocMonad ReadM where
readFileLazy = getRealPath >=> readStoreFile
readFileStrict = getRealPath >=> fmap LBS.toStrict . readStoreFile
getDataFileName = pure
getModificationTime file = do
store <- asks fileStoreHandle
file' <- getRealPath file
liftIO $ fmap revDateTime . revision store =<< latest store file'
fileExists file = do
store <- asks fileStoreHandle
file' <- getRealPath file
liftIO $ (const True <$> latest store file') `catch` \NotFound -> pure False
glob pattern = do
store <- asks fileStoreHandle
directory <- getCurrentDirectory
filter (match $ compile $ directory </> pattern) <$> liftIO (index store)
lookupEnv = liftPandoc . Pandoc.lookupEnv
getCurrentTime = liftPandoc Pandoc.getCurrentTime
getCurrentTimeZone = liftPandoc Pandoc.getCurrentTimeZone
newStdGen = liftPandoc Pandoc.newStdGen
newUniqueHash = liftPandoc Pandoc.newUniqueHash
openURL = liftPandoc . Pandoc.openURL
readStdinStrict = pure mempty
getCommonState = liftPandoc Pandoc.getCommonState
putCommonState = liftPandoc . Pandoc.putCommonState
logOutput = liftPandoc . Pandoc.logOutput
readMessageFile :: FileStore -> FilePath -> IO (Either Error Message)
readMessageFile store file = retrieve store file Nothing >>=
uncurry (parseMessageFile store file) . addHash . T.filter (/= '\r') . decodeUtf8 . BS.toStrict
where addHash text = (convert $ hashWith SHA256 $ encodeUtf8 text, text)
cidOf :: MediaItem -> ContentID
cidOf MediaItem {mediaContents, mediaMimeType} =
fromRight (error "makeContentID failed with valid input!") $
makeContentID $ "<" <> encodedHash <> "@tiedote.md.sha256>"
where encodedHash = encodeBase64' $ convert $ hashWith SHA256 $
LBS.toStrict mediaContents <> encodeUtf8 mediaMimeType
cidUrl :: ContentID -> T.Text
cidUrl = mappend "cid:" . stripAngleBrackets . decodeUtf8 . renderContentID
where stripAngleBrackets = T.init . T.tail
-- The string is always surrounded by < > so this is safe
makeMediaPart :: MediaItem -> MediaPart
makeMediaPart mediaItem@MediaItem {..} = MediaPart
{ mediaPartMimeType = encodeUtf8 mediaMimeType
, mediaPartContentID = renderContentID $ cidOf mediaItem
, mediaPartContents = LBS.toStrict mediaContents
}
reconstructMediaItem :: (FilePath, T.Text, LBS.ByteString) -> MediaItem
reconstructMediaItem (mediaPath, mediaMimeType, mediaContents) = MediaItem {..}
replaceImagesWithCid :: PandocMonad m => Pandoc -> m Pandoc
replaceImagesWithCid = Pandoc.fillMediaBag >=> walkM handleImage
where handleImage (Pandoc.Image attr lab (src, title)) = do
mediaItem <- (\media -> fromMaybe (error $ "fillMediaBag left an image uncollected! impossible!")
$ lookupMedia (T.unpack src) media) <$> Pandoc.getMediaBag
pure $ Pandoc.Image attr lab (cidUrl $ cidOf mediaItem, title)
handleImage x = pure x
parseMessageFile :: FileStore -> FilePath -> ByteString -> T.Text -> IO (Either Error Message)
parseMessageFile store file hash text = fmap (join . first PandocError) . runReadM store file $ do
pandoc@(Pandoc meta _) <- flip readMarkdown text
def {Pandoc.readerStandalone = True, Pandoc.readerExtensions = Pandoc.pandocExtensions} >>= replaceImagesWithCid
let tiedoteMeta = do
previewTo <- lookupMeta' "tarkistaja" meta >>= metaToEmails
previewTime <- lookupMeta' "deadline" meta >>= metaToTime
sendTime <- lookupMeta' "lähetysaika" meta >>= metaToTime
subject <- lookupMeta' "otsikko" meta >>= metaToText
pure (previewTo, previewTime, sendTime, subject)
case tiedoteMeta of
(Left err) -> pure $ Left err
Right (previewTo, previewTime, sendTime, subject) -> do
plainTextMessage <- renderHelper writePlain plainTemplate pandoc
markdownMessage <- renderHelper writeMarkdown markdownTemplate pandoc
let htmlPandoc = let Pandoc meta' blocks' = pandoc in Pandoc
(Pandoc.Meta $ Map.insertWith (flip const) "pagetitle" (Pandoc.MetaString subject) $ Pandoc.unMeta meta')
blocks'
htmlMessage <- liftIO . inlineCSS =<< renderHelper writeHtml5String htmlTemplate htmlPandoc
mediaParts <- Set.fromList . map (makeMediaPart . reconstructMediaItem) . mediaItems <$> Pandoc.getMediaBag
pure $ pure $ Message
{ recipients = []
, messageHash = hash
, messageContent = MessageContent {..}
, previewMailID = Nothing
, ..
}
where renderHelper writer template = writer (writerOpts {Pandoc.writerTemplate = Just template})
writerOpts = def
{ Pandoc.writerTOCDepth = 2
, Pandoc.writerTableOfContents = True
, Pandoc.writerSectionDivs = True
}
inlineCSS :: T.Text -> IO T.Text
inlineCSS html = do
(Just hIn, Just hOut, _, processHandle) <- createProcess $
(proc "douceur" ["inline", "/dev/stdin"]) {std_in = CreatePipe, std_out = CreatePipe}
T.hPutStrLn hIn html
hClose hIn
inlined <- T.hGetContents hOut
exitCode <- waitForProcess processHandle
unless (exitCode == ExitSuccess) $ throwIO $ ProcessError "douceur" exitCode
pure inlined
metaToTime :: Pandoc.MetaValue -> Either Error UTCTime
metaToTime meta = do
textMeta <- metaToTexts meta >>= headOrError
maybe (Left $ InvalidTime textMeta) pure $
fmap zonedTimeToUTC $ iso8601ParseM $ T.unpack $ T.strip textMeta
where headOrError (x:_) = pure x
headOrError _ = Left $ InvalidTime ""
metaToEmails :: Pandoc.MetaValue -> Either Error [Email]
metaToEmails meta = metaToTexts meta >>= mapM
(\text -> maybe (Left $ InvalidEmail text) pure $ email $ encodeUtf8 $ T.strip text)
metaToText :: Pandoc.MetaValue -> Either Error T.Text
metaToText = second T.unwords . metaToTexts
metaToTexts :: Pandoc.MetaValue -> Either Error [T.Text]
metaToTexts (Pandoc.MetaString text) = pure [text]
metaToTexts (Pandoc.MetaInlines inlines) = second singleton $ inlinesToText inlines
metaToTexts (Pandoc.MetaList metas) = second concat $ mapM metaToTexts metas
metaToTexts _ = Left InvalidData
inlinesToText :: [Pandoc.Inline] -> Either Error T.Text
inlinesToText = first PandocError . Pandoc.runPure . writeMarkdown def{Pandoc.writerExtensions = Pandoc.pandocExtensions} . Pandoc Pandoc.nullMeta . singleton . Pandoc.Plain
lookupMeta' :: T.Text -> Pandoc.Meta -> Either Error Pandoc.MetaValue
lookupMeta' key meta = maybe (Left $ NoMeta key) Right $ Pandoc.lookupMeta key meta

114
src/TiedoteMD/Review.hs
View File

@ -1,114 +0,0 @@
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
module TiedoteMD.Review where
import Control.Concurrent (threadDelay)
import Control.Exception (throwIO)
import Control.Lens.Combinators (view, filtered, toListOf, _Right, set, over)
import Control.Monad (forever, when)
import Data.Acid (AcidState, update, query)
import Data.Bifunctor (first)
import Data.Binary.Builder (toLazyByteString)
import Data.ByteString (ByteString)
import Data.IMF (body)
import Data.List (sortBy)
import Data.MIME (Address(..), MIMEMessage, MIME(..), Mailbox(..), ReplySettings, ReplyMode(..), mime, message, parse, matchContentType, contentType, entities, transferDecoded', headerInReplyTo, buildMessage, reply, defaultReplySettings, replyMode, headerCC, headerTo, headerBCC, headerReferences)
import Data.MIME.Charset (charsetText', defaultCharsets)
import Data.Maybe (catMaybes)
import Data.Maybe (listToMaybe, fromMaybe)
import Data.Ord (comparing)
import Data.Text.Encoding (encodeUtf8, decodeUtf8)
import Data.Time (getCurrentTime, diffUTCTime, nominalDay, secondsToNominalDiffTime)
import Data.Time.Format (formatTime, defaultTimeLocale)
import System.Random (getStdRandom, uniform)
import qualified Data.ByteString as BS
import qualified Data.List.NonEmpty as NE
import qualified Data.Text as T
import TiedoteMD.Send (renderMessage', sendmail)
import TiedoteMD.State
import TiedoteMD.Types
manageIncomingEmail :: AcidState State -> Mailbox -> FilePath -> IO ()
manageIncomingEmail acid sender sendmailPath = do
mail <- BS.getContents >>= either throwIO pure . parseEmail
let inReplyTo = concat $ map (map messageIDToMailID) $
toListOf headerInReplyTo mail <> toListOf headerReferences mail
-- References should contain In-Reply-To, but I wouldn't trust every
-- mailer to include References
recipients = getEmailsFromMessage mail
updatedMessages <- update acid $ AddMessageRecipients inReplyTo recipients
mapM_ (sendRecipientVerifications mail sender sendmailPath) updatedMessages
when (null updatedMessages) $ sendmail sendmailPath $ toLazyByteString $ buildMessage $
set body (Part $ encodeUtf8 $ "Vastaavaa tiedote-esikatselua ei löytynyt. Tarkista, että vastasit tiedotteen uusimpaan esikatseluun ja ettei tiedotteen lähetysaika ole jo umpeutunut.\n\nMikäli tämä ei ratkaise ongelmaa, ole yhteydessä järjestelmän ylläpitäjään.") $
reply defaultCharsets (replySettings sender) mail
managePreviews :: AcidState State -> Mailbox -> FilePath -> IO ()
managePreviews acid sender sendmailPath = forever $ do
maybeMessage <- getCurrentTime >>= query acid . GetMessageToPreview
case maybeMessage of
Nothing -> pure ()
Just msg@(Message {..}) -> do
mailID <- uniqueMailID sender
boundary <- getStdRandom uniform
boundary' <- getStdRandom uniform
let mail = renderMessage' "Esikatselu: " (Just mailID) msg sender boundary boundary'
sendmail sendmailPath $ toLazyByteString $ buildMessage $
set (headerTo defaultCharsets) (map (Single . emailToMailbox) previewTo) mail
update acid $ SetPreviewID messageHash mailID
threadDelay $ 1000 * 1000
sendRecipientVerifications :: MIMEMessage -> Mailbox -> FilePath -> Message -> IO ()
sendRecipientVerifications mail sender sendmailPath Message {..} = do
currentTime <- getCurrentTime
let recipientCount = T.pack $ show $ length recipients
formattedSendTime = T.pack $ formatTime defaultTimeLocale "%d.%m.%Y klo %H.%M (UTC%Ez)" sendTime
formatTimeDiff timediff
| timediff > nominalDay = formatTime defaultTimeLocale
"%d päivän, %H tunnin ja %M minuutin päästä" timediff
| timediff > secondsToNominalDiffTime 3600 = formatTime defaultTimeLocale
"%h tunnin ja %M minuutin päästä" timediff
| timediff > secondsToNominalDiffTime (10 * 60) = formatTime defaultTimeLocale
"%m minuutin päästä" timediff
| timediff > secondsToNominalDiffTime 60 = formatTime defaultTimeLocale
"%m minuutin ja %S sekunnin päästä" timediff
| otherwise = formatTime defaultTimeLocale "%s sekunnin päästä" timediff
sendingAfter = T.pack $ formatTimeDiff $ diffUTCTime sendTime currentTime
sendmail sendmailPath $
toLazyByteString $ buildMessage $
setHeaderCC previewTo $
set body (Part $ encodeUtf8 $
(("Viesti lähetetään seuraaviin " <> recipientCount <> " osoitteiseen " <> formattedSendTime <>
", eli " <> sendingAfter <> ". Lähetä vastauksena uusi lista, mikäli tämä on" <>
" virheellinen.\n\n") <>) $
T.intercalate "\n" $ map (decodeUtf8 . emailToByteString) recipients) $
reply defaultCharsets (replySettings sender) mail
where addressToMailboxes (Single mb) = [mb]
addressToMailboxes (Group _ mbs) = mbs
sameRecipient (Mailbox _ addr1) (Mailbox _ addr2) = addr1 == addr2
setHeaderCC reviewers mail' =
let to = concatMap addressToMailboxes $ view (headerTo defaultCharsets) mail'
cc = concatMap addressToMailboxes $ view (headerCC defaultCharsets) mail'
bcc = concatMap addressToMailboxes $ view (headerBCC defaultCharsets) mail'
-- XXX: bcc is only for completeness; there should never be any BCC recipients
ccsToAdd = filter (not . flip (elemBy sameRecipient) (to <> cc <> bcc)) $
map emailToMailbox reviewers
in over (headerCC defaultCharsets) (<> map Single ccsToAdd) mail'
parseEmail :: ByteString -> Either Error MIMEMessage
parseEmail = first (EmailParseError . T.pack) . parse (message mime)
getEmailsFromMessage :: MIMEMessage -> [Email]
getEmailsFromMessage = readEmails . toListOf
(entities . filtered isText . transferDecoded' . _Right . charsetText' defaultCharsets . _Right)
where isText = matchContentType "text" Nothing . view contentType
readEmails :: [T.Text] -> [Email]
readEmails = fromMaybe [] . listToMaybe . reverse . sortBy (comparing length) .
map (catMaybes . map (email . encodeUtf8) . T.lines)
replySettings :: Mailbox -> ReplySettings
replySettings sender = set replyMode ReplyToGroup $ defaultReplySettings $ NE.singleton sender

99
src/TiedoteMD/Send.hs
View File

@ -1,99 +0,0 @@
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
module TiedoteMD.Send where
import Control.Concurrent (threadDelay)
import Control.Exception (throwIO)
import Control.Lens (set, _Just)
import Control.Monad (forever, unless)
import Data.Acid (AcidState, query, update)
import Data.Attoparsec.ByteString (endOfInput, parseOnly)
import Data.Binary.Builder (toLazyByteString)
import Data.MIME (Address(..), Mailbox, Boundary, MIMEMessage, MIME(..), Headers(..), MultipartSubtype(..), ContentTypeWith(..), DispositionType(..), buildMessage, headerTo, headerSubject, headerFrom, headerMessageID, headerContentID, header, createTextPlainMessage, contentType, contentDisposition, dispositionType, createAttachment, parseContentType, makeContentID)
import Data.MIME.Charset (defaultCharsets)
import Data.Set (Set)
import Data.Time (getCurrentTime)
import System.Exit (ExitCode(..))
import System.Exit.Codes (codeTempFail)
import System.IO (hClose, stdout)
import System.Process (CreateProcess(..), StdStream(..), waitForProcess, createProcess, proc)
import System.Random (getStdRandom, uniform)
import qualified Data.ByteString.Lazy as LBS
import qualified Data.IMF as IMF
import qualified Data.List.NonEmpty as NE
import qualified Data.Set as Set
import qualified Data.Text as T
import TiedoteMD.State
import TiedoteMD.Types
sendmail :: FilePath -> LBS.ByteString -> IO ()
sendmail path bs = do
(Just stdin, _, _, processHandle) <- createProcess (proc path ["-t"]) {std_in = CreatePipe}
LBS.hPut stdin bs
hClose stdin
exitCode <- waitForProcess processHandle
unless (exitCode `elem` [ExitSuccess, codeTempFail]) $
throwIO $ ProcessError (T.pack path) exitCode
manageQueue :: AcidState State -> Mailbox -> FilePath -> IO ()
manageQueue acid sender sendmailPath = forever $ do
maybeNextJob <- query acid GetMessageFromQueue
case maybeNextJob of
Nothing -> pure ()
Just (address, message) -> do
boundary <- getStdRandom uniform
boundary' <- getStdRandom uniform
let mail = renderMessage message sender boundary boundary'
sendmail sendmailPath $ toLazyByteString $ buildMessage $
set (headerTo defaultCharsets) [Single $ emailToMailbox address] mail
update acid MarkMessageAsSent
-- Delay for 3s to reduce spamminess
threadDelay $ 3 * 1000 * 1000
manageQueueingMessages :: AcidState State -> IO ()
manageQueueingMessages acid = forever $ do
-- TODO: sleep until next move or updateMessages to save CPU and acid storage size
threadDelay $ 10 * 1000 * 1000
queueMessages acid
queueMessages :: AcidState State -> IO ()
queueMessages acid = getCurrentTime >>= update acid . MoveToSendQueue
renderMessage :: Message -> Mailbox -> Boundary -> Boundary -> MIMEMessage
renderMessage = renderMessage' "" Nothing
renderMessage' :: T.Text -> Maybe MailID -> Message -> Mailbox -> Boundary -> Boundary -> MIMEMessage
renderMessage' subjectPrefix maybeMailID (Message {messageContent = MessageContent {..},..}) sender boundary boundary' =
maybe id (set headerMessageID . Just . mailIDToMessageID) maybeMailID $
set (headerSubject defaultCharsets) (Just $ subjectPrefix <> subject) $
set (header "Precedence") "Bulk" $
-- Apparently some big mail providers want mass email to include "Precedence: Bulk"
set (headerFrom defaultCharsets) [Single sender] $
IMF.Message (Headers []) $ Multipart Alternative boundary $ NE.fromList
[ createTextPlainMessage plainTextMessage
, createTextMarkdownMessage markdownMessage
, createTextHtmlMessage boundary' mediaParts htmlMessage
]
createTextMarkdownMessage :: T.Text -> MIMEMessage
createTextMarkdownMessage = set contentType "text/markdown; charset=utf-8; variant=pandoc" . createTextPlainMessage
createTextHtmlMessage :: Boundary -> Set MediaPart -> T.Text -> MIMEMessage
createTextHtmlMessage boundary mediaParts html = IMF.Message (Headers []) $ multipartRelated $
(set contentType "text/html; charset=utf-8" $ createTextPlainMessage html) NE.:| mediaAttachments
where multipartRelated = Multipart
(Related (Just $ ContentType "text" "html" ()) Nothing Nothing) boundary
mediaAttachments = mediaPartToAttachment <$> Set.toList mediaParts
mediaPartToAttachment :: MediaPart -> MIMEMessage
mediaPartToAttachment MediaPart {..} =
set (contentDisposition . _Just . dispositionType) Inline $
set headerContentID (Just contentID) $
createAttachment mimeType Nothing mediaPartContents
where mimeType = either (error "purebred-email couldn't parse pandoc's mime type!") id $
parseOnly (parseContentType <* endOfInput) mediaPartMimeType
contentID = either (error "purebred-email couldn't parse it's own contentID!") id $
makeContentID mediaPartContentID

135
src/TiedoteMD/State.hs
View File

@ -1,135 +0,0 @@
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TypeFamilies #-}
module TiedoteMD.State where
import Control.Monad.Reader (ask)
import Control.Monad.State (get, put)
import Data.ByteString (ByteString)
import Data.Function (on)
import Data.List (intersectBy)
import Data.List (partition)
import Data.Maybe (listToMaybe, isNothing, catMaybes)
import Data.SafeCopy (base, deriveSafeCopy)
import Data.Time (UTCTime)
import Data.Typeable (Typeable)
import Data.Acid
import qualified Data.List.NonEmpty as NE
import TiedoteMD.Types
data State = State
{ stateMessages :: [Message]
, stateSendJobs :: [SendJob]
} deriving (Show, Typeable)
emptyState :: State
emptyState = State
{ stateMessages = []
, stateSendJobs = []
}
updateListBy :: (a -> a -> Bool) -> [a] -> [a] -> [a]
updateListBy f old new = olds <> news
where news = differenceBy f new old
olds = intersectBy f old new
elemBy :: (a -> b -> Bool) -> a -> [b] -> Bool
elemBy = (.) any
differenceBy :: (a -> b -> Bool) -> [a] -> [b] -> [a]
differenceBy f xs ys = filter (\x -> not $ elemBy f x ys) xs
updateState :: [Message] -> Update State ()
updateState new = do
state@(State {..}) <- get
let newstate = state { stateMessages = updateListBy ((==) `on` messageHash) stateMessages new }
put newstate
updateRecipients :: ByteString -> [Email] -> Update State ()
updateRecipients hash emails = do
state@(State {..}) <- get
let newstate = state { stateMessages = map updateIfSameHash stateMessages }
put newstate
where updateIfSameHash message@(Message {..})
| messageHash == hash = message { recipients = emails }
| otherwise = message
moveToSendQueue :: UTCTime -> Update State ()
moveToSendQueue currentTime = do
state@(State {..}) <- get
let (messagesToSend, remainingMessages) = partition ((<= currentTime) . sendTime) stateMessages
toSendJob sendJobMessage = (\mails -> SendJob {toSend = mails, ..}) <$>
NE.nonEmpty (recipients sendJobMessage)
newstate = state
{ stateMessages = remainingMessages
, stateSendJobs = stateSendJobs <> catMaybes (map toSendJob messagesToSend)
}
put newstate
getMessageFromQueue :: Query State (Maybe (Email, Message))
getMessageFromQueue = do
State {..} <- ask
pure $ do
SendJob {..} <- listToMaybe stateSendJobs
pure (NE.head toSend, sendJobMessage)
-- XXX: This function assumes that new SendJobs are always added to the tail and there is only one thread
markMessageAsSent :: Update State ()
markMessageAsSent = do
state@(State {..}) <- get
let newQueue = case stateSendJobs of
[] -> undefined
-- TODO: This should never happen, how should we deal with it?
-- Should we crash as the code is assuming a wrong state
-- or should we just keep the queue empty and go on
(sendJob@(SendJob {..}) : sendJobs) ->
maybe sendJobs (\remaining -> sendJob {toSend = remaining} : sendJobs) $
NE.nonEmpty $ NE.tail toSend
newstate = state { stateSendJobs = newQueue }
put newstate
addMessageRecipients :: [MailID] -> [Email] -> Update State [Message]
addMessageRecipients ids recipients = do
state@(State {..}) <- get
let newMessages = map addRecipients stateMessages
newstate = state {stateMessages = newMessages}
put newstate
pure $ filter isTarget $ newMessages
where isTarget = maybe False (`elem` ids) . previewMailID
addRecipients message
| isTarget message = message {recipients = recipients}
| otherwise = message
getMessageToPreview :: UTCTime -> Query State (Maybe Message)
getMessageToPreview currentTime = listToMaybe . filter needsPreview . stateMessages <$> ask
where needsPreview Message{..} = currentTime >= previewTime && isNothing previewMailID
setPreviewID :: ByteString -> MailID -> Update State ()
setPreviewID hash mailID = do
state@(State {..}) <- get
let newstate = state {stateMessages = map setMessagePreviewID stateMessages}
put newstate
where setMessagePreviewID msg@(Message {..})
| messageHash == hash = msg {previewMailID = Just mailID}
| otherwise = msg
getState :: Query State State
getState = ask
deriveSafeCopy 0 'base ''State
makeAcidic ''State
[ 'updateState
, 'updateRecipients
, 'moveToSendQueue
, 'getMessageFromQueue
, 'markMessageAsSent
, 'addMessageRecipients
, 'getMessageToPreview
, 'setPreviewID
, 'getState
]

17
src/TiedoteMD/Templates.hs
View File

@ -1,17 +0,0 @@
{-# LANGUAGE TemplateHaskell #-}
module TiedoteMD.Templates where
import Data.Text (Text)
import Text.Pandoc.Templates (Template)
import TiedoteMD.Templates.TH (mkTemplate)
htmlTemplate :: Template Text
htmlTemplate = $(mkTemplate "templates/tiedote.html")
markdownTemplate :: Template Text
markdownTemplate = $(mkTemplate "templates/tiedote.md")
plainTemplate :: Template Text
plainTemplate = $(mkTemplate "templates/tiedote.txt")

34
src/TiedoteMD/Templates/TH.hs
View File

@ -1,34 +0,0 @@
{-# LANGUAGE DeriveLift #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE StandaloneDeriving #-}
{-# OPTIONS_GHC -Wno-orphans #-} -- TODO: is this actually a good idea
module TiedoteMD.Templates.TH where
import Control.Exception (throwIO)
import Data.FileEmbed
import Language.Haskell.TH.Syntax (Q, Exp, Lift, runIO, lift, Quasi(qAddDependentFile))
import Text.DocLayout (Doc(..))
import Text.DocTemplates.Internal (Variable(..), Pipe(..), Alignment(..), Border(..), Template(..))
import Text.Pandoc (compileTemplate)
import qualified Data.Text as T
import qualified Data.Text.IO as T
import TiedoteMD.Types
deriving instance Lift (Doc T.Text)
deriving instance Lift (Template T.Text)
deriving instance Lift Alignment
deriving instance Lift Border
deriving instance Lift Pipe
deriving instance Lift Variable
mkTemplate :: FilePath -> Q Exp
mkTemplate relativeFile = do
file <- makeRelativeToProject relativeFile
qAddDependentFile file
template <- runIO $ do
templateOrError <- T.readFile file >>= compileTemplate file
either (throwIO . TemplateError . T.pack) pure templateOrError :: IO (Template T.Text)
lift template

182
src/TiedoteMD/Types.hs
View File

@ -1,182 +0,0 @@
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE TypeFamilies #-}
module TiedoteMD.Types
( Email(..)
, Error(..)
, MailID
, MediaPart(..)
, Message(..)
, MessageContent(..)
, SendJob(..)
, TiedoteM(..)
, email
, emailToByteString
, emailToMailbox
, mailIDToMessageID
, messageIDToMailID
, renderError
, renderMailID
, uniqueMailID
) where
import Control.Exception (Exception, displayException)
import Control.Monad.Reader (ReaderT)
import Data.Acid (AcidState)
import Data.ByteString (ByteString)
import Data.CaseInsensitive (original, mk)
import Data.IMF (MessageID, Mailbox(..), AddrSpec(..), Domain(..), mailbox, parseMessageID, parse, renderMessageID, renderMailbox)
import Data.List.NonEmpty (NonEmpty)
import Data.MIME.Charset (defaultCharsets)
import Data.SafeCopy (Migrate(..), base, deriveSafeCopy, extension)
import Data.Semigroup (sconcat)
import Data.Set (Set)
import Data.Text (Text)
import Data.Text.Encoding (encodeUtf8, decodeUtf8)
import Data.Time (UTCTime, getCurrentTime, defaultTimeLocale, formatTime)
import Data.Typeable (Typeable)
import System.Exit (ExitCode)
import System.Process (getCurrentPid)
import Text.Pandoc (PandocError)
import qualified Data.List.NonEmpty as NE
import qualified Data.Text as T
import qualified Text.Pandoc as P
-- Unfortunately we have to define our own types for Email and MessageContent
-- instead of using Mailbox and Pandoc, because they do not implement SafeCopy
newtype TiedoteM s a = TiedoteM (ReaderT (AcidState s) IO a)
data Email = Email
{ emailName :: Maybe Text
, emailLocalPart :: ByteString
, emailDomainPart :: Domain'
} deriving (Show, Eq, Typeable)
data Domain' = DomainDotAtom' (NonEmpty ByteString)
| DomainLiteral' ByteString
deriving (Show, Eq, Typeable)
email :: ByteString -> Maybe Email
email = fmap mailboxToEmail . either (const Nothing) Just . parse (mailbox defaultCharsets)
emailToByteString :: Email -> ByteString
emailToByteString = renderMailbox . emailToMailbox
mailboxToEmail :: Mailbox -> Email
mailboxToEmail (Mailbox name (AddrSpec local domain)) = Email
{ emailName = name
, emailLocalPart = local
, emailDomainPart = fromDomain domain
} where fromDomain (DomainDotAtom dotAtoms) = DomainDotAtom' $ fmap original dotAtoms
fromDomain (DomainLiteral bs) = DomainLiteral' bs
emailToMailbox :: Email -> Mailbox
emailToMailbox Email {..} = Mailbox emailName (AddrSpec emailLocalPart (toDomain emailDomainPart))
where toDomain (DomainDotAtom' dotAtoms) = DomainDotAtom $ fmap mk dotAtoms
toDomain (DomainLiteral' bs) = DomainLiteral bs
data Message = Message
{ messageHash :: ByteString
, previewTo :: [Email]
, previewTime :: UTCTime
, sendTime :: UTCTime
, messageContent :: MessageContent
, subject :: Text
, recipients :: [Email]
, previewMailID :: Maybe MailID
} deriving (Show, Eq, Typeable)
data MessageContent = MessageContent
{ plainTextMessage :: Text
, markdownMessage :: Text
, htmlMessage :: Text
, mediaParts :: Set MediaPart
} deriving (Show, Eq, Typeable)
data MediaPart = MediaPart
-- XXX Ideally purebred-email would implement safecopy and we could use proper types
{ mediaPartMimeType :: ByteString -- ContentTypeWith Parameters
, mediaPartContentID :: ByteString -- ContentID
, mediaPartContents :: ByteString
} deriving (Show, Typeable, Ord)
instance Eq MediaPart where
MediaPart {mediaPartContentID = a} == MediaPart {mediaPartContentID = b} = a == b
data MessageContent_v0 = MessageContent_v0
{ plainTextMessage :: Text
, markdownMessage :: Text
, htmlMessage :: Text
} deriving (Show, Eq, Typeable)
data SendJob = SendJob
{ sendJobMessage :: Message
, toSend :: NonEmpty Email
} deriving (Show, Eq, Typeable)
newtype MailID = MailID ByteString deriving (Show, Eq, Typeable)
uniqueMailID :: Mailbox -> IO MailID
uniqueMailID (Mailbox _ (AddrSpec _ domain)) = do
time <- formatTime defaultTimeLocale "%s%q" <$> getCurrentTime
pid <- (show :: Integer -> String) . fromIntegral <$> getCurrentPid
pure . MailID . encodeUtf8 $
"<" <> T.intercalate "." (map T.pack [time, pid]) <> "@" <> mailDomain <> ">"
where mailDomain = case domain of
(DomainLiteral bs) -> decodeUtf8 bs
(DomainDotAtom atoms) -> sconcat $ NE.intersperse "." $
NE.map (decodeUtf8 . original) atoms
mailIDToMessageID :: MailID -> MessageID
mailIDToMessageID (MailID bs) = either error id $ parse parseMessageID bs
messageIDToMailID :: MessageID -> MailID
messageIDToMailID = MailID . renderMessageID
renderMailID :: MailID -> ByteString
renderMailID = renderMessageID . mailIDToMessageID
data Error = PandocError PandocError
| NoMeta Text
| InvalidTime Text
| InvalidData
| InvalidEmail Text
| TemplateError Text
| EmailParseError Text
| ProcessError Text ExitCode
| FileNotFoundError FilePath
deriving (Show, Typeable)
instance Exception Error where
displayException = T.unpack . renderError
renderError :: Error -> Text
renderError (PandocError err) = "Pandoc error: " <> P.renderError err
renderError (NoMeta missingKey) = "Metadata field '" <> missingKey <> "' missing"
renderError (InvalidTime text) = "Failed to read '" <> text <> "' as a time"
renderError InvalidData = "Wrong type of data"
renderError (InvalidEmail text) = "Failed to read '" <> text <> "' as an email address"
renderError (TemplateError err) = "Error compiling templates: " <> err
renderError (EmailParseError err) = "Error parsing incoming email: " <> err
renderError (ProcessError process code) = process <> " exited with error code " <> T.pack (show code)
renderError (FileNotFoundError path) = T.pack path <> " not found"
deriveSafeCopy 0 'base ''Domain'
deriveSafeCopy 0 'base ''Email
deriveSafeCopy 0 'base ''MessageContent_v0
deriveSafeCopy 0 'base ''MediaPart
instance Migrate MessageContent where
type MigrateFrom MessageContent = MessageContent_v0
migrate MessageContent_v0 {..} = MessageContent {mediaParts = mempty, ..}
deriveSafeCopy 1 'extension ''MessageContent
deriveSafeCopy 0 'base ''MailID
deriveSafeCopy 0 'base ''Message
deriveSafeCopy 0 'base ''SendJob

288
templates/tiedote.html
View File

@ -1,288 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="$lang$" xml:lang="$lang$"$if(dir)$ dir="$dir$"$endif$>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
$for(author-meta)$
<meta name="author" content="$author-meta$" />
$endfor$
$if(date-meta)$
<meta name="dcterms.date" content="$date-meta$" />
$endif$
$if(keywords)$
<meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" />
$endif$
<title>$otsikko$</title>
<style>
body { margin: 0px; }
html { background-color: #f8f8f8; }
#htmldiv {
line-height: 1.5;
font-family: Fira Sans,Georgia,sans-serif;
color: #1a1a1a;
background-color: #f8f8f8;
}
#bodydiv {
margin: 0 auto 5em auto;
max-width: 36em;
padding: 1em;
hyphens: auto;
word-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media screen and (max-width: 50em) {
#bodydiv {
font-size: 0.9em;
}
}
@media print {
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #33652e;
}
a:visited {
color: #1b4318;
}
img {
max-width: 100%;
}
h3 {
font-weight: 500;
font-size: 1.25em;
}
blockquote {
margin: 1em 1.7em 1em 1.7em;
color: #808080;
}
#bodydiv > section {
border-left: 0.4em solid #33652e;
padding: 0.5em 1em 0.5em 1em;
background-color: #fdfdfd;
margin: 1.5em 0;
border-radius: 0.25em;
}
code {
font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
background-color: #222234;
padding: .2em .4em;
font-size: 85%;
margin: 0;
}
pre {
margin: 1em 0;
background-color: #222234;
padding: 1em;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
}
hr {
background-color: #1a1a1a;
border: none;
height: 0.1em;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 3em;
text-align: center;
}
h1 {
margin-bottom: 0;
}
#date {
margin-top: 0;
font-size: 1.3em;
margin-bottom: 1em;
}
#luemyös {
font-size: 1.1em;
font-style: italic;
max-width: 20em;
margin: auto;
margin-bottom: 0.5em;
}
#header-logo {
width: 70%;
height: auto;
margin: auto;
display: block;
}
#TOC {
text-align: center;
}
#toc-title {
font-weight: 500;
font-size: 1.4em;
margin-bottom: 0.5em;
color: #606060;
}
#TOC ul {
list-style: none;
padding: 0;
margin: 0;
}
#TOC ul a {
color: #606060;
}
#TOC a:not(:hover) {
text-decoration: none;
}
#social-links {
margin: 2.5em auto;
}
#social-links img {
height: 32px;
width: auto;
margin: none;
display: block;
}
#social-links a {
text-decoration: none;
background: white;
display: inline-block;
padding: 4px;
margin: 2px;
border-radius: 25%;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
$if(quotes)$
q { quotes: "“" "”" "‘" "’"; }
$endif$
footer {
text-align: center;
margin-top: 3em;
}
#footer-info {
margin-top: 2em;
font-weight: 200;
color: #606060;
}
figure img {
display: block;
margin: auto;
width: 100%;
}
figure figcaption {
display: none;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
</head>
<body>
<div id=htmldiv>
<div id=bodydiv>
$for(include-before)$
$include-before$
$endfor$
<header id="title-block-header">
<img id="header-logo" src="https://olarinmaensamoojat.fi/tiedotekuvat/logo.png"/>
<h1>$otsikko$</h1>
<p id="date">$date$</p>
$if(johtajatiedote)$
<p id="luemyös">Tämä tiedote täydentää OMS-tiedotetta, joten luethan myös sen.</p>
$endif$
$if(toc)$
<nav id="$idprefix$TOC" role="doc-toc">
<h2 id="$idprefix$toc-title">Tässä tiedotteessa</h2>
$table-of-contents$
</nav>
$endif$
</header>
$body$
<footer>
<p>
Partioterveisin viestintävastaavat, muu hallitus, ikäkausivastaavat ja jänötiimi.
</p>
<div id="social-links">
<a href="https://www.facebook.com/OlarinmaenSamoojat">
<img src="https://olarinmaensamoojat.fi/tiedotekuvat/facebook.png" alt="Olarinmäen samoojien Facebook-tili"/>
</a>
<a href="https://www.instagram.com/olarinmaensamoojat/">
<img src="https://olarinmaensamoojat.fi/tiedotekuvat/instagram.png" alt="Olarinmäen samoojien Instagram-tili"/>
</a>
<a href="https://kuvat.olarinmaensamoojat.fi">
<img src="https://olarinmaensamoojat.fi/tiedotekuvat/piwigo.png" alt="Olarinmäen samoojien kuvapankki"/>
</a>
<a href="https://olarinmaensamoojat.fi">
<img src="https://olarinmaensamoojat.fi/tiedotekuvat/nettisivut.png" alt="Olarinmäen samoojien nettisivut"/>
</a>
</div>
<div id="footer-info">
$if(johtajatiedote)$
<p>
Tämä sähköposti lähetetään Olarinmäen Samoojiin kuuluville johtajaikäisille
jäsenille. Osoitelähde on jäsenrekisteri Kuksa.
</p>
$else$
<p>
Tämä sähköposti lähetetään Olarinmäen Samoojiin kuuluville jäsenille
ja heidän vanhemmilleen. Osoitelähde on jäsenrekisteri Kuksa.
</p>
$endif$
<address>
Yhteystiedot:
<br>
Olarinmäen Samoojat
<br>
Kuunsäde 3 C
<br>
Espoo 02210
<br>
Finland
</address>
</div>
</footer>
</div>
</div>
</body>
</html>

30
templates/tiedote.md
View File

@ -1,30 +0,0 @@
% $otsikko$
$if(johtajatiedote)$
Tämä tiedote täydentää OMS-tiedotetta, joten luethan myös sen.
$endif$
$if(toc)$
$table-of-contents$
$endif$
$body$
---
Partioterveisin viestintävastaavat, muu hallitus, ikäkausivastaavat ja jänötiimi.
$if(johtajatiedote)$
Tämä sähköposti lähetetään Olarinmäen Samoojiin kuuluville johtajaikäisille
jäsenille. Osoitelähde on jäsenrekisteri Kuksa.
$else$
Tämä sähköposti lähetetään Olarinmäen Samoojiin kuuluville jäsenille
ja heidän vanhemmilleen. Osoitelähde on jäsenrekisteri Kuksa.
$endif$
| Yhteystiedot:
| Olarinmäen Samoojat
| Kuunsäde 3 C
| Espoo 02210
| Finland

29
templates/tiedote.txt
View File

@ -1,29 +0,0 @@
$otsikko$
$if(johtajatiedote)$
Tämä tiedote täydentää OMS-tiedotetta, joten luethan myös sen.
$endif$
$if(toc)$
$table-of-contents$
$endif$
$body$
--
Partioterveisin viestintävastaavat, muu hallitus, ikäkausivastaavat ja jänötiimi.
$if(johtajatiedote)$
Tämä sähköposti lähetetään Olarinmäen Samoojiin kuuluville johtajaikäisille
jäsenille. Osoitelähde on jäsenrekisteri Kuksa.
$else$
Tämä sähköposti lähetetään Olarinmäen Samoojiin kuuluville jäsenille
ja heidän vanhemmilleen. Osoitelähde on jäsenrekisteri Kuksa.
$endif$
Yhteystiedot:
Olarinmäen Samoojat
Kuunsäde 3 C
Espoo 02210
Finland

74
tiedote-md.cabal
View File

@ -1,74 +0,0 @@
cabal-version: 3.6
name: tiedote-md
version: 0.0.1
author: Saku Laesvuori
maintainer: saku@laesvuori.fi
bug-reports: https://git.olarinmaensamoojat.fi/OMS/tiedote.md/issues
synopsis: Git- ja markdown-pohjainen masssasähköpostijärjestelmä OMS:lle
description: Tiedote.md on massasähköpostijärjestelmä, joka käyttää
massasähköpostien hallintaan git-tietovarastossa olevia markdown-tiedostoja
ja sähköpostipohjaista käyttöliittymää. Toistaiseksi tiedote.md on
kovakoodattu käyttämään OMS:n tiedotepohjia.
extra-source-files: templates/*
license: AGPL-3.0-or-later
license-file: COPYING.md
copyright: (c) 2023 Saku Laesvuori <saku@laesvuori.fi>
build-type: Simple
stability: alpha
source-repository head
type: git
location: https://git.olarinmaensamoojat.fi/OMS/tiedote.md.git
executable tiedote.md
build-depends:
acid-state,
attoparsec,
base,
base64,
binary,
bytestring,
case-insensitive,
containers,
cryptonite,
data-default,
directory,
doclayout,
doctemplates,
exit-codes,
file-embed,
filepath,
filestore,
Glob,
hostname,
lens,
memory,
mtl,
network,
optparse-applicative,
pandoc,
pandoc-types,
process,
purebred-email,
random,
safecopy,
scotty,
template-haskell,
text,
time,
unix,
utf8-string
main-is: Main.hs
other-modules:
TiedoteMD.Debug
TiedoteMD.Git
TiedoteMD.Read
TiedoteMD.Review
TiedoteMD.Send
TiedoteMD.State
TiedoteMD.Templates
TiedoteMD.Templates
TiedoteMD.Templates.TH
TiedoteMD.Types
hs-source-dirs: src
default-language: Haskell2010