Club Drupal

/**

 *  @file

 *  File with utilities to handle media in html editing.

 */

(function ($) {

  Drupal.media = Drupal.media || {};

  /**

   * Utility to deal with media tokens / placeholders.

   */

  Drupal.media.filter = {

    /**

     * Replaces media tokens with the placeholders for html editing.

     * @param content

     */

    replaceTokenWithPlaceholder: function(content) {

      Drupal.media.filter.ensure_tagmap();

      var matches = content.match(/\[\[.*?\]\]/g);

      if (matches) {

        for (var i = 0; i < matches.length; i++) {

          var match = matches[i];

          if (match.indexOf('"type":"media"') == -1) {

            continue;

          }

          // Check if the macro exists in the tagmap. This ensures backwards

          // compatibility with existing media and is moderately more efficient

          // than re-building the element.

          var media = Drupal.settings.tagmap[match];

          var media_json = match.replace('[[', '').replace(']]', '');

          // Ensure that the media JSON is valid.

          try {

            var media_definition = JSON.parse(media_json);

          }

          catch (err) {

            // @todo: error logging.

            // Content should be returned to prevent an empty editor.

            return content;

          }

          // Re-build the media if the macro has changed from the tagmap.

          if (!media && media_definition.fid) {

            Drupal.media.filter.ensureSourceMap();

            var source = Drupal.settings.mediaSourceMap[media_definition.fid];

            media = document.createElement(source.tagName);

            media.src = source.src;

          }

          // Apply attributes.

          var element = Drupal.media.filter.create_element(media, media_definition);

          var markup  = Drupal.media.filter.outerHTML(element);

          // Use split and join to replace all instances of macro with markup.

          content = content.split(match).join(markup);

        }

      }

      return content;

    },

    /**

     * Replaces media elements with tokens.

     *

     * @param content (string)

     *   The markup within the wysiwyg instance.

     */

    replacePlaceholderWithToken: function(content) {

      Drupal.media.filter.ensure_tagmap();

      // Rewrite the tagmap in case any of the macros have changed.

      Drupal.settings.tagmap = {};

      // Wrap the content to be able to use replaceWith() and html().

      content = $('<div>').append(content);

      var media = $('.media-element', content);

      if (media.length) {

        // Replace all media elements with their respective macros.

        media.replaceWith(function() {

          var el = $(this),

            macro = Drupal.media.filter.create_macro(el);

          // Store the markup for more efficient rendering later.

          // @see replaceTokenWidthPlaceholder()

          Drupal.settings.tagmap[macro] = Drupal.media.filter.outerHTML(el);

          return macro;

        });

      }

      return content.html();

    },

    /**

     * Serializes file information as a url-encoded JSON object and stores it

     * as a data attribute on the html element.

     *

     * @param html (string)

     *    A html element to be used to represent the inserted media element.

     * @param info (object)

     *    A object containing the media file information (fid, view_mode, etc).

     */

    create_element: function (html, info) {

      if ($('<div>').append(html).text().length === html.length) {

        // Element is not an html tag. Surround it in a span element so we can

        // pass the file attributes.

        html = '<span>' + html + '</span>';

      }

      var element = $(html);

      // Parse out link wrappers. They will be re-applied when the image is

      // rendered on the front-end.

      if (element.is('a')) {

        element = element.children();

      }

      // Move attributes from the file info array to the placeholder element.

      if (info.attributes) {

        $.each(Drupal.settings.media.wysiwyg_allowed_attributes, function(i, a) {

          if (info.attributes[a]) {

            element.attr(a, info.attributes[a]);

          }

        });

        delete(info.attributes);

        // Store information to rebuild the element later, if necessary.

        Drupal.media.filter.ensureSourceMap();

        Drupal.settings.mediaSourceMap[info.fid] = {

          tagName: element[0].tagName,

          src: element[0].src

        }

      }

      info.type = info.type || "media";

      // Store the data in the data map.

      Drupal.media.filter.ensureDataMap();

      Drupal.settings.mediaDataMap[info.fid] = info;

      // Store the fid in the DOM to retrieve the data from the info map.

      element.attr('data-fid', info.fid);

      // Add media-element class so we can find markup element later.

      var classes = ['media-element'];

      if (info.view_mode) {

        classes.push('file-' + info.view_mode.replace(/_/g, '-'));

      }

      element.addClass(classes.join(' '));

      return element;

    },

    /**

     * Create a macro representation of the inserted media element.

     *

     * @param element (jQuery object)

     *    A media element with attached serialized file info.

     */

    create_macro: function (element) {

      var file_info = Drupal.media.filter.extract_file_info(element);

      if (file_info) {

        return '[[' + JSON.stringify(file_info) + ']]';

      }

      return false;

    },

    /**

     * Extract the file info from a WYSIWYG placeholder element as JSON.

     *

     * @param element (jQuery object)

     *    A media element with associated file info via a file id (fid).

     */

    extract_file_info: function (element) {

      var fid, file_info, value;

      if (fid = element.data('fid')) {

        Drupal.media.filter.ensureDataMap();

        if (file_info = Drupal.settings.mediaDataMap[fid]) {

          file_info.attributes = {};

          $.each(Drupal.settings.media.wysiwyg_allowed_attributes, function(i, a) {

            if (value = element.attr(a)) {

              // Replace " by \" to avoid error with JSON format.

              if (typeof value == 'string') {

                value = value.replace('"', '\\"');

              }

              file_info.attributes[a] = value;

            }

          });

          // Extract the link text, if there is any.

          file_info.link_text = element.find('a').html();

        }

      }

      return file_info;

    },

    /**

     * Gets the HTML content of an element.

     *

     * @param element (jQuery object)

     */

    outerHTML: function (element) {

      return element[0].outerHTML || $('<div>').append(element.eq(0).clone()).html();

    },

    /**

     * Gets the wrapped HTML content of an element to insert into the wysiwyg.

     *

     * It also registers the element in the tag map so that the token

     * replacement works.

     *

     * @param element (jQuery object) The element to insert.

     *

     * @see Drupal.media.filter.replacePlaceholderWithToken()

     */

    getWysiwygHTML: function (element) {

      // Create the markup and the macro.

      var markup = Drupal.media.filter.outerHTML(element),

        macro = Drupal.media.filter.create_macro(element);

      // Store macro/markup in the tagmap.

      Drupal.media.filter.ensure_tagmap();

      Drupal.settings.tagmap[macro] = markup;

      // Return the html code to insert in an editor and use it with

      // replacePlaceholderWithToken()

      return markup;

    },

    /**

     * Ensures the src tracking has been initialized and returns it.

     */

    ensureSourceMap: function() {

      Drupal.settings.mediaSourceMap = Drupal.settings.mediaSourceMap || {};

      return Drupal.settings.mediaSourceMap;

    },

    /**

     * Ensures the data tracking has been initialized and returns it.

     */

    ensureDataMap: function() {

      Drupal.settings.mediaDataMap = Drupal.settings.mediaDataMap || {};

      return Drupal.settings.mediaDataMap;

    },

    /**

     * Ensures the tag map has been initialized and returns it.

     */

    ensure_tagmap: function () {

      Drupal.settings.tagmap = Drupal.settings.tagmap || {};

      return Drupal.settings.tagmap;

    }

  }

})(jQuery);