File: ui.go

package info (click to toggle)
snapd 2.72-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 80,412 kB
  • sloc: sh: 16,506; ansic: 16,211; python: 11,213; makefile: 1,919; exp: 190; awk: 58; xml: 22
file content (94 lines) | stat: -rw-r--r-- 2,495 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2018 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package ui

import (
	"fmt"
	"os"
	"strings"
	"time"

	"github.com/snapcore/snapd/osutil"
)

// UI is an interface for user interaction
type UI interface {
	// YesNo asks a yes/no question. The primary text
	// will be printed in a larger font, the secondary text
	// in the standard font and the (optional) footer will
	// be printed in a small font.
	//
	// The value "true" is returned if the user clicks "yes",
	// otherwise "false".
	YesNo(primary, secondary string, options *DialogOptions) bool
}

// Options for the UI interface
type DialogOptions struct {
	Footer  string
	Timeout time.Duration
}

var hasZenityExecutable = func() bool {
	return osutil.ExecutableExists("zenity")
}

var hasKDialogExecutable = func() bool {
	return osutil.ExecutableExists("kdialog")
}

func MockHasZenityExecutable(f func() bool) func() {
	oldHasZenityExecutable := hasZenityExecutable
	hasZenityExecutable = f
	return func() {
		hasZenityExecutable = oldHasZenityExecutable
	}
}

func MockHasKDialogExecutable(f func() bool) func() {
	oldHasKDialogExecutable := hasKDialogExecutable
	hasKDialogExecutable = f
	return func() {
		hasKDialogExecutable = oldHasKDialogExecutable
	}
}

// New returns the best matching UI interface for the given system
// or an error if no ui can be created.
func New() (UI, error) {
	hasZenity := hasZenityExecutable()
	hasKDialog := hasKDialogExecutable()

	switch {
	case hasZenity && hasKDialog:
		// prefer kdialog on KDE, otherwise use zenity
		currentDesktop := os.Getenv("XDG_CURRENT_DESKTOP")
		if strings.Contains("kde", strings.ToLower(currentDesktop)) {
			return &KDialog{}, nil
		}
		return &Zenity{}, nil
	case hasZenity:
		return &Zenity{}, nil
	case hasKDialog:
		return &KDialog{}, nil
	default:
		return nil, fmt.Errorf("cannot create a UI: please install zenity or kdialog")
	}
}