jric11/putnamrec
1
0
Fork 0
generated from jric11/baseProject
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
James Richie
2026-08-20 11:41:17 +00:00
commit 6949695eac
2334 changed files with 646393 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
vendor/tecnickcom/tc-lib-file/.editorconfig
Vendored
+20
View File
@@ -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
vendor/tecnickcom/tc-lib-file/.gitattributes
+22
View File
@@ -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
vendor/tecnickcom/tc-lib-file/.github/ISSUE_TEMPLATE/bug_report.md
Vendored
+29
View File
@@ -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.
vendor/tecnickcom/tc-lib-file/.github/ISSUE_TEMPLATE/feature_request.md
Vendored
+20
View File
@@ -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.
vendor/tecnickcom/tc-lib-file/.github/pull_request_template.md
Vendored
+25
View File
@@ -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.
vendor/tecnickcom/tc-lib-file/.github/workflows/check.yml
Vendored
+59
View File
@@ -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 }}
vendor/tecnickcom/tc-lib-file/.gitignore
+21
View File
@@ -0,0 +1,21 @@
**/*.bak
**/*.tmp
**/.#*
**/.DS_Store
**/._*
**/.idea
**/.vagrant
**/auth.json
**/nbproject
**/temp.php
**/test.php
.phpdoc
.phpunit.cache
.phpunit.result.cache
composer.lock
ecs.php
phpunit.xml
rector.php
target
vendor
PLAN_*
vendor/tecnickcom/tc-lib-file/CODEOWNERS
Vendored
+1
View File
@@ -0,0 +1 @@
* @nicolaasuni
vendor/tecnickcom/tc-lib-file/CODE_OF_CONDUCT.md
Vendored
+128
View File
@@ -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.
vendor/tecnickcom/tc-lib-file/CONTRIBUTING.md
Vendored
+222
View File
@@ -0,0 +1,222 @@
# Contributing to tc-lib-file
Thank you for your interest in contributing to **tc-lib-file**.
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-file.git
cd tc-lib-file
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-file/issues)** to avoid duplicates.
If no existing issue matches, [open a new one](https://github.com/tecnickcom/tc-lib-file/issues/new) and include:
- A **clear title and description** of the problem.
- The **library version** (`composer show tecnickcom/tc-lib-file`) 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-file/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-file/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/FileTest.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/`.
### Sandboxed / network-restricted environments
`FileTest` starts a local `php -S` HTTP server (via `proc_open`) so the cURL
tests can hit a real endpoint over loopback. The startup is bounded and falls
back to skipping those tests if the server cannot be reached, but in
environments that block loopback networking or forbid spawning a child process
you can skip that part outright:
```bash
TC_LIB_FILE_SKIP_HTTP_SERVER=1 make test
```
The four server-dependent tests are then reported as **skipped** instead of
running.
### Cross-platform behavior
Continuous integration runs on **Linux only**. Windows- and macOS-specific
behavior (path case-sensitivity, Unicode normalization, binary read mode) is
therefore exercised on the Linux runner through the injectable
`caseSensitivePaths` override and platform-parameterized helpers, and validated
manually on those operating systems. When changing path-handling code, keep it
drivable from a Linux test — assert both case-sensitive and case-insensitive
modes via the override rather than relying on the host OS — and avoid hardcoding
platform-specific paths (use `sys_get_temp_dir()` and `DIRECTORY_SEPARATOR`, and
compare `realpath()` on both sides). See the "Platform notes" section of the
[README](README.md) for the supported behaviors.
---
## 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-file/discussions) or contact the maintainer at [info@tecnick.com](mailto:info@tecnick.com).
vendor/tecnickcom/tc-lib-file/LICENSE
Vendored
+862
View File
@@ -0,0 +1,862 @@
**********************************************************************
* LICENSE
*
* SOFTWARE : tc-lib-file
* AUTHOR : Nicola Asuni <info@tecnick.com>
* COPYRIGHT : 2015-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>.
**********************************************************************
**********************************************************************
vendor/tecnickcom/tc-lib-file/Makefile
Vendored
+280
View File
@@ -0,0 +1,280 @@
# makefile
#
# @since 2015-07-28
# @category Library
# @package File
# @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-file
#
# This file is part of tc-lib-file software library.
# ----------------------------------------------------------------------------------------------------------------------
SHELL=/bin/bash
.SHELLFLAGS=-o pipefail -c
# Project owner
OWNER=tecnickcom
# Project vendor
VENDOR=${OWNER}
# Project name
PROJECT=tc-lib-file
# 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}/File/
# 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
vendor/tecnickcom/tc-lib-file/README.md
Vendored
+211
View File
@@ -0,0 +1,211 @@
# tc-lib-file
> PHP utilities for low-level file access and byte-level reading.
[![Latest Stable Version](https://poser.pugx.org/tecnickcom/tc-lib-file/version)](https://packagist.org/packages/tecnickcom/tc-lib-file)
[![Build](https://github.com/tecnickcom/tc-lib-file/actions/workflows/check.yml/badge.svg)](https://github.com/tecnickcom/tc-lib-file/actions/workflows/check.yml)
[![Coverage](https://codecov.io/gh/tecnickcom/tc-lib-file/graph/badge.svg?token=iZ9snwgkUA)](https://codecov.io/gh/tecnickcom/tc-lib-file)
[![License](https://poser.pugx.org/tecnickcom/tc-lib-file/license)](https://packagist.org/packages/tecnickcom/tc-lib-file)
[![Downloads](https://poser.pugx.org/tecnickcom/tc-lib-file/downloads)](https://packagist.org/packages/tecnickcom/tc-lib-file)
[![Sponsor on GitHub](https://img.shields.io/badge/sponsor-github-EA4AAA.svg?logo=githubsponsors&logoColor=white)](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-file` provides safe primitives for opening files, reading bytes, and handling binary-oriented workflows used by higher-level PDF and document libraries.
The package is intentionally small but critical: it centralizes low-level I/O concerns so higher-level libraries can focus on document semantics instead of stream safety and byte handling. This separation improves reliability, testability, and reuse across the broader Tecnick ecosystem.
| | |
|---|---|
| **Namespace** | `\Com\Tecnick\File` |
| **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-file> |
| **Packagist** | <https://packagist.org/packages/tecnickcom/tc-lib-file> |
---
## Features
### File Access
- Local and URL-backed file reading helpers
- Path-safety checks for local operations
- cURL-based retrieval options for remote resources
### Binary Utilities
- Byte, integer, and structured binary reads
- Helpers used by parser and image/font import stacks
- Error handling via typed exceptions
---
## Requirements
- PHP 8.2 or later
- Extension: `curl`
- Composer
---
## Installation
```bash
composer require tecnickcom/tc-lib-file
```
---
## Quick Start
```php
<?php
require_once __DIR__ . '/vendor/autoload.php';
$file = new \Com\Tecnick\File\File(
allowedHosts: ['example.com', 'cdn.example.com'],
allowedPaths: [__DIR__, '/var/app/uploads'],
curlopts: [
CURLOPT_MAXREDIRS => 3,
],
);
$fh = $file->fopenLocal(__FILE__, 'rb');
$header = $file->fReadInt($fh);
var_dump($header);
```
## Security Configuration (Required)
`File` defaults to strict-deny behavior for host and path validation.
- `allowedHosts` defaults to an empty array, so remote URLs and host-based alternate path resolution are rejected unless you explicitly trust hosts.
- `allowedPaths` defaults to an empty array, so local file operations are rejected unless you explicitly trust path prefixes.
You should always pass explicit allowlists in the constructor (or set them immediately via setters) for production use.
Example:
```php
$file = new \Com\Tecnick\File\File(
allowedHosts: ['example.com'],
allowedPaths: ['/srv/my-app/data'],
);
// Equivalent runtime configuration:
$file
->setAllowedHosts(['example.com'])
->setAllowedPaths(['/srv/my-app/data']);
```
Avoid wildcard trust (`'*'`) unless you fully control all inputs and deployment boundaries.
### Redirect Handling via `CURLOPT_MAXREDIRS`
Redirect validation is enabled when `CURLOPT_MAXREDIRS` is non-zero.
- `CURLOPT_MAXREDIRS => 0` (default): no redirect-follow validation callback is installed.
- `CURLOPT_MAXREDIRS > 0`: redirects are processed and each `Location` target is validated.
To allow redirects, set a positive max-redirs value and ensure redirect target hosts are present in `allowedHosts`.
```php
$file = new \Com\Tecnick\File\File(
allowedHosts: ['example.com', 'downloads.example.com'],
curlopts: [
CURLOPT_MAXREDIRS => 5,
],
);
```
---
## Platform notes
The library runs on Linux, macOS, and Windows. Path validation adapts to the
host filesystem; a few platform behaviors are worth knowing.
### Path case-sensitivity
Allowlist matching follows the filesystem's case rules:
- **Linux**: case-sensitive.
- **Windows**: case-insensitive.
- **macOS**: per-volume, the default APFS/HFS+ volume is case-insensitive, but
case-sensitive volumes exist. The library probes the actual volume and falls
back to case-insensitive when it cannot.
If auto-detection is wrong for your deployment (for example, data on a
case-sensitive macOS volume, or a case-insensitive mount on Linux), set it
explicitly:
```php
$file = new \Com\Tecnick\File\File(
allowedPaths: ['/srv/my-app/data'],
caseSensitivePaths: true, // or false; null (default) = auto-detect
);
// or at runtime:
$file->setCaseSensitivePaths(true);
```
The same override makes the behavior testable on any host (the CI runs on Linux
only: Windows and macOS are validated locally).
### Unicode (macOS)
Default macOS volumes are normalization-insensitive (`é` composed vs. decomposed
name the same file). When `ext-intl` is installed, the library normalizes paths
to NFC before comparison so the allowlist matches consistently; without
`ext-intl` it degrades to a byte comparison.
### Binary reads
`fopenLocal()` forces the binary (`b`) stream flag when absent, so byte-level
reads are not altered by Windows text-mode CRLF translation. POSIX systems are
unaffected.
### Windows known limitations
These inputs are intentionally **not** treated as trusted/canonical and are not
specially expanded before allowlist matching: 8.3 short names (`PROGRA~1`),
Alternate Data Streams (`file.txt:stream`, `::$DATA`), trailing dots/spaces, and
reserved device names (`CON`, `NUL`, ...). UNC paths (`\\server\share`) are
matched only when explicitly allowlisted (note the network-access implication).
---
## 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/File/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).
vendor/tecnickcom/tc-lib-file/RELEASE
Vendored
+1
View File
@@ -0,0 +1 @@
1
vendor/tecnickcom/tc-lib-file/SECURITY.md
Vendored
+98
View File
@@ -0,0 +1,98 @@
# Security Policy
This document describes the security policy for **tc-lib-file**.
---
## 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-file – <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-file`).
- **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-file) or tools such as `composer audit`.
- **Pin versions in production.** Use `composer.lock` and review changes on every update.
### Required Runtime Configuration
By design, `Com\Tecnick\File\File` starts in a restrictive mode:
- `allowedHosts` defaults to `[]` (no host trusted).
- `allowedPaths` defaults to `[]` (no local path trusted).
You must explicitly define trusted values before using remote URL reads or local path reads in production.
```php
$file = new \Com\Tecnick\File\File(
allowedHosts: ['example.com', 'cdn.example.com'],
allowedPaths: ['/srv/my-app/files'],
);
```
Avoid wildcard trust (`'*'`) unless you have a tightly controlled environment and fully trusted inputs.
### Redirect Policy (`CURLOPT_MAXREDIRS`)
Redirect processing is controlled by cURL options:
- `CURLOPT_MAXREDIRS => 0` disables redirect-follow validation callback behavior used by this library.
- `CURLOPT_MAXREDIRS > 0` enables redirect handling with `Location` target validation.
If you enable redirects, ensure every possible redirect target host is present in `allowedHosts`.
```php
$file = new \Com\Tecnick\File\File(
allowedHosts: ['example.com', 'downloads.example.com'],
curlopts: [
CURLOPT_MAXREDIRS => 5,
],
);
```
---
## 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-file> |
| Packagist | <https://packagist.org/packages/tecnickcom/tc-lib-file> |
vendor/tecnickcom/tc-lib-file/VERSION
Vendored
+1
View File
@@ -0,0 +1 @@
3.7.3
vendor/tecnickcom/tc-lib-file/composer.json
Vendored
+72
View File
@@ -0,0 +1,72 @@
{
"name": "tecnickcom/tc-lib-file",
"description": "PHP library to read byte-level data from files",
"type": "library",
"homepage": "https://tcpdf.org",
"license": "LGPL-3.0-or-later",
"keywords": [
"tc-lib-file",
"file",
"byte",
"bit",
"read",
"short",
"long",
"double"
],
"authors": [
{
"name": "Nicola Asuni",
"email": "info@tecnick.com",
"role": "lead"
}
],
"funding": [
{
"type": "github",
"url": "https://github.com/sponsors/tecnickcom"
}
],
"require": {
"php": ">=8.2",
"ext-curl": "*",
"ext-pcre": "*"
},
"suggest": {
"ext-intl": "Enables Unicode NFC normalization when matching paths against the allowlist"
},
"minimum-stability": "stable",
"prefer-stable": true,
"config": {
"sort-packages": true
},
"require-dev": {
"pdepend/pdepend": "^2.16",
"phpunit/phpunit": "^13.2 || ^12.5 || ^11.5"
},
"autoload": {
"psr-4": {
"Com\\Tecnick\\File\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Test\\": "test"
}
},
"support": {
"issues": "https://github.com/tecnickcom/tc-lib-file/issues",
"source": "https://github.com/tecnickcom/tc-lib-file"
},
"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"]
}
}
vendor/tecnickcom/tc-lib-file/mago.src.toml
Vendored
+56
View File
@@ -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 = false }
halstead = { enabled = true, effort-threshold = 7000 }
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
vendor/tecnickcom/tc-lib-file/mago.test.toml
Vendored
+66
View File
@@ -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
vendor/tecnickcom/tc-lib-file/phpcompatinfo.json
Vendored
+15
View File
@@ -0,0 +1,15 @@
{
"source-providers": [
{
"in": "src as source",
"exclude": "vendor",
"name": "/\\.(php)$/"
}
],
"plugins": [
],
"analysers": [
],
"services": [
]
}
vendor/tecnickcom/tc-lib-file/phpunit.xml.dist
Vendored
+31
View File
@@ -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-file 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>
vendor/tecnickcom/tc-lib-file/resources/autoload.php
Vendored
+30
View File
@@ -0,0 +1,30 @@
<?php
/**
* autoload.php
*
* Autoloader for Tecnick.com libraries
*
* @since 2015-03-04
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file 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(__DIR__).'/'.\str_replace('\\', '/', $relative_class).'.php';
if (\file_exists($file)) {
require $file;
}
}
);
vendor/tecnickcom/tc-lib-file/resources/debian/changelog
Vendored
+7
View 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#~
vendor/tecnickcom/tc-lib-file/resources/debian/control
Vendored
+18
View File
@@ -0,0 +1,18 @@
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-curl, ${misc:Depends}
Recommends: php-intl
Description: PHP Color library
This library includes PHP classes to read byte-level data from files
vendor/tecnickcom/tc-lib-file/resources/debian/copyright
Vendored
+20
View File
@@ -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
vendor/tecnickcom/tc-lib-file/resources/debian/rules
Vendored
+3
View File
@@ -0,0 +1,3 @@
#!/usr/bin/make -f
%:
dh $@
vendor/tecnickcom/tc-lib-file/resources/debian/source/format
Vendored
+1
View File
@@ -0,0 +1 @@
3.0 (quilt)
vendor/tecnickcom/tc-lib-file/resources/debian/watch
Vendored
+4
View File
@@ -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
vendor/tecnickcom/tc-lib-file/resources/rpm/rpm.spec
Vendored
+47
View File
@@ -0,0 +1,47 @@
# SPEC file
%global c_vendor %{_vendor}
%global gh_owner %{_owner}
%global gh_project %{_project}
Name: %{_package}
Version: %{_version}
Release: %{_release}%{?dist}
Summary: This library includes PHP classes to read byte-level data from files
License: LGPLv3+
URL: https://github.com/%{gh_owner}/%{gh_project}
BuildArch: noarch
Requires: php(language) >= 8.2.0
Requires: php-curl
Requires: php-date
Requires: php-pcre
Recommends: php-intl
Provides: php-composer(%{c_vendor}/%{gh_project}) = %{version}
Provides: php-%{gh_project} = %{version}
%description
This library includes PHP classes to read byte-level data from files.
%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
* Sun Feb 05 2026 Nicola Asuni <info@tecnick.com> 1.6.4-1
- Update dependencies
* Mon Jul 27 2026 Nicola Asuni <info@tecnick.com> 1.0.0-1
- Initial Commit
vendor/tecnickcom/tc-lib-file/src/Byte.php
Vendored
+257
View File
@@ -0,0 +1,257 @@
<?php
declare(strict_types=1);
/**
* Byte.php
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Com\Tecnick\File;
use RangeException;
/**
* Com\Tecnick\File\Byte
*
* Function to read byte-level data
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*/
readonly class Byte
{
/**
* Length of the binary string in bytes.
*/
private int $length;
/**
* Initialize a new string to be processed.
*
* Values are read in place via \ord() + bitwise math: no per-read unpack()
* call and no byte-table copy, so memory stays at the size of the string.
*
* The read methods are deliberately inlined (each repeats the bounds check
* and the \ord()/shift sequence) rather than sharing private helpers: every
* userland call in PHP carries real frame-setup overhead and is not inlined
* by the engine in the interpreter, so the duplication is a measurable speed
* win on the hot read path.
*
* @param string $str String (binary) from where to extract values
*/
public function __construct(
/**
* Binary string to process
*/
protected string $str,
) {
$this->length = \strlen($str);
}
/**
* Throw for a read that failed its bounds check.
*
* Kept as a separate method so the cold error path does not bloat the
* inlined read methods; it is never reached on a successful read.
*
* @param int $offset Read start position.
* @param int $length Number of bytes requested.
*
* @throws RangeException always.
*/
private function throwOutOfBounds(int $offset, int $length): never
{
throw new RangeException(
"Out-of-bounds read at offset {$offset} (length {$length}, string length {$this->length})",
);
}
/**
* Get BYTE from string (8-bit unsigned integer).
*
* @param int $offset Point from where to read the data.
*
* @return int 8 bit value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getByte(int $offset): int
{
if ($offset < 0 || $offset >= $this->length) {
$this->throwOutOfBounds($offset, 1);
}
return \ord($this->str[$offset]);
}
/**
* Get USHORT from string (Big Endian 16-bit unsigned integer).
*
* @param int $offset Point from where to read the data
*
* @return int 16 bit value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getUShort(int $offset): int
{
if ($offset < 0 || $offset > ($this->length - 2)) {
$this->throwOutOfBounds($offset, 2);
}
return (\ord($this->str[$offset]) << 8) | \ord($this->str[$offset + 1]);
}
/**
* Get SHORT from string (Big Endian 16-bit signed integer).
*
* @param int $offset Point from where to read the data.
*
* @return int 16 bit value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getShort(int $offset): int
{
if ($offset < 0 || $offset > ($this->length - 2)) {
$this->throwOutOfBounds($offset, 2);
}
// The uint16 value
$val = (\ord($this->str[$offset]) << 8) | \ord($this->str[$offset + 1]);
// Convert unsigned 16-bit to signed (two's complement)
return ($val ^ 0x8000) - 0x8000;
}
/**
* Get UFWORD from string (Big Endian 16-bit unsigned integer).
* Alias for getUShort().
*
* @param int $offset Point from where to read the data.
*
* @return int 16 bit value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getUFWord(int $offset): int
{
if ($offset < 0 || $offset > ($this->length - 2)) {
$this->throwOutOfBounds($offset, 2);
}
return (\ord($this->str[$offset]) << 8) | \ord($this->str[$offset + 1]);
}
/**
* Get FWORD from string (Big Endian 16-bit signed integer).
* Alias for getShort().
*
* @param int $offset Point from where to read the data.
*
* @return int 16 bit value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getFWord(int $offset): int
{
if ($offset < 0 || $offset > ($this->length - 2)) {
$this->throwOutOfBounds($offset, 2);
}
// The uint16 value
$val = (\ord($this->str[$offset]) << 8) | \ord($this->str[$offset + 1]);
// Convert unsigned 16-bit to signed (two's complement)
return ($val ^ 0x8000) - 0x8000;
}
/**
* Get ULONG from string (Big Endian 32-bit unsigned integer).
*
* @param int $offset Point from where to read the data
*
* @return int 32 bit value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getULong(int $offset): int
{
if ($offset < 0 || $offset > ($this->length - 4)) {
$this->throwOutOfBounds($offset, 4);
}
return (
(\ord($this->str[$offset]) << 24)
| (\ord($this->str[$offset + 1]) << 16)
| (\ord($this->str[$offset + 2]) << 8)
| \ord($this->str[$offset + 3])
);
}
/**
* Get LONG from string (Big Endian 32-bit signed integer).
*
* @param int $offset Point from where to read the data
*
* @return int 32 bit value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getLong(int $offset): int
{
if ($offset < 0 || $offset > ($this->length - 4)) {
$this->throwOutOfBounds($offset, 4);
}
// The uint32 value
$val =
(\ord($this->str[$offset]) << 24)
| (\ord($this->str[$offset + 1]) << 16)
| (\ord($this->str[$offset + 2]) << 8)
| \ord($this->str[$offset + 3]);
// Convert unsigned 32-bit to signed (two's complement)
return ($val ^ 0x8000_0000) - 0x8000_0000;
}
/**
* Get FIXED from string (Big Endian 32-bit signed fixed-point number (16.16)).
*
* A fixed-point 16.16 number is the signed int16 integer part plus the
* unsigned 16-bit fractional part divided by 65536 = (1 << 16).
*
* @param int $offset Point from where to read the data.
*
* @return float Fixed-point value
*
* @throws RangeException if the requested read is out of bounds.
*/
public function getFixed(int $offset): float
{
if ($offset < 0 || $offset > ($this->length - 4)) {
$this->throwOutOfBounds($offset, 4);
}
// The int16 integer part
$int16 = (((\ord($this->str[$offset]) << 8) | \ord($this->str[$offset + 1])) ^ 0x8000) - 0x8000;
// Add the uint16 fractional part
return $int16 + (((\ord($this->str[$offset + 2]) << 8) | \ord($this->str[$offset + 3])) / 65_536.0);
}
}
vendor/tecnickcom/tc-lib-file/src/Cache.php
Vendored
+267
View File
@@ -0,0 +1,267 @@
<?php
declare(strict_types=1);
/**
* Cache.php
*
* @since 2011-05-23
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Com\Tecnick\File;
/**
* Com\Tecnick\File\Cache
*
* File caching system with per-instance path and prefix.
* Each Cache instance maintains its own cache directory path and file prefix.
*
* @since 2011-05-23
* @category Library
* @package File
* @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-file
*/
class Cache
{
/**
* Pattern matching characters that are not allowed in cache filename tokens
* (prefix, type, key). Stripping them keeps generated names valid on every
* platform (notably Windows) and prevents glob metacharacters from reaching
* delete()/deleteOlderThan(). getNewFileName() and delete() must use the
* same pattern so the prefix-based glob matches the files actually created.
*/
private const SAFE_NAME_PATTERN = '/[^a-zA-Z0-9_\-]/';
/**
* Cache path (per-instance)
*
* @var string
*/
protected string $path = '';
/**
* File prefix (per-instance)
*/
protected string $prefix;
/**
* Set the file prefix (common name)
*
* @param ?string $prefix Common prefix to be used for all cache files
*/
public function __construct(?string $prefix = null)
{
$this->defineSystemCachePath();
$this->setCachePath();
$prefix ??= \rtrim(
\base64_encode(\pack('H*', \md5(\uniqid((string) \mt_rand(0, \mt_getrandmax()), true)))),
'=',
);
$safePrefix = \preg_replace(self::SAFE_NAME_PATTERN, '', \strtr($prefix, '+/', '-_')) ?? '';
$this->prefix = '_' . $safePrefix . '_';
}
/**
* Get the cache directory path
*/
public function getCachePath(): string
{
return $this->path;
}
/**
* Set the default cache directory path
*
* @param ?string $path Cache directory path; if null use the K_PATH_CACHE value
*/
public function setCachePath(?string $path = null): void
{
if ($path === null || \str_contains($path, '://') || !\is_writable($path)) {
// Normalize the fallback too: K_PATH_CACHE may be supplied by the host
// application without a trailing separator, and getNewFileName()/delete()
// concatenate $this->path directly. Without normalization the generated
// file would escape the cache directory (e.g. ".../cachedir" + "_pfx_..."
// lands next to the directory instead of inside it).
$this->path = $this->normalizePath((string) \constant('K_PATH_CACHE'));
return;
}
$this->path = $this->normalizePath($path);
}
/**
* Get the file prefix
*/
public function getFilePrefix(): string
{
return $this->prefix;
}
/**
* Returns a temporary filename for caching files.
* Throws an exception when tempnam() fails, consistent with the rest of the library.
*
* @param string $type Type of file
* @param string $key File key (used to retrieve file from cache)
*
* @return string Temporary filename
*
* @throws \Com\Tecnick\File\Exception when a temporary file cannot be created.
*/
public function getNewFileName(string $type = 'tmp', string $key = '0'): string
{
// Sanitize so the generated name matches the patterns used by delete()
// and contains no characters that are invalid in Windows filenames.
$safeType = \preg_replace(self::SAFE_NAME_PATTERN, '', $type) ?? '';
$safeKey = \preg_replace(self::SAFE_NAME_PATTERN, '', $key) ?? '';
// tempnam() atomically creates a unique, private file, but on Windows it
// keeps only the first three characters of the prefix. Create the file
// with tempnam(), then rename it to a name carrying the full prefix so
// the prefix-based glob in delete()/deleteOlderThan() works on every
// platform. The rename preserves tempnam()'s restrictive permissions.
$file = \tempnam($this->path, $this->prefix);
if ($file === false) {
throw new Exception('unable to create a temporary file in: ' . $this->path);
}
$unique = \str_replace('.', '', \uniqid('', true));
$target = $this->path . $this->prefix . $safeType . '_' . $safeKey . '_' . $unique;
$renamed = $this->withoutFsWarnings(static fn(): bool => \rename($file, $target));
return $renamed ? $target : $file;
}
/**
* Delete cached files
*
* @param ?string $type Type of files to delete
* @param ?string $key Specific file key to delete
*/
public function delete(?string $type = null, ?string $key = null): void
{
$safeType = $type !== null ? \preg_replace(self::SAFE_NAME_PATTERN, '', $type) : null;
$safeKey = $key !== null ? \preg_replace(self::SAFE_NAME_PATTERN, '', $key) : null;
$path = $this->path . $this->prefix;
if ($safeType !== null) {
$path .= $safeType . '_';
if ($safeKey !== null) {
$path .= $safeKey . '_';
}
}
$path .= '*';
$files = \glob($path);
if ($files === [] || $files === false) {
return;
}
// Suppress warnings: a file may vanish (concurrent cleanup, external
// process) between glob() and unlink(); such races are non-fatal.
$this->withoutFsWarnings(static function () use ($files): void {
foreach ($files as $file) {
\unlink($file);
}
});
}
/**
* Delete cache files older than the given number of seconds.
*
* @param int $seconds Maximum age in seconds; files whose mtime is older are removed.
*/
public function deleteOlderThan(int $seconds): void
{
$pattern = $this->path . $this->prefix . '*';
$files = \glob($pattern);
if ($files === [] || $files === false) {
return;
}
$cutoff = \time() - $seconds;
// Suppress warnings: filemtime()/unlink() may fail if a file disappears
// between glob() and the call (concurrent cleanup); such races are non-fatal.
$this->withoutFsWarnings(static function () use ($files, $cutoff): void {
foreach ($files as $file) {
$mtime = \filemtime($file);
if ($mtime !== false && $mtime < $cutoff) {
\unlink($file);
}
}
});
}
/**
* Execute a callable while suppressing expected filesystem warnings.
*
* The cache helpers race against other processes and against files that may
* vanish between glob() and the operation; those calls already signal failure
* via their return values, so the raw PHP warnings only add noise.
*
* @template T
*
* @param callable():T $callback
*
* @return T
*/
private function withoutFsWarnings(callable $callback): mixed
{
\set_error_handler(static fn(): bool => true, E_WARNING);
try {
return $callback();
} finally {
\restore_error_handler();
}
}
/**
* Set the K_PATH_CACHE constant (if not set) to the default system directory for temporary files
*/
protected function defineSystemCachePath(): void
{
if (\defined('K_PATH_CACHE')) {
return;
}
$kPathCache = \ini_get('upload_tmp_dir');
if ($kPathCache === false || $kPathCache === '') {
$kPathCache = \sys_get_temp_dir();
}
\define('K_PATH_CACHE', $this->normalizePath($kPathCache));
}
/**
* Normalize cache path
*
* @param string $path Path to normalize
*/
protected function normalizePath(string $path): string
{
$rpath = \realpath($path);
if ($rpath === false) {
return '';
}
if (!\str_ends_with($rpath, \DIRECTORY_SEPARATOR)) {
$rpath .= \DIRECTORY_SEPARATOR;
}
return $rpath;
}
}
vendor/tecnickcom/tc-lib-file/src/Dir.php
Vendored
+118
View File
@@ -0,0 +1,118 @@
<?php
declare(strict_types=1);
/**
* Dir.php
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Com\Tecnick\File;
/**
* Com\Tecnick\File\Dir
*
* Function to handle directories
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*/
class Dir
{
/**
* Returns the full path of a parent directory
*
* @param string $name Name of the parent folder to search
* @param string $dir Starting directory
*
* @return string Directory name
*/
public function findParentDir(string $name, string $dir = __DIR__): string
{
$allowedBases = $this->getOpenBasedirPaths();
while ($dir !== '') {
if ($dir === \dirname($dir)) {
$dir = '';
}
$candidate = $dir . DIRECTORY_SEPARATOR . $name;
if ($this->isPathAllowed($candidate, $allowedBases) && \is_writable($candidate)) {
$dir = $candidate;
break;
}
$dir = \dirname($dir);
}
if (\substr($dir, -1) !== DIRECTORY_SEPARATOR) {
$dir .= DIRECTORY_SEPARATOR;
}
return $dir;
}
/**
* Returns the list of directories allowed by the active open_basedir restriction.
*
* An empty array means that no restriction is in effect.
*
* @return array<string> Allowed base directories without trailing separator.
*/
private function getOpenBasedirPaths(): array
{
$openBasedir = \ini_get('open_basedir');
if ($openBasedir === false || $openBasedir === '') {
return [];
}
$paths = [];
foreach (\explode(PATH_SEPARATOR, $openBasedir) as $path) {
$path = \rtrim($path, '/\\');
if ($path !== '') {
$paths[] = $path;
}
}
return $paths;
}
/**
* Tells whether the given path can be safely probed under the active open_basedir restriction.
*
* Probing a path outside the allowed list raises an open_basedir E_WARNING (which can
* corrupt the output stream or be promoted to an exception by the application error handler),
* so such paths must be skipped. When no restriction is in effect every path is allowed.
*
* @param string $path Path to check.
* @param array<string> $allowedBases Allowed base directories (empty when unrestricted).
*/
private function isPathAllowed(string $path, array $allowedBases): bool
{
if ($allowedBases === []) {
return true;
}
foreach ($allowedBases as $base) {
if ($path === $base || \str_starts_with($path, $base . DIRECTORY_SEPARATOR)) {
return true;
}
}
return false;
}
}
vendor/tecnickcom/tc-lib-file/src/Exception.php
Vendored
+34
View File
@@ -0,0 +1,34 @@
<?php
declare(strict_types=1);
/**
* Exception.php
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Com\Tecnick\File;
/**
* Com\Tecnick\File\Exception
*
* Custom Exception class
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*/
class Exception extends \Exception {}
vendor/tecnickcom/tc-lib-file/src/File.php
Vendored
+1187
View File
File diff suppressed because it is too large Load Diff
vendor/tecnickcom/tc-lib-file/test/A0FileNoForceCurlTest.php
Vendored
+28
View File
@@ -0,0 +1,28 @@
<?php
declare(strict_types=1);
namespace Test;
class A0FileNoForceCurlTest extends TestUtil
{
/**
* Covers the early getUrlData() guard when allow_url_fopen is enabled and
* FORCE_CURL is not defined yet.
*
* @throws \Com\Tecnick\File\Exception
*/
public function testGetUrlDataReturnsFalseWhenAllowUrlFopenEnabledWithoutForceCurl(): void
{
if (\defined('FORCE_CURL')) {
$this->markTestSkipped('FORCE_CURL already defined by another test class');
}
if (\ini_get('allow_url_fopen') === false || \ini_get('allow_url_fopen') === '0') {
$this->markTestSkipped('allow_url_fopen is disabled in this environment');
}
$file = new \Com\Tecnick\File\File(['example.com']);
$this->assertFalse($file->getUrlData('http://example.com/path.txt'));
}
}
vendor/tecnickcom/tc-lib-file/test/ByteTest.php
Vendored
+435
View File
@@ -0,0 +1,435 @@
<?php
/**
* ByteTest.php
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Test;
use PHPUnit\Framework\Attributes\DataProvider;
/**
* Byte Color class test
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*/
class ByteTest extends TestUtil
{
/**
* @throws \RangeException
*/
protected function getTestObject(): \Com\Tecnick\File\Byte
{
$str =
\chr(0)
. \chr(0)
. \chr(0)
. \chr(0)
. \chr(1)
. \chr(3)
. \chr(7)
. \chr(15)
. \chr(31)
. \chr(63)
. \chr(127)
. \chr(255)
. \chr(254)
. \chr(252)
. \chr(248)
. \chr(240)
. \chr(224)
. \chr(192)
. \chr(128)
. \chr(0)
. \chr(255)
. \chr(255)
. \chr(255)
. \chr(255);
return new \Com\Tecnick\File\Byte($str);
}
/**
* @throws \RangeException
*/
#[DataProvider('getByteDataProvider')]
public function testGetByte(int $offset, int $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getByte($offset);
$this->assertEquals($expected, $res);
}
/**
* @return array<array{int, int}>
*/
public static function getByteDataProvider(): array
{
return [
[0, 0],
[1, 0],
[2, 0],
[3, 0],
[4, 1],
[5, 3],
[6, 7],
[7, 15],
[8, 31],
[9, 63],
[10, 127],
[11, 255],
[12, 254],
[13, 252],
[14, 248],
[15, 240],
[16, 224],
[17, 192],
[18, 128],
[19, 0],
[20, 255],
[21, 255],
[22, 255],
[23, 255],
];
}
/**
* @throws \RangeException
*/
#[DataProvider('getUShortDataProvider')]
public function testGetUShort(int $offset, int $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getUShort($offset);
$this->assertEquals($expected, $res);
}
/**
* @throws \RangeException
*/
#[DataProvider('getUShortDataProvider')]
public function testGetUFWord(int $offset, int $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getUFWord($offset);
$this->assertEquals($expected, $res);
}
/**
* @return array<array{int, int}>
*/
public static function getUShortDataProvider(): array
{
return [
[0, 0],
[1, 0],
[2, 0],
[3, 1],
[4, 259],
[5, 775],
[6, 1_807],
[7, 3_871],
[8, 7_999],
[9, 16_255],
[10, 32_767],
[11, 65_534],
[12, 65_276],
[13, 64_760],
[14, 63_728],
[15, 61_664],
[16, 57_536],
[17, 49_280],
[18, 32_768],
[19, 255],
[20, 65_535],
[21, 65_535],
[22, 65_535],
];
}
/**
* @throws \RangeException
*/
#[DataProvider('getShortDataProvider')]
public function testGetShort(int $offset, int $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getShort($offset);
$this->assertEquals($expected, $res);
}
/**
* @throws \RangeException
*/
#[DataProvider('getShortDataProvider')]
public function testGetFWord(int $offset, int $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getFWord($offset);
$this->assertEquals($expected, $res);
}
/**
* @return array<array{int, int}>
*/
public static function getShortDataProvider(): array
{
return [
[0, 0],
[1, 0],
[2, 0],
[3, 1],
[4, 259],
[5, 775],
[6, 1_807],
[7, 3_871],
[8, 7_999],
[9, 16_255],
[10, 32_767],
[11, -2],
[12, -260],
[13, -776],
[14, -1_808],
[15, -3_872],
[16, -8_000],
[17, -16_256],
[18, -32_768],
[19, 255],
[20, -1],
[21, -1],
[22, -1],
];
}
/**
* @throws \RangeException
*/
#[DataProvider('getULongDataProvider')]
public function testGetULong(int $offset, int $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getULong($offset);
$this->assertEquals($expected, $res);
}
/**
* @return array<array{int, int}>
*/
public static function getULongDataProvider(): array
{
return [
[0, 0],
[1, 1],
[2, 259],
[3, 66_311],
[4, 16_975_631],
[5, 50_794_271],
[6, 118_431_551],
[7, 253_706_111],
[8, 524_255_231],
[9, 1_065_353_214],
[10, 2_147_483_388],
[11, 4_294_900_984],
[12, 4_277_991_664],
[13, 4_244_173_024],
[14, 4_176_535_744],
[15, 4_041_261_184],
[16, 3_770_712_064],
[17, 3_229_614_335],
[18, 2_147_549_183],
[19, 16_777_215],
[20, 4_294_967_295],
];
}
/**
* @throws \RangeException
*/
#[DataProvider('getLongDataProvider')]
public function testGetLong(int $offset, int $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getLong($offset);
$this->assertEquals($expected, $res);
}
/**
* @return array<array{int, int}>
*/
public static function getLongDataProvider(): array
{
return [
[0, 0],
[1, 1],
[2, 259],
[3, 66_311],
[4, 16_975_631],
[5, 50_794_271],
[6, 118_431_551],
[7, 253_706_111],
[8, 524_255_231],
[9, 1_065_353_214],
[10, 2_147_483_388],
[11, -66_312],
[12, -16_975_632],
[13, -50_794_272],
[14, -118_431_552],
[15, -253_706_112],
[16, -524_255_232],
[17, -1_065_352_961],
[18, -2_147_418_113],
[19, 16_777_215],
[20, -1],
];
}
/**
* @throws \RangeException
*/
#[DataProvider('getFixedDataProvider')]
public function testGetFixed(int $offset, int|float $expected): void
{
$byte = $this->getTestObject();
$res = $byte->getFixed($offset);
// compare floats with a small tolerance to avoid precision issues
$this->assertEqualsWithDelta($expected, $res, 1e-12, "float mismatch at offset {$offset}");
}
/**
* @return array<array{int, float}>
*/
public static function getFixedDataProvider(): array
{
return [
// high and low parts from the test string; see getShort/getUShort providers
// offset 0: all zero bytes
[0, 0.0],
// offset 1: high=0, low=1 -> 1/65536
[1, 1.52587890625E-5],
// offset 2: high=0, low=259 -> 259/65536
[2, 0.0039520263671875],
// offset 3: high=1, low=775 -> 1 + 775/65536
[3, 1.0118255615234375],
// a negative result with fractional part
[11, -1.0118408203125],
// large positive value near next integer
[19, 255.99998474121094],
// negative value very close to zero (tiny fraction)
[20, -1.52587890625E-5],
];
}
// -------------------------------------------------------------------------
// Issue 7: out-of-bounds reads — always throw exceptions
// -------------------------------------------------------------------------
/**
* @throws \RangeException
*/
public function testGetByteOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('AB'); // 2 bytes
$this->expectException(\RangeException::class);
$this->expectExceptionMessageMatches('/Out-of-bounds read/');
$byte->getByte(10);
}
/**
* @throws \RangeException
*/
public function testGetUShortOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('A'); // 1 byte only
$this->expectException(\RangeException::class);
$byte->getUShort(0);
}
/**
* @throws \RangeException
*/
public function testGetULongOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('ABC'); // 3 bytes
$this->expectException(\RangeException::class);
$byte->getULong(0);
}
/**
* @throws \RangeException
*/
public function testGetShortOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('A');
$this->expectException(\RangeException::class);
$byte->getShort(0);
}
/**
* @throws \RangeException
*/
public function testGetFixedOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('AB'); // needs 4 bytes
$this->expectException(\RangeException::class);
$byte->getFixed(0);
}
/**
* @throws \RangeException
*/
public function testGetUFWordOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('A'); // 1 byte, needs 2
$this->expectException(\RangeException::class);
$this->expectExceptionMessageMatches('/Out-of-bounds read/');
$byte->getUFWord(0);
}
/**
* @throws \RangeException
*/
public function testGetFWordOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('A'); // 1 byte, needs 2
$this->expectException(\RangeException::class);
$this->expectExceptionMessageMatches('/Out-of-bounds read/');
$byte->getFWord(0);
}
/**
* @throws \RangeException
*/
public function testGetLongOutOfBoundsThrows(): void
{
$byte = new \Com\Tecnick\File\Byte('ABC'); // 3 bytes, needs 4
$this->expectException(\RangeException::class);
$this->expectExceptionMessageMatches('/Out-of-bounds read/');
$byte->getLong(0);
}
/**
* @throws \RangeException
*/
public function testInBoundsReadNoWarning(): void
{
// A read exactly at the boundary must not warn.
$byte = new \Com\Tecnick\File\Byte("\x00\x01");
$this->assertSame(0, $byte->getByte(0));
$this->assertSame(1, $byte->getByte(1));
}
}
vendor/tecnickcom/tc-lib-file/test/CacheTest.php
Vendored
+399
View File
@@ -0,0 +1,399 @@
<?php
/**
* CacheTest.php
*
* @since 2011-05-23
* @category Library
* @package File
* @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-filecache
*
* This file is part of tc-lib-pdf-filecache software library.
*/
namespace Test;
use PHPUnit\Framework\Attributes\PreserveGlobalState;
use PHPUnit\Framework\Attributes\RunInSeparateProcess;
/**
* Unit Test
*
* @since 2011-05-23
* @category Library
* @package File
* @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-filecache
*/
class CacheTest extends TestUtil
{
protected function getTestObject(): \Com\Tecnick\File\Cache
{
return new \Com\Tecnick\File\Cache('1_2-a+B/c');
}
public function testAutoPrefix(): void
{
$cache = new \Com\Tecnick\File\Cache();
$this->assertNotEmpty($cache->getFilePrefix());
}
public function testGetCachePath(): void
{
$cache = $this->getTestObject();
$cachePath = $cache->getCachePath();
// The normalized cache path always ends with the platform separator.
$this->assertSame(\DIRECTORY_SEPARATOR, \substr($cachePath, -1));
$cache->setCachePath();
$this->assertEquals($cachePath, $cache->getCachePath());
// Use the real temp dir and compare realpath-to-realpath so the
// assertion holds on every platform (e.g. macOS /var -> /private/var
// symlink, Windows backslash separators).
$path = \sys_get_temp_dir();
$real = \realpath($path);
if ($real === false) {
self::fail('the system temp dir must resolve');
}
$cache->setCachePath($path);
$this->assertSame($real . \DIRECTORY_SEPARATOR, $cache->getCachePath());
}
public function testGetFilePrefix(): void
{
$cache = $this->getTestObject();
$filePrefix = $cache->getFilePrefix();
$this->assertEquals('_1_2-a-B_c_', $filePrefix);
}
/**
* @throws \Com\Tecnick\File\Exception
*/
public function testGetNewFileName(): void
{
$cache = $this->getTestObject();
$val = $cache->getNewFileName('tst', '0123');
$this->bcAssertMatchesRegularExpression('/_1_2-a-B_c_tst_0123_/', $val);
\unlink($val);
}
/**
* The full prefix, type and key must survive in the generated filename so
* the prefix-based glob in delete()/deleteOlderThan() matches on every
* platform. tempnam() alone truncates the prefix to 3 chars on Windows.
*
* @throws \Com\Tecnick\File\Exception
*/
public function testGetNewFileNamePreservesFullPrefix(): void
{
$cache = $this->getTestObject();
$fileA = $cache->getNewFileName('typ', 'k1');
$fileB = $cache->getNewFileName('typ', 'k2');
try {
$this->assertNotSame($fileA, $fileB, 'each call must return a distinct file');
$this->assertTrue(\file_exists($fileA));
$this->assertTrue(\file_exists($fileB));
$this->assertStringStartsWith($cache->getFilePrefix() . 'typ_k1_', \basename($fileA));
$this->assertStringStartsWith($cache->getFilePrefix() . 'typ_k2_', \basename($fileB));
} finally {
if (\is_file($fileA)) {
\unlink($fileA);
}
if (\is_file($fileB)) {
\unlink($fileB);
}
}
}
/**
* Characters that are invalid in Windows filenames (and glob metacharacters)
* are stripped from the generated name, keeping it valid and consistent with
* the patterns delete() builds.
*
* @throws \Com\Tecnick\File\Exception
*/
public function testGetNewFileNameSanitizesUnsafeTypeAndKey(): void
{
$cache = $this->getTestObject();
$file = $cache->getNewFileName('a/b*', 'c:d?');
try {
$this->assertStringStartsWith($cache->getFilePrefix() . 'ab_cd_', \basename($file));
$this->assertTrue(\file_exists($file));
} finally {
if (\is_file($file)) {
\unlink($file);
}
}
}
public function testNormalizePathInvalid(): void
{
$cache = $this->getTestObject();
// invoke protected normalizePath via reflection so we can test
// the branch where realpath() returns false
$ref = new \ReflectionMethod($cache, 'normalizePath');
$invalid = \sys_get_temp_dir() . '/nonexistent_' . \uniqid('', true);
$this->assertFalse(\file_exists($invalid), 'Sanity check: path should not exist');
$this->assertSame('', $ref->invoke($cache, $invalid));
}
/**
* @throws \Com\Tecnick\File\Exception
*/
public function testDelete(): void
{
$cache = $this->getTestObject();
$idk = 0;
/** @var array<int, string> $file */
$file = [];
for ($idx = 1; $idx <= 2; ++$idx) {
for ($idy = 1; $idy <= 2; ++$idy) {
$file[$idk] = $cache->getNewFileName((string) $idx, (string) $idy);
\file_put_contents($file[$idk], '');
$this->assertTrue(\file_exists($file[$idk]));
++$idk;
}
}
$f0 = $file[0] ?? '';
$f1 = $file[1] ?? '';
$f2 = $file[2] ?? '';
$f3 = $file[3] ?? '';
// delete a specific type/key pair
$cache->delete('2', '1');
$this->assertFalse(\file_exists($f2));
// delete all entries for type "1"
$cache->delete('1');
$this->assertFalse(\file_exists($f0));
$this->assertFalse(\file_exists($f1));
$this->assertTrue(\file_exists($f3));
// delete everything
$cache->delete();
$this->assertFalse(\file_exists($f3));
}
/**
* @throws \Com\Tecnick\File\Exception
*/
public function testKeyOnlyDeletesAll(): void
{
$cache = $this->getTestObject();
$file = $cache->getNewFileName('foo', 'bar');
\file_put_contents($file, '');
$this->assertTrue(\file_exists($file));
// key-only call should treat as delete all
$cache->delete(null, 'bar');
$this->assertFalse(\file_exists($file));
}
/**
* @throws \Com\Tecnick\File\Exception
*/
public function testDeleteNonExistingPatterns(): void
{
$cache = $this->getTestObject();
$file = $cache->getNewFileName('foo', 'bar');
\file_put_contents($file, '');
$this->assertTrue(\file_exists($file));
// deleting a type that does not exist should leave the file in place
$cache->delete('no-such-type');
$this->assertTrue(\file_exists($file));
// deleting a non-existent key under existing type
$cache->delete('foo', 'no-such-key');
$this->assertTrue(\file_exists($file));
\unlink($file);
}
public function testEachInstanceHasOwnPrefix(): void
{
// Each instance should have its own prefix
$cache1 = new \Com\Tecnick\File\Cache('pfx1');
$cache2 = new \Com\Tecnick\File\Cache('pfx2');
$prefix1 = $cache1->getFilePrefix();
$prefix2 = $cache2->getFilePrefix();
// Prefixes should be different since each instance is independent
$this->assertNotSame($prefix1, $prefix2);
$this->assertStringContainsString('pfx1', $prefix1);
$this->assertStringContainsString('pfx2', $prefix2);
}
public function testEachInstanceHasOwnCachePath(): void
{
$cache1 = new \Com\Tecnick\File\Cache();
$path1 = $cache1->getCachePath();
$tempdir = \sys_get_temp_dir() . '/cache_test_' . \uniqid();
\mkdir($tempdir);
$cache2 = new \Com\Tecnick\File\Cache();
$cache2->setCachePath($tempdir);
$path2 = $cache2->getCachePath();
// Paths should be different for each instance
$this->assertNotSame($path1, $path2);
$this->assertStringContainsString('cache_test_', $path2);
\rmdir($tempdir);
}
// -------------------------------------------------------------------------
// Issue 4: glob-injection sanitisation in delete()
// -------------------------------------------------------------------------
/**
* @throws \Com\Tecnick\File\Exception
*/
public function testDeleteGlobCharsInTypeSanitised(): void
{
$cache = new \Com\Tecnick\File\Cache('safepfx');
// Create a real file we do NOT want deleted.
$real = $cache->getNewFileName('safe', '1');
\file_put_contents($real, '');
$this->assertTrue(\file_exists($real));
// Call delete() with glob metacharacters in $type — must not expand.
$cache->delete('*', null);
// The real file must still exist because '*' was stripped to '' and
// the resulting pattern matched nothing (or only unrelated files).
// If glob injection were possible every file would be gone.
$this->assertTrue(\file_exists($real), 'Glob injection via $type must not delete unrelated files');
\unlink($real);
}
/**
* @throws \Com\Tecnick\File\Exception
*/
public function testDeleteGlobCharsInKeySanitised(): void
{
$cache = new \Com\Tecnick\File\Cache('safepfx2');
$real = $cache->getNewFileName('mytype', 'goodkey');
\file_put_contents($real, '');
$this->assertTrue(\file_exists($real));
// Inject glob metacharacter in $key — must be stripped.
$cache->delete('mytype', '?');
$this->assertTrue(\file_exists($real), 'Glob injection via $key must not delete unrelated files');
\unlink($real);
}
// -------------------------------------------------------------------------
// Issue 6: per-instance cache properties
// -------------------------------------------------------------------------
// Testing covered by testEachInstanceHasOwnPrefix() and testEachInstanceHasOwnCachePath()
// -------------------------------------------------------------------------
// Issue 9: createNewFileName()
// -------------------------------------------------------------------------
// Testing the exception path of getNewFileName() requires tempnam() to return false,
// which is not deterministic in this environment because tempnam() can fall back
// to the system temporary directory.
// -------------------------------------------------------------------------
// Issue 10: deleteOlderThan()
// -------------------------------------------------------------------------
public function testDeleteOlderThanNoFiles(): void
{
// Call deleteOlderThan() when no files exist for this cache prefix.
// glob() returns [] so the early-return on line 171 is exercised.
$cache = new \Com\Tecnick\File\Cache('emptyprefix_' . \uniqid('', true));
$cache->deleteOlderThan(3600);
// No exception thrown is the expected outcome.
$this->expectNotToPerformAssertions();
}
/**
* @throws \Com\Tecnick\File\Exception
*/
public function testDeleteOlderThan(): void
{
$cache = new \Com\Tecnick\File\Cache('ttl');
$old = $cache->getNewFileName('aged', '1');
$fresh = $cache->getNewFileName('aged', '2');
\file_put_contents($old, '');
\file_put_contents($fresh, '');
// Back-date the "old" file to 2 hours ago.
\touch($old, \time() - 7200);
// Delete files older than 1 hour.
$cache->deleteOlderThan(3600);
$this->assertFalse(\file_exists($old), 'Expired file must be deleted');
$this->assertTrue(\file_exists($fresh), 'Fresh file must be kept');
\unlink($fresh);
}
/**
* When the host application defines K_PATH_CACHE without a trailing separator,
* the fallback path must still be normalized so generated files land inside the
* cache directory instead of escaping into its parent (e.g. ".../cache" + name
* yielding ".../cache_<name>"). Runs in a separate process because K_PATH_CACHE
* is a constant that cannot be (re)defined once the cache class has set it.
*
* @throws \Com\Tecnick\File\Exception
*/
#[RunInSeparateProcess]
#[PreserveGlobalState(false)]
public function testGetNewFileNameRespectsCachePathWithoutTrailingSeparator(): void
{
$dir = \sys_get_temp_dir() . \DIRECTORY_SEPARATOR . 'tcfilecache_' . \uniqid('', true);
$this->assertTrue(\mkdir($dir, 0o700));
// Define K_PATH_CACHE without a trailing separator, before the cache class
// has a chance to define it from sys_get_temp_dir().
\define('K_PATH_CACHE', $dir);
try {
$cache = new \Com\Tecnick\File\Cache('trailsep');
// The reported cache path must end with the platform separator.
$cachePath = $cache->getCachePath();
$this->assertSame(\DIRECTORY_SEPARATOR, \substr($cachePath, -1));
$file = $cache->getNewFileName('tmp', '0');
try {
// The generated file must live inside the cache directory.
$this->assertTrue(\str_starts_with($file, $cachePath));
$this->assertSame(\realpath($dir), \realpath(\dirname($file)));
$this->assertTrue(\is_file($file));
} finally {
if (\is_file($file)) {
\unlink($file);
}
}
} finally {
\rmdir($dir);
}
}
}
vendor/tecnickcom/tc-lib-file/test/DirTest.php
Vendored
+89
View File
@@ -0,0 +1,89 @@
<?php
/**
* DirTest.php
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Test;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\PreserveGlobalState;
use PHPUnit\Framework\Attributes\RunInSeparateProcess;
/**
* File Color class test
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*/
class DirTest extends TestUtil
{
protected function getTestObject(): \Com\Tecnick\File\Dir
{
return new \Com\Tecnick\File\Dir();
}
#[DataProvider('getAltFilePathsDataProvider')]
public function testGetAltFilePaths(string $name, string $expected): void
{
$testObj = $this->getTestObject();
$dir = $testObj->findParentDir($name);
$this->bcAssertMatchesRegularExpression('#' . $expected . '#', $dir);
}
/**
* @return array<array{string, string}>
*/
public static function getAltFilePathsDataProvider(): array
{
return [['', '/src/'], ['missing', '/'], ['src', '/src/']];
}
/**
* The upward directory search must not raise open_basedir warnings when it walks
* above the allowed paths (see issue #238). Runs in a separate process because
* open_basedir cannot be relaxed once set.
*/
#[RunInSeparateProcess]
#[PreserveGlobalState(false)]
public function testFindParentDirUnderOpenBasedir(): void
{
$libRoot = \dirname(__DIR__);
// Restrict file access to the library tree (the temp dir is required by the
// test runner). The ancestors of $libRoot fall outside this restriction, so
// probing them would raise open_basedir warnings without the guard.
// @mago-expect lint:no-ini-set -- open_basedir can only be set at runtime in a test.
\ini_set('open_basedir', $libRoot . PATH_SEPARATOR . \sys_get_temp_dir());
$warnings = [];
\set_error_handler(static function (int $_errno, string $errstr) use (&$warnings): bool {
$warnings[] = $errstr;
return true;
});
try {
$dir = $this->getTestObject()->findParentDir('missing', $libRoot . '/src');
} finally {
\restore_error_handler();
}
$this->assertSame([], $warnings, 'open_basedir restriction must not raise warnings');
$this->bcAssertMatchesRegularExpression('#/$#', $dir);
}
}
vendor/tecnickcom/tc-lib-file/test/EmptyReadStreamWrapper.php
Vendored
+70
View File
@@ -0,0 +1,70 @@
<?php
/**
* EmptyReadStreamWrapper.php
*
* @since 2026-04-30
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Test;
/**
* A stream wrapper that returns initial data on the first read then returns
* empty strings on all subsequent reads while never signalling EOF via
* stream_eof(). This exercises the inner `break` in File::rfRead() that
* fires when fread() yields an empty string before the while-loop condition
* can detect EOF.
*/
class EmptyReadStreamWrapper
{
public mixed $context;
private string $initialData = 'ab';
private bool $initialRead = false;
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool
{
unset($path, $mode, $options, $opened_path);
return true;
}
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_read(int $count): string
{
unset($count);
if (!$this->initialRead) {
$this->initialRead = true;
return $this->initialData;
}
// Return empty string while still claiming not at EOF so that the
// while-loop in rfRead() re-enters and hits the inner break.
return '';
}
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_eof(): bool
{
// Never signal EOF — stream_read() will return '' instead.
return false;
}
/**
* @return array<string, mixed>
*/
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_stat(): array
{
return [];
}
}
vendor/tecnickcom/tc-lib-file/test/FileTest.php
Vendored
+1649
View File
File diff suppressed because it is too large Load Diff
vendor/tecnickcom/tc-lib-file/test/RecursiveReadFile.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/**
* RecursiveReadFile.php
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Test;
class RecursiveReadFile extends \Com\Tecnick\File\File
{
protected function hasUnreadBytes(mixed $resource): bool
{
return \is_resource($resource) && !\feof($resource);
}
}
vendor/tecnickcom/tc-lib-file/test/RecursiveReadStreamWrapper.php
Vendored
+61
View File
@@ -0,0 +1,61 @@
<?php
/**
* RecursiveReadStreamWrapper.php
*
* @since 2015-07-28
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Test;
class RecursiveReadStreamWrapper
{
public mixed $context;
private string $data = 'abcde';
private int $position = 0;
private int $reads = 0;
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool
{
unset($path, $mode, $options, $opened_path);
return true;
}
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_read(int $count): string
{
++$this->reads;
$length = $this->reads === 1 ? \min(2, $count) : $count;
$chunk = \substr($this->data, $this->position, $length);
$this->position += \strlen($chunk);
return $chunk;
}
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_eof(): bool
{
return $this->position >= \strlen($this->data);
}
/**
* @return array<string, mixed>
*/
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_stat(): array
{
return [];
}
}
vendor/tecnickcom/tc-lib-file/test/SingleByteStreamWrapper.php
Vendored
+66
View File
@@ -0,0 +1,66 @@
<?php
/**
* SingleByteStreamWrapper.php
*
* @since 2026-04-30
* @category Library
* @package File
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Test;
/**
* A stream wrapper that delivers exactly one byte per stream_read() call.
* Used to exercise the iterative while-loop in File::rfRead().
*/
class SingleByteStreamWrapper
{
public mixed $context;
private string $data = 'abcdefgh';
private int $position = 0;
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool
{
unset($path, $mode, $options, $opened_path);
return true;
}
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_read(int $count): string
{
unset($count);
// Always return one byte at a time regardless of requested count.
if ($this->position >= \strlen($this->data)) {
return '';
}
$byte = $this->data[$this->position];
++$this->position;
return $byte;
}
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_eof(): bool
{
return $this->position >= \strlen($this->data);
}
/**
* @return array<string, mixed>
*/
// phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps
public function stream_stat(): array
{
return [];
}
}
vendor/tecnickcom/tc-lib-file/test/TestUtil.php
Vendored
+60
View File
@@ -0,0 +1,60 @@
<?php
/**
* TestUtil.php
*
* @since 2020-12-19
* @category Library
* @package file
* @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-file
*
* This file is part of tc-lib-file software library.
*/
namespace Test;
use PHPUnit\Framework\TestCase;
/**
* Test Util
*
* @since 2020-12-19
* @category Library
* @package file
* @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-file
*/
class TestUtil extends TestCase
{
public function bcAssertEqualsWithDelta(
mixed $expected,
mixed $actual,
float $delta = 0.01,
string $message = '',
): void {
parent::assertEqualsWithDelta($expected, $actual, $delta, $message);
}
/**
* @param class-string<\Throwable> $exception
*/
public function bcExpectException(string $exception): void
{
parent::expectException($exception);
}
public function bcAssertIsResource(mixed $res): void
{
parent::assertIsResource($res);
}
public function bcAssertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void
{
parent::assertMatchesRegularExpression($pattern, $string, $message);
}
}
vendor/tecnickcom/tc-lib-file/test/empty.txt
Vendored
View File
vendor/tecnickcom/tc-lib-file/test/http/empty.php
Vendored
+10
View File
@@ -0,0 +1,10 @@
<?php
return;
/**
* empty.php - Test HTTP endpoint that returns an empty response body.
*
* Used by FileTest to verify the `$ret === true` branch in getUrlData()
* when CURLOPT_RETURNTRANSFER is not set.
*/
vendor/tecnickcom/tc-lib-file/test/http/large.php
Vendored
+10
View File
@@ -0,0 +1,10 @@
<?php
/**
* large.php - Test HTTP endpoint that returns a large body.
*
* Used by FileTest to verify that the maxRemoteSize limit is enforced
* via the cURL progress callback.
*/
echo \str_repeat('X', 1000);
vendor/tecnickcom/tc-lib-file/test/http/redirect.php
Vendored
+4
View File
@@ -0,0 +1,4 @@
<?php
$target = isset($_GET['to']) && \is_string($_GET['to']) ? $_GET['to'] : '/empty.php';
\header('Location: ' . $target, true, 302);