eacee08135
This PR moves public dashboards into its own self contained service including API, Service, Database, and Models. Routes are mounted on the Grafana HTTPServer by the API service at injection time with wire.go. The main route that loads the frontend for public dashboards is still handled by the API package. Co-authored-by: Jesse Weaver <jesse.weaver@grafana.com> Co-authored-by: Owen Smallwood <owen.smallwood@grafana.com>
116 lines
2.9 KiB
Go
116 lines
2.9 KiB
Go
package models
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/grafana/grafana/pkg/components/simplejson"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
)
|
|
|
|
// PublicDashboardErr represents a dashboard error.
|
|
type PublicDashboardErr struct {
|
|
StatusCode int
|
|
Status string
|
|
Reason string
|
|
}
|
|
|
|
// Error returns the error message.
|
|
func (e PublicDashboardErr) Error() string {
|
|
if e.Reason != "" {
|
|
return e.Reason
|
|
}
|
|
return "Dashboard Error"
|
|
}
|
|
|
|
var (
|
|
ErrPublicDashboardFailedGenerateUniqueUid = PublicDashboardErr{
|
|
Reason: "Failed to generate unique public dashboard id",
|
|
StatusCode: 500,
|
|
}
|
|
ErrPublicDashboardFailedGenerateAccesstoken = PublicDashboardErr{
|
|
Reason: "Failed to public dashboard access token",
|
|
StatusCode: 500,
|
|
}
|
|
ErrPublicDashboardNotFound = PublicDashboardErr{
|
|
Reason: "Public dashboard not found",
|
|
StatusCode: 404,
|
|
Status: "not-found",
|
|
}
|
|
ErrPublicDashboardPanelNotFound = PublicDashboardErr{
|
|
Reason: "Panel not found in dashboard",
|
|
StatusCode: 404,
|
|
Status: "not-found",
|
|
}
|
|
ErrPublicDashboardIdentifierNotSet = PublicDashboardErr{
|
|
Reason: "No Uid for public dashboard specified",
|
|
StatusCode: 400,
|
|
}
|
|
)
|
|
|
|
type PublicDashboard struct {
|
|
Uid string `json:"uid" xorm:"pk uid"`
|
|
DashboardUid string `json:"dashboardUid" xorm:"dashboard_uid"`
|
|
OrgId int64 `json:"-" xorm:"org_id"` // Don't ever marshal orgId to Json
|
|
TimeSettings *simplejson.Json `json:"timeSettings" xorm:"time_settings"`
|
|
IsEnabled bool `json:"isEnabled" xorm:"is_enabled"`
|
|
AccessToken string `json:"accessToken" xorm:"access_token"`
|
|
|
|
CreatedBy int64 `json:"createdBy" xorm:"created_by"`
|
|
UpdatedBy int64 `json:"updatedBy" xorm:"updated_by"`
|
|
|
|
CreatedAt time.Time `json:"createdAt" xorm:"created_at"`
|
|
UpdatedAt time.Time `json:"updatedAt" xorm:"updated_at"`
|
|
}
|
|
|
|
func (pd PublicDashboard) TableName() string {
|
|
return "dashboard_public"
|
|
}
|
|
|
|
type TimeSettings struct {
|
|
From string `json:"from"`
|
|
To string `json:"to"`
|
|
}
|
|
|
|
// build time settings object from json on public dashboard. If empty, use
|
|
// defaults on the dashboard
|
|
func (pd PublicDashboard) BuildTimeSettings(dashboard *models.Dashboard) *TimeSettings {
|
|
ts := &TimeSettings{
|
|
From: dashboard.Data.GetPath("time", "from").MustString(),
|
|
To: dashboard.Data.GetPath("time", "to").MustString(),
|
|
}
|
|
|
|
if pd.TimeSettings == nil {
|
|
return ts
|
|
}
|
|
|
|
// merge time settings from public dashboard
|
|
to := pd.TimeSettings.Get("to").MustString("")
|
|
from := pd.TimeSettings.Get("from").MustString("")
|
|
if to != "" && from != "" {
|
|
ts.From = from
|
|
ts.To = to
|
|
}
|
|
|
|
return ts
|
|
}
|
|
|
|
//
|
|
// DTO for transforming user input in the api
|
|
//
|
|
type SavePublicDashboardConfigDTO struct {
|
|
DashboardUid string
|
|
OrgId int64
|
|
UserId int64
|
|
PublicDashboard *PublicDashboard
|
|
}
|
|
|
|
//
|
|
// COMMANDS
|
|
//
|
|
|
|
type SavePublicDashboardConfigCommand struct {
|
|
DashboardUid string
|
|
OrgId int64
|
|
PublicDashboard PublicDashboard
|
|
}
|