matterbridge/vendor/github.com/mattermost/mattermost-server/v5/model/license.go

351 lines
10 KiB
Go
Raw Normal View History

2020-08-09 22:29:54 +00:00
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
2016-04-10 21:39:38 +00:00
package model
import (
"encoding/json"
"fmt"
2016-04-10 21:39:38 +00:00
"io"
2018-02-08 23:11:04 +00:00
"net/http"
"time"
2016-04-10 21:39:38 +00:00
)
2017-03-25 20:04:10 +00:00
const (
EXPIRED_LICENSE_ERROR = "api.license.add_license.expired.app_error"
INVALID_LICENSE_ERROR = "api.license.add_license.invalid.app_error"
2020-08-09 22:29:54 +00:00
LICENSE_GRACE_PERIOD = 1000 * 60 * 60 * 24 * 10 //10 days
2020-10-19 21:40:00 +00:00
LICENSE_RENEWAL_LINK = "https://mattermost.com/renew/"
2017-03-25 20:04:10 +00:00
)
const (
SIXTY_DAYS = 60
FIFTY_EIGHT = 58
LICENSE_UP_FOR_RENEWAL_EMAIL_SENT = "LicenseUpForRenewalEmailSent"
)
var (
trialDuration = 30*(time.Hour*24) + (time.Hour * 8) // 720 hours (30 days) + 8 hours is trial license duration
adminTrialDuration = 30*(time.Hour*24) + (time.Hour * 23) + (time.Minute * 59) + (time.Second * 59) // 720 hours (30 days) + 23 hours, 59 mins and 59 seconds
// a sanctioned trial's duration is either more than the upper bound,
// or less than the lower bound
sanctionedTrialDurationLowerBound = 31*(time.Hour*24) + (time.Hour * 23) + (time.Minute * 59) + (time.Second * 59) // 744 hours (31 days) + 23 hours, 59 mins and 59 seconds
sanctionedTrialDurationUpperBound = 29*(time.Hour*24) + (time.Hour * 23) + (time.Minute * 59) + (time.Second * 59) // 696 hours (29 days) + 23 hours, 59 mins and 59 seconds
)
2016-04-10 21:39:38 +00:00
type LicenseRecord struct {
Id string `json:"id"`
CreateAt int64 `json:"create_at"`
Bytes string `json:"-"`
}
type License struct {
2020-08-09 22:29:54 +00:00
Id string `json:"id"`
IssuedAt int64 `json:"issued_at"`
StartsAt int64 `json:"starts_at"`
ExpiresAt int64 `json:"expires_at"`
Customer *Customer `json:"customer"`
Features *Features `json:"features"`
SkuName string `json:"sku_name"`
SkuShortName string `json:"sku_short_name"`
IsTrial bool `json:"is_trial"`
2016-04-10 21:39:38 +00:00
}
type Customer struct {
2020-08-09 22:29:54 +00:00
Id string `json:"id"`
Name string `json:"name"`
Email string `json:"email"`
Company string `json:"company"`
}
type TrialLicenseRequest struct {
ServerID string `json:"server_id"`
Email string `json:"email"`
Name string `json:"name"`
SiteURL string `json:"site_url"`
SiteName string `json:"site_name"`
Users int `json:"users"`
TermsAccepted bool `json:"terms_accepted"`
ReceiveEmailsAccepted bool `json:"receive_emails_accepted"`
}
func (tlr *TrialLicenseRequest) ToJson() string {
b, _ := json.Marshal(tlr)
return string(b)
2016-04-10 21:39:38 +00:00
}
type Features struct {
2017-08-16 21:37:37 +00:00
Users *int `json:"users"`
LDAP *bool `json:"ldap"`
2020-08-09 22:29:54 +00:00
LDAPGroups *bool `json:"ldap_groups"`
2017-08-16 21:37:37 +00:00
MFA *bool `json:"mfa"`
GoogleOAuth *bool `json:"google_oauth"`
Office365OAuth *bool `json:"office365_oauth"`
OpenId *bool `json:"openid"`
2017-08-16 21:37:37 +00:00
Compliance *bool `json:"compliance"`
Cluster *bool `json:"cluster"`
Metrics *bool `json:"metrics"`
MHPNS *bool `json:"mhpns"`
SAML *bool `json:"saml"`
Elasticsearch *bool `json:"elastic_search"`
Announcement *bool `json:"announcement"`
2018-02-08 23:11:04 +00:00
ThemeManagement *bool `json:"theme_management"`
2017-08-16 21:37:37 +00:00
EmailNotificationContents *bool `json:"email_notification_contents"`
2018-02-08 23:11:04 +00:00
DataRetention *bool `json:"data_retention"`
MessageExport *bool `json:"message_export"`
CustomPermissionsSchemes *bool `json:"custom_permissions_schemes"`
CustomTermsOfService *bool `json:"custom_terms_of_service"`
2020-08-09 22:29:54 +00:00
GuestAccounts *bool `json:"guest_accounts"`
GuestAccountsPermissions *bool `json:"guest_accounts_permissions"`
IDLoadedPushNotifications *bool `json:"id_loaded"`
LockTeammateNameDisplay *bool `json:"lock_teammate_name_display"`
EnterprisePlugins *bool `json:"enterprise_plugins"`
2020-10-19 21:40:00 +00:00
AdvancedLogging *bool `json:"advanced_logging"`
Cloud *bool `json:"cloud"`
SharedChannels *bool `json:"shared_channels"`
RemoteClusterService *bool `json:"remote_cluster_service"`
2017-08-16 21:37:37 +00:00
2020-08-09 22:29:54 +00:00
// after we enabled more features we'll need to control them with this
2016-11-12 21:00:53 +00:00
FutureFeatures *bool `json:"future_features"`
2016-04-10 21:39:38 +00:00
}
2016-09-17 13:19:18 +00:00
func (f *Features) ToMap() map[string]interface{} {
return map[string]interface{}{
2017-08-16 21:37:37 +00:00
"ldap": *f.LDAP,
2020-08-09 22:29:54 +00:00
"ldap_groups": *f.LDAPGroups,
2017-08-16 21:37:37 +00:00
"mfa": *f.MFA,
"google": *f.GoogleOAuth,
"office365": *f.Office365OAuth,
"openid": *f.OpenId,
2017-08-16 21:37:37 +00:00
"compliance": *f.Compliance,
"cluster": *f.Cluster,
"metrics": *f.Metrics,
"mhpns": *f.MHPNS,
"saml": *f.SAML,
"elastic_search": *f.Elasticsearch,
"email_notification_contents": *f.EmailNotificationContents,
2018-02-08 23:11:04 +00:00
"data_retention": *f.DataRetention,
"message_export": *f.MessageExport,
"custom_permissions_schemes": *f.CustomPermissionsSchemes,
2020-08-09 22:29:54 +00:00
"guest_accounts": *f.GuestAccounts,
"guest_accounts_permissions": *f.GuestAccountsPermissions,
"id_loaded": *f.IDLoadedPushNotifications,
"lock_teammate_name_display": *f.LockTeammateNameDisplay,
"enterprise_plugins": *f.EnterprisePlugins,
2020-10-19 21:40:00 +00:00
"advanced_logging": *f.AdvancedLogging,
"cloud": *f.Cloud,
"shared_channels": *f.SharedChannels,
"remote_cluster_service": *f.RemoteClusterService,
2017-08-16 21:37:37 +00:00
"future": *f.FutureFeatures,
2016-09-17 13:19:18 +00:00
}
}
2016-04-10 21:39:38 +00:00
func (f *Features) SetDefaults() {
2016-04-16 18:39:43 +00:00
if f.FutureFeatures == nil {
2018-02-08 23:11:04 +00:00
f.FutureFeatures = NewBool(true)
2016-04-16 18:39:43 +00:00
}
2016-04-10 21:39:38 +00:00
if f.Users == nil {
2018-02-08 23:11:04 +00:00
f.Users = NewInt(0)
2016-04-10 21:39:38 +00:00
}
if f.LDAP == nil {
2018-02-08 23:11:04 +00:00
f.LDAP = NewBool(*f.FutureFeatures)
2016-04-10 21:39:38 +00:00
}
2020-08-09 22:29:54 +00:00
if f.LDAPGroups == nil {
f.LDAPGroups = NewBool(*f.FutureFeatures)
}
2016-05-15 21:02:30 +00:00
if f.MFA == nil {
2018-02-08 23:11:04 +00:00
f.MFA = NewBool(*f.FutureFeatures)
2016-05-15 21:02:30 +00:00
}
2016-08-15 16:47:31 +00:00
if f.GoogleOAuth == nil {
2018-02-08 23:11:04 +00:00
f.GoogleOAuth = NewBool(*f.FutureFeatures)
2016-08-15 16:47:31 +00:00
}
if f.Office365OAuth == nil {
2018-02-08 23:11:04 +00:00
f.Office365OAuth = NewBool(*f.FutureFeatures)
2016-04-10 21:39:38 +00:00
}
if f.OpenId == nil {
f.OpenId = NewBool(*f.FutureFeatures)
}
2016-05-15 21:02:30 +00:00
if f.Compliance == nil {
2018-02-08 23:11:04 +00:00
f.Compliance = NewBool(*f.FutureFeatures)
2016-05-15 21:02:30 +00:00
}
2016-08-15 16:47:31 +00:00
if f.Cluster == nil {
2018-02-08 23:11:04 +00:00
f.Cluster = NewBool(*f.FutureFeatures)
2016-08-15 16:47:31 +00:00
}
2017-01-16 22:59:50 +00:00
if f.Metrics == nil {
2018-02-08 23:11:04 +00:00
f.Metrics = NewBool(*f.FutureFeatures)
2017-01-16 22:59:50 +00:00
}
2016-04-16 18:39:43 +00:00
if f.MHPNS == nil {
2018-02-08 23:11:04 +00:00
f.MHPNS = NewBool(*f.FutureFeatures)
2016-04-10 21:39:38 +00:00
}
2016-07-22 21:14:13 +00:00
if f.SAML == nil {
2018-02-08 23:11:04 +00:00
f.SAML = NewBool(*f.FutureFeatures)
2016-07-22 21:14:13 +00:00
}
2017-08-16 21:37:37 +00:00
if f.Elasticsearch == nil {
2018-02-08 23:11:04 +00:00
f.Elasticsearch = NewBool(*f.FutureFeatures)
2017-08-16 21:37:37 +00:00
}
if f.Announcement == nil {
2018-02-08 23:11:04 +00:00
f.Announcement = NewBool(true)
}
if f.ThemeManagement == nil {
f.ThemeManagement = NewBool(true)
2017-08-16 21:37:37 +00:00
}
if f.EmailNotificationContents == nil {
2018-02-08 23:11:04 +00:00
f.EmailNotificationContents = NewBool(*f.FutureFeatures)
}
if f.DataRetention == nil {
f.DataRetention = NewBool(*f.FutureFeatures)
}
if f.MessageExport == nil {
f.MessageExport = NewBool(*f.FutureFeatures)
2017-08-16 21:37:37 +00:00
}
if f.CustomPermissionsSchemes == nil {
f.CustomPermissionsSchemes = NewBool(*f.FutureFeatures)
}
2020-08-09 22:29:54 +00:00
if f.GuestAccounts == nil {
f.GuestAccounts = NewBool(*f.FutureFeatures)
}
if f.GuestAccountsPermissions == nil {
f.GuestAccountsPermissions = NewBool(*f.FutureFeatures)
}
if f.CustomTermsOfService == nil {
f.CustomTermsOfService = NewBool(*f.FutureFeatures)
}
2020-08-09 22:29:54 +00:00
if f.IDLoadedPushNotifications == nil {
f.IDLoadedPushNotifications = NewBool(*f.FutureFeatures)
}
if f.LockTeammateNameDisplay == nil {
f.LockTeammateNameDisplay = NewBool(*f.FutureFeatures)
}
if f.EnterprisePlugins == nil {
f.EnterprisePlugins = NewBool(*f.FutureFeatures)
}
2020-10-19 21:40:00 +00:00
if f.AdvancedLogging == nil {
f.AdvancedLogging = NewBool(*f.FutureFeatures)
}
if f.Cloud == nil {
f.Cloud = NewBool(false)
}
if f.SharedChannels == nil {
f.SharedChannels = NewBool(*f.FutureFeatures)
}
if f.RemoteClusterService == nil {
f.RemoteClusterService = NewBool(*f.FutureFeatures)
}
2016-04-10 21:39:38 +00:00
}
func (l *License) IsExpired() bool {
2018-02-08 23:11:04 +00:00
return l.ExpiresAt < GetMillis()
2016-04-10 21:39:38 +00:00
}
2020-08-09 22:29:54 +00:00
func (l *License) IsPastGracePeriod() bool {
timeDiff := GetMillis() - l.ExpiresAt
return timeDiff > LICENSE_GRACE_PERIOD
}
func (l *License) IsWithinExpirationPeriod() bool {
days := l.DaysToExpiration()
return days <= SIXTY_DAYS && days >= FIFTY_EIGHT
}
func (l *License) DaysToExpiration() int {
dif := l.ExpiresAt - GetMillis()
d, _ := time.ParseDuration(fmt.Sprint(dif) + "ms")
days := d.Hours() / 24
return int(days)
}
2016-04-10 21:39:38 +00:00
func (l *License) IsStarted() bool {
2018-02-08 23:11:04 +00:00
return l.StartsAt < GetMillis()
2016-04-10 21:39:38 +00:00
}
func (l *License) ToJson() string {
b, _ := json.Marshal(l)
return string(b)
}
func (l *License) IsTrialLicense() bool {
return l.IsTrial || (l.ExpiresAt-l.StartsAt) == trialDuration.Milliseconds() || (l.ExpiresAt-l.StartsAt) == adminTrialDuration.Milliseconds()
}
func (l *License) IsSanctionedTrial() bool {
duration := l.ExpiresAt - l.StartsAt
return l.IsTrialLicense() &&
(duration >= sanctionedTrialDurationLowerBound.Milliseconds() || duration <= sanctionedTrialDurationUpperBound.Milliseconds())
}
// NewTestLicense returns a license that expires in the future and has the given features.
func NewTestLicense(features ...string) *License {
ret := &License{
ExpiresAt: GetMillis() + 90*24*60*60*1000,
Customer: &Customer{},
Features: &Features{},
2016-04-10 21:39:38 +00:00
}
ret.Features.SetDefaults()
featureMap := map[string]bool{}
for _, feature := range features {
featureMap[feature] = true
}
featureJson, _ := json.Marshal(featureMap)
json.Unmarshal(featureJson, &ret.Features)
return ret
2016-04-10 21:39:38 +00:00
}
func LicenseFromJson(data io.Reader) *License {
var o *License
json.NewDecoder(data).Decode(&o)
return o
2016-04-10 21:39:38 +00:00
}
func (lr *LicenseRecord) IsValid() *AppError {
2020-08-09 22:29:54 +00:00
if !IsValidId(lr.Id) {
2018-02-08 23:11:04 +00:00
return NewAppError("LicenseRecord.IsValid", "model.license_record.is_valid.id.app_error", nil, "", http.StatusBadRequest)
2016-04-10 21:39:38 +00:00
}
if lr.CreateAt == 0 {
2018-02-08 23:11:04 +00:00
return NewAppError("LicenseRecord.IsValid", "model.license_record.is_valid.create_at.app_error", nil, "", http.StatusBadRequest)
2016-04-10 21:39:38 +00:00
}
if lr.Bytes == "" || len(lr.Bytes) > 10000 {
2018-02-08 23:11:04 +00:00
return NewAppError("LicenseRecord.IsValid", "model.license_record.is_valid.create_at.app_error", nil, "", http.StatusBadRequest)
2016-04-10 21:39:38 +00:00
}
return nil
}
func (lr *LicenseRecord) PreSave() {
lr.CreateAt = GetMillis()
}