profiling switching works on linux and maybe on osx, not yet tested
[stack/code/dboxswitch.git] / gui.py
1 # -*- coding: utf-8 -*-
2
3 """
4 Dboxswitch dropbox profile switcher
5
6 license: Modified BSD License
7
8 Copyright (c) 2012,  <stack@inventati.org>
9 All rights reserved.
10
11 Redistribution and use in source and binary forms, with or without
12 modification, are permitted provided that the following conditions are met:
13     * Redistributions of source code must retain the above copyright
14       notice, this list of conditions and the following disclaimer.
15     * Redistributions in binary form must reproduce the above copyright
16       notice, this list of conditions and the following disclaimer in the
17       documentation and/or other materials provided with the distribution.
18     * Neither the name of the <organization> nor the
19       names of its contributors may be used to endorse or promote products
20       derived from this software without specific prior written permission.
21
22 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
23 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
26 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 """
34 import sys
35 import os
36 from PyQt4 import QtGui
37 from PyQt4.QtCore import SIGNAL
38 from qmenutooltip import QMenuToolTip
39
40 from apperror import AppError
41 from settings import appconf
42
43 class Gui(QtGui.QDialog):
44     def __init__(self, prManager):
45         """ Gui init, an QApplication is created and stored here, also a main window and a trayIcon
46         are created.
47         Default actions are builded and profile manager stored from argument (instance of ProfHandler """
48
49         self.app = QtGui.QApplication(sys.argv)
50     
51         #check if system tray is avaiable on the system
52         if not QtGui.QSystemTrayIcon.isSystemTrayAvailable():
53             QtGui.QMessageBox.critical(None, "Systray",
54                     "I couldn't detect any system tray on this system.")
55             sys.exit(1)
56         
57         QtGui.QApplication.setQuitOnLastWindowClosed(False)
58     
59         super(Gui, self).__init__()
60
61         self.createActions()
62         self.createTrayIcon()
63
64         self.trayIcon.show()
65
66         self.setWindowTitle("Profile manager / Dboxswitch - dropbox profile switcher")
67         self.resize(200, 200)
68
69         self.profileManager = prManager
70
71     def main(self): 
72         """ Like Gtk application this main executes the app, thi is somewhat writed for
73         compatibility in porting the app """
74
75         sys.exit(self.app.exec_())
76
77     def closeEvent(self, event):
78         """ Handle application closing """
79
80         if self.trayIcon.isVisible():
81             self.hide()
82             event.ignore()
83
84     def createActions(self):
85         """ Create actions for the various components """
86
87         self.manageprofiles = QtGui.QAction("Manage &Profiles", self,
88                 triggered=self.hide)
89         self.quitAction = QtGui.QAction("&Quit", self,
90                 triggered=QtGui.qApp.quit)
91
92         #profile manager component
93         self.addProfile = QtGui.QAction("  Add &Profile  ", self,
94                 triggered=self.addProfile, icon=QtGui.QIcon(appconf.icon))
95
96
97     def createTrayIcon(self):
98          """ Builds a new tray icon with a context menu and an action for the profile manager menu """
99
100          #context menu build, right click
101          self.trayIconMenu = QtGui.QMenu(self)
102          self.trayIconMenu.addAction(self.manageprofiles)
103          self.trayIconMenu.addSeparator()
104          self.trayIconMenu.addAction(self.quitAction)
105
106          #create the tray with an incon
107          self.trayIcon = QtGui.QSystemTrayIcon(QtGui.QIcon(appconf.icon), self.app)
108          #attach a context menu for the right click to the tray
109          self.trayIcon.setContextMenu(self.trayIconMenu)
110          #baloon on hover for the tray
111          self.trayIcon.setToolTip(appconf.appname+" "+appconf.appversion+"\nRight Click to manage profiles.")
112          #left click profiles show for the tray
113          self.trayIcon.activated.connect(self.showTrayProfiles)
114
115
116     def showTrayProfiles(self,reason):
117         """ Pops up a system tray profile Manager with a list of activable profiles and an 
118         action to add a new One """
119
120         if reason in (QtGui.QSystemTrayIcon.Trigger, QtGui.QSystemTrayIcon.DoubleClick):
121             self.menuProfiles = QMenuToolTip()
122             self.menuProfiles.setTitle("Profiles")
123
124             #Get profiles from the ProfHandler embedded in the gui
125             profiles = self.profileManager.getProfilesList()
126
127             for pr in profiles:
128                 #pr is a profile path
129                 receiver = self.activateProfileAction(pr)
130                 pr = os.path.basename(pr)
131                 menuItem_Profile = self.menuProfiles.addAction(pr)
132                 #Using lambda function to pass additional arguments to the function, in this case the path of the profile
133                 self.connect(menuItem_Profile, SIGNAL('triggered()'), receiver)
134                 #set menu item ToolTip
135                 menuItem_Profile.setToolTip("Activate profile: "+pr)
136
137                 self.menuProfiles.addAction(menuItem_Profile)
138
139             self.menuProfiles.addSeparator()
140             #action and menu item for adding a New Profile
141             self.menuProfiles.addAction(self.addProfile)
142
143             self.menuProfiles.activateWindow()
144             self.menuProfiles.popup(QtGui.QCursor.pos())
145
146     def activateProfileAction(self, pr):
147         """ Returns a callable to be passed as an action for the switching profile mechanism 
148         to self.connect(menuItem_Profile... 
149         It compiles a function with a profile name as argument and also handle the displaying of errors."""
150
151         def f():
152             try:
153                 self.profileManager.activateProfile(pr)
154             except AppError, e:
155                 self.showError(str(e))
156         return f
157
158     def addProfile(self):
159         """ Gui frontend to add a new Profile, it requests the user a profile name 
160         through a QInputDialog and creates a new profile with the help of the ProfHandler embedded in the Gui """
161
162         self.setWindowTitle("Add New Profile - Dboxswitch - dropbox profile switcher")
163         self.resize(300, 100)
164         text, ok = QtGui.QInputDialog.getText(self, 'Input Dialog', 
165                             'Enter profile name:')
166         if ok:
167             try:
168                 self.profileManager.addProfile(unicode(text))
169             except AppError, e:
170                 self.showError(str(e))
171
172     def showError(self, err):
173         """ Display an error message through a QErrorMessage """
174
175         self.setWindowTitle("Error - Dboxswitch - dropbox profile switcher")
176         self.resize(200, 100)
177         err = QtGui.QErrorMessage.showMessage(QtGui.QErrorMessage.qtHandler(), "Error: "+err)