From ee1c8b7c14e5582a6b8c66dc9de5265029dc5592 Mon Sep 17 00:00:00 2001
From: no84by <50858621+no84by@users.noreply.github.com>
Date: Wed, 18 Nov 2026 11:36:40 +0000
Subject: [PATCH] feat(policies): add default ink color for the draw signature
pad
Add the system-only draw_ink_color policy. Its value is exposed as
draw-ink-color in the sign-elements capabilities and used as the
initial pen color of the draw signature pad. The default stays black
and signers can still pick another color.
Signed-off-by: no84by <50858621+no84by@users.noreply.github.com>
---
lib/Capabilities.php | 2 +
lib/ResponseDefinitions.php | 1 +
.../DrawInkColor/DrawInkColorPolicy.php | 56 +++++++++++++
.../Policy/Provider/PolicyProviders.php | 2 +
openapi-administration.json | 6 +-
openapi-full.json | 6 +-
openapi.json | 6 +-
src/components/Draw/Editor.vue | 5 +-
src/tests/components/Draw/Editor.spec.ts | 30 +++++++
.../DrawInkColorRuleEditor.spec.ts | 47 +++++++++++
.../draw-ink-color/realDefinition.spec.ts | 57 +++++++++++++
.../settings/realDefinitions.spec.ts | 1 +
src/types/openapi/openapi-administration.ts | 1 +
src/types/openapi/openapi-full.ts | 1 +
src/types/openapi/openapi.ts | 1 +
.../draw-ink-color/DrawInkColorRuleEditor.vue | 80 +++++++++++++++++++
.../settings/draw-ink-color/model.ts | 23 ++++++
.../settings/draw-ink-color/realDefinition.ts | 44 ++++++++++
.../settings/realDefinitions.ts | 2 +
tests/php/Unit/CapabilitiesTest.php | 32 +++++---
.../DrawInkColor/DrawInkColorPolicyTest.php | 74 +++++++++++++++++
21 files changed, 460 insertions(+), 17 deletions(-)
create mode 100644 lib/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicy.php
create mode 100644 src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.spec.ts
create mode 100644 src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.spec.ts
create mode 100644 src/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.vue
create mode 100644 src/views/Settings/PolicyWorkbench/settings/draw-ink-color/model.ts
create mode 100644 src/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.ts
create mode 100644 tests/php/Unit/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicyTest.php
diff --git a/lib/Capabilities.php b/lib/Capabilities.php
index c3c6abcd6c..7f697e0bd9 100644
--- a/lib/Capabilities.php
+++ b/lib/Capabilities.php
@@ -11,6 +11,7 @@
use OCA\Libresign\Service\Envelope\EnvelopeService;
use OCA\Libresign\Service\Policy\PolicyService;
use OCA\Libresign\Service\Policy\Provider\Confetti\ConfettiPolicy;
+use OCA\Libresign\Service\Policy\Provider\DrawInkColor\DrawInkColorPolicy;
use OCA\Libresign\Service\SignatureTextService;
use OCA\Libresign\Service\SignerElementsService;
use OCP\App\IAppManager;
@@ -51,6 +52,7 @@ public function getCapabilities(): array {
'full-signature-height' => $this->signatureTextService->getFullSignatureHeight(),
'signature-width' => $this->signatureTextService->getSignatureWidth(),
'signature-height' => $this->signatureTextService->getSignatureHeight(),
+ 'draw-ink-color' => (string)$this->policyService->resolve(DrawInkColorPolicy::KEY)->getEffectiveValue(),
],
'envelope' => [
'is-available' => $this->envelopeService->isEnabled(),
diff --git a/lib/ResponseDefinitions.php b/lib/ResponseDefinitions.php
index 81fe277cdf..881755b801 100644
--- a/lib/ResponseDefinitions.php
+++ b/lib/ResponseDefinitions.php
@@ -955,6 +955,7 @@
* full-signature-height: float,
* signature-width: float,
* signature-height: float,
+ * draw-ink-color: string,
* },
* envelope: array{
* is-available: bool,
diff --git a/lib/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicy.php b/lib/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicy.php
new file mode 100644
index 0000000000..8be54ec1c4
--- /dev/null
+++ b/lib/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicy.php
@@ -0,0 +1,56 @@
+ new PolicySpec(
+ key: self::KEY,
+ defaultSystemValue: self::DEFAULT_COLOR,
+ allowedValues: [],
+ normalizer: static fn (mixed $rawValue): string => strtolower(trim((string)$rawValue)),
+ validator: static function (mixed $value): void {
+ if (!is_string($value) || preg_match(self::COLOR_PATTERN, $value) !== 1) {
+ throw new \InvalidArgumentException('Invalid value for ' . self::KEY);
+ }
+ },
+ appConfigKey: self::SYSTEM_APP_CONFIG_KEY,
+ supportsUserPreference: false,
+ supportsRequestOverride: false,
+ requestLifecycle: PolicySpec::LIFECYCLE_RUNTIME,
+ supportedScopes: [PolicySpec::SCOPE_SYSTEM],
+ supportsGroupAdminDelegation: false,
+ ),
+ default => throw new \InvalidArgumentException('Unknown policy key: ' . PolicyKeyNormalizer::normalize($policyKey)),
+ };
+ }
+}
diff --git a/lib/Service/Policy/Provider/PolicyProviders.php b/lib/Service/Policy/Provider/PolicyProviders.php
index 4319d04f57..585dbe4b94 100644
--- a/lib/Service/Policy/Provider/PolicyProviders.php
+++ b/lib/Service/Policy/Provider/PolicyProviders.php
@@ -14,6 +14,7 @@
use OCA\Libresign\Service\Policy\Provider\CrlValidation\CrlValidationPolicy;
use OCA\Libresign\Service\Policy\Provider\DefaultUserFolder\DefaultUserFolderPolicy;
use OCA\Libresign\Service\Policy\Provider\DocMdp\DocMdpPolicy;
+use OCA\Libresign\Service\Policy\Provider\DrawInkColor\DrawInkColorPolicy;
use OCA\Libresign\Service\Policy\Provider\EmailSignerSignature\EmailSignerSignaturePolicy;
use OCA\Libresign\Service\Policy\Provider\Envelope\EnvelopePolicy;
use OCA\Libresign\Service\Policy\Provider\ExpirationRules\ExpirationRulesPolicy;
@@ -46,6 +47,7 @@ final class PolicyProviders {
CrlValidationPolicy::KEY => CrlValidationPolicy::class,
FooterPolicy::KEY => FooterPolicy::class,
DocMdpPolicy::KEY => DocMdpPolicy::class,
+ DrawInkColorPolicy::KEY => DrawInkColorPolicy::class,
EmailSignerSignaturePolicy::KEY => EmailSignerSignaturePolicy::class,
EnvelopePolicy::KEY => EnvelopePolicy::class,
ExpirationRulesPolicy::KEY_MAXIMUM_VALIDITY => ExpirationRulesPolicy::class,
diff --git a/openapi-administration.json b/openapi-administration.json
index d4ce2ce7d4..8f13b13489 100644
--- a/openapi-administration.json
+++ b/openapi-administration.json
@@ -120,7 +120,8 @@
"full-signature-width",
"full-signature-height",
"signature-width",
- "signature-height"
+ "signature-height",
+ "draw-ink-color"
],
"properties": {
"is-available": {
@@ -144,6 +145,9 @@
"signature-height": {
"type": "number",
"format": "double"
+ },
+ "draw-ink-color": {
+ "type": "string"
}
}
},
diff --git a/openapi-full.json b/openapi-full.json
index c7c79e3450..5195dfe334 100644
--- a/openapi-full.json
+++ b/openapi-full.json
@@ -254,7 +254,8 @@
"full-signature-width",
"full-signature-height",
"signature-width",
- "signature-height"
+ "signature-height",
+ "draw-ink-color"
],
"properties": {
"is-available": {
@@ -278,6 +279,9 @@
"signature-height": {
"type": "number",
"format": "double"
+ },
+ "draw-ink-color": {
+ "type": "string"
}
}
},
diff --git a/openapi.json b/openapi.json
index 6b4e635e67..f86ba74153 100644
--- a/openapi.json
+++ b/openapi.json
@@ -207,7 +207,8 @@
"full-signature-width",
"full-signature-height",
"signature-width",
- "signature-height"
+ "signature-height",
+ "draw-ink-color"
],
"properties": {
"is-available": {
@@ -231,6 +232,9 @@
"signature-height": {
"type": "number",
"format": "double"
+ },
+ "draw-ink-color": {
+ "type": "string"
}
}
},
diff --git a/src/components/Draw/Editor.vue b/src/components/Draw/Editor.vue
index 98bc06117e..1665c90aa5 100644
--- a/src/components/Draw/Editor.vue
+++ b/src/components/Draw/Editor.vue
@@ -102,7 +102,8 @@ const capabilities = getCapabilities() as LibresignCapabilities
const signElementsConfig = capabilities.libresign?.config['sign-elements']
const canvasWidth = Number(signElementsConfig?.['signature-width'])
const canvasHeight = Number(signElementsConfig?.['signature-height'])
-const color = ref('#000000')
+const defaultInkColor = signElementsConfig?.['draw-ink-color'] || '#000000'
+const color = ref(defaultInkColor)
const customPalette = [
'#000000',
'#ff0000',
@@ -196,7 +197,7 @@ onMounted(() => {
if (!canvas.value) {
return
}
- canvas.value.signaturePad = new SignaturePad(canvas.value)
+ canvas.value.signaturePad = new SignaturePad(canvas.value, { penColor: color.value })
canvas.value.signaturePad.addEventListener('endStroke', () => {
canSave.value = !canvas.value?.signaturePad?.isEmpty()
})
diff --git a/src/tests/components/Draw/Editor.spec.ts b/src/tests/components/Draw/Editor.spec.ts
index 0a5339745d..59c50b4f5e 100644
--- a/src/tests/components/Draw/Editor.spec.ts
+++ b/src/tests/components/Draw/Editor.spec.ts
@@ -107,6 +107,36 @@ describe('Editor.vue - Drawing Signature Editor', () => {
expect(wrapper.vm.color).toBe('#000000')
})
+ it('starts with the ink color configured by the administrator', async () => {
+ const { getCapabilities } = await import('@nextcloud/capabilities')
+ vi.mocked(getCapabilities).mockReturnValueOnce({
+ libresign: {
+ config: {
+ 'sign-elements': {
+ 'signature-width': 700,
+ 'signature-height': 200,
+ 'draw-ink-color': '#1f2a5a',
+ },
+ },
+ },
+ })
+ vi.resetModules()
+ const { default: FreshEditor } = await import('../../../components/Draw/Editor.vue')
+ const { default: FreshSignaturePad } = await import('signature_pad')
+ const wrapper = mount(FreshEditor, {
+ global: {
+ mocks: {
+ t,
+ },
+ },
+ })
+ await wrapper.vm.$nextTick()
+ await wrapper.vm.$nextTick()
+
+ expect(wrapper.vm.color).toBe('#1f2a5a')
+ expect(FreshSignaturePad).toHaveBeenCalledWith(expect.anything(), { penColor: '#1f2a5a' })
+ })
+
it('has predefined color palette', () => {
const wrapper = mount(Editor, {
global: {
diff --git a/src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.spec.ts b/src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.spec.ts
new file mode 100644
index 0000000000..021c945002
--- /dev/null
+++ b/src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.spec.ts
@@ -0,0 +1,47 @@
+/*
+ * SPDX-FileCopyrightText: 2026 LibreSign contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { mount } from '@vue/test-utils'
+import { describe, expect, it, vi } from 'vitest'
+
+import { createL10nMock } from '../../../../../testHelpers/l10n.js'
+import DrawInkColorRuleEditor from '../../../../../../views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.vue'
+
+vi.mock('@nextcloud/l10n', () => createL10nMock())
+
+const colorPickerStub = {
+ props: ['modelValue'],
+ template: '
',
+}
+
+function mountEditor(modelValue: string | null) {
+ return mount(DrawInkColorRuleEditor, {
+ props: { modelValue },
+ global: { stubs: { NcColorPicker: colorPickerStub } },
+ })
+}
+
+describe('DrawInkColorRuleEditor.vue', () => {
+ it('shows the current color', () => {
+ const wrapper = mountEditor('#1f2a5a')
+
+ expect(wrapper.text()).toContain('Default ink color for drawn signatures')
+ expect(wrapper.find('.picker-stub').attributes('data-value')).toBe('#1f2a5a')
+ })
+
+ it('falls back to black for an invalid value', () => {
+ const wrapper = mountEditor('unexpected')
+
+ expect(wrapper.find('.picker-stub').attributes('data-value')).toBe('#000000')
+ })
+
+ it('emits the picked color normalized to lowercase', async () => {
+ const wrapper = mountEditor('#000000')
+
+ await wrapper.find('.picker-pick').trigger('click')
+
+ expect(wrapper.emitted('update:modelValue')?.[0]?.[0]).toBe('#1f2a5a')
+ })
+})
diff --git a/src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.spec.ts b/src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.spec.ts
new file mode 100644
index 0000000000..314f3a50d6
--- /dev/null
+++ b/src/tests/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.spec.ts
@@ -0,0 +1,57 @@
+/*
+ * SPDX-FileCopyrightText: 2026 LibreSign contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { describe, expect, it, vi } from 'vitest'
+
+import { createL10nMock } from '../../../../../testHelpers/l10n.js'
+import { drawInkColorRealDefinition } from '../../../../../../views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition'
+import { resolveDrawInkColor } from '../../../../../../views/Settings/PolicyWorkbench/settings/draw-ink-color/model'
+
+vi.mock('@nextcloud/l10n', () => createL10nMock())
+
+describe('drawInkColorRealDefinition', () => {
+ it('is a system-only setting that defaults to black', () => {
+ expect(drawInkColorRealDefinition.key).toBe('draw_ink_color')
+ expect(drawInkColorRealDefinition.supportedScopes).toEqual(['system'])
+ expect(drawInkColorRealDefinition.createEmptyValue()).toBe('#000000')
+ expect(drawInkColorRealDefinition.getFallbackSystemDefault(null, null)).toBe('#000000')
+ expect(drawInkColorRealDefinition.normalizeAllowChildOverride('system', true)).toBe(false)
+ expect(drawInkColorRealDefinition.groupAdminBehavior?.canRenderPolicy?.(null)).toBe(false)
+ })
+
+ it('keeps the stored system value as fallback default', () => {
+ expect(drawInkColorRealDefinition.getFallbackSystemDefault('#1f2a5a', 'system')).toBe('#1f2a5a')
+ expect(drawInkColorRealDefinition.getFallbackSystemDefault('#1f2a5a', 'group')).toBe('#000000')
+ })
+
+ it.each([
+ ['#1F2A5A', '#1f2a5a'],
+ ['#000000', '#000000'],
+ ['red', 'Not configured'],
+ [true, 'Not configured'],
+ ])('summarizes %s as %s', (value, summary) => {
+ expect(drawInkColorRealDefinition.summarizeValue(value)).toBe(summary)
+ })
+
+ it('normalizes draft values to a hex color', () => {
+ expect(drawInkColorRealDefinition.normalizeDraftValue(' #ABCDEF ')).toBe('#abcdef')
+ expect(drawInkColorRealDefinition.normalizeDraftValue('unexpected')).toBe('#000000')
+ expect(drawInkColorRealDefinition.hasSelectableDraftValue('unexpected')).toBe(false)
+ })
+})
+
+describe('resolveDrawInkColor', () => {
+ it.each([
+ ['#1f2a5a', '#1f2a5a'],
+ [' #1F2A5A ', '#1f2a5a'],
+ ['#fff', null],
+ ['1f2a5a', null],
+ ['#12345g', null],
+ [1, null],
+ [null, null],
+ ])('resolves %s to %s', (value, expected) => {
+ expect(resolveDrawInkColor(value)).toBe(expected)
+ })
+})
diff --git a/src/tests/views/Settings/PolicyWorkbench/settings/realDefinitions.spec.ts b/src/tests/views/Settings/PolicyWorkbench/settings/realDefinitions.spec.ts
index 1e2aea679d..b8bbec8ddd 100644
--- a/src/tests/views/Settings/PolicyWorkbench/settings/realDefinitions.spec.ts
+++ b/src/tests/views/Settings/PolicyWorkbench/settings/realDefinitions.spec.ts
@@ -25,6 +25,7 @@ const expectedTopLevelKeys = [
'signature_stamp',
'show_confetti_after_signing',
'persist_email_signer_signatures',
+ 'draw_ink_color',
'collect_metadata',
'signer_device_geolocation',
'signer_ip_geolocation',
diff --git a/src/types/openapi/openapi-administration.ts b/src/types/openapi/openapi-administration.ts
index 6a280db00c..6ae3eaf8b4 100644
--- a/src/types/openapi/openapi-administration.ts
+++ b/src/types/openapi/openapi-administration.ts
@@ -387,6 +387,7 @@ export type components = {
"signature-width": number;
/** Format: double */
"signature-height": number;
+ "draw-ink-color": string;
};
envelope: {
"is-available": boolean;
diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
index a37db13462..d9bb0d3cdf 100644
--- a/src/types/openapi/openapi-full.ts
+++ b/src/types/openapi/openapi-full.ts
@@ -1423,6 +1423,7 @@ export type components = {
"signature-width": number;
/** Format: double */
"signature-height": number;
+ "draw-ink-color": string;
};
envelope: {
"is-available": boolean;
diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
index 9fd7aa8f47..1ebe9179f4 100644
--- a/src/types/openapi/openapi.ts
+++ b/src/types/openapi/openapi.ts
@@ -1080,6 +1080,7 @@ export type components = {
"signature-width": number;
/** Format: double */
"signature-height": number;
+ "draw-ink-color": string;
};
envelope: {
"is-available": boolean;
diff --git a/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.vue b/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.vue
new file mode 100644
index 0000000000..a0434cf958
--- /dev/null
+++ b/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/DrawInkColorRuleEditor.vue
@@ -0,0 +1,80 @@
+
+
+
+
+
+
{{ title }}
+
{{ description }}
+
+
+
+
+
+
+
+
+
+
diff --git a/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/model.ts b/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/model.ts
new file mode 100644
index 0000000000..b0e4e1d5c6
--- /dev/null
+++ b/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/model.ts
@@ -0,0 +1,23 @@
+/**
+ * SPDX-FileCopyrightText: 2026 LibreCode coop and contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import type { EffectivePolicyValue } from '../../../../../types/index'
+
+export const DEFAULT_DRAW_INK_COLOR = '#000000'
+
+/**
+ * Normalize the draw ink color policy value to a lowercase #rrggbb string.
+ *
+ * @param value Raw effective policy value.
+ * @return Normalized color or null when the input is not a hex color.
+ */
+export function resolveDrawInkColor(value: EffectivePolicyValue): string | null {
+ if (typeof value !== 'string') {
+ return null
+ }
+
+ const normalized = value.trim().toLowerCase()
+ return /^#[0-9a-f]{6}$/.test(normalized) ? normalized : null
+}
diff --git a/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.ts b/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.ts
new file mode 100644
index 0000000000..b10b87a7f2
--- /dev/null
+++ b/src/views/Settings/PolicyWorkbench/settings/draw-ink-color/realDefinition.ts
@@ -0,0 +1,44 @@
+/**
+ * SPDX-FileCopyrightText: 2026 LibreCode coop and contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { t } from '@nextcloud/l10n'
+
+import type { EffectivePolicyValue } from '../../../../../types/index'
+import type { RealPolicySettingDefinition } from '../realTypes'
+import DrawInkColorRuleEditor from './DrawInkColorRuleEditor.vue'
+import { DEFAULT_DRAW_INK_COLOR, resolveDrawInkColor } from './model'
+
+export const drawInkColorRealDefinition: RealPolicySettingDefinition = {
+ key: 'draw_ink_color',
+ // TRANSLATORS Policy title for the initial ink color of the pad where signers draw their signature.
+ title: t('libresign', 'Default ink color for drawn signatures'),
+ // TRANSLATORS Policy description. Signers can still choose another color while drawing.
+ description: t('libresign', 'Set the color the signature drawing pad starts with. Signers can still choose another color while drawing.'),
+ supportedScopes: ['system'],
+ groupAdminBehavior: {
+ canRenderPolicy: () => false,
+ },
+ editor: DrawInkColorRuleEditor,
+ createEmptyValue: () => DEFAULT_DRAW_INK_COLOR,
+ normalizeDraftValue: (value: EffectivePolicyValue) => resolveDrawInkColor(value) ?? DEFAULT_DRAW_INK_COLOR,
+ hasSelectableDraftValue: (value: EffectivePolicyValue) => resolveDrawInkColor(value) !== null,
+ normalizeAllowChildOverride: () => false,
+ getFallbackSystemDefault: (policyValue: EffectivePolicyValue | null | undefined, sourceScope?: string | null) => {
+ if (sourceScope === 'system' && policyValue !== null && policyValue !== undefined) {
+ return policyValue
+ }
+
+ return DEFAULT_DRAW_INK_COLOR
+ },
+ summarizeValue: (value: EffectivePolicyValue) => {
+ return resolveDrawInkColor(value)
+ // TRANSLATORS Fallback policy summary shown when no valid ink color is set.
+ ?? t('libresign', 'Not configured')
+ },
+ formatAllowOverride: () => {
+ // TRANSLATORS Policy inheritance message indicating group and user scopes cannot override this setting.
+ return t('libresign', 'Lower-level customization is disabled for this setting')
+ },
+}
diff --git a/src/views/Settings/PolicyWorkbench/settings/realDefinitions.ts b/src/views/Settings/PolicyWorkbench/settings/realDefinitions.ts
index 44b66b69ba..16f3c6acf0 100644
--- a/src/views/Settings/PolicyWorkbench/settings/realDefinitions.ts
+++ b/src/views/Settings/PolicyWorkbench/settings/realDefinitions.ts
@@ -8,6 +8,7 @@ import { confettiRealDefinition } from './confetti/realDefinition'
import { crlValidationRealDefinition } from './crl-validation/realDefinition'
import { defaultUserFolderRealDefinition } from './default-user-folder/realDefinition'
import { docMdpRealDefinition } from './docmdp/realDefinition'
+import { drawInkColorRealDefinition } from './draw-ink-color/realDefinition'
import { emailSignerSignatureRealDefinition } from './email-signer-signature/realDefinition'
import { envelopeRealDefinition } from './envelope/realDefinition'
import {
@@ -53,6 +54,7 @@ export const realDefinitions = {
signature_stamp: { ...signatureTextRealDefinition, category: 'signer-experience' },
show_confetti_after_signing: { ...confettiRealDefinition, category: 'signer-experience' },
persist_email_signer_signatures: { ...emailSignerSignatureRealDefinition, category: 'signer-experience' },
+ draw_ink_color: { ...drawInkColorRealDefinition, category: 'signer-experience' },
// 4. What gets recorded
collect_metadata: { ...collectMetadataRealDefinition, category: 'what-gets-recorded' },
diff --git a/tests/php/Unit/CapabilitiesTest.php b/tests/php/Unit/CapabilitiesTest.php
index 408b248367..b539fc9aec 100644
--- a/tests/php/Unit/CapabilitiesTest.php
+++ b/tests/php/Unit/CapabilitiesTest.php
@@ -14,6 +14,7 @@
use OCA\Libresign\Service\Policy\Model\ResolvedPolicy;
use OCA\Libresign\Service\Policy\PolicyService;
use OCA\Libresign\Service\Policy\Provider\Confetti\ConfettiPolicy;
+use OCA\Libresign\Service\Policy\Provider\DrawInkColor\DrawInkColorPolicy;
use OCA\Libresign\Service\SignatureTextService;
use OCA\Libresign\Service\SignerElementsService;
use OCP\App\IAppManager;
@@ -49,14 +50,20 @@ private function getClass(): Capabilities {
return $this->capabilities;
}
+ private function mockResolvedPolicies(bool $showConfetti = true, string $drawInkColor = '#000000'): void {
+ $values = [
+ ConfettiPolicy::KEY => $showConfetti,
+ DrawInkColorPolicy::KEY => $drawInkColor,
+ ];
+ $this->policyService->method('resolve')
+ ->willReturnCallback(fn (string $key): ResolvedPolicy => (new ResolvedPolicy())
+ ->setPolicyKey($key)
+ ->setEffectiveValue($values[$key]));
+ }
+
#[DataProvider('providerSignElementsIsAvailable')]
public function testSignElementsIsAvailable($isEnabled, $expected): void {
- $resolved = (new ResolvedPolicy())
- ->setPolicyKey(ConfettiPolicy::KEY)
- ->setEffectiveValue(true);
- $this->policyService->method('resolve')
- ->with(ConfettiPolicy::KEY)
- ->willReturn($resolved);
+ $this->mockResolvedPolicies();
$this->signerElementsService->method('isSignElementsAvailable')->willReturn($isEnabled);
$capabilities = $this->getClass()->getCapabilities();
$this->assertEquals($expected, $capabilities['libresign']['config']['sign-elements']['is-available']);
@@ -71,12 +78,7 @@ public static function providerSignElementsIsAvailable(): array {
#[DataProvider('providerShowConfetti')]
public function testShowConfetti(bool $configValue, bool $expected): void {
- $resolved = (new ResolvedPolicy())
- ->setPolicyKey(ConfettiPolicy::KEY)
- ->setEffectiveValue($configValue);
- $this->policyService->method('resolve')
- ->with(ConfettiPolicy::KEY)
- ->willReturn($resolved);
+ $this->mockResolvedPolicies(showConfetti: $configValue);
$capabilities = $this->getClass()->getCapabilities();
$this->assertEquals($expected, $capabilities['libresign']['config']['show-confetti']);
}
@@ -87,4 +89,10 @@ public static function providerShowConfetti(): array {
[false, false],
];
}
+
+ public function testDrawInkColor(): void {
+ $this->mockResolvedPolicies(drawInkColor: '#1f2a5a');
+ $capabilities = $this->getClass()->getCapabilities();
+ $this->assertSame('#1f2a5a', $capabilities['libresign']['config']['sign-elements']['draw-ink-color']);
+ }
}
diff --git a/tests/php/Unit/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicyTest.php b/tests/php/Unit/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicyTest.php
new file mode 100644
index 0000000000..9974780714
--- /dev/null
+++ b/tests/php/Unit/Service/Policy/Provider/DrawInkColor/DrawInkColorPolicyTest.php
@@ -0,0 +1,74 @@
+assertSame([DrawInkColorPolicy::KEY], $provider->keys());
+
+ $definition = $provider->get(DrawInkColorPolicy::KEY);
+ $this->assertSame(DrawInkColorPolicy::KEY, $definition->key());
+ $this->assertSame('#000000', $definition->defaultSystemValue());
+ $this->assertSame([PolicySpec::SCOPE_SYSTEM], $definition->supportedScopes());
+ $this->assertFalse($definition->supportsUserPreference());
+ $this->assertFalse($definition->supportsRequestOverride());
+ $this->assertFalse($definition->supportsGroupAdminDelegation());
+ }
+
+ #[DataProvider('provideNormalizedValues')]
+ public function testNormalizeValue(mixed $raw, string $expected): void {
+ $definition = (new DrawInkColorPolicy())->get(DrawInkColorPolicy::KEY);
+ $this->assertSame($expected, $definition->normalizeValue($raw));
+ }
+
+ public static function provideNormalizedValues(): array {
+ return [
+ ['#1F2A5A', '#1f2a5a'],
+ [' #1f2a5a ', '#1f2a5a'],
+ ['#000000', '#000000'],
+ ];
+ }
+
+ public function testValidateAcceptsHexColor(): void {
+ $definition = (new DrawInkColorPolicy())->get(DrawInkColorPolicy::KEY);
+ $definition->validateValue('#1f2a5a', new PolicyContext());
+ $this->addToAssertionCount(1);
+ }
+
+ #[DataProvider('provideInvalidValues')]
+ public function testValidateRejectsInvalidColor(mixed $value): void {
+ $definition = (new DrawInkColorPolicy())->get(DrawInkColorPolicy::KEY);
+ $this->expectException(\InvalidArgumentException::class);
+ $definition->validateValue($definition->normalizeValue($value), new PolicyContext());
+ }
+
+ public static function provideInvalidValues(): array {
+ return [
+ [''],
+ [null],
+ ['red'],
+ ['#fff'],
+ ['#12345g'],
+ ['1f2a5a'],
+ ['#1f2a5a; x'],
+ ];
+ }
+
+ public function testProviderRejectsUnknownKey(): void {
+ $this->expectException(\InvalidArgumentException::class);
+ (new DrawInkColorPolicy())->get('unknown');
+ }
+}