@@ -1,54 +1,73 @@

-# Contao 4 skeleton bundle

+# Contao Memberfiles Bundle

-Contao is an Open Source PHP Content Management System for people who want a

-professional website that is easy to maintain. Visit the [project website][1]

-for more information.

+A Contao bundle for managing secure member-specific file downloads with automatic file assignment and email notifications.

-You can use the skeleton bundle as basis for your own Contao bundle.

+## Features

-## Install

+- **Automatic File Import**: Files are automatically imported from source folders and assigned to members based on filename patterns

+- **Secure Downloads**: Files are stored in member-specific directories and accessible only to the respective member

+- **Email Notifications**: Members receive email notifications when new files are added

+- **Flexible Configuration**: Multiple configurations with different source folders and filename patterns

+- **Backend Integration**: Full Contao backend integration for managing member files

+- **Frontend Module**: Content element for displaying member files in the frontend

-Download the skeleton bundle:

+## Requirements

+

+- PHP 7.4 or 8.0+

+- Contao 4.13+

+- Symfony 5.4+

+- Notification Center 1.7+

+

+## Installation

+

+Install the bundle via Composer:

 ```bash

-wget https://github.com/contao/skeleton-bundle/archive/main.zip

-unzip main.zip

-mv skeleton-bundle-main [package name]

-cd [package name]

+composer require vonrotenberg/contao-memberfiles-bundle

 ```

-## Customize

+## Configuration

+

+1. Create a configuration in the backend (Memberfiles Configuration)

+2. Define:

+   - Source folder (where files are uploaded)

+   - Target folder (where files are stored)

+   - Regular expression to extract member identifier from filename

+   - Member fields to match against

+   - Optional: Email notification settings

+

+## File Naming Convention

-First adjust the following files:

+Files must follow a naming pattern that includes member identifiers. For example:

+- `invoice_12345_document.pdf` (where 12345 is the member ID)

+- `report_smith_john.pdf` (where smith/john match member fields)

- * `composer.json`

- * `ecs.php`

- * `LICENSE`

- * `phpunit.xml.dist`

- * `README.md`

+The regular expression in the configuration extracts these identifiers.

-Then rename the following files and/or the references to `SkeletonBundle` in

-the following files:

+## Cron Jobs

- * `src/ContaoManager/Plugin.php`

- * `src/DependencyInjection/ContaoSkeletonExtension.php`

- * `src/ContaoSkeletonBundle.php`

- * `tests/ContaoSkeletonBundleTest.php`

+The bundle includes two cron jobs:

+- **Import Job** (runs every minute): Imports new files from source folders

+- **Notification Job** (runs every 10 minutes): Sends email notifications for new files

-Finally, add your custom classes and resources. Make sure to register your services

-within `src/Resources/config/services.yml`. Also make sure to

-[adjust the Contao Manager Plugin][2] (and the dependencies within the `composer.json`)

-accordingly, if your bundle makes adjustments to other bundles (e.g. adjustments

-to a DCA of other bundles).

+## Testing

-## Release

+Run code quality checks before releasing:

-Run the PHP-CS-Fixer and the unit test before you release your bundle:

+```bash

+composer ecs

+composer phpstan

+composer unit-tests

+```

+

+Or run all checks at once:

 ```bash

-vendor/bin/ecs check src/ tests/ --fix

-vendor/bin/phpunit

+composer all

 ```

-[1]: https://contao.org

-[2]: https://docs.contao.org/dev/framework/manager-plugin/#the-bundleplugininterface

+## License

+

+This bundle is proprietary software. All rights reserved.

+

+(c) vonRotenberg

@@ -3,11 +3,11 @@

 declare(strict_types=1);

 /*

- * This file is part of eSales Media SinglereisenBundle

+ * This file is part of memberfiles bundle.

  *

- * (c) Benjamin Roth

+ * (c) vonRotenberg

  *

- * @license proprietary

+ * @license commercial

  */

 namespace vonRotenberg\MemberfilesBundle\Command;

@@ -18,8 +18,13 @@ use Symfony\Component\Console\Command\Command;

 use Symfony\Component\Console\Input\InputInterface;

 use Symfony\Component\Console\Output\OutputInterface;

+/**

+ * Console command to manually trigger file import for secure downloads

+ */

 class SecureDownloadsImportCommand extends Command

 {

+    private ContaoFramework $framework;

+

     public function __construct(ContaoFramework $framework)

     {

         $this->framework = $framework;

@@ -3,11 +3,11 @@

 declare(strict_types=1);

 /*

- * This file is part of eSales Media SinglereisenBundle

+ * This file is part of memberfiles bundle.

  *

- * (c) Benjamin Roth

+ * (c) vonRotenberg

  *

- * @license proprietary

+ * @license commercial

  */

 namespace vonRotenberg\MemberfilesBundle\Command;

@@ -18,8 +18,13 @@ use Symfony\Component\Console\Command\Command;

 use Symfony\Component\Console\Input\InputInterface;

 use Symfony\Component\Console\Output\OutputInterface;

+/**

+ * Console command to manually trigger sending notifications for new files

+ */

 class SecureDownloadsNotificationsCommand extends Command

 {

+    private ContaoFramework $framework;

+

     public function __construct(ContaoFramework $framework)

     {

         $this->framework = $framework;

@@ -3,11 +3,11 @@

 declare(strict_types=1);

 /*

- * This file is part of eSales Media SinglereisenBundle

+ * This file is part of memberfiles bundle.

  *

- * (c) Benjamin Roth

+ * (c) vonRotenberg

  *

- * @license proprietary

+ * @license commercial

  */

 namespace vonRotenberg\MemberfilesBundle\Controller\Frontend\ContentElement;

@@ -34,16 +34,16 @@ use Symfony\Contracts\Translation\TranslatorInterface;

 use vonRotenberg\MemberfilesBundle\Model\SecureDownloadsModel;

 /**

+ * Content element controller for displaying member-specific secure downloads

+ *

  * @ContentElement(SecureDownloadsController::TYPE, category="files")

  */

 class SecureDownloadsController extends AbstractContentElementController

 {

     public const TYPE = 'secure_downloads';

-    /** @var Connection */

-    protected $db;

-

-    protected $User;

+    protected Connection $db;

+    protected FrontendUser $User;

     public function __construct(Connection $db)

     {

@@ -68,18 +68,21 @@ class SecureDownloadsController extends AbstractContentElementController

             return new Response('',403);

         }

-        // Handle file requests

+        // Handle file download requests

         if (

             ($path = Input::get('file', true)) !== null

             && ($File = FilesModel::findByPath($path)) !== null

-            && ($SecFile = $SecFile = SecureDownloadsModel::findBy(["uuid = ?"],[$File->uuid])) !== null

+            && ($SecFile = SecureDownloadsModel::findBy(["uuid = ?"],[$File->uuid])) !== null

         )

         {

+            // Verify the file belongs to the current user

             if ($SecFile->pid == $this->User->id)

             {

+                // Track when the file was opened

                 $this->db->update('tl_member_secureDownloads', ['opened' => time()], ['id' => $SecFile->id]);

                 Controller::sendFileToBrowser($path);

             } else {

+                // Unauthorized access attempt

                 return new Response('',403);

             }

         }

@@ -102,10 +105,12 @@ class SecureDownloadsController extends AbstractContentElementController

             return new Response();

         }

+        $projectDir = System::getContainer()->getParameter('kernel.project_dir');

+

         while ($objFiles->next())

         {

-            // Continue if the files has been processed or does not exist

-            if (isset($files[$objFiles->path]) || !file_exists(TL_ROOT . '/' . $objFiles->path))

+            // Continue if the file has been processed or does not exist

+            if (isset($files[$objFiles->path]) || !file_exists($projectDir . '/' . $objFiles->path))

             {

                 continue;

             }

@@ -32,14 +32,13 @@ use Psr\Log\LoggerInterface;

 use Psr\Log\LogLevel;

 use vonRotenberg\MemberfilesBundle\Model\MemberfilesConfigModel;

+/**

+ * Cron job for importing member files and sending notifications

+ */

 class SecureDownloadsJob

 {

-

-    /** @var LoggerInterface */

-    private $logger;

-

-    /** @var Connection */

-    protected $db;

+    private LoggerInterface $logger;

+    private Connection $db;

     public function __construct(Connection $db, LoggerInterface $logger)

     {

@@ -48,33 +47,39 @@ class SecureDownloadsJob

     }

     /**

+     * Send email notifications about new files to members

+     * Runs every 10 minutes

+     *

      * @CronJob("*\/10 * * * *")

      */

-    public function sendFileNotifications(string $scope)

+    public function sendFileNotifications(string $scope): void

     {

-        // Get archives with notifications enabled

+        // Get configurations with notifications enabled

         $Configurations = MemberfilesConfigModel::findBy(["hasNotification = ?", "enabled = ?"], ['1','1']);

         if ($Configurations !== null)

         {

             while ($Configurations->next())

             {

-                // Do we have new items

+                // Check for members with unsent file notifications

                 $Members = $this->db->executeQuery("SELECT s.pid FROM tl_member_secureDownloads s INNER JOIN tl_files f ON f.uuid = s.uuid WHERE s.nc_sent != '1' GROUP BY s.pid");

-                // Load groups and notification models if we have news to share

+                // Send notifications if there are new files and notification is configured

                 if ($Members->rowCount() && ($Notification = Notification::findByPk($Configurations->notification)) !== null)

                 {

                     foreach ($Members->iterateAssociative() as $member)

                     {

+                        // Only process active members with valid email addresses

                         if (($Member = MemberModel::findOneBy(array("disable != '1'","login = '1'","email LIKE '%@%'","id = ?"),array($member['pid']))) !== null)

                         {

+                            // Get all unsent files for this member

                             $Files = $this->db->executeQuery("SELECT s.id, f.uuid, s.ctime FROM tl_member_secureDownloads s INNER JOIN tl_files f ON f.uuid = s.uuid WHERE s.pid = ? AND s.nc_sent != '1' ORDER BY s.ctime DESC, f.name",[$Member->id]);

                             $arrFileIds = [];

                             if ($Files->rowCount())

                             {

                                 $arrDownloads = array();

+                                // Build list of files for notification email

                                 foreach ($Files->iterateAssociative() as $file)

                                 {

                                     if (($File = FilesModel::findByUuid($file['uuid'])) !== null)

@@ -94,8 +99,14 @@ class SecureDownloadsJob

                                 ),$GLOBALS['TL_LANGUAGE']);

                             }

-                            // Flag news as sent

-                            $this->db->executeStatement("UPDATE tl_member_secureDownloads SET nc_sent = '1' WHERE id IN (" . implode(',', $arrFileIds) . ")");

+                            // Flag notifications as sent

+                            if (!empty($arrFileIds)) {

+                                $placeholders = implode(',', array_fill(0, count($arrFileIds), '?'));

+                                $this->db->executeStatement(

+                                    "UPDATE tl_member_secureDownloads SET nc_sent = '1' WHERE id IN ($placeholders)",

+                                    $arrFileIds

+                                );

+                            }

                         }

                     }

                     $this->logger->log(LogLevel::INFO, 'Secure downloads notifications has been sent (' . $Members->rowCount() . ')', array('contao' => new ContaoContext(__METHOD__, 'CRON')));

@@ -105,22 +116,25 @@ class SecureDownloadsJob

     }

     /**

+     * Import files from source folders and assign them to members

+     * Runs every minute

+     *

      * @CronJob("* * * * *")

      */

-    public function importFiles(string $scope)

+    public function importFiles(string $scope): void

     {

         $projectDir = System::getContainer()->getParameter('kernel.project_dir');

         $Configurations = MemberfilesConfigModel::findAll();

         $intFileCount = 0;

-        // No root pages available

+        // Exit if no configurations available

         if ($Configurations === null)

         {

             return;

         }

-        // Iterate page roots

+        // Process each configuration

         while ($Configurations->next())

         {

             if (System::getContainer()->getParameter('kernel.debug'))

@@ -138,14 +152,14 @@ class SecureDownloadsJob

             $Source = FilesModel::findByUuid($Configurations->source);

             $Target = FilesModel::findByUuid($Configurations->target);

-            // Continue if folder doesn't exist

+            // Continue if source or target folder doesn't exist

             if ($Source === null || !file_exists($projectDir . "/".$Source->path) || $Target === null || !file_exists($projectDir . "/".$Target->path))

             {

-                $this->logger->log(LogLevel::WARNING, sprintf('Source or target folder is missing for page root %s. %s %s', $Configurations->title,$Source->path,$Target->path), array('contao' => new ContaoContext(__METHOD__, 'ERROR')));

+                $this->logger->log(LogLevel::WARNING, sprintf('Source or target folder is missing for configuration %s. %s %s', $Configurations->title,$Source->path,$Target->path), array('contao' => new ContaoContext(__METHOD__, 'ERROR')));

                 continue;

             }

-            // Read files inside folder

+            // Read files from source folder

             $Files = FilesModel::findByPid($Source->uuid);

             // Continue if folder is empty

@@ -174,14 +188,14 @@ class SecureDownloadsJob

                 $objFile = new File($Files->path);

-                // Check for fragments

+                // Extract member identifier from filename using regex

                 if (!preg_match('/'.$Configurations->regexp.'/U',$objFile->filename,$fragments))

                 {

                     $this->logger->log(LogLevel::WARNING, sprintf('File "%s" is missing a member fragment or has the wrong syntax.', $objFile->name), array('contao' => new ContaoContext(__METHOD__, 'ERROR')));

                     continue;

                 }

-                // Find member

+                // Find member based on extracted fragments

                 $arrColumns = array();

                 $arrValues = array();

                 foreach (StringUtil::deserialize($Configurations->fields, true) as $i => $field)

@@ -197,11 +211,11 @@ class SecureDownloadsJob

                     continue;

                 }

-                // Remove fragments from file name

+                // Remove member identifier fragments from filename

                 $baseFilename = preg_replace('/'.$Configurations->regexp.'/U','',$objFile->filename);

                 $sanitizedFilename = $baseFilename.'.'.$objFile->extension;

-                // Check or create folder structure

+                // Create organized folder structure (groups of 100 members per folder)

                 $strSubFolder = sprintf("%03d",ceil(($objMember->id+1)/100)-1).'/'.$objMember->id;

                 $strTargetFolder = $Target->path.'/'.$strSubFolder;

@@ -233,17 +247,16 @@ class SecureDownloadsJob

                 $File = Dbafs::addResource($strTargetFolder.'/'.$sanitizedFilename,false);

-                // Add file to DB and delete source

+                // Register file in database for member

                 $arrData = array(

                     'pid'     => $objMember->id,

                     'uuid'    => ($File !== null ? $File->uuid : ''),

                     'tstamp'  => time(),

                     'ctime'   => time(),

-//          'name'    => $sanitizedFilename,

-//          'path'    => $strTargetFolder.'/'.$sanitizedFilename

                 );

                 $this->db->insert('tl_member_secureDownloads',$arrData);

+                // Delete source file after successful import

                 if (!$objFile->delete()) {

                     $this->logger->log(LogLevel::WARNING, sprintf('Could not delete source file "%s" for member ID "%s".', $objFile->name, $objMember->id), array('contao' => new ContaoContext(__METHOD__, 'ERROR')));

                 }

@@ -25,12 +25,12 @@ use Contao\Date;

 use Contao\Config;

 use vonRotenberg\MemberfilesBundle\Model\SecureDownloadsModel;

+/**

+ * Listener for member data container operations

+ */

 class MemberListener {

-    /**

-     * @var BackendUser

-     */

-    protected $User;

+    protected BackendUser $User;

     public function __construct()

     {

@@ -24,13 +24,14 @@ use Contao\System;

 use Contao\Date;

 use Contao\Config;

 use vonRotenberg\MemberfilesBundle\Model\SecureDownloadsModel;

+use Exception;

+/**

+ * Listener for secure downloads data container operations

+ */

 class MemberSecureDownloadsListener {

-    /**

-     * @var BackendUser

-     */

-    protected $User;

+    protected BackendUser $User;

     public function __construct()

     {

@@ -196,13 +197,13 @@ class MemberSecureDownloadsListener {

         if (!$File->exists())

         {

-            throw new \Exception(sprintf($GLOBALS['TL_LANG']['ERR']['invalidFile'],'1'.$varValue));

+            throw new Exception(sprintf($GLOBALS['TL_LANG']['ERR']['invalidFile'],'1'.$varValue));

         }

         $strDirectory = dirname($objFile->path);

         if (!$File->renameTo($strDirectory.'/'.$varValue))

         {

-            throw new \Exception(sprintf($GLOBALS['TL_LANG']['ERR']['invalidFile'],'2'.$varValue));

+            throw new Exception(sprintf($GLOBALS['TL_LANG']['ERR']['invalidFile'],'2'.$varValue));

         }

         if (($objFile = $File->getModel()) !== null) {

@@ -26,12 +26,12 @@ use Contao\Date;

 use Contao\Config;

 use vonRotenberg\MemberfilesBundle\Model\SecureDownloadsModel;

+/**

+ * Listener for memberfiles configuration data container operations

+ */

 class MemberfilesConfigListener {

-    /**

-     * @var BackendUser

-     */

-    protected $User;

+    protected BackendUser $User;

     public function __construct()

     {

@@ -18,12 +18,12 @@ use Contao\CoreBundle\ServiceAnnotation\Callback;

 use Contao\DataContainer;

 use Contao\System;

+/**

+ * Listener for page data container operations (legacy support)

+ */

 class PageListener {

-    /**

-     * @var BackendUser

-     */

-    protected $User;

+    protected BackendUser $User;

     public function __construct()

     {

@@ -9,6 +9,9 @@ use Contao\CoreBundle\Migration\MigrationResult;

 use Doctrine\DBAL\Connection;

 use Doctrine\DBAL\Schema\Schema;

+/**

+ * Migration to move secure downloads configuration from tl_page to tl_memberfiles_config

+ */

 class MemberfilesConfigMigration extends AbstractMigration

 {

     private Connection $connection;

@@ -22,18 +25,18 @@ class MemberfilesConfigMigration extends AbstractMigration

     {

         $schemaManager = $this->connection->createSchemaManager();

-        // Prüfen ob die Quelltabelle existiert

+        // Check if source table exists

         if (!$schemaManager->tablesExist(['tl_page'])) {

             return false;

         }

-        // Prüfen ob die notwendige Spalte in tl_page existiert

+        // Check if required column exists in tl_page

         $columns = $schemaManager->listTableColumns('tl_page');

         if (!isset($columns['securedownloadsenabled'])) {

             return false;

         }

-        // Prüfen ob es Einträge gibt, die migriert werden müssen

+        // Check if there are entries that need to be migrated

         $result = $this->connection->fetchOne(

             "SELECT COUNT(*) FROM tl_page WHERE secureDownloadsEnabled='1'"

         );

@@ -45,7 +48,7 @@ class MemberfilesConfigMigration extends AbstractMigration

     {

         $schemaManager = $this->connection->createSchemaManager();

-        // Erstelle die Zieltabelle, falls sie nicht existiert

+        // Create target table if it doesn't exist

         if (!$schemaManager->tablesExist(['tl_memberfiles_config'])) {

             $this->createMemberfilesConfigTable();

         }

@@ -76,16 +79,19 @@ class MemberfilesConfigMigration extends AbstractMigration

         return new MigrationResult(

             true,

-            sprintf('Erfolgreich %d Secure Downloads Konfigurationen von tl_page nach tl_memberfiles_config migriert.', count($pages))

+            sprintf('Successfully migrated %d secure downloads configurations from tl_page to tl_memberfiles_config.', count($pages))

         );

     }

+    /**

+     * Create the tl_memberfiles_config table

+     */

     private function createMemberfilesConfigTable(): void

     {

         $schema = new Schema();

         $table = $schema->createTable('tl_memberfiles_config');

-        // Pflichtfelder

+        // Define table columns

         $table->addColumn('id', 'integer', ['unsigned' => true, 'autoincrement' => true]);

         $table->addColumn('tstamp', 'integer', ['unsigned' => true, 'default' => 0]);

         $table->addColumn('title', 'string', ['length' => 255, 'default' => '']);

@@ -97,10 +103,10 @@ class MemberfilesConfigMigration extends AbstractMigration

         $table->addColumn('notification', 'integer', ['unsigned' => true, 'default' => 0]);

         $table->addColumn('enabled', 'string', ['length' => 1, 'fixed' => true, 'default' => '']);

-        // Primary Key

+        // Set primary key

         $table->setPrimaryKey(['id']);

-        // Schema anwenden

+        // Apply schema changes

         $queries = $schema->toSql($this->connection->getDatabasePlatform());

         foreach ($queries as $query) {

             $this->connection->executeStatement($query);

@@ -2,6 +2,14 @@

 declare(strict_types=1);

+/*

+ * This file is part of memberfiles bundle.

+ *

+ * (c) vonRotenberg

+ *

+ * @license commercial

+ */

+

 namespace vonRotenberg\MemberfilesBundle\Model;

 use Contao\Model;

@@ -1,11 +1,11 @@

 <?php

 /*

- * This file is part of Contao.

+ * This file is part of memberfiles bundle.

  *

- * (c) Leo Feyer

+ * (c) vonRotenberg

  *

- * @license LGPL-3.0-or-later

+ * @license commercial

  */

 namespace vonRotenberg\MemberfilesBundle\Model;

@@ -14,7 +14,7 @@ use Contao\Model;

 use Contao\Model\Collection;

 /**

- * Reads and writes image sizes

+ * Reads and writes secure downloads for members

  *

  * @property string|integer      $id

  * @property string|integer      $tstamp