Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Download counting for SourceForge #338

Merged
merged 3 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ on:
- reopened

jobs:
main:
Build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v3
- name: Build Image
id: docker_build
uses: docker/build-push-action@v2
uses: docker/build-push-action@v5
with:
context: ./netkan
file: ./netkan/Dockerfile
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v3
- name: Login to DockerHub
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Run tests before deploying
uses: docker/build-push-action@v2
uses: docker/build-push-action@v5
with:
context: ./netkan
file: ./netkan/Dockerfile
push: false
target: test
- name: Build and push NetKAN-infra
uses: docker/build-push-action@v2
uses: docker/build-push-action@v5
with:
context: ./netkan
file: ./netkan/Dockerfile
Expand All @@ -41,15 +41,15 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v3
- name: Login to DockerHub
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push webhooks-proxy
id: docker_build
uses: docker/build-push-action@v2
uses: docker/build-push-action@v5
with:
context: ./nginx
file: ./nginx/Dockerfile
Expand Down
41 changes: 39 additions & 2 deletions netkan/netkan/download_counter.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import urllib.parse
from typing import Dict, Tuple, Any, Optional
import heapq
from datetime import date

import requests

Expand Down Expand Up @@ -205,10 +206,36 @@ def get_result(self, counts: Optional[Dict[str, int]] = None) -> Dict[str, int]:
return counts


class SourceForgeQuerier:

# https://sourceforge.net/p/forge/documentation/Download%20Stats%20API/
API_TEMPLATE = Template('https://sourceforge.net/projects/${proj_id}/files/stats/json'
'?start_date=2010-01-01&end_date=${today}'
'&os_by_country=false&period=monthly')

@classmethod
def get_count(cls, proj_id: str) -> int:
return requests.get(cls.get_query(proj_id), timeout=60).json()['total']

@classmethod
def get_query(cls, proj_id: str) -> str:
return cls.API_TEMPLATE.safe_substitute(proj_id=proj_id,
today=date.today().isoformat())

@classmethod
def get_result(cls, ident: str, proj_id: str,
counts: Optional[Dict[str, int]] = None) -> Dict[str, int]:
if counts is None:
counts = {}
counts[ident] = counts.get(ident, 0) + cls.get_count(proj_id)
return counts


class DownloadCounter:

GITHUB_PATH_PATTERN = re.compile(r'^/([^/]+)/([^/]+)')
SPACEDOCK_PATH_PATTERN = re.compile(r'^/mod/([^/]+)')
SOURCEFORGE_PATH_PATTERN = re.compile(r'^/project/([^/]+)')

def __init__(self, game_id: str, ckm_repo: CkanMetaRepo, github_token: str) -> None:
self.game_id = game_id
Expand Down Expand Up @@ -253,6 +280,14 @@ def get_counts(self) -> None:
if ia_query.full():
ia_query.get_result(self.counts)
ia_query = InternetArchiveBatchedQuery()
elif url_parse.netloc.endswith('.sourceforge.net'):
match = self.SOURCEFORGE_PATH_PATTERN.match(url_parse.path)
if match:
SourceForgeQuerier.get_result(ckan.identifier, match.group(1),
self.counts)
else:
logging.error('Failed to parse SF URL for %s: %s',
ckan.identifier, download)
except Exception as exc: # pylint: disable=broad-except
# Don't let one bad apple spoil the bunch
# Print file path because netkan_dl might be None
Expand Down Expand Up @@ -296,8 +331,10 @@ def log_top(self, how_many: int) -> None:
# This isn't an error, but only errors go to Discord
logging.error('Top %s downloads for %s all-time:\n%s\n\n'
'Top %s downloads for %s today:\n%s',
how_many, self.game_id, self._download_summary_table(self.counts, how_many),
how_many, self.game_id, self._download_summary_table(deltas, how_many))
how_many, self.game_id,
self._download_summary_table(self.counts, how_many),
how_many, self.game_id,
self._download_summary_table(deltas, how_many))

def update_counts(self) -> None:
if self.output_file:
Expand Down