Merge pull request #39 from wrav/release/1.3.0

Changes for v1.3.0

CHANGELOG.md

@@ -1,5 +1,15 @@
 # oEmbed Changelog
 
+## 1.3.0 - 2020-03-05
+
+### Added
+- *(NEW FEATURE)* Added setting to hide preview iframe in the new a collapsable UI component.
+- *(NEW FEATURE)* Added notification by email for broken URLs which can be set up in plugin settings. This feature is still under development and new feature's like Slack, Microsoft Team notification channels will be added including support to update the notify message copy.
+
+### Updated
+- Preview iframe is now rendered into a collapsable component to save space.
+- Add `overflow:hidden` to iframe to prevent overflow ([#37](https://github.com/wrav/oembed/issues/37)).
+
 ## 1.2.5 - 2020-02-10
 
 ### Updated

composer.json

@@ -2,7 +2,7 @@
     "name": "wrav/oembed",
     "description": "A simple plugin to extract media information from websites, like youtube videos, twitter statuses or blog articles.",
     "type": "craft-plugin",
-    "version": "1.2.5",
+    "version": "1.3.0",
     "keywords": [
         "craft",
         "cms",

src/Oembed.php

@@ -10,7 +10,9 @@
 
 namespace wrav\oembed;
 
+use wrav\oembed\events\BrokenUrlEvent;
 use wrav\oembed\fields\OembedField;
+use wrav\oembed\jobs\BrokenUrlNotify;
 use wrav\oembed\services\OembedService;
 use wrav\oembed\variables\OembedVariable;
 use wrav\oembed\models\Settings;
@@ -37,6 +39,8 @@
  */
 class Oembed extends Plugin
 {
+    const EVENT_BROKEN_URL_DETECTED = 'oembedBrokenUrlDetected';
+
     // Static Properties
     // =========================================================================
 
@@ -48,6 +52,11 @@ class Oembed extends Plugin
      */
     public static $plugin;
 
+    /**
+     * @var string|null The plugin’s schema version number
+     */
+    public $schemaVersion = '1.0.1';
+
     // Public Methods
     // =========================================================================
 
@@ -116,6 +125,9 @@ function(Event $event) {
                     $url = Craft::$app->assetManager->getPublishedUrl('@wrav/oembed/assetbundles/oembed/dist/js/oembed.js', true);
 
                     echo "<script src='$url'></script>";
+
+                    $url = Craft::$app->assetManager->getPublishedUrl('@wrav/oembed/assetbundles/oembed/dist/css/oembed.css', true);
+                    echo "<link rel='stylesheet' href='$url'>";
                 }
             }
         );
@@ -128,6 +140,16 @@ function(RegisterUrlRulesEvent $event) {
             }
         );
 
+        Event::on(
+            Oembed::class,
+            Oembed::EVENT_BROKEN_URL_DETECTED,
+            function (BrokenUrlEvent $event) {
+                Craft::$app->getQueue()->push(new BrokenUrlNotify([
+                    'url' => $event->url,
+                ]));
+            }
+        );
+
         Craft::info(
             Craft::t(
                 'oembed',

src/assetbundles/oembed/OembedAsset.php

@@ -40,6 +40,7 @@ public function init()
         ];
 
         $this->css = [
+            'css/oembed.css',
         ];
 
         parent::init();

src/assetbundles/oembed/dist/css/oembed.css

@@ -0,0 +1,15 @@
+.oembed-header {
+  margin: 0.5rem 0;
+  background: #f3f7fc;
+  padding: 10px 15px;
+  cursor: pointer
+}
+
+.oembed-preview {
+  width: 100%;
+  overflow: hidden;
+}
+
+.oembed-preview iframe {
+  max-width: 100%;
+}

src/assetbundles/oembed/dist/js/oembed.js

@@ -12,6 +12,19 @@
 
 var oembedOnChangeTimeout = null;
 
+$('body').on('click', '.oembed-header', function () {
+    var oembedPreview = $(this).parent().find('.oembed-preview');
+    var icon = $(this).parent().find('.oembed-header *[data-icon-after]');
+
+    oembedPreview.toggleClass('hidden');
+
+    if(oembedPreview.hasClass('hidden')) {
+        icon.attr('data-icon-after', 'expand')
+    } else {
+        icon.attr('data-icon-after', 'collapse')
+    }
+});
+
 $('body').on('keyup blur change', 'input.oembed-field', function () {
     var that = $(this);
 

src/controllers/DefaultController.php

@@ -43,6 +43,7 @@ public function actionPreview()
                 [
                     'url' => $url,
                     'options' => $options,
+                    'settings' => Oembed::getInstance()->getSettings(),
                 ]
             );
         } catch(\Exception $exception) {

src/events/BrokenUrlEvent.php

@@ -0,0 +1,21 @@
+<?php
+namespace wrav\oembed\events;
+
+use craft;
+use craft\base\ElementInterface;
+use craft\behaviors\DraftBehavior;
+use yii\base\Event;
+
+/**
+ * Broken Url event class.
+ *
+ * @since 1.2.6
+ */
+class BrokenUrlEvent extends Event
+{
+    /**
+     * @var string The url which is broken
+     */
+    public $url;
+
+}

src/fields/OembedField.php

@@ -21,6 +21,7 @@
 use craft\helpers\Gql as GqlHelper;
 use GraphQL\Type\Definition\Type;
 use wrav\oembed\gql\OembedFieldTypeGenerator;
+use wrav\oembed\Oembed;
 use yii\db\Schema;
 use wrav\oembed\models\OembedModel;
 
@@ -146,18 +147,27 @@ public function getSettingsHtml()
      */
     public function getInputHtml($value, ElementInterface $element = null): string
     {
+        $settings = Oembed::getInstance()->getSettings();
+        $hidden = $settings['previewHidden'];
+        $previewIcon = $hidden ? 'expand' : 'collapse';
+
+
         $input = '<input name="'.$this->handle.'" class="text nicetext fullwidth oembed-field" value="'.$value.'" />';
-        $preview = '<p><strong>Preview</strong></p>';
+        $preview = '<div class="oembed-header">
+                      <p class="fullwidth"><strong>Preview</strong> <span class="right" data-icon-after="'.$previewIcon.'"></span></p>
+                    </div>';
 
         if ($value) {
             try {
                 if ($embed = new OembedModel($value)) {
                     $embed = $embed->embed();
 
+                    $hiddenClass = $hidden ? 'hidden' : '';
+
                     if (!empty($embed)) {
-                        $preview .= '<div class="oembed-preview">'.$embed->code.'</div>';
+                        $preview .= '<div class="oembed-preview '.$hiddenClass.'">'.$embed->code.'</div>';
                     } else {
-                        $preview .= '<div class="oembed-preview"><p class="error">Please check your URL.</p></div>';
+                        $preview .= '<div class="oembed-preview '.$hiddenClass.'"><p class="error">Please check your URL.</p></div>';
                     }
                 }
             } catch (\Exception $exception) {

src/jobs/BrokenUrlNotify.php

@@ -0,0 +1,52 @@
+<?php
+namespace wrav\oembed\jobs;
+
+use craft;
+use craft\base\ElementInterface;
+use craft\behaviors\DraftBehavior;
+use craft\queue\BaseJob;
+use wrav\oembed\Oembed;
+
+/**
+ * BrokenUrlNotify job class.
+ *
+ * @since 1.2.6
+ */
+class BrokenUrlNotify extends BaseJob
+{
+    public $url = null;
+
+    /**
+     * @inheritdoc
+     */
+    public function execute($queue)
+    {
+        $email = Oembed::getInstance()->getSettings()->notificationEmail;
+        $subject = Craft::$app->getSystemName() . ' :: oEmbed detected broken URL';
+
+        if (!$email) {
+            $email = \craft\helpers\App::mailSettings()->fromEmail;
+        }
+
+        if (!$email || !$this->url) {
+            return false;
+        }
+
+        return Craft::$app
+            ->getMailer()
+            ->compose()
+            ->setTo($email)
+            ->setSubject($subject)
+            ->setHtmlBody('The following URL is invalid: '.$this->url)
+            ->send();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function defaultDescription(): string
+    {
+        return Craft::t('app', 'Send notification of broken URL');
+    }
+
+}

src/models/Settings.php

@@ -28,4 +28,19 @@ class Settings extends Model
      */
     public $enableCache;
 
+    /**
+     * @var string
+     */
+    public $enableNotifications;
+
+    /**
+     * @var string
+     */
+    public $notificationEmail;
+
+    /**
+     * @var string
+     */
+    public $previewHidden;
+
 }

src/services/OembedService.php

@@ -16,6 +16,7 @@
 use DOMDocument;
 use Embed\Adapters\Adapter;
 use Embed\Embed;
+use wrav\oembed\events\BrokenUrlEvent;
 use wrav\oembed\Oembed;
 use yii\log\Logger;
 
@@ -46,14 +47,18 @@ public function embed($url, array $options = [])
             $media = Embed::create($url, $options);
 
             if (!empty($media) && !isset($media->code)) {
+                if (Oembed::getInstance()->getSettings()->enableNotifications) {
+                    if (!empty($media->getUrl())) {
+                        Oembed::getInstance()->trigger(Oembed::EVENT_BROKEN_URL_DETECTED, new BrokenUrlEvent([
+                            'url' => $media->getUrl()
+                        ]));
+                    }
+                }
+
                 $media->code = "<iframe src='$url' width='100%' frameborder='0' scrolling='no'></iframe>";
             }
         } finally {
-            if (!empty($media)) {
-                if (Oembed::getInstance()->getSettings()->enableCache) {
-                    Craft::$app->cache->set($url, $media, 'P1H');
-                }
-            } else {
+            if (empty($media)) {
                 $media = new class {
                     // Returns NULL for calls to props
                     public function __call(string $name , array $arguments )
@@ -63,7 +68,6 @@ public function __call(string $name , array $arguments )
                 };
             }
 
-
             // Wrapping to be safe :)
             try {
                 $html = $media->code;
@@ -88,7 +92,7 @@ public function __call(string $name , array $arguments )
                 if (!empty($options['width']) && is_int($options['width'])) {
                     $iframe->setAttribute('width', $options['width']);
                 }
-                
+
                 // Height - Override
                 if (!empty($options['height']) && is_int($options['height'])) {
                     $iframe->setAttribute('height', $options['height']);
@@ -115,6 +119,10 @@ public function __call(string $name , array $arguments )
                 Craft::info($exception->getMessage(), 'oembed');
             }
             finally {
+                if (Oembed::getInstance()->getSettings()->enableCache) {
+                    Craft::$app->cache->set($url, $media, 'P1H');
+                }
+
                 return $media;
             }
         }

src/templates/preview.twig

@@ -1,9 +1,7 @@
 {% set media = craft.oembed.embed(url) %}
 
 {% if media and media.code|default(false) %}
-    <div class="embed-preview">
-        {{ media.code|default('')|raw }}
-    </div>
+    {{ media.code|default('')|raw }}
 {% else %}
     <p class="error">Please check your URL.</p>
 {% endif %}

src/templates/settings.twig

@@ -17,3 +17,27 @@
     name: 'enableCache',
     on: settings.enableCache,
 }) }}
+
+{{ forms.lightswitchField({
+    label: "Previews hidden by default"|t,
+    instructions: "This will hide preview in collapsable component"|t,
+    id: 'previewHidden',
+    name: 'previewHidden',
+    on: settings.previewHidden,
+}) }}
+
+{{ forms.lightswitchField({
+    label: "Enable notifications"|t,
+    instructions: ""|t,
+    id: 'enableNotifications',
+    name: 'enableNotifications',
+    on: settings.enableNotifications,
+}) }}
+
+{{ forms.textField({
+    label: "Notification Email"|t,
+    instructions: "Will default to system email sender"|t,
+    id: 'notificationEmail',
+    name: 'notificationEmail',
+    on: settings.notificationEmail,
+}) }}