LocalContextsPlugin.php

<?php

if (!defined('LOCALCONTEXTS_PLUGIN_DIR')) {
    define('LOCALCONTEXTS_PLUGIN_DIR', dirname(__FILE__));
}

if (!defined('LOCALCONTEXTS_HELPERS_DIR')) {
    define('LOCALCONTEXTS_HELPERS_DIR', LOCALCONTEXTS_PLUGIN_DIR . '/helpers');
}

if (!defined('LOCALCONTEXTS_FORMS_DIR')) {
    define('LOCALCONTEXTS_FORMS_DIR', LOCALCONTEXTS_PLUGIN_DIR . '/forms');
}

require_once LOCALCONTEXTS_PLUGIN_DIR . '/LocalContextsPlugin.php';

/**
 * LocalContexts plugin.
 * 
 * @package Omeka\Plugins\LocalContexts
 */
class LocalContextsPlugin extends Omeka_Plugin_AbstractPlugin
{
    /**
     * @var array Hooks for the plugin.
     */
    protected $_hooks = array(
        'uninstall',
        'admin_head',
        'public_head',
        'initialize',
        'define_routes',
        'config',
        'config_form',
        'before_save_item',
        'admin_items_batch_edit_form',
        'items_batch_edit_custom',
        'public_footer'
    );

    protected $_filters = array(
        'admin_navigation_main',
        'admin_items_form_tabs',
        'exhibit_layouts'
    );

    public function hookUninstall()
    {
        // Delete the plugin options
        delete_option('lc_project_id');
        delete_option('lc_notices');
        delete_option('lc_site_language');
        delete_option('lc_content_site');
    }
    
    public function hookAdminHead()
    {
        queue_css_file('local-contexts');
        queue_js_file('local-contexts');
    }

    public function hookPublicHead()
    {
        queue_css_file('local-contexts');
    }

    public function hookInitialize()
    {
        add_translation_source(dirname(__FILE__) . '/languages');
    }

    public function hookDefineRoutes($args)
    {
        $router = $args['router'];
        $indexRoute = new Zend_Controller_Router_Route('local-contexts',
            array(
                'module'        => 'local-contexts',
                'controller'    => 'local-contexts',
                'action'        => 'index'
                )
            );
        $router->addRoute('localContextsIndex', $indexRoute);

        $assignRoute = new Zend_Controller_Router_Route('local-contexts/assign',
            array(
                'module'        => 'local-contexts',
                'controller'    => 'local-contexts',
                'action'        => 'assign'
                )
            );
        $router->addRoute('localContextsAssign', $assignRoute);
    }

    public function hookConfig($args)
    {
        $post = $args['post'];
        set_option('lc_site_language', $post['lc_site_language']);
        if ($post['lc-content']) {
            set_option('lc_content_site', serialize($post['lc-content']));
        } else {
            delete_option('lc_content_site');
        }
    }

    public function hookConfigForm()
    {
        $view = get_view();
        include 'config_form.php';
    }

    // Save LC content selected in admin item form (below)
    public function hookBeforeSaveItem($args)
    {
        if (!($post = $args['post'])) {
            return;
        }

        $item = $args['record'];

        self::LcContentAddToElement($item, $post);
    }

    public function hookPublicFooter()
    {
        if (get_option('lc_content_site')) {
            $projects = unserialize(get_option('lc_content_site'));
            $lcLanguage = get_option('lc_site_language');
            
            $contentArray = array();
            foreach ($projects as $key => $project) {
                $project = json_decode($project, true);
                $projectArray = array();

                foreach ($project as $key => $content) {
                    if (is_int($key)) {
                        // Only print content in selected language. If 'All', print everything
                        if ((isset($content['language']) && $content['language'] == $lcLanguage)
                        || (!isset($content['language']) && $lcLanguage == 'English')
                        || $lcLanguage == 'All') {
                            $projectArray[] = $content;
                        }
                    }
                }

                // Don't print project URL if element value array is empty
                if (isset($project['project_url']) && $projectArray) {
                    $projectArray['project_url'] = $project['project_url'];
                    $projectArray['project_title'] = $project['project_title'];
                }

                if ($projectArray) {
                    $lcHtml = self::renderLCNoticeHtml($projectArray, $key, true, false);
                    $lcArray['label'] = $lcHtml;
                    $lcArray['value'] = json_encode($project);
                    $contentArray[] = $lcArray;
                }
            }
            $view = get_view();
            echo $view->partial('site-footer.phtml', [
                'lc_content' => $contentArray,
            ]);
        }
    }

    /**
     * Add custom fields to the item batch edit form.
     */
    public function hookAdminItemsBatchEditForm()
    {
        $view = get_view();
        $lcSiteChecked = get_option('lc_content_site') ? unserialize(get_option('lc_content_site')) : [];
        $elementData = get_db()->getTable('Element')->findPairsForSelectForm(array('exclude_item_type' => true));
        $lcLanguageOptions = [
            'All' => __('All available languages'),
            'English' => __('English'),
            'French' => __('French'),
            'Spanish' => __('Spanish'),
            'Māori' => __('Māori'),
        ];

        // Combine available general settings projects with existing site settings projects
        $projects = get_option('lc_notices') ? unserialize(get_option('lc_notices')) : [];
        foreach($lcSiteChecked as $siteProject) {
            $projects[] = json_decode($siteProject, true);
        }

        $projects = get_option('lc_notices') ? unserialize(get_option('lc_notices')) : [];
        foreach (array_unique($projects, SORT_REGULAR) as $key => $project) {
            // Collapse many projects for ease of viewing
            // Save each project's content as single select value
            $lcHtml = self::renderLCNoticeHtml($project, $key, false, true);
            $lcHtml = str_replace("lc-content[]", "custom[lc-content][]", $lcHtml);
            $lcBatchContent[] = $lcHtml;
        }

        echo $view->partial('lc-batch-edit.phtml', [
            'elementData' => $elementData,
            'lcLanguageOptions' => $lcLanguageOptions,
            'lc_content' => $lcBatchContent,
        ]);
    }

    /**
     * Process the item batch edit form.
     *
     * @param array $args
     */
    public function hookItemsBatchEditCustom($args)
    {
        $item = $args['item'];

        if (!($custom = $args['custom'])) {
            return;
        }

        self::LcContentAddToElement($item, $custom);
        // Need to manually save batch edited items
        $item->save();
    }

    // Provide LC content to item add/update form
    public function filterAdminItemsFormTabs($tabs, $args)
    {
        $item = $args['item'];
        $tabs['Local Contexts'] = [];

        $view = get_view();
        if (get_option('lc_notices')) {
			$projects = unserialize(get_option('lc_notices'));
            foreach ($projects as $key => $project) {
                // Collapse many projects for ease of viewing
                $lcHtml = self::renderLCNoticeHtml($project, $key, false, true);
                $contentArray[] = $lcHtml;
            }

            $elementData = get_db()->getTable('Element')->findPairsForSelectForm(array('exclude_item_type' => true));

            $languageData = [
                'All' => __('All available languages'),
                'English' => __('English'),
                'French' => __('French'),
                'Spanish' => __('Spanish'),
                'Māori' => __('Māori'),
            ];

			$tabs['Local Contexts'] = $view->partial('lc-item-edit.phtml', [
	            'item' => $item,
                'lc_content' => $contentArray,
                'element_data' => $elementData,
                'language_data' => $languageData,
	        ]);
        }

        return $tabs;
    }

    /**
     * LocalContexts admin_navigation_main filter.
     *
     * Adds a button to the admin's main navigation.
     *
     * @param array $nav
     * @return array
     */
    public function filterAdminNavigationMain($nav)
    {
        $nav[] = array(
            'label' => __('Local Contexts'),
            'uri' => url('local-contexts'),
        );
        return $nav;
    }

    /**
     * Register an exhibit layout for displaying Local Contexts content.
     *
     * @param array $layouts Exhibit layout specs.
     * @return array
     */
    public function filterExhibitLayouts($layouts)
    {
        $layouts['local-contexts'] = array(
            'name' => __('Local Contexts'),
            'description' => __('Embed Local Contexts content.')
        );
        return $layouts;
    }

    public function lcContentAddToElement($item, $post)
    {
        $lcContentArray = isset($post['lc-content']) ? $post['lc-content'] : [];
        $lcLanguage = isset($post['lc_content_language']) ? $post['lc_content_language'] : '';

        $lcElementValueArray = [];
        if ($lcContentArray) {
            $elementID = $post['lc_content_element'];
            $element = get_db()->getTable('Element')->find($elementID);
            $elementSet = get_db()->getTable('ElementSet')->find($element->element_set_id);
            foreach ($lcContentArray as $project) {
                $project = json_decode($project, true);

                foreach($project as $key => $content) {
                    $lcElementArray = [];
                    if (is_int($key)) {
                        // Only print content in selected language. If 'English' or 'All',
                        // print everything (since English doesn't have language element)
                        if ((isset($content['language']) && $content['language'] == $lcLanguage)
                        || (!isset($content['language']) && $lcLanguage == 'English')
                        || $lcLanguage == 'All') {
                            $lcElementArray[] = $content;
                        }
                        if (!empty($lcElementArray)) {
                            if (isset($project['project_title']) && isset($project['project_url'])) {
                                $lcElementArray['project_title'] = $project['project_title'];
                                $lcElementArray['project_url'] = $project['project_url'];
                            }
                            $lcElementValue = self::renderLCNoticeHtml($lcElementArray, $projectKey = $key, true, true);
                            $lcElementValueArray[] = ['text' => $lcElementValue, 'html' => true];
                        }
                    }
                }
            }

            $elementTexts = array(
                $elementSet->name => array(
                    $element->name => $lcElementValueArray
                )
            );

            $item->addElementTextsByArray($elementTexts);

        } else {
            // Do nothing if no lc content selected
            return;
        }
    }

    public static function renderLCNoticeHtml($project, $projectKey, $isPublic = false, $collapse = false) {
        $view = get_view();

        $projectTitle = isset($project['project_title']) ? $project['project_title'] : "Project";
        $projectUrl = isset($project['project_url']) ? rtrim($project['project_url'], "/") . '/' : '';

        $image_urls = array_unique(array_column($project, 'image_url'));

        // Save each project's content as single select value
        // Only show one image per shared notice group
        $projectByImage = [];
        foreach ($image_urls as $url) {
            // Build new array arranged by notice image url
            $noticeByImage = array_filter($project, function($child) use($url) {
                if (is_array($child)) { return $child['image_url'] == $url; }
            });
            $projectByImage[$url] = $noticeByImage;
        }

        if ($isPublic) {
            return $view->partial('lc-project-public.phtml', [
                'projectTitle' => $projectTitle,
                'projectUrl' => $projectUrl,
                'projectByImage' => $projectByImage,
            ]);
        } else if ($collapse) {
            $collapseHtml = $view->partial('lc-project-collapse.phtml', [
                'project' => $project,
                'projectTitle' => $projectTitle,
                'projectUrl' => $projectUrl,
                'projectKey' => $projectKey,
                'projectByImage' => $projectByImage,
            ]);
            return $collapseHtml;
        } else {
            return $view->partial('lc-project-admin.phtml', [
                'project' => $project,
                'projectTitle' => $projectTitle,
                'projectUrl' => $projectUrl,
                'projectKey' => $projectKey,
                'projectByImage' => $projectByImage,
            ]);
        }
    }
}