fix: deprecation notice in volumes report

dfranco · dfranco · commit 51f9bf92e744 · 2024-10-22T06:11:49.000+02:00
Fix deprecation notice in volumes report for users using PHP 8.2 and above. Replace unmaintained pear/date_humandiff dependency by nesbot/carbon. Use datetime_format_short from the configuration if the user has set it. Resolve #237
diff --git a/application/Controller/VolumesController.php b/application/Controller/VolumesController.php
@@ -23,12 +23,12 @@
 
 use App\Libs\Config;
 use App\Validator\VolumesRequestValidator;
+use Carbon\Carbon;
 use Core\Db\CDBQuery;
 use Core\Db\DBPagination;
 use Core\Utils\CUtils;
 use App\Table\VolumeTable;
 use App\Table\PoolTable;
-use Date_HumanDiff;
 use Exception;
 use Psr\Http\Message\ServerRequestInterface as Request;
 use GuzzleHttp\Psr7\Response;
@@ -178,21 +178,25 @@ public function index(Request $request, Response $response): Response
             'where' => $where ]);
 
         foreach ($pagination->paginate($this->volumeTable, $sqlQuery, $countquery, $params) as $volume) {
-            // Calculate volume expiration
-            // If volume have already been used
+            /**
+             * Calculate volume expiration only if volume has already been written
+             */
             if ($volume['lastwritten'] != "0000-00-00 00:00:00" && !is_null($volume['lastwritten'])) {
-                // Calculate expiration date only if volume status is Full or Used
+                /**
+                 * Calculate expiration date only if volume status is Full or Used
+                 */
                 if ($volume['volstatus'] == 'Full' || $volume['volstatus'] == 'Used') {
-                    $dh = new Date_HumanDiff();
-                    $dateTimeFormatShort = explode(' ', $this->config->get('datetime_format', 'Y-m-d H:i:s'));
-                    $volume['expire'] = date(
-                        $dateTimeFormatShort[0],
-                        strtotime($volume['lastwritten']) + $volume['volretention']
-                    );
-                    $volume['expire'] = $dh->get(
-                        strtotime($volume['lastwritten']) + $volume['volretention'],
-                        time()
-                    ) . ' (' . $volume['expire'] . ')';
+                    if ($this->config->has('datetime_format_short')) {
+                        $dateTimeFormatShort = $this->config->get('datetime_format_short');
+                    } else {
+                        $dateTimeFormatShort = explode(' ', $this->config->get('datetime_format', 'Y-m-d H:i:s'));
+                        $dateTimeFormatShort = $dateTimeFormatShort[0];
+                    }
+
+                    $volumeExpiration = Carbon::parse($volume['lastwritten'])->addSeconds($volume['volretention']);
+                    $volume['expire'] =
+                        $volumeExpiration->format($dateTimeFormatShort) .
+                        ' (in ' . (int) Carbon::now()->diffInDays($volumeExpiration) . ' day(s) )';
                 } else {
                     $volume['expire'] = 'n/a';
                 }
diff --git a/composer.json b/composer.json
@@ -48,7 +48,6 @@
     "novus/nvd3": "@stable",
     "components/font-awesome": "6.*",
     "vlucas/valitron": "^1.4",
-    "pear/date_humandiff": "^0.5.0",
     "vlucas/phpdotenv": "^5.5",
     "php-di/php-di": "^7.0",
     "twbs/bootstrap": "5.2.3",
@@ -59,7 +58,8 @@
     "symfony/translation": "^5.4",
     "symfony/console": "6.0.19",
     "slim/csrf": "^1.3",
-    "symfony/twig-bridge": "^5.4"
+    "symfony/twig-bridge": "^5.4",
+    "nesbot/carbon": "^3.8"
   },
   "require-dev": {
     "phpmd/phpmd": "@stable",
