v1.2.3

.env.sample

@@ -5,7 +5,7 @@ UI_PATH=./ui
 COMPOSE_PROJECT_NAME=emails
 COMPOSE_PATH_SEPARATOR=:
 COMPOSE_FILE=./docker-compose.yml:${CLI_PATH}/docker-compose.yml:${API_PATH}/docker-compose.yml:${UI_PATH}/docker-compose.yml
-COMPOSE_PROFILES=api,ui
+COMPOSE_PROFILES=api,ui,cli
 
 ATT_PATH=./attachments
 LOGS_PATH=./logs

README.md

@@ -6,3 +6,52 @@ Grab attachments from emails by inbox.
 * Choose what mailboxes to watch.
 * Select messages that you want to grab attachments from.
 * Download (or view in browser) (decrypted) attachments from messages.
+
+## Requirements
+
+* Docker with Docker Compose [https://www.docker.com/](https://www.docker.com/)
+
+## Installation
+
+1. Pull from repository
+    ```
+    git pull git@git.provm.cl:Incoviba/emails.git
+    ```
+    Change to latest release
+    ```
+    git checkout release
+    ```
+2. Check the docker-compose.yml files
+   1. docker-compose.yml - central proxy container
+   2. api/docker-compose.yml - API container and database
+   3. cli/docker-compose.yml - CLI container that runs cron jobs
+   4. ui/docker-compose.yml - UI container
+3. Generate the API Key
+   If you have openssl (comes with most linux distros) you can run this in terminal
+   ```
+   echo API_KEY=`(openssl rand -hex 128)` >> .key.env
+   ```
+4. Check Environment files
+   1. .env - Docker Compose and Environment settings. Check volumes and ports.
+   2. .key.env - API_KEY, generated before.
+   3. .mail.env - Email Identification.
+   4. api/.env - Encrypted PDF files passwords.
+   5. api/.db.env - Database configuration.
+   6. cli/.env - API_URI, for connecting to the api container from the cli container. Change it if the api is someplace else.
+   7. ui/.env - API_URI, same as from the cli.
+5. Check if every configuration is correct before starting the application
+   ```
+   docker compose config
+   ```
+   If everything is fine
+   ```
+   docker compose up -d
+   ```
+6. Connect to the UI
+   Default [http://localhost:8000](http://localhost:8000)
+
+## Development
+When development there is a container for adminer, to use it you can add it into `COMPOSE_PROFILES` or run
+```
+docker compose up -d adminer
+```

api/.adminer.env.sample

@@ -0,0 +1,2 @@
+ADMINER_DESIGN=dracula
+ADMINER_PLUGINS="tables-filter table-indexes-structure table-structure struct-comments json-column edit-calendar edit-textarea dump-bz2 dump-date dump-json dump-php enum-option"

api/.db.env.sample

@@ -0,0 +1,4 @@
+MYSQL_ROOT_PASSWORD=
+MYSQL_DATABASE=
+MYSQL_USER=
+MYSQL_PASSWORD=

api/.env.sample

@@ -0,0 +1,2 @@
+PASSWORDS_SEPARATOR=,
+PASSWORDS=

api/.mail.env.sample

@@ -2,5 +2,4 @@ EMAIL_HOST=imap.gmail.com
 EMAIL_PORT=993
 EMAIL_USERNAME=@gmail.com
 EMAIL_PASSWORD=
-EMAIL_FOLDER=
-ATTACHMENTS_FOLDER=/attachments
+ATTACHMENTS_FOLDER=/attachments

api/common/Middleware/Logging.php

@@ -0,0 +1,38 @@
+<?php
+namespace ProVM\Common\Middleware;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Psr\Log\LoggerInterface;
+
+class Logging
+{
+    public function __construct(LoggerInterface $logger) {
+        $this->setLogger($logger);
+    }
+
+    protected LoggerInterface $logger;
+
+    public function getLogger(): LoggerInterface
+    {
+        return $this->logger;
+    }
+
+    public function setLogger(LoggerInterface $logger): Logging
+    {
+        $this->logger = $logger;
+        return $this;
+    }
+
+    public function __invoke(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        $response = $handler->handle($request);
+        $output = [
+            'uri' => var_export($request->getUri(), true),
+            'body' => $request->getBody()->getContents()
+        ];
+        $this->getLogger()->info(\Safe\json_encode($output, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
+        return $response;
+    }
+}

api/docker-compose.yml

@@ -18,7 +18,7 @@ services:
     env_file:
       - ${API_PATH:-.}/.env
       - ${API_PATH:-.}/.db.env
-      - .mail.env
+      - ${API_PATH:-.}/.mail.env
       - .key.env
     volumes:
       - ${API_PATH:-.}/:/app/api

api/public/index.php

@@ -8,6 +8,11 @@ Monolog\ErrorHandler::register($app->getContainer()->get(Psr\Log\LoggerInterface
 try {
     $app->run();
 } catch (Error | Exception $e) {
-    $app->getContainer()->get(Psr\Log\LoggerInterface::class)->error($e);
+    $logger = $app->getContainer()->get(Psr\Log\LoggerInterface::class);
+    if (isset($_REQUEST)) {
+        $logger->debug(Safe\json_encode(compact('_REQUEST')));
+    }
+    $logger->debug(Safe\json_encode(compact('_SERVER')));
+    $logger->error($e);
     throw $e;
 }

api/setup/middleware/98_log.php

@@ -0,0 +1,2 @@
+<?php
+$app->add($app->getContainer()->get(ProVM\Common\Middleware\Logging::class));

api/setup/settings/02_folders.php

@@ -18,4 +18,5 @@ return [
         ]);
     },
     'attachments_folder' => $_ENV['ATTACHMENTS_FOLDER'],
-];
+    'logs_folder' => '/logs',
+];

api/setup/setups/04_middlewares.php

@@ -7,5 +7,8 @@ return [
             $container->get(Nyholm\Psr7\Factory\Psr17Factory::class),
             $container->get(Psr\Log\LoggerInterface::class)
         );
+    },
+    ProVM\Common\Middleware\Logging::class => function(ContainerInterface $container) {
+        return new ProVM\Common\Middleware\Logging($container->get('request_logger'));
     }
-];
+];

api/setup/setups/98_log.php

@@ -10,13 +10,23 @@ return [
         $handler->setFormatter($container->get(Monolog\Formatter\SyslogFormatter::class));
         return $handler;
     },
+    'request_logger' => function(ContainerInterface $container) {
+        $logger = new Monolog\Logger('request_logger');
+        $handler = new Monolog\Handler\RotatingFileHandler(implode(DIRECTORY_SEPARATOR, [$container->get('logs_folder'), 'requests.log']));
+        $handler->setFormatter($container->get(Monolog\Formatter\SyslogFormatter::class));
+        $dedupHandler = new Monolog\Handler\DeduplicationHandler($handler, null, Monolog\Level::Info);
+        $logger->pushHandler($dedupHandler);
+        $logger->pushProcessor($container->get(Monolog\Processor\PsrLogMessageProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\IntrospectionProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\MemoryUsageProcessor::class));
+        return $logger;
+    },
     Psr\Log\LoggerInterface::class => function(ContainerInterface $container) {
         $logger = new Monolog\Logger('file_logger');
         $logger->pushHandler($container->get(Monolog\Handler\DeduplicationHandler::class));
-        //$logger->pushHandler($container->get(Monolog\Handler\RotatingFileHandler::class));
         $logger->pushProcessor($container->get(Monolog\Processor\PsrLogMessageProcessor::class));
         $logger->pushProcessor($container->get(Monolog\Processor\IntrospectionProcessor::class));
         $logger->pushProcessor($container->get(Monolog\Processor\MemoryUsageProcessor::class));
         return $logger;
     }
-];
+];

cli/.env.sample

@@ -0,0 +1 @@
+API_URI=http://proxy:8080

cli/common/Middleware/Logging.php

@@ -0,0 +1,38 @@
+<?php
+namespace ProVM\Common\Middleware;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Psr\Log\LoggerInterface;
+
+class Logging
+{
+    public function __construct(LoggerInterface $logger) {
+        $this->setLogger($logger);
+    }
+
+    protected LoggerInterface $logger;
+
+    public function getLogger(): LoggerInterface
+    {
+        return $this->logger;
+    }
+
+    public function setLogger(LoggerInterface $logger): Logging
+    {
+        $this->logger = $logger;
+        return $this;
+    }
+
+    public function __invoke(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        $response = $handler->handle($request);
+        $output = [
+            'uri' => var_export($request->getUri(), true),
+            'body' => $request->getBody()->getContents()
+        ];
+        $this->getLogger()->info(\Safe\json_encode($output, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
+        return $response;
+    }
+}

cli/public/index.php

@@ -4,9 +4,12 @@ $app = require_once implode(DIRECTORY_SEPARATOR, [
     'setup',
     'app.php'
 ]);
+Monolog\ErrorHandler::register($app->getContainer()->get(Psr\Log\LoggerInterface::class));
 try {
     $app->run();
 } catch (Error | Exception $e) {
-    $app->getContainer()->get(\Psr\Log\LoggerInterface::class)->error($e);
+    $logger = $app->getContainer()->get(Psr\Log\LoggerInterface::class);
+    $logger->debug(Safe\json_encode(compact('_SERVER')));
+    $logger->error($e);
     throw $e;
 }

cli/setup/middleware/98_log.php

@@ -0,0 +1,2 @@
+<?php
+$app->add($app->getContainer()->get(ProVM\Common\Middleware\Logging::class));

cli/setup/settings/02_folders.php

@@ -14,5 +14,6 @@ return [
             $container->get('resources_folder'),
             'commands'
         ]);
-    }
+    },
+    'logs_folder' => '/logs',
 ];

cli/setup/setups/03_middleware.php

@@ -0,0 +1,8 @@
+<?php
+use Psr\Container\ContainerInterface;
+
+return [
+    ProVM\Common\Middleware\Logging::class => function(ContainerInterface $container) {
+        return new ProVM\Common\Middleware\Logging($container->get('request_logger'));
+    }
+];

cli/setup/setups/98_log.php

@@ -2,14 +2,28 @@
 use Psr\Container\ContainerInterface;
 
 return [
-    \Monolog\Handler\RotatingFileHandler::class => function(ContainerInterface $container) {
-        $handler = new \Monolog\Handler\RotatingFileHandler($container->get('log_file'));
-        $handler->setFormatter($container->get(\Monolog\Formatter\LineFormatter::class));
+    Monolog\Handler\RotatingFileHandler::class => function(ContainerInterface $container) {
+        $handler = new Monolog\Handler\RotatingFileHandler($container->get('log_file'));
+        $handler->setFormatter($container->get(Monolog\Formatter\LineFormatter::class));
         return $handler;
     },
-    \Psr\Log\LoggerInterface::class => function(ContainerInterface $container) {
-        $logger = new \Monolog\Logger('file_logger');
-        $logger->pushHandler($container->get(\Monolog\Handler\RotatingFileHandler::class));
+    'request_logger' => function(ContainerInterface $container) {
+        $logger = new Monolog\Logger('request_logger');
+        $handler = new Monolog\Handler\RotatingFileHandler(implode(DIRECTORY_SEPARATOR, [$container->get('logs_folder'), 'requests.log']));
+        $handler->setFormatter($container->get(Monolog\Formatter\SyslogFormatter::class));
+        $dedupHandler = new Monolog\Handler\DeduplicationHandler($handler, null, Monolog\Level::Info);
+        $logger->pushHandler($dedupHandler);
+        $logger->pushProcessor($container->get(Monolog\Processor\PsrLogMessageProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\IntrospectionProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\MemoryUsageProcessor::class));
         return $logger;
-    }
-];
+    },
+    Psr\Log\LoggerInterface::class => function(ContainerInterface $container) {
+        $logger = new Monolog\Logger('file_logger');
+        $logger->pushHandler($container->get(Monolog\Handler\RotatingFileHandler::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\PsrLogMessageProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\IntrospectionProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\MemoryUsageProcessor::class));
+        return $logger;
+    },
+];

ui/.env.sample

@@ -0,0 +1 @@
+API_URI=http://proxy:8080

ui/common/Controller/Api.php

@@ -4,14 +4,13 @@ namespace ProVM\Common\Controller;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use ProVM\Common\Service\Api as Service;
+use Psr\Log\LoggerInterface;
 
 class Api
 {
-    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, Service $service): ResponseInterface
+    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, Service $service, LoggerInterface $logger): ResponseInterface
     {
-        $body = $request->getBody();
-        $json = \Safe\json_decode($body->getContents(), JSON_OBJECT_AS_ARRAY);
-
+        $json = $request->getParsedBody();
         return $service->sendRequest($json);
     }
 }

ui/common/Middleware/Logging.php

@@ -0,0 +1,38 @@
+<?php
+namespace ProVM\Common\Middleware;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+use Psr\Log\LoggerInterface;
+
+class Logging
+{
+    public function __construct(LoggerInterface $logger) {
+        $this->setLogger($logger);
+    }
+
+    protected LoggerInterface $logger;
+
+    public function getLogger(): LoggerInterface
+    {
+        return $this->logger;
+    }
+
+    public function setLogger(LoggerInterface $logger): Logging
+    {
+        $this->logger = $logger;
+        return $this;
+    }
+
+    public function __invoke(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
+    {
+        $response = $handler->handle($request);
+        $output = [
+            'uri' => var_export($request->getUri(), true),
+            'body' => $request->getParsedBody()
+        ];
+        $this->getLogger()->info(\Safe\json_encode($output, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
+        return $response;
+    }
+}

ui/public/index.php

@@ -8,6 +8,11 @@ Monolog\ErrorHandler::register($app->getContainer()->get(Psr\Log\LoggerInterface
 try {
     $app->run();
 } catch (Error | Exception $e) {
-    $app->getContainer()->get(Psr\Log\LoggerInterface::class)->error($e);
+    $logger = $app->getContainer()->get(Psr\Log\LoggerInterface::class);
+    if (isset($_REQUEST)) {
+        $logger->debug(Safe\json_encode(compact('_REQUEST')));
+    }
+    $logger->debug(Safe\json_encode(compact('_SERVER')));
+    $logger->error($e);
     throw $e;
 }

ui/resources/routes/98_api.php

@@ -1,4 +1,4 @@
 <?php
 use ProVM\Common\Controller\Api;
 
-$app->post('/api', Api::class);
+$app->post('/api[/]', Api::class);

ui/resources/views/emails/show.blade.php

@@ -3,7 +3,7 @@
 @section('emails_content')
     <h3>Message - <span id="subject"></span> - <span id="from"></span></h3>
     <h4 id="date_time"></h4>
-    <div class="ui list" id="attachments"></div>
+    <div class="ui bulleted link list" id="attachments"></div>
 @endsection
 
 @push('page_scripts')
@@ -82,7 +82,7 @@
                     attachments: parent => {
                         this.get().attachments().forEach(attachment => {
                             parent.append(
-                                $('<a></a>').attr('href', _urls.base + '/attachment/' + attachment.id).attr('download', attachment.fullname).html(attachment.fullname)
+                                $('<a></a>').attr('href', '{{$urls->base}}/attachment/' + attachment.id).attr('download', attachment.fullname).html(attachment.fullname)
                             )
                         })
                     }
@@ -100,4 +100,4 @@
             message.setup('{{$message_id}}')
         })
     </script>
-@endpush
+@endpush

ui/resources/views/layout/body/footer/scripts/main.blade.php

@@ -3,18 +3,17 @@
         base_url: '{{$urls->api}}',
         base: function({method, uri, data = null}) {
             const request = {
-                uri: uri.replace(/^\//g, ''),
+                uri: uri,
                 method
             }
             const options = {
                 url: this.base_url,
                 method: 'post',
-                contentType: 'application/json'
             }
             if (method.toLowerCase() !== 'get' && data !== null) {
                 request['data'] = data
             }
-            options['data'] = JSON.stringify(request)
+            options['data'] = request
             return $.ajax(options)
         },
         get: function(uri) {
@@ -30,5 +29,5 @@
             return this.base({method: 'delete', uri, data})
         }
     }
-    const _urls = JSON.parse('{!! Safe\json_encode($urls) !!}')
-</script>
+    //const _urls = JSON.parse('{!! Safe\json_encode($urls) !!}')
+</script>

ui/setup/middleware/98_log.php

@@ -0,0 +1,2 @@
+<?php
+$app->add($app->getContainer()->get(ProVM\Common\Middleware\Logging::class));

ui/setup/settings/02_folders.php

@@ -20,6 +20,7 @@ return [
             $arr['base'],
             'cache'
         ]);
+        $arr['logs'] = '/logs';
         return (object) $arr;
     }
-];
+];

ui/setup/setups/02_api.php

@@ -4,7 +4,7 @@ use Psr\Container\ContainerInterface;
 return [
     Psr\Http\Client\ClientInterface::class => function(ContainerInterface $container) {
         return new GuzzleHttp\Client([
-            'base_uri' => "http://proxy:8080",
+            'base_uri' => $container->get('urls')->api,
             'headers' => [
                 'Authorization' => [
                     "Bearer {$container->get('api_key')}"
@@ -15,4 +15,4 @@ return [
     Psr\Http\Message\RequestFactoryInterface::class => function(ContainerInterface $container) {
         return $container->get(Nyholm\Psr7\Factory\Psr17Factory::class);
     },
-];
+];

ui/setup/setups/04_middleware.php

@@ -0,0 +1,8 @@
+<?php
+use Psr\Container\ContainerInterface;
+
+return [
+    ProVM\Common\Middleware\Logging::class => function(ContainerInterface $container) {
+        return new ProVM\Common\Middleware\Logging($container->get('request_logger'));
+    }
+];

ui/setup/setups/98_log.php

@@ -10,13 +10,23 @@ return [
         $handler->setFormatter($container->get(Monolog\Formatter\SyslogFormatter::class));
         return $handler;
     },
-    Psr\Log\LoggerInterface::class => function(ContainerInterface $container) {
-        $logger = new Monolog\Logger('file_logger');
-        $logger->pushHandler($container->get(Monolog\Handler\DeduplicationHandler::class));
-        //$logger->pushHandler($container->get(Monolog\Handler\RotatingFileHandler::class));
+    'request_logger' => function(ContainerInterface $container) {
+        $logger = new Monolog\Logger('request_logger');
+        $handler = new Monolog\Handler\RotatingFileHandler(implode(DIRECTORY_SEPARATOR, [$container->get('folders')->logs, 'requests.log']));
+        $handler->setFormatter($container->get(Monolog\Formatter\SyslogFormatter::class));
+        $dedupHandler = new Monolog\Handler\DeduplicationHandler($handler, null, Monolog\Level::Info);
+        $logger->pushHandler($dedupHandler);
         $logger->pushProcessor($container->get(Monolog\Processor\PsrLogMessageProcessor::class));
         $logger->pushProcessor($container->get(Monolog\Processor\IntrospectionProcessor::class));
         $logger->pushProcessor($container->get(Monolog\Processor\MemoryUsageProcessor::class));
         return $logger;
-    }
-];
+    },
+    Psr\Log\LoggerInterface::class => function(ContainerInterface $container) {
+        $logger = new Monolog\Logger('file_logger');
+        $logger->pushHandler($container->get(Monolog\Handler\DeduplicationHandler::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\PsrLogMessageProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\IntrospectionProcessor::class));
+        $logger->pushProcessor($container->get(Monolog\Processor\MemoryUsageProcessor::class));
+        return $logger;
+    },
+];