class.ilPDExternalFeedBlockGUI.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

include_once("./Services/Block/classes/class.ilBlockGUI.php");
include_once("./Services/Block/classes/class.ilExternalFeedBlockGUIGen.php");
include_once("./Services/Feeds/classes/class.ilExternalFeed.php");

class ilPDExternalFeedBlockGUI extends ilExternalFeedBlockGUIGen
{
        static $block_type = "pdfeed";
        
        function __construct()
        {
                global $ilCtrl, $lng;
                
                parent::__construct();
                
                $lng->loadLanguageModule("feed");
                
                $this->setLimit(5);
                $this->setRowTemplate("tpl.block_external_feed_row.html", "Services/Feeds");
        }
                
        static function getBlockType()
        {
                return self::$block_type;
        }

        static function isRepositoryObject()
        {
                return false;
        }
        
        static function getScreenMode()
        {
                global $ilCtrl;
                
                switch($ilCtrl->getCmd())
                {
                        case "create":
                        case "edit":
                        case "saveFeedBlock":
                        case "updateFeedBlock":
                        case "editFeedBlock":
                        case "showFeedItem":
                        case "confirmDeleteFeedBlock":
                                return IL_SCREEN_CENTER;
                                break;
                                
                        default:
                                return IL_SCREEN_SIDE;
                                break;
                }
        }

        function setBlock($a_block)
        {
                global $ilCtrl;

                // init block
                $this->feed_block = $a_block;
                $this->setTitle($this->feed_block->getTitle());
                $this->setBlockId($this->feed_block->getId());
                
                // get feed object
                include_once("./Services/Feeds/classes/class.ilExternalFeed.php");
                $this->feed = new ilExternalFeed();
                $this->feed->setUrl($this->feed_block->getFeedUrl());
                
                // init details
                $this->setAvailableDetailLevels(2);
                
                $ilCtrl->setParameter($this, "block_id", $this->feed_block->getId());
        }

        function executeCommand()
        {
                global $ilCtrl;

                $next_class = $ilCtrl->getNextClass();
                $cmd = $ilCtrl->getCmd("getHTML");

                switch ($next_class)
                {
                        default:
                                return $this->$cmd();
                }
        }

        function fillDataSection()
        {
                if ($this->getDynamic())
                {
                        $this->setDataSection($this->getDynamicReload());
                }
                else if ($this->getCurrentDetailLevel() > 1 && count($this->getData()) > 0)
                {
                        parent::fillDataSection();
                }
                else
                {
                        $this->setDataSection($this->getOverview());
                }
        }

        function getHTML()
        {
                global $ilCtrl, $lng, $ilUser, $ilAccess, $ilSetting;
                
                $feed_set = new ilSetting("feed");
                
                if ($ilSetting->get("block_limit_pdfeed") == 0)
                {
                        return "";
                }

                if ($this->getCurrentDetailLevel() == 0)
                {
                        return "";
                }

                
                // if no dynamic reload
                if (!$this->getDynamic())
                {
                        $this->feed->fetch();
                        $this->setData($this->feed->getItems());
                }

                $ilCtrl->setParameter($this, "external_feed_block_id",
                        $this->getBlockId());
                $this->addBlockCommand(
                        $ilCtrl->getLinkTarget($this,
                                "editFeedBlock"),
                        $lng->txt("edit"));
                $this->addBlockCommand(
                        $ilCtrl->getLinkTarget($this,
                                "confirmDeleteFeedBlock"),
                        $lng->txt("delete"));
                $ilCtrl->setParameter($this, "external_feed_block_id", "");

                // JS enabler
                $add = "";
                if ($_SESSION["il_feed_js"] == "n" ||
                        ($ilUser->getPref("il_feed_js") == "n" && $_SESSION["il_feed_js"] != "y"))
                {
                        $add = $this->getJSEnabler();
                }
                
                return parent::getHTML().$add;
        }
        
        function getDynamic()
        {
                global $ilCtrl, $ilUser;
                
                if ($ilCtrl->getCmdClass() != "ilcolumngui" && $ilCtrl->getCmd() != "enableJS")
                {
                        $sess_feed_js = "";
                        if (isset($_SESSION["il_feed_js"]))
                        {
                                $sess_feed_js = $_SESSION["il_feed_js"];
                        } 
                        if ($sess_feed_js != "n" &&
                                ($ilUser->getPref("il_feed_js") != "n" || $sess_feed_js == "y"))
                        {
                                // do not get feed dynamically, if cache hit is given.
                                if (!$this->feed->checkCacheHit())
                                {
                                        return true;
                                }
                        }
                }
                
                return false;
        }

        function getDynamicReload()
        {
                global $ilCtrl, $lng;
                
                $ilCtrl->setParameterByClass("ilcolumngui", "block_id",
                        "block_pdfeed_".$this->getBlockId());

                $rel_tpl = new ilTemplate("tpl.dynamic_reload.html", true, true, "Services/Feeds");
                $rel_tpl->setVariable("TXT_LOADING", $lng->txt("feed_loading_feed"));
                $rel_tpl->setVariable("BLOCK_ID", "block_pdfeed_".$this->getBlockId());
                $rel_tpl->setVariable("TARGET", 
                        $ilCtrl->getLinkTargetByClass("ilcolumngui", "updateBlock", "", true));
                        
                // no JS
                $rel_tpl->setVariable("TXT_FEED_CLICK_HERE", $lng->txt("feed_no_js_click_here"));
                $rel_tpl->setVariable("TARGET_NO_JS", 
                        $ilCtrl->getLinkTargetByClass("ilpdexternalfeedblockgui", "disableJS"));

                return $rel_tpl->get();
        }
        
        function getJSEnabler()
        {
                global $ilCtrl, $lng;
                
                $ilCtrl->setParameterByClass("ilcolumngui", "block_id",
                        "block_pdfeed_".$this->getBlockId());

                $rel_tpl = new ilTemplate("tpl.js_enabler.html", true, true, "Services/Feeds");
                $rel_tpl->setVariable("BLOCK_ID", "block_pdfeed_".$this->getBlockId());
                $rel_tpl->setVariable("TARGET", 
                        $ilCtrl->getLinkTargetByClass("ilpdexternalfeedblockgui", "enableJS", true));
                        
                return $rel_tpl->get();
        }
        
        
        function disableJS()
        {
                global $ilCtrl, $ilUser;
                
                $_SESSION["il_feed_js"] = "n";
                $ilUser->writePref("il_feed_js", "n");
                $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
        }
        
        function enableJS()
        {
                global $ilUser;
                
                $_SESSION["il_feed_js"] = "y";
                $ilUser->writePref("il_feed_js", "y");
                echo $this->getHTML();
                exit;
        }
        
        function fillRow($item)
        {
                global $ilUser, $ilCtrl, $lng;

                $ilCtrl->setParameter($this, "feed_item_id", $item->getId());
                $this->tpl->setVariable("VAL_TITLE", $item->getTitle());
                $this->tpl->setVariable("HREF_SHOW",
                        $ilCtrl->getLinkTarget($this, "showFeedItem"));
                $ilCtrl->setParameter($this, "feed_item_id", "");
        }

        function getOverview()
        {
                global $ilUser, $lng, $ilCtrl;
                
                $this->setEnableNumInfo(false);
                return '<div class="small">'.((int) count($this->getData()))." ".$lng->txt("feed_feed_items")."</div>";
        }

        function showFeedItem()
        {
                global $lng, $ilCtrl;
                
                include_once("./Services/News/classes/class.ilNewsItem.php");

                $this->feed->fetch();
                foreach($this->feed->getItems() as $item)
                {
                        if ($item->getId() == $_GET["feed_item_id"])
                        {
                                $c_item = $item;
                                break;
                        }
                }
                
                $tpl = new ilTemplate("tpl.show_feed_item.html", true, true, "Services/Feeds");
                
                if (is_object($c_item))
                {
                        if (trim($c_item->getSummary()) != "")          // summary
                        {
                                $tpl->setCurrentBlock("content");
                                $tpl->setVariable("VAL_CONTENT", $c_item->getSummary());
                                $tpl->parseCurrentBlock();
                        }
                        if (trim($c_item->getDate()) != "" || trim($c_item->getAuthor()) != "")         // date
                        {
                                $tpl->setCurrentBlock("date_author");
                                if (trim($c_item->getAuthor()) != "")
                                {
                                        $tpl->setVariable("VAL_AUTHOR", $c_item->getAuthor()." - ");
                                }
                                $tpl->setVariable("VAL_DATE", $c_item->getDate());
                                $tpl->parseCurrentBlock();
                        }

                        if (trim($c_item->getLink()) != "")             // link
                        {
                                $tpl->setCurrentBlock("plink");
                                $tpl->setVariable("HREF_LINK", $c_item->getLink());
                                $tpl->setVariable("TXT_LINK", $lng->txt("feed_open_source_page"));
                                $tpl->parseCurrentBlock();
                        }
                        $tpl->setVariable("VAL_TITLE", $c_item->getTitle());                    // title
                }
                
                include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
                $content_block = new ilPDContentBlockGUI();
                $content_block->setContent($tpl->get());
                $content_block->setTitle($this->getTitle());
                $content_block->setImage(ilUtil::getImagePath("icon_feed.svg"));
                $content_block->addHeaderCommand($ilCtrl->getParentReturn($this),
                        $lng->txt("selected_items_back"));

                return $content_block->getHTML();
        }
        
        function create()
        {
                return $this->createFeedBlock();
        }

        public function initFormFeedBlock($a_mode)
        {
                global $lng;
                
                $lng->loadLanguageModule("block");
                
                require_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                
                $this->form_gui = new ilPropertyFormGUI();
                
                // Property Title
                $text_input = new ilTextInputGUI($lng->txt("block_feed_block_title"), "block_title");
                $text_input->setInfo("");
                $text_input->setRequired(true);
                $text_input->setMaxLength(200);
                $this->form_gui->addItem($text_input);
                
                // Property FeedUrl
                $text_input = new ilFeedUrlInputGUI($lng->txt("block_feed_block_feed_url"), "block_feed_url");
                $text_input->setInfo($lng->txt("block_feed_block_feed_url_info"));
                $text_input->setRequired(true);
                $text_input->setMaxLength(250);
                $this->form_gui->addItem($text_input);
                
                
                // save and cancel commands
                if (in_array($a_mode, array(IL_FORM_CREATE,IL_FORM_RE_CREATE)))
                {
                        $this->form_gui->addCommandButton("saveFeedBlock", $lng->txt("save"));
                        $this->form_gui->addCommandButton("cancelSaveFeedBlock", $lng->txt("cancel"));
                }
                else
                {
                        $this->form_gui->addCommandButton("updateFeedBlock", $lng->txt("save"));
                        $this->form_gui->addCommandButton("cancelUpdateFeedBlock", $lng->txt("cancel"));
                }
                
                $this->form_gui->setTitle($lng->txt("block_feed_block_head"));
                $this->form_gui->setFormAction($this->ctrl->getFormAction($this));
                
                $this->prepareFormFeedBlock($this->form_gui);

        }

        public function prepareSaveFeedBlock(&$a_feed_block)
        {
                global $ilCtrl;
                
                $a_feed_block->setContextObjId($ilCtrl->getContextObjId());
                $a_feed_block->setContextObjType($ilCtrl->getContextObjType());
                $a_feed_block->setType("pdfeed");
        }

        function confirmDeleteFeedBlock()
        {
                global $ilCtrl, $lng;
                
                include_once("Services/Utilities/classes/class.ilConfirmationGUI.php");
                $c_gui = new ilConfirmationGUI();
                
                // set confirm/cancel commands
                $c_gui->setFormAction($ilCtrl->getFormAction($this, "deleteFeedBlock"));
                $c_gui->setHeaderText($lng->txt("info_delete_sure"));
                $c_gui->setCancel($lng->txt("cancel"), "exitDeleteFeedBlock");
                $c_gui->setConfirm($lng->txt("confirm"), "deleteFeedBlock");

                // add items to delete
                $c_gui->addItem("external_feed_block_id",
                        $this->feed_block->getId(), $this->feed_block->getTitle(),
                        ilUtil::getImagePath("icon_feed.svg"));
                
                return $c_gui->getHTML();
        }
        
        function exitDeleteFeedBlock()
        {
                global $ilCtrl;

                $ilCtrl->returnToParent($this);
        }

        function deleteFeedBlock()
        {
                global $ilCtrl;

                $this->feed_block->delete();
                $ilCtrl->returnToParent($this);
        }
}

?>