Fix io.Reader implementations and wrap more errors

[rbdr/mobius] / hotline / news.go

diff --git a/hotline/news.go b/hotline/news.go
index 38db97af42dee4f11a8731e0cdb740674a01b79b..cd3b6af5d6a5b46d6c5bcd33323f461c19dcbe43 100644 (file)
--- a/hotline/news.go
+++ b/hotline/news.go
@@ -2,8 +2,9 @@ package hotline
 
 import (
        "bytes"
 
 import (
        "bytes"

-       "crypto/rand"

        "encoding/binary"
        "encoding/binary"

+       "io"
+       "slices"

        "sort"
 )
 
        "sort"
 )
 


@@ -15,20 +16,19 @@ const defaultNewsTemplate = `From %s (%s):
 
 __________________________________________________________`
 
 
 __________________________________________________________`
 

+// ThreadedNews is the top level struct containing all threaded news categories, bundles, and articles

 type ThreadedNews struct {
        Categories map[string]NewsCategoryListData15 `yaml:"Categories"`
 }
 
 type NewsCategoryListData15 struct {
 type ThreadedNews struct {
        Categories map[string]NewsCategoryListData15 `yaml:"Categories"`
 }
 
 type NewsCategoryListData15 struct {

-       Type     []byte `yaml:"Type"` // Size 2 ; Bundle (2) or category (3)
-       Count    []byte // Article or SubCategory count Size 2
-       NameSize byte
-       Name     string                            `yaml:"Name"`     //
+       Type     [2]byte                           `yaml:"Type,flow"` // Bundle (2) or category (3)
+       Name     string                            `yaml:"Name"`

        Articles map[uint32]*NewsArtData           `yaml:"Articles"` // Optional, if Type is Category
        SubCats  map[string]NewsCategoryListData15 `yaml:"SubCats"`
        Articles map[uint32]*NewsArtData           `yaml:"Articles"` // Optional, if Type is Category
        SubCats  map[string]NewsCategoryListData15 `yaml:"SubCats"`

-       GUID     []byte                            // Size 16
-       AddSN    []byte                            // Size 4
-       DeleteSN []byte                            // Size 4
+       GUID     [16]byte                          `yaml:"-"` // What does this do?  Undocumented and seeming unused.
+       AddSN    [4]byte                           `yaml:"-"` // What does this do?  Undocumented and seeming unused.
+       DeleteSN [4]byte                           `yaml:"-"` // What does this do?  Undocumented and seeming unused.

 }
 
 func (newscat *NewsCategoryListData15) GetNewsArtListData() NewsArtListData {
 }
 
 func (newscat *NewsCategoryListData15) GetNewsArtListData() NewsArtListData {


@@ -36,50 +36,51 @@ func (newscat *NewsCategoryListData15) GetNewsArtListData() NewsArtListData {
        var newsArtsPayload []byte
 
        for i, art := range newscat.Articles {
        var newsArtsPayload []byte
 
        for i, art := range newscat.Articles {

-               ID := make([]byte, 4)
-               binary.BigEndian.PutUint32(ID, i)
+               id := make([]byte, 4)
+               binary.BigEndian.PutUint32(id, i)

 
                newArt := NewsArtList{
 
                newArt := NewsArtList{

-                       ID:          ID,
+                       ID:          [4]byte(id),

                        TimeStamp:   art.Date,
                        ParentID:    art.ParentArt,
                        TimeStamp:   art.Date,
                        ParentID:    art.ParentArt,

-                       Flags:       []byte{0, 0, 0, 0},
-                       FlavorCount: []byte{0, 0},

                        Title:       []byte(art.Title),
                        Poster:      []byte(art.Poster),
                        ArticleSize: art.DataSize(),
                }
                        Title:       []byte(art.Title),
                        Poster:      []byte(art.Poster),
                        ArticleSize: art.DataSize(),
                }

+

                newsArts = append(newsArts, newArt)
        }
 
        sort.Sort(byID(newsArts))
 
        for _, v := range newsArts {
                newsArts = append(newsArts, newArt)
        }
 
        sort.Sort(byID(newsArts))
 
        for _, v := range newsArts {

-               newsArtsPayload = append(newsArtsPayload, v.Payload()...)
+               b, err := io.ReadAll(&v)
+               if err != nil {
+                       // TODO
+                       panic(err)
+               }
+               newsArtsPayload = append(newsArtsPayload, b...)

        }
 
        }
 

-       nald := NewsArtListData{
-               ID:          []byte{0, 0, 0, 0},
+       return NewsArtListData{

                Count:       len(newsArts),
                Name:        []byte{},
                Description: []byte{},
                NewsArtList: newsArtsPayload,
        }
                Count:       len(newsArts),
                Name:        []byte{},
                Description: []byte{},
                NewsArtList: newsArtsPayload,
        }

-
-       return nald

 }
 
 // NewsArtData represents single news article
 type NewsArtData struct {
 }
 
 // NewsArtData represents single news article
 type NewsArtData struct {

-       Title         string `yaml:"Title"`
-       Poster        string `yaml:"Poster"`
-       Date          []byte `yaml:"Date"`             // size 8
-       PrevArt       []byte `yaml:"PrevArt"`          // size 4
-       NextArt       []byte `yaml:"NextArt"`          // size 4
-       ParentArt     []byte `yaml:"ParentArt"`        // size 4
-       FirstChildArt []byte `yaml:"FirstChildArtArt"` // size 4
-       DataFlav      []byte `yaml:"DataFlav"`         // "text/plain"
-       Data          string `yaml:"Data"`
+       Title         string  `yaml:"Title"`
+       Poster        string  `yaml:"Poster"`
+       Date          [8]byte `yaml:"Date,flow"`
+       PrevArt       [4]byte `yaml:"PrevArt,flow"`
+       NextArt       [4]byte `yaml:"NextArt,flow"`
+       ParentArt     [4]byte `yaml:"ParentArt,flow"`
+       FirstChildArt [4]byte `yaml:"FirstChildArtArt,flow"`
+       DataFlav      []byte  `yaml:"-"` // "text/plain"
+       Data          string  `yaml:"Data"`

 }
 
 func (art *NewsArtData) DataSize() []byte {
 }
 
 func (art *NewsArtData) DataSize() []byte {


@@ -90,34 +91,45 @@ func (art *NewsArtData) DataSize() []byte {
 }
 
 type NewsArtListData struct {
 }
 
 type NewsArtListData struct {

-       ID          []byte `yaml:"ID"` // Size 4
-       Name        []byte `yaml:"Name"`
-       Description []byte `yaml:"Description"` // not used?
-       NewsArtList []byte // List of articles                  Optional (if article count > 0)
+       ID          [4]byte `yaml:"ID"`
+       Name        []byte  `yaml:"Name"`
+       Description []byte  `yaml:"Description"` // not used?
+       NewsArtList []byte  // List of articles                 Optional (if article count > 0)

        Count       int
        Count       int

+
+       readOffset int // Internal offset to track read progress

 }
 
 }
 

-func (nald *NewsArtListData) Payload() []byte {
+func (nald *NewsArtListData) Read(p []byte) (int, error) {

        count := make([]byte, 4)
        binary.BigEndian.PutUint32(count, uint32(nald.Count))
 
        count := make([]byte, 4)
        binary.BigEndian.PutUint32(count, uint32(nald.Count))
 

-       out := append(nald.ID, count...)
-       out = append(out, []byte{uint8(len(nald.Name))}...)
-       out = append(out, nald.Name...)
-       out = append(out, []byte{uint8(len(nald.Description))}...)
-       out = append(out, nald.Description...)
-       out = append(out, nald.NewsArtList...)
+       buf := slices.Concat(
+               nald.ID[:],
+               count,
+               []byte{uint8(len(nald.Name))},
+               nald.Name,
+               []byte{uint8(len(nald.Description))},
+               nald.Description,
+               nald.NewsArtList,
+       )
+
+       if nald.readOffset >= len(buf) {
+               return 0, io.EOF // All bytes have been read
+       }
+       n := copy(p, buf[nald.readOffset:])
+       nald.readOffset += n

 
 

-       return out
+       return n, nil

 }
 
 // NewsArtList is a summarized version of a NewArtData record for display in list view
 type NewsArtList struct {
 }
 
 // NewsArtList is a summarized version of a NewArtData record for display in list view
 type NewsArtList struct {

-       ID          []byte // Size 4
-       TimeStamp   []byte // Year (2 bytes), milliseconds (2 bytes) and seconds (4 bytes)
-       ParentID    []byte // Size 4
-       Flags       []byte // Size 4
-       FlavorCount []byte // Size 2
+       ID          [4]byte
+       TimeStamp   [8]byte // Year (2 bytes), milliseconds (2 bytes) and seconds (4 bytes)
+       ParentID    [4]byte
+       Flags       [4]byte
+       FlavorCount [2]byte

        // Title size   1
        Title []byte // string
        // Poster size  1
        // Title size   1
        Title []byte // string
        // Poster size  1


@@ -126,6 +138,8 @@ type NewsArtList struct {
        FlavorList []NewsFlavorList
        // Flavor list…                       Optional (if flavor count > 0)
        ArticleSize []byte // Size 2
        FlavorList []NewsFlavorList
        // Flavor list…                       Optional (if flavor count > 0)
        ArticleSize []byte // Size 2

+
+       readOffset int // Internal offset to track read progress

 }
 
 type byID []NewsArtList
 }
 
 type byID []NewsArtList


@@ -137,24 +151,38 @@ func (s byID) Swap(i, j int) {
        s[i], s[j] = s[j], s[i]
 }
 func (s byID) Less(i, j int) bool {
        s[i], s[j] = s[j], s[i]
 }
 func (s byID) Less(i, j int) bool {

-       return binary.BigEndian.Uint32(s[i].ID) < binary.BigEndian.Uint32(s[j].ID)
+       return binary.BigEndian.Uint32(s[i].ID[:]) < binary.BigEndian.Uint32(s[j].ID[:])

 }
 
 }
 

-func (nal *NewsArtList) Payload() []byte {
-       out := append(nal.ID, nal.TimeStamp...)
-       out = append(out, nal.ParentID...)
-       out = append(out, nal.Flags...)
+var (
+       NewsFlavorLen = []byte{0x0a}
+       NewsFlavor    = []byte("text/plain")
+)

 
 

-       out = append(out, []byte{0, 1}...)
+func (nal *NewsArtList) Read(p []byte) (int, error) {
+       out := slices.Concat(
+               nal.ID[:],
+               nal.TimeStamp[:],
+               nal.ParentID[:],
+               nal.Flags[:],
+               []byte{0, 1}, // Flavor Count
+               []byte{uint8(len(nal.Title))},
+               nal.Title,
+               []byte{uint8(len(nal.Poster))},
+               nal.Poster,
+               NewsFlavorLen,
+               NewsFlavor,
+               nal.ArticleSize,
+       )
+
+       if nal.readOffset >= len(out) {
+               return 0, io.EOF // All bytes have been read
+       }

 
 

-       out = append(out, []byte{uint8(len(nal.Title))}...)
-       out = append(out, nal.Title...)
-       out = append(out, []byte{uint8(len(nal.Poster))}...)
-       out = append(out, nal.Poster...)
-       out = append(out, []byte{0x0a, 0x74, 0x65, 0x78, 0x74, 0x2f, 0x70, 0x6c, 0x61, 0x69, 0x6e}...) // TODO: wat?
-       out = append(out, nal.ArticleSize...)
+       n := copy(p, out[nal.readOffset:])
+       nal.readOffset += n

 
 

-       return out
+       return n, io.EOF

 }
 
 type NewsFlavorList struct {
 }
 
 type NewsFlavorList struct {


@@ -167,19 +195,13 @@ func (newscat *NewsCategoryListData15) MarshalBinary() (data []byte, err error)
        count := make([]byte, 2)
        binary.BigEndian.PutUint16(count, uint16(len(newscat.Articles)+len(newscat.SubCats)))
 
        count := make([]byte, 2)
        binary.BigEndian.PutUint16(count, uint16(len(newscat.Articles)+len(newscat.SubCats)))
 

-       out := append(newscat.Type, count...)
+       out := append(newscat.Type[:], count...)

 
 

-       if bytes.Equal(newscat.Type, []byte{0, 3}) {
-               // Generate a random GUID // TODO: does this need to be random?
-               b := make([]byte, 16)
-               _, err := rand.Read(b)
-               if err != nil {
-                       return data, err
-               }
-
-               out = append(out, b...)                  // GUID
-               out = append(out, []byte{0, 0, 0, 1}...) // Add SN (TODO: not sure what this is)
-               out = append(out, []byte{0, 0, 0, 2}...) // Delete SN (TODO: not sure what this is)
+       // If type is category
+       if bytes.Equal(newscat.Type[:], []byte{0, 3}) {
+               out = append(out, newscat.GUID[:]...)     // GUID
+               out = append(out, newscat.AddSN[:]...)    // Add SN
+               out = append(out, newscat.DeleteSN[:]...) // Delete SN

        }
 
        out = append(out, newscat.nameLen()...)
        }
 
        out = append(out, newscat.nameLen()...)


@@ -188,26 +210,6 @@ func (newscat *NewsCategoryListData15) MarshalBinary() (data []byte, err error)
        return out, err
 }
 
        return out, err
 }
 

-// ReadNewsCategoryListData parses a byte slice into a NewsCategoryListData15 struct
-// For use on the client side
-func ReadNewsCategoryListData(payload []byte) NewsCategoryListData15 {
-       ncld := NewsCategoryListData15{
-               Type:  payload[0:2],
-               Count: payload[2:4],
-       }
-
-       if bytes.Equal(ncld.Type, []byte{0, 3}) {
-               ncld.GUID = payload[4:20]
-               ncld.AddSN = payload[20:24]
-               ncld.AddSN = payload[24:28]
-               ncld.Name = string(payload[29:])
-       } else {
-               ncld.Name = string(payload[5:])
-       }
-
-       return ncld
-}
-

 func (newscat *NewsCategoryListData15) nameLen() []byte {
        return []byte{uint8(len(newscat.Name))}
 }
 func (newscat *NewsCategoryListData15) nameLen() []byte {
        return []byte{uint8(len(newscat.Name))}
 }