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-2004, Kern E. Sibbald
35 // Implementation of a system tray icon & menu for Bacula
39 #include "winbacula.h"
40 #include "winservice.h"
45 #ifdef properties_implemented
46 const UINT MENU_PROPERTIES_SHOW = RegisterWindowMessage("Bacula.Properties.User.Show");
47 const UINT MENU_DEFAULT_PROPERTIES_SHOW = RegisterWindowMessage("Bacula.Properties.Default.Show");
49 const UINT MENU_ABOUTBOX_SHOW = RegisterWindowMessage("Bacula.AboutBox.Show");
50 const UINT MENU_STATUS_SHOW = RegisterWindowMessage("Bacula.Status.Show");
51 const char *MENU_CLASS_NAME = "BaculaFD Tray Icon";
53 extern void terminate_filed(int sig);
54 extern char *bac_status(char *buf, int buf_len);
61 // Create a dummy window to handle tray icon messages
64 wndclass.cbSize = sizeof(wndclass);
66 wndclass.lpfnWndProc = bacMenu::WndProc;
67 wndclass.cbClsExtra = 0;
68 wndclass.cbWndExtra = 0;
69 wndclass.hInstance = hAppInstance;
70 wndclass.hIcon = LoadIcon(NULL, IDI_APPLICATION);
71 wndclass.hCursor = LoadCursor(NULL, IDC_ARROW);
72 wndclass.hbrBackground = (HBRUSH) GetStockObject(WHITE_BRUSH);
73 wndclass.lpszMenuName = (const char *) NULL;
74 wndclass.lpszClassName = MENU_CLASS_NAME;
75 wndclass.hIconSm = LoadIcon(NULL, IDI_APPLICATION);
77 RegisterClassEx(&wndclass);
79 m_hwnd = CreateWindow(MENU_CLASS_NAME,
94 // record which client created this window
95 SetWindowLong(m_hwnd, GWL_USERDATA, (LONG) this);
97 // Timer to trigger icon updating
98 SetTimer(m_hwnd, 1, 5000, NULL);
100 // Load the icons for the tray
101 m_idle_icon = LoadIcon(hAppInstance, MAKEINTRESOURCE(IDI_IDLE));
102 m_running_icon = LoadIcon(hAppInstance, MAKEINTRESOURCE(IDI_RUNNING));
103 m_error_icon = LoadIcon(hAppInstance, MAKEINTRESOURCE(IDI_JOB_ERROR));
104 m_warn_icon = LoadIcon(hAppInstance, MAKEINTRESOURCE(IDI_JOB_WARNING));
106 // Load the popup menu
107 m_hmenu = LoadMenu(hAppInstance, MAKEINTRESOURCE(IDR_TRAYMENU));
109 // Install the tray icon!
115 // Remove the tray icon
118 // Destroy the loaded menu
120 DestroyMenu(m_hmenu);
124 bacMenu::AddTrayIcon()
126 SendTrayMsg(NIM_ADD, bacstat);
130 bacMenu::DelTrayIcon()
132 SendTrayMsg(NIM_DELETE, 0);
137 bacMenu::UpdateTrayIcon(int bacstat)
139 (void)bac_status(NULL, 0);
140 SendTrayMsg(NIM_MODIFY, bacstat);
144 bacMenu::SendTrayMsg(DWORD msg, int bacstat)
146 struct s_last_job *job;
148 // Create the tray icon message
150 m_nid.cbSize = sizeof(m_nid);
151 m_nid.uID = IDI_BACULA; // never changes after construction
154 m_nid.hIcon = m_idle_icon;
157 m_nid.hIcon = m_running_icon;
159 case JS_ErrorTerminated:
160 m_nid.hIcon = m_error_icon;
163 if (last_jobs->size() > 0) {
164 job = (struct s_last_job *)last_jobs->last();
166 m_nid.hIcon = m_warn_icon;
168 m_nid.hIcon = m_idle_icon;
171 m_nid.hIcon = m_idle_icon;
176 m_nid.uFlags = NIF_ICON | NIF_MESSAGE;
177 m_nid.uCallbackMessage = WM_TRAYNOTIFY;
180 // Use resource string as tip if there is one
181 if (LoadString(hAppInstance, IDI_BACULA, m_nid.szTip, sizeof(m_nid.szTip))) {
182 m_nid.uFlags |= NIF_TIP;
185 // Try to add the Bacula status to the tip string, if possible
186 if (m_nid.uFlags & NIF_TIP) {
187 bac_status(m_nid.szTip, sizeof(m_nid.szTip));
191 if (Shell_NotifyIcon(msg, &m_nid)) {
192 EnableMenuItem(m_hmenu, ID_CLOSE, MF_ENABLED);
194 if (!bacService::RunningAsService()) {
195 if (msg == NIM_ADD) {
196 // The tray icon couldn't be created, so use the Properties dialog
197 // as the main program window
198 // removed because it causes quit when not running as a
199 // service in use with BartPe.
200 // PostQuitMessage(0);
206 // Process window messages
207 LRESULT CALLBACK bacMenu::WndProc(HWND hwnd, UINT iMsg, WPARAM wParam, LPARAM lParam)
209 // This is a static method, so we don't know which instantiation we're
210 // dealing with. We use Allen Hadden's (ahadden@taratec.com) suggestion
211 // from a newsgroup to get the pseudo-this.
212 bacMenu *_this = (bacMenu *) GetWindowLong(hwnd, GWL_USERDATA);
216 // Every five seconds, a timer message causes the icon to update
218 if (bacService::RunningAsService()) {
219 // Attempt to add the icon if it's not already there
220 _this->AddTrayIcon();
224 _this->UpdateTrayIcon(bacstat);
227 // STANDARD MESSAGE HANDLING
232 // User has clicked an item on the tray menu
233 switch (LOWORD(wParam)) {
235 // Show the status dialog
236 _this->m_status.Show(TRUE);
237 _this->UpdateTrayIcon(bacstat);
241 // Show the About box
242 _this->m_about.Show(TRUE);
246 // User selected Close from the tray menu
247 PostMessage(hwnd, WM_CLOSE, 0, 0);
254 // User has clicked on the tray icon or the menu
256 // Get the submenu to use as a pop-up menu
257 HMENU submenu = GetSubMenu(_this->m_hmenu, 0);
259 // What event are we responding to, RMB click?
260 if (lParam==WM_RBUTTONUP) {
261 if (submenu == NULL) {
265 // Make the first menu item the default (bold font)
266 SetMenuDefaultItem(submenu, 0, TRUE);
268 // Get the current cursor position, to display the menu at
270 GetCursorPos(&mouse);
273 // (Microsoft calls it a feature) in Windows 95 that requires calling
274 // SetForegroundWindow. To find out more, search for Q135788 in MSDN.
276 SetForegroundWindow(_this->m_nid.hWnd);
278 // Display the menu at the desired position
279 TrackPopupMenu(submenu,
280 0, mouse.x, mouse.y, 0,
281 _this->m_nid.hWnd, NULL);
286 // Or was there a LMB double click?
287 if (lParam==WM_LBUTTONDBLCLK) {
288 // double click: execute first menu item
289 SendMessage(_this->m_nid.hWnd,
291 GetMenuItemID(submenu, 0),
299 if (bacService::RunningAsService()) {
300 _this->DelTrayIcon();
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
327 if (iMsg == MENU_ABOUTBOX_SHOW) {
328 // External request to show our About dialog
329 PostMessage(hwnd, WM_COMMAND, MAKELONG(ID_ABOUT, 0), 0);
332 if (iMsg == MENU_STATUS_SHOW) {
333 // External request to show our status
334 PostMessage(hwnd, WM_COMMAND, MAKELONG(ID_STATUS, 0), 0);
339 // Message not recognised
340 return DefWindowProc(hwnd, iMsg, wParam, lParam);