Added new Beacon handling code

2016-08-03 17:44:21 +01:00
parent dd2e77d479
commit 778664b20a
14 changed files with 446 additions and 0 deletions
@@ -0,0 +1,115 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Cachet\Integrations\Core;
+
+use CachetHQ\Cachet\Integrations\Contracts\Beacon as BeaconContract;
+use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\Incident;
+use CachetHQ\Cachet\Models\Metric;
+use CachetHQ\Cachet\Models\User;
+use CachetHQ\Cachet\Settings\Repository as Setting;
+use Exception;
+use GuzzleHttp\Client;
+use Illuminate\Contracts\Config\Repository;
+
+/**
+ * This is the beacon class.
+ *
+ * @author James Brooks <james@alt-three.com>
+ */
+class Beacon implements BeaconContract
+{
+    /**
+     * The beacon url.
+     *
+     * @var string
+     */
+    const URL = 'https://cachethq.io/beacon';
+
+    /**
+     * The illuminate config instance.
+     *
+     * @var \Illuminate\Contracts\Config\Repository
+     */
+    protected $config;
+
+    /**
+     * Create a new beacon instance.
+     *
+     * @param \Illuminate\Contracts\Config\Repository $config
+     *
+     * @return void
+     */
+    public function __construct(Repository $config)
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * Has the install enabled Cachet beacon?
+     *
+     * @return bool
+     */
+    public function enabled()
+    {
+        return $this->config->get('cachet.beacon');
+    }
+
+    /**
+     * Send a beacon to our server.
+     *
+     * @return void
+     */
+    public function send()
+    {
+        // We don't want any accidental sending of beacons if the installation has explicitly said no.
+        if (!$this->enabled()) {
+            return;
+        }
+
+        if (!($contactEmail = User::admins()->active()->first()->email)) {
+            $contactEmail = null;
+        }
+
+        $setting = app(Setting::class);
+
+        if (!$installId = $setting->get('install_id', null)) {
+            $installId = sha1(str_random(20));
+
+            $setting->set('install_id', $installId);
+        }
+
+        $payload = [
+            'install_id'    => $installId,
+            'version'       => CACHET_VERSION,
+            'docker'        => $this->config->get('cachet.is_docker'),
+            'database'      => $this->config->get('database.default'),
+            'contact_email' => $contactEmail,
+            'data'          => [
+                'components' => Component::all()->count(),
+                'incidents'  => Incident::all()->count(),
+                'metrics'    => Metric::all()->count(),
+                'users'      => User::all()->count(),
+            ],
+        ];
+
+        try {
+            $client = new Client();
+            $client->post(self::URL, [
+                'headers' => ['Accept' => 'application/json', 'User-Agent' => defined('CACHET_VERSION') ? 'cachet/'.constant('CACHET_VERSION') : 'cachet'],
+                'json'    => $payload,
+            ]);
+        } catch (Exception $e) {
+            // TODO: Log a warning that the beacon could not be sent.
+        }
+    }
+}