diff --git a/.dockerignore b/.dockerignore index 8708dce..1f9515c 100644 --- a/.dockerignore +++ b/.dockerignore @@ -5,6 +5,7 @@ # Only add necessary files to the Docker build context (Dockerfiles are always included implicitly) !/build/ !/internal/ +!/pkg/ !/go.mod !/go.sum !main.go diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..bdd4fe6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,37 @@ +name: Bug report +description: Let us know if something isn't working as expected +labels: ["bug report"] +body: + - type: markdown + attributes: + value: | + > [!NOTE] + > + > Do not prefix your title with "[BUG]", "[Bug report]", etc., a label will be added automatically. + + If you're unsure whether you're experiencing a bug or not, consider using the [Discussions](https://github.com/glanceapp/glance/discussions) or [Discord](https://discord.com/invite/7KQ7Xa9kJd) to ask for help. + + Please include only the information you think is relevant to the bug: + + * How did you install Glance? (Docker container, manual binary install, etc) + * Which version of Glance are you using? + * Include the relevant parts of your `glance.yml` if applicable (widget, data source, properties used, etc) + * Include any relevant logs or screenshots if applicable + * Is the issue specific to a certain browser or OS? + * Steps to reliably reproduce the issue + * Are you hosting Glance on a VPS? + * Anything else you think might be relevant + + **No need to copy the above list into your description, it's just a guide to help you provide the most useful information.** + + - type: textarea + id: description + validations: + required: true + attributes: + label: Description + + - type: markdown + attributes: + value: | + Thank you for taking the time to submit a bug report. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e8c34af --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Discussions + url: https://github.com/glanceapp/glance/discussions + about: For help, feedback, guides, resources and more + - name: Discord + url: https://discord.com/invite/7KQ7Xa9kJd + about: Much like the discussions but more chatty diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..d8f5343 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature request +description: Share your ideas for new features or improvements +labels: ["feature request"] +body: + - type: markdown + attributes: + value: | + > [!NOTE] + > + > Do not prefix your title with "[REQUEST]", "[Feature request]", etc., a label will be added automatically. + + Please provide a detailed description of what the feature would do and what it would look like: + + * What problem would this feature solve? + * Are there any potential downsides to this feature? + * If applicable, what would the configuration for this feature look like? + * Are there any existing examples of this feature in other software? + * If applicable, include any external documentation required to implement this feature + * Anything else you think might be relevant + + **No need to copy the above list into your description, it's just a guide to help you provide the most useful information.** + + - type: textarea + id: description + validations: + required: true + attributes: + label: Description + + - type: markdown + attributes: + value: | + Thank you for taking the time to submit your idea. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 22b3d05..690586f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1 @@ - + diff --git a/.gitignore b/.gitignore index 062999d..2cd84fc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ /assets /build /playground -glance.yml +/.idea +/glance*.yml diff --git a/.goreleaser.yaml b/.goreleaser.yaml index c9c5297..7153a4f 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -50,9 +50,9 @@ dockers: dockerfile: Dockerfile.goreleaser - image_templates: - - &arm64v7_image "{{ .ProjectName }}:{{ .Tag }}-arm64v7" + - &armv7_image "{{ .ProjectName }}:{{ .Tag }}-armv7" build_flag_templates: - - --platform=linux/arm64/v7 + - --platform=linux/arm/v7 goarch: arm goarm: 7 use: buildx @@ -60,13 +60,10 @@ dockers: docker_manifests: - name_template: "{{ .ProjectName }}:{{ .Tag }}" - image_templates: + image_templates: &multiarch_images - *amd64_image - *arm64v8_image - - *arm64v7_image + - *armv7_image - name_template: "{{ .ProjectName }}:latest" skip_push: auto - image_templates: - - *amd64_image - - *arm64v8_image - - *arm64v7_image + image_templates: *multiarch_images diff --git a/Dockerfile b/Dockerfile index e4019ba..0c4cc63 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,13 +1,16 @@ -FROM golang:1.22.5-alpine3.20 AS builder +FROM golang:1.24.2-alpine3.21 AS builder WORKDIR /app COPY . /app RUN CGO_ENABLED=0 go build . -FROM alpine:3.20 +FROM alpine:3.21 WORKDIR /app COPY --from=builder /app/glance . +HEALTHCHECK --timeout=10s --start-period=60s --interval=60s \ + CMD wget --spider -q http://localhost:8080/api/healthz + EXPOSE 8080/tcp -ENTRYPOINT ["/app/glance"] +ENTRYPOINT ["/app/glance", "--config", "/app/config/glance.yml"] diff --git a/Dockerfile.goreleaser b/Dockerfile.goreleaser index dec9ac4..bbfa8ad 100644 --- a/Dockerfile.goreleaser +++ b/Dockerfile.goreleaser @@ -1,8 +1,10 @@ -FROM alpine:3.20 +FROM alpine:3.21 WORKDIR /app COPY glance . -EXPOSE 8080/tcp +HEALTHCHECK --timeout=10s --start-period=60s --interval=60s \ + CMD wget --spider -q http://localhost:8080/api/healthz -ENTRYPOINT ["/app/glance"] +EXPOSE 8080/tcp +ENTRYPOINT ["/app/glance", "--config", "/app/config/glance.yml"] diff --git a/README.md b/README.md index 25db4df..ca16c49 100644 --- a/README.md +++ b/README.md @@ -1,111 +1,436 @@

What if you could see everything at a...

Glance

-

InstallConfigurationThemes

+

InstallConfigurationDiscordSponsor

+

Community widgetsPreconfigured pagesThemes

-![example homepage](docs/images/readme-main-image.png) +![](docs/images/readme-main-image.png) -### Features -#### Various widgets +## Features +### Various widgets * RSS feeds * Subreddit posts -* Weather -* Bookmarks -* Hacker News -* Lobsters -* Latest YouTube videos from specific channels -* Clock -* Calendar -* Stocks -* iframe -* Twitch channels & top games -* GitHub releases -* Repository overview -* Site monitor -* Search box +* Hacker News posts +* Weather forecasts +* YouTube channel uploads +* Twitch channels +* Market prices +* Docker containers status +* Server stats +* Custom widgets +* [and many more...](docs/configuration.md) -#### Themeable -![multiple color schemes example](docs/images/themes-example.png) +### Fast and lightweight +* Low memory usage +* Few dependencies +* Minimal vanilla JS +* Single <20mb binary available for multiple OSs & architectures and just as small Docker container +* Uncached pages usually load within ~1s (depending on internet speed and number of widgets) -#### Optimized for mobile devices -![mobile device previews](docs/images/mobile-preview.png) +### Tons of customizability +* Different layouts +* As many pages/tabs as you need +* Numerous configuration options for each widget +* Multiple styles for some widgets +* Custom CSS -#### Fast and lightweight -* Minimal JS, no bloated frameworks -* Very few dependencies -* Single, easily distributed <15mb binary and just as small docker container -* All requests are parallelized, uncached pages usually load within ~1s (depending on internet speed and number of widgets) +### Optimized for mobile devices +Because you'll want to take it with you on the go. -### Configuration -Checkout the [configuration docs](docs/configuration.md) to learn more. A [preconfigured page](docs/configuration.md#preconfigured-page) is also available to get you started quickly. +![](docs/images/mobile-preview.png) -### Installation -> [!CAUTION] -> -> The project is under active development, expect things to break every once in a while. +### Themeable +Easily create your own theme by tweaking a few numbers or choose from one of the [already available themes](docs/themes.md). -#### Manual -Checkout the [releases page](https://github.com/glanceapp/glance/releases) for available binaries. You can place the binary inside `/opt/glance/` and have it start with your server via a [systemd service](https://linuxhandbook.com/create-systemd-services/). To specify a different path for the config file use the `--config` option: +![](docs/images/themes-example.png) + +
+ +## Configuration +Configuration is done through YAML files, to learn more about how the layout works, how to add more pages and how to configure widgets, visit the [configuration documentation](docs/configuration.md). + +
+Preview example configuration file +
+ +```yaml +pages: + - name: Home + columns: + - size: small + widgets: + - type: calendar + first-day-of-week: monday + + - type: rss + limit: 10 + collapse-after: 3 + cache: 12h + feeds: + - url: https://selfh.st/rss/ + title: selfh.st + limit: 4 + - url: https://ciechanow.ski/atom.xml + - url: https://www.joshwcomeau.com/rss.xml + title: Josh Comeau + - url: https://samwho.dev/rss.xml + - url: https://ishadeed.com/feed.xml + title: Ahmad Shadeed + + - type: twitch-channels + channels: + - theprimeagen + - j_blow + - piratesoftware + - cohhcarnage + - christitustech + - EJ_SA + + - size: full + widgets: + - type: group + widgets: + - type: hacker-news + - type: lobsters + + - type: videos + channels: + - UCXuqSBlHAE6Xw-yeJA0Tunw # Linus Tech Tips + - UCR-DXc1voovS8nhAvccRZhg # Jeff Geerling + - UCsBjURrPoezykLs9EqgamOA # Fireship + - UCBJycsmduvYEL83R_U4JriQ # Marques Brownlee + - UCHnyfMqiRRG1u-2MsSQLbXA # Veritasium + + - type: group + widgets: + - type: reddit + subreddit: technology + show-thumbnails: true + - type: reddit + subreddit: selfhosted + show-thumbnails: true + + - size: small + widgets: + - type: weather + location: London, United Kingdom + units: metric + hour-format: 12h + + - type: markets + markets: + - symbol: SPY + name: S&P 500 + - symbol: BTC-USD + name: Bitcoin + - symbol: NVDA + name: NVIDIA + - symbol: AAPL + name: Apple + - symbol: MSFT + name: Microsoft + + - type: releases + cache: 1d + repositories: + - glanceapp/glance + - go-gitea/gitea + - immich-app/immich + - syncthing/syncthing +``` +
+ +
+ +## Installation + +Choose one of the following methods: + +
+Docker compose using provided directory structure (recommended) +
+ +Create a new directory called `glance` as well as the template files within it by running: + +```bash +mkdir glance && cd glance && curl -sL https://github.com/glanceapp/docker-compose-template/archive/refs/heads/main.tar.gz | tar -xzf - --strip-components 2 +``` + +*[click here to view the files that will be created](https://github.com/glanceapp/docker-compose-template/tree/main/root)* + +Then, edit the following files as desired: +* `docker-compose.yml` to configure the port, volumes and other containery things +* `config/home.yml` to configure the widgets or layout of the home page +* `config/glance.yml` if you want to change the theme or add more pages + +
+Other files you may want to edit + +* `.env` to configure environment variables that will be available inside configuration files +* `assets/user.css` to add custom CSS +
+ +When ready, run: + +```bash +docker compose up -d +``` + +If you encounter any issues, you can check the logs by running: + +```bash +docker compose logs +``` + +
+
+ +
+Docker compose manual +
+ +Create a `docker-compose.yml` file with the following contents: + +```yaml +services: + glance: + container_name: glance + image: glanceapp/glance + restart: unless-stopped + volumes: + - ./config:/app/config + ports: + - 8080:8080 +``` + +Then, create a new directory called `config` and download the example starting [`glance.yml`](https://github.com/glanceapp/glance/blob/main/docs/glance.yml) file into it by running: + +```bash +mkdir config && wget -O config/glance.yml https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml +``` + +Feel free to edit the `glance.yml` file to your liking, and when ready run: + +```bash +docker compose up -d +``` + +If you encounter any issues, you can check the logs by running: + +```bash +docker logs glance +``` + +
+
+ +
+Manual binary installation +
+ +Precompiled binaries are available for Linux, Windows and macOS (x86, x86_64, ARM and ARM64 architectures). + +### Linux + +Visit the [latest release page](https://github.com/glanceapp/glance/releases/latest) for available binaries. You can place the binary in `/opt/glance/` and have it start with your server via a [systemd service](https://linuxhandbook.com/create-systemd-services/). By default, when running the binary, it will look for a `glance.yml` file in the directory it's placed in. To specify a different path for the config file, use the `--config` option: ```bash /opt/glance/glance --config /etc/glance.yml ``` -#### Docker -> [!IMPORTANT] -> -> Make sure you have a valid `glance.yml` file in the same directory before running the container. +To grab a starting template for the config file, run: ```bash -docker run -d -p 8080:8080 \ - -v ./glance.yml:/app/glance.yml \ - -v /etc/timezone:/etc/timezone:ro \ - -v /etc/localtime:/etc/localtime:ro \ - glanceapp/glance +wget https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml ``` -Or if you prefer docker compose: +### Windows + +Download and extract the executable from the [latest release](https://github.com/glanceapp/glance/releases/latest) (most likely the file called `glance-windows-amd64.zip` if you're on a 64-bit system) and place it in a folder of your choice. Then, create a new text file called `glance.yml` in the same folder and paste the content from [here](https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml) in it. You should then be able to run the executable and access the dashboard by visiting `http://localhost:8080` in your browser. + + + +
+
+ +
+Other +
+ +Glance can also be installed through the following 3rd party channels: +* [Proxmox VE Helper Script](https://community-scripts.github.io/ProxmoxVE/scripts?id=glance) +* [NixOS package](https://search.nixos.org/packages?channel=unstable&show=glance) +* [Coolify.io](https://coolify.io/docs/services/glance/) + +
+
+ +
+ +## Common issues +
+Requests timing out + +The most common cause of this is when using Pi-Hole, AdGuard Home or other ad-blocking DNS services, which by default have a fairly low rate limit. Depending on the number of widgets you have in a single page, this limit can very easily be exceeded. To fix this, increase the rate limit in the settings of your DNS service. + +If using Podman, in some rare cases the timeout can be caused by an unknown issue, in which case it may be resolved by adding the following to the bottom of your `docker-compose.yml` file: +```yaml +networks: + podman: + external: true +``` +
+ +
+Broken layout for markets, bookmarks or other widgets + +This is almost always caused by the browser extension Dark Reader. To fix this, disable dark mode for the domain where Glance is hosted. +
+ +
+cannot unmarshal !!map into []glance.page + +The most common cause of this is having a `pages` key in your `glance.yml` and then also having a `pages` key inside one of your included pages. To fix this, remove the `pages` key from the top of your included pages. + +
+ +
+ +## FAQ +
+Does the information on the page update automatically? +No, a page refresh is required to update the information. Some things do dynamically update where it makes sense, like the clock widget and the relative time showing how long ago something happened. +
+ +
+How frequently do widgets update? +No requests are made periodically in the background, information is only fetched upon loading the page and then cached. The default cache lifetime is different for each widget and can be configured. +
+ +
+Can I create my own widgets? + +Yes, there are multiple ways to create custom widgets: +* `iframe` widget - allows you to embed things from other websites +* `html` widget - allows you to insert your own static HTML +* `extension` widget - fetch HTML from a URL +* `custom-api` widget - fetch JSON from a URL and render it using custom HTML +
+ +
+Can I change the title of a widget? + +Yes, the title of all widgets can be changed by specifying the `title` property in the widget's configuration: ```yaml -services: - glance: - image: glanceapp/glance - volumes: - - ./glance.yml:/app/glance.yml - - /etc/timezone:/etc/timezone:ro - - /etc/localtime:/etc/localtime:ro - ports: - - 8080:8080 - restart: unless-stopped +- type: rss + title: My custom title + +- type: markets + title: My custom title + +- type: videos + title: My custom title + +# and so on for all widgets... ``` +
-### Building from source +
-Requirements: [Go](https://go.dev/dl/) >= v1.22 +## Feature requests -To build: +New feature suggestions are always welcome and will be considered, though please keep in mind that some of them may be out of scope for what the project is trying to achieve (or is reasonably capable of). If you have an idea for a new feature and would like to share it, you can do so [here](https://github.com/glanceapp/glance/issues/new?template=feature_request.yml). + +Feature requests are tagged with one of the following: + +* [Roadmap](https://github.com/glanceapp/glance/labels/roadmap) - will be implemented in a future release +* [Backlog](https://github.com/glanceapp/glance/labels/backlog) - may be implemented in the future but needs further feedback or interest from the community +* [Icebox](https://github.com/glanceapp/glance/labels/icebox) - no plans to implement as it doesn't currently align with the project's goals or capabilities, may be revised at a later date + +
+ +## Building from source + +Choose one of the following methods: + +
+Build binary with Go +
+ +Requirements: [Go](https://go.dev/dl/) >= v1.23 + +To build the project for your current OS and architecture, run: ```bash go build -o build/glance . ``` -To run: +To build for a specific OS and architecture, run: + +```bash +GOOS=linux GOARCH=amd64 go build -o build/glance . +``` + +[*click here for a full list of GOOS and GOARCH combinations*](https://go.dev/doc/install/source#:~:text=$GOOS%20and%20$GOARCH) + +Alternatively, if you just want to run the app without creating a binary, like when you're testing out changes, you can run: ```bash go run . ``` +
+
-### Building Docker image +
+Build project and Docker image with Docker +
-Build the image: +Requirements: [Docker](https://docs.docker.com/engine/install/) -**Make sure to replace "owner" with your name or organization.** +To build the project and image using just Docker, run: + +*(replace `owner` with your name or organization)* ```bash docker build -t owner/glance:latest . ``` -Push the image to your registry: +If you wish to push the image to a registry (by default Docker Hub), run: ```bash docker push owner/glance:latest ``` + +
+
+ +
+ +## Contributing guidelines + +* Before working on a new feature it's preferable to submit a feature request first and state that you'd like to implement it yourself +* Please don't submit PRs for feature requests that are either in the roadmap[1], backlog[2] or icebox[3] +* Use `dev` for the base branch if you're adding new features or fixing bugs, otherwise use `main` +* Avoid introducing new dependencies +* Avoid making backwards-incompatible configuration changes +* Avoid introducing new colors or hard-coding colors, use the standard `primary`, `positive` and `negative` +* For icons, try to use [heroicons](https://heroicons.com/) where applicable +* Provide a screenshot of the changes if UI related where possible +* No `package.json` + +
+[1] [2] [3] + +[1] The feature likely already has work put into it that may conflict with your implementation + +[2] The demand, implementation or functionality for this feature is not yet clear + +[3] No plans to add this feature for the time being + +
+ +
+ +## Thank you + +To all the people who were generous enough to [sponsor](https://github.com/sponsors/glanceapp) the project and to everyone who has contributed in any way, be it PRs, submitting issues, helping others in the discussions or Discord server, creating guides and tools or just mentioning Glance on social media. Your support is greatly appreciated and helps keep the project going. diff --git a/docs/configuration.md b/docs/configuration.md index 7d4669f..3999d8c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,10 +1,15 @@ -# Configuration +# Configuring Glance -- [Intro](#intro) - [Preconfigured page](#preconfigured-page) +- [The config file](#the-config-file) + - [Auto reload](#auto-reload) + - [Environment variables](#environment-variables) + - [Including other config files](#including-other-config-files) - [Server](#server) +- [Document](#document) +- [Branding](#branding) - [Theme](#theme) - - [Themes](#themes) + - [Available themes](#available-themes) - [Pages & Columns](#pages--columns) - [Widgets](#widgets) - [RSS](#rss) @@ -13,13 +18,20 @@ - [Lobsters](#lobsters) - [Reddit](#reddit) - [Search](#search-widget) + - [Group](#group) + - [Split Column](#split-column) + - [Custom API](#custom-api) - [Extension](#extension) - [Weather](#weather) - [Monitor](#monitor) - [Releases](#releases) + - [Docker Containers](#docker-containers) + - [DNS Stats](#dns-stats) + - [Server Stats](#server-stats) - [Repository](#repository) - [Bookmarks](#bookmarks) - [Calendar](#calendar) + - [Calendar (legacy)](#calendar-legacy) - [ChangeDetection.io](#changedetectionio) - [Clock](#clock) - [Markets](#markets) @@ -28,85 +40,114 @@ - [iframe](#iframe) - [HTML](#html) -## Intro -Configuration is done via a single YAML file and a server restart is required in order for any changes to take effect. Trying to start the server with an invalid config file will result in an error. ## Preconfigured page -If you don't want to spend time reading through all the available configuration options and just want something to get you going quickly you can use the following `glance.yml` and make changes as you see fit: +If you don't want to spend time reading through all the available configuration options and just want something to get you going quickly you can use [this `glance.yml` file](glance.yml) and make changes to it as you see fit. It will give you a page that looks like the following: + +![](images/preconfigured-page-preview.png) + +Configure the widgets, add more of them, add extra pages, etc. Make it your own! + +## The config file + +### Auto reload +Automatic config reload is supported, meaning that you can make changes to the config file and have them take effect on save without having to restart the container/service. Making changes to environment variables does not trigger a reload and requires manual restart. Deleting a config file will stop that file from being watched, even if it is recreated. + +> [!NOTE] +> +> If you attempt to start Glance with an invalid config it will exit with an error outright. If you successfully started Glance with a valid config and then made changes to it which result in an error, you'll see that error in the console and Glance will continue to run with the old configuration. You can then continue to make changes and when there are no errors the new configuration will be loaded. + +> [!CAUTION] +> +> Reloading the configuration file clears your cached data, meaning that you have to request the data anew each time you do this. This can lead to rate limiting for some APIs if you do it too frequently. Having a cache that persists between reloads will be added in the future. + +### Environment variables +Inserting environment variables is supported anywhere in the config. This is done via the `${ENV_VAR}` syntax. Attempting to use an environment variable that doesn't exist will result in an error and Glance will either not start or load your new config on save. Example: + +```yaml +server: + host: ${HOST} + port: ${PORT} +``` + +Can also be in the middle of a string: + +```yaml +- type: rss + title: ${RSS_TITLE} + feeds: + - url: http://domain.com/rss/${RSS_CATEGORY}.xml +``` + +Works with any type of value, not just strings: + +```yaml +- type: rss + limit: ${RSS_LIMIT} +``` + +If you need to use the syntax `${NAME}` in your config without it being interpreted as an environment variable, you can escape it by prefixing with a backslash `\`: + +```yaml +something: \${NOT_AN_ENV_VAR} +``` + +### Including other config files +Including config files from within your main config file is supported. This is done via the `!include` directive along with a relative or absolute path to the file you want to include. If the path is relative, it will be relative to the main config file. Additionally, environment variables can be used within included files, and changes to the included files will trigger an automatic reload. Example: + +```yaml +pages: + !include: home.yml + !include: videos.yml + !include: homelab.yml +``` + +The file you are including should not have any additional indentation, its values should be at the top level and the appropriate amount of indentation will be added automatically depending on where the file is included. Example: + +`glance.yml` ```yaml pages: - name: Home columns: - - size: small - widgets: - - type: calendar - - - type: rss - limit: 10 - collapse-after: 3 - cache: 3h - feeds: - - url: https://ciechanow.ski/atom.xml - - url: https://www.joshwcomeau.com/rss.xml - title: Josh Comeau - - url: https://samwho.dev/rss.xml - - url: https://awesomekling.github.io/feed.xml - - url: https://ishadeed.com/feed.xml - title: Ahmad Shadeed - - - type: twitch-channels - channels: - - theprimeagen - - cohhcarnage - - christitustech - - blurbs - - asmongold - - jembawls - - size: full widgets: - - type: hacker-news - - - type: videos - channels: - - UCR-DXc1voovS8nhAvccRZhg # Jeff Geerling - - UCv6J_jJa8GJqFwQNgNrMuww # ServeTheHome - - UCOk-gHyjcWZNj3Br4oxwh0A # Techno Tim - - - type: reddit - subreddit: selfhosted - - - size: small + !include: rss.yml + - name: News + columns: + - size: full widgets: - - type: weather - location: London, United Kingdom - - - type: markets - markets: - - symbol: SPY - name: S&P 500 - - symbol: BTC-USD - name: Bitcoin - - symbol: NVDA - name: NVIDIA - - symbol: AAPL - name: Apple - - symbol: MSFT - name: Microsoft - - symbol: GOOGL - name: Google - - symbol: AMD - name: AMD - - symbol: RDDT - name: Reddit + - type: group + widgets: + !include: rss.yml + - type: reddit + subreddit: news ``` -This will give you a page that looks like the following: +`rss.yml` -![](images/preconfigured-page-preview.png) +```yaml +- type: rss + title: News + feeds: + - url: ${RSS_URL} +``` -Configure the widgets, add more of them, add extra pages, etc. Make it your own! +The `!include` directive can be used anywhere in the config file, not just in the `pages` property, however it must be on its own line and have the appropriate indentation. + +If you encounter YAML parsing errors when using the `!include` directive, the reported line numbers will likely be incorrect. This is because the inclusion of files is done before the YAML is parsed, as YAML itself does not support file inclusion. To help with debugging in cases like this, you can use the `config:print` command and pipe it into `less -N` to see the full config file with includes resolved and line numbers added: + +```sh +glance --config /path/to/glance.yml config:print | less -N +``` + +This is a bit more convoluted when running Glance inside a Docker container: + +```sh +docker run --rm -v ./glance.yml:/app/config/glance.yml glanceapp/glance config:print | less -N +``` + +This assumes that the config you want to print is in your current working directory and is named `glance.yml`. ## Server Server configuration is done through a top level `server` property. Example: @@ -123,6 +164,7 @@ server: | ---- | ---- | -------- | ------- | | host | string | no | | | port | number | no | 8080 | +| base-url | string | no | | | assets-path | string | no | | #### `host` @@ -131,6 +173,13 @@ The address which the server will listen on. Setting it to `localhost` means tha #### `port` A number between 1 and 65,535, so long as that port isn't already used by anything else. +#### `base-url` +The base URL that Glance is hosted under. No need to specify this unless you're using a reverse proxy and are hosting Glance under a directory. If that's the case then you can set this value to `/glance` or whatever the directory is called. Note that the forward slash (`/`) in the beginning is required unless you specify the full domain and path. + +> [!IMPORTANT] +> You need to strip the `base-url` prefix before forwarding the request to the Glance server. +> In Caddy you can do this using [`handle_path`](https://caddyserver.com/docs/caddyfile/directives/handle_path) or [`uri strip_prefix`](https://caddyserver.com/docs/caddyfile/directives/uri). + #### `assets-path` The path to a directory that will be served by the server under the `/assets/` path. This is handy for widgets like the Monitor where you have to specify an icon URL and you want to self host all the icons rather than pointing to an external source. @@ -168,6 +217,51 @@ To be able to point to an asset from your assets path, use the `/assets/` path l icon: /assets/gitea-icon.png ``` +## Document +If you want to insert custom HTML into the `` of the document for all pages, you can do so by using the `document` property. Example: + +```yaml +document: + head: | + +``` + +## Branding +You can adjust the various parts of the branding through a top level `branding` property. Example: + +```yaml +branding: + custom-footer: | +

Powered by Glance

+ logo-url: /assets/logo.png + favicon-url: /assets/logo.png +``` + +### Properties + +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| hide-footer | bool | no | false | +| custom-footer | string | no | | +| logo-text | string | no | G | +| logo-url | string | no | | +| favicon-url | string | no | | + +#### `hide-footer` +Hides the footer when set to `true`. + +#### `custom-footer` +Specify custom HTML to use for the footer. + +#### `logo-text` +Specify custom text to use instead of the "G" found in the navigation. + +#### `logo-url` +Specify a URL to a custom image to use instead of the "G" found in the navigation. If both `logo-text` and `logo-url` are set, only `logo-url` will be used. + +#### `favicon-url` +Specify a URL to a custom image to use for the favicon. + ## Theme Theming is done through a top level `theme` property. Values for the colors are in [HSL](https://giggster.com/guide/basics/hue-saturation-lightness/) (hue, saturation, lightness) format. You can use a color picker [like this one](https://hslpicker.com/) to convert colors from other formats to HSL. The values are separated by a space and `%` is not required for any of the numbers. @@ -180,7 +274,7 @@ theme: contrast-multiplier: 1.1 ``` -### Themes +### Available themes If you don't want to spend time configuring your own theme, there are [several available themes](themes.md) which you can simply copy the values for. ### Properties @@ -234,6 +328,9 @@ theme: > .widget-type-rss a { > font-size: 1.5rem; > } +> ``` +> +> In addition, you can also use the `css-class` property which is available on every widget to set custom class names for individual widgets. ## Pages & Columns @@ -259,17 +356,41 @@ pages: ### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | -| title | string | yes | | +| name | string | yes | | | slug | string | no | | +| width | string | no | | +| center-vertically | boolean | no | false | +| hide-desktop-navigation | boolean | no | false | +| expand-mobile-page-navigation | boolean | no | false | | show-mobile-header | boolean | no | false | | columns | array | yes | | -#### `title` +#### `name` The name of the page which gets shown in the navigation bar. #### `slug` The URL friendly version of the title which is used to access the page. For example if the title of the page is "RSS Feeds" you can make the page accessible via `localhost:8080/feeds` by setting the slug to `feeds`. If not defined, it will automatically be generated from the title. +#### `width` +The maximum width of the page on desktop. Possible values are `slim` and `wide`. + +* default: `1600px` (when no value is specified) +* slim: `1100px` +* wide: `1920px` + +> [!NOTE] +> +> When using `slim`, the maximum number of columns allowed for that page is `2`. + +#### `center-vertically` +When set to `true`, vertically centers the content on the page. Has no effect if the content is taller than the height of the viewport. + +#### `hide-desktop-navigation` +Whether to show the navigation links at the top of the page on desktop. + +#### `expand-mobile-page-navigation` +Whether the mobile page navigation should be expanded by default. + #### `show-mobile-header` Whether to show a header displaying the name of the page on mobile. The header purposefully has a lot of vertical whitespace in order to push the content down and make it easier to reach on tall devices. @@ -354,7 +475,9 @@ pages: | ---- | ---- | -------- | | type | string | yes | | title | string | no | +| title-url | string | no | | cache | string | no | +| css-class | string | no | #### `type` Used to specify the widget. @@ -362,6 +485,9 @@ Used to specify the widget. #### `title` The title of the widget. If left blank it will be defined by the widget. +#### `title-url` +The URL to go to when clicking on the widget's title. If left blank it will be defined by the widget (if available). + #### `cache` How long to keep the fetched data in memory. The value is a string and must be a number followed by one of s, m, h, d. Examples: @@ -376,6 +502,9 @@ cache: 1d # 1 day > > Not all widgets can have their cache duration modified. The calendar and weather widgets update on the hour and this cannot be changed. +#### `css-class` +Set custom CSS classes for the specific widget instance. + ### RSS Display a list of articles from multiple RSS feeds. @@ -402,10 +531,31 @@ Example: | thumbnail-height | float | no | 10 | | card-height | float | no | 27 | | limit | integer | no | 25 | +| preserve-order | bool | no | false | +| single-line-titles | boolean | no | false | | collapse-after | integer | no | 5 | +##### `limit` +The maximum number of articles to show. + +##### `collapse-after` +How many articles are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse. + +##### `preserve-order` +When set to `true`, the order of the articles will be preserved as they are in the feeds. Useful if a feed uses its own sorting order which denotes the importance of the articles. If you use this property while having a lot of feeds, it's recommended to set a `limit` to each individual feed since if the first defined feed has 15 articles, the articles from the second feed will start after the 15th article in the list. + +##### `single-line-titles` +When set to `true`, truncates the title of each post if it exceeds one line. Only applies when the style is set to `vertical-list`. + ##### `style` -Used to change the appearance of the widget. Possible values are `vertical-list` and `horizontal-cards` where the former is intended to be used within a small column and the latter a full column. Below are previews of each style. +Used to change the appearance of the widget. Possible values are: + +* `vertical-list` - suitable for `full` and `small` columns +* `detailed-list` - suitable for `full` columns +* `horizontal-cards` - suitable for `full` columns +* `horizontal-cards-2` - suitable for `full` columns + +Below is a preview of each style: `vertical-list` @@ -439,16 +589,26 @@ An array of RSS/atom feeds. The title can optionally be changed. | title | string | no | the title provided by the feed | | | hide-categories | boolean | no | false | Only applicable for `detailed-list` style | | hide-description | boolean | no | false | Only applicable for `detailed-list` style | +| limit | integer | no | | | | item-link-prefix | string | no | | | +| headers | key (string) & value (string) | no | | | + +###### `limit` +The maximum number of articles to show from that specific feed. Useful if you have a feed which posts a lot of articles frequently and you want to prevent it from excessively pushing down articles from other feeds. ###### `item-link-prefix` If an RSS feed isn't returning item links with a base domain and Glance has failed to automatically detect the correct domain you can manually add a prefix to each link with this property. -##### `limit` -The maximum number of articles to show. +###### `headers` +Optionally specify the headers that will be sent with the request. Example: -##### `collapse-after` -How many articles are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse. +```yaml +- type: rss + feeds: + - url: https://domain.com/rss + headers: + User-Agent: Custom User Agent +``` ### Videos Display a list of the latest videos from specific YouTube channels. @@ -470,13 +630,18 @@ Preview: | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | channels | array | yes | | +| playlists | array | no | | | limit | integer | no | 25 | | style | string | no | horizontal-cards | +| collapse-after | integer | no | 7 | | collapse-after-rows | integer | no | 4 | +| include-shorts | boolean | no | false | | video-url-template | string | no | https://www.youtube.com/watch?v={VIDEO-ID} | ##### `channels` -A list of channel IDs. One way of getting the ID of a channel is going to the channel's page and clicking on its description: +A list of channels IDs. + +One way of getting the ID of a channel is going to the channel's page and clicking on its description: ![](images/videos-channel-description-example.png) @@ -484,14 +649,32 @@ Then scroll down and click on "Share channel", then "Copy channel ID": ![](images/videos-copy-channel-id-example.png) +##### `playlists` + +A list of playlist IDs: + +```yaml +- type: videos + playlists: + - PL8mG-RkN2uTyZZ00ObwZxxoG_nJbs3qec + - PL8mG-RkN2uTxTK4m_Vl2dYR9yE41kRdBg +``` + ##### `limit` The maximum number of videos to show. +##### `collapse-after` +Specify the number of videos to show when using the `vertical-list` style before the "SHOW MORE" button appears. + ##### `collapse-after-rows` Specify the number of rows to show when using the `grid-cards` style before the "SHOW MORE" button appears. ##### `style` -Used to change the appearance of the widget. Possible values are `horizontal-cards` and `grid-cards`. +Used to change the appearance of the widget. Possible values are `horizontal-cards`, `vertical-list` and `grid-cards`. + +Preview of `vertical-list`: + +![](images/videos-widget-vertical-list-preview.png) Preview of `grid-cards`: @@ -572,11 +755,23 @@ Preview: #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | +| instance-url | string | no | https://lobste.rs/ | +| custom-url | string | no | | | limit | integer | no | 15 | | collapse-after | integer | no | 5 | | sort-by | string | no | hot | | tags | array | no | | +##### `instance-url` +The base URL for a lobsters instance hosted somewhere other than on lobste.rs. Example: + +```yaml +instance-url: https://www.journalduhacker.net/ +``` + +##### `custom-url` +A custom URL to retrieve lobsters posts from. If this is specified, the `instance-url`, `sort-by` and `tags` properties are ignored. + ##### `limit` The maximum number of posts to show. @@ -609,10 +804,12 @@ Example: | subreddit | string | yes | | | style | string | no | vertical-list | | show-thumbnails | boolean | no | false | +| show-flairs | boolean | no | false | | limit | integer | no | 15 | | collapse-after | integer | no | 5 | | comments-url-template | string | no | https://www.reddit.com/{POST-PATH} | | request-url-template | string | no | | +| proxy | string or multiple parameters | no | | | sort-by | string | no | hot | | top-period | string | no | day | | search | string | no | | @@ -645,6 +842,9 @@ Shows or hides thumbnails next to the post. This only works if the `style` is `v > > Thumbnails don't work for some subreddits due to Reddit's API not returning the thumbnail URL. No workaround for this yet. +##### `show-flairs` +Shows post flairs when set to `true`. + ##### `limit` The maximum number of posts to show. @@ -671,7 +871,7 @@ r/selfhosted/comments/bsp01i/welcome_to_rselfhosted_please_read_this_first/ `{SUBREDDIT}` - the subreddit name ##### `request-url-template` -A custom request url that will be used to fetch the data instead. This is useful when you're hosting Glance on a VPS and Reddit is blocking the requests, and you want to route it through an HTTP proxy. +A custom request URL that will be used to fetch the data. This is useful when you're hosting Glance on a VPS where Reddit is blocking the requests and you want to route them through a proxy that accepts the URL as either a part of the path or a query parameter. Placeholders: @@ -682,6 +882,29 @@ https://proxy/{REQUEST-URL} https://your.proxy/?url={REQUEST-URL} ``` +##### `proxy` +A custom HTTP/HTTPS proxy URL that will be used to fetch the data. This is useful when you're hosting Glance on a VPS where Reddit is blocking the requests and you want to bypass the restriction by routing the requests through a proxy. Example: + +```yaml +proxy: http://user:pass@proxy.com:8080 +proxy: https://user:pass@proxy.com:443 +``` + +Alternatively, you can specify the proxy URL as well as additional options by using multiple parameters: + +```yaml +proxy: + url: http://proxy.com:8080 + allow-insecure: true + timeout: 10s +``` + +###### `allow-insecure` +When set to `true`, allows the use of insecure connections such as when the proxy has a self-signed certificate. + +###### `timeout` +The maximum time to wait for a response from the proxy. The value is a string and must be a number followed by one of s, m, h, d. Example: `10s` for 10 seconds, `1m` for 1 minute, etc + ##### `sort-by` Can be used to specify the order in which the posts should get returned. Possible values are `hot`, `new`, `top` and `rising`. @@ -723,11 +946,19 @@ Preview: | Enter | Perform search in the same tab | Search input is focused and not empty | | Ctrl + Enter | Perform search in a new tab | Search input is focused and not empty | | Escape | Leave focus | Search input is focused | +| Up | Insert the last search query since the page was opened into the input field | Search input is focused | + +> [!TIP] +> +> You can use the property `new-tab` with a value of `true` if you want to show search results in a new tab by default. Ctrl + Enter will then show results in the same tab. #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | search-engine | string | no | duckduckgo | +| new-tab | boolean | no | false | +| autofocus | boolean | no | false | +| placeholder | string | no | Type here to search… | | bangs | array | no | | ##### `search-engine` @@ -738,6 +969,15 @@ Either a value from the table below or a URL to a custom search engine. Use `{QU | duckduckgo | `https://duckduckgo.com/?q={QUERY}` | | google | `https://www.google.com/search?q={QUERY}` | +##### `new-tab` +When set to `true`, swaps the shortcuts for showing results in the same or new tab, defaulting to showing results in a new tab. + +##### `autofocus` +When set to `true`, automatically focuses the search input on page load. + +##### `placeholder` +When set, modifies the text displayed in the input field before typing. + ##### `bangs` What now? [Bangs](https://duckduckgo.com/bangs). They're shortcuts that allow you to use the same search box for many different sites. Assuming you have it configured, if for example you start your search input with `!yt` you'd be able to perform a search on YouTube: @@ -772,6 +1012,394 @@ url: https://store.steampowered.com/search/?term={QUERY} url: https://www.amazon.com/s?k={QUERY} ``` +### Group +Group multiple widgets into one using tabs. Widgets are defined using a `widgets` property exactly as you would on a page column. The only limitation is that you cannot place a group widget or a split column widget within a group widget. + +Example: + +```yaml +- type: group + widgets: + - type: reddit + subreddit: gamingnews + show-thumbnails: true + collapse-after: 6 + - type: reddit + subreddit: games + - type: reddit + subreddit: pcgaming + show-thumbnails: true +``` + +Preview: + +![](images/group-widget-preview.png) + +#### Sharing properties + +To avoid repetition you can use [YAML anchors](https://support.atlassian.com/bitbucket-cloud/docs/yaml-anchors/) and share properties between widgets. + +Example: + +```yaml +- type: group + define: &shared-properties + type: reddit + show-thumbnails: true + collapse-after: 6 + widgets: + - subreddit: gamingnews + <<: *shared-properties + - subreddit: games + <<: *shared-properties + - subreddit: pcgaming + <<: *shared-properties +``` + +### Split Column +Splits a full sized column in half, allowing you to place widgets side by side horizontally. This is converted to a single column on mobile devices or if not enough width is available. Widgets are defined using a `widgets` property exactly as you would on a page column. + +Two widgets side by side in a `full` column: + +![](images/split-column-widget-preview.png) + +
+View glance.yml +
+ +```yaml +# ... +- size: full + widgets: + - type: split-column + widgets: + - type: hacker-news + collapse-after: 3 + - type: lobsters + collapse-after: 3 + + - type: videos +# ... +``` +
+
+ +You can also achieve a number of different full page layouts using just this widget, such as: + +3 column layout where all columns have equal width: + +![](images/split-column-widget-3-columns.png) + +
+View glance.yml +
+ +```yaml +pages: + - name: Home + columns: + - size: full + widgets: + - type: split-column + max-columns: 3 + widgets: + - type: reddit + subreddit: selfhosted + collapse-after: 15 + - type: reddit + subreddit: homelab + collapse-after: 15 + - type: reddit + subreddit: sysadmin + collapse-after: 15 +``` +
+
+ +4 column layout where all columns have equal width (and the page is set to `width: wide`): + +![](images/split-column-widget-4-columns.png) + +
+View glance.yml +
+ +```yaml +pages: + - name: Home + width: wide + columns: + - size: full + widgets: + - type: split-column + max-columns: 4 + widgets: + - type: reddit + subreddit: selfhosted + collapse-after: 15 + - type: reddit + subreddit: homelab + collapse-after: 15 + - type: reddit + subreddit: linux + collapse-after: 15 + - type: reddit + subreddit: sysadmin + collapse-after: 15 +``` +
+
+ +Masonry layout with up to 5 columns where all columns have equal width (and the page is set to `width: wide`): + +![](images/split-column-widget-masonry.png) + +
+View glance.yml +
+ +```yaml +define: + - &subreddit-settings + type: reddit + collapse-after: 5 + +pages: + - name: Home + width: wide + columns: + - size: full + widgets: + - type: split-column + max-columns: 5 + widgets: + - subreddit: selfhosted + <<: *subreddit-settings + - subreddit: homelab + <<: *subreddit-settings + - subreddit: linux + <<: *subreddit-settings + - subreddit: sysadmin + <<: *subreddit-settings + - subreddit: DevOps + <<: *subreddit-settings + - subreddit: Networking + <<: *subreddit-settings + - subreddit: DataHoarding + <<: *subreddit-settings + - subreddit: OpenSource + <<: *subreddit-settings + - subreddit: Privacy + <<: *subreddit-settings + - subreddit: FreeSoftware + <<: *subreddit-settings +``` +
+
+ +Just like the `group` widget, you can insert any widget type, you can even insert a `group` widget inside of a `split-column` widget, but you can't insert a `split-column` widget inside of a `group` widget. + + +### Custom API + +Display data from a JSON API using a custom template. + +> [!NOTE] +> +> The configuration of this widget requires some basic knowledge of programming, HTML, CSS, the Go template language and Glance-specific concepts. + +Examples: + +![](images/custom-api-preview-1.png) + +
+View glance.yml +
+ +```yaml +- type: custom-api + title: Random Fact + cache: 6h + url: https://uselessfacts.jsph.pl/api/v2/facts/random + template: | +

{{ .JSON.String "text" }}

+``` +
+
+ +![](images/custom-api-preview-2.png) + +
+View glance.yml +
+ +```yaml +- type: custom-api + title: Immich stats + cache: 1d + url: https://${IMMICH_URL}/api/server/statistics + headers: + x-api-key: ${IMMICH_API_KEY} + Accept: application/json + template: | +
+
+
{{ .JSON.Int "photos" | formatNumber }}
+
PHOTOS
+
+
+
{{ .JSON.Int "videos" | formatNumber }}
+
VIDEOS
+
+
+
{{ div (.JSON.Int "usage" | toFloat) 1073741824 | toInt | formatNumber }}GB
+
USAGE
+
+
+``` +
+
+ +![](images/custom-api-preview-3.png) + +
+View glance.yml +
+ +```yaml +- type: custom-api + title: Steam Specials + cache: 12h + url: https://store.steampowered.com/api/featuredcategories?cc=us + template: | + +``` +
+ +#### Properties +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| url | string | yes | | +| headers | key (string) & value (string) | no | | +| method | string | no | GET | +| body-type | string | no | json | +| body | any | no | | +| frameless | boolean | no | false | +| allow-insecure | boolean | no | false | +| skip-json-validation | boolean | no | false | +| template | string | yes | | +| parameters | key (string) & value (string|array) | no | | +| subrequests | map of requests | no | | + +##### `url` +The URL to fetch the data from. It must be accessible from the server that Glance is running on. + +##### `headers` +Optionally specify the headers that will be sent with the request. Example: + +```yaml +headers: + x-api-key: your-api-key + Accept: application/json +``` + +##### `method` +The HTTP method to use when making the request. Possible values are `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `OPTIONS` and `HEAD`. + +##### `body-type` +The type of the body that will be sent with the request. Possible values are `json`, and `string`. + +##### `body` +The body that will be sent with the request. It can be a string or a map. Example: + +```yaml +body-type: json +body: + key1: value1 + key2: value2 + multiple-items: + - item1 + - item2 +``` + +```yaml +body-type: string +body: | + key1=value1&key2=value2 +``` + +##### `frameless` +When set to `true`, removes the border and padding around the widget. + +##### `allow-insecure` +Whether to ignore invalid/self-signed certificates. + +##### `skip-json-validation` +When set to `true`, skips the JSON validation step. This is useful when the API returns JSON Lines/newline-delimited JSON, which is a format that consists of several JSON objects separated by newlines. + +##### `template` +The template that will be used to display the data. It relies on Go's `html/template` package so it's recommended to go through [its documentation](https://pkg.go.dev/text/template) to understand how to do basic things such as conditionals, loops, etc. In addition, it also uses [tidwall's gjson](https://github.com/tidwall/gjson) package to parse the JSON data so it's worth going through its documentation if you want to use more advanced JSON selectors. You can view additional examples with explanations and function definitions [here](custom-api.md). + +##### `parameters` +A list of keys and values that will be sent to the custom-api as query paramters. + +##### `subrequests` +A map of additional requests that will be executed concurrently and then made available in the template via the `.Subrequest` property. Example: + +```yaml +- type: custom-api + cache: 2h + subrequests: + another-one: + url: https://uselessfacts.jsph.pl/api/v2/facts/random + title: Random Fact + url: https://uselessfacts.jsph.pl/api/v2/facts/random + template: | +

{{ .JSON.String "text" }}

+

{{ (.Subrequest "another-one").JSON.String "text" }}

+``` + +The subrequests support all the same properties as the main request, except for `subrequests` itself, so you can use `headers`, `parameters`, etc. + +`(.Subrequest "key")` can be a little cumbersome to write, so you can define a variable to make it easier: + +```yaml + template: | + {{ $anotherOne := .Subrequest "another-one" }} +

{{ $anotherOne.JSON.String "text" }}

+``` + +You can also access the `.Response` property of a subrequest as you would with the main request: + +```yaml + template: | + {{ $anotherOne := .Subrequest "another-one" }} +

{{ $anotherOne.Response.StatusCode }}

+``` + +> [!NOTE] +> +> Setting this property will override any query parameters that are already in the URL. + +```yaml +parameters: + param1: value1 + param2: + - item1 + - item2 +``` + ### Extension Display a widget provided by an external source (3rd party). If you want to learn more about developing extensions, checkout the [extensions documentation](extensions.md) (WIP). @@ -787,11 +1415,24 @@ Display a widget provided by an external source (3rd party). If you want to lear | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | url | string | yes | | +| fallback-content-type | string | no | | | allow-potentially-dangerous-html | boolean | no | false | +| headers | key & value | no | | | parameters | key & value | no | | ##### `url` -The URL of the extension. +The URL of the extension. **Note that the query gets stripped from this URL and the one defined by `parameters` gets used instead.** + +##### `fallback-content-type` +Optionally specify the fallback content type of the extension if the URL does not return a valid `Widget-Content-Type` header. Currently the only supported value for this property is `html`. + +##### `headers` +Optionally specify the headers that will be sent with the request. Example: + +```yaml +headers: + x-api-key: ${SECRET_KEY} +``` ##### `allow-potentially-dangerous-html` Whether to allow the extension to display HTML. @@ -901,13 +1542,21 @@ You can hover over the "ERROR" text to view more information. #### Properties -| Name | Type | Required | -| ---- | ---- | -------- | -| sites | array | yes | -| style | string | no | +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| sites | array | yes | | +| style | string | no | | +| show-failing-only | boolean | no | false | + +##### `show-failing-only` +Shows only a list of failing sites when set to `true`. ##### `style` -To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option. +Used to change the appearance of the widget. Possible values are `compact`. + +Preview of `compact`: + +![](images/monitor-widget-compact-preview.png) ##### `sites` @@ -917,9 +1566,12 @@ Properties for each site: | ---- | ---- | -------- | ------- | | title | string | yes | | | url | string | yes | | +| check-url | string | no | | +| error-url | string | no | | | icon | string | no | | | allow-insecure | boolean | no | false | | same-tab | boolean | no | false | +| alt-status-codes | array | no | | `title` @@ -927,11 +1579,19 @@ The title used to indicate the site. `url` -The URL which will be requested and its response will determine the status of the site. Optionally, you can specify this using an environment variable with the syntax `${VARIABLE_NAME}`. +The public facing URL of a monitored service, the user will be redirected here. If `check-url` is not specified, this is used as the status check. + +`check-url` + +The URL which will be requested and its response will determine the status of the site. If not specified, the `url` property is used. + +`error-url` + +If the monitored service returns an error, the user will be redirected here. If not specified, the `url` property is used. `icon` -Optional URL to an image which will be used as the icon for the site. Can be an external URL or internal via [server configured assets](#assets-path). You can also directly use [Simple Icons](https://simpleicons.org/) via a `si:` prefix: +Optional URL to an image which will be used as the icon for the site. Can be an external URL or internal via [server configured assets](#assets-path). You can also directly use [Simple Icons](https://simpleicons.org/) via a `si:` prefix or [Dashboard Icons](https://github.com/walkxcode/dashboard-icons) via a `di:` prefix: ```yaml icon: si:jellyfin @@ -941,7 +1601,7 @@ icon: si:adguard > [!WARNING] > -> Simple Icons are loaded externally and are hosted on `cdnjs.cloudflare.com`, if you do not wish to depend on a 3rd party you are free to download the icons individually and host them locally. +> Simple Icons are loaded externally and are hosted on `cdn.jsdelivr.net`, if you do not wish to depend on a 3rd party you are free to download the icons individually and host them locally. `allow-insecure` @@ -951,18 +1611,30 @@ Whether to ignore invalid/self-signed certificates. Whether to open the link in the same or a new tab. +`alt-status-codes` + +Status codes other than 200 that you want to return "OK". + +```yaml +alt-status-codes: + - 403 +``` + ### Releases -Display a list of releases for specific repositories on Github. Draft releases and prereleases will not be shown. +Display a list of latest releases for specific repositories on Github, GitLab, Codeberg or Docker Hub. Example: ```yaml - type: releases + show-source-icon: true repositories: - - immich-app/immich - go-gitea/gitea - - dani-garcia/vaultwarden - jellyfin/jellyfin + - glanceapp/glance + - codeberg:redict/redict + - gitlab:fdroid/fdroidclient + - dockerhub:gotify/server ``` Preview: @@ -974,12 +1646,53 @@ Preview: | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | repositories | array | yes | | +| show-source-icon | boolean | no | false | | | token | string | no | | +| gitlab-token | string | no | | | limit | integer | no | 10 | | collapse-after | integer | no | 5 | ##### `repositories` -A list of repositores for which to fetch the latest release for. Only the name/repo is required, not the full URL. +A list of repositores to fetch the latest release for. Only the name/repo is required, not the full URL. A prefix can be specified for repositories hosted elsewhere such as GitLab, Codeberg and Docker Hub. Example: + +```yaml +repositories: + - gitlab:inkscape/inkscape + - dockerhub:glanceapp/glance + - codeberg:redict/redict +``` + +Official images on Docker Hub can be specified by omitting the owner: + +```yaml +repositories: + - dockerhub:nginx + - dockerhub:node + - dockerhub:alpine +``` + +You can also specify exact tags for Docker Hub images: + +```yaml +repositories: + - dockerhub:nginx:latest + - dockerhub:nginx:stable-alpine +``` + +To include prereleases you can specify the repository as an object and use the `include-prereleases` property: + +**Note: This feature is currently only available for GitHub repositories.** + +```yaml +repositories: + - gitlab:inkscape/inkscape + - repository: glanceapp/glance + include-prereleases: true + - codeberg:redict/redict +``` + +##### `show-source-icon` +Shows an icon of the source (GitHub/GitLab/Codeberg/Docker Hub) next to the repository name when set to `true`. ##### `token` Without authentication Github allows for up to 60 requests per hour. You can easily exceed this limit and start seeing errors if you're tracking lots of repositories or your cache time is low. To circumvent this you can [create a read only token from your Github account](https://github.com/settings/personal-access-tokens/new) and provide it here. @@ -991,7 +1704,7 @@ services: glance: image: glanceapp/glance environment: - - GITHUB_TOKEN: + - GITHUB_TOKEN= ``` and then use it in your `glance.yml` like this: @@ -1004,12 +1717,303 @@ and then use it in your `glance.yml` like this: This way you can safely check your `glance.yml` in version control without exposing the token. +##### `gitlab-token` +Same as the above but used when fetching GitLab releases. + ##### `limit` The maximum number of releases to show. #### `collapse-after` How many releases are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse. +### Docker Containers + +Display the status of your Docker containers along with an icon and an optional short description. + +![](images/docker-containers-preview.png) + +```yaml +- type: docker-containers + hide-by-default: false +``` + +> [!NOTE] +> +> The widget requires access to `docker.sock`. If you're running Glance inside a container, this can be done by mounting the socket as a volume: +> +> ```yaml +> services: +> glance: +> image: glanceapp/glance +> volumes: +> - /var/run/docker.sock:/var/run/docker.sock +> ``` + +Configuration of the containers is done via labels applied to each container: + +```yaml + jellyfin: + image: jellyfin/jellyfin:latest + labels: + glance.name: Jellyfin + glance.icon: si:jellyfin + glance.url: https://jellyfin.domain.com + glance.description: Movies & shows +``` + +For services with multiple containers you can specify a `glance.id` on the "main" container and `glance.parent` on each "child" container: + +
+View docker-compose.yml +
+ +```yaml +services: + immich-server: + image: ghcr.io/immich-app/immich-server + labels: + glance.name: Immich + glance.icon: si:immich + glance.url: https://immich.domain.com + glance.description: Image & video management + glance.id: immich + + redis: + image: docker.io/redis:6.2-alpine + labels: + glance.parent: immich + glance.name: Redis + + database: + image: docker.io/tensorchord/pgvecto-rs:pg14-v0.2.0 + labels: + glance.parent: immich + glance.name: DB + + proxy: + image: nginx:stable + labels: + glance.parent: immich + glance.name: Proxy +``` +
+
+ +This will place all child containers under the `Immich` container when hovering over its icon: + +![](images/docker-container-parent.png) + +If any of the child containers are down, their status will propagate up to the parent container: + +![](images/docker-container-parent2.png) + +#### Properties + +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| hide-by-default | boolean | no | false | +| sock-path | string | no | /var/run/docker.sock | + +##### `hide-by-default` +Whether to hide the containers by default. If set to `true` you'll have to manually add a `glance.hide: false` label to each container you want to display. By default all containers will be shown and if you want to hide a specific container you can add a `glance.hide: true` label. + +##### `sock-path` +The path to the Docker socket. + +#### Labels +| Name | Description | +| ---- | ----------- | +| glance.name | The name displayed in the UI. If not specified, the name of the container will be used. | +| glance.icon | The icon displayed in the UI. Can be an external URL or an icon prefixed with si:, sh: or di: like with the bookmarks and monitor widgets | +| glance.url | The URL that the user will be redirected to when clicking on the container. | +| glance.same-tab | Whether to open the link in the same or a new tab. Default is `false`. | +| glance.description | A short description displayed in the UI. Default is empty. | +| glance.hide | Whether to hide the container. If set to `true` the container will not be displayed. Defaults to `false`. | +| glance.id | The custom ID of the container. Used to group containers under a single parent. | +| glance.parent | The ID of the parent container. Used to group containers under a single parent. | + +### DNS Stats +Display statistics from a self-hosted ad-blocking DNS resolver such as AdGuard Home or Pi-hole. + +Example: + +```yaml +- type: dns-stats + service: adguard + url: https://adguard.domain.com/ + username: admin + password: ${ADGUARD_PASSWORD} +``` + +Preview: + +![](images/dns-stats-widget-preview.png) + +> [!NOTE] +> +> When using AdGuard Home the 3rd statistic on top will be the average latency and when using Pi-hole it will be the total number of blocked domains from all adlists. + +#### Properties + +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| service | string | no | pihole | +| allow-insecure | bool | no | false | +| url | string | yes | | +| username | string | when service is `adguard` | | +| password | string | when service is `adguard` or `pihole-v6` | | +| token | string | when service is `pihole` | | +| hide-graph | bool | no | false | +| hide-top-domains | bool | no | false | +| hour-format | string | no | 12h | + +##### `service` +Either `adguard`, or `pihole` (major version 5 and below) or `pihole-v6` (major version 6 and above). + +##### `allow-insecure` +Whether to allow invalid/self-signed certificates when making the request to the service. + +##### `url` +The base URL of the service. + +##### `username` +Only required when using AdGuard Home. The username used to log into the admin dashboard. + +##### `password` +Required when using AdGuard Home, where the password is the one used to log into the admin dashboard. + +Also requried when using Pi-hole major version 6 and above, where the password is the one used to log into the admin dashboard or the application password, which can be found in `Settings -> Web Interface / API -> Configure app password`. + +##### `token` +Only required when using Pi-hole major version 5 or earlier. The API token which can be found in `Settings -> API -> Show API token`. + +##### `hide-graph` +Whether to hide the graph showing the number of queries over time. + +##### `hide-top-domains` +Whether to hide the list of top blocked domains. + +##### `hour-format` +Whether to display the relative time in the graph in `12h` or `24h` format. + +### Server Stats +Display statistics such as CPU usage, memory usage and disk usage of the server Glance is running on or other servers. + +Example: + +```yaml +- type: server-stats + servers: + - type: local + name: Services +``` + +Preview: + +![](images/server-stats-preview.gif) + +> [!NOTE] +> +> This widget is currently under development, some features might not function as expected or may change. + +To display data from a remote server you need to have the Glance Agent running on that server. You can download the agent from [here](https://github.com/glanceapp/agent), though keep in mind that it is still in development and may not work as expected. Support for other providers such as Glances will be added in the future. + +In the event that the CPU temperature goes over 80°C, a flame icon will appear next to the CPU. The progress indicators will also turn red (or the equivalent of your negative color) to hopefully grab your attention if anything is unusually high: + +![](images/server-stats-flame-icon.png) + +#### Properties +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| servers | array | no | | + +##### `servers` +If not provided it will display the statistics of the server Glance is running on. + +##### Properties for both `local` and `remote` servers +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| type | string | yes | | +| name | string | no | | +| hide-swap | boolean | no | false | + +###### `type` +Whether to display statistics for the local server or a remote server. Possible values are `local` and `remote`. + +###### `name` +The name of the server which will be displayed on the widget. If not provided it will default to the server's hostname. + +###### `hide-swap` +Whether to hide the swap usage. + +##### Properties for the `local` server +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| cpu-temp-sensor | string | no | | +| hide-mountpoints-by-default | boolean | no | false | +| mountpoints | map\[string\]object | no | | + +###### `cpu-temp-sensor` +The name of the sensor to use for the CPU temperature. When not provided the widget will attempt to find the correct one, if it fails to do so the temperature will not be displayed. To view the available sensors you can use `sensors` command. + +###### `hide-mountpoints-by-default` +If set to `true` you'll have to manually make each mountpoint visible by adding a `hide: false` property to it like so: + +```yaml +- type: server-stats + servers: + - type: local + hide-mountpoints-by-default: true + mountpoints: + "/": + hide: false + "/mnt/data": + hide: false +``` + +This is useful if you're running Glance inside of a container which usually mounts a lot of irrelevant filesystems. + +###### `mountpoints` +A map of mountpoints to display disk usage for. The key is the path to the mountpoint and the value is an object with optional properties. Example: + +```yaml +mountpoints: + "/": + name: Root + "/mnt/data": + name: Data + "/boot/efi": + hide: true +``` + +##### Properties for each `mountpoint` +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| name | string | no | | +| hide | boolean | no | false | + +###### `name` +The name of the mountpoint which will be displayed on the widget. If not provided it will default to the mountpoint's path. + +###### `hide` +Whether to hide this mountpoint from the widget. + +##### Properties for `remote` servers +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| url | string | yes | | +| token | string | no | | +| timeout | string | no | 3s | + +###### `url` +The URL and port of the server to fetch the statistics from. + +###### `token` +The authentication token to use when fetching the statistics. + +###### `timeout` +The maximum time to wait for a response from the server. The value is a string and must be a number followed by one of s, m, h, d. Example: `10s` for 10 seconds, `1m` for 1 minute, etc + ### Repository Display general information about a repository as well as a list of the latest open pull requests and issues. @@ -1020,6 +2024,7 @@ Example: repository: glanceapp/glance pull-requests-limit: 5 issues-limit: 3 + commits-limit: 3 ``` Preview: @@ -1034,6 +2039,7 @@ Preview: | token | string | no | | | pull-requests-limit | integer | no | 3 | | issues-limit | integer | no | 3 | +| commits-limit | integer | no | -1 | ##### `repository` The owner and repository name that will have their information displayed. @@ -1047,6 +2053,9 @@ The maximum number of latest open pull requests to show. Set to `-1` to not show ##### `issues-limit` The maximum number of latest open issues to show. Set to `-1` to not show any. +##### `commits-limit` +The maximum number of lastest commits to show from the default branch. Set to `-1` to not show any. + ### Bookmarks Display a list of links which can be grouped. @@ -1096,20 +2105,23 @@ Preview: | Name | Type | Required | | ---- | ---- | -------- | | groups | array | yes | -| style | string | no | ##### `groups` An array of groups which can optionally have a title and a custom color. -##### `style` -To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option. - ###### Properties for each group | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | title | string | no | | | color | HSL | no | the primary color of the theme | | links | array | yes | | +| same-tab | boolean | no | false | +| hide-arrow | boolean | no | false | +| target | string | no | | + +> [!TIP] +> +> You can set `same-tab`, `hide-arrow` and `target` either on the group which will apply them to all links in that group, or on each individual link which will override the value set on the group. ###### Properties for each link | Name | Type | Required | Default | @@ -1119,10 +2131,11 @@ To make the widget scale appropriately in a `full` size column, set the style to | icon | string | no | | | same-tab | boolean | no | false | | hide-arrow | boolean | no | false | +| target | string | no | | `icon` -URL pointing to an image. You can also directly use [Simple Icons](https://simpleicons.org/) via a `si:` prefix: +URL pointing to an image. You can also directly use [Simple Icons](https://simpleicons.org/) via a `si:` prefix or [Dashboard Icons](https://github.com/walkxcode/dashboard-icons) via a `di:` prefix: ```yaml icon: si:gmail @@ -1132,7 +2145,7 @@ icon: si:reddit > [!WARNING] > -> Simple Icons are loaded externally and are hosted on `cdnjs.cloudflare.com`, if you do not wish to depend on a 3rd party you are free to download the icons individually and host them locally. +> Simple Icons are loaded externally and are hosted on `cdn.jsdelivr.net`, if you do not wish to depend on a 3rd party you are free to download the icons individually and host them locally. `same-tab` @@ -1142,6 +2155,10 @@ Whether to open the link in the same tab or a new one. Whether to hide the colored arrow on each link. +`target` + +Set a custom value for the link's `target` attribute. Possible values are `_blank`, `_self`, `_parent` and `_top`, you can read more about what they do [here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target). This property has precedence over `same-tab`. + ### ChangeDetection.io Display a list watches from changedetection.io. @@ -1241,15 +2258,52 @@ Example: ```yaml - type: calendar + first-day-of-week: monday ``` Preview: ![](images/calendar-widget-preview.png) +#### Properties + +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| first-day-of-week | string | no | monday | + +##### `first-day-of-week` +The day of the week that the calendar starts on. All week days are available as possible values. + +### Calendar (legacy) +Display a calendar. + +Example: + +```yaml +- type: calendar-legacy + start-sunday: false +``` + +Preview: + +![](images/calendar-legacy-widget-preview.png) + > [!NOTE] > -> There is currently no customizability available for the calendar. Extra features will be added in the future. +> This widget is deprecated and may be removed in a future version. + +#### Properties + +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| start-sunday | boolean | no | false | + +##### `start-sunday` +Whether calendar weeks start on Sunday or Monday. + +> [!NOTE] +> +> There is currently little customizability available for the calendar. Extra features will be added in the future. ### Markets Display a list of markets, their current value, change for the day and a small 21d chart. Data is taken from Yahoo Finance. @@ -1281,18 +2335,30 @@ Preview: | ---- | ---- | -------- | | markets | array | yes | | sort-by | string | no | -| style | string | no | +| chart-link-template | string | no | +| symbol-link-template | string | no | ##### `markets` An array of markets for which to display information about. ##### `sort-by` -By default the markets are displayed in the order they were defined. You can customize their ordering by setting the `sort-by` property to `absolute-change` for descending order based on the stock's absolute price change. +By default the markets are displayed in the order they were defined. You can customize their ordering by setting the `sort-by` property to `change` for descending order based on the stock's percentage change (e.g. 1% would be sorted higher than -1%) or `absolute-change` for descending order based on the stock's absolute price change (e.g. -1% would be sorted higher than +0.5%). -##### `style` -To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option. +##### `chart-link-template` +A template for the link to go to when clicking on the chart that will be applied to all markets. The value `{SYMBOL}` will be replaced with the symbol of the market. You can override this on a per-market basis by specifying a `chart-link` property. Example: -###### Properties for each stock +```yaml +chart-link-template: https://www.tradingview.com/chart/?symbol={SYMBOL} +``` + +##### `symbol-link-template` +A template for the link to go to when clicking on the symbol that will be applied to all markets. The value `{SYMBOL}` will be replaced with the symbol of the market. You can override this on a per-market basis by specifying a `symbol-link` property. Example: + +```yaml +symbol-link-template: https://www.google.com/search?tbm=nws&q={SYMBOL} +``` + +###### Properties for each market | Name | Type | Required | | ---- | ---- | -------- | | symbol | string | yes | @@ -1309,9 +2375,11 @@ The symbol, as seen in Yahoo Finance. The name that will be displayed under the symbol. `symbol-link` + The link to go to when clicking on the symbol. `chart-link` + The link to go to when clicking on the chart. ### Twitch Channels diff --git a/docs/custom-api.md b/docs/custom-api.md new file mode 100644 index 0000000..d42d1fc --- /dev/null +++ b/docs/custom-api.md @@ -0,0 +1,415 @@ +[Jump to function definitions](#functions) + +## Examples + +The best way to get an idea of how the templates work would be with a bunch examples. Here are the most common use cases: + +JSON response: + +```json +{ + "title": "My Title", + "content": "My Content", +} +``` + +To access the two fields in the JSON response, you would use the following: + +```html +
{{ .JSON.String "title" }}
+
{{ .JSON.String "content" }}
+``` + +Output: + +```html +
My Title
+
My Content
+``` + +
+ +JSON response: + +```json +{ + "author": "John Doe", + "posts": [ + { + "title": "My Title", + "content": "My Content" + }, + { + "title": "My Title 2", + "content": "My Content 2" + } + ] +} +``` + +To loop through the array of posts, you would use the following: + +```html +{{ range .JSON.Array "posts" }} +
{{ .String "title" }}
+
{{ .String "content" }}
+{{ end }} +``` + +Output: + +```html +
My Title
+
My Content
+
My Title 2
+
My Content 2
+``` + +Notice the missing `.JSON` when accessing the title and content, this is because the range function sets the context to the current array element. + +If you want to access the top-level context within the range, you can use the following: + +```html +{{ range .JSON.Array "posts" }} +
{{ .String "title" }}
+
{{ .String "content" }}
+
{{ $.JSON.String "author" }}
+{{ end }} +``` + +Output: + +```html +
My Title
+
My Content
+
John Doe
+
My Title 2
+
My Content 2
+
John Doe
+``` + +
+ +JSON response: + +```json +[ + "Apple", + "Banana", + "Cherry", + "Watermelon" +] +``` + +Somewhat awkwardly, when the current context is a basic type that isn't an object, the way you specify its type is to use an empty string as the key. So, to loop through the array of strings, you would use the following: + +```html +{{ range .JSON.Array "" }} +
{{ .String "" }}
+{{ end }} +``` + +Output: + +```html +
Apple
+
Banana
+
Cherry
+
Watermelon
+``` + +To access an item at a specific index, you could use the following: + +```html +
{{ .JSON.String "0" }}
+``` + +Output: + +```html +
Apple
+``` + +
+ +JSON response: + +```json +{ + "user": { + "address": { + "city": "New York", + "state": "NY" + } + } +} +``` + +To easily access deeply nested objects, you can use the following dot notation: + +```html +
{{ .JSON.String "user.address.city" }}
+
{{ .JSON.String "user.address.state" }}
+``` + +Output: + +```html +
New York
+
NY
+``` + +Using indexes anywhere in the path is also supported: + +```json +{ + "users": [ + { + "name": "John Doe" + }, + { + "name": "Jane Doe" + } + ] +} +``` + +```html +
{{ .JSON.String "users.0.name" }}
+
{{ .JSON.String "users.1.name" }}
+``` + +Output: + +```html +
John Doe
+
Jane Doe
+``` + +
+ +JSON response: + +```json +{ + "user": { + "name": "John Doe", + "age": 30 + } +} +``` + +To check if a field exists, you can use the following: + +```html +{{ if .JSON.Exists "user.age" }} +
{{ .JSON.Int "user.age" }}
+{{ else }} +
Age not provided
+{{ end }} +``` + +Output: + +```html +
30
+``` + +
+ +JSON response: + +```json +{ + "price": 100, + "discount": 10 +} +``` + +Calculations can be performed on either ints or floats. If both numbers are ints, an int will be returned, otherwise a float will be returned. If you try to divide by zero, 0 will be returned. If you provide non-numeric values, `NaN` will be returned. + +```html +
{{ sub (.JSON.Int "price") (.JSON.Int "discount") }}
+``` + +Output: + +```html +
90
+``` + +Other operations include `add`, `mul`, and `div`. + +
+ +JSON response: + +```json +{ + "posts": [ + { + "title": "Exploring the Depths of Quantum Computing", + "date": "2023-10-27T10:00:00Z" + }, + { + "title": "A Beginner's Guide to Sustainable Living", + "date": "2023-11-15T14:30:00+01:00" + }, + { + "title": "The Art of Baking Sourdough Bread", + "date": "2023-12-03T08:45:22-08:00" + } + ] +} +``` + +To parse the date and display the relative time (e.g. 2h, 1d, etc), you would use the following: + +``` +{{ range .JSON.Array "posts" }} +
{{ .String "title" }}
+
+{{ end }} +``` + +The `parseTime` function takes two arguments: the layout of the date string and the date string itself. The layout can be one of the following: "RFC3339", "RFC3339Nano", "DateTime", "DateOnly", "TimeOnly" or a custom layout in Go's [date format](https://pkg.go.dev/time#pkg-constants). + +Output: + +```html +
Exploring the Depths of Quantum Computing
+
+ +
A Beginner's Guide to Sustainable Living
+
+ +
The Art of Baking Sourdough Bread
+
+``` + +You don't have to worry about the internal implementation, this will then be dynamically populated by Glance on the client side to show the correct relative time. + +The important thing to notice here is that the return value of `toRelativeTime` must be used as an attribute in an HTML tag, be it a `div`, `li`, `span`, etc. + +
+ +In some instances, you may want to know the status code of the response. This can be done using the following: + +```html +{{ if eq .Response.StatusCode 200 }} +

Success!

+{{ else }} +

Failed to fetch data

+{{ end }} +``` + +You can also access the response headers: + +```html +
{{ .Response.Header.Get "Content-Type" }}
+``` + +
+ +JSON response: + +```json +{"name": "Steve", "age": 30} +{"name": "Alex", "age": 25} +{"name": "John", "age": 35} +``` + +The above format is "[ndjson](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-ndjson)" or "[JSON Lines](https://jsonlines.org/)", where each line is a separate JSON object. To parse this format, you must first disable the JSON validation check in your config, since by default the response is expected to be a single valid JSON object: + +```yaml +- type: custom-api + skip-json-validation: true +``` + +Then, to iterate over each object you can use `.JSONLines`: + +```html +{{ range .JSONLines }} +

{{ .String "name" }} is {{ .Int "age" }} years old

+{{ end }} +``` + +Output: + +```html +

Steve is 30 years old

+

Alex is 25 years old

+

John is 35 years old

+``` + +For other ways of selecting data from a JSON Lines response, have a look at the docs for [tidwall/gjson](https://github.com/tidwall/gjson/tree/master?tab=readme-ov-file#json-lines). For example, to get an array of all names, you can use the following: + +```html +{{ range .JSON.Array "..#.name" }} +

{{ .String "" }}

+{{ end }} +``` + +Output: + +```html +

Steve

+

Alex

+

John

+``` + +## Functions + +The following functions are available on the `JSON` object: + +- `String(key string) string`: Returns the value of the key as a string. +- `Int(key string) int`: Returns the value of the key as an integer. +- `Float(key string) float`: Returns the value of the key as a float. +- `Bool(key string) bool`: Returns the value of the key as a boolean. +- `Array(key string) []JSON`: Returns the value of the key as an array of `JSON` objects. +- `Exists(key string) bool`: Returns true if the key exists in the JSON object. + +The following helper functions provided by Glance are available: + +- `toFloat(i int) float`: Converts an integer to a float. +- `toInt(f float) int`: Converts a float to an integer. +- `toRelativeTime(t time.Time) template.HTMLAttr`: Converts Time to a relative time such as 2h, 1d, etc which dynamically updates. **NOTE:** the value of this function should be used as an attribute in an HTML tag, e.g. ``. +- `now() time.Time`: Returns the current time. +- `offsetNow(offset string) time.Time`: Returns the current time with an offset. The offset can be positive or negative and must be in the format "3h" "-1h" or "2h30m10s". +- `duration(str string) time.Duration`: Parses a string such as `1h`, `24h`, `5h30m`, etc into a `time.Duration`. +- `parseTime(layout string, s string) time.Time`: Parses a string into time.Time. The layout must be provided in Go's [date format](https://pkg.go.dev/time#pkg-constants). You can alternatively use these values instead of the literal format: "unix", "RFC3339", "RFC3339Nano", "DateTime", "DateOnly". +- `parseRelativeTime(layout string, s string) time.Time`: A shorthand for `{{ .String "date" | parseTime "rfc3339" | toRelativeTime }}`. +- `add(a, b float) float`: Adds two numbers. +- `sub(a, b float) float`: Subtracts two numbers. +- `mul(a, b float) float`: Multiplies two numbers. +- `div(a, b float) float`: Divides two numbers. +- `formatApproxNumber(n int) string`: Formats a number to be more human-readable, e.g. 1000 -> 1k. +- `formatNumber(n float|int) string`: Formats a number with commas, e.g. 1000 -> 1,000. +- `trimPrefix(prefix string, str string) string`: Trims the prefix from a string. +- `trimSuffix(suffix string, str string) string`: Trims the suffix from a string. +- `trimSpace(str string) string`: Trims whitespace from a string on both ends. +- `replaceAll(old string, new string, str string) string`: Replaces all occurrences of a string in a string. +- `replaceMatches(pattern string, replacement string, str string) string`: Replaces all occurrences of a regular expression in a string. +- `findMatch(pattern string, str string) string`: Finds the first match of a regular expression in a string. +- `findSubmatch(pattern string, str string) string`: Finds the first submatch of a regular expression in a string. +- `sortByString(key string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by a string key in either ascending or descending order. +- `sortByInt(key string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by an integer key in either ascending or descending order. +- `sortByFloat(key string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by a float key in either ascending or descending order. +- `sortByTime(key string, layout string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by a time key in either ascending or descending order. The format must be provided in Go's [date format](https://pkg.go.dev/time#pkg-constants). +- `concat(strings ...string) string`: Concatenates multiple strings together. +- `unique(key string, arr []JSON) []JSON`: Returns a unique array of JSON objects based on the given key. + +The following helper functions provided by Go's `text/template` are available: + +- `eq(a, b any) bool`: Compares two values for equality. +- `ne(a, b any) bool`: Compares two values for inequality. +- `lt(a, b any) bool`: Compares two values for less than. +- `lte(a, b any) bool`: Compares two values for less than or equal to. +- `gt(a, b any) bool`: Compares two values for greater than. +- `gte(a, b any) bool`: Compares two values for greater than or equal to. +- `and(a, b bool) bool`: Returns true if both values are true. +- `or(a, b bool) bool`: Returns true if either value is true. +- `not(a bool) bool`: Returns the opposite of the value. +- `index(a any, b int) any`: Returns the value at the specified index of an array. +- `len(a any) int`: Returns the length of an array. +- `printf(format string, a ...any) string`: Returns a formatted string. diff --git a/docs/extensions.md b/docs/extensions.md index 06db1ae..b6719c1 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -26,9 +26,15 @@ If you know how to setup an HTTP server and a bit of HTML and CSS you're ready t ### `Widget-Title` Used to specify the title of the widget. If not provided, the widget's title will be "Extension". +### `Widget-Title-URL` +Used to specify the URL that will be opened when the widget's title is clicked. If the user has specified a `title-url` in their config, it will take precedence over this header. + ### `Widget-Content-Type` Used to specify the content type that will be returned by the extension. If not provided, the content will be shown as plain text. +### `Widget-Content-Frameless` +When set to `true`, the widget's content will be displayed without the default background or "frame". + ## Content Types > [!NOTE] diff --git a/docs/glance.yml b/docs/glance.yml new file mode 100644 index 0000000..35dc7cb --- /dev/null +++ b/docs/glance.yml @@ -0,0 +1,105 @@ +pages: + - name: Home + # Optionally, if you only have a single page you can hide the desktop navigation for a cleaner look + # hide-desktop-navigation: true + columns: + - size: small + widgets: + - type: calendar + first-day-of-week: monday + + - type: rss + limit: 10 + collapse-after: 3 + cache: 12h + feeds: + - url: https://selfh.st/rss/ + title: selfh.st + limit: 4 + - url: https://ciechanow.ski/atom.xml + - url: https://www.joshwcomeau.com/rss.xml + title: Josh Comeau + - url: https://samwho.dev/rss.xml + - url: https://ishadeed.com/feed.xml + title: Ahmad Shadeed + + - type: twitch-channels + channels: + - theprimeagen + - j_blow + - piratesoftware + - cohhcarnage + - christitustech + - EJ_SA + + - size: full + widgets: + - type: group + widgets: + - type: hacker-news + - type: lobsters + + - type: videos + channels: + - UCXuqSBlHAE6Xw-yeJA0Tunw # Linus Tech Tips + - UCR-DXc1voovS8nhAvccRZhg # Jeff Geerling + - UCsBjURrPoezykLs9EqgamOA # Fireship + - UCBJycsmduvYEL83R_U4JriQ # Marques Brownlee + - UCHnyfMqiRRG1u-2MsSQLbXA # Veritasium + + - type: group + widgets: + - type: reddit + subreddit: technology + show-thumbnails: true + - type: reddit + subreddit: selfhosted + show-thumbnails: true + + - size: small + widgets: + - type: weather + location: London, United Kingdom + units: metric # alternatively "imperial" + hour-format: 12h # alternatively "24h" + # Optionally hide the location from being displayed in the widget + # hide-location: true + + - type: markets + markets: + - symbol: SPY + name: S&P 500 + - symbol: BTC-USD + name: Bitcoin + - symbol: NVDA + name: NVIDIA + - symbol: AAPL + name: Apple + - symbol: MSFT + name: Microsoft + + - type: releases + cache: 1d + # Without authentication the Github API allows for up to 60 requests per hour. You can create a + # read-only token from your Github account settings and use it here to increase the limit. + # token: ... + repositories: + - glanceapp/glance + - go-gitea/gitea + - immich-app/immich + - syncthing/syncthing + + # Add more pages here: + # - name: Your page name + # columns: + # - size: small + # widgets: + # # Add widgets here + + # - size: full + # widgets: + # # Add widgets here + + # - size: small + # widgets: + # # Add widgets here diff --git a/docs/images/calendar-legacy-widget-preview.png b/docs/images/calendar-legacy-widget-preview.png new file mode 100644 index 0000000..5a161bf Binary files /dev/null and b/docs/images/calendar-legacy-widget-preview.png differ diff --git a/docs/images/calendar-widget-preview.png b/docs/images/calendar-widget-preview.png index 5a161bf..4922a9b 100644 Binary files a/docs/images/calendar-widget-preview.png and b/docs/images/calendar-widget-preview.png differ diff --git a/docs/images/custom-api-preview-1.png b/docs/images/custom-api-preview-1.png new file mode 100644 index 0000000..4cf4c30 Binary files /dev/null and b/docs/images/custom-api-preview-1.png differ diff --git a/docs/images/custom-api-preview-2.png b/docs/images/custom-api-preview-2.png new file mode 100644 index 0000000..481ef85 Binary files /dev/null and b/docs/images/custom-api-preview-2.png differ diff --git a/docs/images/custom-api-preview-3.png b/docs/images/custom-api-preview-3.png new file mode 100644 index 0000000..15d8cb2 Binary files /dev/null and b/docs/images/custom-api-preview-3.png differ diff --git a/docs/images/dns-stats-widget-preview.png b/docs/images/dns-stats-widget-preview.png new file mode 100644 index 0000000..defd139 Binary files /dev/null and b/docs/images/dns-stats-widget-preview.png differ diff --git a/docs/images/docker-container-parent.png b/docs/images/docker-container-parent.png new file mode 100644 index 0000000..479b3e8 Binary files /dev/null and b/docs/images/docker-container-parent.png differ diff --git a/docs/images/docker-container-parent2.png b/docs/images/docker-container-parent2.png new file mode 100644 index 0000000..4562239 Binary files /dev/null and b/docs/images/docker-container-parent2.png differ diff --git a/docs/images/docker-containers-preview.png b/docs/images/docker-containers-preview.png new file mode 100644 index 0000000..ba14fce Binary files /dev/null and b/docs/images/docker-containers-preview.png differ diff --git a/docs/images/docker-widget-preview.png b/docs/images/docker-widget-preview.png new file mode 100644 index 0000000..5b644d4 Binary files /dev/null and b/docs/images/docker-widget-preview.png differ diff --git a/docs/images/gaming-page-preview.png b/docs/images/gaming-page-preview.png new file mode 100644 index 0000000..343d22f Binary files /dev/null and b/docs/images/gaming-page-preview.png differ diff --git a/docs/images/group-widget-preview.png b/docs/images/group-widget-preview.png new file mode 100644 index 0000000..4d1d86b Binary files /dev/null and b/docs/images/group-widget-preview.png differ diff --git a/docs/images/markets-page-preview.png b/docs/images/markets-page-preview.png new file mode 100644 index 0000000..51e9f99 Binary files /dev/null and b/docs/images/markets-page-preview.png differ diff --git a/docs/images/mobile-preview.png b/docs/images/mobile-preview.png index 38acdcf..c27a1d2 100644 Binary files a/docs/images/mobile-preview.png and b/docs/images/mobile-preview.png differ diff --git a/docs/images/monitor-widget-compact-preview.png b/docs/images/monitor-widget-compact-preview.png new file mode 100644 index 0000000..3e81fce Binary files /dev/null and b/docs/images/monitor-widget-compact-preview.png differ diff --git a/docs/images/preconfigured-page-preview.png b/docs/images/preconfigured-page-preview.png index 0a57c14..e10084c 100644 Binary files a/docs/images/preconfigured-page-preview.png and b/docs/images/preconfigured-page-preview.png differ diff --git a/docs/images/readme-main-image.png b/docs/images/readme-main-image.png index 821c35b..cce27fb 100644 Binary files a/docs/images/readme-main-image.png and b/docs/images/readme-main-image.png differ diff --git a/docs/images/reddit-field-search.png b/docs/images/reddit-field-search.png index 97ba04a..a84ee33 100644 Binary files a/docs/images/reddit-field-search.png and b/docs/images/reddit-field-search.png differ diff --git a/docs/images/releases-widget-preview.png b/docs/images/releases-widget-preview.png index 47acfd0..ec712bb 100644 Binary files a/docs/images/releases-widget-preview.png and b/docs/images/releases-widget-preview.png differ diff --git a/docs/images/server-stats-flame-icon.png b/docs/images/server-stats-flame-icon.png new file mode 100644 index 0000000..28cf0b8 Binary files /dev/null and b/docs/images/server-stats-flame-icon.png differ diff --git a/docs/images/server-stats-preview.gif b/docs/images/server-stats-preview.gif new file mode 100644 index 0000000..829679b Binary files /dev/null and b/docs/images/server-stats-preview.gif differ diff --git a/docs/images/split-column-widget-3-columns.png b/docs/images/split-column-widget-3-columns.png new file mode 100644 index 0000000..88192c3 Binary files /dev/null and b/docs/images/split-column-widget-3-columns.png differ diff --git a/docs/images/split-column-widget-4-columns.png b/docs/images/split-column-widget-4-columns.png new file mode 100644 index 0000000..450f53e Binary files /dev/null and b/docs/images/split-column-widget-4-columns.png differ diff --git a/docs/images/split-column-widget-masonry.png b/docs/images/split-column-widget-masonry.png new file mode 100644 index 0000000..145b2d6 Binary files /dev/null and b/docs/images/split-column-widget-masonry.png differ diff --git a/docs/images/split-column-widget-preview.png b/docs/images/split-column-widget-preview.png new file mode 100644 index 0000000..1ee336d Binary files /dev/null and b/docs/images/split-column-widget-preview.png differ diff --git a/docs/images/startpage-preview.png b/docs/images/startpage-preview.png new file mode 100644 index 0000000..2af87ed Binary files /dev/null and b/docs/images/startpage-preview.png differ diff --git a/docs/images/themes/dracula.png b/docs/images/themes/dracula.png new file mode 100644 index 0000000..8dba452 Binary files /dev/null and b/docs/images/themes/dracula.png differ diff --git a/docs/images/themes/gruvbox.png b/docs/images/themes/gruvbox.png new file mode 100644 index 0000000..2e5b7a9 Binary files /dev/null and b/docs/images/themes/gruvbox.png differ diff --git a/docs/images/videos-widget-vertical-list-preview.png b/docs/images/videos-widget-vertical-list-preview.png new file mode 100644 index 0000000..e33ce86 Binary files /dev/null and b/docs/images/videos-widget-vertical-list-preview.png differ diff --git a/docs/preconfigured-pages.md b/docs/preconfigured-pages.md new file mode 100644 index 0000000..b70610b --- /dev/null +++ b/docs/preconfigured-pages.md @@ -0,0 +1,226 @@ +# Preconfigured pages + +Don't want to spend time configuring pages from scratch? No problem! Simply copy the config from the ones below. + +Pull requests with your page configurations are welcome! + +> [!NOTE] +> +> Pages must be placed under a top level `pages:` key, you can read more about that [here](configuration.md#pages). + +## Startpage + +![](images/startpage-preview.png) + +
+View config (requires Glance v0.6.0 or higher) + +```yaml +- name: Startpage + width: slim + hide-desktop-navigation: true + center-vertically: true + columns: + - size: full + widgets: + - type: search + autofocus: true + + - type: monitor + cache: 1m + title: Services + sites: + - title: Jellyfin + url: https://yourdomain.com/ + icon: si:jellyfin + - title: Gitea + url: https://yourdomain.com/ + icon: si:gitea + - title: qBittorrent # only for Linux ISOs, of course + url: https://yourdomain.com/ + icon: si:qbittorrent + - title: Immich + url: https://yourdomain.com/ + icon: si:immich + - title: AdGuard Home + url: https://yourdomain.com/ + icon: si:adguard + - title: Vaultwarden + url: https://yourdomain.com/ + icon: si:vaultwarden + + - type: bookmarks + groups: + - title: General + links: + - title: Gmail + url: https://mail.google.com/mail/u/0/ + - title: Amazon + url: https://www.amazon.com/ + - title: Github + url: https://github.com/ + - title: Entertainment + links: + - title: YouTube + url: https://www.youtube.com/ + - title: Prime Video + url: https://www.primevideo.com/ + - title: Disney+ + url: https://www.disneyplus.com/ + - title: Social + links: + - title: Reddit + url: https://www.reddit.com/ + - title: Twitter + url: https://twitter.com/ + - title: Instagram + url: https://www.instagram.com/ +``` +
+ +## Markets + +![](images/markets-page-preview.png) + +
+View config (requires Glance v0.6.0 or higher) + +```yaml + - name: Markets + columns: + - size: small + widgets: + - type: markets + title: Indices + markets: + - symbol: SPY + name: S&P 500 + - symbol: DX-Y.NYB + name: Dollar Index + + - type: markets + title: Crypto + markets: + - symbol: BTC-USD + name: Bitcoin + - symbol: ETH-USD + name: Ethereum + + - type: markets + title: Stocks + sort-by: absolute-change + markets: + - symbol: NVDA + name: NVIDIA + - symbol: AAPL + name: Apple + - symbol: MSFT + name: Microsoft + - symbol: GOOGL + name: Google + - symbol: AMD + name: AMD + - symbol: RDDT + name: Reddit + - symbol: AMZN + name: Amazon + - symbol: TSLA + name: Tesla + - symbol: INTC + name: Intel + - symbol: META + name: Meta + + - size: full + widgets: + - type: rss + title: News + style: horizontal-cards + feeds: + - url: https://feeds.bloomberg.com/markets/news.rss + title: Bloomberg + - url: https://moxie.foxbusiness.com/google-publisher/markets.xml + title: Fox Business + - url: https://moxie.foxbusiness.com/google-publisher/technology.xml + title: Fox Business + + - type: group + widgets: + - type: reddit + show-thumbnails: true + subreddit: technology + - type: reddit + show-thumbnails: true + subreddit: wallstreetbets + + - type: videos + style: grid-cards + collapse-after-rows: 3 + channels: + - UCvSXMi2LebwJEM1s4bz5IBA # New Money + - UCV6KDgJskWaEckne5aPA0aQ # Graham Stephan + - UCAzhpt9DmG6PnHXjmJTvRGQ # Federal Reserve + + - size: small + widgets: + - type: rss + title: News + limit: 30 + collapse-after: 13 + feeds: + - url: https://www.ft.com/technology?format=rss + title: Financial Times + - url: https://feeds.a.dj.com/rss/RSSMarketsMain.xml + title: Wall Street Journal +``` +
+ +## Gaming + +![](images/gaming-page-preview.png) + +
+View config (requires Glance v0.6.0 or higher) + +```yaml +- name: Gaming + columns: + - size: small + widgets: + - type: twitch-top-games + limit: 20 + collapse-after: 13 + exclude: + - just-chatting + - pools-hot-tubs-and-beaches + - music + - art + - asmr + + - size: full + widgets: + - type: group + widgets: + - type: reddit + show-thumbnails: true + subreddit: pcgaming + - type: reddit + subreddit: games + + - type: videos + style: grid-cards + collapse-after-rows: 3 + channels: + - UCNvzD7Z-g64bPXxGzaQaa4g # gameranx + - UCZ7AeeVbyslLM_8-nVy2B8Q # Skill Up + - UCHDxYLv8iovIbhrfl16CNyg # GameLinked + - UC9PBzalIcEQCsiIkq36PyUA # Digital Foundry + + - size: small + widgets: + - type: reddit + subreddit: gamingnews + limit: 7 + style: vertical-cards +``` +
diff --git a/docs/themes.md b/docs/themes.md index b4185db..fdc10b2 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -53,6 +53,16 @@ theme: primary-color: 97 13 80 ``` +### Gruvbox Dark +![screenshot](images/themes/gruvbox.png) +```yaml +theme: + background-color: 0 0 16 + primary-color: 43 59 81 + positive-color: 61 66 44 + negative-color: 6 96 59 +``` + ### Kanagawa Dark ![screenshot](images/themes/kanagawa-dark.png) ```yaml @@ -72,6 +82,17 @@ theme: negative-color: 209 88 54 ``` +### Dracula +![screenshot](images/themes/dracula.png) +```yaml +theme: + background-color: 231 15 21 + primary-color: 265 89 79 + contrast-multiplier: 1.2 + positive-color: 135 94 66 + negative-color: 0 100 67 +``` + ## Light ### Catppuccin Latte diff --git a/docs/v0.7.0-upgrade.md b/docs/v0.7.0-upgrade.md new file mode 100644 index 0000000..93fa6b8 --- /dev/null +++ b/docs/v0.7.0-upgrade.md @@ -0,0 +1,57 @@ +## Upgrading to v0.7.0 from previous versions + +In essence, the `glance.yml` file has been moved from the root of the project to a `config/` directory and you now need to mount that directory to `/app/config` in the container. + +### Before + +Versions before v0.7.0 used a `docker-compose.yml` that looked like the following: + +```yaml +services: + glance: + image: glanceapp/glance + volumes: + - ./glance.yml:/app/glance.yml + ports: + - 8080:8080 +``` + +And expected you to have the following directory structure: + +```plaintext +glance/ + docker-compose.yml + glance.yml +``` + +### After + +With the release of v0.7.0, the recommended `docker-compose.yml` looks like the following: + +```yaml +services: + glance: + container_name: glance + image: glanceapp/glance + volumes: + - ./config:/app/config + ports: + - 8080:8080 +``` + +And expects you to have the following directory structure: + +```plaintext +glance/ + docker-compose.yml + config/ + glance.yml +``` + +## Why this change was necessary + +1. Mounting a file rather than a directory is not common practice and leads to some issues, such as creating a directory if the file is not present, which has tripped up multiple people and caused unnecessary confusion +2. v0.7.0 added automatic reloads when the configuration file changes, which based on testing didn't work when mounting a single file +3. v0.7.0 added the ability to include config files, so you'd have to make this change anyways if you wanted to take advantage of that feature + +Taking all of these into account, it felt like the right time to implement the change. diff --git a/go.mod b/go.mod index 502fc70..4c19477 100644 --- a/go.mod +++ b/go.mod @@ -1,19 +1,32 @@ module github.com/glanceapp/glance -go 1.22.3 +go 1.24.2 require ( + github.com/fsnotify/fsnotify v1.9.0 github.com/mmcdole/gofeed v1.3.0 - golang.org/x/text v0.14.0 + github.com/shirou/gopsutil/v4 v4.25.3 + github.com/tidwall/gjson v1.18.0 + golang.org/x/text v0.24.0 gopkg.in/yaml.v3 v3.0.1 ) require ( - github.com/PuerkitoBio/goquery v1.9.1 // indirect - github.com/andybalholm/cascadia v1.3.2 // indirect + github.com/PuerkitoBio/goquery v1.10.2 // indirect + github.com/andybalholm/cascadia v1.3.3 // indirect + github.com/ebitengine/purego v0.8.2 // indirect + github.com/go-ole/go-ole v1.3.0 // indirect github.com/json-iterator/go v1.1.12 // indirect + github.com/lufia/plan9stats v0.0.0-20250317134145-8bc96cf8fc35 // indirect github.com/mmcdole/goxpp v1.1.1 // indirect github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.2 // indirect - golang.org/x/net v0.24.0 // indirect + github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 // indirect + github.com/tidwall/match v1.1.1 // indirect + github.com/tidwall/pretty v1.2.1 // indirect + github.com/tklauser/go-sysconf v0.3.15 // indirect + github.com/tklauser/numcpus v0.10.0 // indirect + github.com/yusufpapurcu/wmi v1.2.4 // indirect + golang.org/x/net v0.39.0 // indirect + golang.org/x/sys v0.32.0 // indirect ) diff --git a/go.sum b/go.sum index 54489e6..9a79559 100644 --- a/go.sum +++ b/go.sum @@ -1,13 +1,31 @@ -github.com/PuerkitoBio/goquery v1.9.1 h1:mTL6XjbJTZdpfL+Gwl5U2h1l9yEkJjhmlTeV9VPW7UI= -github.com/PuerkitoBio/goquery v1.9.1/go.mod h1:cW1n6TmIMDoORQU5IU/P1T3tGFunOeXEpGP2WHRwkbY= -github.com/andybalholm/cascadia v1.3.2 h1:3Xi6Dw5lHF15JtdcmAHD3i1+T8plmv7BQ/nsViSLyss= -github.com/andybalholm/cascadia v1.3.2/go.mod h1:7gtRlve5FxPPgIgX36uWBX58OdBsSS6lUvCFb+h7KvU= +github.com/PuerkitoBio/goquery v1.10.1 h1:Y8JGYUkXWTGRB6Ars3+j3kN0xg1YqqlwvdTV8WTFQcU= +github.com/PuerkitoBio/goquery v1.10.1/go.mod h1:IYiHrOMps66ag56LEH7QYDDupKXyo5A8qrjIx3ZtujY= +github.com/PuerkitoBio/goquery v1.10.2 h1:7fh2BdHcG6VFZsK7toXBT/Bh1z5Wmy8Q9MV9HqT2AM8= +github.com/PuerkitoBio/goquery v1.10.2/go.mod h1:0guWGjcLu9AYC7C1GHnpysHy056u9aEkUHwhdnePMCU= +github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= +github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/ebitengine/purego v0.8.2 h1:jPPGWs2sZ1UgOSgD2bClL0MJIqu58nOmIcBuXr62z1I= +github.com/ebitengine/purego v0.8.2/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/fsnotify/fsnotify v1.8.0 h1:dAwr6QBTBZIkG8roQaJjGof0pp0EeF+tNV7YBP3F/8M= +github.com/fsnotify/fsnotify v1.8.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= +github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k= +github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= +github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= +github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE= +github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/lufia/plan9stats v0.0.0-20240909124753-873cd0166683 h1:7UMa6KCCMjZEMDtTVdcGu0B1GmmC7QJKiCCjyTAWQy0= +github.com/lufia/plan9stats v0.0.0-20240909124753-873cd0166683/go.mod h1:ilwx/Dta8jXAgpFYFvSWEMwxmbWXyiUHkd5FwyKhb5k= +github.com/lufia/plan9stats v0.0.0-20250317134145-8bc96cf8fc35 h1:PpXWgLPs+Fqr325bN2FD2ISlRRztXibcX6e8f5FR5Dc= +github.com/lufia/plan9stats v0.0.0-20250317134145-8bc96cf8fc35/go.mod h1:autxFIvghDt3jPTLoqZ9OZ7s9qTGNAWmYCjVFWPX/zg= github.com/mmcdole/gofeed v1.3.0 h1:5yn+HeqlcvjMeAI4gu6T+crm7d0anY85+M+v6fIFNG4= github.com/mmcdole/gofeed v1.3.0/go.mod h1:9TGv2LcJhdXePDzxiuMnukhV2/zb6VtnZt1mS+SjkLE= github.com/mmcdole/goxpp v1.1.1 h1:RGIX+D6iQRIunGHrKqnA2+700XMCnNv0bAOOv5MUhx8= @@ -19,47 +37,111 @@ github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9G github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 h1:o4JXh1EVt9k/+g42oCprj/FisM4qX9L3sZB3upGN2ZU= +github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55/go.mod h1:OmDBASR4679mdNQnz2pUhc2G8CO2JrUAVFDRBDP/hJE= +github.com/shirou/gopsutil/v4 v4.25.1 h1:QSWkTc+fu9LTAWfkZwZ6j8MSUk4A2LV7rbH0ZqmLjXs= +github.com/shirou/gopsutil/v4 v4.25.1/go.mod h1:RoUCUpndaJFtT+2zsZzzmhvbfGoDCJ7nFXKJf8GqJbI= +github.com/shirou/gopsutil/v4 v4.25.3 h1:SeA68lsu8gLggyMbmCn8cmp97V1TI9ld9sVzAUcKcKE= +github.com/shirou/gopsutil/v4 v4.25.3/go.mod h1:xbuxyoZj+UsgnZrENu3lQivsngRR5BdjbJwf2fv4szA= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= -github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= -github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= +github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY= +github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4= +github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tklauser/go-sysconf v0.3.14 h1:g5vzr9iPFFz24v2KZXs/pvpvh8/V9Fw6vQK5ZZb78yU= +github.com/tklauser/go-sysconf v0.3.14/go.mod h1:1ym4lWMLUOhuBOPGtRcJm7tEGX4SCYNEEEtghGG/8uY= +github.com/tklauser/go-sysconf v0.3.15 h1:VE89k0criAymJ/Os65CSn1IXaol+1wrsFHEB8Ol49K4= +github.com/tklauser/go-sysconf v0.3.15/go.mod h1:Dmjwr6tYFIseJw7a3dRLJfsHAMXZ3nEnL/aZY+0IuI4= +github.com/tklauser/numcpus v0.9.0 h1:lmyCHtANi8aRUgkckBgoDk1nHCux3n2cgkJLXdQGPDo= +github.com/tklauser/numcpus v0.9.0/go.mod h1:SN6Nq1O3VychhC1npsWostA+oW+VOQTxZrS604NSRyI= +github.com/tklauser/numcpus v0.10.0 h1:18njr6LDBk1zuna922MgdjQuJFjrdppsZG60sHGfjso= +github.com/tklauser/numcpus v0.10.0/go.mod h1:BiTKazU708GQTYF4mB+cmlpT2Is1gLk7XVuEeem8LsQ= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +github.com/yusufpapurcu/wmi v1.2.4 h1:zFUKzehAFReQwLys1b/iSMl+JQGSCSjtVqQn9bBrPo0= +github.com/yusufpapurcu/wmi v1.2.4/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= +golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= +golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= -golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= -golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w= -golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= +golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= +golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= +golang.org/x/net v0.34.0 h1:Mb7Mrk043xzHgnRM88suvJFwzVrRfHEHJEl5/71CKw0= +golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k= +golang.org/x/net v0.39.0 h1:ZCu7HMWDxpXpaiKdhzIfaltL9Lp31x/3fCP11bc6/fY= +golang.org/x/net v0.39.0/go.mod h1:X7NRbYVEA+ewNkCNyJ513WmMdQ3BineSwVtN2zD/d+E= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= +golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201204225414-ed752295db88/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= +golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20= +golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= -golang.org/x/term v0.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= +golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= +golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= +golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= -golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= +golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM= +golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY= +golang.org/x/text v0.24.0 h1:dd5Bzh4yt5KYA8f9CJHCP4FB4D51c2c6JvN37xJJkJ0= +golang.org/x/text v0.24.0/go.mod h1:L8rBsPeo2pSS+xqN0d5u2ikmjtmoJbDBT1b7nHvFCdU= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/internal/assets/files.go b/internal/assets/files.go deleted file mode 100644 index bfb2b4c..0000000 --- a/internal/assets/files.go +++ /dev/null @@ -1,15 +0,0 @@ -package assets - -import ( - "embed" - "io/fs" -) - -//go:embed static -var _publicFS embed.FS - -//go:embed templates -var _templateFS embed.FS - -var PublicFS, _ = fs.Sub(_publicFS, "static") -var TemplateFS, _ = fs.Sub(_templateFS, "templates") diff --git a/internal/assets/templates.go b/internal/assets/templates.go deleted file mode 100644 index 53ae871..0000000 --- a/internal/assets/templates.go +++ /dev/null @@ -1,120 +0,0 @@ -package assets - -import ( - "fmt" - "html/template" - "math" - "strconv" - "time" - - "golang.org/x/text/language" - "golang.org/x/text/message" -) - -var ( - PageTemplate = compileTemplate("page.html", "document.html", "page-style-overrides.gotmpl") - PageContentTemplate = compileTemplate("content.html") - CalendarTemplate = compileTemplate("calendar.html", "widget-base.html") - ClockTemplate = compileTemplate("clock.html", "widget-base.html") - BookmarksTemplate = compileTemplate("bookmarks.html", "widget-base.html") - IFrameTemplate = compileTemplate("iframe.html", "widget-base.html") - WeatherTemplate = compileTemplate("weather.html", "widget-base.html") - ForumPostsTemplate = compileTemplate("forum-posts.html", "widget-base.html") - RedditCardsHorizontalTemplate = compileTemplate("reddit-horizontal-cards.html", "widget-base.html") - RedditCardsVerticalTemplate = compileTemplate("reddit-vertical-cards.html", "widget-base.html") - ReleasesTemplate = compileTemplate("releases.html", "widget-base.html") - ChangeDetectionTemplate = compileTemplate("change-detection.html", "widget-base.html") - VideosTemplate = compileTemplate("videos.html", "widget-base.html", "video-card-contents.html") - VideosGridTemplate = compileTemplate("videos-grid.html", "widget-base.html", "video-card-contents.html") - MarketsTemplate = compileTemplate("markets.html", "widget-base.html") - RSSListTemplate = compileTemplate("rss-list.html", "widget-base.html") - RSSDetailedListTemplate = compileTemplate("rss-detailed-list.html", "widget-base.html") - RSSHorizontalCardsTemplate = compileTemplate("rss-horizontal-cards.html", "widget-base.html") - RSSHorizontalCards2Template = compileTemplate("rss-horizontal-cards-2.html", "widget-base.html") - MonitorTemplate = compileTemplate("monitor.html", "widget-base.html") - TwitchGamesListTemplate = compileTemplate("twitch-games-list.html", "widget-base.html") - TwitchChannelsTemplate = compileTemplate("twitch-channels.html", "widget-base.html") - RepositoryTemplate = compileTemplate("repository.html", "widget-base.html") - SearchTemplate = compileTemplate("search.html", "widget-base.html") - ExtensionTemplate = compileTemplate("extension.html", "widget-base.html") -) - -var globalTemplateFunctions = template.FuncMap{ - "relativeTime": relativeTimeSince, - "formatViewerCount": formatViewerCount, - "formatNumber": intl.Sprint, - "absInt": func(i int) int { - return int(math.Abs(float64(i))) - }, - "formatPrice": func(price float64) string { - return intl.Sprintf("%.2f", price) - }, - "formatTime": func(t time.Time) string { - return t.Format("2006-01-02 15:04:05") - }, - "shouldCollapse": func(i int, collapseAfter int) bool { - if collapseAfter < -1 { - return false - } - - return i >= collapseAfter - }, - "itemAnimationDelay": func(i int, collapseAfter int) string { - return fmt.Sprintf("%dms", (i-collapseAfter)*30) - }, - "dynamicRelativeTimeAttrs": func(t time.Time) template.HTMLAttr { - return template.HTMLAttr(fmt.Sprintf(`data-dynamic-relative-time="%d"`, t.Unix())) - }, -} - -func compileTemplate(primary string, dependencies ...string) *template.Template { - t, err := template.New(primary). - Funcs(globalTemplateFunctions). - ParseFS(TemplateFS, append([]string{primary}, dependencies...)...) - - if err != nil { - panic(err) - } - - return t -} - -var intl = message.NewPrinter(language.English) - -func formatViewerCount(count int) string { - if count < 1_000 { - return strconv.Itoa(count) - } - - if count < 10_000 { - return fmt.Sprintf("%.1fk", float64(count)/1_000) - } - - if count < 1_000_000 { - return fmt.Sprintf("%dk", count/1_000) - } - - return fmt.Sprintf("%.1fm", float64(count)/1_000_000) -} - -func relativeTimeSince(t time.Time) string { - delta := time.Since(t) - - if delta < time.Minute { - return "1m" - } - if delta < time.Hour { - return fmt.Sprintf("%dm", delta/time.Minute) - } - if delta < 24*time.Hour { - return fmt.Sprintf("%dh", delta/time.Hour) - } - if delta < 30*24*time.Hour { - return fmt.Sprintf("%dd", delta/(24*time.Hour)) - } - if delta < 12*30*24*time.Hour { - return fmt.Sprintf("%dmo", delta/(30*24*time.Hour)) - } - - return fmt.Sprintf("%dy", delta/(365*24*time.Hour)) -} diff --git a/internal/assets/templates/bookmarks.html b/internal/assets/templates/bookmarks.html deleted file mode 100644 index a422009..0000000 --- a/internal/assets/templates/bookmarks.html +++ /dev/null @@ -1,37 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} -{{ if ne .Style "dynamic-columns-experimental" }} - -{{ else }} -
- {{ range .Groups }} -
- {{ template "group" . }} -
- {{ end }} -
-{{ end }} -{{ end }} - -{{ define "group" }} -{{ if ne .Title "" }}
{{ .Title }}
{{ end }} - -{{ end }} diff --git a/internal/assets/templates/calendar.html b/internal/assets/templates/calendar.html deleted file mode 100644 index 68fda83..0000000 --- a/internal/assets/templates/calendar.html +++ /dev/null @@ -1,27 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} -
-
{{ .Calendar.CurrentMonthName }}
-
    -
  • Week {{ .Calendar.CurrentWeekNumber }}
  • -
  • {{ .Calendar.CurrentYear }}
  • -
-
- -
-
Mo
-
Tu
-
We
-
Th
-
Fr
-
Sa
-
Su
-
- -
- {{ range .Calendar.Days }} -
{{ . }}
- {{ end }} -
-{{ end }} diff --git a/internal/assets/templates/extension.html b/internal/assets/templates/extension.html deleted file mode 100644 index e5794c8..0000000 --- a/internal/assets/templates/extension.html +++ /dev/null @@ -1,5 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} -{{ .Extension.Content }} -{{ end }} diff --git a/internal/assets/templates/forum-posts.html b/internal/assets/templates/forum-posts.html deleted file mode 100644 index a6fe24d..0000000 --- a/internal/assets/templates/forum-posts.html +++ /dev/null @@ -1,45 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} - -{{ end }} diff --git a/internal/assets/templates/markets.html b/internal/assets/templates/markets.html deleted file mode 100644 index 652427a..0000000 --- a/internal/assets/templates/markets.html +++ /dev/null @@ -1,39 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} -{{ if ne .Style "dynamic-columns-experimental" }} - -{{ else }} -
- {{ range .Markets }} -
- {{ template "market" . }} -
- {{ end }} -
-{{ end }} -{{ end }} - -{{ define "market" }} -
- {{ .Symbol }} -
{{ .Name }}
-
- - - - - - - -
-
{{ printf "%+.2f" .PercentChange }}%
-
{{ .Currency }}{{ .Price | formatPrice }}
-
-{{ end }} diff --git a/internal/assets/templates/monitor.html b/internal/assets/templates/monitor.html deleted file mode 100644 index 0333741..0000000 --- a/internal/assets/templates/monitor.html +++ /dev/null @@ -1,53 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} -{{ if ne .Style "dynamic-columns-experimental" }} - -{{ else }} - -{{ end }} -{{ end }} - -{{ define "site" }} -{{ if .IconUrl }} - -{{ end }} -
- {{ .Title }} -
    - {{ if not .Status.Error }} -
  • {{ .StatusText }}
  • -
  • {{ .Status.ResponseTime.Milliseconds | formatNumber }}ms
  • - {{ else if .Status.TimedOut }} -
  • Timed Out
  • - {{ else }} -
  • ERROR
  • - {{ end }} -
-
-{{ if eq .StatusStyle "ok" }} -
- - - -
-{{ else }} -
- - - -
-{{ end }} -{{ end }} diff --git a/internal/assets/templates/page-style-overrides.gotmpl b/internal/assets/templates/page-style-overrides.gotmpl deleted file mode 100644 index 0bf2a99..0000000 --- a/internal/assets/templates/page-style-overrides.gotmpl +++ /dev/null @@ -1,14 +0,0 @@ - diff --git a/internal/assets/templates/page.html b/internal/assets/templates/page.html deleted file mode 100644 index 98bb111..0000000 --- a/internal/assets/templates/page.html +++ /dev/null @@ -1,67 +0,0 @@ -{{ template "document.html" . }} - -{{ define "document-title" }}{{ .Page.Title }} - Glance{{ end }} - -{{ define "document-head-before" }} - -{{ end }} - -{{ define "document-root-attrs" }}{{ if .App.Config.Theme.Light }}class="light-scheme"{{ end }}{{ end }} -{{ define "document-head-after" }} -{{ template "page-style-overrides.gotmpl" . }} -{{ if ne "" .App.Config.Theme.CustomCSSFile }} - -{{ end }} -{{ end }} - -{{ define "navigation-links" }} -{{ range .App.Config.Pages }} -{{ .Title }} -{{ end }} -{{ end }} - -{{ define "document-body" }} -
-
- - - -
-
- -
-
- - {{ range $i, $column := .Page.Columns }} - - {{ end }} - -
- -
- -
-
-
-
- -
-
-
-
- - -{{ end }} diff --git a/internal/assets/templates/releases.html b/internal/assets/templates/releases.html deleted file mode 100644 index d6a8974..0000000 --- a/internal/assets/templates/releases.html +++ /dev/null @@ -1,18 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} - -{{ end }} diff --git a/internal/assets/templates/repository.html b/internal/assets/templates/repository.html deleted file mode 100644 index 26048dc..0000000 --- a/internal/assets/templates/repository.html +++ /dev/null @@ -1,44 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} -{{ .RepositoryDetails.Name }} - - -{{ if gt (len .RepositoryDetails.PullRequests) 0 }} -
-Open pull requests ({{ .RepositoryDetails.OpenPullRequests | formatNumber }} total) -
-
    - {{ range .RepositoryDetails.PullRequests }} -
  • - {{ end }} -
-
    - {{ range .RepositoryDetails.PullRequests }} -
  • {{ .Title }}
  • - {{ end }} -
-
-{{ end }} - -{{ if gt (len .RepositoryDetails.Issues) 0 }} -
-Open issues ({{ .RepositoryDetails.OpenIssues | formatNumber }} total) -
-
    - {{ range .RepositoryDetails.Issues }} -
  • - {{ end }} -
-
    - {{ range .RepositoryDetails.Issues }} -
  • {{ .Title }}
  • - {{ end }} -
-
-{{ end }} - -{{ end }} diff --git a/internal/assets/templates/weather.html b/internal/assets/templates/weather.html deleted file mode 100644 index 40fdcb6..0000000 --- a/internal/assets/templates/weather.html +++ /dev/null @@ -1,29 +0,0 @@ -{{ template "widget-base.html" . }} - -{{ define "widget-content" }} -
{{ .Weather.WeatherCodeAsString }}
-
Feels like {{ .Weather.ApparentTemperature }}°{{ if eq .Units "metric" }}C{{ else }}F{{ end }}
- -
- {{ range $i, $column := .Weather.Columns }} -
- {{ if $column.HasPrecipitation }} -
- {{ end }} - {{ if and (ge $i $.Weather.SunriseColumn) (le $i $.Weather.SunsetColumn ) }} -
- {{ end }} -
{{ $column.Temperature | absInt }}
-
-
{{ index $.TimeLabels $i }}
-
- {{ end }} -
- -{{ if not .HideLocation }} -
-
-
{{ .Place.Name }},{{ if .ShowAreaName }} {{ .Place.Area }},{{ end }} {{ .Place.Country }}
-
-{{ end }} -{{ end }} diff --git a/internal/assets/templates/widget-base.html b/internal/assets/templates/widget-base.html deleted file mode 100644 index e37d53f..0000000 --- a/internal/assets/templates/widget-base.html +++ /dev/null @@ -1,21 +0,0 @@ -
-
-
{{ .Title }}
- {{ if and .Error .ContentAvailable }} -
- {{ else if .Notice }} -
- {{ end }} -
-
- {{ if .ContentAvailable }} - {{ block "widget-content" . }}{{ end }} - {{ else }} -
-
ERROR
-
-
-

{{ if .Error }}{{ .Error }}{{ else }}No error information provided{{ end }}

- {{ end}} -
-
diff --git a/internal/feed/calendar.go b/internal/feed/calendar.go deleted file mode 100644 index f7ec5d4..0000000 --- a/internal/feed/calendar.go +++ /dev/null @@ -1,53 +0,0 @@ -package feed - -import "time" - -// TODO: very inflexible, refactor to allow more customizability -// TODO: allow changing first day of week -// TODO: allow changing between showing the previous and next week and the entire month -func NewCalendar(now time.Time) *Calendar { - year, week := now.ISOWeek() - weekday := now.Weekday() - - if weekday == 0 { - weekday = 7 - } - - currentMonthDays := daysInMonth(now.Month(), year) - - var previousMonthDays int - - if previousMonthNumber := now.Month() - 1; previousMonthNumber < 1 { - previousMonthDays = daysInMonth(12, year-1) - } else { - previousMonthDays = daysInMonth(previousMonthNumber, year) - } - - startDaysFrom := now.Day() - int(weekday+6) - - days := make([]int, 21) - - for i := 0; i < 21; i++ { - day := startDaysFrom + i - - if day < 1 { - day = previousMonthDays + day - } else if day > currentMonthDays { - day = day - currentMonthDays - } - - days[i] = day - } - - return &Calendar{ - CurrentDay: now.Day(), - CurrentWeekNumber: week, - CurrentMonthName: now.Month().String(), - CurrentYear: year, - Days: days, - } -} - -func daysInMonth(m time.Month, year int) int { - return time.Date(year, m+1, 0, 0, 0, 0, 0, time.UTC).Day() -} diff --git a/internal/feed/extension.go b/internal/feed/extension.go deleted file mode 100644 index 3aa499a..0000000 --- a/internal/feed/extension.go +++ /dev/null @@ -1,97 +0,0 @@ -package feed - -import ( - "fmt" - "html" - "html/template" - "io" - "log/slog" - "net/http" - "net/url" -) - -type ExtensionType int - -const ( - ExtensionContentHTML ExtensionType = iota - ExtensionContentUnknown = iota -) - -var ExtensionStringToType = map[string]ExtensionType{ - "html": ExtensionContentHTML, -} - -const ( - ExtensionHeaderTitle = "Widget-Title" - ExtensionHeaderContentType = "Widget-Content-Type" -) - -type ExtensionRequestOptions struct { - URL string `yaml:"url"` - Parameters map[string]string `yaml:"parameters"` - AllowHtml bool `yaml:"allow-potentially-dangerous-html"` -} - -type Extension struct { - Title string - Content template.HTML -} - -func convertExtensionContent(options ExtensionRequestOptions, content []byte, contentType ExtensionType) template.HTML { - switch contentType { - case ExtensionContentHTML: - if options.AllowHtml { - return template.HTML(content) - } - - fallthrough - default: - return template.HTML(html.EscapeString(string(content))) - } -} - -func FetchExtension(options ExtensionRequestOptions) (Extension, error) { - request, _ := http.NewRequest("GET", options.URL, nil) - - query := url.Values{} - - for key, value := range options.Parameters { - query.Set(key, value) - } - - request.URL.RawQuery = query.Encode() - - response, err := http.DefaultClient.Do(request) - - if err != nil { - slog.Error("failed fetching extension", "error", err, "url", options.URL) - return Extension{}, fmt.Errorf("%w: request failed: %w", ErrNoContent, err) - } - - defer response.Body.Close() - - body, err := io.ReadAll(response.Body) - - if err != nil { - slog.Error("failed reading response body of extension", "error", err, "url", options.URL) - return Extension{}, fmt.Errorf("%w: could not read body: %w", ErrNoContent, err) - } - - extension := Extension{} - - if response.Header.Get(ExtensionHeaderTitle) == "" { - extension.Title = "Extension" - } else { - extension.Title = response.Header.Get(ExtensionHeaderTitle) - } - - contentType, ok := ExtensionStringToType[response.Header.Get(ExtensionHeaderContentType)] - - if !ok { - contentType = ExtensionContentUnknown - } - - extension.Content = convertExtensionContent(options, body, contentType) - - return extension, nil -} diff --git a/internal/feed/github.go b/internal/feed/github.go deleted file mode 100644 index 4d7dc73..0000000 --- a/internal/feed/github.go +++ /dev/null @@ -1,229 +0,0 @@ -package feed - -import ( - "fmt" - "log/slog" - "net/http" - "sync" - "time" -) - -type githubReleaseLatestResponseJson struct { - TagName string `json:"tag_name"` - PublishedAt string `json:"published_at"` - HtmlUrl string `json:"html_url"` - Reactions struct { - Downvotes int `json:"-1"` - } `json:"reactions"` -} - -func parseGithubTime(t string) time.Time { - parsedTime, err := time.Parse("2006-01-02T15:04:05Z", t) - - if err != nil { - return time.Now() - } - - return parsedTime -} - -func FetchLatestReleasesFromGithub(repositories []string, token string) (AppReleases, error) { - appReleases := make(AppReleases, 0, len(repositories)) - - if len(repositories) == 0 { - return appReleases, nil - } - - requests := make([]*http.Request, len(repositories)) - - for i, repository := range repositories { - request, _ := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/repos/%s/releases/latest", repository), nil) - - if token != "" { - request.Header.Add("Authorization", fmt.Sprintf("Bearer %s", token)) - } - - requests[i] = request - } - - task := decodeJsonFromRequestTask[githubReleaseLatestResponseJson](defaultClient) - job := newJob(task, requests).withWorkers(15) - responses, errs, err := workerPoolDo(job) - - if err != nil { - return nil, err - } - - var failed int - - for i := range responses { - if errs[i] != nil { - failed++ - slog.Error("Failed to fetch or parse github release", "error", errs[i], "url", requests[i].URL) - continue - } - - liveRelease := &responses[i] - - if liveRelease == nil { - slog.Error("No live release found", "repository", repositories[i], "url", requests[i].URL) - continue - } - - version := liveRelease.TagName - - if version[0] != 'v' { - version = "v" + version - } - - appReleases = append(appReleases, AppRelease{ - Name: repositories[i], - Version: version, - NotesUrl: liveRelease.HtmlUrl, - TimeReleased: parseGithubTime(liveRelease.PublishedAt), - Downvotes: liveRelease.Reactions.Downvotes, - }) - } - - if len(appReleases) == 0 { - return nil, ErrNoContent - } - - appReleases.SortByNewest() - - if failed > 0 { - return appReleases, fmt.Errorf("%w: could not get %d releases", ErrPartialContent, failed) - } - - return appReleases, nil -} - -type GithubTicket struct { - Number int - CreatedAt time.Time - Title string -} - -type RepositoryDetails struct { - Name string - Stars int - Forks int - OpenPullRequests int - PullRequests []GithubTicket - OpenIssues int - Issues []GithubTicket -} - -type githubRepositoryDetailsResponseJson struct { - Name string `json:"full_name"` - Stars int `json:"stargazers_count"` - Forks int `json:"forks_count"` -} - -type githubTicketResponseJson struct { - Count int `json:"total_count"` - Tickets []struct { - Number int `json:"number"` - CreatedAt string `json:"created_at"` - Title string `json:"title"` - } `json:"items"` -} - -func FetchRepositoryDetailsFromGithub(repository string, token string, maxPRs int, maxIssues int) (RepositoryDetails, error) { - repositoryRequest, err := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/repos/%s", repository), nil) - - if err != nil { - return RepositoryDetails{}, fmt.Errorf("%w: could not create request with repository: %v", ErrNoContent, err) - } - - PRsRequest, _ := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/search/issues?q=is:pr+is:open+repo:%s&per_page=%d", repository, maxPRs), nil) - issuesRequest, _ := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/search/issues?q=is:issue+is:open+repo:%s&per_page=%d", repository, maxIssues), nil) - - if token != "" { - token = fmt.Sprintf("Bearer %s", token) - repositoryRequest.Header.Add("Authorization", token) - PRsRequest.Header.Add("Authorization", token) - issuesRequest.Header.Add("Authorization", token) - } - - var detailsResponse githubRepositoryDetailsResponseJson - var detailsErr error - var PRsResponse githubTicketResponseJson - var PRsErr error - var issuesResponse githubTicketResponseJson - var issuesErr error - var wg sync.WaitGroup - - wg.Add(1) - go (func() { - defer wg.Done() - detailsResponse, detailsErr = decodeJsonFromRequest[githubRepositoryDetailsResponseJson](defaultClient, repositoryRequest) - })() - - if maxPRs > 0 { - wg.Add(1) - go (func() { - defer wg.Done() - PRsResponse, PRsErr = decodeJsonFromRequest[githubTicketResponseJson](defaultClient, PRsRequest) - })() - } - - if maxIssues > 0 { - wg.Add(1) - go (func() { - defer wg.Done() - issuesResponse, issuesErr = decodeJsonFromRequest[githubTicketResponseJson](defaultClient, issuesRequest) - })() - } - - wg.Wait() - - if detailsErr != nil { - return RepositoryDetails{}, fmt.Errorf("%w: could not get repository details: %s", ErrNoContent, detailsErr) - } - - details := RepositoryDetails{ - Name: detailsResponse.Name, - Stars: detailsResponse.Stars, - Forks: detailsResponse.Forks, - PullRequests: make([]GithubTicket, 0, len(PRsResponse.Tickets)), - Issues: make([]GithubTicket, 0, len(issuesResponse.Tickets)), - } - - err = nil - - if maxPRs > 0 { - if PRsErr != nil { - err = fmt.Errorf("%w: could not get PRs: %s", ErrPartialContent, PRsErr) - } else { - details.OpenPullRequests = PRsResponse.Count - - for i := range PRsResponse.Tickets { - details.PullRequests = append(details.PullRequests, GithubTicket{ - Number: PRsResponse.Tickets[i].Number, - CreatedAt: parseGithubTime(PRsResponse.Tickets[i].CreatedAt), - Title: PRsResponse.Tickets[i].Title, - }) - } - } - } - - if maxIssues > 0 { - if issuesErr != nil { - // TODO: fix, overwriting the previous error - err = fmt.Errorf("%w: could not get issues: %s", ErrPartialContent, issuesErr) - } else { - details.OpenIssues = issuesResponse.Count - - for i := range issuesResponse.Tickets { - details.Issues = append(details.Issues, GithubTicket{ - Number: issuesResponse.Tickets[i].Number, - CreatedAt: parseGithubTime(issuesResponse.Tickets[i].CreatedAt), - Title: issuesResponse.Tickets[i].Title, - }) - } - } - } - - return details, err -} diff --git a/internal/feed/hacker-news.go b/internal/feed/hacker-news.go deleted file mode 100644 index f1db111..0000000 --- a/internal/feed/hacker-news.go +++ /dev/null @@ -1,98 +0,0 @@ -package feed - -import ( - "fmt" - "log/slog" - "net/http" - "strconv" - "strings" - "time" -) - -type hackerNewsPostResponseJson struct { - Id int `json:"id"` - Score int `json:"score"` - Title string `json:"title"` - TargetUrl string `json:"url,omitempty"` - CommentCount int `json:"descendants"` - TimePosted int64 `json:"time"` -} - -func getHackerNewsPostIds(sort string) ([]int, error) { - request, _ := http.NewRequest("GET", fmt.Sprintf("https://hacker-news.firebaseio.com/v0/%sstories.json", sort), nil) - response, err := decodeJsonFromRequest[[]int](defaultClient, request) - - if err != nil { - return nil, fmt.Errorf("%w: could not fetch list of post IDs", ErrNoContent) - } - - return response, nil -} - -func getHackerNewsPostsFromIds(postIds []int, commentsUrlTemplate string) (ForumPosts, error) { - requests := make([]*http.Request, len(postIds)) - - for i, id := range postIds { - request, _ := http.NewRequest("GET", fmt.Sprintf("https://hacker-news.firebaseio.com/v0/item/%d.json", id), nil) - requests[i] = request - } - - task := decodeJsonFromRequestTask[hackerNewsPostResponseJson](defaultClient) - job := newJob(task, requests).withWorkers(30) - results, errs, err := workerPoolDo(job) - - if err != nil { - return nil, err - } - - posts := make(ForumPosts, 0, len(postIds)) - - for i := range results { - if errs[i] != nil { - slog.Error("Failed to fetch or parse hacker news post", "error", errs[i], "url", requests[i].URL) - continue - } - - var commentsUrl string - - if commentsUrlTemplate == "" { - commentsUrl = "https://news.ycombinator.com/item?id=" + strconv.Itoa(results[i].Id) - } else { - commentsUrl = strings.ReplaceAll(commentsUrlTemplate, "{POST-ID}", strconv.Itoa(results[i].Id)) - } - - posts = append(posts, ForumPost{ - Title: results[i].Title, - DiscussionUrl: commentsUrl, - TargetUrl: results[i].TargetUrl, - TargetUrlDomain: extractDomainFromUrl(results[i].TargetUrl), - CommentCount: results[i].CommentCount, - Score: results[i].Score, - TimePosted: time.Unix(results[i].TimePosted, 0), - }) - } - - if len(posts) == 0 { - return nil, ErrNoContent - } - - if len(posts) != len(postIds) { - return posts, fmt.Errorf("%w could not fetch some hacker news posts", ErrPartialContent) - } - - return posts, nil -} - -func FetchHackerNewsPosts(sort string, limit int, commentsUrlTemplate string) (ForumPosts, error) { - postIds, err := getHackerNewsPostIds(sort) - - if err != nil { - return nil, err - } - - if len(postIds) > limit { - postIds = postIds[:limit] - } - - return getHackerNewsPostsFromIds(postIds, commentsUrlTemplate) -} diff --git a/internal/feed/lobsters.go b/internal/feed/lobsters.go deleted file mode 100644 index e103f56..0000000 --- a/internal/feed/lobsters.go +++ /dev/null @@ -1,81 +0,0 @@ -package feed - -import ( - "net/http" - "strings" - "time" -) - -type lobstersPostResponseJson struct { - CreatedAt string `json:"created_at"` - Title string `json:"title"` - URL string `json:"url"` - Score int `json:"score"` - CommentCount int `json:"comment_count"` - CommentsURL string `json:"comments_url"` - Tags []string `json:"tags"` -} - -type lobstersFeedResponseJson []lobstersPostResponseJson - -func getLobstersPostsFromFeed(feedUrl string) (ForumPosts, error) { - request, err := http.NewRequest("GET", feedUrl, nil) - - if err != nil { - return nil, err - } - - feed, err := decodeJsonFromRequest[lobstersFeedResponseJson](defaultClient, request) - - if err != nil { - return nil, err - } - - posts := make(ForumPosts, 0, len(feed)) - - for i := range feed { - createdAt, _ := time.Parse(time.RFC3339, feed[i].CreatedAt) - - posts = append(posts, ForumPost{ - Title: feed[i].Title, - DiscussionUrl: feed[i].CommentsURL, - TargetUrl: feed[i].URL, - TargetUrlDomain: extractDomainFromUrl(feed[i].URL), - CommentCount: feed[i].CommentCount, - Score: feed[i].Score, - TimePosted: createdAt, - Tags: feed[i].Tags, - }) - } - - if len(posts) == 0 { - return nil, ErrNoContent - } - - return posts, nil -} - -func FetchLobstersPosts(sortBy string, tags []string) (ForumPosts, error) { - var feedUrl string - - if sortBy == "hot" { - sortBy = "hottest" - } else if sortBy == "new" { - sortBy = "newest" - } - - if len(tags) == 0 { - feedUrl = "https://lobste.rs/" + sortBy + ".json" - } else { - tags := strings.Join(tags, ",") - feedUrl = "https://lobste.rs/t/" + tags + ".json" - } - - posts, err := getLobstersPostsFromFeed(feedUrl) - - if err != nil { - return nil, err - } - - return posts, nil -} diff --git a/internal/feed/monitor.go b/internal/feed/monitor.go deleted file mode 100644 index 03cdcf4..0000000 --- a/internal/feed/monitor.go +++ /dev/null @@ -1,70 +0,0 @@ -package feed - -import ( - "context" - "errors" - "net/http" - "time" -) - -type SiteStatusRequest struct { - URL string `yaml:"url"` - AllowInsecure bool `yaml:"allow-insecure"` -} - -type SiteStatus struct { - Code int - TimedOut bool - ResponseTime time.Duration - Error error -} - -func getSiteStatusTask(statusRequest *SiteStatusRequest) (SiteStatus, error) { - request, err := http.NewRequest(http.MethodGet, statusRequest.URL, nil) - - if err != nil { - return SiteStatus{ - Error: err, - }, nil - } - - ctx, cancel := context.WithTimeout(context.Background(), time.Second*3) - defer cancel() - request = request.WithContext(ctx) - requestSentAt := time.Now() - var response *http.Response - - if !statusRequest.AllowInsecure { - response, err = defaultClient.Do(request) - } else { - response, err = defaultInsecureClient.Do(request) - } - - status := SiteStatus{ResponseTime: time.Since(requestSentAt)} - - if err != nil { - if errors.Is(err, context.DeadlineExceeded) { - status.TimedOut = true - } - - status.Error = err - return status, nil - } - - defer response.Body.Close() - - status.Code = response.StatusCode - - return status, nil -} - -func FetchStatusForSites(requests []*SiteStatusRequest) ([]SiteStatus, error) { - job := newJob(getSiteStatusTask, requests).withWorkers(20) - results, _, err := workerPoolDo(job) - - if err != nil { - return nil, err - } - - return results, nil -} diff --git a/internal/feed/primitives.go b/internal/feed/primitives.go deleted file mode 100644 index 6e0c98f..0000000 --- a/internal/feed/primitives.go +++ /dev/null @@ -1,216 +0,0 @@ -package feed - -import ( - "math" - "sort" - "time" -) - -type ForumPost struct { - Title string - DiscussionUrl string - TargetUrl string - TargetUrlDomain string - ThumbnailUrl string - CommentCount int - Score int - Engagement float64 - TimePosted time.Time - Tags []string -} - -type ForumPosts []ForumPost - -type Calendar struct { - CurrentDay int - CurrentWeekNumber int - CurrentMonthName string - CurrentYear int - Days []int -} - -type Weather struct { - Temperature int - ApparentTemperature int - WeatherCode int - CurrentColumn int - SunriseColumn int - SunsetColumn int - Columns []weatherColumn -} - -type AppRelease struct { - Name string - Version string - NotesUrl string - TimeReleased time.Time - Downvotes int -} - -type AppReleases []AppRelease - -type Video struct { - ThumbnailUrl string - Title string - Url string - Author string - AuthorUrl string - TimePosted time.Time -} - -type Videos []Video - -var currencyToSymbol = map[string]string{ - "USD": "$", - "EUR": "€", - "JPY": "¥", - "CAD": "C$", - "AUD": "A$", - "GBP": "£", - "CHF": "Fr", - "NZD": "N$", - "INR": "₹", - "BRL": "R$", - "RUB": "₽", - "TRY": "₺", - "ZAR": "R", - "CNY": "¥", - "KRW": "₩", - "HKD": "HK$", - "SGD": "S$", - "SEK": "kr", - "NOK": "kr", - "DKK": "kr", - "PLN": "zł", - "PHP": "₱", -} - -type MarketRequest struct { - Name string `yaml:"name"` - Symbol string `yaml:"symbol"` - ChartLink string `yaml:"chart-link"` - SymbolLink string `yaml:"symbol-link"` -} - -type Market struct { - MarketRequest - Currency string `yaml:"-"` - Price float64 `yaml:"-"` - PercentChange float64 `yaml:"-"` - SvgChartPoints string `yaml:"-"` -} - -type Markets []Market - -func (t Markets) SortByAbsChange() { - sort.Slice(t, func(i, j int) bool { - return math.Abs(t[i].PercentChange) > math.Abs(t[j].PercentChange) - }) -} - -var weatherCodeTable = map[int]string{ - 0: "Clear Sky", - 1: "Mainly Clear", - 2: "Partly Cloudy", - 3: "Overcast", - 45: "Fog", - 48: "Rime Fog", - 51: "Drizzle", - 53: "Drizzle", - 55: "Drizzle", - 56: "Drizzle", - 57: "Drizzle", - 61: "Rain", - 63: "Moderate Rain", - 65: "Heavy Rain", - 66: "Freezing Rain", - 67: "Freezing Rain", - 71: "Snow", - 73: "Moderate Snow", - 75: "Heavy Snow", - 77: "Snow Grains", - 80: "Rain", - 81: "Moderate Rain", - 82: "Heavy Rain", - 85: "Snow", - 86: "Snow", - 95: "Thunderstorm", - 96: "Thunderstorm", - 99: "Thunderstorm", -} - -func (w *Weather) WeatherCodeAsString() string { - if weatherCode, ok := weatherCodeTable[w.WeatherCode]; ok { - return weatherCode - } - - return "" -} - -const depreciatePostsOlderThanHours = 7 -const maxDepreciation = 0.9 -const maxDepreciationAfterHours = 24 - -func (p ForumPosts) CalculateEngagement() { - var totalComments int - var totalScore int - - for i := range p { - totalComments += p[i].CommentCount - totalScore += p[i].Score - } - - numberOfPosts := float64(len(p)) - averageComments := float64(totalComments) / numberOfPosts - averageScore := float64(totalScore) / numberOfPosts - - for i := range p { - p[i].Engagement = (float64(p[i].CommentCount)/averageComments + float64(p[i].Score)/averageScore) / 2 - - elapsed := time.Since(p[i].TimePosted) - - if elapsed < time.Hour*depreciatePostsOlderThanHours { - continue - } - - p[i].Engagement *= 1.0 - (math.Max(elapsed.Hours()-depreciatePostsOlderThanHours, maxDepreciationAfterHours)/maxDepreciationAfterHours)*maxDepreciation - } -} - -func (p ForumPosts) SortByEngagement() { - sort.Slice(p, func(i, j int) bool { - return p[i].Engagement > p[j].Engagement - }) -} - -func (s *ForumPost) HasTargetUrl() bool { - return s.TargetUrl != "" -} - -func (p ForumPosts) FilterPostedBefore(postedBefore time.Duration) []ForumPost { - recent := make([]ForumPost, 0, len(p)) - - for i := range p { - if time.Since(p[i].TimePosted) < postedBefore { - recent = append(recent, p[i]) - } - } - - return recent -} - -func (r AppReleases) SortByNewest() AppReleases { - sort.Slice(r, func(i, j int) bool { - return r[i].TimeReleased.After(r[j].TimeReleased) - }) - - return r -} - -func (v Videos) SortByNewest() Videos { - sort.Slice(v, func(i, j int) bool { - return v[i].TimePosted.After(v[j].TimePosted) - }) - - return v -} diff --git a/internal/feed/reddit.go b/internal/feed/reddit.go deleted file mode 100644 index 676d948..0000000 --- a/internal/feed/reddit.go +++ /dev/null @@ -1,114 +0,0 @@ -package feed - -import ( - "fmt" - "html" - "net/http" - "net/url" - "strings" - "time" -) - -type subredditResponseJson struct { - Data struct { - Children []struct { - Data struct { - Id string `json:"id"` - Title string `json:"title"` - Upvotes int `json:"ups"` - Url string `json:"url"` - Time float64 `json:"created"` - CommentsCount int `json:"num_comments"` - Domain string `json:"domain"` - Permalink string `json:"permalink"` - Stickied bool `json:"stickied"` - Pinned bool `json:"pinned"` - IsSelf bool `json:"is_self"` - Thumbnail string `json:"thumbnail"` - } `json:"data"` - } `json:"children"` - } `json:"data"` -} - -func FetchSubredditPosts(subreddit, sort, topPeriod, search, commentsUrlTemplate, requestUrlTemplate string) (ForumPosts, error) { - query := url.Values{} - var requestUrl string - - if search != "" { - query.Set("q", search+" subreddit:"+subreddit) - query.Set("sort", sort) - } - - if sort == "top" { - query.Set("t", topPeriod) - } - - if search != "" { - requestUrl = fmt.Sprintf("https://www.reddit.com/search.json?%s", query.Encode()) - } else { - requestUrl = fmt.Sprintf("https://www.reddit.com/r/%s/%s.json?%s", subreddit, sort, query.Encode()) - } - - if requestUrlTemplate != "" { - requestUrl = strings.ReplaceAll(requestUrlTemplate, "{REQUEST-URL}", requestUrl) - } - - request, err := http.NewRequest("GET", requestUrl, nil) - - if err != nil { - return nil, err - } - - // Required to increase rate limit, otherwise Reddit randomly returns 429 even after just 2 requests - addBrowserUserAgentHeader(request) - responseJson, err := decodeJsonFromRequest[subredditResponseJson](defaultClient, request) - - if err != nil { - return nil, err - } - - if len(responseJson.Data.Children) == 0 { - return nil, fmt.Errorf("no posts found") - } - - posts := make(ForumPosts, 0, len(responseJson.Data.Children)) - - for i := range responseJson.Data.Children { - post := &responseJson.Data.Children[i].Data - - if post.Stickied || post.Pinned { - continue - } - - var commentsUrl string - - if commentsUrlTemplate == "" { - commentsUrl = "https://www.reddit.com" + post.Permalink - } else { - commentsUrl = strings.ReplaceAll(commentsUrlTemplate, "{SUBREDDIT}", subreddit) - commentsUrl = strings.ReplaceAll(commentsUrl, "{POST-ID}", post.Id) - commentsUrl = strings.ReplaceAll(commentsUrl, "{POST-PATH}", strings.TrimLeft(post.Permalink, "/")) - } - - forumPost := ForumPost{ - Title: html.UnescapeString(post.Title), - DiscussionUrl: commentsUrl, - TargetUrlDomain: post.Domain, - CommentCount: post.CommentsCount, - Score: post.Upvotes, - TimePosted: time.Unix(int64(post.Time), 0), - } - - if post.Thumbnail != "" && post.Thumbnail != "self" && post.Thumbnail != "default" { - forumPost.ThumbnailUrl = post.Thumbnail - } - - if !post.IsSelf { - forumPost.TargetUrl = post.Url - } - - posts = append(posts, forumPost) - } - - return posts, nil -} diff --git a/internal/feed/rss.go b/internal/feed/rss.go deleted file mode 100644 index 74f064b..0000000 --- a/internal/feed/rss.go +++ /dev/null @@ -1,230 +0,0 @@ -package feed - -import ( - "context" - "fmt" - "html" - "log/slog" - "net/url" - "regexp" - "sort" - "strings" - "time" - - "github.com/mmcdole/gofeed" - gofeedext "github.com/mmcdole/gofeed/extensions" -) - -type RSSFeedItem struct { - ChannelName string - ChannelURL string - Title string - Link string - ImageURL string - Categories []string - Description string - PublishedAt time.Time -} - -// doesn't cover all cases but works the vast majority of the time -var htmlTagsWithAttributesPattern = regexp.MustCompile(`<\/?[a-zA-Z0-9-]+ *(?:[a-zA-Z-]+=(?:"|').*?(?:"|') ?)* *\/?>`) -var sequentialWhitespacePattern = regexp.MustCompile(`\s+`) - -func sanitizeFeedDescription(description string) string { - if description == "" { - return "" - } - - description = strings.ReplaceAll(description, "\n", " ") - description = htmlTagsWithAttributesPattern.ReplaceAllString(description, "") - description = sequentialWhitespacePattern.ReplaceAllString(description, " ") - description = strings.TrimSpace(description) - description = html.UnescapeString(description) - - return description -} - -type RSSFeedRequest struct { - Url string `yaml:"url"` - Title string `yaml:"title"` - HideCategories bool `yaml:"hide-categories"` - HideDescription bool `yaml:"hide-description"` - ItemLinkPrefix string `yaml:"item-link-prefix"` -} - -type RSSFeedItems []RSSFeedItem - -func (f RSSFeedItems) SortByNewest() RSSFeedItems { - sort.Slice(f, func(i, j int) bool { - return f[i].PublishedAt.After(f[j].PublishedAt) - }) - - return f -} - -var feedParser = gofeed.NewParser() - -func getItemsFromRSSFeedTask(request RSSFeedRequest) ([]RSSFeedItem, error) { - ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) - defer cancel() - - feed, err := feedParser.ParseURLWithContext(request.Url, ctx) - - if err != nil { - return nil, err - } - - items := make(RSSFeedItems, 0, len(feed.Items)) - - for i := range feed.Items { - item := feed.Items[i] - - rssItem := RSSFeedItem{ - ChannelURL: feed.Link, - Title: item.Title, - } - - if request.ItemLinkPrefix != "" { - rssItem.Link = request.ItemLinkPrefix + item.Link - } else if strings.HasPrefix(item.Link, "http://") || strings.HasPrefix(item.Link, "https://") { - rssItem.Link = item.Link - } else { - parsedUrl, err := url.Parse(feed.Link) - - if err != nil { - parsedUrl, err = url.Parse(request.Url) - } - - if err == nil { - var link string - - if item.Link[0] == '/' { - link = item.Link - } else { - link = "/" + item.Link - } - - rssItem.Link = parsedUrl.Scheme + "://" + parsedUrl.Host + link - } - } - - if !request.HideDescription && item.Description != "" { - description, _ := limitStringLength(item.Description, 1000) - description = sanitizeFeedDescription(description) - description, limited := limitStringLength(description, 200) - - if limited { - description += "…" - } - - rssItem.Description = description - } - - if !request.HideCategories { - var categories = make([]string, 0, 6) - - for _, category := range item.Categories { - if len(categories) == 6 { - break - } - - if len(category) == 0 || len(category) > 30 { - continue - } - - categories = append(categories, category) - } - - rssItem.Categories = categories - } - - if request.Title != "" { - rssItem.ChannelName = request.Title - } else { - rssItem.ChannelName = feed.Title - } - - if item.Image != nil { - rssItem.ImageURL = item.Image.URL - } else if url := findThumbnailInItemExtensions(item); url != "" { - rssItem.ImageURL = url - } else if feed.Image != nil { - rssItem.ImageURL = feed.Image.URL - } - - if item.PublishedParsed != nil { - rssItem.PublishedAt = *item.PublishedParsed - } else { - rssItem.PublishedAt = time.Now() - } - - items = append(items, rssItem) - } - - return items, nil -} - -func recursiveFindThumbnailInExtensions(extensions map[string][]gofeedext.Extension) string { - for _, exts := range extensions { - for _, ext := range exts { - if ext.Name == "thumbnail" || ext.Name == "image" { - if url, ok := ext.Attrs["url"]; ok { - return url - } - } - - if ext.Children != nil { - if url := recursiveFindThumbnailInExtensions(ext.Children); url != "" { - return url - } - } - } - } - - return "" -} - -func findThumbnailInItemExtensions(item *gofeed.Item) string { - media, ok := item.Extensions["media"] - - if !ok { - return "" - } - - return recursiveFindThumbnailInExtensions(media) -} - -func GetItemsFromRSSFeeds(requests []RSSFeedRequest) (RSSFeedItems, error) { - job := newJob(getItemsFromRSSFeedTask, requests).withWorkers(10) - feeds, errs, err := workerPoolDo(job) - - if err != nil { - return nil, fmt.Errorf("%w: %v", ErrNoContent, err) - } - - failed := 0 - - entries := make(RSSFeedItems, 0, len(feeds)*10) - - for i := range feeds { - if errs[i] != nil { - failed++ - slog.Error("failed to get rss feed", "error", errs[i], "url", requests[i].Url) - continue - } - - entries = append(entries, feeds[i]...) - } - - if len(entries) == 0 { - return nil, ErrNoContent - } - - entries.SortByNewest() - - if failed > 0 { - return entries, fmt.Errorf("%w: missing %d RSS feeds", ErrPartialContent, failed) - } - - return entries, nil -} diff --git a/internal/feed/twitch.go b/internal/feed/twitch.go deleted file mode 100644 index 1ce9354..0000000 --- a/internal/feed/twitch.go +++ /dev/null @@ -1,254 +0,0 @@ -package feed - -import ( - "encoding/json" - "errors" - "fmt" - "log/slog" - "net/http" - "slices" - "sort" - "strings" - "time" -) - -type TwitchCategory struct { - Slug string `json:"slug"` - Name string `json:"name"` - AvatarUrl string `json:"avatarURL"` - ViewersCount int `json:"viewersCount"` - Tags []struct { - Name string `json:"tagName"` - } `json:"tags"` - GameReleaseDate string `json:"originalReleaseDate"` - IsNew bool `json:"-"` -} - -type TwitchChannel struct { - Login string - Exists bool - Name string - AvatarUrl string - IsLive bool - LiveSince time.Time - Category string - CategorySlug string - ViewersCount int -} - -type TwitchChannels []TwitchChannel - -func (channels TwitchChannels) SortByViewers() { - sort.Slice(channels, func(i, j int) bool { - return channels[i].ViewersCount > channels[j].ViewersCount - }) -} - -func (channels TwitchChannels) SortByLive() { - sort.SliceStable(channels, func(i, j int) bool { - return channels[i].IsLive && !channels[j].IsLive - }) -} - -type twitchOperationResponse struct { - Data json.RawMessage - Extensions struct { - OperationName string `json:"operationName"` - } -} - -type twitchChannelShellOperationResponse struct { - UserOrError struct { - Type string `json:"__typename"` - DisplayName string `json:"displayName"` - ProfileImageUrl string `json:"profileImageURL"` - Stream *struct { - ViewersCount int `json:"viewersCount"` - } - } `json:"userOrError"` -} - -type twitchStreamMetadataOperationResponse struct { - UserOrNull *struct { - Stream *struct { - StartedAt string `json:"createdAt"` - Game *struct { - Slug string `json:"slug"` - Name string `json:"name"` - } `json:"game"` - } `json:"stream"` - } `json:"user"` -} - -type twitchDirectoriesOperationResponse struct { - Data struct { - DirectoriesWithTags struct { - Edges []struct { - Node TwitchCategory `json:"node"` - } `json:"edges"` - } `json:"directoriesWithTags"` - } `json:"data"` -} - -const twitchGqlEndpoint = "https://gql.twitch.tv/gql" -const twitchGqlClientId = "kimne78kx3ncx6brgo4mv6wki5h1ko" - -const twitchDirectoriesOperationRequestBody = `[{"operationName": "BrowsePage_AllDirectories","variables": {"limit": %d,"options": {"sort": "VIEWER_COUNT","tags": []}},"extensions": {"persistedQuery": {"version": 1,"sha256Hash": "2f67f71ba89f3c0ed26a141ec00da1defecb2303595f5cda4298169549783d9e"}}}]` - -func FetchTopGamesFromTwitch(exclude []string, limit int) ([]TwitchCategory, error) { - reader := strings.NewReader(fmt.Sprintf(twitchDirectoriesOperationRequestBody, len(exclude)+limit)) - request, _ := http.NewRequest("POST", twitchGqlEndpoint, reader) - request.Header.Add("Client-ID", twitchGqlClientId) - response, err := decodeJsonFromRequest[[]twitchDirectoriesOperationResponse](defaultClient, request) - - if err != nil { - return nil, err - } - - if len(response) == 0 { - return nil, errors.New("no categories could be retrieved") - } - - edges := (response)[0].Data.DirectoriesWithTags.Edges - categories := make([]TwitchCategory, 0, len(edges)) - - for i := range edges { - if slices.Contains(exclude, edges[i].Node.Slug) { - continue - } - - category := &edges[i].Node - category.AvatarUrl = strings.Replace(category.AvatarUrl, "285x380", "144x192", 1) - - if len(category.Tags) > 2 { - category.Tags = category.Tags[:2] - } - - gameReleasedDate, err := time.Parse("2006-01-02T15:04:05Z", category.GameReleaseDate) - - if err == nil { - if time.Since(gameReleasedDate) < 14*24*time.Hour { - category.IsNew = true - } - } - - categories = append(categories, *category) - } - - if len(categories) > limit { - categories = categories[:limit] - } - - return categories, nil -} - -const twitchChannelStatusOperationRequestBody = `[{"operationName":"ChannelShell","variables":{"login":"%s"},"extensions":{"persistedQuery":{"version":1,"sha256Hash":"580ab410bcd0c1ad194224957ae2241e5d252b2c5173d8e0cce9d32d5bb14efe"}}},{"operationName":"StreamMetadata","variables":{"channelLogin":"%s"},"extensions":{"persistedQuery":{"version":1,"sha256Hash":"676ee2f834ede42eb4514cdb432b3134fefc12590080c9a2c9bb44a2a4a63266"}}}]` - -// TODO: rework -// The operations for multiple channels can all be sent in a single request -// rather than sending a separate request for each channel. Need to figure out -// what the limit is for max operations per request and batch operations in -// multiple requests if number of channels exceeds allowed limit. - -func fetchChannelFromTwitchTask(channel string) (TwitchChannel, error) { - result := TwitchChannel{ - Login: strings.ToLower(channel), - } - - reader := strings.NewReader(fmt.Sprintf(twitchChannelStatusOperationRequestBody, channel, channel)) - request, _ := http.NewRequest("POST", twitchGqlEndpoint, reader) - request.Header.Add("Client-ID", twitchGqlClientId) - - response, err := decodeJsonFromRequest[[]twitchOperationResponse](defaultClient, request) - - if err != nil { - return result, err - } - - if len(response) != 2 { - return result, fmt.Errorf("expected 2 operation responses, got %d", len(response)) - } - - var channelShell twitchChannelShellOperationResponse - var streamMetadata twitchStreamMetadataOperationResponse - - for i := range response { - switch response[i].Extensions.OperationName { - case "ChannelShell": - err = json.Unmarshal(response[i].Data, &channelShell) - - if err != nil { - return result, fmt.Errorf("failed to unmarshal channel shell: %w", err) - } - case "StreamMetadata": - err = json.Unmarshal(response[i].Data, &streamMetadata) - - if err != nil { - return result, fmt.Errorf("failed to unmarshal stream metadata: %w", err) - } - default: - return result, fmt.Errorf("unknown operation name: %s", response[i].Extensions.OperationName) - } - } - - if channelShell.UserOrError.Type != "User" { - result.Name = result.Login - return result, nil - } - - result.Exists = true - result.Name = channelShell.UserOrError.DisplayName - result.AvatarUrl = channelShell.UserOrError.ProfileImageUrl - - if channelShell.UserOrError.Stream != nil { - result.IsLive = true - result.ViewersCount = channelShell.UserOrError.Stream.ViewersCount - - if streamMetadata.UserOrNull != nil && streamMetadata.UserOrNull.Stream != nil && streamMetadata.UserOrNull.Stream.Game != nil { - result.Category = streamMetadata.UserOrNull.Stream.Game.Name - result.CategorySlug = streamMetadata.UserOrNull.Stream.Game.Slug - startedAt, err := time.Parse("2006-01-02T15:04:05Z", streamMetadata.UserOrNull.Stream.StartedAt) - - if err == nil { - result.LiveSince = startedAt - } else { - slog.Warn("failed to parse twitch stream started at", "error", err, "started_at", streamMetadata.UserOrNull.Stream.StartedAt) - } - } - } - - return result, nil -} - -func FetchChannelsFromTwitch(channelLogins []string) (TwitchChannels, error) { - result := make(TwitchChannels, 0, len(channelLogins)) - - job := newJob(fetchChannelFromTwitchTask, channelLogins).withWorkers(10) - channels, errs, err := workerPoolDo(job) - - if err != nil { - return result, err - } - - var failed int - - for i := range channels { - if errs[i] != nil { - failed++ - slog.Warn("failed to fetch twitch channel", "channel", channelLogins[i], "error", errs[i]) - continue - } - - result = append(result, channels[i]) - } - - if failed == len(channelLogins) { - return result, ErrNoContent - } - - if failed > 0 { - return result, fmt.Errorf("%w: failed to fetch %d channels", ErrPartialContent, failed) - } - - return result, nil -} diff --git a/internal/feed/utils.go b/internal/feed/utils.go deleted file mode 100644 index 16c376b..0000000 --- a/internal/feed/utils.go +++ /dev/null @@ -1,97 +0,0 @@ -package feed - -import ( - "errors" - "fmt" - "net/url" - "regexp" - "slices" - "strings" -) - -var ( - ErrNoContent = errors.New("failed to retrieve any content") - ErrPartialContent = errors.New("failed to retrieve some of the content") -) - -func percentChange(current, previous float64) float64 { - return (current/previous - 1) * 100 -} - -func extractDomainFromUrl(u string) string { - if u == "" { - return "" - } - - parsed, err := url.Parse(u) - - if err != nil { - return "" - } - - return strings.TrimPrefix(strings.ToLower(parsed.Host), "www.") -} - -func SvgPolylineCoordsFromYValues(width float64, height float64, values []float64) string { - if len(values) < 2 { - return "" - } - - verticalPadding := height * 0.02 - height -= verticalPadding * 2 - coordinates := make([]string, len(values)) - distanceBetweenPoints := width / float64(len(values)-1) - min := slices.Min(values) - max := slices.Max(values) - - for i := range values { - coordinates[i] = fmt.Sprintf( - "%.2f,%.2f", - float64(i)*distanceBetweenPoints, - ((max-values[i])/(max-min))*height+verticalPadding, - ) - } - - return strings.Join(coordinates, " ") -} - -func maybeCopySliceWithoutZeroValues[T int | float64](values []T) []T { - if len(values) == 0 { - return values - } - - for i := range values { - if values[i] != 0 { - continue - } - - c := make([]T, 0, len(values)-1) - - for i := range values { - if values[i] != 0 { - c = append(c, values[i]) - } - } - - return c - } - - return values -} - - -var urlSchemePattern = regexp.MustCompile(`^[a-z]+:\/\/`) - -func stripURLScheme(url string) string { - return urlSchemePattern.ReplaceAllString(url, "") -} - -func limitStringLength(s string, max int) (string, bool) { - asRunes := []rune(s) - - if len(asRunes) > max { - return string(asRunes[:max]), true - } - - return s, false -} diff --git a/internal/feed/yahoo.go b/internal/feed/yahoo.go deleted file mode 100644 index f962695..0000000 --- a/internal/feed/yahoo.go +++ /dev/null @@ -1,104 +0,0 @@ -package feed - -import ( - "fmt" - "log/slog" - "net/http" -) - -type marketResponseJson struct { - Chart struct { - Result []struct { - Meta struct { - Currency string `json:"currency"` - Symbol string `json:"symbol"` - RegularMarketPrice float64 `json:"regularMarketPrice"` - ChartPreviousClose float64 `json:"chartPreviousClose"` - } `json:"meta"` - Indicators struct { - Quote []struct { - Close []float64 `json:"close,omitempty"` - } `json:"quote"` - } `json:"indicators"` - } `json:"result"` - } `json:"chart"` -} - -// TODO: allow changing chart time frame -const marketChartDays = 21 - -func FetchMarketsDataFromYahoo(marketRequests []MarketRequest) (Markets, error) { - requests := make([]*http.Request, 0, len(marketRequests)) - - for i := range marketRequests { - request, _ := http.NewRequest("GET", fmt.Sprintf("https://query1.finance.yahoo.com/v8/finance/chart/%s?range=1mo&interval=1d", marketRequests[i].Symbol), nil) - requests = append(requests, request) - } - - job := newJob(decodeJsonFromRequestTask[marketResponseJson](defaultClient), requests) - responses, errs, err := workerPoolDo(job) - - if err != nil { - return nil, fmt.Errorf("%w: %v", ErrNoContent, err) - } - - markets := make(Markets, 0, len(responses)) - var failed int - - for i := range responses { - if errs[i] != nil { - failed++ - slog.Error("Failed to fetch market data", "symbol", marketRequests[i].Symbol, "error", errs[i]) - continue - } - - response := responses[i] - - if len(response.Chart.Result) == 0 { - failed++ - slog.Error("Market response contains no data", "symbol", marketRequests[i].Symbol) - continue - } - - prices := response.Chart.Result[0].Indicators.Quote[0].Close - - if len(prices) > marketChartDays { - prices = prices[len(prices)-marketChartDays:] - } - - previous := response.Chart.Result[0].Meta.RegularMarketPrice - - if len(prices) >= 2 && prices[len(prices)-2] != 0 { - previous = prices[len(prices)-2] - } - - points := SvgPolylineCoordsFromYValues(100, 50, maybeCopySliceWithoutZeroValues(prices)) - - currency, exists := currencyToSymbol[response.Chart.Result[0].Meta.Currency] - - if !exists { - currency = response.Chart.Result[0].Meta.Currency - } - - markets = append(markets, Market{ - MarketRequest: marketRequests[i], - Price: response.Chart.Result[0].Meta.RegularMarketPrice, - Currency: currency, - PercentChange: percentChange( - response.Chart.Result[0].Meta.RegularMarketPrice, - previous, - ), - SvgChartPoints: points, - }) - } - - if len(markets) == 0 { - return nil, ErrNoContent - } - - if failed > 0 { - return markets, fmt.Errorf("%w: could not fetch data for %d market(s)", ErrPartialContent, failed) - } - - return markets, nil -} diff --git a/internal/feed/youtube.go b/internal/feed/youtube.go deleted file mode 100644 index e478259..0000000 --- a/internal/feed/youtube.go +++ /dev/null @@ -1,115 +0,0 @@ -package feed - -import ( - "fmt" - "log/slog" - "net/http" - "net/url" - "strings" - "time" -) - -type youtubeFeedResponseXml struct { - Channel string `xml:"title"` - ChannelLink struct { - Href string `xml:"href,attr"` - } `xml:"link"` - Videos []struct { - Title string `xml:"title"` - Published string `xml:"published"` - Link struct { - Href string `xml:"href,attr"` - } `xml:"link"` - - Group struct { - Thumbnail struct { - Url string `xml:"url,attr"` - } `xml:"http://search.yahoo.com/mrss/ thumbnail"` - } `xml:"http://search.yahoo.com/mrss/ group"` - } `xml:"entry"` -} - -func parseYoutubeFeedTime(t string) time.Time { - parsedTime, err := time.Parse("2006-01-02T15:04:05-07:00", t) - - if err != nil { - return time.Now() - } - - return parsedTime -} - -func FetchYoutubeChannelUploads(channelIds []string, videoUrlTemplate string) (Videos, error) { - requests := make([]*http.Request, 0, len(channelIds)) - - for i := range channelIds { - request, _ := http.NewRequest("GET", "https://www.youtube.com/feeds/videos.xml?channel_id="+channelIds[i], nil) - requests = append(requests, request) - } - - job := newJob(decodeXmlFromRequestTask[youtubeFeedResponseXml](defaultClient), requests).withWorkers(30) - - responses, errs, err := workerPoolDo(job) - - if err != nil { - return nil, fmt.Errorf("%w: %v", ErrNoContent, err) - } - - videos := make(Videos, 0, len(channelIds)*15) - - var failed int - - for i := range responses { - if errs[i] != nil { - failed++ - slog.Error("Failed to fetch youtube feed", "channel", channelIds[i], "error", errs[i]) - continue - } - - response := responses[i] - - for j := range response.Videos { - video := &response.Videos[j] - - // TODO: figure out a better way of skipping shorts - if strings.Contains(video.Title, "#shorts") { - continue - } - - var videoUrl string - - if videoUrlTemplate == "" { - videoUrl = video.Link.Href - } else { - parsedUrl, err := url.Parse(video.Link.Href) - - if err == nil { - videoUrl = strings.ReplaceAll(videoUrlTemplate, "{VIDEO-ID}", parsedUrl.Query().Get("v")) - } else { - videoUrl = "#" - } - } - - videos = append(videos, Video{ - ThumbnailUrl: video.Group.Thumbnail.Url, - Title: video.Title, - Url: videoUrl, - Author: response.Channel, - AuthorUrl: response.ChannelLink.Href + "/videos", - TimePosted: parseYoutubeFeedTime(video.Published), - }) - } - } - - if len(videos) == 0 { - return nil, ErrNoContent - } - - videos.SortByNewest() - - if failed > 0 { - return videos, fmt.Errorf("%w: missing videos from %d channels", ErrPartialContent, failed) - } - - return videos, nil -} diff --git a/internal/glance/cli.go b/internal/glance/cli.go index 5987368..f5a16fb 100644 --- a/internal/glance/cli.go +++ b/internal/glance/cli.go @@ -2,41 +2,138 @@ package glance import ( "flag" + "fmt" "os" + "strings" + + "github.com/shirou/gopsutil/v4/disk" + "github.com/shirou/gopsutil/v4/sensors" ) -type CliIntent uint8 +type cliIntent uint8 const ( - CliIntentServe CliIntent = iota - CliIntentCheckConfig = iota + cliIntentVersionPrint cliIntent = iota + cliIntentServe + cliIntentConfigValidate + cliIntentConfigPrint + cliIntentDiagnose + cliIntentSensorsPrint + cliIntentMountpointInfo ) -type CliOptions struct { - Intent CliIntent - ConfigPath string +type cliOptions struct { + intent cliIntent + configPath string + args []string } -func ParseCliOptions() (*CliOptions, error) { +func parseCliOptions() (*cliOptions, error) { + var args []string + + args = os.Args[1:] + if len(args) == 1 && (args[0] == "--version" || args[0] == "-v" || args[0] == "version") { + return &cliOptions{ + intent: cliIntentVersionPrint, + }, nil + } + flags := flag.NewFlagSet("", flag.ExitOnError) + flags.Usage = func() { + fmt.Println("Usage: glance [options] command") - checkConfig := flags.Bool("check-config", false, "Check whether the config is valid") + fmt.Println("\nOptions:") + flags.PrintDefaults() + + fmt.Println("\nCommands:") + fmt.Println(" config:validate Validate the config file") + fmt.Println(" config:print Print the parsed config file with embedded includes") + fmt.Println(" sensors:print List all sensors") + fmt.Println(" mountpoint:info Print information about a given mountpoint path") + fmt.Println(" diagnose Run diagnostic checks") + } configPath := flags.String("config", "glance.yml", "Set config path") - err := flags.Parse(os.Args[1:]) - if err != nil { return nil, err } - intent := CliIntentServe + var intent cliIntent + args = flags.Args() + unknownCommandErr := fmt.Errorf("unknown command: %s", strings.Join(args, " ")) - if *checkConfig { - intent = CliIntentCheckConfig + if len(args) == 0 { + intent = cliIntentServe + } else if len(args) == 1 { + if args[0] == "config:validate" { + intent = cliIntentConfigValidate + } else if args[0] == "config:print" { + intent = cliIntentConfigPrint + } else if args[0] == "sensors:print" { + intent = cliIntentSensorsPrint + } else if args[0] == "diagnose" { + intent = cliIntentDiagnose + } else { + return nil, unknownCommandErr + } + } else if len(args) == 2 { + if args[0] == "mountpoint:info" { + intent = cliIntentMountpointInfo + } else { + return nil, unknownCommandErr + } + } else { + return nil, unknownCommandErr } - return &CliOptions{ - Intent: intent, - ConfigPath: *configPath, + return &cliOptions{ + intent: intent, + configPath: *configPath, + args: args, }, nil } + +func cliSensorsPrint() int { + tempSensors, err := sensors.SensorsTemperatures() + if err != nil { + fmt.Printf("Failed to retrieve list of sensors: %v\n", err) + if warns, ok := err.(*sensors.Warnings); ok { + for _, w := range warns.List { + fmt.Printf(" - %v\n", w) + } + } + + return 1 + } + + if len(tempSensors) == 0 { + fmt.Println("No sensors found") + return 0 + } + + for _, sensor := range tempSensors { + fmt.Printf("%s: %.1f°C\n", sensor.SensorKey, sensor.Temperature) + } + + return 0 +} + +func cliMountpointInfo(requestedPath string) int { + usage, err := disk.Usage(requestedPath) + if err != nil { + fmt.Printf("Failed to retrieve info for path %s: %v\n", requestedPath, err) + if warns, ok := err.(*disk.Warnings); ok { + for _, w := range warns.List { + fmt.Printf(" - %v\n", w) + } + } + + return 1 + } + + fmt.Println("Path:", usage.Path) + fmt.Println("FS type:", ternary(usage.Fstype == "", "unknown", usage.Fstype)) + fmt.Printf("Used percent: %.1f%%\n", usage.UsedPercent) + + return 0 +} diff --git a/internal/glance/config-fields.go b/internal/glance/config-fields.go new file mode 100644 index 0000000..e2ece3f --- /dev/null +++ b/internal/glance/config-fields.go @@ -0,0 +1,276 @@ +package glance + +import ( + "crypto/tls" + "fmt" + "net/http" + "net/url" + "regexp" + "strconv" + "strings" + "time" + + "gopkg.in/yaml.v3" +) + +var hslColorFieldPattern = regexp.MustCompile(`^(?:hsla?\()?(\d{1,3})(?: |,)+(\d{1,3})%?(?: |,)+(\d{1,3})%?\)?$`) + +const ( + hslHueMax = 360 + hslSaturationMax = 100 + hslLightnessMax = 100 +) + +type hslColorField struct { + Hue uint16 + Saturation uint8 + Lightness uint8 +} + +func (c *hslColorField) String() string { + return fmt.Sprintf("hsl(%d, %d%%, %d%%)", c.Hue, c.Saturation, c.Lightness) +} + +func (c *hslColorField) UnmarshalYAML(node *yaml.Node) error { + var value string + + if err := node.Decode(&value); err != nil { + return err + } + + matches := hslColorFieldPattern.FindStringSubmatch(value) + + if len(matches) != 4 { + return fmt.Errorf("invalid HSL color format: %s", value) + } + + hue, err := strconv.ParseUint(matches[1], 10, 16) + if err != nil { + return err + } + + if hue > hslHueMax { + return fmt.Errorf("HSL hue must be between 0 and %d", hslHueMax) + } + + saturation, err := strconv.ParseUint(matches[2], 10, 8) + if err != nil { + return err + } + + if saturation > hslSaturationMax { + return fmt.Errorf("HSL saturation must be between 0 and %d", hslSaturationMax) + } + + lightness, err := strconv.ParseUint(matches[3], 10, 8) + if err != nil { + return err + } + + if lightness > hslLightnessMax { + return fmt.Errorf("HSL lightness must be between 0 and %d", hslLightnessMax) + } + + c.Hue = uint16(hue) + c.Saturation = uint8(saturation) + c.Lightness = uint8(lightness) + + return nil +} + +var durationFieldPattern = regexp.MustCompile(`^(\d+)(s|m|h|d)$`) + +type durationField time.Duration + +func (d *durationField) UnmarshalYAML(node *yaml.Node) error { + var value string + + if err := node.Decode(&value); err != nil { + return err + } + + matches := durationFieldPattern.FindStringSubmatch(value) + + if len(matches) != 3 { + return fmt.Errorf("invalid duration format: %s", value) + } + + duration, err := strconv.Atoi(matches[1]) + if err != nil { + return err + } + + switch matches[2] { + case "s": + *d = durationField(time.Duration(duration) * time.Second) + case "m": + *d = durationField(time.Duration(duration) * time.Minute) + case "h": + *d = durationField(time.Duration(duration) * time.Hour) + case "d": + *d = durationField(time.Duration(duration) * 24 * time.Hour) + } + + return nil +} + +type customIconField struct { + URL string + IsFlatIcon bool + // TODO: along with whether the icon is flat, we also need to know + // whether the icon is black or white by default in order to properly + // invert the color based on the theme being light or dark +} + +func newCustomIconField(value string) customIconField { + field := customIconField{} + + prefix, icon, found := strings.Cut(value, ":") + if !found { + field.URL = value + return field + } + + switch prefix { + case "si": + field.URL = "https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/" + icon + ".svg" + field.IsFlatIcon = true + case "di", "sh": + // syntax: di:[.svg|.png] + // syntax: sh:[.svg|.png] + // if the icon name is specified without extension, it is assumed to be wanting the SVG icon + // otherwise, specify the extension of either .svg or .png to use either of the CDN offerings + // any other extension will be interpreted as .svg + basename, ext, found := strings.Cut(icon, ".") + if !found { + ext = "svg" + basename = icon + } + + if ext != "svg" && ext != "png" { + ext = "svg" + } + + if prefix == "di" { + field.URL = "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/" + ext + "/" + basename + "." + ext + } else { + field.URL = "https://cdn.jsdelivr.net/gh/selfhst/icons/" + ext + "/" + basename + "." + ext + } + default: + field.URL = value + } + + return field +} + +func (i *customIconField) UnmarshalYAML(node *yaml.Node) error { + var value string + if err := node.Decode(&value); err != nil { + return err + } + + *i = newCustomIconField(value) + return nil +} + +type proxyOptionsField struct { + URL string `yaml:"url"` + AllowInsecure bool `yaml:"allow-insecure"` + Timeout durationField `yaml:"timeout"` + client *http.Client `yaml:"-"` +} + +func (p *proxyOptionsField) UnmarshalYAML(node *yaml.Node) error { + type proxyOptionsFieldAlias proxyOptionsField + alias := (*proxyOptionsFieldAlias)(p) + var proxyURL string + + if err := node.Decode(&proxyURL); err != nil { + if err := node.Decode(alias); err != nil { + return err + } + } + + if proxyURL == "" && p.URL == "" { + return nil + } + + if p.URL != "" { + proxyURL = p.URL + } + + parsedUrl, err := url.Parse(proxyURL) + if err != nil { + return fmt.Errorf("parsing proxy URL: %v", err) + } + + var timeout = defaultClientTimeout + if p.Timeout > 0 { + timeout = time.Duration(p.Timeout) + } + + p.client = &http.Client{ + Timeout: timeout, + Transport: &http.Transport{ + Proxy: http.ProxyURL(parsedUrl), + TLSClientConfig: &tls.Config{InsecureSkipVerify: p.AllowInsecure}, + }, + } + + return nil +} + +type queryParametersField map[string][]string + +func (q *queryParametersField) UnmarshalYAML(node *yaml.Node) error { + var decoded map[string]any + + if err := node.Decode(&decoded); err != nil { + return err + } + + *q = make(queryParametersField) + + // TODO: refactor the duplication in the switch cases if any more types get added + for key, value := range decoded { + switch v := value.(type) { + case string: + (*q)[key] = []string{v} + case int, int8, int16, int32, int64, float32, float64: + (*q)[key] = []string{fmt.Sprintf("%v", v)} + case bool: + (*q)[key] = []string{fmt.Sprintf("%t", v)} + case []string: + (*q)[key] = append((*q)[key], v...) + case []any: + for _, item := range v { + switch item := item.(type) { + case string: + (*q)[key] = append((*q)[key], item) + case int, int8, int16, int32, int64, float32, float64: + (*q)[key] = append((*q)[key], fmt.Sprintf("%v", item)) + case bool: + (*q)[key] = append((*q)[key], fmt.Sprintf("%t", item)) + default: + return fmt.Errorf("invalid query parameter value type: %T", item) + } + } + default: + return fmt.Errorf("invalid query parameter value type: %T", value) + } + } + + return nil +} + +func (q *queryParametersField) toQueryString() string { + query := url.Values{} + + for key, values := range *q { + for _, value := range values { + query.Add(key, value) + } + } + + return query.Encode() +} diff --git a/internal/glance/config.go b/internal/glance/config.go index 9acc3be..0d424a2 100644 --- a/internal/glance/config.go +++ b/internal/glance/config.go @@ -1,68 +1,384 @@ package glance import ( + "bytes" "fmt" - "io" + "html/template" + "log" + "maps" + "os" + "path/filepath" + "regexp" + "strings" + "sync" + "time" + "github.com/fsnotify/fsnotify" "gopkg.in/yaml.v3" ) -type Config struct { - Server Server `yaml:"server"` - Theme Theme `yaml:"theme"` - Pages []Page `yaml:"pages"` +type config struct { + Server struct { + Host string `yaml:"host"` + Port uint16 `yaml:"port"` + AssetsPath string `yaml:"assets-path"` + BaseURL string `yaml:"base-url"` + StartedAt time.Time `yaml:"-"` // used in custom css file + } `yaml:"server"` + + Document struct { + Head template.HTML `yaml:"head"` + } `yaml:"document"` + + Theme struct { + BackgroundColor *hslColorField `yaml:"background-color"` + PrimaryColor *hslColorField `yaml:"primary-color"` + PositiveColor *hslColorField `yaml:"positive-color"` + NegativeColor *hslColorField `yaml:"negative-color"` + Light bool `yaml:"light"` + ContrastMultiplier float32 `yaml:"contrast-multiplier"` + TextSaturationMultiplier float32 `yaml:"text-saturation-multiplier"` + CustomCSSFile string `yaml:"custom-css-file"` + } `yaml:"theme"` + + Branding struct { + HideFooter bool `yaml:"hide-footer"` + CustomFooter template.HTML `yaml:"custom-footer"` + LogoText string `yaml:"logo-text"` + LogoURL string `yaml:"logo-url"` + FaviconURL string `yaml:"favicon-url"` + } `yaml:"branding"` + + Pages []page `yaml:"pages"` } -func NewConfigFromYml(contents io.Reader) (*Config, error) { - config := NewConfig() - - contentBytes, err := io.ReadAll(contents) +type page struct { + Title string `yaml:"name"` + Slug string `yaml:"slug"` + Width string `yaml:"width"` + ShowMobileHeader bool `yaml:"show-mobile-header"` + ExpandMobilePageNavigation bool `yaml:"expand-mobile-page-navigation"` + HideDesktopNavigation bool `yaml:"hide-desktop-navigation"` + CenterVertically bool `yaml:"center-vertically"` + Columns []struct { + Size string `yaml:"size"` + Widgets widgets `yaml:"widgets"` + } `yaml:"columns"` + PrimaryColumnIndex int8 `yaml:"-"` + mu sync.Mutex `yaml:"-"` +} +func newConfigFromYAML(contents []byte) (*config, error) { + contents, err := parseConfigEnvVariables(contents) if err != nil { return nil, err } - err = yaml.Unmarshal(contentBytes, config) + config := &config{} + config.Server.Port = 8080 + err = yaml.Unmarshal(contents, config) if err != nil { return nil, err } - if err = configIsValid(config); err != nil { + if err = isConfigStateValid(config); err != nil { return nil, err } + for p := range config.Pages { + for c := range config.Pages[p].Columns { + for w := range config.Pages[p].Columns[c].Widgets { + if err := config.Pages[p].Columns[c].Widgets[w].initialize(); err != nil { + return nil, formatWidgetInitError(err, config.Pages[p].Columns[c].Widgets[w]) + } + } + } + } + return config, nil } -func NewConfig() *Config { - config := &Config{} +// TODO: change the pattern so that it doesn't match commented out lines +var configEnvVariablePattern = regexp.MustCompile(`(^|.)\$\{([A-Z0-9_]+)\}`) - config.Server.Host = "" - config.Server.Port = 8080 +func parseConfigEnvVariables(contents []byte) ([]byte, error) { + var err error - return config + replaced := configEnvVariablePattern.ReplaceAllFunc(contents, func(match []byte) []byte { + if err != nil { + return nil + } + + groups := configEnvVariablePattern.FindSubmatch(match) + if len(groups) != 3 { + return match + } + + prefix, key := string(groups[1]), string(groups[2]) + if prefix == `\` { + if len(match) >= 2 { + return match[1:] + } else { + return nil + } + } + + value, found := os.LookupEnv(key) + if !found { + err = fmt.Errorf("environment variable %s not found", key) + return nil + } + + return []byte(prefix + value) + }) + + if err != nil { + return nil, err + } + + return replaced, nil } -func configIsValid(config *Config) error { +func formatWidgetInitError(err error, w widget) error { + return fmt.Errorf("%s widget: %v", w.GetType(), err) +} + +var includePattern = regexp.MustCompile(`(?m)^(\s*)!include:\s*(.+)$`) + +func parseYAMLIncludes(mainFilePath string) ([]byte, map[string]struct{}, error) { + mainFileContents, err := os.ReadFile(mainFilePath) + if err != nil { + return nil, nil, fmt.Errorf("reading main YAML file: %w", err) + } + + mainFileAbsPath, err := filepath.Abs(mainFilePath) + if err != nil { + return nil, nil, fmt.Errorf("getting absolute path of main YAML file: %w", err) + } + mainFileDir := filepath.Dir(mainFileAbsPath) + + includes := make(map[string]struct{}) + var includesLastErr error + + mainFileContents = includePattern.ReplaceAllFunc(mainFileContents, func(match []byte) []byte { + if includesLastErr != nil { + return nil + } + + matches := includePattern.FindSubmatch(match) + if len(matches) != 3 { + includesLastErr = fmt.Errorf("invalid include match: %v", matches) + return nil + } + + indent := string(matches[1]) + includeFilePath := strings.TrimSpace(string(matches[2])) + if !filepath.IsAbs(includeFilePath) { + includeFilePath = filepath.Join(mainFileDir, includeFilePath) + } + + var fileContents []byte + var err error + + fileContents, err = os.ReadFile(includeFilePath) + if err != nil { + includesLastErr = fmt.Errorf("reading included file %s: %w", includeFilePath, err) + return nil + } + + includes[includeFilePath] = struct{}{} + return []byte(prefixStringLines(indent, string(fileContents))) + }) + + if includesLastErr != nil { + return nil, nil, includesLastErr + } + + return mainFileContents, includes, nil +} + +func configFilesWatcher( + mainFilePath string, + lastContents []byte, + lastIncludes map[string]struct{}, + onChange func(newContents []byte), + onErr func(error), +) (func() error, error) { + mainFileAbsPath, err := filepath.Abs(mainFilePath) + if err != nil { + return nil, fmt.Errorf("getting absolute path of main file: %w", err) + } + + // TODO: refactor, flaky + lastIncludes[mainFileAbsPath] = struct{}{} + + watcher, err := fsnotify.NewWatcher() + if err != nil { + return nil, fmt.Errorf("creating watcher: %w", err) + } + + updateWatchedFiles := func(previousWatched map[string]struct{}, newWatched map[string]struct{}) { + for filePath := range previousWatched { + if _, ok := newWatched[filePath]; !ok { + watcher.Remove(filePath) + } + } + + for filePath := range newWatched { + if _, ok := previousWatched[filePath]; !ok { + if err := watcher.Add(filePath); err != nil { + log.Printf( + "Could not add file to watcher, changes to this file will not trigger a reload. path: %s, error: %v", + filePath, err, + ) + } + } + } + } + + updateWatchedFiles(nil, lastIncludes) + + // needed for lastContents and lastIncludes because they get updated in multiple goroutines + mu := sync.Mutex{} + + parseAndCompareBeforeCallback := func() { + currentContents, currentIncludes, err := parseYAMLIncludes(mainFilePath) + if err != nil { + onErr(fmt.Errorf("parsing main file contents for comparison: %w", err)) + return + } + + // TODO: refactor, flaky + currentIncludes[mainFileAbsPath] = struct{}{} + + mu.Lock() + defer mu.Unlock() + + if !maps.Equal(currentIncludes, lastIncludes) { + updateWatchedFiles(lastIncludes, currentIncludes) + lastIncludes = currentIncludes + } + + if !bytes.Equal(lastContents, currentContents) { + lastContents = currentContents + onChange(currentContents) + } + } + + const debounceDuration = 500 * time.Millisecond + var debounceTimer *time.Timer + debouncedParseAndCompareBeforeCallback := func() { + if debounceTimer != nil { + debounceTimer.Stop() + debounceTimer.Reset(debounceDuration) + } else { + debounceTimer = time.AfterFunc(debounceDuration, parseAndCompareBeforeCallback) + } + } + + deleteLastInclude := func(filePath string) { + mu.Lock() + defer mu.Unlock() + fileAbsPath, _ := filepath.Abs(filePath) + delete(lastIncludes, fileAbsPath) + } + + go func() { + for { + select { + case event, isOpen := <-watcher.Events: + if !isOpen { + return + } + if event.Has(fsnotify.Write) { + debouncedParseAndCompareBeforeCallback() + } else if event.Has(fsnotify.Rename) { + // on linux the file will no longer be watched after a rename, on windows + // it will continue to be watched with the new name but we have no access to + // the new name in this event in order to stop watching it manually and match the + // behavior in linux, may lead to weird unintended behaviors on windows as we're + // only handling renames from linux's perspective + // see https://github.com/fsnotify/fsnotify/issues/255 + + // remove the old file from our manually tracked includes, calling + // debouncedParseAndCompareBeforeCallback will re-add it if it's still + // required after it triggers + deleteLastInclude(event.Name) + + // wait for file to maybe get created again + // see https://github.com/glanceapp/glance/pull/358 + for i := 0; i < 10; i++ { + if _, err := os.Stat(event.Name); err == nil { + break + } + time.Sleep(200 * time.Millisecond) + } + + debouncedParseAndCompareBeforeCallback() + } else if event.Has(fsnotify.Remove) { + deleteLastInclude(event.Name) + debouncedParseAndCompareBeforeCallback() + } + case err, isOpen := <-watcher.Errors: + if !isOpen { + return + } + onErr(fmt.Errorf("watcher error: %w", err)) + } + } + }() + + onChange(lastContents) + + return func() error { + if debounceTimer != nil { + debounceTimer.Stop() + } + + return watcher.Close() + }, nil +} + +func isConfigStateValid(config *config) error { + if len(config.Pages) == 0 { + return fmt.Errorf("no pages configured") + } + + if config.Server.AssetsPath != "" { + if _, err := os.Stat(config.Server.AssetsPath); os.IsNotExist(err) { + return fmt.Errorf("assets directory does not exist: %s", config.Server.AssetsPath) + } + } + for i := range config.Pages { if config.Pages[i].Title == "" { - return fmt.Errorf("Page %d has no title", i+1) + return fmt.Errorf("page %d has no name", i+1) + } + + if config.Pages[i].Width != "" && (config.Pages[i].Width != "wide" && config.Pages[i].Width != "slim") { + return fmt.Errorf("page %d: width can only be either wide or slim", i+1) } if len(config.Pages[i].Columns) == 0 { - return fmt.Errorf("Page %d has no columns", i+1) + return fmt.Errorf("page %d has no columns", i+1) } - if len(config.Pages[i].Columns) > 3 { - return fmt.Errorf("Page %d has more than 3 columns: %d", i+1, len(config.Pages[i].Columns)) + if config.Pages[i].Width == "slim" { + if len(config.Pages[i].Columns) > 2 { + return fmt.Errorf("page %d is slim and cannot have more than 2 columns", i+1) + } + } else { + if len(config.Pages[i].Columns) > 3 { + return fmt.Errorf("page %d has more than 3 columns", i+1) + } } columnSizesCount := make(map[string]int) for j := range config.Pages[i].Columns { if config.Pages[i].Columns[j].Size != "small" && config.Pages[i].Columns[j].Size != "full" { - return fmt.Errorf("Column %d of page %d: size can only be either small or full", j+1, i+1) + return fmt.Errorf("column %d of page %d: size can only be either small or full", j+1, i+1) } columnSizesCount[config.Pages[i].Columns[j].Size]++ @@ -71,7 +387,7 @@ func configIsValid(config *Config) error { full := columnSizesCount["full"] if full > 2 || full == 0 { - return fmt.Errorf("Page %d must have either 1 or 2 full width columns", i+1) + return fmt.Errorf("page %d must have either 1 or 2 full width columns", i+1) } } diff --git a/internal/glance/diagnose.go b/internal/glance/diagnose.go new file mode 100644 index 0000000..1ee1bc3 --- /dev/null +++ b/internal/glance/diagnose.go @@ -0,0 +1,207 @@ +package glance + +import ( + "context" + "fmt" + "io" + "net" + "net/http" + "runtime" + "strings" + "sync" + "time" +) + +const httpTestRequestTimeout = 10 * time.Second + +var diagnosticSteps = []diagnosticStep{ + { + name: "resolve cloudflare.com through Cloudflare DoH", + fn: func() (string, error) { + return testHttpRequestWithHeaders("GET", "https://1.1.1.1/dns-query?name=cloudflare.com", map[string]string{ + "accept": "application/dns-json", + }, 200) + }, + }, + { + name: "resolve cloudflare.com through Google DoH", + fn: func() (string, error) { + return testHttpRequest("GET", "https://8.8.8.8/resolve?name=cloudflare.com", 200) + }, + }, + { + name: "resolve github.com", + fn: func() (string, error) { + return testDNSResolution("github.com") + }, + }, + { + name: "resolve reddit.com", + fn: func() (string, error) { + return testDNSResolution("reddit.com") + }, + }, + { + name: "resolve twitch.tv", + fn: func() (string, error) { + return testDNSResolution("twitch.tv") + }, + }, + { + name: "fetch data from YouTube RSS feed", + fn: func() (string, error) { + return testHttpRequest("GET", "https://www.youtube.com/feeds/videos.xml?channel_id=UCZU9T1ceaOgwfLRq7OKFU4Q", 200) + }, + }, + { + name: "fetch data from Twitch.tv GQL", + fn: func() (string, error) { + // this should always return 0 bytes, we're mainly looking for a 200 status code + return testHttpRequest("OPTIONS", "https://gql.twitch.tv/gql", 200) + }, + }, + { + name: "fetch data from GitHub API", + fn: func() (string, error) { + return testHttpRequest("GET", "https://api.github.com", 200) + }, + }, + { + name: "fetch data from Open-Meteo API", + fn: func() (string, error) { + return testHttpRequest("GET", "https://geocoding-api.open-meteo.com/v1/search?name=London", 200) + }, + }, + { + name: "fetch data from Reddit API", + fn: func() (string, error) { + return testHttpRequest("GET", "https://www.reddit.com/search.json", 200) + }, + }, + { + name: "fetch data from Yahoo finance API", + fn: func() (string, error) { + return testHttpRequestWithHeaders("GET", "https://query1.finance.yahoo.com/v8/finance/chart/NVDA", map[string]string{ + "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:137.0) Gecko/20100101 Firefox/137.0", + }, 200) + }, + }, + { + name: "fetch data from Hacker News Firebase API", + fn: func() (string, error) { + return testHttpRequest("GET", "https://hacker-news.firebaseio.com/v0/topstories.json", 200) + }, + }, + { + name: "fetch data from Docker Hub API", + fn: func() (string, error) { + return testHttpRequest("GET", "https://hub.docker.com/v2/namespaces/library/repositories/ubuntu/tags/latest", 200) + }, + }, +} + +func runDiagnostic() { + fmt.Println("```") + fmt.Println("Glance version: " + buildVersion) + fmt.Println("Go version: " + runtime.Version()) + fmt.Printf("Platform: %s / %s / %d CPUs\n", runtime.GOOS, runtime.GOARCH, runtime.NumCPU()) + fmt.Println("In Docker container: " + ternary(isRunningInsideDockerContainer(), "yes", "no")) + + fmt.Printf("\nChecking network connectivity, this may take up to %d seconds...\n\n", int(httpTestRequestTimeout.Seconds())) + + var wg sync.WaitGroup + for i := range diagnosticSteps { + step := &diagnosticSteps[i] + wg.Add(1) + go func() { + defer wg.Done() + start := time.Now() + step.extraInfo, step.err = step.fn() + step.elapsed = time.Since(start) + }() + } + wg.Wait() + + for _, step := range diagnosticSteps { + var extraInfo string + + if step.extraInfo != "" { + extraInfo = "| " + step.extraInfo + " " + } + + fmt.Printf( + "%s %s %s| %dms\n", + ternary(step.err == nil, "✓ Can", "✗ Can't"), + step.name, + extraInfo, + step.elapsed.Milliseconds(), + ) + + if step.err != nil { + fmt.Printf("└╴ error: %v\n", step.err) + } + } + fmt.Println("```") +} + +type diagnosticStep struct { + name string + fn func() (string, error) + extraInfo string + err error + elapsed time.Duration +} + +func testHttpRequest(method, url string, expectedStatusCode int) (string, error) { + return testHttpRequestWithHeaders(method, url, nil, expectedStatusCode) +} + +func testHttpRequestWithHeaders(method, url string, headers map[string]string, expectedStatusCode int) (string, error) { + ctx, cancel := context.WithTimeout(context.Background(), httpTestRequestTimeout) + defer cancel() + + request, _ := http.NewRequestWithContext(ctx, method, url, nil) + for key, value := range headers { + request.Header.Add(key, value) + } + + response, err := http.DefaultClient.Do(request) + if err != nil { + return "", err + } + defer response.Body.Close() + + body, err := io.ReadAll(response.Body) + if err != nil { + return "", err + } + + printableBody := strings.ReplaceAll(string(body), "\n", "") + if len(printableBody) > 50 { + printableBody = printableBody[:50] + "..." + } + if len(printableBody) > 0 { + printableBody = ", " + printableBody + } + + extraInfo := fmt.Sprintf("%d bytes%s", len(body), printableBody) + + if response.StatusCode != expectedStatusCode { + return extraInfo, fmt.Errorf("expected status code %d, got %d", expectedStatusCode, response.StatusCode) + } + + return extraInfo, nil +} + +func testDNSResolution(domain string) (string, error) { + ips, err := net.LookupIP(domain) + + var ipStrings []string + if err == nil { + for i := range ips { + ipStrings = append(ipStrings, ips[i].String()) + } + } + + return strings.Join(ipStrings, ", "), err +} diff --git a/internal/glance/embed.go b/internal/glance/embed.go new file mode 100644 index 0000000..7bb07c9 --- /dev/null +++ b/internal/glance/embed.go @@ -0,0 +1,62 @@ +package glance + +import ( + "crypto/md5" + "embed" + "encoding/hex" + "io" + "io/fs" + "log" + "strconv" + "time" +) + +//go:embed static +var _staticFS embed.FS + +//go:embed templates +var _templateFS embed.FS + +var staticFS, _ = fs.Sub(_staticFS, "static") +var templateFS, _ = fs.Sub(_templateFS, "templates") + +var staticFSHash = func() string { + hash, err := computeFSHash(staticFS) + if err != nil { + log.Printf("Could not compute static assets cache key: %v", err) + return strconv.FormatInt(time.Now().Unix(), 10) + } + + return hash +}() + +func computeFSHash(files fs.FS) (string, error) { + hash := md5.New() + + err := fs.WalkDir(files, ".", func(path string, d fs.DirEntry, err error) error { + if err != nil { + return err + } + + if d.IsDir() { + return nil + } + + file, err := files.Open(path) + if err != nil { + return err + } + + if _, err := io.Copy(hash, file); err != nil { + return err + } + + return nil + }) + + if err != nil { + return "", err + } + + return hex.EncodeToString(hash.Sum(nil))[:10], nil +} diff --git a/internal/glance/glance.go b/internal/glance/glance.go index 653be75..8fb3e40 100644 --- a/internal/glance/glance.go +++ b/internal/glance/glance.go @@ -4,65 +4,94 @@ import ( "bytes" "context" "fmt" - "log/slog" + "html/template" + "log" "net/http" "path/filepath" - "regexp" + "strconv" "strings" "sync" "time" - - "github.com/glanceapp/glance/internal/assets" - "github.com/glanceapp/glance/internal/widget" ) -var buildVersion = "dev" +var ( + pageTemplate = mustParseTemplate("page.html", "document.html") + pageContentTemplate = mustParseTemplate("page-content.html") + pageThemeStyleTemplate = mustParseTemplate("theme-style.gotmpl") +) -var sequentialWhitespacePattern = regexp.MustCompile(`\s+`) +type application struct { + Version string + Config config + ParsedThemeStyle template.HTML -type Application struct { - Version string - Config Config - slugToPage map[string]*Page + slugToPage map[string]*page + widgetByID map[uint64]widget } -type Theme struct { - BackgroundColor *widget.HSLColorField `yaml:"background-color"` - PrimaryColor *widget.HSLColorField `yaml:"primary-color"` - PositiveColor *widget.HSLColorField `yaml:"positive-color"` - NegativeColor *widget.HSLColorField `yaml:"negative-color"` - Light bool `yaml:"light"` - ContrastMultiplier float32 `yaml:"contrast-multiplier"` - TextSaturationMultiplier float32 `yaml:"text-saturation-multiplier"` - CustomCSSFile string `yaml:"custom-css-file"` +func newApplication(config *config) (*application, error) { + app := &application{ + Version: buildVersion, + Config: *config, + slugToPage: make(map[string]*page), + widgetByID: make(map[uint64]widget), + } + + app.slugToPage[""] = &config.Pages[0] + + providers := &widgetProviders{ + assetResolver: app.AssetPath, + } + + var err error + app.ParsedThemeStyle, err = executeTemplateToHTML(pageThemeStyleTemplate, &app.Config.Theme) + if err != nil { + return nil, fmt.Errorf("parsing theme style: %v", err) + } + + for p := range config.Pages { + page := &config.Pages[p] + page.PrimaryColumnIndex = -1 + + if page.Slug == "" { + page.Slug = titleToSlug(page.Title) + } + + app.slugToPage[page.Slug] = page + + for c := range page.Columns { + column := &page.Columns[c] + + if page.PrimaryColumnIndex == -1 && column.Size == "full" { + page.PrimaryColumnIndex = int8(c) + } + + for w := range column.Widgets { + widget := column.Widgets[w] + app.widgetByID[widget.GetID()] = widget + + widget.setProviders(providers) + } + } + } + + config = &app.Config + + config.Server.BaseURL = strings.TrimRight(config.Server.BaseURL, "/") + config.Theme.CustomCSSFile = app.transformUserDefinedAssetPath(config.Theme.CustomCSSFile) + + if config.Branding.FaviconURL == "" { + config.Branding.FaviconURL = app.AssetPath("favicon.png") + } else { + config.Branding.FaviconURL = app.transformUserDefinedAssetPath(config.Branding.FaviconURL) + } + + config.Branding.LogoURL = app.transformUserDefinedAssetPath(config.Branding.LogoURL) + + return app, nil } -type Server struct { - Host string `yaml:"host"` - Port uint16 `yaml:"port"` - AssetsPath string `yaml:"assets-path"` - StartedAt time.Time `yaml:"-"` -} - -type Column struct { - Size string `yaml:"size"` - Widgets widget.Widgets `yaml:"widgets"` -} - -type templateData struct { - App *Application - Page *Page -} - -type Page struct { - Title string `yaml:"name"` - Slug string `yaml:"slug"` - ShowMobileHeader bool `yaml:"show-mobile-header"` - Columns []Column `yaml:"columns"` - mu sync.Mutex -} - -func (p *Page) UpdateOutdatedWidgets() { +func (p *page) updateOutdatedWidgets() { now := time.Now() var wg sync.WaitGroup @@ -72,14 +101,14 @@ func (p *Page) UpdateOutdatedWidgets() { for w := range p.Columns[c].Widgets { widget := p.Columns[c].Widgets[w] - if !widget.RequiresUpdate(&now) { + if !widget.requiresUpdate(&now) { continue } wg.Add(1) go func() { defer wg.Done() - widget.Update(context) + widget.update(context) }() } } @@ -87,55 +116,34 @@ func (p *Page) UpdateOutdatedWidgets() { wg.Wait() } -// TODO: fix, currently very simple, lots of uncovered edge cases -func titleToSlug(s string) string { - s = strings.ToLower(s) - s = sequentialWhitespacePattern.ReplaceAllString(s, "-") - s = strings.Trim(s, "-") +func (a *application) transformUserDefinedAssetPath(path string) string { + if strings.HasPrefix(path, "/assets/") { + return a.Config.Server.BaseURL + path + } - return s + return path } -func NewApplication(config *Config) (*Application, error) { - if len(config.Pages) == 0 { - return nil, fmt.Errorf("no pages configured") - } - - app := &Application{ - Version: buildVersion, - Config: *config, - slugToPage: make(map[string]*Page), - } - - app.slugToPage[""] = &config.Pages[0] - - for i := range config.Pages { - if config.Pages[i].Slug == "" { - config.Pages[i].Slug = titleToSlug(config.Pages[i].Title) - } - - app.slugToPage[config.Pages[i].Slug] = &config.Pages[i] - } - - return app, nil +type pageTemplateData struct { + App *application + Page *page } -func (a *Application) HandlePageRequest(w http.ResponseWriter, r *http.Request) { +func (a *application) handlePageRequest(w http.ResponseWriter, r *http.Request) { page, exists := a.slugToPage[r.PathValue("page")] if !exists { - a.HandleNotFound(w, r) + a.handleNotFound(w, r) return } - pageData := templateData{ + pageData := pageTemplateData{ Page: page, App: a, } var responseBytes bytes.Buffer - err := assets.PageTemplate.Execute(&responseBytes, pageData) - + err := pageTemplate.Execute(&responseBytes, pageData) if err != nil { w.WriteHeader(http.StatusInternalServerError) w.Write([]byte(err.Error())) @@ -145,24 +153,28 @@ func (a *Application) HandlePageRequest(w http.ResponseWriter, r *http.Request) w.Write(responseBytes.Bytes()) } -func (a *Application) HandlePageContentRequest(w http.ResponseWriter, r *http.Request) { +func (a *application) handlePageContentRequest(w http.ResponseWriter, r *http.Request) { page, exists := a.slugToPage[r.PathValue("page")] if !exists { - a.HandleNotFound(w, r) + a.handleNotFound(w, r) return } - pageData := templateData{ + pageData := pageTemplateData{ Page: page, } - page.mu.Lock() - defer page.mu.Unlock() - page.UpdateOutdatedWidgets() - + var err error var responseBytes bytes.Buffer - err := assets.PageContentTemplate.Execute(&responseBytes, pageData) + + func() { + page.mu.Lock() + defer page.mu.Unlock() + + page.updateOutdatedWidgets() + err = pageContentTemplate.Execute(&responseBytes, pageData) + }() if err != nil { w.WriteHeader(http.StatusInternalServerError) @@ -173,41 +185,58 @@ func (a *Application) HandlePageContentRequest(w http.ResponseWriter, r *http.Re w.Write(responseBytes.Bytes()) } -func (a *Application) HandleNotFound(w http.ResponseWriter, r *http.Request) { +func (a *application) handleNotFound(w http.ResponseWriter, _ *http.Request) { // TODO: add proper not found page w.WriteHeader(http.StatusNotFound) w.Write([]byte("Page not found")) } -func FileServerWithCache(fs http.FileSystem, cacheDuration time.Duration) http.Handler { - server := http.FileServer(fs) +func (a *application) handleWidgetRequest(w http.ResponseWriter, r *http.Request) { + widgetValue := r.PathValue("widget") - return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - // TODO: fix always setting cache control even if the file doesn't exist - w.Header().Set("Cache-Control", fmt.Sprintf("public, max-age=%d", int(cacheDuration.Seconds()))) - server.ServeHTTP(w, r) - }) + widgetID, err := strconv.ParseUint(widgetValue, 10, 64) + if err != nil { + a.handleNotFound(w, r) + return + } + + widget, exists := a.widgetByID[widgetID] + + if !exists { + a.handleNotFound(w, r) + return + } + + widget.handleRequest(w, r) } -func (a *Application) Serve() error { +func (a *application) AssetPath(asset string) string { + return a.Config.Server.BaseURL + "/static/" + staticFSHash + "/" + asset +} + +func (a *application) server() (func() error, func() error) { // TODO: add gzip support, static files must have their gzipped contents cached // TODO: add HTTPS support mux := http.NewServeMux() - mux.HandleFunc("GET /{$}", a.HandlePageRequest) - mux.HandleFunc("GET /{page}", a.HandlePageRequest) - mux.HandleFunc("GET /api/pages/{page}/content/{$}", a.HandlePageContentRequest) - mux.Handle("GET /static/{path...}", http.StripPrefix("/static/", FileServerWithCache(http.FS(assets.PublicFS), 2*time.Hour))) + mux.HandleFunc("GET /{$}", a.handlePageRequest) + mux.HandleFunc("GET /{page}", a.handlePageRequest) + mux.HandleFunc("GET /api/pages/{page}/content/{$}", a.handlePageContentRequest) + mux.HandleFunc("/api/widgets/{widget}/{path...}", a.handleWidgetRequest) + mux.HandleFunc("GET /api/healthz", func(w http.ResponseWriter, _ *http.Request) { + w.WriteHeader(http.StatusOK) + }) + + mux.Handle( + fmt.Sprintf("GET /static/%s/{path...}", staticFSHash), + http.StripPrefix("/static/"+staticFSHash, fileServerWithCache(http.FS(staticFS), 24*time.Hour)), + ) + + var absAssetsPath string if a.Config.Server.AssetsPath != "" { - absAssetsPath, err := filepath.Abs(a.Config.Server.AssetsPath) - - if err != nil { - return fmt.Errorf("invalid assets path: %s", a.Config.Server.AssetsPath) - } - - slog.Info("Serving assets", "path", absAssetsPath) - assetsFS := FileServerWithCache(http.Dir(a.Config.Server.AssetsPath), 2*time.Hour) + absAssetsPath, _ = filepath.Abs(a.Config.Server.AssetsPath) + assetsFS := fileServerWithCache(http.Dir(a.Config.Server.AssetsPath), 2*time.Hour) mux.Handle("/assets/{path...}", http.StripPrefix("/assets/", assetsFS)) } @@ -216,8 +245,25 @@ func (a *Application) Serve() error { Handler: mux, } - a.Config.Server.StartedAt = time.Now() + start := func() error { + a.Config.Server.StartedAt = time.Now() + log.Printf("Starting server on %s:%d (base-url: \"%s\", assets-path: \"%s\")\n", + a.Config.Server.Host, + a.Config.Server.Port, + a.Config.Server.BaseURL, + absAssetsPath, + ) - slog.Info("Starting server", "host", a.Config.Server.Host, "port", a.Config.Server.Port) - return server.ListenAndServe() + if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed { + return err + } + + return nil + } + + stop := func() error { + return server.Close() + } + + return start, stop } diff --git a/internal/glance/main.go b/internal/glance/main.go index 426c41f..67a980c 100644 --- a/internal/glance/main.go +++ b/internal/glance/main.go @@ -2,45 +2,178 @@ package glance import ( "fmt" + "io" + "log" + "net/http" "os" ) -func Main() int { - options, err := ParseCliOptions() +var buildVersion = "dev" +func Main() int { + options, err := parseCliOptions() if err != nil { fmt.Println(err) return 1 } - configFile, err := os.Open(options.ConfigPath) - - if err != nil { - fmt.Printf("failed opening config file: %v\n", err) - return 1 - } - - config, err := NewConfigFromYml(configFile) - configFile.Close() - - if err != nil { - fmt.Printf("failed parsing config file: %v\n", err) - return 1 - } - - if options.Intent == CliIntentServe { - app, err := NewApplication(config) + switch options.intent { + case cliIntentVersionPrint: + fmt.Println(buildVersion) + case cliIntentServe: + // remove in v0.10.0 + if serveUpdateNoticeIfConfigLocationNotMigrated(options.configPath) { + return 1 + } + if err := serveApp(options.configPath); err != nil { + fmt.Println(err) + return 1 + } + case cliIntentConfigValidate: + contents, _, err := parseYAMLIncludes(options.configPath) if err != nil { - fmt.Printf("failed creating application: %v\n", err) + fmt.Printf("Could not parse config file: %v\n", err) return 1 } - if err := app.Serve(); err != nil { - fmt.Printf("http server error: %v\n", err) + if _, err := newConfigFromYAML(contents); err != nil { + fmt.Printf("Config file is invalid: %v\n", err) return 1 } + case cliIntentConfigPrint: + contents, _, err := parseYAMLIncludes(options.configPath) + if err != nil { + fmt.Printf("Could not parse config file: %v\n", err) + return 1 + } + + fmt.Println(string(contents)) + case cliIntentSensorsPrint: + return cliSensorsPrint() + case cliIntentMountpointInfo: + return cliMountpointInfo(options.args[1]) + case cliIntentDiagnose: + runDiagnostic() } return 0 } + +func serveApp(configPath string) error { + exitChannel := make(chan struct{}) + hadValidConfigOnStartup := false + var stopServer func() error + + onChange := func(newContents []byte) { + if stopServer != nil { + log.Println("Config file changed, reloading...") + } + + config, err := newConfigFromYAML(newContents) + if err != nil { + log.Printf("Config has errors: %v", err) + + if !hadValidConfigOnStartup { + close(exitChannel) + } + + return + } else if !hadValidConfigOnStartup { + hadValidConfigOnStartup = true + } + + app, err := newApplication(config) + if err != nil { + log.Printf("Failed to create application: %v", err) + return + } + + if stopServer != nil { + if err := stopServer(); err != nil { + log.Printf("Error while trying to stop server: %v", err) + } + } + + go func() { + var startServer func() error + startServer, stopServer = app.server() + + if err := startServer(); err != nil { + log.Printf("Failed to start server: %v", err) + } + }() + } + + onErr := func(err error) { + log.Printf("Error watching config files: %v", err) + } + + configContents, configIncludes, err := parseYAMLIncludes(configPath) + if err != nil { + return fmt.Errorf("parsing config: %w", err) + } + + stopWatching, err := configFilesWatcher(configPath, configContents, configIncludes, onChange, onErr) + if err == nil { + defer stopWatching() + } else { + log.Printf("Error starting file watcher, config file changes will require a manual restart. (%v)", err) + + config, err := newConfigFromYAML(configContents) + if err != nil { + return fmt.Errorf("validating config file: %w", err) + } + + app, err := newApplication(config) + if err != nil { + return fmt.Errorf("creating application: %w", err) + } + + startServer, _ := app.server() + if err := startServer(); err != nil { + return fmt.Errorf("starting server: %w", err) + } + } + + <-exitChannel + return nil +} + +func serveUpdateNoticeIfConfigLocationNotMigrated(configPath string) bool { + if !isRunningInsideDockerContainer() { + return false + } + + if _, err := os.Stat(configPath); err == nil { + return false + } + + // glance.yml wasn't mounted to begin with or was incorrectly mounted as a directory + if stat, err := os.Stat("glance.yml"); err != nil || stat.IsDir() { + return false + } + + templateFile, _ := templateFS.Open("v0.7-update-notice-page.html") + bodyContents, _ := io.ReadAll(templateFile) + + fmt.Println("!!! WARNING !!!") + fmt.Println("The default location of glance.yml in the Docker image has changed starting from v0.7.0.") + fmt.Println("Please see https://github.com/glanceapp/glance/blob/main/docs/v0.7.0-upgrade.md for more information.") + + mux := http.NewServeMux() + mux.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.FS(staticFS)))) + mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusServiceUnavailable) + w.Header().Set("Content-Type", "text/html") + w.Write([]byte(bodyContents)) + }) + + server := http.Server{ + Addr: ":8080", + Handler: mux, + } + server.ListenAndServe() + + return true +} diff --git a/internal/assets/static/app-icon.png b/internal/glance/static/app-icon.png similarity index 100% rename from internal/assets/static/app-icon.png rename to internal/glance/static/app-icon.png diff --git a/internal/assets/static/favicon.png b/internal/glance/static/favicon.png similarity index 100% rename from internal/assets/static/favicon.png rename to internal/glance/static/favicon.png diff --git a/internal/assets/static/fonts/JetBrainsMono-Regular.woff2 b/internal/glance/static/fonts/JetBrainsMono-Regular.woff2 similarity index 100% rename from internal/assets/static/fonts/JetBrainsMono-Regular.woff2 rename to internal/glance/static/fonts/JetBrainsMono-Regular.woff2 diff --git a/internal/glance/static/icons/codeberg.svg b/internal/glance/static/icons/codeberg.svg new file mode 100644 index 0000000..3bb3c9f --- /dev/null +++ b/internal/glance/static/icons/codeberg.svg @@ -0,0 +1 @@ + diff --git a/internal/glance/static/icons/dockerhub.svg b/internal/glance/static/icons/dockerhub.svg new file mode 100644 index 0000000..8669c00 --- /dev/null +++ b/internal/glance/static/icons/dockerhub.svg @@ -0,0 +1 @@ + diff --git a/internal/glance/static/icons/github.svg b/internal/glance/static/icons/github.svg new file mode 100644 index 0000000..6cf48c8 --- /dev/null +++ b/internal/glance/static/icons/github.svg @@ -0,0 +1 @@ + diff --git a/internal/glance/static/icons/gitlab.svg b/internal/glance/static/icons/gitlab.svg new file mode 100644 index 0000000..42e4c97 --- /dev/null +++ b/internal/glance/static/icons/gitlab.svg @@ -0,0 +1 @@ + diff --git a/internal/glance/static/js/animations.js b/internal/glance/static/js/animations.js new file mode 100644 index 0000000..db5b0aa --- /dev/null +++ b/internal/glance/static/js/animations.js @@ -0,0 +1,33 @@ +export const easeOutQuint = 'cubic-bezier(0.22, 1, 0.36, 1)'; + +export function directions(anim, opt, ...dirs) { + return dirs.map(dir => anim({ direction: dir, ...opt })); +} + +export function slideFade({ + direction = 'left', + fill = 'backwards', + duration = 200, + distance = '1rem', + easing = 'ease', + offset = 0, +}) { + const axis = direction === 'left' || direction === 'right' ? 'X' : 'Y'; + const negative = direction === 'left' || direction === 'up' ? '-' : ''; + const amount = negative + distance; + + return { + keyframes: [ + { + offset: offset, + opacity: 0, + transform: `translate${axis}(${amount})`, + } + ], + options: { + duration: duration, + easing: easing, + fill: fill, + }, + }; +} diff --git a/internal/glance/static/js/calendar.js b/internal/glance/static/js/calendar.js new file mode 100644 index 0000000..fb6602e --- /dev/null +++ b/internal/glance/static/js/calendar.js @@ -0,0 +1,212 @@ +import { directions, easeOutQuint, slideFade } from "./animations.js"; +import { elem, repeat, text } from "./templating.js"; + +const FULL_MONTH_SLOTS = 7*6; +const WEEKDAY_ABBRS = ["Su", "Mo", "Tu", "We", "Th", "Fr", "Sa"]; +const MONTH_NAMES = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]; + +const leftArrowSvg = ` + +`; + +const rightArrowSvg = ` + +`; + +const undoArrowSvg = ` + +`; + +const [datesExitLeft, datesExitRight] = directions( + slideFade, { distance: "2rem", duration: 120, offset: 1 }, + "left", "right" +); + +const [datesEntranceLeft, datesEntranceRight] = directions( + slideFade, { distance: "0.8rem", duration: 500, easing: easeOutQuint }, + "left", "right" +); + +const undoEntrance = slideFade({ direction: "left", distance: "100%", duration: 300 }); + +export default function(element) { + element.swap(Calendar( + Number(element.dataset.firstDayOfWeek ?? 1) + )); +} + +// TODO: when viewing the previous/next month, display the current date if it's within the spill-over days +function Calendar(firstDay) { + let header, dates; + let advanceTimeTicker; + let now = new Date(); + let activeDate; + + const update = (newDate) => { + header.component.update(now, newDate); + dates.component.update(now, newDate); + activeDate = newDate; + }; + + const autoAdvanceNow = () => { + advanceTimeTicker = setTimeout(() => { + // TODO: don't auto advance if looking at a different month + update(now = new Date()); + autoAdvanceNow(); + }, msTillNextDay()); + }; + + const adjacentMonth = (dir) => new Date(activeDate.getFullYear(), activeDate.getMonth() + dir, 1); + const nextClicked = () => update(adjacentMonth(1)); + const prevClicked = () => update(adjacentMonth(-1)); + const undoClicked = () => update(now); + + const calendar = elem().classes("calendar").append( + header = Header(nextClicked, prevClicked, undoClicked), + dates = Dates(firstDay) + ); + + update(now); + autoAdvanceNow(); + + return calendar.component({ + suspend: () => clearTimeout(advanceTimeTicker) + }); +} + +function Header(nextClicked, prevClicked, undoClicked) { + let month, monthNumber, year, undo; + const button = () => elem("button").classes("calendar-header-button"); + + const monthAndYear = elem().classes("size-h2", "color-highlight").append( + month = text(), + " ", + year = elem("span").classes("size-h3"), + undo = button() + .hide() + .classes("calendar-undo-button") + .attr("title", "Back to current month") + .on("click", undoClicked) + .html(undoArrowSvg) + ); + + const monthSwitcher = elem() + .classes("flex", "gap-7", "items-center") + .append( + button() + .attr("title", "Previous month") + .on("click", prevClicked) + .html(leftArrowSvg), + monthNumber = elem() + .classes("color-highlight") + .styles({ marginTop: "0.1rem" }), + button() + .attr("title", "Next month") + .on("click", nextClicked) + .html(rightArrowSvg), + ); + + return elem().classes("flex", "justify-between", "items-center").append( + monthAndYear, + monthSwitcher + ).component({ + update: function (now, newDate) { + month.text(MONTH_NAMES[newDate.getMonth()]); + year.text(newDate.getFullYear()); + const m = newDate.getMonth() + 1; + monthNumber.text((m < 10 ? "0" : "") + m); + + if (!datesWithinSameMonth(now, newDate)) { + if (undo.isHidden()) undo.show().animate(undoEntrance); + } else { + undo.hide(); + } + + return this; + } + }); +} + +function Dates(firstDay) { + let dates, lastRenderedDate; + + const updateFullMonth = function(now, newDate) { + const firstWeekday = new Date(newDate.getFullYear(), newDate.getMonth(), 1).getDay(); + const previousMonthSpilloverDays = (firstWeekday - firstDay + 7) % 7 || 7; + const currentMonthDays = daysInMonth(newDate.getFullYear(), newDate.getMonth()); + const nextMonthSpilloverDays = FULL_MONTH_SLOTS - (previousMonthSpilloverDays + currentMonthDays); + const previousMonthDays = daysInMonth(newDate.getFullYear(), newDate.getMonth() - 1) + const isCurrentMonth = datesWithinSameMonth(now, newDate); + const currentDate = now.getDate(); + + let children = dates.children; + let index = 0; + + for (let i = 0; i < FULL_MONTH_SLOTS; i++) { + children[i].clearClasses("calendar-spillover-date", "calendar-current-date"); + } + + for (let i = 0; i < previousMonthSpilloverDays; i++, index++) { + children[index].classes("calendar-spillover-date").text( + previousMonthDays - previousMonthSpilloverDays + i + 1 + ) + } + + for (let i = 1; i <= currentMonthDays; i++, index++) { + children[index] + .classesIf(isCurrentMonth && i === currentDate, "calendar-current-date") + .text(i); + } + + for (let i = 0; i < nextMonthSpilloverDays; i++, index++) { + children[index].classes("calendar-spillover-date").text(i + 1); + } + + lastRenderedDate = newDate; + }; + + const update = function(now, newDate) { + if (lastRenderedDate === undefined || datesWithinSameMonth(newDate, lastRenderedDate)) { + updateFullMonth(now, newDate); + return; + } + + const next = newDate > lastRenderedDate; + dates.animateUpdate( + () => updateFullMonth(now, newDate), + next ? datesExitLeft : datesExitRight, + next ? datesEntranceRight : datesEntranceLeft, + ); + } + + return elem().append( + elem().classes("calendar-dates", "margin-top-15").append( + ...repeat(7, (i) => elem().classes("size-h6", "color-subdue").text( + WEEKDAY_ABBRS[(firstDay + i) % 7] + )) + ), + + dates = elem().classes("calendar-dates", "margin-top-3").append( + ...elem().classes("calendar-date").duplicate(FULL_MONTH_SLOTS) + ) + ).component({ update }); +} + +function datesWithinSameMonth(d1, d2) { + return d1.getFullYear() === d2.getFullYear() && d1.getMonth() === d2.getMonth(); +} + +function daysInMonth(year, month) { + return new Date(year, month + 1, 0).getDate(); +} + +function msTillNextDay(now) { + now = now || new Date(); + + return 86_400_000 - ( + now.getMilliseconds() + + now.getSeconds() * 1000 + + now.getMinutes() * 60_000 + + now.getHours() * 3_600_000 + ); +} diff --git a/internal/assets/static/main.js b/internal/glance/static/js/main.js similarity index 71% rename from internal/assets/static/main.js rename to internal/glance/static/js/main.js index 3e10b96..41d2ae3 100644 --- a/internal/assets/static/main.js +++ b/internal/glance/static/js/main.js @@ -1,30 +1,11 @@ -function throttledDebounce(callback, maxDebounceTimes, debounceDelay) { - let debounceTimeout; - let timesDebounced = 0; +import { setupPopovers } from './popover.js'; +import { setupMasonries } from './masonry.js'; +import { throttledDebounce, isElementVisible, openURLInNewTab } from './utils.js'; - return function () { - if (timesDebounced == maxDebounceTimes) { - clearTimeout(debounceTimeout); - timesDebounced = 0; - callback(); - return; - } - - clearTimeout(debounceTimeout); - timesDebounced++; - - debounceTimeout = setTimeout(() => { - timesDebounced = 0; - callback(); - }, debounceDelay); - }; -}; - - -async function fetchPageContent(pageSlug) { +async function fetchPageContent(pageData) { // TODO: handle non 200 status codes/time outs // TODO: add retries - const response = await fetch(`/api/pages/${pageSlug}/content/`); + const response = await fetch(`${pageData.baseURL}/api/pages/${pageData.slug}/content/`); const content = await response.text(); return content; @@ -68,29 +49,35 @@ function setupCarousels() { const minuteInSeconds = 60; const hourInSeconds = minuteInSeconds * 60; const dayInSeconds = hourInSeconds * 24; -const monthInSeconds = dayInSeconds * 30; -const yearInSeconds = monthInSeconds * 12; +const monthInSeconds = dayInSeconds * 30.4; +const yearInSeconds = dayInSeconds * 365; -function relativeTimeSince(timestamp) { - const delta = Math.round((Date.now() / 1000) - timestamp); +function timestampToRelativeTime(timestamp) { + let delta = Math.round((Date.now() / 1000) - timestamp); + let prefix = ""; + + if (delta < 0) { + delta = -delta; + prefix = "in "; + } if (delta < minuteInSeconds) { - return "1m"; + return prefix + "1m"; } if (delta < hourInSeconds) { - return Math.floor(delta / minuteInSeconds) + "m"; + return prefix + Math.floor(delta / minuteInSeconds) + "m"; } if (delta < dayInSeconds) { - return Math.floor(delta / hourInSeconds) + "h"; + return prefix + Math.floor(delta / hourInSeconds) + "h"; } if (delta < monthInSeconds) { - return Math.floor(delta / dayInSeconds) + "d"; + return prefix + Math.floor(delta / dayInSeconds) + "d"; } if (delta < yearInSeconds) { - return Math.floor(delta / monthInSeconds) + "mo"; + return prefix + Math.floor(delta / monthInSeconds) + "mo"; } - return Math.floor(delta / yearInSeconds) + "y"; + return prefix + Math.floor(delta / yearInSeconds) + "y"; } function updateRelativeTimeForElements(elements) @@ -103,11 +90,11 @@ function updateRelativeTimeForElements(elements) if (timestamp === undefined) continue - element.textContent = relativeTimeSince(timestamp); + element.textContent = timestampToRelativeTime(timestamp); } } -function setupSearchboxes() { +function setupSearchBoxes() { const searchWidgets = document.getElementsByClassName("search"); if (searchWidgets.length == 0) { @@ -117,12 +104,14 @@ function setupSearchboxes() { for (let i = 0; i < searchWidgets.length; i++) { const widget = searchWidgets[i]; const defaultSearchUrl = widget.dataset.defaultSearchUrl; + const newTab = widget.dataset.newTab === "true"; const inputElement = widget.getElementsByClassName("search-input")[0]; const bangElement = widget.getElementsByClassName("search-bang")[0]; const bangs = widget.querySelectorAll(".search-bangs > input"); const bangsMap = {}; const kbdElement = widget.getElementsByTagName("kbd")[0]; let currentBang = null; + let lastQuery = ""; for (let j = 0; j < bangs.length; j++) { const bang = bangs[j]; @@ -147,19 +136,26 @@ function setupSearchboxes() { query = input; searchUrlTemplate = defaultSearchUrl; } - - if (query.length == 0) { + if (query.length == 0 && currentBang == null) { return; } const url = searchUrlTemplate.replace("!QUERY!", encodeURIComponent(query)); - if (event.ctrlKey) { + if (newTab && !event.ctrlKey || !newTab && event.ctrlKey) { window.open(url, '_blank').focus(); } else { window.location.href = url; } + lastQuery = query; + inputElement.value = ""; + + return; + } + + if (event.key == "ArrowUp" && lastQuery.length > 0) { + inputElement.value = lastQuery; return; } }; @@ -170,9 +166,13 @@ function setupSearchboxes() { } const handleInput = (event) => { - const value = event.target.value.trimStart(); - const words = value.split(" "); + const value = event.target.value.trim(); + if (value in bangsMap) { + changeCurrentBang(bangsMap[value]); + return; + } + const words = value.split(" "); if (words.length >= 2 && words[0] in bangsMap) { changeCurrentBang(bangsMap[words[0]]); return; @@ -246,6 +246,66 @@ function setupDynamicRelativeTime() { }); } +function setupGroups() { + const groups = document.getElementsByClassName("widget-type-group"); + + if (groups.length == 0) { + return; + } + + for (let g = 0; g < groups.length; g++) { + const group = groups[g]; + const titles = group.getElementsByClassName("widget-header")[0].children; + const tabs = group.getElementsByClassName("widget-group-contents")[0].children; + let current = 0; + + for (let t = 0; t < titles.length; t++) { + const title = titles[t]; + + if (title.dataset.titleUrl !== undefined) { + title.addEventListener("mousedown", (event) => { + if (event.button != 1) { + return; + } + + openURLInNewTab(title.dataset.titleUrl, false); + event.preventDefault(); + }); + } + + title.addEventListener("click", () => { + if (t == current) { + if (title.dataset.titleUrl !== undefined) { + openURLInNewTab(title.dataset.titleUrl); + } + + return; + } + + for (let i = 0; i < titles.length; i++) { + titles[i].classList.remove("widget-group-title-current"); + titles[i].setAttribute("aria-selected", "false"); + tabs[i].classList.remove("widget-group-content-current"); + tabs[i].setAttribute("aria-hidden", "true"); + } + + if (current < t) { + tabs[t].dataset.direction = "right"; + } else { + tabs[t].dataset.direction = "left"; + } + + current = t; + + title.classList.add("widget-group-title-current"); + title.setAttribute("aria-selected", "true"); + tabs[t].classList.add("widget-group-content-current"); + tabs[t].setAttribute("aria-hidden", "false"); + }); + } + } +} + function setupLazyImages() { const images = document.querySelectorAll("img[loading=lazy]"); @@ -381,9 +441,9 @@ function setupCollapsibleGrids() { const button = attachExpandToggleButton(gridElement); - let cardsPerRow = 2; + let cardsPerRow; - const resolveCollapsibleItems = () => { + const resolveCollapsibleItems = () => requestAnimationFrame(() => { const hideItemsAfterIndex = cardsPerRow * collapseAfterRows; if (hideItemsAfterIndex >= gridElement.children.length) { @@ -409,14 +469,13 @@ function setupCollapsibleGrids() { child.style.removeProperty("animation-delay"); } } - }; - - afterContentReady(() => { - cardsPerRow = getCardsPerRow(); - resolveCollapsibleItems(); }); - window.addEventListener("resize", () => { + const observer = new ResizeObserver(() => { + if (!isElementVisible(gridElement)) { + return; + } + const newCardsPerRow = getCardsPerRow(); if (cardsPerRow == newCardsPerRow) { @@ -426,6 +485,8 @@ function setupCollapsibleGrids() { cardsPerRow = newCardsPerRow; resolveCollapsibleItems(); }); + + afterContentReady(() => observer.observe(gridElement)); } } @@ -477,9 +538,34 @@ function timeInZone(now, zone) { timeInZone = now } - const diffInHours = Math.round((timeInZone.getTime() - now.getTime()) / 1000 / 60 / 60); + const diffInMinutes = Math.round((timeInZone.getTime() - now.getTime()) / 1000 / 60); - return { time: timeInZone, diffInHours: diffInHours }; + return { time: timeInZone, diffInMinutes: diffInMinutes }; +} + +function zoneDiffText(diffInMinutes) { + if (diffInMinutes == 0) { + return ""; + } + + const sign = diffInMinutes < 0 ? "-" : "+"; + const signText = diffInMinutes < 0 ? "behind" : "ahead"; + + diffInMinutes = Math.abs(diffInMinutes); + + const hours = Math.floor(diffInMinutes / 60); + const minutes = diffInMinutes % 60; + const hourSuffix = hours == 1 ? "" : "s"; + + if (minutes == 0) { + return { text: `${sign}${hours}h`, title: `${hours} hour${hourSuffix} ${signText}` }; + } + + if (hours == 0) { + return { text: `${sign}${minutes}m`, title: `${minutes} minutes ${signText}` }; + } + + return { text: `${sign}${hours}h~`, title: `${hours} hour${hourSuffix} and ${minutes} minutes ${signText}` }; } function setupClocks() { @@ -522,9 +608,11 @@ function setupClocks() { ); updateCallbacks.push((now) => { - const { time, diffInHours } = timeInZone(now, timeZoneContainer.dataset.timeInZone); + const { time, diffInMinutes } = timeInZone(now, timeZoneContainer.dataset.timeInZone); setZoneTime(time); - diffElement.textContent = (diffInHours <= 0 ? diffInHours : '+' + diffInHours) + 'h'; + const { text, title } = zoneDiffText(diffInMinutes); + diffElement.textContent = text; + diffElement.title = title; }); } } @@ -541,36 +629,65 @@ function setupClocks() { updateClocks(); } +async function setupCalendars() { + const elems = document.getElementsByClassName("calendar"); + if (elems.length == 0) return; + + // TODO: implement prefetching, currently loads as a nasty waterfall of requests + const calendar = await import ('./calendar.js'); + + for (let i = 0; i < elems.length; i++) + calendar.default(elems[i]); +} + +function setupTruncatedElementTitles() { + const elements = document.querySelectorAll(".text-truncate, .single-line-titles .title, .text-truncate-2-lines, .text-truncate-3-lines"); + + if (elements.length == 0) { + return; + } + + for (let i = 0; i < elements.length; i++) { + const element = elements[i]; + if (element.getAttribute("title") === null) element.title = element.textContent; + } +} + async function setupPage() { const pageElement = document.getElementById("page"); const pageContentElement = document.getElementById("page-content"); - const pageContent = await fetchPageContent(pageData.slug); + const pageContent = await fetchPageContent(pageData); pageContentElement.innerHTML = pageContent; try { + setupPopovers(); setupClocks() + await setupCalendars(); setupCarousels(); - setupSearchboxes(); + setupSearchBoxes(); setupCollapsibleLists(); setupCollapsibleGrids(); + setupGroups(); + setupMasonries(); setupDynamicRelativeTime(); setupLazyImages(); } finally { pageElement.classList.add("content-ready"); + pageElement.setAttribute("aria-busy", "false"); for (let i = 0; i < contentReadyCallbacks.length; i++) { contentReadyCallbacks[i](); } + setTimeout(() => { + setupTruncatedElementTitles(); + }, 50); + setTimeout(() => { document.body.classList.add("page-columns-transitioned"); }, 300); } } -if (document.readyState === "loading") { - document.addEventListener("DOMContentLoaded", setupPage); -} else { - setupPage(); -} +setupPage(); diff --git a/internal/glance/static/js/masonry.js b/internal/glance/static/js/masonry.js new file mode 100644 index 0000000..45680f4 --- /dev/null +++ b/internal/glance/static/js/masonry.js @@ -0,0 +1,53 @@ + +import { clamp } from "./utils.js"; + +export function setupMasonries() { + const masonryContainers = document.getElementsByClassName("masonry"); + + for (let i = 0; i < masonryContainers.length; i++) { + const container = masonryContainers[i]; + + const options = { + minColumnWidth: container.dataset.minColumnWidth || 330, + maxColumns: container.dataset.maxColumns || 6, + }; + + const items = Array.from(container.children); + let previousColumnsCount = 0; + + const render = function() { + const columnsCount = clamp( + Math.floor(container.offsetWidth / options.minColumnWidth), + 1, + Math.min(options.maxColumns, items.length) + ); + + if (columnsCount === previousColumnsCount) { + return; + } else { + container.textContent = ""; + previousColumnsCount = columnsCount; + } + + const columnsFragment = document.createDocumentFragment(); + + for (let i = 0; i < columnsCount; i++) { + const column = document.createElement("div"); + column.className = "masonry-column"; + columnsFragment.append(column); + } + + // poor man's masonry + // TODO: add an option that allows placing items in the + // shortest column instead of iterating the columns in order + for (let i = 0; i < items.length; i++) { + columnsFragment.children[i % columnsCount].appendChild(items[i]); + } + + container.append(columnsFragment); + }; + + const observer = new ResizeObserver(() => requestAnimationFrame(render)); + observer.observe(container); + } +} diff --git a/internal/glance/static/js/popover.js b/internal/glance/static/js/popover.js new file mode 100644 index 0000000..331ee26 --- /dev/null +++ b/internal/glance/static/js/popover.js @@ -0,0 +1,187 @@ +const defaultShowDelayMs = 200; +const defaultHideDelayMs = 500; +const defaultMaxWidth = "300px"; +const defaultDistanceFromTarget = "0px" +const htmlContentSelector = "[data-popover-html]"; + +let activeTarget = null; +let pendingTarget = null; +let cleanupOnHidePopover = null; +let togglePopoverTimeout = null; + +const containerElement = document.createElement("div"); +const containerComputedStyle = getComputedStyle(containerElement); +containerElement.addEventListener("mouseenter", clearTogglePopoverTimeout); +containerElement.addEventListener("mouseleave", handleMouseLeave); +containerElement.classList.add("popover-container"); + +const frameElement = document.createElement("div"); +frameElement.classList.add("popover-frame"); + +const contentElement = document.createElement("div"); +contentElement.classList.add("popover-content"); + +frameElement.append(contentElement); +containerElement.append(frameElement); +document.body.append(containerElement); + +const queueRepositionContainer = () => requestAnimationFrame(repositionContainer); +const observer = new ResizeObserver(queueRepositionContainer); + +function handleMouseEnter(event) { + clearTogglePopoverTimeout(); + const target = event.target; + pendingTarget = target; + const showDelay = target.dataset.popoverShowDelay || defaultShowDelayMs; + + if (activeTarget !== null) { + if (activeTarget !== target) { + hidePopover(); + requestAnimationFrame(() => requestAnimationFrame(showPopover)); + } + + return; + } + + togglePopoverTimeout = setTimeout(showPopover, showDelay); +} + +function handleMouseLeave(event) { + clearTogglePopoverTimeout(); + const target = activeTarget || event.target; + togglePopoverTimeout = setTimeout(hidePopover, target.dataset.popoverHideDelay || defaultHideDelayMs); +} + +function clearTogglePopoverTimeout() { + clearTimeout(togglePopoverTimeout); +} + +function showPopover() { + if (pendingTarget === null) return; + + activeTarget = pendingTarget; + pendingTarget = null; + + const popoverType = activeTarget.dataset.popoverType; + + if (popoverType === "text") { + const text = activeTarget.dataset.popoverText; + if (text === undefined || text === "") return; + contentElement.textContent = text; + } else if (popoverType === "html") { + const htmlContent = activeTarget.querySelector(htmlContentSelector); + if (htmlContent === null) return; + /** + * The reason for all of the below shenanigans is that I want to preserve + * all attached event listeners of the original HTML content. This is so I don't have to + * re-setup events for things like lazy images, they'd just work as expected. + */ + const placeholder = document.createComment(""); + htmlContent.replaceWith(placeholder); + contentElement.replaceChildren(htmlContent); + htmlContent.removeAttribute("data-popover-html"); + cleanupOnHidePopover = () => { + htmlContent.setAttribute("data-popover-html", ""); + placeholder.replaceWith(htmlContent); + placeholder.remove(); + }; + } else { + return; + } + + const contentMaxWidth = activeTarget.dataset.popoverMaxWidth || defaultMaxWidth; + + if (activeTarget.dataset.popoverTextAlign !== undefined) { + contentElement.style.textAlign = activeTarget.dataset.popoverTextAlign; + } else { + contentElement.style.removeProperty("text-align"); + } + + contentElement.style.maxWidth = contentMaxWidth; + activeTarget.classList.add("popover-active"); + document.addEventListener("keydown", handleHidePopoverOnEscape); + window.addEventListener("resize", queueRepositionContainer); + observer.observe(containerElement); +} + +function repositionContainer() { + containerElement.style.display = "block"; + + const targetBounds = activeTarget.dataset.popoverAnchor !== undefined + ? activeTarget.querySelector(activeTarget.dataset.popoverAnchor).getBoundingClientRect() + : activeTarget.getBoundingClientRect(); + + const containerBounds = containerElement.getBoundingClientRect(); + const containerInlinePadding = parseInt(containerComputedStyle.getPropertyValue("padding-inline")); + const targetBoundsWidthOffset = targetBounds.width * (activeTarget.dataset.popoverTargetOffset || 0.5); + const position = activeTarget.dataset.popoverPosition || "below"; + const popoverOffest = activeTarget.dataset.popoverOffset || 0.5; + const left = Math.round(targetBounds.left + targetBoundsWidthOffset - (containerBounds.width * popoverOffest)); + + if (left < 0) { + containerElement.style.left = 0; + containerElement.style.removeProperty("right"); + containerElement.style.setProperty("--triangle-offset", targetBounds.left - containerInlinePadding + targetBoundsWidthOffset + "px"); + } else if (left + containerBounds.width > window.innerWidth) { + containerElement.style.removeProperty("left"); + containerElement.style.right = 0; + containerElement.style.setProperty("--triangle-offset", containerBounds.width - containerInlinePadding - (window.innerWidth - targetBounds.left - targetBoundsWidthOffset) + -1 + "px"); + } else { + containerElement.style.removeProperty("right"); + containerElement.style.left = left + "px"; + containerElement.style.setProperty("--triangle-offset", ((targetBounds.left + targetBoundsWidthOffset) - left - containerInlinePadding) + -1 + "px"); + } + + const distanceFromTarget = activeTarget.dataset.popoverMargin || defaultDistanceFromTarget; + const topWhenAbove = targetBounds.top + window.scrollY - containerBounds.height; + const topWhenBelow = targetBounds.top + window.scrollY + targetBounds.height; + + if ( + position === "above" && topWhenAbove > window.scrollY || + (position === "below" && topWhenBelow + containerBounds.height > window.scrollY + window.innerHeight) + ) { + containerElement.classList.add("position-above"); + frameElement.style.removeProperty("margin-top"); + frameElement.style.marginBottom = distanceFromTarget; + containerElement.style.top = topWhenAbove + "px"; + } else { + containerElement.classList.remove("position-above"); + frameElement.style.removeProperty("margin-bottom"); + frameElement.style.marginTop = distanceFromTarget; + containerElement.style.top = topWhenBelow + "px"; + } +} + +function hidePopover() { + if (activeTarget === null) return; + + activeTarget.classList.remove("popover-active"); + containerElement.style.display = "none"; + document.removeEventListener("keydown", handleHidePopoverOnEscape); + window.removeEventListener("resize", queueRepositionContainer); + observer.unobserve(containerElement); + + if (cleanupOnHidePopover !== null) { + cleanupOnHidePopover(); + cleanupOnHidePopover = null; + } + + activeTarget = null; +} + +function handleHidePopoverOnEscape(event) { + if (event.key === "Escape") { + hidePopover(); + } +} + +export function setupPopovers() { + const targets = document.querySelectorAll("[data-popover-type]"); + + for (let i = 0; i < targets.length; i++) { + const target = targets[i]; + + target.addEventListener("mouseenter", handleMouseEnter); + target.addEventListener("mouseleave", handleMouseLeave); + } +} diff --git a/internal/glance/static/js/templating.js b/internal/glance/static/js/templating.js new file mode 100644 index 0000000..05824bc --- /dev/null +++ b/internal/glance/static/js/templating.js @@ -0,0 +1,190 @@ +export function elem(tag = "div") { + return document.createElement(tag); +} + +export function fragment(...children) { + const f = document.createDocumentFragment(); + if (children) f.append(...children); + return f; +} + +export function text(str = "") { + return document.createTextNode(str); +} + +export function repeat(n, fn) { + const elems = Array(n); + + for (let i = 0; i < n; i++) + elems[i] = fn(i); + + return elems; +} + +export function find(selector) { + return document.querySelector(selector); +} + +export function findAll(selector) { + return document.querySelectorAll(selector); +} + +const ep = HTMLElement.prototype; +const fp = DocumentFragment.prototype; +const tp = Text.prototype; + +ep.classes = function(...classes) { + this.classList.add(...classes); + return this; +} + +ep.find = function(selector) { + return this.querySelector(selector); +} + +ep.findAll = function(selector) { + return this.querySelectorAll(selector); +} + +ep.classesIf = function(cond, ...classes) { + cond ? this.classList.add(...classes) : this.classList.remove(...classes); + return this; +} + +ep.hide = function() { + this.style.display = "none"; + return this; +} + +ep.show = function() { + this.style.removeProperty("display"); + return this; +} + +ep.showIf = function(cond) { + cond ? this.show() : this.hide(); + return this; +} + +ep.isHidden = function() { + return this.style.display === "none"; +} + +ep.clearClasses = function(...classes) { + classes.length ? this.classList.remove(...classes) : this.className = ""; + return this; +} + +ep.hasClass = function(className) { + return this.classList.contains(className); +} + +ep.attr = function(name, value) { + this.setAttribute(name, value); + return this; +} + +ep.attrs = function(attrs) { + for (const [name, value] of Object.entries(attrs)) + this.setAttribute(name, value); + return this; +} + +ep.tap = function(fn) { + fn(this); + return this; +} + +ep.text = function(text) { + this.innerText = text; + return this; +} + +ep.html = function(html) { + this.innerHTML = html; + return this; +} + +ep.appendTo = function(parent) { + parent.appendChild(this); + return this; +} + +ep.swap = function(element) { + this.replaceWith(element); + return element; +} + +ep.on = function(event, callback, options) { + if (typeof event === "string") { + this.addEventListener(event, callback, options); + return this; + } + + for (let i = 0; i < event.length; i++) + this.addEventListener(event[i], callback, options); + + return this; +} + +const epAppend = ep.append; +ep.append = function(...children) { + epAppend.apply(this, children); + return this; +} + +ep.duplicate = function(n) { + const elems = Array(n); + + for (let i = 0; i < n; i++) + elems[i] = this.cloneNode(true); + + return elems; +} + +ep.styles = function(s) { + Object.assign(this.style, s); + return this; +} + +const epAnimate = ep.animate; +ep.animate = function(anim, callback) { + const a = epAnimate.call(this, anim.keyframes, anim.options); + if (callback) a.onfinish = () => callback(this, a); + return this; +} + +ep.animateUpdate = function(update, exit, entrance) { + this.animate(exit, () => { + update(this); + this.animate(entrance); + }); + + return this; +} + +ep.styleVar = function(name, value) { + this.style.setProperty(`--${name}`, value); + return this; +} + +ep.component = function (methods) { + this.component = methods; + return this; +} + +const fpAppend = fp.append; +fp.append = function(...children) { + fpAppend.apply(this, children); + return this; +} + +fp.appendTo = function(parent) { + parent.appendChild(this); + return this; +} + +tp.text = function(text) { + this.nodeValue = text; + return this; +} diff --git a/internal/glance/static/js/utils.js b/internal/glance/static/js/utils.js new file mode 100644 index 0000000..1d1816a --- /dev/null +++ b/internal/glance/static/js/utils.js @@ -0,0 +1,38 @@ +export function throttledDebounce(callback, maxDebounceTimes, debounceDelay) { + let debounceTimeout; + let timesDebounced = 0; + + return function () { + if (timesDebounced == maxDebounceTimes) { + clearTimeout(debounceTimeout); + timesDebounced = 0; + callback(); + return; + } + + clearTimeout(debounceTimeout); + timesDebounced++; + + debounceTimeout = setTimeout(() => { + timesDebounced = 0; + callback(); + }, debounceDelay); + }; +}; + +export function isElementVisible(element) { + return !!(element.offsetWidth || element.offsetHeight || element.getClientRects().length); +} + +export function clamp(value, min, max) { + return Math.min(Math.max(value, min), max); +} + +// NOTE: inconsistent behavior between browsers when it comes to +// whether the newly opened tab gets focused or not, potentially +// depending on the event that this function is called from +export function openURLInNewTab(url, focus = true) { + const newWindow = window.open(url, '_blank', 'noopener,noreferrer'); + + if (focus && newWindow != null) newWindow.focus(); +} diff --git a/internal/assets/static/main.css b/internal/glance/static/main.css similarity index 64% rename from internal/assets/static/main.css rename to internal/glance/static/main.css index ccad001..2975a73 100644 --- a/internal/assets/static/main.css +++ b/internal/glance/static/main.css @@ -17,7 +17,7 @@ --cm: 1; --tsm: 1; - --widget-gap: 25px; + --widget-gap: 23px; --widget-content-vertical-padding: 15px; --widget-content-horizontal-padding: 17px; --widget-content-padding: var(--widget-content-vertical-padding) var(--widget-content-horizontal-padding); @@ -34,11 +34,17 @@ --color-separator: hsl(var(--bghs), calc(var(--scheme) ((var(--scheme) var(--bgl)) + 4% * var(--cm)))); --color-widget-content-border: hsl(var(--bghs), calc(var(--scheme) (var(--scheme) var(--bgl) + 4%))); --color-widget-background-highlight: hsl(var(--bghs), calc(var(--scheme) (var(--scheme) var(--bgl) + 4%))); + --color-popover-background: hsl(var(--bgh), calc(var(--bgs) + 3%), calc(var(--bgl) + 3%)); + --color-popover-border: hsl(var(--bghs), calc(var(--scheme) (var(--scheme) var(--bgl) + 12%))); + --color-progress-border: hsl(var(--bghs), calc(var(--scheme) ((var(--scheme) var(--bgl)) + 10% * var(--cm)))); + --color-progress-value: hsl(var(--bgh), calc(var(--bgs) * var(--tsm)), calc(var(--scheme) ((var(--scheme) var(--bgl)) + 30% * var(--cm)))); + --color-graph-gridlines: hsl(var(--bghs), calc(var(--scheme) ((var(--scheme) var(--bgl)) + 6% * var(--cm)))); --ths: var(--bgh), calc(var(--bgs) * var(--tsm)); + --color-text-highlight: hsl(var(--ths), calc(var(--scheme) var(--cm) * 85%)); + --color-text-paragraph: hsl(var(--ths), calc(var(--scheme) var(--cm) * 73%)); --color-text-base: hsl(var(--ths), calc(var(--scheme) var(--cm) * 58%)); --color-text-base-muted: hsl(var(--ths), calc(var(--scheme) var(--cm) * 52%)); - --color-text-highlight: hsl(var(--ths), calc(var(--scheme) var(--cm) * 85%)); --color-text-subdue: hsl(var(--ths), calc(var(--scheme) var(--cm) * 35%)); --font-size-h1: 1.7rem; @@ -54,8 +60,9 @@ --scheme: 100% -; } -.size-title-dynamic { - font-size: var(--font-size-h4); +.page { + height: 100%; + padding-block: var(--widget-gap); } .page-content, .page.content-ready .page-loading-container { @@ -66,6 +73,10 @@ display: block; } +.page-column-small .size-title-dynamic { + font-size: var(--font-size-h4); +} + .page-column-full .size-title-dynamic { font-size: var(--font-size-h3); } @@ -74,12 +85,18 @@ color: var(--color-primary); } -.text-truncate { +.text-truncate, +.single-line-titles .title +{ overflow: hidden; text-overflow: ellipsis; white-space: nowrap; } +.single-line-titles .title { + display: block; +} + .text-truncate-2-lines, .text-truncate-3-lines { overflow: hidden; text-overflow: ellipsis; @@ -87,13 +104,13 @@ -webkit-box-orient: vertical; } -.text-truncate-3-lines { -webkit-line-clamp: 3; } -.text-truncate-2-lines { -webkit-line-clamp: 2; } +.text-truncate-3-lines { line-clamp: 3; -webkit-line-clamp: 3; } +.text-truncate-2-lines { line-clamp: 2; -webkit-line-clamp: 2; } .visited-indicator:not(.text-truncate)::after, .visited-indicator.text-truncate::before, .bookmarks-link:not(.bookmarks-link-no-arrow)::after { - content: '↗'; + content: '↗' / ""; margin-left: 0.5em; display: inline-block; position: relative; @@ -110,20 +127,20 @@ color: var(--color-primary); } -.list { --list-half-gap: 0rem; } -.list-gap-2 { --list-half-gap: 0.1rem; } -.list-gap-4 { --list-half-gap: 0.2rem; } -.list-gap-10 { --list-half-gap: 0.5rem; } -.list-gap-14 { --list-half-gap: 0.7rem; } -.list-gap-20 { --list-half-gap: 1rem; } -.list-gap-24 { --list-half-gap: 1.2rem; } -.list-gap-34 { --list-half-gap: 1.7rem; } +.page-columns-transitioned .list-with-transition > * { animation: collapsibleItemReveal .25s backwards; } +.list-with-transition > *:nth-child(2) { animation-delay: 30ms; } +.list-with-transition > *:nth-child(3) { animation-delay: 60ms; } +.list-with-transition > *:nth-child(4) { animation-delay: 90ms; } +.list-with-transition > *:nth-child(5) { animation-delay: 120ms; } +.list-with-transition > *:nth-child(6) { animation-delay: 150ms; } +.list-with-transition > *:nth-child(7) { animation-delay: 180ms; } +.list-with-transition > *:nth-child(8) { animation-delay: 210ms; } .list > *:not(:first-child) { margin-top: calc(var(--list-half-gap) * 2); } -.list-with-separator > *:not(:first-child) { +.list.list-with-separator > *:not(:first-child) { margin-top: var(--list-half-gap); border-top: 1px solid var(--color-separator); padding-top: var(--list-half-gap); @@ -172,7 +189,7 @@ } .expand-toggle-button-icon::before { - content: ''; + content: '' / ""; font-size: 0.8rem; transform: rotate(90deg); line-height: 1; @@ -184,6 +201,56 @@ transform: rotate(-90deg); } +.widget-group-header { + overflow-x: auto; + scrollbar-width: thin; +} + +.widget-group-title { + background: none; + font: inherit; + border: none; + text-transform: uppercase; + border-bottom: 1px dotted transparent; + cursor: pointer; + flex-shrink: 0; + transition: color .3s, border-color .3s; + color: var(--color-text-subdue); + line-height: calc(1.6em - 1px); +} + +.widget-group-title:hover:not(.widget-group-title-current) { + color: var(--color-text-base); +} + +.widget-group-title-current { + border-bottom-color: var(--color-text-base-muted); + color: var(--color-text-base); +} + +.widget-group-content { + animation: widgetGroupContentEntrance .3s cubic-bezier(0.25, 1, 0.5, 1) backwards; +} + +.widget-group-content[data-direction="right"] { + --direction: 5px; +} + +.widget-group-content[data-direction="left"] { + --direction: -5px; +} + +@keyframes widgetGroupContentEntrance { + from { + opacity: 0; + transform: translateX(var(--direction)); + } +} + +.widget-group-content:not(.widget-group-content-current) { + display: none; +} + .widget-content:has(.expand-toggle-button:last-child) { padding-bottom: 0; } @@ -207,6 +274,10 @@ background-color: var(--color-separator); } +pre { + font: inherit; +} + ::selection { background-color: hsl(var(--bghs), calc(var(--scheme) (var(--scheme) var(--bgl) + 20%))); color: var(--color-text-highlight); @@ -223,6 +294,12 @@ width: 10px; } +*:focus-visible { + outline: 2px solid var(--color-primary); + outline-offset: 0.1rem; + border-radius: var(--border-radius); +} + *, *::before, *::after { box-sizing: border-box; } @@ -260,9 +337,27 @@ html { scroll-behavior: smooth; } +html, body, .body-content { + height: 100%; +} + +h1, h2, h3, h4, h5 { + font: inherit; +} + +.visually-hidden { + clip-path: inset(50%); + height: 1px; + overflow: hidden; + position: absolute; + white-space: nowrap; + width: 1px; +} + a { text-decoration: none; color: inherit; + overflow-wrap: break-word; } ul { @@ -292,7 +387,6 @@ body { .page-columns { display: flex; gap: var(--widget-gap); - margin: var(--widget-gap) 0; animation: pageColumnsEntrance .3s cubic-bezier(0.25, 1, 0.5, 1) backwards; } @@ -304,13 +398,19 @@ body { } .page-loading-container { - margin: 50px auto; - width: fit-content; + height: 100%; + display: flex; + align-items: center; + justify-content: center; animation: loadingContainerEntrance 200ms backwards; animation-delay: 150ms; font-size: 2rem; } +.page-loading-container > .loading-icon { + translate: 0 -250%; +} + @keyframes loadingContainerEntrance { from { opacity: 0; @@ -333,12 +433,6 @@ body { } } -@keyframes loadingIconSpin { - to { - transform: rotate(360deg); - } -} - .notice-icon { width: 0.7rem; height: 0.7rem; @@ -370,23 +464,175 @@ kbd:active { box-shadow: 0 0 0 0 var(--color-widget-background-highlight); } +.masonry { + display: flex; + gap: var(--widget-gap); +} + +.masonry-column { + flex: 1; + display: flex; + flex-direction: column; +} + +.popover-container, [data-popover-html] { + display: none; +} + +.popover-container { + --triangle-size: 10px; + --triangle-offset: 50%; + --triangle-margin: calc(var(--triangle-size) + 3px); + --entrance-y-offset: 8px; + --entrance-direction: calc(var(--entrance-y-offset) * -1); + + z-index: 20; + position: absolute; + padding-top: var(--triangle-margin); + padding-inline: var(--content-bounds-padding); +} + +.popover-container.position-above { + --entrance-direction: var(--entrance-y-offset); + padding-top: 0; + padding-bottom: var(--triangle-margin); +} + +.popover-frame { + --shadow-properties: 0 15px 20px -10px; + --shadow-color: hsla(var(--bghs), calc(var(--bgl) * 0.2), 0.5); + position: relative; + padding: 10px; + background: var(--color-popover-background); + border: 1px solid var(--color-popover-border); + border-radius: 5px; + animation: popoverFrameEntrance 0.3s backwards cubic-bezier(0.16, 1, 0.3, 1); + box-shadow: var(--shadow-properties) var(--shadow-color); +} + +.popover-frame::before { + content: ''; + position: absolute; + width: var(--triangle-size); + height: var(--triangle-size); + transform: rotate(45deg); + background-color: var(--color-popover-background); + border-top-left-radius: 2px; + border-left: 1px solid var(--color-popover-border); + border-top: 1px solid var(--color-popover-border); + left: calc(var(--triangle-offset) - (var(--triangle-size) / 2)); + top: calc(var(--triangle-size) / 2 * -1 - 1px); +} + +.popover-container.position-above .popover-frame::before { + transform: rotate(-135deg); + top: auto; + bottom: calc(var(--triangle-size) / 2 * -1 - 1px); +} + +.popover-container.position-above .popover-frame { + --shadow-properties: 0 10px 20px -10px; +} + +@keyframes popoverFrameEntrance { + from { + opacity: 0; + transform: translateY(var(--entrance-direction)); + } +} + +.summary { + width: 100%; + cursor: pointer; + word-spacing: -0.18em; + user-select: none; + list-style: none; + position: relative; + display: flex; + z-index: 1; +} + +.summary::-webkit-details-marker { + display: none; +} + +.details[open] .summary { + margin-bottom: .8rem; +} + +.summary::before { + content: ""; + position: absolute; + inset: -.3rem -.8rem; + border-radius: var(--border-radius); + background-color: var(--color-widget-background-highlight); + opacity: 0; + transition: opacity 0.2s; + z-index: -1; +} + +.details[open] .summary::before, .summary:hover::before { + opacity: 1; +} + +.details:not([open]) .list-with-transition { + display: none; +} + +.summary::after { + content: "◀" / ""; + font-size: 1.2em; + position: absolute; + top: 0; + bottom: 0; + line-height: 1.3em; + right: 0; + transition: rotate .5s cubic-bezier(0.22, 1, 0.36, 1); +} + +details[open] .summary::after { + rotate: -90deg; +} + .content-bounds { max-width: 1600px; + width: 100%; margin-inline: auto; padding: 0 var(--content-bounds-padding); } +.page-width-wide .content-bounds { + max-width: 1920px; +} + +.page-width-slim .content-bounds { + max-width: 1100px; +} + +.page-center-vertically .page { + display: flex; + justify-content: center; + flex-direction: column; +} + +/* TODO: refactor, otherwise I hope I never have to change dynamic columns again */ .dynamic-columns { - gap: calc(var(--widget-content-vertical-padding) / 2); + --list-half-gap: 0.5rem; + gap: var(--widget-content-vertical-padding) var(--widget-content-horizontal-padding); display: grid; grid-template-columns: repeat(var(--columns-per-row), 1fr); - margin: calc(0px - var(--widget-content-vertical-padding) / 2) calc(0px - var(--widget-content-horizontal-padding) / 2); } .dynamic-columns > * { - padding: calc(var(--widget-content-vertical-padding) / 2) calc(var(--widget-content-horizontal-padding) / 1.5); - background-color: var(--color-background); - border-radius: var(--border-radius); + padding-left: var(--widget-content-horizontal-padding); + border-left: 1px solid var(--color-separator); + min-width: 0; +} + +.dynamic-columns > *:first-child { + padding-top: 0; + border-top: none; + border-left: none; } .dynamic-columns:has(> :nth-child(1)) { --columns-per-row: 1; } @@ -395,23 +641,49 @@ kbd:active { .dynamic-columns:has(> :nth-child(4)) { --columns-per-row: 4; } .dynamic-columns:has(> :nth-child(5)) { --columns-per-row: 5; } -@container widget (max-width: 1500px) { +@container widget (max-width: 599px) { + .dynamic-columns { gap: 0; } .dynamic-columns:has(> :nth-child(1)) { --columns-per-row: 1; } + .dynamic-columns > * { + border-left: none; + padding-left: 0; + } + .dynamic-columns > *:not(:first-child) { + margin-top: calc(var(--list-half-gap) * 2); + } + .dynamic-columns.list-with-separator > *:not(:first-child) { + margin-top: var(--list-half-gap); + border-top: 1px solid var(--color-separator); + padding-top: var(--list-half-gap); + } +} +@container widget (min-width: 600px) and (max-width: 849px) { .dynamic-columns:has(> :nth-child(2)) { --columns-per-row: 2; } + .dynamic-columns > :nth-child(2n-1) { + border-left: none; + padding-left: 0; + } +} +@container widget (min-width: 850px) and (max-width: 1249px) { .dynamic-columns:has(> :nth-child(3)) { --columns-per-row: 3; } + .dynamic-columns > :nth-child(3n+1) { + border-left: none; + padding-left: 0; + } +} +@container widget (min-width: 1250px) and (max-width: 1499px) { .dynamic-columns:has(> :nth-child(4)) { --columns-per-row: 4; } + .dynamic-columns > :nth-child(4n+1) { + border-left: none; + padding-left: 0; + } } -@container widget (max-width: 1250px) { - .dynamic-columns:has(> :nth-child(1)) { --columns-per-row: 1; } - .dynamic-columns:has(> :nth-child(2)) { --columns-per-row: 2; } - .dynamic-columns:has(> :nth-child(3)) { --columns-per-row: 3; } -} -@container widget (max-width: 850px) { - .dynamic-columns:has(> :nth-child(1)) { --columns-per-row: 1; } - .dynamic-columns:has(> :nth-child(2)) { --columns-per-row: 2; } -} -@container widget (max-width: 550px) { - .dynamic-columns:has(> :nth-child(1)) { --columns-per-row: 1; } +@container widget (min-width: 1500px) { + .dynamic-columns:has(> :nth-child(5)) { --columns-per-row: 5; } + .dynamic-columns > :nth-child(5n+1) { + border-left: none; + padding-left: 0; + } } .cards-vertical { @@ -444,6 +716,7 @@ kbd:active { .cards-horizontal { overflow-x: auto; + scrollbar-width: thin; padding-bottom: 1rem; } @@ -467,7 +740,10 @@ kbd:active { @container widget (max-width: 750px) { .cards-grid { --cards-per-row: 3; } } @container widget (max-width: 650px) { .cards-grid { --cards-per-row: 2; } } - +.widget-small-content-bounds { + max-width: 350px; + margin: 0 auto; +} .widget-error-header { display: flex; @@ -475,6 +751,7 @@ kbd:active { justify-content: space-between; position: relative; margin-bottom: 1.8rem; + z-index: 1; } .widget-error-header::before { @@ -490,19 +767,11 @@ kbd:active { .widget-error-icon { width: 2.4rem; height: 2.4rem; - border: 0.2rem solid var(--color-negative); - border-radius: 50%; - text-align: center; - line-height: 2rem; flex-shrink: 0; + stroke: var(--color-negative); opacity: 0.6; } -.widget-error-icon::before { - content: '!'; - color: var(--color-text-highlight); -} - .widget-content { container-type: inline-size; container-name: widget; @@ -538,12 +807,26 @@ kbd:active { .widget-header { padding: 0 calc(var(--widget-content-horizontal-padding) + 1px); font-size: var(--font-size-h4); - margin-bottom: 1rem; + margin-bottom: 0.9rem; display: flex; align-items: center; gap: 1rem; } +.widget-beta-icon { + width: 1.6rem; + height: 1.6rem; + flex-shrink: 0; + transition: transform .45s, opacity .45s, stroke .45s; + opacity: 0.7; +} + +.widget-beta-icon:hover, .widget-header .popover-active > .widget-beta-icon { + fill: var(--color-text-highlight); + transform: translateY(-10%) scale(1.3); + opacity: 1; +} + .widget + .widget { margin-top: var(--widget-gap); } @@ -556,9 +839,9 @@ kbd:active { } .list-horizontal-text > *:not(:last-child)::after { - content: '•'; + content: '•' / ""; color: var(--color-text-subdue); - margin: 0 0.5rem; + margin: 0 0.4rem; position: relative; top: 0.1rem; } @@ -584,6 +867,15 @@ kbd:active { padding-right: var(--widget-content-horizontal-padding); } +.logo:has(img) { + display: flex; + align-items: center; +} + +.logo img { + max-height: 2.7rem; +} + .nav { height: 100%; gap: var(--header-items-gap); @@ -594,7 +886,8 @@ kbd:active { } .footer { - margin-block: calc(var(--widget-gap) * 1.5); + padding-bottom: calc(var(--widget-gap) * 1.5); + padding-top: calc(var(--widget-gap) / 2); animation: loadingContainerEntrance 200ms backwards; animation-delay: 150ms; } @@ -609,6 +902,7 @@ kbd:active { border-bottom: 2px solid transparent; transition: color .3s, border-color .3s; font-size: var(--font-size-h3); + flex-shrink: 0; } .nav-item:not(.nav-item-current):hover { @@ -621,9 +915,17 @@ kbd:active { color: var(--color-text-highlight); } +.release-source-icon { + width: 16px; + height: 16px; + flex-shrink: 0; + opacity: 0.4; +} + .market-chart { margin-left: auto; width: 6.5rem; + flex-shrink: 0; } .market-chart svg { @@ -671,14 +973,11 @@ kbd:active { border-radius: var(--border-radius) var(--border-radius) 0 0; } -.video-title { - margin-bottom: auto; - overflow: hidden; - display: block; - text-overflow: ellipsis; - -webkit-line-clamp: 2; - display: -webkit-box; - -webkit-box-orient: vertical; +.video-horizontal-list-thumbnail { + height: 4rem; + aspect-ratio: 16 / 8.9; + object-fit: cover; + border-radius: var(--border-radius); } .search-icon { @@ -761,11 +1060,6 @@ kbd:active { display: none; } -.forum-post-list-item { - display: flex; - gap: 1.2rem; -} - .forum-post-list-thumbnail { flex-shrink: 0; width: 6rem; @@ -780,6 +1074,12 @@ kbd:active { transform: translateY(-0.15rem); } +@container widget (max-width: 550px) { + .forum-post-autohide { + display: none; + } +} + .bookmarks-group { --bookmarks-group-color: var(--color-primary); } @@ -797,6 +1097,8 @@ kbd:active { background-color: var(--color-widget-background-highlight); border-radius: var(--border-radius); padding: 0.5rem; + opacity: 0.7; + flex-shrink: 0; } .bookmarks-icon { @@ -805,26 +1107,203 @@ kbd:active { opacity: 0.8; } -.simple-icon { - opacity: 0.7; -} - -:root:not(.light-scheme) .simple-icon { +:root:not(.light-scheme) .flat-icon { filter: invert(1); } -.calendar-day { +.old-calendar-day { width: calc(100% / 7); text-align: center; padding: 0.6rem 0; } -.calendar-day-today { +.old-calendar-day-today { border-radius: var(--border-radius); background-color: hsl(var(--bghs), calc(var(--scheme) (var(--scheme) (var(--bgl)) + 6%))); color: var(--color-text-highlight); } +.calendar-dates { + text-align: center; + display: grid; + grid-template-columns: repeat(7, 1fr); + gap: 2px; +} + +.calendar-date { + padding: 0.4rem 0; + color: var(--color-text-base); + position: relative; + border-radius: var(--border-radius); + background: none; + border: none; + font: inherit; +} + +.calendar-current-date { + border-radius: var(--border-radius); + background-color: var(--color-popover-border); + color: var(--color-text-highlight); +} + +.calendar-spillover-date { + color: var(--color-text-subdue); +} + +.calendar-header-button { + position: relative; + cursor: pointer; + width: 2rem; + height: 2rem; + z-index: 1; + background: none; + border: none; +} + +.calendar-header-button::before { + content: ''; + position: absolute; + inset: -0.2rem; + border-radius: var(--border-radius); + background-color: var(--color-text-subdue); + opacity: 0; + transition: opacity 0.2s; + z-index: -1; +} + +.calendar-header-button:hover::before { + opacity: 0.4; +} + +.calendar-undo-button { + display: inline-block; + vertical-align: text-top; + width: 2rem; + height: 2rem; + margin-left: 0.7rem; +} + +.dns-stats-totals { + transition: opacity .3s; + transition-delay: 50ms; +} + +.dns-stats:has(.dns-stats-graph .popover-active) .dns-stats-totals { + opacity: 0.1; + transition-delay: 0s; +} + +.dns-stats-graph { + --graph-height: 70px; + height: var(--graph-height); + position: relative; + margin-bottom: 2.5rem; +} + +.dns-stats-graph-gridlines-container { + position: absolute; + inset: 0; +} + +.dns-stats-graph-gridlines { + height: 100%; + width: 100%; +} + +.dns-stats-graph-columns { + display: flex; + height: 100%; +} + +.dns-stats-graph-column { + display: flex; + justify-content: flex-end; + align-items: center; + flex-direction: column; + width: calc(100% / 8); + position: relative; +} + +.dns-stats-graph-column::before { + content: ''; + position: absolute; + inset: 1px 0; + opacity: 0; + background: var(--color-text-base); + transition: opacity .2s; +} + +.dns-stats-graph-column:hover::before { + opacity: 0.05; +} + +.dns-stats-graph-bar { + width: 14px; + height: calc((var(--bar-height) / 100) * var(--graph-height)); + border: 1px solid var(--color-progress-border); + border-radius: var(--border-radius) var(--border-radius) 0 0; + display: flex; + background: var(--color-widget-background); + padding: 2px 2px 0 2px; + flex-direction: column; + gap: 2px; + transition: border-color .2s; + min-height: 10px; +} + +.dns-stats-graph-column.popover-active .dns-stats-graph-bar { + border-color: var(--color-text-subdue); + border-bottom-color: var(--color-progress-border); +} + +.dns-stats-graph-bar > * { + border-radius: 2px; + background: var(--color-progress-value); + min-height: 1px; +} + +.dns-stats-graph-bar > .queries { + flex-grow: 1; +} + +.dns-stats-graph-bar > *:last-child { + border-bottom-right-radius: 0; + border-bottom-left-radius: 0; +} + +.dns-stats-graph-bar > .blocked { + background-color: var(--color-negative); + flex-basis: calc(var(--percent) - 1px); +} + +.dns-stats-graph-column:nth-child(even) .dns-stats-graph-time { + opacity: 1; + transform: translateY(0); +} + +.dns-stats-graph-time, .dns-stats-graph-columns:hover .dns-stats-graph-time { + position: absolute; + font-size: var(--font-size-h6); + inset-inline: 0; + text-align: center; + height: 2.5rem; + line-height: 2.5rem; + top: 100%; + user-select: none; + opacity: 0; + transform: translateY(-0.5rem); + transition: opacity .2s, transform .2s; +} + +.dns-stats-graph-column:hover .dns-stats-graph-time { + opacity: 1; + transform: translateY(0); +} + +.dns-stats-graph-columns:hover .dns-stats-graph-column:not(:hover) .dns-stats-graph-time { + opacity: 0; +} + .weather-column { position: relative; display: flex; @@ -833,7 +1312,6 @@ kbd:active { flex-direction: column; width: calc(100% / 12); padding-top: 3px; - max-width: 30px; } .weather-column-value, .weather-columns:hover .weather-column-value { @@ -892,7 +1370,6 @@ kbd:active { overflow: hidden; mask-image: linear-gradient(0deg, transparent 40%, #000); -webkit-mask-image: linear-gradient(0deg, transparent 40%, #000); - z-index: -1; } .weather-column-rain::before { @@ -967,6 +1444,10 @@ kbd:active { transform: translate(-50%, -50%); } +.clock-time { + min-width: 8ch; +} + .clock-time span { color: var(--color-text-highlight); } @@ -983,11 +1464,18 @@ kbd:active { transition: filter 0.3s, opacity 0.3s; } +.monitor-site-icon.flat-icon { + opacity: 0.7; +} + .monitor-site:hover .monitor-site-icon { - filter: grayscale(0); opacity: 1; } +.monitor-site:hover .monitor-site-icon:not(.flat-icon) { + filter: grayscale(0); +} + .monitor-site-status-icon { flex-shrink: 0; margin-left: auto; @@ -995,6 +1483,170 @@ kbd:active { height: 2rem; } +.monitor-site-status-icon-compact { + width: 1.8rem; + height: 1.8rem; + flex-shrink: 0; +} + +.docker-container-icon { + display: block; + filter: grayscale(0.4); + object-fit: contain; + aspect-ratio: 1 / 1; + width: 2.7rem; + opacity: 0.8; + transition: filter 0.3s, opacity 0.3s; +} + +.docker-container-icon.flat-icon { + opacity: 0.7; +} + +.docker-container:hover .docker-container-icon { + opacity: 1; +} + +.docker-container:hover .docker-container-icon:not(.flat-icon) { + filter: grayscale(0); +} + +.docker-container-status-icon { + width: 2rem; + height: 2rem; +} + +.widget-type-server-info { + position: relative; +} + +.server + .server { + margin-top: 3rem; +} + +.server { + gap: 1rem; + display: flex; + flex-direction: column; +} + +.server-info { + align-items: center; + display: flex; + justify-content: space-between; + gap: 1.5rem; + flex-shrink: 1; + min-width: 0; +} + +.server-details { + min-width: 0; +} + +.server-icon { + height: 3rem; + width: 3rem; +} + +.server-spicy-cpu-icon { + height: 1em; + align-self: center; + margin-left: 0.4em; + margin-bottom: 0.2rem; +} + +.server-stats { + display: flex; + gap: 1.5rem; + margin-top: 0.5rem; +} + +.server-stat-unavailable { + opacity: 0.5; +} + +.progress-bar { + border: 1px solid var(--color-progress-border); + border-radius: var(--border-radius); + display: flex; + flex-direction: column; + gap: 2px; + padding: 2px; + height: 1.5rem; + margin-inline: -3px; /* naughty, but oh so beautiful */ +} + +.progress-bar-combined { + height: 3rem; +} + +.popover-active > .progress-bar { + transition: border-color .3s; + border-color: var(--color-text-subdue); +} + +.progress-value { + --half-border-radius: calc(var(--border-radius) / 2); + border-radius: 0 var(--half-border-radius) var(--half-border-radius) 0; + background: var(--color-progress-value); + width: calc(var(--percent) * 1%); + min-width: 1px; + flex: 1; +} + +.progress-value:first-child { + border-top-left-radius: var(--half-border-radius); +} + +.progress-value:last-child { + border-bottom-left-radius: var(--half-border-radius); +} + +.progress-value-notice { + background: linear-gradient(to right, var(--color-progress-value) 65%, var(--color-negative)); +} + +.value-separator { + min-width: 2rem; + margin-inline: 0.8rem; + flex: 1; + height: calc(1em * 1.1); + border-bottom: 1px dotted var(--color-text-subdue); +} + +@container widget (min-width: 650px) { + .server { + gap: 2rem; + flex-direction: row; + align-items: center; + } + + .server + .server { + margin-top: 1rem; + } + + .server-info { + flex-direction: row-reverse; + justify-content: unset; + margin-right: auto; + z-index: 1; + } + + .server-stats { + flex-direction: row; + justify-content: right; + min-width: 450px; + margin-top: 0; + gap: 2rem; + padding-bottom: 0.8rem; + z-index: 1; + } + + .server-stats > * { + max-width: 200px; + } +} + .thumbnail { filter: grayscale(0.2) contrast(0.9); opacity: 0.8; @@ -1114,6 +1766,14 @@ kbd:active { border: 2px solid var(--color-widget-background); } +.twitch-stream-preview { + max-width: 100%; + width: 400px; + aspect-ratio: 16 / 9; + border-radius: var(--border-radius); + object-fit: cover; +} + .reddit-card-thumbnail { width: 100%; height: 100%; @@ -1142,7 +1802,7 @@ kbd:active { display: none; } - .page-column-full .size-title-dynamic { + .page-column-small .size-title-dynamic { font-size: var(--font-size-h3); } @@ -1167,8 +1827,9 @@ kbd:active { } } - body { - padding-bottom: calc(var(--mobile-navigation-height) + var(--content-bounds-padding)); + .mobile-navigation-offset { + height: var(--mobile-navigation-height); + flex-shrink: 0; } .mobile-navigation { @@ -1178,7 +1839,7 @@ kbd:active { transform: translateY(calc(100% - var(--mobile-navigation-height))); left: var(--content-bounds-padding); right: var(--content-bounds-padding); - z-index: 10; + z-index: 11; background-color: var(--color-widget-background); border: 1px solid var(--color-widget-content-border); border-bottom: 0; @@ -1201,7 +1862,8 @@ kbd:active { padding: 15px var(--content-bounds-padding); display: flex; align-items: center; - overflow-x: scroll; + overflow-x: auto; + scrollbar-width: thin; gap: 2.5rem; } @@ -1276,6 +1938,11 @@ kbd:active { .weather-column-rain::before { background-size: 7px 7px; } + + .ios .search-input { + /* so that iOS Safari does not zoom the page when the input is focused */ + font-size: 16px; + } } @media (max-width: 1190px) and (display-mode: standalone) { @@ -1283,7 +1950,11 @@ kbd:active { --safe-area-inset-bottom: env(safe-area-inset-bottom, 0); } - .list-collapsible-label:has(.list-collapsible-input:checked) { + .ios .body-content { + height: 100dvh; + } + + .expand-toggle-button.container-expanded { bottom: calc(var(--mobile-navigation-height) + var(--safe-area-inset-bottom)); } @@ -1297,6 +1968,10 @@ kbd:active { transition: padding-bottom .3s; } + .mobile-navigation-offset { + height: calc(var(--mobile-navigation-height) + var(--safe-area-inset-bottom)); + } + .mobile-navigation-icons:has(.mobile-navigation-page-links-input:checked) { padding-bottom: 0; } @@ -1310,7 +1985,7 @@ kbd:active { @media (max-width: 550px) { :root { - font-size: 9px; + font-size: 9.4px; --widget-gap: 15px; --widget-content-vertical-padding: 10px; --widget-content-horizontal-padding: 10px; @@ -1341,6 +2016,7 @@ kbd:active { } .rss-detailed-description { + line-clamp: 3; -webkit-line-clamp: 3; } } @@ -1354,18 +2030,22 @@ kbd:active { .size-h6 { font-size: var(--font-size-h6); } .color-highlight { color: var(--color-text-highlight); } +.color-paragraph { color: var(--color-text-paragraph); } .color-base { color: var(--color-text-base); } .color-subdue { color: var(--color-text-subdue); } .color-negative { color: var(--color-negative); } .color-positive { color: var(--color-positive); } .color-primary { color: var(--color-primary); } +.cursor-help { cursor: help; } +.rounded { border-radius: var(--border-radius); } .break-all { word-break: break-all; } .text-left { text-align: left; } .text-right { text-align: right; } .text-center { text-align: center; } .text-elevate { margin-top: -0.2em; } .text-compact { word-spacing: -0.18em; } +.text-very-compact { word-spacing: -0.35em; } .rtl { direction: rtl; } .shrink { flex-shrink: 1; } .shrink-0 { flex-shrink: 0; } @@ -1376,6 +2056,7 @@ kbd:active { .overflow-hidden { overflow: hidden; } .relative { position: relative; } .flex { display: flex; } +.flex-1 { flex: 1; } .flex-wrap { flex-wrap: wrap; } .flex-nowrap { flex-wrap: nowrap; } .justify-between { justify-content: space-between; } @@ -1388,22 +2069,32 @@ kbd:active { .flex-column { flex-direction: column; } .items-center { align-items: center; } .items-start { align-items: start; } +.items-end { align-items: end; } .gap-5 { gap: 0.5rem; } .gap-7 { gap: 0.7rem; } .gap-10 { gap: 1rem; } +.gap-12 { gap: 1.2rem; } .gap-15 { gap: 1.5rem; } +.gap-20 { gap: 2rem; } .gap-25 { gap: 2.5rem; } .gap-35 { gap: 3.5rem; } .gap-45 { gap: 4.5rem; } .gap-55 { gap: 5.5rem; } +.margin-left-auto { margin-left: auto; } .margin-top-3 { margin-top: 0.3rem; } .margin-top-5 { margin-top: 0.5rem; } .margin-top-7 { margin-top: 0.7rem; } .margin-top-10 { margin-top: 1rem; } .margin-top-15 { margin-top: 1.5rem; } +.margin-top-20 { margin-top: 2rem; } +.margin-top-25 { margin-top: 2.5rem; } +.margin-top-35 { margin-top: 3.5rem; } +.margin-top-40 { margin-top: 4rem; } +.margin-top-auto { margin-top: auto; } .margin-block-3 { margin-block: 0.3rem; } .margin-block-5 { margin-block: 0.5rem; } .margin-block-7 { margin-block: 0.7rem; } +.margin-block-8 { margin-block: 0.8rem; } .margin-block-10 { margin-block: 1rem; } .margin-block-15 { margin-block: 1.5rem; } .margin-bottom-3 { margin-bottom: 0.3rem; } @@ -1412,4 +2103,14 @@ kbd:active { .margin-bottom-10 { margin-bottom: 1rem; } .margin-bottom-15 { margin-bottom: 1.5rem; } .margin-bottom-auto { margin-bottom: auto; } +.padding-block-5 { padding-block: 0.5rem; } .scale-half { transform: scale(0.5); } +.list { --list-half-gap: 0rem; } +.list-gap-2 { --list-half-gap: 0.1rem; } +.list-gap-4 { --list-half-gap: 0.2rem; } +.list-gap-8 { --list-half-gap: 0.4rem; } +.list-gap-10 { --list-half-gap: 0.5rem; } +.list-gap-14 { --list-half-gap: 0.7rem; } +.list-gap-20 { --list-half-gap: 1rem; } +.list-gap-24 { --list-half-gap: 1.2rem; } +.list-gap-34 { --list-half-gap: 1.7rem; } diff --git a/internal/assets/static/manifest.json b/internal/glance/static/manifest.json similarity index 84% rename from internal/assets/static/manifest.json rename to internal/glance/static/manifest.json index 668b289..42e8213 100644 --- a/internal/assets/static/manifest.json +++ b/internal/glance/static/manifest.json @@ -6,7 +6,7 @@ "start_url": "/", "icons": [ { - "src": "/static/app-icon.png", + "src": "app-icon.png", "type": "image/png", "sizes": "512x512" } diff --git a/internal/glance/templates.go b/internal/glance/templates.go new file mode 100644 index 0000000..699772d --- /dev/null +++ b/internal/glance/templates.go @@ -0,0 +1,88 @@ +package glance + +import ( + "fmt" + "html/template" + "math" + "strconv" + + "golang.org/x/text/language" + "golang.org/x/text/message" +) + +var intl = message.NewPrinter(language.English) + +var globalTemplateFunctions = template.FuncMap{ + "formatApproxNumber": formatApproxNumber, + "formatNumber": intl.Sprint, + "safeCSS": func(str string) template.CSS { + return template.CSS(str) + }, + "safeURL": func(str string) template.URL { + return template.URL(str) + }, + "absInt": func(i int) int { + return int(math.Abs(float64(i))) + }, + "formatPrice": func(price float64) string { + return intl.Sprintf("%.2f", price) + }, + "formatPriceWithPrecision": func(precision int, price float64) string { + return intl.Sprintf("%."+strconv.Itoa(precision)+"f", price) + }, + "dynamicRelativeTimeAttrs": dynamicRelativeTimeAttrs, + "formatServerMegabytes": func(mb uint64) template.HTML { + var value string + var label string + + if mb < 1_000 { + value = strconv.FormatUint(mb, 10) + label = "MB" + } else if mb < 1_000_000 { + if mb < 10_000 { + value = fmt.Sprintf("%.1f", float64(mb)/1_000) + } else { + value = strconv.FormatUint(mb/1_000, 10) + } + + label = "GB" + } else { + value = fmt.Sprintf("%.1f", float64(mb)/1_000_000) + label = "TB" + } + + return template.HTML(value + ` ` + label + ``) + }, +} + +func mustParseTemplate(primary string, dependencies ...string) *template.Template { + t, err := template.New(primary). + Funcs(globalTemplateFunctions). + ParseFS(templateFS, append([]string{primary}, dependencies...)...) + + if err != nil { + panic(err) + } + + return t +} + +func formatApproxNumber(count int) string { + if count < 1_000 { + return strconv.Itoa(count) + } + + if count < 10_000 { + return strconv.FormatFloat(float64(count)/1_000, 'f', 1, 64) + "k" + } + + if count < 1_000_000 { + return strconv.Itoa(count/1_000) + "k" + } + + return strconv.FormatFloat(float64(count)/1_000_000, 'f', 1, 64) + "m" +} + +func dynamicRelativeTimeAttrs(t interface{ Unix() int64 }) template.HTMLAttr { + return template.HTMLAttr(`data-dynamic-relative-time="` + strconv.FormatInt(t.Unix(), 10) + `"`) +} diff --git a/internal/glance/templates/bookmarks.html b/internal/glance/templates/bookmarks.html new file mode 100644 index 0000000..f247bdb --- /dev/null +++ b/internal/glance/templates/bookmarks.html @@ -0,0 +1,23 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +
+ {{ range .Groups }} +
+ {{ if ne .Title "" }}
{{ .Title }}
{{ end }} +
    + {{ range .Links }} +
  • + {{ if ne "" .Icon.URL }} +
    + +
    + {{ end }} + {{ .Title }} +
  • + {{ end }} +
+
+ {{ end }} +
+{{ end }} diff --git a/internal/glance/templates/calendar.html b/internal/glance/templates/calendar.html new file mode 100644 index 0000000..b3c4a69 --- /dev/null +++ b/internal/glance/templates/calendar.html @@ -0,0 +1,7 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +
+
+
+{{ end }} diff --git a/internal/assets/templates/change-detection.html b/internal/glance/templates/change-detection.html similarity index 100% rename from internal/assets/templates/change-detection.html rename to internal/glance/templates/change-detection.html diff --git a/internal/assets/templates/clock.html b/internal/glance/templates/clock.html similarity index 100% rename from internal/assets/templates/clock.html rename to internal/glance/templates/clock.html diff --git a/internal/glance/templates/custom-api.html b/internal/glance/templates/custom-api.html new file mode 100644 index 0000000..e1f1f6f --- /dev/null +++ b/internal/glance/templates/custom-api.html @@ -0,0 +1,7 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content-classes" }}{{ if .Frameless }}widget-content-frameless{{ end }}{{ end }} + +{{ define "widget-content" }} +{{ .CompiledHTML }} +{{ end }} diff --git a/internal/glance/templates/dns-stats.html b/internal/glance/templates/dns-stats.html new file mode 100644 index 0000000..bb4222c --- /dev/null +++ b/internal/glance/templates/dns-stats.html @@ -0,0 +1,88 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +
+
+
+
{{ .Stats.TotalQueries | formatNumber }}
+
QUERIES
+
+
+
{{ .Stats.BlockedPercent }}%
+
BLOCKED
+
+ {{ if gt .Stats.ResponseTime 0 }} +
+
{{ .Stats.ResponseTime | formatNumber }}ms
+
LATENCY
+
+ {{ else }} +
+
{{ .Stats.DomainsBlocked | formatApproxNumber }}
+
DOMAINS
+
+ {{ end }} +
+ + {{ $showGraph := not (or .HideGraph (eq (len .Stats.Series) 0)) }} + {{ if $showGraph }} +
+
+ + + + + + + + + +
+ +
+ {{ range $i, $column := .Stats.Series }} +
+
+
+
+
{{ $column.Queries | formatNumber }}
+
QUERIES
+
+
+
{{ $column.PercentBlocked }}%
+
BLOCKED
+
+
+
+ {{ if gt $column.PercentTotal 0}} +
+ {{ if ne $column.Queries $column.Blocked }} +
+ {{ end }} + {{ if gt $column.PercentBlocked 0 }} +
+ {{ end }} +
+ {{ end }} +
{{ index $.TimeLabels $i }}
+
+ {{ end }} +
+
+ {{ end }} + + {{ if and (not .HideTopDomains) .Stats.TopBlockedDomains }} +
+ Top blocked domains +
    + {{ range .Stats.TopBlockedDomains }} +
  • +
    {{ .Domain }}
    +
    {{ .PercentBlocked }}%
    +
  • + {{ end }} +
+
+ {{ end }} +
+{{ end }} diff --git a/internal/glance/templates/docker-containers.html b/internal/glance/templates/docker-containers.html new file mode 100644 index 0000000..d84e9a6 --- /dev/null +++ b/internal/glance/templates/docker-containers.html @@ -0,0 +1,66 @@ +{{ template "widget-base.html" . }} + +{{- define "widget-content" }} +
    + {{- range .Containers }} +
  • + + +
    + {{- if .URL }} + {{ .Title }} + {{- else }} +
    {{ .Title }}
    + {{- end }} + {{- if .Description }} +
    {{ .Description }}
    + {{- end }} +
    + +
    + {{ template "state-icon" .StateIcon }} +
    + +
    +
  • + {{- else }} +
    No containers available to show.
    + {{- end }} +
+{{- end }} + +{{- define "state-icon" }} +{{- if eq . "ok" }} + +{{- else if eq . "warn" }} + +{{- else if eq . "paused" }} + +{{- else }} + +{{- end }} +{{- end }} diff --git a/internal/assets/templates/document.html b/internal/glance/templates/document.html similarity index 64% rename from internal/assets/templates/document.html rename to internal/glance/templates/document.html index d126d8b..a26f854 100644 --- a/internal/assets/templates/document.html +++ b/internal/glance/templates/document.html @@ -3,6 +3,7 @@ {{ block "document-head-before" . }}{{ end }} {{ block "document-title" . }}{{ end }} + @@ -11,12 +12,11 @@ - - - - - - + + + + + {{ block "document-head-after" . }}{{ end }} diff --git a/internal/glance/templates/extension.html b/internal/glance/templates/extension.html new file mode 100644 index 0000000..2973246 --- /dev/null +++ b/internal/glance/templates/extension.html @@ -0,0 +1,7 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content-classes" }}{{ if .Extension.Frameless }}widget-content-frameless{{ end }}{{ end }} + +{{ define "widget-content" }} +{{ .Extension.Content }} +{{ end }} diff --git a/internal/glance/templates/forum-posts.html b/internal/glance/templates/forum-posts.html new file mode 100644 index 0000000..05a57d8 --- /dev/null +++ b/internal/glance/templates/forum-posts.html @@ -0,0 +1,49 @@ +{{ template "widget-base.html" . }} + +{{- define "widget-content" }} +
    + {{- range .Posts }} +
  • +
    + {{- if $.ShowThumbnails }} + {{- if .IsCrosspost }} + + + + {{- else if .ThumbnailUrl }} + + {{- else if .TargetUrl }} + + + + {{- else }} + + + + {{- end }} + {{- end }} +
    + {{ .Title }} + {{- if .Tags }} + + {{- end }} +
      +
    • +
    • {{ .Score | formatApproxNumber }} points
    • +
    • {{ .CommentCount | formatApproxNumber }} comments
    • + {{- if .TargetUrl }} +
    • {{ .TargetUrlDomain }}
    • + {{- end }} +
    +
    +
    +
  • + {{- end }} +
+{{- end }} diff --git a/internal/glance/templates/group.html b/internal/glance/templates/group.html new file mode 100644 index 0000000..3a1fb79 --- /dev/null +++ b/internal/glance/templates/group.html @@ -0,0 +1,21 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content-classes" }}widget-content-frameless{{ end }} + +{{ define "widget-content" }} +
+
+ {{- range $i, $widget := .Widgets }} + + {{- end }} +
+
+ +
+{{- range $i, $widget := .Widgets }} +
+ {{- .Render -}} +
+{{- end }} +
+{{ end }} diff --git a/internal/assets/templates/iframe.html b/internal/glance/templates/iframe.html similarity index 100% rename from internal/assets/templates/iframe.html rename to internal/glance/templates/iframe.html diff --git a/internal/glance/templates/markets.html b/internal/glance/templates/markets.html new file mode 100644 index 0000000..cd8da49 --- /dev/null +++ b/internal/glance/templates/markets.html @@ -0,0 +1,25 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +
+ {{ range .Markets }} +
+
+ {{ .Symbol }} +
{{ .Name }}
+
+ + + + + + + +
+
{{ printf "%+.2f" .PercentChange }}%
+
{{ .Currency }}{{ .Price | formatPriceWithPrecision .PriceHint }}
+
+
+ {{ end }} +
+{{ end }} diff --git a/internal/glance/templates/monitor-compact.html b/internal/glance/templates/monitor-compact.html new file mode 100644 index 0000000..dca5683 --- /dev/null +++ b/internal/glance/templates/monitor-compact.html @@ -0,0 +1,39 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +{{ if not (and .ShowFailingOnly (not .HasFailing)) }} +
    + {{ range .Sites }} + {{ if and $.ShowFailingOnly (eq .StatusStyle "ok" ) }}{{ continue }}{{ end }} +
    + {{ template "site" . }} +
    + {{ end }} +
+{{ else }} +
+

All sites are online

+ + + +
+{{ end }} +{{ end }} + +{{ define "site" }} +{{ .Title }} +{{ if not .Status.TimedOut }}
{{ .Status.ResponseTime.Milliseconds | formatNumber }}ms
{{ end }} +{{ if eq .StatusStyle "ok" }} +
+ + + +
+{{ else }} +
+ + + +
+{{ end }} +{{ end }} diff --git a/internal/glance/templates/monitor.html b/internal/glance/templates/monitor.html new file mode 100644 index 0000000..7e95b99 --- /dev/null +++ b/internal/glance/templates/monitor.html @@ -0,0 +1,53 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +{{ if not (and .ShowFailingOnly (not .HasFailing)) }} +
    + {{ range .Sites }} + {{ if and $.ShowFailingOnly (eq .StatusStyle "ok" ) }} {{ continue }} {{ end }} +
    + {{ template "site" . }} +
    + {{ end }} +
+{{ else }} +
+

All sites are online

+ + + +
+{{ end }} +{{ end }} + +{{ define "site" }} +{{ if .Icon.URL }} + +{{ end }} +
+ {{ .Title }} +
    + {{ if not .Status.Error }} +
  • {{ .StatusText }}
  • +
  • {{ .Status.ResponseTime.Milliseconds | formatNumber }}ms
  • + {{ else if .Status.TimedOut }} +
  • Timed Out
  • + {{ else }} +
  • ERROR
  • + {{ end }} +
+
+{{ if eq .StatusStyle "ok" }} +
+ + + +
+{{ else }} +
+ + + +
+{{ end }} +{{ end }} diff --git a/internal/glance/templates/old-calendar.html b/internal/glance/templates/old-calendar.html new file mode 100644 index 0000000..b43d43d --- /dev/null +++ b/internal/glance/templates/old-calendar.html @@ -0,0 +1,34 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +
+
+
{{ .Calendar.CurrentMonthName }}
+
    +
  • Week {{ .Calendar.CurrentWeekNumber }}
  • +
  • {{ .Calendar.CurrentYear }}
  • +
+
+ +
+ {{ if .StartSunday }} +
Su
+ {{ end }} +
Mo
+
Tu
+
We
+
Th
+
Fr
+
Sa
+ {{ if not .StartSunday }} +
Su
+ {{ end }} +
+ +
+ {{ range .Calendar.Days }} +
{{ . }}
+ {{ end }} +
+
+{{ end }} diff --git a/internal/assets/templates/content.html b/internal/glance/templates/page-content.html similarity index 100% rename from internal/assets/templates/content.html rename to internal/glance/templates/page-content.html diff --git a/internal/glance/templates/page.html b/internal/glance/templates/page.html new file mode 100644 index 0000000..90f7177 --- /dev/null +++ b/internal/glance/templates/page.html @@ -0,0 +1,85 @@ +{{ template "document.html" . }} + +{{ define "document-title" }}{{ .Page.Title }}{{ end }} + +{{ define "document-head-before" }} + +{{ end }} + +{{ define "document-root-attrs" }}class="{{ if .App.Config.Theme.Light }}light-scheme {{ end }}{{ if ne "" .Page.Width }}page-width-{{ .Page.Width }} {{ end }}{{ if .Page.CenterVertically }}page-center-vertically{{ end }}"{{ end }} + +{{ define "document-head-after" }} +{{ .App.ParsedThemeStyle }} + +{{ if ne "" .App.Config.Theme.CustomCSSFile }} + +{{ end }} + +{{ if ne "" .App.Config.Document.Head }}{{ .App.Config.Document.Head }}{{ end }} +{{ end }} + +{{ define "navigation-links" }} +{{ range .App.Config.Pages }} +{{ .Title }} +{{ end }} +{{ end }} + +{{ define "document-body" }} +
+ {{ if not .Page.HideDesktopNavigation }} +
+
+ + + +
+
+ {{ end }} + +
+
+ + {{ range $i, $column := .Page.Columns }} + + {{ end }} + +
+ +
+ +
+
+

{{ .Page.Title }}

+
+
+ +
Loading
+ +
+
+
+ + {{ if not .App.Config.Branding.HideFooter }} +
+ {{ if eq "" .App.Config.Branding.CustomFooter }} +
+ Glance {{ if ne "dev" .App.Version }}{{ .App.Version }}{{ else }}({{ .App.Version }}){{ end }} +
+ {{ else }} + {{ .App.Config.Branding.CustomFooter }} + {{ end }} +
+ {{ end }} + +
+
+{{ end }} diff --git a/internal/assets/templates/reddit-horizontal-cards.html b/internal/glance/templates/reddit-horizontal-cards.html similarity index 81% rename from internal/assets/templates/reddit-horizontal-cards.html rename to internal/glance/templates/reddit-horizontal-cards.html index 2012435..9ee31b3 100644 --- a/internal/assets/templates/reddit-horizontal-cards.html +++ b/internal/glance/templates/reddit-horizontal-cards.html @@ -18,10 +18,10 @@ {{ else }}
/r/{{ $.Subreddit }}
{{ end }} - {{ .Title }} + {{ .Title }}
  • -
  • {{ .Score | formatNumber }} points
  • +
  • {{ .Score | formatApproxNumber }} points
diff --git a/internal/assets/templates/reddit-vertical-cards.html b/internal/glance/templates/reddit-vertical-cards.html similarity index 81% rename from internal/assets/templates/reddit-vertical-cards.html rename to internal/glance/templates/reddit-vertical-cards.html index 38ec9e8..747cc7e 100644 --- a/internal/assets/templates/reddit-vertical-cards.html +++ b/internal/glance/templates/reddit-vertical-cards.html @@ -17,10 +17,10 @@ {{ else }}
/r/{{ $.Subreddit }}
{{ end }} - {{ .Title }} + {{ .Title }}
  • -
  • {{ .Score | formatNumber }} points
  • +
  • {{ .Score | formatApproxNumber }} points
diff --git a/internal/glance/templates/releases.html b/internal/glance/templates/releases.html new file mode 100644 index 0000000..3643524 --- /dev/null +++ b/internal/glance/templates/releases.html @@ -0,0 +1,23 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +
    + {{ range .Releases }} +
  • +
    + {{ .Name }} + {{ if $.ShowSourceIcon }} + + {{ end }} +
    +
      +
    • +
    • {{ .Version }}
    • + {{ if gt .Downvotes 3 }} +
    • {{ .Downvotes | formatNumber }} ⚠
    • + {{ end }} +
    +
  • + {{ end }} +
+{{ end }} diff --git a/internal/glance/templates/repository.html b/internal/glance/templates/repository.html new file mode 100644 index 0000000..d0d1b8e --- /dev/null +++ b/internal/glance/templates/repository.html @@ -0,0 +1,61 @@ +{{ template "widget-base.html" . }} + +{{ define "widget-content" }} +{{ .Repository.Name }} +
    +
  • {{ .Repository.Stars | formatNumber }} stars
  • +
  • {{ .Repository.Forks | formatNumber }} forks
  • +
+ +{{ if gt (len .Repository.Commits) 0 }} +
+Last {{ .CommitsLimit }} commits +
+
    + {{ range .Repository.Commits }} +
  • + {{ end }} +
+ +
+{{ end }} + +{{ if gt (len .Repository.PullRequests) 0 }} +
+Open pull requests ({{ .Repository.OpenPullRequests | formatNumber }} total) +
+
    + {{ range .Repository.PullRequests }} +
  • + {{ end }} +
+
    + {{ range .Repository.PullRequests }} +
  • {{ .Title }}
  • + {{ end }} +
+
+{{ end }} + +{{ if gt (len .Repository.Issues) 0 }} +
+Open issues ({{ .Repository.OpenIssues | formatNumber }} total) +
+
    + {{ range .Repository.Issues }} +
  • + {{ end }} +
+
    + {{ range .Repository.Issues }} +
  • {{ .Title }}
  • + {{ end }} +
+
+{{ end }} + +{{ end }} diff --git a/internal/assets/templates/rss-detailed-list.html b/internal/glance/templates/rss-detailed-list.html similarity index 97% rename from internal/assets/templates/rss-detailed-list.html rename to internal/glance/templates/rss-detailed-list.html index a926002..311923d 100644 --- a/internal/assets/templates/rss-detailed-list.html +++ b/internal/glance/templates/rss-detailed-list.html @@ -33,6 +33,8 @@ {{ end }} + {{ else }} +
  • {{ .NoItemsMessage }}
  • {{ end }} {{ end }} diff --git a/internal/assets/templates/rss-horizontal-cards-2.html b/internal/glance/templates/rss-horizontal-cards-2.html similarity index 85% rename from internal/assets/templates/rss-horizontal-cards-2.html rename to internal/glance/templates/rss-horizontal-cards-2.html index ffacc2f..496e56a 100644 --- a/internal/assets/templates/rss-horizontal-cards-2.html +++ b/internal/glance/templates/rss-horizontal-cards-2.html @@ -3,6 +3,7 @@ {{ define "widget-content-classes" }}widget-content-frameless{{ end }} {{ define "widget-content" }} +{{ if gt (len .Items) 0 }}