Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9249b80cb6 | ||
|
|
cc5b9518e4 | ||
|
|
f6cd67ed0d | ||
|
|
4c379a0245 | ||
|
|
39840a20d7 | ||
|
|
2c16a9ebbb | ||
|
|
1201db175b |
No files matched your search
@@ -48,7 +48,20 @@ jobs:
|
||||
|
||||
- name: Compute version
|
||||
id: ver
|
||||
run: echo "version=$(date -u +'%Y.%m.%d-%H%M')" >> "$GITHUB_OUTPUT"
|
||||
run: |
|
||||
# Date-based version to the minute. Two pushes in the same minute would collide on the tag,
|
||||
# so keep moving to the next minute until the tag is unused (format stays YYYY.MM.DD-HHMM).
|
||||
git fetch --tags --quiet origin || true
|
||||
TS=$(date -u +%s)
|
||||
while true; do
|
||||
V=$(date -u -d "@$TS" +'%Y.%m.%d-%H%M')
|
||||
if git rev-parse -q --verify "refs/tags/$V" >/dev/null || git ls-remote --exit-code --tags origin "refs/tags/$V" >/dev/null 2>&1; then
|
||||
TS=$((TS + 60))
|
||||
else
|
||||
break
|
||||
fi
|
||||
done
|
||||
echo "version=$V" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Generate release notes
|
||||
id: notes
|
||||
|
||||
@@ -30,6 +30,11 @@ You need two values from PayPal: a **Client ID** and a **Secret**.
|
||||
Start in **Sandbox**, make a test donation using a PayPal sandbox buyer account, then repeat the steps
|
||||
with the Live credentials and switch the mode to Live in Settings.
|
||||
|
||||
### Behind Cloudflare?
|
||||
Nothing to do: the plugin recognises Cloudflare automatically (by its published addresses) so each visitor is rate
|
||||
limited separately. For another proxy, choose it in StreamGoals > Settings > Advanced; the panel there shows what your
|
||||
server sees.
|
||||
|
||||
### Notes on fees and currency
|
||||
- "Cover the processing fees" adds an estimate based on the rates in Settings (default: US domestic,
|
||||
3.49% + $0.49). Your actual PayPal rate depends on your account, country and payment method.
|
||||
@@ -51,6 +56,19 @@ with the Live credentials and switch the mode to Live in Settings.
|
||||
form, as a **Rewards menu** overlay for OBS, and as a highlighted line in the donation alert. Triggered rewards land in a
|
||||
**queue** on the Rewards screen so you can tick them off as you do them. Rewards count the donation amount, not the
|
||||
optional fee cover, and must be at least your minimum donation.
|
||||
- **Alerts with pictures, GIFs, videos and sounds:** StreamGoals > Alerts. Pick files from your WordPress Media Library
|
||||
(PNG, JPEG, GIF, WebP, MP4, WebM for the picture/video; MP3, OGG, WAV for sound). Tie an alert to **a donation size**
|
||||
("any donation of at least $5": the highest matching amount wins) or to **a reward** (a reward alert beats an amount
|
||||
alert). Set the volume, how long a picture stays, and a message using `{name}`, `{amount}` and `{reward}`. In OBS media
|
||||
plays automatically; in an ordinary browser tab click the page once before sound is allowed. Keep files small (videos
|
||||
under about 25 MB). If a file is deleted the alert still shows, just without it.
|
||||
- **Tiers (milestones):** on the Goals screen use **Tiers** to turn one goal into a ladder, for example $100 "Giveaway",
|
||||
$250 "New microphone", $500 "24-hour stream". The goal bar shows the current tier and fills within it; unlocking a tier
|
||||
shows a **TIER UNLOCKED** line in the alert and the bar moves on to the next one. The goal's final target is your highest
|
||||
tier. The donation form shows "Next unlock: ... to go".
|
||||
- **End at target:** tick "Close this goal to donations when the target is reached" on a goal. When the total reaches or
|
||||
passes the target (for a tiered goal, the final tier) the goal closes and the donation page says so. Donations already
|
||||
in checkout still go through. Use **Reopen** after raising the target.
|
||||
- **Test:** "Send test donation" on the Overlays screen shows an alert without touching real totals.
|
||||
|
||||
## Privacy and moderation
|
||||
|
||||
@@ -44,3 +44,15 @@
|
||||
.sg-admin .sg-filter { display: inline-block; margin: 8px 8px 8px 0; }
|
||||
.sg-admin .sg-table { max-width: 100%; }
|
||||
@media (max-width: 782px) { .sg-admin .sg-copy { flex-direction: column; align-items: stretch; } }
|
||||
/* Phones: wide tables scroll inside their own box instead of pushing the page; controls never exceed the card. */
|
||||
@media (max-width: 782px) {
|
||||
.sg-admin table.sg-table { display: block; max-width: 100%; overflow-x: auto; -webkit-overflow-scrolling: touch; }
|
||||
.sg-admin .sg-table th, .sg-admin .sg-table td { min-width: 3em; padding: 8px 6px; font-size: 13px; }
|
||||
.sg-admin .sg-table code { overflow-wrap: anywhere; word-break: break-all; font-size: 12px; }
|
||||
.sg-admin .sg-table td:last-child .button { margin: 0 4px 4px 0; }
|
||||
.sg-admin .sg-card details > summary { min-height: 44px; display: flex; align-items: center; cursor: pointer; }
|
||||
.sg-admin .sg-card label > input[type="radio"], .sg-admin .sg-card label > input[type="checkbox"] { margin-right: 6px; }
|
||||
.sg-admin .sg-card p > label + .description, .sg-admin .sg-card p > label { display: inline-block; margin: 4px 0; }
|
||||
.sg-admin select, .sg-admin input[type="text"], .sg-admin input[type="url"], .sg-admin input[type="number"], .sg-admin textarea { max-width: 100%; box-sizing: border-box; }
|
||||
.sg-admin .sg-card { padding-left: 14px; padding-right: 14px; }
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
.sga-help{list-style:disc;margin-left:1.4em}
|
||||
.sga-media{display:flex;flex-wrap:wrap;align-items:center;gap:8px}
|
||||
.sga-media-name{font-weight:600;overflow-wrap:anywhere}
|
||||
.sga-media-warn{flex-basis:100%;margin:0;color:#996800}
|
||||
.sga-media-warn:empty{display:none}
|
||||
.sga-form input[type=range]{vertical-align:middle;width:220px;max-width:100%}
|
||||
.sga-stage{min-height:140px;display:flex;align-items:flex-end;justify-content:center;padding:16px;background:repeating-conic-gradient(#2b2b33 0 25%,#34343d 0 50%) 0 0/20px 20px;border-radius:6px;font-size:18px;color:#fff;line-height:1.2}
|
||||
.sga-alert{width:100%;max-width:560px;text-align:center;background:rgba(0,0,0,.45);border:2px solid #7c5cff;border-radius:12px;padding:10px 14px}
|
||||
.sga-alert-media{display:flex;justify-content:center;margin-bottom:6px}
|
||||
.sga-alert-media img,.sga-alert-media video{display:block;max-width:100%;max-height:260px;object-fit:contain;border-radius:6px}
|
||||
.sga-alert-head{font-weight:800;font-size:1.2em}
|
||||
.sga-alert-head b{color:#22d3ee}
|
||||
.sga-idle{color:#bbb;font-size:14px;align-self:center}
|
||||
|
||||
/* Phones: radio rows breathe, slider fills the width, preview stage scales and never overflows. */
|
||||
@media (max-width:782px){
|
||||
.sga-form label{display:inline-block;margin:6px 0;min-height:32px}
|
||||
.sga-form input[type=range]{width:100%;min-height:32px}
|
||||
.sga-stage{min-height:120px;padding:10px;font-size:16px;overflow:hidden;box-sizing:border-box;max-width:100%}
|
||||
.sga-alert{box-sizing:border-box}
|
||||
.sga-alert-media img,.sga-alert-media video{max-height:180px}
|
||||
.sga-media .button{min-height:40px}
|
||||
}
|
||||
@@ -0,0 +1,150 @@
|
||||
/* StreamGoals alert editor: Media Library pickers (wp.media) and a live preview that mirrors the overlay. */
|
||||
( function () {
|
||||
'use strict';
|
||||
var form = document.querySelector( '.sga-form' );
|
||||
var dataEl = document.getElementById( 'sga-data' );
|
||||
var stage = document.getElementById( 'sga-stage' );
|
||||
var playBtn = document.getElementById( 'sga-play' );
|
||||
if ( ! form || ! dataEl || ! stage || ! playBtn ) { return; }
|
||||
var cfg = { currency: 'USD', exp: 2, rewards: [], videoCap: 30000, warnBytes: 26214400, allowed: {} };
|
||||
try { cfg = JSON.parse( dataEl.textContent ); } catch ( e ) { /* defaults */ }
|
||||
var timers = [], media = [];
|
||||
|
||||
function el( tag, cls, text ) {
|
||||
var e = document.createElement( tag );
|
||||
if ( cls ) { e.className = cls; }
|
||||
if ( text != null ) { e.textContent = text; }
|
||||
return e;
|
||||
}
|
||||
|
||||
/* ---- Media Library pickers ---- */
|
||||
Array.prototype.forEach.call( form.querySelectorAll( '.sga-media' ), function ( box ) {
|
||||
var input = box.querySelector( 'input[type=hidden]' );
|
||||
var nameEl = box.querySelector( '.sga-media-name' );
|
||||
var warnEl = box.querySelector( '.sga-media-warn' );
|
||||
var kind = box.getAttribute( 'data-kind' );
|
||||
var frame = null;
|
||||
|
||||
function set( id, url, mime, name, size ) {
|
||||
input.value = String( id || 0 );
|
||||
input.setAttribute( 'data-url', url || '' );
|
||||
input.setAttribute( 'data-mime', mime || '' );
|
||||
nameEl.textContent = id ? name : 'Nothing chosen';
|
||||
var msg = '';
|
||||
if ( id && size > cfg.warnBytes ) {
|
||||
msg = 'This file is over 25 MB. Big files load slowly' + ( /^video\//.test( mime ) ? ' and large videos can make OBS stutter. A short, compressed clip is much better.' : '.' );
|
||||
}
|
||||
warnEl.textContent = msg;
|
||||
input.dispatchEvent( new Event( 'change', { bubbles: true } ) );
|
||||
}
|
||||
function accepts( mime ) {
|
||||
var k = cfg.allowed[ String( mime ).toLowerCase() ];
|
||||
return kind === 'sound' ? k === 'audio' : ( k === 'image' || k === 'video' );
|
||||
}
|
||||
box.querySelector( '.sga-pick' ).addEventListener( 'click', function () {
|
||||
if ( ! window.wp || ! wp.media ) { nameEl.textContent = 'The Media Library could not be loaded. Reload the page.'; return; }
|
||||
if ( ! frame ) {
|
||||
frame = wp.media( {
|
||||
title: kind === 'sound' ? 'Choose a sound' : 'Choose a picture, GIF or video',
|
||||
button: { text: 'Use this file' },
|
||||
library: { type: kind === 'sound' ? [ 'audio' ] : [ 'image', 'video' ] },
|
||||
multiple: false
|
||||
} );
|
||||
frame.on( 'select', function () {
|
||||
var a = frame.state().get( 'selection' ).first().toJSON();
|
||||
if ( ! accepts( a.mime ) ) {
|
||||
warnEl.textContent = 'That file type is not allowed (' + a.mime + '). ' + ( kind === 'sound' ? 'Use MP3, OGG or WAV.' : 'Use PNG, JPEG, GIF, WebP, MP4 or WebM.' );
|
||||
return;
|
||||
}
|
||||
set( a.id, a.url, a.mime, a.filename || a.title || ( 'File ' + a.id ), a.filesizeInBytes || 0 );
|
||||
} );
|
||||
}
|
||||
frame.open();
|
||||
} );
|
||||
box.querySelector( '.sga-clear' ).addEventListener( 'click', function () { set( 0, '', '', '', 0 ); } );
|
||||
} );
|
||||
|
||||
var vol = form.elements.volume, volOut = document.getElementById( 'sga_volume_out' );
|
||||
if ( vol && volOut ) { vol.addEventListener( 'input', function () { volOut.textContent = vol.value; } ); }
|
||||
|
||||
/* ---- preview ---- */
|
||||
function toMinor( raw ) {
|
||||
var s = String( raw == null ? '' : raw ).replace( /[,\s$€£¥]/g, '' );
|
||||
var m = /^(\d+)(?:\.(\d+))?$/.exec( s );
|
||||
if ( ! m ) { return null; }
|
||||
var frac = m[ 2 ] || '';
|
||||
if ( frac.length > cfg.exp ) { return null; }
|
||||
while ( frac.length < cfg.exp ) { frac += '0'; }
|
||||
return parseInt( m[ 1 ] + frac, 10 );
|
||||
}
|
||||
function money( minor ) {
|
||||
var s = String( minor );
|
||||
if ( cfg.exp === 0 ) { return cfg.currency + ' ' + s; }
|
||||
while ( s.length <= cfg.exp ) { s = '0' + s; }
|
||||
return cfg.currency + ' ' + s.slice( 0, -cfg.exp ) + '.' + s.slice( -cfg.exp );
|
||||
}
|
||||
function clean( s ) { return String( s ).replace( /<[^>]*>/g, '' ).replace( /[<>\u0000-\u001f\u007f]/g, ' ' ).replace( /\s+/g, ' ' ).trim(); }
|
||||
function render( tpl, vals ) {
|
||||
var t = clean( tpl );
|
||||
if ( ! t ) { return ''; }
|
||||
return t.replace( /\{([A-Za-z_]{1,20})\}/g, function ( m, k ) { return vals[ k.toLowerCase() ] || ''; } ).replace( /\s+/g, ' ' ).trim().slice( 0, 200 );
|
||||
}
|
||||
function stop() {
|
||||
timers.forEach( clearTimeout ); timers = [];
|
||||
media.forEach( function ( m ) { try { m.pause(); } catch ( e ) { /* ignore */ } } ); media = [];
|
||||
}
|
||||
function inp( name ) { return form.querySelector( '[name="' + name + '"]' ); }
|
||||
|
||||
function play() {
|
||||
stop();
|
||||
stage.textContent = '';
|
||||
var vis = inp( 'visual_id' ), snd = inp( 'sound_id' );
|
||||
var visUrl = vis.value !== '0' ? vis.getAttribute( 'data-url' ) : '', visMime = vis.getAttribute( 'data-mime' ) || '';
|
||||
var sndUrl = snd.value !== '0' ? snd.getAttribute( 'data-url' ) : '';
|
||||
var volume = Math.max( 0, Math.min( 100, parseInt( form.elements.volume.value, 10 ) || 0 ) ) / 100;
|
||||
var dur = Math.max( 1, Math.min( 60, parseFloat( form.elements.duration.value ) || 6 ) ) * 1000;
|
||||
var trig = form.querySelector( 'input[name="trigger_type"]:checked' );
|
||||
var amt = trig && trig.value === 'amount' ? toMinor( form.elements.amount.value ) : null;
|
||||
var rewardSel = form.elements.action_id;
|
||||
var reward = rewardSel && rewardSel.value !== '0' && rewardSel.selectedIndex > 0 ? rewardSel.options[ rewardSel.selectedIndex ].text.replace( / \(turned off\)$/, '' ) : 'Your reward';
|
||||
var vals = { name: 'Alex', amount: money( amt || 500 ), reward: reward };
|
||||
var msg = render( form.elements.message.value, vals );
|
||||
|
||||
var card = el( 'div', 'sga-alert' );
|
||||
var isVideo = /^video\//.test( visMime ), video = null;
|
||||
if ( visUrl ) {
|
||||
var box = el( 'div', 'sga-alert-media' );
|
||||
if ( isVideo ) {
|
||||
video = document.createElement( 'video' );
|
||||
video.playsInline = true; video.setAttribute( 'playsinline', '' );
|
||||
video.muted = !! sndUrl || volume === 0; video.volume = volume;
|
||||
video.src = visUrl; box.appendChild( video );
|
||||
} else {
|
||||
var img = new Image(); img.alt = ''; img.src = visUrl; box.appendChild( img );
|
||||
}
|
||||
card.appendChild( box );
|
||||
}
|
||||
var head = el( 'div', 'sga-alert-head' );
|
||||
if ( msg ) { head.textContent = msg; }
|
||||
else { head.appendChild( el( 'b', null, vals.name ) ); head.appendChild( document.createTextNode( ' donated ' ) ); head.appendChild( el( 'b', null, vals.amount ) ); }
|
||||
card.appendChild( head );
|
||||
stage.appendChild( card );
|
||||
|
||||
if ( sndUrl ) {
|
||||
var au = new Audio( sndUrl ); au.volume = volume; media.push( au );
|
||||
var p = au.play(); if ( p && p.catch ) { p.catch( function () { head.appendChild( el( 'div', 'sga-idle', 'Sound was blocked by the browser.' ) ); } ); }
|
||||
}
|
||||
var end = function () { stop(); stage.textContent = ''; stage.appendChild( el( 'span', 'sga-idle', 'Preview finished.' ) ); };
|
||||
if ( video ) {
|
||||
media.push( video );
|
||||
video.onended = end;
|
||||
var vp = video.play();
|
||||
if ( vp && vp.catch ) { vp.catch( function () { video.muted = true; var again = video.play(); if ( again && again.catch ) { again.catch( function () {} ); } } ); }
|
||||
timers.push( setTimeout( end, cfg.videoCap ) );
|
||||
} else {
|
||||
timers.push( setTimeout( end, dur ) );
|
||||
}
|
||||
}
|
||||
playBtn.addEventListener( 'click', play );
|
||||
stage.appendChild( el( 'span', 'sga-idle', 'Press "Play preview".' ) );
|
||||
}() );
|
||||
@@ -1,4 +1,4 @@
|
||||
.sg-donate{max-width:28rem;font:inherit}
|
||||
.sg-donate{max-width:min(100%,440px);font:inherit}
|
||||
.sg-donate .sg-row{margin:0 0 .9rem}
|
||||
.sg-donate label{display:block;font-weight:600;margin-bottom:.25rem}
|
||||
.sg-donate label.sg-inline{display:flex;gap:.5rem;align-items:center;font-weight:400}
|
||||
@@ -16,7 +16,8 @@
|
||||
.sg-donate label.sg-sub{font-weight:400;margin:.2rem 0 .25rem}
|
||||
.sg-donate .sg-hint{font-size:.85em;opacity:.75;margin-top:.25rem}
|
||||
.sg-donate .sg-cover{display:flex;align-items:center;gap:.5rem}
|
||||
.sg-donate .sg-info{flex:none;width:1.4rem;height:1.4rem;padding:0;border-radius:50%;border:1.5px solid currentColor;background:transparent;color:inherit;font:italic 700 .85rem/1 Georgia,serif;cursor:pointer;display:inline-flex;align-items:center;justify-content:center}
|
||||
.sg-donate .sg-info{flex:none;width:44px;height:44px;margin:-12px -12px -12px -8px;padding:0;position:relative;border:0;border-radius:50%;background:transparent;color:inherit;font:italic 700 14px/1 Georgia,serif;cursor:pointer;display:inline-flex;align-items:center;justify-content:center;touch-action:manipulation}
|
||||
.sg-donate .sg-info::before{content:"";position:absolute;top:50%;left:50%;width:20px;height:20px;margin:-11px 0 0 -11px;border:1.5px solid currentColor;border-radius:50%;box-sizing:content-box}
|
||||
.sg-donate .sg-info:focus-visible{outline:2px solid currentColor;outline-offset:2px}
|
||||
.sg-donate .sg-tip{margin-top:.4rem;padding:.6rem .75rem;border:1px solid rgba(128,128,128,.5);border-radius:.4rem;font-size:.9em;line-height:1.4}
|
||||
.sg-donate .sg-presets.sg-actions{flex-direction:column;flex-wrap:nowrap;align-items:stretch}
|
||||
@@ -24,3 +25,20 @@
|
||||
.sg-donate .sg-act-title{font-weight:600}
|
||||
.sg-donate .sg-act-desc{font-size:.85em;font-weight:400;opacity:.8}
|
||||
.sg-donate .sg-presets button.sg-action:focus-visible{outline:2px solid currentColor;outline-offset:2px}
|
||||
|
||||
/* Mobile: 44px tap targets and 16px inputs (stops iOS Safari auto-zoom). px units on purpose: some themes shrink the root rem. */
|
||||
.sg-donate input[type=text],.sg-donate input[type=number],.sg-donate select,.sg-donate textarea{font-size:16px;min-height:44px}
|
||||
.sg-donate textarea{min-height:88px}
|
||||
.sg-donate .sg-presets button{min-height:44px}
|
||||
.sg-donate .sg-presets button.sg-action{min-height:44px}
|
||||
.sg-donate label.sg-inline{min-height:44px}
|
||||
.sg-donate label.sg-inline input[type=checkbox]{flex:none;width:22px;height:22px;margin:0}
|
||||
.sg-donate .sg-cover{gap:.25rem}
|
||||
.sg-donate .sg-act-title,.sg-donate .sg-act-desc,.sg-donate .sg-tip,.sg-donate .sg-msg,.sg-donate .sg-total{overflow-wrap:anywhere}
|
||||
|
||||
.sg-donate .sg-next-unlock{margin:0 0 .9rem;padding:.5rem .75rem;border:1px solid rgba(128,128,128,.5);border-left-width:4px;border-radius:.4rem;font-weight:600;line-height:1.4;overflow-wrap:anywhere}
|
||||
.sg-donate .sg-next-unlock[hidden]{display:none}
|
||||
.sg-donate .sg-presets button.sg-action{padding-right:2.2em}
|
||||
.sg-donate .sg-presets.sg-actions{padding:0 5px}
|
||||
|
||||
.sg-donate .sg-notice{margin:.6rem 0 0;font-size:.9em;line-height:1.4;opacity:.85;overflow-wrap:anywhere}
|
||||
+15
-2
@@ -82,6 +82,18 @@
|
||||
var status = el('div', { 'class': 'sg-msg', role: 'status' });
|
||||
var buttons = el('div', { 'class': 'sg-buttons' });
|
||||
|
||||
// "Next unlock" line for tiered goals (server computes title + remaining minor units per goal).
|
||||
var nextLine = el('p', { 'class': 'sg-next-unlock', 'aria-live': 'polite' });
|
||||
nextLine.hidden = true;
|
||||
function showNext() {
|
||||
var n = state.goal.nextUnlock;
|
||||
if (!n || !n.title || !(n.remaining_minor > 0)) { nextLine.hidden = true; nextLine.textContent = ''; return; }
|
||||
nextLine.textContent = String(T.nextUnlock || 'Next unlock: %1$s \u2014 %2$s to go')
|
||||
.replace('%1$s', function () { return n.title; })
|
||||
.replace('%2$s', function () { return fmt(n.remaining_minor, state.goal.exp, state.goal.currency); });
|
||||
nextLine.hidden = false;
|
||||
}
|
||||
root.appendChild(nextLine);
|
||||
if (goals.length > 1) { root.appendChild(row([el('label', { 'for': uid + '-goal', text: T.goal }), goalSel])); }
|
||||
root.appendChild(row([el('label', { text: T.amount }), presetBox, el('label', { 'class': 'sg-sub', 'for': uid + '-amt', text: T.customAmount || 'Or enter your own amount' }), amount, hint]));
|
||||
var nameRow = row([el('label', { 'for': uid + '-name', text: T.name }), name]);
|
||||
@@ -109,6 +121,7 @@
|
||||
root.appendChild(row([total]));
|
||||
root.appendChild(status); // messages sit above the PayPal buttons, next to the form fields
|
||||
root.appendChild(buttons);
|
||||
if (C.notice) { root.appendChild(el('p', { 'class': 'sg-notice', text: String(C.notice) })); } // e.g. "Donations are non-refundable." right where the donor pays
|
||||
|
||||
function say(text, cls) { status.textContent = text || ''; status.className = 'sg-msg' + (cls ? ' ' + cls : ''); }
|
||||
function amountStr() { return amount.value.trim().replace(',', '.'); }
|
||||
@@ -223,9 +236,9 @@
|
||||
|
||||
goalSel.addEventListener('change', function () {
|
||||
state.goal = goals.filter(function (g) { return String(g.id) === goalSel.value; })[0] || goals[0];
|
||||
buildPresets(); refresh(); renderButtons();
|
||||
showNext(); buildPresets(); refresh(); renderButtons();
|
||||
});
|
||||
buildPresets(); refresh(); renderButtons();
|
||||
showNext(); buildPresets(); refresh(); renderButtons();
|
||||
}
|
||||
|
||||
function boot() { Array.prototype.forEach.call(document.querySelectorAll('.sg-donate'), init); }
|
||||
|
||||
@@ -24,6 +24,8 @@ body.sg-offline #sg-root{opacity:.6}
|
||||
.sg-w-alerts #sg-root{align-items:flex-end}
|
||||
.sg-alert{width:100%;text-align:center;background:var(--sg-bg);border:.1em solid var(--sg-accent);border-radius:.7em;padding:.6em .9em;animation:sg-in .6s cubic-bezier(.22,1,.36,1) both}
|
||||
.sg-alert.sg-out{animation:sg-out .5s ease-in both}
|
||||
.sg-alert-media{display:flex;justify-content:center;margin-bottom:.4em}
|
||||
.sg-alert-media img,.sg-alert-media video{display:block;max-width:100%;max-height:45vh;object-fit:contain;border-radius:.4em;background:transparent}
|
||||
.sg-alert-head{font-weight:800;font-size:1.2em}
|
||||
.sg-alert-head b{color:var(--sg-accent2)}
|
||||
.sg-alert-msg{margin-top:.3em;font-size:.85em;overflow-wrap:anywhere;max-height:5.2em;overflow:hidden}
|
||||
@@ -47,3 +49,13 @@ body.sg-offline #sg-root{opacity:.6}
|
||||
.sg-menu-track.sg-scrolling{animation:sg-scroll var(--sg-scroll-s,20s) linear infinite}
|
||||
@keyframes sg-scroll{from{transform:translateY(0)}to{transform:translateY(-50%)}}
|
||||
@media (prefers-reduced-motion:reduce){.sg-menu-track.sg-scrolling{animation:none}}
|
||||
|
||||
/* Tiered goals */
|
||||
.sg-tier{font-size:.85em;font-weight:600;margin-bottom:.3em;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;color:var(--sg-accent2)}
|
||||
.sg-tier[hidden]{display:none}
|
||||
.sg-card.sg-tiers-done .sg-tier{font-weight:800}
|
||||
.sg-card.sg-tier-up{animation:sg-tier-pop 1.1s cubic-bezier(.22,1,.36,1) 2,sg-tier-glow 1.3s ease-in-out 2}
|
||||
.sg-bonus-line.sg-tier-line{background:linear-gradient(90deg,#f59e0b,#ef4444);color:#fff;border-radius:.3em;letter-spacing:.04em}
|
||||
@keyframes sg-tier-pop{0%{transform:scale(1)}30%{transform:scale(1.06)}100%{transform:scale(1)}}
|
||||
@keyframes sg-tier-glow{0%,100%{box-shadow:0 0 0 transparent}50%{box-shadow:0 0 1em #f59e0b,0 0 2em var(--sg-accent2)}}
|
||||
@media (prefers-reduced-motion:reduce){.sg-card.sg-tier-up{animation:none;box-shadow:0 0 .8em #f59e0b}}
|
||||
+153
-10
@@ -16,26 +16,52 @@
|
||||
}
|
||||
|
||||
// ---- goal ----
|
||||
var goal = null, shownRaised = 0, raf = 0;
|
||||
var goal = null, shownRaised = 0, raf = 0, lastTierKey = null, celebrateTimer = 0;
|
||||
function renderGoal(d) {
|
||||
if (!d.active) { root.textContent = ''; goal = null; return; }
|
||||
if (!d.active) { root.textContent = ''; goal = null; lastTierKey = null; return; }
|
||||
if (!goal) {
|
||||
root.textContent = '';
|
||||
var card = el('div', 'sg-card');
|
||||
goal = { title: el('div', 'sg-title'), fill: el('div', 'sg-fill'), pct: el('div', 'sg-pct'),
|
||||
goal = { card: card, tier: el('div', 'sg-tier'), title: el('div', 'sg-title'), fill: el('div', 'sg-fill'), pct: el('div', 'sg-pct'),
|
||||
raised: el('span'), target: el('span') };
|
||||
var track = el('div', 'sg-track');
|
||||
track.appendChild(goal.fill); track.appendChild(goal.pct);
|
||||
var nums = el('div', 'sg-nums'); nums.appendChild(goal.raised); nums.appendChild(goal.target);
|
||||
card.appendChild(goal.title); card.appendChild(track); card.appendChild(nums);
|
||||
goal.tier.hidden = true;
|
||||
card.appendChild(goal.title); card.appendChild(goal.tier); card.appendChild(track); card.appendChild(nums);
|
||||
root.appendChild(card);
|
||||
}
|
||||
goal.title.textContent = d.title;
|
||||
goal.target.textContent = d.target_display;
|
||||
goal.fill.style.width = d.percent + '%';
|
||||
goal.pct.textContent = d.percent + '%';
|
||||
renderTier(d.tiers);
|
||||
tweenRaised(d);
|
||||
}
|
||||
// Tiered goals only (d.tiers present): "Tier 2 of 4 \u00b7 title" above the bar, or "All tiers unlocked!".
|
||||
// Untiered goals keep the tier line hidden, so they look exactly as before. textContent only.
|
||||
function renderTier(t) {
|
||||
var valid = t && typeof t === 'object' && isFinite(Number(t.count)) && Number(t.count) > 0;
|
||||
goal.tier.hidden = !valid;
|
||||
goal.card.classList.toggle('sg-tiered', !!valid);
|
||||
goal.card.classList.toggle('sg-tiers-done', !!(valid && t.all_reached));
|
||||
if (!valid) { goal.tier.textContent = ''; lastTierKey = null; return; }
|
||||
var cur = t.current && typeof t.current === 'object' ? t.current : null;
|
||||
goal.tier.textContent = t.all_reached || !cur
|
||||
? 'All tiers unlocked!'
|
||||
: 'Tier ' + parseInt(t.index, 10) + ' of ' + parseInt(t.count, 10) + ' \u00b7 ' + String(cur.title || '');
|
||||
// Celebrate when the current tier changed between polls (never on the first poll / after a reload).
|
||||
var key = (t.all_reached ? 'done' : String(t.index)) + '/' + t.count;
|
||||
if (lastTierKey !== null && lastTierKey !== key) {
|
||||
goal.card.classList.remove('sg-tier-up');
|
||||
void goal.card.offsetWidth; // restart the animation
|
||||
goal.card.classList.add('sg-tier-up');
|
||||
clearTimeout(celebrateTimer);
|
||||
var card = goal.card;
|
||||
celebrateTimer = setTimeout(function () { card.classList.remove('sg-tier-up'); }, 2600);
|
||||
}
|
||||
lastTierKey = key;
|
||||
}
|
||||
function tweenRaised(d) {
|
||||
cancelAnimationFrame(raf);
|
||||
var from = shownRaised, to = d.raised_minor, t0 = performance.now(), dur = 1200;
|
||||
@@ -113,16 +139,87 @@
|
||||
firstAlertPoll = false;
|
||||
next();
|
||||
}
|
||||
// Alert media (optional per alert): {visual:{type,url}|null, sound:{url}|null, volume, duration_ms, message}.
|
||||
// Everything is built with createElement + property assignment; nothing from the server is parsed as HTML.
|
||||
var MEDIA_TIMEOUT = 8000, DEFAULT_HOLD = 6500, VIDEO_CAP = 30000;
|
||||
function okUrl(u) { return typeof u === 'string' && /^(https?:\/\/|\/)/i.test(u); }
|
||||
function cleanMedia(m) {
|
||||
if (!m || typeof m !== 'object') return null;
|
||||
var v = m.visual && typeof m.visual === 'object' && okUrl(m.visual.url) && (m.visual.type === 'image' || m.visual.type === 'video') ? m.visual : null;
|
||||
var s = m.sound && typeof m.sound === 'object' && okUrl(m.sound.url) ? m.sound : null;
|
||||
var msg = typeof m.message === 'string' && m.message ? m.message : null;
|
||||
if (!v && !s && !msg) return null;
|
||||
var vol = Number(m.volume); if (!isFinite(vol)) vol = 80;
|
||||
var dur = Number(m.duration_ms); if (!isFinite(dur) || dur <= 0) dur = DEFAULT_HOLD;
|
||||
return { visual: v, sound: s, volume: Math.max(0, Math.min(100, vol)) / 100, duration: Math.max(1000, Math.min(60000, dur)), message: msg };
|
||||
}
|
||||
// Loads visual + sound before the card appears (no flash of an empty frame). Anything that fails or takes
|
||||
// longer than MEDIA_TIMEOUT is dropped, so the alert falls back to text and the queue never stalls.
|
||||
function preload(m, cb) {
|
||||
var out = { visual: null, sound: null }, pending = 0, fired = false, timer = 0;
|
||||
function finish() { if (fired) return; fired = true; clearTimeout(timer); cb(out); }
|
||||
function part() { pending++; var once = false; return function (ok, set) { if (once) return; once = true; if (ok && set) set(); if (--pending <= 0) finish(); }; }
|
||||
try {
|
||||
if (m.visual) {
|
||||
var vd = part();
|
||||
if (m.visual.type === 'image') {
|
||||
var img = new Image();
|
||||
img.onload = function () { vd(true, function () { out.visual = img; }); };
|
||||
img.onerror = function () { vd(false); };
|
||||
img.src = m.visual.url;
|
||||
} else {
|
||||
var vid = document.createElement('video');
|
||||
vid.preload = 'auto'; vid.playsInline = true; vid.muted = true;
|
||||
vid.setAttribute('playsinline', ''); vid.setAttribute('muted', '');
|
||||
vid.onloadeddata = function () { vd(true, function () { out.visual = vid; }); };
|
||||
vid.onerror = function () { vd(false); };
|
||||
vid.src = m.visual.url;
|
||||
try { vid.load(); } catch (e) { vd(false); }
|
||||
}
|
||||
}
|
||||
if (m.sound) {
|
||||
var sd = part();
|
||||
var au = new Audio();
|
||||
au.preload = 'auto';
|
||||
au.oncanplaythrough = function () { sd(true, function () { out.sound = au; }); };
|
||||
au.onerror = function () { sd(false); };
|
||||
au.src = m.sound.url;
|
||||
try { au.load(); } catch (e2) { sd(false); }
|
||||
}
|
||||
} catch (e3) { /* fall through to the timeout/finish below */ }
|
||||
if (!pending) { finish(); return; }
|
||||
timer = setTimeout(finish, MEDIA_TIMEOUT);
|
||||
}
|
||||
function next() {
|
||||
if (showing || !queue.length) return;
|
||||
showing = true;
|
||||
var a = queue.shift();
|
||||
var m = null;
|
||||
try { m = cleanMedia(a.media); } catch (e) { m = null; }
|
||||
if (!m) { present(a, null, null); return; }
|
||||
var called = false;
|
||||
function go(assets) { if (called) return; called = true; try { present(a, m, assets); } catch (err) { forceDone(); } }
|
||||
try { preload(m, go); } catch (e2) { go({ visual: null, sound: null }); }
|
||||
}
|
||||
function forceDone() { root.textContent = ''; showing = false; setTimeout(next, 0); }
|
||||
function present(a, m, assets) {
|
||||
root.textContent = '';
|
||||
var card = el('div', 'sg-alert');
|
||||
var head = el('div', 'sg-alert-head');
|
||||
head.appendChild(el('b', null, a.name));
|
||||
head.appendChild(document.createTextNode(' donated '));
|
||||
head.appendChild(el('b', null, a.amount_display));
|
||||
var vis = assets && assets.visual, snd = assets && assets.sound;
|
||||
if (vis) {
|
||||
var box = el('div', 'sg-alert-media');
|
||||
box.appendChild(vis);
|
||||
card.appendChild(box);
|
||||
card.classList.add('sg-has-media');
|
||||
}
|
||||
if (m && m.message) {
|
||||
head.textContent = m.message;
|
||||
} else {
|
||||
head.appendChild(el('b', null, a.name));
|
||||
head.appendChild(document.createTextNode(' donated '));
|
||||
head.appendChild(el('b', null, a.amount_display));
|
||||
}
|
||||
card.appendChild(head);
|
||||
var bonuses = Array.isArray(a.bonuses) ? a.bonuses : [];
|
||||
if (bonuses.length) {
|
||||
@@ -132,17 +229,63 @@
|
||||
}
|
||||
}
|
||||
var acts = Array.isArray(a.actions) ? a.actions : [];
|
||||
if (acts.length) card.classList.add('sg-bonus');
|
||||
var tiersUnlocked = Array.isArray(a.tiers) ? a.tiers : [];
|
||||
if (acts.length || tiersUnlocked.length) card.classList.add('sg-bonus');
|
||||
for (var k = 0; k < acts.length; k++) {
|
||||
var times = parseInt(acts[k].times, 10) || 1;
|
||||
card.appendChild(el('div', 'sg-bonus-line', 'ACTION: ' + String(acts[k].title) + (times > 1 ? ' x' + times : '')));
|
||||
}
|
||||
for (var q = 0; q < tiersUnlocked.length; q++) {
|
||||
var tt = tiersUnlocked[q] && tiersUnlocked[q].title;
|
||||
if (tt) card.appendChild(el('div', 'sg-bonus-line sg-tier-line', 'TIER UNLOCKED: ' + String(tt)));
|
||||
}
|
||||
if (a.message) card.appendChild(el('div', 'sg-alert-msg', a.message));
|
||||
root.appendChild(card);
|
||||
setTimeout(function () {
|
||||
|
||||
var finished = false, holdTimer = 0, capTimer = 0;
|
||||
function stopMedia() {
|
||||
try { if (snd) snd.pause(); } catch (e) { /* ignore */ }
|
||||
try { if (vis && vis.tagName === 'VIDEO') { vis.pause(); vis.removeAttribute('src'); vis.load(); } } catch (e2) { /* ignore */ }
|
||||
}
|
||||
function exit() {
|
||||
if (finished) return;
|
||||
finished = true;
|
||||
clearTimeout(holdTimer); clearTimeout(capTimer);
|
||||
stopMedia();
|
||||
card.classList.add('sg-out');
|
||||
setTimeout(function () { root.textContent = ''; showing = false; next(); }, 500);
|
||||
}, 6500);
|
||||
}
|
||||
var hold = m ? m.duration : DEFAULT_HOLD, isVideo = false;
|
||||
if (snd) {
|
||||
try {
|
||||
snd.volume = m.volume; snd.currentTime = 0;
|
||||
var sp = snd.play();
|
||||
if (sp && typeof sp.catch === 'function') sp.catch(function () { /* autoplay blocked: silent alert */ });
|
||||
} catch (e3) { /* ignore */ }
|
||||
}
|
||||
if (vis && vis.tagName === 'VIDEO') {
|
||||
isVideo = true;
|
||||
try {
|
||||
vis.loop = false;
|
||||
vis.muted = !!snd || m.volume === 0; // a separate sound wins; otherwise the clip's own audio at the set volume
|
||||
vis.volume = m.volume;
|
||||
vis.onended = exit;
|
||||
vis.onerror = exit;
|
||||
var vp = vis.play();
|
||||
if (vp && typeof vp.catch === 'function') {
|
||||
vp.catch(function () {
|
||||
// Autoplay with sound refused: retry muted so the picture still plays; give up (text only) if that fails too.
|
||||
try {
|
||||
vis.muted = true;
|
||||
var again = vis.play();
|
||||
if (again && typeof again.catch === 'function') again.catch(function () { if (vis.parentNode) vis.parentNode.removeChild(vis); clearTimeout(capTimer); holdTimer = setTimeout(exit, DEFAULT_HOLD); });
|
||||
} catch (e4) { exit(); }
|
||||
});
|
||||
}
|
||||
} catch (e5) { isVideo = false; }
|
||||
}
|
||||
if (isVideo) capTimer = setTimeout(exit, VIDEO_CAP); // videos play to the end, never longer than 30 s
|
||||
else holdTimer = setTimeout(exit, hold);
|
||||
}
|
||||
|
||||
// ---- actions (reward menu) ----
|
||||
|
||||
@@ -81,3 +81,14 @@ Amounts must be >= Settings::effectiveMin().
|
||||
action_id (for `reward`: applies when that reward triggered; a reward definition wins over an amount definition), title (admin label),
|
||||
visual_id + visual_type (`image` | `video` | '' none), sound_id (audio attachment, 0 none), volume 0-100, duration_ms (how long an image/GIF stays; videos play to the end, capped),
|
||||
message (template with {name} {amount} {reward}; '' = default text), enabled, sort, created_at.
|
||||
|
||||
## Goal tiers (milestones) — contract (Installer DB_VERSION 4)
|
||||
A goal may have ordered TIERS; each is a cumulative target with an item/unlock (e.g. $100 "Giveaway", $250 "New microphone", $500 "24-hour stream").
|
||||
- `sg_goal_tiers`: id, goal_id, target_minor (cumulative raised total needed), title VARCHAR(120) (the item/unlock), description VARCHAR(255), reached_at DATETIME NULL,
|
||||
reached_donation_id BIGINT UNSIGNED NULL, created_at; UNIQUE(goal_id, target_minor). Tier order = target_minor ascending.
|
||||
- A goal WITH tiers keeps `sg_goals.target_minor` equal to its HIGHEST tier target (maintained automatically when tiers change; the goal form shows the target as derived/read-only). So "end at target" closes the goal when the FINAL tier is reached, and everything that reads goal target keeps working.
|
||||
- Raised total for tiers uses the same basis as the goal (`GoalRepository::raised_minor`, base vs total per counts_fees).
|
||||
- Reaching a tier: after a donation is completed (same finalize path as rules/actions, BEFORE the close-at-target check, never throwing, idempotent): for every tier of the goal with reached_at IS NULL and target_minor <= raised, set reached_at=NOW and reached_donation_id=that donation with `UPDATE ... WHERE id=? AND reached_at IS NULL` (a big donation can unlock several tiers at once; all get its id).
|
||||
- "Current tier" = the first tier (by target) with reached_at IS NULL. Goal bar progress for a tiered goal = (raised - floor) / (target - floor) clamped 0..1, where floor = previous tier's target (0 for the first); the cumulative raised and the current tier target are still displayed.
|
||||
- Reached tiers: title/description editable, target locked; a new tier's target must be above the goal's current raised total and unique.
|
||||
- Overlay `goal` payload for a tiered goal adds `tiers: {count, index (1-based current), current:{title,description,target_minor,target_display,floor_minor}|null, all_reached}`; untiered goals are unchanged. Alert payloads gain `tiers: [{title}]` = tiers whose reached_donation_id is that donation, shown as a "TIER UNLOCKED: title" pill.
|
||||
@@ -25,9 +25,14 @@ final class Admin {
|
||||
'sg_rule_save' => array( GoalsPage::class, 'handleRuleSave' ),
|
||||
'sg_rule_toggle' => array( GoalsPage::class, 'handleRuleToggle' ),
|
||||
'sg_rule_delete' => array( GoalsPage::class, 'handleRuleDelete' ),
|
||||
'sg_tier_save' => array( GoalsPage::class, 'handleTierSave' ),
|
||||
'sg_tier_delete' => array( GoalsPage::class, 'handleTierDelete' ),
|
||||
'sg_action_save' => array( ActionsPage::class, 'handleSave' ),
|
||||
'sg_action_toggle' => array( ActionsPage::class, 'handleToggle' ),
|
||||
'sg_action_delete' => array( ActionsPage::class, 'handleDelete' ),
|
||||
'sg_alert_save' => array( AlertsPage::class, 'handleSave' ),
|
||||
'sg_alert_toggle' => array( AlertsPage::class, 'handleToggle' ),
|
||||
'sg_alert_delete' => array( AlertsPage::class, 'handleDelete' ),
|
||||
'sg_event_done' => array( ActionsPage::class, 'handleDone' ),
|
||||
'sg_event_done_all' => array( ActionsPage::class, 'handleDoneAll' ),
|
||||
'sg_export_csv' => array( DonationsPage::class, 'handleExport' ),
|
||||
@@ -65,6 +70,7 @@ final class Admin {
|
||||
$queued = ActionsPage::queuedCount();
|
||||
$qbadge = $queued > 0 ? ' <span class="awaiting-mod">' . (int) $queued . '</span>' : '';
|
||||
add_submenu_page( self::HOME, 'Rewards', 'Rewards' . $qbadge, self::CAP, ActionsPage::PAGE, array( ActionsPage::class, 'render' ) );
|
||||
add_submenu_page( self::HOME, 'Alerts', 'Alerts', self::CAP, AlertsPage::PAGE, array( AlertsPage::class, 'render' ) );
|
||||
add_submenu_page( self::HOME, 'Overlays', 'Overlays', self::CAP, 'streamgoals-overlays', array( OverlaysPage::class, 'render' ) );
|
||||
add_submenu_page( self::HOME, 'Settings', 'Settings', self::CAP, 'streamgoals-settings', array( SettingsPage::class, 'render' ) );
|
||||
}
|
||||
@@ -101,6 +107,11 @@ final class Admin {
|
||||
if ( ActionsPage::PAGE === $page ) {
|
||||
wp_enqueue_script( 'streamgoals-actions', STREAMGOALS_URL . 'assets/admin/actions.js', array( 'streamgoals-admin' ), STREAMGOALS_VERSION, true );
|
||||
}
|
||||
if ( AlertsPage::PAGE === $page ) {
|
||||
wp_enqueue_media();
|
||||
wp_enqueue_style( 'streamgoals-alerts', STREAMGOALS_URL . 'assets/admin/alerts.css', array( 'streamgoals-admin' ), STREAMGOALS_VERSION );
|
||||
wp_enqueue_script( 'streamgoals-alerts', STREAMGOALS_URL . 'assets/admin/alerts.js', array( 'streamgoals-admin', 'jquery' ), STREAMGOALS_VERSION, true );
|
||||
}
|
||||
if ( 'streamgoals-overlays' === $page ) {
|
||||
wp_enqueue_script( 'streamgoals-overlays', STREAMGOALS_URL . 'assets/admin/overlays.js', array( 'streamgoals-admin' ), STREAMGOALS_VERSION, true );
|
||||
}
|
||||
|
||||
@@ -0,0 +1,238 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Admin;
|
||||
|
||||
use StreamGoals\Actions\ActionRepository;
|
||||
use StreamGoals\Alerts\DefInput;
|
||||
use StreamGoals\Alerts\DefRepository;
|
||||
use StreamGoals\Alerts\Media;
|
||||
use StreamGoals\Core\Money;
|
||||
use StreamGoals\Core\Settings;
|
||||
|
||||
/** "Alerts": pictures, GIFs, videos and sounds that play on the alerts overlay for certain donations or rewards. */
|
||||
final class AlertsPage {
|
||||
|
||||
public const PAGE = 'streamgoals-alerts';
|
||||
|
||||
private static function repo(): DefRepository {
|
||||
return new DefRepository();
|
||||
}
|
||||
|
||||
private static function minMinor(): int {
|
||||
return Settings::effectiveMin( (int) Settings::get( 'min_donation_minor', 0 ) );
|
||||
}
|
||||
|
||||
private static function url( array $args = array() ): string {
|
||||
return Admin::url( self::PAGE, $args );
|
||||
}
|
||||
|
||||
/** @return array<int,string> goal id => title */
|
||||
private static function goalTitles(): array {
|
||||
$out = array();
|
||||
foreach ( Store::goals()->all() as $g ) {
|
||||
$out[ (int) $g['id'] ] = (string) $g['title'];
|
||||
}
|
||||
return $out;
|
||||
}
|
||||
|
||||
/** Attachment lookup for validation: mime + size, null when missing. */
|
||||
public static function attachmentInfo( int $id ): ?array {
|
||||
if ( $id <= 0 || 'attachment' !== get_post_type( $id ) ) {
|
||||
return null;
|
||||
}
|
||||
$path = get_attached_file( $id );
|
||||
return array(
|
||||
'mime' => (string) get_post_mime_type( $id ),
|
||||
'size' => ( is_string( $path ) && is_file( $path ) ) ? (int) filesize( $path ) : 0,
|
||||
);
|
||||
}
|
||||
|
||||
/* ---------------------------------------------------------------- render */
|
||||
|
||||
public static function render(): void {
|
||||
Admin::open( 'Alerts' );
|
||||
$edit = Admin::get_int( 'edit' );
|
||||
if ( 'new' === Admin::get_str( 'view' ) || $edit ) {
|
||||
self::renderForm( $edit );
|
||||
} else {
|
||||
self::renderHelp();
|
||||
self::renderList();
|
||||
}
|
||||
Admin::close();
|
||||
}
|
||||
|
||||
private static function renderHelp(): void {
|
||||
echo '<div class="sg-card"><h2>Make your alerts come alive</h2>';
|
||||
echo '<p>An alert is the pop-up on your stream when someone donates. Here you can give it a picture, a GIF or a video, and a sound. Pick the donation size (or a reward) that should trigger it.</p>';
|
||||
echo '<ul class="sga-help">';
|
||||
echo '<li><strong>By amount:</strong> "Any donation of at least $X". If several match, the one with the highest $X wins.</li>';
|
||||
echo '<li><strong>By reward:</strong> plays when a donor triggers one of your rewards. A reward alert beats an amount alert.</li>';
|
||||
echo '<li>Nothing set up? Alerts look and work exactly as before.</li>';
|
||||
echo '<li><strong>In OBS media plays automatically. In a normal browser tab you must click the page once before sound is allowed.</strong></li>';
|
||||
echo '<li>Pictures and GIFs stay for the time you choose. Videos play to the end, for at most 30 seconds.</li>';
|
||||
echo '<li>Keep files small (under 25 MB). Big videos make OBS slow to load and can make your stream stutter.</li>';
|
||||
echo '</ul></div>';
|
||||
}
|
||||
|
||||
private static function renderList(): void {
|
||||
$cur = Admin::currency();
|
||||
$defs = self::repo()->all();
|
||||
$goals = self::goalTitles();
|
||||
$rewards = array();
|
||||
foreach ( ( new ActionRepository() )->all() as $a ) {
|
||||
$rewards[ $a['id'] ] = $a['title'];
|
||||
}
|
||||
echo '<div class="sg-card"><h2>Your alerts</h2>';
|
||||
echo '<p><a class="button button-primary" href="' . esc_url( self::url( array( 'view' => 'new' ) ) ) . '">Add an alert</a></p>';
|
||||
if ( ! $defs ) {
|
||||
echo '<p>No custom alerts yet.</p></div>';
|
||||
return;
|
||||
}
|
||||
echo '<table class="widefat striped sg-table"><thead><tr><th>Name</th><th>Plays when</th><th>Applies to</th><th>Media</th><th>Order</th><th>Actions</th></tr></thead><tbody>';
|
||||
foreach ( $defs as $d ) {
|
||||
$id = (int) $d['id'];
|
||||
$when = 'reward' === $d['trigger_type']
|
||||
? 'Reward: ' . ( $rewards[ $d['action_id'] ] ?? 'a reward that was deleted' )
|
||||
: 'Donation of at least ' . Format::money( (int) $d['min_minor'], $cur );
|
||||
$media = array();
|
||||
if ( $d['visual_id'] ) {
|
||||
$media[] = 'video' === $d['visual_type'] ? 'Video' : 'Picture/GIF';
|
||||
}
|
||||
if ( $d['sound_id'] ) {
|
||||
$media[] = 'Sound';
|
||||
}
|
||||
echo '<tr' . ( $d['enabled'] ? '' : ' class="sg-off"' ) . '><td><strong>' . esc_html( $d['title'] ) . '</strong></td>';
|
||||
echo '<td>' . esc_html( $when ) . '</td>';
|
||||
echo '<td>' . esc_html( 0 === $d['goal_id'] ? 'All goals' : ( $goals[ $d['goal_id'] ] ?? 'Goal #' . $d['goal_id'] ) ) . '</td>';
|
||||
echo '<td>' . esc_html( $media ? implode( ', ', $media ) : 'Text only' ) . '</td>';
|
||||
echo '<td>' . (int) $d['sort'] . '</td><td class="sg-actions">';
|
||||
echo '<a class="button" href="' . esc_url( self::url( array( 'edit' => $id ) ) ) . '">Edit</a> ';
|
||||
Admin::form( 'sg_alert_toggle', array( 'alert_id' => $id, 'enabled' => $d['enabled'] ? 0 : 1 ), 'sg-inline' );
|
||||
echo '<button class="button">' . ( $d['enabled'] ? 'Turn off' : 'Turn on' ) . '</button></form> ';
|
||||
Admin::form( 'sg_alert_delete', array( 'alert_id' => $id ), 'sg-inline sg-confirm' );
|
||||
echo '<button class="button button-link-delete" data-confirm="Delete this alert? Your media files stay in the Media Library.">Delete</button></form>';
|
||||
echo '</td></tr>';
|
||||
}
|
||||
echo '</tbody></table></div>';
|
||||
}
|
||||
|
||||
private static function mediaField( string $name, string $label, string $kind, int $id, string $help ): void {
|
||||
$url = '';
|
||||
$mime = '';
|
||||
if ( $id > 0 && null !== self::attachmentInfo( $id ) ) {
|
||||
$url = (string) wp_get_attachment_url( $id );
|
||||
$mime = (string) get_post_mime_type( $id );
|
||||
}
|
||||
echo '<tr><th scope="row">' . esc_html( $label ) . '</th><td>';
|
||||
echo '<div class="sga-media" data-kind="' . esc_attr( $kind ) . '">';
|
||||
echo '<input type="hidden" name="' . esc_attr( $name ) . '" value="' . ( $id > 0 ? (int) $id : 0 ) . '" data-url="' . esc_attr( $url ) . '" data-mime="' . esc_attr( $mime ) . '">';
|
||||
echo '<span class="sga-media-name">' . esc_html( '' !== $url ? wp_basename( $url ) : 'Nothing chosen' ) . '</span> ';
|
||||
echo '<button type="button" class="button sga-pick">Choose from Media Library</button> ';
|
||||
echo '<button type="button" class="button sga-clear">Remove</button>';
|
||||
echo '<p class="description sga-media-warn" role="status"></p>';
|
||||
echo '</div><p class="description">' . esc_html( $help ) . '</p></td></tr>';
|
||||
}
|
||||
|
||||
private static function renderForm( int $id ): void {
|
||||
$d = $id ? self::repo()->find( $id ) : null;
|
||||
if ( $id && ! $d ) {
|
||||
echo '<p>That alert no longer exists. <a href="' . esc_url( self::url() ) . '">Back to alerts</a></p>';
|
||||
return;
|
||||
}
|
||||
$cur = Admin::currency();
|
||||
$goals = self::goalTitles();
|
||||
$val = static fn( string $k, $default = '' ) => $d[ $k ] ?? $default;
|
||||
$trigger = (string) $val( 'trigger_type', 'amount' );
|
||||
$rewards = array();
|
||||
foreach ( ( new ActionRepository() )->all() as $a ) {
|
||||
if ( $a['enabled'] || (int) $a['id'] === (int) $val( 'action_id', 0 ) ) {
|
||||
$rewards[] = array( 'id' => $a['id'], 'title' => $a['title'], 'enabled' => (bool) $a['enabled'] );
|
||||
}
|
||||
}
|
||||
$data = array(
|
||||
'currency' => $cur,
|
||||
'exp' => Money::exponent( $cur ),
|
||||
'rewards' => $rewards,
|
||||
'videoCap' => Media::VIDEO_CAP_MS,
|
||||
'warnBytes' => Media::WARN_BYTES,
|
||||
'allowed' => Media::MIMES,
|
||||
);
|
||||
|
||||
echo '<h2>' . ( $d ? 'Edit alert' : 'Add an alert' ) . '</h2>';
|
||||
Admin::form( 'sg_alert_save', array( 'alert_id' => $id ), 'sga-form' );
|
||||
echo '<table class="form-table" role="presentation">';
|
||||
echo '<tr><th scope="row"><label for="sga_title">Name</label></th><td><input type="text" required maxlength="120" id="sga_title" name="title" class="regular-text" value="' . esc_attr( (string) $val( 'title' ) ) . '"><p class="description">Only you see this, for example "Big donation fireworks".</p></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sga_goal">Applies to</label></th><td><select id="sga_goal" name="goal_id"><option value="0"' . selected( (int) $val( 'goal_id', 0 ), 0, false ) . '>All goals</option>';
|
||||
foreach ( $goals as $gid => $title ) {
|
||||
echo '<option value="' . (int) $gid . '"' . selected( (int) $val( 'goal_id', 0 ), $gid, false ) . '>' . esc_html( $title ) . '</option>';
|
||||
}
|
||||
echo '</select></td></tr>';
|
||||
echo '<tr><th scope="row">Plays when</th><td>';
|
||||
echo '<label><input type="radio" name="trigger_type" value="amount"' . checked( $trigger, 'amount', false ) . '> Any donation of at least <input type="text" inputmode="decimal" name="amount" class="small-text" value="' . esc_attr( $d && 'amount' === $trigger ? Format::decimal( (int) $d['min_minor'], $cur ) : '' ) . '"> ' . esc_html( $cur ) . '</label>';
|
||||
echo '<p class="description">At least ' . esc_html( Format::money( self::minMinor(), $cur ) ) . ' (your minimum donation). If several amount alerts match, the one with the highest amount wins.</p>';
|
||||
echo '<label><input type="radio" name="trigger_type" value="reward"' . checked( $trigger, 'reward', false ) . '> When a reward is triggered:</label> <select name="action_id"><option value="0">Choose a reward</option>';
|
||||
foreach ( $rewards as $r ) {
|
||||
echo '<option value="' . (int) $r['id'] . '"' . selected( (int) $val( 'action_id', 0 ), (int) $r['id'], false ) . '>' . esc_html( $r['title'] . ( $r['enabled'] ? '' : ' (turned off)' ) ) . '</option>';
|
||||
}
|
||||
echo '</select><p class="description">A reward alert beats an amount alert. Only rewards that are turned on can be picked.</p></td></tr>';
|
||||
self::mediaField( 'visual_id', 'Picture, GIF or video', 'visual', (int) $val( 'visual_id', 0 ), 'PNG, JPEG, GIF, WebP, MP4 or WebM. Optional. Under 25 MB works best; big videos can slow OBS down.' );
|
||||
self::mediaField( 'sound_id', 'Sound', 'sound', (int) $val( 'sound_id', 0 ), 'MP3, OGG or WAV. Optional. If you also pick a video, the video is muted and this sound plays instead.' );
|
||||
echo '<tr><th scope="row"><label for="sga_volume">Volume</label></th><td><input type="range" min="0" max="100" id="sga_volume" name="volume" value="' . (int) $val( 'volume', 80 ) . '"> <output id="sga_volume_out">' . (int) $val( 'volume', 80 ) . '</output>%</td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sga_duration">How long a picture stays</label></th><td><input type="number" min="1" max="60" step="1" id="sga_duration" name="duration" class="small-text" value="' . esc_attr( (string) (int) round( (int) $val( 'duration_ms', 6000 ) / 1000 ) ) . '"> seconds<p class="description">1 to 60. Videos play to the end instead, for at most 30 seconds.</p></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sga_message">Message</label></th><td><input type="text" maxlength="255" id="sga_message" name="message" class="large-text" value="' . esc_attr( (string) $val( 'message' ) ) . '"><p class="description">Optional. Use {name}, {amount} and {reward}, for example "{name} just sent {amount}!". Leave empty for the normal text ("Name donated $5.00").</p></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sga_sort">Order</label></th><td><input type="number" min="0" max="99999" id="sga_sort" name="sort" class="small-text" value="' . ( $d ? (int) $d['sort'] : '' ) . '"><p class="description">Lower numbers win when two alerts are otherwise equal. Leave empty to put it last.</p></td></tr>';
|
||||
echo '</table>';
|
||||
|
||||
echo '<div class="sg-card"><h3>Preview</h3>';
|
||||
echo '<p class="description">This is how the alert will look on stream. Press the button to play it (browsers only allow sound after you click).</p>';
|
||||
echo '<p><button type="button" class="button" id="sga-play">Play preview</button></p>';
|
||||
echo '<div id="sga-stage" class="sga-stage" aria-live="polite"></div>';
|
||||
echo '<script type="application/json" id="sga-data">' . wp_json_encode( $data, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT ) . '</script></div>';
|
||||
echo '<p><button class="button button-primary">' . ( $d ? 'Save alert' : 'Add alert' ) . '</button> <a class="button" href="' . esc_url( self::url() ) . '">Cancel</a></p></form>';
|
||||
}
|
||||
|
||||
/* -------------------------------------------------------------- handlers */
|
||||
|
||||
public static function handleSave(): void {
|
||||
Admin::guard( 'sg_alert_save' );
|
||||
$post = Admin::post_raw();
|
||||
$id = isset( $post['alert_id'] ) ? absint( $post['alert_id'] ) : 0;
|
||||
$back = self::url( $id ? array( 'edit' => $id ) : array( 'view' => 'new' ) );
|
||||
$repo = self::repo();
|
||||
if ( $id && ! $repo->find( $id ) ) {
|
||||
Admin::redirect( self::url(), 'error', 'That alert no longer exists.' );
|
||||
}
|
||||
$enabled = array();
|
||||
foreach ( ( new ActionRepository() )->all() as $a ) {
|
||||
if ( $a['enabled'] ) {
|
||||
$enabled[] = (int) $a['id'];
|
||||
}
|
||||
}
|
||||
$res = DefInput::validate( $post, self::minMinor(), Admin::currency(), array_keys( self::goalTitles() ), $enabled, array( self::class, 'attachmentInfo' ), $repo->nextSort() );
|
||||
if ( null === $res['data'] ) {
|
||||
Admin::redirect( $back, 'error', (string) $res['error'] );
|
||||
}
|
||||
if ( $id ) {
|
||||
$repo->update( $id, $res['data'] );
|
||||
} else {
|
||||
$repo->create( $res['data'] );
|
||||
}
|
||||
$msg = 'Alert saved.' . ( $res['warnings'] ? ' Heads up: ' . implode( ' ', $res['warnings'] ) : '' );
|
||||
Admin::redirect( self::url(), $res['warnings'] ? 'warning' : 'success', $msg );
|
||||
}
|
||||
|
||||
public static function handleToggle(): void {
|
||||
Admin::guard( 'sg_alert_toggle' );
|
||||
$post = Admin::post_raw();
|
||||
self::repo()->setEnabled( isset( $post['alert_id'] ) ? absint( $post['alert_id'] ) : 0, ! empty( $post['enabled'] ) );
|
||||
Admin::redirect( self::url(), 'success', 'Alert updated.' );
|
||||
}
|
||||
|
||||
public static function handleDelete(): void {
|
||||
Admin::guard( 'sg_alert_delete' );
|
||||
$post = Admin::post_raw();
|
||||
self::repo()->delete( isset( $post['alert_id'] ) ? absint( $post['alert_id'] ) : 0 );
|
||||
Admin::redirect( self::url(), 'success', 'Alert deleted.' );
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,9 @@ declare( strict_types=1 );
|
||||
namespace StreamGoals\Admin;
|
||||
|
||||
use StreamGoals\Core\Money;
|
||||
use StreamGoals\Core\Settings;
|
||||
use StreamGoals\Tiers\TierPolicy;
|
||||
use StreamGoals\Tiers\TierRepository;
|
||||
|
||||
/** Goals list/create/edit/status/delete, plus the per-goal rules editor. */
|
||||
final class GoalsPage {
|
||||
@@ -17,6 +20,8 @@ final class GoalsPage {
|
||||
self::renderForm( 'edit' === $view ? $id : 0 );
|
||||
} elseif ( 'rules' === $view && $id ) {
|
||||
self::renderRules( $id );
|
||||
} elseif ( 'tiers' === $view && $id ) {
|
||||
self::renderTiers( $id );
|
||||
} else {
|
||||
self::renderList();
|
||||
}
|
||||
@@ -29,6 +34,7 @@ final class GoalsPage {
|
||||
echo '<p><a class="page-title-action" href="' . esc_url( Admin::url( Admin::HOME, array( 'view' => 'new' ) ) ) . '">Add new goal</a></p>';
|
||||
echo '<p class="description">Overlays and the donation form use your newest <strong>active</strong> goal(s). Pause a goal to stop accepting donations; mark it complete when you are done. A goal that has donations cannot be deleted (complete it instead), so your records stay intact.</p>';
|
||||
$goals = Store::goals()->all();
|
||||
$tierCounts = $goals ? ( new TierRepository() )->countsByGoal() : array();
|
||||
if ( ! $goals ) {
|
||||
echo '<div class="sg-card"><p>No goals yet. <a href="' . esc_url( Admin::url( Admin::HOME, array( 'view' => 'new' ) ) ) . '">Create your first goal</a> or run the <a href="' . esc_url( SetupPage::url( 2 ) ) . '">setup guide</a>.</p></div>';
|
||||
Admin::close();
|
||||
@@ -47,6 +53,8 @@ final class GoalsPage {
|
||||
echo '<td>' . esc_html( self::dateLabel( $g['starts_at'] ?? null, 'Starts' ) ) . '<br>' . esc_html( self::dateLabel( $g['ends_at'] ?? null, 'Ends' ) ) . '</td><td class="sg-actions">';
|
||||
echo '<a class="button" href="' . esc_url( Admin::url( Admin::HOME, array( 'view' => 'edit', 'goal' => $gid ) ) ) . '">Edit</a> ';
|
||||
echo '<a class="button" href="' . esc_url( Admin::url( Admin::HOME, array( 'view' => 'rules', 'goal' => $gid ) ) ) . '">Rules</a> ';
|
||||
$nt = $tierCounts[ $gid ] ?? 0;
|
||||
echo '<a class="button" href="' . esc_url( Admin::url( Admin::HOME, array( 'view' => 'tiers', 'goal' => $gid ) ) ) . '">Tiers' . ( $nt > 0 ? ' (' . (int) $nt . ')' : '' ) . '</a> ';
|
||||
foreach ( array( 'active' => array( 'paused', 'Pause' ), 'paused' => array( 'active', 'Resume' ), 'complete' => array( 'active', 'Reopen' ) ) as $from => [ $to, $lbl ] ) {
|
||||
if ( $g['status'] === $from ) {
|
||||
Admin::form( 'sg_goal_status', array( 'goal_id' => $gid, 'status' => $to ), 'sg-inline' );
|
||||
@@ -80,11 +88,16 @@ final class GoalsPage {
|
||||
return;
|
||||
}
|
||||
$cur = $g ? Format::currency( $g['currency'] ) : Admin::currency();
|
||||
$tiered = $id && (bool) ( new TierRepository() )->forGoal( $id );
|
||||
Admin::open( $g ? 'Edit goal' : 'New goal' );
|
||||
Admin::form( 'sg_goal_save', array( 'goal_id' => $id ) );
|
||||
echo '<table class="form-table" role="presentation">';
|
||||
echo '<tr><th scope="row"><label for="sg_title">Title</label></th><td><input type="text" required maxlength="190" id="sg_title" name="title" class="regular-text" value="' . esc_attr( (string) ( $g['title'] ?? '' ) ) . '"></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sg_target">Target (' . esc_html( $cur ) . ')</label></th><td><input type="text" required inputmode="decimal" id="sg_target" name="target" class="small-text" value="' . esc_attr( $g ? Format::decimal( (int) $g['target_minor'], $cur ) : '' ) . '"></td></tr>';
|
||||
if ( $tiered ) {
|
||||
echo '<tr><th scope="row">Target (' . esc_html( $cur ) . ')</th><td><strong>' . esc_html( Format::money( (int) $g['target_minor'], $cur ) ) . '</strong> <span class="description">Set automatically from your highest tier. To change it, <a href="' . esc_url( Admin::url( Admin::HOME, array( 'view' => 'tiers', 'goal' => $id ) ) ) . '">edit the tiers</a>.</span></td></tr>';
|
||||
} else {
|
||||
echo '<tr><th scope="row"><label for="sg_target">Target (' . esc_html( $cur ) . ')</label></th><td><input type="text" required inputmode="decimal" id="sg_target" name="target" class="small-text" value="' . esc_attr( $g ? Format::decimal( (int) $g['target_minor'], $cur ) : '' ) . '"></td></tr>';
|
||||
}
|
||||
echo '<tr><th scope="row">Currency</th><td><strong>' . esc_html( $cur ) . '</strong> <span class="description">One currency is used across the whole site. Change it in <a href="' . esc_url( Admin::url( 'streamgoals-settings' ) ) . '">Settings</a> (applies to new goals only).</span></td></tr>';
|
||||
$fmt = static fn( ?string $utc ): string => $utc ? get_date_from_gmt( $utc, 'Y-m-d\TH:i' ) : '';
|
||||
echo '<tr><th scope="row"><label for="sg_start">Starts</label></th><td><input type="datetime-local" id="sg_start" name="starts_at" value="' . esc_attr( $fmt( $g['starts_at'] ?? null ) ) . '"> <span class="description">Optional. Your site time zone. Empty = starts immediately.</span></td></tr>';
|
||||
@@ -116,10 +129,12 @@ final class GoalsPage {
|
||||
$cur = $old ? Format::currency( $old['currency'] ) : Admin::currency();
|
||||
$title = Input::text( $post['title'] ?? '', 190 );
|
||||
$tgt = Input::amountToMinor( $post['target'] ?? '', $cur );
|
||||
// A goal with tiers has a derived target (its highest tier): never taken from the form.
|
||||
$tiered = $id && ( new TierRepository() )->forGoal( $id );
|
||||
if ( '' === $title ) {
|
||||
Admin::redirect( $back, 'error', 'Please give the goal a title.' );
|
||||
}
|
||||
if ( null === $tgt || $tgt <= 0 ) {
|
||||
if ( ! $tiered && ( null === $tgt || $tgt <= 0 ) ) {
|
||||
Admin::redirect( $back, 'error', 'Please enter a target greater than zero, for example 250.00.' );
|
||||
}
|
||||
$startRaw = Input::text( $post['starts_at'] ?? '', 20 );
|
||||
@@ -133,6 +148,9 @@ final class GoalsPage {
|
||||
Admin::redirect( $back, 'error', 'The end must be after the start.' );
|
||||
}
|
||||
$data = array( 'title' => $title, 'target_minor' => $tgt, 'starts_at' => $start, 'ends_at' => $end, 'counts_fees' => empty( $post['counts_fees'] ) ? 0 : 1, 'close_at_target' => \StreamGoals\Core\GoalTargetPolicy::flagFromPost( $post['close_at_target'] ?? null ) );
|
||||
if ( $tiered ) {
|
||||
unset( $data['target_minor'] );
|
||||
}
|
||||
if ( $id ) {
|
||||
Store::goals()->update( $id, $data );
|
||||
} else {
|
||||
@@ -171,6 +189,125 @@ final class GoalsPage {
|
||||
Admin::redirect( Admin::url(), 'success', 'Goal deleted.' );
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------------- tiers */
|
||||
|
||||
private static function tiersUrl( int $goalId, array $extra = array() ): string {
|
||||
return Admin::url( Admin::HOME, array_merge( array( 'view' => 'tiers', 'goal' => $goalId ), $extra ) );
|
||||
}
|
||||
|
||||
private static function renderTiers( int $goalId ): void {
|
||||
$g = Store::goals()->find( $goalId );
|
||||
if ( ! $g ) {
|
||||
Admin::open( 'Goal not found' );
|
||||
echo '<p><a href="' . esc_url( Admin::url() ) . '">Back to goals</a></p>';
|
||||
Admin::close();
|
||||
return;
|
||||
}
|
||||
$cur = Format::currency( $g['currency'] );
|
||||
$repo = new TierRepository();
|
||||
$tiers = $repo->forGoal( $goalId );
|
||||
$raised = Store::goals()->raised_minor( $goalId );
|
||||
Admin::open( 'Tiers for "' . (string) $g['title'] . '"' );
|
||||
echo '<p><a href="' . esc_url( Admin::url() ) . '">← Back to goals</a></p>';
|
||||
echo '<p class="sg-lead">Tiers turn one goal into a ladder of milestones. Each tier has a target and something you unlock or give away. When your total reaches a tier\'s target, that tier unlocks and the goal bar moves on to the next one. The goal\'s final target is your highest tier.</p>';
|
||||
|
||||
echo '<div class="sg-card"><h2>Your tiers</h2>';
|
||||
echo '<p class="description">Raised so far: <strong>' . esc_html( Format::money( $raised, $cur ) ) . '</strong>. Targets are cumulative totals, not extra amounts: a tier at ' . esc_html( Format::money( 25000, $cur ) ) . ' unlocks when the goal total reaches ' . esc_html( Format::money( 25000, $cur ) ) . '.</p>';
|
||||
if ( ! $tiers ) {
|
||||
echo '<p>No tiers yet. This goal works as a single target until you add one.</p>';
|
||||
} else {
|
||||
echo '<table class="widefat striped sg-table"><thead><tr><th>#</th><th>Unlock</th><th>Target</th><th>Status</th><th>Actions</th></tr></thead><tbody>';
|
||||
foreach ( TierPolicy::sorted( $tiers ) as $i => $t ) {
|
||||
$tid = (int) $t['id'];
|
||||
$status = TierPolicy::status( $tiers, $t );
|
||||
$label = 'reached' === $status ? 'Reached on ' . get_date_from_gmt( (string) $t['reached_at'], 'Y-m-d H:i' ) : ( 'current' === $status ? 'Current' : 'Upcoming' );
|
||||
echo '<tr><td>' . (int) ( $i + 1 ) . '</td><td><strong>' . esc_html( $t['title'] ) . '</strong>';
|
||||
if ( '' !== $t['description'] ) {
|
||||
echo '<br><span class="description">' . esc_html( $t['description'] ) . '</span>';
|
||||
}
|
||||
echo '</td><td>' . esc_html( Format::money( (int) $t['target_minor'], $cur ) ) . '</td>';
|
||||
echo '<td><span class="sg-badge sg-' . ( 'reached' === $status ? 'complete' : ( 'current' === $status ? 'active' : 'paused' ) ) . '">' . esc_html( $label ) . '</span></td><td class="sg-actions">';
|
||||
echo '<a class="button" href="' . esc_url( self::tiersUrl( $goalId, array( 'tier' => $tid ) ) ) . '#sg-tier-form">Edit</a> ';
|
||||
Admin::form( 'sg_tier_delete', array( 'goal_id' => $goalId, 'tier_id' => $tid ), 'sg-inline sg-confirm' );
|
||||
echo '<button class="button button-link-delete" data-confirm="Delete this tier?">Delete</button></form></td></tr>';
|
||||
}
|
||||
echo '</tbody></table>';
|
||||
}
|
||||
echo '</div>';
|
||||
|
||||
$editId = Admin::get_int( 'tier' );
|
||||
$edit = $editId ? $repo->find( $editId ) : null;
|
||||
if ( $edit && (int) $edit['goal_id'] !== $goalId ) {
|
||||
$edit = null;
|
||||
}
|
||||
$locked = $edit && TierPolicy::isReached( $edit );
|
||||
$min = Settings::effectiveMin( (int) Settings::get( 'min_donation_minor', 0 ) );
|
||||
echo '<div class="sg-card" id="sg-tier-form"><h2>' . ( $edit ? 'Edit tier' : 'Add a tier' ) . '</h2>';
|
||||
Admin::form( 'sg_tier_save', array( 'goal_id' => $goalId, 'tier_id' => $edit ? (int) $edit['id'] : 0 ) );
|
||||
echo '<table class="form-table" role="presentation">';
|
||||
echo '<tr><th scope="row"><label for="sg_t_target">Target (' . esc_html( $cur ) . ')</label></th><td><input type="text" ' . ( $locked ? 'disabled' : 'required' ) . ' inputmode="decimal" id="sg_t_target" name="target" class="small-text" value="' . esc_attr( $edit ? Format::decimal( (int) $edit['target_minor'], $cur ) : '' ) . '">';
|
||||
echo '<p class="description">' . ( $locked ? 'This tier has been reached, so its target is locked. You can still change its name and description.' : 'When your total reaches this amount, this tier unlocks and the goal bar moves on to the next one. Must be above what has been raised so far (' . esc_html( Format::money( $raised, $cur ) ) . ') and at least ' . esc_html( Format::money( $min, $cur ) ) . '.' ) . '</p></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sg_t_title">Item or unlock</label></th><td><input type="text" required maxlength="120" id="sg_t_title" name="title" class="regular-text" value="' . esc_attr( $edit ? (string) $edit['title'] : '' ) . '"><p class="description">What viewers get when this tier is reached, for example "New microphone". Up to 120 characters. Shown on your overlay and the donation form.</p></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sg_t_desc">Description</label></th><td><input type="text" maxlength="255" id="sg_t_desc" name="description" class="large-text" value="' . esc_attr( $edit ? (string) $edit['description'] : '' ) . '"><p class="description">Optional. A short note, up to 255 characters.</p></td></tr>';
|
||||
echo '</table><p><button class="button button-primary">' . ( $edit ? 'Save tier' : 'Add tier' ) . '</button>';
|
||||
if ( $edit ) {
|
||||
echo ' <a class="button" href="' . esc_url( self::tiersUrl( $goalId ) ) . '">Cancel</a>';
|
||||
}
|
||||
echo '</p></form></div>';
|
||||
Admin::close();
|
||||
}
|
||||
|
||||
public static function handleTierSave(): void {
|
||||
Admin::guard( 'sg_tier_save' );
|
||||
$post = Admin::post_raw();
|
||||
$goalId = isset( $post['goal_id'] ) ? absint( $post['goal_id'] ) : 0;
|
||||
$tierId = isset( $post['tier_id'] ) ? absint( $post['tier_id'] ) : 0;
|
||||
$g = $goalId ? Store::goals()->find( $goalId ) : null;
|
||||
if ( ! $g ) {
|
||||
Admin::redirect( Admin::url(), 'error', 'That goal no longer exists.' );
|
||||
}
|
||||
$back = self::tiersUrl( $goalId, $tierId ? array( 'tier' => $tierId ) : array() );
|
||||
$cur = Format::currency( $g['currency'] );
|
||||
$repo = new TierRepository();
|
||||
$min = Settings::effectiveMin( (int) Settings::get( 'min_donation_minor', 0 ) );
|
||||
$res = TierPolicy::validate(
|
||||
$repo->forGoal( $goalId ),
|
||||
$tierId ?: null,
|
||||
Input::amountToMinor( $post['target'] ?? '', $cur ),
|
||||
Input::text( $post['title'] ?? '', 200 ),
|
||||
Input::text( $post['description'] ?? '', 400 ),
|
||||
Store::goals()->raised_minor( $goalId ),
|
||||
$min,
|
||||
Format::money( $min, $cur )
|
||||
);
|
||||
if ( null === $res['data'] ) {
|
||||
Admin::redirect( $back, 'error', (string) $res['error'] );
|
||||
}
|
||||
if ( $tierId ) {
|
||||
$repo->update( $tierId, $goalId, $res['data'] );
|
||||
} elseif ( $repo->create( $goalId, $res['data'] ) <= 0 ) {
|
||||
Admin::redirect( $back, 'error', 'The tier could not be saved. Another tier may already have that target.' );
|
||||
}
|
||||
$repo->syncGoalTarget( $goalId );
|
||||
$msg = 'Tier saved. The goal target is now ' . Format::money( TierPolicy::derivedGoalTarget( $repo->forGoal( $goalId ) ), $cur ) . '.';
|
||||
if ( 'complete' === ( $g['status'] ?? '' ) ) {
|
||||
$msg .= ' This goal is marked complete; use "Reopen" on the goals list if you want donations to continue.';
|
||||
}
|
||||
Admin::redirect( self::tiersUrl( $goalId ), 'success', $msg );
|
||||
}
|
||||
|
||||
public static function handleTierDelete(): void {
|
||||
Admin::guard( 'sg_tier_delete' );
|
||||
$post = Admin::post_raw();
|
||||
$goalId = isset( $post['goal_id'] ) ? absint( $post['goal_id'] ) : 0;
|
||||
if ( $goalId && Store::goals()->find( $goalId ) ) {
|
||||
$repo = new TierRepository();
|
||||
$repo->delete( isset( $post['tier_id'] ) ? absint( $post['tier_id'] ) : 0, $goalId );
|
||||
$repo->syncGoalTarget( $goalId ); // no-op when the last tier was removed: the goal keeps its current target (editable again)
|
||||
}
|
||||
Admin::redirect( self::tiersUrl( $goalId ), 'success', 'Tier deleted.' );
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------------- rules */
|
||||
|
||||
private static function renderRules( int $goalId ): void {
|
||||
|
||||
@@ -34,6 +34,7 @@ final class SettingsPage {
|
||||
}
|
||||
echo '</select><p class="description">One currency for the whole site. It applies to goals you create from now on; existing goals keep their currency. Check the fixed fee below after changing it.</p></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sg_min">Minimum donation (' . esc_html( $cur ) . ')</label></th><td><input type="text" id="sg_min" name="min_donation" class="small-text" inputmode="decimal" value="' . esc_attr( Format::decimal( \StreamGoals\Core\Settings::effectiveMin( (int) $s['min_donation_minor'] ), $cur ) ) . '"> <span class="description">At least ' . esc_html( Format::money( \StreamGoals\Core\Settings::HARD_MIN_MINOR, $cur ) ) . '. Visitors cannot donate less than this.</span></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sg_notice">Notice under the donation form</label></th><td><input type="text" id="sg_notice" name="donation_notice" class="large-text" maxlength="200" value="' . esc_attr( (string) $s['donation_notice'] ) . '"><p class="description">Shown right under the PayPal buttons so donors see it before paying. Plain text, up to 200 characters. The default says donations are non-refundable. Leave it empty to hide the notice.</p></td></tr>';
|
||||
echo '<tr><th scope="row"><label for="sg_len">Longest message</label></th><td><input type="number" id="sg_len" name="message_max_length" min="0" max="500" class="small-text" value="' . (int) $s['message_max_length'] . '"> characters <span class="description">(0 to 500; 0 = no messages)</span></td></tr>';
|
||||
echo '<tr><th scope="row">Names</th><td><fieldset>';
|
||||
foreach ( self::POLICIES as $k => $l ) {
|
||||
@@ -147,6 +148,7 @@ final class SettingsPage {
|
||||
}
|
||||
$upd['funding_card'] = ! empty( $post['funding_card'] );
|
||||
$upd['funding_paylater'] = ! empty( $post['funding_paylater'] );
|
||||
$upd['donation_notice'] = Input::text( $post['donation_notice'] ?? '', 200 );
|
||||
$upd['moderate_messages'] = ! empty( $post['moderate_messages'] );
|
||||
$upd['profanity_filter'] = ! empty( $post['profanity_filter'] );
|
||||
$upd['profanity_use_builtin'] = ! empty( $post['profanity_use_builtin'] );
|
||||
|
||||
@@ -87,6 +87,7 @@ final class Store {
|
||||
self::deleteRule( (int) $r['id'], $goalId );
|
||||
}
|
||||
$wpdb->delete( self::t( 'state' ), array( 'goal_id' => $goalId ), array( '%d' ) );
|
||||
$wpdb->delete( self::t( 'goal_tiers' ), array( 'goal_id' => $goalId ), array( '%d' ) );
|
||||
return self::goals()->delete( $goalId );
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Alerts;
|
||||
|
||||
/**
|
||||
* Builds the public `media` block for one alert. URLs only ever come from the $attachment callback
|
||||
* (WordPress attachment lookup); the DB row contributes ids, never URLs.
|
||||
*/
|
||||
final class AlertMedia {
|
||||
|
||||
/**
|
||||
* @param array<string,mixed> $row Donation row (goal_id, base_minor).
|
||||
* @param array<int,array<string,mixed>> $defs Raw alert definitions.
|
||||
* @param array<int,array{action_id:int,amount_minor:int,title:string}> $triggered Rewards this donation triggered.
|
||||
* @param callable(int):?array{url:string,mime:string} $attachment
|
||||
* @return array{visual:?array{type:string,url:string},sound:?array{url:string},volume:int,duration_ms:int,message:?string}|null
|
||||
*/
|
||||
public static function build( array $row, string $name, string $amountDisplay, array $defs, array $triggered, callable $attachment ): ?array {
|
||||
if ( ! $defs ) {
|
||||
return null;
|
||||
}
|
||||
$ids = array();
|
||||
$amounts = array();
|
||||
foreach ( $triggered as $t ) {
|
||||
$aid = (int) ( $t['action_id'] ?? 0 );
|
||||
$ids[] = $aid;
|
||||
$amounts[ $aid ] = (int) ( $t['amount_minor'] ?? 0 );
|
||||
}
|
||||
$def = Resolver::pick( (int) ( $row['goal_id'] ?? 0 ), (int) ( $row['base_minor'] ?? 0 ), $ids, $defs, $amounts );
|
||||
if ( null === $def ) {
|
||||
return null;
|
||||
}
|
||||
return self::fromDef( $def, $name, $amountDisplay, $triggered, $attachment );
|
||||
}
|
||||
|
||||
/** @return array<string,mixed>|null */
|
||||
public static function fromDef( array $def, string $name, string $amountDisplay, array $triggered, callable $attachment ): ?array {
|
||||
$visual = null;
|
||||
$vid = (int) ( $def['visual_id'] ?? 0 );
|
||||
if ( $vid > 0 ) {
|
||||
$a = self::lookup( $attachment, $vid );
|
||||
$type = $a ? Media::visualType( $a['mime'] ) : null;
|
||||
if ( $a && $type ) {
|
||||
$visual = array( 'type' => $type, 'url' => $a['url'] );
|
||||
}
|
||||
}
|
||||
$sound = null;
|
||||
$sid = (int) ( $def['sound_id'] ?? 0 );
|
||||
if ( $sid > 0 ) {
|
||||
$a = self::lookup( $attachment, $sid );
|
||||
if ( $a && Media::isSound( $a['mime'] ) ) {
|
||||
$sound = array( 'url' => $a['url'] );
|
||||
}
|
||||
}
|
||||
$reward = '';
|
||||
$best = -1;
|
||||
foreach ( $triggered as $t ) {
|
||||
$amt = (int) ( $t['amount_minor'] ?? 0 );
|
||||
if ( 'reward' === ( $def['trigger_type'] ?? '' ) ) {
|
||||
if ( (int) ( $t['action_id'] ?? 0 ) === (int) $def['action_id'] ) {
|
||||
$reward = (string) ( $t['title'] ?? '' );
|
||||
break;
|
||||
}
|
||||
} elseif ( $amt > $best ) {
|
||||
$best = $amt;
|
||||
$reward = (string) ( $t['title'] ?? '' );
|
||||
}
|
||||
}
|
||||
$msg = Template::render( (string) ( $def['message'] ?? '' ), $name, $amountDisplay, $reward );
|
||||
if ( null === $visual && null === $sound && '' === $msg ) {
|
||||
return null; // nothing usable left: behave exactly as a plain alert
|
||||
}
|
||||
$duration = Media::clampDurationMs( $def['duration_ms'] ?? Media::DEFAULT_MS );
|
||||
if ( $visual && 'video' === $visual['type'] ) {
|
||||
$duration = Media::VIDEO_CAP_MS;
|
||||
}
|
||||
return array(
|
||||
'visual' => $visual,
|
||||
'sound' => $sound,
|
||||
'volume' => Media::clampVolume( $def['volume'] ?? 80 ),
|
||||
'duration_ms' => $duration,
|
||||
'message' => '' === $msg ? null : $msg,
|
||||
);
|
||||
}
|
||||
|
||||
/** @return array{url:string,mime:string}|null */
|
||||
private static function lookup( callable $attachment, int $id ): ?array {
|
||||
try {
|
||||
$a = $attachment( $id );
|
||||
} catch ( \Throwable ) {
|
||||
return null;
|
||||
}
|
||||
if ( ! is_array( $a ) || ! Media::isAllowed( $a['mime'] ?? null ) ) {
|
||||
return null;
|
||||
}
|
||||
$url = Media::safeUrl( $a['url'] ?? null );
|
||||
return null === $url ? null : array( 'url' => $url, 'mime' => (string) $a['mime'] );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Alerts;
|
||||
|
||||
use StreamGoals\Admin\Input;
|
||||
|
||||
/** Pure validation/sanitizing for the alert definition form. */
|
||||
final class DefInput {
|
||||
|
||||
/**
|
||||
* @param int[] $validGoalIds Existing goal ids (0 = all goals always allowed).
|
||||
* @param int[] $enabledActionIds Enabled rewards that may be chosen as a trigger.
|
||||
* @param callable(int):?array{mime:string,size?:int} $attachment Lookup of an attachment by id (null = missing).
|
||||
* @return array{data:?array,error:?string,warnings:string[]}
|
||||
*/
|
||||
public static function validate( array $post, int $minMinor, string $currency, array $validGoalIds, array $enabledActionIds, callable $attachment, int $defaultSort = 0 ): array {
|
||||
$fail = static fn( string $m ): array => array( 'data' => null, 'error' => $m, 'warnings' => array() );
|
||||
|
||||
$title = Input::text( $post['title'] ?? '', 200 );
|
||||
if ( '' === $title ) {
|
||||
return $fail( 'Please give this alert a name, for example "Big donation fireworks".' );
|
||||
}
|
||||
if ( mb_strlen( $title ) > 120 ) {
|
||||
return $fail( 'The name can be at most 120 characters.' );
|
||||
}
|
||||
$goal = Input::int( $post['goal_id'] ?? '0', 0, PHP_INT_MAX >> 1 );
|
||||
if ( null === $goal || ( 0 !== $goal && ! in_array( $goal, array_map( 'intval', $validGoalIds ), true ) ) ) {
|
||||
return $fail( 'Please choose all goals or one of your goals.' );
|
||||
}
|
||||
$trigger = is_scalar( $post['trigger_type'] ?? null ) ? (string) $post['trigger_type'] : '';
|
||||
$min = 0;
|
||||
$action = 0;
|
||||
if ( 'amount' === $trigger ) {
|
||||
$min = Input::amountToMinor( $post['amount'] ?? '', $currency );
|
||||
if ( null === $min || $min <= 0 ) {
|
||||
return $fail( 'Please enter the smallest donation that should trigger this alert, for example 10.00.' );
|
||||
}
|
||||
if ( $min < $minMinor ) {
|
||||
return $fail( 'The amount must be at least the minimum donation (' . \StreamGoals\Admin\Format::money( $minMinor, $currency ) . ').' );
|
||||
}
|
||||
} elseif ( 'reward' === $trigger ) {
|
||||
$action = Input::int( $post['action_id'] ?? '', 1, PHP_INT_MAX >> 1 );
|
||||
if ( null === $action || ! in_array( $action, array_map( 'intval', $enabledActionIds ), true ) ) {
|
||||
return $fail( 'Please choose one of your turned-on rewards.' );
|
||||
}
|
||||
} else {
|
||||
return $fail( 'Please choose when this alert plays.' );
|
||||
}
|
||||
|
||||
$warnings = array();
|
||||
$visualId = 0;
|
||||
$visual = '';
|
||||
$sound = 0;
|
||||
$vRaw = Input::int( $post['visual_id'] ?? '0', 0, PHP_INT_MAX >> 1 );
|
||||
$sRaw = Input::int( $post['sound_id'] ?? '0', 0, PHP_INT_MAX >> 1 );
|
||||
if ( null === $vRaw || null === $sRaw ) {
|
||||
return $fail( 'The chosen media file is not valid. Please pick it again.' );
|
||||
}
|
||||
if ( $vRaw > 0 ) {
|
||||
$a = $attachment( $vRaw );
|
||||
if ( ! is_array( $a ) ) {
|
||||
return $fail( 'The picture or video you chose no longer exists in your Media Library. Please pick it again.' );
|
||||
}
|
||||
$type = Media::visualType( $a['mime'] ?? null );
|
||||
if ( null === $type ) {
|
||||
return $fail( 'The picture or video must be PNG, JPEG, GIF, WebP, MP4 or WebM. Other file types are not allowed.' );
|
||||
}
|
||||
$visualId = $vRaw;
|
||||
$visual = $type;
|
||||
self::sizeWarning( $a, 'picture or video', 'video' === $type, $warnings );
|
||||
}
|
||||
if ( $sRaw > 0 ) {
|
||||
$a = $attachment( $sRaw );
|
||||
if ( ! is_array( $a ) ) {
|
||||
return $fail( 'The sound you chose no longer exists in your Media Library. Please pick it again.' );
|
||||
}
|
||||
if ( ! Media::isSound( $a['mime'] ?? null ) ) {
|
||||
return $fail( 'The sound must be an MP3, OGG or WAV file.' );
|
||||
}
|
||||
$sound = $sRaw;
|
||||
self::sizeWarning( $a, 'sound', false, $warnings );
|
||||
}
|
||||
|
||||
$vol = Input::int( $post['volume'] ?? '80', 0, 100 );
|
||||
if ( null === $vol ) {
|
||||
return $fail( 'Volume must be a whole number from 0 to 100.' );
|
||||
}
|
||||
$dur = Media::secondsToMs( $post['duration'] ?? '6' );
|
||||
if ( null === $dur || (int) round( (float) $post['duration'] * 1000 ) !== $dur ) {
|
||||
return $fail( 'How long the picture stays must be between 1 and 60 seconds.' );
|
||||
}
|
||||
$message = Input::text( $post['message'] ?? '', 400 );
|
||||
if ( mb_strlen( $message ) > 255 ) {
|
||||
return $fail( 'The message can be at most 255 characters.' );
|
||||
}
|
||||
$sortRaw = $post['sort'] ?? '';
|
||||
$sort = ( is_scalar( $sortRaw ) && '' === trim( (string) $sortRaw ) ) ? $defaultSort : Input::int( $sortRaw, 0, 99999 );
|
||||
if ( null === $sort ) {
|
||||
return $fail( 'The sort order must be a whole number from 0 to 99999.' );
|
||||
}
|
||||
return array(
|
||||
'data' => array(
|
||||
'goal_id' => $goal,
|
||||
'trigger_type' => $trigger,
|
||||
'min_minor' => $min,
|
||||
'action_id' => $action,
|
||||
'title' => $title,
|
||||
'visual_id' => $visualId,
|
||||
'visual_type' => $visual,
|
||||
'sound_id' => $sound,
|
||||
'volume' => $vol,
|
||||
'duration_ms' => $dur,
|
||||
'message' => $message,
|
||||
'sort' => $sort,
|
||||
),
|
||||
'error' => null,
|
||||
'warnings' => $warnings,
|
||||
);
|
||||
}
|
||||
|
||||
/** @param string[] $warnings */
|
||||
private static function sizeWarning( array $a, string $what, bool $video, array &$warnings ): void {
|
||||
if ( (int) ( $a['size'] ?? 0 ) > Media::WARN_BYTES ) {
|
||||
$warnings[] = 'The ' . $what . ' is over 25 MB.' . ( $video ? ' Big videos can make OBS stutter or load slowly; a short, compressed clip works much better.' : ' Large files take longer to load, so the alert may start late.' );
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Alerts;
|
||||
|
||||
/** $wpdb access to sg_alert_defs. */
|
||||
final class DefRepository {
|
||||
|
||||
private object $db;
|
||||
|
||||
public function __construct( ?object $db = null ) {
|
||||
$this->db = $db ?? $GLOBALS['wpdb'];
|
||||
}
|
||||
|
||||
private function t(): string {
|
||||
return $this->db->prefix . 'sg_alert_defs';
|
||||
}
|
||||
|
||||
/** @return array<string,mixed> */
|
||||
private static function cast( array $r ): array {
|
||||
return array(
|
||||
'id' => (int) ( $r['id'] ?? 0 ),
|
||||
'goal_id' => (int) ( $r['goal_id'] ?? 0 ),
|
||||
'trigger_type' => 'reward' === ( $r['trigger_type'] ?? '' ) ? 'reward' : 'amount',
|
||||
'min_minor' => (int) ( $r['min_minor'] ?? 0 ),
|
||||
'action_id' => (int) ( $r['action_id'] ?? 0 ),
|
||||
'title' => (string) ( $r['title'] ?? '' ),
|
||||
'visual_id' => (int) ( $r['visual_id'] ?? 0 ),
|
||||
'visual_type' => (string) ( $r['visual_type'] ?? '' ),
|
||||
'sound_id' => (int) ( $r['sound_id'] ?? 0 ),
|
||||
'volume' => (int) ( $r['volume'] ?? 80 ),
|
||||
'duration_ms' => (int) ( $r['duration_ms'] ?? 6000 ),
|
||||
'message' => (string) ( $r['message'] ?? '' ),
|
||||
'enabled' => (int) ( $r['enabled'] ?? 0 ),
|
||||
'sort' => (int) ( $r['sort'] ?? 0 ),
|
||||
'created_at' => (string) ( $r['created_at'] ?? '' ),
|
||||
);
|
||||
}
|
||||
|
||||
public function all(): array {
|
||||
return array_map( array( self::class, 'cast' ), (array) $this->db->get_results( 'SELECT * FROM ' . $this->t() . ' ORDER BY sort ASC, id ASC', ARRAY_A ) );
|
||||
}
|
||||
|
||||
/** All enabled definitions (one query); the Resolver filters by goal. */
|
||||
public function enabled(): array {
|
||||
return array_map( array( self::class, 'cast' ), (array) $this->db->get_results( 'SELECT * FROM ' . $this->t() . ' WHERE enabled = 1 ORDER BY sort ASC, id ASC', ARRAY_A ) );
|
||||
}
|
||||
|
||||
public function find( int $id ): ?array {
|
||||
$row = $this->db->get_row( $this->db->prepare( 'SELECT * FROM ' . $this->t() . ' WHERE id = %d', $id ), ARRAY_A );
|
||||
return $row ? self::cast( $row ) : null;
|
||||
}
|
||||
|
||||
public function nextSort(): int {
|
||||
return (int) $this->db->get_var( 'SELECT COALESCE(MAX(sort),0)+10 FROM ' . $this->t() );
|
||||
}
|
||||
|
||||
private const COLS = array(
|
||||
'goal_id' => '%d', 'trigger_type' => '%s', 'min_minor' => '%d', 'action_id' => '%d', 'title' => '%s', 'visual_id' => '%d',
|
||||
'visual_type' => '%s', 'sound_id' => '%d', 'volume' => '%d', 'duration_ms' => '%d', 'message' => '%s', 'sort' => '%d',
|
||||
);
|
||||
|
||||
public function create( array $d ): int {
|
||||
$row = array();
|
||||
foreach ( self::COLS as $k => $f ) {
|
||||
$row[ $k ] = $d[ $k ];
|
||||
}
|
||||
$row['enabled'] = 1;
|
||||
$row['created_at'] = gmdate( 'Y-m-d H:i:s' );
|
||||
$ok = $this->db->insert( $this->t(), $row, array_merge( array_values( self::COLS ), array( '%d', '%s' ) ) );
|
||||
return $ok ? (int) $this->db->insert_id : 0;
|
||||
}
|
||||
|
||||
public function update( int $id, array $d ): void {
|
||||
$row = array();
|
||||
foreach ( self::COLS as $k => $f ) {
|
||||
$row[ $k ] = $d[ $k ];
|
||||
}
|
||||
$this->db->update( $this->t(), $row, array( 'id' => $id ), array_values( self::COLS ), array( '%d' ) );
|
||||
}
|
||||
|
||||
public function setEnabled( int $id, bool $on ): void {
|
||||
$this->db->update( $this->t(), array( 'enabled' => $on ? 1 : 0 ), array( 'id' => $id ), array( '%d' ), array( '%d' ) );
|
||||
}
|
||||
|
||||
public function delete( int $id ): void {
|
||||
$this->db->delete( $this->t(), array( 'id' => $id ), array( '%d' ) );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Alerts;
|
||||
|
||||
/** Pure helpers: MIME whitelist, type classification and duration clamping for alert media. */
|
||||
final class Media {
|
||||
|
||||
/** Exact MIME => kind. Everything else (svg, html, ...) is rejected. */
|
||||
public const MIMES = array(
|
||||
'image/png' => 'image',
|
||||
'image/jpeg' => 'image',
|
||||
'image/gif' => 'image',
|
||||
'image/webp' => 'image',
|
||||
'video/mp4' => 'video',
|
||||
'video/webm' => 'video',
|
||||
'audio/mpeg' => 'audio',
|
||||
'audio/ogg' => 'audio',
|
||||
'audio/wav' => 'audio',
|
||||
);
|
||||
|
||||
public const WARN_BYTES = 26214400; // 25 MB
|
||||
public const MIN_DURATION_MS = 1000;
|
||||
public const MAX_DURATION_MS = 60000;
|
||||
public const DEFAULT_MS = 6000;
|
||||
public const VIDEO_CAP_MS = 30000;
|
||||
|
||||
/** 'image' | 'video' | 'audio' for an allowed MIME, else null. Strict: no parameters, no case games. */
|
||||
public static function kind( mixed $mime ): ?string {
|
||||
if ( ! is_string( $mime ) ) {
|
||||
return null;
|
||||
}
|
||||
return self::MIMES[ strtolower( $mime ) ] ?? null;
|
||||
}
|
||||
|
||||
public static function isAllowed( mixed $mime ): bool {
|
||||
return null !== self::kind( $mime );
|
||||
}
|
||||
|
||||
/** 'image' | 'video' for a visual attachment MIME, else null (audio is not a visual). */
|
||||
public static function visualType( mixed $mime ): ?string {
|
||||
$k = self::kind( $mime );
|
||||
return 'image' === $k || 'video' === $k ? $k : null;
|
||||
}
|
||||
|
||||
public static function isSound( mixed $mime ): bool {
|
||||
return 'audio' === self::kind( $mime );
|
||||
}
|
||||
|
||||
public static function clampDurationMs( mixed $ms, int $default = self::DEFAULT_MS ): int {
|
||||
if ( ! is_numeric( $ms ) ) {
|
||||
return $default;
|
||||
}
|
||||
return max( self::MIN_DURATION_MS, min( self::MAX_DURATION_MS, (int) $ms ) );
|
||||
}
|
||||
|
||||
/** Whole seconds (1-60) to clamped milliseconds; null when the input is not a number. */
|
||||
public static function secondsToMs( mixed $s ): ?int {
|
||||
if ( ! is_scalar( $s ) || ! preg_match( '/^\s*\d{1,4}(\.\d+)?\s*$/', (string) $s ) ) {
|
||||
return null;
|
||||
}
|
||||
return self::clampDurationMs( (int) round( (float) $s * 1000 ) );
|
||||
}
|
||||
|
||||
public static function clampVolume( mixed $v, int $default = 80 ): int {
|
||||
return is_numeric( $v ) ? max( 0, min( 100, (int) $v ) ) : $default;
|
||||
}
|
||||
|
||||
/** Only plain http(s) URLs are ever handed to the overlay. */
|
||||
public static function safeUrl( mixed $url ): ?string {
|
||||
if ( ! is_string( $url ) || '' === $url || strlen( $url ) > 2000 || preg_match( '/[\x00-\x20\x7F"\'<>\\\\]/', $url ) ) {
|
||||
return null;
|
||||
}
|
||||
return preg_match( '#^https?://[^/]#i', $url ) ? $url : null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Alerts;
|
||||
|
||||
/** Picks the single alert definition that applies to one donation. Pure. */
|
||||
final class Resolver {
|
||||
|
||||
/**
|
||||
* @param int[] $triggeredActionIds Rewards triggered by this donation.
|
||||
* @param array<int,array<string,mixed>> $defs Raw sg_alert_defs rows (any state; filtered here).
|
||||
* @param array<int,int> $actionAmounts action id => reward amount (minor); ties fall back to sort, id.
|
||||
* @return array<string,mixed>|null the winning row (with ints normalised) or null
|
||||
*/
|
||||
public static function pick( int $goalId, int $baseMinor, array $triggeredActionIds, array $defs, array $actionAmounts = array() ): ?array {
|
||||
$triggered = array_flip( array_map( 'intval', $triggeredActionIds ) );
|
||||
$reward = array();
|
||||
$amount = array();
|
||||
foreach ( $defs as $d ) {
|
||||
if ( ! is_array( $d ) || empty( $d['enabled'] ) ) {
|
||||
continue;
|
||||
}
|
||||
$dg = (int) ( $d['goal_id'] ?? 0 );
|
||||
if ( 0 !== $dg && $dg !== $goalId ) {
|
||||
continue;
|
||||
}
|
||||
$d['id'] = (int) ( $d['id'] ?? 0 );
|
||||
$d['sort'] = (int) ( $d['sort'] ?? 0 );
|
||||
$d['min_minor'] = (int) ( $d['min_minor'] ?? 0 );
|
||||
$d['action_id'] = (int) ( $d['action_id'] ?? 0 );
|
||||
$d['goal_id'] = $dg;
|
||||
if ( 'reward' === ( $d['trigger_type'] ?? '' ) ) {
|
||||
if ( $d['action_id'] > 0 && isset( $triggered[ $d['action_id'] ] ) ) {
|
||||
$reward[] = $d;
|
||||
}
|
||||
} elseif ( 'amount' === ( $d['trigger_type'] ?? '' ) && $baseMinor >= $d['min_minor'] ) {
|
||||
$amount[] = $d;
|
||||
}
|
||||
}
|
||||
if ( $reward ) {
|
||||
usort( $reward, static function ( array $a, array $b ) use ( $actionAmounts ): int {
|
||||
return ( (int) ( $actionAmounts[ $b['action_id'] ] ?? 0 ) <=> (int) ( $actionAmounts[ $a['action_id'] ] ?? 0 ) )
|
||||
?: ( $a['sort'] <=> $b['sort'] )
|
||||
?: ( $a['id'] <=> $b['id'] );
|
||||
} );
|
||||
return $reward[0];
|
||||
}
|
||||
if ( $amount ) {
|
||||
usort( $amount, static fn( array $a, array $b ): int => ( $b['min_minor'] <=> $a['min_minor'] ) ?: ( $a['sort'] <=> $b['sort'] ) ?: ( $a['id'] <=> $b['id'] ) );
|
||||
return $amount[0];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Alerts;
|
||||
|
||||
/** Renders the custom alert message. Output is plain text: no tags, no control characters, length-capped. */
|
||||
final class Template {
|
||||
|
||||
public const MAX = 200;
|
||||
|
||||
public static function clean( string $s ): string {
|
||||
$s = strip_tags( $s );
|
||||
$s = (string) preg_replace( '/[\x00-\x1F\x7F\x{200B}-\x{200F}\x{202A}-\x{202E}\x{2066}-\x{2069}\x{FEFF}]+/u', ' ', $s );
|
||||
$s = str_replace( array( '<', '>' ), '', $s );
|
||||
return trim( (string) preg_replace( '/\s+/u', ' ', $s ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tokens: {name} {amount} {reward} (case-insensitive). Unknown tokens are dropped. Substituted values are never
|
||||
* re-scanned for tokens. Empty template (or empty result) returns '' meaning "use the default text".
|
||||
*/
|
||||
public static function render( string $template, string $name, string $amount, string $reward, int $max = self::MAX ): string {
|
||||
$tpl = self::clean( $template );
|
||||
if ( '' === $tpl ) {
|
||||
return '';
|
||||
}
|
||||
$name = self::clean( $name );
|
||||
$vals = array(
|
||||
'name' => '' === $name ? 'Anonymous' : mb_substr( $name, 0, 60 ),
|
||||
'amount' => mb_substr( self::clean( $amount ), 0, 30 ),
|
||||
'reward' => mb_substr( self::clean( $reward ), 0, 80 ),
|
||||
);
|
||||
$out = (string) preg_replace_callback(
|
||||
'/\{([A-Za-z_]{1,20})\}/',
|
||||
static fn( array $m ): string => $vals[ strtolower( $m[1] ) ] ?? '',
|
||||
$tpl
|
||||
);
|
||||
$out = trim( (string) preg_replace( '/\s+/u', ' ', $out ) );
|
||||
return mb_substr( $out, 0, max( 1, $max ) );
|
||||
}
|
||||
}
|
||||
@@ -8,7 +8,7 @@ namespace StreamGoals\Core;
|
||||
*/
|
||||
final class Installer {
|
||||
|
||||
public const DB_VERSION = '3';
|
||||
public const DB_VERSION = '4';
|
||||
|
||||
public static function activate(): void {
|
||||
self::install_schema();
|
||||
@@ -143,6 +143,20 @@ final class Installer {
|
||||
KEY goal_enabled (goal_id,enabled)
|
||||
) $c;" );
|
||||
|
||||
dbDelta( "CREATE TABLE {$p}goal_tiers (
|
||||
id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
|
||||
goal_id BIGINT UNSIGNED NOT NULL,
|
||||
target_minor BIGINT UNSIGNED NOT NULL,
|
||||
title VARCHAR(120) NOT NULL,
|
||||
description VARCHAR(255) NOT NULL DEFAULT '',
|
||||
reached_at DATETIME NULL,
|
||||
reached_donation_id BIGINT UNSIGNED NULL,
|
||||
created_at DATETIME NOT NULL,
|
||||
PRIMARY KEY (id),
|
||||
UNIQUE KEY goal_target (goal_id,target_minor),
|
||||
KEY reached_donation (reached_donation_id)
|
||||
) $c;" );
|
||||
|
||||
update_option( 'sg_db_version', self::DB_VERSION );
|
||||
}
|
||||
}
|
||||
@@ -34,6 +34,7 @@ final class Settings {
|
||||
'profanity_words' => '', // streamer's extra words, one per line
|
||||
'message_max_length' => 200,
|
||||
'min_donation_minor' => 100,
|
||||
'donation_notice' => 'Donations are non-refundable.', // shown under the donation form; empty hides it
|
||||
'overlay_token' => '',
|
||||
'visitor_ip_header' => 'auto', // auto | '' (direct) | cloudflare | real_ip | forwarded (see Core\ClientIp)
|
||||
'funding_paylater' => false, // show PayPal "Pay Later" button
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Overlay;
|
||||
|
||||
/** Optional capability: configurable alert media (definitions, triggered rewards, attachment lookup). */
|
||||
interface AlertMediaSource {
|
||||
|
||||
/** Enabled alert definitions, raw rows. Called at most once per request. */
|
||||
public function alertDefs(): array;
|
||||
|
||||
/**
|
||||
* Rewards triggered per donation, one lookup for the whole page.
|
||||
*
|
||||
* @param int[] $donationIds
|
||||
* @return array<int,array<int,array{action_id:int,amount_minor:int,title:string}>> donation id => rewards
|
||||
*/
|
||||
public function triggeredActionsFor( array $donationIds ): array;
|
||||
|
||||
/**
|
||||
* Server-side attachment lookup (the only place media URLs come from). Null when it is gone.
|
||||
*
|
||||
* @return array{url:string,mime:string}|null
|
||||
*/
|
||||
public function attachment( int $id ): ?array;
|
||||
}
|
||||
@@ -8,14 +8,31 @@ final class OverlayService {
|
||||
|
||||
public const WIDGETS = array( 'goal', 'timer', 'counter', 'alerts', 'actions' );
|
||||
|
||||
/** @var array<int,array<string,mixed>>|null */
|
||||
private ?array $defs = null;
|
||||
|
||||
public function __construct( private OverlayDataSource $source ) {}
|
||||
|
||||
/** Enabled alert definitions, loaded at most once per service instance (= per request). */
|
||||
private function defs(): array {
|
||||
if ( null === $this->defs ) {
|
||||
$this->defs = $this->source instanceof AlertMediaSource ? array_values( $this->source->alertDefs() ) : array();
|
||||
}
|
||||
return $this->defs;
|
||||
}
|
||||
|
||||
/** Extra ETag input so editing media definitions invalidates cached alert payloads even when no alert is pending. */
|
||||
public function etagSalt( string $widget ): string {
|
||||
return 'alerts' === $widget && $this->defs() ? md5( (string) json_encode( $this->defs() ) ) : '';
|
||||
}
|
||||
|
||||
public function payload( string $widget, int $now, ?int $since = null, bool $recent = false ): ?array {
|
||||
$goal = $this->source->activeGoal();
|
||||
$gid = $goal ? (int) $goal['id'] : 0;
|
||||
switch ( $widget ) {
|
||||
case 'goal':
|
||||
return Payloads::goal( $goal, $goal ? $this->source->raisedMinor( $goal ) : 0 );
|
||||
$tiers = ( $gid && $this->source instanceof TiersSource ) ? $this->source->tiersFor( $gid ) : array();
|
||||
return Payloads::goal( $goal, $goal ? $this->source->raisedMinor( $goal ) : 0, $tiers ?: null );
|
||||
case 'timer':
|
||||
return Payloads::timer(
|
||||
$gid ? $this->source->stateValue( $gid, 'timer_ends_at' ) : null,
|
||||
@@ -39,11 +56,22 @@ final class OverlayService {
|
||||
$ids = array_values( array_filter( array_map( static fn( $r ) => (int) ( $r['id'] ?? 0 ), $rows ) ) );
|
||||
$bonuses = ( ( $recent || null !== $since ) && $ids ) ? $this->source->bonusesFor( $ids ) : array();
|
||||
$actions = ( ( $recent || null !== $since ) && $ids && $this->source instanceof ActionsSource ) ? $this->source->actionsFor( $ids ) : array();
|
||||
$tiers = ( ( $recent || null !== $since ) && $ids && $this->source instanceof TiersSource ) ? $this->source->tiersReachedFor( $ids ) : array();
|
||||
foreach ( $rows as $i => $r ) {
|
||||
$rows[ $i ]['bonuses'] = $bonuses[ (int) ( $r['id'] ?? 0 ) ] ?? array();
|
||||
$rows[ $i ]['actions'] = $actions[ (int) ( $r['id'] ?? 0 ) ] ?? array();
|
||||
$rows[ $i ]['tiers'] = $tiers[ (int) ( $r['id'] ?? 0 ) ] ?? array();
|
||||
}
|
||||
return Payloads::alerts( $rows, $since, $recent ? 20 : 10, $recent );
|
||||
$mediaFor = null;
|
||||
$defs = ( $recent || null !== $since ) ? $this->defs() : array();
|
||||
if ( $defs && $ids && $this->source instanceof AlertMediaSource ) {
|
||||
$src = $this->source;
|
||||
$triggered = $src->triggeredActionsFor( $ids );
|
||||
$mediaFor = static fn( array $r, string $name, string $amount ): ?array => \StreamGoals\Alerts\AlertMedia::build(
|
||||
$r, $name, $amount, $defs, $triggered[ (int) ( $r['id'] ?? 0 ) ] ?? array(), static fn( int $id ): ?array => $src->attachment( $id )
|
||||
);
|
||||
}
|
||||
return Payloads::alerts( $rows, $since, $recent ? 20 : 10, $recent, $mediaFor );
|
||||
case 'actions':
|
||||
$rows = ( $gid && $this->source instanceof ActionsSource ) ? $this->source->menuActions( $gid ) : array();
|
||||
return Payloads::actionsMenu( $goal, $rows );
|
||||
|
||||
@@ -4,6 +4,7 @@ declare( strict_types=1 );
|
||||
namespace StreamGoals\Overlay;
|
||||
|
||||
use StreamGoals\Core\Money;
|
||||
use StreamGoals\Tiers\TierPolicy;
|
||||
|
||||
/**
|
||||
* Pure, WordPress-free payload builders. Everything returned here is public-safe.
|
||||
@@ -31,7 +32,10 @@ final class Payloads {
|
||||
return max( 0, min( 100, intdiv( max( 0, $raised ) * 100, $target ) ) );
|
||||
}
|
||||
|
||||
public static function goal( ?array $goal, int $raised ): array {
|
||||
/**
|
||||
* @param array<int,array<string,mixed>>|null $tiers Raw sg_goal_tiers rows; null/empty = an ordinary (untiered) goal, payload unchanged.
|
||||
*/
|
||||
public static function goal( ?array $goal, int $raised, ?array $tiers = null ): array {
|
||||
if ( null === $goal ) {
|
||||
return array( 'active' => false, 'title' => '', 'raised_minor' => 0, 'target_minor' => 0, 'percent' => 0,
|
||||
'currency' => 'USD', 'raised_display' => '', 'target_display' => '' );
|
||||
@@ -39,6 +43,9 @@ final class Payloads {
|
||||
$cur = strtoupper( (string) ( $goal['currency'] ?? 'USD' ) );
|
||||
$target = max( 0, (int) ( $goal['target_minor'] ?? 0 ) );
|
||||
$raised = max( 0, $raised );
|
||||
if ( $tiers ) {
|
||||
return self::tieredGoal( $goal, $raised, $cur, $tiers );
|
||||
}
|
||||
return array(
|
||||
'active' => true,
|
||||
'title' => (string) ( $goal['title'] ?? '' ),
|
||||
@@ -51,6 +58,40 @@ final class Payloads {
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tiered goal: raised stays cumulative; target/percent describe the CURRENT tier (percent is within the tier).
|
||||
* When every tier is reached the bar is full at the top tier's target.
|
||||
*/
|
||||
private static function tieredGoal( array $goal, int $raised, string $cur, array $tiers ): array {
|
||||
$sorted = TierPolicy::sorted( $tiers );
|
||||
$current = TierPolicy::currentTier( $sorted );
|
||||
$all = null === $current;
|
||||
$target = $all ? TierPolicy::derivedGoalTarget( $sorted ) : max( 0, (int) $current['target_minor'] );
|
||||
$floor = TierPolicy::floorMinor( $sorted );
|
||||
return array(
|
||||
'active' => true,
|
||||
'title' => (string) ( $goal['title'] ?? '' ),
|
||||
'raised_minor' => $raised,
|
||||
'target_minor' => $target,
|
||||
'percent' => TierPolicy::percentFor( $sorted, $raised ),
|
||||
'currency' => $cur,
|
||||
'raised_display' => self::money( $raised, $cur ),
|
||||
'target_display' => self::money( $target, $cur ),
|
||||
'tiers' => array(
|
||||
'count' => count( $sorted ),
|
||||
'index' => TierPolicy::currentIndex( $sorted ),
|
||||
'current' => $all ? null : array(
|
||||
'title' => self::text( $current['title'] ?? '', 120 ),
|
||||
'description' => self::text( $current['description'] ?? '', 255 ),
|
||||
'target_minor' => $target,
|
||||
'target_display' => self::money( $target, $cur ),
|
||||
'floor_minor' => $floor,
|
||||
),
|
||||
'all_reached' => $all,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|null $endsAt sg_state `timer_ends_at` (epoch seconds, or a UTC datetime string).
|
||||
* @param string|null $pausedRemaining sg_state `paused_remaining` seconds; non-null means paused.
|
||||
@@ -78,7 +119,7 @@ final class Payloads {
|
||||
* @param bool $recent Recent mode: ignore $since and return the newest $limit approved alerts (ascending id),
|
||||
* so a message approved after newer donations still shows up. The client dedupes by id.
|
||||
*/
|
||||
public static function alerts( array $rows, ?int $since, int $limit = 10, bool $recent = false ): array {
|
||||
public static function alerts( array $rows, ?int $since, int $limit = 10, bool $recent = false, ?callable $mediaFor = null ): array {
|
||||
$safe = array();
|
||||
foreach ( $rows as $r ) {
|
||||
if ( 'completed' !== ( $r['status'] ?? '' ) || 'approved' !== ( $r['moderation'] ?? '' ) ) {
|
||||
@@ -89,7 +130,7 @@ final class Payloads {
|
||||
usort( $safe, static fn( $a, $b ) => (int) $a['id'] <=> (int) $b['id'] );
|
||||
if ( $recent ) {
|
||||
$safe = array_slice( $safe, -max( 1, $limit ) );
|
||||
$alerts = array_map( array( self::class, 'alert' ), $safe );
|
||||
$alerts = array_map( static fn( array $r ): array => self::alert( $r, $mediaFor ), $safe );
|
||||
return array( 'alerts' => $alerts, 'last_id' => $alerts ? (int) end( $alerts )['id'] : 0 );
|
||||
}
|
||||
$lastId = $since ?? 0;
|
||||
@@ -104,7 +145,7 @@ final class Payloads {
|
||||
if ( (int) $r['id'] <= $since ) {
|
||||
continue;
|
||||
}
|
||||
$alerts[] = self::alert( $r );
|
||||
$alerts[] = self::alert( $r, $mediaFor );
|
||||
}
|
||||
$alerts = array_slice( $alerts, 0, max( 1, $limit ) );
|
||||
if ( $alerts ) {
|
||||
@@ -113,20 +154,27 @@ final class Payloads {
|
||||
return array( 'alerts' => $alerts, 'last_id' => $lastId );
|
||||
}
|
||||
|
||||
/** @param array<string,mixed> $r */
|
||||
private static function alert( array $r ): array {
|
||||
/**
|
||||
* @param array<string,mixed> $r
|
||||
* @param (callable(array,string,string):?array)|null $mediaFor Builds the `media` block from (row, public name, amount display).
|
||||
*/
|
||||
private static function alert( array $r, ?callable $mediaFor = null ): array {
|
||||
$cur = strtoupper( (string) ( $r['currency'] ?? 'USD' ) );
|
||||
$anon = ! empty( $r['is_anonymous'] );
|
||||
$name = trim( (string) ( $r['donor_name'] ?? '' ) );
|
||||
$pub = ( $anon || '' === $name ) ? self::ANON_NAME : $name;
|
||||
$disp = self::money( (int) $r['base_minor'], $cur );
|
||||
return array(
|
||||
'id' => (int) $r['id'],
|
||||
'name' => ( $anon || '' === $name ) ? self::ANON_NAME : $name,
|
||||
'name' => $pub,
|
||||
'amount_minor' => (int) $r['base_minor'],
|
||||
'amount_display' => self::money( (int) $r['base_minor'], $cur ),
|
||||
'amount_display' => $disp,
|
||||
'currency' => $cur,
|
||||
'message' => (string) ( $r['message'] ?? '' ),
|
||||
'bonuses' => self::bonuses( $r['bonuses'] ?? array() ),
|
||||
'actions' => self::actionEvents( $r['actions'] ?? array() ),
|
||||
'tiers' => self::tierEvents( $r['tiers'] ?? array() ),
|
||||
'media' => $mediaFor ? $mediaFor( $r, $pub, $disp ) : null,
|
||||
);
|
||||
}
|
||||
|
||||
@@ -194,6 +242,27 @@ final class Payloads {
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tiers a donation unlocked, for the "TIER UNLOCKED" pill: [ {title} ]. At most 5, titles capped at 80 chars, blanks dropped.
|
||||
*
|
||||
* @param mixed $events
|
||||
* @return array<int,array{title:string}>
|
||||
*/
|
||||
public static function tierEvents( mixed $events ): array {
|
||||
$out = array();
|
||||
foreach ( is_array( $events ) ? $events : array() as $e ) {
|
||||
$title = self::text( is_array( $e ) ? ( $e['title'] ?? '' ) : '', 80 );
|
||||
if ( '' === $title ) {
|
||||
continue;
|
||||
}
|
||||
$out[] = array( 'title' => $title );
|
||||
if ( count( $out ) >= 5 ) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* The on-stream reward menu for the active goal. Empty list means "render nothing".
|
||||
*
|
||||
@@ -223,10 +292,10 @@ final class Payloads {
|
||||
return array( 'active' => (bool) $list, 'currency' => $cur, 'actions' => $list );
|
||||
}
|
||||
|
||||
/** Strong ETag over the payload, ignoring the volatile server_now so unchanged data yields 304s. */
|
||||
public static function etag( array $payload ): string {
|
||||
/** Strong ETag over the payload (plus an optional salt, e.g. a hash of media definitions), ignoring the volatile server_now so unchanged data yields 304s. */
|
||||
public static function etag( array $payload, string $salt = '' ): string {
|
||||
unset( $payload['server_now'] );
|
||||
return '"' . md5( (string) json_encode( $payload, JSON_UNESCAPED_UNICODE ) ) . '"';
|
||||
return '"' . md5( $salt . (string) json_encode( $payload, JSON_UNESCAPED_UNICODE ) ) . '"';
|
||||
}
|
||||
|
||||
private static function toEpoch( ?string $v ): ?int {
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Overlay;
|
||||
|
||||
/** Optional capability: goal tiers (milestones). Sources without it behave as if no goal had tiers. */
|
||||
interface TiersSource {
|
||||
|
||||
/**
|
||||
* Tiers of a goal ordered by target ascending. Rows with keys id, target_minor, title, description, reached_at.
|
||||
*
|
||||
* @return array<int,array<string,mixed>>
|
||||
*/
|
||||
public function tiersFor( int $goalId ): array;
|
||||
|
||||
/**
|
||||
* Tiers unlocked by each donation, ONE lookup for the whole page: donation id => [ {title} ].
|
||||
*
|
||||
* @param int[] $donationIds
|
||||
* @return array<int,array<int,array<string,mixed>>>
|
||||
*/
|
||||
public function tiersReachedFor( array $donationIds ): array;
|
||||
}
|
||||
@@ -4,7 +4,10 @@ declare( strict_types=1 );
|
||||
namespace StreamGoals\Overlay;
|
||||
|
||||
/** $wpdb adapter reading sg_goals, sg_donations, sg_state, sg_rules directly. */
|
||||
final class WpdbDataSource implements OverlayDataSource, RecentDonationsSource, ActionsSource {
|
||||
final class WpdbDataSource implements OverlayDataSource, RecentDonationsSource, ActionsSource, AlertMediaSource, TiersSource {
|
||||
|
||||
/** @var array<int,?array{url:string,mime:string}> */
|
||||
private array $attachments = array();
|
||||
|
||||
private function t( string $name ): string {
|
||||
global $wpdb;
|
||||
@@ -117,9 +120,55 @@ final class WpdbDataSource implements OverlayDataSource, RecentDonationsSource,
|
||||
return $out;
|
||||
}
|
||||
|
||||
public function tiersFor( int $goalId ): array {
|
||||
return ( new \StreamGoals\Tiers\TierRepository( $GLOBALS['wpdb'] ) )->forGoal( $goalId );
|
||||
}
|
||||
|
||||
public function tiersReachedFor( array $donationIds ): array {
|
||||
return ( new \StreamGoals\Tiers\TierRepository( $GLOBALS['wpdb'] ) )->reachedByDonation( $donationIds );
|
||||
}
|
||||
|
||||
public function alertDefs(): array {
|
||||
return ( new \StreamGoals\Alerts\DefRepository( $GLOBALS['wpdb'] ) )->enabled();
|
||||
}
|
||||
|
||||
public function triggeredActionsFor( array $donationIds ): array {
|
||||
global $wpdb;
|
||||
$ids = array_values( array_unique( array_filter( array_map( 'intval', $donationIds ), static fn( $i ) => $i > 0 ) ) );
|
||||
if ( ! $ids ) {
|
||||
return array();
|
||||
}
|
||||
$in = implode( ',', array_fill( 0, count( $ids ), '%d' ) );
|
||||
$rows = $wpdb->get_results( $wpdb->prepare(
|
||||
"SELECT e.donation_id, e.action_id, e.title, COALESCE(a.amount_minor,0) AS amount_minor FROM {$this->t('action_events')} e
|
||||
LEFT JOIN {$this->t('actions')} a ON a.id = e.action_id WHERE e.donation_id IN ($in) ORDER BY e.id ASC",
|
||||
$ids
|
||||
), ARRAY_A );
|
||||
$out = array();
|
||||
foreach ( (array) $rows as $row ) {
|
||||
$out[ (int) $row['donation_id'] ][] = array( 'action_id' => (int) $row['action_id'], 'amount_minor' => (int) $row['amount_minor'], 'title' => (string) $row['title'] );
|
||||
}
|
||||
return $out;
|
||||
}
|
||||
|
||||
public function attachment( int $id ): ?array {
|
||||
if ( array_key_exists( $id, $this->attachments ) ) {
|
||||
return $this->attachments[ $id ];
|
||||
}
|
||||
$out = null;
|
||||
if ( $id > 0 && 'attachment' === get_post_type( $id ) ) {
|
||||
$mime = (string) get_post_mime_type( $id );
|
||||
$url = wp_get_attachment_url( $id );
|
||||
if ( \StreamGoals\Alerts\Media::isAllowed( $mime ) && is_string( $url ) && '' !== $url ) {
|
||||
$out = array( 'url' => $url, 'mime' => $mime );
|
||||
}
|
||||
}
|
||||
return $this->attachments[ $id ] = $out;
|
||||
}
|
||||
|
||||
public function donations( ?int $sinceId, int $limit ): array {
|
||||
global $wpdb;
|
||||
$cols = 'id, base_minor, currency, donor_name, is_anonymous, message, status, moderation';
|
||||
$cols = 'id, goal_id, base_minor, currency, donor_name, is_anonymous, message, status, moderation';
|
||||
$where = "status = 'completed' AND moderation = 'approved'";
|
||||
if ( null === $sinceId ) {
|
||||
$rows = $wpdb->get_results( "SELECT $cols FROM {$this->t('donations')} WHERE $where ORDER BY id DESC LIMIT 1", ARRAY_A );
|
||||
@@ -136,7 +185,7 @@ final class WpdbDataSource implements OverlayDataSource, RecentDonationsSource,
|
||||
public function recentDonations( int $limit ): array {
|
||||
global $wpdb;
|
||||
$rows = $wpdb->get_results( $wpdb->prepare(
|
||||
"SELECT id, base_minor, currency, donor_name, is_anonymous, message, status, moderation FROM {$this->t('donations')}
|
||||
"SELECT id, goal_id, base_minor, currency, donor_name, is_anonymous, message, status, moderation FROM {$this->t('donations')}
|
||||
WHERE status = 'completed' AND moderation = 'approved' ORDER BY id DESC LIMIT %d",
|
||||
max( 1, $limit )
|
||||
), ARRAY_A );
|
||||
|
||||
@@ -93,6 +93,13 @@ final class DonationStore {
|
||||
} catch ( \Throwable $e ) {
|
||||
error_log( 'StreamGoals: Recorder failed for donation ' . $id . ': ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions
|
||||
}
|
||||
// Goal tiers: unlock every tier this donation reaches. MUST run before the close-at-target check below
|
||||
// (the final tier's target is the goal target). Own try/catch; never throws, never delays a capture.
|
||||
try {
|
||||
\StreamGoals\Tiers\Recorder::forDonation( $id );
|
||||
} catch ( \Throwable $e ) {
|
||||
error_log( 'StreamGoals: tier unlock failed for donation ' . $id . ': ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions
|
||||
}
|
||||
self::close_goal_if_target_reached( $id );
|
||||
}
|
||||
|
||||
|
||||
@@ -162,7 +162,8 @@ final class DonateController {
|
||||
if ( $pinned && (int) $g['id'] !== $pinned ) {
|
||||
continue;
|
||||
}
|
||||
$goals[] = array(
|
||||
$next = self::next_unlock( $g );
|
||||
$goals[] = ( null === $next ? array() : array( 'nextUnlock' => $next ) ) + array(
|
||||
'id' => (int) $g['id'],
|
||||
'title' => (string) $g['title'],
|
||||
'currency' => strtoupper( (string) $g['currency'] ),
|
||||
@@ -187,6 +188,7 @@ final class DonateController {
|
||||
'policy' => (string) $s['anonymity_policy'],
|
||||
'minMinor' => \StreamGoals\Core\Settings::effectiveMin( (int) $s['min_donation_minor'] ),
|
||||
'messageMax' => min( 500, (int) $s['message_max_length'] ),
|
||||
'notice' => (string) ( $s['donation_notice'] ?? '' ),
|
||||
'disableFunding' => array_values( array_filter( array( empty( $s['funding_paylater'] ) ? 'paylater' : '', empty( $s['funding_card'] ) ? 'card' : '' ) ) ),
|
||||
'goals' => $goals,
|
||||
'i18n' => array(
|
||||
@@ -206,6 +208,8 @@ final class DonateController {
|
||||
'customPlaceholder' => __( 'Other amount', 'streamgoals-donate' ),
|
||||
/* translators: %s: formatted amount, e.g. $5.00 */
|
||||
'everyLabel' => __( 'Every %s', 'streamgoals-donate' ),
|
||||
/* translators: 1: item/unlock title, 2: formatted amount still needed, e.g. $106.00 */
|
||||
'nextUnlock' => __( 'Next unlock: %1$s — %2$s to go', 'streamgoals-donate' ),
|
||||
'actionsHint' => __( 'Pick a reward, or enter your own amount below.', 'streamgoals-donate' ),
|
||||
/* translators: %s: formatted minimum amount, e.g. $1.00 */
|
||||
'minHint' => __( 'Minimum donation: %s', 'streamgoals-donate' ),
|
||||
@@ -222,6 +226,27 @@ final class DonateController {
|
||||
|
||||
/* ------------------------------------------------------------- Helpers */
|
||||
|
||||
/**
|
||||
* "Next unlock" hint for a tiered goal: the current (first unreached) tier's title and the amount still needed, in minor units.
|
||||
* Null for goals without tiers or with every tier reached. Computed when the page renders.
|
||||
*
|
||||
* @return array{title:string,remaining_minor:int}|null
|
||||
*/
|
||||
private static function next_unlock( array $goal ): ?array {
|
||||
try {
|
||||
global $wpdb;
|
||||
$tiers = ( new \StreamGoals\Tiers\TierRepository( $wpdb ) )->forGoal( (int) $goal['id'] );
|
||||
$cur = $tiers ? \StreamGoals\Tiers\TierPolicy::currentTier( $tiers ) : null;
|
||||
if ( null === $cur ) {
|
||||
return null;
|
||||
}
|
||||
$raised = ( new \StreamGoals\Core\GoalRepository( $wpdb ) )->raised_minor( (int) $goal['id'] );
|
||||
return array( 'title' => (string) $cur['title'], 'remaining_minor' => max( 1, (int) $cur['target_minor'] - $raised ) );
|
||||
} catch ( \Throwable $e ) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Enabled actions per goal id (rows with goal_id 0 apply to every goal), at or above the effective minimum.
|
||||
* Public-safe fields only. One query; reads sg_actions directly.
|
||||
|
||||
@@ -49,12 +49,13 @@ final class OverlayController {
|
||||
}
|
||||
$since = $req->has_param( 'since' ) && '' !== (string) $req->get_param( 'since' ) ? absint( $req->get_param( 'since' ) ) : null;
|
||||
$recent = $req->has_param( 'recent' ) && 1 === absint( $req->get_param( 'recent' ) );
|
||||
$payload = ( new OverlayService( new WpdbDataSource() ) )->payload( (string) $req['widget'], time(), $since, $recent );
|
||||
$service = new OverlayService( new WpdbDataSource() );
|
||||
$payload = $service->payload( (string) $req['widget'], time(), $since, $recent );
|
||||
if ( null === $payload ) {
|
||||
return new \WP_Error( 'sg_not_found', 'Not found.', array( 'status' => 404 ) );
|
||||
}
|
||||
|
||||
$etag = Payloads::etag( $payload );
|
||||
$etag = Payloads::etag( $payload, $service->etagSalt( (string) $req['widget'] ) );
|
||||
$headers = array( 'ETag' => $etag, 'Cache-Control' => 'private, max-age=1, must-revalidate', 'X-Robots-Tag' => 'noindex' );
|
||||
$inm = (string) $req->get_header( 'if_none_match' );
|
||||
if ( '' !== $inm && in_array( $etag, array_map( 'trim', explode( ',', str_replace( 'W/', '', $inm ) ) ), true ) ) {
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tiers;
|
||||
|
||||
/** Unlocks the tiers a completed donation reaches. Runs BEFORE the "end at target" check. */
|
||||
final class Recorder {
|
||||
|
||||
/**
|
||||
* Never throws. Idempotent (atomic UPDATE ... WHERE reached_at IS NULL per tier). Test donations (goal_id 0) are skipped.
|
||||
*
|
||||
* @return int[] ids of the tiers this call unlocked.
|
||||
*/
|
||||
public static function forDonation( int $donationId ): array {
|
||||
try {
|
||||
global $wpdb;
|
||||
$row = $wpdb->get_row( $wpdb->prepare( 'SELECT id, goal_id, status FROM ' . $wpdb->prefix . 'sg_donations WHERE id = %d', $donationId ), ARRAY_A );
|
||||
if ( ! is_array( $row ) || 'completed' !== ( $row['status'] ?? '' ) || (int) $row['goal_id'] <= 0 ) {
|
||||
return array();
|
||||
}
|
||||
$goalId = (int) $row['goal_id'];
|
||||
$repo = new TierRepository( $wpdb );
|
||||
if ( ! $repo->forGoal( $goalId ) ) {
|
||||
return array();
|
||||
}
|
||||
$raised = ( new \StreamGoals\Core\GoalRepository( $wpdb ) )->raised_minor( $goalId );
|
||||
return $repo->markReached( $goalId, $raised, $donationId );
|
||||
} catch ( \Throwable $e ) {
|
||||
error_log( 'StreamGoals: tier unlock failed for donation ' . $donationId . ': ' . $e->getMessage() ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions
|
||||
return array();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,179 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tiers;
|
||||
|
||||
/**
|
||||
* Pure rules for goal tiers (milestones). No WordPress / database access.
|
||||
* A tier row is an array with keys: id, target_minor, title, description, reached_at (null|string), reached_donation_id.
|
||||
*/
|
||||
final class TierPolicy {
|
||||
|
||||
public const TITLE_MAX = 120;
|
||||
public const DESC_MAX = 255;
|
||||
|
||||
/** Tiers ordered by target ascending (ties by id). Non-array entries are dropped. @return array[] */
|
||||
public static function sorted( array $tiers ): array {
|
||||
$tiers = array_values( array_filter( $tiers, 'is_array' ) );
|
||||
usort(
|
||||
$tiers,
|
||||
static fn( array $a, array $b ): int => ( (int) $a['target_minor'] <=> (int) $b['target_minor'] ) ?: ( (int) ( $a['id'] ?? 0 ) <=> (int) ( $b['id'] ?? 0 ) )
|
||||
);
|
||||
return $tiers;
|
||||
}
|
||||
|
||||
public static function isReached( array $tier ): bool {
|
||||
return ! empty( $tier['reached_at'] );
|
||||
}
|
||||
|
||||
/** The first tier (by target) that is not reached yet, or null (no tiers, or all reached). */
|
||||
public static function currentTier( array $tiers ): ?array {
|
||||
foreach ( self::sorted( $tiers ) as $t ) {
|
||||
if ( ! self::isReached( $t ) ) {
|
||||
return $t;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/** True when there is at least one tier and every tier is reached. */
|
||||
public static function allReached( array $tiers ): bool {
|
||||
return $tiers && null === self::currentTier( $tiers );
|
||||
}
|
||||
|
||||
/** 1-based position of the current tier; when all are reached, the count; 0 without tiers. */
|
||||
public static function currentIndex( array $tiers ): int {
|
||||
$sorted = self::sorted( $tiers );
|
||||
foreach ( $sorted as $i => $t ) {
|
||||
if ( ! self::isReached( $t ) ) {
|
||||
return $i + 1;
|
||||
}
|
||||
}
|
||||
return count( $sorted );
|
||||
}
|
||||
|
||||
/** Start of the current tier's range: the previous tier's target (0 for the first / when none is current). */
|
||||
public static function floorMinor( array $tiers ): int {
|
||||
$prev = 0;
|
||||
foreach ( self::sorted( $tiers ) as $t ) {
|
||||
if ( ! self::isReached( $t ) ) {
|
||||
return $prev;
|
||||
}
|
||||
$prev = (int) $t['target_minor'];
|
||||
}
|
||||
return $prev; // all reached: the top tier's target
|
||||
}
|
||||
|
||||
/** Progress inside a tier, 0..100 (clamped). Below the floor = 0, at or above the target = 100. */
|
||||
public static function percent( int $raised, int $floor, int $target ): int {
|
||||
if ( $target <= $floor ) {
|
||||
return $raised >= $target && $target > 0 ? 100 : 0;
|
||||
}
|
||||
$p = intdiv( ( $raised - $floor ) * 100, $target - $floor );
|
||||
return max( 0, min( 100, $p ) );
|
||||
}
|
||||
|
||||
/** Percent within the current tier for the given tiers and raised total (100 when all reached, 0 without tiers). */
|
||||
public static function percentFor( array $tiers, int $raised ): int {
|
||||
$cur = self::currentTier( $tiers );
|
||||
if ( null === $cur ) {
|
||||
return $tiers ? 100 : 0;
|
||||
}
|
||||
return self::percent( $raised, self::floorMinor( $tiers ), (int) $cur['target_minor'] );
|
||||
}
|
||||
|
||||
/** Money still needed to reach the current tier (0 when none). */
|
||||
public static function remainingMinor( array $tiers, int $raised ): int {
|
||||
$cur = self::currentTier( $tiers );
|
||||
return null === $cur ? 0 : max( 0, (int) $cur['target_minor'] - $raised );
|
||||
}
|
||||
|
||||
/** Every unreached tier whose target is at or below the raised total, in target order. A big donation can unlock several. @return array[] */
|
||||
public static function newlyReached( array $tiers, int $raised ): array {
|
||||
$out = array();
|
||||
foreach ( self::sorted( $tiers ) as $t ) {
|
||||
if ( ! self::isReached( $t ) && (int) $t['target_minor'] <= $raised ) {
|
||||
$out[] = $t;
|
||||
}
|
||||
}
|
||||
return $out;
|
||||
}
|
||||
|
||||
/** The goal's target when it has tiers: the highest tier target (0 when no tiers). */
|
||||
public static function derivedGoalTarget( array $tiers ): int {
|
||||
$max = 0;
|
||||
foreach ( $tiers as $t ) {
|
||||
$max = max( $max, (int) ( $t['target_minor'] ?? 0 ) );
|
||||
}
|
||||
return $max;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate a tier form submission.
|
||||
*
|
||||
* @param array $tiers All tiers of the goal (including the one being edited).
|
||||
* @param int|null $editId Tier id when editing, null when adding.
|
||||
* @param int|null $target Parsed target in minor units (null = not a valid amount).
|
||||
* @param int $raised Goal raised total (minor units).
|
||||
* @param int $minMinor Settings::effectiveMin().
|
||||
* @return array{data:?array{target_minor:int,title:string,description:string},error:?string}
|
||||
*/
|
||||
public static function validate( array $tiers, ?int $editId, ?int $target, string $title, string $description, int $raised, int $minMinor, string $minLabel = '' ): array {
|
||||
$fail = static fn( string $m ): array => array( 'data' => null, 'error' => $m );
|
||||
$title = trim( $title );
|
||||
$desc = trim( $description );
|
||||
if ( '' === $title ) {
|
||||
return $fail( 'Please name what unlocks at this tier, for example "New microphone".' );
|
||||
}
|
||||
if ( self::len( $title ) > self::TITLE_MAX ) {
|
||||
return $fail( 'The title can be at most ' . self::TITLE_MAX . ' characters.' );
|
||||
}
|
||||
if ( self::len( $desc ) > self::DESC_MAX ) {
|
||||
return $fail( 'The description can be at most ' . self::DESC_MAX . ' characters.' );
|
||||
}
|
||||
$existing = null;
|
||||
if ( null !== $editId ) {
|
||||
foreach ( $tiers as $t ) {
|
||||
if ( (int) ( $t['id'] ?? 0 ) === $editId ) {
|
||||
$existing = $t;
|
||||
}
|
||||
}
|
||||
if ( null === $existing ) {
|
||||
return $fail( 'That tier no longer exists.' );
|
||||
}
|
||||
}
|
||||
if ( null !== $existing && self::isReached( $existing ) ) {
|
||||
// Reached tiers: the target is locked, only the text can change.
|
||||
return array( 'data' => array( 'target_minor' => (int) $existing['target_minor'], 'title' => $title, 'description' => $desc ), 'error' => null );
|
||||
}
|
||||
if ( null === $target || $target <= 0 ) {
|
||||
return $fail( 'Please enter a target greater than zero, for example 250.00.' );
|
||||
}
|
||||
if ( $target < $minMinor ) {
|
||||
return $fail( 'The target must be at least the minimum donation' . ( '' !== $minLabel ? ' (' . $minLabel . ')' : '' ) . '.' );
|
||||
}
|
||||
foreach ( $tiers as $t ) {
|
||||
if ( (int) ( $t['id'] ?? 0 ) !== (int) $editId && (int) $t['target_minor'] === $target ) {
|
||||
return $fail( 'Another tier already has that target. Each tier needs its own amount.' );
|
||||
}
|
||||
}
|
||||
$unchanged = null !== $existing && (int) $existing['target_minor'] === $target;
|
||||
if ( ! $unchanged && $target <= $raised ) {
|
||||
return $fail( 'This goal has already raised more than that, so the tier would unlock instantly. Choose a target above the current total.' );
|
||||
}
|
||||
return array( 'data' => array( 'target_minor' => $target, 'title' => $title, 'description' => $desc ), 'error' => null );
|
||||
}
|
||||
|
||||
/** Display status of a tier given the sorted list: 'reached' | 'current' | 'upcoming'. */
|
||||
public static function status( array $tiers, array $tier ): string {
|
||||
if ( self::isReached( $tier ) ) {
|
||||
return 'reached';
|
||||
}
|
||||
$cur = self::currentTier( $tiers );
|
||||
return $cur && (int) $cur['id'] === (int) $tier['id'] ? 'current' : 'upcoming';
|
||||
}
|
||||
|
||||
private static function len( string $s ): int {
|
||||
return function_exists( 'mb_strlen' ) ? mb_strlen( $s ) : strlen( $s );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,151 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tiers;
|
||||
|
||||
/** $wpdb access to sg_goal_tiers (and keeping sg_goals.target_minor in step). */
|
||||
final class TierRepository {
|
||||
|
||||
private object $db;
|
||||
|
||||
public function __construct( ?object $db = null ) {
|
||||
$this->db = $db ?? $GLOBALS['wpdb'];
|
||||
}
|
||||
|
||||
private function t( string $name ): string {
|
||||
return $this->db->prefix . 'sg_' . $name;
|
||||
}
|
||||
|
||||
/** @return array{id:int,goal_id:int,target_minor:int,title:string,description:string,reached_at:?string,reached_donation_id:?int,created_at:string} */
|
||||
private static function cast( array $r ): array {
|
||||
return array(
|
||||
'id' => (int) ( $r['id'] ?? 0 ),
|
||||
'goal_id' => (int) ( $r['goal_id'] ?? 0 ),
|
||||
'target_minor' => (int) ( $r['target_minor'] ?? 0 ),
|
||||
'title' => (string) ( $r['title'] ?? '' ),
|
||||
'description' => (string) ( $r['description'] ?? '' ),
|
||||
'reached_at' => isset( $r['reached_at'] ) && '' !== (string) $r['reached_at'] ? (string) $r['reached_at'] : null,
|
||||
'reached_donation_id' => isset( $r['reached_donation_id'] ) && null !== $r['reached_donation_id'] ? (int) $r['reached_donation_id'] : null,
|
||||
'created_at' => (string) ( $r['created_at'] ?? '' ),
|
||||
);
|
||||
}
|
||||
|
||||
/** Tiers of a goal ordered by target ascending. @return array[] */
|
||||
public function forGoal( int $goalId ): array {
|
||||
$rows = $this->db->get_results(
|
||||
$this->db->prepare( 'SELECT * FROM ' . $this->t( 'goal_tiers' ) . ' WHERE goal_id = %d ORDER BY target_minor ASC, id ASC', $goalId ),
|
||||
ARRAY_A
|
||||
);
|
||||
return array_map( array( self::class, 'cast' ), (array) $rows );
|
||||
}
|
||||
|
||||
public function find( int $id ): ?array {
|
||||
$row = $this->db->get_row( $this->db->prepare( 'SELECT * FROM ' . $this->t( 'goal_tiers' ) . ' WHERE id = %d', $id ), ARRAY_A );
|
||||
return $row ? self::cast( $row ) : null;
|
||||
}
|
||||
|
||||
/** Tier counts per goal id (one query) for the goals list. @return array<int,int> */
|
||||
public function countsByGoal(): array {
|
||||
$rows = $this->db->get_results( 'SELECT goal_id, COUNT(*) AS n FROM ' . $this->t( 'goal_tiers' ) . ' GROUP BY goal_id', ARRAY_A );
|
||||
$out = array();
|
||||
foreach ( (array) $rows as $r ) {
|
||||
$out[ (int) $r['goal_id'] ] = (int) $r['n'];
|
||||
}
|
||||
return $out;
|
||||
}
|
||||
|
||||
/** @param array{target_minor:int,title:string,description:string} $d @return int new id (0 on failure, e.g. duplicate target) */
|
||||
public function create( int $goalId, array $d ): int {
|
||||
$ok = $this->db->insert(
|
||||
$this->t( 'goal_tiers' ),
|
||||
array(
|
||||
'goal_id' => $goalId,
|
||||
'target_minor' => (int) $d['target_minor'],
|
||||
'title' => (string) $d['title'],
|
||||
'description' => (string) $d['description'],
|
||||
'created_at' => gmdate( 'Y-m-d H:i:s' ),
|
||||
),
|
||||
array( '%d', '%d', '%s', '%s', '%s' )
|
||||
);
|
||||
return $ok ? (int) $this->db->insert_id : 0;
|
||||
}
|
||||
|
||||
public function update( int $id, int $goalId, array $d ): void {
|
||||
$this->db->update(
|
||||
$this->t( 'goal_tiers' ),
|
||||
array( 'target_minor' => (int) $d['target_minor'], 'title' => (string) $d['title'], 'description' => (string) $d['description'] ),
|
||||
array( 'id' => $id, 'goal_id' => $goalId ),
|
||||
array( '%d', '%s', '%s' ),
|
||||
array( '%d', '%d' )
|
||||
);
|
||||
}
|
||||
|
||||
public function delete( int $id, int $goalId ): void {
|
||||
$this->db->delete( $this->t( 'goal_tiers' ), array( 'id' => $id, 'goal_id' => $goalId ), array( '%d', '%d' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark every unreached tier of the goal with target <= $raised as reached by $donationId. One atomic
|
||||
* UPDATE per tier (WHERE reached_at IS NULL): replays and concurrent callers cannot re-mark a tier.
|
||||
*
|
||||
* @return int[] ids of the tiers THIS call marked.
|
||||
*/
|
||||
public function markReached( int $goalId, int $raised, int $donationId ): array {
|
||||
$marked = array();
|
||||
if ( $goalId <= 0 || $donationId <= 0 ) {
|
||||
return $marked;
|
||||
}
|
||||
$now = gmdate( 'Y-m-d H:i:s' );
|
||||
foreach ( TierPolicy::newlyReached( $this->forGoal( $goalId ), $raised ) as $tier ) {
|
||||
$n = $this->db->query(
|
||||
$this->db->prepare(
|
||||
'UPDATE ' . $this->t( 'goal_tiers' ) . ' SET reached_at = %s, reached_donation_id = %d WHERE id = %d AND reached_at IS NULL',
|
||||
$now,
|
||||
$donationId,
|
||||
(int) $tier['id']
|
||||
)
|
||||
);
|
||||
if ( 1 === (int) $n ) {
|
||||
$marked[] = (int) $tier['id'];
|
||||
}
|
||||
}
|
||||
return $marked;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tiers unlocked by each donation, one query for the whole page: donation id => [ {title}, ... ] in target order.
|
||||
*
|
||||
* @param int[] $donationIds
|
||||
* @return array<int,array<int,array{title:string}>>
|
||||
*/
|
||||
public function reachedByDonation( array $donationIds ): array {
|
||||
$ids = array_values( array_unique( array_filter( array_map( 'intval', $donationIds ), static fn( $i ) => $i > 0 ) ) );
|
||||
if ( ! $ids ) {
|
||||
return array();
|
||||
}
|
||||
$in = implode( ',', array_fill( 0, count( $ids ), '%d' ) );
|
||||
$rows = $this->db->get_results(
|
||||
$this->db->prepare( 'SELECT reached_donation_id, title FROM ' . $this->t( 'goal_tiers' ) . " WHERE reached_donation_id IN ($in) ORDER BY target_minor ASC, id ASC", ...$ids ),
|
||||
ARRAY_A
|
||||
);
|
||||
$out = array();
|
||||
foreach ( (array) $rows as $r ) {
|
||||
$out[ (int) $r['reached_donation_id'] ][] = array( 'title' => (string) $r['title'] );
|
||||
}
|
||||
return $out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Keep sg_goals.target_minor equal to the highest tier target. Leaves the goal untouched when it has no tiers.
|
||||
*
|
||||
* @return bool true when the goal row was set from tiers.
|
||||
*/
|
||||
public function syncGoalTarget( int $goalId ): bool {
|
||||
$max = $this->db->get_var( $this->db->prepare( 'SELECT MAX(target_minor) FROM ' . $this->t( 'goal_tiers' ) . ' WHERE goal_id = %d', $goalId ) );
|
||||
if ( null === $max || (int) $max <= 0 ) {
|
||||
return false;
|
||||
}
|
||||
$this->db->query( $this->db->prepare( 'UPDATE ' . $this->t( 'goals' ) . ' SET target_minor = %d WHERE id = %d', (int) $max, $goalId ) );
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Alerts\DefInput;
|
||||
|
||||
final class AlertDefInputTest extends TestCase {
|
||||
|
||||
private function att(): callable {
|
||||
$files = array(
|
||||
10 => array( 'mime' => 'image/gif', 'size' => 1000 ),
|
||||
11 => array( 'mime' => 'video/mp4', 'size' => 30 * 1024 * 1024 ),
|
||||
12 => array( 'mime' => 'audio/mpeg', 'size' => 5000 ),
|
||||
13 => array( 'mime' => 'image/svg+xml', 'size' => 10 ),
|
||||
14 => array( 'mime' => 'text/html', 'size' => 10 ),
|
||||
15 => array( 'mime' => 'image/png', 'size' => 10 ),
|
||||
);
|
||||
return static fn( int $id ): ?array => $files[ $id ] ?? null;
|
||||
}
|
||||
|
||||
private function post( array $o = array() ): array {
|
||||
return $o + array( 'title' => 'Big', 'goal_id' => '0', 'trigger_type' => 'amount', 'amount' => '10.00', 'visual_id' => '10', 'sound_id' => '12',
|
||||
'volume' => '70', 'duration' => '8', 'message' => '{name} sent {amount}', 'sort' => '' );
|
||||
}
|
||||
|
||||
private function run_( array $post, int $min = 100 ): array {
|
||||
return DefInput::validate( $post, $min, 'USD', array( 3 ), array( 5 ), $this->att(), 40 );
|
||||
}
|
||||
|
||||
public function test_valid_amount_def(): void {
|
||||
$r = $this->run_( $this->post() );
|
||||
$this->assertNull( $r['error'] );
|
||||
$d = $r['data'];
|
||||
$this->assertSame( array( 0, 'amount', 1000, 0, 10, 'image', 12, 70, 8000, 40 ), array( $d['goal_id'], $d['trigger_type'], $d['min_minor'], $d['action_id'], $d['visual_id'], $d['visual_type'], $d['sound_id'], $d['volume'], $d['duration_ms'], $d['sort'] ) );
|
||||
$this->assertSame( array(), $r['warnings'] );
|
||||
}
|
||||
|
||||
public function test_valid_reward_def_ignores_amount(): void {
|
||||
$r = $this->run_( $this->post( array( 'trigger_type' => 'reward', 'action_id' => '5', 'amount' => '' ) ) );
|
||||
$this->assertNull( $r['error'] );
|
||||
$this->assertSame( array( 'reward', 0, 5 ), array( $r['data']['trigger_type'], $r['data']['min_minor'], $r['data']['action_id'] ) );
|
||||
}
|
||||
|
||||
public function test_reward_must_be_enabled_one(): void {
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'trigger_type' => 'reward', 'action_id' => '6' ) ) )['error'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'trigger_type' => 'reward', 'action_id' => '0' ) ) )['error'] );
|
||||
}
|
||||
|
||||
public function test_amount_must_reach_effective_minimum(): void {
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'amount' => '0.50' ) ), 100 )['error'] );
|
||||
$this->assertNull( $this->run_( $this->post( array( 'amount' => '1.00' ) ), 100 )['error'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'amount' => 'abc' ) ) )['error'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'amount' => '' ) ) )['error'] );
|
||||
}
|
||||
|
||||
public function test_rejects_bad_mime_and_missing_attachments(): void {
|
||||
foreach ( array( 13, 14, 12, 99 ) as $bad ) {
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'visual_id' => (string) $bad ) ) )['error'], "visual $bad" );
|
||||
}
|
||||
foreach ( array( 13, 10, 11, 99 ) as $bad ) {
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'sound_id' => (string) $bad ) ) )['error'], "sound $bad" );
|
||||
}
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'visual_id' => 'x' ) ) )['error'] );
|
||||
}
|
||||
|
||||
public function test_media_is_optional_and_type_is_detected_server_side(): void {
|
||||
$r = $this->run_( $this->post( array( 'visual_id' => '0', 'sound_id' => '0', 'visual_type' => 'video' ) ) );
|
||||
$this->assertSame( array( 0, '', 0 ), array( $r['data']['visual_id'], $r['data']['visual_type'], $r['data']['sound_id'] ) );
|
||||
$r = $this->run_( $this->post( array( 'visual_id' => '15', 'visual_type' => 'video' ) ) );
|
||||
$this->assertSame( 'image', $r['data']['visual_type'], 'client-supplied type is ignored' );
|
||||
}
|
||||
|
||||
public function test_big_files_warn_but_do_not_block(): void {
|
||||
$r = $this->run_( $this->post( array( 'visual_id' => '11' ) ) );
|
||||
$this->assertNull( $r['error'] );
|
||||
$this->assertSame( 'video', $r['data']['visual_type'] );
|
||||
$this->assertCount( 1, $r['warnings'] );
|
||||
$this->assertStringContainsString( 'OBS', $r['warnings'][0] );
|
||||
}
|
||||
|
||||
public function test_numeric_ranges(): void {
|
||||
foreach ( array( '-1', '101', 'x' ) as $v ) {
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'volume' => $v ) ) )['error'], "volume $v" );
|
||||
}
|
||||
$this->assertSame( 0, $this->run_( $this->post( array( 'volume' => '0' ) ) )['data']['volume'] );
|
||||
foreach ( array( '0', '61', '0.5', 'x', '' , '-2' ) as $v ) {
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'duration' => $v ) ) )['error'], "duration '$v'" );
|
||||
}
|
||||
$this->assertSame( 60000, $this->run_( $this->post( array( 'duration' => '60' ) ) )['data']['duration_ms'] );
|
||||
$this->assertSame( 1000, $this->run_( $this->post( array( 'duration' => '1' ) ) )['data']['duration_ms'] );
|
||||
}
|
||||
|
||||
public function test_title_goal_message_sort(): void {
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'title' => ' ' ) ) )['error'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'title' => str_repeat( 'a', 121 ) ) ) )['error'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'goal_id' => '99' ) ) )['error'] );
|
||||
$this->assertSame( 3, $this->run_( $this->post( array( 'goal_id' => '3' ) ) )['data']['goal_id'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'trigger_type' => 'nope' ) ) )['error'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'message' => str_repeat( 'm', 256 ) ) ) )['error'] );
|
||||
$this->assertNotNull( $this->run_( $this->post( array( 'sort' => '100000' ) ) )['error'] );
|
||||
$this->assertStringNotContainsString( '<', $this->run_( $this->post( array( 'title' => '<script>x</script>Hi', 'message' => '<b>hi</b>' ) ) )['data']['title'] );
|
||||
$this->assertStringNotContainsString( '<', $this->run_( $this->post( array( 'message' => '<b>hi</b>{name}' ) ) )['data']['message'] );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Alerts\Media;
|
||||
use StreamGoals\Alerts\Template;
|
||||
|
||||
final class AlertHelpersTest extends TestCase {
|
||||
|
||||
public function test_mime_whitelist_and_kinds(): void {
|
||||
foreach ( array( 'image/png', 'image/jpeg', 'image/gif', 'image/webp' ) as $m ) {
|
||||
$this->assertSame( 'image', Media::kind( $m ) );
|
||||
$this->assertSame( 'image', Media::visualType( $m ) );
|
||||
}
|
||||
foreach ( array( 'video/mp4', 'video/webm' ) as $m ) {
|
||||
$this->assertSame( 'video', Media::visualType( $m ) );
|
||||
}
|
||||
foreach ( array( 'audio/mpeg', 'audio/ogg', 'audio/wav' ) as $m ) {
|
||||
$this->assertTrue( Media::isSound( $m ) );
|
||||
$this->assertNull( Media::visualType( $m ) );
|
||||
}
|
||||
$this->assertTrue( Media::isAllowed( 'IMAGE/PNG' ) );
|
||||
}
|
||||
|
||||
/** @dataProvider hostileMimes */
|
||||
public function test_hostile_mimes_rejected( mixed $mime ): void {
|
||||
$this->assertFalse( Media::isAllowed( $mime ) );
|
||||
$this->assertNull( Media::visualType( $mime ) );
|
||||
$this->assertFalse( Media::isSound( $mime ) );
|
||||
}
|
||||
|
||||
public static function hostileMimes(): array {
|
||||
return array(
|
||||
array( 'image/svg+xml' ), array( 'text/html' ), array( 'application/javascript' ), array( '' ), array( null ), array( 123 ),
|
||||
array( array( 'image/png' ) ), array( 'image/png; charset=x' ), array( "image/png\0.html" ), array( ' image/png' ), array( 'image/*' ),
|
||||
array( 'video/x-msvideo' ), array( 'audio/x-wav' ), array( 'image/png,text/html' ),
|
||||
);
|
||||
}
|
||||
|
||||
public function test_duration_clamping(): void {
|
||||
$this->assertSame( 6000, Media::clampDurationMs( 'abc' ) );
|
||||
$this->assertSame( 1000, Media::clampDurationMs( 5 ) );
|
||||
$this->assertSame( 1000, Media::clampDurationMs( -9999 ) );
|
||||
$this->assertSame( 60000, Media::clampDurationMs( 9999999 ) );
|
||||
$this->assertSame( 12000, Media::clampDurationMs( '12000' ) );
|
||||
$this->assertSame( 8000, Media::secondsToMs( '8' ) );
|
||||
$this->assertSame( 1500, Media::secondsToMs( '1.5' ) );
|
||||
$this->assertNull( Media::secondsToMs( 'x' ) );
|
||||
$this->assertNull( Media::secondsToMs( '-3' ) );
|
||||
$this->assertNull( Media::secondsToMs( array() ) );
|
||||
$this->assertSame( 100, Media::clampVolume( 500 ) );
|
||||
$this->assertSame( 0, Media::clampVolume( -5 ) );
|
||||
$this->assertSame( 80, Media::clampVolume( 'loud' ) );
|
||||
}
|
||||
|
||||
public function test_safe_url(): void {
|
||||
$this->assertSame( 'https://x.test/a.png', Media::safeUrl( 'https://x.test/a.png' ) );
|
||||
foreach ( array( 'javascript:alert(1)', 'data:text/html,x', '//evil.test/x', '/relative.png', 'https://x.test/a b', "https://x.test/\"onerror=", '', null, 5 ) as $bad ) {
|
||||
$this->assertNull( Media::safeUrl( $bad ), var_export( $bad, true ) );
|
||||
}
|
||||
}
|
||||
|
||||
public function test_template_tokens(): void {
|
||||
$this->assertSame( 'Al sent $5.00 for Bean!', Template::render( '{name} sent {amount} for {reward}!', 'Al', '$5.00', 'Bean' ) );
|
||||
$this->assertSame( 'Al sent', Template::render( '{Name} {nope} sent', 'Al', '$5', '' ), 'unknown tokens dropped, case-insensitive' );
|
||||
$this->assertSame( '', Template::render( '', 'Al', '$5', '' ) );
|
||||
$this->assertSame( '', Template::render( ' ', 'Al', '$5', '' ) );
|
||||
$this->assertSame( 'Anonymous rocks', Template::render( '{name} rocks', '', '$5', '' ) );
|
||||
}
|
||||
|
||||
public function test_template_is_html_free_and_not_reexpanded(): void {
|
||||
$out = Template::render( '<b>{name}</b><script>alert(1)</script> {amount}', '<img src=x onerror=alert(1)>Al', '$5', '' );
|
||||
$this->assertStringNotContainsString( '<', $out );
|
||||
$this->assertStringNotContainsString( '>', $out );
|
||||
$this->assertStringContainsString( 'Al', $out );
|
||||
$this->assertSame( '{amount} 5', Template::render( '{name} {amount}', '{amount}', '5', '' ) );
|
||||
$this->assertStringNotContainsString( '9', Template::render( '{name}', 'x{amount}', '9', '' ) );
|
||||
$this->assertStringNotContainsString( "\n", Template::render( "a\r\n\t{name}\x00\u{202E}", 'Al', '$5', '' ) );
|
||||
$this->assertStringNotContainsString( '<', Template::render( '<<b>script>x', 'Al', '$5', '' ) );
|
||||
}
|
||||
|
||||
public function test_template_length_capped(): void {
|
||||
$this->assertLessThanOrEqual( 200, mb_strlen( Template::render( str_repeat( 'x', 5000 ), 'Al', '$5', '' ) ) );
|
||||
$long = str_repeat( 'N', 500 );
|
||||
$this->assertLessThanOrEqual( 60, mb_strlen( Template::render( '{name}', $long, '$5', '' ) ) );
|
||||
$this->assertLessThanOrEqual( 80, mb_strlen( Template::render( '{reward}', 'Al', '$5', $long ) ) );
|
||||
$this->assertLessThanOrEqual( 10, mb_strlen( Template::render( str_repeat( 'x', 50 ), 'Al', '$5', '', 10 ) ) );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Alerts\Resolver;
|
||||
|
||||
final class AlertResolverTest extends TestCase {
|
||||
|
||||
private function def( int $id, array $o = array() ): array {
|
||||
return $o + array( 'id' => $id, 'goal_id' => 0, 'trigger_type' => 'amount', 'min_minor' => 100, 'action_id' => 0, 'enabled' => 1, 'sort' => 0 );
|
||||
}
|
||||
|
||||
public function test_highest_matching_amount_wins(): void {
|
||||
$defs = array( $this->def( 1, array( 'min_minor' => 100 ) ), $this->def( 2, array( 'min_minor' => 1000 ) ), $this->def( 3, array( 'min_minor' => 5000 ) ) );
|
||||
$this->assertSame( 2, Resolver::pick( 1, 1000, array(), $defs )['id'] );
|
||||
$this->assertSame( 2, Resolver::pick( 1, 4999, array(), $defs )['id'] );
|
||||
$this->assertSame( 3, Resolver::pick( 1, 99999, array(), $defs )['id'] );
|
||||
$this->assertSame( 1, Resolver::pick( 1, 100, array(), $defs )['id'] );
|
||||
}
|
||||
|
||||
public function test_none_when_below_every_minimum_or_no_defs(): void {
|
||||
$this->assertNull( Resolver::pick( 1, 99, array(), array( $this->def( 1 ) ) ) );
|
||||
$this->assertNull( Resolver::pick( 1, 5000, array(), array() ) );
|
||||
}
|
||||
|
||||
public function test_reward_beats_amount(): void {
|
||||
$defs = array( $this->def( 1, array( 'min_minor' => 100 ) ), $this->def( 2, array( 'trigger_type' => 'reward', 'action_id' => 9 ) ) );
|
||||
$this->assertSame( 2, Resolver::pick( 1, 5000, array( 9 ), $defs )['id'] );
|
||||
$this->assertSame( 1, Resolver::pick( 1, 5000, array( 8 ), $defs )['id'], 'other reward does not match' );
|
||||
$this->assertSame( 1, Resolver::pick( 1, 5000, array(), $defs )['id'] );
|
||||
}
|
||||
|
||||
public function test_reward_def_matches_even_when_base_is_tiny(): void {
|
||||
$defs = array( $this->def( 2, array( 'trigger_type' => 'reward', 'action_id' => 9, 'min_minor' => 0 ) ) );
|
||||
$this->assertSame( 2, Resolver::pick( 1, 1, array( 9 ), $defs )['id'] );
|
||||
}
|
||||
|
||||
public function test_several_rewards_highest_reward_amount_then_sort_then_id(): void {
|
||||
$defs = array(
|
||||
$this->def( 1, array( 'trigger_type' => 'reward', 'action_id' => 5, 'sort' => 0 ) ),
|
||||
$this->def( 2, array( 'trigger_type' => 'reward', 'action_id' => 6, 'sort' => 9 ) ),
|
||||
);
|
||||
$this->assertSame( 2, Resolver::pick( 1, 5000, array( 5, 6 ), $defs, array( 5 => 500, 6 => 2500 ) )['id'] );
|
||||
$this->assertSame( 1, Resolver::pick( 1, 5000, array( 5, 6 ), $defs, array( 5 => 500, 6 => 500 ) )['id'], 'tie: lower sort' );
|
||||
$defs[1]['sort'] = 0;
|
||||
$this->assertSame( 1, Resolver::pick( 1, 5000, array( 5, 6 ), $defs )['id'], 'tie: lower id' );
|
||||
}
|
||||
|
||||
public function test_goal_scoping(): void {
|
||||
$defs = array( $this->def( 1, array( 'goal_id' => 7, 'min_minor' => 100 ) ), $this->def( 2, array( 'goal_id' => 0, 'min_minor' => 100, 'sort' => 5 ) ) );
|
||||
$this->assertSame( 1, Resolver::pick( 7, 500, array(), $defs )['id'] );
|
||||
$this->assertSame( 2, Resolver::pick( 8, 500, array(), $defs )['id'], 'goal 8 never sees goal 7 defs' );
|
||||
$this->assertSame( 2, Resolver::pick( 0, 500, array(), $defs )['id'], 'test donations (goal 0) use goal-0 defs only' );
|
||||
$only7 = array( $defs[0] );
|
||||
$this->assertNull( Resolver::pick( 0, 500, array(), $only7 ) );
|
||||
}
|
||||
|
||||
public function test_disabled_ignored(): void {
|
||||
$defs = array( $this->def( 1, array( 'enabled' => 0, 'min_minor' => 1000 ) ), $this->def( 2, array( 'min_minor' => 100 ) ),
|
||||
$this->def( 3, array( 'trigger_type' => 'reward', 'action_id' => 9, 'enabled' => 0 ) ) );
|
||||
$this->assertSame( 2, Resolver::pick( 1, 5000, array( 9 ), $defs )['id'] );
|
||||
}
|
||||
|
||||
public function test_string_columns_from_db_are_handled_and_unknown_trigger_ignored(): void {
|
||||
$defs = array( array( 'id' => '4', 'goal_id' => '0', 'trigger_type' => 'amount', 'min_minor' => '500', 'enabled' => '1', 'sort' => '0' ),
|
||||
array( 'id' => '5', 'trigger_type' => 'bogus', 'enabled' => 1 ) );
|
||||
$this->assertSame( 4, Resolver::pick( 3, 500, array(), $defs )['id'] );
|
||||
}
|
||||
|
||||
public function test_equal_minimum_tie_breaks_by_sort_then_id(): void {
|
||||
$defs = array( $this->def( 1, array( 'sort' => 5 ) ), $this->def( 2, array( 'sort' => 1 ) ) );
|
||||
$this->assertSame( 2, Resolver::pick( 1, 500, array(), $defs )['id'] );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Admin\Input;
|
||||
use StreamGoals\Core\Settings;
|
||||
|
||||
final class DonationNoticeTest extends TestCase {
|
||||
|
||||
public function test_default_notice_says_donations_are_non_refundable(): void {
|
||||
$d = Settings::defaults();
|
||||
$this->assertArrayHasKey( 'donation_notice', $d );
|
||||
$this->assertStringContainsString( 'non-refundable', strtolower( (string) $d['donation_notice'] ) );
|
||||
}
|
||||
|
||||
public function test_admin_input_is_plain_text_and_length_capped(): void {
|
||||
$this->assertSame( 'No refunds, sorry.', Input::text( ' No refunds, sorry. ', 200 ) );
|
||||
$this->assertStringNotContainsString( '<', Input::text( '<script>alert(1)</script><b>Hi</b>', 200 ), 'no markup survives (and it is rendered as text anyway)' );
|
||||
$this->assertStringNotContainsString( '<', Input::text( '<b>Bold</b> <i>text</i>', 200 ) );
|
||||
$this->assertSame( 200, strlen( Input::text( str_repeat( 'a', 500 ), 200 ) ) );
|
||||
$this->assertSame( '', Input::text( "\x00\x1F", 200 ) );
|
||||
}
|
||||
|
||||
public function test_form_script_renders_the_notice_with_textcontent_only(): void {
|
||||
$js = (string) file_get_contents( dirname( __DIR__, 2 ) . '/assets/donate/donate.js' );
|
||||
$this->assertMatchesRegularExpression( '/if \(C\.notice\).*sg-notice.*text: String\(C\.notice\)/s', $js, 'notice must be rendered as text, never HTML' );
|
||||
$this->assertStringNotContainsString( 'innerHTML', $js );
|
||||
}
|
||||
|
||||
public function test_form_config_passes_the_notice_through(): void {
|
||||
$php = (string) file_get_contents( dirname( __DIR__, 2 ) . '/includes/Rest/DonateController.php' );
|
||||
$this->assertStringContainsString( "'notice' => (string) ( \$s['donation_notice'] ?? '' )", $php );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,172 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Alerts\AlertMedia;
|
||||
use StreamGoals\Overlay\ActionsSource;
|
||||
use StreamGoals\Overlay\AlertMediaSource;
|
||||
use StreamGoals\Overlay\OverlayDataSource;
|
||||
use StreamGoals\Overlay\OverlayService;
|
||||
use StreamGoals\Overlay\Payloads;
|
||||
use StreamGoals\Overlay\RecentDonationsSource;
|
||||
|
||||
final class OverlayAlertMediaTest extends TestCase {
|
||||
|
||||
private function def( int $id, array $o = array() ): array {
|
||||
return $o + array( 'id' => $id, 'goal_id' => 0, 'trigger_type' => 'amount', 'min_minor' => 100, 'action_id' => 0, 'visual_id' => 10, 'visual_type' => 'image',
|
||||
'sound_id' => 12, 'volume' => 60, 'duration_ms' => 7000, 'message' => '', 'enabled' => 1, 'sort' => 0 );
|
||||
}
|
||||
|
||||
private function row( int $id, array $o = array() ): array {
|
||||
return $o + array( 'id' => $id, 'goal_id' => 7, 'base_minor' => 2500, 'currency' => 'USD', 'donor_name' => 'Al', 'is_anonymous' => 0,
|
||||
'message' => '', 'status' => 'completed', 'moderation' => 'approved' );
|
||||
}
|
||||
|
||||
private function files(): array {
|
||||
return array(
|
||||
10 => array( 'url' => 'https://cdn.test/a.gif', 'mime' => 'image/gif' ),
|
||||
11 => array( 'url' => 'https://cdn.test/v.mp4', 'mime' => 'video/mp4' ),
|
||||
12 => array( 'url' => 'https://cdn.test/s.mp3', 'mime' => 'audio/mpeg' ),
|
||||
13 => array( 'url' => 'https://cdn.test/x.svg', 'mime' => 'image/svg+xml' ),
|
||||
14 => array( 'url' => 'javascript:alert(1)', 'mime' => 'image/png' ),
|
||||
);
|
||||
}
|
||||
|
||||
private function build( array $def, array $row = array(), array $triggered = array() ): ?array {
|
||||
$files = $this->files();
|
||||
return AlertMedia::build( $row ?: $this->row( 1 ), 'Al', '$25.00', array( $def ), $triggered, static fn( int $id ): ?array => $files[ $id ] ?? null );
|
||||
}
|
||||
|
||||
public function test_shape_for_image_and_sound(): void {
|
||||
$m = $this->build( $this->def( 1, array( 'message' => '{name} gave {amount}' ) ) );
|
||||
$this->assertSame( array(
|
||||
'visual' => array( 'type' => 'image', 'url' => 'https://cdn.test/a.gif' ),
|
||||
'sound' => array( 'url' => 'https://cdn.test/s.mp3' ),
|
||||
'volume' => 60,
|
||||
'duration_ms' => 7000,
|
||||
'message' => 'Al gave $25.00',
|
||||
), $m );
|
||||
}
|
||||
|
||||
public function test_video_duration_is_capped_and_type_comes_from_mime(): void {
|
||||
$m = $this->build( $this->def( 1, array( 'visual_id' => 11, 'visual_type' => 'image', 'duration_ms' => 2000 ) ) );
|
||||
$this->assertSame( 'video', $m['visual']['type'] );
|
||||
$this->assertSame( 30000, $m['duration_ms'] );
|
||||
$this->assertNull( $m['message'] );
|
||||
}
|
||||
|
||||
public function test_invalid_media_dropped_silently(): void {
|
||||
$m = $this->build( $this->def( 1, array( 'visual_id' => 13, 'sound_id' => 99 ) ) );
|
||||
$this->assertNull( $m, 'nothing usable and no message: plain alert' );
|
||||
$m = $this->build( $this->def( 1, array( 'visual_id' => 13, 'sound_id' => 12 ) ) );
|
||||
$this->assertNull( $m['visual'] );
|
||||
$this->assertSame( 'https://cdn.test/s.mp3', $m['sound']['url'] );
|
||||
$m = $this->build( $this->def( 1, array( 'visual_id' => 14, 'sound_id' => 0, 'message' => 'hi' ) ) );
|
||||
$this->assertNull( $m['visual'], 'non-http url dropped' );
|
||||
$this->assertSame( 'hi', $m['message'] );
|
||||
$this->assertNull( $this->build( $this->def( 1, array( 'sound_id' => 10, 'visual_id' => 12 ) ) ), 'wrong kinds in wrong slots' );
|
||||
}
|
||||
|
||||
public function test_urls_come_only_from_callback_not_from_def_or_row(): void {
|
||||
$def = $this->def( 1, array( 'url' => 'https://evil.test/x.png', 'visual_url' => 'https://evil.test/y.png' ) );
|
||||
$row = $this->row( 1, array( 'media' => array( 'visual' => array( 'type' => 'image', 'url' => 'https://evil.test/z.png' ) ) ) );
|
||||
$json = json_encode( $this->build( $def, $row ) );
|
||||
$this->assertStringNotContainsString( 'evil.test', (string) $json );
|
||||
$this->assertStringContainsString( 'cdn.test\/a.gif', (string) $json );
|
||||
$boom = AlertMedia::build( $this->row( 1 ), 'Al', '$1', array( $this->def( 1 ) ), array(), static function ( int $id ): ?array { throw new \RuntimeException( 'db' ); } );
|
||||
$this->assertNull( $boom );
|
||||
}
|
||||
|
||||
public function test_reward_token_and_reward_priority(): void {
|
||||
$trig = array( array( 'action_id' => 5, 'amount_minor' => 500, 'title' => 'Eat bean' ), array( 'action_id' => 6, 'amount_minor' => 2500, 'title' => 'Pushups' ) );
|
||||
$defs = array( $this->def( 1, array( 'message' => 'amt {reward}' ) ), $this->def( 2, array( 'trigger_type' => 'reward', 'action_id' => 5, 'message' => 'rw {reward}' ) ) );
|
||||
$files = $this->files();
|
||||
$m = AlertMedia::build( $this->row( 1 ), 'Al', '$25.00', $defs, $trig, static fn( int $id ): ?array => $files[ $id ] ?? null );
|
||||
$this->assertSame( 'rw Eat bean', $m['message'] );
|
||||
$m = AlertMedia::build( $this->row( 1 ), 'Al', '$25.00', array( $defs[0] ), $trig, static fn( int $id ): ?array => $files[ $id ] ?? null );
|
||||
$this->assertSame( 'amt Pushups', $m['message'], 'amount def gets the highest triggered reward' );
|
||||
}
|
||||
|
||||
/** Service-level: one defs query, one triggered query, goal 0 for tests, anonymity/moderation intact. */
|
||||
private function svc( array $defs, array $db, array $triggered = array() ): array {
|
||||
$src = new class( $defs, $db, $triggered, $this->files() ) implements OverlayDataSource, RecentDonationsSource, ActionsSource, AlertMediaSource {
|
||||
public int $defQueries = 0; public int $trigQueries = 0;
|
||||
public function __construct( public array $defs, private array $db, private array $trig, private array $files ) {}
|
||||
public function activeGoal(): ?array { return array( 'id' => 7, 'currency' => 'USD' ); }
|
||||
public function raisedMinor( array $goal ): int { return 0; }
|
||||
public function stateValue( int $goalId, string $key ): ?string { return null; }
|
||||
public function counter( int $goalId ): array { return array( 'label' => '', 'value' => 0 ); }
|
||||
public function bonusesFor( array $ids ): array { return array(); }
|
||||
public function donations( ?int $sinceId, int $limit ): array { return array_values( array_filter( $this->db, fn( $d ) => $d['id'] > (int) $sinceId ) ); }
|
||||
public function recentDonations( int $limit ): array { return $this->db; }
|
||||
public function menuActions( int $goalId ): array { return array(); }
|
||||
public function actionsFor( array $ids ): array { return array(); }
|
||||
public function alertDefs(): array { ++$this->defQueries; return $this->defs; }
|
||||
public function triggeredActionsFor( array $ids ): array { ++$this->trigQueries; return $this->trig; }
|
||||
public function attachment( int $id ): ?array { return $this->files[ $id ] ?? null; }
|
||||
};
|
||||
return array( new OverlayService( $src ), $src );
|
||||
}
|
||||
|
||||
public function test_payload_carries_media_in_recent_and_since_modes_with_single_queries(): void {
|
||||
[ $svc, $src ] = $this->svc( array( $this->def( 1 ) ), array( $this->row( 1 ), $this->row( 2 ), $this->row( 3, array( 'goal_id' => 0 ) ) ) );
|
||||
$out = $svc->payload( 'alerts', 1, null, true );
|
||||
$this->assertSame( 'https://cdn.test/a.gif', $out['alerts'][0]['media']['visual']['url'] );
|
||||
$this->assertSame( 1, $src->defQueries );
|
||||
$this->assertSame( 1, $src->trigQueries );
|
||||
[ $svc2 ] = $this->svc( array( $this->def( 1 ) ), array( $this->row( 1 ), $this->row( 2 ) ) );
|
||||
$this->assertSame( 60, $svc2->payload( 'alerts', 1, 0, false )['alerts'][1]['media']['volume'] );
|
||||
}
|
||||
|
||||
public function test_goal_scoping_in_payload_and_test_donations(): void {
|
||||
$defs = array( $this->def( 1, array( 'goal_id' => 7 ) ) );
|
||||
[ $svc ] = $this->svc( $defs, array( $this->row( 1 ), $this->row( 2, array( 'goal_id' => 0 ) ), $this->row( 3, array( 'goal_id' => 9 ) ) ) );
|
||||
$a = $svc->payload( 'alerts', 1, null, true )['alerts'];
|
||||
$this->assertNotNull( $a[0]['media'] );
|
||||
$this->assertNull( $a[1]['media'], 'test donation (goal 0) does not use goal-7 defs' );
|
||||
$this->assertNull( $a[2]['media'] );
|
||||
}
|
||||
|
||||
public function test_no_defs_means_media_null_and_no_trigger_query(): void {
|
||||
[ $svc, $src ] = $this->svc( array(), array( $this->row( 1 ) ) );
|
||||
$this->assertNull( $svc->payload( 'alerts', 1, null, true )['alerts'][0]['media'] );
|
||||
$this->assertSame( 0, $src->trigQueries );
|
||||
}
|
||||
|
||||
public function test_moderation_and_anonymity_unchanged(): void {
|
||||
$rows = array( $this->row( 1, array( 'is_anonymous' => 1, 'donor_name' => 'Secret' ) ), $this->row( 2, array( 'moderation' => 'pending' ) ) );
|
||||
[ $svc ] = $this->svc( array( $this->def( 1, array( 'message' => '{name}!' ) ) ), $rows );
|
||||
$a = $svc->payload( 'alerts', 1, null, true )['alerts'];
|
||||
$this->assertCount( 1, $a );
|
||||
$this->assertSame( 'Anonymous', $a[0]['name'] );
|
||||
$this->assertSame( 'Anonymous!', $a[0]['media']['message'] );
|
||||
$this->assertStringNotContainsString( 'Secret', (string) json_encode( $a ) );
|
||||
}
|
||||
|
||||
public function test_etag_changes_with_media_definitions_even_without_alerts(): void {
|
||||
[ $a ] = $this->svc( array( $this->def( 1 ) ), array() );
|
||||
[ $b ] = $this->svc( array( $this->def( 1, array( 'volume' => 10 ) ) ), array() );
|
||||
[ $none ] = $this->svc( array(), array() );
|
||||
$pa = $a->payload( 'alerts', 1, 0, false );
|
||||
$ea = Payloads::etag( $pa, $a->etagSalt( 'alerts' ) );
|
||||
$this->assertNotSame( $ea, Payloads::etag( $pa, $b->etagSalt( 'alerts' ) ) );
|
||||
$this->assertNotSame( $ea, Payloads::etag( $pa, $none->etagSalt( 'alerts' ) ) );
|
||||
$this->assertSame( Payloads::etag( $pa ), Payloads::etag( $pa, $none->etagSalt( 'alerts' ) ), 'no defs: unchanged etag' );
|
||||
$this->assertSame( '', $a->etagSalt( 'goal' ) );
|
||||
}
|
||||
|
||||
public function test_etag_changes_when_attachment_url_changes(): void {
|
||||
$p1 = array( 'alerts' => array( array( 'id' => 1, 'media' => array( 'visual' => array( 'url' => 'https://a/1' ) ) ) ) );
|
||||
$p2 = array( 'alerts' => array( array( 'id' => 1, 'media' => array( 'visual' => array( 'url' => 'https://a/2' ) ) ) ) );
|
||||
$this->assertNotSame( Payloads::etag( $p1 ), Payloads::etag( $p2 ) );
|
||||
}
|
||||
|
||||
public function test_payloads_alerts_calls_media_callback_with_public_name_only_for_shown_rows(): void {
|
||||
$seen = array();
|
||||
$cb = static function ( array $r, string $name, string $amount ) use ( &$seen ): ?array { $seen[] = array( $r['id'], $name, $amount ); return null; };
|
||||
Payloads::alerts( array( $this->row( 1, array( 'is_anonymous' => 1 ) ), $this->row( 2, array( 'moderation' => 'rejected' ) ) ), null, 10, true, $cb );
|
||||
$this->assertSame( array( array( 1, 'Anonymous', '$25.00' ) ), $seen );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Overlay\OverlayDataSource;
|
||||
use StreamGoals\Overlay\OverlayService;
|
||||
use StreamGoals\Overlay\Payloads;
|
||||
use StreamGoals\Overlay\RecentDonationsSource;
|
||||
use StreamGoals\Overlay\TiersSource;
|
||||
|
||||
final class OverlayTiersTest extends TestCase {
|
||||
|
||||
private function tiers( array $reached = array() ): array {
|
||||
$rows = array( array( 1, 10000, 'Giveaway' ), array( 2, 25000, 'Microphone' ), array( 3, 50000, '24h stream' ) );
|
||||
return array_map( static fn( $r ) => array( 'id' => $r[0], 'target_minor' => $r[1], 'title' => $r[2], 'description' => 'd' . $r[0], 'reached_at' => in_array( $r[0], $reached, true ) ? '2026-01-01 00:00:00' : null ), $rows );
|
||||
}
|
||||
|
||||
private function svc( array $tiers, int $raised, array $db = array(), array $unlocked = array(), ?object &$probe = null ): OverlayService {
|
||||
$probe = new class( $tiers, $raised, $db, $unlocked ) implements OverlayDataSource, RecentDonationsSource, TiersSource {
|
||||
public int $reachedQueries = 0;
|
||||
public function __construct( private array $tiers, private int $raised, private array $db, private array $unlocked ) {}
|
||||
public function activeGoal(): ?array { return array( 'id' => 7, 'title' => 'Stream', 'currency' => 'USD', 'target_minor' => 50000 ); }
|
||||
public function raisedMinor( array $goal ): int { return $this->raised; }
|
||||
public function stateValue( int $goalId, string $key ): ?string { return null; }
|
||||
public function counter( int $goalId ): array { return array( 'label' => '', 'value' => 0 ); }
|
||||
public function bonusesFor( array $ids ): array { return array(); }
|
||||
public function donations( ?int $sinceId, int $limit ): array { return $this->db; }
|
||||
public function recentDonations( int $limit ): array { return $this->db; }
|
||||
public function tiersFor( int $goalId ): array { return $this->tiers; }
|
||||
public function tiersReachedFor( array $ids ): array { ++$this->reachedQueries; return $this->unlocked; }
|
||||
};
|
||||
return new OverlayService( $probe );
|
||||
}
|
||||
|
||||
private function row( int $id ): array {
|
||||
return array( 'id' => $id, 'base_minor' => 2500, 'currency' => 'USD', 'donor_name' => 'Al', 'is_anonymous' => 0, 'message' => '', 'status' => 'completed', 'moderation' => 'approved' );
|
||||
}
|
||||
|
||||
public function test_untiered_goal_payload_is_unchanged(): void {
|
||||
$g = Payloads::goal( array( 'title' => 'G', 'currency' => 'USD', 'target_minor' => 20000 ), 5000 );
|
||||
$this->assertArrayNotHasKey( 'tiers', $g );
|
||||
$this->assertSame( 25, $g['percent'] );
|
||||
$this->assertSame( $g, Payloads::goal( array( 'title' => 'G', 'currency' => 'USD', 'target_minor' => 20000 ), 5000, array() ) );
|
||||
$this->assertArrayNotHasKey( 'tiers', $this->svc( array(), 100 )->payload( 'goal', 1 ) );
|
||||
}
|
||||
|
||||
public function test_tiered_goal_percent_is_within_tier_and_displays(): void {
|
||||
$g = $this->svc( $this->tiers( array( 1 ) ), 17500 )->payload( 'goal', 1 );
|
||||
$this->assertSame( 50, $g['percent'] );
|
||||
$this->assertSame( 17500, $g['raised_minor'] );
|
||||
$this->assertSame( '$175.00', $g['raised_display'] );
|
||||
$this->assertSame( 25000, $g['target_minor'] );
|
||||
$this->assertSame( '$250.00', $g['target_display'] );
|
||||
$t = $g['tiers'];
|
||||
$this->assertSame( 3, $t['count'] );
|
||||
$this->assertSame( 2, $t['index'] );
|
||||
$this->assertFalse( $t['all_reached'] );
|
||||
$this->assertSame( array( 'title' => 'Microphone', 'description' => 'd2', 'target_minor' => 25000, 'target_display' => '$250.00', 'floor_minor' => 10000 ), $t['current'] );
|
||||
}
|
||||
|
||||
public function test_tiered_goal_below_first_tier_and_all_reached(): void {
|
||||
$g = $this->svc( $this->tiers(), 2500 )->payload( 'goal', 1 );
|
||||
$this->assertSame( 25, $g['percent'] );
|
||||
$this->assertSame( 1, $g['tiers']['index'] );
|
||||
$this->assertSame( 0, $g['tiers']['current']['floor_minor'] );
|
||||
$all = $this->svc( $this->tiers( array( 1, 2, 3 ) ), 60000 )->payload( 'goal', 1 );
|
||||
$this->assertSame( 100, $all['percent'] );
|
||||
$this->assertTrue( $all['tiers']['all_reached'] );
|
||||
$this->assertNull( $all['tiers']['current'] );
|
||||
$this->assertSame( 3, $all['tiers']['index'] );
|
||||
$this->assertSame( '$500.00', $all['target_display'] );
|
||||
$this->assertSame( '$600.00', $all['raised_display'] );
|
||||
}
|
||||
|
||||
public function test_tier_text_is_sanitized(): void {
|
||||
$t = $this->tiers();
|
||||
$t[0]['title'] = '<script>x</script>Hi' . str_repeat( 'a', 300 );
|
||||
$g = $this->svc( $t, 0 )->payload( 'goal', 1 );
|
||||
$this->assertStringNotContainsString( '<', $g['tiers']['current']['title'] );
|
||||
$this->assertLessThanOrEqual( 120, mb_strlen( $g['tiers']['current']['title'] ) );
|
||||
}
|
||||
|
||||
public function test_alert_tiers_in_since_and_recent_with_one_query(): void {
|
||||
$probe = null;
|
||||
$svc = $this->svc( array(), 0, array( $this->row( 3 ), $this->row( 4 ) ), array( 3 => array( array( 'title' => 'Giveaway' ), array( 'title' => 'Microphone' ) ) ), $probe );
|
||||
$since = $svc->payload( 'alerts', 1, 0 );
|
||||
$this->assertSame( 1, $probe->reachedQueries );
|
||||
$recent = $svc->payload( 'alerts', 1, null, true );
|
||||
$this->assertSame( 2, $probe->reachedQueries );
|
||||
$this->assertSame( $since['alerts'], $recent['alerts'] );
|
||||
$this->assertSame( array( array( 'title' => 'Giveaway' ), array( 'title' => 'Microphone' ) ), $recent['alerts'][0]['tiers'] );
|
||||
$this->assertSame( array(), $recent['alerts'][1]['tiers'] );
|
||||
$svc->payload( 'alerts', 1, null ); // baseline poll: no lookup
|
||||
$this->assertSame( 2, $probe->reachedQueries );
|
||||
}
|
||||
|
||||
public function test_alert_tier_events_sanitized_and_capped(): void {
|
||||
$ev = array( array( 'title' => '<b>Hi</b>' ), array( 'title' => '' ), 'junk', array( 'title' => str_repeat( 'é', 200 ) ) );
|
||||
for ( $i = 0; $i < 9; $i++ ) {
|
||||
$ev[] = array( 'title' => "T$i" );
|
||||
}
|
||||
$out = Payloads::tierEvents( $ev );
|
||||
$this->assertCount( 5, $out );
|
||||
$this->assertSame( array( 'title' => 'Hi' ), $out[0] );
|
||||
$this->assertSame( 80, mb_strlen( $out[1]['title'] ) );
|
||||
$this->assertSame( array(), Payloads::tierEvents( 'nope' ) );
|
||||
}
|
||||
|
||||
public function test_etag_changes_when_a_tier_unlocks_or_current_tier_moves(): void {
|
||||
$a = Payloads::etag( $this->svc( array(), 0, array( $this->row( 3 ) ) )->payload( 'alerts', 1, null, true ) );
|
||||
$b = Payloads::etag( $this->svc( array(), 0, array( $this->row( 3 ) ), array( 3 => array( array( 'title' => 'X' ) ) ) )->payload( 'alerts', 1, null, true ) );
|
||||
$this->assertNotSame( $a, $b );
|
||||
$g1 = Payloads::etag( $this->svc( $this->tiers(), 9000 )->payload( 'goal', 1 ) );
|
||||
$g2 = Payloads::etag( $this->svc( $this->tiers( array( 1 ) ), 10000 )->payload( 'goal', 1 ) );
|
||||
$this->assertNotSame( $g1, $g2 );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,142 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Tiers\TierPolicy;
|
||||
|
||||
final class TierPolicyTest extends TestCase {
|
||||
|
||||
private function tiers( array $reachedIds = array() ): array {
|
||||
$rows = array( array( 1, 10000, 'Giveaway' ), array( 2, 25000, 'Microphone' ), array( 3, 50000, '24h stream' ) );
|
||||
$out = array();
|
||||
foreach ( $rows as [ $id, $t, $title ] ) {
|
||||
$out[] = array( 'id' => $id, 'target_minor' => $t, 'title' => $title, 'description' => '', 'reached_at' => in_array( $id, $reachedIds, true ) ? '2026-01-01 00:00:00' : null );
|
||||
}
|
||||
return array_reverse( $out ); // unsorted on purpose
|
||||
}
|
||||
|
||||
public function test_current_tier_and_index(): void {
|
||||
$this->assertSame( 1, TierPolicy::currentTier( $this->tiers() )['id'] );
|
||||
$this->assertSame( 1, TierPolicy::currentIndex( $this->tiers() ) );
|
||||
$this->assertSame( 3, TierPolicy::currentTier( $this->tiers( array( 1, 2 ) ) )['id'] );
|
||||
$this->assertSame( 3, TierPolicy::currentIndex( $this->tiers( array( 1, 2 ) ) ) );
|
||||
$this->assertNull( TierPolicy::currentTier( $this->tiers( array( 1, 2, 3 ) ) ) );
|
||||
$this->assertSame( 3, TierPolicy::currentIndex( $this->tiers( array( 1, 2, 3 ) ) ) );
|
||||
$this->assertTrue( TierPolicy::allReached( $this->tiers( array( 1, 2, 3 ) ) ) );
|
||||
$this->assertFalse( TierPolicy::allReached( $this->tiers( array( 1 ) ) ) );
|
||||
$this->assertFalse( TierPolicy::allReached( array() ) );
|
||||
$this->assertSame( 0, TierPolicy::currentIndex( array() ) );
|
||||
}
|
||||
|
||||
public function test_floor(): void {
|
||||
$this->assertSame( 0, TierPolicy::floorMinor( $this->tiers() ) );
|
||||
$this->assertSame( 10000, TierPolicy::floorMinor( $this->tiers( array( 1 ) ) ) );
|
||||
$this->assertSame( 25000, TierPolicy::floorMinor( $this->tiers( array( 1, 2 ) ) ) );
|
||||
$this->assertSame( 50000, TierPolicy::floorMinor( $this->tiers( array( 1, 2, 3 ) ) ), 'all reached: top target' );
|
||||
}
|
||||
|
||||
public function test_percent_within_tier_clamped(): void {
|
||||
$this->assertSame( 0, TierPolicy::percent( 0, 0, 10000 ) );
|
||||
$this->assertSame( 50, TierPolicy::percent( 5000, 0, 10000 ) );
|
||||
$this->assertSame( 50, TierPolicy::percent( 17500, 10000, 25000 ) );
|
||||
$this->assertSame( 0, TierPolicy::percent( 10000, 10000, 25000 ), 'exactly at the floor' );
|
||||
$this->assertSame( 0, TierPolicy::percent( 500, 10000, 25000 ), 'raised below the floor clamps to 0' );
|
||||
$this->assertSame( 100, TierPolicy::percent( 25000, 10000, 25000 ), 'exactly at the target' );
|
||||
$this->assertSame( 100, TierPolicy::percent( 99999, 10000, 25000 ), 'above clamps to 100' );
|
||||
$this->assertSame( 0, TierPolicy::percent( 5, 100, 100 ), 'degenerate range, not reached' );
|
||||
$this->assertSame( 100, TierPolicy::percent( 100, 100, 100 ), 'degenerate range, reached' );
|
||||
}
|
||||
|
||||
public function test_percent_for_walks_the_ladder(): void {
|
||||
$this->assertSame( 25, TierPolicy::percentFor( $this->tiers(), 2500 ) );
|
||||
$this->assertSame( 0, TierPolicy::percentFor( $this->tiers( array( 1 ) ), 10000 ) );
|
||||
$this->assertSame( 50, TierPolicy::percentFor( $this->tiers( array( 1 ) ), 17500 ) );
|
||||
$this->assertSame( 100, TierPolicy::percentFor( $this->tiers( array( 1, 2, 3 ) ), 60000 ) );
|
||||
$this->assertSame( 0, TierPolicy::percentFor( array(), 500 ) );
|
||||
$this->assertSame( 7500, TierPolicy::remainingMinor( $this->tiers(), 2500 ) );
|
||||
$this->assertSame( 0, TierPolicy::remainingMinor( $this->tiers( array( 1, 2, 3 ) ), 60000 ) );
|
||||
}
|
||||
|
||||
public function test_newly_reached_several_in_one_donation_in_order(): void {
|
||||
$ids = array_column( TierPolicy::newlyReached( $this->tiers(), 30000 ), 'id' );
|
||||
$this->assertSame( array( 1, 2 ), $ids );
|
||||
$this->assertSame( array( 1, 2, 3 ), array_column( TierPolicy::newlyReached( $this->tiers(), 50000 ), 'id' ), 'exactly at the last target counts' );
|
||||
$this->assertSame( array(), TierPolicy::newlyReached( $this->tiers(), 9999 ) );
|
||||
$this->assertSame( array( 2 ), array_column( TierPolicy::newlyReached( $this->tiers( array( 1 ) ), 30000 ), 'id' ), 'reached ones are skipped' );
|
||||
}
|
||||
|
||||
public function test_replay_is_idempotent_at_policy_level(): void {
|
||||
$tiers = $this->tiers();
|
||||
$first = TierPolicy::newlyReached( $tiers, 30000 );
|
||||
foreach ( $tiers as &$t ) {
|
||||
if ( in_array( $t['id'], array_column( $first, 'id' ), true ) ) {
|
||||
$t['reached_at'] = '2026-02-02 00:00:00';
|
||||
}
|
||||
}
|
||||
unset( $t );
|
||||
$this->assertSame( array(), TierPolicy::newlyReached( $tiers, 30000 ) );
|
||||
$this->assertSame( array(), TierPolicy::newlyReached( $tiers, 12000 ), 'a lower total (refund) never un-reaches or re-reaches' );
|
||||
}
|
||||
|
||||
public function test_derived_target_is_highest(): void {
|
||||
$this->assertSame( 50000, TierPolicy::derivedGoalTarget( $this->tiers() ) );
|
||||
$this->assertSame( 0, TierPolicy::derivedGoalTarget( array() ) );
|
||||
}
|
||||
|
||||
public function test_status(): void {
|
||||
$t = $this->tiers( array( 1 ) );
|
||||
$by = array();
|
||||
foreach ( $t as $row ) {
|
||||
$by[ $row['id'] ] = TierPolicy::status( $t, $row );
|
||||
}
|
||||
$this->assertSame( array( 3 => 'upcoming', 2 => 'current', 1 => 'reached' ), $by );
|
||||
}
|
||||
|
||||
/* ------------------------------------------------------------ validation */
|
||||
|
||||
private function v( ?int $target, string $title = 'Mic', string $desc = '', ?int $edit = null, int $raised = 0, ?array $tiers = null ): array {
|
||||
return TierPolicy::validate( $tiers ?? $this->tiers( array( 1 ) ), $edit, $target, $title, $desc, $raised, 100, '$1.00' );
|
||||
}
|
||||
|
||||
public function test_valid_new_tier(): void {
|
||||
$r = $this->v( 70000, ' New desk ', ' nice ', null, 12000 );
|
||||
$this->assertNull( $r['error'] );
|
||||
$this->assertSame( array( 'target_minor' => 70000, 'title' => 'New desk', 'description' => 'nice' ), $r['data'] );
|
||||
}
|
||||
|
||||
public function test_rejects_bad_values(): void {
|
||||
$this->assertNotNull( $this->v( null )['error'] );
|
||||
$this->assertNotNull( $this->v( 0 )['error'] );
|
||||
$this->assertStringContainsString( 'minimum', (string) $this->v( 50 )['error'] );
|
||||
$this->assertStringContainsString( 'title', (string) $this->v( 70000, ' ' )['error'] . ' title' );
|
||||
$this->assertNotNull( $this->v( 70000, ' ' )['error'] );
|
||||
$this->assertNotNull( $this->v( 70000, str_repeat( 'a', 121 ) )['error'] );
|
||||
$this->assertNull( $this->v( 70000, str_repeat( 'a', 120 ) )['error'] );
|
||||
$this->assertNotNull( $this->v( 70000, 'x', str_repeat( 'd', 256 ) )['error'] );
|
||||
$this->assertNull( $this->v( 70000, 'x', str_repeat( 'd', 255 ) )['error'] );
|
||||
}
|
||||
|
||||
public function test_target_must_be_unique_and_above_raised(): void {
|
||||
$this->assertStringContainsString( 'already', (string) $this->v( 25000 )['error'] );
|
||||
$this->assertStringContainsString( 'already raised', (string) $this->v( 20000, 'x', '', null, 20000 )['error'], 'equal to raised unlocks instantly' );
|
||||
$this->assertNull( $this->v( 20001, 'x', '', null, 20000 )['error'] );
|
||||
}
|
||||
|
||||
public function test_reached_tier_target_is_locked_but_text_editable(): void {
|
||||
$r = $this->v( 999999, 'Renamed', 'd', 1, 12000 );
|
||||
$this->assertNull( $r['error'] );
|
||||
$this->assertSame( 10000, $r['data']['target_minor'] );
|
||||
$this->assertSame( 'Renamed', $r['data']['title'] );
|
||||
$r2 = $this->v( null, 'Renamed', '', 1, 12000 );
|
||||
$this->assertSame( 10000, $r2['data']['target_minor'] );
|
||||
}
|
||||
|
||||
public function test_edit_unreached_keeps_or_moves_target(): void {
|
||||
$this->assertNull( $this->v( 25000, 'Mic2', '', 2, 12000 )['error'], 'unchanged target is fine' );
|
||||
$this->assertNull( $this->v( 30000, 'Mic', '', 2, 12000 )['error'] );
|
||||
$this->assertStringContainsString( 'already', (string) $this->v( 50000, 'Mic', '', 2, 12000 )['error'] );
|
||||
$this->assertStringContainsString( 'no longer', (string) $this->v( 30000, 'Mic', '', 99, 12000 )['error'] );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
<?php
|
||||
declare( strict_types=1 );
|
||||
|
||||
namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Tiers\TierRepository;
|
||||
|
||||
final class TierRepositoryTest extends TestCase {
|
||||
|
||||
private function fake( array $rows = array(), $var = null ): object {
|
||||
if ( ! defined( 'ARRAY_A' ) ) {
|
||||
define( 'ARRAY_A', 'ARRAY_A' );
|
||||
}
|
||||
return new class( $rows, $var ) {
|
||||
public string $prefix = 'wp_';
|
||||
public array $sql = array();
|
||||
public int $insert_id = 9;
|
||||
public array $queryResults = array();
|
||||
public function __construct( public array $rows, public $var ) {}
|
||||
public function prepare( string $q, ...$args ): string {
|
||||
$i = 0;
|
||||
return (string) preg_replace_callback( '/%[dsf]/', static function ( $m ) use ( &$i, $args ) {
|
||||
$v = $args[ $i++ ];
|
||||
return '%s' === $m[0] ? "'" . $v . "'" : (string) $v;
|
||||
}, $q );
|
||||
}
|
||||
public function query( string $q ) { $this->sql[] = $q; return array_shift( $this->queryResults ) ?? 1; }
|
||||
public function get_results( string $q, $o = null ): array { $this->sql[] = $q; return $this->rows; }
|
||||
public function get_var( string $q ) { $this->sql[] = $q; return $this->var; }
|
||||
public function insert( string $t, array $d, array $f ) { $this->sql[] = 'INSERT ' . $t . ' ' . json_encode( $d ); return 1; }
|
||||
};
|
||||
}
|
||||
|
||||
private function row( int $id, int $target, ?string $reached = null ): array {
|
||||
return array( 'id' => (string) $id, 'goal_id' => '7', 'target_minor' => (string) $target, 'title' => "T$id", 'description' => '', 'reached_at' => $reached, 'reached_donation_id' => null, 'created_at' => '2026-01-01 00:00:00' );
|
||||
}
|
||||
|
||||
public function test_for_goal_orders_by_target_and_casts(): void {
|
||||
$db = $this->fake( array( $this->row( 1, 10000 ) ) );
|
||||
$rows = ( new TierRepository( $db ) )->forGoal( 7 );
|
||||
$this->assertStringContainsString( 'WHERE goal_id = 7 ORDER BY target_minor ASC', $db->sql[0] );
|
||||
$this->assertSame( 10000, $rows[0]['target_minor'] );
|
||||
$this->assertNull( $rows[0]['reached_at'] );
|
||||
}
|
||||
|
||||
public function test_mark_reached_is_atomic_per_tier_and_only_for_reachable(): void {
|
||||
$db = $this->fake( array( $this->row( 1, 10000 ), $this->row( 2, 25000 ), $this->row( 3, 50000 ), $this->row( 4, 5000, '2026-01-01 00:00:00' ) ) );
|
||||
$marked = ( new TierRepository( $db ) )->markReached( 7, 30000, 55 );
|
||||
$this->assertSame( array( 1, 2 ), $marked );
|
||||
$updates = array_values( array_filter( $db->sql, static fn( $q ) => str_starts_with( $q, 'UPDATE' ) ) );
|
||||
$this->assertCount( 2, $updates );
|
||||
foreach ( $updates as $q ) {
|
||||
$this->assertStringContainsString( 'reached_at IS NULL', $q );
|
||||
$this->assertStringContainsString( 'reached_donation_id = 55', $q );
|
||||
$this->assertStringContainsString( 'UPDATE wp_sg_goal_tiers', $q );
|
||||
}
|
||||
}
|
||||
|
||||
public function test_mark_reached_replay_loses_race_and_reports_nothing(): void {
|
||||
$db = $this->fake( array( $this->row( 1, 10000 ) ) );
|
||||
$db->queryResults = array( 0 ); // someone else already marked it
|
||||
$this->assertSame( array(), ( new TierRepository( $db ) )->markReached( 7, 30000, 55 ) );
|
||||
}
|
||||
|
||||
public function test_mark_reached_ignores_invalid_ids(): void {
|
||||
$db = $this->fake( array( $this->row( 1, 10000 ) ) );
|
||||
$this->assertSame( array(), ( new TierRepository( $db ) )->markReached( 0, 30000, 55 ) );
|
||||
$this->assertSame( array(), ( new TierRepository( $db ) )->markReached( 7, 30000, 0 ) );
|
||||
$this->assertSame( array(), $db->sql );
|
||||
}
|
||||
|
||||
public function test_reached_by_donation_is_one_query_and_grouped(): void {
|
||||
$db = $this->fake( array( array( 'reached_donation_id' => '5', 'title' => 'A' ), array( 'reached_donation_id' => '5', 'title' => 'B' ), array( 'reached_donation_id' => '6', 'title' => 'C' ) ) );
|
||||
$out = ( new TierRepository( $db ) )->reachedByDonation( array( 5, 6, 6, 0, -1 ) );
|
||||
$this->assertCount( 1, $db->sql );
|
||||
$this->assertStringContainsString( 'reached_donation_id IN (5,6)', $db->sql[0] );
|
||||
$this->assertSame( array( 5 => array( array( 'title' => 'A' ), array( 'title' => 'B' ) ), 6 => array( array( 'title' => 'C' ) ) ), $out );
|
||||
$this->assertSame( array(), ( new TierRepository( $this->fake() ) )->reachedByDonation( array() ) );
|
||||
}
|
||||
|
||||
public function test_sync_goal_target_sets_highest_and_skips_untiered(): void {
|
||||
$db = $this->fake( array(), '50000' );
|
||||
$this->assertTrue( ( new TierRepository( $db ) )->syncGoalTarget( 7 ) );
|
||||
$this->assertStringContainsString( 'MAX(target_minor)', $db->sql[0] );
|
||||
$this->assertStringContainsString( 'UPDATE wp_sg_goals SET target_minor = 50000 WHERE id = 7', $db->sql[1] );
|
||||
$none = $this->fake( array(), null );
|
||||
$this->assertFalse( ( new TierRepository( $none ) )->syncGoalTarget( 7 ) );
|
||||
$this->assertCount( 1, $none->sql, 'no UPDATE when the goal has no tiers' );
|
||||
}
|
||||
|
||||
public function test_installer_defines_tier_table_unique_key_and_version(): void {
|
||||
$src = (string) file_get_contents( dirname( __DIR__, 2 ) . '/includes/Core/Installer.php' );
|
||||
$this->assertSame( 1, preg_match( "/DB_VERSION = '(\\d+)'/", $src, $m ) );
|
||||
$this->assertGreaterThanOrEqual( 4, (int) $m[1] );
|
||||
$this->assertStringContainsString( 'CREATE TABLE {$p}goal_tiers (', $src );
|
||||
$this->assertStringContainsString( 'UNIQUE KEY goal_target (goal_id,target_minor)', $src );
|
||||
$this->assertStringContainsString( 'reached_donation_id BIGINT UNSIGNED NULL', $src );
|
||||
}
|
||||
|
||||
public function test_donation_store_marks_tiers_before_close_at_target(): void {
|
||||
$src = (string) file_get_contents( dirname( __DIR__, 2 ) . '/includes/PayPal/DonationStore.php' );
|
||||
$start = strpos( $src, 'function notify_applied' );
|
||||
$body = substr( $src, $start, strpos( $src, 'function close_goal_if_target_reached' ) - $start );
|
||||
$a = strpos( $body, 'Recorder::forDonation' );
|
||||
$tier = strpos( $body, 'Tiers\\Recorder::forDonation' );
|
||||
$close = strpos( $body, 'self::close_goal_if_target_reached' );
|
||||
$this->assertNotFalse( $tier );
|
||||
$this->assertNotFalse( $a );
|
||||
$this->assertLessThan( $tier, strpos( $body, 'call_engine' ), 'engine first' );
|
||||
$this->assertLessThan( $close, $tier, 'tiers before the close check' );
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user