From 7f1263b7d32ac2469d63fac4d16aca01098e93ae Mon Sep 17 00:00:00 2001 From: delliott Date: Wed, 24 Dec 2025 13:00:42 +0000 Subject: [PATCH] feat/versions (#5512) # Summary Add a stage to the build process that sparse clones deps and puts them in the required places. This should make it much easier to keep track of vendored deps, and similar. Solves https://git.fsfe.org/FSFE/fsfe-website/issues/5426 and helps makes progress towards https://git.fsfe.org/FSFE/fsfe-website/issues/4825 This pr moves almost all thirdparty deps from being vendored to being added by the build process. This pr should be deployed on test and some cgi scripts tested before merge, there is some possibility of issues. But it should be minimal. One thing: we manually mention the versions of things in https://fsfe.org/about/js-licences I think we could make this automatic perhaps? This pr atm does make us dependent on our sources being online for full builds. This is common, but perhaps not acceptable for us? We could instead do one of the following: - cache downloaded repos outside of the website dir, so they survive a full rebuild - make this script an updater script, so all deps are still vendored, but we have a nice script to update them. Not a big fan of this. - Use nix to fetch all the deps. Now reliant on nixos org instead of github, significant barrier for new contributors. - have a mirror of all the repos we use for builds on this git server. I kinda like this option, it leaves the most sensible and "normal" build process. Does not seem hard: https://docs.gitea.com/usage/repo-mirror # State of deps ## Moved - PHPmailer - Bootstrap ( we were using different versions for the less and js. this is almost certainly A mistake, but I have kept it the same in this issue to minimize disruption, and will try and fix it later). Also we had some bootstrap js we do not use anywhere, we just have a small bit of custom bootstrap js, not the whole package. - Lunr (could not get a minimized version from upstream repo, so we have lost minimization. Not very important as it is only used on search page) - Jquery ( this can be dropped once we upgrade bootstrap, only used as a bootstrap dep) ## Could not move - moderniser (I hope to drop this down the line, but we use a custom build of an old version that I could find no way to recreate/pull from their git repo. So I could not fetch it as a dep) - the various xml files. These are incredibly static compared to everything else, so I did not bother. - Fonts: they are often only available as release artifacts from some site, and so downloading them would massively complicate the dep script. I do not want to maintain a package manager, and so if we think that necessary I would advocate for nix. Also, some fonts are only available from google fonts which does not seem to expose versions. This would again be a problem to be solved with nix. # Checklist - [x] site looks correct locally - [x] search works locally - [x] no missing scripts using inspector locally - [x] Deployed on test Co-authored-by: Darragh Elliott Reviewed-on: https://git.fsfe.org/FSFE/fsfe-website/pulls/5512 Reviewed-by: tobiasd Co-authored-by: delliott Co-committed-by: delliott --- .drone.yml | 33 +- .gitignore | 4 +- build/fsfe_website_build/build.py | 8 + build/fsfe_website_build/globals.py | 10 + .../fsfe_website_build/phase0/clean_cache.py | 23 + build/fsfe_website_build/phase0/full.py | 6 +- .../phase1/get_dependencies.py | 101 + build/fsfe_website_build/phase1/run.py | 2 + .../caching_test.py | 5 +- docker-compose.yml | 6 +- docs/contributing.md | 3 +- docs/management.md | 2 +- fsfe.org/.gitignore | 8 + fsfe.org/about/js-licences.en.xhtml | 10 +- fsfe.org/cgi-bin/PHPMailer/Exception.php | 40 - fsfe.org/cgi-bin/PHPMailer/PHPMailer.php | 5362 ----------------- fsfe.org/cgi-bin/PHPMailer/SMTP.php | 1547 ----- fsfe.org/cgi-bin/perdiem.php | 8 +- fsfe.org/cgi-bin/reimbursement.php | 6 +- fsfe.org/dependencies.toml | 27 + fsfe.org/look/base.less | 1 + fsfe.org/look/thirdparty/bootstrap/LICENSE | 21 - fsfe.org/look/thirdparty/bootstrap/README.md | 149 - .../look/thirdparty/bootstrap/alerts.less | 73 - .../look/thirdparty/bootstrap/badges.less | 66 - .../look/thirdparty/bootstrap/bootstrap.less | 56 - .../thirdparty/bootstrap/breadcrumbs.less | 26 - .../thirdparty/bootstrap/button-groups.less | 246 - .../look/thirdparty/bootstrap/buttons.less | 168 - .../look/thirdparty/bootstrap/carousel.less | 273 - fsfe.org/look/thirdparty/bootstrap/close.less | 37 - fsfe.org/look/thirdparty/bootstrap/code.less | 69 - .../bootstrap/component-animations.less | 36 - .../look/thirdparty/bootstrap/dropdowns.less | 213 - fsfe.org/look/thirdparty/bootstrap/forms.less | 605 -- .../look/thirdparty/bootstrap/glyphicons.less | 307 - fsfe.org/look/thirdparty/bootstrap/grid.less | 94 - .../thirdparty/bootstrap/input-groups.less | 173 - .../look/thirdparty/bootstrap/jumbotron.less | 54 - .../look/thirdparty/bootstrap/labels.less | 64 - .../look/thirdparty/bootstrap/list-group.less | 130 - fsfe.org/look/thirdparty/bootstrap/media.less | 66 - .../look/thirdparty/bootstrap/mixins.less | 40 - .../thirdparty/bootstrap/mixins/alerts.less | 15 - .../bootstrap/mixins/background-variant.less | 9 - .../bootstrap/mixins/border-radius.less | 18 - .../thirdparty/bootstrap/mixins/buttons.less | 61 - .../bootstrap/mixins/center-block.less | 7 - .../thirdparty/bootstrap/mixins/clearfix.less | 22 - .../thirdparty/bootstrap/mixins/forms.less | 85 - .../bootstrap/mixins/gradients.less | 59 - .../bootstrap/mixins/grid-framework.less | 91 - .../thirdparty/bootstrap/mixins/grid.less | 122 - .../bootstrap/mixins/hide-text.less | 23 - .../thirdparty/bootstrap/mixins/image.less | 30 - .../thirdparty/bootstrap/mixins/labels.less | 12 - .../bootstrap/mixins/list-group.less | 30 - .../bootstrap/mixins/nav-divider.less | 10 - .../bootstrap/mixins/nav-vertical-align.less | 9 - .../thirdparty/bootstrap/mixins/opacity.less | 7 - .../bootstrap/mixins/pagination.less | 24 - .../thirdparty/bootstrap/mixins/panels.less | 24 - .../bootstrap/mixins/progress-bar.less | 10 - .../bootstrap/mixins/reset-filter.less | 8 - .../bootstrap/mixins/reset-text.less | 18 - .../thirdparty/bootstrap/mixins/resize.less | 6 - .../mixins/responsive-visibility.less | 13 - .../thirdparty/bootstrap/mixins/size.less | 10 - .../bootstrap/mixins/tab-focus.less | 9 - .../bootstrap/mixins/table-row.less | 28 - .../bootstrap/mixins/text-emphasis.less | 9 - .../bootstrap/mixins/text-overflow.less | 8 - .../bootstrap/mixins/vendor-prefixes.less | 229 - .../look/thirdparty/bootstrap/modals.less | 150 - .../look/thirdparty/bootstrap/navbar.less | 656 -- fsfe.org/look/thirdparty/bootstrap/navs.less | 244 - .../look/thirdparty/bootstrap/normalize.less | 429 -- fsfe.org/look/thirdparty/bootstrap/pager.less | 54 - .../look/thirdparty/bootstrap/pagination.less | 86 - .../look/thirdparty/bootstrap/panels.less | 273 - .../look/thirdparty/bootstrap/popovers.less | 126 - fsfe.org/look/thirdparty/bootstrap/print.less | 101 - .../thirdparty/bootstrap/progress-bars.less | 89 - .../bootstrap/responsive-embed.less | 35 - .../bootstrap/responsive-utilities.less | 196 - .../thirdparty/bootstrap/scaffolding.less | 161 - .../look/thirdparty/bootstrap/tables.less | 236 - fsfe.org/look/thirdparty/bootstrap/theme.less | 297 - .../look/thirdparty/bootstrap/thumbnails.less | 38 - .../look/thirdparty/bootstrap/tooltip.less | 112 - fsfe.org/look/thirdparty/bootstrap/type.less | 304 - .../look/thirdparty/bootstrap/utilities.less | 57 - .../look/thirdparty/bootstrap/variables.less | 738 --- fsfe.org/look/thirdparty/bootstrap/wells.less | 29 - fsfe.org/look/variables.less | 718 +++ .../scripts/thirdparty/bootstrap-3.0.3.min.js | 7 - ...ap-3.0.3.custom.js => bootstrap.custom.js} | 0 .../scripts/thirdparty/jquery-3.5.1.min.js | 2 - .../scripts/thirdparty/jquery-3.5.1.min.map | 1 - fsfe.org/scripts/thirdparty/lunr-2.3.9.min.js | 6 - fsfe.org/search/search.en.xhtml | 2 +- fsfe.org/search/search.nl.xhtml | 2 +- fsfe.org/search/subdir.py | 5 +- global/xslt/internal/body_scripts.xsl | 2 +- global/xslt/internal/fsfe_head.xsl | 2 +- lefthook.yaml | 2 - pyproject.toml | 1 + tools/ci-checks/general.sh | 4 +- tools/ci-checks/remove-empty-paragraphs.xsl | 4 +- uv.lock | 11 + 110 files changed, 960 insertions(+), 15404 deletions(-) create mode 100644 build/fsfe_website_build/globals.py create mode 100644 build/fsfe_website_build/phase0/clean_cache.py create mode 100644 build/fsfe_website_build/phase1/get_dependencies.py delete mode 100644 fsfe.org/cgi-bin/PHPMailer/Exception.php delete mode 100644 fsfe.org/cgi-bin/PHPMailer/PHPMailer.php delete mode 100644 fsfe.org/cgi-bin/PHPMailer/SMTP.php create mode 100644 fsfe.org/dependencies.toml delete mode 100644 fsfe.org/look/thirdparty/bootstrap/LICENSE delete mode 100644 fsfe.org/look/thirdparty/bootstrap/README.md delete mode 100644 fsfe.org/look/thirdparty/bootstrap/alerts.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/badges.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/bootstrap.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/breadcrumbs.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/button-groups.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/buttons.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/carousel.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/close.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/code.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/component-animations.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/dropdowns.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/forms.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/glyphicons.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/grid.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/input-groups.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/jumbotron.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/labels.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/list-group.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/media.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/alerts.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/background-variant.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/border-radius.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/buttons.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/center-block.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/clearfix.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/forms.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/gradients.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/grid-framework.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/grid.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/hide-text.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/image.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/labels.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/list-group.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/nav-divider.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/nav-vertical-align.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/opacity.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/pagination.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/panels.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/progress-bar.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/reset-filter.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/reset-text.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/resize.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/responsive-visibility.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/size.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/tab-focus.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/table-row.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/text-emphasis.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/text-overflow.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/mixins/vendor-prefixes.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/modals.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/navbar.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/navs.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/normalize.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/pager.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/pagination.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/panels.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/popovers.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/print.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/progress-bars.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/responsive-embed.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/responsive-utilities.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/scaffolding.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/tables.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/theme.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/thumbnails.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/tooltip.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/type.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/utilities.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/variables.less delete mode 100644 fsfe.org/look/thirdparty/bootstrap/wells.less create mode 100644 fsfe.org/look/variables.less delete mode 100644 fsfe.org/scripts/thirdparty/bootstrap-3.0.3.min.js rename fsfe.org/scripts/thirdparty/{bootstrap-3.0.3.custom.js => bootstrap.custom.js} (100%) delete mode 100644 fsfe.org/scripts/thirdparty/jquery-3.5.1.min.js delete mode 100644 fsfe.org/scripts/thirdparty/jquery-3.5.1.min.map delete mode 100644 fsfe.org/scripts/thirdparty/lunr-2.3.9.min.js diff --git a/.drone.yml b/.drone.yml index 0647b1421c..1ee50f55ee 100644 --- a/.drone.yml +++ b/.drone.yml @@ -19,13 +19,12 @@ steps: path: /run/user/1001/docker.sock commands: - export FSFE_WEBSITE_HOST_SOURCE_CODE=$(docker container inspect "$HOSTNAME" --format '{{ range .Mounts }}{{ if eq .Destination "/drone/src" }}{{ .Source }}{{ end }}{{ end }}') - - docker ps && echo "tampered with" - echo "DRONE_COMMIT_BRANCH ${DRONE_COMMIT_BRANCH}" - echo "DRONE_COMMIT_REF ${DRONE_COMMIT_REF}" - - PROJECT="$(echo "fsfe-website-pre-commit-${DRONE_COMMIT_REF}" | tr "/" "-")" - - docker compose -p "$PROJECT" down - - docker compose -p "$PROJECT" run --remove-orphans --build pre-commit "origin/${DRONE_COMMIT_BRANCH}" - - docker compose -p "$PROJECT" down + - export COMPOSE_PROJECT_NAME="$(echo "fsfe-website-pre-commit-${DRONE_COMMIT_REF}" | tr "/" "-")" + - docker compose down + - docker compose run --remove-orphans --build pre-commit "origin/${DRONE_COMMIT_BRANCH}" + - docker compose down # Test building the deploy docker image - name: test-build-docker-image @@ -73,20 +72,19 @@ steps: from_secret: KEY_PASSWORD FSFE_WEBSITE_GIT_TOKEN: from_secret: BUILD_TOKEN - PROJECT: fsfe-website-master + COMPOSE_PROJECT_NAME: fsfe-website-master volumes: # Mounting Docker socket of rootless docker user - name: dockersock path: /run/user/1001/docker.sock commands: - export FSFE_WEBSITE_HOST_SOURCE_CODE=$(docker container inspect "$HOSTNAME" --format '{{ range .Mounts }}{{ if eq .Destination "/drone/src" }}{{ .Source }}{{ end }}{{ end }}') - - docker ps && echo "tampered with" - - docker compose -p "$PROJECT" down + - docker compose down # If we are in a cron job, then do a full rebuild # Ideally the cron would set the flag itself, but drone does not support that. - - if [ "$DRONE_BUILD_EVENT" = "cron" ]; then EXTRA_FLAGS="--full"; fi - - docker compose -p "$PROJECT" run --remove-orphans --build build --target "$TARGET" $EXTRA_FLAGS - - docker compose -p "$PROJECT" down + - if [ "$DRONE_BUILD_EVENT" = "cron" ]; then EXTRA_FLAGS="--full --clean-cache"; fi + - docker compose run --remove-orphans --build build --target "$TARGET" $EXTRA_FLAGS + - docker compose down when: branch: - master @@ -108,20 +106,19 @@ steps: from_secret: KEY_PASSWORD FSFE_WEBSITE_GIT_TOKEN: from_secret: BUILD_TOKEN - PROJECT: fsfe-website-test + COMPOSE_PROJECT_NAME: fsfe-website-test volumes: # Mounting Docker socket of rootless docker user - name: dockersock path: /run/user/1001/docker.sock commands: - export FSFE_WEBSITE_HOST_SOURCE_CODE=$(docker container inspect "$HOSTNAME" --format '{{ range .Mounts }}{{ if eq .Destination "/drone/src" }}{{ .Source }}{{ end }}{{ end }}') - - docker ps && echo "tampered with" - - docker compose -p "$PROJECT" down + - docker compose down # If we are in a cron job, then do a full rebuild # Ideally the cron would set the flag itself, but drone does not support that. - - if [ "$DRONE_BUILD_EVENT" = "cron" ]; then EXTRA_FLAGS="--full"; fi - - docker compose -p "$PROJECT" run --remove-orphans --build build --target "$TARGET" $EXTRA_FLAGS - - docker compose -p "$PROJECT" down + - if [ "$DRONE_BUILD_EVENT" = "cron" ]; then EXTRA_FLAGS="--full --clean-cache"; fi + - docker compose run --remove-orphans --build build --target "$TARGET" $EXTRA_FLAGS + - docker compose down when: branch: - test @@ -148,6 +145,6 @@ volumes: path: /run/user/1001/docker.sock --- kind: signature -hmac: aa5d8fd7cd515e165b861345495517924992c4e1ff86e16c9b1ed293fed7a565 +hmac: 627a990b0ba4c6dc8aa43dda45f0d35cb3d3ada367c6db7e8b59c751e13ad5b2 ... diff --git a/.gitignore b/.gitignore index 888beda4fc..456b7e7247 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +# build cache stuff +.cache global/data/texts/.texts.??.xml global/data/topbanner/.topbanner.??.xml .default.xsl @@ -8,8 +10,6 @@ output # Python stuff .venv __pycache__ -#Nltk -.nltk_data #phpcsfixer cache .php-cs-fixer.cache # Secrets diff --git a/build/fsfe_website_build/build.py b/build/fsfe_website_build/build.py index 6653fab4df..6b63bd7f37 100755 --- a/build/fsfe_website_build/build.py +++ b/build/fsfe_website_build/build.py @@ -11,6 +11,7 @@ from pathlib import Path from textwrap import dedent from .lib.misc import lang_from_filename +from .phase0.clean_cache import clean_cache from .phase0.full import full from .phase0.global_symlinks import global_symlinks from .phase0.prepare_early_subdirectories import prepare_early_subdirectories @@ -32,6 +33,11 @@ def _parse_arguments() -> argparse.Namespace: help="Force a full rebuild of all webpages.", action="store_true", ) + parser.add_argument( + "--clean-cache", + help="Clean the global cache stored in the platform cache directory.", + action="store_true", + ) parser.add_argument( "--languages", help="Languages to build website in.", @@ -107,6 +113,8 @@ def build(args: argparse.Namespace) -> None: with multiprocessing.Pool(args.processes) as pool: logger.info("Starting phase 0 - Global Conditional Setup") + if args.clean_cache: + clean_cache() # TODO Should also be triggered whenever any build python file is changed if args.full: full(args.source) diff --git a/build/fsfe_website_build/globals.py b/build/fsfe_website_build/globals.py new file mode 100644 index 0000000000..f5a9b618bd --- /dev/null +++ b/build/fsfe_website_build/globals.py @@ -0,0 +1,10 @@ +# SPDX-FileCopyrightText: Free Software Foundation Europe e.V. +# +# SPDX-License-Identifier: GPL-3.0-or-later +"""Global variables for build process.""" + +from pathlib import Path + +from platformdirs import user_cache_dir + +CACHE_DIR = Path(user_cache_dir("fsfe-website-build", "fsfe")) diff --git a/build/fsfe_website_build/phase0/clean_cache.py b/build/fsfe_website_build/phase0/clean_cache.py new file mode 100644 index 0000000000..990f594dd6 --- /dev/null +++ b/build/fsfe_website_build/phase0/clean_cache.py @@ -0,0 +1,23 @@ +# SPDX-FileCopyrightText: Free Software Foundation Europe e.V. +# +# SPDX-License-Identifier: GPL-3.0-or-later + +"""Clean global cache.""" + +import logging +import shutil + +from fsfe_website_build.globals import CACHE_DIR + +logger = logging.getLogger(__name__) + + +def clean_cache() -> None: + """Remove the global cache folder.""" + logger.info("Cleaning global cache") + # Slightly more complex logic to handle the cache dir being a mount in docker + for item in CACHE_DIR.iterdir(): + if item.is_file() or item.is_symlink(): + item.unlink() + elif item.is_dir(): + shutil.rmtree(item) diff --git a/build/fsfe_website_build/phase0/full.py b/build/fsfe_website_build/phase0/full.py index 189aaff4ef..9305a47b38 100644 --- a/build/fsfe_website_build/phase0/full.py +++ b/build/fsfe_website_build/phase0/full.py @@ -25,12 +25,10 @@ def full(source: Path) -> None: [ "git", "--git-dir", - str(source) + "/.git", + str(source / ".git"), "clean", - "-fdx", + "-ffdx", "--exclude", "/.venv", - "--exclude", - "/.nltk_data", ], ) diff --git a/build/fsfe_website_build/phase1/get_dependencies.py b/build/fsfe_website_build/phase1/get_dependencies.py new file mode 100644 index 0000000000..7bea515714 --- /dev/null +++ b/build/fsfe_website_build/phase1/get_dependencies.py @@ -0,0 +1,101 @@ +# SPDX-FileCopyrightText: Free Software Foundation Europe e.V. +# +# SPDX-License-Identifier: GPL-3.0-or-later +"""Download the dependencies of a site, should it be necessary.""" + +import logging +import tomllib +from collections import defaultdict +from pathlib import Path + +from fsfe_website_build.globals import CACHE_DIR +from fsfe_website_build.lib.misc import run_command + +logger = logging.getLogger(__name__) + + +def fetch_sparse( + cache: Path, + repo: str, + rev: str, + file_mappings: list[dict[str, str]], +) -> None: + """Clone source, and move necessary files into place with source/dest pairs.""" + clone_dir = cache / f"{Path(repo).name}_{rev}" + + if not (clone_dir / ".git").exists(): + clone_dir.mkdir(exist_ok=True) + run_command( + ["git", "-C", str(clone_dir), "init", "--quiet", "--no-initial-branch"] + ) + run_command(["git", "-C", str(clone_dir), "remote", "add", "origin", repo]) + run_command( + ["git", "-C", str(clone_dir), "config", "core.sparseCheckout", "true"] + ) + # Extract all paths for sparse checkout + paths = [mapping["source"] for mapping in file_mappings] + sparse_checkout_path = clone_dir / ".git" / "info" / "sparse-checkout" + # if path is ".", checkout the whole repo + if any(path == "." for path in paths): + sparse_checkout_path.write_text("/*\n") + else: + sparse_checkout_path.write_text("\n".join(paths) + "\n") + + # Fetch the required revision + run_command(["git", "-C", str(clone_dir), "fetch", "--depth=1", "origin", rev]) + # Checkout the fetched revision + run_command(["git", "-C", str(clone_dir), "checkout", "FETCH_HEAD"]) + # Copy each file to its destination + for mapping in file_mappings: + # create our source path + # the source syntax is that of .gitignore, and so may have a leading / + # to say to interpret it only relative to the root + # and so we remove that so joining gives us a proper path + src = clone_dir / mapping["source"].lstrip("/") + dest_path = Path(mapping["dest"]) + dest_path.parent.mkdir(parents=True, exist_ok=True) + + run_command( + [ + "rsync", + "-avz", + "--del", + "--exclude=.git", + str(src) if not src.is_dir() else str(src) + "/", + str(dest_path), + ] + ) + + +def get_dependencies( + source_dir: Path, +) -> None: + """Download and put in place all website dependencies.""" + logger.info("Getting Dependencies") + cache = CACHE_DIR / "repos" + cache.mkdir(parents=True, exist_ok=True) + deps_file = source_dir / "dependencies.toml" + if deps_file.exists(): + with deps_file.open("rb") as file: + cfg = tomllib.load(file) + + # Group file mappings by repository and revision + repo_tasks: defaultdict[tuple[str, str], list[dict[str, str]]] = defaultdict( + list + ) + + for data in cfg.values(): + repo = str(data["repo"]) + rev = str(data["rev"]) + key = (repo, rev) + + for file_set in data["file_sets"]: + # Make path relative to source dir + dest = source_dir / file_set["target"] + repo_tasks[key].append( + {"source": str(file_set["source"]), "dest": str(dest)} + ) + + # Process each repository/revision only once + for (repo, rev), file_mappings in repo_tasks.items(): + fetch_sparse(cache, repo, rev, file_mappings) diff --git a/build/fsfe_website_build/phase1/run.py b/build/fsfe_website_build/phase1/run.py index 65198ef107..52ffe62e67 100644 --- a/build/fsfe_website_build/phase1/run.py +++ b/build/fsfe_website_build/phase1/run.py @@ -12,6 +12,7 @@ directory tree and does not touch the target directory tree at all. import logging from typing import TYPE_CHECKING +from .get_dependencies import get_dependencies from .prepare_subdirectories import prepare_subdirectories from .update_css import update_css from .update_defaultxsls import update_defaultxsls @@ -35,6 +36,7 @@ def phase1_run( ) -> None: """Run all the necessary sub functions for phase1.""" logger.info("Starting Phase 1 - Setup") + get_dependencies(source_site) update_css(source_site) update_stylesheets(source_site, pool) prepare_subdirectories(source, source_site, languages, processes) diff --git a/build/fsfe_website_build_tests_ci/caching_test.py b/build/fsfe_website_build_tests_ci/caching_test.py index c26c40805e..569b250cbd 100644 --- a/build/fsfe_website_build_tests_ci/caching_test.py +++ b/build/fsfe_website_build_tests_ci/caching_test.py @@ -15,13 +15,12 @@ def no_rebuild_twice_test(mocker: MockFixture) -> None: # first, run a full build args = Namespace( full=True, + clean_cache=False, languages=[ "en", - "nl", - "de", ], log_level="CRITICAL", # by only logging critical messages - # the build should be faster, as evaluating less trhings to strings + # the build should be faster, as evaluating less things to strings processes=8, source=Path(), serve=False, diff --git a/docker-compose.yml b/docker-compose.yml index ea45d37807..d6284c8a43 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -23,10 +23,12 @@ services: - FSFE_WEBSITE_KEY_PASSWORD - FSFE_WEBSITE_GIT_TOKEN volumes: - - cache:/website-cached + - website-cache:/website-cached + - dependency-cache:/root/.cache/fsfe-website-build - ${FSFE_WEBSITE_HOST_SOURCE_CODE:-./}:/website-source volumes: - cache: + website-cache: + dependency-cache: secrets: FSFE_WEBSITE_KEY_PRIVATE: environment: FSFE_WEBSITE_KEY_PRIVATE diff --git a/docs/contributing.md b/docs/contributing.md index f5bdc0efdf..63bd31d6af 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -33,9 +33,10 @@ This is a little bit of a messy list of things we have found that are not perhap - When doing manipulation of stuff, have a look in the lib functions to see if it is already present. If you find a common pattern, perhaps functionise it. - In phase 1, only update files using the `update_if_changed` function. This function will, as expected, take a file path and a string, and only update the file with the string if there is a difference. Not doing this means a file will always be updated, and hence anything depending on it will always be rebuild, even if the file has not actually changed. +- When fetching things from the internet (avoid if possible), such as dependencies and such during the build, please make sure and cache them in a global cache directory, as provided by `fsfe_website_build.globals.CACHE_DIR`. This ensures that full builds can be done without internet access, only needing internet for a run with `--clean-cache`. - When generating lists that end up in files, take care that they are stable to prevent unnecessary rebuilding. - All steps are largely considered to be synchronous, and must be finished before the next step can start. Therefore, async must unfortunately be avoided. There are some steps where performance benefits could be achieved by allowing the next step to run concurrently, but the design complications make this unattractive. - We use a single process pool to multithread with. This gives a small performance benefit over making and deleting pools continuously. - All paths are to be handled with `pathlib`, not as strings. - XML code should be generated with LXML instead of string templating. This is to ensure that we generate valid XML every time, and prevents issues with escaping, etc. -- Where possibly, type hint stuff. We try and keep the codebase reasonably typed to make it comprehensible +- This codebase is strictly typed using pyright, and all code should be compliant with pyright strict. diff --git a/docs/management.md b/docs/management.md index 0fc938fe35..34e70f4145 100644 --- a/docs/management.md +++ b/docs/management.md @@ -8,4 +8,4 @@ If you have the correct permission, you will see a blue new build button in the After it is pressed, a popup for the new build will appear on-screen. Select the branch the wish to build, `master` or `test`. -To pass extra arguments to the build script add a parameter with key `EXTRA_FLAGS` and the values being an unquoted list of arguments. For example to do a full build one would do `--full`. Be sure and hit the add message on the right after setting to actually enable the parameter for the build. Then hit create, and away we go. +To pass extra arguments to the build script add a parameter with key `EXTRA_FLAGS` and the values being an unquoted list of arguments. For example to do a full build that also deletes cached dependencies one would do `--full --clean-cache`. Be sure and hit the add message on the right after setting to actually enable the parameter for the build. Then hit create, and away we go. diff --git a/fsfe.org/.gitignore b/fsfe.org/.gitignore index 73274dd2fa..06bf8937a2 100644 --- a/fsfe.org/.gitignore +++ b/fsfe.org/.gitignore @@ -15,3 +15,11 @@ tags/tagged-*.??.xhtml tags/.tags.??.xml # internal activities file internal/fsfe-activities-options.*.xml + +# thirdpary stuff fetched by deps +# once all deps are managed this way we can make this a more general pattern +cgi-bin/thirdparty +scripts/thirdparty/jquery* +scripts/thirdparty/lunr.min.js +scripts/thirdparty/bootstrap.min.js +look/thirdparty/bootstrap diff --git a/fsfe.org/about/js-licences.en.xhtml b/fsfe.org/about/js-licences.en.xhtml index a3a9025ca2..cf21f49d18 100644 --- a/fsfe.org/about/js-licences.en.xhtml +++ b/fsfe.org/about/js-licences.en.xhtml @@ -28,7 +28,7 @@ Modernizr 2.7.1 - scripts/thirdparty/bootstrap-3.0.3.custom.js + scripts/thirdparty/bootstrap.custom.js Apache-2.0 Bootstrap 3.0.3 @@ -38,9 +38,9 @@ GPLv3 or later - scripts/thirdparty/jquery-3.5.1.min.js + scripts/thirdparty/jquery.min.js Expat - jQuery 3.5.1 + jQuery 3.5.1 scripts/filter-teams.js @@ -48,9 +48,9 @@ Filter Teams - scripts/thirdparty/lunr-2.3.9.min.js + scripts/thirdparty/lunr.min.js Expat - lunr-2.3.9.min.js + lunr.min.js diff --git a/fsfe.org/cgi-bin/PHPMailer/Exception.php b/fsfe.org/cgi-bin/PHPMailer/Exception.php deleted file mode 100644 index 09c1a2cfef..0000000000 --- a/fsfe.org/cgi-bin/PHPMailer/Exception.php +++ /dev/null @@ -1,40 +0,0 @@ - - * @author Jim Jagielski (jimjag) - * @author Andy Prevost (codeworxtech) - * @author Brent R. Matzelle (original founder) - * @copyright 2012 - 2020 Marcus Bointon - * @copyright 2010 - 2012 Jim Jagielski - * @copyright 2004 - 2009 Andy Prevost - * @license https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html GNU Lesser General Public License - * @note This program is distributed in the hope that it will be useful - WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. - */ - -namespace PHPMailer\PHPMailer; - -/** - * PHPMailer exception handler. - * - * @author Marcus Bointon - */ -class Exception extends \Exception -{ - /** - * Prettify error message output. - * - * @return string - */ - public function errorMessage() - { - return '' . htmlspecialchars($this->getMessage(), ENT_COMPAT | ENT_HTML401) . "
\n"; - } -} diff --git a/fsfe.org/cgi-bin/PHPMailer/PHPMailer.php b/fsfe.org/cgi-bin/PHPMailer/PHPMailer.php deleted file mode 100644 index 2444bcf351..0000000000 --- a/fsfe.org/cgi-bin/PHPMailer/PHPMailer.php +++ /dev/null @@ -1,5362 +0,0 @@ - - * @author Jim Jagielski (jimjag) - * @author Andy Prevost (codeworxtech) - * @author Brent R. Matzelle (original founder) - * @copyright 2012 - 2020 Marcus Bointon - * @copyright 2010 - 2012 Jim Jagielski - * @copyright 2004 - 2009 Andy Prevost - * @license https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html GNU Lesser General Public License - * @note This program is distributed in the hope that it will be useful - WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. - */ - -namespace PHPMailer\PHPMailer; - -/** - * PHPMailer - PHP email creation and transport class. - * - * @author Marcus Bointon (Synchro/coolbru) - * @author Jim Jagielski (jimjag) - * @author Andy Prevost (codeworxtech) - * @author Brent R. Matzelle (original founder) - */ -class PHPMailer -{ - const CHARSET_ASCII = 'us-ascii'; - const CHARSET_ISO88591 = 'iso-8859-1'; - const CHARSET_UTF8 = 'utf-8'; - - const CONTENT_TYPE_PLAINTEXT = 'text/plain'; - const CONTENT_TYPE_TEXT_CALENDAR = 'text/calendar'; - const CONTENT_TYPE_TEXT_HTML = 'text/html'; - const CONTENT_TYPE_MULTIPART_ALTERNATIVE = 'multipart/alternative'; - const CONTENT_TYPE_MULTIPART_MIXED = 'multipart/mixed'; - const CONTENT_TYPE_MULTIPART_RELATED = 'multipart/related'; - - const ENCODING_7BIT = '7bit'; - const ENCODING_8BIT = '8bit'; - const ENCODING_BASE64 = 'base64'; - const ENCODING_BINARY = 'binary'; - const ENCODING_QUOTED_PRINTABLE = 'quoted-printable'; - - const ENCRYPTION_STARTTLS = 'tls'; - const ENCRYPTION_SMTPS = 'ssl'; - - const ICAL_METHOD_REQUEST = 'REQUEST'; - const ICAL_METHOD_PUBLISH = 'PUBLISH'; - const ICAL_METHOD_REPLY = 'REPLY'; - const ICAL_METHOD_ADD = 'ADD'; - const ICAL_METHOD_CANCEL = 'CANCEL'; - const ICAL_METHOD_REFRESH = 'REFRESH'; - const ICAL_METHOD_COUNTER = 'COUNTER'; - const ICAL_METHOD_DECLINECOUNTER = 'DECLINECOUNTER'; - - /** - * Email priority. - * Options: null (default), 1 = High, 3 = Normal, 5 = low. - * When null, the header is not set at all. - * - * @var int|null - */ - public $Priority; - - /** - * The character set of the message. - * - * @var string - */ - public $CharSet = self::CHARSET_ISO88591; - - /** - * The MIME Content-type of the message. - * - * @var string - */ - public $ContentType = self::CONTENT_TYPE_PLAINTEXT; - - /** - * The message encoding. - * Options: "8bit", "7bit", "binary", "base64", and "quoted-printable". - * - * @var string - */ - public $Encoding = self::ENCODING_8BIT; - - /** - * Holds the most recent mailer error message. - * - * @var string - */ - public $ErrorInfo = ''; - - /** - * The From email address for the message. - * - * @var string - */ - public $From = ''; - - /** - * The From name of the message. - * - * @var string - */ - public $FromName = ''; - - /** - * The envelope sender of the message. - * This will usually be turned into a Return-Path header by the receiver, - * and is the address that bounces will be sent to. - * If not empty, will be passed via `-f` to sendmail or as the 'MAIL FROM' value over SMTP. - * - * @var string - */ - public $Sender = ''; - - /** - * The Subject of the message. - * - * @var string - */ - public $Subject = ''; - - /** - * An HTML or plain text message body. - * If HTML then call isHTML(true). - * - * @var string - */ - public $Body = ''; - - /** - * The plain-text message body. - * This body can be read by mail clients that do not have HTML email - * capability such as mutt & Eudora. - * Clients that can read HTML will view the normal Body. - * - * @var string - */ - public $AltBody = ''; - - /** - * An iCal message part body. - * Only supported in simple alt or alt_inline message types - * To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator. - * - * @see https://kigkonsult.se/iCalcreator/ - * - * @var string - */ - public $Ical = ''; - - /** - * Value-array of "method" in Contenttype header "text/calendar" - * - * @var string[] - */ - protected static $IcalMethods = [ - self::ICAL_METHOD_REQUEST, - self::ICAL_METHOD_PUBLISH, - self::ICAL_METHOD_REPLY, - self::ICAL_METHOD_ADD, - self::ICAL_METHOD_CANCEL, - self::ICAL_METHOD_REFRESH, - self::ICAL_METHOD_COUNTER, - self::ICAL_METHOD_DECLINECOUNTER, - ]; - - /** - * The complete compiled MIME message body. - * - * @var string - */ - protected $MIMEBody = ''; - - /** - * The complete compiled MIME message headers. - * - * @var string - */ - protected $MIMEHeader = ''; - - /** - * Extra headers that createHeader() doesn't fold in. - * - * @var string - */ - protected $mailHeader = ''; - - /** - * Word-wrap the message body to this number of chars. - * Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance. - * - * @see static::STD_LINE_LENGTH - * - * @var int - */ - public $WordWrap = 0; - - /** - * Which method to use to send mail. - * Options: "mail", "sendmail", or "smtp". - * - * @var string - */ - public $Mailer = 'mail'; - - /** - * The path to the sendmail program. - * - * @var string - */ - public $Sendmail = '/usr/sbin/sendmail'; - - /** - * Whether mail() uses a fully sendmail-compatible MTA. - * One which supports sendmail's "-oi -f" options. - * - * @var bool - */ - public $UseSendmailOptions = true; - - /** - * The email address that a reading confirmation should be sent to, also known as read receipt. - * - * @var string - */ - public $ConfirmReadingTo = ''; - - /** - * The hostname to use in the Message-ID header and as default HELO string. - * If empty, PHPMailer attempts to find one with, in order, - * $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value - * 'localhost.localdomain'. - * - * @see PHPMailer::$Helo - * - * @var string - */ - public $Hostname = ''; - - /** - * An ID to be used in the Message-ID header. - * If empty, a unique id will be generated. - * You can set your own, but it must be in the format "", - * as defined in RFC5322 section 3.6.4 or it will be ignored. - * - * @see https://www.rfc-editor.org/rfc/rfc5322#section-3.6.4 - * - * @var string - */ - public $MessageID = ''; - - /** - * The message Date to be used in the Date header. - * If empty, the current date will be added. - * - * @var string - */ - public $MessageDate = ''; - - /** - * SMTP hosts. - * Either a single hostname or multiple semicolon-delimited hostnames. - * You can also specify a different port - * for each host by using this format: [hostname:port] - * (e.g. "smtp1.example.com:25;smtp2.example.com"). - * You can also specify encryption type, for example: - * (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465"). - * Hosts will be tried in order. - * - * @var string - */ - public $Host = 'localhost'; - - /** - * The default SMTP server port. - * - * @var int - */ - public $Port = 25; - - /** - * The SMTP HELO/EHLO name used for the SMTP connection. - * Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find - * one with the same method described above for $Hostname. - * - * @see PHPMailer::$Hostname - * - * @var string - */ - public $Helo = ''; - - /** - * What kind of encryption to use on the SMTP connection. - * Options: '', static::ENCRYPTION_STARTTLS, or static::ENCRYPTION_SMTPS. - * - * @var string - */ - public $SMTPSecure = ''; - - /** - * Whether to enable TLS encryption automatically if a server supports it, - * even if `SMTPSecure` is not set to 'tls'. - * Be aware that in PHP >= 5.6 this requires that the server's certificates are valid. - * - * @var bool - */ - public $SMTPAutoTLS = true; - - /** - * Whether to use SMTP authentication. - * Uses the Username and Password properties. - * - * @see PHPMailer::$Username - * @see PHPMailer::$Password - * - * @var bool - */ - public $SMTPAuth = false; - - /** - * Options array passed to stream_context_create when connecting via SMTP. - * - * @var array - */ - public $SMTPOptions = []; - - /** - * SMTP username. - * - * @var string - */ - public $Username = ''; - - /** - * SMTP password. - * - * @var string - */ - public $Password = ''; - - /** - * SMTP authentication type. Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2. - * If not specified, the first one from that list that the server supports will be selected. - * - * @var string - */ - public $AuthType = ''; - - /** - * SMTP SMTPXClient command attributes - * - * @var array - */ - protected $SMTPXClient = []; - - /** - * An implementation of the PHPMailer OAuthTokenProvider interface. - * - * @var OAuthTokenProvider - */ - protected $oauth; - - /** - * The SMTP server timeout in seconds. - * Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2. - * - * @var int - */ - public $Timeout = 300; - - /** - * Comma separated list of DSN notifications - * 'NEVER' under no circumstances a DSN must be returned to the sender. - * If you use NEVER all other notifications will be ignored. - * 'SUCCESS' will notify you when your mail has arrived at its destination. - * 'FAILURE' will arrive if an error occurred during delivery. - * 'DELAY' will notify you if there is an unusual delay in delivery, but the actual - * delivery's outcome (success or failure) is not yet decided. - * - * @see https://www.rfc-editor.org/rfc/rfc3461.html#section-4.1 for more information about NOTIFY - */ - public $dsn = ''; - - /** - * SMTP class debug output mode. - * Debug output level. - * Options: - * @see SMTP::DEBUG_OFF: No output - * @see SMTP::DEBUG_CLIENT: Client messages - * @see SMTP::DEBUG_SERVER: Client and server messages - * @see SMTP::DEBUG_CONNECTION: As SERVER plus connection status - * @see SMTP::DEBUG_LOWLEVEL: Noisy, low-level data output, rarely needed - * - * @see SMTP::$do_debug - * - * @var int - */ - public $SMTPDebug = 0; - - /** - * How to handle debug output. - * Options: - * * `echo` Output plain-text as-is, appropriate for CLI - * * `html` Output escaped, line breaks converted to `
`, appropriate for browser output - * * `error_log` Output to error log as configured in php.ini - * By default PHPMailer will use `echo` if run from a `cli` or `cli-server` SAPI, `html` otherwise. - * Alternatively, you can provide a callable expecting two params: a message string and the debug level: - * - * ```php - * $mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";}; - * ``` - * - * Alternatively, you can pass in an instance of a PSR-3 compatible logger, though only `debug` - * level output is used: - * - * ```php - * $mail->Debugoutput = new myPsr3Logger; - * ``` - * - * @see SMTP::$Debugoutput - * - * @var string|callable|\Psr\Log\LoggerInterface - */ - public $Debugoutput = 'echo'; - - /** - * Whether to keep the SMTP connection open after each message. - * If this is set to true then the connection will remain open after a send, - * and closing the connection will require an explicit call to smtpClose(). - * It's a good idea to use this if you are sending multiple messages as it reduces overhead. - * See the mailing list example for how to use it. - * - * @var bool - */ - public $SMTPKeepAlive = false; - - /** - * Whether to split multiple to addresses into multiple messages - * or send them all in one message. - * Only supported in `mail` and `sendmail` transports, not in SMTP. - * - * @var bool - * - * @deprecated 6.0.0 PHPMailer isn't a mailing list manager! - */ - public $SingleTo = false; - - /** - * Storage for addresses when SingleTo is enabled. - * - * @var array - */ - protected $SingleToArray = []; - - /** - * Whether to generate VERP addresses on send. - * Only applicable when sending via SMTP. - * - * @see https://en.wikipedia.org/wiki/Variable_envelope_return_path - * @see https://www.postfix.org/VERP_README.html Postfix VERP info - * - * @var bool - */ - public $do_verp = false; - - /** - * Whether to allow sending messages with an empty body. - * - * @var bool - */ - public $AllowEmpty = false; - - /** - * DKIM selector. - * - * @var string - */ - public $DKIM_selector = ''; - - /** - * DKIM Identity. - * Usually the email address used as the source of the email. - * - * @var string - */ - public $DKIM_identity = ''; - - /** - * DKIM passphrase. - * Used if your key is encrypted. - * - * @var string - */ - public $DKIM_passphrase = ''; - - /** - * DKIM signing domain name. - * - * @example 'example.com' - * - * @var string - */ - public $DKIM_domain = ''; - - /** - * DKIM Copy header field values for diagnostic use. - * - * @var bool - */ - public $DKIM_copyHeaderFields = true; - - /** - * DKIM Extra signing headers. - * - * @example ['List-Unsubscribe', 'List-Help'] - * - * @var array - */ - public $DKIM_extraHeaders = []; - - /** - * DKIM private key file path. - * - * @var string - */ - public $DKIM_private = ''; - - /** - * DKIM private key string. - * - * If set, takes precedence over `$DKIM_private`. - * - * @var string - */ - public $DKIM_private_string = ''; - - /** - * Callback Action function name. - * - * The function that handles the result of the send email action. - * It is called out by send() for each email sent. - * - * Value can be any php callable: https://www.php.net/is_callable - * - * Parameters: - * bool $result result of the send action - * array $to email addresses of the recipients - * array $cc cc email addresses - * array $bcc bcc email addresses - * string $subject the subject - * string $body the email body - * string $from email address of sender - * string $extra extra information of possible use - * "smtp_transaction_id' => last smtp transaction id - * - * @var string - */ - public $action_function = ''; - - /** - * What to put in the X-Mailer header. - * Options: An empty string for PHPMailer default, whitespace/null for none, or a string to use. - * - * @var string|null - */ - public $XMailer = ''; - - /** - * Which validator to use by default when validating email addresses. - * May be a callable to inject your own validator, but there are several built-in validators. - * The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option. - * - * If CharSet is UTF8, the validator is left at the default value, - * and you send to addresses that use non-ASCII local parts, then - * PHPMailer automatically changes to the 'eai' validator. - * - * @see PHPMailer::validateAddress() - * - * @var string|callable - */ - public static $validator = 'php'; - - /** - * An instance of the SMTP sender class. - * - * @var SMTP - */ - protected $smtp; - - /** - * The array of 'to' names and addresses. - * - * @var array - */ - protected $to = []; - - /** - * The array of 'cc' names and addresses. - * - * @var array - */ - protected $cc = []; - - /** - * The array of 'bcc' names and addresses. - * - * @var array - */ - protected $bcc = []; - - /** - * The array of reply-to names and addresses. - * - * @var array - */ - protected $ReplyTo = []; - - /** - * An array of all kinds of addresses. - * Includes all of $to, $cc, $bcc. - * - * @see PHPMailer::$to - * @see PHPMailer::$cc - * @see PHPMailer::$bcc - * - * @var array - */ - protected $all_recipients = []; - - /** - * An array of names and addresses queued for validation. - * In send(), valid and non duplicate entries are moved to $all_recipients - * and one of $to, $cc, or $bcc. - * This array is used only for addresses with IDN. - * - * @see PHPMailer::$to - * @see PHPMailer::$cc - * @see PHPMailer::$bcc - * @see PHPMailer::$all_recipients - * - * @var array - */ - protected $RecipientsQueue = []; - - /** - * An array of reply-to names and addresses queued for validation. - * In send(), valid and non duplicate entries are moved to $ReplyTo. - * This array is used only for addresses with IDN. - * - * @see PHPMailer::$ReplyTo - * - * @var array - */ - protected $ReplyToQueue = []; - - /** - * Whether the need for SMTPUTF8 has been detected. Set by - * preSend() if necessary. - * - * @var bool - */ - public $UseSMTPUTF8 = false; - - /** - * The array of attachments. - * - * @var array - */ - protected $attachment = []; - - /** - * The array of custom headers. - * - * @var array - */ - protected $CustomHeader = []; - - /** - * The most recent Message-ID (including angular brackets). - * - * @var string - */ - protected $lastMessageID = ''; - - /** - * The message's MIME type. - * - * @var string - */ - protected $message_type = ''; - - /** - * The array of MIME boundary strings. - * - * @var array - */ - protected $boundary = []; - - /** - * The array of available text strings for the current language. - * - * @var array - */ - protected $language = []; - - /** - * The number of errors encountered. - * - * @var int - */ - protected $error_count = 0; - - /** - * The S/MIME certificate file path. - * - * @var string - */ - protected $sign_cert_file = ''; - - /** - * The S/MIME key file path. - * - * @var string - */ - protected $sign_key_file = ''; - - /** - * The optional S/MIME extra certificates ("CA Chain") file path. - * - * @var string - */ - protected $sign_extracerts_file = ''; - - /** - * The S/MIME password for the key. - * Used only if the key is encrypted. - * - * @var string - */ - protected $sign_key_pass = ''; - - /** - * Whether to throw exceptions for errors. - * - * @var bool - */ - protected $exceptions = false; - - /** - * Unique ID used for message ID and boundaries. - * - * @var string - */ - protected $uniqueid = ''; - - /** - * The PHPMailer Version number. - * - * @var string - */ - const VERSION = '6.10.0'; - - /** - * Error severity: message only, continue processing. - * - * @var int - */ - const STOP_MESSAGE = 0; - - /** - * Error severity: message, likely ok to continue processing. - * - * @var int - */ - const STOP_CONTINUE = 1; - - /** - * Error severity: message, plus full stop, critical error reached. - * - * @var int - */ - const STOP_CRITICAL = 2; - - /** - * The SMTP standard CRLF line break. - * If you want to change line break format, change static::$LE, not this. - */ - const CRLF = "\r\n"; - - /** - * "Folding White Space" a white space string used for line folding. - */ - const FWS = ' '; - - /** - * SMTP RFC standard line ending; Carriage Return, Line Feed. - * - * @var string - */ - protected static $LE = self::CRLF; - - /** - * The maximum line length supported by mail(). - * - * Background: mail() will sometimes corrupt messages - * with headers longer than 65 chars, see #818. - * - * @var int - */ - const MAIL_MAX_LINE_LENGTH = 63; - - /** - * The maximum line length allowed by RFC 2822 section 2.1.1. - * - * @var int - */ - const MAX_LINE_LENGTH = 998; - - /** - * The lower maximum line length allowed by RFC 2822 section 2.1.1. - * This length does NOT include the line break - * 76 means that lines will be 77 or 78 chars depending on whether - * the line break format is LF or CRLF; both are valid. - * - * @var int - */ - const STD_LINE_LENGTH = 76; - - /** - * Constructor. - * - * @param bool $exceptions Should we throw external exceptions? - */ - public function __construct($exceptions = null) - { - if (null !== $exceptions) { - $this->exceptions = (bool) $exceptions; - } - //Pick an appropriate debug output format automatically - $this->Debugoutput = (strpos(PHP_SAPI, 'cli') !== false ? 'echo' : 'html'); - } - - /** - * Destructor. - */ - public function __destruct() - { - //Close any open SMTP connection nicely - $this->smtpClose(); - } - - /** - * Call mail() in a safe_mode-aware fashion. - * Also, unless sendmail_path points to sendmail (or something that - * claims to be sendmail), don't pass params (not a perfect fix, - * but it will do). - * - * @param string $to To - * @param string $subject Subject - * @param string $body Message Body - * @param string $header Additional Header(s) - * @param string|null $params Params - * - * @return bool - */ - private function mailPassthru($to, $subject, $body, $header, $params) - { - //Check overloading of mail function to avoid double-encoding - if ((int)ini_get('mbstring.func_overload') & 1) { - $subject = $this->secureHeader($subject); - } else { - $subject = $this->encodeHeader($this->secureHeader($subject)); - } - //Calling mail() with null params breaks - $this->edebug('Sending with mail()'); - $this->edebug('Sendmail path: ' . ini_get('sendmail_path')); - $this->edebug("Envelope sender: {$this->Sender}"); - $this->edebug("To: {$to}"); - $this->edebug("Subject: {$subject}"); - $this->edebug("Headers: {$header}"); - if (!$this->UseSendmailOptions || null === $params) { - $result = @mail($to, $subject, $body, $header); - } else { - $this->edebug("Additional params: {$params}"); - $result = @mail($to, $subject, $body, $header, $params); - } - $this->edebug('Result: ' . ($result ? 'true' : 'false')); - return $result; - } - - /** - * Output debugging info via a user-defined method. - * Only generates output if debug output is enabled. - * - * @see PHPMailer::$Debugoutput - * @see PHPMailer::$SMTPDebug - * - * @param string $str - */ - protected function edebug($str) - { - if ($this->SMTPDebug <= 0) { - return; - } - //Is this a PSR-3 logger? - if ($this->Debugoutput instanceof \Psr\Log\LoggerInterface) { - $this->Debugoutput->debug(rtrim($str, "\r\n")); - - return; - } - //Avoid clash with built-in function names - if (is_callable($this->Debugoutput) && !in_array($this->Debugoutput, ['error_log', 'html', 'echo'])) { - call_user_func($this->Debugoutput, $str, $this->SMTPDebug); - - return; - } - switch ($this->Debugoutput) { - case 'error_log': - //Don't output, just log - /** @noinspection ForgottenDebugOutputInspection */ - error_log($str); - break; - case 'html': - //Cleans up output a bit for a better looking, HTML-safe output - echo htmlentities( - preg_replace('/[\r\n]+/', '', $str), - ENT_QUOTES, - 'UTF-8' - ), "
\n"; - break; - case 'echo': - default: - //Normalize line breaks - $str = preg_replace('/\r\n|\r/m', "\n", $str); - echo gmdate('Y-m-d H:i:s'), - "\t", - //Trim trailing space - trim( - //Indent for readability, except for trailing break - str_replace( - "\n", - "\n \t ", - trim($str) - ) - ), - "\n"; - } - } - - /** - * Sets message type to HTML or plain. - * - * @param bool $isHtml True for HTML mode - */ - public function isHTML($isHtml = true) - { - if ($isHtml) { - $this->ContentType = static::CONTENT_TYPE_TEXT_HTML; - } else { - $this->ContentType = static::CONTENT_TYPE_PLAINTEXT; - } - } - - /** - * Send messages using SMTP. - */ - public function isSMTP() - { - $this->Mailer = 'smtp'; - } - - /** - * Send messages using PHP's mail() function. - */ - public function isMail() - { - $this->Mailer = 'mail'; - } - - /** - * Send messages using $Sendmail. - */ - public function isSendmail() - { - $ini_sendmail_path = ini_get('sendmail_path'); - - if (false === stripos($ini_sendmail_path, 'sendmail')) { - $this->Sendmail = '/usr/sbin/sendmail'; - } else { - $this->Sendmail = $ini_sendmail_path; - } - $this->Mailer = 'sendmail'; - } - - /** - * Send messages using qmail. - */ - public function isQmail() - { - $ini_sendmail_path = ini_get('sendmail_path'); - - if (false === stripos($ini_sendmail_path, 'qmail')) { - $this->Sendmail = '/var/qmail/bin/qmail-inject'; - } else { - $this->Sendmail = $ini_sendmail_path; - } - $this->Mailer = 'qmail'; - } - - /** - * Add a "To" address. - * - * @param string $address The email address to send to - * @param string $name - * - * @throws Exception - * - * @return bool true on success, false if address already used or invalid in some way - */ - public function addAddress($address, $name = '') - { - return $this->addOrEnqueueAnAddress('to', $address, $name); - } - - /** - * Add a "CC" address. - * - * @param string $address The email address to send to - * @param string $name - * - * @throws Exception - * - * @return bool true on success, false if address already used or invalid in some way - */ - public function addCC($address, $name = '') - { - return $this->addOrEnqueueAnAddress('cc', $address, $name); - } - - /** - * Add a "BCC" address. - * - * @param string $address The email address to send to - * @param string $name - * - * @throws Exception - * - * @return bool true on success, false if address already used or invalid in some way - */ - public function addBCC($address, $name = '') - { - return $this->addOrEnqueueAnAddress('bcc', $address, $name); - } - - /** - * Add a "Reply-To" address. - * - * @param string $address The email address to reply to - * @param string $name - * - * @throws Exception - * - * @return bool true on success, false if address already used or invalid in some way - */ - public function addReplyTo($address, $name = '') - { - return $this->addOrEnqueueAnAddress('Reply-To', $address, $name); - } - - /** - * Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer - * can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still - * be modified after calling this function), addition of such addresses is delayed until send(). - * Addresses that have been added already return false, but do not throw exceptions. - * - * @param string $kind One of 'to', 'cc', 'bcc', or 'Reply-To' - * @param string $address The email address - * @param string $name An optional username associated with the address - * - * @throws Exception - * - * @return bool true on success, false if address already used or invalid in some way - */ - protected function addOrEnqueueAnAddress($kind, $address, $name) - { - $pos = false; - if ($address !== null) { - $address = trim($address); - $pos = strrpos($address, '@'); - } - if (false === $pos) { - //At-sign is missing. - $error_message = sprintf( - '%s (%s): %s', - $this->lang('invalid_address'), - $kind, - $address - ); - $this->setError($error_message); - $this->edebug($error_message); - if ($this->exceptions) { - throw new Exception($error_message); - } - - return false; - } - if ($name !== null && is_string($name)) { - $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim - } else { - $name = ''; - } - $params = [$kind, $address, $name]; - //Enqueue addresses with IDN until we know the PHPMailer::$CharSet. - //Domain is assumed to be whatever is after the last @ symbol in the address - if ($this->has8bitChars(substr($address, ++$pos))) { - if (static::idnSupported()) { - if ('Reply-To' !== $kind) { - if (!array_key_exists($address, $this->RecipientsQueue)) { - $this->RecipientsQueue[$address] = $params; - - return true; - } - } elseif (!array_key_exists($address, $this->ReplyToQueue)) { - $this->ReplyToQueue[$address] = $params; - - return true; - } - } - //We have an 8-bit domain, but we are missing the necessary extensions to support it - //Or we are already sending to this address - return false; - } - - //Immediately add standard addresses without IDN. - return call_user_func_array([$this, 'addAnAddress'], $params); - } - - /** - * Set the boundaries to use for delimiting MIME parts. - * If you override this, ensure you set all 3 boundaries to unique values. - * The default boundaries include a "=_" sequence which cannot occur in quoted-printable bodies, - * as suggested by https://www.rfc-editor.org/rfc/rfc2045#section-6.7 - * - * @return void - */ - public function setBoundaries() - { - $this->uniqueid = $this->generateId(); - $this->boundary[1] = 'b1=_' . $this->uniqueid; - $this->boundary[2] = 'b2=_' . $this->uniqueid; - $this->boundary[3] = 'b3=_' . $this->uniqueid; - } - - /** - * Add an address to one of the recipient arrays or to the ReplyTo array. - * Addresses that have been added already return false, but do not throw exceptions. - * - * @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo' - * @param string $address The email address to send, resp. to reply to - * @param string $name - * - * @throws Exception - * - * @return bool true on success, false if address already used or invalid in some way - */ - protected function addAnAddress($kind, $address, $name = '') - { - if ( - self::$validator === 'php' && - ((bool) preg_match('/[\x80-\xFF]/', $address)) - ) { - //The caller has not altered the validator and is sending to an address - //with UTF-8, so assume that they want UTF-8 support instead of failing - $this->CharSet = self::CHARSET_UTF8; - self::$validator = 'eai'; - } - if (!in_array($kind, ['to', 'cc', 'bcc', 'Reply-To'])) { - $error_message = sprintf( - '%s: %s', - $this->lang('Invalid recipient kind'), - $kind - ); - $this->setError($error_message); - $this->edebug($error_message); - if ($this->exceptions) { - throw new Exception($error_message); - } - - return false; - } - if (!static::validateAddress($address)) { - $error_message = sprintf( - '%s (%s): %s', - $this->lang('invalid_address'), - $kind, - $address - ); - $this->setError($error_message); - $this->edebug($error_message); - if ($this->exceptions) { - throw new Exception($error_message); - } - - return false; - } - if ('Reply-To' !== $kind) { - if (!array_key_exists(strtolower($address), $this->all_recipients)) { - $this->{$kind}[] = [$address, $name]; - $this->all_recipients[strtolower($address)] = true; - - return true; - } - } elseif (!array_key_exists(strtolower($address), $this->ReplyTo)) { - $this->ReplyTo[strtolower($address)] = [$address, $name]; - - return true; - } - - return false; - } - - /** - * Parse and validate a string containing one or more RFC822-style comma-separated email addresses - * of the form "display name
" into an array of name/address pairs. - * Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available. - * Note that quotes in the name part are removed. - * - * @see https://www.andrew.cmu.edu/user/agreen1/testing/mrbs/web/Mail/RFC822.php A more careful implementation - * - * @param string $addrstr The address list string - * @param bool $useimap Whether to use the IMAP extension to parse the list - * @param string $charset The charset to use when decoding the address list string. - * - * @return array - */ - public static function parseAddresses($addrstr, $useimap = true, $charset = self::CHARSET_ISO88591) - { - $addresses = []; - if ($useimap && function_exists('imap_rfc822_parse_adrlist')) { - //Use this built-in parser if it's available - $list = imap_rfc822_parse_adrlist($addrstr, ''); - // Clear any potential IMAP errors to get rid of notices being thrown at end of script. - imap_errors(); - foreach ($list as $address) { - if ( - '.SYNTAX-ERROR.' !== $address->host && - static::validateAddress($address->mailbox . '@' . $address->host) - ) { - //Decode the name part if it's present and encoded - if ( - property_exists($address, 'personal') && - //Check for a Mbstring constant rather than using extension_loaded, which is sometimes disabled - defined('MB_CASE_UPPER') && - preg_match('/^=\?.*\?=$/s', $address->personal) - ) { - $origCharset = mb_internal_encoding(); - mb_internal_encoding($charset); - //Undo any RFC2047-encoded spaces-as-underscores - $address->personal = str_replace('_', '=20', $address->personal); - //Decode the name - $address->personal = mb_decode_mimeheader($address->personal); - mb_internal_encoding($origCharset); - } - - $addresses[] = [ - 'name' => (property_exists($address, 'personal') ? $address->personal : ''), - 'address' => $address->mailbox . '@' . $address->host, - ]; - } - } - } else { - //Use this simpler parser - $list = explode(',', $addrstr); - foreach ($list as $address) { - $address = trim($address); - //Is there a separate name part? - if (strpos($address, '<') === false) { - //No separate name, just use the whole thing - if (static::validateAddress($address)) { - $addresses[] = [ - 'name' => '', - 'address' => $address, - ]; - } - } else { - list($name, $email) = explode('<', $address); - $email = trim(str_replace('>', '', $email)); - $name = trim($name); - if (static::validateAddress($email)) { - //Check for a Mbstring constant rather than using extension_loaded, which is sometimes disabled - //If this name is encoded, decode it - if (defined('MB_CASE_UPPER') && preg_match('/^=\?.*\?=$/s', $name)) { - $origCharset = mb_internal_encoding(); - mb_internal_encoding($charset); - //Undo any RFC2047-encoded spaces-as-underscores - $name = str_replace('_', '=20', $name); - //Decode the name - $name = mb_decode_mimeheader($name); - mb_internal_encoding($origCharset); - } - $addresses[] = [ - //Remove any surrounding quotes and spaces from the name - 'name' => trim($name, '\'" '), - 'address' => $email, - ]; - } - } - } - } - - return $addresses; - } - - /** - * Set the From and FromName properties. - * - * @param string $address - * @param string $name - * @param bool $auto Whether to also set the Sender address, defaults to true - * - * @throws Exception - * - * @return bool - */ - public function setFrom($address, $name = '', $auto = true) - { - $address = trim((string)$address); - $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim - //Don't validate now addresses with IDN. Will be done in send(). - $pos = strrpos($address, '@'); - if ( - (false === $pos) - || ((!$this->has8bitChars(substr($address, ++$pos)) || !static::idnSupported()) - && !static::validateAddress($address)) - ) { - $error_message = sprintf( - '%s (From): %s', - $this->lang('invalid_address'), - $address - ); - $this->setError($error_message); - $this->edebug($error_message); - if ($this->exceptions) { - throw new Exception($error_message); - } - - return false; - } - $this->From = $address; - $this->FromName = $name; - if ($auto && empty($this->Sender)) { - $this->Sender = $address; - } - - return true; - } - - /** - * Return the Message-ID header of the last email. - * Technically this is the value from the last time the headers were created, - * but it's also the message ID of the last sent message except in - * pathological cases. - * - * @return string - */ - public function getLastMessageID() - { - return $this->lastMessageID; - } - - /** - * Check that a string looks like an email address. - * Validation patterns supported: - * * `auto` Pick best pattern automatically; - * * `pcre8` Use the squiloople.com pattern, requires PCRE > 8.0; - * * `pcre` Use old PCRE implementation; - * * `php` Use PHP built-in FILTER_VALIDATE_EMAIL; - * * `html5` Use the pattern given by the HTML5 spec for 'email' type form input elements. - * * `eai` Use a pattern similar to the HTML5 spec for 'email' and to firefox, extended to support EAI (RFC6530). - * * `noregex` Don't use a regex: super fast, really dumb. - * Alternatively you may pass in a callable to inject your own validator, for example: - * - * ```php - * PHPMailer::validateAddress('user@example.com', function($address) { - * return (strpos($address, '@') !== false); - * }); - * ``` - * - * You can also set the PHPMailer::$validator static to a callable, allowing built-in methods to use your validator. - * - * @param string $address The email address to check - * @param string|callable $patternselect Which pattern to use - * - * @return bool - */ - public static function validateAddress($address, $patternselect = null) - { - if (null === $patternselect) { - $patternselect = static::$validator; - } - //Don't allow strings as callables, see SECURITY.md and CVE-2021-3603 - if (is_callable($patternselect) && !is_string($patternselect)) { - return call_user_func($patternselect, $address); - } - //Reject line breaks in addresses; it's valid RFC5322, but not RFC5321 - if (strpos($address, "\n") !== false || strpos($address, "\r") !== false) { - return false; - } - switch ($patternselect) { - case 'pcre': //Kept for BC - case 'pcre8': - /* - * A more complex and more permissive version of the RFC5322 regex on which FILTER_VALIDATE_EMAIL - * is based. - * In addition to the addresses allowed by filter_var, also permits: - * * dotless domains: `a@b` - * * comments: `1234 @ local(blah) .machine .example` - * * quoted elements: `'"test blah"@example.org'` - * * numeric TLDs: `a@b.123` - * * unbracketed IPv4 literals: `a@192.168.0.1` - * * IPv6 literals: 'first.last@[IPv6:a1::]' - * Not all of these will necessarily work for sending! - * - * @copyright 2009-2010 Michael Rushton - * Feel free to use and redistribute this code. But please keep this copyright notice. - */ - return (bool) preg_match( - '/^(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){255,})(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){65,}@)' . - '((?>(?>(?>((?>(?>(?>\x0D\x0A)?[\t ])+|(?>[\t ]*\x0D\x0A)?[\t ]+)?)(\((?>(?2)' . - '(?>[\x01-\x08\x0B\x0C\x0E-\'*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\)))+(?2))|(?2))?)' . - '([!#-\'*+\/-9=?^-~-]+|"(?>(?2)(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\x7F]))*' . - '(?2)")(?>(?1)\.(?1)(?4))*(?1)@(?!(?1)[a-z0-9-]{64,})(?1)(?>([a-z0-9](?>[a-z0-9-]*[a-z0-9])?)' . - '(?>(?1)\.(?!(?1)[a-z0-9-]{64,})(?1)(?5)){0,126}|\[(?:(?>IPv6:(?>([a-f0-9]{1,4})(?>:(?6)){7}' . - '|(?!(?:.*[a-f0-9][:\]]){8,})((?6)(?>:(?6)){0,6})?::(?7)?))|(?>(?>IPv6:(?>(?6)(?>:(?6)){5}:' . - '|(?!(?:.*[a-f0-9]:){6,})(?8)?::(?>((?6)(?>:(?6)){0,4}):)?))?(25[0-5]|2[0-4][0-9]|1[0-9]{2}' . - '|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD', - $address - ); - case 'html5': - /* - * This is the pattern used in the HTML5 spec for validation of 'email' type form input elements. - * - * @see https://html.spec.whatwg.org/#e-mail-state-(type=email) - */ - return (bool) preg_match( - '/^[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}' . - '[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/sD', - $address - ); - case 'eai': - /* - * This is the pattern used in the HTML5 spec for validation of 'email' type - * form input elements (as above), modified to accept Unicode email addresses. - * This is also more lenient than Firefox' html5 spec, in order to make the regex faster. - * 'eai' is an acronym for Email Address Internationalization. - * This validator is selected automatically if you attempt to use recipient addresses - * that contain Unicode characters in the local part. - * - * @see https://html.spec.whatwg.org/#e-mail-state-(type=email) - * @see https://en.wikipedia.org/wiki/International_email - */ - return (bool) preg_match( - '/^[-\p{L}\p{N}\p{M}.!#$%&\'*+\/=?^_`{|}~]+@[\p{L}\p{N}\p{M}](?:[\p{L}\p{N}\p{M}-]{0,61}' . - '[\p{L}\p{N}\p{M}])?(?:\.[\p{L}\p{N}\p{M}]' . - '(?:[-\p{L}\p{N}\p{M}]{0,61}[\p{L}\p{N}\p{M}])?)*$/usD', - $address - ); - case 'php': - default: - return filter_var($address, FILTER_VALIDATE_EMAIL) !== false; - } - } - - /** - * Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the - * `intl` and `mbstring` PHP extensions. - * - * @return bool `true` if required functions for IDN support are present - */ - public static function idnSupported() - { - return function_exists('idn_to_ascii') && function_exists('mb_convert_encoding'); - } - - /** - * Converts IDN in given email address to its ASCII form, also known as punycode, if possible. - * Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet. - * This function silently returns unmodified address if: - * - No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form) - * - Conversion to punycode is impossible (e.g. required PHP functions are not available) - * or fails for any reason (e.g. domain contains characters not allowed in an IDN). - * - * @see PHPMailer::$CharSet - * - * @param string $address The email address to convert - * - * @return string The encoded address in ASCII form - */ - public function punyencodeAddress($address) - { - //Verify we have required functions, CharSet, and at-sign. - $pos = strrpos($address, '@'); - if ( - !empty($this->CharSet) && - false !== $pos && - static::idnSupported() - ) { - $domain = substr($address, ++$pos); - //Verify CharSet string is a valid one, and domain properly encoded in this CharSet. - if ($this->has8bitChars($domain) && @mb_check_encoding($domain, $this->CharSet)) { - //Convert the domain from whatever charset it's in to UTF-8 - $domain = mb_convert_encoding($domain, self::CHARSET_UTF8, $this->CharSet); - //Ignore IDE complaints about this line - method signature changed in PHP 5.4 - $errorcode = 0; - if (defined('INTL_IDNA_VARIANT_UTS46')) { - //Use the current punycode standard (appeared in PHP 7.2) - $punycode = idn_to_ascii( - $domain, - \IDNA_DEFAULT | \IDNA_USE_STD3_RULES | \IDNA_CHECK_BIDI | - \IDNA_CHECK_CONTEXTJ | \IDNA_NONTRANSITIONAL_TO_ASCII, - \INTL_IDNA_VARIANT_UTS46 - ); - } elseif (defined('INTL_IDNA_VARIANT_2003')) { - //Fall back to this old, deprecated/removed encoding - $punycode = idn_to_ascii($domain, $errorcode, \INTL_IDNA_VARIANT_2003); - } else { - //Fall back to a default we don't know about - $punycode = idn_to_ascii($domain, $errorcode); - } - if (false !== $punycode) { - return substr($address, 0, $pos) . $punycode; - } - } - } - - return $address; - } - - /** - * Create a message and send it. - * Uses the sending method specified by $Mailer. - * - * @throws Exception - * - * @return bool false on error - See the ErrorInfo property for details of the error - */ - public function send() - { - try { - if (!$this->preSend()) { - return false; - } - - return $this->postSend(); - } catch (Exception $exc) { - $this->mailHeader = ''; - $this->setError($exc->getMessage()); - if ($this->exceptions) { - throw $exc; - } - - return false; - } - } - - /** - * Prepare a message for sending. - * - * @throws Exception - * - * @return bool - */ - public function preSend() - { - if ( - 'smtp' === $this->Mailer - || ('mail' === $this->Mailer && (\PHP_VERSION_ID >= 80000 || stripos(PHP_OS, 'WIN') === 0)) - ) { - //SMTP mandates RFC-compliant line endings - //and it's also used with mail() on Windows - static::setLE(self::CRLF); - } else { - //Maintain backward compatibility with legacy Linux command line mailers - static::setLE(PHP_EOL); - } - //Check for buggy PHP versions that add a header with an incorrect line break - if ( - 'mail' === $this->Mailer - && ((\PHP_VERSION_ID >= 70000 && \PHP_VERSION_ID < 70017) - || (\PHP_VERSION_ID >= 70100 && \PHP_VERSION_ID < 70103)) - && ini_get('mail.add_x_header') === '1' - && stripos(PHP_OS, 'WIN') === 0 - ) { - trigger_error($this->lang('buggy_php'), E_USER_WARNING); - } - - try { - $this->error_count = 0; //Reset errors - $this->mailHeader = ''; - - //The code below tries to support full use of Unicode, - //while remaining compatible with legacy SMTP servers to - //the greatest degree possible: If the message uses - //Unicode in the local parts of any addresses, it is sent - //using SMTPUTF8. If not, it it sent using - //punycode-encoded domains and plain SMTP. - if ( - static::CHARSET_UTF8 === strtolower($this->CharSet) && - ($this->anyAddressHasUnicodeLocalPart($this->RecipientsQueue) || - $this->anyAddressHasUnicodeLocalPart(array_keys($this->all_recipients)) || - $this->anyAddressHasUnicodeLocalPart($this->ReplyToQueue) || - $this->addressHasUnicodeLocalPart($this->From)) - ) { - $this->UseSMTPUTF8 = true; - } - //Dequeue recipient and Reply-To addresses with IDN - foreach (array_merge($this->RecipientsQueue, $this->ReplyToQueue) as $params) { - if (!$this->UseSMTPUTF8) { - $params[1] = $this->punyencodeAddress($params[1]); - } - call_user_func_array([$this, 'addAnAddress'], $params); - } - if (count($this->to) + count($this->cc) + count($this->bcc) < 1) { - throw new Exception($this->lang('provide_address'), self::STOP_CRITICAL); - } - - //Validate From, Sender, and ConfirmReadingTo addresses - foreach (['From', 'Sender', 'ConfirmReadingTo'] as $address_kind) { - if ($this->{$address_kind} === null) { - $this->{$address_kind} = ''; - continue; - } - $this->{$address_kind} = trim($this->{$address_kind}); - if (empty($this->{$address_kind})) { - continue; - } - $this->{$address_kind} = $this->punyencodeAddress($this->{$address_kind}); - if (!static::validateAddress($this->{$address_kind})) { - $error_message = sprintf( - '%s (%s): %s', - $this->lang('invalid_address'), - $address_kind, - $this->{$address_kind} - ); - $this->setError($error_message); - $this->edebug($error_message); - if ($this->exceptions) { - throw new Exception($error_message); - } - - return false; - } - } - - //Set whether the message is multipart/alternative - if ($this->alternativeExists()) { - $this->ContentType = static::CONTENT_TYPE_MULTIPART_ALTERNATIVE; - } - - $this->setMessageType(); - //Refuse to send an empty message unless we are specifically allowing it - if (!$this->AllowEmpty && empty($this->Body)) { - throw new Exception($this->lang('empty_message'), self::STOP_CRITICAL); - } - - //Trim subject consistently - $this->Subject = trim($this->Subject); - //Create body before headers in case body makes changes to headers (e.g. altering transfer encoding) - $this->MIMEHeader = ''; - $this->MIMEBody = $this->createBody(); - //createBody may have added some headers, so retain them - $tempheaders = $this->MIMEHeader; - $this->MIMEHeader = $this->createHeader(); - $this->MIMEHeader .= $tempheaders; - - //To capture the complete message when using mail(), create - //an extra header list which createHeader() doesn't fold in - if ('mail' === $this->Mailer) { - if (count($this->to) > 0) { - $this->mailHeader .= $this->addrAppend('To', $this->to); - } else { - $this->mailHeader .= $this->headerLine('To', 'undisclosed-recipients:;'); - } - $this->mailHeader .= $this->headerLine( - 'Subject', - $this->encodeHeader($this->secureHeader($this->Subject)) - ); - } - - //Sign with DKIM if enabled - if ( - !empty($this->DKIM_domain) - && !empty($this->DKIM_selector) - && (!empty($this->DKIM_private_string) - || (!empty($this->DKIM_private) - && static::isPermittedPath($this->DKIM_private) - && file_exists($this->DKIM_private) - ) - ) - ) { - $header_dkim = $this->DKIM_Add( - $this->MIMEHeader . $this->mailHeader, - $this->encodeHeader($this->secureHeader($this->Subject)), - $this->MIMEBody - ); - $this->MIMEHeader = static::stripTrailingWSP($this->MIMEHeader) . static::$LE . - static::normalizeBreaks($header_dkim) . static::$LE; - } - - return true; - } catch (Exception $exc) { - $this->setError($exc->getMessage()); - if ($this->exceptions) { - throw $exc; - } - - return false; - } - } - - /** - * Actually send a message via the selected mechanism. - * - * @throws Exception - * - * @return bool - */ - public function postSend() - { - try { - //Choose the mailer and send through it - switch ($this->Mailer) { - case 'sendmail': - case 'qmail': - return $this->sendmailSend($this->MIMEHeader, $this->MIMEBody); - case 'smtp': - return $this->smtpSend($this->MIMEHeader, $this->MIMEBody); - case 'mail': - return $this->mailSend($this->MIMEHeader, $this->MIMEBody); - default: - $sendMethod = $this->Mailer . 'Send'; - if (method_exists($this, $sendMethod)) { - return $this->{$sendMethod}($this->MIMEHeader, $this->MIMEBody); - } - - return $this->mailSend($this->MIMEHeader, $this->MIMEBody); - } - } catch (Exception $exc) { - $this->setError($exc->getMessage()); - $this->edebug($exc->getMessage()); - if ($this->Mailer === 'smtp' && $this->SMTPKeepAlive == true && $this->smtp->connected()) { - $this->smtp->reset(); - } - if ($this->exceptions) { - throw $exc; - } - } - - return false; - } - - /** - * Send mail using the $Sendmail program. - * - * @see PHPMailer::$Sendmail - * - * @param string $header The message headers - * @param string $body The message body - * - * @throws Exception - * - * @return bool - */ - protected function sendmailSend($header, $body) - { - if ($this->Mailer === 'qmail') { - $this->edebug('Sending with qmail'); - } else { - $this->edebug('Sending with sendmail'); - } - $header = static::stripTrailingWSP($header) . static::$LE . static::$LE; - //This sets the SMTP envelope sender which gets turned into a return-path header by the receiver - //A space after `-f` is optional, but there is a long history of its presence - //causing problems, so we don't use one - //Exim docs: https://www.exim.org/exim-html-current/doc/html/spec_html/ch-the_exim_command_line.html - //Sendmail docs: https://www.sendmail.org/~ca/email/man/sendmail.html - //Example problem: https://www.drupal.org/node/1057954 - - //PHP 5.6 workaround - $sendmail_from_value = ini_get('sendmail_from'); - if (empty($this->Sender) && !empty($sendmail_from_value)) { - //PHP config has a sender address we can use - $this->Sender = ini_get('sendmail_from'); - } - //CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped. - if (!empty($this->Sender) && static::validateAddress($this->Sender) && self::isShellSafe($this->Sender)) { - if ($this->Mailer === 'qmail') { - $sendmailFmt = '%s -f%s'; - } else { - $sendmailFmt = '%s -oi -f%s -t'; - } - } else { - //allow sendmail to choose a default envelope sender. It may - //seem preferable to force it to use the From header as with - //SMTP, but that introduces new problems (see - //), and - //it has historically worked this way. - $sendmailFmt = '%s -oi -t'; - } - - $sendmail = sprintf($sendmailFmt, escapeshellcmd($this->Sendmail), $this->Sender); - $this->edebug('Sendmail path: ' . $this->Sendmail); - $this->edebug('Sendmail command: ' . $sendmail); - $this->edebug('Envelope sender: ' . $this->Sender); - $this->edebug("Headers: {$header}"); - - if ($this->SingleTo) { - foreach ($this->SingleToArray as $toAddr) { - $mail = @popen($sendmail, 'w'); - if (!$mail) { - throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); - } - $this->edebug("To: {$toAddr}"); - fwrite($mail, 'To: ' . $toAddr . "\n"); - fwrite($mail, $header); - fwrite($mail, $body); - $result = pclose($mail); - $addrinfo = static::parseAddresses($toAddr, true, $this->CharSet); - $this->doCallback( - ($result === 0), - [[$addrinfo['address'], $addrinfo['name']]], - $this->cc, - $this->bcc, - $this->Subject, - $body, - $this->From, - [] - ); - $this->edebug("Result: " . ($result === 0 ? 'true' : 'false')); - if (0 !== $result) { - throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); - } - } - } else { - $mail = @popen($sendmail, 'w'); - if (!$mail) { - throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); - } - fwrite($mail, $header); - fwrite($mail, $body); - $result = pclose($mail); - $this->doCallback( - ($result === 0), - $this->to, - $this->cc, - $this->bcc, - $this->Subject, - $body, - $this->From, - [] - ); - $this->edebug("Result: " . ($result === 0 ? 'true' : 'false')); - if (0 !== $result) { - throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL); - } - } - - return true; - } - - /** - * Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters. - * Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows. - * - * @see https://github.com/PHPMailer/PHPMailer/issues/924 CVE-2016-10045 bug report - * - * @param string $string The string to be validated - * - * @return bool - */ - protected static function isShellSafe($string) - { - //It's not possible to use shell commands safely (which includes the mail() function) without escapeshellarg, - //but some hosting providers disable it, creating a security problem that we don't want to have to deal with, - //so we don't. - if (!function_exists('escapeshellarg') || !function_exists('escapeshellcmd')) { - return false; - } - - if ( - escapeshellcmd($string) !== $string - || !in_array(escapeshellarg($string), ["'$string'", "\"$string\""]) - ) { - return false; - } - - $length = strlen($string); - - for ($i = 0; $i < $length; ++$i) { - $c = $string[$i]; - - //All other characters have a special meaning in at least one common shell, including = and +. - //Full stop (.) has a special meaning in cmd.exe, but its impact should be negligible here. - //Note that this does permit non-Latin alphanumeric characters based on the current locale. - if (!ctype_alnum($c) && strpos('@_-.', $c) === false) { - return false; - } - } - - return true; - } - - /** - * Check whether a file path is of a permitted type. - * Used to reject URLs and phar files from functions that access local file paths, - * such as addAttachment. - * - * @param string $path A relative or absolute path to a file - * - * @return bool - */ - protected static function isPermittedPath($path) - { - //Matches scheme definition from https://www.rfc-editor.org/rfc/rfc3986#section-3.1 - return !preg_match('#^[a-z][a-z\d+.-]*://#i', $path); - } - - /** - * Check whether a file path is safe, accessible, and readable. - * - * @param string $path A relative or absolute path to a file - * - * @return bool - */ - protected static function fileIsAccessible($path) - { - if (!static::isPermittedPath($path)) { - return false; - } - $readable = is_file($path); - //If not a UNC path (expected to start with \\), check read permission, see #2069 - if (strpos($path, '\\\\') !== 0) { - $readable = $readable && is_readable($path); - } - return $readable; - } - - /** - * Send mail using the PHP mail() function. - * - * @see https://www.php.net/manual/en/book.mail.php - * - * @param string $header The message headers - * @param string $body The message body - * - * @throws Exception - * - * @return bool - */ - protected function mailSend($header, $body) - { - $header = static::stripTrailingWSP($header) . static::$LE . static::$LE; - - $toArr = []; - foreach ($this->to as $toaddr) { - $toArr[] = $this->addrFormat($toaddr); - } - $to = trim(implode(', ', $toArr)); - - //If there are no To-addresses (e.g. when sending only to BCC-addresses) - //the following should be added to get a correct DKIM-signature. - //Compare with $this->preSend() - if ($to === '') { - $to = 'undisclosed-recipients:;'; - } - - $params = null; - //This sets the SMTP envelope sender which gets turned into a return-path header by the receiver - //A space after `-f` is optional, but there is a long history of its presence - //causing problems, so we don't use one - //Exim docs: https://www.exim.org/exim-html-current/doc/html/spec_html/ch-the_exim_command_line.html - //Sendmail docs: https://www.sendmail.org/~ca/email/man/sendmail.html - //Example problem: https://www.drupal.org/node/1057954 - //CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped. - - //PHP 5.6 workaround - $sendmail_from_value = ini_get('sendmail_from'); - if (empty($this->Sender) && !empty($sendmail_from_value)) { - //PHP config has a sender address we can use - $this->Sender = ini_get('sendmail_from'); - } - if (!empty($this->Sender) && static::validateAddress($this->Sender)) { - if (self::isShellSafe($this->Sender)) { - $params = sprintf('-f%s', $this->Sender); - } - $old_from = ini_get('sendmail_from'); - ini_set('sendmail_from', $this->Sender); - } - $result = false; - if ($this->SingleTo && count($toArr) > 1) { - foreach ($toArr as $toAddr) { - $result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params); - $addrinfo = static::parseAddresses($toAddr, true, $this->CharSet); - $this->doCallback( - $result, - [[$addrinfo['address'], $addrinfo['name']]], - $this->cc, - $this->bcc, - $this->Subject, - $body, - $this->From, - [] - ); - } - } else { - $result = $this->mailPassthru($to, $this->Subject, $body, $header, $params); - $this->doCallback($result, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From, []); - } - if (isset($old_from)) { - ini_set('sendmail_from', $old_from); - } - if (!$result) { - throw new Exception($this->lang('instantiate'), self::STOP_CRITICAL); - } - - return true; - } - - /** - * Get an instance to use for SMTP operations. - * Override this function to load your own SMTP implementation, - * or set one with setSMTPInstance. - * - * @return SMTP - */ - public function getSMTPInstance() - { - if (!is_object($this->smtp)) { - $this->smtp = new SMTP(); - } - - return $this->smtp; - } - - /** - * Provide an instance to use for SMTP operations. - * - * @return SMTP - */ - public function setSMTPInstance(SMTP $smtp) - { - $this->smtp = $smtp; - - return $this->smtp; - } - - /** - * Provide SMTP XCLIENT attributes - * - * @param string $name Attribute name - * @param ?string $value Attribute value - * - * @return bool - */ - public function setSMTPXclientAttribute($name, $value) - { - if (!in_array($name, SMTP::$xclient_allowed_attributes)) { - return false; - } - if (isset($this->SMTPXClient[$name]) && $value === null) { - unset($this->SMTPXClient[$name]); - } elseif ($value !== null) { - $this->SMTPXClient[$name] = $value; - } - - return true; - } - - /** - * Get SMTP XCLIENT attributes - * - * @return array - */ - public function getSMTPXclientAttributes() - { - return $this->SMTPXClient; - } - - /** - * Send mail via SMTP. - * Returns false if there is a bad MAIL FROM, RCPT, or DATA input. - * - * @see PHPMailer::setSMTPInstance() to use a different class. - * - * @uses \PHPMailer\PHPMailer\SMTP - * - * @param string $header The message headers - * @param string $body The message body - * - * @throws Exception - * - * @return bool - */ - protected function smtpSend($header, $body) - { - $header = static::stripTrailingWSP($header) . static::$LE . static::$LE; - $bad_rcpt = []; - if (!$this->smtpConnect($this->SMTPOptions)) { - throw new Exception($this->lang('smtp_connect_failed'), self::STOP_CRITICAL); - } - //If we have recipient addresses that need Unicode support, - //but the server doesn't support it, stop here - if ($this->UseSMTPUTF8 && !$this->smtp->getServerExt('SMTPUTF8')) { - throw new Exception($this->lang('no_smtputf8'), self::STOP_CRITICAL); - } - //Sender already validated in preSend() - if ('' === $this->Sender) { - $smtp_from = $this->From; - } else { - $smtp_from = $this->Sender; - } - if (count($this->SMTPXClient)) { - $this->smtp->xclient($this->SMTPXClient); - } - if (!$this->smtp->mail($smtp_from)) { - $this->setError($this->lang('from_failed') . $smtp_from . ' : ' . implode(',', $this->smtp->getError())); - throw new Exception($this->ErrorInfo, self::STOP_CRITICAL); - } - - $callbacks = []; - //Attempt to send to all recipients - foreach ([$this->to, $this->cc, $this->bcc] as $togroup) { - foreach ($togroup as $to) { - if (!$this->smtp->recipient($to[0], $this->dsn)) { - $error = $this->smtp->getError(); - $bad_rcpt[] = ['to' => $to[0], 'error' => $error['detail']]; - $isSent = false; - } else { - $isSent = true; - } - - $callbacks[] = ['issent' => $isSent, 'to' => $to[0], 'name' => $to[1]]; - } - } - - //Only send the DATA command if we have viable recipients - if ((count($this->all_recipients) > count($bad_rcpt)) && !$this->smtp->data($header . $body)) { - throw new Exception($this->lang('data_not_accepted'), self::STOP_CRITICAL); - } - - $smtp_transaction_id = $this->smtp->getLastTransactionID(); - - if ($this->SMTPKeepAlive) { - $this->smtp->reset(); - } else { - $this->smtp->quit(); - $this->smtp->close(); - } - - foreach ($callbacks as $cb) { - $this->doCallback( - $cb['issent'], - [[$cb['to'], $cb['name']]], - [], - [], - $this->Subject, - $body, - $this->From, - ['smtp_transaction_id' => $smtp_transaction_id] - ); - } - - //Create error message for any bad addresses - if (count($bad_rcpt) > 0) { - $errstr = ''; - foreach ($bad_rcpt as $bad) { - $errstr .= $bad['to'] . ': ' . $bad['error']; - } - throw new Exception($this->lang('recipients_failed') . $errstr, self::STOP_CONTINUE); - } - - return true; - } - - /** - * Initiate a connection to an SMTP server. - * Returns false if the operation failed. - * - * @param array $options An array of options compatible with stream_context_create() - * - * @throws Exception - * - * @uses \PHPMailer\PHPMailer\SMTP - * - * @return bool - */ - public function smtpConnect($options = null) - { - if (null === $this->smtp) { - $this->smtp = $this->getSMTPInstance(); - } - - //If no options are provided, use whatever is set in the instance - if (null === $options) { - $options = $this->SMTPOptions; - } - - //Already connected? - if ($this->smtp->connected()) { - return true; - } - - $this->smtp->setTimeout($this->Timeout); - $this->smtp->setDebugLevel($this->SMTPDebug); - $this->smtp->setDebugOutput($this->Debugoutput); - $this->smtp->setVerp($this->do_verp); - $this->smtp->setSMTPUTF8($this->UseSMTPUTF8); - if ($this->Host === null) { - $this->Host = 'localhost'; - } - $hosts = explode(';', $this->Host); - $lastexception = null; - - foreach ($hosts as $hostentry) { - $hostinfo = []; - if ( - !preg_match( - '/^(?:(ssl|tls):\/\/)?(.+?)(?::(\d+))?$/', - trim($hostentry), - $hostinfo - ) - ) { - $this->edebug($this->lang('invalid_hostentry') . ' ' . trim($hostentry)); - //Not a valid host entry - continue; - } - //$hostinfo[1]: optional ssl or tls prefix - //$hostinfo[2]: the hostname - //$hostinfo[3]: optional port number - //The host string prefix can temporarily override the current setting for SMTPSecure - //If it's not specified, the default value is used - - //Check the host name is a valid name or IP address before trying to use it - if (!static::isValidHost($hostinfo[2])) { - $this->edebug($this->lang('invalid_host') . ' ' . $hostinfo[2]); - continue; - } - $prefix = ''; - $secure = $this->SMTPSecure; - $tls = (static::ENCRYPTION_STARTTLS === $this->SMTPSecure); - if ('ssl' === $hostinfo[1] || ('' === $hostinfo[1] && static::ENCRYPTION_SMTPS === $this->SMTPSecure)) { - $prefix = 'ssl://'; - $tls = false; //Can't have SSL and TLS at the same time - $secure = static::ENCRYPTION_SMTPS; - } elseif ('tls' === $hostinfo[1]) { - $tls = true; - //TLS doesn't use a prefix - $secure = static::ENCRYPTION_STARTTLS; - } - //Do we need the OpenSSL extension? - $sslext = defined('OPENSSL_ALGO_SHA256'); - if (static::ENCRYPTION_STARTTLS === $secure || static::ENCRYPTION_SMTPS === $secure) { - //Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled - if (!$sslext) { - throw new Exception($this->lang('extension_missing') . 'openssl', self::STOP_CRITICAL); - } - } - $host = $hostinfo[2]; - $port = $this->Port; - if ( - array_key_exists(3, $hostinfo) && - is_numeric($hostinfo[3]) && - $hostinfo[3] > 0 && - $hostinfo[3] < 65536 - ) { - $port = (int) $hostinfo[3]; - } - if ($this->smtp->connect($prefix . $host, $port, $this->Timeout, $options)) { - try { - if ($this->Helo) { - $hello = $this->Helo; - } else { - $hello = $this->serverHostname(); - } - $this->smtp->hello($hello); - //Automatically enable TLS encryption if: - //* it's not disabled - //* we are not connecting to localhost - //* we have openssl extension - //* we are not already using SSL - //* the server offers STARTTLS - if ( - $this->SMTPAutoTLS && - $this->Host !== 'localhost' && - $sslext && - $secure !== 'ssl' && - $this->smtp->getServerExt('STARTTLS') - ) { - $tls = true; - } - if ($tls) { - if (!$this->smtp->startTLS()) { - $message = $this->getSmtpErrorMessage('connect_host'); - throw new Exception($message); - } - //We must resend EHLO after TLS negotiation - $this->smtp->hello($hello); - } - if ( - $this->SMTPAuth && !$this->smtp->authenticate( - $this->Username, - $this->Password, - $this->AuthType, - $this->oauth - ) - ) { - throw new Exception($this->lang('authenticate')); - } - - return true; - } catch (Exception $exc) { - $lastexception = $exc; - $this->edebug($exc->getMessage()); - //We must have connected, but then failed TLS or Auth, so close connection nicely - $this->smtp->quit(); - } - } - } - //If we get here, all connection attempts have failed, so close connection hard - $this->smtp->close(); - //As we've caught all exceptions, just report whatever the last one was - if ($this->exceptions && null !== $lastexception) { - throw $lastexception; - } - if ($this->exceptions) { - // no exception was thrown, likely $this->smtp->connect() failed - $message = $this->getSmtpErrorMessage('connect_host'); - throw new Exception($message); - } - - return false; - } - - /** - * Close the active SMTP session if one exists. - */ - public function smtpClose() - { - if ((null !== $this->smtp) && $this->smtp->connected()) { - $this->smtp->quit(); - $this->smtp->close(); - } - } - - /** - * Set the language for error messages. - * The default language is English. - * - * @param string $langcode ISO 639-1 2-character language code (e.g. French is "fr") - * Optionally, the language code can be enhanced with a 4-character - * script annotation and/or a 2-character country annotation. - * @param string $lang_path Path to the language file directory, with trailing separator (slash) - * Do not set this from user input! - * - * @return bool Returns true if the requested language was loaded, false otherwise. - */ - public function setLanguage($langcode = 'en', $lang_path = '') - { - //Backwards compatibility for renamed language codes - $renamed_langcodes = [ - 'br' => 'pt_br', - 'cz' => 'cs', - 'dk' => 'da', - 'no' => 'nb', - 'se' => 'sv', - 'rs' => 'sr', - 'tg' => 'tl', - 'am' => 'hy', - ]; - - if (array_key_exists($langcode, $renamed_langcodes)) { - $langcode = $renamed_langcodes[$langcode]; - } - - //Define full set of translatable strings in English - $PHPMAILER_LANG = [ - 'authenticate' => 'SMTP Error: Could not authenticate.', - 'buggy_php' => 'Your version of PHP is affected by a bug that may result in corrupted messages.' . - ' To fix it, switch to sending using SMTP, disable the mail.add_x_header option in' . - ' your php.ini, switch to MacOS or Linux, or upgrade your PHP to version 7.0.17+ or 7.1.3+.', - 'connect_host' => 'SMTP Error: Could not connect to SMTP host.', - 'data_not_accepted' => 'SMTP Error: data not accepted.', - 'empty_message' => 'Message body empty', - 'encoding' => 'Unknown encoding: ', - 'execute' => 'Could not execute: ', - 'extension_missing' => 'Extension missing: ', - 'file_access' => 'Could not access file: ', - 'file_open' => 'File Error: Could not open file: ', - 'from_failed' => 'The following From address failed: ', - 'instantiate' => 'Could not instantiate mail function.', - 'invalid_address' => 'Invalid address: ', - 'invalid_header' => 'Invalid header name or value', - 'invalid_hostentry' => 'Invalid hostentry: ', - 'invalid_host' => 'Invalid host: ', - 'mailer_not_supported' => ' mailer is not supported.', - 'provide_address' => 'You must provide at least one recipient email address.', - 'recipients_failed' => 'SMTP Error: The following recipients failed: ', - 'signing' => 'Signing Error: ', - 'smtp_code' => 'SMTP code: ', - 'smtp_code_ex' => 'Additional SMTP info: ', - 'smtp_connect_failed' => 'SMTP connect() failed.', - 'smtp_detail' => 'Detail: ', - 'smtp_error' => 'SMTP server error: ', - 'variable_set' => 'Cannot set or reset variable: ', - 'no_smtputf8' => 'Server does not support SMTPUTF8 needed to send to Unicode addresses', - ]; - if (empty($lang_path)) { - //Calculate an absolute path so it can work if CWD is not here - $lang_path = dirname(__DIR__) . DIRECTORY_SEPARATOR . 'language' . DIRECTORY_SEPARATOR; - } - - //Validate $langcode - $foundlang = true; - $langcode = strtolower($langcode); - if ( - !preg_match('/^(?P[a-z]{2})(?P