2018-09-28 21:39:39 +03:00
|
|
|
package bug
|
2018-07-12 22:31:41 +03:00
|
|
|
|
|
|
|
import (
|
2020-11-08 21:15:06 +03:00
|
|
|
"crypto/rand"
|
2019-01-19 21:23:31 +03:00
|
|
|
"encoding/json"
|
2018-09-15 14:15:00 +03:00
|
|
|
"fmt"
|
|
|
|
"strings"
|
|
|
|
|
2019-08-11 15:08:03 +03:00
|
|
|
"github.com/MichaelMure/git-bug/entity"
|
2018-11-21 20:56:12 +03:00
|
|
|
"github.com/MichaelMure/git-bug/identity"
|
2020-07-01 20:39:02 +03:00
|
|
|
"github.com/MichaelMure/git-bug/repository"
|
2018-09-15 14:15:00 +03:00
|
|
|
"github.com/MichaelMure/git-bug/util/text"
|
2019-02-25 01:05:03 +03:00
|
|
|
"github.com/MichaelMure/git-bug/util/timestamp"
|
2018-07-12 22:31:41 +03:00
|
|
|
)
|
|
|
|
|
2018-09-29 21:41:19 +03:00
|
|
|
var _ Operation = &CreateOperation{}
|
2018-07-12 22:31:41 +03:00
|
|
|
|
2018-09-29 21:41:19 +03:00
|
|
|
// CreateOperation define the initial creation of a bug
|
2018-07-12 22:31:41 +03:00
|
|
|
type CreateOperation struct {
|
2018-10-01 12:37:17 +03:00
|
|
|
OpBase
|
2020-11-08 21:15:06 +03:00
|
|
|
// mandatory random bytes to ensure a better randomness of the data of the first
|
|
|
|
// operation of a bug, used to later generate the ID
|
|
|
|
// len(Nonce) should be > 20 and < 64 bytes
|
|
|
|
Nonce []byte `json:"nonce"`
|
2020-07-01 20:39:02 +03:00
|
|
|
Title string `json:"title"`
|
|
|
|
Message string `json:"message"`
|
|
|
|
Files []repository.Hash `json:"files"`
|
2018-07-12 22:31:41 +03:00
|
|
|
}
|
|
|
|
|
2020-02-03 23:03:48 +03:00
|
|
|
// Sign-post method for gqlgen
|
|
|
|
func (op *CreateOperation) IsOperation() {}
|
|
|
|
|
2018-09-29 21:41:19 +03:00
|
|
|
func (op *CreateOperation) base() *OpBase {
|
2018-10-01 12:37:17 +03:00
|
|
|
return &op.OpBase
|
2018-09-28 21:39:39 +03:00
|
|
|
}
|
|
|
|
|
2019-08-11 15:08:03 +03:00
|
|
|
func (op *CreateOperation) Id() entity.Id {
|
2019-08-07 16:31:38 +03:00
|
|
|
return idOperation(op)
|
2018-09-29 00:51:47 +03:00
|
|
|
}
|
|
|
|
|
2020-11-29 22:22:09 +03:00
|
|
|
// OVERRIDE
|
|
|
|
func (op *CreateOperation) SetMetadata(key string, value string) {
|
|
|
|
// sanity check: we make sure we are not in the following scenario:
|
|
|
|
// - the bug is created with a first operation
|
|
|
|
// - Id() is used
|
|
|
|
// - metadata are added, which will change the Id
|
|
|
|
// - Id() is used again
|
|
|
|
|
|
|
|
if op.id != entity.UnsetId {
|
|
|
|
panic("usage of Id() after changing the first operation")
|
|
|
|
}
|
|
|
|
|
|
|
|
op.OpBase.SetMetadata(key, value)
|
|
|
|
}
|
|
|
|
|
2018-09-29 21:41:19 +03:00
|
|
|
func (op *CreateOperation) Apply(snapshot *Snapshot) {
|
2019-03-31 23:32:35 +03:00
|
|
|
snapshot.addActor(op.Author)
|
|
|
|
snapshot.addParticipant(op.Author)
|
|
|
|
|
2018-07-12 22:31:41 +03:00
|
|
|
snapshot.Title = op.Title
|
2018-09-29 21:41:19 +03:00
|
|
|
|
|
|
|
comment := Comment{
|
2019-08-11 15:08:03 +03:00
|
|
|
id: op.Id(),
|
2018-09-29 21:41:19 +03:00
|
|
|
Message: op.Message,
|
|
|
|
Author: op.Author,
|
2019-02-25 01:05:03 +03:00
|
|
|
UnixTime: timestamp.Timestamp(op.UnixTime),
|
2018-07-12 22:31:41 +03:00
|
|
|
}
|
2018-09-29 21:41:19 +03:00
|
|
|
|
|
|
|
snapshot.Comments = []Comment{comment}
|
2018-08-01 03:15:40 +03:00
|
|
|
snapshot.Author = op.Author
|
2020-06-26 00:18:17 +03:00
|
|
|
snapshot.CreateTime = op.Time()
|
2018-09-29 21:41:19 +03:00
|
|
|
|
|
|
|
snapshot.Timeline = []TimelineItem{
|
2018-09-30 18:15:54 +03:00
|
|
|
&CreateTimelineItem{
|
2019-08-11 15:08:03 +03:00
|
|
|
CommentTimelineItem: NewCommentTimelineItem(op.Id(), comment),
|
2018-09-30 18:15:54 +03:00
|
|
|
},
|
2018-09-29 21:41:19 +03:00
|
|
|
}
|
2018-07-12 22:31:41 +03:00
|
|
|
}
|
2018-07-25 19:01:32 +03:00
|
|
|
|
2020-07-01 20:39:02 +03:00
|
|
|
func (op *CreateOperation) GetFiles() []repository.Hash {
|
2018-09-12 17:57:04 +03:00
|
|
|
return op.Files
|
2018-08-03 00:37:49 +03:00
|
|
|
}
|
|
|
|
|
2018-09-29 21:41:19 +03:00
|
|
|
func (op *CreateOperation) Validate() error {
|
2018-09-28 21:39:39 +03:00
|
|
|
if err := opBaseValidate(op, CreateOp); err != nil {
|
2018-09-15 14:15:00 +03:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2020-11-08 21:15:06 +03:00
|
|
|
if len(op.Nonce) > 64 {
|
|
|
|
return fmt.Errorf("create nonce is too big")
|
|
|
|
}
|
|
|
|
if len(op.Nonce) < 20 {
|
|
|
|
return fmt.Errorf("create nonce is too small")
|
|
|
|
}
|
|
|
|
|
2018-09-15 14:15:00 +03:00
|
|
|
if text.Empty(op.Title) {
|
|
|
|
return fmt.Errorf("title is empty")
|
|
|
|
}
|
|
|
|
if strings.Contains(op.Title, "\n") {
|
|
|
|
return fmt.Errorf("title should be a single line")
|
|
|
|
}
|
|
|
|
if !text.Safe(op.Title) {
|
|
|
|
return fmt.Errorf("title is not fully printable")
|
|
|
|
}
|
|
|
|
|
|
|
|
if !text.Safe(op.Message) {
|
|
|
|
return fmt.Errorf("message is not fully printable")
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2020-11-29 22:22:09 +03:00
|
|
|
// UnmarshalJSON is a two step JSON unmarshalling
|
2019-08-11 15:08:03 +03:00
|
|
|
// This workaround is necessary to avoid the inner OpBase.MarshalJSON
|
|
|
|
// overriding the outer op's MarshalJSON
|
2019-01-19 21:23:31 +03:00
|
|
|
func (op *CreateOperation) UnmarshalJSON(data []byte) error {
|
|
|
|
// Unmarshal OpBase and the op separately
|
|
|
|
|
|
|
|
base := OpBase{}
|
|
|
|
err := json.Unmarshal(data, &base)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
aux := struct {
|
2020-11-08 21:15:06 +03:00
|
|
|
Nonce []byte `json:"nonce"`
|
2020-07-01 20:39:02 +03:00
|
|
|
Title string `json:"title"`
|
|
|
|
Message string `json:"message"`
|
|
|
|
Files []repository.Hash `json:"files"`
|
2019-01-19 21:23:31 +03:00
|
|
|
}{}
|
|
|
|
|
|
|
|
err = json.Unmarshal(data, &aux)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
op.OpBase = base
|
2020-11-08 21:15:06 +03:00
|
|
|
op.Nonce = aux.Nonce
|
2019-01-19 21:23:31 +03:00
|
|
|
op.Title = aux.Title
|
|
|
|
op.Message = aux.Message
|
|
|
|
op.Files = aux.Files
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-12-23 19:11:37 +03:00
|
|
|
// Sign post method for gqlgen
|
|
|
|
func (op *CreateOperation) IsAuthored() {}
|
|
|
|
|
2020-11-08 21:15:06 +03:00
|
|
|
func makeNonce(len int) []byte {
|
|
|
|
result := make([]byte, len)
|
|
|
|
_, err := rand.Read(result)
|
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
return result
|
|
|
|
}
|
|
|
|
|
2020-07-01 20:39:02 +03:00
|
|
|
func NewCreateOp(author identity.Interface, unixTime int64, title, message string, files []repository.Hash) *CreateOperation {
|
2018-09-29 21:41:19 +03:00
|
|
|
return &CreateOperation{
|
2018-09-28 21:39:39 +03:00
|
|
|
OpBase: newOpBase(CreateOp, author, unixTime),
|
2020-11-08 21:15:06 +03:00
|
|
|
Nonce: makeNonce(20),
|
2018-07-25 22:25:26 +03:00
|
|
|
Title: title,
|
|
|
|
Message: message,
|
2018-09-12 17:57:04 +03:00
|
|
|
Files: files,
|
2018-07-25 22:25:26 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-09-30 18:15:54 +03:00
|
|
|
// CreateTimelineItem replace a Create operation in the Timeline and hold its edition history
|
|
|
|
type CreateTimelineItem struct {
|
|
|
|
CommentTimelineItem
|
|
|
|
}
|
|
|
|
|
2019-06-23 19:32:22 +03:00
|
|
|
// Sign post method for gqlgen
|
|
|
|
func (c *CreateTimelineItem) IsAuthored() {}
|
|
|
|
|
2018-07-25 22:25:26 +03:00
|
|
|
// Convenience function to apply the operation
|
2018-11-21 20:56:12 +03:00
|
|
|
func Create(author identity.Interface, unixTime int64, title, message string) (*Bug, *CreateOperation, error) {
|
2018-09-25 18:56:58 +03:00
|
|
|
return CreateWithFiles(author, unixTime, title, message, nil)
|
2018-08-03 00:37:49 +03:00
|
|
|
}
|
|
|
|
|
2020-07-01 20:39:02 +03:00
|
|
|
func CreateWithFiles(author identity.Interface, unixTime int64, title, message string, files []repository.Hash) (*Bug, *CreateOperation, error) {
|
2018-09-28 21:39:39 +03:00
|
|
|
newBug := NewBug()
|
2018-09-25 18:56:58 +03:00
|
|
|
createOp := NewCreateOp(author, unixTime, title, message, files)
|
2018-09-15 14:15:00 +03:00
|
|
|
|
|
|
|
if err := createOp.Validate(); err != nil {
|
2018-10-02 00:31:16 +03:00
|
|
|
return nil, createOp, err
|
2018-09-15 14:15:00 +03:00
|
|
|
}
|
|
|
|
|
2018-07-25 19:01:32 +03:00
|
|
|
newBug.Append(createOp)
|
|
|
|
|
2018-10-02 00:31:16 +03:00
|
|
|
return newBug, createOp, nil
|
2018-07-25 19:01:32 +03:00
|
|
|
}
|