From 2a7ebfd0d8354df51a1f94f671a68efefd7e8a35 Mon Sep 17 00:00:00 2001
From: John Kloor <john@kloor.org>
Date: Tue, 21 Sep 2021 09:19:50 -0400
Subject: [PATCH] Add support for tagging collections.

---
 .../themes/default/collections/form-tabs.php  |  5 ++
 admin/themes/default/collections/form.php     |  5 ++
 admin/themes/default/collections/show.php     |  9 ++
 admin/themes/default/collections/tag-form.php | 31 +++++++
 admin/themes/default/collections/tag-list.php |  9 ++
 admin/themes/default/collections/tags.php     | 11 +++
 .../controllers/CollectionsController.php     | 14 +++
 application/models/Api/Collection.php         |  2 +
 application/models/Collection.php             | 12 +++
 application/models/Table/Collection.php       | 85 +++++++++++++++++++
 10 files changed, 183 insertions(+)
 create mode 100644 admin/themes/default/collections/tag-form.php
 create mode 100644 admin/themes/default/collections/tag-list.php
 create mode 100644 admin/themes/default/collections/tags.php

diff --git a/admin/themes/default/collections/form-tabs.php b/admin/themes/default/collections/form-tabs.php
index c6c433965e..91d68d7bd1 100644
--- a/admin/themes/default/collections/form-tabs.php
+++ b/admin/themes/default/collections/form-tabs.php
@@ -10,6 +10,11 @@
     $tabs[$tabName] = $tabContent;    
 }
 
+ob_start();
+require 'tag-form.php';
+$tabs['Tags'] = ob_get_contents();
+ob_end_clean();
+
 $tabs = apply_filters('admin_collections_form_tabs', $tabs, array('collection' => $collection));
 ?>
 
diff --git a/admin/themes/default/collections/form.php b/admin/themes/default/collections/form.php
index a357e6126f..d49363bb82 100644
--- a/admin/themes/default/collections/form.php
+++ b/admin/themes/default/collections/form.php
@@ -1,10 +1,15 @@
 <?php echo js_tag('vendor/tinymce/tinymce.min'); ?>
 <?php echo js_tag('elements'); ?>
 <?php echo js_tag('tabs'); ?>
+<?php echo js_tag('items'); ?>
 <script type="text/javascript">
 jQuery(document).ready(function () {
     Omeka.Tabs.initialize();
     
+    Omeka.Items.tagDelimiter = <?php echo js_escape(get_option('tag_delimiter')); ?>;
+    Omeka.Items.enableTagRemoval();
+    Omeka.Items.tagChoices('#tags', <?php echo js_escape(url(array('controller'=>'tags', 'action'=>'autocomplete'), 'default', array(), true)); ?>);
+
     Omeka.wysiwyg({
         selector: false,
         forced_root_block: false
diff --git a/admin/themes/default/collections/show.php b/admin/themes/default/collections/show.php
index f7441128b0..e932ae87a3 100644
--- a/admin/themes/default/collections/show.php
+++ b/admin/themes/default/collections/show.php
@@ -42,6 +42,15 @@
         <p><span class="label"><?php echo __('Featured'); ?>:</span> <?php echo ($collection->featured) ? __('Yes') : __('No'); ?></p>
     </div>
 
+    <?php if (metadata('collection', 'has tags')): ?>
+    <div class="tags panel">
+        <h4><?php echo __('Tags'); ?></h4>
+        <div id="tag-cloud">
+            <?php echo common('tag-list', compact('collection'), 'collections'); ?>
+        </div>
+     </div>
+    <?php endif; ?>
+
     <div class="total-items panel">
         <h4><?php echo __('Total Number of Items'); ?></h4>
         <p><?php echo link_to_items_in_collection(); ?></p>
diff --git a/admin/themes/default/collections/tag-form.php b/admin/themes/default/collections/tag-form.php
new file mode 100644
index 0000000000..2c04bc2dba
--- /dev/null
+++ b/admin/themes/default/collections/tag-form.php
@@ -0,0 +1,31 @@
+<div id="tag-form" class="field">
+    <?php
+        $tags = $collection->getTags();
+    ?>
+    <input type="hidden" name="tags-to-add" id="tags-to-add" value="" />
+    <input type="hidden" name="tags-to-delete" id="tags-to-delete" value="" />
+    <div id="add-tags">
+        <label><?php echo __('Add Tags'); ?></label>           
+        <input type="text" name="tags" size="20" id="tags" class="textinput" value="" />
+        <p id="add-tags-explanation" class="explanation"><?php echo __('Separate tags with %s', option('tag_delimiter')); ?></p>
+        <input type="submit" name="add-tags-button" id="add-tags-button" class="green button" value="<?php echo __('Add Tags'); ?>" />
+    </div>
+    <div id="all-tags">
+    <?php if ($tags): ?>
+        <h3><?php echo __('All Tags'); ?></h3>
+        
+        <div class="tag-list">
+        <ul id="all-tags-list">
+            <?php foreach( $tags as $tag ): ?>
+                <li>
+                    <?php echo '<span class="tag">' . html_escape($tag->name) . '</span>';
+                          echo '<span class="undo-remove-tag"><a href="#">' . __('Undo') . '</a></span>';
+                          echo '<span class="remove-tag"><a href="#">' . __('Remove') . '</a></span>'; ?>
+                </li>
+            <?php endforeach; ?>
+        </ul>
+        </div>
+    <?php endif; ?>
+    </div>
+</div>
+<?php fire_plugin_hook('admin_collections_form_tags', array('collection' => $collection, 'view' => $this)); ?>
diff --git a/admin/themes/default/collections/tag-list.php b/admin/themes/default/collections/tag-list.php
new file mode 100644
index 0000000000..3fdc2e2174
--- /dev/null
+++ b/admin/themes/default/collections/tag-list.php
@@ -0,0 +1,9 @@
+<?php if ($collection->Tags): ?>
+    <ul class="tags">
+        <?php foreach( $collection->Tags as $key => $tag ): ?>
+        <li class="tag">
+            <a href="<?php echo html_escape(url('collections/browse', array('tags' => $tag->name))); ?>"><?php echo html_escape($tag->name); ?></a>
+        </li>
+        <?php endforeach; ?>
+    </ul>
+<?php endif; ?>
diff --git a/admin/themes/default/collections/tags.php b/admin/themes/default/collections/tags.php
new file mode 100644
index 0000000000..fe8a1f2343
--- /dev/null
+++ b/admin/themes/default/collections/tags.php
@@ -0,0 +1,11 @@
+<?php
+$pageTitle = __('Browse Collections by Tag');
+echo head(array('title' => $pageTitle));
+echo flash();
+?>
+<?php if (count($tags)): ?>
+    <?php echo tag_cloud($tags, 'collections/browse'); ?>
+<?php else: ?>
+    <p><?php echo __('There are no tags to display. You must first tag some collections.'); ?></p>
+<?php endif; ?>
+<?php echo foot(); ?>
diff --git a/application/controllers/CollectionsController.php b/application/controllers/CollectionsController.php
index 6900cc9af4..1c1b495e93 100644
--- a/application/controllers/CollectionsController.php
+++ b/application/controllers/CollectionsController.php
@@ -52,6 +52,20 @@ public function editAction()
         parent::editAction();
     }
 
+    /**
+     * Finds all tags associated with collections (used for tag cloud)
+     */
+    public function tagsAction()
+    {
+        $params = array_merge(
+            array('sort_field' => 'name'),
+            $this->_getAllParams(),
+            array('type' => 'Collection')
+        );
+        $tags = $this->_helper->db->getTable('Tag')->findBy($params);
+        $this->view->assign(compact('tags'));
+    }
+
     protected function _getAddSuccessMessage($collection)
     {
         $collectionTitle = $this->_getElementMetadata($collection, 'Dublin Core', 'Title');
diff --git a/application/models/Api/Collection.php b/application/models/Api/Collection.php
index 38de25e8a9..5bc3040bff 100644
--- a/application/models/Api/Collection.php
+++ b/application/models/Api/Collection.php
@@ -36,6 +36,7 @@ public function getRepresentation(Omeka_Record_AbstractRecord $record)
                 'url' => self::getResourceUrl("/items?collection={$record->id}"),
                 'resource' => 'items',
             ),
+            'tags' = $this->getTagRepresentations($record),
             'element_texts' => $this->getElementTextRepresentations($record),
         );
 
@@ -56,6 +57,7 @@ public function setPostData(Omeka_Record_AbstractRecord $record, $data)
         if (isset($data->featured)) {
             $record->featured = $data->featured;
         }
+        $this->setTagData($record, $data);
         $this->setElementTextData($record, $data);
     }
 
diff --git a/application/models/Collection.php b/application/models/Collection.php
index db6cfa59e6..a6307164b1 100644
--- a/application/models/Collection.php
+++ b/application/models/Collection.php
@@ -54,6 +54,7 @@ class Collection extends Omeka_Record_AbstractRecord implements Zend_Acl_Resourc
      * @see Omeka_Record_AbstractRecord::__get
      */
     protected $_related = array(
+        'Tags' => 'getTags',
         'ElementTexts' => 'getAllElementTexts'
     );
 
@@ -62,6 +63,7 @@ class Collection extends Omeka_Record_AbstractRecord implements Zend_Acl_Resourc
      */
     protected function _initializeMixins()
     {
+        $this->_mixins[] = new Mixin_Tag($this);
         $this->_mixins[] = new Mixin_PublicFeatured($this);
         $this->_mixins[] = new Mixin_Owner($this);
         $this->_mixins[] = new Mixin_ElementText($this);
@@ -211,6 +213,16 @@ protected function afterSave($args)
         if (!$this->public) {
             $this->setSearchTextPrivate();
         }
+
+        if ($args['post']) {
+            $post = $args['post'];
+
+            // Save/delete the tags.
+            if (isset($post['tags-to-add'])) {
+                $this->addTags($post['tags-to-add']);
+                $this->deleteTags($post['tags-to-delete']);
+            }
+        }
     }
 
     /**
diff --git a/application/models/Table/Collection.php b/application/models/Table/Collection.php
index 5f8fde8887..eae4162409 100644
--- a/application/models/Table/Collection.php
+++ b/application/models/Table/Collection.php
@@ -37,6 +37,13 @@ public function applySearchFilters($select, $params)
                 case 'range':
                     $this->filterByRange($select, $value);
                     break;
+                case 'tag':
+                case 'tags':
+                    $this->filterByTags($select, $value);
+                    break;
+                case 'excludeTags':
+                    $this->filterByExcludedTags($select, $value);
+                    break;
             }
         }
     }
@@ -134,4 +141,82 @@ public function applySorting($select, $sortField, $sortDir)
             }
         }
     }
+
+    /**
+     * Query must look like the following in order to correctly retrieve collections
+     * that have all the tags provided (in this example, all collections that are
+     * tagged both 'foo' and 'bar'):
+     *
+     *    SELECT i.id
+     *    FROM omeka_collections 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 = 'Collection')
+     *    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 = 'Collection')
+     *    )
+     *      ...
+     *
+     *
+     * @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 collection 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('collections.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` = "Collection"', trim($tagName));
+
+            $select->where('collections.id IN (' . (string) $subSelect . ')');
+        }
+    }
+
+    /**
+     * Filter SELECT statement based on collections 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('collections' => $db->Collection), 'collections.id')
+                         ->joinInner(array('records_tags' => $db->RecordsTags),
+                                     'records_tags.record_id = collections.id AND records_tags.record_type = "Collection"',
+                                     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('collections.id NOT IN ('.$subSelect->__toString().')');
+    }
 }