Your IP : 3.144.26.11
<?php
/**
* Zip AI - Admin Configurations.
*
* @package zip-ai
*/
namespace ZipAI\Classes;
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
// Classes to be used, in alphabetical order.
use ZipAI\Classes\Helper;
use ZipAI\Classes\Module;
use ZipAI\Classes\Utils;
/**
* The Admin_Configurations Class.
*/
class Admin_Configurations {
/**
* The menu slug.
*
* @since 1.0.0
* @var string Menu slug.
*/
private $menu_slug = ZIP_AI_MENU_SLUG;
/**
* Instance of this class.
*
* @since 1.0.0
* @var object Class object.
*/
private static $instance;
/**
* Custom Capability
*
* @since 1.1.8
* @access public
* @var string capabilities.
*/
public static $custom_capability = 'manage_zip_ai_assistant';
/**
* Initiator of this class.
*
* @since 1.0.0
* @return object initialized object of this class.
*/
public static function get_instance() {
if ( ! isset( self::$instance ) ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Constructor of this class.
*
* @since 1.0.0
* @return void
*/
public function __construct() {
// Setup the Admin Scripts.
// add_action( 'admin_init', array( $this, 'settings_admin_scripts' ) ); - This can be added later if required.
// Verify Zip AI Authorization.
add_action( 'admin_init', array( $this, 'verify_authorization' ) );
/**
* This action hook is used to add custom capabilities to the administrator role.
* The custom capability is 'manage_zip_ai_assistant'.
* This action hook is triggered when the admin initiates, meaning when the admin
* goes to the admin dashboard, this action hook is triggered.
* The priority of this action hook is set to 10, meaning it will be executed before
* other action hooks with lower priorities.
* The callback function for this action hook is the 'add_custom_capabilities' method
* of the same class.
*/
add_action( 'admin_init', array( $this, 'add_custom_capabilities' ), 10 );
// Setup the Admin Menu Page.
// add_action( 'admin_menu', array( $this, 'setup_menu_page' ) ); - This can be added later if required.
// Setup the Admin Ajax Actions.
add_action( 'wp_ajax_zip_ai_toggle_assistant_status_ajax', array( $this, 'toggle_assistant_status_ajax' ) );
add_action( 'wp_ajax_zip_ai_disabler_ajax', array( $this, 'disabler_ajax' ) );
}
/**
* Add custom capabilities.
*
* @since 1.1.8
* @return void
*/
public function add_custom_capabilities() {
// Remove the custom capability from all roles except the roles specified in the filter.
$this->remove_custom_capability_from_other_roles();
/**
* Get the additional roles to add the custom capability.
*
* The additional roles are filtered by the `zip_ai_assistant_capability_additional_roles` filter.
* If this filter is not used, then only the 'administrator' role will get the custom capability.
* The default additional roles are 'administrator' and 'editor'.
*
* @since 1.1.8
*
* @return array The additional roles to add the custom capability.
*/
$roles = apply_filters(
'zip_ai_assistant_capability_additional_roles',
array( 'administrator', 'editor' )
);
// Loop through each role and add the custom capability to the role object.
foreach ( $roles as $role_slug ) {
// Get the role object by the role slug.
$role_object = get_role( $role_slug );
// Check if the role object exists.
if ( $role_object ) {
// Add the custom capability to the role object.
$role_object->add_cap( self::$custom_capability );
}
}
}
/**
* Remove custom capabilities.
*
* @since 1.1.8
* @return void
*/
public function remove_custom_capability_from_other_roles() {
// Set the default role to retain the custom capability.
$default_role = 'administrator';
// Get the default role object.
$default_role_object = get_role( $default_role );
// Remove the custom capability from all roles except the default role.
// Here, we are iterating through all the roles and removing the custom capability
// from each role except the default role.
if ( $default_role_object ) {
// Get all the role names.
$roles = wp_roles()->role_names;
// Exclude the default role from the list of roles.
unset( $roles[ $default_role ] );
// Loop through each role.
foreach ( $roles as $role_slug => $role_name ) {
// Get the role object by the role slug.
$role_object = get_role( $role_slug );
// Check if the role object exists and if the role object has the custom capability.
if ( $role_object && $role_object->has_cap( self::$custom_capability ) ) {
// Remove the custom capability from the role object.
$role_object->remove_cap( self::$custom_capability );
}
}
}
}
/**
* Add the Zip AI menu page.
*
* @since 1.0.0
* @return void
*/
public function setup_menu_page() {
// If the current user does not have the required capability, then abandon ship.
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
$capability = 'manage_options';
// Add the Zip AI Submenu.
add_submenu_page(
apply_filters( 'zip_ai_parent_page', 'none' ), // The parent page of this menu.
apply_filters( 'zip_ai_page_title', 'Zip - AI Assistant' ), // The page title.
apply_filters( 'zip_ai_menu_title', 'Zip - AI Assistant' ), // The menu title.
apply_filters( 'zip_ai_menu_capability', $capability ), // The capability required for access to this page.
$this->menu_slug, // The menu slug.
array( $this, 'render_dashboard' ), // The rendered output function.
apply_filters( 'zip_ai_menu_position', 1 ) // The position of this menu item in the menu.
);
}
/**
* Verify if the user was given authorization to use Zip AI.
*
* @since 1.0.0
* @return void
*/
public function verify_authorization() {
// If the current user does not have the required capability or the referrer is empty, then abandon ship.
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
// Get the nonce.
$nonce = ( isset( $_GET['nonce'] ) ) ? sanitize_key( $_GET['nonce'] ) : '';
// If the nonce is not valid, or if there's no token, then abandon ship.
if ( false === wp_verify_nonce( $nonce, 'zip_ai_auth_nonce' ) ) {
return;
}
// Redirect to the settings page if the user is trying to revoke the token.
if ( isset( $_GET['revoke_zip_ai_authorization_token'] ) && 'definitely' === sanitize_text_field( $_GET['revoke_zip_ai_authorization_token'] ) ) {
// Clear out the Zip AI settings and disconnect the user.
Helper::update_admin_settings_option( 'zip_ai_settings', [ 'status' => 'disconnected' ] );
// Redirect to the settings page.
$redirection_url = apply_filters( 'zip_ai_revoke_redirection_url', admin_url() );
wp_safe_redirect( $redirection_url );
exit;
}//end if
// If none of the required data is received, abandon ship.
if ( ! isset( $_GET['credit_token'] ) && ! isset( $_GET['token'] ) && ! isset( $_GET['email'] ) ) {
return;
}
// Get the existing options, and update the auth token before updating the option.
$db_settings_options = Helper::get_setting();
// At this point, the user is connected with Zip AI.
$db_settings_options['status'] = 'connected';
// Update the auth token if needed.
if ( isset( $_GET['credit_token'] ) && is_string( $_GET['credit_token'] ) ) {
$db_settings_options['auth_token'] = Utils::encrypt( sanitize_text_field( $_GET['credit_token'] ) );
}
// Update the Zip token if needed.
if ( isset( $_GET['token'] ) && is_string( $_GET['token'] ) ) {
$db_settings_options['zip_token'] = Utils::encrypt( sanitize_text_field( $_GET['token'] ) );
}
// Update the email if needed.
if ( isset( $_GET['email'] ) && is_string( $_GET['email'] ) ) {
$db_settings_options['email'] = sanitize_email( $_GET['email'] );
}
// Update the Zip AI settings.
Helper::update_admin_settings_option( 'zip_ai_settings', $db_settings_options );
// Redirect to the settings page.
if ( apply_filters( 'zip_ai_auth_redirection_flag', true ) ) {
$redirection_url = apply_filters( 'zip_ai_auth_redirection_url', admin_url( 'admin.php?page=zip-ai' ) );
wp_safe_redirect( $redirection_url );
exit;
}
}
/**
* Setup the Ajax Event to Entirely Disable the Zip AI Library from loading.
*
* @since 1.0.5
* @return void
*/
public function disabler_ajax() {
// If the current user does not have the required capability, then abandon ship.
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error();
}
// Verify the nonce.
check_ajax_referer( 'zip_ai_admin_nonce', 'nonce' );
// Have a variable to check if the module was disabled.
$is_module_disabled = false;
// Check if the Zip AI Assistant was requested to be disabled.
if ( ! empty( $_POST['disable_zip_ai_assistant'] ) ) {
$is_module_disabled = Module::disable( 'ai_assistant' );
}
// Send the status based on whether the Zip AI Library is enabled or not.
if ( $is_module_disabled ) {
wp_send_json_success();
} else {
wp_send_json_error();
}
}
/**
* Setup the AI Assistant Toggle Ajax.
*
* @since 1.0.0
* @return void
*/
public function toggle_assistant_status_ajax() {
// If the current user does not have the required capability, then abandon ship.
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error();
}
// Verify the nonce.
check_ajax_referer( 'zip_ai_admin_nonce', 'nonce' );
// If the Zip options is not an array, then send an error.
if ( empty( $_POST['enable_zip_chat'] ) || ! is_string( $_POST['enable_zip_chat'] ) ) {
wp_send_json_error();
}
// Create a variable to check if the assistant module was toggled.
$is_module_toggled = false;
// Update the enabled status.
if ( 'enabled' === sanitize_text_field( $_POST['enable_zip_chat'] ) ) {
$is_module_toggled = Module::enable( 'ai_assistant' );
} else {
$is_module_toggled = Module::disable( 'ai_assistant' );
}
// Send the status based on whether the module was toggled.
if ( $is_module_toggled ) {
wp_send_json_success();
} else {
wp_send_json_error();
}
}
/**
* Render the Zip AI Admin Settings Page.
*
* @since 1.0.0
* @return void
*/
public function render_dashboard() {
// Render the dashboard app div.
?>
<div id="zip-ai__dashboard-app--wrapper">
<div id="zip-ai-dashboard-app" class="zip-ai-dashboard-app"></div>
</div>
<?php
}
/**
* Load the Admin Settings and Scripts on initialization.
*
* @since 1.0.0
* @return void
*/
public function settings_admin_scripts() {
// If the current page is not the Zip AI Settings page, then abandon ship.
if ( empty( $_GET['page'] ) || ( $this->menu_slug !== $_GET['page'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
return;
}
// Enqueue the Admin Styles and Scripts for the React App.
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_styles_and_scripts' ) );
// Add the footer link if needed.
if ( Helper::is_authorized() ) {
// Add the footer link.
add_filter( 'admin_footer_text', array( $this, 'add_footer_link' ), 99 );
}
}
/**
* Enqueues the needed CSS/JS for Zip AI's admin settings page.
*
* @since 1.0.0
* @return void
*/
public function enqueue_styles_and_scripts() {
if ( class_exists( '\UAGB_Admin_Helper' ) && method_exists( '\UAGB_Admin_Helper', 'should_exclude_assets_for_cpt' ) ) {
if ( \UAGB_Admin_Helper::should_exclude_assets_for_cpt() ) {
return; // Early return to prevent loading assets.
}
}
// Enqueue the admin Google Fonts and WP Components.
$admin_slug = 'zip-ai-admin';
wp_enqueue_style(
$admin_slug . '-font',
'https://fonts.googleapis.com/css2?family=Inter:wght@400;500&display=swap',
array(),
ZIP_AI_VERSION
);
wp_enqueue_style( 'wp-components' );
// Set the default credit details.
$credit_details = array(
'used' => 0,
'total' => 0,
'threshold' => array(
'medium' => ZIP_AI_CREDIT_THRESHOLD_MEDIUM,
'high' => ZIP_AI_CREDIT_THRESHOLD_HIGH,
),
'percentage' => 0,
);
// Get the response from the endpoint.
$response = Helper::get_credit_server_response( 'usage' );
// If the response is not an error, then update the credit details.
if (
empty( $response['error'] )
&& ! empty( $response['total_credits'] )
) {
$credit_details['used'] = ! empty( $response['total_used_credits'] ) ? $response['total_used_credits'] : 0;
$credit_details['total'] = $response['total_credits'];
$credit_details['percentage'] = intval( ( $credit_details['used'] / $credit_details['total'] ) * 100 );
}
// Add the data to localize.
$localize = apply_filters(
'zip_ai_admin_localize',
array(
'admin_url' => admin_url(),
'ajax_url' => admin_url( 'admin-ajax.php' ),
'auth_middleware' => Helper::get_auth_middleware_url(),
'auth_revoke_url' => Helper::get_auth_revoke_url(),
'credit_topup_url' => ZIP_AI_CREDIT_TOPUP_URL,
'is_authorized' => Helper::is_authorized(),
'is_ai_assistant_enabled' => Module::is_enabled( 'ai_assistant' ),
'admin_nonce' => wp_create_nonce( 'zip_ai_admin_nonce' ),
'page_slug' => $this->menu_slug,
'credit_details' => Helper::get_credit_details(),
)
);
// Enqueue the admin scripts.
$this->localize_and_enqueue_admin_scripts( $localize );
}
/**
* Localize and Enqueue the Admin Scripts.
*
* @param array $localize The data to localize.
* @since 1.0.0
* @return void
*/
public function localize_and_enqueue_admin_scripts( $localize ) {
// Set the required variables.
$handle = 'zip-ai-admin-settings';
$build_path = ZIP_AI_DIR . 'admin/dashboard-app/build/';
$build_url = ZIP_AI_URL . 'admin/dashboard-app/build/';
$script_asset_path = $build_path . 'dashboard-app.asset.php';
$script_info = file_exists( $script_asset_path )
? include $script_asset_path
: array(
'dependencies' => array(),
'version' => ZIP_AI_VERSION,
);
$script_dep = array_merge( $script_info['dependencies'], array( 'updates' ) );
// Register the admin scripts.
wp_register_script(
$handle,
$build_url . 'dashboard-app.js',
$script_dep,
$script_info['version'],
true
);
// Register the admin styles.
wp_register_style(
$handle,
$build_url . 'dashboard-app.css',
array(),
ZIP_AI_VERSION
);
// Register the admin Google Fonts.
wp_register_style(
'zip-ai-admin-google-fonts',
'https://fonts.googleapis.com/css2?family=Inter:wght@200&display=swap',
array(),
ZIP_AI_VERSION
);
// Enqueue the admin scripts.
wp_enqueue_script( $handle );
// Set the script translations.
wp_set_script_translations( $handle, apply_filters( 'zip_ai_library_textdomain', 'zip-ai' ) );
// Enqueue the Google Fonts.
wp_enqueue_style( 'zip-ai-admin-google-fonts' );
// Enqueue the admin styles.
wp_enqueue_style( $handle );
// Set the RTL styles.
wp_style_add_data( $handle, 'rtl', 'replace' );
// Localize the script.
wp_localize_script( $handle, 'zip_ai_react', $localize );
}
/**
* Add the footer link.
*
* @since 1.0.0
* @return string The footer link.
*/
public function add_footer_link() {
return '<span id="footer-thankyou">' . sprintf(
/* translators: %1$s: HTML link start tag, %2$s: HTML link end tag. */
__( 'Thank you for using %1$sZip AI.%2$s', 'astra-sites' ),
'<a href="https://wpspectra.com/zip-ai/" class="focus:text-spec-hover active:text-spec-hover hover:text-spec-hover" target="_blank" rel="noopener noreferrer">',
'</a>'
) . '</span>';
}
}