You are here

Home » API reference » oEmbed 7

oembed.filter.inc in oEmbed 7

Same filename and directory in other branches
  1. 8 oembed.filter.inc
  2. 7.0 oembed.filter.inc

Input filter that enhances oEmbed enabled URLs with extra content

File

oembed.filter.inc
View source 
<?php

/**
 * @file
 * Input filter that enhances oEmbed enabled URLs with extra content
 */
define('OEMBED_AUTOEMBED', 1);
define('OEMBED_AUTOEMBED_UNWRAP', 2);
define('OEMBED_AUTOEMBED_DISABLED', 0);
define('OEMBED_PATTERN_AUTOEMBED', '|^\\s*(https?://[^\\s"]+)\\s*$|im');
define('OEMBED_PATTERN_AUTOEMBED_UNWRAP', serialize(array(
  OEMBED_PATTERN_AUTOEMBED,
  '|<[a-z0-9]*[^>]*?>(https?://[^\\s"]+?)</[a-z0-9]*>|i',
  '|<span[^>]*?>(https?://[^\\s"]+?)</span>|i',
  '|<a[^>]*?>(https?://[^\\s"]+?)</a>|i',
  '|^(https?:\\/\\/[^\\s"]+?)\\s|i',
  '|\\s(https?:\\/\\/[^\\s"]+?)$|i',
  '|\\s(https?:\\/\\/[^\\s"]+?)\\s|i',
  '|^(https?:\\/\\/[^\\s"]+?)$|i',
)));
define('OEMBED_PATTERN_EMBED_SHORTCODE', '/(.?)\\[embed\\b(.*?)\\](.+?)\\[\\/embed\\](.?)/s');
define('OEMBED_PATTERN_EMBED_UNWRAP', '/<p>\\s*+(\\[embed\\b.*?\\].+?\\[\\/embed\\])\\s*+<\\/p>/s');

/**
 * Implements hook_filter_info().
 */
function oembed_filter_info() {
  $filters = array();
  $filters['oembed'] = array(
    'title' => t('oEmbed filter'),
    'description' => t('Embeds content for oEmbed-enabled web addresses and turns the rest, and e-mail addresses, into clickable links.'),
    'prepare callback' => 'oembed_filter_oembed_prepare',
    'process callback' => 'oembed_filter_oembed_process',
    'settings callback' => 'oembed_filter_oembed_settings',
    'tips callback' => 'oembed_filter_oembed_tips',
    'default settings' => array(
      'options' => '',
      'autoembed' => OEMBED_AUTOEMBED,
    ),
  );
  $filters['oembed_legacy'] = array(
    'title' => t('oEmbed legacy filter'),
    'description' => t('Embeds content for oEmbed-enabled web addresses and turns the rest, and e-mail addresses, into clickable links.'),
    'process callback' => 'oembed_filter_oembed_legacy_process',
    'settings callback' => 'oembed_filter_oembed_legacy_settings',
    'default settings' => array(
      'maxwidth' => '',
      'maxheight' => '',
    ),
  );
  return $filters;
}

/**
 * Implements hook_filter_FILTER_settings().
 */
function oembed_filter_oembed_legacy_settings($form, &$form_state, $filter, $format, $defaults, $filters) {
  module_load_include('inc', 'oembed', 'oembed_legacy');
  return _oembed_filter_settings($form, $form_state, $filter, $format, $defaults);
}

/**
 * Implements hook_filter_FILTER_process().
 */
function oembed_filter_oembed_legacy_process($text, $filter, $format, $langcode, $cache, $cache_id) {
  module_load_include('inc', 'oembed', 'oembed_legacy');
  return _oembed_filter_apply($text, $filter, $format, $langcode, $cache, $cache_id);
}

/**
 * Implements hook_filter_FILTER_settings().
 */
function oembed_filter_oembed_settings($form, &$form_state, $filter, $format, $defaults, $filters) {
  $filter->settings += $defaults;
  $settings = array();
  $settings['options'] = array(
    '#type' => 'textfield',
    '#title' => t('Default oEmbed request options'),
    '#default_value' => $filter->settings['options'],
    '#description' => t('A series of attribute value pairs for the default request options. For example, <em>maxwidth="500"</em>.'),
  );
  $settings['autoembed'] = array(
    '#type' => 'radios',
    '#title' => t('Automatically embed URLs'),
    '#default_value' => $filter->settings['autoembed'],
    '#options' => array(
      OEMBED_AUTOEMBED => t('Embed URL that are on its own line.'),
      OEMBED_AUTOEMBED_UNWRAP => t('Embed URL on its own line ignoring any &lt;p&gt; tags that may have been inserted by a WYSIWYG editor.'),
      OEMBED_AUTOEMBED_DISABLED => t('Disabled'),
    ),
    '#description' => t('When possible, embed the media content from a URL directly in the input.'),
  );
  return $settings;
}

/**
 * Implements hook_filter_FILTER_process().
 */
function oembed_filter_oembed_prepare($text, $filter, $format, $langcode, $cache, $cache_id) {
  if (OEMBED_AUTOEMBED == $filter->settings['autoembed']) {
    $text = preg_replace_callback(OEMBED_PATTERN_AUTOEMBED, 'oembed_preg_auto_replace', $text);
  }
  elseif (OEMBED_AUTOEMBED_UNWRAP == $filter->settings['autoembed']) {
    $text = preg_replace_callback(unserialize(OEMBED_PATTERN_AUTOEMBED_UNWRAP), 'oembed_preg_auto_replace', $text);
  }
  return $text;
}

/**
 * Implements hook_filter_FILTER_process().
 */
function oembed_filter_oembed_process($text, $filter, $format, $langcode, $cache, $cache_id) {
  global $_oembed_filter_settings;
  $_oembed_filter_settings = !empty($filter->settings['options']) ? oembed_parse_attr($filter->settings['options']) : array();

  // Undo auto paragraph around oEmbed shortcodes.
  $text = preg_replace(OEMBED_PATTERN_EMBED_UNWRAP, '$1 ', $text);
  $text = preg_replace_callback(OEMBED_PATTERN_EMBED_SHORTCODE, 'oembed_preg_tag_replace', $text);
  unset($_oembed_filter_settings);
  return $text;
}

/**
 * Implements hook_filter_FILTER_tips().
 */
function oembed_filter_oembed_tips($filter, $format, $long) {
  if ($long) {
    return t('Embed content by wrapping a supported URL in [embed] &hellip; [/embed]. Set options such as width and height with attributes [embed width="123" height="456"] &hellip; [/embed]. Unsupported options will be ignored.');
  }
  else {
    return t('Embed content by wrapping a supported URL in [embed] &hellip; [/embed].');
  }
}

/**
 * PREG replace callback finds [embed] shortcodes, URLs and request options.
 */
function oembed_preg_tag_replace($match) {
  global $_oembed_filter_settings;

  // allow [[oembed]] syntax for escaping a tag
  if ($match[1] === '[' && $match[4] === ']') {
    return substr($match[0], 1, -1);
  }
  $url = $match[3];
  $shortcode_options = !empty($match[2]) ? oembed_parse_attr($match[2]) : array();
  $options = array_merge($_oembed_filter_settings, $shortcode_options);
  $callback = variable_get('oembed_resolve_link_callback', 'oembed_resolve_link');
  if (!function_exists($callback)) {
    $callback = 'oembed_resolve_link';
  }
  return $match[1] . $callback($url, $options) . $match[4];
}

/**
 * PREG replace callback finds URLs
 */
function oembed_preg_auto_replace($match) {
  return '[embed]' . $match[1] . "[/embed] ";
}

/**
 * PREG replace callback finds [embed] shortcodes, URLs and request options.
 *
 * Override in Drupal system variable `oembed_resolve_link_callback`
 *
 * @see MediaInternetOEmbedHandler::preSave().
 *
 * @param string $url
 *   URL to embed.
 * @param array $options
 *   oEmbed request options.
 *
 * @return string
 *   Rendered oEmbed response.
 */
function oembed_resolve_link($url, $options = array()) {
  $url = decode_entities($url);
  $element = array();
  $matches = array();
  if ($provider = oembed_get_provider($url, $matches)) {
    $embed = oembed_get_data($url);
    if ($embed) {
      $element = oembed_render_element('oembed', $url, $options);
    }
  }
  $return = drupal_render($element);
  if (empty($return)) {
    $return = $url;
  }
  return $return;
}

/**
 * Retrieve all attributes from the shortcodes tag.
 *
 * @see shortcode_parse_atts in WordPress 3.1.3.
 * @param string $text
 * @return array List of attributes and their value.
 */
function oembed_parse_attr($text) {
  $attributes = array();
  $pattern = '/(\\w+)\\s*=\\s*"([^"]*)"(?:\\s|$)|(\\w+)\\s*=\\s*\'([^\']*)\'(?:\\s|$)|(\\w+)\\s*=\\s*([^\\s\'"]+)(?:\\s|$)|"([^"]*)"(?:\\s|$)|(\\S+)(?:\\s|$)/';
  $text = preg_replace("/[\\x{00a0}\\x{200b}]+/u", " ", $text);
  if (preg_match_all($pattern, $text, $matches, PREG_SET_ORDER)) {
    foreach ($matches as $match) {
      if (!empty($match[1])) {
        $attributes[strtolower($match[1])] = stripcslashes($match[2]);
      }
      elseif (!empty($match[3])) {
        $attributes[strtolower($match[3])] = stripcslashes($match[4]);
      }
      elseif (!empty($match[5])) {
        $attributes[strtolower($match[5])] = stripcslashes($match[6]);
      }
      elseif (isset($match[7]) and strlen($match[7])) {
        $attributes[] = stripcslashes($match[7]);
      }
      elseif (isset($match[8])) {
        $attributes[] = stripcslashes($match[8]);
      }
    }
  }
  else {
    $attributes = ltrim($text);
  }
  return $attributes;
}

/**
 * Extract all URLs for oEmbed to process.
 *
 * Returns an array of URLs grouped by field, delta, and column.
 */
function _oembed_field_extract_urls($entity_type, $entity) {
  $urls = array();

  // Determine if any formats use oEmbed filter.
  $filter_settings = array();
  foreach (filter_formats() as $format) {
    $filters = filter_list_format($format->format);
    if (isset($filters['oembed']) && $filters['oembed']->status) {
      $filter_settings[$format->format] = $filters['oembed']->settings;
    }
  }
  if (!empty($filter_settings)) {
    list(, , $bundle) = entity_extract_ids($entity_type, $entity);
    $instances = field_info_instances($entity_type, $bundle);
    foreach ($instances as $info) {

      // All text fields have a text_processing setting. Only search text fields with
      // text processing enabled.
      if (isset($info['settings']['text_processing']) && $info['settings']['text_processing']) {
        $items = field_get_items($entity_type, $entity, $info['field_name']);
        if (!$items) {
          continue;
        }
        foreach ($items as $delta => $item) {
          if (isset($filter_settings[$item['format']])) {

            // URLs may be contained within the other column values.
            foreach (array(
              'value',
              'summary',
            ) as $column) {
              if (!empty($item[$column])) {
                $text = $item[$column];

                // copied from oembed_filter_oembed_prepare().
                if (OEMBED_AUTOEMBED == $filter_settings[$item['format']]['autoembed']) {
                  $text = preg_replace_callback(OEMBED_PATTERN_AUTOEMBED, 'oembed_preg_auto_replace', $text);
                }
                elseif (OEMBED_AUTOEMBED_UNWRAP == $filter_settings[$item['format']]['autoembed']) {
                  $text = preg_replace_callback(unserialize(OEMBED_PATTERN_AUTOEMBED_UNWRAP), 'oembed_preg_auto_replace', $text);
                }

                // copied from oembed_filter_oembed_process().
                $matches = array();
                preg_match_all(OEMBED_PATTERN_EMBED_SHORTCODE, $text, $matches);
                $urls[$info['field_name']][$delta][$column] = array_filter($matches[3], '_oembed_field_filter_urls');
              }
            }
          }
        }
      }
    }
  }
  return $urls;
}

/**
 * array_filter() callback that removes URLs for which there is no provider.
 */
function _oembed_field_filter_urls($match) {
  $matches = array();
  if (oembed_get_provider($match, $matches)) {
    return TRUE;
  }
  return FALSE;
}

/**
 * Implements hook_field_attach_validate().
 */
function oembed_field_attach_validate($entity_type, $entity, array &$errors) {
  foreach (_oembed_field_extract_urls($entity_type, $entity) as $field_name => $items) {
    foreach ($items as $delta => $item) {
      foreach ($item as $column => $urls) {
        $messages = array();
        foreach ($urls as $url) {
          $embed = oembed_get_data($url);
          $validation_errors = oembed_validate_response($embed);
          if (!empty($validation_errors)) {
            $message = t('!url could not be embedded.', array(
              '!url' => l(_filter_url_trim($url, 50), $url),
            ));
            $message .= theme('item_list', array(
              'items' => $validation_errors,
            ));
            $messages[] = $message;
          }
        }
        if (!empty($messages)) {
          $errors[$field_name][$entity->language][$delta][] = array(
            'error' => 'oembed_' . $column,
            'message' => theme('item_list', array(
              'items' => $messages,
            )),
            'repeat' => TRUE,
          );
        }
      }
    }
  }
}

Functions

Namesort descending Description
oembed_field_attach_validate Implements hook_field_attach_validate().
oembed_filter_info Implements hook_filter_info().
oembed_filter_oembed_legacy_process Implements hook_filter_FILTER_process().
oembed_filter_oembed_legacy_settings Implements hook_filter_FILTER_settings().
oembed_filter_oembed_prepare Implements hook_filter_FILTER_process().
oembed_filter_oembed_process Implements hook_filter_FILTER_process().
oembed_filter_oembed_settings Implements hook_filter_FILTER_settings().
oembed_filter_oembed_tips Implements hook_filter_FILTER_tips().
oembed_parse_attr Retrieve all attributes from the shortcodes tag.
oembed_preg_auto_replace PREG replace callback finds URLs
oembed_preg_tag_replace PREG replace callback finds [embed] shortcodes, URLs and request options.
oembed_resolve_link PREG replace callback finds [embed] shortcodes, URLs and request options.
_oembed_field_extract_urls Extract all URLs for oEmbed to process.
_oembed_field_filter_urls array_filter() callback that removes URLs for which there is no provider.

Constants

Namesort descending Description
OEMBED_AUTOEMBED @file Input filter that enhances oEmbed enabled URLs with extra content
OEMBED_AUTOEMBED_DISABLED
OEMBED_AUTOEMBED_UNWRAP
OEMBED_PATTERN_AUTOEMBED
OEMBED_PATTERN_AUTOEMBED_UNWRAP
OEMBED_PATTERN_EMBED_SHORTCODE
OEMBED_PATTERN_EMBED_UNWRAP