Compare commits

..

No commits in common. 'ocfl-files-and-hierarchy' and 'main' have entirely different histories.

  1. 339
      LICENSE
  2. 172
      README.md
  3. 35
      composer.json
  4. 4
      config/install/ocfl_export.settings.yml
  5. 12
      config/schema/ocfl_export.schema.yml
  6. 27
      ocfl_export.install
  7. 82
      ocfl_export.module
  8. 1
      ocfl_export.routing.yml
  9. 16
      ocfl_export.services.yml
  10. 15
      src/Controller/OcflExportController.php
  11. 39
      src/Form/OcflSettingsForm.php
  12. 3
      src/MediaSerializerService.php
  13. 160
      src/NodeSerializerService.php
  14. 390
      src/OcflExporter.php
  15. 545
      src/OcflStorageService.php
  16. 12
      src/Plugin/Action/ExportMediaToOcfl.php
  17. 12
      src/Plugin/Action/ExportNodeToOcfl.php

339
LICENSE

@ -1,339 +0,0 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) 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
this service 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 make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. 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.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
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
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the 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 a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE 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.
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
convey 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 2 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, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision 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, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This 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.

172
README.md

@ -1,172 +0,0 @@
# OCFL Export
Exports Drupal nodes and media as [OCFL](https://ocfl.io/1.1/spec/) (Oxford
Common File Layout) objects on the filesystem, for digital preservation.
The module is Islandora aware: a node's OCFL object contains the node's
metadata, the binaries of every media that belongs to it (originals,
derivatives, etc.) and its place in the collection hierarchy. It also works on
plain Drupal sites, where it includes files in a node's own file/image fields
and media referenced from the node's fields.
## Requirements
- Drupal 10.5+
- PHP 8.3+
- Core modules: node, user, media (and file)
- Optional: [Islandora](https://github.com/Islandora/islandora) for
`field_media_of`, `field_member_of` and `field_model` support
## Installation
```sh
composer require roblib/ocfl_export
drush en ocfl_export
```
Then configure it at **Administration » Configuration » Content authoring »
OCFL Export Settings** (`/admin/config/content/ocfl-export`).
When upgrading an existing installation, run `drush updatedb` to add new
settings.
## What gets exported
Every node and (optionally) every media entity becomes its own OCFL object.
A node object looks like this:
```
node.json Node metadata (see below)
media/{media uuid}/{filename} Files of each associated media
files/{field name}/{filename} Files in the node's own file/image fields
```
Associated media are:
- media whose "media of" field (Islandora: `field_media_of`) points at the
node, and
- media referenced from any media reference field on the node (for example
`field_representative_image`).
A standalone media object contains `node.json` (the media's metadata) and
`files/{field name}/{filename}`. Media thumbnails generated by Drupal are not
exported.
### node.json
In addition to the node's base properties (`uuid`, `nid`, `title`, `type`,
`created`, `changed`, `status`, `author`) and all of its `fields`, `node.json`
contains:
- `relationships`
- `model`: the Islandora model term (`tid`, `uuid`, `name`, and its
external `uri` when present).
- `member_of`: the node's direct parents, each with `nid`, `uuid`, `title`,
`type` and `model`.
- `hierarchy`: every ancestor path through `member_of`, each ordered from
the root collection down to the direct parent. A node with several parents
has several paths.
- `media`: each associated media's full metadata (including
`field_media_use`), how it is associated with the node (`media_of` and/or
`field:<field name>`) and its `files`.
- `files`: the node's own files.
- `_metadata`: export information. `_metadata.missing_files` lists any file
that could not be read during export; the rest of the object is still saved.
Each file entry gives its `logical_path` inside the object, plus `field`,
`fid`, `uuid`, `filename`, `filemime`, `filesize` and the original Drupal
`uri`.
### Versions and deduplication
Every export creates a new OCFL version. A file whose checksum (sha512) is
already in the object's manifest is not copied again: the new version simply
references the existing copy, so large files that don't change are stored
once. Each copied file is verified against its checksum. Checksums are cached
by file URI, size and modification time so unchanged files aren't re-read on
every export.
Deleting a node or media creates a final version marked `"deleted": true`; the
earlier versions, including their files, are kept.
## Storage layout
The storage root (default `private://ocfl-storage`) uses the
[0003-hash-and-id-n-tuple-storage-layout](https://ocfl.github.io/extensions/0003-hash-and-id-n-tuple-storage-layout.html)
extension. Object IDs are `urn:uuid:{entity uuid}`, and an object is stored at
the first three 3-character tuples of the sha256 of its ID, followed by the
percent-encoded ID:
```
ocfl-storage/
├── 0=ocfl_1.1
├── ocfl_layout.json
├── extensions/0003-hash-and-id-n-tuple-storage-layout/config.json
└── b55/aed/a8b/urn%3auuid%3a11111111-2222-3333-4444-555555555555/
├── 0=ocfl_object_1.1
├── inventory.json
├── inventory.json.sha512
├── v1/
└── v2/
```
To find an object on disk, search for its UUID:
```sh
find /path/to/ocfl-storage -maxdepth 4 -name '*<uuid>*'
```
The module refuses to write into a storage root that declares a different
layout.
## Configuration
| Setting | Default | Description |
|---|---|---|
| Storage Root Path | `private://ocfl-storage` | Stream wrapper URI or absolute path of the storage root. |
| Enable automatic export on node save | on | Export nodes when they (or their media) are saved. |
| Content types to export | all | Limit automatic node export to these types. |
| Enable automatic export on media save | on | Also export each media as its own object. |
| Media types to export | all | Limit standalone media export to these types. |
| Copy files into OCFL objects | on | When off, only metadata is exported. |
| "Media of" field | `field_media_of` | Media field pointing at the owning node. |
| "Member of" field | `field_member_of` | Node field pointing at parent nodes. |
| Model field | `field_model` | Node field holding the model term. |
Leave a field setting empty to disable that feature.
**Islandora sites:** media binaries are already stored in their parent node's
object. Leaving standalone media export on stores them a second time, so you
will usually want to turn it off.
## Exporting
- **Automatically:** saving a node, or inserting, updating or deleting one of
its media, queues the node. Queued nodes are exported once when the request
ends, so saving a node together with several media creates one new version.
This also applies to drush commands. Islandora derivatives arrive in
separate requests, so each derivative creates a version of its parent node.
- **Manually:** the **Export to OCFL** button on a node or media page (requires
the *Export content to OCFL* permission).
- **In bulk:** the **Export to OCFL** action, available to Views bulk
operations on content and media listings.
Users with the *Export content to OCFL* permission see the current export
version on node and media pages, with a link to view the latest `node.json`.
## Permissions
- *Administer OCFL Export*: change the module's settings.
- *Export content to OCFL*: export manually and view export status and JSON.
## Limitations
- Titles stored in `member_of` and `hierarchy` are those at export time.
Renaming a collection does not re-export its descendants; their records
update the next time each is exported.
- Version `user` entries contain only a name (no address), so OCFL validators
report the W008 recommendation.
## License
GPL-2.0-or-later. See [LICENSE](LICENSE).

35
composer.json

@ -1,35 +0,0 @@
{
"name": "roblib/ocfl_export",
"description": "Exports Drupal nodes and media (Islandora aware) as OCFL (Oxford Common File Layout) objects, including their files and collection hierarchy.",
"type": "drupal-module",
"license": "GPL-2.0-or-later",
"keywords": [
"Drupal",
"Islandora",
"OCFL",
"digital preservation"
],
"homepage": "https://git.library.upei.ca/Code/ocfl_export",
"support": {
"issues": "https://git.library.upei.ca/Code/ocfl_export/issues",
"source": "https://git.library.upei.ca/Code/ocfl_export"
},
"authors": [
{
"name": "Robertson Library, University of Prince Edward Island",
"role": "Owner"
},
{
"name": "Paul Pound",
"role": "Maintainer"
}
],
"require": {
"php": ">=8.3",
"drupal/core": "^10.5"
},
"suggest": {
"drupal/islandora": "Adds media discovered via field_media_of, collection hierarchy (field_member_of) and model information to node exports.",
"drupal/paragraphs": "Paragraph fields are serialized into the exported metadata when present."
}
}

4
config/install/ocfl_export.settings.yml

@ -4,7 +4,3 @@ content_types: []
auto_export_media_enabled: true auto_export_media_enabled: true
media_types: [] media_types: []
ocfl_version: '1.1' ocfl_version: '1.1'
include_files: true
member_of_field: field_member_of
media_of_field: field_media_of
model_field: field_model

12
config/schema/ocfl_export.schema.yml

@ -26,15 +26,3 @@ ocfl_export.settings:
ocfl_version: ocfl_version:
type: string type: string
label: 'OCFL version' label: 'OCFL version'
include_files:
type: boolean
label: 'Copy media and file binaries into OCFL objects'
member_of_field:
type: string
label: 'Node field holding parent membership (isMemberOf)'
media_of_field:
type: string
label: 'Media field pointing at the owning node'
model_field:
type: string
label: 'Node field holding the model taxonomy term'

27
ocfl_export.install

@ -1,27 +0,0 @@
<?php
/**
* @file
* Install, update and uninstall functions for the OCFL Export module.
*/
declare(strict_types=1);
/**
* Add settings for file export and Islandora relationship fields.
*/
function ocfl_export_update_10001(): void {
$config = \Drupal::configFactory()->getEditable('ocfl_export.settings');
$defaults = [
'include_files' => TRUE,
'member_of_field' => 'field_member_of',
'media_of_field' => 'field_media_of',
'model_field' => 'field_model',
];
foreach ($defaults as $key => $value) {
if ($config->get($key) === NULL) {
$config->set($key, $value);
}
}
$config->save();
}

82
ocfl_export.module

@ -12,30 +12,33 @@ use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Url; use Drupal\Core\Url;
use Drupal\media\MediaInterface; use Drupal\media\MediaInterface;
use Drupal\node\NodeInterface; use Drupal\node\NodeInterface;
use Drupal\ocfl_export\OcflExporter;
/** /**
* Implements hook_node_insert(). * Implements hook_node_insert().
*/ */
function ocfl_export_node_insert(NodeInterface $node): void { function ocfl_export_node_insert(NodeInterface $node): void {
_ocfl_export_exporter()->queueNode($node); _ocfl_export_save_node($node);
} }
/** /**
* Implements hook_node_update(). * Implements hook_node_update().
*/ */
function ocfl_export_node_update(NodeInterface $node): void { function ocfl_export_node_update(NodeInterface $node): void {
_ocfl_export_exporter()->queueNode($node); _ocfl_export_save_node($node);
} }
/** /**
* Implements hook_node_delete(). * Implements hook_node_delete().
*/ */
function ocfl_export_node_delete(NodeInterface $node): void { function ocfl_export_node_delete(NodeInterface $node): void {
$exporter = _ocfl_export_exporter(); $config = \Drupal::config('ocfl_export.settings');
$exporter->unqueueNode($node);
if (!$exporter->shouldAutoExportNode($node)) { if (!$config->get('auto_export_enabled')) {
return;
}
$content_types = $config->get('content_types') ?: [];
if (!empty($content_types) && !in_array($node->bundle(), $content_types, TRUE)) {
return; return;
} }
@ -52,6 +55,38 @@ function ocfl_export_node_delete(NodeInterface $node): void {
} }
} }
/**
* Helper function to save node to OCFL storage.
*/
function _ocfl_export_save_node(NodeInterface $node): void {
$config = \Drupal::config('ocfl_export.settings');
if (!$config->get('auto_export_enabled')) {
return;
}
$content_types = $config->get('content_types') ?: [];
if (!empty($content_types) && !in_array($node->bundle(), $content_types, TRUE)) {
return;
}
try {
/** @var \Drupal\ocfl_export\NodeSerializerService $serializer */
$serializer = \Drupal::service('ocfl_export.node_serializer');
/** @var \Drupal\ocfl_export\OcflStorageService $storage */
$storage = \Drupal::service('ocfl_export.storage');
$data = $serializer->serialize($node);
$storage->saveObject($node->uuid(), $data);
}
catch (\Exception $e) {
\Drupal::logger('ocfl_export')->error('Failed to export node @nid to OCFL: @message', [
'@nid' => $node->id(),
'@message' => $e->getMessage(),
]);
}
}
/** /**
* Implements hook_media_insert(). * Implements hook_media_insert().
*/ */
@ -70,12 +105,14 @@ function ocfl_export_media_update(MediaInterface $media): void {
* Implements hook_media_delete(). * Implements hook_media_delete().
*/ */
function ocfl_export_media_delete(MediaInterface $media): void { function ocfl_export_media_delete(MediaInterface $media): void {
$exporter = _ocfl_export_exporter(); $config = \Drupal::config('ocfl_export.settings');
// The owning node's object should no longer include this media. if (!$config->get('auto_export_media_enabled')) {
$exporter->queueParentNodes($media); return;
}
if (!$exporter->shouldAutoExportMedia($media)) { $media_types = $config->get('media_types') ?: [];
if (!empty($media_types) && !in_array($media->bundle(), $media_types, TRUE)) {
return; return;
} }
@ -96,17 +133,25 @@ function ocfl_export_media_delete(MediaInterface $media): void {
* Helper function to save media to OCFL storage. * Helper function to save media to OCFL storage.
*/ */
function _ocfl_export_save_media(MediaInterface $media): void { function _ocfl_export_save_media(MediaInterface $media): void {
$exporter = _ocfl_export_exporter(); $config = \Drupal::config('ocfl_export.settings');
// Islandora media (and derivatives) belong to a node's object. if (!$config->get('auto_export_media_enabled')) {
$exporter->queueParentNodes($media); return;
}
if (!$exporter->shouldAutoExportMedia($media)) { $media_types = $config->get('media_types') ?: [];
if (!empty($media_types) && !in_array($media->bundle(), $media_types, TRUE)) {
return; return;
} }
try { try {
$exporter->exportMedia($media); /** @var \Drupal\ocfl_export\MediaSerializerService $serializer */
$serializer = \Drupal::service('ocfl_export.media_serializer');
/** @var \Drupal\ocfl_export\OcflStorageService $storage */
$storage = \Drupal::service('ocfl_export.storage');
$data = $serializer->serialize($media);
$storage->saveObject($media->uuid(), $data);
} }
catch (\Exception $e) { catch (\Exception $e) {
\Drupal::logger('ocfl_export')->error('Failed to export media @mid to OCFL: @message', [ \Drupal::logger('ocfl_export')->error('Failed to export media @mid to OCFL: @message', [
@ -116,13 +161,6 @@ function _ocfl_export_save_media(MediaInterface $media): void {
} }
} }
/**
* Get the OCFL exporter service.
*/
function _ocfl_export_exporter(): OcflExporter {
return \Drupal::service('ocfl_export.exporter');
}
/** /**
* Implements hook_node_view(). * Implements hook_node_view().
*/ */

1
ocfl_export.routing.yml

@ -38,4 +38,3 @@ ocfl_export.view_export:
requirements: requirements:
_permission: 'export ocfl content' _permission: 'export ocfl content'
entity_type: 'node|media' entity_type: 'node|media'
uuid: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'

16
ocfl_export.services.yml

@ -5,31 +5,15 @@ services:
- '@config.factory' - '@config.factory'
- '@file_system' - '@file_system'
- '@logger.factory' - '@logger.factory'
- '@keyvalue'
- '@current_user'
ocfl_export.node_serializer: ocfl_export.node_serializer:
class: Drupal\ocfl_export\NodeSerializerService class: Drupal\ocfl_export\NodeSerializerService
arguments: arguments:
- '@entity_type.manager' - '@entity_type.manager'
- '@datetime.time' - '@datetime.time'
- '@config.factory'
ocfl_export.media_serializer: ocfl_export.media_serializer:
class: Drupal\ocfl_export\MediaSerializerService class: Drupal\ocfl_export\MediaSerializerService
arguments: arguments:
- '@entity_type.manager' - '@entity_type.manager'
- '@datetime.time' - '@datetime.time'
ocfl_export.exporter:
class: Drupal\ocfl_export\OcflExporter
arguments:
- '@entity_type.manager'
- '@entity_field.manager'
- '@config.factory'
- '@ocfl_export.storage'
- '@ocfl_export.node_serializer'
- '@ocfl_export.media_serializer'
- '@logger.factory'
tags:
- { name: needs_destruction }

15
src/Controller/OcflExportController.php

@ -9,7 +9,8 @@ use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Url; use Drupal\Core\Url;
use Drupal\media\MediaInterface; use Drupal\media\MediaInterface;
use Drupal\node\NodeInterface; use Drupal\node\NodeInterface;
use Drupal\ocfl_export\OcflExporter; use Drupal\ocfl_export\MediaSerializerService;
use Drupal\ocfl_export\NodeSerializerService;
use Drupal\ocfl_export\OcflStorageService; use Drupal\ocfl_export\OcflStorageService;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\HttpFoundation\RedirectResponse;
@ -23,7 +24,8 @@ class OcflExportController extends ControllerBase {
public function __construct( public function __construct(
protected OcflStorageService $storageService, protected OcflStorageService $storageService,
protected OcflExporter $exporter, protected NodeSerializerService $nodeSerializerService,
protected MediaSerializerService $mediaSerializerService,
MessengerInterface $messenger, MessengerInterface $messenger,
) { ) {
$this->messenger = $messenger; $this->messenger = $messenger;
@ -35,7 +37,8 @@ class OcflExportController extends ControllerBase {
public static function create(ContainerInterface $container): static { public static function create(ContainerInterface $container): static {
return new static( return new static(
$container->get('ocfl_export.storage'), $container->get('ocfl_export.storage'),
$container->get('ocfl_export.exporter'), $container->get('ocfl_export.node_serializer'),
$container->get('ocfl_export.media_serializer'),
$container->get('messenger'), $container->get('messenger'),
); );
} }
@ -51,7 +54,8 @@ class OcflExportController extends ControllerBase {
*/ */
public function exportNode(NodeInterface $node): RedirectResponse { public function exportNode(NodeInterface $node): RedirectResponse {
try { try {
$success = $this->exporter->exportNode($node, 'Manual export'); $data = $this->nodeSerializerService->serialize($node);
$success = $this->storageService->saveObject($node->uuid(), $data);
if ($success) { if ($success) {
$this->messenger->addStatus($this->t('Node "@title" has been exported to OCFL storage.', [ $this->messenger->addStatus($this->t('Node "@title" has been exported to OCFL storage.', [
@ -96,7 +100,8 @@ class OcflExportController extends ControllerBase {
*/ */
public function exportMedia(MediaInterface $media): RedirectResponse { public function exportMedia(MediaInterface $media): RedirectResponse {
try { try {
$success = $this->exporter->exportMedia($media, 'Manual export'); $data = $this->mediaSerializerService->serialize($media);
$success = $this->storageService->saveObject($media->uuid(), $data);
if ($success) { if ($success) {
$this->messenger->addStatus($this->t('Media "@name" has been exported to OCFL storage.', [ $this->messenger->addStatus($this->t('Media "@name" has been exported to OCFL storage.', [

39
src/Form/OcflSettingsForm.php

@ -155,41 +155,6 @@ class OcflSettingsForm extends ConfigFormBase {
'#default_value' => $config->get('media_types') ?: [], '#default_value' => $config->get('media_types') ?: [],
]; ];
// Files and relationships.
$form['content'] = [
'#type' => 'details',
'#title' => $this->t('Files and Relationships'),
'#open' => TRUE,
];
$form['content']['include_files'] = [
'#type' => 'checkbox',
'#title' => $this->t('Copy files into OCFL objects'),
'#description' => $this->t('Copy the binaries of associated media and of file/image fields into each object. Unchanged files are not copied again in later versions. When unchecked, only metadata is exported.'),
'#default_value' => $config->get('include_files') ?? TRUE,
];
$form['content']['media_of_field'] = [
'#type' => 'textfield',
'#title' => $this->t('"Media of" field'),
'#description' => $this->t('Media field that references the node the media belongs to (Islandora: field_media_of). Media found through it are included in the OCFL object of that node. Leave empty to disable.'),
'#default_value' => $config->get('media_of_field'),
];
$form['content']['member_of_field'] = [
'#type' => 'textfield',
'#title' => $this->t('"Member of" field'),
'#description' => $this->t('Node field that references parent nodes (Islandora: field_member_of). Used to record direct parents and the full collection hierarchy. Leave empty to disable.'),
'#default_value' => $config->get('member_of_field'),
];
$form['content']['model_field'] = [
'#type' => 'textfield',
'#title' => $this->t('Model field'),
'#description' => $this->t('Node field that references the model term (Islandora: field_model). Leave empty to disable.'),
'#default_value' => $config->get('model_field'),
];
// Initialize button. // Initialize button.
$form['actions']['initialize'] = [ $form['actions']['initialize'] = [
'#type' => 'submit', '#type' => 'submit',
@ -231,10 +196,6 @@ class OcflSettingsForm extends ConfigFormBase {
->set('auto_export_media_enabled', (bool) $form_state->getValue('auto_export_media_enabled')) ->set('auto_export_media_enabled', (bool) $form_state->getValue('auto_export_media_enabled'))
->set('media_types', array_values($mediaTypes)) ->set('media_types', array_values($mediaTypes))
->set('ocfl_version', $form_state->getValue('ocfl_version')) ->set('ocfl_version', $form_state->getValue('ocfl_version'))
->set('include_files', (bool) $form_state->getValue('include_files'))
->set('media_of_field', trim((string) $form_state->getValue('media_of_field')))
->set('member_of_field', trim((string) $form_state->getValue('member_of_field')))
->set('model_field', trim((string) $form_state->getValue('model_field')))
->save(); ->save();
parent::submitForm($form, $form_state); parent::submitForm($form, $form_state);

3
src/MediaSerializerService.php

@ -38,7 +38,6 @@ class MediaSerializerService {
$data = [ $data = [
'uuid' => $media->uuid(), 'uuid' => $media->uuid(),
'mid' => (int) $media->id(),
'type' => $media->bundle(), 'type' => $media->bundle(),
'name' => $media->getName(), 'name' => $media->getName(),
'created' => $this->formatTimestamp((int) $media->getCreatedTime()), 'created' => $this->formatTimestamp((int) $media->getCreatedTime()),
@ -364,7 +363,6 @@ class MediaSerializerService {
protected function serializeMediaReference(MediaInterface $media): array { protected function serializeMediaReference(MediaInterface $media): array {
$data = [ $data = [
'uuid' => $media->uuid(), 'uuid' => $media->uuid(),
'mid' => (int) $media->id(),
'bundle' => $media->bundle(), 'bundle' => $media->bundle(),
'name' => $media->getName(), 'name' => $media->getName(),
'status' => $media->isPublished(), 'status' => $media->isPublished(),
@ -421,7 +419,6 @@ class MediaSerializerService {
protected function serializeNodeReference(NodeInterface $node): array { protected function serializeNodeReference(NodeInterface $node): array {
return [ return [
'uuid' => $node->uuid(), 'uuid' => $node->uuid(),
'nid' => (int) $node->id(),
'type' => $node->bundle(), 'type' => $node->bundle(),
'title' => $node->getTitle(), 'title' => $node->getTitle(),
'status' => $node->isPublished(), 'status' => $node->isPublished(),

160
src/NodeSerializerService.php

@ -5,7 +5,6 @@ declare(strict_types=1);
namespace Drupal\ocfl_export; namespace Drupal\ocfl_export;
use Drupal\Component\Datetime\TimeInterface; use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Field\FieldItemListInterface; use Drupal\Core\Field\FieldItemListInterface;
use Drupal\media\MediaInterface; use Drupal\media\MediaInterface;
@ -19,15 +18,9 @@ use Drupal\user\UserInterface;
*/ */
class NodeSerializerService { class NodeSerializerService {
/**
* Maximum number of ancestors followed when building hierarchy paths.
*/
protected const MAX_HIERARCHY_DEPTH = 50;
public function __construct( public function __construct(
protected EntityTypeManagerInterface $entityTypeManager, protected EntityTypeManagerInterface $entityTypeManager,
protected TimeInterface $time, protected TimeInterface $time,
protected ConfigFactoryInterface $configFactory,
) {} ) {}
/** /**
@ -44,7 +37,6 @@ class NodeSerializerService {
$data = [ $data = [
'uuid' => $node->uuid(), 'uuid' => $node->uuid(),
'nid' => (int) $node->id(),
'type' => $node->bundle(), 'type' => $node->bundle(),
'title' => $node->getTitle(), 'title' => $node->getTitle(),
'created' => $this->formatTimestamp((int) $node->getCreatedTime()), 'created' => $this->formatTimestamp((int) $node->getCreatedTime()),
@ -55,7 +47,6 @@ class NodeSerializerService {
'name' => $author->getAccountName(), 'name' => $author->getAccountName(),
'display_name' => $author->getDisplayName(), 'display_name' => $author->getDisplayName(),
], ],
'relationships' => $this->serializeRelationships($node),
'fields' => $this->serializeFields($node), 'fields' => $this->serializeFields($node),
'_metadata' => [ '_metadata' => [
'ocfl_version' => '1.1', 'ocfl_version' => '1.1',
@ -67,155 +58,6 @@ class NodeSerializerService {
return $data; return $data;
} }
/**
* Serialize Islandora-style membership (isMemberOf) and model information.
*
* @param \Drupal\node\NodeInterface $node
* The node.
*
* @return array
* An array with 'model', 'member_of' (direct parents) and 'hierarchy'
* (every ancestor path, each ordered from the root down to the direct
* parent). Keys are omitted when the corresponding field is not present.
*/
protected function serializeRelationships(NodeInterface $node): array {
$config = $this->configFactory->get('ocfl_export.settings');
$modelField = $config->get('model_field');
$memberOfField = $config->get('member_of_field');
$relationships = [];
if ($modelField && $node->hasField($modelField)) {
$relationships['model'] = $this->getModel($node);
}
if ($memberOfField && $node->hasField($memberOfField)) {
$relationships['member_of'] = array_map(
fn (NodeInterface $parent) => $this->summarizeHierarchyNode($parent),
$this->getMemberOfParents($node),
);
$relationships['hierarchy'] = $this->buildAncestorPaths($node);
}
return $relationships;
}
/**
* Get the parent nodes a node is a member of.
*
* @param \Drupal\node\NodeInterface $node
* The node.
*
* @return \Drupal\node\NodeInterface[]
* The parent nodes.
*/
protected function getMemberOfParents(NodeInterface $node): array {
$field = $this->configFactory->get('ocfl_export.settings')->get('member_of_field');
if (!$field || !$node->hasField($field)) {
return [];
}
return array_values(array_filter(
$node->get($field)->referencedEntities(),
fn ($entity) => $entity instanceof NodeInterface,
));
}
/**
* Build every ancestor path for a node via the member-of field.
*
* @param \Drupal\node\NodeInterface $node
* The node.
* @param int[] $visited
* Node IDs already on the current path, to guard against cycles.
*
* @return array
* A list of paths. Each path is a list of node summaries ordered from the
* root collection down to the node's direct parent.
*/
protected function buildAncestorPaths(NodeInterface $node, array $visited = []): array {
$visited[] = (int) $node->id();
if (count($visited) > static::MAX_HIERARCHY_DEPTH) {
return [];
}
$paths = [];
foreach ($this->getMemberOfParents($node) as $parent) {
if (in_array((int) $parent->id(), $visited, TRUE)) {
continue;
}
$summary = $this->summarizeHierarchyNode($parent);
$parentPaths = $this->buildAncestorPaths($parent, $visited);
if (!$parentPaths) {
$paths[] = [$summary];
continue;
}
foreach ($parentPaths as $path) {
$path[] = $summary;
$paths[] = $path;
}
}
return $paths;
}
/**
* Summarize a node for membership and hierarchy listings.
*
* @param \Drupal\node\NodeInterface $node
* The node.
*
* @return array
* The node summary.
*/
protected function summarizeHierarchyNode(NodeInterface $node): array {
$summary = [
'nid' => (int) $node->id(),
'uuid' => $node->uuid(),
'title' => $node->getTitle(),
'type' => $node->bundle(),
];
$model = $this->getModel($node);
if ($model) {
$summary['model'] = $model['name'];
}
return $summary;
}
/**
* Get the Islandora model term of a node.
*
* @param \Drupal\node\NodeInterface $node
* The node.
*
* @return array|null
* The model name, term UUID and external URI (if any), or NULL.
*/
protected function getModel(NodeInterface $node): ?array {
$field = $this->configFactory->get('ocfl_export.settings')->get('model_field');
if (!$field || !$node->hasField($field)) {
return NULL;
}
$term = $node->get($field)->entity;
if (!$term instanceof TermInterface) {
return NULL;
}
$model = [
'tid' => (int) $term->id(),
'uuid' => $term->uuid(),
'name' => $term->getName(),
];
if ($term->hasField('field_external_uri') && !$term->get('field_external_uri')->isEmpty()) {
$model['uri'] = $term->get('field_external_uri')->uri;
}
return $model;
}
/** /**
* Serialize all fields of a node. * Serialize all fields of a node.
* *
@ -459,7 +301,6 @@ class NodeSerializerService {
protected function serializeMedia(MediaInterface $media): array { protected function serializeMedia(MediaInterface $media): array {
$data = [ $data = [
'uuid' => $media->uuid(), 'uuid' => $media->uuid(),
'mid' => (int) $media->id(),
'name' => $media->getName(), 'name' => $media->getName(),
'bundle' => $media->bundle(), 'bundle' => $media->bundle(),
]; ];
@ -514,7 +355,6 @@ class NodeSerializerService {
protected function serializeNodeReference(NodeInterface $node): array { protected function serializeNodeReference(NodeInterface $node): array {
return [ return [
'uuid' => $node->uuid(), 'uuid' => $node->uuid(),
'nid' => (int) $node->id(),
'type' => $node->bundle(), 'type' => $node->bundle(),
'title' => $node->getTitle(), 'title' => $node->getTitle(),
'status' => $node->isPublished(), 'status' => $node->isPublished(),

390
src/OcflExporter.php

@ -1,390 +0,0 @@
<?php
declare(strict_types=1);
namespace Drupal\ocfl_export;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\DestructableInterface;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\file\FileInterface;
use Drupal\media\MediaInterface;
use Drupal\node\NodeInterface;
use Psr\Log\LoggerInterface;
/**
* Builds complete OCFL objects (metadata plus files) for nodes and media.
*
* A node object contains node.json plus the binaries of:
* - media that point at the node through the "media of" field (Islandora),
* stored under media/{media uuid}/;
* - media referenced from the node's own media reference fields, stored the
* same way;
* - files in the node's own file and image fields, stored under
* files/{field name}/.
*
* Automatic (hook driven) exports are queued and run once per node when the
* request ends, so saving a node together with several media creates a single
* new version rather than one per save.
*/
class OcflExporter implements DestructableInterface {
/**
* File field types whose files are copied into objects.
*/
protected const FILE_FIELD_TYPES = ['file', 'image'];
/**
* The logger channel.
*/
protected LoggerInterface $logger;
/**
* Node IDs queued for export at the end of the request.
*
* @var int[]
*/
protected array $queue = [];
public function __construct(
protected EntityTypeManagerInterface $entityTypeManager,
protected EntityFieldManagerInterface $entityFieldManager,
protected ConfigFactoryInterface $configFactory,
protected OcflStorageService $storage,
protected NodeSerializerService $nodeSerializer,
protected MediaSerializerService $mediaSerializer,
LoggerChannelFactoryInterface $loggerFactory,
) {
$this->logger = $loggerFactory->get('ocfl_export');
}
/**
* Export a node, its associated media and its files as one OCFL object.
*
* @param \Drupal\node\NodeInterface $node
* The node.
* @param string|null $message
* Optional OCFL version message.
*
* @return bool
* TRUE on success.
*/
public function exportNode(NodeInterface $node, ?string $message = NULL): bool {
$data = $this->nodeSerializer->serialize($node);
$files = [];
$data['files'] = $this->collectEntityFiles($node, 'files', TRUE, $files);
$data['media'] = [];
foreach ($this->getAssociatedMedia($node) as $item) {
/** @var \Drupal\media\MediaInterface $media */
$media = $item['media'];
$mediaData = $this->mediaSerializer->serialize($media);
unset($mediaData['_metadata']);
$mediaData['association'] = $item['association'];
$mediaData['files'] = $this->collectEntityFiles($media, 'media/' . $media->uuid(), FALSE, $files, ['thumbnail']);
$data['media'][] = $mediaData;
}
if (!$this->includeFiles()) {
$files = [];
}
return $this->save($node, $data, $files, $message);
}
/**
* Export a media entity and its files as its own OCFL object.
*
* @param \Drupal\media\MediaInterface $media
* The media entity.
* @param string|null $message
* Optional OCFL version message.
*
* @return bool
* TRUE on success.
*/
public function exportMedia(MediaInterface $media, ?string $message = NULL): bool {
$data = $this->mediaSerializer->serialize($media);
$files = [];
$data['files'] = $this->collectEntityFiles($media, 'files', TRUE, $files, ['thumbnail']);
if (!$this->includeFiles()) {
$files = [];
}
return $this->save($media, $data, $files, $message);
}
/**
* Save an entity's OCFL object and refresh its rendered export status.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The exported entity.
* @param array $data
* The metadata.
* @param array $files
* Map of logical path => file URI.
* @param string|null $message
* Optional OCFL version message.
*
* @return bool
* TRUE on success.
*/
protected function save(EntityInterface $entity, array $data, array $files, ?string $message): bool {
$saved = $this->storage->saveObject($entity->uuid(), $data, $files, $message);
if ($saved) {
// The export status block is part of the cached entity render.
Cache::invalidateTags($entity->getCacheTagsToInvalidate());
}
return $saved;
}
/**
* Queue a node for automatic export if the settings allow it.
*
* @param \Drupal\node\NodeInterface $node
* The node.
*/
public function queueNode(NodeInterface $node): void {
if ($this->shouldAutoExportNode($node)) {
$this->queue[(int) $node->id()] = (int) $node->id();
}
}
/**
* Queue the nodes a media entity belongs to (before and after the change).
*
* @param \Drupal\media\MediaInterface $media
* The media entity being inserted, updated or deleted.
*/
public function queueParentNodes(MediaInterface $media): void {
$field = $this->configFactory->get('ocfl_export.settings')->get('media_of_field');
if (!$field || !$media->hasField($field)) {
return;
}
$parents = $media->get($field)->referencedEntities();
$original = method_exists($media, 'getOriginal') ? $media->getOriginal() : ($media->original ?? NULL);
if ($original instanceof MediaInterface && $original->hasField($field)) {
$parents = array_merge($parents, $original->get($field)->referencedEntities());
}
foreach ($parents as $parent) {
if ($parent instanceof NodeInterface) {
$this->queueNode($parent);
}
}
}
/**
* Remove a node from the export queue (e.g. because it was deleted).
*
* @param \Drupal\node\NodeInterface $node
* The node.
*/
public function unqueueNode(NodeInterface $node): void {
unset($this->queue[(int) $node->id()]);
}
/**
* {@inheritdoc}
*/
public function destruct(): void {
if (!$this->queue) {
return;
}
$nids = $this->queue;
$this->queue = [];
$nodes = $this->entityTypeManager->getStorage('node')->loadMultiple($nids);
foreach ($nodes as $node) {
try {
if (!$this->exportNode($node)) {
$this->logger->error('Failed to export node @nid to OCFL.', ['@nid' => $node->id()]);
}
}
catch (\Exception $e) {
$this->logger->error('Failed to export node @nid to OCFL: @message', [
'@nid' => $node->id(),
'@message' => $e->getMessage(),
]);
}
}
}
/**
* Whether a node should be exported automatically.
*
* @param \Drupal\node\NodeInterface $node
* The node.
*
* @return bool
* TRUE if automatic export is enabled for the node's bundle.
*/
public function shouldAutoExportNode(NodeInterface $node): bool {
$config = $this->configFactory->get('ocfl_export.settings');
if (!$config->get('auto_export_enabled')) {
return FALSE;
}
$types = $config->get('content_types') ?: [];
return empty($types) || in_array($node->bundle(), $types, TRUE);
}
/**
* Whether a media entity should be exported automatically.
*
* @param \Drupal\media\MediaInterface $media
* The media entity.
*
* @return bool
* TRUE if automatic export is enabled for the media's bundle.
*/
public function shouldAutoExportMedia(MediaInterface $media): bool {
$config = $this->configFactory->get('ocfl_export.settings');
if (!$config->get('auto_export_media_enabled')) {
return FALSE;
}
$types = $config->get('media_types') ?: [];
return empty($types) || in_array($media->bundle(), $types, TRUE);
}
/**
* Find the media associated with a node.
*
* @param \Drupal\node\NodeInterface $node
* The node.
*
* @return array
* Keyed by media ID; each value has 'media' (the entity) and
* 'association' (a list such as ['media_of', 'field:field_image']).
*/
protected function getAssociatedMedia(NodeInterface $node): array {
$associated = [];
$mediaStorage = $this->entityTypeManager->getStorage('media');
// Islandora: media point at the node they belong to.
$mediaOfField = $this->configFactory->get('ocfl_export.settings')->get('media_of_field');
$mediaFieldStorage = $this->entityFieldManager->getFieldStorageDefinitions('media');
if ($mediaOfField && isset($mediaFieldStorage[$mediaOfField])) {
$mids = $mediaStorage->getQuery()
->accessCheck(FALSE)
->condition($mediaOfField, $node->id())
->sort('mid')
->execute();
foreach ($mediaStorage->loadMultiple($mids) as $mid => $media) {
$associated[$mid] = ['media' => $media, 'association' => ['media_of']];
}
}
// Plain Drupal: the node references media from its own fields.
foreach ($node->getFieldDefinitions() as $fieldName => $definition) {
if ($definition->getType() !== 'entity_reference' || $definition->getSetting('target_type') !== 'media') {
continue;
}
foreach ($node->get($fieldName)->referencedEntities() as $media) {
$mid = (int) $media->id();
$associated[$mid]['media'] = $media;
$associated[$mid]['association'][] = 'field:' . $fieldName;
}
}
ksort($associated);
return $associated;
}
/**
* Collect the files held in an entity's file and image fields.
*
* @param \Drupal\Core\Entity\FieldableEntityInterface $entity
* The entity.
* @param string $prefix
* Logical directory the files are placed under.
* @param bool $groupByField
* Whether to add a sub-directory per field.
* @param array $files
* Map of logical path => file URI, added to in place.
* @param string[] $skipFields
* Field names to ignore.
*
* @return array
* Descriptions of the files for inclusion in node.json.
*/
protected function collectEntityFiles(FieldableEntityInterface $entity, string $prefix, bool $groupByField, array &$files, array $skipFields = []): array {
$descriptions = [];
foreach ($entity->getFieldDefinitions() as $fieldName => $definition) {
if (!in_array($definition->getType(), static::FILE_FIELD_TYPES, TRUE) || in_array($fieldName, $skipFields, TRUE)) {
continue;
}
foreach ($entity->get($fieldName) as $delta => $item) {
$file = $item->entity;
if (!$file instanceof FileInterface) {
continue;
}
$dir = $groupByField ? $prefix . '/' . $fieldName : $prefix;
$logicalPath = $this->uniqueLogicalPath($dir, $file, $files);
$files[$logicalPath] = $file->getFileUri();
$descriptions[] = [
'logical_path' => $this->includeFiles() ? $logicalPath : NULL,
'field' => $fieldName,
'delta' => $delta,
'fid' => (int) $file->id(),
'uuid' => $file->uuid(),
'filename' => $file->getFilename(),
'filemime' => $file->getMimeType(),
'filesize' => (int) $file->getSize(),
'uri' => $file->getFileUri(),
];
}
}
return $descriptions;
}
/**
* Build a safe logical path that doesn't collide with one already used.
*
* @param string $dir
* The logical directory.
* @param \Drupal\file\FileInterface $file
* The file.
* @param array $files
* Logical paths already in use, as keys.
*
* @return string
* The logical path.
*/
protected function uniqueLogicalPath(string $dir, FileInterface $file, array $files): string {
$name = preg_replace('/[\x00-\x1F\x7F\/\\\\]/u', '_', trim((string) $file->getFilename()));
if ($name === '' || $name === '.' || $name === '..') {
$name = 'file-' . $file->id();
}
$path = $dir . '/' . $name;
if (!isset($files[$path])) {
return $path;
}
$info = pathinfo($name);
$extension = isset($info['extension']) ? '.' . $info['extension'] : '';
return $dir . '/' . $info['filename'] . '-' . $file->id() . $extension;
}
/**
* Whether binary files should be copied into objects.
*/
protected function includeFiles(): bool {
return (bool) ($this->configFactory->get('ocfl_export.settings')->get('include_files') ?? TRUE);
}
}

545
src/OcflStorageService.php

@ -6,10 +6,7 @@ namespace Drupal\ocfl_export;
use Drupal\Core\Config\ConfigFactoryInterface; use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\File\FileSystemInterface; use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\KeyValueStore\KeyValueFactoryInterface;
use Drupal\Core\KeyValueStore\KeyValueStoreInterface;
use Drupal\Core\Logger\LoggerChannelFactoryInterface; use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\Session\AccountProxyInterface;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
/** /**
@ -17,45 +14,14 @@ use Psr\Log\LoggerInterface;
*/ */
class OcflStorageService { class OcflStorageService {
/**
* Logical path of the metadata JSON file within every object.
*/
public const METADATA_FILE = 'node.json';
/**
* The OCFL storage layout extension used for the storage root.
*/
public const LAYOUT_EXTENSION = '0003-hash-and-id-n-tuple-storage-layout';
/**
* Configuration of the storage layout extension.
*/
protected const LAYOUT_CONFIG = [
'extensionName' => self::LAYOUT_EXTENSION,
'digestAlgorithm' => 'sha256',
'tupleSize' => 3,
'numberOfTuples' => 3,
];
/**
* The logger channel.
*/
protected LoggerInterface $logger; protected LoggerInterface $logger;
/**
* Cache of file digests keyed by URI, to avoid rehashing unchanged files.
*/
protected KeyValueStoreInterface $digestCache;
public function __construct( public function __construct(
protected ConfigFactoryInterface $configFactory, protected ConfigFactoryInterface $configFactory,
protected FileSystemInterface $fileSystem, protected FileSystemInterface $fileSystem,
LoggerChannelFactoryInterface $loggerFactory, LoggerChannelFactoryInterface $loggerFactory,
KeyValueFactoryInterface $keyValueFactory,
protected AccountProxyInterface $currentUser,
) { ) {
$this->logger = $loggerFactory->get('ocfl_export'); $this->logger = $loggerFactory->get('ocfl_export');
$this->digestCache = $keyValueFactory->get('ocfl_export.digest_cache');
} }
/** /**
@ -91,7 +57,7 @@ class OcflStorageService {
// Create OCFL root declaration file. // Create OCFL root declaration file.
$declarationFile = $root . '/0=ocfl_1.1'; $declarationFile = $root . '/0=ocfl_1.1';
if (!file_exists($declarationFile)) { if (!file_exists($declarationFile)) {
$content = "ocfl_1.1\n"; $content = "ocfl_1.1\nhttps://ocfl.io/1.1/spec/#root-conformance-declaration\n";
if (file_put_contents($declarationFile, $content) === FALSE) { if (file_put_contents($declarationFile, $content) === FALSE) {
$this->logger->error('Failed to create OCFL root declaration file.'); $this->logger->error('Failed to create OCFL root declaration file.');
return FALSE; return FALSE;
@ -102,357 +68,110 @@ class OcflStorageService {
$layoutFile = $root . '/ocfl_layout.json'; $layoutFile = $root . '/ocfl_layout.json';
if (!file_exists($layoutFile)) { if (!file_exists($layoutFile)) {
$layout = [ $layout = [
'extension' => self::LAYOUT_EXTENSION, 'extension' => '0002-flat-direct-storage-layout',
'description' => 'Hashed n-tuple layout (sha256, 3 tuples of 3 characters) ending in the percent-encoded object ID; object IDs are urn:uuid URIs.', 'description' => 'OCFL storage using flat direct layout with UUIDs.',
]; ];
if (file_put_contents($layoutFile, json_encode($layout, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)) === FALSE) { if (file_put_contents($layoutFile, json_encode($layout, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)) === FALSE) {
$this->logger->error('Failed to create OCFL layout file.'); $this->logger->error('Failed to create OCFL layout file.');
return FALSE; return FALSE;
} }
} }
else {
// Never write objects into a root that declares a different layout.
$layout = json_decode((string) file_get_contents($layoutFile), TRUE);
if (($layout['extension'] ?? NULL) !== self::LAYOUT_EXTENSION) {
$this->logger->error('OCFL storage root @path uses layout @layout, but this module requires @required.', [
'@path' => $root,
'@layout' => $layout['extension'] ?? 'unknown',
'@required' => self::LAYOUT_EXTENSION,
]);
return FALSE;
}
}
// Create the layout extension's configuration file.
$extensionDir = $root . '/extensions/' . self::LAYOUT_EXTENSION;
if (!file_exists($extensionDir . '/config.json')) {
if (!is_dir($extensionDir) && !$this->fileSystem->mkdir($extensionDir, 0755, TRUE)) {
$this->logger->error('Failed to create OCFL extension directory: @path', ['@path' => $extensionDir]);
return FALSE;
}
if (file_put_contents($extensionDir . '/config.json', json_encode(self::LAYOUT_CONFIG, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)) === FALSE) {
$this->logger->error('Failed to create OCFL layout extension config.');
return FALSE;
}
}
return TRUE; return TRUE;
} }
/**
* Build the OCFL object ID for an entity UUID.
*
* @param string $uuid
* The entity UUID.
*
* @return string
* The object ID, a urn:uuid URI.
*/
public function getObjectId(string $uuid): string {
return 'urn:uuid:' . $uuid;
}
/**
* Get the directory of an object.
*
* @param string $uuid
* The entity UUID.
*
* @return string
* The absolute path to the object directory.
*/
public function getObjectPath(string $uuid): string {
return $this->getStorageRoot() . '/' . $this->getObjectRelativePath($this->getObjectId($uuid));
}
/**
* Map an object ID to its path using the hash-and-id n-tuple layout.
*
* The path is the first tuples of the ID's digest followed by the
* percent-encoded ID, e.g.
* "3f2/a9c/e01/urn%3auuid%3a11111111-2222-3333-4444-555555555555".
*
* @param string $objectId
* The object ID.
*
* @return string
* The object path relative to the storage root.
*
* @see https://ocfl.github.io/extensions/0003-hash-and-id-n-tuple-storage-layout.html
*/
public function getObjectRelativePath(string $objectId): string {
$config = self::LAYOUT_CONFIG;
$digest = hash($config['digestAlgorithm'], $objectId);
// Percent-encode every byte except [A-Za-z0-9_-], using lowercase hex.
$encoded = preg_replace_callback(
'/[^A-Za-z0-9_-]/',
fn (array $match) => '%' . bin2hex($match[0]),
$objectId,
);
if (strlen($encoded) > 100) {
$encoded = substr($encoded, 0, 100) . '-' . $digest;
}
$tuples = str_split(substr($digest, 0, $config['tupleSize'] * $config['numberOfTuples']), $config['tupleSize']);
return implode('/', $tuples) . '/' . $encoded;
}
/** /**
* Save or update an OCFL object. * Save or update an OCFL object.
* *
* Each call creates a new version. Content files whose digest already * @param string $objectId
* appears in the object's manifest are not copied again; the new version's * The object ID (UUID).
* state simply references the existing content path (forward-delta
* deduplication as described in the OCFL spec).
*
* @param string $uuid
* The entity UUID; the object ID is derived from it.
* @param array $data * @param array $data
* The metadata to save as node.json. * The data to save.
* @param array $files
* Binary files to include, keyed by logical path with the source file URI
* (any readable stream wrapper URI or local path) as the value.
* @param string|null $message
* Optional version message.
* *
* @return bool * @return bool
* TRUE if save was successful. * TRUE if save was successful.
*/ */
public function saveObject(string $uuid, array $data, array $files = [], ?string $message = NULL): bool { public function saveObject(string $objectId, array $data): bool {
if (!$this->initializeStorageRoot()) { if (!$this->initializeStorageRoot()) {
return FALSE; return FALSE;
} }
$objectId = $this->getObjectId($uuid); $root = $this->getStorageRoot();
$objectPath = $this->getObjectPath($uuid); $objectPath = $root . '/' . $objectId;
$existing = $this->loadInventory($objectPath); // Check if object exists and get current version.
$currentVersion = $existing ? (int) substr($existing['head'], 1) : 0; $currentVersion = $this->getCurrentVersion($objectPath);
$newVersion = $currentVersion + 1; $newVersion = $currentVersion + 1;
$versionDir = 'v' . $newVersion; $versionDir = 'v' . $newVersion;
$versionPath = $objectPath . '/' . $versionDir;
// A version directory that is not yet recorded in the inventory is left // Create object directory structure.
// over from an interrupted export; its files would not be in the manifest. $contentPath = $objectPath . '/' . $versionDir . '/content';
if (is_dir($versionPath)) { if (!is_dir($contentPath)) {
$this->fileSystem->deleteRecursive($versionPath); if (!$this->fileSystem->mkdir($contentPath, 0755, TRUE)) {
} $this->logger->error('Failed to create OCFL object content directory: @path', ['@path' => $contentPath]);
if (!$this->fileSystem->mkdir($versionPath . '/content', 0755, TRUE)) { return FALSE;
$this->logger->error('Failed to create OCFL object content directory: @path', ['@path' => $versionPath . '/content']); }
return FALSE;
} }
// Create object declaration file for new objects. // Create object declaration file for new objects.
if ($currentVersion === 0) { if ($currentVersion === 0) {
$declarationFile = $objectPath . '/0=ocfl_object_1.1'; $declarationFile = $objectPath . '/0=ocfl_object_1.1';
$content = "ocfl_object_1.1\n"; $content = "ocfl_object_1.1\nhttps://ocfl.io/1.1/spec/#object-conformance-declaration\n";
if (file_put_contents($declarationFile, $content) === FALSE) { if (file_put_contents($declarationFile, $content) === FALSE) {
$this->logger->error('Failed to create OCFL object declaration file.'); $this->logger->error('Failed to create OCFL object declaration file.');
return FALSE; return FALSE;
} }
} }
$manifest = $existing['manifest'] ?? []; // Write node.json to content directory.
$state = []; $nodeJsonPath = $contentPath . '/node.json';
// Add binary files first so missing ones can be recorded in node.json.
$missing = [];
foreach ($files as $logicalPath => $sourceUri) {
$digest = $this->addContentFile($objectPath, $versionDir, (string) $logicalPath, $sourceUri, $manifest);
if ($digest === NULL) {
$missing[] = (string) $logicalPath;
continue;
}
$state[$digest][] = (string) $logicalPath;
}
if ($missing) {
$data['_metadata']['missing_files'] = $missing;
}
$jsonContent = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE); $jsonContent = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
if ($jsonContent === FALSE) { if (file_put_contents($nodeJsonPath, $jsonContent) === FALSE) {
$this->logger->error('Failed to encode metadata for OCFL object @id.', ['@id' => $objectId]); $this->logger->error('Failed to write node.json to OCFL object.');
return FALSE; return FALSE;
} }
$digest = hash('sha512', $jsonContent);
if (!isset($manifest[$digest])) {
$contentPath = $versionDir . '/content/' . self::METADATA_FILE;
if (file_put_contents($objectPath . '/' . $contentPath, $jsonContent) === FALSE) {
$this->logger->error('Failed to write @file to OCFL object.', ['@file' => self::METADATA_FILE]);
return FALSE;
}
$manifest[$digest] = [$contentPath];
}
$state[$digest][] = self::METADATA_FILE;
$versions = $existing['versions'] ?? []; // Generate and write inventory.
$versions[$versionDir] = [ $inventory = $this->generateInventory($objectId, $objectPath, $newVersion, $nodeJsonPath);
'created' => date('c'),
'message' => $message ?? ($newVersion === 1 ? 'Initial version' : 'Updated version'),
'state' => $state,
'user' => [
'name' => $this->currentUser->isAnonymous() ? 'Drupal system' : $this->currentUser->getDisplayName(),
],
];
// Don't leave an empty content directory when everything was deduplicated.
@rmdir($versionPath . '/content');
$inventory = [
'id' => $objectId,
'type' => 'https://ocfl.io/1.1/spec/#inventory',
'digestAlgorithm' => 'sha512',
'head' => $versionDir,
'contentDirectory' => 'content',
'manifest' => $manifest,
'versions' => $versions,
];
// Write inventory to version directory.
$versionInventoryPath = $objectPath . '/' . $versionDir . '/inventory.json';
$inventoryJson = json_encode($inventory, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE); $inventoryJson = json_encode($inventory, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
$sidecar = hash('sha512', $inventoryJson) . " inventory.json\n"; if (file_put_contents($versionInventoryPath, $inventoryJson) === FALSE) {
$this->logger->error('Failed to write version inventory.json.');
return FALSE;
}
// Write the version inventory, then replace the root inventory last so // Write inventory checksum to version directory.
// the object only advances to the new head once the version is complete. $versionChecksumPath = $objectPath . '/' . $versionDir . '/inventory.json.sha512';
if (file_put_contents($versionPath . '/inventory.json', $inventoryJson) === FALSE $checksum = hash('sha512', $inventoryJson);
|| file_put_contents($versionPath . '/inventory.json.sha512', $sidecar) === FALSE) { if (file_put_contents($versionChecksumPath, $checksum . ' inventory.json') === FALSE) {
$this->logger->error('Failed to write version inventory for OCFL object @id.', ['@id' => $objectId]); $this->logger->error('Failed to write version inventory checksum.');
return FALSE; return FALSE;
} }
$tmpInventory = $objectPath . '/inventory.json.tmp';
if (file_put_contents($tmpInventory, $inventoryJson) === FALSE // Write inventory to object root.
|| !rename($tmpInventory, $objectPath . '/inventory.json') $rootInventoryPath = $objectPath . '/inventory.json';
|| file_put_contents($objectPath . '/inventory.json.sha512', $sidecar) === FALSE) { if (file_put_contents($rootInventoryPath, $inventoryJson) === FALSE) {
$this->logger->error('Failed to write root inventory for OCFL object @id.', ['@id' => $objectId]); $this->logger->error('Failed to write root inventory.json.');
return FALSE;
}
// Write inventory checksum to object root.
$rootChecksumPath = $objectPath . '/inventory.json.sha512';
if (file_put_contents($rootChecksumPath, $checksum . ' inventory.json') === FALSE) {
$this->logger->error('Failed to write root inventory checksum.');
return FALSE; return FALSE;
} }
$this->logger->info('OCFL object @id saved as version @version (@count files).', [ $this->logger->info('OCFL object @id saved as version @version.', [
'@id' => $objectId, '@id' => $objectId,
'@version' => $versionDir, '@version' => $versionDir,
'@count' => count($files) - count($missing) + 1,
]); ]);
return TRUE; return TRUE;
} }
/**
* Add a binary file to a version, deduplicating against the manifest.
*
* @param string $objectPath
* The object root path.
* @param string $versionDir
* The version directory name (e.g. "v3").
* @param string $logicalPath
* The logical path of the file within the object.
* @param string $sourceUri
* The URI of the source file.
* @param array $manifest
* The manifest, updated in place when the file is copied.
*
* @return string|null
* The file's digest, or NULL if it could not be read or copied.
*/
protected function addContentFile(string $objectPath, string $versionDir, string $logicalPath, string $sourceUri, array &$manifest): ?string {
$digest = $this->getDigest($sourceUri);
if ($digest === NULL) {
$this->logger->warning('Could not read @uri for OCFL object path @path; skipping.', [
'@uri' => $sourceUri,
'@path' => $logicalPath,
]);
return NULL;
}
if (isset($manifest[$digest])) {
return $digest;
}
$contentPath = $versionDir . '/content/' . $logicalPath;
$destination = $objectPath . '/' . $contentPath;
$dir = dirname($destination);
if (!is_dir($dir) && !$this->fileSystem->mkdir($dir, 0755, TRUE)) {
$this->logger->error('Failed to create directory @dir.', ['@dir' => $dir]);
return NULL;
}
if (!@copy($sourceUri, $destination) || hash_file('sha512', $destination) !== $digest) {
$this->logger->error('Failed to copy @uri into OCFL object at @path, or the copy failed fixity verification.', [
'@uri' => $sourceUri,
'@path' => $contentPath,
]);
@unlink($destination);
return NULL;
}
$manifest[$digest] = [$contentPath];
return $digest;
}
/**
* Compute the sha512 digest of a file, using a size/mtime keyed cache.
*
* @param string $uri
* The file URI.
*
* @return string|null
* The hex digest, or NULL if the file can't be read.
*/
protected function getDigest(string $uri): ?string {
clearstatcache(TRUE, $uri);
$stat = @stat($uri);
$cacheable = $stat !== FALSE && !empty($stat['mtime']);
$key = hash('sha256', $uri);
if ($cacheable) {
$cached = $this->digestCache->get($key);
if (is_array($cached)
&& $cached['uri'] === $uri
&& $cached['size'] === (int) $stat['size']
&& $cached['mtime'] === (int) $stat['mtime']) {
return $cached['digest'];
}
}
$digest = @hash_file('sha512', $uri);
if ($digest === FALSE) {
return NULL;
}
if ($cacheable) {
$this->digestCache->set($key, [
'uri' => $uri,
'size' => (int) $stat['size'],
'mtime' => (int) $stat['mtime'],
'digest' => $digest,
]);
}
return $digest;
}
/**
* Load and minimally validate an object's root inventory.
*
* @param string $objectPath
* The path to the object directory.
*
* @return array|null
* The inventory, or NULL if the object doesn't exist yet.
*/
protected function loadInventory(string $objectPath): ?array {
$inventoryPath = $objectPath . '/inventory.json';
if (!file_exists($inventoryPath)) {
return NULL;
}
$inventory = json_decode(file_get_contents($inventoryPath), TRUE);
if (!is_array($inventory) || !isset($inventory['head'])) {
return NULL;
}
return $inventory;
}
/** /**
* Mark an OCFL object as deleted (for nodes). * Mark an OCFL object as deleted (for nodes).
* *
@ -463,7 +182,8 @@ class OcflStorageService {
* TRUE if marking was successful. * TRUE if marking was successful.
*/ */
public function markDeleted(\Drupal\node\NodeInterface $node): bool { public function markDeleted(\Drupal\node\NodeInterface $node): bool {
$objectPath = $this->getObjectPath($node->uuid()); $root = $this->getStorageRoot();
$objectPath = $root . '/' . $node->uuid();
if (!is_dir($objectPath)) { if (!is_dir($objectPath)) {
return TRUE; return TRUE;
@ -472,7 +192,6 @@ class OcflStorageService {
// Create a new version with deletion marker. // Create a new version with deletion marker.
$data = [ $data = [
'uuid' => $node->uuid(), 'uuid' => $node->uuid(),
'nid' => (int) $node->id(),
'type' => $node->bundle(), 'type' => $node->bundle(),
'title' => $node->getTitle(), 'title' => $node->getTitle(),
'deleted' => TRUE, 'deleted' => TRUE,
@ -486,7 +205,7 @@ class OcflStorageService {
], ],
]; ];
return $this->saveObject($node->uuid(), $data, [], 'Node deleted'); return $this->saveObject($node->uuid(), $data);
} }
/** /**
@ -499,7 +218,8 @@ class OcflStorageService {
* TRUE if marking was successful. * TRUE if marking was successful.
*/ */
public function markMediaDeleted(\Drupal\media\MediaInterface $media): bool { public function markMediaDeleted(\Drupal\media\MediaInterface $media): bool {
$objectPath = $this->getObjectPath($media->uuid()); $root = $this->getStorageRoot();
$objectPath = $root . '/' . $media->uuid();
if (!is_dir($objectPath)) { if (!is_dir($objectPath)) {
return TRUE; return TRUE;
@ -508,7 +228,6 @@ class OcflStorageService {
// Create a new version with deletion marker. // Create a new version with deletion marker.
$data = [ $data = [
'uuid' => $media->uuid(), 'uuid' => $media->uuid(),
'mid' => (int) $media->id(),
'type' => $media->bundle(), 'type' => $media->bundle(),
'name' => $media->getName(), 'name' => $media->getName(),
'deleted' => TRUE, 'deleted' => TRUE,
@ -522,7 +241,98 @@ class OcflStorageService {
], ],
]; ];
return $this->saveObject($media->uuid(), $data, [], 'Media deleted'); return $this->saveObject($media->uuid(), $data);
}
/**
* Get the current version number for an object.
*
* @param string $objectPath
* The path to the object directory.
*
* @return int
* The current version number (0 if object doesn't exist).
*/
protected function getCurrentVersion(string $objectPath): int {
if (!is_dir($objectPath)) {
return 0;
}
$inventoryPath = $objectPath . '/inventory.json';
if (!file_exists($inventoryPath)) {
return 0;
}
$inventory = json_decode(file_get_contents($inventoryPath), TRUE);
if (!$inventory || !isset($inventory['head'])) {
return 0;
}
// Parse version number from head (e.g., "v3" -> 3).
return (int) substr($inventory['head'], 1);
}
/**
* Generate OCFL inventory for an object.
*
* @param string $objectId
* The object ID.
* @param string $objectPath
* The object path.
* @param int $version
* The new version number.
* @param string $nodeJsonPath
* The path to the new node.json file.
*
* @return array
* The inventory data.
*/
protected function generateInventory(string $objectId, string $objectPath, int $version, string $nodeJsonPath): array {
$versionDir = 'v' . $version;
// Calculate checksum for the new content file.
$contentChecksum = hash_file('sha512', $nodeJsonPath);
// Load existing inventory if this is an update.
$existingManifest = [];
$existingVersions = [];
if ($version > 1) {
$existingInventoryPath = $objectPath . '/inventory.json';
if (file_exists($existingInventoryPath)) {
$existing = json_decode(file_get_contents($existingInventoryPath), TRUE);
$existingManifest = $existing['manifest'] ?? [];
$existingVersions = $existing['versions'] ?? [];
}
}
// Build manifest - maps checksums to file paths.
$manifest = $existingManifest;
$contentPath = $versionDir . '/content/node.json';
$manifest[$contentChecksum] = [$contentPath];
// Build version state - maps checksums to logical paths.
$versionState = [
$contentChecksum => ['node.json'],
];
// Build versions array.
$versions = $existingVersions;
$versions[$versionDir] = [
'created' => date('c'),
'message' => $version === 1 ? 'Initial version' : 'Updated version',
'state' => $versionState,
];
$inventory = [
'id' => $objectId,
'type' => 'https://ocfl.io/1.1/spec/#inventory',
'digestAlgorithm' => 'sha512',
'head' => $versionDir,
'manifest' => $manifest,
'versions' => $versions,
];
return $inventory;
} }
/** /**
@ -533,9 +343,7 @@ class OcflStorageService {
*/ */
public function isInitialized(): bool { public function isInitialized(): bool {
$root = $this->getStorageRoot(); $root = $this->getStorageRoot();
return file_exists($root . '/0=ocfl_1.1') return file_exists($root . '/0=ocfl_1.1') && file_exists($root . '/ocfl_layout.json');
&& file_exists($root . '/ocfl_layout.json')
&& file_exists($root . '/extensions/' . self::LAYOUT_EXTENSION . '/config.json');
} }
/** /**
@ -548,35 +356,15 @@ class OcflStorageService {
* Object info or NULL if not found. * Object info or NULL if not found.
*/ */
public function getObjectInfo(string $uuid): ?array { public function getObjectInfo(string $uuid): ?array {
return $this->loadInventory($this->getObjectPath($uuid)); $root = $this->getStorageRoot();
} $objectPath = $root . '/' . $uuid;
$inventoryPath = $objectPath . '/inventory.json';
/** if (!file_exists($inventoryPath)) {
* Resolve a logical path in the head version to its file on disk. return NULL;
*
* Because unchanged content is deduplicated, the file may live in an
* earlier version's content directory.
*
* @param string $uuid
* The object UUID.
* @param string $logicalPath
* The logical path within the object.
*
* @return string|null
* The absolute path, or NULL if not found.
*/
public function resolveHeadPath(string $uuid, string $logicalPath): ?string {
$inventory = $this->getObjectInfo($uuid);
$state = $inventory['versions'][$inventory['head'] ?? '']['state'] ?? [];
foreach ($state as $digest => $paths) {
if (in_array($logicalPath, $paths, TRUE) && isset($inventory['manifest'][$digest][0])) {
$filePath = $this->getObjectPath($uuid) . '/' . $inventory['manifest'][$digest][0];
return file_exists($filePath) ? $filePath : NULL;
}
} }
return NULL; return json_decode(file_get_contents($inventoryPath), TRUE);
} }
/** /**
@ -589,7 +377,19 @@ class OcflStorageService {
* The absolute path to the latest node.json file, or NULL if not found. * The absolute path to the latest node.json file, or NULL if not found.
*/ */
public function getLatestExportPath(string $uuid): ?string { public function getLatestExportPath(string $uuid): ?string {
return $this->resolveHeadPath($uuid, self::METADATA_FILE); $objectInfo = $this->getObjectInfo($uuid);
if (!$objectInfo || !isset($objectInfo['head'])) {
return NULL;
}
$root = $this->getStorageRoot();
$filePath = $root . '/' . $uuid . '/' . $objectInfo['head'] . '/content/node.json';
if (!file_exists($filePath)) {
return NULL;
}
return $filePath;
} }
/** /**
@ -603,17 +403,24 @@ class OcflStorageService {
*/ */
public function getExportStatus(string $uuid): ?array { public function getExportStatus(string $uuid): ?array {
$objectInfo = $this->getObjectInfo($uuid); $objectInfo = $this->getObjectInfo($uuid);
$filePath = $this->getLatestExportPath($uuid); if (!$objectInfo || !isset($objectInfo['head'])) {
if (!$objectInfo || !$filePath) {
return NULL; return NULL;
} }
$head = $objectInfo['head']; $head = $objectInfo['head'];
$root = $this->getStorageRoot();
$filePath = $root . '/' . $uuid . '/' . $head . '/content/node.json';
if (!file_exists($filePath)) {
return NULL;
}
$created = $objectInfo['versions'][$head]['created'] ?? NULL;
return [ return [
'version' => $head, 'version' => $head,
'path' => $filePath, 'path' => $filePath,
'created' => $objectInfo['versions'][$head]['created'] ?? NULL, 'created' => $created,
]; ];
} }

12
src/Plugin/Action/ExportMediaToOcfl.php

@ -8,7 +8,8 @@ use Drupal\Core\Action\ActionBase;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface; use Drupal\Core\Session\AccountInterface;
use Drupal\media\MediaInterface; use Drupal\media\MediaInterface;
use Drupal\ocfl_export\OcflExporter; use Drupal\ocfl_export\MediaSerializerService;
use Drupal\ocfl_export\OcflStorageService;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
@ -28,7 +29,8 @@ class ExportMediaToOcfl extends ActionBase implements ContainerFactoryPluginInte
array $configuration, array $configuration,
$plugin_id, $plugin_id,
$plugin_definition, $plugin_definition,
protected OcflExporter $exporter, protected OcflStorageService $storageService,
protected MediaSerializerService $serializerService,
protected LoggerInterface $logger, protected LoggerInterface $logger,
) { ) {
parent::__construct($configuration, $plugin_id, $plugin_definition); parent::__construct($configuration, $plugin_id, $plugin_definition);
@ -42,7 +44,8 @@ class ExportMediaToOcfl extends ActionBase implements ContainerFactoryPluginInte
$configuration, $configuration,
$plugin_id, $plugin_id,
$plugin_definition, $plugin_definition,
$container->get('ocfl_export.exporter'), $container->get('ocfl_export.storage'),
$container->get('ocfl_export.media_serializer'),
$container->get('logger.factory')->get('ocfl_export'), $container->get('logger.factory')->get('ocfl_export'),
); );
} }
@ -56,7 +59,8 @@ class ExportMediaToOcfl extends ActionBase implements ContainerFactoryPluginInte
} }
try { try {
$success = $this->exporter->exportMedia($media, 'Bulk action export'); $data = $this->serializerService->serialize($media);
$success = $this->storageService->saveObject($media->uuid(), $data);
if ($success) { if ($success) {
$this->logger->info('Batch exported media @mid (@name) to OCFL.', [ $this->logger->info('Batch exported media @mid (@name) to OCFL.', [

12
src/Plugin/Action/ExportNodeToOcfl.php

@ -8,7 +8,8 @@ use Drupal\Core\Action\ActionBase;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface; use Drupal\Core\Session\AccountInterface;
use Drupal\node\NodeInterface; use Drupal\node\NodeInterface;
use Drupal\ocfl_export\OcflExporter; use Drupal\ocfl_export\NodeSerializerService;
use Drupal\ocfl_export\OcflStorageService;
use Psr\Log\LoggerInterface; use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
@ -28,7 +29,8 @@ class ExportNodeToOcfl extends ActionBase implements ContainerFactoryPluginInter
array $configuration, array $configuration,
$plugin_id, $plugin_id,
$plugin_definition, $plugin_definition,
protected OcflExporter $exporter, protected OcflStorageService $storageService,
protected NodeSerializerService $serializerService,
protected LoggerInterface $logger, protected LoggerInterface $logger,
) { ) {
parent::__construct($configuration, $plugin_id, $plugin_definition); parent::__construct($configuration, $plugin_id, $plugin_definition);
@ -42,7 +44,8 @@ class ExportNodeToOcfl extends ActionBase implements ContainerFactoryPluginInter
$configuration, $configuration,
$plugin_id, $plugin_id,
$plugin_definition, $plugin_definition,
$container->get('ocfl_export.exporter'), $container->get('ocfl_export.storage'),
$container->get('ocfl_export.node_serializer'),
$container->get('logger.factory')->get('ocfl_export'), $container->get('logger.factory')->get('ocfl_export'),
); );
} }
@ -56,7 +59,8 @@ class ExportNodeToOcfl extends ActionBase implements ContainerFactoryPluginInter
} }
try { try {
$success = $this->exporter->exportNode($node, 'Bulk action export'); $data = $this->serializerService->serialize($node);
$success = $this->storageService->saveObject($node->uuid(), $data);
if ($success) { if ($success) {
$this->logger->info('Batch exported node @nid (@title) to OCFL.', [ $this->logger->info('Batch exported node @nid (@title) to OCFL.', [

Loading…
Cancel
Save