init project

Author: samuraee

.gitignore

@@ -0,0 +1 @@
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Kraken Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,58 @@
+# laravel-xlog
+Extended Laravel Log Component
+XLog adds `User ID`, `User IP`, `Track ID` to each log
+
+## Installation
+
+```bash
+composer require tartan/laravel-xlog
+```
+
+Add this to your app service providers :
+```php
+    Tartan\Log\XLogServiceProvider::class,
+```
+
+## Config (optional)
+add following keys to your project .env file
+
+```ini
+# track id key
+XLOG_ADD_USERID= (default true)
+XLOG_TRACK_ID_KEY= (default xTrackId)
+```
+
+
+## Usage
+
+```php
+use Tartan\Log\XLog; // or register XLog Facade
+
+XLog::info('test message');
+XLog::notice('test message');
+XLog::warning('test message');
+XLog::error('test message');
+XLog::critical('test message');
+XLog::alert('test message');
+XLog::emergency('test message');
+```
+
+## Pass parameters
+```php
+
+// passing string
+$string = 'test'
+XLog::info('test message', [$string]);
+
+// passing array
+$array = [1,2,'test',4.2];
+XLog::info('test message', $array);
+
+```
+
+
+## Log exception
+
+```php
+XLog::exception($e, 'error');
+```

composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "tartan/laravel-xlog",
+    "version": "0.0.3",
+    "description": "extended Laravel 5.x log",
+    "keywords": ["laravel", "log", "xlog", "extended logger"],
+    "type": "laravel-component",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Aboozar Ghaffari <Tartan>",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Tartan\\Log\\": "src"
+        },
+        "files": [
+            "src/helper.php"
+        ]
+    },
+    "require": {
+        "php": ">=5.4",
+        "illuminate/support": "5.x.x"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~4.0"
+    }
+}

src/Facades/XLog.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Tartan\Log\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * Class XLog
+ * @package Tartan\XLog
+ * @author  Aboozar Ghaffari <[email protected]>
+ */
+class XLog extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor ()
+    {
+        return 'Tartan\Log\XLog';
+    }
+}

src/XLog.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Tartan\Log;
+
+use Illuminate\Support\Facades\Auth;
+use Exception;
+
+class XLog
+{
+    private static $LOG_LEVELS = ['debug', 'info', 'notice', 'warning', 'error', 'critical', 'alert', 'emergency'];
+
+    public function __call($name, $arguments)
+    {
+        if (!in_array($name, self::$LOG_LEVELS)) {
+            $name = 'debug';
+        }
+
+        return call_user_func_array(['Illuminate\Support\Facades\Log', $name], $arguments);
+    }
+
+    public static function __callStatic($name, $arguments)
+    {
+        if (session_status() == PHP_SESSION_NONE) {
+            $arguments[1]['sid'] = session_id();
+        } else {
+            $arguments[1]['sid'] = '';
+        }
+
+        $arguments[1]['uip'] = @clientIp();
+
+        // add user id to all logs
+        if (env('XLOG_ADD_USERID', true)) {
+            if (!Auth::guest()) {
+                $arguments[1]['uid'] = 'us' . Auth::user()->id . 'er'; // user id as a tag
+            }
+        }
+        $trackIdKey = env('XLOG_TRACK_ID_KEY', 'xTrackId');
+
+        // get request track ID from service container
+        if (!isset($arguments[1][$trackIdKey])) {
+            $arguments[1][$trackIdKey] = resolve($trackIdKey);
+        }
+
+        return call_user_func_array(['Illuminate\Support\Facades\Log', $name], $arguments);
+    }
+
+    public static function exception(Exception $e, $level = 'error')
+    {
+        $arguments     = [];
+        $arguments [0] = 'exception' . $e->getMessage();
+        $arguments [1] = [
+            'code' => $e->getCode(),
+            'file' => basename($e->getFile()),
+            'line' => $e->getLine(),
+        ];
+
+        return call_user_func_array(['XLog', $level], $arguments);
+    }
+}

src/XLogServiceProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Tartan\Log;
+
+use Illuminate\Support\ServiceProvider;
+
+class XLogServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register the application services.
+     */
+    public function register()
+    {
+        $this->app->singleton(env('XLOG_TRACK_ID_KEY', 'xTrackId'), function ($app) {
+            return substr(0, 10, sha1(uniqid('xTrackId')));
+        });
+
+        $this->app->singleton('XLog', function ($app) {
+            return new \Tartan\Log\XLog($app);
+        });
+    }
+}

src/helper.php

@@ -0,0 +1,27 @@
+<?php
+
+if (!function_exists('clientIp')) {
+    function clientIp()
+    {
+        foreach (array(
+                     'HTTP_CLIENT_IP',
+                     'HTTP_X_FORWARDED_FOR',
+                     'HTTP_X_FORWARDED',
+                     'HTTP_X_CLUSTER_CLIENT_IP',
+                     'HTTP_FORWARDED_FOR',
+                     'HTTP_FORWARDED',
+                     'REMOTE_ADDR'
+                 ) as $key) {
+            if (array_key_exists($key, $_SERVER) === true) {
+                foreach (explode(',', $_SERVER[$key]) as $ip) {
+                    $ip = trim($ip); // just to be safe
+                    if (filter_var($ip, FILTER_VALIDATE_IP,
+                            FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE) !== false) {
+                        return $ip;
+                    }
+                }
+            }
+        }
+        return '';
+    }
+}