Merge branch 'release/2.1.0'

Author: brandonkelly

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release Notes for Webhooks for Craft CMS
 
+## 2.1.0 - 2019-07-26
+
+### Added
+- Webhooks for element events can now be executed depending on whether the element is new, is a draft/revision, or is being duplicated/propagated/bulk-resaved. ([#14](https://github.com/craftcms/webhooks/issues/14))
+- Modules and plugins can register additional webhook filters using the new `craft\webhooks\Plugin::EVENT_REGISTER_FILTER_TYPES` event.  
+
+### Fixed
+- Fixed an error that could occur when detecting available component classes in Craft 3.2.
+
 ## 2.0.1 - 2019-03-20
 
 ### Fixed

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "craftcms/webhooks",
   "description": "Post webhooks when events are triggered in Craft CMS.",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "type": "craft-plugin",
   "keywords": [
     "html",

src/Plugin.php

@@ -4,12 +4,20 @@
 
 use Craft;
 use craft\db\Query;
+use craft\events\RegisterComponentTypesEvent;
 use craft\events\RegisterUrlRulesEvent;
 use craft\helpers\ArrayHelper;
 use craft\helpers\Db;
 use craft\helpers\Json;
 use craft\helpers\StringHelper;
 use craft\web\UrlManager;
+use craft\webhooks\filters\DraftFilter;
+use craft\webhooks\filters\DuplicatingFilter;
+use craft\webhooks\filters\FilterInterface;
+use craft\webhooks\filters\NewElementFilter;
+use craft\webhooks\filters\PropagatingFilter;
+use craft\webhooks\filters\ResavingFilter;
+use craft\webhooks\filters\RevisionFilter;
 use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\RequestOptions;
 use yii\base\Arrayable;
@@ -37,6 +45,29 @@ class Plugin extends \craft\base\Plugin
     const STATUS_REQUESTED = 'requested';
     const STATUS_DONE = 'done';
 
+    /**
+     * @event RegisterComponentTypesEvent The event that is triggered when registering filter types.
+     *
+     * Filter types must implement [[FilterInterface]].
+     * ---
+     * ```php
+     * use craft\events\RegisterComponentTypesEvent;
+     * use craft\webhooks\Plugin as Webhooks;
+     * use yii\base\Event;
+     *
+     * if (class_exists(Webhooks::class)) {
+     *     Event::on(Webhooks::class,
+     *         Webhooks::EVENT_REGISTER_FILTER_TYPES,
+     *         function(RegisterComponentTypesEvent $event) {
+     *             $event->types[] = MyFilterType::class;
+     *         }
+     *     );
+     * }
+     * ```
+     * @since 2.1
+     */
+    const EVENT_REGISTER_FILTER_TYPES = 'registerFilterTypes';
+
     // Properties
     // =========================================================================
 
@@ -48,7 +79,7 @@ class Plugin extends \craft\base\Plugin
     /**
      * @inheritdoc
      */
-    public $schemaVersion = '2.0.1';
+    public $schemaVersion = '2.1.0';
 
     // Public Methods
     // =========================================================================
@@ -79,6 +110,14 @@ public function init()
 
         foreach ($webhooks as $webhook) {
             Event::on($webhook->class, $webhook->event, function(Event $e) use ($webhook) {
+                // Make sure it passes the filters
+                foreach ($webhook->filters as $filterClass => $filterValue) {
+                    /** @var string|FilterInterface $filterClass */
+                    if (class_exists($filterClass) && !$filterClass::check($e, $filterValue)) {
+                        return;
+                    }
+                }
+
                 if ($webhook->method === 'post') {
                     // Build out the body data
                     if ($webhook->payloadTemplate) {
@@ -329,4 +368,28 @@ protected function createSettingsModel()
     {
         return new Settings();
     }
+
+    /**
+     * Returns all available filter classes.
+     *
+     * @return string[] The available field type classes
+     */
+    public function getAllFilters(): array
+    {
+        $filterTypes = [
+            NewElementFilter::class,
+            DraftFilter::class,
+            RevisionFilter::class,
+            DuplicatingFilter::class,
+            PropagatingFilter::class,
+            ResavingFilter::class,
+        ];
+
+        $event = new RegisterComponentTypesEvent([
+            'types' => $filterTypes
+        ]);
+        $this->trigger(self::EVENT_REGISTER_FILTER_TYPES, $event);
+
+        return $event->types;
+    }
 }

src/Webhook.php

@@ -47,6 +47,11 @@ class Webhook extends Model
      */
     public $event;
 
+    /**
+     * @var array
+     */
+    public $filters = [];
+
     /**
      * @var string
      */
@@ -142,6 +147,21 @@ function(string $attribute, array $params = null, Validator $validator) {
                     }
                 }
             ],
+            [
+                ['filters'],
+                function(string $attribute) {
+                    foreach ($this->filters as $class => &$value) {
+                        if ($value === 'yes') {
+                            $value = true;
+                        } else if ($value === 'no') {
+                            $value = false;
+                        }
+                        if (!is_bool($value)) {
+                            unset($this->filters[$class]);
+                        }
+                    }
+                }
+            ],
             [['userAttributes', 'senderAttributes'], 'validateAttributeList'],
             [['eventAttributes'], 'validateAttributeList', 'params' => ['regex' => '/^[a-z]\w*\.[a-z]\w*(?:\.[a-z]\w*)*$/i']],
             [['payloadTemplate'], 'validatePayloadTemplate'],

src/WebhookHelper.php

@@ -109,6 +109,7 @@ private static function _findClasses(): array
                         !class_exists($class, false) &&
                         !interface_exists($class, false) &&
                         !trait_exists($class, false) &&
+                        strpos($class, 'craft\\test\\') !== 0 &&
                         file_exists($file) &&
                         substr($class, -4) !== 'Test' &&
                         substr($class, -8) !== 'TestCase'

src/WebhookManager.php

@@ -4,6 +4,7 @@
 
 use Craft;
 use craft\db\Query;
+use craft\helpers\Json;
 use craft\helpers\StringHelper;
 use yii\base\InvalidArgumentException;
 
@@ -196,6 +197,7 @@ public function saveWebhook(Webhook $webhook, bool $runValidation = true): bool
             'name' => $name,
             'class' => $webhook->class,
             'event' => $webhook->event,
+            'filters' => Json::encode($webhook->filters),
             'method' => $webhook->method,
             'url' => $webhook->url,
             'userAttributes' => $webhook->userAttributes,
@@ -236,7 +238,7 @@ public function deleteWebhookById(int $id)
     private function _createWebhookQuery(): Query
     {
         return (new Query())
-            ->select(['id', 'groupId', 'enabled', 'name', 'class', 'event', 'method', 'url', 'userAttributes', 'senderAttributes', 'eventAttributes', 'payloadTemplate'])
+            ->select(['id', 'groupId', 'enabled', 'name', 'class', 'event', 'filters', 'method', 'url', 'userAttributes', 'senderAttributes', 'eventAttributes', 'payloadTemplate'])
             ->from(['{{%webhooks}}']);
     }
 
@@ -251,6 +253,12 @@ private function _createWebhook(array $result, bool $isMysql = null): Webhook
             $result['name'] = html_entity_decode($result['name'], ENT_QUOTES | ENT_HTML5);
         }
 
+        if ($result['filters']) {
+            $result['filters'] = Json::decode($result['filters']);
+        } else {
+            $result['filters'] = [];
+        }
+
         return new Webhook($result);
     }
 

src/assets/edit/EditAsset.php

@@ -27,4 +27,8 @@ class EditAsset extends AssetBundle
     public $js = [
         'js/EditWebhook.js',
     ];
+
+    public $css = [
+        'css/edit-webhook.css',
+    ];
 }

src/assets/edit/dist/css/edit-webhook.css

@@ -0,0 +1,43 @@
+#filter-pane,
+#filter-pane p {
+    display: inline-block;
+}
+
+#no-filters {
+    margin: 0;
+}
+
+#filters tr:first-child > * {
+    border-top: none;
+    padding-top: 0;
+}
+
+#filters tr:last-child > * {
+    border-bottom: none;
+    padding-bottom: 0;
+}
+
+#filters th {
+    font-weight: normal;
+}
+
+#filters .btngroup:focus {
+    outline: none;
+}
+
+#filters .btn[data-icon]:before {
+    margin-top: -2px;
+    width: 1em;
+}
+
+#filters .filter-yes {
+    color: #27AE60;
+}
+
+#filters .filter-no {
+    color: #D0021B;
+}
+
+#filters .filter-ignore .status {
+    margin: 0;
+}