first commit

lib/pkp/pages/announcement/AnnouncementHandler.php

@@ -0,0 +1,115 @@
+<?php
+
+/**
+ * @file pages/announcement/AnnouncementHandler.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class AnnouncementHandler
+ *
+ * @ingroup pages_announcement
+ *
+ * @brief Handle requests for public announcement functions.
+ */
+
+namespace PKP\pages\announcement;
+
+use APP\core\Application;
+use APP\core\Request;
+use APP\facades\Repo;
+use APP\handler\Handler;
+use APP\template\TemplateManager;
+use PKP\announcement\Collector;
+use PKP\config\Config;
+use PKP\core\PKPRequest;
+use PKP\security\authorization\ContextRequiredPolicy;
+
+class AnnouncementHandler extends Handler
+{
+    //
+    // Public handler methods.
+    //
+    /**
+     * Show public announcements page.
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     */
+    public function index($args, $request)
+    {
+        if (!$this->isAnnouncementsEnabled($request)) {
+            $request->getDispatcher()->handle404();
+        }
+
+        $this->setupTemplate($request);
+
+        $templateMgr = TemplateManager::getManager($request);
+        $templateMgr->assign('announcementsIntroduction', $this->getAnnouncementsIntro($request));
+
+        // TODO the announcements list should support pagination
+        $collector = Repo::announcement()
+            ->getCollector()
+            ->filterByActive();
+
+        if ($request->getContext()) {
+            $collector->filterByContextIds([$request->getContext()->getId()]);
+        } else {
+            $collector->withSiteAnnouncements(Collector::SITE_ONLY);
+        }
+
+        $announcements = $collector->getMany();
+
+        $templateMgr->assign('announcements', $announcements->toArray());
+        $templateMgr->display('frontend/pages/announcements.tpl');
+    }
+
+    /**
+     * View announcement details.
+     *
+     * @param array $args first parameter is the ID of the announcement to display
+     * @param PKPRequest $request
+     */
+    public function view($args, $request)
+    {
+        if (!$this->isAnnouncementsEnabled($request)) {
+            $request->getDispatcher()->handle404();
+        }
+        $this->validate();
+        $this->setupTemplate($request);
+
+        $announcementId = (int) array_shift($args);
+        $announcement = Repo::announcement()->get($announcementId);
+        if (
+            $announcement
+            && $announcement->getAssocType() == Application::getContextAssocType()
+            && $announcement->getAssocId() == $request->getContext()?->getId()
+            && (
+                $announcement->getDateExpire() == null || strtotime($announcement->getDateExpire()) > time()
+            )
+        ) {
+            $templateMgr = TemplateManager::getManager($request);
+            $templateMgr->assign('announcement', $announcement);
+            $templateMgr->assign('announcementTitle', $announcement->getLocalizedTitleFull());
+            return $templateMgr->display('frontend/pages/announcement.tpl');
+        }
+        $request->redirect(null, 'announcement');
+    }
+
+    protected function isAnnouncementsEnabled(Request $request): bool
+    {
+        if (!Config::getVar('features', 'site_announcements') && !$request->getContext()) {
+            return false;
+        }
+
+        $contextOrSite = $request->getContext() ?? $request->getSite();
+        return $contextOrSite->getData('enableAnnouncements');
+    }
+
+    protected function getAnnouncementsIntro(Request $request): ?string
+    {
+        $contextOrSite = $request->getContext() ?? $request->getSite();
+        return $contextOrSite->getLocalizedData('announcementsIntroduction');
+    }
+}