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