Avii/Radicale
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #2012 from maxberger/master

Browse Source 
Support PermittedCreateCollectionByToken in UI
This commit is contained in:
Peter Bieringer
2026-03-04 06:18:13 +01:00
committed by GitHub
parent 460b249cdc 193878f659
commit aba14178a2
7 changed files with 335 additions and 311 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
radicale/sharing/__init__.py
View File

@@ -963,10 +963,10 @@ class BaseSharing:
answer['Status'] = "success" answer['Status'] = "success"
if ShareType in ["all", "map"]: if ShareType in ["all", "map"]:
answer['FeatureEnabledCollectionByMap'] = self.sharing_collection_by_map answer['FeatureEnabledCollectionByMap'] = self.sharing_collection_by_map
answer['PermittedCreateCollectionByMap'] = True # TODO toggle per permission, default? answer['PermittedCreateCollectionByMap'] = self.permit_create_map
if ShareType in ["all", "token"]: if ShareType in ["all", "token"]:
answer['FeatureEnabledCollectionByToken'] = self.sharing_collection_by_token answer['FeatureEnabledCollectionByToken'] = self.sharing_collection_by_token
answer['PermittedCreateCollectionByToken'] = True # TODO toggle per permission, default? answer['PermittedCreateCollectionByToken'] = self.permit_create_token
# action: TOGGLE # action: TOGGLE
elif action in API_SHARE_TOGGLES_V1: elif action in API_SHARE_TOGGLES_V1:

28
radicale/tests/test_sharing.py
View File

@@ -220,7 +220,9 @@ class TestSharingApiSanity(BaseTest):
# path with valid API and hook but not enabled "token" # path with valid API and hook but not enabled "token"
self.configure({"sharing": { self.configure({"sharing": {
"collection_by_map": "True", "collection_by_map": "True",
"collection_by_token": "False"} "collection_by_token": "False",
"permit_create_map": "False",
"permit_create_token": "False"}
}) })
sharetype = "token" sharetype = "token"
for action in sharing.API_HOOKS_V1: for action in sharing.API_HOOKS_V1:
@@ -233,10 +235,10 @@ class TestSharingApiSanity(BaseTest):
json_dict = {} json_dict = {}
_, headers, answer = self._sharing_api_json("all", "info", check=200, login="owner:ownerpw", json_dict=json_dict) _, headers, answer = self._sharing_api_json("all", "info", check=200, login="owner:ownerpw", json_dict=json_dict)
answer_dict = json.loads(answer) answer_dict = json.loads(answer)
assert answer_dict['FeatureEnabledCollectionByMap'] is True assert answer_dict['FeatureEnabledCollectionByMap'] is True, f'FeatureEnabledCollectionByMap {db_type}'
assert answer_dict['FeatureEnabledCollectionByToken'] is False assert answer_dict['FeatureEnabledCollectionByToken'] is False, f'FeatureEnabledCollectionByToken {db_type}'
assert answer_dict['PermittedCreateCollectionByMap'] is True assert answer_dict['PermittedCreateCollectionByMap'] is False, f'PermittedCreateCollectionByMap {db_type}'
assert answer_dict['PermittedCreateCollectionByToken'] is True assert answer_dict['PermittedCreateCollectionByToken'] is False, f'PermittedCreateCollectionByToken {db_type}'
logging.info("\n*** check API hook: info/map") logging.info("\n*** check API hook: info/map")
json_dict = {} json_dict = {}
@@ -270,6 +272,22 @@ class TestSharingApiSanity(BaseTest):
assert 'FeatureEnabledCollectionByMap' not in answer_dict assert 'FeatureEnabledCollectionByMap' not in answer_dict
assert 'PermittedCreateCollectionByMap' not in answer_dict assert 'PermittedCreateCollectionByMap' not in answer_dict
# When turning on permission to create
self.configure({"sharing": {
"collection_by_map": "True",
"collection_by_token": "True",
"permit_create_map": "True",
"permit_create_token": "True"}
})
logging.info("\n*** check API hook: info/all")
json_dict = {}
_, headers, answer = self._sharing_api_json("all", "info", check=200, login="owner:ownerpw", json_dict=json_dict)
answer_dict = json.loads(answer)
assert answer_dict['FeatureEnabledCollectionByMap'] is True, f'FeatureEnabledCollectionByMap {db_type}'
assert answer_dict['FeatureEnabledCollectionByToken'] is True, f'FeatureEnabledCollectionByToken {db_type}'
assert answer_dict['PermittedCreateCollectionByMap'] is True, f'PermittedCreateCollectionByMap {db_type}'
assert answer_dict['PermittedCreateCollectionByToken'] is True, f'PermittedCreateCollectionByToken {db_type}'
def test_sharing_api_list_with_auth(self) -> None: def test_sharing_api_list_with_auth(self) -> None:
"""POST/list with authentication.""" """POST/list with authentication."""
self.configure({"auth": {"type": "htpasswd", self.configure({"auth": {"type": "htpasswd",

5
radicale/web/internal_data/CollectionsScene.js
View File

@@ -21,9 +21,9 @@
import { CreateEditCollectionScene } from "./CreateEditCollectionScene.js"; import { CreateEditCollectionScene } from "./CreateEditCollectionScene.js";
import { DeleteCollectionScene } from "./DeleteCollectionScene.js"; import { DeleteCollectionScene } from "./DeleteCollectionScene.js";
import { LoadingScene } from "./LoadingScene.js"; import { LoadingScene } from "./LoadingScene.js";
import { CreateShareCollectionScene } from "./ShareCollectionScene.js"; import { CreateShareCollectionScene, maybe_enable_sharing_options } from "./ShareCollectionScene.js";
import { UploadCollectionScene } from "./UploadCollectionScene.js"; import { UploadCollectionScene } from "./UploadCollectionScene.js";
import { get_collections } from "./api.js"; import { discover_server_features, get_collections } from "./api.js";
import { SERVER } from "./constants.js"; import { SERVER } from "./constants.js";
import { Collection, CollectionType } from "./models.js"; import { Collection, CollectionType } from "./models.js";
import { Scene, pop_scene, push_scene, scene_stack } from "./scene_manager.js"; import { Scene, pop_scene, push_scene, scene_stack } from "./scene_manager.js";
@@ -189,6 +189,7 @@ export class CollectionsScene {
upload_btn.onclick = onupload; upload_btn.onclick = onupload;
if (collections === null) { if (collections === null) {
update(); update();
discover_server_features(user, password, maybe_enable_sharing_options);
} else { } else {
// from update loading scene // from update loading scene
show_collections(collections); show_collections(collections);

48
radicale/web/internal_data/CreateEditCollectionScene.js
View File

@@ -18,12 +18,12 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
import { Scene, push_scene, pop_scene, scene_stack } from "./scene_manager.js";
import { Collection, CollectionType } from "./models.js";
import { random_uuid, random_hex, cleanHREFinput, isValidHREF } from "./utils.js";
import { LoadingScene } from "./LoadingScene.js"; import { LoadingScene } from "./LoadingScene.js";
import { COLOR_RE } from "./constants.js";
import { create_collection, edit_collection } from "./api.js"; import { create_collection, edit_collection } from "./api.js";
import { COLOR_RE } from "./constants.js";
import { Collection, CollectionType } from "./models.js";
import { Scene, pop_scene, push_scene, scene_stack } from "./scene_manager.js";
import { cleanHREFinput, isValidHREF, random_hex, random_uuid } from "./utils.js";
/** /**
* @constructor * @constructor
@@ -34,7 +34,8 @@ import { create_collection, edit_collection } from "./api.js";
* collection will be created inside of it. * collection will be created inside of it.
* Otherwise the collection will be edited. * Otherwise the collection will be edited.
*/ */
export function CreateEditCollectionScene(user, password, collection) { export class CreateEditCollectionScene {
constructor(user, password, collection) {
let edit = collection.type !== CollectionType.PRINCIPAL; let edit = collection.type !== CollectionType.PRINCIPAL;
let html_scene = document.getElementById(edit ? "editcollectionscene" : "createcollectionscene"); let html_scene = document.getElementById(edit ? "editcollectionscene" : "createcollectionscene");
/** @type {HTMLElement} */ let title_form = edit ? html_scene.querySelector("[data-name=title]") : null; /** @type {HTMLElement} */ let title_form = edit ? html_scene.querySelector("[data-name=title]") : null;
@@ -67,7 +68,7 @@ export function CreateEditCollectionScene(user, password, collection) {
let type = edit ? collection.type : CollectionType.CALENDAR_JOURNAL_TASKS; let type = edit ? collection.type : CollectionType.CALENDAR_JOURNAL_TASKS;
let color = edit && collection.color ? collection.color : "#" + random_hex(6); let color = edit && collection.color ? collection.color : "#" + random_hex(6);
if(!edit){ if (!edit) {
href_form.addEventListener("keydown", cleanHREFinput); href_form.addEventListener("keydown", cleanHREFinput);
} }
@@ -86,10 +87,10 @@ export function CreateEditCollectionScene(user, password, collection) {
} }
function read_form() { function read_form() {
if(!edit){ if (!edit) {
cleanHREFinput(href_form); cleanHREFinput(href_form);
let newhreftxtvalue = href_form.value.trim().toLowerCase(); let newhreftxtvalue = href_form.value.trim().toLowerCase();
if(!isValidHREF(newhreftxtvalue)){ if (!isValidHREF(newhreftxtvalue)) {
alert("You must enter a valid HREF"); alert("You must enter a valid HREF");
return false; return false;
} }
@@ -104,7 +105,7 @@ export function CreateEditCollectionScene(user, password, collection) {
} }
function fill_form() { function fill_form() {
if(!edit){ if (!edit) {
href_form.value = random_uuid(); href_form.value = random_uuid();
} }
displayname_form.value = displayname; displayname_form.value = displayname;
@@ -112,7 +113,7 @@ export function CreateEditCollectionScene(user, password, collection) {
source_form.value = source; source_form.value = source;
type_form.value = type; type_form.value = type;
color_form.value = color; color_form.value = color;
if(error){ if (error) {
error_form.textContent = "Error: " + error; error_form.textContent = "Error: " + error;
error_form.classList.remove("hidden"); error_form.classList.remove("hidden");
} }
@@ -123,7 +124,7 @@ export function CreateEditCollectionScene(user, password, collection) {
function onsubmit() { function onsubmit() {
try { try {
if(!read_form()){ if (!read_form()) {
return false; return false;
} }
let sane_color = color.trim(); let sane_color = color.trim();
@@ -139,7 +140,7 @@ export function CreateEditCollectionScene(user, password, collection) {
let loading_scene = new LoadingScene(); let loading_scene = new LoadingScene();
push_scene(loading_scene, false); push_scene(loading_scene, false);
let collection = new Collection(href, type, displayname, description, sane_color, 0, 0, source); let collection = new Collection(href, type, displayname, description, sane_color, 0, 0, source);
let callback = function(error1) { let callback = function (error1) {
if (scene_index === null) { if (scene_index === null) {
return; return;
} }
@@ -156,7 +157,7 @@ export function CreateEditCollectionScene(user, password, collection) {
} else { } else {
create_edit_req = create_collection(user, password, collection, callback); create_edit_req = create_collection(user, password, collection, callback);
} }
} catch(err) { } catch (err) {
console.error(err); console.error(err);
} }
return false; return false;
@@ -165,29 +166,29 @@ export function CreateEditCollectionScene(user, password, collection) {
function oncancel() { function oncancel() {
try { try {
pop_scene(scene_index - 1); pop_scene(scene_index - 1);
} catch(err) { } catch (err) {
console.error(err); console.error(err);
} }
return false; return false;
} }
function onTypeChange(e){ function onTypeChange(e) {
if(type_form.value == CollectionType.WEBCAL){ if (type_form.value == CollectionType.WEBCAL) {
source_label.classList.remove("hidden"); source_label.classList.remove("hidden");
source_form.classList.remove("hidden"); source_form.classList.remove("hidden");
}else{ } else {
source_label.classList.add("hidden"); source_label.classList.add("hidden");
source_form.classList.add("hidden"); source_form.classList.add("hidden");
} }
} }
this.show = function() { this.show = function () {
this.release(); this.release();
scene_index = scene_stack.length - 1; scene_index = scene_stack.length - 1;
// Clone type_form because it's impossible to hide options without removing them // Clone type_form because it's impossible to hide options without removing them
saved_type_form = type_form; saved_type_form = type_form;
type_form = type_form.cloneNode(true); type_form = /** @type {HTMLSelectElement} */ (type_form.cloneNode(true));
saved_type_form.parentNode.replaceChild(type_form, saved_type_form); saved_type_form.parentNode.replaceChild(type_form, saved_type_form);
remove_invalid_types(); remove_invalid_types();
html_scene.classList.remove("hidden"); html_scene.classList.remove("hidden");
@@ -197,14 +198,14 @@ export function CreateEditCollectionScene(user, password, collection) {
fill_form(); fill_form();
submit_btn.onclick = onsubmit; submit_btn.onclick = onsubmit;
cancel_btn.onclick = oncancel; cancel_btn.onclick = oncancel;
if(error){ if (error) {
error_form.textContent = "Error: " + error; error_form.textContent = "Error: " + error;
error_form.classList.remove("hidden"); error_form.classList.remove("hidden");
}else{ } else {
error_form.classList.add("hidden"); error_form.classList.add("hidden");
} }
}; };
this.hide = function() { this.hide = function () {
read_form(); read_form();
html_scene.classList.add("hidden"); html_scene.classList.add("hidden");
// restore type_form // restore type_form
@@ -214,11 +215,12 @@ export function CreateEditCollectionScene(user, password, collection) {
submit_btn.onclick = null; submit_btn.onclick = null;
cancel_btn.onclick = null; cancel_btn.onclick = null;
}; };
this.release = function() { this.release = function () {
scene_index = null; scene_index = null;
if (create_edit_req !== null) { if (create_edit_req !== null) {
create_edit_req.abort(); create_edit_req.abort();
create_edit_req = null; create_edit_req = null;
} }
}; };
}
} }

32
radicale/web/internal_data/LoginScene.js
View File

@@ -18,17 +18,17 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
import { Scene, push_scene, pop_scene, scene_stack } from "./scene_manager.js"; import { get_principal } from "./api.js";
import { LoadingScene } from "./LoadingScene.js";
import { get_principal, discover_server_features } from "./api.js";
import { CollectionsScene } from "./CollectionsScene.js"; import { CollectionsScene } from "./CollectionsScene.js";
import { maybe_enable_sharing_options } from "./ShareCollectionScene.js"; import { LoadingScene } from "./LoadingScene.js";
import { Scene, pop_scene, push_scene, scene_stack } from "./scene_manager.js";
/** /**
* @constructor * @constructor
* @implements {Scene} * @implements {Scene}
*/ */
export function LoginScene() { export class LoginScene {
constructor() {
/** @type {HTMLElement} */ let html_scene = document.getElementById("loginscene"); /** @type {HTMLElement} */ let html_scene = document.getElementById("loginscene");
/** @type {HTMLElement} */ let form = html_scene.querySelector("[data-name=form]"); /** @type {HTMLElement} */ let form = html_scene.querySelector("[data-name=form]");
/** @type {HTMLInputElement} */ let user_form = html_scene.querySelector("[data-name=user]"); /** @type {HTMLInputElement} */ let user_form = html_scene.querySelector("[data-name=user]");
@@ -51,10 +51,10 @@ export function LoginScene() {
function fill_form() { function fill_form() {
user_form.value = user; user_form.value = user;
password_form.value = ""; password_form.value = "";
if(error){ if (error) {
error_form.textContent = "Error: " + error; error_form.textContent = "Error: " + error;
error_form.classList.remove("hidden"); error_form.classList.remove("hidden");
}else{ } else {
error_form.classList.add("hidden"); error_form.classList.add("hidden");
} }
} }
@@ -73,7 +73,7 @@ export function LoginScene() {
// Fetch principal // Fetch principal
let loading_scene = new LoadingScene(); let loading_scene = new LoadingScene();
push_scene(loading_scene, false); push_scene(loading_scene, false);
principal_req = get_principal(user, password, function(collection, error1) { principal_req = get_principal(user, password, function (collection, error1) {
if (scene_index === null) { if (scene_index === null) {
return; return;
} }
@@ -86,11 +86,10 @@ export function LoginScene() {
let saved_user = user; let saved_user = user;
user = ""; user = "";
let collections_scene = new CollectionsScene( let collections_scene = new CollectionsScene(
saved_user, password, collection, function(error1) { saved_user, password, collection, function (error1) {
error = error1; error = error1;
user = saved_user; user = saved_user;
}); });
discover_server_features(saved_user, password, maybe_enable_sharing_options);
push_scene(collections_scene, true); push_scene(collections_scene, true);
} }
}); });
@@ -98,7 +97,7 @@ export function LoginScene() {
error = "Username is empty"; error = "Username is empty";
fill_form(); fill_form();
} }
} catch(err) { } catch (err) {
console.error(err); console.error(err);
} }
return false; return false;
@@ -124,14 +123,14 @@ export function LoginScene() {
logout_user_form.textContent = ""; logout_user_form.textContent = "";
} }
function refresh(){ function refresh() {
//The easiest way to refresh is to push a LoadingScene onto the stack and then pop it //The easiest way to refresh is to push a LoadingScene onto the stack and then pop it
//forcing the scene below it, the Collections Scene to refresh itself. //forcing the scene below it, the Collections Scene to refresh itself.
push_scene(new LoadingScene(), false); push_scene(new LoadingScene(), false);
pop_scene(scene_stack.length-2); pop_scene(scene_stack.length - 2);
} }
this.show = function() { this.show = function () {
remove_logout(); remove_logout();
fill_form(); fill_form();
form.onsubmit = onlogin; form.onsubmit = onlogin;
@@ -139,12 +138,12 @@ export function LoginScene() {
scene_index = scene_stack.length - 1; scene_index = scene_stack.length - 1;
user_form.focus(); user_form.focus();
}; };
this.hide = function() { this.hide = function () {
read_form(); read_form();
html_scene.classList.add("hidden"); html_scene.classList.add("hidden");
form.onsubmit = null; form.onsubmit = null;
}; };
this.release = function() { this.release = function () {
scene_index = null; scene_index = null;
// cancel pending requests // cancel pending requests
if (principal_req !== null) { if (principal_req !== null) {
@@ -153,4 +152,5 @@ export function LoginScene() {
} }
remove_logout(); remove_logout();
}; };
}
} }

8
radicale/web/internal_data/ShareCollectionScene.js
View File

@@ -83,12 +83,14 @@ export class CreateShareCollectionScene {
scene_index = scene_stack.length - 1; scene_index = scene_stack.length - 1;
html_scene.classList.remove("hidden"); html_scene.classList.remove("hidden");
cancel_btn.onclick = oncancel; cancel_btn.onclick = oncancel;
if (server_features["sharing"]["FeatureEnabledCollectionByToken"]) { if (server_features["sharing"]["PermittedCreateCollectionByToken"]) {
share_by_token_btn_ro.classList.remove("hidden");
share_by_token_btn_rw.classList.remove("hidden");
share_by_token_btn_ro.onclick = onsharebytoken_ro; share_by_token_btn_ro.onclick = onsharebytoken_ro;
share_by_token_btn_rw.onclick = onsharebytoken_rw; share_by_token_btn_rw.onclick = onsharebytoken_rw;
} else { } else {
share_by_token_btn_ro.parentElement.removeChild(share_by_token_btn_ro); share_by_token_btn_ro.classList.add("hidden");
share_by_token_btn_rw.parentElement.removeChild(share_by_token_btn_rw); share_by_token_btn_rw.classList.add("hidden");
} }
title.textContent = collection.displayname || collection.href; title.textContent = collection.displayname || collection.href;
update_share_list(user, password, collection); update_share_list(user, password, collection);

15
radicale/web/internal_data/api.js
View File

@@ -28,7 +28,7 @@ export let server_features = {};
* Find the principal collection. * Find the principal collection.
* @param {string} user * @param {string} user
* @param {string} password * @param {string} password
* @param {function(?Collection, ?string)} callback Returns result or error * @param {function(?Collection, ?string):void} callback Returns result or error
* @return {XMLHttpRequest} * @return {XMLHttpRequest}
*/ */
export function get_principal(user, password, callback) { export function get_principal(user, password, callback) {
@@ -48,6 +48,7 @@ export function get_principal(user, password, callback) {
CollectionType.PRINCIPAL, CollectionType.PRINCIPAL,
displayname_element ? displayname_element.textContent : "", displayname_element ? displayname_element.textContent : "",
"", "",
"",
0, 0,
""), null); ""), null);
} else { } else {
@@ -72,7 +73,7 @@ export function get_principal(user, password, callback) {
* @param {string} user * @param {string} user
* @param {string} password * @param {string} password
* @param {Collection} collection * @param {Collection} collection
* @param {function(?Array<Collection>, ?string)} callback Returns result or error * @param {function(?Array<Collection>, ?string):void} callback Returns result or error
* @return {XMLHttpRequest} * @return {XMLHttpRequest}
*/ */
export function get_collections(user, password, collection, callback) { export function get_collections(user, password, collection, callback) {
@@ -195,7 +196,7 @@ export function get_collections(user, password, collection, callback) {
* @param {string} password * @param {string} password
* @param {string} collection_href Must always start and end with /. * @param {string} collection_href Must always start and end with /.
* @param {File} file * @param {File} file
* @param {function(?string)} callback Returns error or null * @param {function(?string):void} callback Returns error or null
* @return {XMLHttpRequest} * @return {XMLHttpRequest}
*/ */
export function upload_collection(user, password, collection_href, file, callback) { export function upload_collection(user, password, collection_href, file, callback) {
@@ -220,7 +221,7 @@ export function upload_collection(user, password, collection_href, file, callbac
* @param {string} user * @param {string} user
* @param {string} password * @param {string} password
* @param {Collection} collection * @param {Collection} collection
* @param {function(?string)} callback Returns error or null * @param {function(?string):void} callback Returns error or null
* @return {XMLHttpRequest} * @return {XMLHttpRequest}
*/ */
export function delete_collection(user, password, collection, callback) { export function delete_collection(user, password, collection, callback) {
@@ -245,7 +246,7 @@ export function delete_collection(user, password, collection, callback) {
* @param {string} password * @param {string} password
* @param {Collection} collection * @param {Collection} collection
* @param {boolean} create * @param {boolean} create
* @param {function(?string)} callback Returns error or null * @param {function(?string):void} callback Returns error or null
* @return {XMLHttpRequest} * @return {XMLHttpRequest}
*/ */
function create_edit_collection(user, password, collection, create, callback) { function create_edit_collection(user, password, collection, create, callback) {
@@ -325,7 +326,7 @@ function create_edit_collection(user, password, collection, create, callback) {
* @param {string} user * @param {string} user
* @param {string} password * @param {string} password
* @param {Collection} collection * @param {Collection} collection
* @param {function(?string)} callback Returns error or null * @param {function(?string):void} callback Returns error or null
* @return {XMLHttpRequest} * @return {XMLHttpRequest}
*/ */
export function create_collection(user, password, collection, callback) { export function create_collection(user, password, collection, callback) {
@@ -336,7 +337,7 @@ export function create_collection(user, password, collection, callback) {
* @param {string} user * @param {string} user
* @param {string} password * @param {string} password
* @param {Collection} collection * @param {Collection} collection
* @param {function(?string)} callback Returns error or null * @param {function(?string):void} callback Returns error or null
* @return {XMLHttpRequest} * @return {XMLHttpRequest}
*/ */
export function edit_collection(user, password, collection, callback) { export function edit_collection(user, password, collection, callback) {