init

Author: cesargb

.gitignore

@@ -0,0 +1,4 @@
+build
+vendor
+composer.lock
+tests/files

.travis.yml

@@ -0,0 +1,18 @@
+language: php
+
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+
+env:
+  matrix:
+    - COMPOSER_FLAGS="--prefer-lowest"
+    - COMPOSER_FLAGS=""
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+
+script:
+  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Cesar Garcia
+
+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,23 @@
+
+# PHP class to logs rotation
+PHP Class to Rotate files with compression
+
+## Usage
+
+This is an example:
+
+```php
+use use Cesargb\Log\Rotation;
+
+$fileLog='file.log';
+
+$rotation = new Rotation();
+
+$rotation->addProcessor(new GzProcessor());
+
+$rotation->addProcessor(
+    (new RotativeProcessor())->setMaxFiles(7)
+);
+
+$rotation->rotate($fileLog);
+```

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "cesargb/php-log-rotation",
+    "description": "PHP Class to rotate log files",
+    "type": "library",
+    "keywords": [
+        "php",
+        "log",
+        "rotation"
+    ],
+    "homepage": "https://github.com/cesargb/php-log-rotation",
+    "authors": [
+	{
+		"name": "Cesar Garcia",
+		"email": "cesargb@gmail.com"
+	}
+    ],
+    "license": "MIT",
+    "require": {
+        "php": "^5.6 || ^7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Cesargb\\Log\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Cesargb\\Log\\Test\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.7 || ^7.0"
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="League Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="tap" target="build/report.tap"/>
+        <log type="junit" target="build/report.junit.xml"/>
+        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-text" target="build/coverage.txt"/>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+</phpunit>

src/Exceptions/DirectoryIsNotValid.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Cesargb\Log\Exceptions;
+
+use Exception;
+
+class DirectoryIsNotValid extends Exception
+{
+    public function __construct($dir, $message) {
+        parent::__construct(sprintf('The dir %s is not writable: %s.', $dir, $message), 0, null);
+    }
+}

src/Exceptions/FileIsNotValid.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Cesargb\Log\Exceptions;
+
+use Exception;
+
+class FileIsNotValid extends Exception
+{
+    public function __construct($file, $message) {
+        parent::__construct(sprintf('The file %s %s.', $file, $message), 0, null);
+    }
+}

src/Exceptions/RotateFailed.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Cesargb\Log\Exceptions;
+
+use Exception;
+
+class RotateFailed extends Exception
+{
+    public function __construct($fileSource, $fileDestination, $message = '') {
+        parent::__construct(sprintf('Fail to move data from file %s to %s: %s.', $fileSource, $fileDestination, $message), 0, null);
+    }
+}

src/Handlers/AbstractHandler.php

@@ -0,0 +1,106 @@
+<?php
+
+namespace Cesargb\Log\Handlers;
+
+use Exception;
+use Cesargb\Log\Exceptions\RotateFailed;
+use Cesargb\Log\Exceptions\FileIsNotValid;
+use Cesargb\Log\Exceptions\DirectoryIsNotValid;
+
+abstract class AbstractHandler implements HandlerInterface
+{
+
+    protected $file;
+
+    protected $compress;
+
+    public function __construct($file, bool $compress = true)
+    {
+        $this->file = $file;
+
+        $this->compress = $compress;
+
+        clearstatcache();
+    }
+
+    protected function validateSource()
+    {
+        if (! is_writable($this->file)) {
+            return new FileIsNotValid($this->file, 'is not writable');
+        }
+
+        return true;
+    }
+
+    protected function validateDestination($fileDestination)
+    {
+        $dir_destination = dirname($fileDestination);
+
+        if (! is_dir($dir_destination)) {
+            if (! file_exists($dir_destination)) {
+                if (! mkdir($dir_destination, 0777, true)) {
+                    return new DirectoryIsNotValid($this->file, 'Not is writable');
+                }
+            } else {
+                return new DirectoryIsNotValid($this->file, 'Exists and is not a directory');
+            }
+        }
+
+        if (! is_writable($dir_destination)) {
+            return new DirectoryIsNotValid($this->file, 'Not is writable');
+        }
+
+        return true;
+    }
+
+    protected function moveTo($fileDestination)
+    {
+        if ($e = $this->validateSource($this->file) !== true) {
+            return $e;
+        }
+
+        if ($e = $this->validateDestination($fileDestination) !== true) {
+            return $e;
+        }
+
+        if (filesize($this->file) == 0) {
+            return true;
+        }
+
+        $fdSource = fopen($this->file, 'r+');
+
+        if (! $fdSource) {
+            return new FileIsNotValid($this->file, 'is not writable');
+        }
+
+        if (! flock($fdSource, LOCK_EX)) {
+            fclose($fdSource);
+
+            return new FileIsNotValid($this->file, 'is not lockeable');
+        }
+
+        if (! copy($this->file, $fileDestination)) {
+            fclose($fdSource);
+
+            return new RotateFailed($this->file, $fileDestination, 'fail to copy data');
+        }
+
+        if (! ftruncate($fdSource, 0)) {
+            fclose($fdSource);
+
+            unlink($fileDestination);
+
+            return new FileIsNotValid($this->file, 'fail to truncate');
+        }
+
+        flock($fdSource, LOCK_UN);
+
+        fflush($fdSource);
+
+        fclose($fdSource);
+
+        clearstatcache();
+
+        return true;
+    }
+}