Release 2.3.0: Settings page, private repo support, navigation restructure

skerbis · skerbis · commit a4a5ac4f4b3d · 2026-01-02T17:40:12.000+01:00
diff --git a/README.md b/README.md
@@ -28,7 +28,12 @@ Dieses AddOn ermöglicht die einfache Installation von AddOns oder Plugins durch
 
 ## Verwendung
 
-Das AddOn ist im Installer unter "ZIP Upload/GitHub" zu finden und bietet drei Möglichkeiten zur Installation:
+Das AddOn ist im Installer unter "ZIP Upload" zu finden. Es gliedert sich in zwei Bereiche:
+
+1.  **Upload**: Hier können AddOns via ZIP-Datei oder URL installiert werden. Auch die GitHub-Suche befindet sich hier.
+2.  **Einstellungen**: Hier können der GitHub-Token und die maximale Upload-Größe konfiguriert werden.
+
+Die Installation bietet drei Möglichkeiten:
 
 1.  **ZIP-Upload**: Direkter Upload einer ZIP-Datei eines AddOns/Plugins
 2.  **URL-Installation**: Eingabe eines Links zu einer ZIP-Datei oder einem GitHub-Repository
@@ -53,17 +58,18 @@ Plugins werden automatisch in das entsprechende Verzeichnis des zugehörigen Add
 *   Die `update.php` des AddOns wird nicht ausgeführt.
 *   Der Upload ist auf 50 MB begrenzt.
 
-## GitHub API-Token setzen
+## GitHub API-Token & Private Repositories
 
-Das Add-on liefert keinen Token für die GitHub-API mit. Ohne Token sind die API-Abfragen auf 60 pro Stunde begrenzt.
-Ein persönlicher Zugriffstoken kann unter GitHub > Settings > Developer settings > Personal access tokens erstellt werden.
-Der Token benötigt mindestens 'public_repo' Berechtigung für öffentliche Repositories.
-Der Token kann z.B. in der install.php des project-Add-ons oder einem eigenen wie folgt updatesicher gesetzt werden:
+Das AddOn liefert keinen Token für die GitHub-API mit. Ohne Token sind die API-Abfragen auf 60 pro Stunde begrenzt.
 
-```
-$addon = rex_addon::get('zip_install');
-$addon->setConfig('github_token', 'GitHubToken');
-```
+Ein persönlicher Zugriffstoken kann unter **GitHub > Settings > Developer settings > Personal access tokens** erstellt werden.
+Der Token kann bequem über die **Einstellungen-Seite** des AddOns eingetragen werden.
+
+**Vorteile eines Tokens:**
+*   Erhöhtes Rate-Limit (5000 Anfragen/Stunde statt 60).
+*   **Zugriff auf private Repositories**: Mit einem Token, der über den Scope `repo` verfügt, können auch private Repositories installiert werden.
+
+Für öffentliche Repositories reicht in der Regel ein Token ohne spezielle Scopes (oder der Scope `public_repo`).
 
 ## Voraussetzungen
 
diff --git a/lang/de_de.lang b/lang/de_de.lang
@@ -41,8 +41,11 @@ zip_install_security_warning = Bitte beachten: Installieren Sie nur AddOns aus v
 
 zip_install_settings_github_token = GitHub Token
 zip_install_settings_github_token_info = Optional. Ein GitHub Token erhöht das stündliche API-Limit von 60 auf 5000 Anfragen.
+zip_install_settings_github_token_create = GitHub Token erstellen
 zip_install_settings_upload_max_size = Maximale Upload-Größe (MB)
 zip_install_settings_upload_max_size_info = Maximale Größe von ZIP-Dateien, die hochgeladen werden können. Standard: 50 MB.
+zip_install_settings_upload_max_size_invalid = Die Upload-Größe muss zwischen 1 und 500 MB liegen.
+zip_install_settings_saved = Einstellungen wurden erfolgreich gespeichert.
 
 #permissions
 perm_general_zip_install[] = Berechtigungen für ZIP Upload/GitHub Installation
diff --git a/lang/en_gb.lang b/lang/en_gb.lang
@@ -41,8 +41,11 @@ zip_install_security_warning = Please note: Only install AddOns from trusted sou
 
 zip_install_settings_github_token = GitHub Token
 zip_install_settings_github_token_info = Optional. A GitHub token increases the hourly API limit from 60 to 5000 requests.
+zip_install_settings_github_token_create = Create GitHub Token
 zip_install_settings_upload_max_size = Maximum Upload Size (MB)
 zip_install_settings_upload_max_size_info = Maximum size of ZIP files that can be uploaded. Default: 50 MB.
+zip_install_settings_upload_max_size_invalid = The upload size must be between 1 and 500 MB.
+zip_install_settings_saved = Settings have been saved successfully.
 
 #permissions
 perm_general_zip_install[] = Permissions for ZIP Upload/GitHub Installation
diff --git a/lib/zip_install.php b/lib/zip_install.php
@@ -265,7 +265,8 @@ public function getGitHubRepos(string $username): array
                 if (isset($http_response_header)) {
                     foreach ($http_response_header as $header) {
                         if (stripos($header, 'X-RateLimit-Remaining:') === 0) {
-                            $remaining = intval(trim(substr($header, 21)));
+                            // Extract value after "X-RateLimit-Remaining: " (22 chars + space = 23)
+                            $remaining = intval(trim(substr($header, 23)));
                             if ($remaining <= 5) {
                                 // Using warning level for rate limit notifications
                                 \rex_logger::factory()->log(\Psr\Log\LogLevel::WARNING, 
@@ -351,6 +352,15 @@ protected function isValidUrl(string $url): bool
              curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
              curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
 
+             // Add Authorization header if token is available
+             $token = $this->addon->getConfig('github_token');
+             $host = parse_url($url, PHP_URL_HOST);
+             if ($token && $host && ($host === 'github.com' || str_ends_with($host, '.github.qkg1.top'))) {
+                 curl_setopt($ch, CURLOPT_HTTPHEADER, [
+                     'Authorization: Bearer ' . $token
+                 ]);
+             }
+
              curl_exec($ch);
              $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
              $error = curl_error($ch);
@@ -389,10 +399,20 @@ protected function downloadFile(string $url, string $destination): bool
             curl_setopt($ch, CURLOPT_USERAGENT, 'REDAXOZipInstall/2.2.1');
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
             curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
-            curl_setopt($ch, CURLOPT_HTTPHEADER, [
+            
+            $headers = [
                 'Accept: application/zip, application/octet-stream, */*',
                 'Cache-Control: no-cache'
-            ]);
+            ];
+
+            // Add Authorization header if token is available
+            $token = $this->addon->getConfig('github_token');
+            $host = parse_url($url, PHP_URL_HOST);
+            if ($token && $host && ($host === 'github.com' || str_ends_with($host, '.github.qkg1.top'))) {
+                $headers[] = 'Authorization: Bearer ' . $token;
+            }
+
+            curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
 
             $content = curl_exec($ch);
             $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
@@ -615,4 +635,52 @@ public function getAddonKeyFromUrl(string $url): ?string
         }
         return null;
     }
+
+    /**
+     * Get GitHub API Rate Limit
+     *
+     * @return array|null Returns array with limit, remaining, reset or null on error
+     */
+    public function getRateLimit(): ?array
+    {
+        $token = $this->addon->getConfig('github_token');
+        
+        $headers = [
+            'User-Agent: REDAXOZipInstall/2.0',
+            'Accept: application/vnd.github.v3+json'
+        ];
+        
+        if ($token) {
+            $headers[] = 'Authorization: Bearer ' . $token;
+        }
+        
+        $options = [
+            'http' => [
+                'method' => 'GET',
+                'header' => implode("\r\n", $headers),
+                'timeout' => 5
+            ]
+        ];
+
+        $context = stream_context_create($options);
+        
+        try {
+            $response = @file_get_contents('https://api.github.com/rate_limit', false, $context);
+            
+            if ($response !== false) {
+                $data = json_decode($response, true);
+                if (isset($data['rate'])) {
+                    return [
+                        'limit' => $data['rate']['limit'],
+                        'remaining' => $data['rate']['remaining'],
+                        'reset' => $data['rate']['reset']
+                    ];
+                }
+            }
+        } catch (Exception $e) {
+            // Ignore errors
+        }
+        
+        return null;
+    }
 }
diff --git a/package.yml b/package.yml
@@ -1,5 +1,5 @@
 package: zip_install
-version: '2.2.4'
+version: '2.3.0'
 author: Friends Of REDAXO
 supportpage: github.com/FriendsOfREDAXO/zip_install
 live_mode: false
@@ -11,11 +11,20 @@ requires:
         extensions: [fileinfo, zip]
 
 pages:
-    install/packages/zip_install:
+    install/zip_install:
         title: translate:title
-        icon: rex-icon fa-upload
+        icon: rex-icon fa-solid fa-file-arrow-up
         perm: admin[]
         pjax: true
+        subpages:
+            upload:
+                title: translate:zip_install_file_upload
+                icon: rex-icon fa-solid fa-file-arrow-up
+                perm: admin[]
+            settings:
+                title: translate:settings
+                icon: rex-icon fa-cog
+                perm: admin[]
         
 conflicts:
     packages:
diff --git a/pages/install.zip_install.php b/pages/install.zip_install.php
@@ -0,0 +1,7 @@
+<?php
+
+$package = rex_addon::get('zip_install');
+
+echo rex_view::title($package->i18n('title'));
+
+rex_be_controller::includeCurrentPageSubPath();
diff --git a/pages/install.zip_install.settings.php b/pages/install.zip_install.settings.php
@@ -0,0 +1,106 @@
+<?php
+
+use FriendsOfRedaxo\ZipInstall\ZipInstall;
+
+$addon = rex_addon::get('zip_install');
+$csrf = rex_csrf_token::factory('zip_install_settings');
+
+// Handle form submission
+if (rex_post('save', 'boolean')) {
+    if ($csrf->isValid()) {
+        $githubToken = rex_post('github_token', 'string', '');
+        $uploadMaxSize = rex_post('upload_max_size', 'int', 50);
+        
+        // Validate upload size
+        if ($uploadMaxSize < 1 || $uploadMaxSize > 500) {
+            echo rex_view::error(rex_i18n::msg('zip_install_settings_upload_max_size_invalid'));
+        } else {
+            // Save settings
+            rex_config::set('zip_install', 'github_token', $githubToken);
+            rex_config::set('zip_install', 'upload_max_size', $uploadMaxSize);
+            
+            echo rex_view::success(rex_i18n::msg('zip_install_settings_saved'));
+        }
+    } else {
+        echo rex_view::error(rex_i18n::msg('csrf_token_invalid'));
+    }
+}
+
+// Get current settings
+$githubToken = rex_config::get('zip_install', 'github_token', '');
+$uploadMaxSize = rex_config::get('zip_install', 'upload_max_size', 50);
+
+// Get Rate Limit Info
+$rateLimitInfo = '';
+try {
+    $installer = new ZipInstall();
+    $rateLimit = $installer->getRateLimit();
+    
+    if ($rateLimit) {
+        $resetTime = date('H:i:s', $rateLimit['reset']);
+        
+        $rateLimitInfo = '<div class="alert alert-info" style="margin-top: 10px;">';
+        $rateLimitInfo .= '<strong>GitHub API Status:</strong><br>';
+        $rateLimitInfo .= 'Limit: ' . $rateLimit['limit'] . ' Requests/h<br>';
+        $rateLimitInfo .= 'Remaining: <strong>' . $rateLimit['remaining'] . '</strong><br>';
+        $rateLimitInfo .= 'Reset: ' . $resetTime;
+        $rateLimitInfo .= '</div>';
+    }
+} catch (Exception $e) {
+    // Ignore
+}
+
+// Build form
+$content = '';
+$content .= '<fieldset>';
+
+// GitHub Token field
+$formElements = [];
+
+$n = [];
+$n['label'] = '<label for="github_token">' . rex_i18n::msg('zip_install_settings_github_token') . '</label>';
+$n['field'] = '<input class="form-control" type="text" id="github_token" name="github_token" value="' . rex_escape($githubToken) . '" placeholder="ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" />';
+$n['note'] = rex_i18n::msg('zip_install_settings_github_token_info') . '<br><a href="https://github.com/settings/tokens/new" target="_blank" rel="noopener noreferrer"><i class="rex-icon fa-external-link"></i> ' . rex_i18n::msg('zip_install_settings_github_token_create') . '</a>';
+if ($rateLimitInfo) {
+    $n['note'] .= $rateLimitInfo;
+}
+$formElements[] = $n;
+
+// Upload Max Size field
+$n = [];
+$n['label'] = '<label for="upload_max_size">' . rex_i18n::msg('zip_install_settings_upload_max_size') . '</label>';
+$n['field'] = '<input class="form-control" type="number" id="upload_max_size" name="upload_max_size" value="' . $uploadMaxSize . '" min="1" max="500" />';
+$n['note'] = rex_i18n::msg('zip_install_settings_upload_max_size_info');
+$formElements[] = $n;
+
+$fragment = new rex_fragment();
+$fragment->setVar('elements', $formElements, false);
+$content .= $fragment->parse('core/form/form.php');
+
+$content .= '</fieldset>';
+
+// Form buttons
+$formElements = [];
+$n = [];
+$n['field'] = '<button class="btn btn-save rex-form-aligned" type="submit" name="save" value="1">' . rex_i18n::msg('zip_install_settings_save') . '</button>';
+$formElements[] = $n;
+
+$fragment = new rex_fragment();
+$fragment->setVar('elements', $formElements, false);
+$buttons = $fragment->parse('core/form/submit.php');
+$content .= $buttons;
+
+// Wrap in form
+$fragment = new rex_fragment();
+$fragment->setVar('class', 'edit', false);
+$fragment->setVar('title', rex_i18n::msg('zip_install_settings'), false);
+$fragment->setVar('body', $content, false);
+$content = $fragment->parse('core/page/section.php');
+
+$content = '
+<form action="' . rex_url::currentBackendPage() . '" method="post">
+    ' . $csrf->getHiddenField() . '
+    ' . $content . '
+</form>';
+
+echo $content;
diff --git a/pages/install.zip_install.upload.php b/pages/install.zip_install.upload.php
