-
Notifications
You must be signed in to change notification settings - Fork 195
/
Item.php
540 lines (484 loc) · 17.9 KB
/
Item.php
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
<?php
/**
* Omeka
*
* @copyright Copyright 2007-2012 Roy Rosenzweig Center for History and New Media
* @license http://www.gnu.org/licenses/gpl-3.0.txt GNU GPLv3
*/
/**
* @package Omeka\Db\Table
*/
class Table_Item extends Omeka_Db_Table
{
/**
* Run the search filter on the SELECT statement
*
* @param Zend_Db_Select
* @param array
*/
public function filterBySearch($select, $params)
{
//Apply the simple or advanced search
if (isset($params['search']) || isset($params['advanced'])) {
if ($simpleTerms = @$params['search']) {
$this->_simpleSearch($select, $simpleTerms);
}
if ($advancedTerms = @$params['advanced']) {
$this->_advancedSearch($select, $advancedTerms);
}
}
}
/**
* Build the simple search.
*
* The search query consists of a derived table that is INNER JOINed to the
* main SQL query. That derived table is a union of two SELECT queries. The
* first query searches the FULLTEXT index on the items_elements table, and
* the second query searches the tags table for every word in the search
* terms and assigns each found result a rank of '1'. That should make
* tagged items show up higher on the found results list for a given search.
*
* @param Zend_Db_Select $select
* @param string $simpleTerms
*/
protected function _simpleSearch($select, $terms)
{
$db = $this->getDb();
// Build tags query.
$tagList = preg_split('/\s+/', $terms);
// Make sure the tag list contains the whole search string, just in case
// that is found
if (count($tagList) > 1) {
$tagList[] = $terms;
}
$select->joinLeft(
array('_simple_records_tags' => $db->RecordsTags),
"_simple_records_tags.record_id = items.id AND _simple_records_tags.record_type = 'Item'",
array()
);
$select->joinLeft(
array('_simple_tags' => $db->Tag),
'_simple_tags.id = _simple_records_tags.tag_id',
array()
);
$subquery = new Omeka_Db_Select;
$subquery->from(array('_simple_etx' => $db->ElementText), '_simple_etx.record_id')
->where("_simple_etx.record_type = 'Item'")
->where('_simple_etx.text LIKE ?', '%' . $terms . '%');
$whereCondition = "items.id IN ($subquery) OR "
. $db->quoteInto('_simple_tags.name IN (?)', $tagList);
$select->where($whereCondition);
}
/**
* Build the advanced search.
*
* @param Zend_Db_Select $select
* @param array $simpleTerms
*/
protected function _advancedSearch($select, $terms)
{
$db = $this->getDb();
$where = '';
$advancedIndex = 0;
foreach ($terms as $v) {
// Do not search on blank rows.
if (empty($v['element_id']) || empty($v['type'])) {
continue;
}
$value = isset($v['terms']) ? $v['terms'] : null;
$type = $v['type'];
$elementId = (int) $v['element_id'];
$alias = "_advanced_{$advancedIndex}";
$joiner = isset($v['joiner']) && $advancedIndex > 0 ? $v['joiner'] : null;
$negate = false;
// Determine what the WHERE clause should look like.
switch ($type) {
case 'does not contain':
$negate = true;
case 'contains':
$predicate = "LIKE " . $db->quote('%'.$value .'%');
break;
case 'is not exactly':
$negate = true;
case 'is exactly':
$predicate = ' = ' . $db->quote($value);
break;
case 'is empty':
$negate = true;
case 'is not empty':
$predicate = 'IS NOT NULL';
break;
case 'starts with':
$predicate = "LIKE " . $db->quote($value.'%');
break;
case 'ends with':
$predicate = "LIKE " . $db->quote('%'.$value);
break;
case 'does not match':
$negate = true;
case 'matches':
if (!strlen($value)) {
continue 2;
}
$predicate = 'REGEXP ' . $db->quote($value);
break;
default:
throw new Omeka_Record_Exception(__('Invalid search type given!'));
}
$predicateClause = "{$alias}.text {$predicate}";
// Note that $elementId was earlier forced to int, so manual quoting
// is unnecessary here
$joinCondition = "{$alias}.record_id = items.id AND {$alias}.record_type = 'Item' AND {$alias}.element_id = $elementId";
if ($negate) {
$joinCondition .= " AND {$predicateClause}";
$whereClause = "{$alias}.text IS NULL";
} else {
$whereClause = $predicateClause;
}
$select->joinLeft(array($alias => $db->ElementText), $joinCondition, array());
if ($where == '') {
$where = $whereClause;
} elseif ($joiner == 'or') {
$where .= " OR $whereClause";
} else {
$where .= " AND $whereClause";
}
$advancedIndex++;
}
if ($where) {
$select->where($where);
}
}
/**
* Filter the SELECT statement based on an item's collection
*
* @param Zend_Db_Select $select
* @param Collection|int|array $collections Either a Collection object,
* or the collection id or an array of collection object or id.
*/
public function filterByCollection($select, $collections)
{
if (!is_array($collections)) {
$collections = array($collections);
}
$collectionIds = array_map(function ($collection) {
if ($collection === 0 || $collection === '0') {
return null;
}
if ($collection instanceof Collection) {
return (int) $collection->id;
}
if (is_numeric($collection)) {
return (int) $collection;
}
return;
}, $collections);
$hasEmpty = in_array(null, $collectionIds);
$collectionIds = array_filter($collectionIds);
if (!empty($collectionIds)) {
$select->joinLeft(
array('collections' => $this->getDb()->Collection),
'items.collection_id = collections.id',
array());
$condition = 'collections.id IN (?)';
if ($hasEmpty) {
$condition .= ' OR items.collection_id IS NULL';
}
$select->where($condition, $collectionIds);
}
// Check no collection only.
elseif ($hasEmpty) {
$select->where('items.collection_id IS NULL');
}
}
/**
* Filter the SELECT statement based on the item Type
*
* @param Zend_Db_Select $select
* @param Type|int|string|array $types One or multiple Item Type object,
* Item Type ID or Item Type name.
*/
public function filterByItemType($select, $types)
{
if (!is_array($types)) {
$types = array($types);
}
$typeIdsOrNames = array_map(function ($type) {
if ($type === 0 || $type === '0') {
return null;
}
if ($type instanceof ItemType) {
return (int) $type->id;
}
if (is_numeric($type)) {
return (int) $type;
}
if (is_string($type)) {
return $type;
}
return;
}, $types);
$hasEmpty = in_array(null, $typeIdsOrNames);
$typeIdsOrNames = array_filter($typeIdsOrNames);
if ($typeIdsOrNames) {
$select->joinLeft(array(
'item_types' => $this->getDb()->ItemType),
'items.item_type_id = item_types.id',
array());
$typeIds = array_filter($typeIdsOrNames, 'is_integer');
$typeNames = array_diff($typeIdsOrNames, $typeIds);
if (!empty($typeIds)) {
if (!empty($typeNames)) {
$conditions = 'item_types.id IN (' . implode(',', $typeIds) . ') OR item_types.name IN (?)';
$bind = array($typeNames);
} else {
$conditions = 'item_types.id IN (?)';
$bind = array($typeIds);
}
} else {
$conditions = 'item_types.name IN (?)';
$bind = array($typeNames);
}
if ($hasEmpty) {
$conditions .= ' OR items.item_type_id IS NULL';
}
$select->where($conditions, $bind);
}
// Check no collection only.
elseif ($hasEmpty) {
$select->where('items.item_type_id IS NULL');
}
}
/**
* Query must look like the following in order to correctly retrieve items
* that have all the tags provided (in this example, all items that are
* tagged both 'foo' and 'bar'):
*
* SELECT i.id
* FROM omeka_items i
* WHERE
* (
* i.id IN
* (SELECT tg.record_id as id
* FROM omeka_records_tags tg
* INNER JOIN omeka_tags t ON t.id = tg.tag_id
* WHERE t.name = 'foo' AND tg.record_type = 'Item')
* AND i.id IN
* (SELECT tg.record_id as id
* FROM omeka_records_tags tg
* INNER JOIN omeka_tags t ON t.id = tg.tag_id
* WHERE t.name = 'bar' AND tg.record_type = 'Item')
* )
* ...
*
*
* @param Omeka_Db_Select
* @param string|array A comma-delimited string or an array of tag names.
*/
public function filterByTags($select, $tags)
{
// Split the tags into an array if they aren't already
if (!is_array($tags)) {
$tags = explode(get_option('tag_delimiter'), $tags);
}
$db = $this->getDb();
// For each of the tags, create a SELECT subquery using Omeka_Db_Select.
// This subquery should only return item IDs, so that the subquery can be
// appended to the main query by WHERE i.id IN (SUBQUERY).
foreach ($tags as $tagName) {
$subSelect = new Omeka_Db_Select;
$subSelect->from(array('records_tags' => $db->RecordsTags), array('items.id' => 'records_tags.record_id'))
->joinInner(array('tags' => $db->Tag), 'tags.id = records_tags.tag_id', array())
->where('tags.name = ? AND records_tags.`record_type` = "Item"', trim($tagName));
$select->where('items.id IN (' . (string) $subSelect . ')');
}
}
/**
* Filter SELECT statement based on items that are not tagged with a specific
* set of tags
*
* @param Zend_Db_Select
* @param array|string Set of tag names (either array or comma-delimited string)
*/
public function filterByExcludedTags($select, $tags)
{
$db = $this->getDb();
if (!is_array($tags)) {
$tags = explode(get_option('tag_delimiter'), $tags);
}
$subSelect = new Omeka_Db_Select;
$subSelect->from(array('items' => $db->Item), 'items.id')
->joinInner(array('records_tags' => $db->RecordsTags),
'records_tags.record_id = items.id AND records_tags.record_type = "Item"',
array())
->joinInner(array('tags' => $db->Tag),
'records_tags.tag_id = tags.id',
array());
foreach ($tags as $key => $tag) {
$subSelect->where('tags.name LIKE ?', $tag);
}
$select->where('items.id NOT IN ('.$subSelect->__toString().')');
}
/**
* Filter SELECT statement based on whether items have a derivative image
* file.
*
* @param Zend_Db_Select
* @param bool $hasDerivativeImage Whether items should have a derivative
* image file.
*/
public function filterByHasDerivativeImage($select, $hasDerivativeImage = true)
{
$hasDerivativeImage = $hasDerivativeImage ? '1' : '0';
$db = $this->getDb();
$select->joinLeft(array('files' => "$db->File"), 'files.item_id = items.id', array());
$select->where('files.has_derivative_image = ?', $hasDerivativeImage);
}
/**
* @param Omeka_Db_Select
* @param array
*/
public function applySearchFilters($select, $params)
{
$boolean = new Omeka_Filter_Boolean;
foreach ($params as $key => $value) {
if ($value === null || (is_string($value) && trim($value) == '')) {
continue;
}
switch ($key) {
case 'user':
case 'owner':
case 'user_id':
case 'owner_id':
$this->filterByUser($select, $value, 'owner_id');
break;
case 'public':
$this->filterByPublic($select, $boolean->filter($value));
break;
case 'featured':
$this->filterByFeatured($select, $boolean->filter($value));
break;
case 'collection':
case 'collection_id':
$this->filterByCollection($select, $value);
break;
case 'type':
case 'item_type':
case 'item_type_id':
$this->filterByItemType($select, $value);
break;
case 'tag':
case 'tags':
$this->filterByTags($select, $value);
break;
case 'excludeTags':
$this->filterByExcludedTags($select, $value);
break;
case 'hasImage':
$this->filterByHasDerivativeImage($select, $boolean->filter($value));
break;
case 'range':
$this->filterByRange($select, $value);
break;
case 'added_since':
$this->filterBySince($select, $value, 'added');
break;
case 'modified_since':
$this->filterBySince($select, $value, 'modified');
break;
}
}
$this->filterBySearch($select, $params);
// If we returning the data itself, we need to group by the item ID
$select->group('items.id');
}
/**
* Enables sorting based on ElementSet,Element field strings.
*
* @param Omeka_Db_Select $select
* @param string $sortField Field to sort on
* @param string $sortDir Sorting direction (ASC or DESC)
*/
public function applySorting($select, $sortField, $sortDir)
{
parent::applySorting($select, $sortField, $sortDir);
$db = $this->getDb();
$fieldData = explode(',', $sortField);
if (count($fieldData) == 2) {
$element = $db->getTable('Element')->findByElementSetNameAndElementName($fieldData[0], $fieldData[1]);
if ($element) {
$select->joinLeft(array('et_sort' => $db->ElementText),
"et_sort.record_id = items.id AND et_sort.record_type = 'Item' AND et_sort.element_id = {$element->id}",
array())
->group('items.id')
->order(array("IF(ISNULL(et_sort.text), 1, 0) $sortDir",
"et_sort.text $sortDir"));
}
}
}
/**
* This is a kind of simple factory that spits out proper beginnings
* of SQL statements when retrieving items
*
* @return Omeka_Db_Select
*/
public function getSelect()
{
$select = parent::getSelect();
$permissions = new Omeka_Db_Select_PublicPermissions('Items');
$permissions->apply($select, 'items');
return $select;
}
/**
* Return the first item accessible to the current user.
*
* @return Item|null
*/
public function findFirst()
{
$select = $this->getSelect();
$select->order('items.id ASC');
$select->limit(1);
return $this->fetchObject($select);
}
/**
* Return the last item accessible to the current user.
*
* @return Item|null
*/
public function findLast()
{
$select = $this->getSelect();
$select->order('items.id DESC');
$select->limit(1);
return $this->fetchObject($select);
}
public function findPrevious($item)
{
return $this->findNearby($item, 'previous');
}
public function findNext($item)
{
return $this->findNearby($item, 'next');
}
protected function findNearby($item, $position = 'next')
{
//This will only pull the title and id for the item
$select = $this->getSelect();
$select->limit(1);
switch ($position) {
case 'next':
$select->where('items.id > ?', (int) $item->id);
$select->order('items.id ASC');
break;
case 'previous':
$select->where('items.id < ?', (int) $item->id);
$select->order('items.id DESC');
break;
default:
throw new Omeka_Record_Exception('Invalid position provided to ItemTable::findNearby()!');
break;
}
return $this->fetchObject($select);
}
}