Add subscription entity

pkg/migration/20210209204715.go

@@ -0,0 +1,48 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2021 Vikunja and contributors. All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public Licensee as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public Licensee for more details.
+//
+// You should have received a copy of the GNU Affero General Public Licensee
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package migration
+
+import (
+	"src.techknowlogick.com/xormigrate"
+	"time"
+	"xorm.io/xorm"
+)
+
+type subscriptions20210209204715 struct {
+	ID         int64     `xorm:"autoincr not null unique pk" json:"id"`
+	EntityType int       `xorm:"not null" json:"-"`
+	EntityID   int64     `xorm:"bigint not null" json:"entity_id"`
+	UserID     int64     `xorm:"bigint not null" json:"-"`
+	Created    time.Time `xorm:"created not null" json:"created"`
+}
+
+func (subscriptions20210209204715) TableName() string {
+	return "subscriptions"
+}
+
+func init() {
+	migrations = append(migrations, &xormigrate.Migration{
+		ID:          "20210209204715",
+		Description: "",
+		Migrate: func(tx *xorm.Engine) error {
+			return tx.Sync2(subscriptions20210209204715{})
+		},
+		Rollback: func(tx *xorm.Engine) error {
+			return nil
+		},
+	})
+}

pkg/models/subscription.go

@@ -0,0 +1,67 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2021 Vikunja and contributors. All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public Licensee as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public Licensee for more details.
+//
+// You should have received a copy of the GNU Affero General Public Licensee
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package models
+
+import (
+	"code.vikunja.io/api/pkg/user"
+	"code.vikunja.io/web"
+	"time"
+	"xorm.io/xorm"
+)
+
+// SubscriptionEntityType represents all entities which can be subscribed to
+type SubscriptionEntityType int
+
+const (
+	SubscriptionEntityNamespace = iota
+	SubscriptionEntityList
+	SubscriptionEntityTask
+)
+
+// Subscription represents a subscription for an entity
+type Subscription struct {
+	// The numeric ID of the subscription
+	ID int64 `xorm:"autoincr not null unique pk" json:"id"`
+
+	EntityType SubscriptionEntityType `xorm:"not null" json:"-"`
+	Entity     string                 `xorm:"-" json:"-" param:"entity"`
+	// The id of the entity to subscribe to.
+	EntityID int64 `xorm:"bigint not null" json:"entity_id"`
+
+	// The user who made this subscription
+	User   *user.User `xorm:"-" json:"user"`
+	UserID int64      `xorm:"bigint not null" json:"-"`
+
+	// A timestamp when this subscription was created. You cannot change this value.
+	Created time.Time `xorm:"created not null" json:"created"`
+
+	web.CRUDable `xorm:"-" json:"-"`
+	web.Rights   `xorm:"-" json:"-"`
+}
+
+// TableName gives us a better tabel name for the subscriptions table
+func (sb *Subscription) TableName() string {
+	return "subscriptions"
+}
+
+func (sb *Subscription) Create(s *xorm.Session, auth web.Auth) error {
+
+}
+
+func (sb *Subscription) Delete(s *xorm.Session, auth web.Auth) error {
+
+}