blob: b9b3ffeeeed92c706b5d291239c129210aa0104e [file] [log] [blame]
package client
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import (
"errors"
"fmt"
"net/http"
"net/url"
"strconv"
"github.com/apache/trafficcontrol/lib/go-rfc"
"github.com/apache/trafficcontrol/lib/go-tc"
"github.com/apache/trafficcontrol/traffic_ops/toclientlib"
)
func (to *Session) GetUsersWithHdr(header http.Header) ([]tc.User, toclientlib.ReqInf, error) {
data := tc.UsersResponse{}
route := "/users"
inf, err := to.get(route, header, &data)
return data.Response, inf, err
}
// GetUsers returns all users accessible from current user
// Deprecated: GetUsers will be removed in 6.0. Use GetUsersWithHdr.
func (to *Session) GetUsers() ([]tc.User, toclientlib.ReqInf, error) {
return to.GetUsersWithHdr(nil)
}
func (to *Session) GetUsersByRoleWithHdr(roleName string, header http.Header) ([]tc.User, toclientlib.ReqInf, error) {
data := tc.UsersResponse{}
route := fmt.Sprintf("/users?role=%s", url.QueryEscape(roleName))
inf, err := to.get(route, header, &data)
return data.Response, inf, err
}
// GetUsersByRole returns all users accessible from current user for a given role
// Deprecated: GetUsersByRole will be removed in 6.0. Use GetUsersByRoleWithHdr.
func (to *Session) GetUsersByRole(roleName string) ([]tc.User, toclientlib.ReqInf, error) {
return to.GetUsersByRoleWithHdr(roleName, nil)
}
func (to *Session) GetUserByIDWithHdr(id int, header http.Header) ([]tc.User, toclientlib.ReqInf, error) {
data := tc.UsersResponse{}
route := fmt.Sprintf("/users/%d", id)
inf, err := to.get(route, header, &data)
return data.Response, inf, err
}
// Deprecated: GetUserByID will be removed in 6.0. Use GetUserByIDWithHdr.
func (to *Session) GetUserByID(id int) ([]tc.User, toclientlib.ReqInf, error) {
return to.GetUserByIDWithHdr(id, nil)
}
func (to *Session) GetUserByUsernameWithHdr(username string, header http.Header) ([]tc.User, toclientlib.ReqInf, error) {
data := tc.UsersResponse{}
route := fmt.Sprintf("/users?username=%s", url.QueryEscape(username))
inf, err := to.get(route, header, &data)
return data.Response, inf, err
}
// Deprecated: GetUserByUsername will be removed in 6.0. Use GetUserByUsernameWithHdr.
func (to *Session) GetUserByUsername(username string) ([]tc.User, toclientlib.ReqInf, error) {
return to.GetUserByUsernameWithHdr(username, nil)
}
func (to *Session) GetUserCurrentWithHdr(header http.Header) (*tc.UserCurrent, toclientlib.ReqInf, error) {
route := `/user/current`
resp := tc.UserCurrentResponse{}
reqInf, err := to.get(route, header, &resp)
if err != nil {
return nil, reqInf, err
}
return &resp.Response, reqInf, nil
}
// GetUserCurrent gets information about the current user
// Deprecated: GetUserCurrent will be removed in 6.0. Use GetUserCurrentWithHdr.
func (to *Session) GetUserCurrent() (*tc.UserCurrent, toclientlib.ReqInf, error) {
return to.GetUserCurrentWithHdr(nil)
}
// UpdateCurrentUser replaces the current user data with the provided tc.User structure.
func (to *Session) UpdateCurrentUser(u tc.User) (*tc.UpdateUserResponse, toclientlib.ReqInf, error) {
user := struct {
User tc.User `json:"user"`
}{u}
var clientResp tc.UpdateUserResponse
reqInf, err := to.put("/user/current", user, nil, &clientResp)
return &clientResp, reqInf, err
}
// CreateUser creates a user
func (to *Session) CreateUser(user *tc.User) (*tc.CreateUserResponse, toclientlib.ReqInf, error) {
if user.TenantID == nil && user.Tenant != nil {
tenant, _, err := to.TenantByNameWithHdr(*user.Tenant, nil)
if err != nil {
return nil, toclientlib.ReqInf{}, err
}
if tenant == nil {
return nil, toclientlib.ReqInf{}, errors.New("no tenant with name " + *user.Tenant)
}
user.TenantID = &tenant.ID
}
if user.RoleName != nil && *user.RoleName != "" {
roles, _, _, err := to.GetRoleByNameWithHdr(*user.RoleName, nil)
if err != nil {
return nil, toclientlib.ReqInf{}, err
}
if len(roles) == 0 || roles[0].ID == nil {
return nil, toclientlib.ReqInf{}, errors.New("no role with name " + *user.RoleName)
}
user.Role = roles[0].ID
}
route := "/users"
var clientResp tc.CreateUserResponse
reqInf, err := to.post(route, user, nil, &clientResp)
return &clientResp, reqInf, err
}
// UpdateUserByID updates user with the given id
func (to *Session) UpdateUserByID(id int, u *tc.User) (*tc.UpdateUserResponse, toclientlib.ReqInf, error) {
route := "/users/" + strconv.Itoa(id)
var clientResp tc.UpdateUserResponse
reqInf, err := to.put(route, u, nil, &clientResp)
return &clientResp, reqInf, err
}
// DeleteUserByID updates user with the given id
func (to *Session) DeleteUserByID(id int) (tc.Alerts, toclientlib.ReqInf, error) {
route := "/users/" + strconv.Itoa(id)
var alerts tc.Alerts
reqInf, err := to.del(route, nil, &alerts)
return alerts, reqInf, err
}
// RegisterNewUser requests the registration of a new user with the given tenant ID and role ID,
// through their email.
func (to *Session) RegisterNewUser(tenantID uint, roleID uint, email rfc.EmailAddress) (tc.Alerts, toclientlib.ReqInf, error) {
var alerts tc.Alerts
reqBody := tc.UserRegistrationRequest{
Email: email,
TenantID: tenantID,
Role: roleID,
}
reqInf, err := to.post("/users/register", reqBody, nil, &alerts)
return alerts, reqInf, err
}