bundles/FoxHabbit/BasisBundle/Tool/Url.php line 122

Open in your IDE?
  1. <?php
  2. // declare(strict_types=1);
  4. namespace FoxHabbit\BasisBundle\Tool;
  6. use Pimcore\Log\ApplicationLogger;
  8. class Url
  9. {
  10.     /**
  11.      * Add a scheme to an url
  12.      *
  13.      * @param  string $url     the url
  14.      * @param  string $scheme  the scheme
  15.      * @param  bool   $replace allow to replace an existing scheme
  16.      * @return string the url prefixed with the scheme or the original url, if anything goes wrong
  17.      */
  18.     public static function addScheme(string $url, string $scheme, bool $replace = false) : string {
  20.         // check input
  21.         if (0 === strlen($scheme)) {
  22.             ApplicationLogger::info('No scheme passed. Returning.');
  23.             return $url;
  24.         }
  25.         if (0 === strlen($url)) {
  26.             ApplicationLogger::info('No URL passed. Returning.');
  27.             return $url;
  28.         }
  30.         $existingScheme = parse_url( $url , PHP_URL_SCHEME );
  32.         if (false === $existingScheme) {
  33.             ApplicationLogger::warn('Malformed URL "'.$url.'"');
  34.             return $url;
  35.         } else if ('' !== $existingScheme && false === $replace) {
  36.             ApplicationLogger::notice('Replacing scheme prohibited in "'.$url.'"');
  37.             return $url;
  38.         }
  40.         if ('' === $existingScheme) {
  41.             $url = preg_replace('@^:?/{2}@', '', $url);
  42.             return $scheme.'://'.$url;
  43.         } else {
  44.             $url = preg_replace('@^'.$existingScheme.':/{2}@', $scheme.'://', $url);
  45.             return $url;
  46.         }
  48.     }
  49.     /**
  50.      * Add http:// to an url if it is missing
  51.      *
  52.      * @param string $url The url
  53.      *
  54.      * @return string The url having http:// prefixed
  55.      */
  56.     public static function addHttp( $url, $replace = false) {
  57.         return self::addScheme($url, 'http', $replace);
  58.     }
  60.     /**
  61.      * Add https:// to an url if it is missing
  62.      *
  63.      * @param string $url The url
  64.      *
  65.      * @return string The url having https:// prefixed
  66.      */
  67.     public static function addHttps( $url, $replace = false) {
  68.         return self::addScheme($url, 'https', $replace);
  69.     }
  71.     /**
  72.      * Remove the http:// prefix from an url
  73.      *
  74.      * @param string $url The url
  75.      *
  76.      * @return string The url having http:// removed
  77.      */
  78.     public static function removeHttp( $url) {
  79.         if( ! strlen( $url)) {
  80.             return $url;
  81.         }
  82.         if( preg_match( '@^https?://(.+)$@', $url, $m)) {
  83.             return $m[1];
  84.         } else {
  85.             return $url;
  86.         }
  87.     }
  89.     public static function isExternalLink( $target, $recursive=true) {
  90.         if( ! $target) {
  91.             return false;
  92.         }
  93.         // Some targets like downloads are forced to be external to be opened in a new tab
  94.         if( is_object( $target)) {
  95.             switch( get_class( $target)) {
  96.                 case 'Pimcore\Model\Document\Tag\Href':    // bis Pimcore 5.5
  97.                 case 'Pimcore\Model\Document\Tag\Relation':    // ab Pimcore 5.6
  98.                 case 'Pimcore\Model\Document\Editable\Relation':    // ab Pimcore 6.8
  99.                         if( $recursive) {
  100.                         return self::isExternalLink($target->getElement(), $recursive);
  101.                     }
  102.                     break;
  103.                 case 'Pimcore\Model\Asset\Document':
  104.                 case 'Pimcore\Model\Asset\Image':
  105.                         // Diese Downloads in neuem Fenster öffnen
  106.                     return true;
  107.                     break;
  108.             }
  109.         }
  110.         $href = self::getHref( $target, $recursive);
  111.         $href_host = parse_url($href, PHP_URL_HOST);
  112.         $server_host = $_SERVER['HTTP_HOST'];
  113.         if( ! $href_host) {
  114.             return false;
  115.         }
  116.         return $href_host !== $server_host;
  117.     }
  119.     public static function getTarget( $in, $recursive=true) {
  120.         return ( self::isExternalLink($in) ) ? '_blank':'_self';
  121.     }
  122.     public static function isPublished( $target, $recursive=true) {
  123.         if( is_object( $target)) {
  124.             switch( get_class( $target)) {
  125.                 case 'Pimcore\Model\Document\Tag\Href':    // bis Pimcore 5.5
  126.                 case 'Pimcore\Model\Document\Tag\Relation':    // ab Pimcore 5.6
  127.                 case 'Pimcore\Model\Document\Editable\Relation':    // ab Pimcore 6.8
  128.                         if( $recursive) {
  129.                         return self::isPublished($target->getElement(), $recursive);
  130.                     } else {
  131.                         return $target->isPublished();
  132.                     }
  133.                     break;
  134.                 case 'Pimcore\Model\Document\Link':
  135.                     if( $target->isPublished()) {
  136.                         if( $recursive) {
  137.                             switch( $target->getLinktype()) {
  138.                                 case 'direct':
  139.                                     // Link enthält eine URL
  140.                                     return true;
  141.                                     break;
  142.                                 case 'internal':
  143.                                     return self::isPublished($target->getObject(), $recursive);
  144.                                     break;
  145.                             }
  146.                         } else {
  147.                             return true;
  148.                         }
  149.                     }
  150.                     break;
  152.                 default:
  153.                     if( $target instanceof \Pimcore\Model\Document) {
  154.                         return $target->isPublished();
  155.                     }
  156.                     if( $target instanceof \Pimcore\Model\Asset) {
  157.                         return true;
  158.                     }
  159.                     exit( 'Website\Tool\Url::isVisible(): unhandled target type "'.get_class( $target).'"');
  160.             }
  161.         } else if( is_string( $target)) {
  162.             return true;
  163.         }
  164.         return false;
  165.     }
  166.     public static function getHref( $target, $recursive=true) {
  167.         if( is_object( $target)) {
  168.             switch( get_class( $target)) {
  169.                 case 'Pimcore\Model\Document\Tag\Href':    // bis Pimcore 5.5
  170.                 case 'Pimcore\Model\Document\Tag\Relation':    // ab Pimcore 5.6
  171.                 case 'Pimcore\Model\Document\Editable\Relation':    // ab Pimcore 6.8
  172.                     if( $recursive) {
  173.                         return self::getHref($target->getElement(), $recursive);
  174.                     } else {
  175.                         return $target->getFullPath();
  176.                     }
  177.                     break;
  178.                 case 'Pimcore\Model\Document\Link':
  179.                     if( $recursive) {
  180.                         switch( $target->getLinktype()) {
  181.                             case 'direct':
  182.                                 // Link enthält eine URL
  183.                                 return $target->getHref();
  184.                                 break;
  185.                             case 'internal':
  186.                                 return self::getHref( $target->getObject(), $recursive);
  187.                                 break;
  188.                         }
  189.                     } else {
  190.                         return $target->getHref();
  191.                     }
  192.                     break;
  193.                 case 'Pimcore\Model\Document\Page':
  194.                 case 'Pimcore\Model\Document\Hardlink':
  195.                 case 'Pimcore\Model\Asset\Image':
  196.                 case 'Pimcore\Model\Asset\Document':
  197.                     return $target->getFullPath();
  198.                     break;
  199.                 case 'Pimcore\Navigation\Page\Document':
  200.                     if( $recursive) {
  201.                         return self::getHref( $target->getDocument(), $recursive);
  202.                     } else {
  203.                         return $target->getHref();
  204.                     }
  205.                     break;
  206.                 default:
  207.                     return 'Website\Tool\Url::getHref(): unhandled target type "'.get_class( $target).'"';
  208.             }
  209.         }
  210.         return $target;
  211.     }
  214. }