Merge pull request dokuwiki#4489 from dokuwiki/extension-base

ExtensionManager: get base from plugin classes. fixes dokuwiki#4484

Author: splitbrain

lib/plugins/extension/Extension.php

@@ -25,6 +25,18 @@ class Extension
         512 => 'CSS/JS-only',
     ];
 
+    /** @var string[] List of plugin component file base names */
+    public const COMPONENT_FILES = [
+        'syntax',
+        'admin',
+        'action',
+        'render',
+        'helper',
+        'remote',
+        'auth',
+        'cli',
+    ];
+
     /** @var string "plugin"|"template" */
     protected string $type = self::TYPE_PLUGIN;
 
@@ -117,7 +129,7 @@ protected function initFromDirectory($dir, $type = null, $base = null)
         } elseif (isset($this->localInfo['base'])) {
             $this->base = $this->localInfo['base'];
         } else {
-            $this->base = basename($dir);
+            $this->base = $this->getBaseFromClass($dir) ?: basename($dir);
         }
     }
 
@@ -769,6 +781,28 @@ protected function readLocalInfo()
         $this->localInfo = array_filter($this->localInfo); // remove all falsy keys
     }
 
+    /**
+     * Try to determine the extension's base name from a plugin class name
+     *
+     * We use this as a fallback for old plugins without an info file
+     *
+     * @param string $dir The directory where the extension is located
+     * @return string
+     */
+    protected function getBaseFromClass($dir)
+    {
+        foreach (Extension::COMPONENT_FILES as $type) {
+            $file = $dir . '/' . $type . '.php';
+            if (!is_readable($file)) continue;
+            $class = $this->getClassNameFromFile($file);
+            if ($class === null) continue;
+            if (preg_match('/' . $type . '_plugin_(\w+)/', $class, $matches)) {
+                return $matches[1];
+            }
+        }
+        return '';
+    }
+
     /**
      * Fetches the remote info from the repository
      *
@@ -845,6 +879,39 @@ protected function idToTypeBase($id)
         return [$type, $base];
     }
 
+    /**
+     * Extract the class name from a file
+     *
+     * @param string $filePath
+     * @return string|null
+     */
+    protected function getClassNameFromFile($filePath)
+    {
+        $code = file_get_contents($filePath);
+        $tokens = token_get_all($code);
+
+        for ($i = 0, $count = count($tokens); $i < $count; $i++) {
+            if (is_array($tokens[$i]) && $tokens[$i][0] === T_CLASS) {
+                // Skip whitespace/comments after T_CLASS
+                $j = $i + 1;
+                while (
+                    isset($tokens[$j]) &&
+                    is_array($tokens[$j]) &&
+                    in_array($tokens[$j][0], [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT])
+                ) {
+                    $j++;
+                }
+
+                // The next token should be the class name
+                if (isset($tokens[$j]) && is_array($tokens[$j]) && $tokens[$j][0] === T_STRING) {
+                    return $tokens[$j][1]; // Return class name
+                }
+            }
+        }
+
+        return null; // No class found
+    }
+
     /**
      * @return string
      */

lib/plugins/extension/Installer.php

@@ -94,7 +94,7 @@ public function installExtension(Extension $extension)
         if (!$url) {
             throw new Exception('error_nourl', [$extension->getId()]);
         }
-        $this->installFromUrl($url);
+        $this->installFromUrl($url, $extension->getBase());
     }
 
     /**
@@ -127,14 +127,12 @@ public function installFromUpload($field)
             throw new Exception('msg_upload_failed', [$_FILES[$field]['error']]);
         }
 
+        $tmpbase = $this->fileToBase($_FILES[$field]['name']) ?: 'upload';
         $tmp = $this->mkTmpDir();
-        if (!move_uploaded_file($_FILES[$field]['tmp_name'], "$tmp/upload.archive")) {
+        if (!move_uploaded_file($_FILES[$field]['tmp_name'], "$tmp/$tmpbase.archive")) {
             throw new Exception('msg_upload_failed', ['move failed']);
         }
-        $this->installFromArchive(
-            "$tmp/upload.archive",
-            $this->fileToBase($_FILES[$field]['name']),
-        );
+        $this->installFromArchive("$tmp/$tmpbase.archive");
     }
 
     /**
@@ -149,8 +147,7 @@ public function installFromUpload($field)
      */
     public function installFromArchive($archive, $base = null)
     {
-        if ($base === null) $base = $this->fileToBase($archive);
-        $target = $this->mkTmpDir() . '/' . $base;
+        $target = $this->mkTmpDir() . '/' . ($base ?? $this->fileToBase($archive));
         $this->extractArchive($archive, $target);
         $extensions = $this->findExtensions($target, $base);
         foreach ($extensions as $extension) {
@@ -433,7 +430,7 @@ public static function ensurePermissions(Extension $extension)
     protected function fileToBase($file)
     {
         $base = PhpString::basename($file);
-        $base = preg_replace('/\.(tar\.gz|tar\.bz|tar\.bz2|tar|tgz|tbz|zip)$/', '', $base);
+        $base = preg_replace('/\.(tar\.gz|tar\.bz|tar\.bz2|tar|tgz|tbz|zip|archive)$/', '', $base);
         return preg_replace('/\W+/', '', $base);
     }
 
@@ -487,7 +484,6 @@ protected function findExtensions($dir, $base = null)
         if (count($files) === 1 && is_dir($files[0])) {
             $dir = $files[0];
         }
-        $base ??= PhpString::basename($dir);
         return [Extension::createFromDirectory($dir, null, $base)];
     }
 

lib/plugins/extension/_test/InstallerTest.php

@@ -28,6 +28,7 @@ public function provideFindExtensionsData()
             'plgsub6' => ['plgsub6', ['plugin6' => 'plugin']],
             'plugin1' => ['plugin1', ['plugin1' => 'plugin']],
             'plugin2' => ['plugin2', ['plugin2' => 'plugin']],
+            'plugin3' => ['plugin3', ['foobar' => 'plugin']],
             'template1' => ['template1', ['template1' => 'template']],
             'tplfoo5' => ['tplfoo5', ['template5' => 'template']],
             'tplsub3' => ['tplsub3', ['template3' => 'template']],

lib/plugins/extension/_test/testdata/plugin3/syntax.php

@@ -0,0 +1,5 @@
+<?php
+
+class syntax_plugin_foobar extends DokuWiki_Plugin {
+
+}

lib/plugins/extension/cli.php

@@ -206,7 +206,7 @@ protected function cmdInstall($extensions)
 
             try {
                 if (preg_match("/^https?:\/\//i", $extname)) {
-                    $installer->installFromURL($extname, true);
+                    $installer->installFromURL($extname);
                 } else {
                     $installer->installFromId($extname);
                 }