JezK

Edit File: Controller.php

<?php

namespace GeminiLabs\SiteReviews\Addons;

use GeminiLabs\SiteReviews\Controllers\AbstractController;
use GeminiLabs\SiteReviews\Database\OptionManager;
use GeminiLabs\SiteReviews\Helpers\Arr;
use GeminiLabs\SiteReviews\Helpers\Cast;
use GeminiLabs\SiteReviews\Helpers\Str;
use GeminiLabs\SiteReviews\Install;
use GeminiLabs\SiteReviews\Modules\Assets\AssetCss;
use GeminiLabs\SiteReviews\Modules\Assets\AssetJs;
use GeminiLabs\SiteReviews\Modules\Html\Template;
use GeminiLabs\SiteReviews\Modules\Translation;
use GeminiLabs\SiteReviews\Modules\Translator;
use GeminiLabs\SiteReviews\Role;

abstract class Controller extends AbstractController
{
    /**
     * @action admin_enqueue_scripts
     */
    public function enqueueAdminAssets(): void
    {
        if ($this->isReviewAdminPage()) {
            $this->enqueueAsset('css', ['suffix' => 'admin']);
            $this->enqueueAsset('js', ['suffix' => 'admin']);
        }
    }

/**
     * @action wp_enqueue_scripts
     */
    public function enqueuePublicAssets(): void
    {
        if (!glsr(AssetCss::class)->canOptimize() || !glsr(AssetCss::class)->isOptimized()) {
            $this->enqueueAsset('css');
        }
        if (!glsr(AssetJs::class)->canOptimize() || !glsr(AssetJs::class)->isOptimized()) {
            $this->enqueueAsset('js', ['in_footer' => true]);
        }
    }

/**
     * @filter plugin_action_links_{$this->app()->id}/{$this->app()->id}.php
     */
    public function filterActionLinks(array $links): array
    {
        $actions = [];
        if (glsr()->hasPermission('settings') && !empty($this->app()->config('settings'))) {
            $actions['settings'] = glsr_admin_link("settings.addons.{$this->app()->slug}", _x('Settings', 'admin-text', 'site-reviews'));
        }
        return array_merge($actions, $links);
    }

/**
     * @filter site-reviews/capabilities
     */
    public function filterCapabilities(array $capabilities): array
    {
        if (!$this->app()->hasPostType()) {
            return $capabilities;
        }
        $defaults = [
            'create_posts',
            'delete_others_posts',
            'delete_posts',
            'delete_private_posts',
            'delete_published_posts',
            'edit_others_posts',
            'edit_posts',
            'edit_private_posts',
            'edit_published_posts',
            'publish_posts',
            'read_private_posts',
        ];
        foreach ($defaults as $capability) {
            $capabilities[] = str_replace('post', $this->app()->post_type, $capability);
        }
        return $capabilities;
    }

/**
     * @filter site-reviews/config
     */
    public function filterConfigPath(string $path): string
    {
        $prefix = trailingslashit($this->app()->id);
        return str_contains($path, $prefix)
            ? $prefix.str_replace($prefix, '', $path)
            : $path;
    }

/**
     * @filter site-reviews/addon/documentation
     */
    public function filterDocumentation(array $documentation): array
    {
        $notice = glsr()->build('views/partials/addons/support-notice', [
            'addon_id' => $this->app()->id,
        ]);
        $support = $this->app()->build('views/documentation');
        $documentation[$this->app()->id] = $notice.$support;
        return $documentation;
    }

/**
     * @filter site-reviews/path
     */
    public function filterFilePaths(string $path, string $file): string
    {
        $addonPrefix = trailingslashit($this->app()->id);
        return str_starts_with($file, $addonPrefix)
            ? $this->app()->path(Str::replaceFirst($addonPrefix, '', $file))
            : $path;
    }

/**
     * @param string $translation
     * @param string $single
     *
     * @filter gettext_{$this->app()->id}
     */
    public function filterGettext($translation, $single): string
    {
        $translation = Cast::toString($translation);
        return glsr(Translator::class)->translate($translation, $this->app()->id, [
            'single' => Cast::toString($single),
        ]);
    }

/**
     * @param string $translation
     * @param string $single
     * @param string $context
     *
     * @filter gettext_with_context_{$this->app()->id}
     */
    public function filterGettextWithContext($translation, $single, $context): string
    {
        $translation = Cast::toString($translation);
        return glsr(Translator::class)->translate($translation, $this->app()->id, [
            'context' => Cast::toString($context),
            'single' => Cast::toString($single),
        ]);
    }

/**
     * @filter site-reviews/enqueue/public/localize
     */
    public function filterLocalizedPublicVariables(array $variables): array
    {
        $variables['addons'][$this->app()->id] = null;
        return $variables;
    }

/**
     * @param string $translation
     * @param string $single
     * @param string $plural
     * @param int    $number
     *
     * @filter ngettext_{$this->app()->id}
     */
    public function filterNgettext($translation, $single, $plural, $number): string
    {
        $translation = Cast::toString($translation);
        return glsr(Translator::class)->translate($translation, $this->app()->id, [
            'number' => Cast::toInt($number),
            'plural' => Cast::toString($plural),
            'single' => Cast::toString($single),
        ]);
    }

/**
     * @param string $translation
     * @param string $single
     * @param string $plural
     * @param int    $number
     * @param string $context
     *
     * @filter ngettext_with_context_{$this->app()->id}
     */
    public function filterNgettextWithContext($translation, $single, $plural, $number, $context): string
    {
        $translation = Cast::toString($translation);
        return glsr(Translator::class)->translate($translation, $this->app()->id, [
            'context' => Cast::toString($context),
            'number' => Cast::toInt($number),
            'plural' => Cast::toString($plural),
            'single' => Cast::toString($single),
        ]);
    }

/**
     * @filter {$this->app()->hookPrefix()}/render/view
     */
    public function filterRenderView(string $view): string
    {
        $style = glsr(OptionManager::class)->get('settings.general.style', 'default');
        $styledView = sprintf('views/styles/%s/%s', $style, basename($view));
        if (file_exists($this->app()->file($styledView))) {
            return $styledView;
        }
        return $view;
    }

/**
     * @filter site-reviews/roles
     */
    public function filterRoles(array $roles): array
    {
        if (!$this->app()->hasPostType()) {
            return $roles;
        }
        $defaults = [
            'administrator' => [
                'create_posts',
                'delete_others_posts',
                'delete_posts',
                'delete_private_posts',
                'delete_published_posts',
                'edit_others_posts',
                'edit_posts',
                'edit_private_posts',
                'edit_published_posts',
                'publish_posts',
                'read_private_posts',
            ],
            'editor' => [
                'create_posts',
                'delete_others_posts',
                'delete_posts',
                'delete_private_posts',
                'delete_published_posts',
                'edit_others_posts',
                'edit_posts',
                'edit_private_posts',
                'edit_published_posts',
                'publish_posts',
                'read_private_posts',
            ],
            'author' => [
                'create_posts',
                'delete_posts',
                'delete_published_posts',
                'edit_posts',
                'edit_published_posts',
                'publish_posts',
            ],
            'contributor' => [
                'delete_posts',
                'edit_posts',
            ],
        ];
        foreach ($defaults as $role => $capabilities) {
            if (!array_key_exists($role, $roles)) {
                continue;
            }
            foreach ($capabilities as $capability) {
                $roles[$role][] = str_replace('post', $this->app()->post_type, $capability);
            }
        }
        return $roles;
    }

/**
     * @filter plugin_row_meta
     */
    public function filterRowMeta(array $links, string $file): array
    {
        if ($file !== $this->app()->basename) {
            return $links;
        }
        $actions = [];
        if (glsr()->hasPermission('documentation')) {
            $actions['documentation'] = glsr_admin_link('documentation.addons', [
                'data-expand' => "#addon-{$this->app()->id}",
                'text' => _x('Documentation', 'admin-text', 'site-reviews'),
            ]);
        }
        $actions['support'] = glsr_premium_link('support', [
            'aria-label' => _x('Visit premium customer support', 'admin-text', 'site-reviews'),
            'text' => _x('Support', 'admin-text', 'site-reviews'),
        ]);
        return array_merge($links, $actions);
    }

/**
     * Merges the addon's settings config into the shared settings form,
     * remounting keys at the addon's composed-view path. A depends_on key
     * names a setting and is mounted the same way, so a config can be written
     * entirely in short keys and stay correct in both shapes.
     *
     * @filter site-reviews/settings
     */
    public function filterSettings(array $settings): array
    {
        $config = [];
        $standalone = "settings.addons.{$this->app()->slug}.";
        $prefix = "settings.{$this->app()->settingsPath()}.";
        $mount = function (string $key) use ($standalone, $prefix): string {
            if (str_starts_with($key, 'settings.addons.')) {
                return str_starts_with($key, $standalone)
                    ? $prefix.substr($key, strlen($standalone)) // this addon's own standalone-era spelling
                    : $key; // another addon's, already qualified
            }
            return $prefix.Str::removePrefix($key, 'settings.');
        };
        foreach ($this->app()->config('settings') as $key => $values) {
            if (!empty($values['depends_on']) && is_array($values['depends_on'])) {
                $values['depends_on'] = array_combine(
                    array_map($mount, array_keys($values['depends_on'])),
                    $values['depends_on']
                );
            }
            $config[$mount($key)] = $values;
        }
        return array_merge($config, $settings);
    }

/**
     * @filter site-reviews/addon/subsubsub
     */
    public function filterSubsubsub(array $subsubsub): array
    {
        return $subsubsub;
    }

/**
     * @filter site-reviews/translation/entries
     */
    public function filterTranslationEntries(array $entries): array
    {
        $addon = $this->app();
        if ($addon instanceof Addon && $addon->hostedBy()) {
            return $entries; // the host's catalog carries the hosted addon's strings
        }
        $potFile = $addon->path("{$addon->languages}/{$addon->id}.pot");
        return glsr(Translation::class)->extractEntriesFromPotFile($potFile, $addon->id, $entries);
    }

/**
     * @filter site-reviews/translator/domains
     */
    public function filterTranslatorDomains(array $domains): array
    {
        $addon = $this->app();
        if ($addon instanceof Addon && $addon->hostedBy()) {
            return $domains; // hosted addons translate under the host's domain
        }
        return [...$domains, $addon->id];
    }

/**
     * @action {$this->app()->hookPrefix()}/activated
     */
    public function install(): void
    {
    }

/**
     * Migrates legacy addon settings (stored in the core plugin's option) to
     * the addon's own option. One-shot: skipped once the addon's option exists.
     * The legacy subtree is copied, not deleted — it is shadowed by the composed
     * settings view and garbage-collected on the next settings save; leaving it
     * in place protects downgrades to older addon versions.
     *
     * @action admin_init:5
     * @action {$this->app()->hookPrefix()}/activated
     */
    public function migrateOptions(): void
    {
        $addon = $this->app();
        if (!$addon instanceof Addon || 'settings' !== $addon->storagePath()) {
            return;
        }
        if ($addon->isHost()) {
            return; // a host imports its own state
        }
        $key = $addon->storageKey();
        $stored = get_option($key);
        if (is_array($stored) && !OptionManager::isAddonRow($stored)) {
            // The key holds the addon's own data (see OptionManager::isAddonRow).
            // Strip the stale stamps v8.2.0/v8.2.1 wrote into it; the addon's
            // settings stay in the parent's row until the addon vacates the key.
            $stripped = array_diff_key($stored, array_flip(['version', 'version_upgraded_from']));
            if ($stripped === $stored) {
                return; // the addon's own data; the key is taken
            }
            if (!empty($stripped)) {
                update_option($key, $stripped, true);
                return; // the addon's own data, now clean of the stale stamps
            }
            delete_option($key); // only stale stamps held the key; migrate below
            $stored = false;
        }
        if (false !== $stored) {
            return;
        }
        $legacy = Arr::consolidate(glsr(OptionManager::class)->wp(OptionManager::databaseKey(), []));
        $legacy = Arr::getAs('array', $legacy, "settings.addons.{$addon->slug}");
        add_option($key, [
            'settings' => $legacy,
            'version' => $addon->version,
        ], '', true);
        glsr()->discard('settings'); // recompose the settings view
    }

/**
     * @action admin_init
     */
    public function onActivation(): void
    {
        $option = glsr()->prefix."activated_{$this->app()->id}";
        if (empty(get_option($option))) {
            update_option($option, true);
            if ($this->app()->post_type) {
                glsr(Role::class)->reset($this->filterRoles([
                    'administrator' => [],
                    'author' => [],
                    'contributor' => [],
                    'editor' => [],
                ]));
            }
            $this->app()->action('activated');
        }
    }

/**
     * @action deactivate_{$this->app()->basename}
     */
    public function onDeactivation(bool $isNetworkDeactivation): void
    {
        $option = glsr()->prefix."activated_{$this->app()->id}";
        if (!$isNetworkDeactivation) {
            delete_option($option);
            $this->app()->action('deactivated');
            return;
        }
        foreach (glsr(Install::class)->sites() as $siteId) {
            switch_to_blog($siteId);
            delete_option($option);
            $this->app()->action('deactivated');
            restore_current_blog();
        }
    }

/**
     * @action init
     */
    public function registerLanguages(): void
    {
        $path = plugin_basename($this->app()->path());
        $path = trailingslashit("{$path}/{$this->app()->languages}");
        load_plugin_textdomain($this->app()->id, false, $path);
    }

/**
     * @action init
     */
    public function registerShortcodes(): void
    {
    }

/**
     * @action admin_init
     */
    public function registerTinymcePopups(): void
    {
    }

/**
     * @action widgets_init
     */
    public function registerWidgets(): void
    {
    }

/**
     * @action site-reviews/settings/{$this->app()->slug}
     */
    public function renderSettings(string $rows): void
    {
        glsr(Template::class)->render("{$this->app()->id}/views/settings", [
            'context' => [
                'rows' => $rows,
                'title' => $this->app()->name,
            ],
        ]);
    }

protected function buildAssetArgs(string $ext, array $args = []): array
    {
        $args = wp_parse_args($args, [
            'defer' => true,
            'in_footer' => false,
            'suffix' => '',
        ]);
        $suffix = Str::prefix($args['suffix'], '-');
        $path = "assets/{$this->app()->id}{$suffix}.{$ext}";
        if (!file_exists($this->app()->path($path)) || !in_array($ext, ['css', 'js'])) {
            return [];
        }
        $suffix = Str::prefix($args['suffix'], '/');
        $dependencies = Arr::get($args, 'dependencies', [glsr()->id.$suffix]);
        $handle = $this->app()->id.$suffix;
        $funcArgs = [
            $handle,
            $this->app()->url($path),
            Arr::consolidate($dependencies),
            $this->app()->version,
        ];
        if ('js' === $ext && wp_validate_boolean($args['in_footer'])) {
            $funcArgs[] = true; // load script in the footer
        }
        return $funcArgs;
    }

protected function enqueueAsset(string $extension, array $args = []): void
    {
        $defer = Arr::get($args, 'defer', false);
        if ($args = $this->buildAssetArgs($extension, $args)) {
            if ('js' === $extension) {
                call_user_func_array('wp_register_script', $args);
                call_user_func('wp_enqueue_script', $args[0]);
            } else {
                call_user_func_array('wp_register_style', $args);
                call_user_func('wp_enqueue_style', $args[0]);
            }
            if (wp_validate_boolean($defer)) {
                wp_script_add_data($args[0], 'strategy', 'defer');
            }
        }
    }

protected function registerAsset(string $extension, array $args = []): void
    {
        $defer = Arr::get($args, 'defer', false);
        if ($args = $this->buildAssetArgs($extension, $args)) {
            $function = 'js' === $extension
                ? 'wp_register_script'
                : 'wp_register_style';
            call_user_func_array($function, $args);
            if (wp_validate_boolean($defer)) {
                wp_script_add_data($args[0], 'strategy', 'defer');
            }
        }
    }
}