*/ // must be run within Dokuwiki if (!defined('DOKU_INC')) { die(); } /** * Main action component for the dokullm plugin * * This class handles: * - Registering event handlers for page rendering and AJAX calls * - Adding JavaScript to edit pages * - Processing AJAX requests from the frontend * - Handling page template loading with metadata support * - Adding copy page button to page tools * * The plugin provides integration with LLM APIs for text processing * operations directly within the DokuWiki editor. * * Configuration options: * - api_url: The LLM API endpoint URL * - api_key: Authentication key for the API (optional) * - model: The model identifier to use for requests * - timeout: Request timeout in seconds * - profile: Profile for prompt templates * - temperature: Temperature setting for response randomness (0.0-1.0) * - top_p: Top-p (nucleus sampling) setting (0.0-1.0) * - top_k: Top-k setting (integer >= 1) * - min_p: Minimum probability threshold (0.0-1.0) * - think: Whether to enable thinking in LLM responses (boolean) * - show_copy_button: Whether to show the copy page button (boolean) * - replace_id: Whether to replace template ID when copying (boolean) */ class action_plugin_dokullm extends DokuWiki_Action_Plugin { /** * Register the event handlers for this plugin * * Hooks into: * - TPL_METAHEADER_OUTPUT: To add JavaScript to edit pages * - AJAX_CALL_UNKNOWN: To handle plugin-specific AJAX requests * * @param Doku_Event_Handler $controller The event handler controller */ public function register(Doku_Event_Handler $controller) { $controller->register_hook('DOKUWIKI_STARTED', 'AFTER', $this, 'handleDokuwikiStarted'); $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'handleMetaHeaders'); $controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'handleAjax'); $controller->register_hook('COMMON_PAGETPL_LOAD', 'BEFORE', $this, 'handleTemplate'); $controller->register_hook('MENU_ITEMS_ASSEMBLY', 'AFTER', $this, 'addCopyPageButton', array()); $controller->register_hook('INDEXER_TASKS_RUN', 'AFTER', $this, 'handlePageSave'); } /** * Insert metadata line after the first title in DokuWiki format * * If the first line starts with '=', insert the metadata after it. * Otherwise, insert at the very beginning. * * @param string $text The text content * @param string $metadataLine The metadata line to insert * @return string The text with metadata inserted */ private function insertMetadataAfterTitle($text, $metadataLine) { // Check if the first line is a title (starts with = in DokuWiki) $lines = explode("\n", $text); if (count($lines) > 0 && trim($lines[0]) !== '' && trim($lines[0])[0] === '=') { // Insert after the first line (the title) array_splice($lines, 1, 0, $metadataLine); return implode("\n", $lines); } else { // Insert at the very beginning return $metadataLine . "\n" . $text; } } /** * Add JavaScript to the page header for edit pages * * This method checks if we're on an edit or preview page and adds * the plugin's JavaScript file to the page header. * * @param Doku_Event $event The event object * @param mixed $param Additional parameters */ public function handleMetaHeaders(Doku_Event $event, $param) { global $INFO; // Only add JS to edit pages if ($INFO['act'] == 'edit' || $INFO['act'] == 'preview') { $event->data['script'][] = array( 'type' => 'text/javascript', 'src' => DOKU_BASE . 'lib/plugins/dokullm/script.js', '_data' => 'dokullm' ); } } /** * Add dokullm configuration to JSINFO * * @param Doku_Event $event The event object * @param mixed $param Additional parameters */ public function handleDokuwikiStarted(Doku_Event $event, $param) { global $JSINFO; if (!isset($JSINFO['plugins'])) { $JSINFO['plugins'] = []; } $JSINFO['plugins']['dokullm'] = [ 'enable_chromadb' => $this->getConf('enable_chromadb') ]; } /** * Handle AJAX requests for the plugin * * Processes AJAX calls with the identifier 'plugin_dokullm' and * routes them to the appropriate text processing method. * * @param Doku_Event $event The event object * @param mixed $param Additional parameters */ public function handleAjax(Doku_Event $event, $param) { if ($event->data !== 'plugin_dokullm') { return; } $event->stopPropagation(); $event->preventDefault(); // Handle the AJAX request $this->processRequest(); } /** * Process the AJAX request and return JSON response * * Extracts action, text, prompt, metadata, and template parameters from the request, * validates the input, and calls the appropriate processing method. * Returns JSON encoded result or error. * * @return void */ private function processRequest() { global $INPUT; // Get form data $action = $INPUT->str('action'); $text = $INPUT->str('text'); $prompt = $INPUT->str('prompt', ''); $template = $INPUT->str('template', ''); $examples = $INPUT->str('examples', ''); $previous = $INPUT->str('previous', ''); // Parse examples - split by newline and filter out empty lines $examplesList = array_filter(array_map('trim', explode("\n", $examples))); // Create metadata object with prompt, template, examples, and previous $metadata = [ 'prompt' => $prompt, 'template' => $template, 'examples' => $examplesList, 'previous' => $previous ]; // Handle the special case of get_actions action if ($action === 'get_actions') { try { $actions = $this->getActions(); echo json_encode(['result' => $actions]); } catch (Exception $e) { http_status(500); echo json_encode(['error' => $e->getMessage()]); } return; } // Handle the special case of get_template action if ($action === 'get_template') { try { $templateId = $template; $templateContent = $this->getPageContent($templateId); if ($templateContent === false) { throw new Exception('Template not found: ' . $templateId); } echo json_encode(['result' => ['content' => $templateContent]]); } catch (Exception $e) { http_status(500); echo json_encode(['error' => $e->getMessage()]); } return; } // Handle the special case of find_template action if ($action === 'find_template') { try { $searchText = $INPUT->str('text'); $template = $this->findTemplate($searchText); if (!empty($template)) { echo json_encode(['result' => ['template' => $template[0]]]); } else { echo json_encode(['result' => ['template' => null]]); } } catch (Exception $e) { http_status(500); echo json_encode(['error' => $e->getMessage()]); } return; } // Validate input if (empty($text)) { http_status(400); echo json_encode(['error' => 'No text provided']); return; } // Create ChromaDB client only if enabled $chromaClient = null; if ($this->getConf('enable_chromadb')) { $chromaClient = new \dokuwiki\plugin\dokullm\ChromaDBClient( $this->getConf('chroma_host'), $this->getConf('chroma_port'), $this->getConf('chroma_tenant'), $this->getConf('chroma_database'), $this->getConf('chroma_collection'), $this->getConf('ollama_host'), $this->getConf('ollama_port'), $this->getConf('ollama_embeddings_model') ); } $client = new \dokuwiki\plugin\dokullm\LlmClient( $this->getConf('api_url'), $this->getConf('api_key'), $this->getConf('model'), $this->getConf('timeout'), $this->getConf('temperature'), $this->getConf('top_p'), $this->getConf('top_k'), $this->getConf('min_p'), $this->getConf('think', false), $this->getConf('profile', 'default'), $chromaClient, $ID ); try { $result = $client->process($action, $text, $metadata); echo json_encode(['result' => $result]); } catch (Exception $e) { http_status(500); echo json_encode(['error' => $e->getMessage()]); } } /** * Get action definitions from the DokuWiki table at dokullm:profiles:PROFILE * * Parses the table containing action definitions with the following columns: * * - ID: The action identifier, which corresponds to the prompt name * - Label: The text displayed on the button * - Description: A detailed description of the action, used as a tooltip * - Icon: The icon displayed on the button (can be empty) * - Result: The action to perform with the LLM result: * - show: Display the result in a modal dialog * - append: Add the result to the end of the current content * - replace: Replace the selected content with the result * - insert: Insert the result at the cursor position * * The parsing stops after the first table ends to avoid processing * additional tables that might contain disabled or work-in-progress commands. * * The ID can be either: * - A simple word (e.g., "summary") * - A link to a page in the profile namespace (e.g., "[[.:default:summarize]]") * * For page links, the actual ID is extracted as the last part after the final ':' * * @return array Array of action definitions, each containing: * - id: string, the action identifier * - label: string, the button label * - description: string, the action description * - icon: string, the icon name * - result: string, the result handling method */ private function getActions() { // Get the content of the profile page $profile = $this->getConf('profile', 'default'); try { $content = $this->getPageContent('dokullm:profiles:' . $profile); } catch (Exception $e) { // If access is denied or page doesn't exist, return empty list return []; } // Return empty list if page doesn't exist if ($content === false) { return []; } // Parse the table from the page content $actions = []; $lines = explode("\n", $content); $inTable = false; foreach ($lines as $line) { // Check if this is a table row if (preg_match('/^\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|\s*([^\|]+)\s*\|$/', $line, $matches)) { $inTable = true; // Skip header row if (trim($matches[1]) === 'ID' || trim($matches[1]) === 'id') { continue; } // Extract ID from either simple text or page link $rawId = trim($matches[1]); $id = $rawId; // Check if ID is a page link in format [[namespace:page]] or [[.:namespace:page]] if (preg_match('/\[\[\.?:?([^\]]+)\]\]/', $rawId, $linkMatches)) { // Extract the actual page path $pagePath = $linkMatches[1]; // Get the last part after the final ':' as the ID $pathParts = explode(':', $pagePath); $id = end($pathParts); } // Append the action definition $actions[] = [ 'id' => $id, 'label' => trim($matches[2]), 'description' => trim($matches[3]), 'icon' => trim($matches[4]), 'result' => trim($matches[5]) ]; } else if ($inTable) { // We've exited the table, so stop parsing break; } } // Return the actions definitions return $actions; } /** * Get the content of a DokuWiki page * * Retrieves the raw content of a DokuWiki page by its ID. * Used for loading template and example page content for context. * * @param string $pageId The page ID to retrieve * @return string|false The page content or false if not found/readable * @throws Exception If access is denied */ private function getPageContent($pageId) { // Clean the ID and check ACL $cleanId = cleanID($pageId); if (auth_quickaclcheck($cleanId) < AUTH_READ) { throw new Exception('You are not allowed to read this file'); } // Convert page ID to file path $pageFile = wikiFN($cleanId); // Check if file exists and is readable if (file_exists($pageFile) && is_readable($pageFile)) { return file_get_contents($pageFile); } return false; } /** * Find an appropriate template based on the provided text * * Uses ChromaDB to search for the most relevant template based on the content. * * @param string $text The text to use for finding a template * @return array The template ID array or empty array if none found * @throws Exception If an error occurs during the search */ private function findTemplate($text) { try { // Create ChromaDB client only if enabled $chromaClient = null; if ($this->getConf('enable_chromadb')) { $chromaClient = new \dokuwiki\plugin\dokullm\ChromaDBClient( $this->getConf('chroma_host'), $this->getConf('chroma_port'), $this->getConf('chroma_tenant'), $this->getConf('chroma_database'), $this->getConf('chroma_collection'), $this->getConf('ollama_host'), $this->getConf('ollama_port'), $this->getConf('ollama_embeddings_model') ); } $client = new \dokuwiki\plugin\dokullm\LlmClient( $this->getConf('api_url'), $this->getConf('api_key'), $this->getConf('model'), $this->getConf('timeout'), $this->getConf('temperature'), $this->getConf('top_p'), $this->getConf('top_k'), $this->getConf('min_p'), $this->getConf('think', false), $this->getConf('profile', 'default'), $chromaClient, $ID ); // Query ChromaDB for the most relevant template $template = $client->queryChromaDBTemplate($text); return $template; } catch (Exception $e) { throw new Exception('Error finding template: ' . $e->getMessage()); } } /** * Handle page save event and send page to ChromaDB * * This method is triggered after a page is saved and sends the page content * to ChromaDB for indexing. * * @param Doku_Event $event The event object * @param mixed $param Additional parameters */ public function handlePageSave(Doku_Event $event, $param) { global $ID; // Only process if we have a valid page ID if (empty($ID)) { return; } // Check ACL before accessing page content if (auth_quickaclcheck($ID) < AUTH_READ) { // Log error but don't stop execution \dokuwiki\Logger::error('dokullm: Access denied for page: ' . $ID); return; } // Get the page content $content = rawWiki($ID); // Skip empty pages if (empty($content)) { return; } try { // Send page to ChromaDB $this->sendPageToChromaDB($ID, $content); } catch (Exception $e) { // Log error but don't stop execution \dokuwiki\Logger::error('dokullm: Error sending page to ChromaDB: ' . $e->getMessage()); } } /** * Send page content to ChromaDB * * @param string $pageId The page ID * @param string $content The page content * @return void */ private function sendPageToChromaDB($pageId, $content) { // Skip if ChromaDB is disabled if (!$this->getConf('enable_chromadb')) { return; } // Convert page ID to file path format for ChromaDB $filePath = wikiFN($pageId); try { // Get configuration values $chromaHost = $this->getConf('chroma_host'); $chromaPort = $this->getConf('chroma_port'); $chromaTenant = $this->getConf('chroma_tenant'); $chromaDatabase = $this->getConf('chroma_database'); $ollamaHost = $this->getConf('ollama_host'); $ollamaPort = $this->getConf('ollama_port'); $ollamaModel = $this->getConf('ollama_embeddings_model'); // Use the existing ChromaDB client to process the file $chroma = new \dokuwiki\plugin\dokullm\ChromaDBClient( $chromaHost, $chromaPort, $chromaTenant, $chromaDatabase, $this->getConf('chroma_collection'), $ollamaHost, $ollamaPort, $ollamaModel ); // Use the first part of the document ID as collection name, fallback to 'documents' $idParts = explode(':', $pageId); $collectionName = isset($idParts[0]) && !empty($idParts[0]) ? $idParts[0] : 'documents'; // Process the file directly $result = $chroma->processSingleFile($filePath, $collectionName, false); // Log success or failure if ($result['status'] === 'success') { \dokuwiki\Logger::debug('dokullm: Successfully sent page to ChromaDB: ' . $pageId); } else if ($result['status'] === 'skipped') { \dokuwiki\Logger::debug('dokullm: Skipped sending page to ChromaDB: ' . $pageId . ' - ' . $result['message']); } else { \dokuwiki\Logger::error('dokullm: Error sending page to ChromaDB: ' . $pageId . ' - ' . $result['message']); } } catch (Exception $e) { throw $e; } } /** * Handler to load page template. * * @param Doku_Event $event event object by reference * @param mixed $param [the parameters passed as fifth argument to register_hook() when this * handler was registered] * @return void */ public function handleTemplate(Doku_Event &$event, $param) { if (strlen($_REQUEST['copyfrom']) > 0) { $template_id = $_REQUEST['copyfrom']; if (auth_quickaclcheck($template_id) >= AUTH_READ) { $tpl = io_readFile(wikiFN($template_id)); if ($this->getConf('replace_id')) { $id = $event->data['id']; $tpl = str_replace($template_id, $id, $tpl); } // Add LLM_TEMPLATE metadata if the original page ID contains 'template' if (strpos($template_id, 'template') !== false) { $tpl = $this->insertMetadataAfterTitle($tpl, '~~LLM_TEMPLATE:' . $template_id . '~~'); } $event->data['tpl'] = $tpl; $event->preventDefault(); } } } /** * Add 'Copy page' button to page tools, SVG based * * @param Doku_Event $event */ public function addCopyPageButton(Doku_Event $event) { global $INFO; if ($event->data['view'] != 'page' || !$this->getConf('show_copy_button')) { return; } if (! $INFO['exists']) { return; } array_splice($event->data['items'], -1, 0, [new \dokuwiki\plugin\dokullm\MenuItem()]); } }