custom django command for promo logos

added path vailidity verification and IOError handling

added option to overwrite existing logo and force flag

improved uppon suggestions

mistake correction

fixed string conversion bugs and logical error

corrected path conversion

f

better error handling and corrections

ajout d'une section de documentation pour la feature

copié coller

fixed documentation bullet points

added resampling clean up error handling

removed useless IOError

core/management/commands/add_promo_logo.py

@@ -0,0 +1,41 @@
+import pathlib
+
+from django.apps import apps
+from django.core.management.base import BaseCommand
+from PIL import Image, UnidentifiedImageError
+
+
+class Command(BaseCommand):
+    def add_arguments(self, parser):
+        parser.add_argument("number", type=int)
+        parser.add_argument("path", type=pathlib.Path)
+        parser.add_argument("-f", "--force", action="store_true")
+
+    def handle(self, number: int, path: pathlib.Path, force: int, *args, **options):
+        if not path.exists() or path.is_dir():
+            self.stderr.write(f"{path} is not a file or does not exist")
+            return
+
+        dest_path = (
+            pathlib.Path(apps.get_app_config("core").path)
+            / "static"
+            / "core"
+            / "img"
+            / f"promo_{number}.png"
+        )
+
+        if dest_path.exists() and not force:
+            over = input("File already exists, do you want to overwrite it? (y/N):")
+            if over.lower() != "y":
+                self.stdout.write("exiting")
+                return
+        try:
+            im = Image.open(path)
+            im.resize((120, 120), resample=Image.Resampling.LANCZOS).save(
+                dest_path, format="PNG"
+            )
+            self.stdout.write(
+                f"Promo logo moved and resized successfully at {dest_path}"
+            )
+        except UnidentifiedImageError:
+            self.stderr.write("image cannot be opened and identified.")

core/management/commands/install_xapian.sh

@@ -4,13 +4,13 @@
 VERSION="$1"
 
 # Cleanup env vars for auto discovery mechanism
-export CPATH=
+unset CPATH
-export LIBRARY_PATH=
+unset LIBRARY_PATH
-export CFLAGS=
+unset CFLAGS
-export LDFLAGS=
+unset LDFLAGS
-export CCFLAGS=
+unset CCFLAGS
-export CXXFLAGS=
+unset CXXFLAGS
-export CPPFLAGS=
+unset CPPFLAGS
 
 # prepare
 rm -rf "$VIRTUAL_ENV/packages"

core/static/bundled/utils/alert-message.ts

@@ -0,0 +1,38 @@
+interface AlertParams {
+  success?: boolean;
+  duration?: number;
+}
+
+export class AlertMessage {
+  public open: boolean;
+  public success: boolean;
+  public content: string;
+  private timeoutId?: number;
+  private readonly defaultDuration: number;
+
+  constructor(params?: { defaultDuration: number }) {
+    this.open = false;
+    this.content = "";
+    this.timeoutId = null;
+    this.defaultDuration = params?.defaultDuration ?? 2000;
+  }
+
+  public display(message: string, params: AlertParams) {
+    this.clear();
+    this.open = true;
+    this.content = message;
+    this.success = params.success ?? true;
+    this.timeoutId = setTimeout(() => {
+      this.open = false;
+      this.timeoutId = null;
+    }, params.duration ?? this.defaultDuration);
+  }
+
+  public clear() {
+    if (this.timeoutId !== null) {
+      clearTimeout(this.timeoutId);
+      this.timeoutId = null;
+    }
+    this.open = false;
+  }
+}

core/static/bundled/utils/api.ts

@@ -1,5 +1,5 @@
-import type { Client, Options, RequestResult, TDataShape } from "@hey-api/client-fetch";
+import type { Client, RequestResult, TDataShape } from "#openapi:client";
-import { client } from "#openapi";
+import { type Options, client } from "#openapi";
 
 export interface PaginatedResponse<T> {
   count: number;

counter/static/bundled/counter/counter-click-index.ts

@@ -1,3 +1,4 @@
+import { AlertMessage } from "#core:utils/alert-message";
 import { BasketItem } from "#counter:counter/basket";
 import type { CounterConfig, ErrorMessage } from "#counter:counter/types";
 import type { CounterProductSelect } from "./components/counter-product-select-index.ts";
@@ -5,14 +6,9 @@ import type { CounterProductSelect } from "./components/counter-product-select-i
 document.addEventListener("alpine:init", () => {
   Alpine.data("counter", (config: CounterConfig) => ({
     basket: {} as Record<string, BasketItem>,
-    errors: [],
     customerBalance: config.customerBalance,
     codeField: null as CounterProductSelect | null,
-    alertMessage: {
+    alertMessage: new AlertMessage({ defaultDuration: 2000 }),
-      content: "",
-      show: false,
-      timeout: null,
-    },
 
     init() {
       // Fill the basket with the initial data
@@ -77,22 +73,10 @@ document.addEventListener("alpine:init", () => {
       return total;
     },
 
-    showAlertMessage(message: string) {
-      if (this.alertMessage.timeout !== null) {
-        clearTimeout(this.alertMessage.timeout);
-      }
-      this.alertMessage.content = message;
-      this.alertMessage.show = true;
-      this.alertMessage.timeout = setTimeout(() => {
-        this.alertMessage.show = false;
-        this.alertMessage.timeout = null;
-      }, 2000);
-    },
-
     addToBasketWithMessage(id: string, quantity: number) {
       const message = this.addToBasket(id, quantity);
       if (message.length > 0) {
-        this.showAlertMessage(message);
+        this.alertMessage.display(message, { success: false });
       }
     },
 
@@ -109,7 +93,9 @@ document.addEventListener("alpine:init", () => {
 
     finish() {
       if (this.getBasketSize() === 0) {
-        this.showAlertMessage(gettext("You can't send an empty basket."));
+        this.alertMessage.display(gettext("You can't send an empty basket."), {
+          success: false,
+        });
         return;
       }
       this.$refs.basketForm.submit();

counter/static/bundled/counter/product-list-index.ts

@@ -167,7 +167,7 @@ document.addEventListener("alpine:init", () => {
       });
       // if products to download are already in-memory, directly take them.
       // If not, fetch them.
-      const products =
+      const products: ProductSchema[] =
         this.nbPages > 1
           ? await paginated(productSearchProductsDetailed, this.getQueryParams())
           : Object.values<ProductSchema[]>(this.products).flat();

counter/static/bundled/counter/product-type-index.ts

@@ -1,15 +1,11 @@
+import { AlertMessage } from "#core:utils/alert-message";
 import Alpine from "alpinejs";
 import { producttypeReorder } from "#openapi";
 
 document.addEventListener("alpine:init", () => {
   Alpine.data("productTypesList", () => ({
     loading: false,
-    alertMessage: {
+    alertMessage: new AlertMessage({ defaultDuration: 2000 }),
-      open: false,
-      success: true,
-      content: "",
-      timeout: null,
-    },
 
     async reorder(itemId: number, newPosition: number) {
       // The sort plugin of Alpine doesn't manage dynamic lists with x-sort
@@ -41,23 +37,14 @@ document.addEventListener("alpine:init", () => {
     },
 
     openAlertMessage(response: Response) {
-      if (response.ok) {
+      const success = response.ok;
-        this.alertMessage.success = true;
+      const content = response.ok
-        this.alertMessage.content = gettext("Products types reordered!");
+        ? gettext("Products types reordered!")
-      } else {
+        : interpolate(
-        this.alertMessage.success = false;
-        this.alertMessage.content = interpolate(
             gettext("Product type reorganisation failed with status code : %d"),
             [response.status],
           );
-      }
+      this.alertMessage.display(content, { success: success });
-      this.alertMessage.open = true;
-      if (this.alertMessage.timeout !== null) {
-        clearTimeout(this.alertMessage.timeout);
-      }
-      this.alertMessage.timeout = setTimeout(() => {
-        this.alertMessage.open = false;
-      }, 2000);
       this.loading = false;
     },
   }));

counter/static/bundled/counter/types.d.ts

@@ -1,4 +1,4 @@
-type ErrorMessage = string;
+export type ErrorMessage = string;
 
 export interface InitialFormData {
   /* Used to refill the form when the backend raises an error */

docs/howto/logo.md

@@ -12,6 +12,15 @@ nouveau logo d'une promo. C'est un processus manuel.
 	de faire cette opération manuellement, ça prend quelques
 	minutes et on est certain de la qualité à la fin.
 
+### avec une commande django
+```bash
+./manage.py add_promo_logo numero_de_promo chemin_dacces_du_logo
+```
+options:
+
+* `--force/-f` pour automatiquement écraser les logos de promo avec le même nom.
+
+### manuellement
 Les logos de promo sont à manuellement ajouter dans le projet.
 Ils se situent dans le dossier `core/static/core/img/`.
 

package-lock.json

@@ -48,6 +48,7 @@
         "@types/cytoscape-cxtmenu": "^3.4.4",
         "@types/cytoscape-klay": "^3.1.4",
         "@types/jquery": "^3.5.31",
+        "@types/js-cookie": "^3.0.6",
         "typescript": "^5.8.3",
         "vite": "^6.2.5",
         "vite-bundle-visualizer": "^1.2.1",
@@ -2865,6 +2866,13 @@
         "@types/sizzle": "*"
       }
     },
+    "node_modules/@types/js-cookie": {
+      "version": "3.0.6",
+      "resolved": "https://registry.npmjs.org/@types/js-cookie/-/js-cookie-3.0.6.tgz",
+      "integrity": "sha512-wkw9yd1kEXOPnvEeEV1Go1MmxtBJL0RR79aOTAApecWFVu7w0NNXNqhcWgvw2YgZDYadliXkl14pa3WXw5jlCQ==",
+      "dev": true,
+      "license": "MIT"
+    },
     "node_modules/@types/json-schema": {
       "version": "7.0.15",
       "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",

package.json

@@ -10,7 +10,7 @@
     "openapi": "openapi-ts",
     "analyse-dev": "vite-bundle-visualizer --mode development",
     "analyse-prod": "vite-bundle-visualizer --mode production",
-    "check": "biome check --write"
+    "check": "tsc && biome check --write"
   },
   "keywords": [],
   "author": "",
@@ -30,9 +30,10 @@
     "@hey-api/openapi-ts": "^0.73.0",
     "@rollup/plugin-inject": "^5.0.5",
     "@types/alpinejs": "^3.13.10",
-    "@types/jquery": "^3.5.31",
     "@types/cytoscape-cxtmenu": "^3.4.4",
     "@types/cytoscape-klay": "^3.1.4",
+    "@types/jquery": "^3.5.31",
+    "@types/js-cookie": "^3.0.6",
     "typescript": "^5.8.3",
     "vite": "^6.2.5",
     "vite-bundle-visualizer": "^1.2.1",

pyproject.toml

@@ -92,7 +92,7 @@ docs = [
 default-groups = ["dev", "tests", "docs"]
 
 [tool.xapian]
-version = "1.4.25"
+version = "1.4.29"
 
 [tool.ruff]
 output-format = "concise" # makes ruff error logs easier to read

sas/static/bundled/sas/album-index.ts

@@ -83,7 +83,6 @@ document.addEventListener("alpine:init", () => {
 
   Alpine.data("pictureUpload", (albumId: number) => ({
     errors: [] as string[],
-    pictures: [],
     sending: false,
     progress: null as HTMLProgressElement,
 

sas/static/bundled/sas/viewer-index.ts

@@ -1,3 +1,4 @@
+import type { UserAjaxSelect } from "#core:core/components/ajax-select-index";
 import { paginated } from "#core:utils/api";
 import { exportToHtml } from "#core:utils/globals";
 import { History } from "#core:utils/history";
@@ -130,7 +131,7 @@ exportToHtml("loadViewer", (config: ViewerConfig) => {
       currentPicture: {
         // biome-ignore lint/style/useNamingConvention: api is in snake_case
         is_moderated: true,
-        id: null,
+        id: null as number,
         name: "",
         // biome-ignore lint/style/useNamingConvention: api is in snake_case
         display_name: "",
@@ -142,7 +143,7 @@ exportToHtml("loadViewer", (config: ViewerConfig) => {
         full_size_url: "",
         owner: "",
         date: new Date(),
-        identifications: [],
+        identifications: [] as IdentifiedUserSchema[],
       },
       /**
        * The picture which will be displayed next if the user press the "next" button
@@ -155,7 +156,7 @@ exportToHtml("loadViewer", (config: ViewerConfig) => {
       /**
        * The select2 component used to identify users
        **/
-      selector: undefined,
+      selector: undefined as UserAjaxSelect,
       /**
        * Error message when a moderation operation fails
        **/

tsconfig.json

@@ -14,6 +14,7 @@
     "types": ["jquery", "alpinejs"],
     "paths": {
       "#openapi": ["./staticfiles/generated/openapi/client/index.ts"],
+      "#openapi:*": ["./staticfiles/generated/openapi/client/*"],
       "#core:*": ["./core/static/bundled/*"],
       "#pedagogy:*": ["./pedagogy/static/bundled/*"],
       "#counter:*": ["./counter/static/bundled/*"],