reddit: unexpected status error codes are bubbled up

.gitignore

@@ -38,3 +38,5 @@ public/*.min.js
 models/
 
 /out
+
+/redmage

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Tigor Hutasuhut
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -12,6 +12,8 @@ export REDMAGE_WEB_DEPENDENCIES_DAYJS_VERSION=$(shell echo "$${REDMAGE_WEB_DEPEN
 export REDMAGE_WEB_DEPENDENCIES_ALPINEJS_VERSION=$(shell echo "$${REDMAGE_WEB_DEPENDENCIES_ALPINEJS_VERSION:-3.13.10}")
 export REDMAGE_RUNTIME_VERSION=$(shell echo "$${REDMAGE_RUNTIME_VERSION:-unknown}")
 
+export GCO_ENABLED=0
+
 start: dev-dependencies web-dependencies migrate-up
 	REDMAGE_RUNTIME_VERSION=$(shell git describe --tags --abbrev=0) air
 
@@ -84,7 +86,10 @@ web-build-docker:
 	npx tailwindcss --minify -i views/style.css -o public/style.css
 
 build: web-dependencies build-dependencies prepare
-	go build -o redmage
+	go build -ldflags="-s -w" -o redmage
+
+build-prod: build
+	upx -9 redmage
 
 build-docker:
 	goose up

Readme.md

@@ -0,0 +1,33 @@
+# Redmage
+
+Redmage is a Reddit Image Downloader with Scheduler, Image Filters, and GUI for management.
+Redmage is self-hosted friendly with single binary and docker image.
+
+## Features
+
+1. Image Filter by Resolution and Aspect Ratio.
+2. Device profiles for different devices.
+   Each device will have its own list of images and filters.
+3. Scheduler to download images from Subreddits at specific time.
+4. Web GUI for management.
+5. Images are stored in normal directories and can be accessed easily. Syncs well with cloud storage or Syncthing.
+
+## Installation
+
+### Binary
+
+Download from [Releases] page, select your OS and architecture, and run the binary.
+
+### Docker
+
+```bash
+docker run  -d -p 8080:8080 -v /path/to/images:/app/images -v /path/to/database:/app/db git.tigor.web.id/tigor/redmage
+```
+
+### Docker Compose
+
+See [docker-compose.yml](./docker-compose.yaml) for example.
+
+## Usage
+
+After installation, go to `localhost:8080` to access the web GUI. Add a Device Profile and subscribe to Subreddits. You can also set the Scheduler to download images at specific time.

api/download_subreddit_images.go

@@ -139,7 +139,7 @@ func (api *API) downloadSubredditImage(ctx context.Context, post reddit.Post, su
 	ctx, span := tracer.Start(ctx, "*API.downloadSubredditImage")
 	defer span.End()
 
-	imageHandler, err := api.reddit.DownloadImage(ctx, post, api.downloadBroadcast)
+	imageHandler, err := api.reddit.DownloadImage(ctx, post, api.eventBroadcast)
 	if err != nil {
 		return errs.Wrapw(err, "failed to download image")
 	}

api/events/image_download.go

@@ -44,6 +44,10 @@ type ImageDownload struct {
 	Device                string             `json:"device,omitempty"`
 }
 
+func (id ImageDownload) Clone() ImageDownload {
+	return id
+}
+
 // Render the template.
 func (im ImageDownload) Render(ctx context.Context, w io.Writer) error {
 	switch im.EventKind {

api/reddit/download_images.go

@@ -7,7 +7,9 @@ import (
 	"net/http"
 
 	"github.com/alecthomas/units"
+	"github.com/teivah/broadcast"
 	"github.com/tigorlazuardi/redmage/api/bmessage"
+	"github.com/tigorlazuardi/redmage/api/events"
 	"github.com/tigorlazuardi/redmage/pkg/errs"
 )
 
@@ -35,7 +37,7 @@ func (po *PostImage) Close() error {
 // DownloadImage downloades the image.
 //
 // If downloading image or thumbnail fails
-func (reddit *Reddit) DownloadImage(ctx context.Context, post Post, broadcaster DownloadStatusBroadcaster) (image PostImage, err error) {
+func (reddit *Reddit) DownloadImage(ctx context.Context, post Post, broadcaster *broadcast.Relay[events.Event]) (image PostImage, err error) {
 	ctx, span := tracer.Start(ctx, "*Reddit.DownloadImage")
 	defer span.End()
 	imageUrl := post.GetImageURL()
@@ -45,7 +47,7 @@ func (reddit *Reddit) DownloadImage(ctx context.Context, post Post, broadcaster
 	return image, err
 }
 
-func (reddit *Reddit) DownloadThumbnail(ctx context.Context, post Post, broadcaster DownloadStatusBroadcaster) (image PostImage, err error) {
+func (reddit *Reddit) DownloadThumbnail(ctx context.Context, post Post, broadcaster *broadcast.Relay[events.Event]) (image PostImage, err error) {
 	ctx, span := tracer.Start(ctx, "*Reddit.DownloadThumbnail")
 	defer span.End()
 	imageUrl := post.GetThumbnailURL()
@@ -55,7 +57,7 @@ func (reddit *Reddit) DownloadThumbnail(ctx context.Context, post Post, broadcas
 	return image, err
 }
 
-func (reddit *Reddit) downloadImage(ctx context.Context, post Post, kind bmessage.ImageKind, broadcaster DownloadStatusBroadcaster) (io.ReadCloser, error) {
+func (reddit *Reddit) downloadImage(ctx context.Context, post Post, kind bmessage.ImageKind, broadcaster *broadcast.Relay[events.Event]) (io.ReadCloser, error) {
 	var (
 		url    string
 		height int64
@@ -80,52 +82,53 @@ func (reddit *Reddit) downloadImage(ctx context.Context, post Post, kind bmessag
 		return nil, errs.Fail("unexpected status code when trying to download images",
 			"url", url,
 			"status_code", resp.StatusCode,
-		)
+		).Code(resp.StatusCode)
 	}
 	idleSpeedStr := reddit.Config.String("download.timeout.idlespeed")
 	metricSpeed, _ := units.ParseMetricBytes(idleSpeedStr)
 	if metricSpeed == 0 {
 		metricSpeed = 10 * units.KB
 	}
-	metadata := bmessage.ImageMetadata{
-		URL:    url,
-		Height: height,
-		Width:  width,
-		Kind:   kind,
+	eventData := events.ImageDownload{
+		ImageURL:         post.GetImageURL(),
+		ImageHeight:      int32(height),
+		ImageWidth:       int32(width),
+		Subreddit:        post.GetSubreddit(),
+		PostURL:          post.GetPostURL(),
+		PostName:         post.GetPostName(),
+		PostTitle:        post.GetPostTitle(),
+		PostCreated:      post.GetPostCreated(),
+		PostAuthor:       post.GetAuthor(),
+		PostAuthorURL:    post.GetAuthorURL(),
+		ImageOriginalURL: post.GetImageURL(),
+		NSFW:             int32(post.IsNSFWInt()),
 	}
 	idr := &ImageDownloadReader{
 		OnProgress: func(downloaded int64, contentLength int64, err error) {
-			var event bmessage.DownloadEvent
+			var kind events.ImageDownloadEvent
 			if errors.Is(err, io.EOF) {
 				err = nil
 			}
 			if err != nil {
-				event = bmessage.DownloadError
+				kind = events.ImageDownloadError
 			} else {
-				event = bmessage.DownloadProgress
+				kind = events.ImageDownloadProgress
 			}
-			broadcaster.Broadcast(bmessage.ImageDownloadMessage{
-				Event:         event,
-				Metadata:      metadata,
-				ContentLength: units.MetricBytes(resp.ContentLength),
-				Downloaded:    units.MetricBytes(downloaded),
-				Subreddit:     post.GetSubreddit(),
-				PostURL:       post.GetPermalink(),
-				PostID:        post.GetID(),
-				Error:         err,
-			})
+			ev := eventData.Clone()
+			ev.EventKind = kind
+			ev.Downloaded = downloaded
+			ev.ImageSize = contentLength
+			ev.ContentLength = contentLength
+			events.PublishImageDownloadEvent(broadcaster, ev)
 		},
 		OnClose: func(downloaded, contentLength int64, closeErr error) {
-			broadcaster.Broadcast(bmessage.ImageDownloadMessage{
-				Event:         bmessage.DownloadEnd,
-				Metadata:      metadata,
-				ContentLength: units.MetricBytes(resp.ContentLength),
-				Downloaded:    units.MetricBytes(downloaded),
-				Subreddit:     post.GetSubreddit(),
-				PostURL:       post.GetPostURL(),
-				PostID:        post.GetID(),
-				Error:         closeErr,
-			})
+			ev := eventData.Clone()
+			ev.EventKind = events.ImageDownloadEnd
+			ev.Downloaded = downloaded
+			ev.ImageSize = contentLength
+			ev.ContentLength = contentLength
+			ev.Error = closeErr
+			events.PublishImageDownloadEvent(broadcaster, ev)
 		},
 		IdleTimeout:        reddit.Config.Duration("download.timeout.idle"),
 		IdleSpeedThreshold: metricSpeed,
@@ -135,18 +138,11 @@ func (reddit *Reddit) downloadImage(ctx context.Context, post Post, kind bmessag
 	reader, writer := io.Pipe()
 	go func() {
 		defer resp.Body.Close()
-		broadcaster.Broadcast(bmessage.ImageDownloadMessage{
-			Event: bmessage.DownloadStart,
-			Metadata: bmessage.ImageMetadata{
-				URL:    url,
-				Height: height,
-				Width:  width,
-				Kind:   kind,
-			},
-			Subreddit: post.GetSubreddit(),
-			PostURL:   post.GetPostURL(),
-			PostID:    post.GetID(),
-		})
+		ev := eventData.Clone()
+		ev.EventKind = events.ImageDownloadStart
+		ev.ImageSize = resp.ContentLength
+		ev.ContentLength = resp.ContentLength
+		events.PublishImageDownloadEvent(broadcaster, ev)
 		_, err := io.Copy(writer, resp.Body)
 		_ = writer.CloseWithError(err)
 	}()

api/reddit/post.go

@@ -225,6 +225,13 @@ func (post *Post) IsNSFW() bool {
 	return post.Data.Over18
 }
 
+func (post *Post) IsNSFWInt() int {
+	if post.IsNSFW() {
+		return 1
+	}
+	return 0
+}
+
 func (post *Post) IsImagePost() bool {
 	return post.Data.PostHint == "image"
 }
@@ -375,6 +382,18 @@ func (post *Post) GetPostURL() string {
 	return fmt.Sprintf("https://reddit.com%s", post.Data.Permalink)
 }
 
+func (post *Post) GetPostName() string {
+	return post.Data.Name
+}
+
+func (post *Post) GetPostTitle() string {
+	return post.Data.Title
+}
+
+func (post *Post) GetPostCreated() int64 {
+	return int64(post.Data.Created)
+}
+
 func (post *Post) GetID() string {
 	return post.Data.ID
 }

api/reddit/reddit.go

@@ -1,6 +1,8 @@
 package reddit
 
-import "github.com/tigorlazuardi/redmage/config"
+import (
+	"github.com/tigorlazuardi/redmage/config"
+)
 
 type Reddit struct {
 	Client Client

config/default.go

@@ -18,13 +18,13 @@ var DefaultConfig = map[string]any{
 	"log.level":       "info",
 	"log.output":      "stderr",
 	"log.file.enable": true,
-	"log.file.path":   "redmage.log",
+	"log.file.path":   path.Join(xdg.CacheHome, "redmage", "redmage.log"),
 
 	"db.driver":      "sqlite3",
-	"db.string":      "data.db",
+	"db.string":      path.Join(xdg.Home, ".local", "share", "redmage", "data.db"),
 	"db.automigrate": true,
 
-	"pubsub.db.name":      "pubsub.db",
+	"pubsub.db.name":      path.Join(xdg.Home, ".local", "share", "redmage", "pubsub.db"),
 	"pubsub.db.timeout":   "5s",
 	"pubsub.ack.deadline": "30m",
 

flake.nix

@@ -20,6 +20,7 @@
           nodePackages_latest.nodejs
           goose
           air
+          upx
         ];
       };
     };