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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
Copyright 2014 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 warranties of
MERCHANTABILITY, SATISFACTORY QUALITY, 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 sounds
import (
"errors"
"os"
"os/exec"
"path/filepath"
"strings"
"launchpad.net/go-xdg/v0"
"launchpad.net/ubuntu-push/bus/accounts"
"launchpad.net/ubuntu-push/click"
"launchpad.net/ubuntu-push/launch_helper"
"launchpad.net/ubuntu-push/logger"
)
type Sound interface {
// Present() presents the notification audibly if applicable.
Present(app *click.AppId, nid string, notification *launch_helper.Notification) bool
// GetSound() returns absolute path to the file the given notification will play.
GetSound(app *click.AppId, nid string, notification *launch_helper.Notification) string
}
type sound struct {
player string
log logger.Logger
acc accounts.Accounts
fallback string
dataDirs func() []string
dataFind func(string) (string, error)
}
func New(log logger.Logger, acc accounts.Accounts, fallback string) *sound {
return &sound{
player: "paplay",
log: log,
acc: acc,
fallback: fallback,
dataDirs: xdg.Data.Dirs,
dataFind: xdg.Data.Find,
}
}
func (snd *sound) Present(app *click.AppId, nid string, notification *launch_helper.Notification) bool {
if notification == nil {
panic("please check notification is not nil before calling present")
}
absPath := snd.GetSound(app, nid, notification)
if absPath == "" {
return false
}
snd.log.Debugf("[%s] playing sound %s using %s", nid, absPath, snd.player)
cmd := exec.Command(snd.player, absPath)
err := cmd.Start()
if err != nil {
snd.log.Debugf("[%s] unable to play: %v", nid, err)
return false
}
go func() {
err := cmd.Wait()
if err != nil {
snd.log.Debugf("[%s] error playing sound %s: %v", nid, absPath, err)
}
}()
return true
}
// Returns the absolute path of the sound to be played for app, nid and notification.
func (snd *sound) GetSound(app *click.AppId, nid string, notification *launch_helper.Notification) string {
if snd.acc.SilentMode() {
snd.log.Debugf("[%s] no sounds: silent mode on.", nid)
return ""
}
fallback := snd.acc.MessageSoundFile()
if fallback == "" {
fallback = snd.fallback
}
sound := notification.Sound(fallback)
if sound == "" {
snd.log.Debugf("[%s] notification has no Sound: %#v", nid, sound)
return ""
}
absPath := snd.findSoundFile(app, nid, sound)
if absPath == "" {
snd.log.Debugf("[%s] unable to find sound %s", nid, sound)
}
return absPath
}
// Removes all cruft from path, ensures it's a "forward" path.
func (snd *sound) cleanPath(path string) (string, error) {
cleaned := filepath.Clean(path)
if strings.Contains(cleaned, "../") {
return "", errors.New("Path escaping xdg attempt")
}
return cleaned, nil
}
func (snd *sound) findSoundFile(app *click.AppId, nid string, sound string) string {
// XXX also support legacy appIds?
// first, check package-specific
sound, err := snd.cleanPath(sound)
if err != nil {
// bad boy
return ""
}
absPath, err := snd.dataFind(filepath.Join(app.Package, sound))
if err == nil {
// ffffound
return absPath
}
// next, check the XDG data dirs (but skip the first one -- that's "home")
// XXX should we only check in $XDG/sounds ? (that's for sound *themes*...)
for _, dir := range snd.dataDirs()[1:] {
absPath := filepath.Join(dir, sound)
_, err := os.Stat(absPath)
if err == nil {
return absPath
}
}
return ""
}
|