-
Notifications
You must be signed in to change notification settings - Fork 0
/
cwrc_eap.module
363 lines (321 loc) · 10.4 KB
/
cwrc_eap.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
<?php
/**
* @file
* Hooks and helper functions for the cwrc_eap module.
*/
module_load_include('inc', 'cwrc_eap', 'cwrc_eap.api');
/**
* Implements hook_menu().
*/
function cwrc_eap_menu() {
$items['islandora/object/%islandora_object/edit-entity'] = array(
'title' => 'Edit',
'page callback' => 'cwrc_eap_edit_entity',
'access callback' => 'cwrc_eap_edit_entity_access',
'access arguments' => array(2),
'type' => MENU_LOCAL_TASK,
);
$items['islandora/cwrc-eap/%/%'] = array(
'title' => 'View',
'page callback' => 'cwrc_eap_xmldb_json',
'page arguments' => array(2, 3),
'access arguments' => array(ISLANDORA_CWRC_BASEXDB_AC_QUERY),
'file' => 'cwrc_eap.api.inc',
'type' => MENU_CALLBACK,
);
$items['islandora/cwrc-eap/material/%/%'] = array(
'title' => 'View',
'page callback' => 'cwrc_eap_xmldb_json_material',
'page arguments' => array(3, 4),
'access arguments' => array(ISLANDORA_CWRC_BASEXDB_AC_QUERY),
'file' => 'cwrc_eap.api.inc',
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_theme().
*/
function cwrc_eap_theme($existing, $type, $theme, $path) {
return array(
// Full EAP template callback, wraps several others from below.
'cwrc_eap' => array(
'template' => 'templates/cwrc-eap',
'variables' => array(
// Generic information elements.
'object' => NULL,
'project' => NULL,
'image' => NULL,
'summary' => NULL,
// Info is a renderable array of one or more "cwrc_eap_info" elements.
'info_record' => array(),
'info_identity' => array(),
'info_description' => array(),
// Associations is a list of links to associated entities.
'associations_person' => NULL,
'associations_place' => NULL,
'associations_organization' => NULL,
// Materials is a renderable array of one or more "cwrc_eap_material"
// elements.
'materials' => array(),
),
),
// Generic info element wrapper.
'cwrc_eap_info' => array(
'template' => 'templates/cwrc-eap-info',
'variables' => array(
'label' => NULL,
'elements' => array(),
),
),
// Generic materials wrapper.
'cwrc_eap_material' => array(
'template' => 'templates/cwrc-eap-material',
'variables' => array(
'pid' => NULL,
'image' => NULL,
'label' => NULL,
'summary' => NULL,
),
),
);
}
/**
* Loads object and sources appropriate data for thumbnail, label and summary.
*/
function cwrc_eap_preprocess_cwrc_eap_material(&$variables) {
// Allow PID to be passed as string or directly as object.
if (is_object($variables['pid'])) {
$object = $variables['pid'];
$variables['pid'] = $object->id;
}
else {
$object = islandora_object_load($variables['pid']);
}
// No object could be loaded.
if (!$object) {
return;
}
// Label.
$variables['label'] = $object->label;
// Add cmodel classes.
foreach ($object->models as $cmodel) {
$variables['classes_array'][] = strtolower(drupal_clean_css_identifier($cmodel, array(
':' => '-',
' ' => '-',
'_' => '-',
'/' => '-',
'[' => '-',
']' => '',
)));
}
// Check for TN datastream, render as image.
if (isset($object['TN'])) {
$image = array(
'#theme' => 'image',
'#path' => url('islandora/object/' . $object->id . '/datastream/TN/view'),
'#alt' => t('@object thumbnail', array('@object' => $object->label)),
'#attributes' => array(),
);
$variables['image'] = render($image);
}
// Check for DC datastream, use description if found.
if (isset($object['DC'])) {
$dc_doc = new DOMDocument();
$dc_doc->loadXML($object['DC']->content);
$xpath = new DOMXPath($dc_doc);
$xpath->registerNamespace('dc', 'http://purl.org/dc/elements/1.1/');
$xpath->registerNamespace('oai_dc', 'http://www.openarchives.org/OAI/2.0/oai_dc/');
$desc_node = $xpath->evaluate('/oai_dc:dc/dc:description/text()');
if ($desc_node->item(0)) {
$variables['summary'] = $desc_node->item(0)->nodeValue;
}
}
}
/**
* Add a theme hook suggestion to allow custom templates for different EAPs.
*/
function cwrc_eap_preprocess_cwrc_eap(&$variables) {
$models = array_intersect(_cwrc_eap_get_models(), $variables['object']->models);
$model = reset($models);
$variables['classes_array'][] = strtolower(drupal_clean_css_identifier($model, array(
':' => '-',
' ' => '-',
'_' => '-',
'/' => '-',
'[' => '-',
']' => '',
)));
$variables['theme_hook_suggestions'][] = 'cwrc_eap__' . strtolower(drupal_clean_css_identifier($model, array(
':' => '_',
'-' => '_',
' ' => '_',
'/' => '_',
'[' => '_',
']' => '',
)));
}
/**
* Page callback to dump an error message saying JS must be enabled.
*/
function cwrc_eap_edit_entity() {
return t('You must have javascript enabled to edit CWRC entities.');
}
/**
* Ensures this object is a valid entity and then ensures user has edit access.
*/
function cwrc_eap_edit_entity_access($object) {
module_load_include('inc', 'islandora_cwrc_writer', 'includes/utilities');
if (!islandora_cwrc_writer_valid_entity_type(islandora_cwrc_writer_get_entity_type($object))) {
return FALSE;
}
else {
return islandora_object_manage_access_callback(
array(
ISLANDORA_MANAGE_PROPERTIES,
ISLANDORA_METADATA_EDIT,
ISLANDORA_ADD_DS,
ISLANDORA_PURGE,
ISLANDORA_INGEST,
), $object);
}
}
/**
* Implements hook_preprocess_menu_local_task().
*/
function cwrc_eap_preprocess_menu_local_task(&$variables) {
// When our link is rendered as a local task we load the library and attach
// relevant javascript and settings so that we can do our job here.
if (isset($variables['element']['#link']['path']) && $variables['element']['#link']['path'] == 'islandora/object/%/edit-entity') {
global $base_url;
// Add our css and javascripts.
drupal_add_js(drupal_get_path('module', 'cwrc_eap') . '/js/edit-eap.js');
// Create settings for edit dialog.
$object = menu_get_object('islandora_object', 2);
$settings = array(
'base_url' => $base_url,
'entity_type' => islandora_cwrc_writer_get_entity_type($object),
'opts' => array(
'id' => $object->id,
'name' => $object->label,
'data' => $object[islandora_cwrc_writer_entity_content_datastream_id($object)]->content,
'repository' => 'cwrc',
),
);
drupal_add_js(array('cwrc_eap' => $settings), 'setting');
// Inject ID attribute into the render element.
$variables['element']['#link']['options']['attributes']['class'][] = 'cwrc-eap-edit-link';
$variables['element']['#link']['localized_options']['attributes']['class'][] = 'cwrc-eap-edit-link';
}
}
/**
* Implements hook_islandora_view_object().
*/
function cwrc_eap_islandora_view_object($object, $user, $page_number = NULL, $page_size = NULL) {
drupal_add_js('var $ = jQuery;', array(
'type' => 'inline',
'scope' => 'header',
'every_page' => TRUE,
'requires_jquery' => TRUE,
));
$build = array();
$cmodels = array_intersect(_cwrc_eap_get_models(), $object->models);
if (count($cmodels) > 0) {
// For now we assume that the first cmodel is the one we should use for
// rendering the object, may need to revisit though.
$cmodel = reset($cmodels);
// Begin build array.
$build = array(
'#theme' => 'cwrc_eap',
'#object' => $object,
);
// Get the parent project (default to cwrc commons if none is found).
$project = _cwrc_projects_get_project($object->id);
if (!$project) {
$nid = variable_get('cwrc_eap_default_project', FALSE);
if ($nid) {
$project = node_load($nid);
}
}
$build['#project'] = $project;
// Check for TN datastream, render as image.
if (isset($object['TN'])) {
$image = array(
'#theme' => 'image',
'#path' => url('islandora/object/' . $object->id . '/datastream/TN/view'),
'#alt' => t('@object thumbnail', array('@object' => $object->label)),
'#attributes' => array(),
);
$build['#image'] = render($image);
}
// Check for DC datastream, use description if found.
if (isset($object['DC'])) {
$dc_doc = new DOMDocument();
$dc_doc->loadXML($object['DC']->content);
$xpath = new DOMXPath($dc_doc);
$xpath->registerNamespace('dc', 'http://purl.org/dc/elements/1.1/');
$xpath->registerNamespace('oai_dc', 'http://www.openarchives.org/OAI/2.0/oai_dc/');
$desc_node = $xpath->evaluate('/oai_dc:dc/dc:description/text()');
if ($desc_node->item(0)) {
$build['#summary'] = $desc_node->item(0)->nodeValue;
}
}
// Route to appropriate additional handler here.
module_load_include('inc', 'cwrc_eap', 'cwrc_eap.build');
switch ($cmodel) {
case 'cwrc:person-entityCModel':
_cwrc_eap_build_person($build);
break;
case 'cwrc:organization-entityCModel':
_cwrc_eap_build_organization($build);
break;
case 'cwrc:place-entityCModel':
_cwrc_eap_build_place($build);
break;
}
}
return render($build);
}
/**
* Helper function to get a list of models.
*/
function _cwrc_eap_get_models() {
static $models = array(
'cwrc:person-entityCModel',
'cwrc:organization-entityCModel',
'cwrc:place-entityCModel',
);
return $models;
}
/**
* Helper function to get a material label given a key.
*/
function _cwrc_eap_map_material_label($key) {
$labels = &drupal_static(__FUNCTION__);
if (!isset($labels)) {
$labels = array(
'entries_other' => t('Entries (Other)'),
'entries_about' => t('Entries About'),
'bibliographic_about' => t('Oeuvre'),
'entries_mentioning' => t('Entries'),
'bibliographic_related' => t('About'),
'multimedia' => t('Multimedia'),
);
}
$key = (string) $key;
return isset($labels[$key]) ? $labels[$key] : $key;
}
/**
* Implements hook_preproccess_html().
*/
function cwrc_eap_preprocess_html(&$vars) {
$islandora_object = menu_get_object('islandora_object', 2);
if ($islandora_object != NULL) {
$cmodels = array_intersect(_cwrc_eap_get_models(), $islandora_object->models);
if (count($cmodels) > 0) {
$model = reset($cmodels);
$vars['classes_array'][] = 'cwrc-eap-body';
$vars['classes_array'][] = 'cwrc-eap-' . strtolower(drupal_clean_css_identifier($model)) . '-body';
}
}
}