Compare commits

...

2 Commits

8 changed files with 575 additions and 340 deletions
+22
View File
@@ -0,0 +1,22 @@
<?php
/**
* Copyright (C) 2026 fhcomplete.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
if (!defined('BASEPATH')) exit('No direct script access allowed');
$config['stv'] = "menu/StvMenuLib";
@@ -0,0 +1,58 @@
<?php
/**
* Copyright (C) 2026 fhcomplete.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
if (! defined('BASEPATH')) exit('No direct script access allowed');
/**
* This controller operates between (interface) the JS (GUI) and the back-end
* Provides data to the ajax get calls about menues
* This controller works with JSON calls on the HTTP GET or POST and the output is always JSON
*/
class Menu extends FHCAPI_Controller
{
public function __construct()
{
$permissions = [];
$router = load_class('Router');
// TODO(chris): permission
$permissions[$router->method] = ['admin:r', 'assistenz:r'];
parent::__construct($permissions);
// Load Config
$this->config->load('menubuilder');
}
/**
* @param string $method
* @param array $params (optional)
*
* @return void
*/
public function _remap($method, $params = [])
{
$this->load->library($this->config->item($method), null, 'menulib');
if (!$this->menulib)
show_404();
$submenu = $this->menulib->build($params);
$this->terminateWithSuccess($submenu);
}
}
+41
View File
@@ -0,0 +1,41 @@
/**
* Copyright (C) 2026 fhcomplete.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
export default {
get(config, path = '') {
return {
method: 'get',
url: '/api/frontend/v1/menu/' + config + '/' + path
};
},
// TODO(chris): handle favorites per config
favorites: {
get() {
return {
method: 'get',
url: 'api/frontend/v1/stv/favorites'
};
},
set(favorites) {
return {
method: 'post',
url: 'api/frontend/v1/stv/favorites/set',
params: { favorites }
};
}
}
};
+362
View File
@@ -0,0 +1,362 @@
import MenuEntry from './Menu/Entry.js';
import dragClick from '../../directives/dragClick.js';
import ApiMenu from '../../api/factory/menu.js';
export default {
components: {
PvTreetable: primevue.treetable,
PvColumn: primevue.column,
MenuEntry
},
directives: {
dragClick
},
emits: [
'selectEntry',
'drop'
],
props: {
config: {
type: String,
required: true,
},
preselectedKey: {
type: String,
default: null
}
},
data() {
return {
loading: true,
nodes: [],
selectedKey: [],
expandedKeys: {},
filters: {}, // TODO(chris): filter only 1st level?
favorites: {on: false, list: []}
}
},
computed: {
filteredNodes() {
if (this.favorites.on)
return this.nodes.filter(node => this.favorites.list.includes(node.data.path));
return this.nodes;
}
},
watch: {
preselectedKey(newVal, oldVal) {
if (newVal !== oldVal) {
this.setPreselection();
}
}
},
methods: {
reloadNodesWithProp(prop, nodes = undefined) {
if (!nodes)
nodes = this.nodes;
nodes.forEach(node => {
if (node.data[prop]) {
// reload
delete node.children;
this.onExpandTreeNode(node);
} else if (node.children) {
this.reloadNodesWithProp(prop, node.children);
}
});
},
findNodeByKey(key, arr) {
if (!arr)
arr = this.nodes;
let res = arr.filter(n => n.key == key);
if (res.length)
return res.pop();
res = arr.map(n => n.children ? this.findNodeByKey(key, n.children) : null).filter(a => a);
if (res.length)
return res.pop();
return null;
},
async onExpandTreeNode(node) {
if (!node.children) {
if (node.data.path) {
/**
* NOTE(chris): activeEl is for keyboard navigation to
* prevent the focus jumping down to the next parent
* instead of the current submenu entry (which is not yet
* loaded)
*/
let activeEl = null;
this.$nextTick(() => {
this.$nextTick(() => {
activeEl = document.activeElement;
});
});
this.loading = true;
return this.$api
.call(ApiMenu.get(this.config, node.data.path))
.then(result => {
const subNodes = result.data.map(this.mapResultToTreeData);
const realNode = this.findNodeByKey(node.key);
if (realNode)
realNode.children = subNodes;
else
node.children = subNodes; // NOTE(chris): fallback should never be the case
this.$nextTick(() => {
if (activeEl != document.activeElement)
return;
let treeitem = this.$refs.tree.$el.querySelector('[data-tree-item-key="' + node.key + '"]');
if (!treeitem)
return;
treeitem = treeitem.closest('[role="row"]');
if (!treeitem)
return;
treeitem.dispatchEvent(new KeyboardEvent('keydown', {
code: 'ArrowDown',
key: 'ArrowDown'
}));
});
this.loading = false;
})
.catch(this.$fhcAlert.handleSystemError);
}
}
},
onSelectTreeNode(node) {
this.$emit('selectEntry', node.data);
},
mapNodesToNoSemReloadNodes(result, node) {
if (node.data.no_sem_reload)
result.push(node);
if (node.children)
result = node.children.reduce(this.mapNodesToNoSemReloadNodes, result);
return result;
},
mapResultToTreeData(el) {
const cp = {
key: ("" + el.path).replace(/\//g, '-'),
data: el,
label: el.name // TODO(chris): phrase
};
if (el.children)
cp.children = el.children.map(this.mapResultToTreeData);
else
cp.leaf = el.leaf || false;
return cp;
},
async setPreselection()
{
if (!this.preselectedKey)
{
this.selectedKey = null;
return;
}
let rawKey = this.preselectedKey
if (!rawKey || typeof rawKey !== 'string')
return;
const parts = this.preselectedKey.split('/');
let currentKey = parts[0];
let currentNode = this.findNodeByKey(currentKey);
if (!currentNode)
return;
if(this.selectedKey)
{
const currentSelectedKey = Object.keys(this.selectedKey).find(Boolean);
if (currentSelectedKey) {
if (currentSelectedKey == currentKey)
return;
/**
* Do not select a new entry if the current is a child of the new one.
* This happens if a child entry of a new stg is selected and the router
* tries to select the stg root entry (because subtrees do not have
* routes yet)
*/
const isChild = this.findNodeByKey(
currentSelectedKey,
currentNode.children || []
);
if (isChild)
return;
}
}
for (let i = 1; i < parts.length; i++)
{
this.expandedKeys[currentNode.key] = true;
await this.onExpandTreeNode(currentNode);
currentKey += '-' + parts[i];
currentNode = this.findNodeByKey(currentKey);
if (!currentNode)
{
return;
}
}
this.selectedKey = {[currentNode.key]: true};
this.onSelectTreeNode(currentNode);
},
async toggleTreeNode(node) {
if (this.expandedKeys[node.key]) {
delete this.expandedKeys[node.key];
} else if (!node.leaf) {
await this.onExpandTreeNode(node);
this.expandedKeys[node.key] = true;
}
},
filterFav() {
this.favorites.on = !this.favorites.on;
this.$api
.call(ApiMenu.favorites.set(
JSON.stringify(this.favorites)
));
},
markFav(key) {
let index = this.favorites.list.indexOf(key.data.path + '');
if (index != -1) {
this.favorites.list.splice(index, 1);
} else {
this.favorites.list.push(key.data.path + '');
}
this.$api
.call(ApiMenu.favorites.set(
JSON.stringify(this.favorites)
));
},
unsetFavFocus(e) {
if (e.target.dataset?.linkFavAdd !== undefined) {
e.target.tabIndex = -1;
} else {
let items = e.target.querySelectorAll('[data-link-fav-add]:not([tabindex="-1"])');
items.forEach(el => el.tabIndex = document.activeElement == el ? 0 : -1);
}
},
setFavFocus(e) {
if (e.target.dataset?.linkFavAdd !== undefined) {
e.target.tabIndex = 0;
} else {
let items = e.target.querySelectorAll('[data-link-fav-add][tabindex="-1"]');
items.forEach(el => el.tabIndex = 0);
}
}
},
mounted() {
this.$api
.call(ApiMenu.get(this.config))
.then(result => {
this.nodes = result.data.map(el => {
el.root = true;
return this.mapResultToTreeData(el);
});
this.setPreselection();
this.loading = false;
})
.catch(this.$fhcAlert.handleSystemError);
this.$api
.call(ApiMenu.favorites.get())
.then(result => {
if (result.data) {
this.favorites = JSON.parse(result.data);
}
})
.catch(this.$fhcAlert.handleSystemError);
},
template: /* html */`
<pv-treetable
ref="tree"
v-model:expanded-keys="expandedKeys"
v-model:selection-keys="selectedKey"
class="menu p-treetable-sm"
:value="filteredNodes"
selection-mode="single"
scrollable
scroll-height="flex"
:filters="filters"
@node-expand="onExpandTreeNode"
@node-select="onSelectTreeNode"
@focusin="setFavFocus"
@focusout="unsetFavFocus"
>
<pv-column
field="name"
expander
class="text-break"
>
<template #header>
<div class="text-right">
<div class="p-input-icon-left">
<i class="pi pi-search"></i>
<input
type="text"
v-model="filters['global']"
class="form-control ps-5"
placeholder="Search"
>
</div>
</div>
</template>
<template #body="{ node }">
<menu-entry
:node="node"
:data-tree-item-key="node.key"
v-drag-click="() => toggleTreeNode(node)"
@drop="$emit('drop', $event)"
/>
</template>
</pv-column>
<pv-column
field="fav"
class="flex-shrink-0 flex-grow-0"
header-class="flex-shrink-0 flex-grow-0"
>
<template #header>
<a
v-if="favorites.on || favorites.list.length"
href="#"
@click.prevent="filterFav"
>
<i
:class="favorites.on ? 'fa-solid' : 'fa-regular'"
class="fa-star"
></i>
</a>
</template>
<template #body="{ node }">
<a
v-if="node.data.root"
href="#"
tabindex="-1"
data-link-fav-add
@click.prevent="markFav(node)"
@keydown.enter.stop.prevent="markFav(node)"
>
<i
:class="favorites.list.includes(node.data.path + '') ? 'fa-solid' : 'fa-regular'"
class="fa-star"
></i>
</a>
</template>
</pv-column>
<pv-column field="search" class="d-none"></pv-column>
</pv-treetable>`
};
+50
View File
@@ -0,0 +1,50 @@
import drop from '../../../directives/drop.js';
export default {
directives: {
drop
},
emits: [
'drop'
],
props: {
node: {
type: Object,
required: true
}
},
computed: {
name() {
if (Array.isArray(this.node.data.name))
return this.$p.t(this.node.data.name);
return this.node.data.name;
},
title() {
if (!this.node.data.title)
return this.name;
if (Array.isArray(this.node.data.title))
return this.$p.t(this.node.data.title);
return this.node.data.title;
},
dropConfig() {
if (!this.node.data?.droplink)
return null;
const allowed = [ ...this.node.data.droplink ];
const effect = allowed.shift();
return { effect, allowed };
}
},
template: /* html */`
<span
class="menu-entry d-flex align-items-center w-100 h-100"
:title="title"
v-drop:[dropConfig]="(evt, data) => $emit('drop', { drop: node.data, drag: data })"
>
{{ name }}
</span>`
};
@@ -273,10 +273,10 @@ export default {
},
onSelectVerband({ link, studiengang_kz, semester, orgform_kurzbz }) {
let urlpath = String(link);
if (!urlpath.match(/\/prestudent/))
/*if (!urlpath.match(/\/prestudent/))
{
urlpath = 'CURRENT_SEMESTER' + '/' + urlpath;
}
}*/
this.$refs.stvList.updateUrl(ApiStv.students.verband(urlpath));
this.studiengangKz = studiengang_kz;
@@ -1,17 +1,11 @@
import drop from '../../../directives/drop.js';
import dragClick from '../../../directives/dragClick.js';
import BaseMenu from '../../Base/Menu.js';
import ApiStvGroups from '../../../api/factory/stv/group.js';
import ApiStvDetails from '../../../api/factory/stv/details.js';
export default {
components: {
PvTreetable: primevue.treetable,
PvColumn: primevue.column
},
directives: {
drop,
dragClick
BaseMenu
},
inject: {
$reloadList: {
@@ -33,230 +27,22 @@ export default {
'selectVerband'
],
props: {
endpoint: {
type: Object,
required: true,
},
preselectedKey: {
type: String,
default: null
}
},
data() {
return {
loading: true,
nodes: [],
selectedKey: [],
expandedKeys: {},
filters: {}, // TODO(chris): filter only 1st level?
favorites: {on: false, list: []}
}
},
computed: {
filteredNodes() {
if (this.favorites.on)
return this.nodes.filter(node => this.favorites.list.includes(node.key));
return this.nodes;
},
noSemReloadNodes() {
return this.nodes.reduce(this.mapNodesToNoSemReloadNodes, []);
}
},
watch: {
'preselectedKey': function (newVal, oldVal) {
if (newVal !== oldVal) {
this.setPreselection();
}
},
'appConfig.number_displayed_past_studiensemester'(newVal, oldVal) {
if (oldVal !== undefined) {
this.noSemReloadNodes.forEach(node => {
delete node.children;
this.onExpandTreeNode(node);
});
if (oldVal !== undefined && this.$refs.menu) {
this.$refs.menu.reloadNodesWithProp('no_sem_reload');
}
}
},
methods: {
findNodeByKey(key, arr) {
if (!arr)
arr = this.nodes;
let res = arr.filter(n => n.key == key);
if (res.length)
return res.pop();
res = arr.map(n => n.children ? this.findNodeByKey(key, n.children) : null).filter(a => a);
if (res.length)
return res.pop();
return null;
},
async onExpandTreeNode(node) {
if (!node.children) {
if (node.data.link) {
let activeEl = null;
this.$nextTick(() => {
this.$nextTick(() => {
activeEl = document.activeElement;
});
});
this.loading = true;
return this.$api
.call(this.endpoint.get(node.data.link))
.then(result => result.data)
.then(result => {
const subNodes = result.map(this.mapResultToTreeData);
const realNode = this.findNodeByKey(node.key);
if (realNode)
realNode.children = subNodes;
else
node.children = subNodes; // NOTE(chris): fallback should never be the case
let treeitem = this.$refs.tree.$el.querySelector('[data-tree-item-key="' + node.key + '"]');
treeitem = treeitem.closest('[role="row"]');
this.$nextTick(() => {
if (activeEl == document.activeElement)
treeitem.dispatchEvent(new KeyboardEvent('keydown', {
code: 'ArrowDown',
key: 'ArrowDown'
}));
});
this.loading = false;
})
.catch(this.$fhcAlert.handleSystemError);
}
}
},
onSelectTreeNode(node) {
if (node.data.link)
this.$emit('selectVerband', {link: node.data.link, studiengang_kz: node.data.stg_kz, semester: node.data.semester, orgform_kurzbz: node.data.orgform_kurzbz});
},
mapNodesToNoSemReloadNodes(result, node) {
if (node.data.no_sem_reload)
result.push(node);
if (node.children)
result = node.children.reduce(this.mapNodesToNoSemReloadNodes, result);
return result;
},
mapResultToTreeData(el) {
const cp = {
key: ("" + el.link).replace('/', '-'),
data: el,
label: el.name
};
if (el.children)
cp.children = el.children.map(this.mapResultToTreeData);
else
cp.leaf = el.leaf || false;
return cp;
},
filterFav() {
this.favorites.on = !this.favorites.on;
this.$api
.call(this.endpoint.favorites.set(
JSON.stringify(this.favorites)
));
},
markFav(key) {
let index = this.favorites.list.indexOf(key.data.link + '');
if (index != -1) {
this.favorites.list.splice(index, 1);
} else {
this.favorites.list.push(key.data.link + '');
}
this.$api
.call(this.endpoint.favorites.set(
JSON.stringify(this.favorites)
));
},
unsetFavFocus(e) {
if (e.target.dataset?.linkFavAdd !== undefined) {
e.target.tabIndex = -1;
} else {
let items = e.target.querySelectorAll('[data-link-fav-add]:not([tabindex="-1"])');
items.forEach(el => el.tabIndex = document.activeElement == el ? 0 : -1);
}
},
setFavFocus(e) {
if (e.target.dataset?.linkFavAdd !== undefined) {
e.target.tabIndex = 0;
} else {
let items = e.target.querySelectorAll('[data-link-fav-add][tabindex="-1"]');
items.forEach(el => el.tabIndex = 0);
}
},
async setPreselection()
{
if (!this.preselectedKey)
{
this.selectedKey = null;
return;
}
let rawKey = this.preselectedKey
if (!rawKey || typeof rawKey !== 'string')
return;
const parts = this.preselectedKey.split('/');
let currentKey = parts[0];
let currentNode = this.findNodeByKey(currentKey);
if (!currentNode)
return;
if(this.selectedKey)
{
const currentSelectedKey = Object.keys(this.selectedKey).find(Boolean);
if (currentSelectedKey) {
if (currentSelectedKey == currentKey)
return;
/**
* Do not select a new entry if the current is a child of the new one.
* This happens if a child entry of a new stg is selected and the router
* tries to select the stg root entry (because subtrees do not have
* routes yet)
*/
const isChild = this.findNodeByKey(
currentSelectedKey,
currentNode.children || []
);
if (isChild)
return;
}
}
for (let i = 1; i < parts.length; i++)
{
this.expandedKeys[currentNode.key] = true;
await this.onExpandTreeNode(currentNode);
currentKey += '-' + parts[i];
currentNode = this.findNodeByKey(currentKey);
if (!currentNode)
{
return;
}
}
this.selectedKey = {[currentNode.key]: true};
this.onSelectTreeNode(currentNode);
},
async toggleTreeNode(node) {
if (this.expandedKeys[node.key]) {
delete this.expandedKeys[node.key];
} else if (!node.leaf) {
await this.onExpandTreeNode(node);
this.expandedKeys[node.key] = true;
}
if (node.link)
this.$emit('selectVerband', {link: node.link, studiengang_kz: node.stg_kz, semester: node.semester, orgform_kurzbz: node.orgform_kurzbz});
},
getStudentAjaxId(student) {
let res = student.id;
@@ -264,23 +50,22 @@ export default {
res += ' (' + student.vorname + ' ' + student.nachname + ')';
return res;
},
dropStudents(node, students) {
const data = node.data;
onDrop({ drag, drop }) {
let endpoint;
if (data.gruppe_kurzbz) {
endpoint = students.map(student => [
if (drop.gruppe_kurzbz) {
endpoint = drag.map(student => [
this.getStudentAjaxId(student),
ApiStvGroups.add(
student.id,
data.gruppe_kurzbz,
drop.gruppe_kurzbz,
this.currentSemester
)
]);
} else {
const { semester, verband, gruppe } = data;
const { semester, verband, gruppe } = drop;
const params = { semester, verband, gruppe };
endpoint = students.map(student => [
endpoint = drag.map(student => [
this.getStudentAjaxId(student),
ApiStvDetails.saveStudent(
student.id,
@@ -296,117 +81,14 @@ export default {
.catch(this.$fhcAlert.handleSystemError);
}
},
mounted() {
this.$api
.call(this.endpoint.get())
.then(result => {
this.nodes = result.data.map(el => {
el.root = true;
return this.mapResultToTreeData(el);
});
this.setPreselection();
this.loading = false;
})
.catch(this.$fhcAlert.handleSystemError);
this.$api
.call(this.endpoint.favorites.get())
.then(result => {
if (result.data) {
this.favorites = JSON.parse(result.data);
}
})
.catch(this.$fhcAlert.handleSystemError);
},
template: /* html */`
<div class="overflow-auto" tabindex="-1">
<pv-treetable
ref="tree"
class="stv-verband p-treetable-sm"
:value="filteredNodes"
@node-expand="onExpandTreeNode"
selection-mode="single"
v-model:expanded-keys="expandedKeys"
v-model:selection-keys="selectedKey"
@node-select="onSelectTreeNode"
scrollable
scroll-height="flex"
@focusin="setFavFocus"
@focusout="unsetFavFocus"
:filters="filters"
>
<pv-column
field="name"
expander
class="text-break"
>
<template #header>
<div class="text-right">
<div class="p-input-icon-left">
<i class="pi pi-search"></i>
<input
type="text"
v-model="filters['global']"
class="form-control ps-5"
placeholder="Search"
>
</div>
</div>
</template>
<template #body="{ node }">
<span
v-if="['semester', 'verband', 'gruppe', 'gruppe_kurzbz'].some(key => node.data.hasOwnProperty(key))"
:data-tree-item-key="node.key"
:title="node.data.studiengang_kz"
v-drag-click="() => toggleTreeNode(node)"
v-drop:link-strict.student-collection="(evt, students) => dropStudents(node, students)"
>
{{ node.data.name }}
</span>
<span
v-else
:data-tree-item-key="node.key"
:title="node.data.studiengang_kz"
v-drag-click="() => toggleTreeNode(node)"
>
{{ node.data.name }}
</span>
</template>
</pv-column>
<pv-column
field="fav"
class="flex-shrink-0 flex-grow-0"
header-class="flex-shrink-0 flex-grow-0"
>
<template #header>
<a
v-if="favorites.on || favorites.list.length"
href="#"
@click.prevent="filterFav"
>
<i
:class="favorites.on ? 'fa-solid' : 'fa-regular'"
class="fa-star"
></i>
</a>
</template>
<template #body="{ node }">
<a
v-if="node.data.root"
href="#"
tabindex="-1"
data-link-fav-add
@click.prevent="markFav(node)"
@keydown.enter.stop.prevent="markFav(node)"
>
<i
:class="favorites.list.includes(node.data.link + '') ? 'fa-solid' : 'fa-regular'"
class="fa-star"
></i>
</a>
</template>
</pv-column>
<pv-column field="studiengang_kz" class="d-none"></pv-column>
</pv-treetable>
<base-menu
ref="menu"
config="stv"
:preselected-key="preselectedKey"
@select-entry="onSelectTreeNode"
@drop="onDrop"
/>
</div>`
};
+20
View File
@@ -9,6 +9,26 @@ const EFFECTS = [
export default {
mounted(el, binding) {
if (!binding.arg) {
binding.arg = 'none';
} else if (typeof binding.arg === 'object' && !Array.isArray(binding.arg)) {
// NOTE(chris): allow object as arg and map it to arg and
// modifiers to allow dynamic modifiers.
if (binding.arg.allowed) {
binding.modifiers = binding.arg.allowed.reduce((a, c) => {
a[c] = true;
return a;
}, {});
}
if (!binding.arg.effect)
binding.arg.effect = 'none';
if (binding.arg.strict)
binding.arg = binding.arg.effect + '-strict';
else
binding.arg = binding.arg.effect;
}
const allowedTypes = Object.keys(binding.modifiers);
allowedTypes.forEach(type => {
if (type.substr(-11) == '-collection') {