assistants.php
3 years ago
chatbot.php
2 years ago
chatbot_legacy.php
2 years ago
discussions.php
2 years ago
security.php
3 years ago
chatbot.php
494 lines
| 1 | <?php |
| 2 | |
| 3 | // Params for the chatbot (front and server) |
| 4 | |
| 5 | define( 'MWAI_CHATBOT_FRONT_PARAMS', [ 'id', 'customId', 'aiName', 'userName', 'guestName', |
| 6 | 'textSend', 'textClear', |
| 7 | 'textInputPlaceholder', 'textInputMaxLength', 'textCompliance', 'startSentence', 'localMemory', |
| 8 | 'themeId', 'window', 'icon', 'iconText', 'iconAlt', 'iconPosition', 'fullscreen', 'copyButton' |
| 9 | ] ); |
| 10 | define( 'MWAI_CHATBOT_SERVER_PARAMS', [ 'id', 'env', 'mode', 'contentAware', 'embeddingsIndex', 'context', |
| 11 | 'casuallyFineTuned', 'promptEnding', 'completionEnding', 'model', 'temperature', 'maxTokens', |
| 12 | 'maxResults', 'apiKey', 'service' |
| 13 | ] ); |
| 14 | |
| 15 | // Params for the discussions (front and server) |
| 16 | |
| 17 | define( 'MWAI_DISCUSSIONS_FRONT_PARAMS', [ 'themeId', 'textNewChat' ] ); |
| 18 | define( 'MWAI_DISCUSSIONS_SERVER_PARAMS', [ 'customId' ] ); |
| 19 | |
| 20 | class Meow_MWAI_Modules_Chatbot { |
| 21 | private $core = null; |
| 22 | private $namespace = 'mwai-ui/v1'; |
| 23 | private $siteWideChatId = null; |
| 24 | |
| 25 | public function __construct() { |
| 26 | global $mwai_core; |
| 27 | $this->core = $mwai_core; |
| 28 | add_shortcode( 'mwai_chatbot_v2', array( $this, 'chat_shortcode' ) ); |
| 29 | add_action( 'rest_api_init', array( $this, 'rest_api_init' ) ); |
| 30 | $this->siteWideChatId = $this->core->get_option( 'botId' ); |
| 31 | add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts' ) ); |
| 32 | |
| 33 | if ( $this->core->get_option( 'shortcode_chat_discussions' ) ) { |
| 34 | add_shortcode( 'mwai_discussions', [ $this, 'shortcode_chat_discussions' ] ); |
| 35 | } |
| 36 | } |
| 37 | |
| 38 | public function register_scripts() { |
| 39 | $physical_file = trailingslashit( MWAI_PATH ) . 'app/chatbot.js'; |
| 40 | $cache_buster = file_exists( $physical_file ) ? filemtime( $physical_file ) : MWAI_VERSION; |
| 41 | wp_register_script( 'mwai_chatbot', trailingslashit( MWAI_URL ) . 'app/chatbot.js', |
| 42 | [ 'wp-element' ], $cache_buster, false ); |
| 43 | if ( !empty( $this->siteWideChatId ) && $this->siteWideChatId !== 'none' ) { |
| 44 | $this->enqueue_scripts(); |
| 45 | add_action( 'wp_footer', array( $this, 'inject_chat' ) ); |
| 46 | } |
| 47 | } |
| 48 | |
| 49 | public function enqueue_scripts() { |
| 50 | wp_enqueue_script( "mwai_chatbot" ); |
| 51 | if ( $this->core->get_option( 'shortcode_chat_syntax_highlighting' ) ) { |
| 52 | wp_enqueue_script( "mwai_highlight" ); |
| 53 | } |
| 54 | } |
| 55 | |
| 56 | public function rest_api_init() { |
| 57 | register_rest_route( $this->namespace, '/chats/submit', array( |
| 58 | 'methods' => 'POST', |
| 59 | 'callback' => array( $this, 'rest_chat' ), |
| 60 | 'permission_callback' => '__return_true' |
| 61 | ) ); |
| 62 | |
| 63 | } |
| 64 | |
| 65 | public function basics_security_check( $botId, $customId, $newMessage ) { |
| 66 | if ( empty( $newMessage ) ) { |
| 67 | error_log("AI Engine: The query was rejected - message was empty."); |
| 68 | return false; |
| 69 | } |
| 70 | if ( !$botId && !$customId ) { |
| 71 | error_log("AI Engine: The query was rejected - no botId nor id was specified."); |
| 72 | return false; |
| 73 | } |
| 74 | |
| 75 | $length = strlen( $newMessage ); |
| 76 | if ( $length < 1 || $length > ( 4096 * 16 ) ) { |
| 77 | error_log("AI Engine: The query was rejected - message was too short or too long."); |
| 78 | return false; |
| 79 | } |
| 80 | return true; |
| 81 | } |
| 82 | |
| 83 | public function rest_chat( $request ) { |
| 84 | $params = $request->get_json_params(); |
| 85 | $botId = $params['botId'] ?? null; |
| 86 | $customId = $params['customId'] ?? null; |
| 87 | $stream = $params['stream'] ?? false; |
| 88 | $newMessage = trim( $params['newMessage'] ?? '' ); |
| 89 | |
| 90 | if ( !$this->basics_security_check( $botId, $customId, $newMessage )) { |
| 91 | return new WP_REST_Response( [ |
| 92 | 'success' => false, |
| 93 | 'message' => apply_filters( 'mwai_ai_exception', 'Sorry, your query has been rejected.' ) |
| 94 | ], 403 ); |
| 95 | } |
| 96 | |
| 97 | try { |
| 98 | $data = $this->chat_submit( $botId, $newMessage, $params, $stream ); |
| 99 | return new WP_REST_Response( [ |
| 100 | 'success' => true, |
| 101 | 'reply' => $data['reply'], |
| 102 | 'images' => $data['images'], |
| 103 | 'usage' => $data['usage'] |
| 104 | ], 200 ); |
| 105 | } |
| 106 | catch ( Exception $e ) { |
| 107 | $message = apply_filters( 'mwai_ai_exception', $e->getMessage() ); |
| 108 | return new WP_REST_Response( [ |
| 109 | 'success' => false, |
| 110 | 'message' => $message |
| 111 | ], 500 ); |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | public function chat_submit( $botId, $newMessage, $params = [], $stream = false ) { |
| 116 | try { |
| 117 | $chatbot = null; |
| 118 | $customId = $params['customId'] ?? null; |
| 119 | |
| 120 | // Custom Chatbot |
| 121 | if ( $customId ) { |
| 122 | $chatbot = get_transient( 'mwai_custom_chatbot_' . $customId ); |
| 123 | } |
| 124 | // Registered Chatbot |
| 125 | if ( !$chatbot && $botId ) { |
| 126 | $chatbot = $this->core->getChatbot( $botId ); |
| 127 | } |
| 128 | |
| 129 | if ( !$chatbot ) { |
| 130 | error_log("AI Engine: No chatbot was found for this query."); |
| 131 | throw new Exception( 'Sorry, your query has been rejected.' ); |
| 132 | } |
| 133 | |
| 134 | // Create QueryText |
| 135 | $context = null; |
| 136 | $mode = $chatbot['mode'] ?? 'chat'; |
| 137 | |
| 138 | if ( $mode === 'images' ) { |
| 139 | $query = new Meow_MWAI_Query_Image( $newMessage ); |
| 140 | |
| 141 | // Handle Params |
| 142 | $newParams = []; |
| 143 | foreach ( $chatbot as $key => $value ) { |
| 144 | $newParams[$key] = $value; |
| 145 | } |
| 146 | foreach ( $params as $key => $value ) { |
| 147 | $newParams[$key] = $value; |
| 148 | } |
| 149 | $params = apply_filters( 'mwai_chatbot_params', $newParams ); |
| 150 | $params['env'] = empty( $params['env'] ) ? 'chatbot' : $params['env']; |
| 151 | $query->injectParams( $params ); |
| 152 | } |
| 153 | else { |
| 154 | $query = new Meow_MWAI_Query_Text( $newMessage, 1024 ); |
| 155 | $streamCallback = null; |
| 156 | |
| 157 | // Handle Params |
| 158 | $newParams = []; |
| 159 | foreach ( $chatbot as $key => $value ) { |
| 160 | $newParams[$key] = $value; |
| 161 | } |
| 162 | foreach ( $params as $key => $value ) { |
| 163 | $newParams[$key] = $value; |
| 164 | } |
| 165 | $params = apply_filters( 'mwai_chatbot_params', $newParams ); |
| 166 | $params['env'] = empty( $params['env'] ) ? 'chatbot' : $params['env']; |
| 167 | $query->injectParams( $params ); |
| 168 | |
| 169 | // Takeover |
| 170 | $takeoverAnswer = apply_filters( 'mwai_chatbot_takeover', null, $query, $params ); |
| 171 | if ( !empty( $takeoverAnswer ) ) { |
| 172 | return [ |
| 173 | 'reply' => $takeoverAnswer, |
| 174 | 'images' => null, |
| 175 | 'usage' => null |
| 176 | ]; |
| 177 | } |
| 178 | |
| 179 | // Moderation |
| 180 | if ( $this->core->get_option( 'shortcode_chat_moderation' ) ) { |
| 181 | global $mwai; |
| 182 | $isFlagged = $mwai->moderationCheck( $query->prompt ); |
| 183 | if ( $isFlagged ) { |
| 184 | throw new Exception( 'Sorry, your message has been rejected by moderation.' ); |
| 185 | } |
| 186 | } |
| 187 | |
| 188 | // Awareness & Embeddings |
| 189 | // TODO: This is same in Chatbot Legacy and Forms, maybe we should move it to the core? |
| 190 | $embeddingsIndex = $params['embeddingsIndex'] ?? null; |
| 191 | $embeddingsNamespace = $params['embeddingsNamespace'] ?? null; |
| 192 | if ( $query->mode === 'chat' ) { |
| 193 | $context = apply_filters( 'mwai_context_search', $context, $query, [ |
| 194 | 'embeddingsIndex' => $embeddingsIndex, |
| 195 | 'embeddingsNamespace' => $embeddingsNamespace |
| 196 | ] ); |
| 197 | if ( !empty( $context ) ) { |
| 198 | if ( isset( $context['content'] ) ) { |
| 199 | $content = $this->core->cleanSentences( $context['content'] ); |
| 200 | $query->injectContext( $content ); |
| 201 | } |
| 202 | else { |
| 203 | error_log( "AI Engine: A context without content was returned." ); |
| 204 | } |
| 205 | } |
| 206 | } |
| 207 | } |
| 208 | |
| 209 | // Process Query |
| 210 | if ( $stream ) { |
| 211 | $streamCallback = function( $reply ) { |
| 212 | //$raw = _wp_specialchars( $reply, ENT_NOQUOTES, 'UTF-8', true ); |
| 213 | $raw = $reply; |
| 214 | $this->stream_push( [ 'type' => 'live', 'data' => $raw ] ); |
| 215 | if ( ob_get_level() > 0 ) { |
| 216 | ob_flush(); |
| 217 | } |
| 218 | flush(); |
| 219 | }; |
| 220 | header( 'Cache-Control: no-cache' ); |
| 221 | header( 'Content-Type: text/event-stream' ); |
| 222 | header( 'X-Accel-Buffering: no' ); // This is useful to disable buffering in nginx through headers. |
| 223 | ob_implicit_flush( true ); |
| 224 | ob_end_flush(); |
| 225 | } |
| 226 | |
| 227 | $reply = $this->core->ai->run( $query, $streamCallback ); |
| 228 | $rawText = $reply->result; |
| 229 | $extra = []; |
| 230 | if ( $context ) { |
| 231 | $extra = [ 'embeddings' => $context['embeddings'] ]; |
| 232 | } |
| 233 | |
| 234 | $rawText = apply_filters( 'mwai_chatbot_reply', $rawText, $query, $params, $extra ); |
| 235 | // TODO: There is no need for the shortcode_chat_formatting sice Markdown is handled on the client side. |
| 236 | // if ( $this->core->get_option( 'shortcode_chat_formatting' ) ) { |
| 237 | // $html = $this->core->markdown_to_html( $rawText ); |
| 238 | // } |
| 239 | |
| 240 | $restRes = [ |
| 241 | 'reply' => $rawText, |
| 242 | 'images' => $reply->getType() === 'images' ? $reply->results : null, |
| 243 | 'usage' => $reply->usage |
| 244 | ]; |
| 245 | |
| 246 | // Process Reply |
| 247 | if ( $stream ) { |
| 248 | $this->stream_push( [ |
| 249 | 'type' => 'end', |
| 250 | 'data' => json_encode([ |
| 251 | 'success' => true, |
| 252 | 'reply' => $restRes['reply'], |
| 253 | 'images' => $restRes['images'], |
| 254 | 'usage' => $restRes['usage'] |
| 255 | ]) |
| 256 | ] ); |
| 257 | die(); |
| 258 | } |
| 259 | else { |
| 260 | return $restRes; |
| 261 | } |
| 262 | |
| 263 | } |
| 264 | catch ( Exception $e ) { |
| 265 | $message = apply_filters( 'mwai_ai_exception', $e->getMessage() ); |
| 266 | if ( $stream ) { |
| 267 | $this->stream_push( [ 'type' => 'error', 'data' => $message ] ); |
| 268 | die(); |
| 269 | } |
| 270 | else { |
| 271 | throw $e; |
| 272 | } |
| 273 | } |
| 274 | } |
| 275 | |
| 276 | public function stream_push( $data ) { |
| 277 | $out = "data: " . json_encode( $data ); |
| 278 | echo $out; |
| 279 | echo "\n\n"; |
| 280 | if (ob_get_level() > 0) { |
| 281 | ob_end_flush(); |
| 282 | } |
| 283 | flush(); |
| 284 | } |
| 285 | |
| 286 | public function inject_chat() { |
| 287 | $params = $this->core->getChatbot( $this->siteWideChatId ); |
| 288 | $cleanParams = []; |
| 289 | if ( !empty( $params ) ) { |
| 290 | $cleanParams['window'] = true; |
| 291 | $cleanParams['id'] = $this->siteWideChatId; |
| 292 | echo $this->chat_shortcode( $cleanParams ); |
| 293 | } |
| 294 | return null; |
| 295 | } |
| 296 | |
| 297 | public function build_front_params( $botId, $customId ) { |
| 298 | $frontSystem = [ |
| 299 | 'botId' => $botId, |
| 300 | 'customId' => $customId, |
| 301 | 'userData' => $this->core->getUserData(), |
| 302 | 'sessionId' => $this->core->get_session_id(), |
| 303 | 'restNonce' => $this->core->get_nonce(), |
| 304 | 'contextId' => get_the_ID(), |
| 305 | 'pluginUrl' => MWAI_URL, |
| 306 | 'restUrl' => untrailingslashit( rest_url() ), |
| 307 | 'debugMode' => $this->core->get_option( 'debug_mode' ), |
| 308 | 'typewriter' => $this->core->get_option( 'shortcode_chat_typewriter' ), |
| 309 | 'speech_recognition' => $this->core->get_option( 'speech_recognition' ), |
| 310 | 'speech_synthesis' => $this->core->get_option( 'speech_synthesis' ), |
| 311 | 'stream' => $this->core->get_option( 'shortcode_chat_stream' ), |
| 312 | ]; |
| 313 | return $frontSystem; |
| 314 | } |
| 315 | |
| 316 | public function resolveBotInfo( $atts ) |
| 317 | { |
| 318 | $chatbot = null; |
| 319 | $botId = $atts['id'] ?? null; |
| 320 | $customId = $atts['custom_id'] ?? null; |
| 321 | if (!$botId && !$customId) { |
| 322 | $botId = "default"; |
| 323 | } |
| 324 | if ( $botId ) { |
| 325 | $chatbot = $this->core->getChatbot( $botId ); |
| 326 | if (!$chatbot) { |
| 327 | $botId = $botId ?: 'N/A'; |
| 328 | return [ |
| 329 | 'error' => "AI Engine: Chatbot '{$botId}' not found. If you meant to set an ID for your custom chatbot, please use 'custom_id' instead of 'id'.", |
| 330 | ]; |
| 331 | } |
| 332 | } |
| 333 | $chatbot = $chatbot ?: $this->core->getChatbot( 'default' ); |
| 334 | if ( !empty( $customId ) ) { |
| 335 | $botId = null; |
| 336 | } |
| 337 | return [ |
| 338 | 'chatbot' => $chatbot, |
| 339 | 'botId' => $botId, |
| 340 | 'customId' => $customId, |
| 341 | ]; |
| 342 | } |
| 343 | |
| 344 | public function chat_shortcode( $atts ) { |
| 345 | $atts = empty($atts) ? [] : $atts; |
| 346 | |
| 347 | // Resolve the bot info |
| 348 | $resolvedBot = $this->resolveBotInfo( $atts ); |
| 349 | if ( isset( $resolvedBot['error'] ) ) { |
| 350 | return $resolvedBot['error']; |
| 351 | } |
| 352 | $chatbot = $resolvedBot['chatbot']; |
| 353 | $botId = $resolvedBot['botId']; |
| 354 | $customId = $resolvedBot['customId']; |
| 355 | |
| 356 | // Let the user override the chatbot params |
| 357 | $atts = apply_filters( 'mwai_chatbot_params', $atts, $chatbot ); |
| 358 | |
| 359 | // Rename the keys of the atts into camelCase to match the internal params system. |
| 360 | $atts = array_map( function( $key, $value ) { |
| 361 | $key = str_replace( '_', ' ', $key ); |
| 362 | $key = ucwords( $key ); |
| 363 | $key = str_replace( ' ', '', $key ); |
| 364 | $key = lcfirst( $key ); |
| 365 | return [ $key => $value ]; |
| 366 | }, array_keys( $atts ), $atts ); |
| 367 | $atts = array_merge( ...$atts ); |
| 368 | |
| 369 | $frontParams = []; |
| 370 | foreach ( MWAI_CHATBOT_FRONT_PARAMS as $param ) { |
| 371 | if ( isset( $atts[$param] ) ) { |
| 372 | if ( $param === 'localMemory' ) { |
| 373 | $frontParams[$param] = $atts[$param] === 'true'; |
| 374 | } |
| 375 | else { |
| 376 | $frontParams[$param] = $atts[$param]; |
| 377 | } |
| 378 | } |
| 379 | else if ( isset( $chatbot[$param] ) ) { |
| 380 | $frontParams[$param] = $chatbot[$param]; |
| 381 | } |
| 382 | } |
| 383 | |
| 384 | // Server Params |
| 385 | $serverParams = []; |
| 386 | foreach ( MWAI_CHATBOT_SERVER_PARAMS as $param ) { |
| 387 | if ( isset( $atts[$param] ) ) { |
| 388 | $serverParams[$param] = $atts[$param]; |
| 389 | } |
| 390 | } |
| 391 | |
| 392 | // Front Params |
| 393 | $frontSystem = $this->build_front_params( $botId, $customId ); |
| 394 | |
| 395 | // Clean Params |
| 396 | $frontParams = $this->cleanParams( $frontParams ); |
| 397 | $frontSystem = $this->cleanParams( $frontSystem ); |
| 398 | $serverParams = $this->cleanParams( $serverParams ); |
| 399 | |
| 400 | // Server-side: Keep the System Params |
| 401 | if ( count( $serverParams ) > 0 ) { |
| 402 | if ( empty( $customId ) ) { |
| 403 | $customId = md5( json_encode( $serverParams ) ); |
| 404 | $frontSystem['customId'] = $customId; |
| 405 | } |
| 406 | set_transient( 'mwai_custom_chatbot_' . $customId, $serverParams, 60 * 60 * 24 ); |
| 407 | } |
| 408 | |
| 409 | // Client-side: Prepare JSON for Front Params and System Params |
| 410 | $theme = isset( $frontParams['themeId'] ) ? $this->core->getTheme( $frontParams['themeId'] ) : null; |
| 411 | $jsonFrontParams = htmlspecialchars( json_encode( $frontParams ), ENT_QUOTES, 'UTF-8' ); |
| 412 | $jsonFrontSystem = htmlspecialchars( json_encode( $frontSystem ), ENT_QUOTES, 'UTF-8' ); |
| 413 | $jsonFrontTheme = htmlspecialchars( json_encode( $theme ), ENT_QUOTES, 'UTF-8' ); |
| 414 | //$jsonAttributes = htmlspecialchars(json_encode($atts), ENT_QUOTES, 'UTF-8'); |
| 415 | |
| 416 | $this->enqueue_scripts(); |
| 417 | return "<div class='mwai-chatbot-container' data-params='{$jsonFrontParams}' data-system='{$jsonFrontSystem}' data-theme='{$jsonFrontTheme}'></div>"; |
| 418 | } |
| 419 | |
| 420 | function shortcode_chat_discussions( $atts ) { |
| 421 | $atts = empty($atts) ? [] : $atts; |
| 422 | |
| 423 | // Resolve the bot info |
| 424 | $resolvedBot = $this->resolveBotInfo( $atts ); |
| 425 | if ( isset( $resolvedBot['error'] ) ) { |
| 426 | return $resolvedBot['error']; |
| 427 | } |
| 428 | $chatbot = $resolvedBot['chatbot']; |
| 429 | $botId = $resolvedBot['botId']; |
| 430 | $customId = $resolvedBot['customId']; |
| 431 | |
| 432 | // Rename the keys of the atts into camelCase to match the internal params system. |
| 433 | $atts = array_map( function( $key, $value ) { |
| 434 | $key = str_replace( '_', ' ', $key ); |
| 435 | $key = ucwords( $key ); |
| 436 | $key = str_replace( ' ', '', $key ); |
| 437 | $key = lcfirst( $key ); |
| 438 | return [ $key => $value ]; |
| 439 | }, array_keys( $atts ), $atts ); |
| 440 | $atts = array_merge( ...$atts ); |
| 441 | |
| 442 | // Front Params |
| 443 | $frontParams = []; |
| 444 | foreach ( MWAI_DISCUSSIONS_FRONT_PARAMS as $param ) { |
| 445 | if ( isset( $atts[$param] ) ) { |
| 446 | $frontParams[$param] = $atts[$param]; |
| 447 | } |
| 448 | else if ( isset( $chatbot[$param] ) ) { |
| 449 | $frontParams[$param] = $chatbot[$param]; |
| 450 | } |
| 451 | } |
| 452 | |
| 453 | // Server Params |
| 454 | $serverParams = []; |
| 455 | foreach ( MWAI_DISCUSSIONS_SERVER_PARAMS as $param ) { |
| 456 | if ( isset( $atts[$param] ) ) { |
| 457 | $serverParams[$param] = $atts[$param]; |
| 458 | } |
| 459 | } |
| 460 | |
| 461 | // Front System |
| 462 | $frontSystem = $this->build_front_params( $botId, $customId ); |
| 463 | |
| 464 | // Clean Params |
| 465 | $frontParams = $this->cleanParams( $frontParams ); |
| 466 | $frontSystem = $this->cleanParams( $frontSystem ); |
| 467 | $serverParams = $this->cleanParams( $serverParams ); |
| 468 | |
| 469 | $theme = isset( $frontParams['themeId'] ) ? $this->core->getTheme( $frontParams['themeId'] ) : null; |
| 470 | $jsonFrontParams = htmlspecialchars( json_encode( $frontParams ), ENT_QUOTES, 'UTF-8' ); |
| 471 | $jsonFrontSystem = htmlspecialchars( json_encode( $frontSystem ), ENT_QUOTES, 'UTF-8' ); |
| 472 | $jsonFrontTheme = htmlspecialchars( json_encode( $theme ), ENT_QUOTES, 'UTF-8' ); |
| 473 | |
| 474 | return "<div class='mwai-discussions-container' data-params='{$jsonFrontParams}' data-system='{$jsonFrontSystem}' data-theme='{$jsonFrontTheme}'></div>"; |
| 475 | } |
| 476 | |
| 477 | function cleanParams( &$params ) { |
| 478 | foreach ( $params as $param => $value ) { |
| 479 | if ( empty( $value ) || is_array( $value ) ) { |
| 480 | continue; |
| 481 | } |
| 482 | $lowerCaseValue = strtolower( $value ); |
| 483 | if ( $lowerCaseValue === 'true' || $lowerCaseValue === 'false' || is_bool( $value ) ) { |
| 484 | $params[$param] = filter_var( $value, FILTER_VALIDATE_BOOLEAN ); |
| 485 | } |
| 486 | else if ( is_numeric( $value ) ) { |
| 487 | $params[$param] = filter_var( $value, FILTER_VALIDATE_FLOAT ); |
| 488 | } |
| 489 | } |
| 490 | return $params; |
| 491 | } |
| 492 | |
| 493 | } |
| 494 |