# vimeography/2.2/lib/shortcode.php

Vimeography: Vimeo Video Gallery WordPress Plugin, version 2.2. 383 lines.

- Page: https://pluginprobe.com/plugins/vimeography/2.2/code/lib/shortcode.php
- Raw: https://pluginprobe.com/plugins/vimeography/2.2/raw/lib/shortcode.php
- Modified: 2021-02-24T17:08:06+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/vimeography/2.2/code/lib/shortcode.php#L10-L20`.

```php
<?php

// Exit if accessed directly
if (!defined('ABSPATH')) {
  exit();
}

class Vimeography_Shortcode extends Vimeography
{
  /**
   * The shortcode tag attributes applied by the user on a page or post.
   *
   * @var array
   */
  private $_atts;

  /**
   * The content located inside of the shortcode tag applied by the
   * user on a page or post.
   *
   * @var string
   */
  private $_content = null;

  /**
   * The id number associated with a gallery entry in the database.
   *
   * @var int or tokenized string
   */
  protected $_gallery_id;

  /**
   * The settings being used to render the current gallery.
   * This includes the theme name, resource URI, featured video, cache settings,
   * and gallery width parameter.
   *
   * @var array
   */
  private $_gallery_settings;

  /**
   * Hook into the Vimeography Shortcode and
   * add shortcode support for widgets.
   */
  public function __construct()
  {
    add_filter('widget_text', 'do_shortcode');
    add_shortcode('vimeography', array($this, 'vimeography_shortcode'));

    if (function_exists('register_block_type')) {
      register_block_type('vimeography/gallery', array(
        'editor_script' => 'vimeography-gallery-block-editor',
        'editor_style' => 'vimeography-gallery-block-editor',
        'style' => 'vimeography-gallery-block',
        'render_callback' => array($this, 'vimeography_shortcode')
      ));
    }
  }

  /**
   * Loads the gallery settings, generates any custom CSS, and creates the gallery token.
   *
   * @param array  $atts    The shortcode tag attributes applied by the user on a page or post.
   * @param string $content The content located inside of the shortcode tag.
   */
  public function vimeography_shortcode($atts, $content = null)
  {
    $this->_atts = $atts;
    $this->_content = $content;

    try {
      $this->_gallery_settings = self::_apply_shortcode_gallery_settings(
        $this->_atts
      );
      $this->_gallery_id = isset($atts['id'])
        ? intval($atts['id'])
        : self::_get_inline_gallery_id($this->_gallery_settings);

      $this->_vimeography_enqueue_custom_stylesheets();
      return $this->output();
    } catch (Vimeography_Exception $e) {
      return __("Vimeography Error: ", 'vimeography') . $e->getMessage();
    }
  }

  /**
   * Determines which gallery settings to use based on the provided
   * shortcode settings, the existing gallery db settings, and the
   * fallback gallery settings.
   *
   * @return array  The gallery settings to be used to render the current gallery.
   */
  private static function _apply_shortcode_gallery_settings($atts)
  {
    if (!empty($atts['id'])) {
      $db_gallery_settings = self::_get_db_gallery_settings(
        intval($atts['id'])
      );
    }

    // Get admin panel options
    $default_settings = get_option('vimeography_default_settings');

    $fallback_gallery_settings = array();
    $fallback_gallery_settings['theme'] = isset(
      $db_gallery_settings->theme_name
    )
      ? $db_gallery_settings->theme_name
      : $default_settings['theme_name'];
    $fallback_gallery_settings['featured'] = isset(
      $db_gallery_settings->featured_video
    )
      ? $db_gallery_settings->featured_video
      : $default_settings['featured_video'];
    $fallback_gallery_settings['endpoint'] = isset(
      $db_gallery_settings->resource_uri
    )
      ? $db_gallery_settings->resource_uri
      : $default_settings['resource_uri'];
    $fallback_gallery_settings['limit'] = isset(
      $db_gallery_settings->video_limit
    )
      ? $db_gallery_settings->video_limit
      : $default_settings['video_limit'];
    $fallback_gallery_settings['cache'] = isset(
      $db_gallery_settings->cache_timeout
    )
      ? $db_gallery_settings->cache_timeout
      : $default_settings['cache_timeout'];
    $fallback_gallery_settings['width'] = isset(
      $db_gallery_settings->gallery_width
    )
      ? $db_gallery_settings->gallery_width
      : '';

    $fallback_gallery_settings = apply_filters(
      'vimeography.gallery.settings',
      $fallback_gallery_settings,
      $atts
    );

    // Get shortcode attributes
    $shortcode_gallery_settings = shortcode_atts(
      array(
        'theme' => $fallback_gallery_settings['theme'],
        'featured' => $fallback_gallery_settings['featured'],
        'source' => $fallback_gallery_settings['endpoint'],
        'limit' => $fallback_gallery_settings['limit'],
        'cache' => $fallback_gallery_settings['cache'],
        'width' => $fallback_gallery_settings['width']
      ),
      $atts,
      'vimeography'
    );

    // Remove this line once 3.6 is the minimum supported version.
    $shortcode_gallery_settings = apply_filters(
      'vimeography-pro/do-shortcode',
      $shortcode_gallery_settings,
      '',
      $atts
    );

    $shortcode_gallery_settings['width'] = self::_validate_gallery_width(
      $shortcode_gallery_settings['width']
    );

    if (
      $shortcode_gallery_settings['source'] !=
      $fallback_gallery_settings['endpoint']
    ) {
      $shortcode_gallery_settings[
        'source'
      ] = Vimeography::validate_vimeo_source(
        $shortcode_gallery_settings['source']
      );
    }

    // Hot swap the showcases source for albums until showcases are supported via the API
    $shortcode_gallery_settings['source'] = str_replace(
      "showcases",
      "albums",
      $shortcode_gallery_settings['source']
    );

    $shortcode_gallery_settings['source'] =
      $shortcode_gallery_settings['source'] . '/videos';

    return $shortcode_gallery_settings;
  }

  /**
   * Retrieves the gallery data for the provided gallery ID.
   *
   * @return object  The settings associated with the gallery in the database.
   */
  private static function _get_db_gallery_settings($id)
  {
    global $wpdb;

    $db_gallery_settings = $wpdb->get_results(
      '
      SELECT *
      FROM ' .
        $wpdb->vimeography_gallery_meta .
        ' AS meta
      JOIN ' .
        $wpdb->vimeography_gallery .
        ' AS gallery
      ON meta.gallery_id = gallery.id
      WHERE meta.gallery_id = ' .
        $id .
        '
      LIMIT 1;
    '
    );

    if (empty($db_gallery_settings)) {
      throw new Vimeography_Exception(
        sprintf(
          __(
            'a Vimeography gallery with an ID of "%1$s" was not found.',
            'vimeography'
          ),
          intval($id)
        )
      );
    }

    return $db_gallery_settings[0];
  }

  /**
   * Verifies that the provided width setting is a valid CSS parameter
   *
   * @param  string $width
   * @return string        A percentage, pixel-based, or empty width value.
   */
  private static function _validate_gallery_width($width)
  {
    if (!empty($width)) {
      preg_match('/(\d*)(px|%?)/', $width, $matches);
      // If a number value is set...
      if (!empty($matches[1])) {
        // If a '%' or 'px' is set...
        if (!empty($matches[2])) {
          // Accept the valid matching string
          $width = $matches[0];
        } else {
          // Append a 'px' value to the matching number
          $width = $matches[1] . 'px';
        }
      } else {
        // Not a valid width
        $width = '';
      }
    }
    return $width;
  }

  /**
   * Create a gallery_id token for any inline gallery that doesn't have an id.
   *
   * @return string  A unique token representing the current gallery
   */
  private static function _get_inline_gallery_id($shortcode)
  {
    return substr(md5(serialize($shortcode)), 0, -24);
  }

  /**
   * Load any custom CSS files that have been generated by the
   * Vimegraphy theme customization tools.
   *
   * @return void
   */
  private function _vimeography_enqueue_custom_stylesheets()
  {
    $name = 'vimeography-gallery-' . $this->_gallery_id . '-custom';
    $filename = $name . '.css';
    $filepath = VIMEOGRAPHY_CUSTOMIZATIONS_PATH . $filename;
    $file_url = VIMEOGRAPHY_CUSTOMIZATIONS_URL . $filename;

    if (file_exists($filepath)) {
      $stylesheet_key = "vimeography_gallery_" . $this->_gallery_id;
      $css = file_get_contents($filepath);

      // migrate local css file to db entry
      if (function_exists('wp_update_custom_css_post')) {
        $r = wp_update_custom_css_post($css, array(
          'stylesheet' => $stylesheet_key // should be unique per gallery, copy on galleryduplicate
        ));

        unlink($filepath);
        return;
      }

      $vimeography = Vimeography::get_instance();
      $addons = $vimeography->addons->set_active_theme(
        $this->_gallery_settings['theme']
      );
      $theme = $addons->active_theme;

      $dependencies = array();

      // Make sure the current theme's stylesheet handle is set as a dependency
      if (
        version_compare($theme['version'], '2.0', '<') ||
        isset($theme['app_css'])
      ) {
        $dependencies = array(
          'vimeography-' . strtolower($this->_gallery_settings['theme'])
        );
      }

      wp_register_style(
        $name,
        $file_url,
        $dependencies,
        strval(filemtime($filepath))
      );
      wp_enqueue_style($name);
    }
  }

  /**
   * Loads the Vimeography engine and renderer and returns the rendered HTML for output.
   *
   * @return string
   */
  public function output()
  {
    $vimeography = Vimeography::get_instance();
    $addons = $vimeography->addons->set_active_theme(
      $this->_gallery_settings['theme']
    );
    $theme = $addons->active_theme;

    try {
      $engine = new \Vimeography\Engine();
      return $engine
        ->set_gallery_id($this->_gallery_id)
        ->set_gallery_settings($this->_gallery_settings)
        ->set_theme($theme)
        ->load()
        ->fetch()
        ->post_process()
        ->render();
    } catch (Vimeography_Exception $e) {
      $link = get_permalink();
      $time = current_time('timestamp', true);
      do_action('vimeography.exception.report', $e, $this, $link, $time);

      ob_start();
      ?>
        <div class="vimeography-error">
          <h2><?php _e(
            'This video gallery couldn\'t be loaded.',
            'vimeography'
          ); ?></h2>
          <p><?php echo $e->getMessage(); ?></p>
        </div>

        <style>
          .vimeography-error {
            background-color: rgba(255, 255, 255, 0.25);
            max-width: 500px;
            margin: 0 auto 2rem;
            text-align: center;
            border-radius: 4px;
            padding: 1rem;
            box-shadow: 0 2px 5px rgba(0, 0, 0, 0.05);
          }

          .vimeography-error h2 {
            font-size: 1.3rem;
          }
        </style>
      <?php return ob_get_clean();
    }
  }
}

```