Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -139,6 +139,22 @@ public function missing(string $key): bool
return $this->cache->missing($key);
}

/**
* Invalidate cache for a specific screen
*
* @param int $screenId Screen ID
* @return bool
* @throws \RuntimeException If underlying cache doesn't support invalidate
*/
public function invalidate(int $screenId, string $language): bool
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->invalidate($screenId, $language);
}

throw new \RuntimeException('Underlying cache implementation does not support invalidate method');
}

/**
* Calculate the approximate size in bytes of a value
*
Expand DownExpand Up@@ -169,4 +185,23 @@ protected function calculateSize(mixed $value): int

return 0; // for null or other types
}

/**
* Get a value from the cache or store it if it doesn't exist.
*
* @param string $key
* @param callable $callback
* @return mixed
*/
public function getOrCache(string $key, callable $callback): mixed
{
if ($this->cache->has($key)) {
return $this->cache->get($key);
}

$value = $callback();
$this->cache->set($key, $value);

return $value;
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Storage;
use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
Expand DownExpand Up@@ -54,4 +55,40 @@ public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}

/**
* Delete a screen from cache
*/
public function delete(string $key): bool
{
return $this->compiledManager->deleteCompiledContent($key);
}

/**
* Clear all screen caches
*/
public function clear(): bool
{
return $this->compiledManager->clearCompiledContent();
}

/**
* Check if screen is missing from cache
*/
public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
*
* @param int $screenId Screen ID
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all files from storage that match the pattern for this screen ID
return $this->compiledManager->deleteScreenCompiledContent($screenId, $language);
}
}
10 changes: 10 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,4 +47,14 @@ public static function create(): ScreenCacheInterface
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}

/**
* Get the current screen cache instance
*
* @return ScreenCacheInterface
*/
public static function getScreenCache(): ScreenCacheInterface
{
return self::create();
}
}
37 changes: 37 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,43 @@ public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool;

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool;

/**
* Clear all screen caches
*
* @return bool
*/
public function clear(): bool;

/**
* Check if screen is missing from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool;

/**
* Invalidate cache for a specific screen
*
* @param int $screenId
* @return bool
*/
public function invalidate(
int $screenId,
string $language,
): bool;
}
22 changes: 22 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;
use ProcessMaker\Models\Screen;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
Expand DownExpand Up@@ -139,4 +140,25 @@ public function missing(string $key): bool
{
return !$this->has($key);
}

/**
* Invalidate all cache entries for a specific screen
* @param int $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function invalidate(int $screenId, string $language): bool
{
// Get all keys from cache that match the pattern for this screen ID
// TODO Improve this to avoid scanning the entire cache
$pattern = "*_{$language}_sid_{$screenId}_*";
$keys = $this->cacheManager->get($pattern);

// Delete all matching keys
foreach ($keys as $key) {
$this->cacheManager->forget($key);
}

return true;
}
}
3 changes: 2 additions & 1 deletion ProcessMaker/Cache/Settings/SettingCacheManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ private function determineCacheDriver(): string
if (in_array($defaultCache, ['redis', 'cache_settings'])) {
return self::DEFAULT_CACHE_DRIVER;
}

return $defaultCache;
}

Expand DownExpand Up@@ -150,7 +151,7 @@ public function clearBy(string $pattern): void
// Get all keys
$keys = Redis::connection($connection)->keys($this->cacheManager->getPrefix() . '*');
// Filter keys by pattern
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));
$matchedKeys = array_filter($keys, fn($key) => preg_match('/' . $pattern . '/', $key));

if (!empty($matchedKeys)) {
Redis::connection($connection)->del($matchedKeys);
Expand Down
31 changes: 31 additions & 0 deletions ProcessMaker/Events/TranslationChanged.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
<?php

namespace ProcessMaker\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class TranslationChanged
{
use Dispatchable;

public string $locale;

public array $changes;

public ?string $screenId;

/**
* Create a new event instance.
*
* @param string $locale
* @param array $changes Key-value pairs of changed translations
* @param string|null $screenId Optional screen ID if change is specific to a screen
*/
public function __construct(int $screenId, string $language, array $changes)
{
$this->language = $language;
$this->changes = $changes;
$this->screenId = $screenId;
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
<?php

namespace ProcessMaker\Listeners;

use Illuminate\Support\Facades\Log;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Models\Screen;

class InvalidateScreenCacheOnTranslationChange
{
/**
* Handle the event.
*/
public function handle(TranslationChanged $event): void
{
try {
if ($event->screenId) {
$this->invalidateScreen($event->screenId, $event->language);
}
} catch (\Exception $e) {
Log::error('Failed to invalidate screen cache', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'language' => $event->language,
'screenId' => $event->screenId,
]);
throw $e; // Re-throw to ensure error is properly handled
}
}

/**
* Invalidate cache for a specific screen
*/
protected function invalidateScreen(string $screenId, string $locale): void
{
try {
$screen = Screen::find($screenId);
if ($screen) {
$cache = ScreenCacheFactory::getScreenCache();
$cache->invalidate($screen->id, $locale);
} else {
Log::warning('Screen not found', ['screenId' => $screenId]);
}
} catch (\Exception $e) {
Log::error('Error in invalidateScreen', [
'error' => $e->getMessage(),
'trace' => $e->getTraceAsString(),
'screenId' => $screenId,
'locale' => $locale,
]);
throw $e;
}
}
}
24 changes: 24 additions & 0 deletions ProcessMaker/Managers/ScreenCompiledManager.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,4 +106,28 @@ protected function getFilename(string $screenKey)
{
return 'screen_' . $screenKey . '.bin';
}

/**
* Delete all compiled content for a specific screen ID and language
*
* @param string $screenId Screen ID
* @param string $language Language code
* @return bool
*/
public function deleteScreenCompiledContent(string $screenId, string $language): bool
{
$files = Storage::disk($this->storageDisk)->files($this->storagePath);
$deleted = false;

foreach ($files as $file) {
// Remove the 'screen_' prefix and '.bin' extension for pattern matching
$filename = str_replace(['screen_', '.bin'], '', basename($file));
if (strpos($filename, "_{$language}_sid_{$screenId}_") !== false) {
Storage::disk($this->storageDisk)->delete($file);
$deleted = true;
}
}

return $deleted;
}
}
1 change: 1 addition & 0 deletions ProcessMaker/Models/Screen.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
Expand Down
9 changes: 9 additions & 0 deletions ProcessMaker/Models/ScreenVersion.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

Expand DownExpand Up@@ -33,6 +34,14 @@ class ScreenVersion extends ProcessMakerModel implements ScreenInterface
'translations' => 'array',
];

/**
* Boot the model and its events
*/
public static function boot()
{
parent::boot();
}

/**
* Set multiple|single categories to the screen
*
Expand Down
8 changes: 4 additions & 4 deletions ProcessMaker/Models/Setting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -143,7 +143,7 @@ public static function messages()
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @return Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
Expand DownExpand Up@@ -393,7 +393,7 @@ public static function getFavicon()
*/
public static function groupsByMenu($menuId)
{
$query = Setting::query()
$query = self::query()
->select('group')
->groupBy('group')
->where('group_id', $menuId)
Expand All@@ -420,7 +420,7 @@ public static function groupsByMenu($menuId)
*/
public static function updateSettingsGroup($settingsGroup, $id)
{
Setting::where('group', $settingsGroup)->whereNull('group_id')->chunk(
self::where('group', $settingsGroup)->whereNull('group_id')->chunk(
50,
function ($settings) use ($id) {
foreach ($settings as $setting) {
Expand All@@ -440,7 +440,7 @@ function ($settings) use ($id) {
*/
public static function updateAllSettingsGroupId()
{
Setting::whereNull('group_id')->chunk(100, function ($settings) {
self::whereNull('group_id')->chunk(100, function ($settings) {
$defaultId = SettingsMenus::EMAIL_MENU_GROUP;
foreach ($settings as $setting) {
// Define the value of 'menu_group' based on 'group'
Expand Down
Loading