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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
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
57 changes: 57 additions & 0 deletions ProcessMaker/Cache/Screens/LegacyScreenCacheAdapter.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
<?php

namespace ProcessMaker\Cache\Screens;

use ProcessMaker\Managers\ScreenCompiledManager;

class LegacyScreenCacheAdapter implements ScreenCacheInterface
{
protected ScreenCompiledManager $compiledManager;

public function __construct(ScreenCompiledManager $compiledManager)
{
$this->compiledManager = $compiledManager;
}

/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return $this->compiledManager->createKey(
(string) $processId,
(string) $processVersionId,
$language,
(string) $screenId,
(string) $screenVersionId
);
}

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed
{
$content = $this->compiledManager->getCompiledContent($key);

return $content ?? $default;
}

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool
{
$this->compiledManager->storeCompiledContent($key, $value);

return true;
}

/**
* Check if screen exists in cache
*/
public function has(string $key): bool
{
return $this->compiledManager->getCompiledContent($key) !== null;
}
}
18 changes: 18 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFacade.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Facade;

/**
* Class ScreenCacheFacade
*
* @mixin \ProcessMaker\Cache\Settings\ScreenCacheManager
*/
class ScreenCacheFacade extends Facade
{
protected static function getFacadeAccessor()
{
return 'screen.cache';
}
}
45 changes: 45 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheFactory
{
private static ?ScreenCacheInterface $testInstance = null;

/**
* Set a test instance for the factory
*
* @param ScreenCacheInterface|null $instance
*/
public static function setTestInstance(?ScreenCacheInterface $instance): void
{
self::$testInstance = $instance;
}

/**
* Create a screen cache handler based on configuration
*
* @return ScreenCacheInterface
*/
public static function create(): ScreenCacheInterface
{
if (self::$testInstance !== null) {
return self::$testInstance;
}

$manager = Config::get('screens.cache.manager', 'legacy');

if ($manager === 'new') {
return app(ScreenCacheManager::class);
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
}
}
26 changes: 26 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheInterface.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
<?php

namespace ProcessMaker\Cache\Screens;

interface ScreenCacheInterface
{
/**
* Create a cache key for a screen
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string;

/**
* Get a screen from cache
*/
public function get(string $key, mixed $default = null): mixed;

/**
* Store a screen in cache
*/
public function set(string $key, mixed $value): bool;

/**
* Check if screen exists in cache
*/
public function has(string $key): bool;
}
115 changes: 115 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCacheManager.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Cache\CacheManager;
use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Managers\ScreenCompiledManager;

class ScreenCacheManager implements CacheInterface, ScreenCacheInterface
{
protected CacheManager $cacheManager;

protected ScreenCompiledManager $screenCompiler;

/**
* Default TTL for cached screens (24 hours)
*/
protected const DEFAULT_TTL = 86400;

public function __construct(CacheManager $cacheManager, ScreenCompiledManager $screenCompiler)
{
$this->cacheManager = $cacheManager;
$this->screenCompiler = $screenCompiler;
}

/**
* Create a cache key for a screen
*
* @param int $processId Process ID
* @param int $processVersionId Process version ID
* @param string $language Language code
* @param int $screenId Screen ID
* @param int $screenVersionId Screen version ID
* @return string Cache key
*/
public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
return "pid_{$processId}_{$processVersionId}_{$language}_sid_{$screenId}_{$screenVersionId}";
}

/**
* Get a screen from cache
*
* @param string $key Screen cache key
* @param mixed $default Default value
* @return mixed
*/
public function get(string $key, mixed $default = null): mixed
{
$serializedContent = $this->cacheManager->get($key);
if ($serializedContent !== null) {
return unserialize($serializedContent);
}

return $default;
}

/**
* Store a screen in memory cache
*
* @param string $key Screen cache key
* @param mixed $value Compiled screen content
* @param null|int|\DateInterval $ttl Time to live
* @return bool
*/
public function set(string $key, mixed $value, null|int|\DateInterval $ttl = null): bool
{
$serializedContent = serialize($value);

return $this->cacheManager->put($key, $serializedContent, $ttl ?? self::DEFAULT_TTL);
}

/**
* Delete a screen from cache
*
* @param string $key Screen cache key
* @return bool
*/
public function delete(string $key): bool
{
return $this->cacheManager->forget($key);
}

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

/**
* Check if screen exists in cache
*
* @param string $key Screen cache key
* @return bool
*/
public function has(string $key): bool
{
return $this->cacheManager->has($key);
}

/**
* Check if screen is missing
*
* @param string $key Screen cache key
* @return bool
*/
public function missing(string $key): bool
{
return !$this->has($key);
}
}
36 changes: 24 additions & 12 deletions ProcessMaker/Http/Controllers/Api/V1_1/TaskController.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use ProcessMaker\Facades\ScreenCompiledManager;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Http\Controllers\Controller;
use ProcessMaker\Http\Resources\V1_1\TaskInterstitialResource;
use ProcessMaker\Http\Resources\V1_1\TaskResource;
Expand DownExpand Up@@ -102,31 +102,43 @@ public function showScreen($taskId)
$task = ProcessRequestToken::select(
array_merge($this->defaultFields, ['process_request_id', 'process_id'])
)
// eager loading process_request.process_version_id
->with([
'processRequest'=> function ($query) {
'processRequest'=> function ($query) {
$query->select('id', 'process_version_id');
},
])->findOrFail($taskId);

// Prepare the key for the screen cache
// Get screen version and prepare cache key
$processId = $task->process_id;
$processVersionId = $task->processRequest->process_version_id;
$language = TranslationManager::getTargetLanguage();
$screenVersion = $task->getScreenVersion();
$key = ScreenCompiledManager::createKey($processId, $processVersionId, $language, $screenVersion->screen_id, $screenVersion->id);

// Get the screen content from the cache or compile it
$translatedScreen = ScreenCompiledManager::getCompiledContent($key);
if (!isset($translatedScreen)) {
// Get the appropriate cache handler based on configuration
$screenCache = ScreenCacheFactory::create();

// Create cache key
$key = $screenCache->createKey(
(int) $processId,
(int) $processVersionId,
$language,
(int) $screenVersion->screen_id,
(int) $screenVersion->id
);

// Try to get the screen from cache
$translatedScreen = $screenCache->get($key);

if ($translatedScreen === null) {
// If not in cache, create new response
$response = new TaskScreen($task);
$translatedScreen = $response->toArray(request())['screen'];
ScreenCompiledManager::storeCompiledContent($key, $translatedScreen);
}

$response = response($translatedScreen, 200);
// Store in cache
$screenCache->set($key, $translatedScreen);
}

return $response;
return response($translatedScreen, 200);
}

public function showInterstitial($taskId)
Expand Down
23 changes: 23 additions & 0 deletions config/screens.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
<?php

return [
/*
|--------------------------------------------------------------------------
| Screen Cache Configuration
|--------------------------------------------------------------------------
|
| Here you can configure the screen caching behavior.
|
*/

'cache' => [
// Cache manager to use: 'new' for ScreenCacheManager, 'legacy' for ScreenCompiledManager
'manager' => env('SCREEN_CACHE_MANAGER', 'legacy'),

// Cache driver to use (redis, file)
'driver' => env('SCREEN_CACHE_DRIVER', 'file'),

// Default TTL for cached screens (24 hours)
'ttl' => env('SCREEN_CACHE_TTL', 86400),
],
];
Loading