├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── composer.json
├── spec
    └── Umpirsky
    │   └── PermissionsHandler
    │       ├── ConfigurationSpec.php
    │       └── SetfaclPermissionsSetterSpec.php
└── src
    └── PermissionsHandler
        ├── ChmodPermissionsSetter.php
        ├── Configuration.php
        ├── Exception
            ├── ExceptionInterface.php
            ├── InvalidConfigurationException.php
            └── PathNotFoundException.php
        ├── PermissionsSetter.php
        ├── PermissionsSetterInterface.php
        ├── ScriptHandler.php
        └── SetfaclPermissionsSetter.php


/.gitignore:
--------------------------------------------------------------------------------
1 | /bin
2 | vendor
3 | composer.lock
4 | .idea
5 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 | php:
3 |     - 7.2
4 | 
5 | install:
6 |     - composer install
7 | 
8 | script: php bin/phpspec run -f pretty
9 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2012 Saša Stamenković <umpirsky@gmail.com>
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | of this software and associated documentation files (the "Software"), to deal
 5 | in the Software without restriction, including without limitation the rights
 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | copies of the Software, and to permit persons to whom the Software is furnished
 8 | to do so, subject to the following conditions:
 9 | 
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 | 
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | THE SOFTWARE.
20 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <h3 align="center">
 2 |     <a href="https://github.com/umpirsky">
 3 |         <img src="https://farm2.staticflickr.com/1709/25098526884_ae4d50465f_o_d.png" />
 4 |     </a>
 5 | </h3>
 6 | <p align="center">
 7 |   <a href="https://github.com/umpirsky/Symfony-Upgrade-Fixer">symfony upgrade fixer</a> &bull;
 8 |   <a href="https://github.com/umpirsky/Twig-Gettext-Extractor">twig gettext extractor</a> &bull;
 9 |   <a href="https://github.com/umpirsky/wisdom">wisdom</a> &bull;
10 |   <a href="https://github.com/umpirsky/centipede">centipede</a> &bull;
11 |   <b>permissions handler<b> &bull;
12 |   <a href="https://github.com/umpirsky/Extraload">extraload</a> &bull;
13 |   <a href="https://github.com/umpirsky/Gravatar">gravatar</a> &bull;
14 |   <a href="https://github.com/umpirsky/locurro">locurro</a> &bull;
15 |   <a href="https://github.com/umpirsky/country-list">country list</a> &bull;
16 |   <a href="https://github.com/umpirsky/Transliterator">transliterator</a>
17 | </p>
18 | 
19 | # Composer Permissions Handler [![Build Status](https://travis-ci.org/umpirsky/PermissionsHandler.svg?branch=master)](https://travis-ci.org/umpirsky/PermissionsHandler)
20 | 
21 | Composer script handling directories permissions by making them writable both by the web server and the command line user.
22 | 
23 | ## Usage
24 | 
25 | Add the following in your root composer.json file:
26 | 
27 | ```json
28 | {
29 |     "require": {
30 |         "umpirsky/composer-permissions-handler": "~1.0"
31 |     },
32 |     "scripts": {
33 |         "post-install-cmd": [
34 |             "Umpirsky\\PermissionsHandler\\ScriptHandler::setPermissions"
35 |         ]
36 |     },
37 |     "extra": {
38 |         "writable-dirs": ["app/cache", "app/logs"]
39 |     }
40 | }
41 | ```
42 | 
43 | `app/cache` and `app/logs` are directories we want writable by the web server and the command line user.
44 | 
45 | ## Examples
46 | 
47 | * [Symfony](https://github.com/umpirsky/symfony-standard/tree/feature/permissions-handler)
48 | * [Lavarel](https://github.com/umpirsky/laravel/tree/feature/permissions-handler)
49 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "umpirsky/composer-permissions-handler",
 3 |     "description": "Composer script handling directories permissions by making them writable both by the web server and the command line user.",
 4 |     "keywords": [
 5 |         "permissions handling"
 6 |     ],
 7 |     "license": "MIT",
 8 |     "authors": [
 9 |         {
10 |             "name": "Saša Stamenković",
11 |             "email": "umpirsky@gmail.com"
12 |         }
13 |     ],
14 |     "require": {
15 |         "php": "^7.2 || ^8.0",
16 |         "symfony/process": "^2.3 || ^3.0 || ^4.0 || ^5.0"
17 |     },
18 |     "require-dev": {
19 |         "composer/composer": "^2.2.4",
20 |         "phpspec/phpspec": "^7.1"
21 |     },
22 |     "autoload": {
23 |         "psr-4": {
24 |             "Umpirsky\\": "src",
25 |             "Spec\\": "spec"
26 |         }
27 |     },
28 |     "config": {
29 |         "bin-dir": "bin"
30 |     },
31 |     "branch-alias": {
32 |         "dev-master": "1.0-dev"
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/spec/Umpirsky/PermissionsHandler/ConfigurationSpec.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Spec\Umpirsky\PermissionsHandler;
 6 | 
 7 | use Composer\Composer;
 8 | use Composer\Package\PackageInterface;
 9 | use Composer\Script\Event;
10 | use PhpSpec\ObjectBehavior;
11 | 
12 | class ConfigurationSpec extends ObjectBehavior
13 | {
14 |     function let(Event $event, Composer $composer, PackageInterface $package)
15 |     {
16 |         $this->beConstructedWith($event);
17 | 
18 |         $event->getComposer()->shouldBeCalled()->willReturn($composer);
19 |         $composer->getPackage()->shouldBeCalled()->willReturn($package);
20 |         $package->getExtra()->shouldBeCalled()->willReturn(
21 |             ['writable-dirs' => ['app/cache', 'app/logs']]
22 |         );
23 |     }
24 | 
25 |     function it_is_initializable()
26 |     {
27 |         $this->shouldHaveType('APP\PermissionsHandler\Configuration');
28 |     }
29 | 
30 |     function it_gets_writable_dirs()
31 |     {
32 |         $this->getWritableDirs()->shouldReturn(['app/cache', 'app/logs']);
33 |     }
34 | 
35 |     function it_throws_exception_if_writable_dirs_are_not_configured($package)
36 |     {
37 |         $package->getExtra()->shouldBeCalled()->willReturn([]);
38 | 
39 |         $this->shouldThrow('APP\PermissionsHandler\Exception\InvalidConfigurationException')->duringGetWritableDirs();
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/spec/Umpirsky/PermissionsHandler/SetfaclPermissionsSetterSpec.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Spec\Umpirsky\PermissionsHandler;
 6 | 
 7 | use PhpSpec\ObjectBehavior;
 8 | use Symfony\Component\Process\Process;
 9 | 
10 | class SetfaclPermissionsSetterSpec extends ObjectBehavior
11 | {
12 |     function let(Process $process)
13 |     {
14 |         $this->beConstructedWith($process);
15 |     }
16 | 
17 |     function it_is_initializable()
18 |     {
19 |         $this->shouldHaveType('APP\PermissionsHandler\SetfaclPermissionsSetter');
20 |     }
21 | 
22 |     function it_is_permissions_setter()
23 |     {
24 |         $this->shouldHaveType('APP\PermissionsHandler\PermissionsSetterInterface');
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/ChmodPermissionsSetter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler;
 6 | 
 7 | use Umpirsky\PermissionsHandler\Exception\PathNotFoundException;
 8 | 
 9 | class ChmodPermissionsSetter extends PermissionsSetter
10 | {
11 |     public function setPermissions($path)
12 |     {
13 |         if (!is_dir($path)) {
14 |             throw new PathNotFoundException($path);
15 |         }
16 | 
17 |         $this->runCommand('chmod +a "%httpduser% allow delete,write,append,file_inherit,directory_inherit" %path%', $path);
18 |         $this->runCommand('chmod +a "`whoami` allow delete,write,append,file_inherit,directory_inherit" %path%', $path);
19 |     }
20 | }
21 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/Configuration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler;
 6 | 
 7 | use Umpirsky\PermissionsHandler\Exception\InvalidConfigurationException;
 8 | use Composer\Script\Event;
 9 | 
10 | class Configuration
11 | {
12 |     private $configuration;
13 | 
14 |     public function __construct(Event $event)
15 |     {
16 |         $this->configuration = $event->getComposer()
17 |             ->getPackage()
18 |             ->getExtra();
19 |     }
20 | 
21 |     /**
22 |      * @return array
23 |      */
24 |     public function getWritableDirs(): array
25 |     {
26 |         if (!isset($this->configuration['writable-dirs'])) {
27 |             throw new InvalidConfigurationException('The writable-dirs must be specified in composer arbitrary extra data.');
28 |         }
29 | 
30 |         if (!is_array($this->configuration['writable-dirs'])) {
31 |             throw new InvalidConfigurationException('The writable-dirs must be an array.');
32 |         }
33 | 
34 |         return $this->configuration['writable-dirs'];
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/Exception/ExceptionInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler\Exception;
 6 | 
 7 | interface ExceptionInterface
 8 | {
 9 | }
10 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/Exception/InvalidConfigurationException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler\Exception;
 6 | 
 7 | use InvalidArgumentException;
 8 | 
 9 | class InvalidConfigurationException extends InvalidArgumentException implements ExceptionInterface
10 | {
11 | }
12 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/Exception/PathNotFoundException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler\Exception;
 6 | 
 7 | use InvalidArgumentException;
 8 | 
 9 | class PathNotFoundException extends InvalidArgumentException implements ExceptionInterface
10 | {
11 |     public function __construct(Process $process)
12 |     {
13 |         parent::__construct(sprintf('Path "%s" not found.', $path));
14 |     }
15 | }
16 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/PermissionsSetter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler;
 6 | 
 7 | use Symfony\Component\Process\Exception\ProcessFailedException;
 8 | use Symfony\Component\Process\Process;
 9 | 
10 | abstract class PermissionsSetter implements PermissionsSetterInterface
11 | {
12 |     private $process;
13 | 
14 |     public function __construct(Process $process = null)
15 |     {
16 |         $this->process = $process;
17 |     }
18 | 
19 |     /**
20 |      * @return string
21 |      */
22 |     protected function getHttpdUser(): string
23 |     {
24 |         return $this->runProcess(
25 |             "ps aux | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\  -f1"
26 |         );
27 |     }
28 | 
29 |     /**
30 |      * @param $command
31 |      * @param $path
32 |      * @return void
33 |      */
34 |     protected function runCommand($command, $path)
35 |     {
36 |         $this->runProcess(str_replace(
37 |             ['%httpduser%', '%path%'],
38 |             [$this->getHttpdUser(), $path],
39 |             $command
40 |         ));
41 |     }
42 | 
43 |     /**
44 |      * @param $commandline
45 |      * @return string
46 |      */
47 |     protected function runProcess($commandline): string
48 |     {
49 |         if (null === $this->process) {
50 |             $this->process = new Process(null);
51 |         }
52 | 
53 |         $this->process->setCommandLine($commandline);
54 |         $this->process->run();
55 |         if (!$this->process->isSuccessful()) {
56 |             throw new ProcessFailedException($this->process);
57 |         }
58 | 
59 |         return trim($this->process->getOutput());
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/PermissionsSetterInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler;
 6 | 
 7 | interface PermissionsSetterInterface
 8 | {
 9 |     public function setPermissions($path);
10 | }
11 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/ScriptHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler;
 6 | 
 7 | use Composer\Script\Event;
 8 | use Symfony\Component\Process\Exception\ProcessFailedException;
 9 | 
10 | class ScriptHandler
11 | {
12 |     /**
13 |      * @param Event $event
14 |      * @return void
15 |      */
16 |     public static function setPermissions(Event $event)
17 |     {
18 |         if ('WIN' === strtoupper(substr(PHP_OS, 0, 3))) {
19 |             $event->getIO()->write('<info>No permissions setup is required on Windows.</info>');
20 | 
21 |             return;
22 |         }
23 | 
24 |         $event->getIO()->write('Setting up permissions.');
25 | 
26 |         try {
27 |             self::setPermissionsSetfacl($event);
28 | 
29 |             return;
30 |         } catch (ProcessFailedException $setfaclException) {
31 |             $event->getIO()->write(sprintf('<error>%s</error>', $setfaclException->getMessage()));
32 |             $event->getIO()->write('<info>Trying chmod...</info>');
33 |         }
34 | 
35 |         try {
36 |             self::setPermissionsChmod($event);
37 | 
38 |             return;
39 |         } catch (ProcessFailedException $chmodException) {
40 |             $event->getIO()->write(sprintf('<error>%s</error>', $chmodException->getMessage()));
41 |         }
42 |     }
43 | 
44 |     /**
45 |      * @param Event $event
46 |      * @return void
47 |      */
48 |     public static function setPermissionsSetfacl(Event $event)
49 |     {
50 |         self::setPermissionsWithSetter($event, new SetfaclPermissionsSetter());
51 |     }
52 | 
53 |     /**
54 |      * @param Event $event
55 |      * @return void
56 |      */
57 |     public static function setPermissionsChmod(Event $event)
58 |     {
59 |         self::setPermissionsWithSetter($event, new ChmodPermissionsSetter());
60 |     }
61 | 
62 |     /**
63 |      * @param Event $event
64 |      * @param PermissionsSetterInterface $permissionsSetter
65 |      * @return void
66 |      */
67 |     private static function setPermissionsWithSetter(Event $event, PermissionsSetterInterface $permissionsSetter)
68 |     {
69 |         foreach ((new Configuration($event))->getWritableDirs() as $path) {
70 |             $permissionsSetter->setPermissions($path);
71 |         }
72 |     }
73 | }
74 | 


--------------------------------------------------------------------------------
/src/PermissionsHandler/SetfaclPermissionsSetter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Umpirsky\PermissionsHandler;
 6 | 
 7 | use Umpirsky\PermissionsHandler\Exception\PathNotFoundException;
 8 | 
 9 | class SetfaclPermissionsSetter extends PermissionsSetter
10 | {
11 |     /**
12 |      * @param $path
13 |      * @return void
14 |      */
15 |     public function setPermissions($path)
16 |     {
17 |         if (!is_dir($path)) {
18 |             throw new PathNotFoundException($path);
19 |         }
20 | 
21 |         $this->runCommand('setfacl -m u:"%httpduser%":rwX -m u:`whoami`:rwX %path%', $path);
22 |         $this->runCommand('setfacl -d -m u:"%httpduser%":rwX -m u:`whoami`:rwX %path%', $path);
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------