Cachet is now a Laravel 5 app

app/Models/Component.php

@@ -0,0 +1,153 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property int            $user_id
+ * @property string         $name
+ * @property string         $description
+ * @property int            $status
+ * @property string         $link
+ * @property int            $order
+ * @property int            $group_id
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ * @property \Carbon\Carbon $deleted_at
+ */
+class Component extends Model
+{
+    use SoftDeletes, ValidatingTrait;
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'user_id' => 'integer|required',
+        'name'    => 'required',
+        'status'  => 'integer|required',
+        'link'    => 'url',
+    ];
+
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = [
+        'name',
+        'description',
+        'status',
+        'user_id',
+        'tags',
+        'link',
+        'order',
+        'group_id',
+    ];
+
+    /**
+     * List of attributes that have default values.
+     *
+     * @var mixed[]
+     */
+    protected $attributes = [
+        'order'       => 0,
+        'group_id'    => 0,
+        'description' => '',
+        'link'        => '',
+    ];
+
+    /**
+	 * The attributes that should be mutated to dates.
+	 *
+	 * @var array
+	 */
+	protected $dates = ['deleted_at'];
+
+    /**
+     * Components can belong to a group.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function group()
+    {
+        return $this->belongsTo('CachetHQ\Cachet\Models\ComponentGroup', 'group_id', 'id');
+    }
+
+    /**
+     * Lookup all of the incidents reported on the component.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function incidents()
+    {
+        return $this->hasMany('CachetHQ\Cachet\Models\Incident', 'component_id', 'id');
+    }
+
+    /**
+     * Components can have many tags.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
+     */
+    public function tags()
+    {
+        return $this->belongsToMany('CachetHQ\Cachet\Models\Tag');
+    }
+
+    /**
+     * Finds all components by status.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param int                                   $status
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeStatus(Builder $query, $status)
+    {
+        return $query->where('status', $status);
+    }
+
+    /**
+     * Finds all components which don't have the given status.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param int                                   $status
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeNotStatus(Builder $query, $status)
+    {
+        return $query->where('status', '<>', $status);
+    }
+
+    /**
+     * Looks up the human readable version of the status.
+     *
+     * @return string
+     */
+    public function getHumanStatusAttribute()
+    {
+        return trans('cachet.components.status.'.$this->status);
+    }
+
+    /**
+     * Returns all of the tags on this component.
+     *
+     * @return string
+     */
+    public function getTagsListAttribute()
+    {
+        $tags = $this->tags->map(function ($tag) {
+            return $tag->name;
+        });
+
+        return implode(', ', $tags->toArray());
+    }
+}

app/Models/ComponentGroup.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property string         $name
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ * @property \Carbon\Carbon $deleted_at
+ */
+class ComponentGroup extends Model
+{
+    use SoftDeletes, ValidatingTrait;
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'name' => 'required|unique:component_groups',
+    ];
+
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['name'];
+
+    /**
+     * The attributes that should be mutated to dates.
+     *
+     * @var array
+     */
+    protected $dates = ['deleted_at'];
+
+    /**
+     * A group can have many components.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function components()
+    {
+        return $this->hasMany('CachetHQ\Cachet\Models\Component', 'group_id', 'id');
+    }
+}

app/Models/Incident.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use McCool\LaravelAutoPresenter\HasPresenter;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property int            $component_id
+ * @property int            $user_id
+ * @property string         $name
+ * @property int            $status
+ * @property string         $message
+ * @property string         $humanStatus
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ * @property \Carbon\Carbon $deleted_at
+ */
+class Incident extends Model implements HasPresenter
+{
+    use SoftDeletes, ValidatingTrait;
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'user_id'      => 'required|integer',
+        'component_id' => 'integer',
+        'name'         => 'required',
+        'status'       => 'required|integer',
+        'message'      => 'required',
+    ];
+
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['user_id', 'component_id', 'name', 'status', 'message', 'scheduled_at'];
+
+    /**
+     * The accessors to append to the model's serialized form.
+     *
+     * @var string[]
+     */
+    protected $appends = ['human_status'];
+
+    /**
+     * The attributes that should be mutated to dates.
+     *
+     * @var string[]
+     */
+    protected $dates = ['scheduled_at', 'deleted_at'];
+
+    /**
+     * Finds all scheduled incidents (maintenance).
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeScheduled($query)
+    {
+        return $query->where('status', 0)->where('scheduled_at', '>=', Carbon::now());
+    }
+
+    /**
+     * Finds all non-scheduled incidents.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeNotScheduled($query)
+    {
+        return $query->where(function ($query) {
+            return $query->whereNull('scheduled_at')->orWhere('scheduled_at', '<=', Carbon::now());
+        });
+    }
+
+    /**
+     * An incident belongs to a component.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function component()
+    {
+        return $this->belongsTo('CachetHQ\Cachet\Models\Component', 'component_id', 'id');
+    }
+
+    /**
+     * Returns a human readable version of the status.
+     *
+     * @return string
+     */
+    public function getHumanStatusAttribute()
+    {
+        $statuses = trans('cachet.incidents.status');
+
+        return $statuses[$this->status];
+    }
+
+    /**
+     * Returns whether the "incident" is scheduled or not.
+     *
+     * @return bool
+     */
+    public function getIsScheduledAttribute()
+    {
+        return $this->getOriginal('scheduled_at');
+    }
+
+    /**
+     * Get the presenter class.
+     *
+     * @return string
+     */
+    public function getPresenterClass()
+    {
+        return 'CachetHQ\Cachet\Presenters\IncidentPresenter';
+    }
+}

app/Models/IncidentTemplate.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property string         $name
+ * @property string         $slug
+ * @property string         $template
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
+class IncidentTemplate extends Model
+{
+    use ValidatingTrait;
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'name'     => 'required',
+        'template' => 'required',
+    ];
+
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['name', 'template'];
+
+    /**
+     * Overrides the models boot method.
+     *
+     * @return void
+     */
+    public static function boot()
+    {
+        parent::boot();
+
+        self::saving(function ($template) {
+            $template->slug = Str::slug($template->name);
+        });
+    }
+}

app/Models/Metric.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use DateInterval;
+use DateTime;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\DB;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property string         $name
+ * @property string         $suffix
+ * @property string         $description
+ * @property int            $display_chart
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
+class Metric extends Model
+{
+    use ValidatingTrait;
+
+    const CALC_SUM = 0;
+    const CALC_AVG = 1;
+
+    /**
+     * The model's attributes.
+     *
+     * @var string[]
+     */
+    protected $attributes = [
+        'name'          => '',
+        'display_chart' => 1,
+        'default_value' => 0,
+        'calc_type'     => 0,
+    ];
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'name'          => 'required',
+        'suffix'        => 'required',
+        'display_chart' => 'boolean',
+        'default_value' => 'numeric',
+    ];
+
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['name', 'suffix', 'description', 'display_chart', 'default_value', 'calc_type'];
+
+    /**
+     * Metrics contain many metric points.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function points()
+    {
+        return $this->hasMany('CachetHQ\Cachet\Models\MetricPoint', 'metric_id', 'id');
+    }
+
+    /**
+     * Returns the sum of all values a metric has.
+     *
+     * @param int $hour
+     *
+     * @return int
+     */
+    public function getValues($hour)
+    {
+        $dateTime = new DateTime();
+        $dateTime->sub(new DateInterval('PT'.$hour.'H'));
+
+        if (Config::get('database.default') === 'mysql') {
+            if (! isset($this->calc_type) || $this->calc_type === self::CALC_SUM) {
+                $value = (int) $this->points()->whereRaw('DATE_FORMAT(created_at, "%Y%m%e%H") = '.$dateTime->format('YmdH'))->whereRaw('HOUR(created_at) = HOUR(DATE_SUB(NOW(), INTERVAL '.$hour.' HOUR))')->groupBy(DB::raw('HOUR(created_at)'))->sum('value');
+            } elseif ($this->calc_type === self::CALC_AVG) {
+                $value = (int) $this->points()->whereRaw('DATE_FORMAT(created_at, "%Y%m%e%H") = '.$dateTime->format('YmdH'))->whereRaw('HOUR(created_at) = HOUR(DATE_SUB(NOW(), INTERVAL '.$hour.' HOUR))')->groupBy(DB::raw('HOUR(created_at)'))->avg('value');
+            }
+        } else {
+            // Default metrics calculations.
+            if (! isset($this->calc_type) || $this->calc_type === self::CALC_SUM) {
+                $queryType = "sum(metric_points.value)";
+            } elseif ($this->calc_type === self::CALC_AVG) {
+                $queryType = "avg(metric_points.value)";
+            }
+
+            $query = DB::select("select {$queryType} as aggregate FROM metrics JOIN metric_points ON metric_points.metric_id = metrics.id WHERE to_char(metric_points.created_at, 'YYYYMMDDHH') = :timestamp AND to_char(metric_points.created_at, 'H') = to_char(now() - interval '{$hour} hour', 'H') GROUP BY to_char(metric_points.created_at, 'H')", [
+                'timestamp' => $dateTime->format('YmdH'),
+            ]);
+
+            if (isset($query[0])) {
+                $value = $query[0]->aggregate;
+            } else {
+                $value = 0;
+            }
+        }
+
+        if ($value === 0 && $this->default_value != $value) {
+            return $this->default_value;
+        }
+
+        return $value;
+    }
+
+    /**
+     * Determines whether a chart should be shown.
+     *
+     * @return bool
+     */
+    public function getShouldDisplayAttribute()
+    {
+        return $this->display_chart === 1;
+    }
+}

app/Models/MetricPoint.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property int            $metric_id
+ * @property int            $value
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
+class MetricPoint extends Model
+{
+    use ValidatingTrait;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['metric_id', 'value'];
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'value' => 'numeric|required',
+    ];
+
+    /**
+     * A metric point belongs to a metric unit.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function metric()
+    {
+        return $this->belongsTo('CachetHQ\Cachet\Models\Metric', 'id', 'metric_id');
+    }
+}

app/Models/Service.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property string         $type
+ * @property int            $active
+ * @property string         $properties
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ * @property \Carbon\Carbon $deleted_at
+ */
+class Service extends Model
+{
+    use ValidatingTrait;
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'type'       => 'alpha_dash|required',
+        'active'     => 'required|in:0,1',
+        'properties' => '',
+    ];
+
+    /**
+     * Returns a decoded properties object for the service.
+     *
+     * @param string $properties
+     *
+     * @return object
+     */
+    public function getPropertiesAttribute($properties)
+    {
+        return json_decode($properties);
+    }
+
+    /**
+     * Sets the properties attribute which auto encodes to a JSON string.
+     *
+     * @param mixed $properties
+     */
+    public function setPropertiesAttribute($properties)
+    {
+        $this->attributes['properties'] = json_encode($properties);
+    }
+}

app/Models/Setting.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int            $id
+ * @property string         $name
+ * @property string         $value
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
+class Setting extends Model
+{
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['name', 'value'];
+
+    /**
+     * List of attributes that have default values.
+     *
+     * @var string[]
+     */
+    protected $attributes = ['value' => ''];
+}

app/Models/Subscriber.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property string         $email
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ * @property \Carbon\Carbon $deleted_at
+ */
+class Subscriber extends Model
+{
+    use SoftDeletes, ValidatingTrait;
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'email' => 'required|email',
+    ];
+
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['email'];
+}

app/Models/Tag.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property string         $name
+ * @property string         $slug
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
+class Tag extends Model
+{
+    use ValidatingTrait;
+
+    /**
+     * The fillable properties.
+     *
+     * @var string[]
+     */
+    protected $fillable = ['name'];
+
+    /**
+     * Overrides the models boot method.
+     *
+     * @return void
+     */
+    public static function boot()
+    {
+        parent::boot();
+
+        self::creating(function ($tag) {
+            $tag->slug = Str::slug($tag->name);
+        });
+    }
+
+    /**
+     * Tags can have many components.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
+     */
+    public function components()
+    {
+        return $this->belongsToMany('CachetHQ\Cachet\Models\Component');
+    }
+}

app/Models/User.php

@@ -0,0 +1,150 @@
+<?php
+
+namespace CachetHQ\Cachet\Models;
+
+use Illuminate\Auth\Authenticatable;
+use Illuminate\Auth\Passwords\CanResetPassword;
+use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
+use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Support\Facades\Hash;
+use Watson\Validating\ValidatingTrait;
+
+/**
+ * @property int            $id
+ * @property string         $username
+ * @property string         $password
+ * @property string         $remember_token
+ * @property string         $google_2fa_secret
+ * @property string         $email
+ * @property string         $api_key
+ * @property int            $active
+ * @property int            $level
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
+class User extends Model implements AuthenticatableContract, CanResetPasswordContract
+{
+    use Authenticatable, CanResetPassword, ValidatingTrait;
+
+    /**
+     * The validation rules.
+     *
+     * @var string[]
+     */
+    protected $rules = [
+        'username' => 'required|alpha_num|unique:users',
+        'email'    => 'required|email|unique:users',
+        'password' => 'required',
+    ];
+
+    /**
+     * The hidden properties.
+     *
+     * These are excluded when we are serializing the model.
+     *
+     * @var string[]
+     */
+    protected $hidden = ['password', 'remember_token', 'google_2fa_secret'];
+
+    /**
+     * The properties that cannot be mass assigned.
+     *
+     * @var string[]
+     */
+    protected $guarded = [];
+
+    /**
+     * Overrides the models boot method.
+     *
+     * @return void
+     */
+    public static function boot()
+    {
+        parent::boot();
+
+        self::creating(function ($user) {
+            if (! $user->api_key) {
+                $user->api_key = self::generateApiKey();
+            }
+        });
+    }
+
+    /**
+     * Hash any password being inserted by default.
+     *
+     * @param string $password
+     *
+     * @return \CachetHQ\Cachet\Models\User
+     */
+    public function setPasswordAttribute($password)
+    {
+        $this->attributes['password'] = Hash::make($password);
+
+        return $this;
+    }
+
+    /**
+     * Returns a Gravatar URL for the users email address.
+     *
+     * @param int $size
+     *
+     * @return string
+     */
+    public function getGravatarAttribute($size = 200)
+    {
+        return sprintf('https://www.gravatar.com/avatar/%s?size=%d', md5($this->email), $size);
+    }
+
+    /**
+     * Find by api_key, or throw an exception.
+     *
+     * @param string   $token
+     * @param string[] $columns
+     *
+     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
+     *
+     * @return \CachetHQ\Cachet\Models\User
+     */
+    public static function findByApiToken($token, $columns = ['*'])
+    {
+        $user = static::where('api_key', $token)->first($columns);
+
+        if (!$user) {
+            throw new ModelNotFoundException();
+        }
+
+        return $user;
+    }
+
+    /**
+     * Returns an API key.
+     *
+     * @return string
+     */
+    public static function generateApiKey()
+    {
+        return str_random(20);
+    }
+
+    /**
+     * Returns whether a user is at admin level.
+     *
+     * @return bool
+     */
+    public function getIsAdminAttribute()
+    {
+        return $this->level == 1;
+    }
+
+    /**
+     * Returns if a user has enabled two factor authentication.
+     *
+     * @return bool
+     */
+    public function getHasTwoFactorAttribute()
+    {
+        return trim($this->google_2fa_secret) !== '';
+    }
+}