1 // Copyright (C) 1999 AT&T Laboratories Cambridge. All Rights Reserved.
3 // This file was part of the vnc system.
5 // The vnc system is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation; either version 2 of the License, or
8 // (at your option) any later version.
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
20 // If the source code for the vnc system is not available from the place
21 // whence you received this file, check http://www.uk.research.att.com/vnc or contact
22 // the authors on vnc@uk.research.att.com for information on obtaining it.
24 // This file has been adapted to the Win32 version of Bacula
25 // by Kern E. Sibbald. Many thanks to ATT and James Weatherall,
26 // the original author, for providing an excellent template.
28 // Copyright (2000-2003) Kern E. Sibbald
35 // Implementation of a system tray icon & menu for Bacula
37 #include "winbacula.h"
38 #include "winservice.h"
46 #ifdef properties_implemented
47 const UINT MENU_PROPERTIES_SHOW = RegisterWindowMessage("Bacula.Properties.User.Show");
48 const UINT MENU_DEFAULT_PROPERTIES_SHOW = RegisterWindowMessage("Bacula.Properties.Default.Show");
50 const UINT MENU_ABOUTBOX_SHOW = RegisterWindowMessage("Bacula.AboutBox.Show");
51 const UINT MENU_STATUS_SHOW = RegisterWindowMessage("Bacula.Status.Show");
52 const UINT MENU_EVENTS_SHOW = RegisterWindowMessage("Bacula.Events.Show");
53 const UINT MENU_SERVICEHELPER_MSG = RegisterWindowMessage("Bacula.ServiceHelper.Message");
54 const UINT MENU_ADD_CLIENT_MSG = RegisterWindowMessage("Bacula.AddClient.Message");
55 const char *MENU_CLASS_NAME = "Bacula Tray Icon";
57 extern char *bac_status(int stat);
64 // Create a dummy window to handle tray icon messages
67 wndclass.cbSize = sizeof(wndclass);
69 wndclass.lpfnWndProc = bacMenu::WndProc;
70 wndclass.cbClsExtra = 0;
71 wndclass.cbWndExtra = 0;
72 wndclass.hInstance = hAppInstance;
73 wndclass.hIcon = LoadIcon(NULL, IDI_APPLICATION);
74 wndclass.hCursor = LoadCursor(NULL, IDC_ARROW);
75 wndclass.hbrBackground = (HBRUSH) GetStockObject(WHITE_BRUSH);
76 wndclass.lpszMenuName = (const char *) NULL;
77 wndclass.lpszClassName = MENU_CLASS_NAME;
78 wndclass.hIconSm = LoadIcon(NULL, IDI_APPLICATION);
80 RegisterClassEx(&wndclass);
82 m_hwnd = CreateWindow(MENU_CLASS_NAME,
97 // record which client created this window
98 SetWindowLong(m_hwnd, GWL_USERDATA, (LONG) this);
100 // Timer to trigger icon updating
101 SetTimer(m_hwnd, 1, 5000, NULL);
103 // Load the icons for the tray
104 m_idle_icon = LoadIcon(hAppInstance, MAKEINTRESOURCE(IDI_IDLE));
105 m_running_icon = LoadIcon(hAppInstance, MAKEINTRESOURCE(IDI_RUNNING));
106 m_error_icon = LoadIcon(hAppInstance, MAKEINTRESOURCE(IDI_JOB_ERROR));
108 // Load the popup menu
109 m_hmenu = LoadMenu(hAppInstance, MAKEINTRESOURCE(IDR_TRAYMENU));
111 // Install the tray icon!
117 // Remove the tray icon
118 SendTrayMsg(NIM_DELETE, 0);
120 // Destroy the loaded menu
122 DestroyMenu(m_hmenu);
126 bacMenu::AddTrayIcon()
128 SendTrayMsg(NIM_ADD, bacstat);
132 bacMenu::DelTrayIcon()
134 SendTrayMsg(NIM_DELETE, 0);
139 bacMenu::UpdateTrayIcon(int bacstat)
141 (void *)bac_status(0);
142 SendTrayMsg(NIM_MODIFY, bacstat);
146 bacMenu::SendTrayMsg(DWORD msg, int bacstat)
148 // Create the tray icon message
150 m_nid.cbSize = sizeof(m_nid);
151 m_nid.uID = IDI_BACULA; // never changes after construction
153 m_nid.hIcon = m_idle_icon;
154 else if (bacstat == 1)
155 m_nid.hIcon = m_running_icon;
156 else if (bacstat < 0)
157 m_nid.hIcon = m_error_icon;
159 m_nid.uFlags = NIF_ICON | NIF_MESSAGE;
160 m_nid.uCallbackMessage = WM_TRAYNOTIFY;
163 // Use resource string as tip if there is one
164 if (LoadString(hAppInstance, IDI_BACULA, m_nid.szTip, sizeof(m_nid.szTip))) {
165 m_nid.uFlags |= NIF_TIP;
168 // Try to add the Bacula status to the tip string, if possible
169 if (m_nid.uFlags & NIF_TIP) {
170 strncpy(m_nid.szTip, bac_status(0), (sizeof(m_nid.szTip)-1));
174 if (Shell_NotifyIcon(msg, &m_nid)) {
175 EnableMenuItem(m_hmenu, ID_CLOSE, MF_ENABLED);
177 if (!bacService::RunningAsService()) {
178 if (msg == NIM_ADD) {
179 // The tray icon couldn't be created, so use the Properties dialog
180 // as the main program window
187 // Process window messages
188 LRESULT CALLBACK bacMenu::WndProc(HWND hwnd, UINT iMsg, WPARAM wParam, LPARAM lParam)
190 // This is a static method, so we don't know which instantiation we're
191 // dealing with. We use Allen Hadden's (ahadden@taratec.com) suggestion
192 // from a newsgroup to get the pseudo-this.
193 bacMenu *_this = (bacMenu *) GetWindowLong(hwnd, GWL_USERDATA);
198 // Every five seconds, a timer message causes the icon to update
200 // *** HACK for running servicified
201 if (bacService::RunningAsService()) {
202 // Attempt to add the icon if it's not already there
203 _this->AddTrayIcon();
204 // Trigger a check of the current user
205 PostMessage(hwnd, WM_USERCHANGED, 0, 0);
209 _this->UpdateTrayIcon(bacstat);
212 // DEAL WITH NOTIFICATIONS FROM THE SERVER:
213 case WM_SRV_CLIENT_AUTHENTICATED:
214 case WM_SRV_CLIENT_DISCONNECT:
215 // Adjust the icon accordingly
216 _this->UpdateTrayIcon(bacstat);
219 // STANDARD MESSAGE HANDLING
224 // User has clicked an item on the tray menu
225 switch (LOWORD(wParam))
228 // Show the status dialog
229 _this->m_status.Show(TRUE);
230 _this->UpdateTrayIcon(bacstat);
234 // Show the Events dialog
235 _this->m_events.Show(TRUE);
236 _this->UpdateTrayIcon(bacstat);
241 // Disconnect all currently connected clients
245 // Show the About box
246 _this->m_about.Show(TRUE);
250 // User selected Close from the tray menu
251 PostMessage(hwnd, WM_CLOSE, 0, 0);
258 // User has clicked on the tray icon or the menu
260 // Get the submenu to use as a pop-up menu
261 HMENU submenu = GetSubMenu(_this->m_hmenu, 0);
263 // What event are we responding to, RMB click?
264 if (lParam==WM_RBUTTONUP) {
265 if (submenu == NULL) {
269 // Make the first menu item the default (bold font)
270 SetMenuDefaultItem(submenu, 0, TRUE);
272 // Get the current cursor position, to display the menu at
274 GetCursorPos(&mouse);
277 // (Microsoft calls it a feature) in Windows 95 that requires calling
278 // SetForegroundWindow. To find out more, search for Q135788 in MSDN.
280 SetForegroundWindow(_this->m_nid.hWnd);
282 // Display the menu at the desired position
283 TrackPopupMenu(submenu,
284 0, mouse.x, mouse.y, 0,
285 _this->m_nid.hWnd, NULL);
290 // Or was there a LMB double click?
291 if (lParam==WM_LBUTTONDBLCLK) {
292 // double click: execute first menu item
293 SendMessage(_this->m_nid.hWnd,
295 GetMenuItemID(submenu, 0),
306 // The user wants Bacula to quit cleanly...
310 case WM_QUERYENDSESSION:
311 // Are we running as a system service?
312 // Or is the system shutting down (in which case we should check anyway!)
313 if ((!bacService::RunningAsService()) || (lParam == 0)) {
314 // No, so we are about to be killed
316 // If there are remote connections then we should verify
317 // that the user is happy about killing them.
319 // Finally, post a quit message, just in case
324 // Tell the OS that we've handled it anyway
325 // PostQuitMessage(0);
330 if (iMsg == MENU_ABOUTBOX_SHOW) {
331 // External request to show our About dialog
332 PostMessage(hwnd, WM_COMMAND, MAKELONG(ID_ABOUT, 0), 0);
335 if (iMsg == MENU_STATUS_SHOW) {
336 // External request to show our status
337 PostMessage(hwnd, WM_COMMAND, MAKELONG(ID_STATUS, 0), 0);
341 if (iMsg == MENU_EVENTS_SHOW) {
342 // External request to show our Events dialogue
343 PostMessage(hwnd, WM_COMMAND, MAKELONG(ID_EVENTS, 0), 0);
347 if (iMsg == MENU_SERVICEHELPER_MSG) {
348 // External ServiceHelper message.
349 // This message holds a process id which we can use to
350 // impersonate a specific user. In doing so, we can load their
351 // preferences correctly
352 bacService::ProcessUserHelperMessage(wParam, lParam);
354 // - Trigger a check of the current user
355 PostMessage(hwnd, WM_USERCHANGED, 0, 0);
358 if (iMsg == MENU_ADD_CLIENT_MSG) {
359 // Add Client message. This message includes an IP address
360 // of a listening client, to which we should connect.
366 // Message not recognised
367 return DefWindowProc(hwnd, iMsg, wParam, lParam);