diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6a56af1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,287 @@ + EUROPEAN UNION PUBLIC LICENCE v. 1.2 + EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined +below) which is provided under the terms of this Licence. Any use of the Work, +other than as authorised under this Licence is prohibited (to the extent such +use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: + + Licensed under the EUPL + +or has expressed by any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: + +- ‘The Licence’: this Licence. + +- ‘The Original Work’: the work or software distributed or communicated by the + Licensor under this Licence, available as Source Code and also as Executable + Code as the case may be. + +- ‘Derivative Works’: the works or software that could be created by the + Licensee, based upon the Original Work or modifications thereof. This Licence + does not define the extent of modification or dependence on the Original Work + required in order to classify a work as a Derivative Work; this extent is + determined by copyright law applicable in the country mentioned in Article 15. + +- ‘The Work’: the Original Work or its Derivative Works. + +- ‘The Source Code’: the human-readable form of the Work which is the most + convenient for people to study and modify. + +- ‘The Executable Code’: any code which has generally been compiled and which is + meant to be interpreted by a computer as a program. + +- ‘The Licensor’: the natural or legal person that distributes or communicates + the Work under the Licence. + +- ‘Contributor(s)’: any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. + +- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of + the Work under the terms of the Licence. + +- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright vested +in the Original Work: + +- use the Work in any circumstance and for all usage, +- reproduce the Work, +- modify the Work, and make Derivative Works based upon the Work, +- communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case may + be, the Work, +- distribute the Work or copies thereof, +- lend and rent the Work or copies thereof, +- sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository where +the Source Code is easily and freely accessible for as long as the Licensor +continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits from +any exception or limitation to the exclusive rights of the rights owners in the +Work, of the exhaustion of those rights or of other applicable limitations +thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and a +copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of the +Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions on +the Work or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed under +a Compatible Licence, this Distribution or Communication can be done under the +terms of this Compatible Licence. For the sake of this clause, ‘Compatible +Licence’ refers to the licences listed in the appendix attached to this Licence. +Should the Licensee's obligations under the Compatible Licence conflict with +his/her obligations under this Licence, the obligations of the Compatible +Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the Work, +the Licensee will provide a machine-readable copy of the Source Code or indicate +a repository where this Source will be easily and freely available for as long +as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade names, +trademarks, service marks, or names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +‘bugs’ inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an ‘as is’ basis +and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other than +copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the use +of the Work, including without limitation, damages for loss of goodwill, work +stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such damage. +However, the Licensor will be liable under statutory product liability laws as +far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional agreement, +defining obligations or services consistent with this Licence. However, if +accepting obligations, You may act only on your own behalf and on your sole +responsibility, not on behalf of the original Licensor or any other Contributor, +and only if You agree to indemnify, defend, and hold each Contributor harmless +for any liability incurred by, or claims asserted against such Contributor by +the fact You have accepted any warranty or additional liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this Licence, +such as the use of the Work, the creation by You of a Derivative Work or the +Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of electronic +communication by You (for example, by offering to download the Work from a +remote location) the distribution channel or media (for example, a website) must +at least provide to the public the information requested by the applicable law +regarding the Licensor, the Licence and the way it may be accessible, concluded, +stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed or reformed so as necessary to make it +valid and enforceable. + +The European Commission may publish other linguistic versions or new versions of +this Licence or updated versions of the Appendix, so far this is required and +reasonable, without reducing the scope of the rights granted by the Licence. New +versions of the Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, + +- any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as a + Licensor, and any Licensee, will be subject to the jurisdiction of the Court + of Justice of the European Union, as laid down in article 272 of the Treaty on + the Functioning of the European Union, + +- any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive jurisdiction + of the competent court where the Licensor resides or conducts its primary + business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, + +- this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, + +- this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + +Appendix + +‘Compatible Licences’ according to Article 5 EUPL are: + +- GNU General Public License (GPL) v. 2, v. 3 +- GNU Affero General Public License (AGPL) v. 3 +- Open Software License (OSL) v. 2.1, v. 3.0 +- Eclipse Public License (EPL) v. 1.0 +- CeCILL v. 2.0, v. 2.1 +- Mozilla Public Licence (MPL) v. 2 +- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +- European Union Public Licence (EUPL) v. 1.1, v. 1.2 +- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong + Reciprocity (LiLiQ-R+). + +The European Commission may update this Appendix to later versions of the above +licences without producing a new version of the EUPL, as long as they provide +the rights granted in Article 2 of this Licence and protect the covered Source +Code from exclusive appropriation. + +All other changes or additions to this Appendix require the production of a new +EUPL version. diff --git a/README.md b/README.md new file mode 100644 index 0000000..086e9fe --- /dev/null +++ b/README.md @@ -0,0 +1,148 @@ +# Inotify + +A Swift wrapper around the Linux [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) API, built on modern Swift concurrency. It lets you watch individual files or directories for filesystem events, recursively monitor entire subtrees, and optionally have newly created subdirectories watched automatically. + +Events are delivered as an `AsyncSequence`, so you can consume them with a simple `for await` loop. + +## Adding Inotify to Your Project + +Add the package dependency in your `Package.swift`: + +```swift +dependencies: [ + .package(url: "https://github.com/astzweig/swift-inotify.git", from: "1.0.0") +] +``` + +Then add `Inotify` to your target's dependencies: + +```swift +.target( + ... + dependencies: [ + .product(name: "Inotify", package: "swift-inotify") + ] + ... +) +``` + +## Quick Start + +```swift +import Inotify + +let inotify = try Inotify() + +// Watch a single file for modifications +try inotify.addWatch(path: "/tmp/some-existing-file.txt", mask: [.modify]) + +// Watch a single directory for file creations and modifications +try inotify.addWatch(path: "/tmp/watched", mask: [.create, .modify]) + +// Consume events as they arrive +for await event in await inotify.events { + print("Event at \(event.path): \(event.mask)") +} +``` + +## Watching Subtrees + +Inotify operates on individual watch descriptors, so monitoring a directory does not automatically cover its children. This library provides two convenience methods that handle the recursion for you. + +### Recursive Watch + +`addRecursiveWatch` walks the directory tree at setup time and installs a watch on every existing subdirectory: + +```swift +try await inotify.addRecursiveWatch( + forDirectory: "/home/user/project", + mask: [.create, .modify, .delete] +) +``` + +Subdirectories created after the call are **not** watched. + +### Automatic Subtree Watching + +`addWatchWithAutomaticSubtreeWatching` does everything `addRecursiveWatch` does, and additionally listens for `CREATE` events with the `isDir` flag. Whenever a new subdirectory appears, a watch is installed on it automatically: + +```swift +try await inotify.addWatchWithAutomaticSubtreeWatching( + forDirectory: "/home/user/project", + mask: [.create, .modify, .delete] +) +``` + +This is the most convenient option when you need full coverage of a growing directory tree. + +## Event Masks + +`InotifyEventMask` is an `OptionSet` that mirrors the native inotify flags. You can combine them freely. + +| Mask | Description | +|------|-------------| +| `.access` | File was read | +| `.attrib` | Metadata changed (permissions, timestamps, ...) | +| `.closeWrite` | File opened for writing was closed | +| `.closeNoWrite` | File **not** opened for writing was closed | +| `.create` | File or directory created in watched directory | +| `.delete` | File or directory deleted in watched directory | +| `.deleteSelf` | Watched item itself was deleted | +| `.modify` | File was written to | +| `.moveSelf` | Watched item itself was moved | +| `.movedFrom` | File moved **out** of watched directory | +| `.movedTo` | File moved **into** watched directory | +| `.open` | File was opened | + +Convenience combinations: `.move` (`.movedFrom` + `.movedTo`), `.close` (`.closeWrite` + `.closeNoWrite`), `.allEvents`. + +Watch flags: `.dontFollow`, `.onlyDir`, `.oneShot`. + +Kernel-only flags returned in events: `.isDir`, `.ignored`, `.queueOverflow`, `.unmount`. + +## Removing a Watch + +Every `addWatch` variant returns one or more watch descriptors that you can use to remove the watch later: + +```swift +let wd = try inotify.addWatch(path: "/tmp/watched", mask: .create) + +// ... later +try inotify.removeWatch(wd) +``` + +## Build Tool + +The package ships with a `task` executable (the `TaskCLI` target) that serves as the project's build tool. It spins up a Docker container running `swift:latest` on Linux and executes the full test suite inside it, so you can validate everything on the correct platform even when developing on macOS. + +```bash +swift run task test +``` + +Use `-v`, `-vv`, or `-vvv` to increase log verbosity. The command runs two passes: first all tests except `InotifyLimitTests`, then only `InotifyLimitTests` (which manipulate system-level inotify limits and need to run in isolation). + +Docker must be installed and running on your machine. + +## Documentation + +Full API documentation is available as DocC catalogs bundled with the package. Generate them locally with: + +```bash +# Inotify library +swift package generate-documentation --target Inotify + +# Task build tool +swift package generate-documentation --target TaskCLI +``` + +Or preview in Xcode by selecting **Product > Build Documentation**. + +## Requirements + +- Swift 6.0+ +- Linux (inotify is a Linux-only API) +- Docker (for running the test suite via `swift run task test`) + +## License + +See [LICENSE](LICENSE) for details. diff --git a/Sources/Inotify/Inotify.docc/Inotify.md b/Sources/Inotify/Inotify.docc/Inotify.md new file mode 100644 index 0000000..74edf5d --- /dev/null +++ b/Sources/Inotify/Inotify.docc/Inotify.md @@ -0,0 +1,40 @@ +# ``Inotify`` + +Monitor filesystem events on Linux using modern Swift concurrency. + +## Overview + +The Inotify library wraps the Linux [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) API in a Swift-native interface built around actors and async sequences. You create an ``Inotify/Inotify`` actor, add watches for the paths you care about, and iterate over the ``Inotify/Inotify/events`` property to receive ``InotifyEvent`` values as they occur. + +```swift +let inotify = try Inotify() +try inotify.addWatch(path: "/tmp/inbox", mask: [.create, .modify]) + +for await event in await inotify.events { + print("\(event.mask) at \(event.path)") +} +``` + +Beyond single-directory watches, the library provides two higher-level methods for monitoring entire directory trees: + +- ``Inotify/Inotify/addRecursiveWatch(forDirectory:mask:)`` installs watches on every existing subdirectory at setup time. +- ``Inotify/Inotify/addWatchWithAutomaticSubtreeWatching(forDirectory:mask:)`` does the same **and** automatically watches subdirectories that are created after setup. + +All public types conform to `Sendable`, so they can be safely passed across concurrency boundaries. + +## Topics + +### Essentials + +- ``Inotify/Inotify`` +- ``InotifyEvent`` +- ``InotifyEventMask`` + +### Errors + +- ``InotifyError`` +- ``DirectoryResolverError`` + +### Low-Level Types + +- ``RawInotifyEvent`` diff --git a/Sources/Inotify/Inotify.docc/WatchingDirectoryTrees.md b/Sources/Inotify/Inotify.docc/WatchingDirectoryTrees.md new file mode 100644 index 0000000..71b97c5 --- /dev/null +++ b/Sources/Inotify/Inotify.docc/WatchingDirectoryTrees.md @@ -0,0 +1,42 @@ +# Watching Directory Trees + +Monitor an entire directory hierarchy for filesystem events. + +## Overview + +The Linux inotify API watches individual directories — it does not descend into subdirectories automatically. The ``Inotify/Inotify`` actor offers two convenience methods that handle the recursion for you. + +### Recursive Watch + +Call ``Inotify/Inotify/addRecursiveWatch(forDirectory:mask:)`` to walk the directory tree once and install a watch on every subdirectory that exists at the time of the call: + +```swift +let inotify = try Inotify() +let descriptors = try await inotify.addRecursiveWatch( + forDirectory: "/home/user/project", + mask: [.create, .modify, .delete] +) +``` + +The returned array contains one watch descriptor per directory. Subdirectories created **after** this call are not covered. + +### Automatic Subtree Watching + +When you also want future subdirectories to be picked up, use ``Inotify/Inotify/addWatchWithAutomaticSubtreeWatching(forDirectory:mask:)`` instead: + +```swift +let descriptors = try await inotify.addWatchWithAutomaticSubtreeWatching( + forDirectory: "/home/user/project", + mask: [.create, .modify, .delete] +) +``` + +Internally this listens for `CREATE` events carrying the ``InotifyEventMask/isDir`` flag and installs a new watch with the same mask whenever a subdirectory appears. + +### Choosing the Right Method + +| Method | Covers existing subdirectories | Covers new subdirectories | +|--------|:----:|:----:| +| ``Inotify/Inotify/addWatch(path:mask:)`` | No | No | +| ``Inotify/Inotify/addRecursiveWatch(forDirectory:mask:)`` | Yes | No | +| ``Inotify/Inotify/addWatchWithAutomaticSubtreeWatching(forDirectory:mask:)`` | Yes | Yes | diff --git a/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md b/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md new file mode 100644 index 0000000..0627eee --- /dev/null +++ b/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md @@ -0,0 +1,46 @@ +# ``TaskCLI`` + +The build tool for the Swift Inotify project. + +## Overview + +`TaskCLI` is a small command-line executable (exposed as `task` in `Package.swift`) that automates project-level workflows. Its primary purpose is running the integration test suite inside a Linux Docker container, so you can validate the inotify-dependent code on the correct platform even when developing on macOS. + +### Running the Tests + +```bash +swift run task test +``` + +This launches a `swift:latest` Docker container with the repository mounted at `/code`, then executes two test passes: + +1. All tests **except** `InotifyLimitTests` — the regular integration suite. +2. Only `InotifyLimitTests` (with `--skip-build`) — tests that manipulate system-level inotify limits and must run in isolation. + +The container is started with `--security-opt systempaths=unconfined` so that the limit tests can write to `/proc/sys/fs/inotify/*`. + +### Verbosity + +Pass one or more `-v` flags to increase log output: + +| Flag | Level | +|------|-------| +| *(none)* | `notice` | +| `-v` | `info` | +| `-vv` | `debug` | +| `-vvv` | `trace` | + +### Prerequisites + +Docker must be installed and running on the host machine. The container uses the `linux/arm64` platform by default. + +## Topics + +### Commands + +- ``Command`` +- ``TestCommand`` + +### Configuration + +- ``GlobalOptions``