grafana/pkg/services/export/service.go

package export

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
	"path/filepath"
	"sync"
	"time"

	"github.com/grafana/grafana/pkg/api/response"
	"github.com/grafana/grafana/pkg/infra/appcontext"
	"github.com/grafana/grafana/pkg/infra/db"
	"github.com/grafana/grafana/pkg/infra/log"
	"github.com/grafana/grafana/pkg/models"
	"github.com/grafana/grafana/pkg/services/dashboardsnapshots"
	"github.com/grafana/grafana/pkg/services/datasources"
	"github.com/grafana/grafana/pkg/services/featuremgmt"
	"github.com/grafana/grafana/pkg/services/live"
	"github.com/grafana/grafana/pkg/services/org"
	"github.com/grafana/grafana/pkg/services/playlist"
	"github.com/grafana/grafana/pkg/services/store/entity"
	"github.com/grafana/grafana/pkg/setting"
)

type ExportService interface {
	// List folder contents
	HandleGetStatus(c *models.ReqContext) response.Response

	// List Get Options
	HandleGetOptions(c *models.ReqContext) response.Response

	// Read raw file contents out of the store
	HandleRequestExport(c *models.ReqContext) response.Response

	// Cancel any running export
	HandleRequestStop(c *models.ReqContext) response.Response
}

var exporters = []Exporter{
	{
		Key:         "auth",
		Name:        "Authentication",
		Description: "Saves raw SQL tables",
		process:     dumpAuthTables,
	},
	{
		Key:         "dash",
		Name:        "Dashboards",
		Description: "Save dashboard JSON",
		process:     exportDashboards,
		Exporters: []Exporter{
			{
				Key:         "dash_thumbs",
				Name:        "Dashboard thumbnails",
				Description: "Save current dashboard preview images",
				process:     exportDashboardThumbnails,
			},
		},
	},
	{
		Key:         "alerts",
		Name:        "Alerts",
		Description: "Archive alert rules and configuration",
		process:     exportAlerts,
	},
	{
		Key:         "ds",
		Name:        "Data sources",
		Description: "Data source configurations",
		process:     exportDataSources,
	},
	{
		Key:         "system",
		Name:        "System",
		Description: "Save service settings",
		Exporters: []Exporter{
			{
				Key:         "system_preferences",
				Name:        "Preferences",
				Description: "User and team preferences",
				process:     exportSystemPreferences,
			},
			{
				Key:         "system_stars",
				Name:        "Stars",
				Description: "User stars",
				process:     exportSystemStars,
			},
			{
				Key:         "system_playlists",
				Name:        "Playlists",
				Description: "Playlists",
				process:     exportSystemPlaylists,
			},
			{
				Key:         "system_kv_store",
				Name:        "Key Value store",
				Description: "Internal KV store",
				process:     exportKVStore,
			},
			{
				Key:         "system_short_url",
				Name:        "Short URLs",
				Description: "saved links",
				process:     exportSystemShortURL,
			},
			{
				Key:         "system_live",
				Name:        "Grafana live",
				Description: "archived messages",
				process:     exportLive,
			},
		},
	},
	{
		Key:         "files",
		Name:        "Files",
		Description: "Export internal file system",
		process:     exportFiles,
	},
	{
		Key:         "anno",
		Name:        "Annotations",
		Description: "Write an DataFrame for all annotations on a dashboard",
		process:     exportAnnotations,
	},
	{
		Key:         "plugins",
		Name:        "Plugins",
		Description: "Save settings for all configured plugins",
		process:     exportPlugins,
	},
	{
		Key:         "usage",
		Name:        "Usage",
		Description: "archive current usage stats",
		process:     exportUsage,
	},
	// {
	// 	Key:         "snapshots",
	// 	Name:        "Snapshots",
	// 	Description: "write snapshots",
	// 	process:     exportSnapshots,
	// },
}

type StandardExport struct {
	logger  log.Logger
	glive   *live.GrafanaLive
	mutex   sync.Mutex
	dataDir string

	// Services
	db                        db.DB
	dashboardsnapshotsService dashboardsnapshots.Service
	playlistService           playlist.Service
	orgService                org.Service
	datasourceService         datasources.DataSourceService
	store                     entity.EntityStoreServer

	// updated with mutex
	exportJob Job
}

func ProvideService(db db.DB, features featuremgmt.FeatureToggles, gl *live.GrafanaLive, cfg *setting.Cfg,
	dashboardsnapshotsService dashboardsnapshots.Service, playlistService playlist.Service, orgService org.Service,
	datasourceService datasources.DataSourceService, store entity.EntityStoreServer) ExportService {
	if !features.IsEnabled(featuremgmt.FlagExport) {
		return &StubExport{}
	}

	return &StandardExport{
		glive:                     gl,
		logger:                    log.New("export_service"),
		dashboardsnapshotsService: dashboardsnapshotsService,
		playlistService:           playlistService,
		orgService:                orgService,
		datasourceService:         datasourceService,
		exportJob:                 &stoppedJob{},
		dataDir:                   cfg.DataPath,
		store:                     store,
		db:                        db,
	}
}

func (ex *StandardExport) HandleGetOptions(c *models.ReqContext) response.Response {
	info := map[string]interface{}{
		"exporters": exporters,
	}
	return response.JSON(http.StatusOK, info)
}

func (ex *StandardExport) HandleGetStatus(c *models.ReqContext) response.Response {
	ex.mutex.Lock()
	defer ex.mutex.Unlock()

	return response.JSON(http.StatusOK, ex.exportJob.getStatus())
}

func (ex *StandardExport) HandleRequestStop(c *models.ReqContext) response.Response {
	ex.mutex.Lock()
	defer ex.mutex.Unlock()

	ex.exportJob.requestStop()

	return response.JSON(http.StatusOK, ex.exportJob.getStatus())
}

func (ex *StandardExport) HandleRequestExport(c *models.ReqContext) response.Response {
	var cfg ExportConfig
	err := json.NewDecoder(c.Req.Body).Decode(&cfg)
	if err != nil {
		return response.Error(http.StatusBadRequest, "unable to read config", err)
	}

	ex.mutex.Lock()
	defer ex.mutex.Unlock()

	status := ex.exportJob.getStatus()
	if status.Running {
		ex.logger.Error("export already running")
		return response.Error(http.StatusLocked, "export already running", nil)
	}

	ctx := appcontext.WithUser(context.Background(), c.SignedInUser)
	var job Job
	broadcast := func(s ExportStatus) {
		ex.broadcastStatus(c.OrgID, s)
	}
	switch cfg.Format {
	case "dummy":
		job, err = startDummyExportJob(cfg, broadcast)
	case "entityStore":
		job, err = startEntityStoreJob(ctx, cfg, broadcast, ex.db, ex.playlistService, ex.store, ex.dashboardsnapshotsService)
	case "git":
		dir := filepath.Join(ex.dataDir, "export_git", fmt.Sprintf("git_%d", time.Now().Unix()))
		if err := os.MkdirAll(dir, os.ModePerm); err != nil {
			return response.Error(http.StatusBadRequest, "Error creating export folder", nil)
		}
		job, err = startGitExportJob(ctx, cfg, ex.db, ex.dashboardsnapshotsService, dir, c.OrgID, broadcast, ex.playlistService, ex.orgService, ex.datasourceService)
	default:
		return response.Error(http.StatusBadRequest, "Unsupported job format", nil)
	}

	if err != nil {
		ex.logger.Error("failed to start export job", "err", err)
		return response.Error(http.StatusBadRequest, "failed to start export job", err)
	}

	ex.exportJob = job

	info := map[string]interface{}{
		"cfg":    cfg, // parsed job we are running
		"status": ex.exportJob.getStatus(),
	}
	return response.JSON(http.StatusOK, info)
}

func (ex *StandardExport) broadcastStatus(orgID int64, s ExportStatus) {
	msg, err := json.Marshal(s)
	if err != nil {
		ex.logger.Warn("Error making message", "err", err)
		return
	}
	err = ex.glive.Publish(orgID, "grafana/broadcast/export", msg)
	if err != nil {
		ex.logger.Warn("Error Publish message", "err", err)
		return
	}
}