From 01b05aaed0e43922702e2b62ff6e9684834fd65c Mon Sep 17 00:00:00 2001
From: Pierre-Olivier Mercier <nemunaire@nemunai.re>
Date: Fri, 21 Jan 2022 13:06:37 +0100
Subject: [PATCH] Implement label only flag

---
 admin/sync/exercice_defines.go                |   1 +
 admin/sync/exercice_keys.go                   |  45 ++++-
 .../ui/src/components/ExerciceFlags.svelte    |   6 +-
 libfic/db.go                                  |  32 +++
 libfic/flag.go                                |  14 ++
 libfic/flag_label.go                          | 187 ++++++++++++++++++
 libfic/mcq_justification.go                   |   4 +-
 libfic/team.go                                |   5 +-
 libfic/team_my.go                             |  28 ++-
 9 files changed, 311 insertions(+), 11 deletions(-)
 create mode 100644 libfic/flag_label.go

diff --git a/admin/sync/exercice_defines.go b/admin/sync/exercice_defines.go
index f7841e33..0fabe9e7 100644
--- a/admin/sync/exercice_defines.go
+++ b/admin/sync/exercice_defines.go
@@ -49,6 +49,7 @@ type ExerciceFlag struct {
 	NeedFlag      []ExerciceDependency `toml:"need_flag,omitempty"`
 	NoShuffle     bool
 	Unit          string      `toml:"unit,omitempty"`
+	Variant       string      `toml:"variant,omitempty"`
 	NumberMin     interface{} `toml:"min,omitempty"`
 	NumberMax     interface{} `toml:"max,omitempty"`
 	NumberStep    interface{} `toml:"step,omitempty"`
diff --git a/admin/sync/exercice_keys.go b/admin/sync/exercice_keys.go
index 4c028d95..c7ffc972 100644
--- a/admin/sync/exercice_keys.go
+++ b/admin/sync/exercice_keys.go
@@ -95,11 +95,37 @@ func getRawKey(input interface{}, validatorRe string, ordered bool, showLines bo
 	return
 }
 
+func buildLabelFlag(exercice *fic.Exercice, flag ExerciceFlag, flagline int) (f *fic.FlagLabel, errs []string) {
+	if len(flag.Label) == 0 {
+		errs = append(errs, fmt.Sprintf("%q: flag #%d: Label cannot be empty.", path.Base(exercice.Path), flagline))
+		return
+	}
+
+	if flag.Raw != nil {
+		errs = append(errs, fmt.Sprintf("%q: flag #%d: raw cannot be defined.", path.Base(exercice.Path), flagline))
+	}
+
+	if len(flag.Choice) != 0 {
+		errs = append(errs, fmt.Sprintf("%q: flag #%d: choices cannot be defined.", path.Base(exercice.Path), flagline))
+	}
+
+	f = &fic.FlagLabel{
+		Order:   int8(flagline),
+		Label:   flag.Label,
+		Variant: flag.Variant,
+	}
+	return
+}
+
 func buildKeyFlag(exercice *fic.Exercice, flag ExerciceFlag, flagline int, defaultLabel string) (f *fic.Flag, choices []*fic.FlagChoice, errs []string) {
 	if len(flag.Label) == 0 {
 		flag.Label = defaultLabel
 	}
 
+	if len(flag.Variant) != 0 {
+		errs = append(errs, fmt.Sprintf("%q: flag #%d: variant is not defined for this kind of flag.", path.Base(exercice.Path), flagline))
+	}
+
 	if flag.Label[0] == '`' {
 		errs = append(errs, fmt.Sprintf("%q: flag #%d: Label should not begin with `.", path.Base(exercice.Path), flagline))
 		flag.Label = flag.Label[1:]
@@ -221,6 +247,8 @@ func buildExerciceFlag(i Importer, exercice *fic.Exercice, flag ExerciceFlag, nl
 	switch strings.ToLower(flag.Type) {
 	case "":
 		flag.Type = "key"
+	case "label":
+		flag.Type = "label"
 	case "key":
 		flag.Type = "key"
 	case "number":
@@ -273,7 +301,18 @@ func buildExerciceFlag(i Importer, exercice *fic.Exercice, flag ExerciceFlag, nl
 		}
 	}
 
-	if flag.Type == "key" || strings.HasPrefix(flag.Type, "number") || flag.Type == "text" || flag.Type == "ucq" || flag.Type == "radio" || flag.Type == "vector" {
+	if flag.Type == "label" {
+		addedFlag, berrs := buildLabelFlag(exercice, flag, nline+1)
+		if len(berrs) > 0 {
+			errs = append(errs, berrs...)
+		}
+		if addedFlag != nil {
+			ret = append(ret, importFlag{
+				Line: nline + 1,
+				Flag: addedFlag,
+			})
+		}
+	} else if flag.Type == "key" || strings.HasPrefix(flag.Type, "number") || flag.Type == "text" || flag.Type == "ucq" || flag.Type == "radio" || flag.Type == "vector" {
 		addedFlag, choices, berrs := buildKeyFlag(exercice, flag, nline+1, "Flag")
 		if len(berrs) > 0 {
 			errs = append(errs, berrs...)
@@ -296,6 +335,10 @@ func buildExerciceFlag(i Importer, exercice *fic.Exercice, flag ExerciceFlag, nl
 		hasOne := false
 		isJustified := false
 
+		if len(flag.Variant) != 0 {
+			errs = append(errs, fmt.Sprintf("%q: flag #%d: variant is not defined for this kind of flag.", path.Base(exercice.Path), nline+1))
+		}
+
 		if !flag.NoShuffle {
 			rand.Shuffle(len(flag.Choice), func(i, j int) {
 				flag.Choice[i], flag.Choice[j] = flag.Choice[j], flag.Choice[i]
diff --git a/frontend/ui/src/components/ExerciceFlags.svelte b/frontend/ui/src/components/ExerciceFlags.svelte
index efdc8178..c176db57 100644
--- a/frontend/ui/src/components/ExerciceFlags.svelte
+++ b/frontend/ui/src/components/ExerciceFlags.svelte
@@ -198,7 +198,11 @@
         <CardBody>
 	    <form on:submit|preventDefault={submitFlags}>
                 {#each flags as flag ((flag.type?flag.type:"i") + flag.id)}
-                    {#if flag.type == "mcq"}
+                    {#if !flag.type && !flag.id}
+                        <div class="form-group mb-3">
+                            <label class="{flag.variant?('text-'+flag.variant):''}">{flag.label}</label>
+                        </div>
+                    {:else if flag.type == "mcq"}
                         <FlagMCQ
                             exercice_id={exercice.id}
                             {flag}
diff --git a/libfic/db.go b/libfic/db.go
index 030a3446..bed09333 100644
--- a/libfic/db.go
+++ b/libfic/db.go
@@ -198,6 +198,18 @@ CREATE TABLE IF NOT EXISTS exercice_flags(
   choices_cost INTEGER NOT NULL,
   FOREIGN KEY(id_exercice) REFERENCES exercices(id_exercice)
 ) DEFAULT CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
+`); err != nil {
+		return err
+	}
+	if _, err := db.Exec(`
+CREATE TABLE IF NOT EXISTS exercice_flag_labels(
+  id_label INTEGER NOT NULL PRIMARY KEY AUTO_INCREMENT,
+  id_exercice INTEGER NOT NULL,
+  ordre TINYINT NOT NULL,
+  label VARCHAR(255) NOT NULL,
+  variant VARCHAR(255) NOT NULL,
+  FOREIGN KEY(id_exercice) REFERENCES exercices(id_exercice)
+) DEFAULT CHARACTER SET = utf8mb4 COLLATE = utf8mb4_unicode_ci;
 `); err != nil {
 		return err
 	}
@@ -218,6 +230,16 @@ CREATE TABLE IF NOT EXISTS exercice_flags_deps(
   FOREIGN KEY(id_flag) REFERENCES exercice_flags(id_flag),
   FOREIGN KEY(id_flag_dep) REFERENCES exercice_flags(id_flag)
 ) DEFAULT CHARACTER SET = utf8 COLLATE = utf8_bin;
+`); err != nil {
+		return err
+	}
+	if _, err := db.Exec(`
+CREATE TABLE IF NOT EXISTS exercice_flag_labels_deps(
+  id_label INTEGER NOT NULL,
+  id_flag_dep INTEGER NOT NULL,
+  FOREIGN KEY(id_label) REFERENCES exercice_flag_labels(id_label),
+  FOREIGN KEY(id_flag_dep) REFERENCES exercice_flags(id_flag)
+) DEFAULT CHARACTER SET = utf8 COLLATE = utf8_bin;
 `); err != nil {
 		return err
 	}
@@ -290,6 +312,16 @@ CREATE TABLE IF NOT EXISTS exercice_flags_omcq_deps(
   FOREIGN KEY(id_flag) REFERENCES exercice_flags(id_flag),
   FOREIGN KEY(id_mcq_dep) REFERENCES exercice_mcq(id_mcq)
 ) DEFAULT CHARACTER SET = utf8 COLLATE = utf8_bin;
+`); err != nil {
+		return err
+	}
+	if _, err := db.Exec(`
+CREATE TABLE IF NOT EXISTS exercice_flag_labels_omcq_deps(
+  id_label INTEGER NOT NULL,
+  id_mcq_dep INTEGER NOT NULL,
+  FOREIGN KEY(id_label) REFERENCES exercice_flag_labels(id_label),
+  FOREIGN KEY(id_mcq_dep) REFERENCES exercice_mcq(id_mcq)
+) DEFAULT CHARACTER SET = utf8 COLLATE = utf8_bin;
 `); err != nil {
 		return err
 	}
diff --git a/libfic/flag.go b/libfic/flag.go
index db57a83c..5442a95c 100644
--- a/libfic/flag.go
+++ b/libfic/flag.go
@@ -27,6 +27,14 @@ func (e *Exercice) GetFlags() ([]Flag, error) {
 		}
 	}
 
+	if ls, err := e.GetFlagLabels(); err != nil {
+		return nil, err
+	} else {
+		for _, l := range ls {
+			flags = append(flags, l)
+		}
+	}
+
 	if ms, err := e.GetMCQ(); err != nil {
 		return nil, err
 	} else {
@@ -53,6 +61,10 @@ func (e *Exercice) WipeFlags() (int64, error) {
 		return 0, err
 	} else if _, err := DBExec("DELETE FROM exercice_flags_omcq_deps WHERE id_flag IN (SELECT id_flag FROM exercice_flags WHERE id_exercice = ?)", e.Id); err != nil {
 		return 0, err
+	} else if _, err := DBExec("DELETE FROM exercice_flag_labels_omcq_deps WHERE id_label IN (SELECT id_label FROM exercice_flag_labels WHERE id_exercice = ?)", e.Id); err != nil {
+		return 0, err
+	} else if _, err := DBExec("DELETE FROM exercice_flag_labels_deps WHERE id_label IN (SELECT id_label FROM exercice_flag_labels WHERE id_exercice = ?)", e.Id); err != nil {
+		return 0, err
 	} else if _, err := DBExec("DELETE FROM exercice_hints_okey_deps WHERE id_flag_dep IN (SELECT id_flag FROM exercice_flags WHERE id_exercice = ?)", e.Id); err != nil {
 		return 0, err
 	} else if _, err := DBExec("DELETE FROM exercice_hints_omcq_deps WHERE id_mcq_dep IN (SELECT id_mcq FROM exercice_mcq WHERE id_exercice = ?)", e.Id); err != nil {
@@ -63,6 +75,8 @@ func (e *Exercice) WipeFlags() (int64, error) {
 		return 0, err
 	} else if _, err := DBExec("DELETE FROM flag_choices WHERE id_flag IN (SELECT id_flag FROM exercice_flags WHERE id_exercice = ?)", e.Id); err != nil {
 		return 0, err
+	} else if _, err := DBExec("DELETE FROM exercice_flag_labels WHERE id_exercice = ?", e.Id); err != nil {
+		return 0, err
 	} else if res, err := DBExec("DELETE FROM exercice_flags WHERE id_exercice = ?", e.Id); err != nil {
 		return 0, err
 	} else if nb, err := res.RowsAffected(); err != nil {
diff --git a/libfic/flag_label.go b/libfic/flag_label.go
new file mode 100644
index 00000000..857269fb
--- /dev/null
+++ b/libfic/flag_label.go
@@ -0,0 +1,187 @@
+package fic
+
+import (
+	"fmt"
+)
+
+// FlagLabel represents a flag's challenge, stored as hash.
+type FlagLabel struct {
+	Id int `json:"id"`
+	// IdExercice is the identifier of the underlying challenge
+	IdExercice int64 `json:"idExercice"`
+	// Order is used to sort the flag between them
+	Order int8 `json:"order"`
+	// Label is the title of the flag as displayed to players
+	Label string `json:"label"`
+	// Variant stores the label color.
+	Variant string `json:"variant"`
+}
+
+// GetFlagLabels returns a list of key's flags comming with the challenge.
+func (e *Exercice) GetFlagLabels() ([]*FlagLabel, error) {
+	if rows, err := DBQuery("SELECT id_label, id_exercice, ordre, label, variant FROM exercice_flag_labels WHERE id_exercice = ?", e.Id); err != nil {
+		return nil, err
+	} else {
+		defer rows.Close()
+
+		flags := []*FlagLabel{}
+		for rows.Next() {
+			k := &FlagLabel{}
+			k.IdExercice = e.Id
+
+			if err := rows.Scan(&k.Id, &k.IdExercice, &k.Order, &k.Label, &k.Variant); err != nil {
+				return nil, err
+			}
+
+			flags = append(flags, k)
+		}
+		if err := rows.Err(); err != nil {
+			return nil, err
+		}
+
+		return flags, nil
+	}
+}
+
+// GetFlagLabel returns a list of flags comming with the challenge.
+func GetFlagLabel(id int) (k *FlagLabel, err error) {
+	k = &FlagLabel{}
+	err = DBQueryRow("SELECT id_label, id_exercice, ordre, label, variant FROM exercice_flag_labels WHERE id_flag = ?", id).Scan(&k.Id, &k.IdExercice, &k.Order, &k.Label, &k.Variant)
+	return
+}
+
+// GetFlagLabelByLabel returns a flag matching the given label.
+func (e *Exercice) GetFlagLabelByLabel(label string) (k *FlagLabel, err error) {
+	k = &FlagLabel{}
+	err = DBQueryRow("SELECT id_label, id_exercice, ordre, label, variant FROM exercice_flags WHERE type LIKE ? AND id_exercice = ?", label, e.Id).Scan(&k.Id, &k.IdExercice, &k.Order, &k.Label, &k.Variant)
+	return
+}
+
+// GetId returns the Flag identifier.
+func (k *FlagLabel) GetId() int {
+	return k.Id
+}
+
+// RecoverId returns the Flag identifier as register in DB.
+func (k *FlagLabel) RecoverId() (Flag, error) {
+	if err := DBQueryRow("SELECT id_label FROM exercice_flag_labels WHERE label LIKE ? AND id_exercice = ?", k.Label, k.IdExercice).Scan(&k.Id); err != nil {
+		return nil, err
+	} else {
+		return k, err
+	}
+}
+
+// AddFlagLabel creates and fills a new struct Flag and registers it into the database.
+func (k *FlagLabel) Create(e *Exercice) (Flag, error) {
+	if res, err := DBExec("INSERT INTO exercice_flag_labels (id_exercice, ordre, label, variant) VALUES (?, ?, ?, ?)", e.Id, k.Order, k.Label, k.Variant); err != nil {
+		return k, err
+	} else if kid, err := res.LastInsertId(); err != nil {
+		return k, err
+	} else {
+		k.Id = int(kid)
+		k.IdExercice = e.Id
+		return k, nil
+	}
+}
+
+// Update applies modifications back to the database.
+func (k *FlagLabel) Update() (int64, error) {
+	if res, err := DBExec("UPDATE exercice_flag_labels SET id_exercice = ?, ordre = ?, label = ?, variant = ? WHERE id_label = ?", k.IdExercice, k.Order, k.Label, k.Variant, k.Id); err != nil {
+		return 0, err
+	} else if nb, err := res.RowsAffected(); err != nil {
+		return 0, err
+	} else {
+		return nb, err
+	}
+}
+
+// Delete the flag from the database.
+func (k *FlagLabel) Delete() (int64, error) {
+	if _, err := DBExec("DELETE FROM exercice_flag_labels_deps WHERE id_label = ?", k.Id); err != nil {
+		return 0, err
+	} else if _, err := DBExec("DELETE FROM exercice_flag_labels_omcq_deps WHERE id_label = ?", k.Id); err != nil {
+		return 0, err
+	} else if res, err := DBExec("DELETE FROM exercice_flag_labels WHERE id_label = ?", k.Id); err != nil {
+		return 0, err
+	} else if nb, err := res.RowsAffected(); err != nil {
+		return 0, err
+	} else {
+		return nb, err
+	}
+}
+
+func (k *FlagLabel) GetOrder() int8 {
+	return k.Order
+}
+
+// AddDepend insert a new dependency to a given flag.
+func (k *FlagLabel) AddDepend(j Flag) (err error) {
+	if d, ok := j.(*FlagKey); ok {
+		_, err = DBExec("INSERT INTO exercice_flag_labels_deps (id_label, id_flag_dep) VALUES (?, ?)", k.Id, d.Id)
+	} else if d, ok := j.(*MCQ); ok {
+		_, err = DBExec("INSERT INTO exercice_flag_labels_omcq_deps (id_label, id_mcq_dep) VALUES (?, ?)", k.Id, d.Id)
+	} else {
+		err = fmt.Errorf("dependancy type for key (%T) not implemented for this flag", j)
+	}
+	return
+}
+
+// GetDepends retrieve the flag's dependency list.
+func (k *FlagLabel) GetDepends() ([]Flag, error) {
+	var deps []Flag
+
+	if rows, err := DBQuery("SELECT id_flag_dep FROM exercice_flag_labels_deps WHERE id_label = ?", k.Id); err != nil {
+		return nil, err
+	} else {
+		defer rows.Close()
+
+		for rows.Next() {
+			var d int
+			if err := rows.Scan(&d); err != nil {
+				return nil, err
+			}
+			deps = append(deps, &FlagKey{Id: d, IdExercice: k.IdExercice})
+		}
+		if err := rows.Err(); err != nil {
+			return nil, err
+		}
+	}
+
+	if rows, err := DBQuery("SELECT id_mcq_dep FROM exercice_flag_labels_omcq_deps WHERE id_label = ?", k.Id); err != nil {
+		return nil, err
+	} else {
+		defer rows.Close()
+
+		for rows.Next() {
+			var d int
+			if err := rows.Scan(&d); err != nil {
+				return nil, err
+			}
+			deps = append(deps, &MCQ{Id: d, IdExercice: k.IdExercice})
+		}
+		if err := rows.Err(); err != nil {
+			return nil, err
+		}
+	}
+
+	return deps, nil
+}
+
+// Check if the given val is the expected one for this flag.
+func (k *FlagLabel) Check(v interface{}) int {
+	return 0
+}
+
+// FoundBy registers in the database that the given Team solved the flag.
+func (k *FlagLabel) FoundBy(t *Team) {
+}
+
+// GetExercice returns the parent Exercice where this flag can be found.
+func (k *FlagLabel) GetExercice() (*Exercice, error) {
+	var eid int64
+	if err := DBQueryRow("SELECT id_exercice FROM exercice_flag_labels WHERE id_label = ?", k.Id).Scan(&eid); err != nil {
+		return nil, err
+	}
+
+	return GetExercice(eid)
+}
diff --git a/libfic/mcq_justification.go b/libfic/mcq_justification.go
index cf8096ad..f00291f4 100644
--- a/libfic/mcq_justification.go
+++ b/libfic/mcq_justification.go
@@ -6,7 +6,7 @@ import (
 	"strings"
 )
 
-type FlagLabel struct {
+type FlagMCQLabel struct {
 	Label    string
 	IdChoice int
 }
@@ -17,7 +17,7 @@ func (k FlagKey) IsMCQJustification() bool {
 }
 
 // GetMCQJustification returns the structure corresponding to the given flag.
-func (k FlagKey) GetMCQJustification() (fl FlagLabel, err error) {
+func (k FlagKey) GetMCQJustification() (fl FlagMCQLabel, err error) {
 	spl := strings.Split(k.Label, "%")
 	if len(spl) >= 3 && len(spl[0]) == 0 {
 		var idChoice int64
diff --git a/libfic/team.go b/libfic/team.go
index 96cc19e5..9260d3fc 100644
--- a/libfic/team.go
+++ b/libfic/team.go
@@ -312,7 +312,10 @@ func (t *Team) GetSolvedRank(e *Exercice) (nb int64, err error) {
 
 // HasPartiallySolved checks if the Team already has unlocked the given flag and returns the validation's timestamp.
 func (t *Team) HasPartiallySolved(f Flag) (tm *time.Time) {
-	if k, ok := f.(*FlagKey); ok {
+	if _, ok := f.(*FlagLabel); ok {
+		now := time.Now()
+		return &now
+	} else if k, ok := f.(*FlagKey); ok {
 		DBQueryRow("SELECT MIN(time) FROM flag_found WHERE id_team = ? AND id_flag = ?", t.Id, k.Id).Scan(&tm)
 	} else if m, ok := f.(*MCQ); ok {
 		DBQueryRow("SELECT MIN(time) FROM mcq_found WHERE id_team = ? AND id_mcq = ?", t.Id, m.Id).Scan(&tm)
diff --git a/libfic/team_my.go b/libfic/team_my.go
index f860e021..f516df7f 100644
--- a/libfic/team_my.go
+++ b/libfic/team_my.go
@@ -31,7 +31,7 @@ type myTeamHint struct {
 	Cost    int64  `json:"cost"`
 }
 type myTeamFlag struct {
-	Id          int                    `json:"id"`
+	Id          int                    `json:"id,omitempty"`
 	order       int8                   `json:"order"`
 	Label       string                 `json:"label"`
 	Type        string                 `json:"type,omitempty"`
@@ -50,6 +50,7 @@ type myTeamFlag struct {
 	Justify     bool                   `json:"justify,omitempty"`
 	Choices     map[string]interface{} `json:"choices,omitempty"`
 	ChoicesCost int64                  `json:"choices_cost,omitempty"`
+	Variant     string                 `json:"variant,omitempty"`
 	Min         *float64               `json:"min,omitempty"`
 	Max         *float64               `json:"max,omitempty"`
 	Step        *float64               `json:"step,omitempty"`
@@ -142,10 +143,8 @@ func MyJSONTeam(t *Team, started bool) (interface{}, error) {
 					} else {
 						exercice.Tries, stime = t.CountTries(e)
 						exercice.SolvedTime = stime
-						if exercice.Tries > 0 {
-							if DisplayMCQBadCount {
-								exercice.SolveDist = t.LastTryDist(e)
-							}
+						if DisplayMCQBadCount && exercice.Tries > 0 {
+							exercice.SolveDist = t.LastTryDist(e)
 						}
 					}
 
@@ -194,6 +193,23 @@ func MyJSONTeam(t *Team, started bool) (interface{}, error) {
 
 				justifiedMCQ := map[int]myTeamFlag{}
 
+				if labels, err := e.GetFlagLabels(); err != nil {
+					return nil, err
+				} else {
+					for _, l := range labels {
+						if !DisplayAllFlags && t != nil && !t.CanSeeFlag(l) {
+							// Dependancy missing, skip the flag for now
+							continue
+						}
+
+						exercice.Flags = append(exercice.Flags, myTeamFlag{
+							order:   l.Order,
+							Label:   l.Label,
+							Variant: l.Variant,
+						})
+					}
+				}
+
 				if flags, err := e.GetFlagKeys(); err != nil {
 					return nil, err
 				} else {
@@ -257,7 +273,7 @@ func MyJSONTeam(t *Team, started bool) (interface{}, error) {
 
 						flag.Multiline = k.Multiline
 
-						var fl FlagLabel
+						var fl FlagMCQLabel
 						if fl, err = k.GetMCQJustification(); err == nil {
 							k.Label = fl.Label
 						}