package api import ( "context" "net/http" "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/api/response" "github.com/grafana/grafana/pkg/kinds/preferences" "github.com/grafana/grafana/pkg/services/auth/identity" contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model" "github.com/grafana/grafana/pkg/services/dashboards" pref "github.com/grafana/grafana/pkg/services/preference" "github.com/grafana/grafana/pkg/services/preference/prefapi" "github.com/grafana/grafana/pkg/web" ) // POST /api/preferences/set-home-dash func (hs *HTTPServer) SetHomeDashboard(c *contextmodel.ReqContext) response.Response { cmd := pref.SavePreferenceCommand{} if err := web.Bind(c.Req, &cmd); err != nil { return response.Error(http.StatusBadRequest, "bad request data", err) } userID, errID := identity.UserIdentifier(c.SignedInUser.GetNamespacedID()) if errID != nil { return response.Error(http.StatusInternalServerError, "Failed to set home dashboard", errID) } cmd.UserID = userID cmd.OrgID = c.SignedInUser.GetOrgID() // the default value of HomeDashboardID is taken from input, when HomeDashboardID is set also, // UID is used in preference to identify dashboard dashboardID := cmd.HomeDashboardID if cmd.HomeDashboardUID != nil { query := dashboards.GetDashboardQuery{UID: *cmd.HomeDashboardUID} if query.UID == "" { dashboardID = 0 // clear the value } else { queryResult, err := hs.DashboardService.GetDashboard(c.Req.Context(), &query) if err != nil { return response.Error(http.StatusNotFound, "Dashboard not found", err) } dashboardID = queryResult.ID } } cmd.HomeDashboardID = dashboardID if err := hs.preferenceService.Save(c.Req.Context(), &cmd); err != nil { return response.ErrOrFallback(http.StatusInternalServerError, "Failed to set home dashboard", err) } return response.Success("Home dashboard set") } // swagger:route GET /user/preferences user_preferences getUserPreferences // // Get user preferences. // // Responses: // 200: getPreferencesResponse // 401: unauthorisedError // 500: internalServerError func (hs *HTTPServer) GetUserPreferences(c *contextmodel.ReqContext) response.Response { userID, errID := identity.UserIdentifier(c.SignedInUser.GetNamespacedID()) if errID != nil { return response.Error(http.StatusInternalServerError, "Failed to get user preferences", errID) } return prefapi.GetPreferencesFor(c.Req.Context(), hs.DashboardService, hs.preferenceService, c.SignedInUser.GetOrgID(), userID, 0) } // swagger:route PUT /user/preferences user_preferences updateUserPreferences // // Update user preferences. // // Omitting a key (`theme`, `homeDashboardId`, `timezone`) will cause the current value to be replaced with the system default value. // // Responses: // 200: okResponse // 400: badRequestError // 401: unauthorisedError // 500: internalServerError func (hs *HTTPServer) UpdateUserPreferences(c *contextmodel.ReqContext) response.Response { dtoCmd := dtos.UpdatePrefsCmd{} if err := web.Bind(c.Req, &dtoCmd); err != nil { return response.Error(http.StatusBadRequest, "bad request data", err) } userID, errID := identity.UserIdentifier(c.SignedInUser.GetNamespacedID()) if errID != nil { return response.Error(http.StatusInternalServerError, "Failed to update user preferences", errID) } return prefapi.UpdatePreferencesFor(c.Req.Context(), hs.DashboardService, hs.preferenceService, c.SignedInUser.GetOrgID(), userID, 0, &dtoCmd) } // swagger:route PATCH /user/preferences user_preferences patchUserPreferences // // Patch user preferences. // // Responses: // 200: okResponse // 400: badRequestError // 401: unauthorisedError // 500: internalServerError func (hs *HTTPServer) PatchUserPreferences(c *contextmodel.ReqContext) response.Response { dtoCmd := dtos.PatchPrefsCmd{} if err := web.Bind(c.Req, &dtoCmd); err != nil { return response.Error(http.StatusBadRequest, "bad request data", err) } userID, errID := identity.UserIdentifier(c.SignedInUser.GetNamespacedID()) if errID != nil { return response.Error(http.StatusInternalServerError, "Failed to update user preferences", errID) } return hs.patchPreferencesFor(c.Req.Context(), c.SignedInUser.GetOrgID(), userID, 0, &dtoCmd) } func (hs *HTTPServer) patchPreferencesFor(ctx context.Context, orgID, userID, teamId int64, dtoCmd *dtos.PatchPrefsCmd) response.Response { if dtoCmd.Theme != nil && !pref.IsValidThemeID(*dtoCmd.Theme) { return response.Error(http.StatusBadRequest, "Invalid theme", nil) } // convert dashboard UID to ID in order to store internally if it exists in the query, otherwise take the id from query dashboardID := dtoCmd.HomeDashboardID if dtoCmd.HomeDashboardUID != nil { query := dashboards.GetDashboardQuery{UID: *dtoCmd.HomeDashboardUID, OrgID: orgID} if query.UID == "" { // clear the value defaultDash := int64(0) dashboardID = &defaultDash } else { queryResult, err := hs.DashboardService.GetDashboard(ctx, &query) if err != nil { return response.Error(http.StatusNotFound, "Dashboard not found", err) } dashboardID = &queryResult.ID } } dtoCmd.HomeDashboardID = dashboardID patchCmd := pref.PatchPreferenceCommand{ UserID: userID, OrgID: orgID, TeamID: teamId, Theme: dtoCmd.Theme, Timezone: dtoCmd.Timezone, WeekStart: dtoCmd.WeekStart, HomeDashboardID: dtoCmd.HomeDashboardID, Language: dtoCmd.Language, QueryHistory: dtoCmd.QueryHistory, CookiePreferences: dtoCmd.Cookies, } if err := hs.preferenceService.Patch(ctx, &patchCmd); err != nil { return response.ErrOrFallback(http.StatusInternalServerError, "Failed to save preferences", err) } return response.Success("Preferences updated") } // swagger:route GET /org/preferences org_preferences getOrgPreferences // // Get Current Org Prefs. // // Responses: // 200: getPreferencesResponse // 401: unauthorisedError // 403: forbiddenError // 500: internalServerError func (hs *HTTPServer) GetOrgPreferences(c *contextmodel.ReqContext) response.Response { return prefapi.GetPreferencesFor(c.Req.Context(), hs.DashboardService, hs.preferenceService, c.SignedInUser.GetOrgID(), 0, 0) } // swagger:route PUT /org/preferences org_preferences updateOrgPreferences // // Update Current Org Prefs. // // Responses: // 200: okResponse // 400: badRequestError // 401: unauthorisedError // 403: forbiddenError // 500: internalServerError func (hs *HTTPServer) UpdateOrgPreferences(c *contextmodel.ReqContext) response.Response { dtoCmd := dtos.UpdatePrefsCmd{} if err := web.Bind(c.Req, &dtoCmd); err != nil { return response.Error(http.StatusBadRequest, "bad request data", err) } return prefapi.UpdatePreferencesFor(c.Req.Context(), hs.DashboardService, hs.preferenceService, c.SignedInUser.GetOrgID(), 0, 0, &dtoCmd) } // swagger:route PATCH /org/preferences org_preferences patchOrgPreferences // // Patch Current Org Prefs. // // Responses: // 200: okResponse // 400: badRequestError // 401: unauthorisedError // 403: forbiddenError // 500: internalServerError func (hs *HTTPServer) PatchOrgPreferences(c *contextmodel.ReqContext) response.Response { dtoCmd := dtos.PatchPrefsCmd{} if err := web.Bind(c.Req, &dtoCmd); err != nil { return response.Error(http.StatusBadRequest, "bad request data", err) } return hs.patchPreferencesFor(c.Req.Context(), c.SignedInUser.GetOrgID(), 0, 0, &dtoCmd) } // swagger:parameters updateUserPreferences type UpdateUserPreferencesParams struct { // in:body // required:true Body dtos.UpdatePrefsCmd `json:"body"` } // swagger:parameters updateOrgPreferences type UpdateOrgPreferencesParams struct { // in:body // required:true Body dtos.UpdatePrefsCmd `json:"body"` } // swagger:response getPreferencesResponse type GetPreferencesResponse struct { // in:body Body preferences.Spec `json:"body"` } // swagger:parameters patchUserPreferences type PatchUserPreferencesParams struct { // in:body // required:true Body dtos.PatchPrefsCmd `json:"body"` } // swagger:parameters patchOrgPreferences type PatchOrgPreferencesParams struct { // in:body // required:true Body dtos.PatchPrefsCmd `json:"body"` }