1<?php 2/** 3 * DokuWiki Plugin dokullm (Action Component) 4 * 5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html 6 * @author Costin Stroie <costinstroie@eridu.eu.org> 7 */ 8 9// must be run within Dokuwiki 10if (!defined('DOKU_INC')) { 11 die(); 12} 13 14/** 15 * Main action component for the dokullm plugin 16 * 17 * This class handles: 18 * - Registering event handlers for page rendering and AJAX calls 19 * - Adding JavaScript to edit pages 20 * - Processing AJAX requests from the frontend 21 * - Handling page template loading with metadata support 22 * - Adding copy page button to page tools 23 * 24 * The plugin provides integration with LLM APIs for text processing 25 * operations directly within the DokuWiki editor. 26 * 27 * Configuration options: 28 * - api_url: The LLM API endpoint URL 29 * - api_key: Authentication key for the API (optional) 30 * - model: The model identifier to use for requests 31 * - timeout: Request timeout in seconds 32 * - profile: Profile for prompt templates 33 * - temperature: Temperature setting for response randomness (0.0-1.0) 34 * - top_p: Top-p (nucleus sampling) setting (0.0-1.0) 35 * - top_k: Top-k setting (integer >= 1) 36 * - min_p: Minimum probability threshold (0.0-1.0) 37 * - think: Whether to enable thinking in LLM responses (boolean) 38 * - show_copy_button: Whether to show the copy page button (boolean) 39 * - replace_id: Whether to replace template ID when copying (boolean) 40 */ 41class action_plugin_dokullm extends DokuWiki_Action_Plugin 42{ 43 /** 44 * Register the event handlers for this plugin 45 * 46 * Hooks into: 47 * - TPL_METAHEADER_OUTPUT: To add JavaScript to edit pages 48 * - AJAX_CALL_UNKNOWN: To handle plugin-specific AJAX requests 49 * 50 * @param Doku_Event_Handler $controller The event handler controller 51 */ 52 public function register(Doku_Event_Handler $controller) 53 { 54 $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'handleMetaHeaders'); 55 $controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'handleAjax'); 56 $controller->register_hook('COMMON_PAGETPL_LOAD', 'BEFORE', $this, 'handleTemplate'); 57 $controller->register_hook('MENU_ITEMS_ASSEMBLY', 'AFTER', $this, 'addCopyPageButton', array()); 58 $controller->register_hook('INDEXER_TASKS_RUN', 'AFTER', $this, 'handlePageSave'); 59 } 60 61 /** 62 * Add JavaScript to the page header for edit pages 63 * 64 * This method checks if we're on an edit or preview page and adds 65 * the plugin's JavaScript file to the page header. 66 * 67 * @param Doku_Event $event The event object 68 * @param mixed $param Additional parameters 69 */ 70 public function handleMetaHeaders(Doku_Event $event, $param) 71 { 72 global $INFO; 73 74 // Only add JS to edit pages 75 if ($INFO['act'] == 'edit' || $INFO['act'] == 'preview') { 76 $event->data['script'][] = array( 77 'type' => 'text/javascript', 78 'src' => DOKU_BASE . 'lib/plugins/dokullm/script.js', 79 '_data' => 'dokullm' 80 ); 81 } 82 } 83 84 /** 85 * Handle AJAX requests for the plugin 86 * 87 * Processes AJAX calls with the identifier 'plugin_dokullm' and 88 * routes them to the appropriate text processing method. 89 * 90 * @param Doku_Event $event The event object 91 * @param mixed $param Additional parameters 92 */ 93 public function handleAjax(Doku_Event $event, $param) 94 { 95 if ($event->data !== 'plugin_dokullm') { 96 return; 97 } 98 99 $event->stopPropagation(); 100 $event->preventDefault(); 101 102 // Handle the AJAX request 103 $this->processRequest(); 104 } 105 106 /** 107 * Process the AJAX request and return JSON response 108 * 109 * Extracts action, text, prompt, metadata, and template parameters from the request, 110 * validates the input, and calls the appropriate processing method. 111 * Returns JSON encoded result or error. 112 * 113 * @return void 114 */ 115 private function processRequest() 116 { 117 global $INPUT; 118 119 // Get form data 120 $action = $INPUT->str('action'); 121 $text = $INPUT->str('text'); 122 $prompt = $INPUT->str('prompt', ''); 123 $template = $INPUT->str('template', ''); 124 $examples = $INPUT->str('examples', ''); 125 $previous = $INPUT->str('previous', ''); 126 127 // Parse examples - split by newline and filter out empty lines 128 $examplesList = array_filter(array_map('trim', explode("\n", $examples))); 129 130 // Create metadata object with prompt, template, examples, and previous 131 $metadata = [ 132 'prompt' => $prompt, 133 'template' => $template, 134 'examples' => $examplesList, 135 'previous' => $previous 136 ]; 137 138 // Handle the special case of get_actions action 139 if ($action === 'get_actions') { 140 try { 141 $actions = $this->getActions(); 142 echo json_encode(['result' => $actions]); 143 } catch (Exception $e) { 144 http_status(500); 145 echo json_encode(['error' => $e->getMessage()]); 146 } 147 return; 148 } 149 150 // Handle the special case of get_template action 151 if ($action === 'get_template') { 152 try { 153 $templateId = $template; 154 $templateContent = $this->getPageContent($templateId); 155 if ($templateContent === false) { 156 throw new Exception('Template not found: ' . $templateId); 157 } 158 echo json_encode(['result' => ['content' => $templateContent]]); 159 } catch (Exception $e) { 160 http_status(500); 161 echo json_encode(['error' => $e->getMessage()]); 162 } 163 return; 164 } 165 166 // Handle the special case of find_template action 167 if ($action === 'find_template') { 168 try { 169 $searchText = $INPUT->str('text'); 170 $template = $this->findTemplate($searchText); 171 if (!empty($template)) { 172 echo json_encode(['result' => ['template' => $template[0]]]); 173 } else { 174 echo json_encode(['result' => ['template' => null]]); 175 } 176 } catch (Exception $e) { 177 http_status(500); 178 echo json_encode(['error' => $e->getMessage()]); 179 } 180 return; 181 } 182 183 // Validate input 184 if (empty($text)) { 185 http_status(400); 186 echo json_encode(['error' => 'No text provided']); 187 return; 188 } 189 190 191 // Create ChromaDB client 192 $chromaClient = new \dokuwiki\plugin\dokullm\ChromaDBClient( 193 $this->getConf('chroma_host'), 194 $this->getConf('chroma_port'), 195 $this->getConf('chroma_tenant'), 196 $this->getConf('chroma_database'), 197 $this->getConf('chroma_collection'), 198 $this->getConf('ollama_host'), 199 $this->getConf('ollama_port'), 200 $this->getConf('ollama_embeddings_model') 201 ); 202 203 $client = new \dokuwiki\plugin\dokullm\LlmClient( 204 $this->getConf('api_url'), 205 $this->getConf('api_key'), 206 $this->getConf('model'), 207 $this->getConf('timeout'), 208 $this->getConf('temperature'), 209 $this->getConf('top_p'), 210 $this->getConf('top_k'), 211 $this->getConf('min_p'), 212 $this->getConf('think', false), 213 $this->getConf('profile', 'default'), 214 $chromaClient, 215 $ID 216 ); 217 try { 218 switch ($action) { 219 case 'custom': 220 $result = $client->processCustomPrompt($text, $metadata); 221 default: 222 $result = $client->process($action, $text, $metadata); 223 } 224 echo json_encode(['result' => $result]); 225 } catch (Exception $e) { 226 http_status(500); 227 echo json_encode(['error' => $e->getMessage()]); 228 } 229 } 230 231 /** 232 * Get action definitions from the DokuWiki table at dokullm:profiles:PROFILE 233 * 234 * Parses the table containing action definitions with the following columns: 235 * 236 * - ID: The action identifier, which corresponds to the prompt name 237 * - Label: The text displayed on the button 238 * - Description: A detailed description of the action, used as a tooltip 239 * - Icon: The icon displayed on the button (can be empty) 240 * - Result: The action to perform with the LLM result: 241 * - show: Display the result in a modal dialog 242 * - append: Add the result to the end of the current content 243 * - replace: Replace the selected content with the result 244 * - insert: Insert the result at the cursor position 245 * 246 * The parsing stops after the first table ends to avoid processing 247 * additional tables that might contain disabled or work-in-progress commands. 248 * 249 * @return array Array of action definitions, each containing: 250 * - id: string, the action identifier 251 * - label: string, the button label 252 * - description: string, the action description 253 * - icon: string, the icon name 254 * - result: string, the result handling method 255 */ 256 private function getActions() 257 { 258 // Get the content of the profile page 259 $profile = $this->getConf('profile', 'default'); 260 $content = $this->getPageContent('dokullm:profiles:' . $profile); 261 262 if ($content === false) { 263 // Return empty list if page doesn't exist 264 return []; 265 } 266 267 // Parse the table from the page content 268 $actions = []; 269 $lines = explode("\n", $content); 270 $inTable = false; 271 272 foreach ($lines as $line) { 273 // Check if this is a table row 274 if (preg_match('/^\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|$/', $line, $matches)) { 275 $inTable = true; 276 277 // Skip header row 278 if (trim($matches[1]) === 'ID' || trim($matches[1]) === 'id') { 279 continue; 280 } 281 282 $actions[] = [ 283 'id' => trim($matches[1]), 284 'label' => trim($matches[2]), 285 'description' => trim($matches[3]), 286 'icon' => trim($matches[4]), 287 'result' => trim($matches[5]) 288 ]; 289 } else if ($inTable) { 290 // We've exited the table, so stop parsing 291 break; 292 } 293 } 294 295 return $actions; 296 } 297 298 /** 299 * Get the content of a DokuWiki page 300 * 301 * Retrieves the raw content of a DokuWiki page by its ID. 302 * Used for loading template and example page content for context. 303 * 304 * @param string $pageId The page ID to retrieve 305 * @return string|false The page content or false if not found/readable 306 */ 307 private function getPageContent($pageId) 308 { 309 // Convert page ID to file path 310 $pageFile = wikiFN($pageId); 311 312 // Check if file exists and is readable 313 if (file_exists($pageFile) && is_readable($pageFile)) { 314 return file_get_contents($pageFile); 315 } 316 317 return false; 318 } 319 320 321 /** 322 * Find an appropriate template based on the provided text 323 * 324 * Uses ChromaDB to search for the most relevant template based on the content. 325 * 326 * @param string $text The text to use for finding a template 327 * @return array The template ID array or empty array if none found 328 * @throws Exception If an error occurs during the search 329 */ 330 private function findTemplate($text) { 331 try { 332 // Create ChromaDB client 333 $chromaClient = new \dokuwiki\plugin\dokullm\ChromaDBClient( 334 $this->getConf('chroma_host'), 335 $this->getConf('chroma_port'), 336 $this->getConf('chroma_tenant'), 337 $this->getConf('chroma_database'), 338 $this->getConf('chroma_collection'), 339 $this->getConf('ollama_host'), 340 $this->getConf('ollama_port'), 341 $this->getConf('ollama_embeddings_model') 342 ); 343 344 $client = new \dokuwiki\plugin\dokullm\LlmClient( 345 $this->getConf('api_url'), 346 $this->getConf('api_key'), 347 $this->getConf('model'), 348 $this->getConf('timeout'), 349 $this->getConf('temperature'), 350 $this->getConf('top_p'), 351 $this->getConf('top_k'), 352 $this->getConf('min_p'), 353 $this->getConf('think', false), 354 $this->getConf('profile', 'default'), 355 $chromaClient, 356 $ID 357 ); 358 359 // Query ChromaDB for the most relevant template 360 $template = $client->queryChromaDBTemplate($text); 361 362 return $template; 363 } catch (Exception $e) { 364 throw new Exception('Error finding template: ' . $e->getMessage()); 365 } 366 } 367 368 369 /** 370 * Handle page save event and send page to ChromaDB 371 * 372 * This method is triggered after a page is saved and sends the page content 373 * to ChromaDB for indexing. 374 * 375 * @param Doku_Event $event The event object 376 * @param mixed $param Additional parameters 377 */ 378 public function handlePageSave(Doku_Event $event, $param) 379 { 380 global $ID; 381 382 // Only process if we have a valid page ID 383 if (empty($ID)) { 384 return; 385 } 386 387 // Get the page content 388 $content = rawWiki($ID); 389 390 // Skip empty pages 391 if (empty($content)) { 392 return; 393 } 394 395 try { 396 // Send page to ChromaDB 397 $this->sendPageToChromaDB($ID, $content); 398 } catch (Exception $e) { 399 // Log error but don't stop execution 400 \dokuwiki\Logger::error('dokullm: Error sending page to ChromaDB: ' . $e->getMessage()); 401 } 402 } 403 404 405 /** 406 * Send page content to ChromaDB 407 * 408 * @param string $pageId The page ID 409 * @param string $content The page content 410 * @return void 411 */ 412 private function sendPageToChromaDB($pageId, $content) 413 { 414 // Convert page ID to file path format for ChromaDB 415 $filePath = wikiFN($pageId); 416 417 try { 418 // Get configuration values 419 $chromaHost = $this->getConf('chroma_host'); 420 $chromaPort = $this->getConf('chroma_port'); 421 $chromaTenant = $this->getConf('chroma_tenant'); 422 $chromaDatabase = $this->getConf('chroma_database'); 423 $ollamaHost = $this->getConf('ollama_host'); 424 $ollamaPort = $this->getConf('ollama_port'); 425 $ollamaModel = $this->getConf('ollama_embeddings_model'); 426 427 // Use the existing ChromaDB client to process the file 428 $chroma = new \dokuwiki\plugin\dokullm\ChromaDBClient( 429 $chromaHost, 430 $chromaPort, 431 $chromaTenant, 432 $chromaDatabase, 433 $this->getConf('chroma_collection'), 434 $ollamaHost, 435 $ollamaPort, 436 $ollamaModel 437 ); 438 439 // Use the first part of the document ID as collection name, fallback to 'documents' 440 $idParts = explode(':', $pageId); 441 $collectionName = isset($idParts[0]) && !empty($idParts[0]) ? $idParts[0] : 'documents'; 442 443 // Process the file directly 444 $result = $chroma->processSingleFile($filePath, $collectionName, false); 445 446 // Log success or failure 447 if ($result['status'] === 'success') { 448 \dokuwiki\Logger::debug('dokullm: Successfully sent page to ChromaDB: ' . $pageId); 449 } else if ($result['status'] === 'skipped') { 450 \dokuwiki\Logger::debug('dokullm: Skipped sending page to ChromaDB: ' . $pageId . ' - ' . $result['message']); 451 } else { 452 \dokuwiki\Logger::error('dokullm: Error sending page to ChromaDB: ' . $pageId . ' - ' . $result['message']); 453 } 454 } catch (Exception $e) { 455 throw $e; 456 } 457 } 458 459 460 /** 461 * Handler to load page template. 462 * 463 * @param Doku_Event $event event object by reference 464 * @param mixed $param [the parameters passed as fifth argument to register_hook() when this 465 * handler was registered] 466 * @return void 467 */ 468 public function handleTemplate(Doku_Event &$event, $param) { 469 if (strlen($_REQUEST['copyfrom']) > 0) { 470 $template_id = $_REQUEST['copyfrom']; 471 if (auth_quickaclcheck($template_id) >= AUTH_READ) { 472 $tpl = io_readFile(wikiFN($template_id)); 473 if ($this->getConf('replace_id')) { 474 $id = $event->data['id']; 475 $tpl = str_replace($template_id, $id, $tpl); 476 } 477 // Add LLM_TEMPLATE metadata if the original page ID contains 'template' 478 if (strpos($template_id, 'template') !== false) { 479 $tpl = '~~LLM_TEMPLATE:' . $template_id . '~~' . "\n" . $tpl; 480 } 481 $event->data['tpl'] = $tpl; 482 $event->preventDefault(); 483 } 484 } 485 } 486 487 488 489 /** 490 * Add 'Copy page' button to page tools, SVG based 491 * 492 * @param Doku_Event $event 493 */ 494 public function addCopyPageButton(Doku_Event $event) 495 { 496 global $INFO; 497 if ($event->data['view'] != 'page' || !$this->getConf('show_copy_button')) { 498 return; 499 } 500 if (! $INFO['exists']) { 501 return; 502 } 503 array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\dokullm\MenuItem()]); 504 } 505} 506