vendor/fritzmg/contao-sharebuttons/system/modules/sharebuttons/classes/ShareButtons.php line 36

Open in your IDE?
  1. <?php
  3. /**
  4.  * Contao Open Source CMS
  5.  *
  6.  * simple extension to provide a share buttons module
  7.  * 
  8.  * @copyright inspiredminds 2015-2019
  9.  * @package   sharebuttons
  10.  * @link      http://www.inspiredminds.at
  11.  * @author    Fritz Michael Gschwantner <fmg@inspiredminds.at>
  12.  * @license   LGPL-3.0-or-later
  13.  */
  15. use Contao\ArticleModel;
  16. use Contao\CalendarModel;
  17. use Contao\ContentModel;
  18. use Contao\Controller;
  19. use Contao\DataContainer;
  20. use Contao\Environment;
  21. use Contao\FrontendTemplate;
  22. use Contao\Input;
  23. use Contao\Model;
  24. use Contao\Module;
  25. use Contao\ModuleNews;
  26. use Contao\NewsArchiveModel;
  27. use Contao\StringUtil;
  28. use Contao\System;
  29. use Contao\Template;
  31. class ShareButtons
  32. {
  33.     const DEFAULT_THEME = '';
  34.     const DEFAULT_TEMPLATE = 'sharebuttons_default';
  36.     public static function createShareButtons($networks, $theme = self::DEFAULT_THEME, $template = self::DEFAULT_TEMPLATE, $url = null, $title = null, $description = null, $image = null, $articleId = null)
  37.     {
  38.         // access to page
  39.         global $objPage;
  41.         if (!$objPage) {
  42.             return '';
  43.         }
  45.         // try to deserialize
  46.         if( is_string( $networks ) )
  47.             $networks = StringUtil::deserialize( $networks );
  49.         $networks = array_intersect($networks, array_keys($GLOBALS['sharebuttons']['networks']));
  51.         // if there are no networks, don't do anything
  52.         if( !is_array( $networks ) || count( $networks ) == 0 )
  53.             return '';
  55.         // process theme
  56.         if( $theme == 'sharebuttons_none' || $theme == 'none' || !in_array( $theme, array_keys( $GLOBALS['sharebuttons']['themes'] ) ) )
  57.             $theme = '';
  59.         // force theme to fontawesome if fontawesome template is used
  60.         if( stripos( $template, 'fontawesome' ) !== false && $theme !== '' && $theme !== 'text' )
  61.             $theme = 'fontawesome';
  62.         // force template to fontawesome if fontawesome theme is used
  63.         elseif( $theme == 'fontawesome' )
  64.             $template = 'sharebuttons_fontawesome';
  66.         // check for empty template
  67.         if( !$template )
  68.             $template = self::DEFAULT_TEMPLATE;
  70.         // create share buttons template
  71.         $objButtonsTemplate = new FrontendTemplate( $template );
  73.         // assign enabled networks to template
  74.         $objButtonsTemplate->networks = $networks;
  76.         // determine the share image (e.g. for pinterest)
  77.         if( !$image && isset( $GLOBALS['SOCIAL_IMAGES'] ) && is_array( $GLOBALS['SOCIAL_IMAGES'] ) && count( $GLOBALS['SOCIAL_IMAGES'] ) > 0 )
  78.             $image = Environment::get('base') . $GLOBALS['SOCIAL_IMAGES'][0];
  80.         // process url
  81.         if( $url && stripos( $url, 'http' ) !== 0 )
  82.             $url = Environment::get('base') . $url;
  84.         // assign url, title, theme, image, description to template
  85.         $objButtonsTemplate->url         = rawurlencode( $url ?: Environment::get('base') . Environment::get('request') );
  86.         $objButtonsTemplate->title       = rawurlencode( strip_tags( $title ?: ( $objPage->pageTitle ?: $objPage->title ) ) );
  87.         $objButtonsTemplate->theme       = $theme;
  88.         $objButtonsTemplate->image       = rawurlencode( $image );
  89.         $objButtonsTemplate->description = rawurlencode( strip_tags( $description ?: $objPage->description ) );
  91.         // add translations to template
  92.         $translations = $GLOBALS['TL_LANG']['sharebuttons'];
  93.         $translations['mail_subject'] = rawurlencode( $translations['mail_subject'] );
  94.         $objButtonsTemplate->lang = $translations;
  96.         // add PDF link
  97.         if (\in_array('pdf', $networks)) {
  98.             $objArticle = $articleId ? ArticleModel::findById($articleId) : ArticleModel::findPublishedByPidAndColumn($objPage->id, 'main');
  100.             if (null !== $objArticle) {
  101.                 $request = Environment::get('indexFreeRequest');
  102.                 $objButtonsTemplate->pdfLink = $request . ((strpos($request, '?') !== false) ? '&amp;' : '?') . 'pdf=' . $objArticle->id;
  103.             }
  104.         }
  106.         // insert CSS if necessary
  107.         if( $theme )
  108.         {
  109.             $GLOBALS['TL_CSS'][] ='system/modules/sharebuttons/assets/base.css||static';
  110.             $css_theme = $GLOBALS['sharebuttons']['themes'][ $theme ][1];
  112.             if (defined('TL_ROOT')) {
  113.                 $projectDir = constant('TL_ROOT');
  114.             } else {
  115.                 $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  116.             }
  118.             if( is_file( $projectDir . '/' . $css_theme ) )
  119.                 $GLOBALS['TL_CSS'][] = $css_theme.'||static';
  120.         }
  122.         // insert javascript
  123.         $GLOBALS['TL_JAVASCRIPT'][] = 'system/modules/sharebuttons/assets/scripts.js|async';
  125.         // return parsed template
  126.         return $objButtonsTemplate->parse();
  127.     }
  129.     public static function createInsertTag($networks, $theme = '', $template = '', $articleId = null)
  130.     {
  131.         // try to deserialize
  132.         if (is_string($networks)) {
  133.             $networks = StringUtil::deserialize($networks, true);
  134.         }
  136.         $networks = array_intersect($networks, array_keys($GLOBALS['sharebuttons']['networks']));
  138.         // check for networks
  139.         if (!\is_array($networks) || count($networks) === 0) {
  140.             return '';
  141.         }
  143.         $elements = [];
  145.         if ($theme) {
  146.             $elements[] = $theme;
  147.         }
  149.         if ($template) {
  150.             $elements[] = $template;
  151.         }
  153.         $elements[] = implode(':', $networks);
  155.         if ($articleId) {
  156.             $elements[] = $articleId;
  157.         }
  159.         // build insert tag
  160.         $strInsertTag = '{{sharebuttons::' . implode('::', $elements) . '}}';
  162.         // return insert tag
  163.         return $strInsertTag;
  164.     }
  167.     /**
  168.      * parseArticles hook for news
  169.      *
  170.      * @param \Template $objTemplate
  171.      * @param array $arrData
  172.      * @param \Module $objModule
  173.      * 
  174.      * @return void
  175.      */
  176.     public function parseArticles(Template $objTemplate, $arrData, Module $objModule)
  177.     {
  178.         // check for news module
  179.         if(!$objModule instanceof ModuleNews)
  180.         {
  181.             return;
  182.         }
  184.         // get the news archive
  185.         $objArchive = NewsArchiveModel::findById($arrData['pid']);
  187.         // get the networks for the archive
  188.         $arrNetworks = StringUtil::deserialize($objArchive->sharebuttons_networks, true); 
  190.         // prepare sharebuttons string
  191.         $strSharebuttons = '';
  193.         // check if there are any networks
  194.         if (count($arrNetworks) > 0)
  195.         {
  196.             // set data
  197.             $theme       = $objArchive->sharebuttons_theme;
  198.             $template    = $objArchive->sharebuttons_template;
  199.             $url         = $objTemplate->link;
  200.             $title       = $arrData['headline'];
  201.             $description = $arrData['teaser'];
  202.             $image       = ($objTemplate->addImage && $objTemplate->singleSRC) ? Environment::get('base') . $objTemplate->singleSRC : null;
  204.             // create the share buttons
  205.             $strSharebuttons = self::createShareButtons($arrNetworks, $theme, $template, $url, $title, $description, $image);
  206.         }
  208.         // set sharebuttons string
  209.         $objTemplate->sharebuttons = $strSharebuttons;
  210.     }
  213.     /**
  214.      * parseTemplate hook for articles and events
  215.      *
  216.      * @param \Template $objTempalte
  217.      */
  218.     public function parseTemplate( Template $objTemplate )
  219.     {
  220.         // check for mod_article template
  221.         if( stripos( $objTemplate->getName(), 'mod_article' ) !== false )
  222.         {
  223.             // prepare sharebuttons string
  224.             $strSharebuttons = '';
  226.             // get the networks
  227.             $arrNetworks = StringUtil::deserialize( $objTemplate->sharebuttons_networks );
  229.             // check if there are any networks
  230.             if( $arrNetworks )
  231.             {
  232.                 // set data
  233.                 $networks    = $arrNetworks;
  234.                 $theme       = $objTemplate->sharebuttons_theme;
  235.                 $template    = $objTemplate->sharebuttons_template;
  236.                 $url         = $objTemplate->href;
  237.                 $title       = $objTemplate->title;
  238.                 $description = $objTemplate->teaser;
  240.                 // create the share buttons
  241.                 $strSharebuttons = self::createShareButtons($networks, $theme, $template, $url, $title, $description, null, $objTemplate->id);                
  242.             }
  244.             // set sharebuttons variable
  245.             $objTemplate->sharebuttons = $strSharebuttons;
  246.         }
  247.         // check for event template
  248.         elseif( stripos( $objTemplate->getName(), 'event_' ) === 0 )
  249.         {
  250.             // prepare sharebuttons string
  251.             $strSharebuttons = '';
  253.             // get the calendar
  254.             if( ( $objCalendar = CalendarModel::findById( $objTemplate->pid ) ) !== null )
  255.             {
  256.                 // get the networks
  257.                 $arrNetworks = StringUtil::deserialize( $objCalendar->sharebuttons_networks );
  259.                 // check if there are any networks
  260.                 if( $arrNetworks )
  261.                 {
  262.                     // set data
  263.                     $networks    = $arrNetworks;
  264.                     $theme       = $objCalendar->sharebuttons_theme;
  265.                     $template    = $objCalendar->sharebuttons_template;
  266.                     $url         = $objTemplate->href;
  267.                     $title       = $objTemplate->title;
  268.                     $description = $objTemplate->teaser;
  269.                     $image       = $objTemplate->singleSRC;
  271.                     // create the share buttons
  272.                     $strSharebuttons = self::createShareButtons( $networks, $theme, $template, $url, $title, $description, $image );                
  273.                 }
  275.             }
  277.             // set sharebuttons variable
  278.             $objTemplate->sharebuttons = $strSharebuttons;            
  279.         }
  280.     }
  283.     /**
  284.      * replaceInsertTag hook
  285.      *
  286.      * @param string $strTag
  287.      * @param bool $blnCache
  288.      *
  289.      * @return string
  290.      */
  291.     public function replaceInsertTag( $strTag, $blnCache = false )
  292.     {
  293.         // split tag
  294.         $arrTag = explode( '::', $strTag );
  296.         // check for share button tag
  297.         if( $arrTag[0] !== 'sharebuttons' )
  298.             return false;
  299.         else
  300.             array_shift( $arrTag );
  302.         // determine theme, networks and template
  303.         $networks = array();
  304.         $theme = self::DEFAULT_THEME;
  305.         $template = self::DEFAULT_TEMPLATE;
  306.         $articleId = null;
  308.         // go through each parameter
  309.         while (count($arrTag) > 0) {
  310.             // get the parameter
  311.             $strParam = array_shift($arrTag);
  313.             // check for theme
  314.             if (in_array($strParam, array_keys($GLOBALS['sharebuttons']['themes']))) {
  315.                 $theme = $strParam;
  316.                 continue;
  317.             }
  319.             // check for template
  320.             if (strpos($strParam, 'sharebuttons_') !== false) {
  321.                 $template = $strParam;
  322.                 continue;
  323.             }
  325.             // check for article id
  326.             if (is_numeric($strParam)) {
  327.                 $articleId = (int) $strParam;
  328.             }
  330.             // check for networks
  331.             if (count($networks) == 0) {
  332.                 $networks = array_intersect(explode(':', $strParam ), array_keys($GLOBALS['sharebuttons']['networks']));
  333.             }
  334.         }
  336.         // create sharebuttons
  337.         return self::createShareButtons($networks, $theme, $template, null, null, null, null, $articleId);
  338.     }
  341.     /**
  342.      * This dynamically allows PDF printing by checking whether a "pdf" share 
  343.      * network is enabled for the article itself or one of its content elements.
  344.      * 
  345.      * @param Model $objElement
  346.      * @param bool $blnReturn
  347.      *
  348.      * @return bool
  349.      */
  350.     public function isVisibleElement(Model $objElement, bool $blnReturn): bool
  351.     {
  352.         if (!$objElement instanceof ArticleModel) {
  353.             return $blnReturn;
  354.         }
  356.         $articleId = Input::get('pdf');
  358.         if (null === $articleId || (int) $objElement->id !== (int) $articleId) {
  359.             return $blnReturn;
  360.         }
  362.         $printable = $objElement->printable;
  364.         if ((int) $printable === 1) {
  365.             return $blnReturn;
  366.         }
  368.         $options = StringUtil::deserialize($printable, true);
  370.         if (\in_array('pdf', $options)) {
  371.             return $blnReturn;
  372.         }
  374.         $articleNetworks = StringUtil::deserialize($objElement->sharebuttons_networks, true);
  376.         if (\in_array('pdf', $articleNetworks)) {
  377.             $options[] = 'pdf';
  378.             $objElement->printable = serialize($options);
  380.             return $blnReturn;
  381.         }
  383.         $elements = ContentModel::findPublishedByPidAndTable((int) $objElement->id, $objElement->getTable());
  385.         if (null === $elements) {
  386.             return $blnReturn;
  387.         }
  389.         foreach ($elements as $element) {
  390.             if ('sharebuttons' !== $element->type) {
  391.                 continue;
  392.             }
  394.             $elementNetworks = StringUtil::deserialize($element->sharebuttons_networks, true);
  396.             if (\in_array('pdf', $elementNetworks)) {
  397.                 $options[] = 'pdf';
  398.                 $objElement->printable = serialize($options);
  400.                 return $blnReturn;
  401.             }
  402.         }
  404.         return $blnReturn;
  405.     }
  408.     /**
  409.      * DCA functions
  410.      */
  411.     public function getNetworks(DataContainer $dc)
  412.     {
  413.         $networks = $GLOBALS['sharebuttons']['networks'];
  415.         // Only allow PDF button in article settings and as a content element
  416.         if (!\in_array($dc->table, ['tl_article', 'tl_content'], true)) {
  417.             unset($networks['pdf']);
  418.         }
  420.         foreach ($networks as $network => &$label) {
  421.             if (!empty($GLOBALS['TL_LANG']['sharebuttons']['networks'][$network])) {
  422.                 $label = $GLOBALS['TL_LANG']['sharebuttons']['networks'][$network];
  423.             }
  424.         }
  426.         return $networks;
  427.     }
  429.     public function getButtonThemes()
  430.     {
  431.         $themes = array( '' => $GLOBALS['TL_LANG']['sharebuttons']['no_theme'] );
  432.         foreach( $GLOBALS['sharebuttons']['themes'] as $k => $v )
  433.             $themes[$k] = $v[0];
  434.         return $themes;
  435.     }
  437.     public function getSharebuttonsTemplates()
  438.     {
  439.         return Controller::getTemplateGroup('sharebuttons_');
  440.     }
  442.     public static function isBackendRequest(): bool
  443.     {
  444.         if (method_exists(System::class, 'getContainer')) {
  445.             $container = System::getContainer();
  446.             $request = $container->get('request_stack')->getCurrentRequest();
  447.             
  448.             return $request && $container->get('contao.routing.scope_matcher')->isBackendRequest($request);
  449.         }
  451.         if (defined('TL_MODE')) {
  452.             return 'BE' === constant('TL_MODE');
  453.         }
  455.         return false;
  456.     }
  457. }