added version command and api endpoint (#321)

src/API/HealthcheckController.php

@@ -11,6 +11,7 @@ declare(strict_types=1);
 
 namespace App\API;
 
+use App\Constants;
 use FOS\RestBundle\Controller\Annotations as Rest;
 use FOS\RestBundle\View\View;
 use FOS\RestBundle\View\ViewHandlerInterface;
@@ -46,4 +47,25 @@ class HealthcheckController extends Controller
 
         return $this->viewHandler->handle($view);
     }
+
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     description="Returns version information about the current release",
+     * )
+     *
+     * @Rest\Get(path="/version")
+     */
+    public function versionAction()
+    {
+        $version = [
+            'version' => Constants::VERSION,
+            'candidate' => Constants::STATUS,
+            'semver' => Constants::VERSION . '-' . Constants::STATUS,
+            'name' => Constants::NAME,
+            'copyright' => 'Kimai 2 - ' . Constants::VERSION . ' ' . Constants::STATUS . ' (' . Constants::NAME . ') by Kevin Papst and contributors.',
+        ];
+
+        return $this->viewHandler->handle(new View($version, 200));
+    }
 }

src/Command/VersionCommand.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use App\Constants;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+/**
+ * Command used to fetch Kimai version information.
+ */
+class VersionCommand extends Command
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('kimai:version')
+            ->setDescription('Receive version information')
+            ->setHelp('This command allows you to fetch various version information about Kimai.')
+            ->addOption('name', null, InputOption::VALUE_NONE, 'Display the major release name')
+            ->addOption('candidate', null, InputOption::VALUE_NONE, 'Display the current version candidate (e.g. "stable" or "dev")')
+            ->addOption('short', null, InputOption::VALUE_NONE, 'Display the version only')
+            ->addOption('semver', null, InputOption::VALUE_NONE, 'Semantical versioning (SEMVER) compatible version string')
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        if ($input->getOption('semver')) {
+            $io->writeln(Constants::VERSION . '-' . Constants::STATUS);
+
+            return;
+        }
+
+        if ($input->getOption('short')) {
+            $io->writeln(Constants::VERSION);
+
+            return;
+        }
+
+        if ($input->getOption('name')) {
+            $io->writeln(Constants::NAME);
+
+            return;
+        }
+
+        if ($input->getOption('candidate')) {
+            $io->writeln(Constants::STATUS);
+
+            return;
+        }
+
+        $io->writeln('Kimai 2 - ' . Constants::VERSION . ' ' . Constants::STATUS . ' (' . Constants::NAME . ') by Kevin Papst and contributors.');
+    }
+}

src/Constants.php

@@ -15,9 +15,17 @@ namespace App;
 class Constants
 {
     /**
-     * Currently only used for informational purpose in the footer
+     * The current release version
      */
-    public const VERSION = '2.0 dev';
+    public const VERSION = 0.5;
+    /**
+     * The release name
+     */
+    public const NAME = 'Ayumi';
+    /**
+     * The current release status
+     */
+    public const STATUS = 'dev';
     /**
      * Used in multiple views
      */

src/Migrations/Version20180924111853.php

@@ -40,6 +40,7 @@ final class Version20180924111853 extends AbstractMigration
             $this->addSql('DROP TABLE __temp__' . $invoiceTemplates);
             $this->addSql('CREATE UNIQUE INDEX UNIQ_1626CFE95E237E06 ON ' . $invoiceTemplates . ' (name)');
         } else {
+            $this->addSql('UPDATE ' . $invoiceTemplates . ' SET name=SUBSTRING(name, 1, 60)');
             $this->addSql('ALTER TABLE ' . $invoiceTemplates . ' CHANGE name name VARCHAR(60) NOT NULL, CHANGE vat vat DOUBLE PRECISION DEFAULT 0');
         }
     }