Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

# -*- coding: utf-8 -*- 

# 

# Copyright (C) 2007, 2008 Andrew Resch <andrewresch@gmail.com> 

# 

# This file is part of Deluge and is licensed under GNU General Public License 3.0, or later, with 

# the additional special exception to link portions of this program with the OpenSSL library. 

# See LICENSE for more details. 

# 

 

import logging 

import os 

 

import gtk 

 

import deluge.common 

import deluge.component as component 

from deluge.configmanager import ConfigManager 

from deluge.ui.client import client 

from deluge.ui.gtkui import dialogs 

from deluge.ui.gtkui.common import build_menu_radio_list, get_logo 

 

try: 

    import appindicator 

except ImportError: 

    appindicator = None 

 

log = logging.getLogger(__name__) 

 

 

class SystemTray(component.Component): 

    def __init__(self): 

        component.Component.__init__(self, "SystemTray", interval=4) 

        self.window = component.get("MainWindow") 

        self.config = ConfigManager("gtkui.conf") 

        # List of widgets that need to be hidden when not connected to a host 

        self.hide_widget_list = [ 

            "menuitem_add_torrent", 

            "menuitem_pause_session", 

            "menuitem_resume_session", 

            "menuitem_download_limit", 

            "menuitem_upload_limit", 

            "menuitem_quitdaemon", 

            "separatormenuitem1", 

            "separatormenuitem2", 

            "separatormenuitem3", 

            "separatormenuitem4" 

        ] 

        self.config.register_set_function("enable_system_tray", self.on_enable_system_tray_set) 

        # bit of a hack to prevent function from doing something on startup 

        self.__enabled_set_once = False 

        self.config.register_set_function("enable_appindicator", self.on_enable_appindicator_set) 

 

        self.max_download_speed = -1.0 

        self.download_rate = 0.0 

        self.max_upload_speed = -1.0 

        self.upload_rate = 0.0 

 

        self.config_value_changed_dict = { 

            "max_download_speed": self._on_max_download_speed, 

            "max_upload_speed": self._on_max_upload_speed 

        } 

 

    def enable(self): 

        """Enables the system tray icon.""" 

        self.builder = gtk.Builder() 

        self.builder.add_from_file(deluge.common.resource_filename( 

            "deluge.ui.gtkui", os.path.join("glade", "tray_menu.ui")) 

        ) 

 

        self.builder.connect_signals({ 

            "on_menuitem_show_deluge_activate": self.on_menuitem_show_deluge_activate, 

            "on_menuitem_add_torrent_activate": self.on_menuitem_add_torrent_activate, 

            "on_menuitem_pause_session_activate": self.on_menuitem_pause_session_activate, 

            "on_menuitem_resume_session_activate": self.on_menuitem_resume_session_activate, 

            "on_menuitem_quit_activate": self.on_menuitem_quit_activate, 

            "on_menuitem_quitdaemon_activate": self.on_menuitem_quitdaemon_activate 

        }) 

 

        self.tray_menu = self.builder.get_object("tray_menu") 

 

        if appindicator and self.config["enable_appindicator"]: 

            log.debug("Enabling the Application Indicator...") 

            self.indicator = appindicator.Indicator("deluge", "deluge", 

                                                    appindicator.CATEGORY_APPLICATION_STATUS) 

            try: 

                self.indicator.set_property("title", _("Deluge")) 

            except TypeError: 

                # Catch 'title' property error for previous appindicator versions 

                pass 

            # Pass the menu to the Application Indicator 

            self.indicator.set_menu(self.tray_menu) 

 

            # Make sure the status of the Show Window MenuItem is correct 

            self._sig_win_hide = self.window.window.connect("hide", self._on_window_hide) 

            self._sig_win_show = self.window.window.connect("show", self._on_window_show) 

            if self.window.visible(): 

                self.builder.get_object("menuitem_show_deluge").set_active(True) 

            else: 

                self.builder.get_object("menuitem_show_deluge").set_active(False) 

 

            # Show the Application Indicator 

            self.indicator.set_status(appindicator.STATUS_ACTIVE) 

 

        else: 

            log.debug("Enabling the system tray icon..") 

            if deluge.common.windows_check() or deluge.common.osx_check(): 

                self.tray = gtk.status_icon_new_from_pixbuf(get_logo(32)) 

            else: 

                try: 

                    self.tray = gtk.status_icon_new_from_icon_name("deluge") 

                except: 

                    log.warning("Update PyGTK to 2.10 or greater for SystemTray..") 

                    return 

 

            self.tray.connect("activate", self.on_tray_clicked) 

            self.tray.connect("popup-menu", self.on_tray_popup) 

 

        self.builder.get_object("download-limit-image").set_from_file( 

            deluge.common.get_pixmap("downloading16.png")) 

        self.builder.get_object("upload-limit-image").set_from_file( 

            deluge.common.get_pixmap("seeding16.png")) 

 

        client.register_event_handler("ConfigValueChangedEvent", self.config_value_changed) 

        if client.connected(): 

            # We're connected so we need to get some values from the core 

            self.__start() 

        else: 

            # Hide menu widgets because we're not connected to a host. 

            for widget in self.hide_widget_list: 

                self.builder.get_object(widget).hide() 

 

    def __start(self): 

        if self.config["enable_system_tray"]: 

 

            if self.config["classic_mode"]: 

                try: 

                    self.hide_widget_list.remove("menuitem_quitdaemon") 

                    self.hide_widget_list.remove("separatormenuitem4") 

                except ValueError: 

                    pass 

                self.builder.get_object("menuitem_quitdaemon").hide() 

                self.builder.get_object("separatormenuitem4").hide() 

 

            # Show widgets in the hide list because we've connected to a host 

            for widget in self.hide_widget_list: 

                self.builder.get_object(widget).show() 

 

            # Build the bandwidth speed limit menus 

            self.build_tray_bwsetsubmenu() 

 

            # Get some config values 

            def update_config_values(configs): 

                self._on_max_download_speed(configs["max_download_speed"]) 

                self._on_max_upload_speed(configs["max_upload_speed"]) 

            client.core.get_config_values(["max_download_speed", "max_upload_speed"]).addCallback(update_config_values) 

 

    def start(self): 

        self.__start() 

 

    def stop(self): 

        if self.config["enable_system_tray"] and not self.config["enable_appindicator"]: 

            try: 

                # Hide widgets in hide list because we're not connected to a host 

                for widget in self.hide_widget_list: 

                    self.builder.get_object(widget).hide() 

            except Exception as ex: 

                log.debug("Unable to hide system tray menu widgets: %s", ex) 

 

            self.tray.set_tooltip(_("Deluge") + "\n" + _("Not Connected...")) 

 

    def shutdown(self): 

        if self.config["enable_system_tray"]: 

            if appindicator and self.config["enable_appindicator"]: 

                self.indicator.set_status(appindicator.STATUS_PASSIVE) 

            else: 

                self.tray.set_visible(False) 

 

    def send_status_request(self): 

        client.core.get_session_status([ 

            "payload_upload_rate", 

            "payload_download_rate"]).addCallback(self._on_get_session_status) 

 

    def config_value_changed(self, key, value): 

        """This is called when we received a config_value_changed signal from 

        the core.""" 

        if key in self.config_value_changed_dict.keys(): 

            self.config_value_changed_dict[key](value) 

 

    def _on_max_download_speed(self, max_download_speed): 

        if self.max_download_speed != max_download_speed: 

            self.max_download_speed = max_download_speed 

            self.build_tray_bwsetsubmenu() 

 

    def _on_max_upload_speed(self, max_upload_speed): 

        if self.max_upload_speed != max_upload_speed: 

            self.max_upload_speed = max_upload_speed 

            self.build_tray_bwsetsubmenu() 

 

    def _on_get_session_status(self, status): 

        self.download_rate = deluge.common.fsize(status["payload_download_rate"]) 

        self.upload_rate = deluge.common.fsize(status["payload_upload_rate"]) 

 

    def update(self): 

        if not self.config["enable_system_tray"]: 

            return 

 

        # Tool tip text not available for appindicator 

        if appindicator and self.config["enable_appindicator"]: 

            if self.window.visible(): 

                self.builder.get_object("menuitem_show_deluge").set_active(True) 

            else: 

                self.builder.get_object("menuitem_show_deluge").set_active(False) 

            return 

 

        # Set the tool tip text 

        max_download_speed = self.max_download_speed 

        max_upload_speed = self.max_upload_speed 

 

        if max_download_speed == -1: 

            max_download_speed = _("Unlimited") 

        else: 

            max_download_speed = "%s %s" % (max_download_speed, _("KiB/s")) 

        if max_upload_speed == -1: 

            max_upload_speed = _("Unlimited") 

        else: 

            max_upload_speed = "%s %s" % (max_upload_speed, _("KiB/s")) 

 

        msg = '%s\n%s: %s (%s)\n%s: %s (%s)' % ( 

            _("Deluge"), _("Down"), self.download_rate, 

            max_download_speed, _("Up"), self.upload_rate, max_upload_speed 

        ) 

 

        # Set the tooltip 

        self.tray.set_tooltip(msg) 

 

        self.send_status_request() 

 

    def build_tray_bwsetsubmenu(self): 

        # Create the Download speed list sub-menu 

        submenu_bwdownset = build_menu_radio_list( 

            self.config["tray_download_speed_list"], self.on_tray_setbwdown, 

            self.max_download_speed, 

            _("KiB/s"), show_notset=True, show_other=True 

        ) 

 

        # Create the Upload speed list sub-menu 

        submenu_bwupset = build_menu_radio_list( 

            self.config["tray_upload_speed_list"], self.on_tray_setbwup, 

            self.max_upload_speed, 

            _("KiB/s"), show_notset=True, show_other=True 

        ) 

        # Add the sub-menus to the tray menu 

        self.builder.get_object("menuitem_download_limit").set_submenu( 

            submenu_bwdownset) 

        self.builder.get_object("menuitem_upload_limit").set_submenu( 

            submenu_bwupset) 

 

        # Show the sub-menus for all to see 

        submenu_bwdownset.show_all() 

        submenu_bwupset.show_all() 

 

    def disable(self, invert_app_ind_conf=False): 

        """Disables the system tray icon or appindicator.""" 

        try: 

            if invert_app_ind_conf: 

                app_ind_conf = not self.config["enable_appindicator"] 

            else: 

                app_ind_conf = self.config["enable_appindicator"] 

            if appindicator and app_ind_conf: 

                if hasattr(self, "_sig_win_hide"): 

                    self.window.window.disconnect(self._sig_win_hide) 

                    self.window.window.disconnect(self._sig_win_show) 

                    log.debug("Disabling the application indicator..") 

 

                self.indicator.set_status(appindicator.STATUS_PASSIVE) 

                del self.indicator 

            else: 

                log.debug("Disabling the system tray icon..") 

                self.tray.set_visible(False) 

                del self.tray 

            del self.builder 

            del self.tray_menu 

        except Exception as ex: 

            log.debug("Unable to disable system tray: %s", ex) 

 

    def blink(self, value): 

        try: 

            self.tray.set_blinking(value) 

        except AttributeError: 

            # If self.tray is not defined then ignore. This happens when the 

            # tray icon is not being used. 

            pass 

 

    def on_enable_system_tray_set(self, key, value): 

        """Called whenever the 'enable_system_tray' config key is modified""" 

        if value: 

            self.enable() 

        else: 

            self.disable() 

 

    def on_enable_appindicator_set(self, key, value): 

        """Called whenever the 'enable_appindicator' config key is modified""" 

        if self.__enabled_set_once: 

            self.disable(True) 

            self.enable() 

        self.__enabled_set_once = True 

 

    def on_tray_clicked(self, icon): 

        """Called when the tray icon is left clicked.""" 

        self.blink(False) 

 

        if self.window.active(): 

            self.window.hide() 

        else: 

            self.window.present() 

 

    def on_tray_popup(self, status_icon, button, activate_time): 

        """Called when the tray icon is right clicked.""" 

        self.blink(False) 

 

        if self.window.visible(): 

            self.builder.get_object("menuitem_show_deluge").set_active(True) 

        else: 

            self.builder.get_object("menuitem_show_deluge").set_active(False) 

 

        popup_function = gtk.status_icon_position_menu 

        if deluge.common.windows_check(): 

            popup_function = None 

            button = 0 

        self.tray_menu.popup(None, None, popup_function, button, activate_time, status_icon) 

 

    def on_menuitem_show_deluge_activate(self, menuitem): 

        log.debug("on_menuitem_show_deluge_activate") 

        if menuitem.get_active() and not self.window.visible(): 

            self.window.present() 

        elif not menuitem.get_active() and self.window.visible(): 

            self.window.hide() 

 

    def on_menuitem_add_torrent_activate(self, menuitem): 

        log.debug("on_menuitem_add_torrent_activate") 

        component.get("AddTorrentDialog").show() 

 

    def on_menuitem_pause_session_activate(self, menuitem): 

        log.debug("on_menuitem_pause_session_activate") 

        client.core.pause_session() 

 

    def on_menuitem_resume_session_activate(self, menuitem): 

        log.debug("on_menuitem_resume_session_activate") 

        client.core.resume_session() 

 

    def on_menuitem_quit_activate(self, menuitem): 

        log.debug("on_menuitem_quit_activate") 

        self.window.quit() 

 

    def on_menuitem_quitdaemon_activate(self, menuitem): 

        log.debug("on_menuitem_quitdaemon_activate") 

        self.window.quit(shutdown=True) 

 

    def on_tray_setbwdown(self, widget, data=None): 

        if isinstance(widget, gtk.RadioMenuItem): 

            # ignore previous radiomenuitem value 

            if not widget.get_active(): 

                return 

        self.setbwlimit(widget, _("Download Speed Limit"), _("Set the maximum download speed"), 

                        "max_download_speed", "tray_download_speed_list", self.max_download_speed, 

                        "downloading.svg") 

 

    def on_tray_setbwup(self, widget, data=None): 

        if isinstance(widget, gtk.RadioMenuItem): 

            # ignore previous radiomenuitem value 

            if not widget.get_active(): 

                return 

        self.setbwlimit(widget, _("Upload Speed Limit"), _("Set the maximum upload speed"), 

                        "max_upload_speed", "tray_upload_speed_list", self.max_upload_speed, 

                        "seeding.svg") 

 

    def _on_window_hide(self, widget, data=None): 

        """_on_window_hide - update the menuitem's status""" 

        log.debug("_on_window_hide") 

        self.builder.get_object("menuitem_show_deluge").set_active(False) 

 

    def _on_window_show(self, widget, data=None): 

        """_on_window_show - update the menuitem's status""" 

        log.debug("_on_window_show") 

        self.builder.get_object("menuitem_show_deluge").set_active(True) 

 

    def setbwlimit(self, widget, header, text, core_key, ui_key, default, image): 

        """Sets the bandwidth limit based on the user selection.""" 

        def set_value(value): 

            log.debug('setbwlimit: %s', value) 

            if value is None: 

                return 

            elif value == 0: 

                value = -1 

            # Set the config in the core 

            client.core.set_config({core_key: value}) 

 

        if widget.get_name() == "unlimited": 

            set_value(-1) 

        elif widget.get_name() == "other": 

            dialog = dialogs.OtherDialog(header, text, _("KiB/s"), image, default) 

            dialog.run().addCallback(set_value) 

        else: 

            set_value(widget.get_children()[0].get_text().split(" ")[0])