Add common settings (#4547)

Author: nono

client/instances.go

@@ -70,6 +70,7 @@ type InstanceOptions struct {
 	Sponsorships       []string
 	Email              string
 	PublicName         string
+	Phone              string
 	Settings           string
 	BlockingReason     string
 	SwiftLayout        int
@@ -156,6 +157,7 @@ func (ac *AdminClient) CreateInstance(opts *InstanceOptions) (*Instance, error)
 		"ContextName":     {opts.ContextName},
 		"Email":           {opts.Email},
 		"PublicName":      {opts.PublicName},
+		"Phone":           {opts.Phone},
 		"Settings":        {opts.Settings},
 		"SwiftLayout":     {strconv.Itoa(opts.SwiftLayout)},
 		"CouchCluster":    {strconv.Itoa(opts.CouchCluster)},
@@ -237,6 +239,7 @@ func (ac *AdminClient) ModifyInstance(opts *InstanceOptions) (*Instance, error)
 		"ContextName":     {opts.ContextName},
 		"Email":           {opts.Email},
 		"PublicName":      {opts.PublicName},
+		"Phone":           {opts.Phone},
 		"Settings":        {opts.Settings},
 		"DiskQuota":       {strconv.FormatInt(opts.DiskQuota, 10)},
 	}

cmd/instances.go

@@ -31,6 +31,7 @@ var flagLocale string
 var flagTimezone string
 var flagEmail string
 var flagPublicName string
+var flagPhone string
 var flagSettings string
 var flagDiskQuota string
 var flagApps []string
@@ -192,6 +193,7 @@ be used as the error message.
 			Sponsorships:    flagSponsorships,
 			Email:           flagEmail,
 			PublicName:      flagPublicName,
+			Phone:           flagPhone,
 			Settings:        flagSettings,
 			SwiftLayout:     flagSwiftLayout,
 			CouchCluster:    flagCouchCluster,
@@ -281,6 +283,7 @@ settings for a specified domain.
 			Sponsorships:    flagSponsorships,
 			Email:           flagEmail,
 			PublicName:      flagPublicName,
+			Phone:           flagPhone,
 			Settings:        flagSettings,
 			BlockingReason:  flagBlockingReason,
 			DiskQuota:       diskQuota,
@@ -1091,6 +1094,7 @@ func init() {
 	addInstanceCmd.Flags().StringSliceVar(&flagSponsorships, "sponsorships", nil, "Sponsorships of the instance (comma separated list)")
 	addInstanceCmd.Flags().StringVar(&flagEmail, "email", "", "The email of the owner")
 	addInstanceCmd.Flags().StringVar(&flagPublicName, "public-name", "", "The public name of the owner")
+	addInstanceCmd.Flags().StringVar(&flagPhone, "phone", "", "The phone number of the owner")
 	addInstanceCmd.Flags().StringVar(&flagSettings, "settings", "", "A list of settings (eg context:foo,offer:premium)")
 	addInstanceCmd.Flags().IntVar(&flagSwiftLayout, "swift-layout", -1, "Specify the layout to use for Swift (from 0 for layout V1 to 2 for layout V3, -1 means the default)")
 	addInstanceCmd.Flags().IntVar(&flagCouchCluster, "couch-cluster", -1, "Specify the CouchDB cluster where the instance will be created (-1 means the default)")
@@ -1112,6 +1116,7 @@ func init() {
 	modifyInstanceCmd.Flags().StringSliceVar(&flagSponsorships, "sponsorships", nil, "Sponsorships of the instance (comma separated list)")
 	modifyInstanceCmd.Flags().StringVar(&flagEmail, "email", "", "New email")
 	modifyInstanceCmd.Flags().StringVar(&flagPublicName, "public-name", "", "New public name")
+	modifyInstanceCmd.Flags().StringVar(&flagPhone, "phone", "", "New phone number")
 	modifyInstanceCmd.Flags().StringVar(&flagSettings, "settings", "", "New list of settings (eg offer:premium)")
 	modifyInstanceCmd.Flags().StringVar(&flagDiskQuota, "disk-quota", "", "Specify a new disk quota")
 	modifyInstanceCmd.Flags().StringVar(&flagBlockingReason, "blocking-reason", "", "Code that explains why the instance is blocked (PAYMENT_FAILED, LOGIN_FAILED, etc.)")

cozy.example.yaml

@@ -361,6 +361,12 @@ office:
 #       url: https://manager.example.org/
 #       token: xxxxxx
 
+# [internal usage] Common settings
+# common_settings:
+#   default:
+#     url: https://sign-up.example.org/
+#     token: f95880b7fa9e8a51e103ac5383bc5956d849267e99b336f31df8bd86c2e9ec50
+
 # All the deprecated apps listed here will see their OAUTH2 Authorization
 # flow interupted and redirected to a page proposing to move to the new
 # cozy application.

docs/cli/cozy-stack_instances_add.md

@@ -39,6 +39,7 @@ $ cozy-stack instances add --passphrase cozy --apps drive,photos,settings,home,s
       --magic_link                Enable authentication with magic links sent by email
       --oidc_id string            The identifier for checking authentication from OIDC
       --passphrase string         Register the instance with this passphrase (useful for tests)
+      --phone string              The phone number of the owner
       --public-name string        The public name of the owner
       --settings string           A list of settings (eg context:foo,offer:premium)
       --sponsorships strings      Sponsorships of the instance (comma separated list)

docs/cli/cozy-stack_instances_modify.md

@@ -29,6 +29,7 @@ cozy-stack instances modify <domain> [flags]
       --magic_link                  Enable authentication with magic links sent by email
       --oidc_id string              New identifier for checking authentication from OIDC
       --onboarding-finished         Force the finishing of the onboarding
+      --phone string                New phone number
       --public-name string          New public name
       --settings string             New list of settings (eg offer:premium)
       --sponsorships strings        Sponsorships of the instance (comma separated list)

model/instance/instance.go

@@ -73,6 +73,8 @@ type Instance struct {
 	BytesDiskQuota    int64 `json:"disk_quota,string,omitempty"` // The total size in bytes allowed to the user
 	IndexViewsVersion int   `json:"indexes_version,omitempty"`
 
+	CommonSettingsVersion int `json:"common_settings_version,omitempty"`
+
 	// Swift layout number:
 	// - 0 for layout v1
 	// - 1 for layout v2

model/instance/lifecycle/create.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/cozy/cozy-stack/model/contact"
 	"github.com/cozy/cozy-stack/model/instance"
+	"github.com/cozy/cozy-stack/model/settings/common"
 	"github.com/cozy/cozy-stack/pkg/config/config"
 	"github.com/cozy/cozy-stack/pkg/consts"
 	"github.com/cozy/cozy-stack/pkg/couchdb"
@@ -39,6 +40,7 @@ type Options struct {
 	FeatureSets        []string
 	Email              string
 	PublicName         string
+	Phone              string
 	Settings           string
 	SettingsObj        *couchdb.JSONDoc
 	AuthMode           string
@@ -268,6 +270,12 @@ func Create(opts *Options) (*instance.Instance, error) {
 		}
 	})
 
+	opts.trace("create common settings", func() {
+		if err = common.CreateCommonSettings(i, settings); err != nil {
+			i.Logger().Errorf("Failed to create common settings: %s", err)
+		}
+	})
+
 	return i, nil
 }
 
@@ -368,6 +376,9 @@ func buildSettings(inst *instance.Instance, opts *Options) (*couchdb.JSONDoc, er
 	if name := opts.PublicName; name != "" {
 		settings.M["public_name"] = name
 	}
+	if phone := opts.Phone; phone != "" {
+		settings.M["phone"] = phone
+	}
 
 	if len(opts.TOSSigned) == 8 {
 		opts.TOSSigned = "1.0.0-" + opts.TOSSigned

model/instance/lifecycle/patch.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/cozy/cozy-stack/model/cloudery"
 	"github.com/cozy/cozy-stack/model/instance"
+	"github.com/cozy/cozy-stack/model/settings/common"
 	"github.com/cozy/cozy-stack/pkg/couchdb"
 	"github.com/cozy/cozy-stack/pkg/logger"
 	"github.com/labstack/echo/v4"
@@ -165,6 +166,7 @@ func Patch(i *instance.Instance, opts *Options) error {
 		if err != nil {
 			return err
 		}
+
 		if needSharingReupload && AskReupload != nil {
 			go func() {
 				inst := i.Clone().(*instance.Instance)
@@ -198,6 +200,17 @@ func Patch(i *instance.Instance, opts *Options) error {
 		}
 	}
 
+	updated, err := common.UpdateCommonSettings(i, settings)
+	if err != nil {
+		i.Logger().Errorf("Failed to update common settings: %s", err)
+	}
+	if updated {
+		// We need to persist the common settings version
+		if err = update(i); err != nil {
+			return err
+		}
+	}
+
 	if debug := opts.Debug; debug != nil {
 		var err error
 		if *debug {