-
Notifications
You must be signed in to change notification settings - Fork 2
/
islandora_aspace.module
404 lines (366 loc) · 13.2 KB
/
islandora_aspace.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<?php
/**
* @file
* Defines all the hooks this module implements.
*/
// Content Model.
define('ISLANDORA_ASPACE_OBJECT_CMODEL', 'islandora:aspaceCModel');
// DS Name.
define('ISLANDORA_ASPACE_DSID', 'ARCHIVESSPACE');
/**
* Implements hook_init().
*/
function islandora_aspace_init() {
require_once __DIR__ . "/vendor/autoload.php";
}
/**
* Implements hook_menu().
*/
function islandora_aspace_menu() {
$items = array();
$items['admin/islandora/tools/aspace'] = array(
'title' => 'ArchivesSpace Integration',
'description' => 'Configure settings for Islandora ArchivesSpace integration.',
'page callback' => 'drupal_get_form',
'page arguments' => array('islandora_aspace_admin_form'),
'file' => 'includes/admin_form.inc',
'access arguments' => array('administer site configuration'),
'type' => MENU_NORMAL_ITEM,
);
$items['admin/islandora/tools/aspace/config'] = array(
'title' => 'Settings',
'description' => 'Configure settings for Islandora ArchivesSpace integration.',
'page callback' => 'drupal_get_form',
'page arguments' => array('islandora_aspace_admin_form'),
'file' => 'includes/admin_form.inc',
'access arguments' => array('administer site configuration'),
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/islandora/tools/aspace/templates'] = array(
'title' => 'Templates',
'description' => 'Configure metadata templates for integration.',
'page callback' => 'islandora_aspace_templates',
'file' => 'includes/templates_form.inc',
'access arguments' => array('administer site configuration'),
'type' => MENU_LOCAL_TASK,
);
$items['admin/islandora/tools/aspace/templates/create'] = array(
'title' => 'Create Template',
'description' => 'Create a new template.',
'page callback' => 'drupal_get_form',
'page arguments' => array('islandora_aspace_template_create_form'),
'file' => 'includes/templates_form.inc',
'access arguments' => array('administer site configuration'),
'type' => MENU_LOCAL_ACTION,
);
$items['admin/islandora/tools/aspace/templates/delete/%'] = array(
'page callback' => 'drupal_get_form',
'page arguments' => array('islandora_aspace_template_delete_form', 6),
'file' => 'includes/templates_form.inc',
'access arguments' => array('administer site configuration'),
'type' => MENU_CALLBACK,
);
$items['admin/islandora/tools/aspace/templates/copy/%'] = array(
'page callback' => 'drupal_get_form',
'page arguments' => array('islandora_aspace_template_copy_form', 6),
'file' => 'includes/templates_form.inc',
'access arguments' => array('administer site configuration'),
'type' => MENU_CALLBACK,
);
$items['admin/islandora/tools/aspace/templates/edit/%'] = array(
'page callback' => 'drupal_get_form',
'page arguments' => array('islandora_aspace_template_create_form', 6),
'file' => 'includes/templates_form.inc',
'access arguments' => array('administer site configuration'),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_islandora_ingest_steps().
*/
function islandora_aspace_islandora_ingest_steps(array $form_state) {
$shared_storage = islandora_ingest_form_get_shared_storage($form_state);
$intersection = array_intersect($shared_storage['models'], variable_get('islandora_aspace_enabled_models', array()));
if (count($intersection) > 0) {
return array(
'islandora_aspace_step_enable_form' => array(
'type' => 'form',
'weight' => -5,
'form_id' => 'islandora_aspace_step_enable_form',
'file' => 'includes/ingest_steps.inc',
'module' => 'islandora_aspace',
),
);
}
}
/**
* Implements hook_islandora_ingest_steps_alter().
*/
function islandora_aspace_islandora_ingest_steps_alter(array &$steps, array &$form_state) {
if (!isset($form_state['islandora']['step_storage']['islandora_aspace_step_enable_form']['islandora_aspace_enable'])) {
return;
}
$enabled = $form_state['islandora']['step_storage']['islandora_aspace_step_enable_form']['islandora_aspace_enable'];
if ($enabled) {
// Don't use the normal MODs form.
if (isset($steps['xml_form_builder_metadata_step']) && $steps['xml_form_builder_metadata_step']['args'][0]['dsid'] == 'MODS') {
unset($steps['xml_form_builder_metadata_step']);
}
// Don't use the normal form association selector.
if (isset($steps['xml_form_builder_association_step'])) {
unset($steps['xml_form_builder_association_step']);
}
// Do add a basic metadata form for the archivesspace ingest.
$steps['islandora_aspace_step_metadata_form'] = array(
'type' => 'form',
'weight' => -4,
'form_id' => 'islandora_aspace_step_metadata_form',
'file' => 'includes/ingest_steps.inc',
'module' => 'islandora_aspace',
);
// Do add the callback to create the archivesspace object.
$steps['islandora_aspace_step_object_create_callback'] = array(
'type' => 'callback',
'weight' => 50,
'do_function' => array(
'function' => 'islandora_aspace_step_object_create_callback',
),
'file' => 'includes/ingest_steps.inc',
'module' => 'islandora_aspace',
);
}
}
/**
* Implements hook_islandora_required_objects().
*/
function islandora_aspace_islandora_required_objects(IslandoraTuque $connection) {
$module_path = drupal_get_path('module', 'islandora_aspace');
// ArchivesSpace Content Model.
$aspace_content_model = $connection->repository->constructObject(ISLANDORA_ASPACE_OBJECT_CMODEL);
$aspace_content_model->owner = 'fedoraAdmin';
$aspace_content_model->label = 'Islandora ArchivesSpace Content Model';
$aspace_content_model->models = 'fedora-system:ContentModel-3.0';
// DS-COMPOSITE-MODEL Datastream.
$datastream = $aspace_content_model->constructDatastream('DS-COMPOSITE-MODEL', 'X');
$datastream->label = 'DS-COMPOSITE-MODEL';
$datastream->mimetype = 'application/xml';
$datastream->setContentFromFile("$module_path/xml/islandora_aspace_ds_composite_model.xml", FALSE);
$aspace_content_model->ingestDatastream($datastream);
return array(
'islandora_aspace' => array(
'title' => 'Islandora ArchivesSpace',
'objects' => array(
$aspace_content_model,
),
),
);
}
/**
* Implements hook_islandora_undeletable_datastreams().
*/
function islandora_aspace_islandora_undeletable_datastreams(array $models) {
if (in_array(ISLANDORA_ASPACE_OBJECT_CMODEL, $models)) {
return array(ISLANDORA_ASPACE_DSID, 'MODS');
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function islandora_aspace_form_islandora_object_properties_form_alter(&$form, &$form_state, $form_id) {
$object = islandora_object_load($form['pid']['#value']);
if (in_array(ISLANDORA_ASPACE_OBJECT_CMODEL, $object->models)) {
$form['object_state']['#disabled'] = TRUE;
$form['object_label']['#disabled'] = TRUE;
$form['archivesspace_info'] = array(
'#markup' => '<h1>' . t('This item is managed in ArchivesSpace, please manage its properties there.') . '</h1>',
'#weight' => -10,
);
}
}
/**
* Implements hook_hook_theme_registry_alter().
*/
function islandora_aspace_theme_registry_alter(&$theme_registry) {
$path = drupal_get_path('module', 'islandora_aspace');
$theme_registry['islandora_default_edit']['includes'][] = "{$path}/theme/theme.inc";
$theme_registry['islandora_default_edit']['preprocess functions'][] = 'islandora_aspace_preprocess_islandora_default_edit';
}
/**
* Implements hook_services_resources().
*/
function islandora_aspace_services_resources() {
return array(
'islandora_aspace' => array(
'create' => array(
'help' => 'Creates the link from and Islandora object to ArchivesSpace object.',
'file' => array(
'type' => 'inc',
'module' => 'islandora_aspace',
'name' => 'includes/rest',
),
'callback' => 'islandora_aspace_rest_create',
'access callback' => 'islandora_aspace_rest_access',
'args' => array(
array(
'name' => 'pid',
'type' => 'string',
'description' => 'The pid of the object to update',
'source' => array('path' => '0'),
'optional' => FALSE,
),
array(
'name' => 'data',
'type' => 'struct',
'description' => 'The data for the object being updated',
'source' => 'data',
'optional' => FALSE,
),
),
),
'update' => array(
'help' => 'Updates an Islandora object with assoicated ArchivesSpace data.',
'file' => array(
'type' => 'inc',
'module' => 'islandora_aspace',
'name' => 'includes/rest',
),
'callback' => 'islandora_aspace_rest_update',
'access callback' => 'islandora_aspace_rest_access',
'args' => array(
array(
'name' => 'pid',
'type' => 'string',
'description' => 'The pid of the object to update',
'source' => array('path' => '0'),
'optional' => FALSE,
),
array(
'name' => 'data',
'type' => 'struct',
'description' => 'The data for the object being updated',
'source' => 'data',
'optional' => FALSE,
),
),
),
'retrieve' => array(
'help' => 'Retreieves information about an Islandora objects ArchivesSpace connection.',
'file' => array(
'type' => 'inc',
'module' => 'islandora_aspace',
'name' => 'includes/rest',
),
'callback' => 'islandora_aspace_rest_retrieve',
'access callback' => 'islandora_aspace_rest_access',
'args' => array(
array(
'name' => 'pid',
'type' => 'string',
'description' => 'The pid of the object to update',
'source' => array('path' => '0'),
'optional' => FALSE,
),
),
),
'delete' => array(
'help' => 'Updates an islandora to delete archivesspace connection.',
'file' => array(
'type' => 'inc',
'module' => 'islandora_aspace',
'name' => 'includes/rest',
),
'callback' => 'islandora_aspace_rest_delete',
'access callback' => 'islandora_aspace_rest_access',
'args' => array(
array(
'name' => 'pid',
'type' => 'string',
'description' => 'The pid of the object to update',
'source' => array('path' => '0'),
'optional' => FALSE,
),
),
),
),
);
}
/**
* Implements hook_ctools_plugin_api().
*/
function islandora_aspace_ctools_plugin_api($owner, $api) {
if ($owner == 'services' && $api == 'services') {
return array(
'version' => 3,
'file' => 'rest.inc',
'path' => drupal_get_path('module', 'islandora_aspace') . '/includes',
);
}
}
/**
* Implements hook_cmodel_pid_islandora_object_alter().
*/
function islandora_aspace_islandora_aspacecmodel_islandora_object_alter(AbstractObject $object, array &$context) {
module_load_include('inc', 'islandora_aspace', 'includes/aspace_api');
module_load_include('inc', 'islandora_aspace', 'includes/utilities');
if ($context['action'] == 'purge' && islandora_aspace_get_aspace_flag($object)) {
$data = json_decode($object['ARCHIVESSPACE']->content, TRUE);
$return = islandora_aspace_delete_deposit($data['uri']);
if ($return->code != 200) {
watchdog(
'islandora_aspace',
'Unable to notify ArchivesSpace of delete for PID: @pid. Error code: @code. Data: @body.',
array(
'@pid' => $object->id,
'@code' => $return->code,
'@body' => $return->data,
),
WATCHDOG_ERROR
);
drupal_set_message(t('Error notifying ArchivesSpace of delete.'), 'error');
}
}
}
/**
* Implements hook_islandora_aspace_template_paths().
*/
function islandora_aspace_islandora_aspace_template_paths() {
$module_path = drupal_get_path('module', 'islandora_aspace');
return "${module_path}/templates";
}
/**
* Implements hook_cmodel_islandora_derivative().
*/
function islandora_aspace_islandora_aspacecmodel_islandora_derivative(AbstractObject $object = NULL, $ds_modified_params = array()) {
$derivatives = array();
$path = drupal_get_path('module', 'islandora_aspace');
$derivatives[] = array(
'source_dsid' => NULL,
'destination_dsid' => NULL,
'weight' => -10,
'function' => array('islandora_aspace_create_aspace_object'),
'file' => $path . '/includes/derivatives.inc',
);
$derivatives[] = array(
'source_dsid' => ISLANDORA_ASPACE_DSID,
'destination_dsid' => NULL,
'weight' => 1,
'function' => array('islandora_aspace_update_object'),
'file' => $path . '/includes/derivatives.inc',
);
$derivatives[] = array(
'source_dsid' => ISLANDORA_ASPACE_DSID,
'destination_dsid' => 'MODS',
'weight' => 10,
'function' => array('islandora_aspace_create_mods'),
'file' => $path . '/includes/derivatives.inc',
);
$derivatives[] = array(
'source_dsid' => 'MODS',
'destination_dsid' => 'DC',
'weight' => 20,
'function' => array('islandora_aspace_create_dc'),
'file' => $path . '/includes/derivatives.inc',
);
return $derivatives;
}