Download raw (7.2 KB)

<?php

namespace Grav\Plugin;

use Grav\Common\Plugin;
use Grav\Common\Grav;
use Grav\Common\Page\Page;
use Grav\Common\Page\Collection;
use Grav\Common\Filesystem\Folder;
use RocketTheme\Toolbox\Event\Event;

/**
 * Class SimpleEventsPlugin
 * @package Grav\Plugin
 */
class SimpleEventsPlugin extends Plugin
{
    /**
     * @return array
     *
     * The getSubscribedEvents() gives the core a list of events
     *     that the plugin wants to listen to. The key of each
     *     array section is the event that the plugin listens to
     *     and the value (in the form of an array) contains the
     *     callable (or function) as well as the priority. The
     *     higher the number the higher the priority.
     */
    public static function getSubscribedEvents()
    {
        return [
            'onPluginsInitialized' => ['onPluginsInitialized', 0],
        ];
    }

    /**
     * Initialize the plugin
     */
    public function onPluginsInitialized()
    {
        if ($this->isAdmin()) {
            $this->enable([
                'onGetPageTemplates'    => ['onGetPageTemplates', 0],
                'onGetPageBlueprints'   => ['onGetPageBlueprints', 0],
                'onAdminSave'           => ['onAdminSave', 0],
            ]);
            return;
        }

        $this->enable([
            'onBuildPagesInitialized' => ['onBuildPagesInitialized', 0],
            'onTwigInitialized'       => ['onTwigInitialized', 0],
            'onTwigTemplatePaths'     => ['onTwigTemplatePaths', 0],
        ]);
    }

    /**
     * Add templates directory to page templates.
     */
    public function onGetPageTemplates(Event $event)
    {
        $types = $event->types;
        $types->scanTemplates('plugin://' . $this->name . '/templates');
    }

    /**
     * Add blueprint directory to page blueprints.
     */
    public function onGetPageBlueprints(Event $event)
    {
        $types = $event->types;
        $types->scanBlueprints('plugin://' . $this->name . '/blueprints');
    }

    public function onAdminSave(Event $event) {
        if (! $event['object'] instanceof Page || $event['object']->template() !== 'events') {
            return;
        }

        $page = $event['object'];
        $header = $page->header();
        $orderBy = $header->content['order']['by'];
        $orderDir= $header->content['order']['dir'];

        $header->content = [
            'items' => '@self.children',
            'order' => [
                'by' => $orderBy,
                'dir' => $orderDir,
            ],
            'filter' => [
                'published' => true,
                'type' => 'event',
            ],
        ];
    }
    /**
     * Add templates to twig paths.
     */
    public function onTwigTemplatePaths()
    {
        $this->grav['twig']->twig_paths[] = __DIR__ . '/templates';
    }

    /**
     * Register the new Twig filter.
     */
    public function onTwigInitialized(Event $e)
    {
        $this->grav['twig']->twig()->addFilter(
            new \Twig_SimpleFilter('linked', [$this, 'linkIt'])
        );
        $this->grav['twig']->twig()->addFunction(
            new \Twig_SimpleFunction('linkit', [$this, 'linkIt'])
        );
        $this->grav['twig']->twig()->addFilter(
            new \Twig_SimpleFilter('filterEvents', [$this, 'filterEvents'])
        );
    }

    /**
     * Turn part of a string in [] into a link.
     */
    public function linkIt($string, $url)
    {
        if ($url) {
            if (substr($url, 0, 4) == "http") {
                $addr = $url;
            } else {
                $addr = $this->grav['base_url'] . '/' . $url;
            }
            if (preg_match('/(.*)\[(.*)\](.*)/', $string, $matches)) {
                $linked = $matches[1] . '<a href="' . $addr . '">' . $matches[2] . '</a>' . $matches[3];
            } else {
                $linked = '<a href="' . $addr . '">' . $string . '</a>';
            }
            return $linked;
        } else {
            return $string;
        }
    }

    public function filterEvents(Collection $collection, string $filterRegion)
    {
        $collection->filter(function ($slug, $path) use ($collection, $filterRegion) {
            $event = $collection[$path];
            $header = (array) $event->header();

            if ($event && !empty($header['simple-events']['region'])) {
                return $filterRegion === $header['simple-events']['region'];
            } else {
                return false;
            }
        });

        return $collection;
    }

    /** Fired when Grav needs to refresh/build the cache */
    public function onBuildPagesInitialized()
    {
        $this->enable([
            'onPagesInitialized' => ['onPagesInitialized', 0],
        ]);
    }

    /** Cleanup up expired events when page collection has been build and restructure frontmatter */
    public function onPagesInitialized(Event $event)
    {
        $pages = $event['pages'];
        $events = $pages->all()->ofType('event')->order('header.simple-events.start');

        foreach ($events as $event) {
            // Header must be copied before any other operation
            $header = (array) $event->header();

            // check header structure
            if (!isset($header['simple-events'])) {
              if (isset($header['start'])) {
                $header['simple-events']['start'] = $header['start'];
                unset($header['start']);
              }
              if (isset($header['end'])) {
                $header['simple-events']['end'] = $header['end'];
                unset($header['end']);
              }
              if (isset($header['link'])) {
                $header['simple-events']['link'] = $header['link'];
                unset($header['link']);
              }
              if (isset($header['region'])) {
                $header['simple-events']['region'] = $header['region'];
                unset($header['region']);
              }
            }
            $event->header($header);
            $event->save();

            $header = (array) $event->header();
            $config = $this->mergeConfig($event);
            $unpublishDay = $config->get('unpublish_day') ?? 'start';
            $endTime = $config->get($unpublishDay) ?? $config->get('start');

            if (is_int($endTime)) {
                $endTime = date('Y-m-d', $endTime);
            } else {
                $tmp = strtotime($endTime);
                $endTime = date('Y-m-d', $tmp);
            }

            if (!empty($config->get('unpublish_time'))) {
                $endTime = $endTime . ' ' . $config->get('unpublish_time');
            }

            if (!isset($header['unpublish_date']) || $header['unpublish_date'] !== $endTime) {
                $header['unpublish_date'] = $endTime;
                $event->header($header);
                $event->published(new \DateTime('now') <= new \DateTime($endTime));
                $event->save();
            }
        }

        // clear out past events
        if ($this->config->get('plugins.simple-events.delete_old') === true) {
            $nonPublishedEvents = $pages->all()->ofType('event')->nonPublished();

            foreach ($nonPublishedEvents as $event) {
                // Event will be deleted for all languages !!
                Folder::delete($event->path());
            }
        }
    }
}