backend

Aug 13, 2023

Changes in this version

+ func LocateConfigFile(configFilename string, portable bool) (string, error)

+ func LocateDataFile(configFilename string, portable bool) (string, error)

Jun 3, 2023

Changes in this version

+ type HighlightCounts struct

+ Official int64

+ Sideloaded int64

+ Total int64

type Settings

+ UploadStoreHighlights bool

+ UploadStorePromptShown bool

+ func (s *Settings) MarkUploadStorePromptShown() error

+ func (s *Settings) SaveStoreHighlights(uploadStoreHighlights bool) error

Jan 4, 2023

Changes in this version

+ const HIGHLIGHT_REQUEST_BATCH_MAX

Dec 10, 2022

Changes in this version

+ func CloseLogFile()

+ func StartLogger()

type Backend

+ func (b *Backend) FormatSystemDetails() string

+ func (b *Backend) GetPlainSystemDetails() string

+ func (b *Backend) NavigateExplorerToLogLocation()

Oct 23, 2022

Changes in this version

+ var MaxHighlightLen = 8096

Jun 2, 2022

Changes in this version

+ var AuthEndpoint = "https://readwise.io/api/v2/auth/"

+ var BooksEndpoint = "https://readwise.io/api/v2/books?page_size=1000&category=books&source=OctoberForKobo"

+ var Conn *gorm.DB

+ var CoverEndpoint = "https://readwise.io/api/v2/books/%d"

+ var HighlightsEndpoint = "https://readwise.io/api/v2/highlights/"

+ var SourceCategory = "books"

+ var SourceType = "OctoberForKobo"

+ var UserAgent = "october/2.0.0 <https://github.com/marcus-crane/october>"

+ func ConfigureLogger()

+ func NormaliseText(s string) string

+ func OpenConnection(filepath string) error

+ type Backend struct

+ Bookmark *Bookmark

+ ConnectedKobos map[string]Kobo

+ Content *Content

+ Kobo *Kobo

+ Readwise *Readwise

+ RuntimeContext *context.Context

+ SelectedKobo Kobo

+ Settings *Settings

+ func StartBackend(ctx *context.Context) *Backend

+ func (b *Backend) DetectKobos() []Kobo

+ func (b *Backend) ForwardToReadwise() (int, error)

+ func (b *Backend) GetBookmark() *Bookmark

+ func (b *Backend) GetContent() *Content

+ func (b *Backend) GetSelectedKobo() Kobo

+ func (b *Backend) GetSettings() *Settings

+ func (b *Backend) PromptForLocalDBPath() error

+ func (b *Backend) SelectKobo(devicePath string) error

+ type BookListEntry struct

+ CoverURL string

+ ID int

+ SourceURL string

+ Title string

+ type BookListResponse struct

+ Count int

+ Results []BookListEntry

+ type Bookmark struct

+ Annotation string

+ BookmarkID string

+ ChapterProgress float64

+ ContentID string

+ ContextString string

+ Creator string

+ DateCreated string

+ DateModified string

+ EndContainerChildIndex string

+ EndContainerPath string

+ EndOffset string

+ ExtraAnnotationData string

+ Hidden string

+ Published string

+ StartContainerChild string

+ StartContainerChildIndex string

+ StartContainerPath string

+ StartOffset string

+ SyncTime string

+ Text string

+ Type string

+ UUID string

+ UserID string

+ Version string

+ VolumeID string

+ func (Bookmark) TableName() string

+ type Content struct

+ Accessibility int

+ AdobeLoanExpiration string

+ AdobeLocation string

+ AnnotationsSyncToken string

+ ApplicableSubscriptions string

+ Attribution string

+ AttributionKana string

+ AverageRating float64

+ BookID string

+ BookTitle string

+ BookmarkWordOffset int

+ BookshelfTags string

+ ChapterIDBookmarked string

+ ContentID string

+ ContentType string

+ ContentURL string

+ CrossRevisionId string

+ CurrentChapterEstimate string

+ CurrentChapterProgress float32

+ DateAdded string

+ DateCreated string

+ DateLastRead string

+ DateModified string

+ Depth int

+ Description string

+ DownloadUrl bool

+ EntitlementId string

+ EpubType string

+ ExpirationStatus int

+ ExternalId string

+ ExternalIds string

+ Fallback string

+ FavouritesIndex int

+ FeedbackType int

+ FeedbackTypeSynced bool

+ FileOffset int

+ FileSize int

+ FirstTimeReading bool

+ HideFromHomePage bool

+ ISBN string

+ ImageId string

+ ImageUrl string

+ InWishlist string

+ IsDownloaded bool

+ IsEncrypted bool

+ IsInternetArchive bool

+ IsPurchaseable bool

+ IsSocialEnabled bool

+ IsSupported bool

+ Language string

+ LastTimeFinishedReading string

+ LastTimeStartedReading string

+ MediaOverlay string

+ MimeType string

+ Monetization string

+ NumPages int

+ NumShortcovers int

+ PageProgressDirection string

+ ParagraphBookmarked int

+ PercentRead string

+ PocketStatus string

+ PreviewFileSize int

+ Properties string

+ PublicationId string

+ Publisher string

+ PublisherKana string

+ PurchaseRevisionId string

+ RatingCount string

+ ReadStateSynced bool

+ ReadStatus int

+ RedirectPreviewUrl bool

+ RenditionSpread string

+ RestOfBookEstimate string

+ ReviewsSyncDate string

+ Series string

+ SeriesID string

+ SeriesKana string

+ SeriesNumber string

+ SeriesNumberFloat float64

+ ShortCoverKey string

+ Subtitle string

+ SubtitleKana string

+ SyncTime string

+ TimeSpentReading int

+ TimesStartedReading int

+ Title string

+ TitleKana string

+ UnsyncedPocketChanges string

+ UserID string

+ VolumeIndex int

+ WishlistedDate string

+ WordCount string

+ WorkId string

+ func (Content) TableName() string

+ type CoverUpdate struct

+ Cover string

+ type Highlight struct

+ Author string

+ Category string

+ HighlightedAt string

+ Note string

+ SourceType string

+ SourceURL string

+ Text string

+ Title string

+ type Kobo struct

+ DbPath string

+ DisplayPPI int

+ MntPath string

+ Name string

+ Storage int

+ func GetKoboMetadata(detectedPaths []string) []Kobo

+ func (k *Kobo) BuildContentIndex(content []Content) map[string]Content

+ func (k *Kobo) CountDeviceBookmarks() int64

+ func (k *Kobo) FindBookOnDevice(bookID string) (Content, error)

+ func (k *Kobo) ListBookmarksByID(contentID string) ([]Bookmark, error)

+ func (k *Kobo) ListBooksOnDevice() ([]Content, error)

+ func (k *Kobo) ListDeviceBookmarks() ([]Bookmark, error)

+ func (k *Kobo) ListDeviceContent() ([]Content, error)

+ type Readwise struct

+ func (r *Readwise) CheckTokenValidity(token string) error

+ func (r *Readwise) RetrieveUploadedBooks(token string) (BookListResponse, error)

+ func (r *Readwise) SendBookmarks(payload Response, token string) (int, error)

+ func (r *Readwise) UploadCover(encodedCover string, bookId int, token string) error

+ type Response struct

+ Highlights []Highlight

+ func BuildPayload(bookmarks []Bookmark, contentIndex map[string]Content) (Response, error)

+ type Settings struct

+ ReadwiseToken string

+ UploadCovers bool

+ func LoadSettings() (*Settings, error)

+ func (s *Settings) CheckReadwiseConfig() bool

+ func (s *Settings) Save() error

+ func (s *Settings) SaveCoverUploading(uploadCovers bool) error

+ func (s *Settings) SaveToken(token string) error