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