├── .hadolint.yaml ├── .github ├── renovate.json └── workflows │ ├── wait-for-status-checks.yaml │ └── image-build.yml ├── go.mod ├── docker-compose.yaml ├── imapmemserver.Dockerfile ├── examples ├── k8s │ └── deployment.yaml ├── docker-stack │ └── docker-compose.yaml └── imapfilter-config │ └── config.lua ├── Dockerfile ├── README.md ├── go.sum ├── entrypoint.sh └── LICENSE /.hadolint.yaml: -------------------------------------------------------------------------------- 1 | ignored: 2 | - DL3018 3 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "local>ntnn/renovate-config" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/ntnn/docker-imapfilter 2 | 3 | go 1.20 4 | 5 | require ( 6 | github.com/emersion/go-imap/v2 v2.0.0-beta.7 7 | github.com/stretchr/testify v1.11.1 8 | ) 9 | 10 | require ( 11 | github.com/davecgh/go-spew v1.1.1 // indirect 12 | github.com/emersion/go-message v0.18.1 // indirect 13 | github.com/emersion/go-sasl v0.0.0-20231106173351-e73c9f7bad43 // indirect 14 | github.com/pmezard/go-difflib v1.0.0 // indirect 15 | gopkg.in/yaml.v3 v3.0.1 // indirect 16 | ) 17 | -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | # This docker-compose is for development and testing. 2 | # For production use please check 3 | # ./examples/docker-stack/docker-compose.yaml 4 | 5 | networks: 6 | imapfilter: 7 | driver: bridge 8 | 9 | services: 10 | 11 | imapmemserver: 12 | build: 13 | context: . 14 | dockerfile: imapmemserver.Dockerfile 15 | command: -listen 0.0.0.0:143 -insecure-auth 16 | networks: 17 | - imapfilter 18 | 19 | imapfilter: 20 | depends_on: 21 | - imapmemserver 22 | build: 23 | context: . 24 | dockerfile: Dockerfile 25 | networks: 26 | - imapfilter 27 | volumes: 28 | - ./examples/imapfilter-config/config.lua:/config.lua 29 | environment: 30 | IMAPFILTER_CONFIG: /config.lua 31 | -------------------------------------------------------------------------------- /.github/workflows/wait-for-status-checks.yaml: -------------------------------------------------------------------------------- 1 | name: wait-for-status-checks 2 | 3 | on: 4 | pull_request: {} 5 | 6 | permissions: {} 7 | 8 | jobs: 9 | # Branch protection rules can enforce that status checks must pass 10 | # before merging - however it requires to name each check explicitly 11 | # in the configuration. It is no longer possible to require all 12 | # checks. 13 | # This job waits for all checks to complete, so it can be set as 14 | # _the_ required check in the branch protection rules. 15 | wait-for-status-checks: 16 | runs-on: ubuntu-latest 17 | permissions: 18 | checks: read 19 | steps: 20 | - uses: poseidon/wait-for-status-checks@899c768d191b56eef585c18f8558da19e1f3e707 # v0.6.0 21 | with: 22 | token: ${{ secrets.GITHUB_TOKEN }} 23 | -------------------------------------------------------------------------------- /imapmemserver.Dockerfile: -------------------------------------------------------------------------------- 1 | FROM --platform=$BUILDPLATFORM golang:1.25@sha256:36b4f45d2874905b9e8573b783292629bcb346d0a70d8d7150b6df545234818f AS builder 2 | 3 | WORKDIR /workspace 4 | 5 | COPY go.mod go.sum ./ 6 | RUN --mount=type=cache,target=/go/pkg/mod \ 7 | go mod download && go mod verify 8 | 9 | RUN --mount=type=cache,target=/go/pkg/mod/ \ 10 | --mount=type=cache,target=/root/.cache/go-build \ 11 | CGO_ENABLED=0 \ 12 | GOCACHE=/root/.cache/go-build \ 13 | GOOS=$TARGETOS \ 14 | GOARCH=$TARGETARCH \ 15 | go build -o imapmemserver github.com/emersion/go-imap/v2/cmd/imapmemserver 16 | 17 | FROM gcr.io/distroless/static:nonroot@sha256:2b7c93f6d6648c11f0e80a48558c8f77885eb0445213b8e69a6a0d7c89fc6ae4 18 | WORKDIR / 19 | COPY --from=builder /workspace/imapmemserver . 20 | USER 65532:65532 21 | 22 | ENTRYPOINT ["/imapmemserver"] 23 | -------------------------------------------------------------------------------- /examples/k8s/deployment.yaml: -------------------------------------------------------------------------------- 1 | # This is roughly equivalent to the imapfilter-git service in the 2 | # docker-stack example. 3 | kind: Deployment 4 | apiVersion: apps/v1 5 | metadata: 6 | name: imapfilter 7 | labels: 8 | app: imapfilter 9 | spec: 10 | replicas: 1 11 | selector: 12 | matchLabels: 13 | app: imapfilter 14 | template: 15 | metadata: 16 | labels: 17 | app: imapfilter 18 | spec: 19 | containers: 20 | - name: imapfilter-git 21 | image: ntnn/imapfilter:latest 22 | imagePullPolicy: Always 23 | env: 24 | - name: GIT_USER 25 | value: my_git_user 26 | - name: GIT_TARGET 27 | value: https://my.git.repo/imapfilter-configs.git 28 | - name: IMAPFILTER_CONFIG 29 | value: config.lua 30 | - name: IMAPFILTER_DAEMON 31 | value: yes 32 | envFrom: 33 | # This assumes a secret with one key GIT_TOKEN 34 | - secretRef: 35 | name: git-token 36 | # This assumes a secret with one key that is read by the config.lua 37 | - secretRef: 38 | name: email-password 39 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine@sha256:865b95f46d98cf867a156fe4a135ad3fe50d2056aa3f25ed31662dff6da4eb62 AS builder 2 | 3 | # imapfilter_spec can be a specific commit or a version tag 4 | ARG imapfilter_spec=master 5 | 6 | # Original from simbelmas: 7 | # https://github.com/simbelmas/dockerfiles/tree/master/imapfilter 8 | 9 | WORKDIR /imapfilter_build 10 | 11 | RUN apk --no-cache add lua openssl pcre git \ 12 | && apk --no-cache add -t dev_tools lua-dev openssl-dev make gcc libc-dev pcre-dev pcre2-dev \ 13 | && git clone https://github.com/lefcha/imapfilter.git . \ 14 | && git checkout "${imapfilter_spec}" \ 15 | && make && make install 16 | 17 | FROM alpine@sha256:865b95f46d98cf867a156fe4a135ad3fe50d2056aa3f25ed31662dff6da4eb62 18 | 19 | # create an empty config.lua to prevent an error when running imapfilter directly 20 | RUN adduser -D -u 1001 imapfilter \ 21 | && mkdir -p /home/imapfilter/.imapfilter && touch /home/imapfilter/.imapfilter/config.lua \ 22 | && mkdir -p /opt/imapfilter/config \ 23 | && chown imapfilter: /opt/imapfilter 24 | 25 | COPY --from=builder /usr/local/bin/imapfilter /usr/local/bin/imapfilter 26 | COPY --from=builder /usr/local/share/imapfilter /usr/local/share/imapfilter 27 | COPY --from=builder /usr/local/man /usr/local/man 28 | 29 | RUN apk --no-cache add lua lua-dev openssl pcre git 30 | 31 | COPY --chown=imapfilter: --chmod=a+x entrypoint.sh /entrypoint.sh 32 | 33 | USER imapfilter 34 | ENTRYPOINT ["/entrypoint.sh"] 35 | -------------------------------------------------------------------------------- /examples/docker-stack/docker-compose.yaml: -------------------------------------------------------------------------------- 1 | # For details on handling secrets in docker swam/compose please refer to 2 | # the official documentation: 3 | # Compose: https://docs.docker.com/compose/how-tos/use-secrets/ 4 | # Swarm: https://docs.docker.com/engine/swarm/secrets/ 5 | secrets: 6 | git-token: 7 | external: true 8 | # contains the password for the email 9 | email-password: 10 | external: true 11 | 12 | services: 13 | 14 | # This config pulls a git repository containing the imapfilter configs 15 | # and runs imapfilter in daemon mode. 16 | # Note that this depends highly on your environment, git server and 17 | # how you authenticate with your git server. YMMV. 18 | imapfilter-git: 19 | image: ntnn/imapfilter 20 | environment: 21 | GIT_TARGET: https://my.git.repo/imapfilter-configs.git 22 | # The name of your main imapfilter config file, relative to the 23 | # repository root. 24 | IMAPFILTER_CONFIG: config.lua 25 | IMAPFILTER_DAEMON: 'yes' 26 | GIT_USER: my_git_user 27 | GIT_TOKEN: /secrets/git-token 28 | secrets: 29 | - source: git-token 30 | target: /secrets/git-token 31 | # This assumes that your config.lua reads the email password from 32 | # /secrets/email-password 33 | - source: email-password 34 | target: /secrets/email-password 35 | deploy: 36 | mode: global 37 | 38 | # This config mounts a local directory containing the imapfilter 39 | # configs and runs imapfilter in daemon mode. 40 | imapfilter-mounted: 41 | image: ntnn/imapfilter 42 | environment: 43 | # Where the entrypoint should look for the configs. This is 44 | # important for relative imports in your imapfilter config files. 45 | IMAPFILTER_CONFIG_BASE: /configs 46 | # The name of your main imapfilter config file. 47 | IMAPFILTER_CONFIG: config.lua 48 | IMAPFILTER_DAEMON: 'yes' 49 | secrets: 50 | # This assumes that your config.lua reads the email password from 51 | # /secrets/email-password 52 | - source: email-password 53 | target: /secrets/email-password 54 | volumes: 55 | # Mount your local config directory here. The right side must be 56 | # what IMAPFILTER_CONFIG_BASE is set to. 57 | - /path/to/your/local/configs:/configs 58 | deploy: 59 | mode: global 60 | -------------------------------------------------------------------------------- /examples/imapfilter-config/config.lua: -------------------------------------------------------------------------------- 1 | -- Do not automatically create mailboxes - prevents typos from creating 2 | -- unwanted mailboxes. 3 | options.create = false 4 | 5 | -- Automatically subscribe to newly created mailboxes. 6 | options.subscribe = true 7 | 8 | -- This allows :enter_idle to wake up from any event, not just 9 | -- new mail, e.g. when setting a flag on a message. 10 | -- options.wakeonany = true 11 | 12 | -- A function to filter spam. 13 | function spam(account, mbox) 14 | -- Setting a default mailbox if none is provided. 15 | if mbox == nil then mbox = "INBOX" end 16 | 17 | -- Explicitly creating the Spam mailbox if it does not exist. 18 | account:create_mailbox('Spam') 19 | 20 | -- Gathering a number of messages, X-Spam_bar is usually set by 21 | -- spamassassin. 22 | result = account[mbox]:contain_field('X-Spam_bar', '++++') + 23 | account[mbox]:contain_field('X-Spam_bar', '+++') + 24 | account[mbox]:contain_field('X-Spam_bar', '++') + 25 | account[mbox]:contain_field('X-Spam_bar', '+') 26 | -- Moving the gathered messages to the Spam mailbox. 27 | result:move_messages(account['Spam']) 28 | end 29 | 30 | -- A function to archive old emails. 31 | function archive(account, mbox) 32 | if mbox == nil then mbox = "INBOX" end 33 | account:create_mailbox("Archive") 34 | -- Moving messages older than 365 days to the Archive mailbox. 35 | account[mbox]:is_older(365):move_messages(account["Archive"]) 36 | end 37 | 38 | -- The configuration for the email account. 39 | account = IMAP { 40 | -- The values here are for a test imap server running in docker, 41 | -- adjust according to your email provider. 42 | server = 'imapmemserver', 43 | port = 143, 44 | username = 'user', 45 | -- Instead of hardcoding the password should be provided in a secure way. 46 | -- e.g. setting it as an environment variable and reading it here: 47 | -- password = os.getenv('IMAPFILTER_PASS'), 48 | password= 'user', 49 | -- ssl should be set to 'auto' (or better 'tls1.3') to 50 | -- ensure a secure connection. The test setup however doesn't have 51 | -- TLS so it is disabled. 52 | } 53 | 54 | if os.getenv('IMAPFILTER_DAEMON') == 'yes' then 55 | -- docker-imapfilter supports daemon mode. If in daemon mode the 56 | -- imapfilter lua script is run once, expecting it to enter idle. 57 | -- The script then periodically checks for updates to the 58 | -- configuration and restarts the script if any changes are 59 | -- detected. 60 | -- 61 | -- Daemon mode is generally better as it keeps the imap connection 62 | -- alive and responds faster to new mail. 63 | while true do 64 | spam(account) 65 | archive(account) 66 | account["INBOX"]:enter_idle() 67 | end 68 | else 69 | -- The non-daemon mode simply runs the filtering once. In this case 70 | -- the docker-imapfilter script loops by itself, waiting 71 | -- IMAPFILTER_SLEEP seconds between runs. 72 | spam(account) 73 | archive(account) 74 | end 75 | -------------------------------------------------------------------------------- /.github/workflows/image-build.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: build 3 | 4 | on: 5 | push: 6 | branches: 7 | - main 8 | pull_request: 9 | branches: 10 | - main 11 | schedule: 12 | - cron: '0 3 * * *' 13 | workflow_dispatch: 14 | 15 | jobs: 16 | 17 | lint: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 21 | - uses: hadolint/hadolint-action@2332a7b74a6de0dda2e2221d575162eba76ba5e5 # v3.3.0 22 | with: 23 | dockerfile: Dockerfile 24 | 25 | grab-imapfilter-latest: 26 | needs: lint 27 | runs-on: ubuntu-latest 28 | steps: 29 | - id: imapfilter-latest-tag 30 | run: | 31 | # Can't find an endpoint that returns the latest tag - only 32 | # the latest release. And since lefcha doesn't use GitHub's 33 | # release feature the tags must be used. 34 | tag="$(curl --location --silent https://api.github.com/repos/lefcha/imapfilter/tags | jq -r '.[].name' | head -1)" 35 | echo "tag=$tag" >> "$GITHUB_OUTPUT" 36 | outputs: 37 | tag: ${{ steps.imapfilter-latest-tag.outputs.tag }} 38 | 39 | build: 40 | needs: grab-imapfilter-latest 41 | runs-on: ubuntu-latest 42 | 43 | strategy: 44 | matrix: 45 | include: 46 | - flavor: | 47 | latest=false 48 | suffix= 49 | args: 50 | imapfilter_spec=master 51 | - flavor: | 52 | latest=false 53 | suffix=-tag 54 | args: | 55 | imapfilter_spec=${{ needs.grab-imapfilter-latest.outputs.tag }} 56 | 57 | steps: 58 | - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 59 | - uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3 60 | with: 61 | # Spurious segfaults when compiling 62 | # https://github.com/docker/setup-qemu-action/issues/188 63 | image: tonistiigi/binfmt:qemu-v8.1.5 64 | - uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3 65 | 66 | - uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5 67 | id: meta 68 | with: 69 | flavor: ${{ matrix.flavor }} 70 | images: | 71 | name=ntnn/imapfilter,enable=${{ github.repository == 'ntnn/docker-imapfilter' && github.ref == 'refs/heads/main' }} 72 | name=ghcr.io/${{ github.repository }},enable=true 73 | tags: | 74 | type=raw,value=latest,enable=${{ github.ref == 'refs/heads/main' }} 75 | type=raw,value=main,enable=${{ github.ref == 'refs/heads/main' }} 76 | type=ref,event=branch 77 | type=ref,event=pr 78 | type=sha 79 | 80 | - name: Login to GitHub Container Registry 81 | uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3 82 | with: 83 | registry: ghcr.io 84 | username: ${{ github.actor }} 85 | password: ${{ secrets.GITHUB_TOKEN }} 86 | 87 | - name: Login to Docker Hub 88 | uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3 89 | if: ${{ github.repository == 'ntnn/docker-imapfilter' && github.ref == 'refs/heads/main' }} 90 | with: 91 | username: ${{ secrets.DOCKER_HUB_USERNAME }} 92 | password: ${{ secrets.DOCKER_HUB_TOKEN }} 93 | 94 | - uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6 95 | with: 96 | tags: ${{ steps.meta.outputs.tags }} 97 | push: true 98 | platforms: linux/amd64,linux/arm64,linux/arm/v7 99 | build-args: ${{ matrix.args }} 100 | 101 | - uses: peter-evans/dockerhub-description@1b9a80c056b620d92cedb9d9b5a223409c68ddfa # v5 102 | if: ${{ github.repository == 'ntnn/docker-imapfilter' && github.ref == 'refs/heads/main' }} 103 | with: 104 | repository: ntnn/imapfilter 105 | username: ${{ secrets.DOCKER_HUB_USERNAME }} 106 | password: ${{ secrets.DOCKER_HUB_TOKEN }} 107 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # imapfilter 2 | 3 | Docker image to run imapfilter as a daemon: [ntnn/imapfilter](https://hub.docker.com/r/ntnn/imapfilter) 4 | 5 | Can also be used to access an up-to-date imapfilter docker image: 6 | 7 | ```bash 8 | > docker run -it --rm --entrypoint imapfilter ntnn/imapfilter -V 9 | IMAPFilter 2.8.1 Copyright (c) 2001-2023 Eleftherios Chatzimparmpas 10 | ``` 11 | 12 | The intended way to use this image is to have your imapfilter 13 | configuration in a git repo, which will then be pulled in the 14 | entrypoint. 15 | 16 | ## Image tags 17 | 18 | The repository builds two versions of the image: 19 | 20 | 1. The `latest`/`main` tagged version, which is always build from the 21 | main branches of both [lefcha/imapfilter][imapfilter] and this 22 | repository. 23 | 24 | 2. The `latest-tag`/`vX.Y.Z` tagged version, which is always build from 25 | the main branch of this repository and the latest tag of the 26 | [lefcha/imapfilter][imapfilter] repository. 27 | 28 | ## Examples 29 | 30 | See the examples in the `examples` directory. 31 | 32 | The `imapfilter-config` directory contains an example imapfilter 33 | configuration. 34 | 35 | The `docker-stack` directory contains an arguably dated example for 36 | a docker stack or docker-compose deployment. 37 | 38 | The `k8s` directory contains an example for a kubernetes deployment. 39 | This is largely based on the git-based example from the `docker-stack` 40 | directory. 41 | 42 | ## Environment variables 43 | 44 | ### imapfilter 45 | 46 | #### `IMAPFILTER_CONFIG` and `IMAPFILTER_CONFIG_BASE` 47 | 48 | `IMAPFILTER_CONFIG` is the path of the imapfilter config relative to 49 | `IMAPFILTER_CONFIG_BASE`. 50 | 51 | E.g. if the imapfilter config is called `config.lua` and the directory 52 | is mounted into the container at `/configs`: 53 | 54 | ```bash 55 | IMAPFILTER_CONFIG=config.lua 56 | IMAPFILTER_CONFIG_BASE=/configs 57 | ``` 58 | 59 | In a git-based setup `IMAPFILTER_CONFIG_BASE` is not needed. In this 60 | case `IMAPFILTER_CONFIG` must be relative to the root of the git repo. 61 | 62 | > [!WARNING] 63 | > When using multiple config files use relative imports, otherwise the 64 | > imports will break in the container. 65 | 66 | Defaults: 67 | 68 | ```bash 69 | IMAPFILTER_CONFIG_BASE=/opts/imapfilter/config 70 | IMAPFILTER_CONFIG= 71 | ``` 72 | 73 | #### `IMAPFILTER_DAEMON` and `IMAPFILTER_SLEEP` 74 | 75 | If `IMAPFILTER_DAEMON` is set to `yes`, docker-imapfilter expects the 76 | configuration to enter idle mode. See the example configuration on how 77 | to accomplish this. 78 | 79 | If `IMAPFILTER_DAEMON` is not set to `yes`, the entrypoint will run in 80 | a loop, sleeping for `IMAPFILTER_SLEEP` seconds between runs of 81 | imapfilter. 82 | 83 | Defaults: 84 | 85 | ```bash 86 | IMAPFILTER_DAEMON= 87 | IMAPFILTER_SLEEP=30 88 | ``` 89 | 90 | #### `IMAPFILTER_LOGFILE` 91 | 92 | If `IMAPFILTER_LOGFILE` is set, imapfilter will write its log output 93 | to the specified file instead of standard output. 94 | 95 | Default: 96 | 97 | ```bash 98 | IMAPFILTER_LOGFILE= 99 | ``` 100 | 101 | ### git 102 | 103 | To use a git-based configuration configure at least `GIT_TARGET` to the 104 | endpoint of your git repository. 105 | 106 | E.g. if your git repository is at `https://my.git.com/user/repo.git`, set: 107 | 108 | ```bash 109 | GIT_TARGET=httsp://my.git.com/user/repo 110 | # (the .git suffix is optional) 111 | ``` 112 | 113 | To authenticate set `GIT_USER` if your git server requires a username 114 | for your method of authentication. 115 | 116 | The password to authenticate with can be either set in a file pointed to 117 | by `GIT_TOKEN`, or directly in the `GIT_TOKEN_RAW` variable. 118 | 119 | Note that git server authentication methods vary between the different 120 | providers. See your git provider's documentation for details. 121 | 122 | Generally if you use token-based authentication set: 123 | 124 | ```bash 125 | GIT_TOKEN_RAW=your-access-token 126 | GIT_TARGET=my.git.com/user/repo 127 | ``` 128 | 129 | If you use username/password-based authentication set: 130 | 131 | ```bash 132 | GIT_USER=your-username 133 | GIT_TOKEN_RAW=your-password 134 | GIT_TARGET=my.git.com/user/repo 135 | ``` 136 | 137 | Substitute `GIT_TOKEN_RAW` with `GIT_TOKEN` if you want to read the 138 | token from a file. 139 | 140 | [imapfilter]: https://github.com/lefcha/imapfilter 141 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 2 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 3 | github.com/emersion/go-imap/v2 v2.0.0-beta.7 h1:lNznYWa5uhMrngnSYEklzCeye4DBq9TEJ+pr0K593+8= 4 | github.com/emersion/go-imap/v2 v2.0.0-beta.7/go.mod h1:BZTFHsS1hmgBkFlHqbxGLXk2hnRqTItUgwjSSCsYNAk= 5 | github.com/emersion/go-message v0.18.1 h1:tfTxIoXFSFRwWaZsgnqS1DSZuGpYGzSmCZD8SK3QA2E= 6 | github.com/emersion/go-message v0.18.1/go.mod h1:XpJyL70LwRvq2a8rVbHXikPgKj8+aI0kGdHlg16ibYA= 7 | github.com/emersion/go-sasl v0.0.0-20231106173351-e73c9f7bad43 h1:hH4PQfOndHDlpzYfLAAfl63E8Le6F2+EL/cdhlkyRJY= 8 | github.com/emersion/go-sasl v0.0.0-20231106173351-e73c9f7bad43/go.mod h1:iL2twTeMvZnrg54ZoPDNfJaJaqy0xIQFuBdrLsmspwQ= 9 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 10 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 11 | github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= 12 | github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= 13 | github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= 14 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 15 | golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= 16 | golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= 17 | golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= 18 | golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= 19 | golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= 20 | golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= 21 | golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= 22 | golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 23 | golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 24 | golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 25 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 26 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 27 | golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 28 | golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 29 | golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 30 | golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 31 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 32 | golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= 33 | golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= 34 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 35 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 36 | golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= 37 | golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= 38 | golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= 39 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 40 | golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= 41 | golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= 42 | golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= 43 | golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 44 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 45 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 46 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 47 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 48 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | vcs_token() { 4 | if [ -n "$GIT_TOKEN_RAW" ]; then 5 | echo "$GIT_TOKEN_RAW" 6 | return 7 | fi 8 | 9 | if [ -n "$GIT_TOKEN" ]; then 10 | cat "${GIT_TOKEN}" 11 | fi 12 | 13 | return 1 14 | } 15 | 16 | vcs_target_protocol() { 17 | # https://a.b.c/ 18 | # -> https 19 | echo "${GIT_TARGET%%://*}" 20 | } 21 | 22 | vcs_target_base() { 23 | # https://a.b.c/ 24 | # -> a.b.c/ 25 | echo "${GIT_TARGET##*://}" 26 | } 27 | 28 | vcs_uri() { 29 | s="$(vcs_target_protocol)://" 30 | if [ -n "$GIT_USER" ]; then 31 | # https://user 32 | s="${s}${GIT_USER}" 33 | fi 34 | 35 | token="$(vcs_token)" 36 | 37 | # no user - https:// 38 | # no user - token https://user: 39 | # user - no token https://user 40 | if [ -n "$GIT_USER" ] && [ -n "$token" ]; then 41 | s="${s}:" 42 | fi 43 | 44 | # no user - token https://user:token 45 | # user - no token https://user 46 | if [ -n "$token" ]; then 47 | s="${s}${token}" 48 | fi 49 | 50 | # no user - no token https:// 51 | # no user - token https://user:token@ 52 | # user - no token https://user@ 53 | if [ -n "$GIT_USER" ] || [ -n "$token" ]; then 54 | s="${s}@" 55 | fi 56 | 57 | # no user - no token https://target 58 | # no user - token https://user:token@target 59 | # user - no token https://user@target 60 | echo "${s}$(vcs_target_base)" 61 | } 62 | 63 | config_in_vcs() { 64 | [ -n "$(vcs_token)" ] && [ -n "$GIT_TARGET" ] 65 | } 66 | 67 | config_target_base="${IMAPFILTER_CONFIG_BASE:-/opt/imapfilter/config}" 68 | config_target="${IMAPFILTER_CONFIG}" 69 | 70 | # If config_target is an absolute path strip the base. 71 | # Originally IMAPFILTER_CONFIG was allowed to be absolute and relative, 72 | # this handles the former absolute path (as long as 73 | # IMAPFILTER_CONFIG_BASE is correctly used). 74 | case "$config_target" in 75 | (/*) config_target="${config_target#${config_target_base}/}";; 76 | esac 77 | 78 | pull_config() { 79 | config_in_vcs || return 80 | 81 | printf ">>> Updating config\n" 82 | if [ ! -d "$config_target_base/.git" ]; then 83 | printf ">>> Config has not been cloned yet, cloning\n" 84 | mkdir -p "$config_target_base" 85 | git clone "$(vcs_uri)" "$config_target_base" 86 | return 87 | else 88 | cd "$config_target_base" 89 | printf ">>> Pulling config\n" 90 | git remote update 91 | if [ "$(git rev-parse HEAD)" != "$(git rev-parse FETCH_HEAD)" ]; then 92 | git pull 93 | return 94 | fi 95 | cd - 96 | fi 97 | return 1 98 | } 99 | 100 | start_imapfilter() { 101 | # enter a subshell to not affect the pwd of the running process 102 | ( 103 | if ! [ -d "$config_target_base" ]; then 104 | echo "The directory '$config_target_base' does not exist, exiting" 105 | echo "Please validate IMAPFILTER_CONFIG_BASE" 106 | exit 1 107 | fi 108 | 109 | # Enter the basedir of the config. Required to allow relative 110 | # includes in the lua scripts. 111 | cd "$config_target_base" 112 | 113 | log_parameter= 114 | if [ -n "$IMAPFILTER_LOGFILE" ]; then 115 | log_parameter="-l $IMAPFILTER_LOGFILE" 116 | fi 117 | 118 | if ! [ -f "$config_target" ]; then 119 | echo "The file '$config_target' does not exist relative to '$config_target_base', exiting" 120 | echo "Please validate IMAPFILTER_CONFIG" 121 | exit 1 122 | fi 123 | 124 | imapfilter -c "$config_target" $log_parameter 125 | ) 126 | } 127 | 128 | imapfilter_pid= 129 | imapfilter_restart_daemon() { 130 | if [ -n "$imapfilter_pid" ]; then 131 | kill -TERM "$imapfilter_pid" 132 | wait "$imapfilter_pid" 133 | fi 134 | start_imapfilter & 135 | imapfilter_pid="$(jobs -p)" 136 | } 137 | 138 | loop_no_daemon() { 139 | while true; do 140 | pull_config 141 | 142 | printf ">>> Running imapfilter\n" 143 | if ! start_imapfilter; then 144 | printf ">>> imapfilter failed\n" 145 | exit 1 146 | fi 147 | 148 | printf ">>> Sleeping\n" 149 | sleep "${IMAPFILTER_SLEEP:-30}" 150 | done 151 | } 152 | 153 | loop_daemon() { 154 | imapfilter_restart_daemon 155 | while true; do 156 | if pull_config; then 157 | printf ">>> Update in VCS, restarting imapfilter daemon\n" 158 | imapfilter_restart_daemon 159 | fi 160 | 161 | printf ">>> Sleeping\n" 162 | sleep "${IMAPFILTER_SLEEP:-30}" 163 | 164 | if ! kill -0 "$imapfilter_pid" 2>/dev/null; then 165 | printf ">>> imapfilter daemon died, exiting\n" 166 | exit 1 167 | fi 168 | done 169 | } 170 | 171 | pull_config 172 | if [ "$IMAPFILTER_DAEMON" = "yes" ]; then 173 | loop_daemon 174 | else 175 | loop_no_daemon 176 | fi 177 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------