Merge pull request #242 from Xpirix/allow_empty_plugin

Allow uploading an empty plugin

Author: Xpirix

qgis-app/plugins/forms.py

@@ -194,6 +194,67 @@ def clean(self):
         return super(PluginVersionForm, self).clean()
 
 
+class PluginCreateForm(forms.Form):
+    """
+    Form for creating an empty plugin (no versions yet).
+    Minimal fields - the rest will be populated from metadata.txt on first upload.
+    """
+
+    required_css_class = "required"
+    name = forms.CharField(
+        label=_("Plugin name"),
+        help_text=_("A display name for your plugin. It must be unique."),
+        max_length=256,
+    )
+    package_name = forms.CharField(
+        label=_("Package name"),
+        help_text=_(
+            "This must be the main plugin folder name inside your zip file. Use only ASCII letters, digits, '-' or '_'. This cannot be changed later."
+        ),
+        max_length=256,
+    )
+
+    def clean_package_name(self):
+        package_name = self.cleaned_data.get("package_name", "").strip()
+        if not re.match(r"^[A-Za-z][A-Za-z0-9-_]+$", package_name):
+            raise ValidationError(
+                _(
+                    "Package name must start with a letter and can contain only ASCII letters, digits, '-' or '_'."
+                )
+            )
+        existing = Plugin.objects.filter(package_name__iexact=package_name).first()
+        if existing:
+            raise ValidationError(
+                _("A plugin with a similar package name (%s) already exists.")
+                % existing.package_name
+            )
+        return package_name
+
+    def clean_name(self):
+        name = self.cleaned_data.get("name", "").strip()
+        existing = Plugin.objects.filter(name__iexact=name).first()
+        if existing:
+            raise ValidationError(
+                _("A plugin with a similar name (%s) already exists.") % existing.name
+            )
+        return name
+
+    def save(self, created_by, commit=True):
+        plugin = Plugin()
+        # Set all required fields first
+        plugin.created_by = created_by
+        plugin.author = created_by.get_full_name() or created_by.username
+        plugin.email = created_by.email or "noreply@example.com"
+        plugin.description = "Placeholder - will be updated on first version upload"
+        plugin.package_name = self.cleaned_data.get("package_name")
+        plugin.name = self.cleaned_data.get("name")
+
+        if commit:
+            # Skip model validation since we already validated in the form
+            plugin.save()
+        return plugin
+
+
 class PackageUploadForm(forms.Form):
     """
     Single step upload for new plugins

qgis-app/plugins/templates/plugins/plugin_create_empty.html

@@ -0,0 +1,44 @@
+{% extends 'plugins/plugin_base.html' %}{% load i18n %}
+{% block content %}
+  <h2>{% trans "Create an empty plugin" %}</h2>
+  <div class="container rich">
+    <div class="cont coloring-6">
+      <p>{% trans "Create a plugin entry without uploading a package. This is useful if you want to generate a token and upload versions later via the API." %}</p>
+      <p>{% trans "Only the package name and plugin name are required here. All other plugin details (description, author, homepage, etc.) will be automatically populated from the metadata.txt file when you upload your first version." %}</p>
+    </div>
+  </div>
+  <div class="container rich mt-3">
+    <div class="cont coloring-2">
+      <p class="has-text-weight-bold">
+        <i class="fas fa-exclamation-triangle"></i>
+        {% trans "Important: The package name you specify below must exactly match the main folder name inside your plugin's zip file when you upload versions later." %}
+      </p>
+    </div>
+  </div>
+  {% if form.errors %}
+  <div class="notification is-danger is-light">
+    <button class="delete" data-dismiss="alert">&times;</button>
+    {% trans "The form contains errors and cannot be submitted, please check the fields highlighted in red." %}
+  </div>
+  {% endif %}
+  {% if form.non_field_errors %}
+  <div class="notification is-danger is-light">
+    <button class="delete" data-dismiss="alert">&times;</button>
+    {% for error in form.non_field_errors %}
+      {{ error }}<br />
+    {% endfor %}
+  </div>
+  {% endif %}
+
+  <form action="" method="post" class="horizontal" enctype="multipart/form-data">{% csrf_token %}
+    {% include "plugins/form_snippet.html" %}
+    <div class="mt-3 has-text-centered">
+      <button class="button is-success is-medium" type="submit">
+        <span class="icon is-small">
+          <i class="fas fa-plus"></i>
+        </span>
+        <span>{% trans "Create plugin" %}</span>
+      </button>
+    </div>
+  </form>
+{% endblock %}

qgis-app/plugins/templates/plugins/plugin_sidebar.html

@@ -1,12 +1,20 @@
 {% load i18n plugins_tagcloud simplemenu_tags static plugin_utils %}
 <nav id="sidebar" class="sidebar">
   <ul class="content-wrapper">
-    <li>
-      <a class="button is-success is-medium" href="{% url "plugin_upload" %}">
-        <i class="fas fa-upload"></i>
-        {% trans "Upload a plugin" %}
+    <div class="buttons mb-0">
+      <a class="button is-success is-fullwidth" href="{% url "plugin_upload" %}">
+        <span class="icon">
+          <i class="fas fa-upload"></i>
+        </span>
+        <span>{% trans "Upload a plugin" %}</span>
       </a>
-    </li>
+      <a class="button is-success is-outlined is-fullwidth" href="{% url "plugin_create_empty" %}">
+        <span class="icon">
+          <i class="fas fa-plus"></i>
+        </span>
+        <span>{% trans "Create empty plugin" %}</span>
+      </a>
+    </div>
     <hr/>
 
     {% get_navigation_menu user as menu %}

qgis-app/plugins/templates/plugins/plugin_token_list.html

@@ -6,9 +6,11 @@ <h2>{% trans "Tokens for" %} {{ plugin.name }}</h2>
   <div style="margin:0; width:fit-content;">
     <h2>
       <button type="submit" name="plugin_token_create" id="plugin_token_create"
-        value="{% trans "Generate a New Token" %}" class="button" style="padding: 10px">
-        <i class="fas fa-plus" style="vertical-align: middle;"></i>
-        &nbsp;{% trans "Generate a New Token" %}
+        value="{% trans "Generate a New Token" %}" class="button is-light">
+        <span class="icon">
+          <i class="fas fa-plus"></i>
+        </span>
+        <span>{% trans "Generate a New Token" %}</span>
       </button>
     </h2>
   </div>
@@ -74,4 +76,4 @@ <h2>
     direction: rtl;
   }
 </style>
-{% endblock %}
+{% endblock %}

qgis-app/plugins/templates/plugins/plugin_upload.html

@@ -1,11 +1,15 @@
 {% extends 'plugins/plugin_base.html' %}{% load i18n %}
 {% block content %}
     <h2>{% trans "Upload a plugin" %}</h2>
-    
+
     <div class="container rich">
         <div class="cont coloring-6">
             <p>{% trans "To upload a new plugin or update an existing one, you can specify the zipped file in this form." %}</p>
             <p>{% trans "Alternatively, to update an existing plugin, you can also open the plugin's details view and add a new version from there." %}</p>
+            <p>
+                {% trans "Need to initialize a plugin without uploading a package?" %}
+                <a href="{% url "plugin_create_empty" %}">{% trans "Create an empty plugin" %}</a>.
+            </p>
         </div>
     </div>
     {% if form.non_field_errors %}
@@ -20,7 +24,7 @@ <h2>{% trans "Upload a plugin" %}</h2>
     <form action="" method="post" enctype="multipart/form-data" class="horizontal">{% csrf_token %}
         {% include "plugins/form_snippet.html" %}
         <div class="mt-3 has-text-centered">
-            <button class="button is-success is-large" type="submit">
+            <button class="button is-success is-medium" type="submit">
                 <span class="icon is-small">
                     <i class="fas fa-upload"></i>
                 </span>
@@ -35,10 +39,10 @@ <h2>{% trans "Upload a plugin" %}</h2>
     <div class="container rich">
         <div class="cont coloring-2">
             <p>
-                {% blocktrans %} 
-                    Please note that by uploading a plugin to the official QGIS plugin repository, 
-                    you agree that we will use your email to contact you. We will only contact 
-                    you for matters relating to the management of plugins and will not make 
+                {% blocktrans %}
+                    Please note that by uploading a plugin to the official QGIS plugin repository,
+                    you agree that we will use your email to contact you. We will only contact
+                    you for matters relating to the management of plugins and will not make
                     your email available to third parties for marketing purposes.
                 {% endblocktrans %}
 
@@ -48,16 +52,16 @@ <h2>{% trans "Upload a plugin" %}</h2>
     <div class="container rich">
         <div class="cont coloring-2">
             <p>
-                {% blocktrans %} 
-                    By uploading your plugin to the QGIS plugin repository, 
-                    you agree to keep your email address current and to be 
-                    responsive to any correspondence we may send you 
-                    regarding the management of your plugin. We require 
-                    this in order to be able to provide our users assurance 
-                    that the plugins we host are well maintained and will be 
+                {% blocktrans %}
+                    By uploading your plugin to the QGIS plugin repository,
+                    you agree to keep your email address current and to be
+                    responsive to any correspondence we may send you
+                    regarding the management of your plugin. We require
+                    this in order to be able to provide our users assurance
+                    that the plugins we host are well maintained and will be
                     fixed should serious issues arise during their use.
-                    We reserve the right to hide or remove plugins in cases 
-                    where the plugin author is not contactable and there 
+                    We reserve the right to hide or remove plugins in cases
+                    where the plugin author is not contactable and there
                     are issues reported about a plugin.
                 {% endblocktrans %}
             </p>