Merge pull request #19 from lowerends/add-ignored-user

Add ignored user for whom logging is disabled.

Author: freekmurze

README.md

@@ -36,7 +36,7 @@ This service provider must be registered.
 You'll also need to publish and run the migration in order to create the db-table.
 ```
 php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="migrations"
-php artisan migrate 
+php artisan migrate
 ```
 
 
@@ -65,12 +65,12 @@ The configuration will be written to  ```config/activitylog.php```. The options
 Logging some activity is very simple.
 ```php
 
-/* 
+/*
   The log-function takes two parameters:
   	- $text: the activity you wish to log.
-  	- $user: optional can be an user id or a user object. 
+  	- $user: optional can be an user id or a user object.
   	         if not proved the id of Auth::user() will be used
-  
+
 */
 Activity::log('Some activity that you wish to log');
 ```
@@ -122,6 +122,33 @@ public function getActivityDescriptionForEvent($eventName)
 ```
 The result of this function will be logged, unless the result is an empty string.
 
+### Disable logging under certain conditions
+If you want to disable logging under certain conditions, such as for a specific user, create a class in your application namespace that implements the `Spatie\Activitylog\Handlers\BeforeHandlerInterface`. This interface defines an `ignore()` method in which you can code any custom logic to determine whether logging should be ignored or not. Returning `true` from this function will ignore logging, returning `false` will continue with the logging. Add the namespaced class name to the `beforeCallback` field in the configuration file:
+```php
+'beforeCallback' => '\App\Handlers\BeforeHandler',
+```
+For example, this callback class could look like this to disable logging for the first user:
+```php
+<?php
+
+namespace App\Handlers;
+
+use Spatie\Activitylog\Handlers\BeforeHandlerInterface;
+
+class BeforeHandler implements BeforeHandlerInterface
+{
+    public function ignore()
+	{
+		if (\Auth::user()->id == 1)
+		{
+			return true;
+		}
+
+		return false;
+	}
+}
+```
+
 ### Retrieving logged entries
 All events will be logged in the `activity_log`-table. This package provides an Eloquent model to work with the table. You can use all the normal Eloquent methods that you know and love. Here's how you can get the last 100 activities together with the associated users.
 
@@ -131,6 +158,10 @@ use Spatie\Activitylog\Models\Activity;
 $latestActivities = Activity::with('user')->latest()->limit(100)->get();
 ```
 
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
 ### Cleaning up the log
 
 Over time your log will grow. To clean up the database table you can run this command:

src/Spatie/Activitylog/ActivitylogSupervisor.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Config\Repository;
 use Illuminate\Auth\Guard;
+use Spatie\Activitylog\Handlers\BeforeHandler;
 use Spatie\Activitylog\Handlers\DefaultLaravelHandler;
 use Request;
 use Config;
@@ -23,21 +24,28 @@ class ActivitylogSupervisor
      * Create the logsupervisor using a default Handler
      * Also register Laravels Log Handler if needed.
      *
-     * @param Handlers\ActivitylogHandlerInterface $handler
+     * @param Handlers\ActivitylogHandlerInterface $logHandler
+     * @param Handlers\BeforeHandlerInterface      $beforeHandler
      * @param Repository                           $config
      * @param Guard                                $auth
      */
-    public function __construct(Handlers\ActivitylogHandlerInterface $handler, Repository $config, Guard $auth)
+    public function __construct(Handlers\ActivitylogHandlerInterface $logHandler, Handlers\BeforeHandler $beforeHandler, Repository $config, Guard $auth)
     {
         $this->config = $config;
 
-        $this->logHandlers[] = $handler;
+        $this->logHandlers[] = $logHandler;
+
         if ($this->config->get('activitylog.alsoLogInDefaultLog')) {
             $this->logHandlers[] = new DefaultLaravelHandler();
         }
-        $this->auth = $auth;
 
+        if ($beforeCallback = $this->config->get('activitylog.beforeCallback')) {
+            $this->beforeHandler = new $beforeCallback;
+        } else {
+            $this->beforeHandler = $beforeHandler;
+        }
 
+        $this->auth = $auth;
     }
 
     /**
@@ -50,6 +58,10 @@ public function __construct(Handlers\ActivitylogHandlerInterface $handler, Repos
      */
     public function log($text, $userId = '')
     {
+        if ($this->beforeHandler->ignore()) {
+            return false;
+        }
+
         $userId = $this->normalizeUserId($userId);
 
         $ipAddress = Request::getClientIp();

src/Spatie/Activitylog/Handlers/BeforeHandler.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Spatie\Activitylog\Handlers;
+
+class BeforeHandler implements BeforeHandlerInterface
+{
+    /**
+     * Don't log if this function returns true.
+     *
+     * @return bool
+     */
+     public function ignore()
+     {
+         return false;
+     }
+}

src/Spatie/Activitylog/Handlers/BeforeHandlerInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Spatie\Activitylog\Handlers;
+
+interface BeforeHandlerInterface
+{
+    /**
+     * Don't log if this function returns true.
+     *
+     * @return bool
+     */
+    public function ignore();
+}

src/config/activitylog.php

@@ -34,4 +34,16 @@
     |
     */
     'defaultUserId' => '',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Handler that is called before logging is done
+    |--------------------------------------------------------------------------
+    |
+    | If you want to disable logging based on some custom conditions, create
+    | a handler class that implements the BeforeHandlerInterface and
+    | reference it here.
+    |
+    */
+    'beforeCallback' => null,
 ];

tests/ActivityLogSupervisorTest.php

@@ -6,19 +6,19 @@
 
 class ActivityLogSupervistorTest extends PHPUnit_Framework_TestCase
 {
-
     protected $logHandler;
     protected $activityLogSupervisor;
     protected $config;
 
     public function setUp()
     {
         $this->logHandler = Mockery::mock('\Spatie\Activitylog\Handlers\EloquentHandler');
+        $this->beforeHandler = Mockery::mock('\Spatie\Activitylog\Handlers\BeforeHandler');
         $this->config = Mockery::mock('\Illuminate\Config\Repository');
         $this->auth = Mockery::mock('Illuminate\Auth\Guard');
 
         $this->config->shouldReceive('get')->andReturn(false);
-        $this->activityLogSupervisor = new ActivitylogSupervisor($this->logHandler, $this->config, $this->auth);
+        $this->activityLogSupervisor = new ActivitylogSupervisor($this->logHandler, $this->beforeHandler, $this->config, $this->auth);
     }
 
     /**
@@ -57,5 +57,4 @@ public function it_normalizes_a_numeric_user_id()
 
         $this->assertSame(123, $normalizedUserId);
     }
-
-}
+}