Merge branch 'custom-connect-command' into 'master'

Custom Connect Command

circle/dashboard/admin.py

@@ -21,18 +21,22 @@ from django import contrib
 from django.contrib.auth.admin import UserAdmin, GroupAdmin
 from django.contrib.auth.models import User, Group
 
-from dashboard.models import Profile, GroupProfile
+from dashboard.models import Profile, GroupProfile, ConnectCommand
 
 
 class ProfileInline(contrib.admin.TabularInline):
     model = Profile
 
 
+class CommandInline(contrib.admin.TabularInline):
+    model = ConnectCommand
+
+
 class GroupProfileInline(contrib.admin.TabularInline):
     model = GroupProfile
 
 
-UserAdmin.inlines = (ProfileInline, )
+UserAdmin.inlines = (ProfileInline, CommandInline, )
 GroupAdmin.inlines = (GroupProfileInline, )
 
 contrib.admin.site.unregister(User)

circle/dashboard/forms.py

@@ -54,7 +54,9 @@ from .models import Profile, GroupProfile
 from circle.settings.base import LANGUAGES, MAX_NODE_RAM
 from django.utils.translation import string_concat
 
-from .virtvalidator import domain_validator
+from .validators import domain_validator
+
+from dashboard.models import ConnectCommand
 
 LANGUAGES_WITH_CODE = ((l[0], string_concat(l[1], " (", l[0], ")"))
                        for l in LANGUAGES)
@@ -1064,6 +1066,22 @@ class UserKeyForm(forms.ModelForm):
         return super(UserKeyForm, self).clean()
 
 
+class ConnectCommandForm(forms.ModelForm):
+    class Meta:
+        fields = ('name', 'access_method', 'template')
+        model = ConnectCommand
+
+    def __init__(self, *args, **kwargs):
+        self.user = kwargs.pop("user")
+        super(ConnectCommandForm, self).__init__(*args, **kwargs)
+
+    def clean(self):
+        if self.user:
+            self.instance.user = self.user
+
+        return super(ConnectCommandForm, self).clean()
+
+
 class TraitsForm(forms.ModelForm):
 
     class Meta:

circle/dashboard/models.py

@@ -46,8 +46,10 @@ from acl.models import AclBase
 from common.models import HumanReadableObject, create_readable, Encoder
 
 from vm.tasks.agent_tasks import add_keys, del_keys
+from vm.models.instance import ACCESS_METHODS
 
 from .store_api import Store, NoStoreException, NotOkException
+from .validators import connect_command_template_validator
 
 logger = getLogger(__name__)
 
@@ -100,6 +102,25 @@ class Notification(TimeStampedModel):
         self.message_data = None if value is None else value.to_dict()
 
 
+class ConnectCommand(Model):
+    user = ForeignKey(User, related_name='command_set')
+    access_method = CharField(max_length=10, choices=ACCESS_METHODS,
+                              verbose_name=_('access method'),
+                              help_text=_('Type of the remote access method.'))
+    name = CharField(max_length="128", verbose_name=_('name'), blank=False,
+                     help_text=_("Name of your custom command."))
+    template = CharField(blank=True, null=True, max_length=256,
+                         verbose_name=_('command template'),
+                         help_text=_('Template for connection command string. '
+                                     'Available parameters are: '
+                                     'username, password, '
+                                     'host, port.'),
+                         validators=[connect_command_template_validator])
+
+    def __unicode__(self):
+        return self.template
+
+
 class Profile(Model):
     user = OneToOneField(User)
     preferred_language = CharField(verbose_name=_('preferred language'),
@@ -129,6 +150,25 @@ class Profile(Model):
         default=2048 * 1024 * 1024,
         help_text=_('Disk quota in mebibytes.'))
 
+    def get_connect_commands(self, instance, use_ipv6=False):
+        """ Generate connection command based on template."""
+        single_command = instance.get_connect_command(use_ipv6)
+        if single_command:  # can we even connect to that VM
+            commands = self.user.command_set.filter(
+                access_method=instance.access_method)
+            if commands.count() < 1:
+                return [single_command]
+            else:
+                return [
+                    command.template % {
+                        'port': instance.get_connect_port(use_ipv6=use_ipv6),
+                        'host':  instance.get_connect_host(use_ipv6=use_ipv6),
+                        'password': instance.pw,
+                        'username': 'cloud',
+                    } for command in commands]
+        else:
+            return []
+
     def notify(self, subject, template, context=None, valid_until=None,
                **kwargs):
         if context is not None:

circle/dashboard/static/dashboard/dashboard.css

@@ -654,7 +654,8 @@ textarea[name="list-new-namelist"] {
   width: 130px;
 }
 
-#vm-details-connection-string-copy {
+.vm-details-connection-string-copy,
+#vm-details-pw-show {
   cursor: pointer;
 }
 
@@ -681,10 +682,9 @@ textarea[name="list-new-namelist"] {
   max-width: 200px;
 }
 
-#dashboard-vm-details-connect-command {
+.dashboard-vm-details-connect-command {
   /* for mobile view */
   margin-bottom: 20px;
-
 }
 
 #store-list-list {
@@ -868,6 +868,12 @@ textarea[name="list-new-namelist"] {
   padding: 5px 0px;
 }
 
+#profile-key-list-table td:last-child, #profile-key-list-table th:last-child, 
+#profile-command-list-table td:last-child, #profile-command-list-table th:last-child,
+#profile-command-list-table td:nth-child(2), #profile-command-list-table th:nth-child(2) {
+  text-align: center;  
+  vertical-align: middle;
+}
 
 #vm-list-table .migrating-icon {
   -webkit-animation: passing 2s linear infinite;

circle/dashboard/static/dashboard/vm-details.js

@@ -105,19 +105,20 @@ $(function() {
   $("#vm-details-pw-show").click(function() {
     var input = $(this).parent("div").children("input");
     var eye = $(this).children("#vm-details-pw-eye");
+    var span = $(this);
     
-    eye.tooltip("destroy")
+    span.tooltip("destroy")
     if(eye.hasClass("fa-eye")) {
       eye.removeClass("fa-eye").addClass("fa-eye-slash");
       input.prop("type", "text");
-      input.focus();
-      eye.prop("title", "Hide password");
+      input.select();
+      span.prop("title", gettext("Hide password"));
     } else {
       eye.removeClass("fa-eye-slash").addClass("fa-eye");
       input.prop("type", "password");
-      eye.prop("title", "Show password");
+      span.prop("title", gettext("Show password"));
     }
-    eye.tooltip();
+    span.tooltip();
   });
 
   /* change password confirmation */
@@ -198,7 +199,7 @@ $(function() {
   $("#vm-details-h1-name, .vm-details-rename-button").click(function() {
     $("#vm-details-h1-name").hide();
     $("#vm-details-rename").css('display', 'inline');
-    $("#vm-details-rename-name").focus();
+    $("#vm-details-rename-name").select();
     return false;
   });
 
@@ -206,7 +207,7 @@ $(function() {
   $(".vm-details-home-edit-name-click").click(function() {
     $(".vm-details-home-edit-name-click").hide();
     $("#vm-details-home-rename").show();
-    $("input", $("#vm-details-home-rename")).focus();
+    $("input", $("#vm-details-home-rename")).select();
     return false;
   });
 
@@ -306,8 +307,8 @@ $(function() {
   });
 
   // select connection string
-  $("#vm-details-connection-string-copy").click(function() {
-    $("#vm-details-connection-string").focus();
+  $(".vm-details-connection-string-copy").click(function() {
+    $(this).parent("div").find("input").select();
   });
 
   $("a.operation-password_reset").click(function() {

circle/dashboard/tables.py

@@ -25,6 +25,7 @@ from django_tables2.columns import (TemplateColumn, Column, BooleanColumn,
 from vm.models import Node, InstanceTemplate, Lease
 from django.utils.translation import ugettext_lazy as _
 from django_sshkey.models import UserKey
+from dashboard.models import ConnectCommand
 
 
 class NodeListTable(Table):
@@ -248,5 +249,41 @@ class UserKeyListTable(Table):
 
     class Meta:
         model = UserKey
-        attrs = {'class': ('table table-bordered table-striped table-hover')}
+        attrs = {'class': ('table table-bordered table-striped table-hover'),
+                 'id': "profile-key-list-table"}
         fields = ('name', 'fingerprint', 'created', 'actions')
+        prefix = "key-"
+        empty_text = _("You haven't added any public keys yet.")
+
+
+class ConnectCommandListTable(Table):
+    name = LinkColumn(
+        'dashboard.views.connect-command-detail',
+        args=[A('pk')],
+        attrs={'th': {'data-sort': "string"}}
+    )
+    access_method = Column(
+        verbose_name=_("Access method"),
+        attrs={'th': {'data-sort': "string"}}
+    )
+    template = Column(
+        verbose_name=_("Template"),
+        attrs={'th': {'data-sort': "string"}}
+    )
+    actions = TemplateColumn(
+        verbose_name=_("Actions"),
+        template_name=("dashboard/connect-command-list/column-command"
+                       "-actions.html"),
+        orderable=False,
+    )
+
+    class Meta:
+        model = ConnectCommand
+        attrs = {'class': ('table table-bordered table-striped table-hover'),
+                 'id': "profile-command-list-table"}
+        fields = ('name', 'access_method',  'template', 'actions')
+        prefix = "cmd-"
+        empty_text = _(
+            "You don't have any custom connection commands yet. You can "
+            "specify commands to be displayed on VM detail pages instead of "
+            "the defaults.")

circle/dashboard/templates/dashboard/connect-command-create.html

+{% extends "dashboard/base.html" %}
+{% load i18n %}
+{% load crispy_forms_tags %}
+
+{% block title-page %}{% trans "Create command template" %}{% endblock %}
+
+{% block content %}
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <a class="pull-right btn btn-default btn-xs" href="{% url "dashboard.views.profile-preferences" %}">{% trans "Back" %}</a>
+        <h3 class="no-margin"><i class="fa fa-code"></i> {% trans "Create new command template" %}</h3>
+      </div>
+      <div class="panel-body">
+        <form method="POST">
+          {% csrf_token %}
+          {{ form.name|as_crispy_field }}
+          {{ form.access_method|as_crispy_field }}
+          {{ form.template|as_crispy_field }}
+          <p class="text-muted">
+            {% trans "Examples" %}
+          </p>
+          <p>
+            <strong>SSH:</strong>
+            <span class="text-muted">
+              sshpass -p %(password)s ssh -o StrictHostKeyChecking=no cloud@%(host)s -p %(port)d
+            </span>
+          </p>
+          <p>
+            <strong>RDP:</strong>
+            <span class="text-muted">
+              rdesktop %(host)s:%(port)d -u cloud -p %(password)s
+            </span>
+          </p>
+          <input type="submit" class="btn btn-primary" value="{% trans "Save" %}">
+        </form>
+      </div>
+    </div>
+  </div>
+</div>
+
+{% endblock %}

circle/dashboard/templates/dashboard/connect-command-edit.html

+{% extends "dashboard/base.html" %}
+{% load i18n %}
+{% load crispy_forms_tags %}
+
+{% block title-page %}{% trans "Edit command template" %}{% endblock %}
+
+{% block content %}
+
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <a class="pull-right btn btn-default btn-xs" href="{% url "dashboard.views.profile-preferences" %}">{% trans "Back" %}</a>
+        <h3 class="no-margin"><i class="fa fa-code"></i> {% trans "Edit command template" %}</h3>
+      </div>
+      <div class="panel-body">
+        <form method="POST">
+          {% csrf_token %}
+          {{ form.name|as_crispy_field }}
+          {{ form.access_method|as_crispy_field }}
+          {{ form.template|as_crispy_field }}
+          <p class="text-muted">
+            {% trans "Examples" %}
+          </p>
+          <p>
+            <strong>SSH:</strong>
+            <span class="text-muted">
+              sshpass -p %(password)s ssh -o StrictHostKeyChecking=no cloud@%(host)s -p %(port)d
+            </span>
+          </p>
+          <p>
+            <strong>RDP:</strong>
+            <span class="text-muted">
+              rdesktop %(host)s:%(port)d -u cloud -p %(password)s
+            </span>
+          </p>
+          <input type="submit" class="btn btn-primary" value="{% trans "Save" %}">
+        </form>
+      </div>
+    </div>
+  </div>
+</div>
+
+{% endblock %}

circle/dashboard/templates/dashboard/connect-command-list/column-command-actions.html

+{% load i18n %}
+<a href="{% url "dashboard.views.connect-command-detail" pk=record.pk%}" id="template-list-edit-button" class="btn btn-default btn-xs" title="{% trans "Edit" %}">
+  <i class="fa fa-edit"></i>
+</a>
+<a data-template-pk="{{ record.pk }}" href="{% url "dashboard.views.connect-command-delete" pk=record.pk %}" class="btn btn-danger btn-xs template-delete" title="{% trans "Delete" %}">
+  <i class="fa fa-times"></i>
+</a>

circle/dashboard/templates/dashboard/profile_form.html

@@ -66,4 +66,20 @@
   </div>
 </div>
 
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-default">
+      <div class="panel-heading">
+        <a href="{% url "dashboard.views.connect-command-create" %}" 
+          class="pull-right btn btn-success btn-xs" style="margin-right: 10px;">
+          <i class="fa fa-plus"></i> {% trans "add command template" %}
+        </a>
+        <h3 class="no-margin"><i class="fa fa-code"></i> {% trans "Command templates" %}</h3>
+      </div>
+      <div class="panel-body">
+        {% render_table connectcommand_table %}
+      </div>
+    </div>
+  </div>
+</div>
 {% endblock %}	

circle/dashboard/templates/dashboard/vm-detail.html

@@ -98,8 +98,9 @@
           <div class="input-group">
             <input type="text" id="vm-details-pw-input" class="form-control input-sm input-tags"
             value="{{ instance.pw }}" spellcheck="false"/>
-            <span class="input-group-addon input-tags" id="vm-details-pw-show">
-              <i class="fa fa-eye" id="vm-details-pw-eye" title="Show password"></i>
+            <span class="input-group-addon input-tags" id="vm-details-pw-show"
+              title="{% trans "Show password" %}" data-container="body">
+              <i class="fa fa-eye" id="vm-details-pw-eye"></i>
             </span>
           </div>
         </dd>
@@ -111,16 +112,29 @@
           </div>
         </dd>
       </dl>
-
-      <div class="input-group" id="dashboard-vm-details-connect-command">
+      {% for c in connect_commands %}
+      <div class="input-group dashboard-vm-details-connect-command">
         <span class="input-group-addon input-tags">{% trans "Command" %}</span>
         <input type="text" spellcheck="false"
-        value="{% if instance.get_connect_command %}{{ instance.get_connect_command }}{% else %}{% trans "Connection is not possible." %}{% endif %}"
+        value="{{ c }}"
+        id="vm-details-connection-string" class="form-control input-tags" />
+        <span class="input-group-addon input-tags vm-details-connection-string-copy"
+          title="{% trans "Select all" %}" data-container="body">
+          <i class="fa fa-copy"></i>
+        </span>
+      </div>
+
+      {% empty %}
+      <div class="input-group dashboard-vm-details-connect-command">
+        <span class="input-group-addon input-tags">{% trans "Command" %}</span>
+        <input type="text" spellcheck="false" value="{% trans "Connection is not possible." %}"
         id="vm-details-connection-string" class="form-control input-tags" />
         <span class="input-group-addon input-tags" id="vm-details-connection-string-copy">
           <i class="fa fa-copy" title="{% trans "Select all" %}"></i>
         </span>
       </div>
+
+      {% endfor %}
     </div>
     <div class="col-md-8" id="vm-detail-pane">
       <div class="panel panel-default" id="vm-detail-panel">

circle/dashboard/urls.py

@@ -39,6 +39,7 @@ from .views import (
     get_vm_screenshot,
     ProfileView, toggle_use_gravatar, UnsubscribeFormView,
     UserKeyDelete, UserKeyDetail, UserKeyCreate,
+    ConnectCommandDelete, ConnectCommandDetail, ConnectCommandCreate,
     StoreList, store_download, store_upload, store_get_upload_url, StoreRemove,
     store_new_directory, store_refresh_toplist,
     VmTraitsUpdate, VmRawDataUpdate,
@@ -177,6 +178,16 @@ urlpatterns = patterns(
         UserKeyCreate.as_view(),
         name="dashboard.views.userkey-create"),
 
+    url(r'^conncmd/delete/(?P<pk>\d+)/$',
+        ConnectCommandDelete.as_view(),
+        name="dashboard.views.connect-command-delete"),
+    url(r'^conncmd/(?P<pk>\d+)/$',
+        ConnectCommandDetail.as_view(),
+        name="dashboard.views.connect-command-detail"),
+    url(r'^conncmd/create/$',
+        ConnectCommandCreate.as_view(),
+        name="dashboard.views.connect-command-create"),
+
     url(r'^autocomplete/', include('autocomplete_light.urls')),
 
     url(r"^store/list/$", StoreList.as_view(),

circle/dashboard/virtvalidator.py → circle/dashboard/validators.py

 from django.core.exceptions import ValidationError
+from django.utils.translation import ugettext_lazy as _
+
 from lxml import etree as ET
 import logging
 
@@ -29,3 +31,27 @@ def domain_validator(value):
             relaxng.assertValid(parsed_xml)
         except Exception as e:
             raise ValidationError(e.message)
+
+
+def connect_command_template_validator(value):
+    """Validate value as a connect command template.
+
+    >>> try: connect_command_template_validator("%(host)s")
+    ... except ValidationError as e: print e
+    ...
+    >>> connect_command_template_validator("%(host)s")
+    >>> try: connect_command_template_validator("%(host)s %s")
+    ... except ValidationError as e: print e
+    ...
+    [u'Invalid template string.']
+    """
+
+    try:
+        value % {
+            'username': "uname",
+            'password': "pw",
+            'host': "111.111.111.111",
+            'port': 12345,
+        }
+    except (KeyError, TypeError, ValueError):
+        raise ValidationError(_("Invalid template string."))

circle/dashboard/views.py

@@ -70,12 +70,12 @@ from .forms import (
     VmSaveForm, UserKeyForm, VmRenewForm, VmStateChangeForm,
     CirclePasswordChangeForm, VmCreateDiskForm, VmDownloadDiskForm,
     TraitsForm, RawDataForm, GroupPermissionForm, AclUserAddForm,
-    VmResourcesForm, VmAddInterfaceForm, VmListSearchForm
+    VmResourcesForm, VmAddInterfaceForm, VmListSearchForm, ConnectCommandForm
 )
 
 from .tables import (
     NodeListTable, TemplateListTable, LeaseListTable,
-    GroupListTable, UserKeyListTable
+    GroupListTable, UserKeyListTable, ConnectCommandListTable,
 )
 from common.models import (
     HumanReadableObject, HumanReadableException, fetch_human_exception,
@@ -87,7 +87,8 @@ from vm.models import (
 )
 from storage.models import Disk
 from firewall.models import Vlan, Host, Rule
-from .models import Favourite, Profile, GroupProfile, FutureMember
+from .models import (Favourite, Profile, GroupProfile, FutureMember,
+                     ConnectCommand)
 
 from .store_api import Store, NoStoreException, NotOkException
 
@@ -306,6 +307,7 @@ class VmDetailView(CheckedDetailView):
                                     kwargs={'pk': self.object.pk}),
             'ops': ops,
             'op': {i.op: i for i in ops},
+            'connect_commands': user.profile.get_connect_commands(instance)
         })
 
         # activity data
@@ -2907,11 +2909,16 @@ class MyPreferencesView(UpdateView):
                 user=self.request.user),
             'change_language': MyProfileForm(instance=self.get_object()),
         }
-        table = UserKeyListTable(
+        key_table = UserKeyListTable(
             UserKey.objects.filter(user=self.request.user),
             request=self.request)
-        table.page = None
-        context['userkey_table'] = table
+        key_table.page = None
+        context['userkey_table'] = key_table
+        cmd_table = ConnectCommandListTable(
+            self.request.user.command_set.all(),
+            request=self.request)
+        cmd_table.page = None
+        context['connectcommand_table'] = cmd_table
         return context
 
     def get_object(self, queryset=None):
@@ -3316,6 +3323,82 @@ class UserKeyCreate(LoginRequiredMixin, SuccessMessageMixin, CreateView):
         return kwargs
 
 
+class ConnectCommandDetail(LoginRequiredMixin, SuccessMessageMixin,
+                           UpdateView):
+    model = ConnectCommand
+    template_name = "dashboard/connect-command-edit.html"
+    form_class = ConnectCommandForm
+    success_message = _("Successfully modified command template.")
+
+    def get(self, request, *args, **kwargs):
+        object = self.get_object()
+        if object.user != request.user:
+            raise PermissionDenied()
+        return super(ConnectCommandDetail, self).get(request, *args, **kwargs)
+
+    def get_success_url(self):
+        return reverse_lazy("dashboard.views.connect-command-detail",
+                            kwargs=self.kwargs)
+
+    def post(self, request, *args, **kwargs):
+        object = self.get_object()
+        if object.user != request.user:
+            raise PermissionDenied()
+        return super(ConnectCommandDetail, self).post(request, args, kwargs)
+
+    def get_form_kwargs(self):
+        kwargs = super(ConnectCommandDetail, self).get_form_kwargs()
+        kwargs['user'] = self.request.user
+        return kwargs
+
+
+class ConnectCommandDelete(LoginRequiredMixin, DeleteView):
+    model = ConnectCommand
+
+    def get_success_url(self):
+        return reverse("dashboard.views.profile-preferences")
+
+    def get_template_names(self):
+        if self.request.is_ajax():
+            return ['dashboard/confirm/ajax-delete.html']
+        else:
+            return ['dashboard/confirm/base-delete.html']
+
+    def delete(self, request, *args, **kwargs):
+        object = self.get_object()
+        if object.user != request.user:
+            raise PermissionDenied()
+
+        object.delete()
+        success_url = self.get_success_url()
+        success_message = _("Command template successfully deleted.")
+
+        if request.is_ajax():
+            return HttpResponse(
+                json.dumps({'message': success_message}),
+                content_type="application/json",
+            )
+        else:
+            messages.success(request, success_message)
+            return HttpResponseRedirect(success_url)
+
+
+class ConnectCommandCreate(LoginRequiredMixin, SuccessMessageMixin,
+                           CreateView):
+    model = ConnectCommand
+    form_class = ConnectCommandForm
+    template_name = "dashboard/connect-command-create.html"
+    success_message = _("Successfully created a new command template.")
+
+    def get_success_url(self):
+        return reverse_lazy("dashboard.views.profile-preferences")
+
+    def get_form_kwargs(self):
+        kwargs = super(ConnectCommandCreate, self).get_form_kwargs()
+        kwargs['user'] = self.request.user
+        return kwargs
+
+
 class HelpView(TemplateView):
 
     def get_context_data(self, *args, **kwargs):