Merge f651245 into 0ebdbd4

mikebronner · Dec 10, 2017 · cccbe51 · cccbe51
2 parents 0ebdbd4 + f651245
commit cccbe51
Show file tree

Hide file tree

Showing 8 changed files with 113 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,8 @@
 # Change Log
+## [0.6.1] - 10 Dec 2017
+### Added
+- ability to exclude a page from caffinating the application via meta tag.
+
 ## [0.6.0] - 9 Dec 2017
 ### Added
 - drip timeout check and force page refresh if timeout occurred.

diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ For Laravel 5.2, follow the directions here: https://github.com/GeneaLabs/larave
    // ];
    ```
 
-## Upgrad Notes
+## Upgrade Notes
 ### 0.6.0
 This update changes the config file setting names. Please delete the published
 config file `config/genealabs-laravel-caffeine.php` if it exists, and follow the
@@ -145,3 +145,13 @@ php artisan caffeine:publish --config
 That was it! It will apply itself automatically where it finds a form with a
 `_token` field, or a meta tag named "csrf-token", while pages are open in
 browsers.
+
+### Prevent Caffeination
+If you would like to prevent a certain page from caffeinating your application,
+then add the following meta tag:
+```php
+<meta name="caffeinated" content="false">
+```
+
+__This will only have effect if the page includes a form. If not, the page will
+not caffeinate your application anyway.__
diff --git a/resources/views/tests/disabled.blade.php b/resources/views/tests/disabled.blade.php
@@ -0,0 +1,13 @@
+@extends ('genealabs-laravel-caffeine::tests.layout')
+
+@section ('meta')
+    <meta name="caffeinated" content="false">
+@endsection
+
+@section ('content')
+    <form method="post">
+        {{ csrf_field() }}
+        <input type="hidden" name="success" value="true">
+        <input type="submit" value="Test Form Submit">
+    </form>
+@endsection
diff --git a/resources/views/tests/layout.blade.php b/resources/views/tests/layout.blade.php
@@ -5,6 +5,8 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
 
+    @yield ('meta')
+
     <!-- CSRF Token -->
     <meta name="csrf-token" content="{{ csrf_token() }}">
 
@@ -15,7 +17,9 @@
 </head>
 <body>
     <div id="app">
-        @yield('content')
+
+        @yield ('content')
+
     </div>
 
     <!-- Scripts -->

diff --git a/routes/web.php b/routes/web.php
@@ -11,7 +11,10 @@
     'as' => 'genealabs-laravel-caffeine.',
     'prefix' => 'tests'
 ], function () {
-    Route::any('form', Test::class . '@drippedForm')->name('tests.form');
+    Route::any('form', Test::class . '@drippedForm')
+        ->name('tests.form');
     Route::any('dripped-form', Test::class . '@drippedForm');
     Route::any('expiring-form', Test::class . '@expiredForm');
+    Route::any('disabled-page', Test::class . '@disabledPage')
+        ->name('tests.disabled-page');
 });
diff --git a/src/Http/Controllers/Test.php b/src/Http/Controllers/Test.php
@@ -12,4 +12,9 @@ public function drippedForm() : View
 
         return view('genealabs-laravel-caffeine::tests.form');
     }
+
+    public function disabledPage() : View
+    {
+        return view('genealabs-laravel-caffeine::tests.disabled');
+    }
 }
diff --git a/src/Http/Middleware/LaravelCaffeineDripMiddleware.php b/src/Http/Middleware/LaravelCaffeineDripMiddleware.php
@@ -9,21 +9,52 @@ class LaravelCaffeineDripMiddleware
     public function handle(Request $request, Closure $next)
     {
         $response = $next($request);
+
         $content = $response->getContent();
 
-        if (is_string($content)
-            && (strpos($content, '_token')
-                || (preg_match("/\<meta name=[\"\']csrf[_-]token[\"\']/", $content)))
-        ) {
-            $dripper = (new Dripper);
-            $content = str_replace(
-                '</body>',
-                "{$dripper->html}</body>",
-                $content
-            );
-            $response->setContent($content);
+        if (! is_string($content)) {
+            return $response;
+        }
+
+        $shouldDripRegexp = $this->makeRegex([
+            '<meta\s+',
+            '(name\s*=\s*[\'"]caffeinated[\'"]\s+content\s*=\s*[\'"]false[\'"]',
+            '|content\s*=\s*[\'"]false[\'"]\s+name\s*=\s*[\'"]caffeinated[\'"])',
+        ]);
+
+        $shouldNotDrip = preg_match($shouldDripRegexp, $content);
+
+        if ($shouldNotDrip) {
+            return $response;
+        }
+
+        $formTokenRegexp = $this->makeRegex([
+            '<input([^>]*?[\n]?)*[^>]*?name\s*=\s*[\'"]_token[\'"]',
+        ]);
+        $metaTokenRegexp = $this->makeRegex([
+            '<meta\s+',
+            'name\s*=\s*[\'"]csrf[_-]token[\'"]',
+        ]);
+        $hasNoFormToken = ! preg_match($formTokenRegexp, $content);
+        $hasNoMetaToken = ! preg_match($metaTokenRegexp, $content);
+
+        if ($hasNoFormToken && $hasNoMetaToken) {
+            return $response;
         }
 
+        $dripper = (new Dripper);
+        $content = str_replace(
+            '</body>',
+            "{$dripper->html}</body>",
+            $content
+        );
+        $response->setContent($content);
+
         return $response;
     }
+
+    protected function makeRegex(array $regexp) : string
+    {
+        return '/' . implode('', $regexp) . '/';
+    }
 }
diff --git a/tests/Feature/CaffeineTest.php b/tests/Feature/CaffeineTest.php
@@ -7,6 +7,7 @@ class CaffeineTest extends TestCase
     public function testBootstrap3TestPageCanLoad()
     {
         $dripRoute = config('genealabs-laravel-caffeine.route', 'genealabs/laravel-caffeine/drip');
+
         $response = $this->get($dripRoute);
 
         $response->assertStatus(204);
@@ -39,11 +40,18 @@ public function testSuccessfulDrip()
 
     public function testExpiredDrip()
     {
-        $dripRoute = config('genealabs-laravel-caffeine.dripInterval', 'genealabs/laravel-caffeine/drip');
+        $dripRoute = config(
+            'genealabs-laravel-caffeine.dripInterval',
+            'genealabs/laravel-caffeine/drip'
+        );
         $html = $this->get(route('genealabs-laravel-caffeine.tests.form'))
             ->getContent();
         $matches = [];
-        preg_match('/<meta name="csrf-token" content="(.*?)">/', $html, $matches);
+        preg_match(
+            '/<meta name="csrf-token" content="(.*?)">/',
+            $html,
+            $matches
+        );
         $csrfToken = $matches[1];
 
         app('session')->flush();
@@ -53,4 +61,23 @@ public function testExpiredDrip()
 
         $response->assertStatus(404);
     }
+
+    public function testDisabledCaffeination()
+    {
+        $html = $this
+            ->get(route('genealabs-laravel-caffeine.tests.disabled-page'))
+            ->getContent();
+
+        $isDisabled = (bool) preg_match(
+            '/<meta name="caffeinated" content="false">/',
+            $html
+        );
+        $hasDripper = (bool) preg_match(
+            '/\bconst caffeineSendDrip\b/',
+            $html
+        );
+
+        $this->assertTrue($isDisabled);
+        $this->assertFalse($hasDripper);
+    }
 }