vendor/numero2/contao-opengraph3/src/Resources/contao/classes/OpenGraph.php line 304

Open in your IDE?
  1. <?php
  3. /**
  4.  * Contao Open Source CMS
  5.  *
  6.  * Copyright (c) 2005-2022 Leo Feyer
  7.  *
  8.  * @package   Opengraph3
  9.  * @author    Benny Born <benny.born@numero2.de>
  10.  * @author    Michael Bösherz <michael.boesherz@numero2.de>
  11.  * @license   LGPL
  12.  * @copyright 2022 numero2 - Agentur für digitales Marketing GbR
  13.  */
  16. namespace numero2\OpenGraph3;
  18. use Contao\Config;
  19. use Contao\ContentElement;
  20. use Contao\Controller;
  21. use Contao\Environment;
  22. use Contao\File;
  23. use Contao\FilesModel;
  24. use Contao\Frontend;
  25. use Contao\ModuleModel;
  26. use Contao\PageModel;
  27. use Contao\StringUtil;
  28. use Contao\System;
  31. class OpenGraph3 extends Frontend {
  34.     /**
  35.      * Add OpenGraph tags to the current page
  36.      *
  37.      * @param Model $ref
  38.      */
  39.     public static function addTagsToPage( $ref=null ): void {
  41.         Controller::loadDataContainer('opengraph_fields');
  42.         System::loadLanguageFile('opengraph_fields');
  44.         global $objPage;
  46.         $objRef = !$ref ? $objPage : $ref;
  47.         $objRootPage = ($objRef instanceof PageModel) ? PageModel::findById($objPage->rootId) : null;
  49.         self::parseAdditionalProperties( $objRef );
  50.         self::parseAdditionalProperties( $objRootPage );
  52.         // add og tags
  53.         if( !empty($GLOBALS['TL_DCA']['opengraph_fields']['fields']) ) {
  55.             foreach( $GLOBALS['TL_DCA']['opengraph_fields']['fields'] as $fieldName => $field ) {
  57.                 // add tag if missing
  58.                 if( (($objRef && !empty($objRef->{$fieldName})) || ($objRootPage && !empty($objRootPage->{$fieldName}))) && !self::checkTag($field['label'][0]) ) {
  60.                     $tag = $field['label'][0];
  62.                     $value = null;
  63.                     $value = !empty($objRef->{$fieldName}) ? $objRef->{$fieldName} : $objRootPage->{$fieldName};
  65.                     $resized = null;
  67.                     // get value based on inputType
  68.                     switch( $field['inputType'] ) {
  70.                         case 'textarea':
  71.                         case 'select':
  72.                         case 'text':
  74.                             switch( $fieldName ) {
  76.                                 case 'og_country_name':
  77.                                 case 'og_business_contact_data_country_name':
  79.                                     $arrCountries = [];
  80.                                     $arrCountries = System::getCountries();
  82.                                     $value = $arrCountries[$value];
  84.                                 break;
  85.                             }
  87.                             if( !empty($field['eval']['rgxp']) ) {
  89.                                 switch( $field['eval']['rgxp'] ) {
  91.                                     case 'datim':
  93.                                         $date = null;
  94.                                         $date = \DateTime::createFromFormat( Config::get('datimFormat'), $value );
  96.                                         $value = $date->format('Y-m-d\TH:i:s');
  98.                                     break;
  99.                                 }
  100.                             }
  102.                         break;
  104.                         case 'fileTree':
  106.                             $objFile = null;
  107.                             $objFile = FilesModel::findByUuid( $value );
  109.                             if( $objFile ) {
  111.                                 $value = Environment::get('base') . $objFile->path;
  113.                                 $size = Config::get($fieldName.'_size');
  114.                                 if( $size ) {
  116.                                     $oFile = new File($objFile->path);
  118.                                     $size = StringUtil::deserialize($size);
  119.                                     if( is_numeric($size) ){
  120.                                         $size = [0, 0, (int) $size];
  121.                                     } else if( !is_array($size) ) {
  122.                                         $size = [];
  123.                                     }
  125.                                     $size += [0, 0, 'crop'];
  127.                                     if( $oFile && $oFile->exists() && $oFile->isGdImage ) {
  128.                                         try {
  129.                                             $resized = System::getContainer()->get('contao.image.image_factory')->create(TL_ROOT . '/' . $objFile->path, $size);
  130.                                             $src = $resized->getUrl(TL_ROOT);
  132.                                             if( $src !== $objFile->path ) {
  133.                                                 $value = Environment::get('base') . $src;
  134.                                             }
  136.                                         } catch( \Exception $e ) {
  137.                                         }
  138.                                     }
  139.                                 }
  140.                             } else {
  141.                                 continue 2;
  142.                             }
  144.                         break;
  146.                         case 'openGraphProperties':
  147.                             continue 2;
  148.                         break;
  150.                         default:
  151.                             throw new \Exception("Unhandled field type ".$field['inputType']);
  152.                         break;
  153.                     }
  155.                     // add og:image:secure_url and image size tags if applicable
  156.                     if( $tag === 'og:image' && $resized ) {
  157.                         $resizedSize = $resized->getDimensions()->getSize();
  159.                         self::addTag('og:image:width', $resizedSize->getWidth());
  160.                         self::addTag('og:image:height', $resizedSize->getHeight());
  162.                         if ( strpos($value,'https:') !== false ) {
  163.                             self::addTag('og:image:secure_url', $value);
  164.                         }
  165.                     }
  167.                     self::addTag($tag, $value);
  168.                 }
  169.             }
  171.             // og:locale
  172.             if( !self::checkTag('og:locale') ) {
  174.                 $value = ($objRef && isset($objRef->og_locale) && $objRef->og_locale) ? $objRef->og_locale : (($objRootPage && isset($objRootPage->og_locale) && $objRootPage->og_locale) ? $objRootPage->og_locale : null);
  176.                 // set default locale based on the page´s language
  177.                 if( !$value ) {
  179.                     switch( $objPage->language ) {
  180.                         case 'en' :
  181.                             $value = 'en_US';
  182.                             break;
  183.                         default :
  184.                             $value = sprintf("%s_%s",$objPage->language,strtoupper($objPage->language));
  185.                             break;
  186.                     }
  187.                 }
  189.                 self::addTag( 'og:locale', $value );
  190.             }
  192.             // og:url added automatically
  193.             if( !self::checkTag('og:url') ) {
  194.                 self::addTag( 'og:url', Environment::get('url') . Environment::get('requestUri') );
  195.             }
  196.         }
  197.     }
  200.     /**
  201.      * Appends a property to the given object
  202.      *
  203.      * @param string $prop
  204.      * @param string $value
  205.      * @param Model $objRef
  206.      */
  207.     public static function addProperty( $prop, $value, $objRef ): void {
  209.         $aProperties = [];
  210.         $aProperties = $objRef->og_properties ? StringUtil::deserialize($objRef->og_properties) : [];
  212.         $aProperties[] = [$prop, $value];
  214.         $objRef->og_properties = serialize($aProperties);
  215.     }
  218.     /**
  219.      * Appends OpenGraph data for the given module
  220.      *
  221.      * @param Model $objRow
  222.      * @param String $strBuffer
  223.      * @param Module $objModule
  224.      *
  225.      * @return String
  226.      */
  227.     public function appendTagsByModule( $objRow, $strBuffer, $objModule ): string {
  229.         $moduleClass = null;
  230.         $moduleClass = get_class($objModule);
  232.         // find and import a matching module to parse the OpenGraph data from
  233.         foreach( $GLOBALS['TL_OG_MODULES'] as $module ) {
  235.             if( $moduleClass === "Contao\ModuleModel" && $objModule->type === $module[0] || $moduleClass === $module[1] ) {
  237.                 $this->import($module[2]);
  238.                 $this->{$module[2]}->addModuleData($objModule);
  239.             }
  240.         }
  242.         return $strBuffer?:'';
  243.     }
  246.     /**
  247.      * Checks if the given Content Element is a module and tries to use it
  248.      * for OpenGraph data
  249.      *
  250.      * @param Model $objRow
  251.      * @param String $strBuffer
  252.      * @param Contao\ContentElement $objElement
  253.      *
  254.      * @return String
  255.      */
  256.     public function findCompatibleModules( $objRow, $strBuffer, $objElement ): string {
  258.         if( get_class($objElement) === "Contao\ContentModule" ) {
  260.             $objModule = null;
  261.             $objModule = ModuleModel::findById($objElement->module);
  263.             if( $objModule ) {
  264.                 self::appendTagsByModule(null, $strBuffer, $objModule);
  265.             }
  266.         }
  268.         return $strBuffer?:'';
  269.     }
  272.     /**
  273.     * Adds the additional og_properties as individual attributes
  274.     *
  275.     * @param Model $ref
  276.     */
  277.     private static function parseAdditionalProperties( $ref ): void {
  279.         if( !empty($ref->og_properties) ) {
  281.             $props = null;
  282.             $props = StringUtil::deserialize($ref->og_properties);
  284.             if( !empty($props) ) {
  286.                 foreach( $props as $p ) {
  287.                     if( !isset($ref->{$p[0]}) || empty($ref->{$p[0]}) ) {
  288.                         $ref->{$p[0]} = $p[1];
  289.                     }
  290.                 }
  291.             }
  292.         }
  293.     }
  296.     /**
  297.     * Adds a specific OpenGraph tag to the head
  298.     *
  299.     * @param String $tagName
  300.     * @param String $tagValue
  301.     *
  302.     * @return bool
  303.     */
  304.     private static function addTag( $tagName=null, $tagValue=null ): bool {
  306.         if( empty($tagName) || empty($tagValue) ) {
  307.             return false;
  308.         }
  310.         $attribute = 'property';
  312.         if( strpos($tagName, 'twitter') === 0 ) {
  313.             $attribute = 'name';
  314.         }
  316.         $GLOBALS['TL_HEAD'][] = sprintf(
  317.             '<meta %s="%s" content="%s" />'
  318.         ,   $attribute
  319.         ,   $tagName
  320.         ,   htmlspecialchars( self::replaceInsertTags($tagValue) )
  321.         );
  323.         return true;
  324.     }
  327.     /**
  328.      * Checks if a specific OpenGraph tag already exists
  329.      *
  330.      * @param String $tagName
  331.      * @param String $tagValue
  332.      *
  333.      * @return bool
  334.      */
  335.     private static function checkTag( $tagName=null ): bool {
  337.         if( empty($tagName) ) {
  338.             return false;
  339.         }
  341.         if( !empty($GLOBALS['TL_HEAD']) && is_array($GLOBALS['TL_HEAD']) ) {
  343.             foreach( $GLOBALS['TL_HEAD'] as $i => $v ) {
  345.                 if( strpos($v, $tagName) !== FALSE ) {
  346.                     return true;
  347.                 }
  348.             }
  349.         }
  351.         return false;
  352.     }
  353. }