core

Documentation

Index

• Variables
• func CheckUpdate(ctx infra.DnoteCtx) error
• func GetBookUUID(ctx infra.DnoteCtx, label string) (string, error)
• func GetConfigPath(ctx infra.DnoteCtx) string
• func GetDnoteTmpContentPath(ctx infra.DnoteCtx) string
• func GetEditorInput(ctx infra.DnoteCtx, fpath string, content *string) error
• func InitFiles(ctx infra.DnoteCtx) error
• func InitSystem(ctx infra.DnoteCtx) error
• func LogAction(tx *sql.Tx, schema int, actionType, data string, timestamp int64) error
• func ReadConfig(ctx infra.DnoteCtx) (infra.Config, error)
• func SanitizeContent(s string) string
• func WriteConfig(ctx infra.DnoteCtx, config infra.Config) error
• type Book
  • func NewBook(uuid, label string, usn int, deleted, dirty bool) Book
  • func (b Book) Expunge(tx *sql.Tx) error
  • func (b Book) Insert(tx *sql.Tx) error
  • func (b Book) Update(tx *sql.Tx) error
  • func (b *Book) UpdateUUID(tx *sql.Tx, newUUID string) error
• type Note
  • func NewNote(uuid, bookUUID, content string, addedOn, editedOn int64, usn int, ...) Note
  • func (n Note) Expunge(tx *sql.Tx) error
  • func (n Note) Insert(tx *sql.Tx) error
  • func (n Note) Update(tx *sql.Tx) error
  • func (n *Note) UpdateUUID(tx *sql.Tx, newUUID string) error
• type RunEFunc

Variables

var (
	// ConfigFilename is the name of the config file
	ConfigFilename = "dnoterc"
	// TmpContentFilename is the name of the temporary file that holds editor input
	TmpContentFilename = "DNOTE_TMPCONTENT"
)

Functions

func CheckUpdate

func CheckUpdate(ctx infra.DnoteCtx) error

CheckUpdate triggers update if needed

func GetBookUUID

func GetBookUUID(ctx infra.DnoteCtx, label string) (string, error)

GetBookUUID returns a uuid of a book given a label

func GetConfigPath

func GetConfigPath(ctx infra.DnoteCtx) string

GetConfigPath returns the path to the dnote config file

func GetDnoteTmpContentPath

func GetDnoteTmpContentPath(ctx infra.DnoteCtx) string

GetDnoteTmpContentPath returns the path to the temporary file containing content being added or edited

func GetEditorInput

func GetEditorInput(ctx infra.DnoteCtx, fpath string, content *string) error

GetEditorInput gets the user input by launching a text editor and waiting for it to exit

func InitFiles

func InitFiles(ctx infra.DnoteCtx) error

InitFiles creates, if necessary, the dnote directory and files inside

func InitSystem

func InitSystem(ctx infra.DnoteCtx) error

InitSystem inserts system data if missing

func LogAction

func LogAction(tx *sql.Tx, schema int, actionType, data string, timestamp int64) error

LogAction logs action and updates the last_action

func ReadConfig

func ReadConfig(ctx infra.DnoteCtx) (infra.Config, error)

ReadConfig reads the config file

func SanitizeContent

func SanitizeContent(s string) string

SanitizeContent sanitizes note content

func WriteConfig

func WriteConfig(ctx infra.DnoteCtx, config infra.Config) error

WriteConfig writes the config to the config file

Types

type Book

type Book struct {
	UUID    string `json:"uuid"`
	Label   string `json:"label"`
	USN     int    `json:"usn"`
	Notes   []Note `json:"notes"`
	Deleted bool   `json:"deleted"`
	Dirty   bool   `json:"dirty"`
}

Book holds a metadata and its notes

func NewBook

func NewBook(uuid, label string, usn int, deleted, dirty bool) Book

NewBook constructs a book with the given data

func (Book) Expunge

func (b Book) Expunge(tx *sql.Tx) error

Expunge hard-deletes the book from the database

func (Book) Insert

func (b Book) Insert(tx *sql.Tx) error

Insert inserts a new book

func (Book) Update

func (b Book) Update(tx *sql.Tx) error

Update updates the book with the given data

func (*Book) UpdateUUID

func (b *Book) UpdateUUID(tx *sql.Tx, newUUID string) error

UpdateUUID updates the uuid of a book

type Note

type Note struct {
	UUID     string `json:"uuid"`
	BookUUID string `json:"book_uuid"`
	Content  string `json:"content"`
	AddedOn  int64  `json:"added_on"`
	EditedOn int64  `json:"edited_on"`
	USN      int    `json:"usn"`
	Public   bool   `json:"public"`
	Deleted  bool   `json:"deleted"`
	Dirty    bool   `json:"dirty"`
}

Note represents a note

func NewNote

func NewNote(uuid, bookUUID, content string, addedOn, editedOn int64, usn int, public, deleted, dirty bool) Note

NewNote constructs a note with the given data

func (Note) Expunge

func (n Note) Expunge(tx *sql.Tx) error

Expunge hard-deletes the note from the database

func (Note) Insert

func (n Note) Insert(tx *sql.Tx) error

Insert inserts a new note

func (Note) Update

func (n Note) Update(tx *sql.Tx) error

Update updates the note with the given data

func (*Note) UpdateUUID

func (n *Note) UpdateUUID(tx *sql.Tx, newUUID string) error

UpdateUUID updates the uuid of a book

type RunEFunc

type RunEFunc func(*cobra.Command, []string) error

RunEFunc is a function type of dnote commands