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 * - language: Language code 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('language', 'en'), 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:prompts 233 * 234 * Parses the table containing action definitions with columns: 235 * ID, Label, Icon, Action 236 * 237 * Stops parsing after the first table ends to avoid processing 238 * additional tables with disabled or work-in-progress commands. 239 * 240 * @return array Array of action definitions 241 */ 242 private function getActions() 243 { 244 // Get the content of the prompts page 245 $content = $this->getPageContent('dokullm:prompts'); 246 247 if ($content === false) { 248 // Return empty list if page doesn't exist 249 return []; 250 } 251 252 // Parse the table from the page content 253 $actions = []; 254 $lines = explode("\n", $content); 255 $inTable = false; 256 257 foreach ($lines as $line) { 258 // Check if this is a table row 259 if (preg_match('/^\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|$/', $line, $matches)) { 260 $inTable = true; 261 262 // Skip header row 263 if (trim($matches[1]) === 'ID' || trim($matches[1]) === 'id') { 264 continue; 265 } 266 267 $actions[] = [ 268 'id' => trim($matches[1]), 269 'label' => trim($matches[2]), 270 'description' => trim($matches[3]), 271 'icon' => trim($matches[4]), 272 'result' => trim($matches[5]) 273 ]; 274 } else if ($inTable) { 275 // We've exited the table, so stop parsing 276 break; 277 } 278 } 279 280 return $actions; 281 } 282 283 /** 284 * Get the content of a DokuWiki page 285 * 286 * Retrieves the raw content of a DokuWiki page by its ID. 287 * Used for loading template and example page content for context. 288 * 289 * @param string $pageId The page ID to retrieve 290 * @return string|false The page content or false if not found/readable 291 */ 292 private function getPageContent($pageId) 293 { 294 // Convert page ID to file path 295 $pageFile = wikiFN($pageId); 296 297 // Check if file exists and is readable 298 if (file_exists($pageFile) && is_readable($pageFile)) { 299 return file_get_contents($pageFile); 300 } 301 302 return false; 303 } 304 305 306 /** 307 * Find an appropriate template based on the provided text 308 * 309 * Uses ChromaDB to search for the most relevant template based on the content. 310 * 311 * @param string $text The text to use for finding a template 312 * @return array The template ID array or empty array if none found 313 * @throws Exception If an error occurs during the search 314 */ 315 private function findTemplate($text) { 316 try { 317 // Create ChromaDB client 318 $chromaClient = new \dokuwiki\plugin\dokullm\ChromaDBClient( 319 $this->getConf('chroma_host'), 320 $this->getConf('chroma_port'), 321 $this->getConf('chroma_tenant'), 322 $this->getConf('chroma_database'), 323 $this->getConf('chroma_collection'), 324 $this->getConf('ollama_host'), 325 $this->getConf('ollama_port'), 326 $this->getConf('ollama_embeddings_model') 327 ); 328 329 $client = new \dokuwiki\plugin\dokullm\LlmClient( 330 $this->getConf('api_url'), 331 $this->getConf('api_key'), 332 $this->getConf('model'), 333 $this->getConf('timeout'), 334 $this->getConf('temperature'), 335 $this->getConf('top_p'), 336 $this->getConf('top_k'), 337 $this->getConf('min_p'), 338 $this->getConf('think', false), 339 $this->getConf('language', 'en'), 340 $chromaClient, 341 $ID 342 ); 343 344 // Query ChromaDB for the most relevant template 345 $template = $client->queryChromaDBTemplate($text); 346 347 return $template; 348 } catch (Exception $e) { 349 throw new Exception('Error finding template: ' . $e->getMessage()); 350 } 351 } 352 353 354 /** 355 * Handle page save event and send page to ChromaDB 356 * 357 * This method is triggered after a page is saved and sends the page content 358 * to ChromaDB for indexing. 359 * 360 * @param Doku_Event $event The event object 361 * @param mixed $param Additional parameters 362 */ 363 public function handlePageSave(Doku_Event $event, $param) 364 { 365 global $ID; 366 367 // Only process if we have a valid page ID 368 if (empty($ID)) { 369 return; 370 } 371 372 // Get the page content 373 $content = rawWiki($ID); 374 375 // Skip empty pages 376 if (empty($content)) { 377 return; 378 } 379 380 try { 381 // Send page to ChromaDB 382 $this->sendPageToChromaDB($ID, $content); 383 } catch (Exception $e) { 384 // Log error but don't stop execution 385 \dokuwiki\Logger::error('dokullm: Error sending page to ChromaDB: ' . $e->getMessage()); 386 } 387 } 388 389 390 /** 391 * Send page content to ChromaDB 392 * 393 * @param string $pageId The page ID 394 * @param string $content The page content 395 * @return void 396 */ 397 private function sendPageToChromaDB($pageId, $content) 398 { 399 // Convert page ID to file path format for ChromaDB 400 $filePath = wikiFN($pageId); 401 402 try { 403 // Get configuration values 404 $chromaHost = $this->getConf('chroma_host'); 405 $chromaPort = $this->getConf('chroma_port'); 406 $chromaTenant = $this->getConf('chroma_tenant'); 407 $chromaDatabase = $this->getConf('chroma_database'); 408 $ollamaHost = $this->getConf('ollama_host'); 409 $ollamaPort = $this->getConf('ollama_port'); 410 $ollamaModel = $this->getConf('ollama_embeddings_model'); 411 412 // Use the existing ChromaDB client to process the file 413 $chroma = new \dokuwiki\plugin\dokullm\ChromaDBClient( 414 $chromaHost, 415 $chromaPort, 416 $chromaTenant, 417 $chromaDatabase, 418 $this->getConf('chroma_collection'), 419 $ollamaHost, 420 $ollamaPort, 421 $ollamaModel 422 ); 423 424 // Use the first part of the document ID as collection name, fallback to 'documents' 425 $idParts = explode(':', $pageId); 426 $collectionName = isset($idParts[0]) && !empty($idParts[0]) ? $idParts[0] : 'documents'; 427 428 // Process the file directly 429 $result = $chroma->processSingleFile($filePath, $collectionName, false); 430 431 // Log success or failure 432 if ($result['status'] === 'success') { 433 \dokuwiki\Logger::debug('dokullm: Successfully sent page to ChromaDB: ' . $pageId); 434 } else if ($result['status'] === 'skipped') { 435 \dokuwiki\Logger::debug('dokullm: Skipped sending page to ChromaDB: ' . $pageId . ' - ' . $result['message']); 436 } else { 437 \dokuwiki\Logger::error('dokullm: Error sending page to ChromaDB: ' . $pageId . ' - ' . $result['message']); 438 } 439 } catch (Exception $e) { 440 throw $e; 441 } 442 } 443 444 445 /** 446 * Handler to load page template. 447 * 448 * @param Doku_Event $event event object by reference 449 * @param mixed $param [the parameters passed as fifth argument to register_hook() when this 450 * handler was registered] 451 * @return void 452 */ 453 public function handleTemplate(Doku_Event &$event, $param) { 454 if (strlen($_REQUEST['copyfrom']) > 0) { 455 $template_id = $_REQUEST['copyfrom']; 456 if (auth_quickaclcheck($template_id) >= AUTH_READ) { 457 $tpl = io_readFile(wikiFN($template_id)); 458 if ($this->getConf('replace_id')) { 459 $id = $event->data['id']; 460 $tpl = str_replace($template_id, $id, $tpl); 461 } 462 // Add LLM_TEMPLATE metadata if the original page ID contains 'template' 463 if (strpos($template_id, 'template') !== false) { 464 $tpl = '~~LLM_TEMPLATE:' . $template_id . '~~' . "\n" . $tpl; 465 } 466 $event->data['tpl'] = $tpl; 467 $event->preventDefault(); 468 } 469 } 470 } 471 472 473 474 /** 475 * Add 'Copy page' button to page tools, SVG based 476 * 477 * @param Doku_Event $event 478 */ 479 public function addCopyPageButton(Doku_Event $event) 480 { 481 global $INFO; 482 if ($event->data['view'] != 'page' || !$this->getConf('show_copy_button')) { 483 return; 484 } 485 if (! $INFO['exists']) { 486 return; 487 } 488 array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\dokullm\MenuItem()]); 489 } 490} 491