gonextcloud/users_impl.go

440 lines
11 KiB
Go
Raw Permalink Normal View History

package gonextcloud
import (
2018-07-24 18:26:12 +00:00
"encoding/json"
2018-07-05 13:22:56 +00:00
"net/http"
"net/url"
"path"
"strings"
"sync"
req "github.com/levigross/grequests"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
)
//users contains all users available actions
type users struct {
c *client
}
// List return the Nextcloud'user list
func (u *users) List() ([]string, error) {
res, err := u.c.baseRequest(http.MethodGet, routes.users, nil)
//res, err := c.session.Get(u.String(), nil)
if err != nil {
return nil, err
}
var r userListResponse
2018-07-24 18:26:12 +00:00
res.JSON(&r)
return r.Ocs.Data.Users, nil
}
//ListDetails return a map of user with details
func (u *users) ListDetails() (map[string]UserDetails, error) {
res, err := u.c.baseRequest(http.MethodGet, routes.users, nil, "details")
//res, err := c.session.Get(u.String(), nil)
if err != nil {
return nil, err
}
var r userListDetailsResponse
res.JSON(&r)
return r.Ocs.Data.Users, nil
}
// Get return the details about the specified user
func (u *users) Get(name string) (*UserDetails, error) {
2018-07-24 18:26:12 +00:00
if name == "" {
return nil, &APIError{Message: "name cannot be empty"}
2018-07-24 18:26:12 +00:00
}
res, err := u.c.baseRequest(http.MethodGet, routes.users, nil, name)
if err != nil {
return nil, err
}
var r userResponse
2018-07-24 18:26:12 +00:00
js := res.String()
// Nextcloud does not encode JSON properly
js = reformatJSON(js)
if err := json.Unmarshal([]byte(js), &r); err != nil {
return nil, err
}
2018-07-24 18:26:12 +00:00
return &r.Ocs.Data, nil
}
// Search returns the users whose name match the search string
func (u *users) Search(search string) ([]string, error) {
ro := &req.RequestOptions{
Params: map[string]string{"search": search},
}
res, err := u.c.baseRequest(http.MethodGet, routes.users, ro)
if err != nil {
return nil, err
}
var r userListResponse
res.JSON(&r)
return r.Ocs.Data.Users, nil
}
// Create create a new user
func (u *users) Create(username string, password string, user *UserDetails) error {
// Create base users
ro := &req.RequestOptions{
Data: map[string]string{
"userid": username,
"password": password,
},
}
if err := u.baseRequest(http.MethodPost, ro); err != nil {
return err
}
2018-10-16 07:34:56 +00:00
// Check if we need to add user details information
if user == nil {
return nil
}
2018-10-16 07:34:56 +00:00
// Add user details information
return u.Update(user)
}
// CreateWithoutPassword create a user without provisioning a password, the email address must be provided to send
// an init password email
func (u *users) CreateWithoutPassword(username, email, displayName, quota, language string, groups ...string) error {
if u.c.version.Major < 14 {
return errors.New("unsupported method: requires Nextcloud 14+")
}
if username == "" || email == "" {
return errors.New("username and email cannot be empty")
}
data := map[string]string{
"userid": username,
"email": email,
"displayName": displayName,
"quota": quota,
"language": language,
}
ro := &req.RequestOptions{}
f := url.Values{}
for k, v := range data {
if v != "" {
f.Add(k, v)
}
}
for _, g := range groups {
f.Add("groups[]", g)
}
ro.RequestBody = strings.NewReader(f.Encode())
ro.Headers = map[string]string{"Content-Type": "application/x-www-form-urlencoded"}
if err := u.baseRequest(http.MethodPost, ro); err != nil {
return err
}
return nil
}
//CreateBatchWithoutPassword create multiple users and send them the init password email
func (u *users) CreateBatchWithoutPassword(users []User) error {
var wg sync.WaitGroup
errs := make(chan error)
for _, us := range users {
wg.Add(1)
go func(user User) {
logrus.Debugf("creating user %s", user.Username)
defer wg.Done()
if err := u.CreateWithoutPassword(
user.Username, user.Email, user.DisplayName, "", "", user.Groups...,
); err != nil {
errs <- err
}
}(us)
}
go func() {
wg.Wait()
close(errs)
}()
var es []error
for err := range errs {
es = append(es, err)
}
if len(es) > 0 {
return errors.Errorf("errors occurred while creating users: %v", es)
}
return nil
}
//Delete delete the user
func (u *users) Delete(name string) error {
return u.baseRequest(http.MethodDelete, nil, name)
}
//Enable enables the user
func (u *users) Enable(name string) error {
ro := &req.RequestOptions{
Data: map[string]string{},
}
return u.baseRequest(http.MethodPut, ro, name, "enable")
}
//Disable disables the user
func (u *users) Disable(name string) error {
ro := &req.RequestOptions{
Data: map[string]string{},
}
return u.baseRequest(http.MethodPut, ro, name, "disable")
}
//SendWelcomeEmail (re)send the welcome mail to the user (return an error if the user has not configured his email)
func (u *users) SendWelcomeEmail(name string) error {
return u.baseRequest(http.MethodPost, nil, name, "welcome")
}
//Update takes a *types.users struct to update the user's information
// Updatable fields: Email, Displayname, Phone, Address, Website, Twitter, Quota, groups
func (u *users) Update(user *UserDetails) error {
// Get user to update only modified fields
original, err := u.Get(user.ID)
if err != nil {
return err
}
errs := make(chan *UpdateError)
var wg sync.WaitGroup
update := func(key string, value string) {
defer wg.Done()
if err := u.updateAttribute(user.ID, strings.ToLower(key), value); err != nil {
errs <- &UpdateError{
Field: key,
Error: err,
}
2019-01-18 10:25:14 +00:00
}
errs <- nil
}
// Email
if user.Email != original.Email {
wg.Add(1)
go update("Email", user.Email)
}
// Displayname
if user.Displayname != original.Displayname {
wg.Add(1)
go update("Displayname", user.Displayname)
}
// Phone
if user.Phone != original.Phone {
wg.Add(1)
go update("Phone", user.Phone)
}
// Address
if user.Address != original.Address {
wg.Add(1)
go update("Address", user.Address)
}
// Website
if user.Website != original.Website {
wg.Add(1)
go update("Website", user.Website)
}
// Twitter
if user.Twitter != original.Twitter {
wg.Add(1)
go update("Twitter", user.Twitter)
}
// Quota
if user.Quota.Quota != original.Quota.Quota {
2019-01-16 14:31:22 +00:00
var value string
// If empty
if user.Quota == (Quota{}) {
value = "default"
2019-01-16 14:31:22 +00:00
} else {
value = user.Quota.String()
2019-01-16 14:31:22 +00:00
}
wg.Add(1)
go update("Quota", value)
}
// groups
// Group removed
for _, g := range original.Groups {
if !contains(user.Groups, g) {
wg.Add(1)
2019-02-19 08:30:27 +00:00
go func(gr string) {
defer wg.Done()
2019-02-19 08:30:27 +00:00
if err := u.GroupRemove(user.ID, gr); err != nil {
errs <- &UpdateError{
Field: "groups/" + gr,
Error: err,
}
}
errs <- nil
2019-02-19 08:30:27 +00:00
}(g)
}
}
// Group Added
for _, g := range user.Groups {
if !contains(original.Groups, g) {
wg.Add(1)
2019-02-19 08:30:27 +00:00
go func(gr string) {
defer wg.Done()
2019-02-19 08:30:27 +00:00
if err := u.GroupAdd(user.ID, gr); err != nil {
errs <- &UpdateError{
Field: "groups/" + gr,
Error: err,
}
}
errs <- nil
2019-02-19 08:30:27 +00:00
}(g)
}
}
go func() {
wg.Wait()
close(errs)
}()
2019-01-18 12:42:40 +00:00
// Warning : we actually need to check the *err
if err := newUpdateError(errs); err != nil {
2019-01-18 12:42:40 +00:00
return err
}
return nil
}
//UpdateEmail update the user's email
func (u *users) UpdateEmail(name string, email string) error {
return u.updateAttribute(name, "email", email)
}
//UpdateDisplayName update the user's display name
func (u *users) UpdateDisplayName(name string, displayName string) error {
return u.updateAttribute(name, "displayname", displayName)
}
//UpdatePhone update the user's phone
func (u *users) UpdatePhone(name string, phone string) error {
return u.updateAttribute(name, "phone", phone)
}
//UpdateAddress update the user's address
func (u *users) UpdateAddress(name string, address string) error {
return u.updateAttribute(name, "address", address)
}
//UpdateWebSite update the user's website
func (u *users) UpdateWebSite(name string, website string) error {
return u.updateAttribute(name, "website", website)
}
//UpdateTwitter update the user's twitter
func (u *users) UpdateTwitter(name string, twitter string) error {
return u.updateAttribute(name, "twitter", twitter)
}
//UpdatePassword update the user's password
func (u *users) UpdatePassword(name string, password string) error {
return u.updateAttribute(name, "password", password)
}
2019-01-16 14:31:22 +00:00
//UpdateQuota update the user's quota (bytes). Set negative quota for unlimited
func (u *users) UpdateQuota(name string, quota int64) error {
q := Quota{Quota: quota}
2019-01-16 14:31:22 +00:00
return u.updateAttribute(name, "quota", q.String())
}
//GroupList lists the user's groups
func (u *users) GroupList(name string) ([]string, error) {
res, err := u.c.baseRequest(http.MethodGet, routes.users, nil, name, "groups")
2018-07-05 14:15:51 +00:00
if err != nil {
return nil, err
}
var r groupListResponse
2018-07-05 14:15:51 +00:00
res.JSON(&r)
return r.Ocs.Data.Groups, nil
}
//GroupAdd adds a the user to the group
func (u *users) GroupAdd(name string, group string) error {
2018-07-05 14:15:51 +00:00
ro := &req.RequestOptions{
Data: map[string]string{
"groupid": group,
},
}
return u.baseRequest(http.MethodPost, ro, name, "groups")
2018-07-05 14:15:51 +00:00
}
//GroupRemove removes the user from the group
func (u *users) GroupRemove(name string, group string) error {
2018-07-05 14:15:51 +00:00
ro := &req.RequestOptions{
Data: map[string]string{
"groupid": group,
},
}
return u.baseRequest(http.MethodDelete, ro, name, "groups")
2018-07-05 14:15:51 +00:00
}
//GroupPromote promotes the user as group admin
func (u *users) GroupPromote(name string, group string) error {
2018-07-05 14:15:51 +00:00
ro := &req.RequestOptions{
Data: map[string]string{
"groupid": group,
},
}
return u.baseRequest(http.MethodPost, ro, name, "subadmins")
2018-07-05 14:15:51 +00:00
}
//GroupDemote demotes the user
func (u *users) GroupDemote(name string, group string) error {
2018-07-05 14:15:51 +00:00
ro := &req.RequestOptions{
Data: map[string]string{
"groupid": group,
},
}
return u.baseRequest(http.MethodDelete, ro, name, "subadmins")
2018-07-05 14:15:51 +00:00
}
//GroupSubAdminList lists the groups where he is subadmin
func (u *users) GroupSubAdminList(name string) ([]string, error) {
if !u.c.loggedIn() {
2018-07-30 08:08:35 +00:00
return nil, errUnauthorized
2018-07-05 14:15:51 +00:00
}
ur := u.c.baseURL.ResolveReference(routes.users)
ur.Path = path.Join(ur.Path, name, "subadmins")
res, err := u.c.session.Get(ur.String(), nil)
2018-07-05 14:15:51 +00:00
if err != nil {
return nil, err
}
var r baseResponse
2018-07-05 14:15:51 +00:00
res.JSON(&r)
return r.Ocs.Data, nil
}
func (u *users) updateAttribute(name string, key string, value string) error {
ro := &req.RequestOptions{
Data: map[string]string{
"key": key,
"value": value,
},
}
return u.baseRequest(http.MethodPut, ro, name)
2018-07-05 13:22:56 +00:00
}
func (u *users) baseRequest(method string, ro *req.RequestOptions, subRoutes ...string) error {
_, err := u.c.baseRequest(method, routes.users, ro, subRoutes...)
return err
}
func ignoredUserField(key string) bool {
keys := []string{"Email", "Displayname", "Phone", "Address", "Website", "Twitter", "Quota", "groups"}
for _, k := range keys {
if key == k {
2019-01-18 10:16:49 +00:00
return false
}
}
2019-01-18 10:16:49 +00:00
return true
}
func contains(slice []string, e string) bool {
for _, s := range slice {
if e == s {
return true
}
}
return false
}