Initial commit
@@ -0,0 +1,20 @@
|
||||
# Ref: https://EditorConfig.org
|
||||
|
||||
# top-most EditorConfig file
|
||||
root = true
|
||||
|
||||
# Unix-style end of lines and a blank line at the end of the file
|
||||
[*]
|
||||
indent_style = tab
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
[*.php]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.{js,json,scss,css,yml,vue}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
@@ -0,0 +1,22 @@
|
||||
# Normalize text sources to LF in the repository and on checkout everywhere.
|
||||
# Critical for a byte-level library: keeps source and fixtures byte-identical
|
||||
# across Windows/macOS/Linux checkouts regardless of core.autocrlf.
|
||||
*.php text eol=lf
|
||||
*.md text eol=lf
|
||||
*.xml text eol=lf
|
||||
*.xml.dist text eol=lf
|
||||
*.json text eol=lf
|
||||
*.toml text eol=lf
|
||||
*.yml text eol=lf
|
||||
*.yaml text eol=lf
|
||||
*.txt text eol=lf
|
||||
Makefile text eol=lf
|
||||
|
||||
# Byte-exact fixtures must never be transformed (CRLF/auto-detection off).
|
||||
test/**/*.bin -text
|
||||
*.png binary
|
||||
*.jpg binary
|
||||
*.gif binary
|
||||
*.pdf binary
|
||||
*.ttf binary
|
||||
*.otf binary
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. ...
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Logs**
|
||||
If applicable, copy the relevant logs to help explain your problem.
|
||||
|
||||
**Environment:**
|
||||
- OS:
|
||||
- PHP version:
|
||||
- Version:
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
@@ -0,0 +1,25 @@
|
||||
# Description
|
||||
|
||||
Please include a summary of the change and include relevant motivation and context.
|
||||
|
||||
...
|
||||
|
||||
|
||||
## Checklist:
|
||||
|
||||
- [ ] The `make buildall` command has been run successfully without any error or warning.
|
||||
- [ ] Any new code line is covered by unit tests and the coverage has not dropped.
|
||||
- [ ] Any new code follows the style guidelines of this project.
|
||||
- [ ] The code changes have been self-reviewed.
|
||||
- [ ] Corresponding changes to the documentation have been made.
|
||||
- [ ] The version has been updated in the VERSION file.
|
||||
|
||||
## Type of change:
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue) → The patch number in the VERSION file has been increased.
|
||||
- [ ] New feature (non-breaking change which adds functionality) → The minor number in the VERSION file has been increased.
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) → The major number in the VERSION file has been increased.
|
||||
- [ ] Automation.
|
||||
- [ ] Documentation.
|
||||
- [ ] Example.
|
||||
- [ ] Testing.
|
||||
@@ -0,0 +1,59 @@
|
||||
name: check
|
||||
|
||||
env:
|
||||
XDEBUG_MODE: coverage
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- 'main'
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
test-php:
|
||||
name: Test on php ${{ matrix.php-version }} and ${{ matrix.os }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
continue-on-error: ${{ matrix.experimental }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
php-version: ["8.2", "8.3", "8.4", "8.5"]
|
||||
experimental: [false]
|
||||
os: [ubuntu-latest]
|
||||
coverage-extension: [pcov]
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- name: Use php ${{ matrix.php-version }}
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php-version }}
|
||||
coverage: ${{ matrix.coverage-extension }}
|
||||
extensions: bcmath, curl, date, gd, hash, imagick, json, mbstring, openssl, pcre, zlib
|
||||
ini-values: display_errors=on, error_reporting=-1, zend.assertions=1
|
||||
- name: List php modules
|
||||
run: php -m
|
||||
- name: List php modules using "no php ini" mode
|
||||
run: php -m -n
|
||||
- name: Cache module
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: ~/.composer/cache/
|
||||
key: composer-cache
|
||||
- name: Install dependencies
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: make deps
|
||||
- name: Run all tests
|
||||
run: make qa
|
||||
- name: Send coverage
|
||||
uses: codecov/codecov-action@v7
|
||||
with:
|
||||
flags: php-${{ matrix.php-version }}-${{ matrix.os }}
|
||||
name: php-${{ matrix.php-version }}-${{ matrix.os }}
|
||||
@@ -0,0 +1,21 @@
|
||||
.phpdoc
|
||||
.phpunit.cache
|
||||
.phpunit.result.cache
|
||||
**/._*
|
||||
**/.#*
|
||||
**/.DS_Store
|
||||
**/.idea
|
||||
**/.vagrant
|
||||
**/*.bak
|
||||
**/*.tmp
|
||||
**/auth.json
|
||||
**/nbproject
|
||||
**/temp.php
|
||||
**/test.php
|
||||
composer.lock
|
||||
ecs.php
|
||||
phpunit.xml
|
||||
PLAN_*
|
||||
rector.php
|
||||
target
|
||||
vendor
|
||||
@@ -0,0 +1 @@
|
||||
* @nicolaasuni
|
||||
@@ -0,0 +1,128 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
@@ -0,0 +1,194 @@
|
||||
# Contributing to tc-lib-pdf-image
|
||||
|
||||
Thank you for your interest in contributing to **tc-lib-pdf-image**.
|
||||
Contributions of all kinds are welcome: bug reports, bug fixes, documentation improvements, new features, and refactors.
|
||||
|
||||
Please take a moment to read this guide before opening an issue or pull request.
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Security Vulnerabilities](#security-vulnerabilities)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Reporting a Bug](#reporting-a-bug)
|
||||
- [Submitting a Bug Fix](#submitting-a-bug-fix)
|
||||
- [Proposing a New Feature](#proposing-a-new-feature)
|
||||
- [Development Workflow](#development-workflow)
|
||||
- [Coding Standards](#coding-standards)
|
||||
- [Testing](#testing)
|
||||
- [Pull Request Guidelines](#pull-request-guidelines)
|
||||
- [Commit Message Guidelines](#commit-message-guidelines)
|
||||
|
||||
---
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating you agree to abide by its terms. Please report unacceptable behaviour to [info@tecnick.com](mailto:info@tecnick.com).
|
||||
|
||||
---
|
||||
|
||||
## Security Vulnerabilities
|
||||
|
||||
**Do not open a public GitHub issue for security vulnerabilities.**
|
||||
Please follow the [Security Policy](SECURITY.md) and report them privately.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Requirements
|
||||
|
||||
- PHP **≥ 8.2**
|
||||
- [Composer](https://getcomposer.org/) v2
|
||||
- `make`, `git`
|
||||
- Optional: `rpmbuild` (RPM packaging), `dpkg-buildpackage` (DEB packaging)
|
||||
|
||||
### Local setup
|
||||
|
||||
```bash
|
||||
git clone https://github.com/tecnickcom/tc-lib-pdf-image.git
|
||||
cd tc-lib-pdf-image
|
||||
make buildall
|
||||
```
|
||||
|
||||
To verify everything is working after a change:
|
||||
|
||||
```bash
|
||||
make qa
|
||||
```
|
||||
|
||||
This runs linting, static analysis, and the full unit-test suite with coverage.
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Bug
|
||||
|
||||
Before opening an issue:
|
||||
|
||||
1. **Check the [Security Policy](SECURITY.md)** — if the bug is a security vulnerability, do not file a public issue.
|
||||
2. **Search [existing issues](https://github.com/tecnickcom/tc-lib-pdf-image/issues)** to avoid duplicates.
|
||||
|
||||
If no existing issue matches, [open a new one](https://github.com/tecnickcom/tc-lib-pdf-image/issues/new) and include:
|
||||
|
||||
- A **clear title and description** of the problem.
|
||||
- The **library version** (`composer show tecnickcom/tc-lib-pdf-image`) and PHP version.
|
||||
- A **minimal, self-contained reproduction** — a short PHP script or a failing PHPUnit test case is ideal.
|
||||
- **Expected vs. actual behaviour** — what you expected to happen and what actually happened.
|
||||
- Any relevant **stack trace or error output**.
|
||||
|
||||
The more precise and reproducible the report, the faster it can be triaged and fixed.
|
||||
|
||||
---
|
||||
|
||||
## Submitting a Bug Fix
|
||||
|
||||
1. [Fork the repository](https://github.com/tecnickcom/tc-lib-pdf-image/fork) and create a branch from `main`:
|
||||
```bash
|
||||
git checkout -b fix/short-description-of-bug
|
||||
```
|
||||
2. Make your changes, following the [Coding Standards](#coding-standards) below.
|
||||
3. Add or update unit tests to cover the changes.
|
||||
4. Run the full quality-assurance suite locally and ensure it passes:
|
||||
```bash
|
||||
make qa
|
||||
```
|
||||
5. Commit your changes (see [Commit Message Guidelines](#commit-message-guidelines)).
|
||||
6. Open a pull request against `main` and fill in the PR template:
|
||||
- Describe the problem and your solution.
|
||||
- Reference the related issue number (e.g. `Fixes #123`).
|
||||
|
||||
---
|
||||
|
||||
## Proposing a New Feature
|
||||
|
||||
Before writing any code:
|
||||
|
||||
1. **Open a Feature Request** on [GitHub Issues](https://github.com/tecnickcom/tc-lib-pdf-image/issues/new) describing the use case and proposed API.
|
||||
2. Wait for feedback from the maintainer. This avoids investing time in a direction that may not be accepted.
|
||||
|
||||
Once the feature is agreed upon, follow the same branch → code → test → PR workflow as for bug fixes, using a branch named `feature/short-description`.
|
||||
|
||||
---
|
||||
|
||||
## Development Workflow
|
||||
|
||||
The `Makefile` exposes all common development tasks:
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `make qa` | Run linting, static analysis, tests, and reports |
|
||||
| `make test` | Run PHPUnit with code coverage |
|
||||
| `make lint` | Check coding standards |
|
||||
| `make format` | Auto-format the code |
|
||||
| `make buildall` | Install dependencies, fix style, run QA, and build packages |
|
||||
| `make clean` | Remove `vendor/` and `target/` directories |
|
||||
| `make server` | Start the built-in PHP development server for the examples |
|
||||
|
||||
Run `make help` to see the full list of available targets.
|
||||
|
||||
---
|
||||
|
||||
## Coding Standards
|
||||
|
||||
- The codebase follows **PSR-12** for formatting.
|
||||
- Run `make format` to auto-format the code.
|
||||
- Run `make lint` to catch remaining issues.
|
||||
- All source files live under `src/`, all tests under `test/`.
|
||||
- Use strict types and explicit visibility on all class members.
|
||||
- Avoid introducing new external dependencies without prior discussion.
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
Tests are written with [PHPUnit](https://phpunit.de/) and live in `test/`.
|
||||
|
||||
```bash
|
||||
# Run the full test suite with coverage
|
||||
make test
|
||||
|
||||
# Run a specific test file
|
||||
XDEBUG_MODE=coverage ./vendor/bin/phpunit test/HTMLTest.php
|
||||
```
|
||||
|
||||
Requirements for contributions:
|
||||
|
||||
- Every bug fix must be accompanied by a regression test that fails before the fix and passes after.
|
||||
- Every new feature must be accompanied by tests that cover both the happy path and edge cases.
|
||||
|
||||
Coverage reports are generated in `target/coverage/`.
|
||||
|
||||
---
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- Target the `main` branch.
|
||||
- Keep PRs focused — one fix or feature per PR.
|
||||
- Ensure `make qa` passes locally before opening the PR.
|
||||
- Do not bump the version number in your PR; that is handled by the maintainer at release time.
|
||||
- Be responsive to review feedback; stale PRs may be closed after an extended period of inactivity.
|
||||
|
||||
---
|
||||
|
||||
## Commit Message Guidelines
|
||||
|
||||
Use concise, imperative-mood commit messages:
|
||||
|
||||
```
|
||||
fix: correct path traversal in font loader
|
||||
feat: add support for XYZ
|
||||
test: add regression test for #123
|
||||
docs: update CONTRIBUTING workflow
|
||||
refactor: extract text measurement into helper
|
||||
```
|
||||
|
||||
Prefix tags: `fix`, `feat`, `test`, `docs`, `refactor`, `chore`, `ci`.
|
||||
Reference issues where relevant: `fix: correct X (closes #42)`.
|
||||
|
||||
---
|
||||
|
||||
## Questions?
|
||||
|
||||
If you have a question that is not covered here, feel free to open a [GitHub Discussion](https://github.com/tecnickcom/tc-lib-pdf-image/discussions) or contact the maintainer at [info@tecnick.com](mailto:info@tecnick.com).
|
||||
@@ -0,0 +1,862 @@
|
||||
**********************************************************************
|
||||
* LICENSE
|
||||
*
|
||||
* SOFTWARE : tc-lib-pdf-image
|
||||
* AUTHOR : Nicola Asuni <info@tecnick.com>
|
||||
* COPYRIGHT : 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
**********************************************************************
|
||||
|
||||
This is free software: you can redistribute it and/or modify it
|
||||
under the terms of the GNU Lesser General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://www.fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser General Public License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://www.fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
||||
**********************************************************************
|
||||
**********************************************************************
|
||||
@@ -0,0 +1,281 @@
|
||||
# makefile
|
||||
#
|
||||
# @since 2015-05-14
|
||||
# @category Library
|
||||
# @package PdfImage
|
||||
# @author Nicola Asuni <info@tecnick.com>
|
||||
# @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
# @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
# @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
#
|
||||
# This file is part of tc-lib-pdf-image software library.
|
||||
# ----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
SHELL=/bin/bash
|
||||
.SHELLFLAGS=-o pipefail -c
|
||||
|
||||
# Project owner
|
||||
OWNER=tecnickcom
|
||||
|
||||
# Project vendor
|
||||
VENDOR=${OWNER}
|
||||
|
||||
# Project name
|
||||
PROJECT=tc-lib-pdf-image
|
||||
|
||||
# Project version
|
||||
VERSION=$(shell cat VERSION)
|
||||
|
||||
# Project release number (packaging build number)
|
||||
RELEASE=$(shell cat RELEASE)
|
||||
|
||||
# Name of RPM or DEB package
|
||||
PKGNAME=php-${OWNER}-${PROJECT}
|
||||
|
||||
# Data dir
|
||||
DATADIR=usr/share
|
||||
|
||||
# PHP home folder
|
||||
PHPHOME=${DATADIR}/php/Com/Tecnick
|
||||
|
||||
# Default installation path for code
|
||||
LIBPATH=${PHPHOME}/Pdf/Image/
|
||||
|
||||
# Path for configuration files (etc/$(PKGNAME)/)
|
||||
CONFIGPATH=
|
||||
|
||||
# Default installation path for documentation
|
||||
DOCPATH=${DATADIR}/doc/$(PKGNAME)/
|
||||
|
||||
# Installation path for the code
|
||||
PATHINSTBIN=$(DESTDIR)/$(LIBPATH)
|
||||
|
||||
# Installation path for the configuration files
|
||||
PATHINSTCFG=$(DESTDIR)/$(CONFIGPATH)
|
||||
|
||||
# Installation path for documentation
|
||||
PATHINSTDOC=$(DESTDIR)/$(DOCPATH)
|
||||
|
||||
# Current directory
|
||||
CURRENTDIR=$(CURDIR)/
|
||||
|
||||
# Target directory
|
||||
TARGETDIR=target
|
||||
|
||||
# RPM Packaging path (where RPMs will be stored)
|
||||
PATHRPMPKG=$(TARGETDIR)/RPM
|
||||
|
||||
# RPM local database path (avoid host rpmdb permission issues)
|
||||
RPMDBPATH=$(PATHRPMPKG)/.rpmdb
|
||||
|
||||
# DEB Packaging path (where DEBs will be stored)
|
||||
PATHDEBPKG=$(TARGETDIR)/DEB
|
||||
|
||||
# BZ2 Packaging path (where BZ2s will be stored)
|
||||
PATHBZ2PKG=$(TARGETDIR)/BZ2
|
||||
|
||||
# sed argument for in-place substitutions
|
||||
SEDINPLACE=-i
|
||||
ifeq ($(shell uname -s),Darwin)
|
||||
SEDINPLACE=-i ''
|
||||
endif
|
||||
|
||||
# Default port number for the example server
|
||||
PORT?=8000
|
||||
|
||||
# PHP binary
|
||||
PHP=$(shell which php)
|
||||
|
||||
# Composer executable (disable APC to as a work-around of a bug)
|
||||
COMPOSER=$(PHP) -d "apc.enable_cli=0" $(shell which composer)
|
||||
|
||||
# phpDocumentor executable file
|
||||
PHPDOC=$(shell which phpDocumentor)
|
||||
|
||||
# Mago version
|
||||
MAGOVERSION=1.43.0
|
||||
|
||||
# --- MAKE TARGETS ---
|
||||
|
||||
# Display general help about this command
|
||||
.PHONY: help
|
||||
help:
|
||||
@echo ""
|
||||
@echo "$(PROJECT) Makefile."
|
||||
@echo "The following commands are available:"
|
||||
@echo ""
|
||||
@awk '/^## /{desc=substr($$0,4)} /^\.PHONY:/{if(NF>1) {target=$$2; if(desc) printf " make %-15s: %s\n",target,desc; desc=""}}' Makefile
|
||||
@echo ""
|
||||
@echo "To test and build everything from scratch, use the shortcut:"
|
||||
@echo " make x"
|
||||
@echo ""
|
||||
|
||||
# alias for help target
|
||||
.PHONY: all
|
||||
all: help
|
||||
|
||||
# Full build and test sequence
|
||||
.PHONY: x
|
||||
x: buildall
|
||||
|
||||
## Full build and test sequence
|
||||
.PHONY: buildall
|
||||
buildall: deps format qa bz2 rpm deb
|
||||
|
||||
# Package the library in a compressed bz2 archive
|
||||
.PHONY: bz2
|
||||
bz2:
|
||||
rm -rf "$(PATHBZ2PKG)"
|
||||
make install DESTDIR="$(PATHBZ2PKG)"
|
||||
tar -jcvf "$(PATHBZ2PKG)/$(PKGNAME)-$(VERSION)-$(RELEASE).tbz2" -C "$(PATHBZ2PKG)" "$(DATADIR)"
|
||||
|
||||
## Delete the vendor and target directories
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -rf ./vendor "$(TARGETDIR)"
|
||||
|
||||
## Build a DEB package for Debian-like Linux distributions
|
||||
.PHONY: deb
|
||||
deb:
|
||||
rm -rf "$(PATHDEBPKG)"
|
||||
$(MAKE) install DESTDIR="$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)"
|
||||
rm -f "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/$(DOCPATH)LICENSE"
|
||||
tar -zcvf "$(PATHDEBPKG)/$(PKGNAME)_$(VERSION).orig.tar.gz" -C "$(PATHDEBPKG)/" "$(PKGNAME)-$(VERSION)"
|
||||
cp -rf ./resources/debian "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian"
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -name '*.bak' -delete
|
||||
chmod 755 "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/rules"
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#DATE#~/`date -R`/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#VENDOR#~/$(VENDOR)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#PROJECT#~/$(PROJECT)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#PKGNAME#~/$(PKGNAME)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#VERSION#~/$(VERSION)/" {} \;
|
||||
find "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/" -type f -exec sed $(SEDINPLACE) "s/~#RELEASE#~/$(RELEASE)/" {} \;
|
||||
echo "$(LIBPATH)" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(LIBPATH)* $(LIBPATH)" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
echo "$(DOCPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(DOCPATH)* $(DOCPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
ifneq ($(strip $(CONFIGPATH)),)
|
||||
echo "$(CONFIGPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).dirs"
|
||||
echo "$(CONFIGPATH)* $(CONFIGPATH)" >> "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/install"
|
||||
endif
|
||||
echo "new-package-should-close-itp-bug" > "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)/debian/$(PKGNAME).lintian-overrides"
|
||||
cd "$(PATHDEBPKG)/$(PKGNAME)-$(VERSION)" && debuild -us -uc
|
||||
|
||||
## Clean all artifacts and download all dependencies
|
||||
.PHONY: deps
|
||||
deps: ensuretarget
|
||||
rm -rf ./vendor/*
|
||||
($(COMPOSER) install -vvv --no-interaction)
|
||||
curl --proto '=https' --tlsv1.2 --silent --show-error --fail --location https://carthage.software/mago.sh | bash -s -- --install-dir=./vendor/bin --version=$(MAGOVERSION)
|
||||
|
||||
## Generate source code documentation
|
||||
.PHONY: doc
|
||||
doc: ensuretarget
|
||||
rm -rf "$(TARGETDIR)/doc"
|
||||
$(PHPDOC) -d ./src -t "$(TARGETDIR)/doc/"
|
||||
|
||||
## Create missing target directories for test and build artifacts
|
||||
.PHONY: ensuretarget
|
||||
ensuretarget:
|
||||
mkdir -p "$(TARGETDIR)/test"
|
||||
mkdir -p "$(TARGETDIR)/report"
|
||||
mkdir -p "$(TARGETDIR)/doc"
|
||||
|
||||
## Install this application
|
||||
.PHONY: install
|
||||
install: uninstall
|
||||
mkdir -p "$(PATHINSTBIN)"
|
||||
cp -rf ./src/* "$(PATHINSTBIN)"
|
||||
cp -f ./resources/autoload.php "$(PATHINSTBIN)"
|
||||
find "$(PATHINSTBIN)" -type d -exec chmod 755 {} \;
|
||||
find "$(PATHINSTBIN)" -type f -exec chmod 644 {} \;
|
||||
mkdir -p "$(PATHINSTDOC)"
|
||||
cp -f ./LICENSE "$(PATHINSTDOC)"
|
||||
cp -f ./README.md "$(PATHINSTDOC)"
|
||||
cp -f ./VERSION "$(PATHINSTDOC)"
|
||||
cp -f ./RELEASE "$(PATHINSTDOC)"
|
||||
chmod -R 644 "$(PATHINSTDOC)"*
|
||||
ifneq ($(strip $(CONFIGPATH)),)
|
||||
mkdir -p "$(PATHINSTCFG)"
|
||||
touch -c "$(PATHINSTCFG)"*
|
||||
cp -ru "./resources/${CONFIGPATH}"* "$(PATHINSTCFG)"
|
||||
find "$(PATHINSTCFG)" -type d -exec chmod 755 {} \;
|
||||
find "$(PATHINSTCFG)" -type f -exec chmod 644 {} \;
|
||||
endif
|
||||
|
||||
## Format the source code
|
||||
.PHONY: format
|
||||
format:
|
||||
./vendor/bin/mago fmt src test
|
||||
|
||||
## Analyze and Lint the source code
|
||||
.PHONY: lint
|
||||
lint:
|
||||
./vendor/bin/mago --config ./mago.src.toml analyze src
|
||||
./vendor/bin/mago --config ./mago.test.toml analyze test
|
||||
./vendor/bin/mago --config ./mago.src.toml lint src
|
||||
./vendor/bin/mago --config ./mago.test.toml lint test
|
||||
|
||||
## Run all tests and reports
|
||||
.PHONY: qa
|
||||
qa: ensuretarget lint test report
|
||||
|
||||
## Generate various reports
|
||||
.PHONY: report
|
||||
report: ensuretarget
|
||||
./vendor/bin/pdepend --jdepend-xml="$(TARGETDIR)/report/dependencies.xml" --summary-xml="$(TARGETDIR)/report/metrics.xml" --jdepend-chart="$(TARGETDIR)/report/dependecies.svg" --overview-pyramid="$(TARGETDIR)/report/overview-pyramid.svg" --ignore=vendor ./src
|
||||
#./vendor/bartlett/php-compatinfo/bin/phpcompatinfo --no-ansi analyser:run src/ > $(TARGETDIR)/report/phpcompatinfo.txt
|
||||
|
||||
## Build the RPM package for RedHat-like Linux distributions
|
||||
.PHONY: rpm
|
||||
rpm:
|
||||
@test $(words $(CURDIR)) -eq 1 || { echo "ERROR: rpmbuild does not support spaces in the project path: $(CURDIR)"; exit 1; }
|
||||
rm -rf "$(PATHRPMPKG)"
|
||||
mkdir -p "$(RPMDBPATH)" "$(PATHRPMPKG)/tmp"
|
||||
rpmbuild \
|
||||
--define "_topdir $(CURRENTDIR)$(PATHRPMPKG)" \
|
||||
--define "_dbpath $(CURRENTDIR)$(RPMDBPATH)" \
|
||||
--define "_tmppath $(CURRENTDIR)$(PATHRPMPKG)/tmp" \
|
||||
--define "_vendor $(VENDOR)" \
|
||||
--define "_owner $(OWNER)" \
|
||||
--define "_project $(PROJECT)" \
|
||||
--define "_package $(PKGNAME)" \
|
||||
--define "_version $(VERSION)" \
|
||||
--define "_release $(RELEASE)" \
|
||||
--define "_current_directory $(CURRENTDIR)" \
|
||||
--define "_libpath /$(LIBPATH)" \
|
||||
--define "_docpath /$(DOCPATH)" \
|
||||
--define "_configpath /$(CONFIGPATH)" \
|
||||
-bb resources/rpm/rpm.spec
|
||||
|
||||
## Start the development server
|
||||
.PHONY: server
|
||||
server:
|
||||
$(PHP) -t example -S localhost:$(PORT)
|
||||
|
||||
## Tag this GIT version
|
||||
.PHONY: tag
|
||||
tag:
|
||||
git checkout main && \
|
||||
git tag -a ${VERSION} -m "Release ${VERSION}" && \
|
||||
git push origin --tags && \
|
||||
git pull
|
||||
|
||||
## Run unit tests
|
||||
.PHONY: test
|
||||
test:
|
||||
cp phpunit.xml.dist phpunit.xml
|
||||
#./vendor/bin/phpunit --migrate-configuration || true
|
||||
XDEBUG_MODE=coverage ./vendor/bin/phpunit --stderr test
|
||||
|
||||
## Remove all installed files
|
||||
.PHONY: uninstall
|
||||
uninstall:
|
||||
rm -rf "$(PATHINSTBIN)"
|
||||
rm -rf "$(PATHINSTDOC)"
|
||||
|
||||
## Increase the version patch number
|
||||
.PHONY: versionup
|
||||
versionup:
|
||||
echo ${VERSION} | gawk -F. '{printf("%d.%d.%d\n",$$1,$$2,(($$3+1)));}' > VERSION
|
||||
|
||||
@@ -0,0 +1,199 @@
|
||||
# tc-lib-pdf-image
|
||||
|
||||
> Image import and embedding utilities for PDF streams.
|
||||
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-pdf-image)
|
||||
[](https://github.com/tecnickcom/tc-lib-pdf-image/actions/workflows/check.yml)
|
||||
[](https://codecov.io/gh/tecnickcom/tc-lib-pdf-image)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-pdf-image)
|
||||
[](https://packagist.org/packages/tecnickcom/tc-lib-pdf-image)
|
||||
|
||||
[](https://github.com/sponsors/tecnickcom)
|
||||
|
||||
> 💖 Part of the [tc-lib-pdf / TCPDF](https://github.com/tecnickcom/tc-lib-pdf) ecosystem (100M+ installs). [Sponsor its maintenance →](https://github.com/sponsors/tecnickcom)
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
`tc-lib-pdf-image` handles image import, conversion, and output structures used by PDF generators.
|
||||
|
||||
The library isolates image pipeline concerns such as format handling, normalization, and object generation for PDF embedding. Keeping this logic separate helps reduce complexity in document-level code and makes image behavior easier to validate and maintain.
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Namespace** | `\Com\Tecnick\Pdf\Image` |
|
||||
| **Author** | Nicola Asuni <info@tecnick.com> |
|
||||
| **License** | [GNU LGPL v3](https://www.gnu.org/copyleft/lesser.html) - see [LICENSE](LICENSE) |
|
||||
| **API docs** | <https://tcpdf.org/docs/srcdoc/tc-lib-pdf-image> |
|
||||
| **Packagist** | <https://packagist.org/packages/tecnickcom/tc-lib-pdf-image> |
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
### Import Support
|
||||
- Native handling for PNG and JPEG
|
||||
- Additional format handling through GD processing paths
|
||||
- Transparency and palette-related metadata handling
|
||||
|
||||
### PDF Integration
|
||||
- Image caching keys for repeated assets
|
||||
- Alternate image support for print/display contexts
|
||||
- Output helpers for embedding image objects
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
- PHP 8.2 or later
|
||||
- Extensions: `gd`, `zlib`
|
||||
- Composer
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
composer require tecnickcom/tc-lib-pdf-image
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
require_once __DIR__ . '/vendor/autoload.php';
|
||||
|
||||
$encrypt = new \Com\Tecnick\Pdf\Encrypt\Encrypt();
|
||||
$fileHelper = new \Com\Tecnick\File\File();
|
||||
|
||||
$img = new \Com\Tecnick\Pdf\Image\Import(
|
||||
kunit: 1.0,
|
||||
encrypt: $encrypt,
|
||||
fileHelper: $fileHelper,
|
||||
);
|
||||
$imageId = $img->add('/path/to/image.png');
|
||||
|
||||
var_dump($imageId);
|
||||
```
|
||||
|
||||
You can configure the `\Com\Tecnick\File\File` helper with host/path allowlists:
|
||||
|
||||
```php
|
||||
$fileHelper = new \Com\Tecnick\File\File(
|
||||
allowedHosts: ['example.com', 'cdn.example.com'],
|
||||
allowedPaths: ['/srv/app/images', __DIR__ . '/images'],
|
||||
);
|
||||
```
|
||||
|
||||
For full file-loading options, see the `tc-lib-file` documentation:
|
||||
<https://tcpdf.org/docs/srcdoc/tc-lib-file>
|
||||
|
||||
---
|
||||
|
||||
## Persistent image cache
|
||||
|
||||
Processing an image (decode, resize, re-encode, alpha-mask extraction) is the
|
||||
expensive part of importing. By default the result is cached **in memory for the
|
||||
lifetime of the `Import` instance**, so reusing the same image within one
|
||||
document is cheap.
|
||||
|
||||
To reuse processed images **across documents and processes** (e.g. brand assets
|
||||
reused on thousands of PDFs), inject an optional external cache. The library
|
||||
ships only the contract — `\Com\Tecnick\Pdf\Image\ImageCacheInterface` — and you
|
||||
provide the backend (filesystem, APCu, Redis, a PSR-16 cache, ...):
|
||||
|
||||
```php
|
||||
interface ImageCacheInterface
|
||||
{
|
||||
/** @return array|null Stored image data, or null on a miss. */
|
||||
public function get(string $key): ?array;
|
||||
|
||||
public function set(string $key, array $data): void;
|
||||
}
|
||||
```
|
||||
|
||||
Pass an implementation to the constructor (default `null` keeps the current
|
||||
in-memory-only behaviour):
|
||||
|
||||
```php
|
||||
$img = new \Com\Tecnick\Pdf\Image\Import(
|
||||
kunit: 1.0,
|
||||
encrypt: $encrypt,
|
||||
fileHelper: $fileHelper,
|
||||
imageCache: $myCache, // any ImageCacheInterface implementation
|
||||
);
|
||||
```
|
||||
|
||||
On a miss the processed data is written through to the cache; on a later run a
|
||||
hit short-circuits all processing. For local files the persistent key folds in
|
||||
the file modification time and size, so editing an image in place invalidates
|
||||
its stale entry automatically.
|
||||
|
||||
> **Security:** the cache store is a trust boundary. Stored bytes (image data,
|
||||
> palette, ICC profile) are embedded verbatim into generated PDFs, so use a
|
||||
> store only your application can write to. If your implementation serializes
|
||||
> entries, deserialize with object restoration disabled, e.g.
|
||||
> `unserialize($s, ['allowed_classes' => false])`.
|
||||
|
||||
A minimal example implementation:
|
||||
|
||||
```php
|
||||
use Com\Tecnick\Pdf\Image\ImageCacheInterface;
|
||||
|
||||
final class FilesystemImageCache implements ImageCacheInterface
|
||||
{
|
||||
public function __construct(private readonly string $dir) {}
|
||||
|
||||
public function get(string $key): ?array
|
||||
{
|
||||
$file = $this->dir . '/' . hash('xxh128', $key) . '.cache';
|
||||
if (!is_file($file)) {
|
||||
return null;
|
||||
}
|
||||
$data = unserialize((string) file_get_contents($file), ['allowed_classes' => false]);
|
||||
return is_array($data) ? $data : null;
|
||||
}
|
||||
|
||||
public function set(string $key, array $data): void
|
||||
{
|
||||
$file = $this->dir . '/' . hash('xxh128', $key) . '.cache';
|
||||
file_put_contents($file, serialize($data), LOCK_EX);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
make deps
|
||||
make help
|
||||
make qa
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Packaging
|
||||
|
||||
```bash
|
||||
make rpm
|
||||
make deb
|
||||
```
|
||||
|
||||
For system packages, bootstrap with:
|
||||
|
||||
```php
|
||||
require_once '/usr/share/php/Com/Tecnick/Pdf/Image/autoload.php';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome. Please review [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and [SECURITY.md](SECURITY.md).
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
1
|
||||
@@ -0,0 +1,62 @@
|
||||
# Security Policy
|
||||
|
||||
This document describes the security policy for **tc-lib-pdf-image**.
|
||||
|
||||
---
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Security fixes are applied only to the **latest stable release** on the `main` branch.
|
||||
|
||||
We strongly recommend always running the latest release.
|
||||
|
||||
---
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
**Please do not open a public GitHub issue for security vulnerabilities.**
|
||||
|
||||
If you discover a security vulnerability — or suspect one — follow responsible disclosure:
|
||||
|
||||
1. **Email** the maintainer directly at **[info@tecnick.com](mailto:info@tecnick.com)** with the subject line:
|
||||
`[SECURITY] tc-lib-pdf-image – <brief description>`
|
||||
2. Include as much detail as possible (see [What to include](#what-to-include) below).
|
||||
3. You will receive an acknowledgement as soon as possible.
|
||||
4. We will work on a fix or mitigation as promptly as the complexity of the issue allows.
|
||||
|
||||
If you do not receive a timely response, please follow up by replying to the same email thread.
|
||||
|
||||
---
|
||||
|
||||
## What to Include
|
||||
|
||||
A high-quality report helps us triage and fix issues faster. Please provide:
|
||||
|
||||
- **Description** — a clear summary of the vulnerability and its potential impact.
|
||||
- **Affected component** — which class, method, or feature is involved (e.g., `HTML::render()`, font loading, image processing).
|
||||
- **Steps to reproduce** — a minimal, self-contained PHP script or unit test that demonstrates the issue.
|
||||
- **Expected vs. actual behaviour** — what you expected to happen and what actually happened.
|
||||
- **Environment** — PHP version, OS, library version (output of `composer show tecnickcom/tc-lib-pdf-image`).
|
||||
- **CVE / CWE reference** (optional) — if you have already identified a relevant classification.
|
||||
- **Suggested fix** (optional) — a patch or proposed mitigation if you have one.
|
||||
|
||||
---
|
||||
|
||||
## Security Best Practices for Integrators
|
||||
|
||||
Integrators are responsible for sanitising input **before** passing it to the library. We recommend:
|
||||
|
||||
- **Validate and sanitise all user-supplied data**. Use a dedicated sanitiser when accepting content from end users.
|
||||
- **Keep dependencies up to date.** Run `composer update` regularly and monitor advisories via [Packagist Security Advisories](https://packagist.org/packages/tecnickcom/tc-lib-pdf-image) or tools such as `composer audit`.
|
||||
- **Pin versions in production.** Use `composer.lock` and review changes on every update.
|
||||
|
||||
---
|
||||
|
||||
## Contact
|
||||
|
||||
| Channel | Details |
|
||||
|---------|---------|
|
||||
| Security email | [info@tecnick.com](mailto:info@tecnick.com) |
|
||||
| Project website | <https://tcpdf.org> |
|
||||
| GitHub repository | <https://github.com/tecnickcom/tc-lib-pdf-image> |
|
||||
| Packagist | <https://packagist.org/packages/tecnickcom/tc-lib-pdf-image> |
|
||||
@@ -0,0 +1 @@
|
||||
3.12.2
|
||||
@@ -0,0 +1,67 @@
|
||||
{
|
||||
"name": "tecnickcom/tc-lib-pdf-image",
|
||||
"description": "PHP library containing PDF Image methods",
|
||||
"type": "library",
|
||||
"homepage": "https://tcpdf.org",
|
||||
"license": "LGPL-3.0-or-later",
|
||||
"keywords": [
|
||||
"tc-lib-pdf-image",
|
||||
"PDF",
|
||||
"image",
|
||||
"PNG",
|
||||
"JPEG",
|
||||
"JPG"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Nicola Asuni",
|
||||
"email": "info@tecnick.com",
|
||||
"role": "lead"
|
||||
}
|
||||
],
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/tecnickcom"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=8.2",
|
||||
"ext-gd": "*",
|
||||
"ext-zlib": "*",
|
||||
"tecnickcom/tc-lib-file": "^3.7",
|
||||
"tecnickcom/tc-lib-color": "^2.13",
|
||||
"tecnickcom/tc-lib-pdf-encrypt": "^2.9"
|
||||
},
|
||||
"minimum-stability": "stable",
|
||||
"prefer-stable": true,
|
||||
"require-dev": {
|
||||
"pdepend/pdepend": "^2.16",
|
||||
"phpunit/phpunit": "^11.5 || ^12.5 || ^13.2"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Com\\Tecnick\\Pdf\\Image\\": "src"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Test\\": "test"
|
||||
}
|
||||
},
|
||||
"support": {
|
||||
"issues": "https://github.com/tecnickcom/tc-lib-pdf-image/issues",
|
||||
"source": "https://github.com/tecnickcom/tc-lib-pdf-image"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "@php -d xdebug.mode=coverage vendor/bin/phpunit --stderr test",
|
||||
"analyse": ["@analyse:src", "@analyse:test"],
|
||||
"analyse:src": "mago --config mago.src.toml analyze src",
|
||||
"analyse:test": "mago --config mago.test.toml analyze test",
|
||||
"cs-check": ["@cs-check:src", "@cs-check:test"],
|
||||
"cs-check:src": "mago --config mago.src.toml lint src",
|
||||
"cs-check:test": "mago --config mago.test.toml lint test",
|
||||
"cs-fix": "mago fmt src test",
|
||||
"qa": ["@cs-check", "@analyse", "@test"]
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
#:schema https://mago.carthage.software/1.43.0/schema.json
|
||||
version = "1"
|
||||
php-version = "8.2.0"
|
||||
|
||||
[source]
|
||||
workspace = "."
|
||||
paths = ["src"]
|
||||
includes = ["vendor"]
|
||||
excludes = []
|
||||
|
||||
[source.glob]
|
||||
literal-separator = true
|
||||
|
||||
[formatter]
|
||||
print-width = 120
|
||||
tab-width = 4
|
||||
use-tabs = false
|
||||
|
||||
[linter]
|
||||
integrations = []
|
||||
|
||||
[linter.rules]
|
||||
ambiguous-function-call = { enabled = false }
|
||||
literal-named-argument = { enabled = false }
|
||||
cyclomatic-complexity = { enabled = false }
|
||||
excessive-parameter-list = { enabled = true, threshold = 7 }
|
||||
halstead = { enabled = true, difficulty-threshold = 17.0, effort-threshold = 11000.0 }
|
||||
identity-comparison = { enabled = true }
|
||||
kan-defect = { enabled = false }
|
||||
no-boolean-flag-parameter = { enabled = false }
|
||||
no-else-clause = { enabled = false }
|
||||
no-empty = { enabled = true }
|
||||
too-many-methods = { enabled = false }
|
||||
no-isset = { enabled = true, allow-array-checks = true }
|
||||
|
||||
[analyzer]
|
||||
plugins = []
|
||||
find-unused-definitions = true
|
||||
find-unused-expressions = true
|
||||
analyze-dead-code = true
|
||||
memoize-properties = true
|
||||
check-throws = true
|
||||
unchecked-exceptions = [
|
||||
"Error",
|
||||
"LogicException",
|
||||
"ReflectionException",
|
||||
]
|
||||
unchecked-exception-classes = []
|
||||
check-missing-override = true
|
||||
find-unused-parameters = true
|
||||
strict-list-index-checks = true
|
||||
strict-array-index-existence = true
|
||||
allow-array-truthy-operand = false
|
||||
no-boolean-literal-comparison = true
|
||||
check-missing-type-hints = true
|
||||
register-super-globals = true
|
||||
@@ -0,0 +1,66 @@
|
||||
#:schema https://mago.carthage.software/1.43.0/schema.json
|
||||
version = "1"
|
||||
php-version = "8.2.0"
|
||||
|
||||
[source]
|
||||
workspace = "."
|
||||
paths = ["src", "test"]
|
||||
includes = ["vendor"]
|
||||
excludes = []
|
||||
|
||||
[source.glob]
|
||||
literal-separator = true
|
||||
|
||||
[formatter]
|
||||
print-width = 120
|
||||
tab-width = 4
|
||||
use-tabs = false
|
||||
|
||||
[linter]
|
||||
integrations = ["phpunit"]
|
||||
|
||||
[linter.rules]
|
||||
ambiguous-function-call = { enabled = false }
|
||||
literal-named-argument = { enabled = false }
|
||||
assertion-style = { enabled = false }
|
||||
cyclomatic-complexity = { enabled = false }
|
||||
excessive-parameter-list = { enabled = false }
|
||||
halstead = { enabled = false, effort-threshold = 7000 }
|
||||
identity-comparison = { enabled = false }
|
||||
kan-defect = { enabled = false }
|
||||
no-boolean-flag-parameter = { enabled = false }
|
||||
no-else-clause = { enabled = false }
|
||||
no-empty = { enabled = false }
|
||||
no-empty-catch-clause = { enabled = false }
|
||||
no-isset = { enabled = false }
|
||||
readable-literal = { enabled = false }
|
||||
str-contains = { enabled = false }
|
||||
strict-assertions = { enabled = false }
|
||||
strict-behavior = { enabled = false }
|
||||
strict-types = { enabled = false }
|
||||
too-many-methods = { enabled = false }
|
||||
|
||||
[analyzer]
|
||||
plugins = []
|
||||
find-unused-definitions = true
|
||||
find-unused-expressions = true
|
||||
analyze-dead-code = true
|
||||
memoize-properties = true
|
||||
check-throws = true
|
||||
unchecked-exceptions = [
|
||||
"Error",
|
||||
"LogicException",
|
||||
"ReflectionException",
|
||||
"PHPUnit\\Framework\\Exception",
|
||||
"PHPUnit\\Framework\\ExpectationFailedException",
|
||||
"PHPUnit\\Framework\\UnknownClassOrInterfaceException",
|
||||
]
|
||||
unchecked-exception-classes = []
|
||||
check-missing-override = true
|
||||
find-unused-parameters = true
|
||||
strict-list-index-checks = true
|
||||
strict-array-index-existence = true
|
||||
allow-array-truthy-operand = false
|
||||
no-boolean-literal-comparison = true
|
||||
check-missing-type-hints = true
|
||||
register-super-globals = true
|
||||
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"source-providers": [
|
||||
{
|
||||
"in": "src as source",
|
||||
"exclude": "vendor",
|
||||
"name": "/\\.(php)$/"
|
||||
}
|
||||
],
|
||||
"plugins": [
|
||||
],
|
||||
"analysers": [
|
||||
],
|
||||
"services": [
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit backupGlobals="false"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
displayDetailsOnTestsThatTriggerDeprecations="true"
|
||||
displayDetailsOnTestsThatTriggerErrors="true"
|
||||
displayDetailsOnTestsThatTriggerNotices="true"
|
||||
displayDetailsOnTestsThatTriggerWarnings="true"
|
||||
displayDetailsOnPhpunitDeprecations="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false">
|
||||
<testsuites>
|
||||
<testsuite name="tc-lib-pdf-image Test Suite">
|
||||
<directory>./test</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">src</directory>
|
||||
</include>
|
||||
</source>
|
||||
<coverage>
|
||||
<report>
|
||||
<clover outputFile="target/coverage/coverage.xml"/>
|
||||
<html outputDirectory="target/coverage" lowUpperBound="50" highLowerBound="90"/>
|
||||
</report>
|
||||
</coverage>
|
||||
<logging>
|
||||
<junit outputFile="target/logs/junit.xml"/>
|
||||
</logging>
|
||||
</phpunit>
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
/**
|
||||
* autoload.php
|
||||
*
|
||||
* Autoloader for Tecnick.com libraries
|
||||
*
|
||||
* @since 2015-03-04
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
\spl_autoload_register(
|
||||
function ($class) {
|
||||
$prefix = 'Com\\Tecnick\\';
|
||||
$len = \strlen($prefix);
|
||||
if (\strncmp($prefix, $class, $len) !== 0) {
|
||||
return;
|
||||
}
|
||||
$relative_class = \substr($class, $len);
|
||||
$file = \dirname(\dirname(__DIR__)).'/'.\str_replace('\\', '/', $relative_class).'.php';
|
||||
if (\file_exists($file)) {
|
||||
require $file;
|
||||
}
|
||||
}
|
||||
);
|
||||
@@ -0,0 +1,7 @@
|
||||
~#PKGNAME#~ (~#VERSION#~-~#RELEASE#~) UNRELEASED; urgency=low
|
||||
|
||||
* Please check the
|
||||
https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
commit history
|
||||
|
||||
-- Nicola Asuni <info@tecnick.com> ~#DATE#~
|
||||
@@ -0,0 +1,17 @@
|
||||
Source: ~#PKGNAME#~
|
||||
Maintainer: Nicola Asuni <info@tecnick.com>
|
||||
Section: php
|
||||
Priority: optional
|
||||
Build-Depends: debhelper-compat (= 13)
|
||||
Standards-Version: 4.7.2
|
||||
Rules-Requires-Root: no
|
||||
Homepage: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
Vcs-Git: https://github.com/~#VENDOR#~/~#PROJECT#~.git
|
||||
Vcs-Browser: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
|
||||
Package: ~#PKGNAME#~
|
||||
Provides: php-~#PROJECT#~
|
||||
Architecture: all
|
||||
Depends: php (>= 8.2.0), php-gd, php-tecnickcom-tc-lib-file (<< 3.0.0), php-tecnickcom-tc-lib-file (>= 3.7.3), php-tecnickcom-tc-lib-color (<< 3.0.0), php-tecnickcom-tc-lib-color (>= 2.13.3), php-tecnickcom-tc-lib-pdf-encrypt (<< 3.0.0), php-tecnickcom-tc-lib-pdf-encrypt (>= 2.9.3), ${misc:Depends}
|
||||
Description: PHP PDF Image Library
|
||||
PHP library containing PDF Image methods.
|
||||
@@ -0,0 +1,20 @@
|
||||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: ~#PROJECT#~
|
||||
Source: https://github.com/~#VENDOR#~/~#PROJECT#~
|
||||
|
||||
Files: *
|
||||
Copyright: Copyright 2001-2026 Nicola Asuni <info@tecnick.com>
|
||||
License: LGPL-3
|
||||
|
||||
License: LGPL-3
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/> or
|
||||
/usr/share/common-licenses/LGPL-3
|
||||
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/make -f
|
||||
%:
|
||||
dh $@
|
||||
@@ -0,0 +1 @@
|
||||
3.0 (quilt)
|
||||
@@ -0,0 +1,4 @@
|
||||
version=4
|
||||
opts=filenamemangle=s/.+\/v?(\d[\d\.]+)\.tar\.gz/~#PKGNAME#~_$1.orig.tar.gz/ \
|
||||
https://github.com/~#VENDOR#~/~#PROJECT#~/tags \
|
||||
.*/archive/refs/tags/v?(\d[\d\.]*)\.tar\.gz
|
||||
@@ -0,0 +1,48 @@
|
||||
# SPEC file
|
||||
|
||||
%global c_vendor %{_vendor}
|
||||
%global gh_owner %{_owner}
|
||||
%global gh_project %{_project}
|
||||
|
||||
Name: %{_package}
|
||||
Version: %{_version}
|
||||
Release: %{_release}%{?dist}
|
||||
Summary: PHP library containing PDF Image methods
|
||||
|
||||
License: LGPLv3+
|
||||
URL: https://github.com/%{gh_owner}/%{gh_project}
|
||||
|
||||
BuildArch: noarch
|
||||
|
||||
Requires: php(language) >= 8.2.0
|
||||
Requires: php-gd
|
||||
Requires: php-zlib
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-file) < 3.0.0
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-file) >= 3.7.3
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-color) < 3.0.0
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-color) >= 2.13.3
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-pdf-encrypt) < 3.0.0
|
||||
Requires: php-composer(%{c_vendor}/tc-lib-pdf-encrypt) >= 2.9.3
|
||||
|
||||
Provides: php-composer(%{c_vendor}/%{gh_project}) = %{version}
|
||||
Provides: php-%{gh_project} = %{version}
|
||||
|
||||
%description
|
||||
PHP library containing PDF Image methods
|
||||
|
||||
%build
|
||||
#(cd %{_current_directory} && make build)
|
||||
|
||||
%install
|
||||
rm -rf "%{buildroot}"
|
||||
(cd "%{_current_directory}" && make install DESTDIR="%{buildroot}")
|
||||
|
||||
%files
|
||||
%attr(-,root,root) %{_libpath}
|
||||
%attr(-,root,root) %{_docpath}
|
||||
%docdir %{_docpath}
|
||||
# Optional config files can be listed here when used by a project.
|
||||
|
||||
%changelog
|
||||
* Fri Jan 15 2026 Nicola Asuni <info@tecnick.com> 1.0.0-1
|
||||
- Initial Commit
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Exception.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Image;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Image\Exception
|
||||
*
|
||||
* Custom Exception class
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*/
|
||||
class Exception extends \Exception {}
|
||||
@@ -0,0 +1,73 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* ImageCacheInterface.php
|
||||
*
|
||||
* @since 2026-06-16
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Image;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Image\ImageCacheInterface
|
||||
*
|
||||
* Optional external cache used to persist processed image data across
|
||||
* Import instances and PHP processes, avoiding recomputation of images that
|
||||
* have already been imported, resized and encoded.
|
||||
*
|
||||
* Implementations are a thin bridge to any backend (filesystem, APCu, Redis,
|
||||
* a PSR-16 cache, ...). They only need to store and retrieve plain arrays;
|
||||
* (de)serialization and eviction are the backend's responsibility.
|
||||
*
|
||||
* The cached value is the import-time snapshot of an image: it never contains
|
||||
* PDF object numbers (those are assigned per document at output time). Both
|
||||
* methods MUST be best-effort and MUST NOT throw on a backend miss or
|
||||
* transient backend failure, so that a cache problem never breaks PDF
|
||||
* generation.
|
||||
*
|
||||
* Security: the cache store is a trust boundary. The stored arrays (image
|
||||
* data, palette and ICC bytes) are embedded verbatim into generated PDFs, so
|
||||
* anyone able to write to the backend can influence document output. Use a
|
||||
* store only your application can write to, and when an implementation
|
||||
* deserializes data it MUST disable object restoration
|
||||
* (e.g. unserialize($s, ['allowed_classes' => false])).
|
||||
*
|
||||
* @since 2026-06-16
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* @phpstan-import-type ImageRawData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
interface ImageCacheInterface
|
||||
{
|
||||
/**
|
||||
* Retrieve a previously stored image data array.
|
||||
*
|
||||
* @param string $key Image cache key.
|
||||
*
|
||||
* @return ImageRawData|null Stored image data array, or null on a miss.
|
||||
*/
|
||||
public function get(string $key): ?array;
|
||||
|
||||
/**
|
||||
* Store an image data array.
|
||||
*
|
||||
* @param string $key Image cache key.
|
||||
* @param ImageRawData $data Image data array to store.
|
||||
*/
|
||||
public function set(string $key, array $data): void;
|
||||
}
|
||||
@@ -0,0 +1,930 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Import.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Image;
|
||||
|
||||
use Com\Tecnick\Pdf\Image\Exception as ImageException;
|
||||
use Com\Tecnick\Pdf\Image\Import\ImageImportInterface;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Image\Import
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* @phpstan-type ImageBaseData array{
|
||||
* 'bits': int,
|
||||
* 'channels': int,
|
||||
* 'colspace': string,
|
||||
* 'data': string,
|
||||
* 'exturl': bool,
|
||||
* 'file': string,
|
||||
* 'filter': string,
|
||||
* 'height': int,
|
||||
* 'icc': string,
|
||||
* 'ismask': bool,
|
||||
* 'key': string,
|
||||
* 'mapto': int,
|
||||
* 'native': bool,
|
||||
* 'obj': int,
|
||||
* 'obj_alt': int,
|
||||
* 'obj_icc': int,
|
||||
* 'obj_pal': int,
|
||||
* 'pal': string,
|
||||
* 'parms': string,
|
||||
* 'raw': string,
|
||||
* 'recode': bool,
|
||||
* 'recoded': bool,
|
||||
* 'splitalpha': bool,
|
||||
* 'trns': array<int, int>,
|
||||
* 'type': int,
|
||||
* 'width': int,
|
||||
* }
|
||||
*
|
||||
* @phpstan-type ImageRawData array{
|
||||
* 'bits': int,
|
||||
* 'channels': int,
|
||||
* 'colspace': string,
|
||||
* 'data': string,
|
||||
* 'exturl': bool,
|
||||
* 'file': string,
|
||||
* 'filter': string,
|
||||
* 'height': int,
|
||||
* 'icc': string,
|
||||
* 'ismask': bool,
|
||||
* 'key': string,
|
||||
* 'mapto': int,
|
||||
* 'mask'?: ImageBaseData,
|
||||
* 'native': bool,
|
||||
* 'obj': int,
|
||||
* 'obj_alt': int,
|
||||
* 'obj_icc': int,
|
||||
* 'obj_pal': int,
|
||||
* 'out'?: true,
|
||||
* 'pal': string,
|
||||
* 'parms': string,
|
||||
* 'plain'?: ImageBaseData,
|
||||
* 'raw': string,
|
||||
* 'recode': bool,
|
||||
* 'recoded': bool,
|
||||
* 'splitalpha': bool,
|
||||
* 'trns': array<int, int>,
|
||||
* 'type': int,
|
||||
* 'width': int,
|
||||
* }
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.ExcessiveClassLength")
|
||||
* @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
|
||||
*/
|
||||
class Import extends \Com\Tecnick\Pdf\Image\Output
|
||||
{
|
||||
/**
|
||||
* Image index.
|
||||
* Count the number of added images.
|
||||
*/
|
||||
protected int $iid = 0;
|
||||
|
||||
/**
|
||||
* Namespace + schema version prefix for external cache keys.
|
||||
* Bump the version when the ImageRawData shape changes so that stale
|
||||
* persisted entries are ignored instead of being fed into output.
|
||||
*/
|
||||
private const CACHE_PREFIX = 'tc-lib-pdf-image:v2:';
|
||||
|
||||
/**
|
||||
* Native image types and associated importing class.
|
||||
* (Image types for which we have an import method).
|
||||
*
|
||||
* @var array<int, string>
|
||||
*/
|
||||
private const NATIVE = [
|
||||
IMAGETYPE_PNG => 'Png',
|
||||
IMAGETYPE_JPEG => 'Jpeg',
|
||||
];
|
||||
|
||||
/**
|
||||
* Lossless image types.
|
||||
*
|
||||
* @var array<int>
|
||||
*/
|
||||
protected const LOSSLESS = [
|
||||
IMAGETYPE_GIF, // 1
|
||||
IMAGETYPE_PNG, // 3
|
||||
IMAGETYPE_PSD, // 5
|
||||
IMAGETYPE_BMP, // 6
|
||||
IMAGETYPE_WBMP, // 15
|
||||
IMAGETYPE_XBM, // 16
|
||||
IMAGETYPE_TIFF_II, // 7
|
||||
IMAGETYPE_TIFF_MM, // 8
|
||||
IMAGETYPE_IFF, // 14
|
||||
IMAGETYPE_SWC, // 13
|
||||
IMAGETYPE_ICO, // 17
|
||||
];
|
||||
|
||||
/**
|
||||
* Map number of channels with color space name.
|
||||
*
|
||||
* @var array<int, string>
|
||||
*/
|
||||
protected const COLSPACEMAP = [
|
||||
1 => 'DeviceGray',
|
||||
3 => 'DeviceRGB',
|
||||
4 => 'DeviceCMYK',
|
||||
];
|
||||
|
||||
/**
|
||||
* Add a new image.
|
||||
*
|
||||
* @param string $image Image file name, URL or a '@' character followed by the image data string.
|
||||
* To link an image without embedding it on the document, set an asterisk
|
||||
* character before the URL (i.e.: '*http://www.example.com/image.jpg').
|
||||
* @param ?int $width New width in pixels or null to keep the original value.
|
||||
* @param ?int $height New height in pixels or null to keep the original value.
|
||||
* @param bool $ismask True if the image is a transparency mask.
|
||||
* @param int $quality Quality for JPEG files (0 = max compression; 100 = best quality, bigger file).
|
||||
* @param bool $defprint Indicate if the image is the default
|
||||
* for printing when used as alternative image.
|
||||
* @param array<int, int> $altimgs Arrays of alternate image keys.
|
||||
*
|
||||
* @return int Image ID.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be added.
|
||||
* @throws \Com\Tecnick\File\Exception If reading image content fails.
|
||||
*/
|
||||
public function add(
|
||||
string $image,
|
||||
?int $width = null,
|
||||
?int $height = null,
|
||||
bool $ismask = false,
|
||||
int $quality = 100,
|
||||
bool $defprint = false,
|
||||
array $altimgs = [],
|
||||
): int {
|
||||
$data = $this->import($image, $width, $height, $ismask, $quality);
|
||||
++$this->iid;
|
||||
$this->image[$this->iid] = [
|
||||
'iid' => $this->iid,
|
||||
'key' => $data['key'],
|
||||
'width' => $data['width'],
|
||||
'height' => $data['height'],
|
||||
'defprint' => $defprint,
|
||||
'altimgs' => $altimgs,
|
||||
];
|
||||
return $this->iid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Image key used for caching.
|
||||
*
|
||||
* @param string $image Image file name or content.
|
||||
* @param int $width Width in pixels.
|
||||
* @param int $height Height in pixels.
|
||||
* @param int $quality Quality for JPEG files.
|
||||
*/
|
||||
public function getKey(string $image, int $width = 0, int $height = 0, int $quality = 100): string
|
||||
{
|
||||
// The parts are joined with a delimiter so that distinct inputs cannot
|
||||
// collapse into the same digest (e.g. ('img', 12, 3) vs ('img1', 2, 3)).
|
||||
$seed = $image . '|' . $width . '|' . $height . '|' . $quality;
|
||||
return \strtr(\rtrim(\base64_encode(\pack('H*', \md5($seed))), '='), '+/', '-_');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an imported image by key.
|
||||
*
|
||||
* @param string $key Image key.
|
||||
*
|
||||
* @return ImageRawData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the key is not found.
|
||||
*/
|
||||
public function getImageDataByKey(string $key): array
|
||||
{
|
||||
$cache = $this->cache[$key] ?? null;
|
||||
if ($cache === null) {
|
||||
throw new ImageException('Unknown key');
|
||||
}
|
||||
|
||||
return $cache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the image dimensions for a cached image.
|
||||
*
|
||||
* - If both $width and $height are zero, the original image dimensions are returned.
|
||||
* - If only one of $width and $height is greater than zero, the other is
|
||||
* calculated preserving the original aspect ratio.
|
||||
* - If both are greater than zero, they are returned as-is, unless $fit is
|
||||
* true, in which case the image is scaled to fit within the $width x $height
|
||||
* bounding box preserving the original aspect ratio.
|
||||
*
|
||||
* @param string $key Image key.
|
||||
* @param int $width Target width in pixels (0 = unspecified).
|
||||
* @param int $height Target height in pixels (0 = unspecified).
|
||||
* @param bool $fit If true and both sides are specified, scale to fit
|
||||
* within the bounding box preserving the aspect ratio.
|
||||
*
|
||||
* @return array{width: int, height: int} Image dimensions in pixels.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the key is not found.
|
||||
*/
|
||||
public function getImageDimensionsByKey(string $key, int $width = 0, int $height = 0, bool $fit = false): array
|
||||
{
|
||||
$data = $this->getImageDataByKey($key);
|
||||
|
||||
[$width, $height] = $this->scaleToAspect(
|
||||
$data['width'],
|
||||
$data['height'],
|
||||
$width > 0 ? $width : null,
|
||||
$height > 0 ? $height : null,
|
||||
$fit,
|
||||
);
|
||||
|
||||
return [
|
||||
'width' => $width,
|
||||
'height' => $height,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Import the original image raw data.
|
||||
*
|
||||
* @param string $image Image file name, URL or a '@' character followed by the image data string.
|
||||
* To link an image without embedding it on the document, set an asterisk
|
||||
* character before the URL (i.e.: '*http://www.example.com/image.jpg').
|
||||
* @param ?int $width New width in pixels or null to keep the original value.
|
||||
* @param ?int $height New height in pixels or null to keep the original value.
|
||||
* @param bool $ismask True if the image is a transparency mask.
|
||||
* @param int $quality Quality for JPEG files (0 = max compression; 100 = best quality, bigger file).
|
||||
*
|
||||
* @return ImageRawData Image raw data array
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be imported.
|
||||
* @throws \Com\Tecnick\File\Exception If reading image content fails.
|
||||
*/
|
||||
protected function import(
|
||||
string $image,
|
||||
?int $width = null,
|
||||
?int $height = null,
|
||||
bool $ismask = false,
|
||||
int $quality = 100,
|
||||
): array {
|
||||
$quality = \max(0, \min(100, $quality));
|
||||
$imgkey = $this->getKey($image, (int) $width, (int) $height, $quality);
|
||||
|
||||
// Tier 1: in-process memory cache (fast path, also dedups within a document).
|
||||
if (isset($this->cache[$imgkey])) {
|
||||
return $this->cache[$imgkey];
|
||||
}
|
||||
|
||||
// Tier 2: optional external cache (survives across instances and processes).
|
||||
$cache = $this->imageCache;
|
||||
$extkey = '';
|
||||
if ($cache !== null) {
|
||||
$extkey = $this->getExternalCacheKey($image, $imgkey, (int) $width, (int) $height, $quality);
|
||||
$cached = $cache->get($extkey);
|
||||
if ($cached !== null) {
|
||||
$cached['key'] = $imgkey;
|
||||
$this->cache[$imgkey] = $cached;
|
||||
return $cached;
|
||||
}
|
||||
}
|
||||
|
||||
$data = $this->getRawData($image);
|
||||
$data['key'] = $imgkey;
|
||||
|
||||
[$width, $height] = $this->resolveDimensions($data, $width, $height);
|
||||
|
||||
if (!$data['native'] || $width !== $data['width'] || $height !== $data['height']) {
|
||||
$data = $this->getResizedRawData($this->getBaseData($data), $width, $height, true, $quality);
|
||||
}
|
||||
|
||||
$data = $this->getData($data, $width, $height, $quality);
|
||||
|
||||
$data = $this->enrichMaskData($data, $width, $height, $quality, $ismask);
|
||||
|
||||
// store data in the in-process cache
|
||||
$this->cache[$imgkey] = $data;
|
||||
|
||||
// write-through to the external cache (best-effort, persistable snapshot)
|
||||
if ($cache !== null) {
|
||||
$cache->set($extkey, $this->getPersistableData($data));
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the persistent (external) cache key for an image.
|
||||
*
|
||||
* For local file inputs the file modification time and size are folded into
|
||||
* the key, so that editing a file in place invalidates stale persisted
|
||||
* entries. Inline data ('@...') and remote URLs are identified by their
|
||||
* string, which already carries their content/identity.
|
||||
*
|
||||
* @param string $image Image file name, URL or '@'-prefixed data string.
|
||||
* @param string $imgkey Image key already computed from the raw image string.
|
||||
* @param int $width Width in pixels.
|
||||
* @param int $height Height in pixels.
|
||||
* @param int $quality Quality for JPEG files.
|
||||
*/
|
||||
private function getExternalCacheKey(string $image, string $imgkey, int $width, int $height, int $quality): string
|
||||
{
|
||||
$identity = $image;
|
||||
|
||||
if ($image !== '' && $image[0] !== '@') {
|
||||
$path = $image[0] === '*' ? \substr($image, 1) : $image;
|
||||
if (\is_file($path)) {
|
||||
$mtime = \filemtime($path);
|
||||
$size = \filesize($path);
|
||||
if ($mtime !== false && $size !== false) {
|
||||
$identity = $image . ':' . $mtime . ':' . $size;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// When the identity is just the raw image string the key is identical
|
||||
// to the one already computed by the caller, so reuse it and avoid a
|
||||
// second md5/base64 round.
|
||||
$key = $identity === $image ? $imgkey : $this->getKey($identity, $width, $height, $quality);
|
||||
|
||||
return self::CACHE_PREFIX . $key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Produce a persistable snapshot of the imported image data.
|
||||
*
|
||||
* Drops the original raw bytes (not used at output time) to shrink the
|
||||
* stored payload. PDF object numbers and the output flag are intentionally
|
||||
* left as imported (all zero / unset), so a loaded entry is ready for a
|
||||
* fresh document without any reset.
|
||||
*
|
||||
* @param ImageRawData $data Imported image data.
|
||||
*
|
||||
* @return ImageRawData Persistable image data.
|
||||
*/
|
||||
private function getPersistableData(array $data): array
|
||||
{
|
||||
$data['raw'] = '';
|
||||
|
||||
if (isset($data['mask'])) {
|
||||
$data['mask']['raw'] = '';
|
||||
}
|
||||
|
||||
if (isset($data['plain'])) {
|
||||
$data['plain']['raw'] = '';
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve target image dimensions preserving aspect ratio when one side is omitted.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
* @param ?int $width Target width in pixels (null = unspecified, derive from aspect ratio).
|
||||
* @param ?int $height Target height in pixels (null = unspecified, derive from aspect ratio).
|
||||
*
|
||||
* @return array{0: int, 1: int}
|
||||
*/
|
||||
private function resolveDimensions(array $data, ?int $width, ?int $height): array
|
||||
{
|
||||
return $this->scaleToAspect($data['width'], $data['height'], $width, $height);
|
||||
}
|
||||
|
||||
/**
|
||||
* Scale target dimensions against a source size, preserving the aspect ratio.
|
||||
*
|
||||
* - If both $width and $height are null (unspecified), the source dimensions
|
||||
* are returned.
|
||||
* - If only one side is specified, the other is derived from the source aspect
|
||||
* ratio.
|
||||
* - If both sides are specified, they are returned as-is, unless $fit is true,
|
||||
* in which case the result is scaled to fit within the $width x $height box
|
||||
* while preserving the source aspect ratio.
|
||||
*
|
||||
* An explicit zero (as opposed to null) is kept as-is so that callers can
|
||||
* detect and reject invalid target dimensions downstream.
|
||||
*
|
||||
* @param int $srcwidth Source width in pixels.
|
||||
* @param int $srcheight Source height in pixels.
|
||||
* @param ?int $width Target width in pixels (null = unspecified).
|
||||
* @param ?int $height Target height in pixels (null = unspecified).
|
||||
* @param bool $fit Scale to fit within the box when both sides are given.
|
||||
*
|
||||
* @return array{0: int, 1: int}
|
||||
*/
|
||||
private function scaleToAspect(int $srcwidth, int $srcheight, ?int $width, ?int $height, bool $fit = false): array
|
||||
{
|
||||
if ($width === null && $height === null) {
|
||||
return [\max(0, $srcwidth), \max(0, $srcheight)];
|
||||
}
|
||||
|
||||
if ($fit && $width !== null && $width > 0 && $height !== null && $height > 0) {
|
||||
return $this->fitToBox($srcwidth, $srcheight, $width, $height);
|
||||
}
|
||||
|
||||
if ($width !== null && $height === null && $srcwidth > 0) {
|
||||
$height = $this->scaleSide($width, $srcheight, $srcwidth);
|
||||
}
|
||||
|
||||
if ($height !== null && $width === null && $srcheight > 0) {
|
||||
$width = $this->scaleSide($height, $srcwidth, $srcheight);
|
||||
}
|
||||
|
||||
return [\max(0, $width ?? $srcwidth), \max(0, $height ?? $srcheight)];
|
||||
}
|
||||
|
||||
/**
|
||||
* Scale a single dimension proportionally: round($value * $numerator / $denominator).
|
||||
*
|
||||
* @param int $value The known side to scale from (e.g. the specified width or height).
|
||||
* @param int $numerator Source size of the side being computed.
|
||||
* @param int $denominator Source size of the side $value corresponds to.
|
||||
*
|
||||
* @return int Scaled size of the computed side, in pixels.
|
||||
*/
|
||||
private function scaleSide(int $value, int $numerator, int $denominator): int
|
||||
{
|
||||
return (int) \round(((float) $value * (float) $numerator) / (float) $denominator);
|
||||
}
|
||||
|
||||
/**
|
||||
* Scale the source size to fit within the $width x $height box, preserving the aspect ratio.
|
||||
*
|
||||
* @param int $srcwidth Source width in pixels.
|
||||
* @param int $srcheight Source height in pixels.
|
||||
* @param int $width Bounding box width in pixels.
|
||||
* @param int $height Bounding box height in pixels.
|
||||
*
|
||||
* @return array{0: int, 1: int}
|
||||
*/
|
||||
private function fitToBox(int $srcwidth, int $srcheight, int $width, int $height): array
|
||||
{
|
||||
if ($srcwidth <= 0 || $srcheight <= 0) {
|
||||
return [\max(0, $width), \max(0, $height)];
|
||||
}
|
||||
|
||||
$scale = \min((float) $width / (float) $srcwidth, (float) $height / (float) $srcheight);
|
||||
return [
|
||||
\max(0, (int) \round((float) $srcwidth * $scale)),
|
||||
\max(0, (int) \round((float) $srcheight * $scale)),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Add plain/mask variants when required by mask mode or alpha splitting.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
* @param int $width Width in pixels.
|
||||
* @param int $height Height in pixels.
|
||||
* @param int $quality Quality for JPEG files.
|
||||
* @param bool $ismask True if the image is a transparency mask.
|
||||
*
|
||||
* @return ImageRawData
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be imported.
|
||||
*/
|
||||
private function enrichMaskData(array $data, int $width, int $height, int $quality, bool $ismask): array
|
||||
{
|
||||
$basedata = $this->getBaseData($data);
|
||||
|
||||
if ($ismask) {
|
||||
$data['mask'] = $basedata;
|
||||
return $data;
|
||||
}
|
||||
|
||||
if (!$data['splitalpha']) {
|
||||
return $data;
|
||||
}
|
||||
|
||||
// create 2 separate images: plain + mask
|
||||
$data['plain'] = $this->createPlainImage($basedata, $width, $height, $quality);
|
||||
$data['mask'] = $this->createMaskImage($basedata, $width, $height, $quality);
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageBaseData $basedata Image base data.
|
||||
* @param int $width Width in pixels.
|
||||
* @param int $height Height in pixels.
|
||||
* @param int $quality Quality for JPEG files.
|
||||
*
|
||||
* @return ImageBaseData
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be imported.
|
||||
*/
|
||||
private function createPlainImage(array $basedata, int $width, int $height, int $quality): array
|
||||
{
|
||||
$plain = $this->getResizedRawData($basedata, $width, $height, false, $quality);
|
||||
$plain = $this->getData($plain, $width, $height, $quality);
|
||||
|
||||
return $this->getBaseData($plain);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageBaseData $basedata Image base data.
|
||||
* @param int $width Width in pixels.
|
||||
* @param int $height Height in pixels.
|
||||
* @param int $quality Quality for JPEG files.
|
||||
*
|
||||
* @return ImageBaseData
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be imported.
|
||||
*/
|
||||
private function createMaskImage(array $basedata, int $width, int $height, int $quality): array
|
||||
{
|
||||
$mask = $this->getAlphaChannelRawData($basedata);
|
||||
$mask = $this->getData($mask, $width, $height, $quality);
|
||||
$mask = $this->getBaseData($mask);
|
||||
$mask['colspace'] = 'DeviceGray';
|
||||
|
||||
return $mask;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the relevant data from the image.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
* @param int $width Width in pixels.
|
||||
* @param int $height Height in pixels.
|
||||
* @param int $quality Quality for JPEG files.
|
||||
*
|
||||
* @return ImageRawData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be imported.
|
||||
*/
|
||||
protected function getData(array $data, int $width, int $height, int $quality): array
|
||||
{
|
||||
if (!$data['native']) {
|
||||
throw new ImageException('Unable to import image');
|
||||
}
|
||||
|
||||
$imageImport = $this->createImportImage($data);
|
||||
$data = $imageImport->getData($this->getBaseData($data));
|
||||
|
||||
if ($data['recode']) {
|
||||
// re-encode the image as it was not possible to decode it
|
||||
$data = $this->getResizedRawData($this->getBaseData($data), $width, $height, true, $quality);
|
||||
$data = $imageImport->getData($this->getBaseData($data));
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{'type': int}|ImageRawData $data Image raw data.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image type is unknown.
|
||||
*/
|
||||
private function createImportImage(array $data): ImageImportInterface
|
||||
{
|
||||
if (!isset(self::NATIVE[$data['type']])) {
|
||||
throw new ImageException('Unable to import image: unknown type');
|
||||
}
|
||||
|
||||
return match (self::NATIVE[$data['type']]) {
|
||||
'Png' => new \Com\Tecnick\Pdf\Image\Import\Png(),
|
||||
'Jpeg' => new \Com\Tecnick\Pdf\Image\Import\Jpeg(),
|
||||
default => throw new ImageException('Unable to import image: unknown type'),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize raw image data to its base shape.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
*
|
||||
* @return ImageBaseData Image base data.
|
||||
*/
|
||||
private function getBaseData(array $data): array
|
||||
{
|
||||
return [
|
||||
'bits' => $data['bits'],
|
||||
'channels' => $data['channels'],
|
||||
'colspace' => $data['colspace'],
|
||||
'data' => $data['data'],
|
||||
'exturl' => $data['exturl'],
|
||||
'file' => $data['file'],
|
||||
'filter' => $data['filter'],
|
||||
'height' => $data['height'],
|
||||
'icc' => $data['icc'],
|
||||
'ismask' => $data['ismask'],
|
||||
'key' => $data['key'],
|
||||
'mapto' => $data['mapto'],
|
||||
'native' => $data['native'],
|
||||
'obj' => $data['obj'],
|
||||
'obj_alt' => $data['obj_alt'],
|
||||
'obj_icc' => $data['obj_icc'],
|
||||
'obj_pal' => $data['obj_pal'],
|
||||
'pal' => $data['pal'],
|
||||
'parms' => $data['parms'],
|
||||
'raw' => $data['raw'],
|
||||
'recode' => $data['recode'],
|
||||
'recoded' => $data['recoded'],
|
||||
'splitalpha' => $data['splitalpha'],
|
||||
'trns' => $data['trns'],
|
||||
'type' => $data['type'],
|
||||
'width' => $data['width'],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the original image raw data.
|
||||
*
|
||||
* @param string $image Image file name, URL or a '@' character followed by the image data string.
|
||||
* To link an image without embedding it on the document, set an asterisk character
|
||||
* before the URL (i.e.: '*http://www.example.com/image.jpg').
|
||||
*
|
||||
* @return ImageRawData Image data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be read.
|
||||
* @throws \Com\Tecnick\File\Exception If reading image content fails.
|
||||
*/
|
||||
protected function getRawData(string $image): array
|
||||
{
|
||||
// default data to return
|
||||
$data = [
|
||||
'bits' => 8, // number of bits per channel
|
||||
'channels' => 3, // number of channels
|
||||
'colspace' => 'DeviceRGB', // color space
|
||||
'data' => '', // PDF image data
|
||||
'exturl' => false, // true if the image is an exernal URL that should not be embedded
|
||||
'file' => '', // source file name or URL
|
||||
'filter' => 'FlateDecode', // decoding filter
|
||||
'height' => 0, // image height in pixels
|
||||
'icc' => '', // ICC profile
|
||||
'ismask' => false, // true if the image is a transparency mask
|
||||
'key' => '', // image key
|
||||
'mapto' => IMAGETYPE_PNG, // type to convert to
|
||||
'native' => false, // true if the image is PNG or JPEG
|
||||
'obj' => 0, // PDF object number
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '', // colour palette
|
||||
'parms' => '', // additional PDF decoding parameters
|
||||
'raw' => '', // raw image data
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [], // colour key masking
|
||||
'type' => 0, // image type constant: IMAGETYPE_XXX
|
||||
'width' => 0, // image width in pixels
|
||||
];
|
||||
|
||||
if ($image === '' || ($image[0] === '@' || $image[0] === '*') && \strlen($image) === 1) {
|
||||
throw new ImageException('Empty image');
|
||||
}
|
||||
|
||||
if ($image[0] === '@') { // image from string
|
||||
$data['raw'] = \substr($image, 1);
|
||||
return $this->getMetaData($data);
|
||||
}
|
||||
|
||||
if ($image[0] === '*') { // not-embedded external URL
|
||||
$data['exturl'] = true;
|
||||
$image = \substr($image, 1);
|
||||
}
|
||||
|
||||
$data['file'] = $image;
|
||||
$raw = $this->fileHelper->getFileData($image);
|
||||
if ($raw === false) {
|
||||
throw new ImageException('Unable to read image file: ' . $image);
|
||||
}
|
||||
|
||||
$data['raw'] = $raw;
|
||||
|
||||
return $this->getMetaData($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the image meta data.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
*
|
||||
* @return ImageRawData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image format is invalid.
|
||||
*/
|
||||
protected function getMetaData(array $data): array
|
||||
{
|
||||
// getimagesizefromstring() does not throw: it emits warnings (silenced
|
||||
// below) and returns false on failure, which is handled right after.
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
$meta = \getimagesizefromstring($data['raw']);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
|
||||
if ($meta === false) {
|
||||
throw new ImageException('Invalid image format');
|
||||
}
|
||||
|
||||
$data['width'] = $meta[0];
|
||||
$data['height'] = $meta[1];
|
||||
$data['type'] = $meta[2];
|
||||
$data['native'] = isset(self::NATIVE[$data['type']]);
|
||||
$data['mapto'] = \in_array($data['type'], self::LOSSLESS, true) ? IMAGETYPE_PNG : IMAGETYPE_JPEG;
|
||||
/** @var array{'bits'?: int, 'channels'?: int} $meta */
|
||||
if (isset($meta['bits'])) {
|
||||
$data['bits'] = $meta['bits'];
|
||||
}
|
||||
|
||||
if (isset($meta['channels']) && $meta['channels'] !== 0) {
|
||||
$data['channels'] = (int) $meta['channels'];
|
||||
}
|
||||
|
||||
if (isset(self::COLSPACEMAP[$data['channels']])) {
|
||||
$data['colspace'] = self::COLSPACEMAP[$data['channels']];
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the resized image raw data
|
||||
* (always convert the image type to a native format: PNG or JPEG).
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data as returned by getRawData.
|
||||
* @param int $width New width in pixels.
|
||||
* @param int $height New height in pixels.
|
||||
* @param bool $alpha If true save the alpha channel information,
|
||||
* if false merge the alpha channel (PNG mode).
|
||||
* @param int $quality Quality for JPEG files
|
||||
* (0 = max compression; 100 = best quality, bigger file).
|
||||
*
|
||||
* @return ImageRawData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image cannot be resized.
|
||||
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
|
||||
* @SuppressWarnings("PHPMD.NPathComplexity")
|
||||
*/
|
||||
protected function getResizedRawData(
|
||||
array $data,
|
||||
int $width,
|
||||
int $height,
|
||||
bool $alpha = true,
|
||||
int $quality = 100,
|
||||
): array {
|
||||
if ($width <= 0 || $height <= 0) {
|
||||
throw new ImageException('Image width and/or height are empty');
|
||||
}
|
||||
|
||||
$img = \imagecreatefromstring($data['raw']);
|
||||
if ($img === false) {
|
||||
throw new ImageException('Unable to create new image from string');
|
||||
}
|
||||
|
||||
$newimg = \imagecreatetruecolor($width, $height);
|
||||
if ($newimg === false) {
|
||||
throw new ImageException('Unable to create new resized image');
|
||||
}
|
||||
|
||||
\imageinterlace($newimg, false);
|
||||
|
||||
if ($alpha) {
|
||||
$trid = \imagecolorallocate($newimg, 0, 0, 0);
|
||||
if ($trid === false) {
|
||||
throw new ImageException('Unable to allocate alpha color for transparency');
|
||||
}
|
||||
\imagecolortransparent($newimg, $trid);
|
||||
} else {
|
||||
$tid = \imagecolortransparent($img);
|
||||
$palsize = \imagecolorstotal($img);
|
||||
if ($tid >= 0 && $palsize > 0 && $tid < $palsize) {
|
||||
// set transparency for Indexed image
|
||||
/** @var array{'red': int, 'green': int, 'blue': int, 'alpha': int} $tcol */
|
||||
$tcol = \imagecolorsforindex($img, $tid);
|
||||
$trid = \imagecolorallocate($newimg, $tcol['red'], $tcol['green'], $tcol['blue']);
|
||||
if ($trid === false) {
|
||||
throw new ImageException('Unable to allocate color for transparency');
|
||||
}
|
||||
\imagefill($newimg, 0, 0, $trid);
|
||||
\imagecolortransparent($newimg, $trid);
|
||||
}
|
||||
}
|
||||
|
||||
\imagealphablending($newimg, !$alpha);
|
||||
\imagesavealpha($newimg, $alpha);
|
||||
|
||||
\imagecopyresampled($newimg, $img, 0, 0, 0, 0, $width, $height, $data['width'], $data['height']);
|
||||
|
||||
\ob_start();
|
||||
if ($data['mapto'] === IMAGETYPE_PNG) {
|
||||
\imagepng($newimg, null, 9, PNG_ALL_FILTERS);
|
||||
} else {
|
||||
\imagejpeg($newimg, null, $quality);
|
||||
}
|
||||
$ogc = \ob_get_clean();
|
||||
if ($ogc === false) {
|
||||
throw new ImageException('Unable to extract alpha channel');
|
||||
}
|
||||
|
||||
$data['raw'] = $ogc;
|
||||
$data['exturl'] = false;
|
||||
$data['recoded'] = true;
|
||||
return $this->getMetaData($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the alpha channel as separate image to be used as a mask.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data as returned by getRawData.
|
||||
*
|
||||
* @return ImageRawData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the alpha channel cannot be extracted.
|
||||
*/
|
||||
protected function getAlphaChannelRawData(array $data): array
|
||||
{
|
||||
$img = \imagecreatefromstring($data['raw']);
|
||||
if ($img === false) {
|
||||
throw new ImageException('Unable to create alpha channel image from string');
|
||||
}
|
||||
|
||||
$newimg = \imagecreate(\max(1, $data['width']), \max(1, $data['height']));
|
||||
if ($newimg === false) {
|
||||
throw new ImageException('Unable to create new empty alpha channel image');
|
||||
}
|
||||
|
||||
\imageinterlace($newimg, false);
|
||||
|
||||
// generate gray scale palette (0 -> 255)
|
||||
for ($col = 0; $col < 256; ++$col) {
|
||||
\imagecolorallocate($newimg, $col, $col, $col);
|
||||
}
|
||||
|
||||
// Precompute the gamma-corrected output for each of the 128 possible
|
||||
// GD alpha values (7-bit: 0 -> 127), so the expensive pow() runs 128
|
||||
// times instead of once per pixel.
|
||||
$alphamap = [];
|
||||
for ($alf = 0; $alf < 128; ++$alf) {
|
||||
// GD alpha is only 7 bit (0 -> 127); 2.2 is the gamma value
|
||||
$alphamap[$alf] = (int) ((((float) (127 - $alf) / 127) ** 2.2) * 255);
|
||||
}
|
||||
|
||||
$truecolor = \imageistruecolor($img);
|
||||
|
||||
// extract alpha channel
|
||||
for ($xpx = 0; $xpx < $data['width']; ++$xpx) {
|
||||
for ($ypx = 0; $ypx < $data['height']; ++$ypx) {
|
||||
$colindex = \imagecolorat($img, $xpx, $ypx);
|
||||
if ($colindex === false) {
|
||||
throw new ImageException('Unable to extract alpha channel color index');
|
||||
}
|
||||
|
||||
// get and correct gamma color (keys 0-127 are always present)
|
||||
if ($truecolor) {
|
||||
// For truecolor images the alpha is packed in bits 24-30 of
|
||||
// the pixel value, so it can be read directly instead of
|
||||
// allocating a colour-component array per pixel.
|
||||
$alpha = $alphamap[($colindex >> 24) & 0x7F] ?? 0;
|
||||
} else {
|
||||
/** @var array{'red': int, 'green': int, 'blue': int, 'alpha': int} $color */
|
||||
$color = \imagecolorsforindex($img, $colindex);
|
||||
$alpha = $alphamap[$color['alpha']] ?? 0;
|
||||
}
|
||||
|
||||
\imagesetpixel($newimg, $xpx, $ypx, $alpha);
|
||||
}
|
||||
}
|
||||
|
||||
\ob_start();
|
||||
\imagepng($newimg, null, 9, PNG_ALL_FILTERS);
|
||||
$ogc = \ob_get_clean();
|
||||
if ($ogc === false) {
|
||||
throw new ImageException('Unable to extract alpha channel');
|
||||
}
|
||||
|
||||
$data['raw'] = $ogc;
|
||||
$data['channels'] = 1;
|
||||
$data['colspace'] = 'DeviceGray';
|
||||
$data['exturl'] = false;
|
||||
$data['recoded'] = true;
|
||||
$data['ismask'] = true;
|
||||
return $this->getMetaData($data);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* ImageImportInterface.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author jmleroux <jmleroux.pro@gmail.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Image\Import;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Image\Import\ImageImportInterface
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author jmleroux <jmleroux.pro@gmail.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
interface ImageImportInterface
|
||||
{
|
||||
/**
|
||||
* Extract data from an image.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*/
|
||||
public function getData(array $data): array;
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Jpeg.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Image\Import;
|
||||
|
||||
use Com\Tecnick\File\Byte;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Image\Import\Jpeg
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
class Jpeg implements ImageImportInterface
|
||||
{
|
||||
/**
|
||||
* Extract data from a JPEG image.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*
|
||||
* @throws \RangeException If the byte offset is out of range.
|
||||
*/
|
||||
public function getData(array $data): array
|
||||
{
|
||||
$data['filter'] = 'DCTDecode';
|
||||
$data['data'] = $data['raw'];
|
||||
$byte = new Byte($data['raw']);
|
||||
// extract embedded ICC profile (if any)
|
||||
$icc = [];
|
||||
$offset = 0;
|
||||
// Length in bytes of the "ICC_PROFILE" marker string, used as the
|
||||
// minimum forward step so a malformed segment can never stall the scan.
|
||||
$markerlen = 11;
|
||||
while (($pos = \strpos($data['raw'], 'ICC_PROFILE', $offset)) !== false) {
|
||||
if ($pos < 2) {
|
||||
// Not enough bytes before the marker to read the APP2 length.
|
||||
$offset = $pos + $markerlen;
|
||||
continue;
|
||||
}
|
||||
|
||||
// get ICC sequence length
|
||||
$length = $byte->getUShort($pos - 2) - 16;
|
||||
if ($length <= 0) {
|
||||
// Malformed or spurious marker: skip past it so $offset always
|
||||
// advances and the loop cannot get stuck re-finding this match.
|
||||
$offset = $pos + $markerlen;
|
||||
continue;
|
||||
}
|
||||
|
||||
// marker sequence number
|
||||
$msn = \max(1, \ord($data['raw'][$pos + 12] ?? "\x00"));
|
||||
// number of markers (total of APP2 used)
|
||||
//$nom = \max(1, \ord($data['raw'][($pos + 13)]));
|
||||
// get sequence segment
|
||||
$icc[$msn - 1] = \substr($data['raw'], $pos + 14, $length);
|
||||
// move forward to next sequence
|
||||
$offset = $pos + 14 + $length;
|
||||
}
|
||||
|
||||
// order and compact ICC segments
|
||||
if ($icc !== []) {
|
||||
\ksort($icc);
|
||||
$icc = \implode('', $icc);
|
||||
if (\substr($icc, 36, 4) === 'acsp') {
|
||||
// valid ICC profile
|
||||
$data['icc'] = $icc;
|
||||
}
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,325 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Png.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Image\Import;
|
||||
|
||||
use Com\Tecnick\File\Byte;
|
||||
use Com\Tecnick\Pdf\Image\Exception as ImageException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Image\Import\Png
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
class Png implements ImageImportInterface
|
||||
{
|
||||
/**
|
||||
* Extract data from a PNG image.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image is invalid.
|
||||
* @throws \RangeException If the byte offset is out of range.
|
||||
*/
|
||||
public function getData(array $data): array
|
||||
{
|
||||
$data['filter'] = 'FlateDecode';
|
||||
$byte = new Byte($data['raw']);
|
||||
|
||||
$offset = 0;
|
||||
// check signature
|
||||
if (\substr($data['raw'], $offset, 8) !== \chr(137) . 'PNG' . \chr(13) . \chr(10) . \chr(26) . \chr(10)) {
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new ImageException('Not a PNG image');
|
||||
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
|
||||
$offset += 8;
|
||||
$offset += 4;
|
||||
|
||||
$data = $this->getIhdrChunk($byte, $data, $offset);
|
||||
|
||||
$offset += 3;
|
||||
|
||||
// check compression, filter and interlacing settings
|
||||
if (
|
||||
$byte->getByte($offset - 3) !== 0
|
||||
|| $byte->getByte($offset - 2) !== 0
|
||||
|| $byte->getByte($offset - 1) !== 0
|
||||
) {
|
||||
if ($data['recoded']) {
|
||||
// this image has been already re-encoded
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new ImageException('Unsupported feature');
|
||||
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
|
||||
// re-encode PNG
|
||||
$data['recode'] = true;
|
||||
return $data;
|
||||
}
|
||||
|
||||
if (\str_contains($data['colspace'], '+Alpha')) {
|
||||
// alpha channel: split images (plain + alpha)
|
||||
$data['splitalpha'] = true;
|
||||
$data['colspace'] = \substr($data['colspace'], 0, -6);
|
||||
return $data;
|
||||
}
|
||||
|
||||
$data['parms'] =
|
||||
'/DecodeParms << /Predictor 15 /Colors '
|
||||
. $data['channels']
|
||||
. ' /BitsPerComponent '
|
||||
. $data['bits']
|
||||
. ' /Columns '
|
||||
. $data['width']
|
||||
. ' >>';
|
||||
|
||||
$offset += 4;
|
||||
return $this->getChunks($byte, $data, $offset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the IHDR chunk data.
|
||||
*
|
||||
* The header chunk (IHDR) contains basic information about the image data and must appear as the first chunk,
|
||||
* and there must only be one header chunk in a PNG data stream.
|
||||
*
|
||||
* @param Byte $byte Byte class object wrapping the raw image data.
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
* @param int $offset Current byte offset.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image is invalid.
|
||||
* @throws \RangeException If the byte offset is out of range.
|
||||
*/
|
||||
protected function getIhdrChunk(Byte $byte, array $data, int &$offset): array
|
||||
{
|
||||
if (\substr($data['raw'], $offset, 4) !== 'IHDR') {
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new ImageException('Invalid PNG image');
|
||||
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
|
||||
$offset += 4;
|
||||
$data['width'] = $byte->getULong($offset);
|
||||
$offset += 4;
|
||||
$data['height'] = $byte->getULong($offset);
|
||||
$offset += 4;
|
||||
$data['bits'] = $byte->getByte($offset);
|
||||
++$offset;
|
||||
$chc = $byte->getByte($offset); // channels code
|
||||
++$offset;
|
||||
$data['channels'] = $chc === 2 ? 3 : 1;
|
||||
$chcmap = [
|
||||
0 => 'DeviceGray',
|
||||
2 => 'DeviceRGB',
|
||||
3 => 'Indexed',
|
||||
4 => 'DeviceGray+Alpha',
|
||||
6 => 'DeviceRGB+Alpha',
|
||||
];
|
||||
if (isset($chcmap[$chc])) {
|
||||
$data['colspace'] = $chcmap[$chc];
|
||||
} else {
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new ImageException('Unknown color mode');
|
||||
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract chunks data from a PNG image.
|
||||
*
|
||||
* @param Byte $byte Byte class object wrapping the raw image data.
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
* @param int $offset Current byte offset.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image is invalid.
|
||||
* @throws \RangeException If the byte offset is out of range.
|
||||
*/
|
||||
protected function getChunks(Byte $byte, array $data, int $offset): array
|
||||
{
|
||||
// getULong() is unsigned so a "len >= 0" guard would always be true; the
|
||||
// loop instead ends on the IEND chunk, or on the RangeException raised
|
||||
// when a (truncated) stream is read past its end.
|
||||
while (true) {
|
||||
$len = $byte->getULong($offset);
|
||||
$offset += 4;
|
||||
$type = \substr($data['raw'], $offset, 4);
|
||||
$offset += 4;
|
||||
if ($type === 'PLTE') {
|
||||
$data = $this->getPlteChunk($data, $offset, $len);
|
||||
} elseif ($type === 'tRNS') {
|
||||
$data = $this->getTrnsChunk($data, $offset, $len);
|
||||
} elseif ($type === 'IDAT') {
|
||||
$data = $this->getIdatChunk($data, $offset, $len);
|
||||
} elseif ($type === 'iCCP') {
|
||||
$data = $this->getIccpChunk($byte, $data, $offset, $len);
|
||||
} elseif ($type === 'IEND') {
|
||||
// The image trailer chunk (IEND) must be the final chunk
|
||||
// and marks the end of the PNG file or data stream.
|
||||
break;
|
||||
} else {
|
||||
$offset += $len;
|
||||
$offset += 4;
|
||||
}
|
||||
}
|
||||
|
||||
if ($data['colspace'] === 'Indexed' && $data['pal'] === '') {
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new ImageException('The color palette is missing');
|
||||
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the PLTE chunk data.
|
||||
*
|
||||
* The palette chunk (PLTE) stores the colormap data associated with the image data.
|
||||
* This chunk is present only if the image data uses a color palette and must appear before the image data chunk.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
* @param int $offset Current byte offset.
|
||||
* @param int $len Number of bytes in this chunk.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*/
|
||||
protected function getPlteChunk(array $data, int &$offset, int $len): array
|
||||
{
|
||||
$data['pal'] = \substr($data['raw'], $offset, $len);
|
||||
$offset += $len;
|
||||
$offset += 4;
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the tRNS chunk data.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
* @param int $offset Current byte offset.
|
||||
* @param int $len Number of bytes in this chunk.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*/
|
||||
protected function getTrnsChunk(array $data, int &$offset, int $len): array
|
||||
{
|
||||
// read transparency info
|
||||
$trns = \substr($data['raw'], $offset, $len);
|
||||
$offset += $len;
|
||||
if ($data['colspace'] === 'DeviceGray') {
|
||||
// DeviceGray
|
||||
$data['trns'][] = \ord($trns[1]);
|
||||
} elseif ($data['colspace'] === 'DeviceRGB') {
|
||||
// DeviceRGB
|
||||
$data['trns'][] = \ord($trns[1]);
|
||||
$data['trns'][] = \ord($trns[3]);
|
||||
$data['trns'][] = \ord($trns[5]);
|
||||
} else {
|
||||
// Indexed
|
||||
$data['trns'] = \array_map('ord', \str_split($trns));
|
||||
}
|
||||
|
||||
$offset += 4;
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the IDAT chunk data.
|
||||
*
|
||||
* The image data chunk (IDAT) stores the actual image data,
|
||||
* and multiple image data chunks may occur in a data stream and must be stored in contiguous order.
|
||||
*
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
* @param int $offset Current byte offset.
|
||||
* @param int $len Number of bytes in this chunk.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*/
|
||||
protected function getIdatChunk(array $data, int &$offset, int $len): array
|
||||
{
|
||||
$data['data'] .= \substr($data['raw'], $offset, $len);
|
||||
$offset += $len;
|
||||
$offset += 4;
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract the iCCP chunk data.
|
||||
*
|
||||
* @param Byte $byte Byte class object.
|
||||
* @param ImageBaseData $data Image raw data.
|
||||
* @param int $offset Current byte offset.
|
||||
* @param int $len Number of bytes in this chunk.
|
||||
*
|
||||
* @return ImageBaseData Image raw data array.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the filter method is unknown.
|
||||
* @throws \RangeException If attempting to read beyond available bytes.
|
||||
*/
|
||||
protected function getIccpChunk(Byte $byte, array $data, int &$offset, int $len): array
|
||||
{
|
||||
// skip profile name
|
||||
$pos = 0;
|
||||
while ($byte->getByte($offset++) !== 0 && $pos < 80) {
|
||||
++$pos;
|
||||
}
|
||||
|
||||
// get compression method
|
||||
if ($byte->getByte($offset++) !== 0) {
|
||||
// @codeCoverageIgnoreStart
|
||||
throw new ImageException('Unknown filter method');
|
||||
|
||||
// @codeCoverageIgnoreEnd
|
||||
}
|
||||
|
||||
// read ICC Color Profile
|
||||
$len -= $pos + 2;
|
||||
$icc = \gzuncompress(\substr($data['raw'], $offset, $len));
|
||||
if ($icc !== false) {
|
||||
$data['icc'] = $icc;
|
||||
} else {
|
||||
throw new ImageException('Error while decompressing ICC profile');
|
||||
}
|
||||
|
||||
$offset += $len;
|
||||
$offset += 4;
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,578 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Output.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Com\Tecnick\Pdf\Image;
|
||||
|
||||
use Com\Tecnick\File\File as ObjFile;
|
||||
use Com\Tecnick\Pdf\Encrypt\Encrypt;
|
||||
use Com\Tecnick\Pdf\Image\Exception as ImageException;
|
||||
|
||||
/**
|
||||
* Com\Tecnick\Pdf\Image\Output
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* @phpstan-type TFileOptions array{
|
||||
* allowedHosts?: array<string>,
|
||||
* maxRemoteSize?: int,
|
||||
* curlopts?: array<int, bool|int|string>,
|
||||
* defaultCurlOpts?: array<int, bool|int|string>,
|
||||
* fixedCurlOpts?: array<int, bool|int|string>
|
||||
* }
|
||||
*
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
* @phpstan-import-type ImageRawData from \Com\Tecnick\Pdf\Image\Import
|
||||
*
|
||||
* @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
|
||||
*/
|
||||
abstract class Output
|
||||
{
|
||||
/**
|
||||
* Current PDF object number.
|
||||
*/
|
||||
protected int $pon;
|
||||
|
||||
/**
|
||||
* Store image object IDs for the XObject Dictionary.
|
||||
*
|
||||
* @var array<string, int>
|
||||
*/
|
||||
protected array $xobjdict = [];
|
||||
|
||||
/**
|
||||
* Stack of added images.
|
||||
*
|
||||
* @var array<int, array{
|
||||
* 'iid': int,
|
||||
* 'key': string,
|
||||
* 'width': int,
|
||||
* 'height': int,
|
||||
* 'defprint': bool,
|
||||
* 'altimgs'?: array<int, int>,
|
||||
* }>
|
||||
*/
|
||||
protected array $image = [];
|
||||
|
||||
/**
|
||||
* Cache used to store imported image data.
|
||||
* The same image data can be reused multiple times.
|
||||
*
|
||||
* @var array<string, ImageRawData>
|
||||
*/
|
||||
protected array $cache = [];
|
||||
|
||||
/**
|
||||
* Initialize images data.
|
||||
*
|
||||
* @param float $kunit Unit of measure conversion ratio.
|
||||
* @param Encrypt $encrypt Encrypt object.
|
||||
* @param ObjFile $fileHelper File helper for image loading and writing.
|
||||
* @param bool $pdfa True if we are in PDF/A mode.
|
||||
* @param bool $compress Set to false to disable stream compression.
|
||||
* @param ?ImageCacheInterface $imageCache Optional external cache to persist processed image
|
||||
* data across instances and processes (null = disabled).
|
||||
*/
|
||||
public function __construct(
|
||||
protected float $kunit,
|
||||
protected Encrypt $encrypt,
|
||||
protected ObjFile $fileHelper,
|
||||
protected bool $pdfa = false,
|
||||
protected bool $compress = true,
|
||||
protected ?ImageCacheInterface $imageCache = null,
|
||||
) {
|
||||
$this->fileHelper = $fileHelper;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns current PDF object number.
|
||||
*/
|
||||
public function getObjectNumber(): int
|
||||
{
|
||||
return $this->pon;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a callback with a temporary file helper.
|
||||
*
|
||||
* @template TResult
|
||||
*
|
||||
* @param ObjFile $fileHelper Temporary file helper to use while the callback executes.
|
||||
* @param callable(): TResult $callback Callback executed with the temporary file helper.
|
||||
*
|
||||
* @return TResult
|
||||
*/
|
||||
public function withFileHelper(ObjFile $fileHelper, callable $callback): mixed
|
||||
{
|
||||
$previousFileHelper = $this->fileHelper;
|
||||
$this->fileHelper = $fileHelper;
|
||||
|
||||
try {
|
||||
return $callback();
|
||||
} finally {
|
||||
$this->fileHelper = $previousFileHelper;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string to print the specified image ID.
|
||||
*
|
||||
* @param int $iid Image ID.
|
||||
* @param float $xpos Abscissa (X coordinate) of the upper-left Image corner in user units.
|
||||
* @param float $ypos Ordinate (Y coordinate) of the upper-left Image corner in user units.
|
||||
* @param float $width Image width in user units.
|
||||
* @param float $height Image height in user units.
|
||||
* @param float $pageheight Page height in user units.
|
||||
*
|
||||
* @return string Image PDF page content.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception If the image ID is not found.
|
||||
*/
|
||||
public function getSetImage(
|
||||
int $iid,
|
||||
float $xpos,
|
||||
float $ypos,
|
||||
float $width,
|
||||
float $height,
|
||||
float $pageheight,
|
||||
): string {
|
||||
$img = $this->image[$iid] ?? null;
|
||||
if ($img === null) {
|
||||
throw new ImageException('Unknown image ID: ' . $iid);
|
||||
}
|
||||
|
||||
$out = 'q';
|
||||
$out .= \sprintf(
|
||||
' %F 0 0 %F %F %F cm',
|
||||
$width * $this->kunit,
|
||||
$height * $this->kunit,
|
||||
$xpos * $this->kunit,
|
||||
($pageheight - $ypos - $height) * $this->kunit, // reverse coordinate
|
||||
);
|
||||
|
||||
if (!isset($this->cache[$img['key']]['mask'])) {
|
||||
return $out . ' /IMG' . $iid . ' Do Q' . "\n";
|
||||
}
|
||||
|
||||
if (!isset($this->cache[$img['key']]['plain'])) {
|
||||
return $out . ' /IMGmask' . $iid . ' Do Q' . "\n";
|
||||
}
|
||||
|
||||
return $out . ' /IMGplain' . $iid . ' Do Q' . "\n";
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string for Images.
|
||||
*
|
||||
* @param int $pon Current PDF Object Number.
|
||||
*
|
||||
* @return string PDF code for the images block.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception If image object encryption fails.
|
||||
*/
|
||||
public function getOutImagesBlock(int $pon): string
|
||||
{
|
||||
$this->pon = $pon;
|
||||
$out = '';
|
||||
foreach ($this->image as $iid => $img) {
|
||||
if (!isset($this->cache[$img['key']]['out'])) {
|
||||
if (isset($this->cache[$img['key']]['mask'])) {
|
||||
/** @var ImageRawData $mask */
|
||||
$mask = &$this->cache[$img['key']]['mask'];
|
||||
$out .= $this->getOutImage($img, $mask, 'mask');
|
||||
if (isset($this->cache[$img['key']]['plain'])) {
|
||||
/** @var ImageRawData $plain */
|
||||
$plain = &$this->cache[$img['key']]['plain'];
|
||||
$out .= $this->getOutImage($img, $plain, 'plain');
|
||||
}
|
||||
}
|
||||
|
||||
if (!isset($this->cache[$img['key']]['mask'])) {
|
||||
$out .= $this->getOutImage($img, $this->cache[$img['key']]);
|
||||
}
|
||||
|
||||
unset($mask, $plain);
|
||||
|
||||
$this->image[$iid] = $img;
|
||||
}
|
||||
|
||||
if (($this->cache[$img['key']]['mask']['obj'] ?? 0) === 0) {
|
||||
$this->xobjdict['IMG' . $img['iid']] = $this->cache[$img['key']]['obj'];
|
||||
} else {
|
||||
$maskData = $this->cache[$img['key']]['mask'] ?? null;
|
||||
if ($maskData === null) {
|
||||
$this->xobjdict['IMG' . $img['iid']] = $this->cache[$img['key']]['obj'];
|
||||
continue;
|
||||
}
|
||||
|
||||
$plainData = $this->cache[$img['key']]['plain'] ?? null;
|
||||
if (($plainData['obj'] ?? 0) === 0) {
|
||||
$this->xobjdict['IMGmask' . $img['iid']] = (int) $maskData['obj'];
|
||||
} elseif ($plainData !== null) {
|
||||
$this->xobjdict['IMGplain' . $img['iid']] = (int) $plainData['obj'];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string for Image object.
|
||||
*
|
||||
* @param array{
|
||||
* 'iid': int,
|
||||
* 'key': string,
|
||||
* 'width': int,
|
||||
* 'height': int,
|
||||
* 'defprint': bool,
|
||||
* 'altimgs'?: array<int, int>,
|
||||
* } $img Image reference.
|
||||
* @param ImageRawData $data Image raw data.
|
||||
* @param string $sub Sub image ('mask', 'plain' or empty string).
|
||||
*
|
||||
* @return string PDF Image object.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception If image data encryption fails.
|
||||
*/
|
||||
protected function getOutImage(array &$img, array &$data, string $sub = ''): string
|
||||
{
|
||||
$out = $this->getOutIcc($data) . $this->getOutPalette($data) . $this->getOutAltImages($img, $data, $sub);
|
||||
|
||||
$data['obj'] = ++$this->pon;
|
||||
|
||||
$out .=
|
||||
$data['obj']
|
||||
. ' 0 obj'
|
||||
. "\n"
|
||||
. '<<'
|
||||
. ' /Type /XObject'
|
||||
. ' /Subtype /Image'
|
||||
. ' /Width '
|
||||
. $data['width']
|
||||
. ' /Height '
|
||||
. $data['height']
|
||||
. $this->getOutColorInfo($data);
|
||||
|
||||
if ($data['exturl']) {
|
||||
// external stream
|
||||
$out .=
|
||||
' /Length 0 /F'
|
||||
. ' <<'
|
||||
. ' /FS /URL /F '
|
||||
. $this->encrypt->escapeDataString('true', $this->pon)
|
||||
. ' >>';
|
||||
if ($data['filter'] !== '') {
|
||||
$out .= ' /FFilter /' . $data['filter'];
|
||||
}
|
||||
|
||||
$out .= ' >>' . "\n";
|
||||
} else {
|
||||
if ($data['filter'] !== '') {
|
||||
$out .= ' /Filter /' . $data['filter'];
|
||||
}
|
||||
|
||||
if ($data['parms'] !== '') {
|
||||
$out .= ' ' . $data['parms'];
|
||||
}
|
||||
|
||||
// Colour Key Masking
|
||||
if ($data['trns'] !== []) {
|
||||
$trns = $this->getOutTransparency($data);
|
||||
if ($trns !== '') {
|
||||
$out .= ' /Mask [ ' . $trns . ']';
|
||||
}
|
||||
}
|
||||
|
||||
$stream = $this->encrypt->encryptString($data['data'], $this->pon);
|
||||
$out .= ' /Length ' . \strlen($stream) . '>> stream' . "\n" . $stream . "\n" . 'endstream' . "\n";
|
||||
}
|
||||
|
||||
$out .= 'endobj' . "\n";
|
||||
|
||||
$this->cache[$img['key']]['out'] = true; // mark this as done
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return XObjects Dictionary portion for the images.
|
||||
*/
|
||||
public function getXobjectDict(): string
|
||||
{
|
||||
$out = '';
|
||||
foreach ($this->xobjdict as $iid => $objid) {
|
||||
$out .= ' /' . $iid . ' ' . $objid . ' 0 R';
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return XObjects Dictionary.
|
||||
*
|
||||
* @param array<int> $keys Image IDs.
|
||||
*/
|
||||
public function getXobjectDictByKeys(array $keys): string
|
||||
{
|
||||
if ($keys === []) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$out = '';
|
||||
|
||||
foreach ($keys as $iid) {
|
||||
$key = 'IMG' . $iid;
|
||||
if (isset($this->xobjdict[$key])) {
|
||||
$out .= ' /' . $key . ' ' . $this->xobjdict[$key] . ' 0 R';
|
||||
continue;
|
||||
}
|
||||
$key = 'IMGplain' . $iid;
|
||||
if (isset($this->xobjdict[$key])) {
|
||||
$out .= ' /' . $key . ' ' . $this->xobjdict[$key] . ' 0 R';
|
||||
continue;
|
||||
}
|
||||
$key = 'IMGmask' . $iid;
|
||||
if (isset($this->xobjdict[$key])) {
|
||||
$out .= ' /' . $key . ' ' . $this->xobjdict[$key] . ' 0 R';
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string for ICC object.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception If ICC profile encryption fails.
|
||||
*/
|
||||
protected function getOutIcc(array &$data): string
|
||||
{
|
||||
if ($data['icc'] === '') {
|
||||
return '';
|
||||
}
|
||||
|
||||
$data['obj_icc'] = ++$this->pon;
|
||||
$out =
|
||||
$data['obj_icc']
|
||||
. ' 0 obj'
|
||||
. "\n"
|
||||
. '<<'
|
||||
. ' /N '
|
||||
. $data['channels']
|
||||
. ' /Alternate /'
|
||||
. $data['colspace'];
|
||||
$icc = $data['icc'];
|
||||
if ($this->compress) {
|
||||
$out .= ' /Filter /FlateDecode';
|
||||
$cicc = \gzcompress($icc);
|
||||
if ($cicc !== false) {
|
||||
$icc = $cicc;
|
||||
}
|
||||
}
|
||||
|
||||
$stream = $this->encrypt->encryptString($icc, $this->pon);
|
||||
return (
|
||||
$out . (
|
||||
' /Length '
|
||||
. \strlen($stream)
|
||||
. ' >>'
|
||||
. ' stream'
|
||||
. "\n"
|
||||
. $stream
|
||||
. "\n"
|
||||
. 'endstream'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n"
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string for Indexed palette object.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception If palette encryption fails.
|
||||
*/
|
||||
protected function getOutPalette(array &$data): string
|
||||
{
|
||||
if ($data['colspace'] !== 'Indexed') {
|
||||
return '';
|
||||
}
|
||||
|
||||
$data['obj_pal'] = ++$this->pon;
|
||||
$out = $data['obj_pal'] . ' 0 obj' . "\n" . '<<';
|
||||
$pal = $data['pal'];
|
||||
if ($this->compress) {
|
||||
$out .= '/Filter /FlateDecode';
|
||||
$cpal = \gzcompress($pal);
|
||||
if ($cpal !== false) {
|
||||
$pal = $cpal;
|
||||
}
|
||||
}
|
||||
|
||||
$stream = $this->encrypt->encryptString($pal, $this->pon);
|
||||
return (
|
||||
$out . (
|
||||
' /Length '
|
||||
. \strlen($stream)
|
||||
. '>>'
|
||||
. ' stream'
|
||||
. "\n"
|
||||
. $stream
|
||||
. "\n"
|
||||
. 'endstream'
|
||||
. "\n"
|
||||
. 'endobj'
|
||||
. "\n"
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string for color and mask information.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
*/
|
||||
protected function getOutColorInfo(array $data): string
|
||||
{
|
||||
$out = '';
|
||||
// set color space
|
||||
if ($data['obj_icc'] !== 0) {
|
||||
// ICC Colour Space
|
||||
$out .= ' /ColorSpace [/ICCBased ' . $data['obj_icc'] . ' 0 R]';
|
||||
} elseif ($data['obj_pal'] !== 0) {
|
||||
// Indexed Colour Space
|
||||
$out .=
|
||||
' /ColorSpace [/Indexed /DeviceRGB '
|
||||
. ((\strlen($data['pal']) / 3) - 1)
|
||||
. ' '
|
||||
. $data['obj_pal']
|
||||
. ' 0 R]';
|
||||
} else {
|
||||
// Device Colour Space
|
||||
$out .= ' /ColorSpace /' . $data['colspace'];
|
||||
}
|
||||
|
||||
if ($data['colspace'] === 'DeviceCMYK') {
|
||||
$out .= ' /Decode [1 0 1 0 1 0 1 0]';
|
||||
}
|
||||
|
||||
$out .= ' /BitsPerComponent ' . $data['bits'];
|
||||
|
||||
$maskobj = (int) ($this->cache[$data['key']]['mask']['obj'] ?? 0);
|
||||
if (!$data['ismask'] && $maskobj > 0) {
|
||||
$out .= ' /SMask ' . $maskobj . ' 0 R';
|
||||
}
|
||||
|
||||
if ($data['obj_alt'] !== 0) {
|
||||
// reference to alternate images dictionary
|
||||
$out .= ' /Alternates ' . $data['obj_alt'] . ' 0 R';
|
||||
}
|
||||
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string for Alternate images object.
|
||||
*
|
||||
* @param array{
|
||||
* 'iid': int,
|
||||
* 'key': string,
|
||||
* 'width': int,
|
||||
* 'height': int,
|
||||
* 'defprint': bool,
|
||||
* 'altimgs'?: array<int, int>,
|
||||
* } $img Image reference.
|
||||
* @param ImageRawData $data Image raw data.
|
||||
* @param string $sub Sub image ('mask', 'plain' or empty string).
|
||||
*/
|
||||
protected function getOutAltImages(array $img, array &$data, string $sub = ''): string
|
||||
{
|
||||
if ($this->pdfa || !isset($img['altimgs']) || $img['altimgs'] === [] || $sub === 'mask') {
|
||||
return '';
|
||||
}
|
||||
|
||||
$data['obj_alt'] = ++$this->pon;
|
||||
|
||||
$out = $this->pon . ' 0 obj' . "\n" . '[';
|
||||
foreach ($img['altimgs'] as $iid) {
|
||||
$altimg = $this->image[$iid] ?? null;
|
||||
if ($altimg === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$altobj = (int) ($this->cache[$altimg['key']]['obj'] ?? 0);
|
||||
if ($altobj === 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$out .=
|
||||
' << /Image '
|
||||
. $altobj
|
||||
. ' 0 R'
|
||||
. ' /DefaultForPrinting '
|
||||
. ($altimg['defprint'] ? 'true' : 'false')
|
||||
. ' >>';
|
||||
}
|
||||
|
||||
return $out . (' ]' . "\n" . 'endobj' . "\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the PDF output string for color transparency.
|
||||
*
|
||||
* @param ImageRawData $data Image raw data.
|
||||
*/
|
||||
protected function getOutTransparency(array $data): string
|
||||
{
|
||||
$trns = '';
|
||||
|
||||
if ($data['colspace'] === 'Indexed') {
|
||||
// Indexed: trns holds one alpha byte per palette entry; mask the
|
||||
// fully-transparent entries (alpha 0) by their palette index.
|
||||
foreach ($data['trns'] as $idx => $val) {
|
||||
if ($val !== 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$trns .= $idx . ' ' . $idx . ' ';
|
||||
}
|
||||
|
||||
return $trns;
|
||||
}
|
||||
|
||||
// DeviceRGB / DeviceGray: trns holds the transparent colour sample
|
||||
// values themselves, emitted as single-value colour-key ranges.
|
||||
foreach ($data['trns'] as $val) {
|
||||
$trns .= $val . ' ' . $val . ' ';
|
||||
}
|
||||
|
||||
return $trns;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* ImageCacheTest.php
|
||||
*
|
||||
* @since 2026-06-16
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Com\Tecnick\Pdf\Image\ImageCacheInterface;
|
||||
use Com\Tecnick\Pdf\Image\Import;
|
||||
|
||||
/**
|
||||
* External image cache test.
|
||||
*
|
||||
* @since 2026-06-16
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*/
|
||||
class ImageCacheTest extends TestUtil
|
||||
{
|
||||
private function getImport(?ImageCacheInterface $cache): Import
|
||||
{
|
||||
return new Import(0.75, $this->getTestEncrypt(), $this->getTestFileHelper(), imageCache: $cache);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testWriteThroughAndReadThrough(): void
|
||||
{
|
||||
$src = __DIR__ . '/images/200x100_RGB.png';
|
||||
|
||||
$spy = new SpyImageCache();
|
||||
$img1 = $this->getImport($spy);
|
||||
$img1->add($src);
|
||||
|
||||
// one external lookup (miss) + one write-through
|
||||
$this->assertSame(1, $spy->getCount);
|
||||
$this->assertCount(1, $spy->setKeys);
|
||||
|
||||
// doctor the stored entry with a sentinel: a hit must be returned verbatim
|
||||
$key = $spy->setKeys[0] ?? '';
|
||||
$this->assertArrayHasKey($key, $spy->store);
|
||||
if (isset($spy->store[$key])) {
|
||||
$spy->store[$key]['width'] = 4321;
|
||||
}
|
||||
|
||||
// a fresh Import (empty in-process cache) reusing the same backend
|
||||
$img2 = $this->getImport($spy);
|
||||
$img2->add($src);
|
||||
$data = $img2->getImageDataByKey($img2->getKey($src));
|
||||
|
||||
// proves the external entry was used as-is (no recomputation)
|
||||
$this->assertSame(4321, $data['width']);
|
||||
// no additional write-through happened on a hit
|
||||
$this->assertCount(1, $spy->setKeys);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testDisabledByDefault(): void
|
||||
{
|
||||
$src = __DIR__ . '/images/200x100_RGB.png';
|
||||
|
||||
$img = $this->getImport(null);
|
||||
$img->add($src);
|
||||
$data = $img->getImageDataByKey($img->getKey($src));
|
||||
|
||||
// with no external cache, the in-process data keeps the original bytes
|
||||
$this->assertNotEmpty($data['data']);
|
||||
$this->assertNotEmpty($data['raw']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testPersistedSnapshotIsClean(): void
|
||||
{
|
||||
$spy = new SpyImageCache();
|
||||
$img = $this->getImport($spy);
|
||||
$img->add(__DIR__ . '/images/200x100_RGBALPHA.png');
|
||||
|
||||
$stored = $spy->fetch($spy->setKeys[0] ?? '');
|
||||
|
||||
// original bytes dropped to shrink the payload
|
||||
$this->assertSame('', $stored['raw']);
|
||||
// no PDF object numbers / output flag are persisted
|
||||
$this->assertSame(0, $stored['obj']);
|
||||
$this->assertSame(0, $stored['obj_alt']);
|
||||
$this->assertSame(0, $stored['obj_icc']);
|
||||
$this->assertSame(0, $stored['obj_pal']);
|
||||
$this->assertArrayNotHasKey('out', $stored);
|
||||
|
||||
// alpha image splits into plain + mask: their raw bytes are dropped too
|
||||
$this->assertArrayHasKey('mask', $stored);
|
||||
if (isset($stored['mask'])) {
|
||||
$this->assertSame('', $stored['mask']['raw']);
|
||||
}
|
||||
if (isset($stored['plain'])) {
|
||||
$this->assertSame('', $stored['plain']['raw']);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testStaleFileProducesDifferentKey(): void
|
||||
{
|
||||
$tmp = $this->makeTempFile('.png');
|
||||
\copy(__DIR__ . '/images/200x100_RGB.png', $tmp);
|
||||
\clearstatcache(true, $tmp);
|
||||
|
||||
$spy = new SpyImageCache();
|
||||
$this->getImport($spy)->add($tmp);
|
||||
$this->assertCount(1, $spy->setKeys);
|
||||
$firstKey = $spy->setKeys[0] ?? '';
|
||||
|
||||
// edit the file in place: different content/size and a newer mtime
|
||||
\copy(__DIR__ . '/images/200x100_GRAY.png', $tmp);
|
||||
\touch($tmp, \time() + 5);
|
||||
\clearstatcache(true, $tmp);
|
||||
|
||||
$this->getImport($spy)->add($tmp);
|
||||
$this->assertCount(2, $spy->setKeys);
|
||||
|
||||
// mtime+size folded into the persistent key invalidates the stale entry
|
||||
$this->assertNotSame($firstKey, $spy->setKeys[1] ?? '');
|
||||
|
||||
\unlink($tmp);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testOutputIdenticalWithAndWithoutCache(): void
|
||||
{
|
||||
$src = __DIR__ . '/images/200x100_RGB.png';
|
||||
|
||||
$ref = $this->getImport(null);
|
||||
$ref->add($src);
|
||||
$refOut = $ref->getOutImagesBlock(10);
|
||||
|
||||
$spy = new SpyImageCache();
|
||||
// warm the cache, then import again from a fresh instance (external hit)
|
||||
$this->getImport($spy)->add($src);
|
||||
$cached = $this->getImport($spy);
|
||||
$cached->add($src);
|
||||
$cachedOut = $cached->getOutImagesBlock(10);
|
||||
|
||||
// stripping raw never affects the emitted PDF objects
|
||||
$this->assertSame($refOut, $cachedOut);
|
||||
}
|
||||
|
||||
private function makeTempFile(string $ext): string
|
||||
{
|
||||
return \sys_get_temp_dir() . \DIRECTORY_SEPARATOR . 'tclpi_' . \uniqid('', true) . $ext;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,421 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* ImportEdgeCasesTest.php
|
||||
*
|
||||
* @since 2026-04-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Import edge cases test
|
||||
*
|
||||
* @since 2026-04-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*/
|
||||
class ImportEdgeCasesTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Pdf\Image\Import
|
||||
{
|
||||
$encrypt = $this->getTestEncrypt();
|
||||
return new \Com\Tecnick\Pdf\Image\Import(0.75, $encrypt, $this->getTestFileHelper());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithZeroWidth(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png', 0, 50);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithZeroHeight(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png', 100, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithOnlyWidthKeepsAspectRatio(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png', 100, null);
|
||||
|
||||
$key = $import->getKey(__DIR__ . '/images/200x100_RGB.png', 100, 0, 100);
|
||||
$data = $import->getImageDataByKey($key);
|
||||
$this->assertSame(100, $data['width']);
|
||||
$this->assertSame(50, $data['height']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithOnlyHeightKeepsAspectRatio(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png', null, 50);
|
||||
|
||||
$key = $import->getKey(__DIR__ . '/images/200x100_RGB.png', 0, 50, 100);
|
||||
$data = $import->getImageDataByKey($key);
|
||||
$this->assertSame(100, $data['width']);
|
||||
$this->assertSame(50, $data['height']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithQualityLow(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.jpg', null, null, false, 0);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithQualityHigh(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.jpg', null, null, false, 100);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithQualityExceeding100(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Quality > 100 should be clamped to 100
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.jpg', null, null, false, 150);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithNegativeQuality(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Negative quality should be clamped to 0
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.jpg', null, null, false, -50);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithMaskAndAlphaParameters(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Add image as mask
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png', null, null, true);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithDefprintParameter(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Add with defprint=true
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png', null, null, false, 100, true);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithAlternateImages(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid1 = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$iid2 = $import->add(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
// Add with alternate images
|
||||
$iid3 = $import->add(__DIR__ . '/images/200x100_RGBALPHA.png', null, null, false, 100, false, [$iid1, $iid2]);
|
||||
$this->assertGreaterThan(0, $iid3);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddImageFromStringData(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$fileData = \file_get_contents(__DIR__ . '/images/200x100_RGB.png');
|
||||
$this->assertIsString($fileData);
|
||||
|
||||
// Add image from raw data
|
||||
$iid = $import->add('@' . $fileData);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetKeyConsistency(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Same image parameters should produce same key
|
||||
$key1 = $import->getKey('/path/image.png', 100, 200, 75);
|
||||
$key2 = $import->getKey('/path/image.png', 100, 200, 75);
|
||||
$this->assertEquals($key1, $key2);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetKeyDifference(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Different parameters should produce different keys
|
||||
$key1 = $import->getKey('/path/image.png', 100, 200, 75);
|
||||
$key2 = $import->getKey('/path/image.png', 100, 200, 80);
|
||||
$this->assertNotEquals($key1, $key2);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testMultipleAddOperations(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid1 = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$iid2 = $import->add(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
$iid3 = $import->add(__DIR__ . '/images/200x100_RGBALPHA.png');
|
||||
|
||||
$this->assertEquals(1, $iid1);
|
||||
$this->assertEquals(2, $iid2);
|
||||
$this->assertEquals(3, $iid3);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testRepeatedImageAddition(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Adding the same image twice with same params should reuse cache
|
||||
$iid1 = $import->add(__DIR__ . '/images/200x100_RGB.png', 100, 50);
|
||||
$iid2 = $import->add(__DIR__ . '/images/200x100_RGB.png', 100, 50);
|
||||
|
||||
// Should have different image IDs but share same cached data
|
||||
$this->assertEquals(1, $iid1);
|
||||
$this->assertEquals(2, $iid2);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithResizeDownscale(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Downscale image
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png', 100, 50);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAddWithResizeUpscale(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Upscale image
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png', 400, 200);
|
||||
$this->assertGreaterThan(0, $iid);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageAfterMultipleAdds(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid1 = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$iid2 = $import->add(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
$iid3 = $import->add(__DIR__ . '/images/200x100_RGBALPHA.png');
|
||||
|
||||
$result1 = $import->getSetImage($iid1, 0, 0, 100, 100, 600);
|
||||
$result2 = $import->getSetImage($iid2, 0, 0, 100, 100, 600);
|
||||
$result3 = $import->getSetImage($iid3, 0, 0, 100, 100, 600);
|
||||
|
||||
$this->assertNotEmpty($result1);
|
||||
$this->assertNotEmpty($result2);
|
||||
$this->assertNotEmpty($result3);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testInvalidImageFile(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/nonexistent.png');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testInvalidImageData(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->add('@invalidbinarydata');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDimensionsByKeyReturnsOriginal(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$image = __DIR__ . '/images/200x100_RGB.png';
|
||||
$import->add($image);
|
||||
$key = $import->getKey($image, 0, 0, 100);
|
||||
|
||||
$this->assertSame(['width' => 200, 'height' => 100], $import->getImageDimensionsByKey($key));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDimensionsByKeyDerivesHeightFromWidth(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$image = __DIR__ . '/images/200x100_RGB.png';
|
||||
$import->add($image);
|
||||
$key = $import->getKey($image, 0, 0, 100);
|
||||
|
||||
$this->assertSame(['width' => 100, 'height' => 50], $import->getImageDimensionsByKey($key, 100));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDimensionsByKeyDerivesWidthFromHeight(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$image = __DIR__ . '/images/200x100_RGB.png';
|
||||
$import->add($image);
|
||||
$key = $import->getKey($image, 0, 0, 100);
|
||||
|
||||
$this->assertSame(['width' => 100, 'height' => 50], $import->getImageDimensionsByKey($key, 0, 50));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDimensionsByKeyKeepsBothWhenSpecified(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$image = __DIR__ . '/images/200x100_RGB.png';
|
||||
$import->add($image);
|
||||
$key = $import->getKey($image, 0, 0, 100);
|
||||
|
||||
$this->assertSame(['width' => 80, 'height' => 80], $import->getImageDimensionsByKey($key, 80, 80));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDimensionsByKeyFitWithinBox(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$image = __DIR__ . '/images/200x100_RGB.png';
|
||||
$import->add($image);
|
||||
$key = $import->getKey($image, 0, 0, 100);
|
||||
|
||||
// box 80x80, source 200x100: scale = min(0.4, 0.8) = 0.4 => 80x40
|
||||
$this->assertSame(['width' => 80, 'height' => 40], $import->getImageDimensionsByKey($key, 80, 80, true));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDimensionsByKeyUnknownKeyThrows(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->getImageDimensionsByKey('nonexistent-key');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,353 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* ImportOutputPngEdgeCasesTest.php
|
||||
*
|
||||
* @since 2026-05-21
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test;
|
||||
|
||||
require_once __DIR__ . '/ImportProtectedMethodsHarness.php';
|
||||
require_once __DIR__ . '/PngChunkParsingHarness.php';
|
||||
|
||||
/**
|
||||
* Extra branch-focused tests for import, output and PNG chunk parsing.
|
||||
*
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
* @phpstan-import-type ImageRawData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
class ImportOutputPngEdgeCasesTest extends TestUtil
|
||||
{
|
||||
/**
|
||||
* @return ImageBaseData
|
||||
*/
|
||||
protected function getBaseData(string $key = 'test'): array
|
||||
{
|
||||
return [
|
||||
'bits' => 8,
|
||||
'channels' => 3,
|
||||
'colspace' => 'DeviceRGB',
|
||||
'data' => 'abc',
|
||||
'exturl' => false,
|
||||
'file' => '',
|
||||
'filter' => 'FlateDecode',
|
||||
'height' => 1,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => $key,
|
||||
'mapto' => IMAGETYPE_PNG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => 'raw',
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_PNG,
|
||||
'width' => 1,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return ImageRawData
|
||||
*/
|
||||
protected function getRawData(string $key = 'test'): array
|
||||
{
|
||||
return $this->getBaseData($key);
|
||||
}
|
||||
|
||||
protected function getImportHarness(bool $pdfa = false): ImportProtectedMethodsHarness
|
||||
{
|
||||
return new ImportProtectedMethodsHarness(
|
||||
0.75,
|
||||
$this->getTestEncrypt(),
|
||||
$this->getTestFileHelper(),
|
||||
$pdfa,
|
||||
false,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function testGetDataThrowsWhenImageIsNotNative(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
|
||||
$import = $this->getImportHarness();
|
||||
$data = $this->getRawData();
|
||||
$data['native'] = false;
|
||||
$import->callGetData($data, 10, 10, 90);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function testGetDataThrowsWhenNativeTypeIsUnknown(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
|
||||
$import = $this->getImportHarness();
|
||||
$data = $this->getRawData();
|
||||
$data['type'] = IMAGETYPE_GIF;
|
||||
$import->callGetData($data, 10, 10, 90);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function testGetResizedRawDataRejectsInvalidRawImage(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
|
||||
$import = $this->getImportHarness();
|
||||
$data = $this->getBaseData();
|
||||
$data['raw'] = 'not-image-binary';
|
||||
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
$import->callGetResizedRawData($data, 10, 10, true, 90);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function testGetAlphaChannelRawDataRejectsInvalidRawImage(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
|
||||
$import = $this->getImportHarness();
|
||||
$data = $this->getBaseData();
|
||||
$data['raw'] = 'not-image-binary';
|
||||
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
$import->callGetAlphaChannelRawData($data);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetOutImageSupportsExternalStreamWithFilter(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
$import->setPon(10);
|
||||
|
||||
$img = [
|
||||
'iid' => 1,
|
||||
'key' => 'ext',
|
||||
'width' => 10,
|
||||
'height' => 5,
|
||||
'defprint' => false,
|
||||
'altimgs' => [],
|
||||
];
|
||||
$data = $this->getRawData('ext');
|
||||
$data['exturl'] = true;
|
||||
$data['filter'] = 'ASCIIHexDecode';
|
||||
$data['width'] = 10;
|
||||
$data['height'] = 5;
|
||||
|
||||
$import->setCacheEntry('ext', $data);
|
||||
$out = $import->callGetOutImage($img, $data);
|
||||
|
||||
$this->assertStringContainsString('/Length 0 /F << /FS /URL /F (true) >>', $out);
|
||||
$this->assertStringContainsString('/FFilter /ASCIIHexDecode', $out);
|
||||
}
|
||||
|
||||
public function testGetXobjectDictByKeysFallsBackToPlainAndMaskEntries(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
$import->setXobjdict([
|
||||
'IMGplain2' => 42,
|
||||
'IMGmask3' => 43,
|
||||
]);
|
||||
|
||||
$out = $import->getXobjectDictByKeys([2, 3]);
|
||||
$this->assertSame(' /IMGplain2 42 0 R /IMGmask3 43 0 R', $out);
|
||||
}
|
||||
|
||||
public function testGetOutAltImagesSkipsUnknownOrUnbuiltAlternateImages(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
$import->setPon(20);
|
||||
|
||||
$import->setImageEntry(2, [
|
||||
'iid' => 2,
|
||||
'key' => 'alt-no-object',
|
||||
'width' => 10,
|
||||
'height' => 5,
|
||||
'defprint' => true,
|
||||
'altimgs' => [],
|
||||
]);
|
||||
|
||||
$altData = $this->getRawData('alt-no-object');
|
||||
$altData['obj'] = 0;
|
||||
$import->setCacheEntry('alt-no-object', $altData);
|
||||
|
||||
$img = [
|
||||
'iid' => 1,
|
||||
'key' => 'main',
|
||||
'width' => 10,
|
||||
'height' => 5,
|
||||
'defprint' => false,
|
||||
'altimgs' => [999, 2],
|
||||
];
|
||||
$data = $this->getRawData('main');
|
||||
|
||||
$out = $import->callGetOutAltImages($img, $data);
|
||||
|
||||
$this->assertStringContainsString('21 0 obj', $out);
|
||||
$this->assertStringContainsString('[ ]', $out);
|
||||
}
|
||||
|
||||
public function testGetOutTransparencyIndexedSkipsNonZeroValues(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
$data = $this->getRawData();
|
||||
$data['colspace'] = 'Indexed';
|
||||
$data['trns'] = [0 => 0, 1 => 9, 2 => 0];
|
||||
|
||||
// Indexed: the fully-transparent palette indices (alpha 0) are masked.
|
||||
$out = $import->callGetOutTransparency($data);
|
||||
$this->assertSame('0 0 2 2 ', $out);
|
||||
}
|
||||
|
||||
public function testGetOutTransparencyRgbUsesColorValues(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
$data = $this->getRawData();
|
||||
$data['colspace'] = 'DeviceRGB';
|
||||
// trns holds the transparent colour sample values (R, G, B).
|
||||
$data['trns'] = [255, 128, 0];
|
||||
|
||||
$out = $import->callGetOutTransparency($data);
|
||||
$this->assertSame('255 255 128 128 0 0 ', $out);
|
||||
}
|
||||
|
||||
public function testGetOutTransparencyGrayUsesColorValue(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
$data = $this->getRawData();
|
||||
$data['colspace'] = 'DeviceGray';
|
||||
$data['trns'] = [128];
|
||||
|
||||
$out = $import->callGetOutTransparency($data);
|
||||
$this->assertSame('128 128 ', $out);
|
||||
}
|
||||
|
||||
public function testGetTrnsChunkHandlesGrayAndRgbFormats(): void
|
||||
{
|
||||
$png = new PngChunkParsingHarness();
|
||||
|
||||
$gray = $this->getBaseData();
|
||||
$gray['colspace'] = 'DeviceGray';
|
||||
$gray['raw'] = "\x00\x7f";
|
||||
$gray['trns'] = [];
|
||||
$grayOffset = 0;
|
||||
$gray = $png->callGetTrnsChunk($gray, $grayOffset, 2);
|
||||
$this->assertSame([127], $gray['trns']);
|
||||
$this->assertSame(6, $grayOffset);
|
||||
|
||||
$rgb = $this->getBaseData();
|
||||
$rgb['colspace'] = 'DeviceRGB';
|
||||
$rgb['raw'] = "\x00\x11\x00\x22\x00\x33";
|
||||
$rgb['trns'] = [];
|
||||
$rgbOffset = 0;
|
||||
$rgb = $png->callGetTrnsChunk($rgb, $rgbOffset, 6);
|
||||
$this->assertSame([17, 34, 51], $rgb['trns']);
|
||||
$this->assertSame(10, $rgbOffset);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetIccpChunkThrowsOnInvalidCompressedProfile(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
|
||||
$png = new PngChunkParsingHarness();
|
||||
$data = $this->getBaseData();
|
||||
$data['raw'] = "ICC\x00\x00BAD";
|
||||
$offset = 0;
|
||||
$byte = new \Com\Tecnick\File\Byte($data['raw']);
|
||||
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
$png->callGetIccpChunk($byte, $data, $offset, 8);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function testGetResizedRawDataPreservesIndexedTransparency(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
|
||||
$raw = \file_get_contents(__DIR__ . '/images/200x100_INDEXALPHA.png');
|
||||
$this->assertIsString($raw);
|
||||
|
||||
$data = $this->getBaseData();
|
||||
$data['raw'] = $raw;
|
||||
$data['width'] = 200;
|
||||
$data['height'] = 100;
|
||||
|
||||
// alpha=false exercises the indexed-palette transparency branch.
|
||||
\set_error_handler(static fn(): bool => true);
|
||||
try {
|
||||
$resized = $import->callGetResizedRawData($data, 100, 50, false, 90);
|
||||
} finally {
|
||||
\restore_error_handler();
|
||||
}
|
||||
|
||||
$this->assertSame(100, $resized['width']);
|
||||
$this->assertSame(50, $resized['height']);
|
||||
$this->assertTrue($resized['recoded']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDimensionsByKeyFitWithZeroSourceReturnsBox(): void
|
||||
{
|
||||
$import = $this->getImportHarness();
|
||||
|
||||
$data = $this->getRawData('zero-source');
|
||||
$data['width'] = 0;
|
||||
$data['height'] = 0;
|
||||
$import->setCacheEntry('zero-source', $data);
|
||||
|
||||
// A zero-sized source falls back to the requested bounding box as-is.
|
||||
$this->assertSame(
|
||||
['width' => 80, 'height' => 80],
|
||||
$import->getImageDimensionsByKey('zero-source', 80, 80, true),
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
* @phpstan-import-type ImageRawData from \Com\Tecnick\Pdf\Image\Import
|
||||
* @phpstan-type ImageRef array{'iid': int, 'key': string, 'width': int, 'height': int, 'defprint': bool, 'altimgs'?: array<int, int>}
|
||||
*/
|
||||
class ImportProtectedMethodsHarness extends \Com\Tecnick\Pdf\Image\Import
|
||||
{
|
||||
/**
|
||||
* @param ImageRawData $data
|
||||
*
|
||||
* @return ImageRawData
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function callGetData(array $data, int $width, int $height, int $quality): array
|
||||
{
|
||||
return $this->getData($data, $width, $height, $quality);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageBaseData $data
|
||||
*
|
||||
* @return ImageRawData
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function callGetResizedRawData(
|
||||
array $data,
|
||||
int $width,
|
||||
int $height,
|
||||
bool $alpha = true,
|
||||
int $quality = 100,
|
||||
): array {
|
||||
return $this->getResizedRawData($data, $width, $height, $alpha, $quality);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageBaseData $data
|
||||
*
|
||||
* @return ImageRawData
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
*/
|
||||
public function callGetAlphaChannelRawData(array $data): array
|
||||
{
|
||||
return $this->getAlphaChannelRawData($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageRef $img
|
||||
* @param ImageRawData $data
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function callGetOutImage(array &$img, array &$data, string $sub = ''): string
|
||||
{
|
||||
return $this->getOutImage($img, $data, $sub);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageRef $img
|
||||
* @param ImageRawData $data
|
||||
*/
|
||||
public function callGetOutAltImages(array $img, array &$data, string $sub = ''): string
|
||||
{
|
||||
return $this->getOutAltImages($img, $data, $sub);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageRawData $data
|
||||
*/
|
||||
public function callGetOutTransparency(array $data): string
|
||||
{
|
||||
return $this->getOutTransparency($data);
|
||||
}
|
||||
|
||||
public function setPon(int $pon): void
|
||||
{
|
||||
$this->pon = $pon;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageRawData $data
|
||||
*/
|
||||
public function setCacheEntry(string $key, array $data): void
|
||||
{
|
||||
$this->cache[$key] = $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, int> $xobjdict
|
||||
*/
|
||||
public function setXobjdict(array $xobjdict): void
|
||||
{
|
||||
$this->xobjdict = $xobjdict;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageRef $img
|
||||
*/
|
||||
public function setImageEntry(int $iid, array $img): void
|
||||
{
|
||||
$this->image[$iid] = $img;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,321 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* ImportTest.php
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
|
||||
/**
|
||||
* Unit Test
|
||||
*
|
||||
* @since 2011-05-23
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*/
|
||||
class ImportTest extends TestUtil
|
||||
{
|
||||
protected function getTestObject(): \Com\Tecnick\Pdf\Image\Import
|
||||
{
|
||||
$encrypt = $this->getTestEncrypt();
|
||||
return new \Com\Tecnick\Pdf\Image\Import(0.75, $encrypt, $this->getTestFileHelper());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetKey(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$result = $import->getKey('/images/200x100_RGB.png', 200, 100, 100);
|
||||
$this->assertEquals('0i9dDNrAwOZdFa6L6u1zfg', $result);
|
||||
|
||||
// The parts are delimited, so inputs that would concatenate to the same
|
||||
// string ('img' + 12 + 3 vs 'img1' + 2 + 3) must not collide.
|
||||
$this->assertNotEquals($import->getKey('img', 12, 3, 100), $import->getKey('img1', 2, 3, 100));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testConstructorUsesConfiguredFileHelper(): void
|
||||
{
|
||||
$encrypt = $this->getTestEncrypt();
|
||||
$allowedHosts = ['localhost', 'example.test'];
|
||||
$allowedPaths = [__DIR__ . '/images'];
|
||||
$maxRemoteSize = 10485760;
|
||||
$curlopts = [CURLOPT_TIMEOUT => 5];
|
||||
$defaultCurlOpts = [CURLOPT_TIMEOUT => 12];
|
||||
$fixedCurlOpts = [CURLOPT_SSL_VERIFYHOST => 2, CURLOPT_SSL_VERIFYPEER => true];
|
||||
|
||||
$fileHelper = new \Com\Tecnick\File\File(
|
||||
allowedHosts: $allowedHosts,
|
||||
maxRemoteSize: $maxRemoteSize,
|
||||
curlopts: $curlopts,
|
||||
defaultCurlOpts: $defaultCurlOpts,
|
||||
fixedCurlOpts: $fixedCurlOpts,
|
||||
allowedPaths: $allowedPaths,
|
||||
);
|
||||
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import(0.75, $encrypt, $fileHelper);
|
||||
|
||||
$method = new \ReflectionProperty($import, 'fileHelper');
|
||||
/** @var \Com\Tecnick\File\File $file */
|
||||
$file = $method->getValue($import);
|
||||
|
||||
$ref = new \ReflectionClass($file);
|
||||
$allowedHostsProp = $ref->getProperty('allowedHosts');
|
||||
$allowedPathsProp = $ref->getProperty('allowedPaths');
|
||||
$maxRemoteSizeProp = $ref->getProperty('maxRemoteSize');
|
||||
$curloptsProp = $ref->getProperty('curlopts');
|
||||
$defaultProp = $ref->getProperty('defaultCurlOpts');
|
||||
$fixedProp = $ref->getProperty('fixedCurlOpts');
|
||||
|
||||
$this->assertSame($allowedHosts, $allowedHostsProp->getValue($file));
|
||||
$this->assertSame($allowedPaths, $allowedPathsProp->getValue($file));
|
||||
$this->assertSame($maxRemoteSize, $maxRemoteSizeProp->getValue($file));
|
||||
$this->assertSame($curlopts, $curloptsProp->getValue($file));
|
||||
$this->assertSame($defaultCurlOpts, $defaultProp->getValue($file));
|
||||
$this->assertSame($fixedCurlOpts, $fixedProp->getValue($file));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetImageDataByKeyError(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->getImageDataByKey('missing');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageError(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->getSetImage(1, 2, 3, 5, 7, 17);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, array<int, string>>
|
||||
*/
|
||||
public static function getBadAddValues(): array
|
||||
{
|
||||
return [
|
||||
[''],
|
||||
[__DIR__ . '/images/missing.png'],
|
||||
['@'],
|
||||
['@garbage'],
|
||||
['*'],
|
||||
['*http://www.example.com/image.png'],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
#[DataProvider('getBadAddValues')]
|
||||
public function testAddError(string $bad): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->add($bad);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testAdd(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG1 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG2 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_GRAY.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG3 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_INDEX16.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG4 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_INDEX256.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG5 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.jpg');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG6 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG7 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGBALPHA.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMGplain8 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 200, 100, 600));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_INDEXALPHA.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG9 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
200,
|
||||
100,
|
||||
600,
|
||||
));
|
||||
|
||||
// resize
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png', 100, 50, true, 75, true);
|
||||
$this->assertEquals('q 75.000000 0 0 37.500000 2.250000 408.750000 cm /IMGmask10 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 100, 50, 600));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGBALPHA.png', 100, 50, true, 75, true);
|
||||
$this->assertEquals('q 75.000000 0 0 37.500000 2.250000 408.750000 cm /IMGmask11 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 100, 50, 600));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_INDEXALPHA.png', 100, 50, true, 75, true);
|
||||
$this->assertEquals('q 75.000000 0 0 37.500000 2.250000 408.750000 cm /IMGmask12 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 100, 50, 600));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.jpg', 100, 50, false, 75, true, [1, 2, 3]);
|
||||
$this->assertEquals('q 75.000000 0 0 37.500000 2.250000 408.750000 cm /IMG13 Do Q' . "\n", $import->getSetImage(
|
||||
$iid,
|
||||
3,
|
||||
5,
|
||||
100,
|
||||
50,
|
||||
600,
|
||||
));
|
||||
|
||||
// ICC
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGBICC.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG14 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 200, 100, 600));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGBICC.jpg');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG15 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 200, 100, 600));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGBINT.png');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMGplain16 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 200, 100, 600));
|
||||
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_CMYK.jpg');
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG17 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 200, 100, 600));
|
||||
|
||||
$key = $import->getKey(__DIR__ . '/images/200x100_INDEX256.png');
|
||||
$data = $import->getImageDataByKey($key);
|
||||
$this->assertEquals($key, $data['key']);
|
||||
|
||||
$iid = $import->add('@' . $data['raw']);
|
||||
$this->assertEquals('q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG18 Do Q'
|
||||
. "\n", $import->getSetImage($iid, 3, 5, 200, 100, 600));
|
||||
|
||||
// disabled because of libpngerror
|
||||
// $iid = $testObj->add('*http://localhost:8000/200x100_INDEX16.png');
|
||||
// $this->assertEquals(
|
||||
// 'q 150.000000 0 0 75.000000 2.250000 371.250000 cm /IMG18 Do Q' . "\n",
|
||||
// $testObj->getSetImage($iid, 3, 5, 200, 100, 600)
|
||||
// );
|
||||
|
||||
$out = $import->getOutImagesBlock(10);
|
||||
$this->assertNotEmpty($out);
|
||||
|
||||
$this->assertEquals(37, $import->getObjectNumber());
|
||||
|
||||
$xobjectDict = $import->getXobjectDict();
|
||||
$this->assertEquals(
|
||||
' /IMG1 11 0 R /IMG2 12 0 R /IMG3 13 0 R /IMG4 15 0 R'
|
||||
. ' /IMG5 17 0 R /IMG6 18 0 R /IMG7 11 0 R /IMGplain8 20 0 R'
|
||||
. ' /IMG9 22 0 R /IMGmask10 23 0 R /IMGmask11 24 0 R'
|
||||
. ' /IMGmask12 25 0 R /IMG13 27 0 R /IMG14 29 0 R'
|
||||
. ' /IMG15 31 0 R /IMGplain16 33 0 R /IMG17 35 0 R /IMG18 37 0 R',
|
||||
$xobjectDict,
|
||||
);
|
||||
|
||||
$xdByKeys = $import->getXobjectDictByKeys([2, 3]);
|
||||
$this->assertEquals(' /IMG2 12 0 R /IMG3 13 0 R', $xdByKeys);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,461 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* JpegTest.php
|
||||
*
|
||||
* @since 2026-04-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Jpeg class test
|
||||
*
|
||||
* @since 2026-04-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
class JpegTest extends TestUtil
|
||||
{
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataRgbJpeg(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_RGB.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 3,
|
||||
'colspace' => 'DeviceRGB',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_RGB.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals('DCTDecode', $result['filter']);
|
||||
$this->assertNotEmpty($result['data']);
|
||||
$this->assertEquals($file, $result['data']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataGrayJpeg(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 1,
|
||||
'colspace' => 'DeviceGray',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_GRAY.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals('DCTDecode', $result['filter']);
|
||||
$this->assertEquals(1, $result['channels']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataCmykJpeg(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_CMYK.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 4,
|
||||
'colspace' => 'DeviceCMYK',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_CMYK.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals('DCTDecode', $result['filter']);
|
||||
$this->assertEquals(4, $result['channels']);
|
||||
$this->assertEquals('DeviceCMYK', $result['colspace']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataJpegWithIcc(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_RGBICC.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 3,
|
||||
'colspace' => 'DeviceRGB',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_RGBICC.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals('DCTDecode', $result['filter']);
|
||||
$this->assertNotEmpty($result['icc']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataJpegWithoutIcc(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_RGB.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 3,
|
||||
'colspace' => 'DeviceRGB',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_RGB.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals('DCTDecode', $result['filter']);
|
||||
$this->assertEmpty($result['icc']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataPreservesRawData(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_RGB.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 3,
|
||||
'colspace' => 'DeviceRGB',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_RGB.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals($file, $result['raw']);
|
||||
$this->assertEquals($file, $result['data']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataWithMissingIcc(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_RGB.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 3,
|
||||
'colspace' => 'DeviceRGB',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_RGB.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals('DCTDecode', $result['filter']);
|
||||
$this->assertEquals('DeviceRGB', $result['colspace']);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataPreservesChannels(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$file = \file_get_contents(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
$this->assertIsString($file);
|
||||
|
||||
$data = [
|
||||
'bits' => 8,
|
||||
'channels' => 1,
|
||||
'colspace' => 'DeviceGray',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => __DIR__ . '/images/200x100_GRAY.jpg',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $file,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertEquals(1, $result['channels']);
|
||||
$this->assertEquals($file, $result['data']);
|
||||
}
|
||||
|
||||
/**
|
||||
* A crafted "ICC_PROFILE" marker preceded by a 2-byte length of 0 yields a
|
||||
* negative segment length. The scanner must still move forward instead of
|
||||
* re-finding the same marker forever (DoS regression).
|
||||
*
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataDoesNotHangOnMalformedIccMarker(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$raw = 'XX' . "\x00\x00" . 'ICC_PROFILE' . "\x00\x01\x01" . 'PAYLOAD';
|
||||
$data = $this->makeJpegData($raw);
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertSame('DCTDecode', $result['filter']);
|
||||
$this->assertSame('', $result['icc']);
|
||||
$this->assertSame($raw, $result['data']);
|
||||
}
|
||||
|
||||
/**
|
||||
* A marker at the very start of the stream has too few bytes before it to
|
||||
* carry a length: it must be skipped without throwing or looping.
|
||||
*
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function testGetDataIgnoresIccMarkerWithoutLengthPrefix(): void
|
||||
{
|
||||
$import = new \Com\Tecnick\Pdf\Image\Import\Jpeg();
|
||||
$raw = 'ICC_PROFILE' . "\x00" . 'rest';
|
||||
$data = $this->makeJpegData($raw);
|
||||
|
||||
$result = $import->getData($data);
|
||||
|
||||
$this->assertSame('', $result['icc']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a minimal JPEG base-data array wrapping the given raw bytes.
|
||||
*
|
||||
* @return ImageBaseData
|
||||
*/
|
||||
private function makeJpegData(string $raw): array
|
||||
{
|
||||
return [
|
||||
'bits' => 8,
|
||||
'channels' => 3,
|
||||
'colspace' => 'DeviceRGB',
|
||||
'data' => '',
|
||||
'exturl' => false,
|
||||
'file' => '',
|
||||
'filter' => '',
|
||||
'height' => 100,
|
||||
'icc' => '',
|
||||
'ismask' => false,
|
||||
'key' => 'test',
|
||||
'mapto' => IMAGETYPE_JPEG,
|
||||
'native' => true,
|
||||
'obj' => 0,
|
||||
'obj_alt' => 0,
|
||||
'obj_icc' => 0,
|
||||
'obj_pal' => 0,
|
||||
'pal' => '',
|
||||
'parms' => '',
|
||||
'raw' => $raw,
|
||||
'recode' => false,
|
||||
'recoded' => false,
|
||||
'splitalpha' => false,
|
||||
'trns' => [],
|
||||
'type' => IMAGETYPE_JPEG,
|
||||
'width' => 200,
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,309 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* OutputTest.php
|
||||
*
|
||||
* @since 2026-04-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* Output class test
|
||||
*
|
||||
* @since 2026-04-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*/
|
||||
class OutputTest extends TestUtil
|
||||
{
|
||||
/**
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
public function throwWithFileHelperCallbackError(): void
|
||||
{
|
||||
throw new \RuntimeException('withFileHelper callback error');
|
||||
}
|
||||
|
||||
protected function getTestObject(): \Com\Tecnick\Pdf\Image\Import
|
||||
{
|
||||
$encrypt = $this->getTestEncrypt();
|
||||
return new \Com\Tecnick\Pdf\Image\Import(0.75, $encrypt, $this->getTestFileHelper());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetObjectNumber(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
// Add some images and check object number increases after calling getOutImagesBlock
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$import->getOutImagesBlock(10);
|
||||
$this->assertGreaterThan(10, $import->getObjectNumber());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testWithFileHelperRestoresAfterSuccess(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$fileHelperProp = new \ReflectionProperty($import, 'fileHelper');
|
||||
/** @var \Com\Tecnick\File\File $originalFileHelper */
|
||||
$originalFileHelper = $fileHelperProp->getValue($import);
|
||||
|
||||
$tempFileHelper = new \Com\Tecnick\File\File(allowedHosts: ['localhost'], allowedPaths: ['*']);
|
||||
|
||||
$result = $import->withFileHelper($tempFileHelper, function () use (
|
||||
$import,
|
||||
$fileHelperProp,
|
||||
$tempFileHelper,
|
||||
): string {
|
||||
$this->assertSame($tempFileHelper, $fileHelperProp->getValue($import));
|
||||
return 'ok';
|
||||
});
|
||||
|
||||
$this->assertSame('ok', $result);
|
||||
$this->assertSame($originalFileHelper, $fileHelperProp->getValue($import));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testWithFileHelperRestoresAfterException(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$fileHelperProp = new \ReflectionProperty($import, 'fileHelper');
|
||||
/** @var \Com\Tecnick\File\File $originalFileHelper */
|
||||
$originalFileHelper = $fileHelperProp->getValue($import);
|
||||
|
||||
$tempFileHelper = new \Com\Tecnick\File\File(allowedHosts: ['example.test'], allowedPaths: ['*']);
|
||||
|
||||
$this->bcExpectException(\RuntimeException::class);
|
||||
|
||||
try {
|
||||
$import->withFileHelper($tempFileHelper, [$this, 'throwWithFileHelperCallbackError']);
|
||||
} finally {
|
||||
$this->assertSame($originalFileHelper, $fileHelperProp->getValue($import));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetXobjectDictEmpty(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$this->assertEquals('', $import->getXobjectDict());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetXobjectDictByKeysEmpty(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$this->assertEquals('', $import->getXobjectDictByKeys([]));
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetXobjectDictByKeysInvalid(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$import->getOutImagesBlock(10);
|
||||
|
||||
// Test with non-existent image IDs
|
||||
$result = $import->getXobjectDictByKeys([999]);
|
||||
$this->assertEquals('', $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetXobjectDictByKeysWithValidImage(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$import->getOutImagesBlock(10);
|
||||
|
||||
$result = $import->getXobjectDictByKeys([$iid]);
|
||||
$this->assertNotEmpty($result);
|
||||
$this->assertStringContainsString('IMG' . $iid, $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetOutImagesBlockMultiple(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$import->add(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
|
||||
$result = $import->getOutImagesBlock(10);
|
||||
$this->assertNotEmpty($result);
|
||||
$this->assertStringContainsString('XObject', $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetOutImagesBlockObjectNumberIncrement(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$import->add(__DIR__ . '/images/200x100_RGBALPHA.png');
|
||||
|
||||
$import->getOutImagesBlock(20);
|
||||
$this->assertGreaterThan(20, $import->getObjectNumber());
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageWithMask(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGBALPHA.png', 100, 50, true, 75, true);
|
||||
|
||||
$result = $import->getSetImage($iid, 3, 5, 100, 50, 600);
|
||||
$this->assertStringContainsString('IMGmask' . $iid, $result);
|
||||
$this->assertStringContainsString('cm /IMGmask' . $iid . ' Do Q', $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageRealOutput(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
|
||||
$result = $import->getSetImage($iid, 3, 5, 200, 100, 600);
|
||||
$this->assertStringContainsString('q ', $result);
|
||||
$this->assertStringContainsString('Do Q', $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageWithoutMaskOrPlain(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
|
||||
$result = $import->getSetImage($iid, 3, 5, 200, 100, 600);
|
||||
$this->assertStringContainsString('/IMG' . $iid . ' Do Q', $result);
|
||||
$this->assertStringNotContainsString('IMGplain', $result);
|
||||
$this->assertStringNotContainsString('IMGmask', $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageWithCoordinates(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
|
||||
// Test with different coordinates and page height
|
||||
$result = $import->getSetImage($iid, 10, 20, 100, 50, 800);
|
||||
$this->assertStringContainsString('q 75.000000 0 0 37.500000', $result);
|
||||
$this->assertStringContainsString('/IMG' . $iid . ' Do Q', $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageErrorInvalidId(): void
|
||||
{
|
||||
$this->bcExpectException(\Com\Tecnick\Pdf\Image\Exception::class);
|
||||
$import = $this->getTestObject();
|
||||
$import->getSetImage(999, 0, 0, 100, 100, 600);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageMultipleImages(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid1 = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
$iid2 = $import->add(__DIR__ . '/images/200x100_GRAY.jpg');
|
||||
|
||||
$result1 = $import->getSetImage($iid1, 0, 0, 100, 100, 600);
|
||||
$result2 = $import->getSetImage($iid2, 10, 10, 150, 150, 600);
|
||||
|
||||
$this->assertNotEmpty($result1);
|
||||
$this->assertNotEmpty($result2);
|
||||
$this->assertStringContainsString('IMG' . $iid1, $result1);
|
||||
$this->assertStringContainsString('IMG' . $iid2, $result2);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \Com\Tecnick\File\Exception
|
||||
* @throws \Com\Tecnick\Pdf\Encrypt\Exception
|
||||
*/
|
||||
public function testGetSetImageVariousCoordinates(): void
|
||||
{
|
||||
$import = $this->getTestObject();
|
||||
$iid = $import->add(__DIR__ . '/images/200x100_RGB.png');
|
||||
|
||||
// Test with zero coordinates
|
||||
$result = $import->getSetImage($iid, 0, 0, 100, 100, 600);
|
||||
$this->assertStringContainsString('0.000000', $result);
|
||||
$this->assertStringContainsString('cm /IMG', $result);
|
||||
|
||||
// Test with large coordinates
|
||||
$result2 = $import->getSetImage($iid, 100, 200, 300, 400, 1000);
|
||||
$this->assertStringContainsString('300.000000', $result2);
|
||||
$this->assertStringContainsString('cm /IMG', $result2);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test;
|
||||
|
||||
/**
|
||||
* @phpstan-import-type ImageBaseData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
class PngChunkParsingHarness extends \Com\Tecnick\Pdf\Image\Import\Png
|
||||
{
|
||||
/**
|
||||
* @param ImageBaseData $data
|
||||
*
|
||||
* @return ImageBaseData
|
||||
*/
|
||||
public function callGetTrnsChunk(array $data, int &$offset, int $len): array
|
||||
{
|
||||
return $this->getTrnsChunk($data, $offset, $len);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageBaseData $data
|
||||
*
|
||||
* @return ImageBaseData
|
||||
*
|
||||
* @throws \Com\Tecnick\Pdf\Image\Exception
|
||||
* @throws \RangeException
|
||||
*/
|
||||
public function callGetIccpChunk(\Com\Tecnick\File\Byte $byte, array $data, int &$offset, int $len): array
|
||||
{
|
||||
return $this->getIccpChunk($byte, $data, $offset, $len);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* SpyImageCache.php
|
||||
*
|
||||
* @since 2026-06-16
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2011-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-pdf-image software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Com\Tecnick\Pdf\Image\ImageCacheInterface;
|
||||
|
||||
/**
|
||||
* In-memory ImageCacheInterface implementation that records access for tests.
|
||||
*
|
||||
* @phpstan-import-type ImageRawData from \Com\Tecnick\Pdf\Image\Import
|
||||
*/
|
||||
class SpyImageCache implements ImageCacheInterface
|
||||
{
|
||||
/**
|
||||
* Backing store.
|
||||
*
|
||||
* @var array<string, ImageRawData>
|
||||
*/
|
||||
public array $store = [];
|
||||
|
||||
/**
|
||||
* Number of get() calls.
|
||||
*/
|
||||
public int $getCount = 0;
|
||||
|
||||
/**
|
||||
* Number of set() calls.
|
||||
*/
|
||||
public int $setCount = 0;
|
||||
|
||||
/**
|
||||
* Keys passed to set(), in order.
|
||||
*
|
||||
* @var list<string>
|
||||
*/
|
||||
public array $setKeys = [];
|
||||
|
||||
/**
|
||||
* @return ImageRawData|null
|
||||
*/
|
||||
public function get(string $key): ?array
|
||||
{
|
||||
++$this->getCount;
|
||||
return $this->store[$key] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch a stored entry by key, failing loudly when it is absent.
|
||||
*
|
||||
* @return ImageRawData
|
||||
*/
|
||||
public function fetch(string $key): array
|
||||
{
|
||||
$data = $this->store[$key] ?? null;
|
||||
if ($data === null) {
|
||||
throw new \LogicException('No cached entry for key: ' . $key);
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ImageRawData $data
|
||||
*/
|
||||
public function set(string $key, array $data): void
|
||||
{
|
||||
++$this->setCount;
|
||||
$this->setKeys[] = $key;
|
||||
$this->store[$key] = $data;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* TestUtil.php
|
||||
*
|
||||
* @since 2020-12-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*
|
||||
* This file is part of tc-lib-color software library.
|
||||
*/
|
||||
|
||||
namespace Test;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
/**
|
||||
* Web Color class test
|
||||
*
|
||||
* @since 2020-12-19
|
||||
* @category Library
|
||||
* @package PdfImage
|
||||
* @author Nicola Asuni <info@tecnick.com>
|
||||
* @copyright 2015-2026 Nicola Asuni - Tecnick.com LTD
|
||||
* @license https://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE)
|
||||
* @link https://github.com/tecnickcom/tc-lib-pdf-image
|
||||
*/
|
||||
class TestUtil extends TestCase
|
||||
{
|
||||
protected function getTestFileHelper(): \Com\Tecnick\File\File
|
||||
{
|
||||
return new \Com\Tecnick\File\File(allowedHosts: ['*'], allowedPaths: ['*']);
|
||||
}
|
||||
|
||||
protected function getTestEncrypt(): \Com\Tecnick\Pdf\Encrypt\Encrypt
|
||||
{
|
||||
return new class extends \Com\Tecnick\Pdf\Encrypt\Encrypt {
|
||||
public function __construct() {}
|
||||
|
||||
public function encryptString(string $str, int $objnum = 0): string
|
||||
{
|
||||
return $str;
|
||||
}
|
||||
|
||||
public function escapeDataString(string $str, int $objnum = 0): string
|
||||
{
|
||||
return '(' . $str . ')';
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @param class-string<\Throwable> $exception
|
||||
*/
|
||||
public function bcExpectException(string $exception): void
|
||||
{
|
||||
parent::expectException($exception);
|
||||
}
|
||||
}
|
||||
|
After Width: | Height: | Size: 960 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
After Width: | Height: | Size: 11 KiB |
|
After Width: | Height: | Size: 2.8 KiB |
|
After Width: | Height: | Size: 9.6 KiB |
|
After Width: | Height: | Size: 7.2 KiB |
|
After Width: | Height: | Size: 29 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 29 KiB |
|
After Width: | Height: | Size: 32 KiB |
|
After Width: | Height: | Size: 38 KiB |