[PATCH cluster/manager v3 0/2] Configurable window titles for nodes

[Thomas Ellmenreich <t.ellmenreich@proxmox.com>]

Thank you @Dominik Csapak, @Thomas Lamprecht, @Elias Huhsovitz for your comments.

Configurable window titles for nodes
====================================

Currently the window title is fixed to the following string:

$nodename - Proxmox Virtual Environment

This has become problematic for users with multiple clusters, each containing
the same node name. To help distinguish between tabs, it has been requested [1]
that the window title be made configurable with the fqdn as an option.

[1] https://bugzilla.proxmox.com/show_bug.cgi?id=5475

Implementation
--------------

After considering the different options, I have deemed a server side
implementation, through the datacenter.cfg, to be the better option.
Specifically because of its durability across sessions and because it
automatically configures the title for all users and all nodes across the
cluster.

The config now contains a new ui-settings format string which then in turn
contains a 'title' enum field for the window title. This enum string will then
be converted to a window title and inserted in the index.html.tpl template on
every request.

The current enum options are:

- default - Displays the default '$nodename - Proxmox Virtual Environment' string
  if the config enum is not present

- 'node-and-cluster' - Displays the nodename and then the clustername in the
  following style: '$nodename - $clustername - Proxmox Virtual Environment'

- 'fqdn' - Displays the current fqdn as returned by `PVE::Tools::get_fqdn()`
  like so: '$fqdn - Proxmox Virtual Environment'


Possible future extensions
--------------------------

- If proper cross-node user settings are implemented in the future, they could
  be used to allow users to define their own window title settings and have
  these settings be persisted across sessions

- One of the selection options for window titles could be a user defined
  template string which would allow users of PVE to define their own
  window titles.

Changes since v2
----------------

- The creation of the final title is now wrapped in an 'eval' block to catch
  any exceptions. If an error occurs or the return value is undefined, the
  default title is shown.

- `get_fqdn` is now correctly called with the $nodename. Thanks @Elias ;)

- The combo box showing the title options now displays descriptive names for
  the different options instead of an example of what the real title would
  look like.

Changes since v1
----------------

- Instead of storing the 'window-title' setting directly in the datacenter.cfg
  its now nested in a more general 'ui-settings' format string. This allows
  easier expansion in the future

- All adjustments that were needed to create the 'ui-settings' format string

Changes since RFC
-----------------

- change of the `datacenter.cfg` setting title from "windowtitle" to
  "window-title"

- renamed `nodeandcluster` to `node-and-cluster`

- added the " - Proxmox Virtual Environment" trailer to all titles

- removed the questions from this text and added the "Possible future
  extensions" section


pve-manager:

Thomas Ellmenreich (1):
  fix #5475: configurable window title

 PVE/Service/pveproxy.pm       | 27 ++++++++++++++++
 www/index.html.tpl            |  2 +-
 www/manager6/UIOptions.js     |  6 ++++
 www/manager6/dc/OptionView.js | 61 +++++++++++++++++++++++++++++++++++
 4 files changed, 95 insertions(+), 1 deletion(-)


pve-cluster:

Thomas Ellmenreich (1):
  fix #5475: configurable window title

 src/PVE/DataCenterConfig.pm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)


Summary over all repositories:
  5 files changed, 120 insertions(+), 1 deletions(-)

-- 
Generated by murpp 0.12.0