Kiln » TortoiseHg » TortoiseHg
Clone URL:  
TortoiseHgOverlayServer.py
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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
# Creates a task-bar icon. Run from Python.exe to see the # messages printed. Takes an optional logfile as first command # line parameter import sys if hasattr(sys, "frozen"): class BlackHole(object): closed = True softspace = 0 def write(self, data): pass def close(self): pass def flush(self): pass sys.stdout = BlackHole() sys.stderr = BlackHole() import os import time import threading import cStringIO import Queue import traceback import gc try: from win32api import * from win32gui import * import win32pipe import win32con import win32event import win32file import winerror import pywintypes import win32security except ImportError, e: print 'Fatal error at startup', e sys.exit(1) from mercurial import demandimport demandimport.ignore.append('win32com.shell') demandimport.enable() from mercurial import ui, error from mercurial.windows import posixfile, unlink, rename from tortoisehg.util.i18n import agettext as _ from tortoisehg.util import thread2, paths, shlib, version APP_TITLE = _('TortoiseHg Overlay Icon Server') EXIT_CMD = 1025 class Logger(): def __init__(self): self.file = None def setfile(self, name): oname = name + '.old' try: rename(name, oname) except: pass self.file = posixfile(name, 'wb') self.msg('%s, Version %s' % (APP_TITLE, version.version())) self.msg('Logging to file started') def msg(self, msg): ts = '[%s] ' % time.strftime('%c') f = self.file if f: f.write(ts + msg + '\n') f.flush() os.fsync(f.fileno()) print 'L' + ts + msg else: print ts + msg logger = Logger() def SetIcon(hwnd, name, add=False): # Try and find a custom icon if '--noicon' in sys.argv: return print "SetIcon(%s)" % name hinst = GetModuleHandle(None) from tortoisehg.util.paths import get_tortoise_icon iconPathName = get_tortoise_icon(name) if iconPathName and os.path.isfile(iconPathName): icon_flags = win32con.LR_LOADFROMFILE | win32con.LR_DEFAULTSIZE hicon = LoadImage(hinst, iconPathName, win32con.IMAGE_ICON, 0, 0, icon_flags) else: print "Can't find a Python icon file - using default" hicon = LoadIcon(0, win32con.IDI_APPLICATION) flags = NIF_ICON | NIF_MESSAGE | NIF_TIP nid = (hwnd, 0, flags, win32con.WM_USER+20, hicon, APP_TITLE) action = NIM_MODIFY if add: action = NIM_ADD try: Shell_NotifyIcon(action, nid) except pywintypes.error: # This is common when windows is starting, and this code is hit # before the taskbar has been created. print "Failed to add the taskbar icon - is explorer running?" # but keep running anyway - when explorer starts, we get the # TaskbarCreated message. class MainWindow: def __init__(self): self.pipethread = None msg_TaskbarRestart = RegisterWindowMessage("TaskbarCreated"); message_map = { msg_TaskbarRestart: self.OnRestart, win32con.WM_DESTROY: self.OnDestroy, win32con.WM_COMMAND: self.OnCommand, win32con.WM_USER+20 : self.OnTaskbarNotify, } # Register the Window class. wc = WNDCLASS() hinst = wc.hInstance = GetModuleHandle(None) wc.lpszClassName = "THgRpcServer" wc.style = win32con.CS_VREDRAW | win32con.CS_HREDRAW; wc.hCursor = LoadCursor( 0, win32con.IDC_ARROW ) wc.hbrBackground = win32con.COLOR_WINDOW wc.lpfnWndProc = message_map # could also specify a wndproc. classAtom = RegisterClass(wc) # Create the Window. style = win32con.WS_OVERLAPPED | win32con.WS_SYSMENU self.hwnd = CreateWindow( classAtom, APP_TITLE, style, \ 0, 0, win32con.CW_USEDEFAULT, win32con.CW_USEDEFAULT, \ 0, 0, hinst, None) UpdateWindow(self.hwnd) self._DoCreateIcons() def _DoCreateIcons(self): show, highlight = get_config() if show: SetIcon(self.hwnd, "hg.ico", add=True) # start namepipe server for hg status self.start_pipe_server() def OnRestart(self, hwnd, msg, wparam, lparam): logger.msg("MainWindow.OnRestart") self._DoCreateIcons() def OnDestroy(self, hwnd, msg, wparam, lparam): logger.msg("MainWindow.OnDestroy") nid = (self.hwnd, 0) try: Shell_NotifyIcon(NIM_DELETE, nid) except pywintypes.error: pass # happens when we run without icon PostQuitMessage(0) # Terminate the app. def OnTaskbarNotify(self, hwnd, msg, wparam, lparam): if lparam==win32con.WM_RBUTTONUP or lparam==win32con.WM_LBUTTONUP: menu = CreatePopupMenu() # AppendMenu(menu, win32con.MF_SEPARATOR, 0, '') AppendMenu(menu, win32con.MF_STRING, EXIT_CMD, _('Exit')) pos = GetCursorPos() # See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/menus_0hdi.asp try: SetForegroundWindow(self.hwnd) TrackPopupMenu(menu, win32con.TPM_LEFTALIGN, pos[0], pos[1], 0, self.hwnd, None) PostMessage(self.hwnd, win32con.WM_NULL, 0, 0) except pywintypes.error: pass return 1 def OnCommand(self, hwnd, msg, wparam, lparam): id = LOWORD(wparam) if id == EXIT_CMD: self.exit_application() else: print "Unknown command -", id def exit_application(self): logger.msg("MainWindow.exit_application") if self.stop_pipe_server(): DestroyWindow(self.hwnd) logger.msg("Goodbye") def stop_pipe_server(self): logger.msg("MainWindow.stop_pipe_server") if not self.pipethread.isAlive(): logger.msg("pipethread is not alive") return True # Try the nice way first self.svc.SvcStop() max_try = 10 cnt = 1 while cnt <= max_try and self.pipethread.isAlive(): print "testing pipe [try %d] ..." % cnt try: try: self.pipethread.terminate() except ValueError: pass win32pipe.CallNamedPipe(PIPENAME, '', PIPEBUFSIZE, 0) except: logger.msg(traceback.format_exc()) pass cnt += 1 if self.pipethread.isAlive(): msg = "WARNING: unable to stop server after %d trys." % max_try logger.msg(msg) return False else: return True def start_pipe_server(self): if self.pipethread is not None: return def servepipe(): self.svc = PipeServer(self.hwnd) self.svc.SvcDoRun() self.pipethread = thread2.Thread(target=servepipe) self.pipethread.start() PIPENAME = r"\\.\pipe\TortoiseHgRpcServer-bc0c27107423-" PIPENAME += GetUserName() PIPEBUFSIZE = 4096 def getrepos(batch): roots = set() notifypaths = set() for path in batch: r = paths.find_root(path) if r is None: try: for n in os.listdir(path): r = paths.find_root(os.path.join(path, n)) if (r is not None): roots.add(r) notifypaths.add(r) except Exception, e: # This exception raises in case of fixutf8 extension enabled # and folder name contains '0x5c'(backslash). logger.msg('Failed listdir %s (%s)' % (path, str(e))) else: roots.add(r); notifypaths.add(path) return roots, notifypaths def update_batch(batch): '''updates thgstatus for all paths in batch''' roots, notifypaths = getrepos(batch) if roots: _ui = ui.ui(); failedroots = set() errorstream = cStringIO.StringIO() _stderr = sys.stderr sys.stderr = errorstream try: for r in sorted(roots): try: shlib.update_thgstatus(_ui, r, wait=False) shlib.shell_notify([r]) logger.msg('Updated ' + r) except (IOError, OSError): print "IOError or OSError on updating %s (check permissions)" % r logger.msg('Failed updating %s (check permissions)' % r) failedroots.add(r) except (error.Abort, error.ConfigError, error.RepoError, error.RevlogError, ImportError), e: logger.msg('Failed updating %s (%s)' % (r, str(e))) failedroots.add(r) notifypaths -= failedroots if notifypaths: time.sleep(2) shlib.shell_notify(list(notifypaths)) logger.msg('Shell notified') errmsg = errorstream.getvalue() if errmsg: logger.msg('stderr: %s' % errmsg) finally: sys.stderr = _stderr requests = Queue.Queue(0) def get_config(): show_taskbaricon = True hgighlight_taskbaricon = True version2cmenu = False try: from _winreg import HKEY_CURRENT_USER, OpenKey, QueryValueEx hkey = OpenKey(HKEY_CURRENT_USER, r'Software\TortoiseHg') t = ('1', 'True') try: show_taskbaricon = QueryValueEx(hkey, 'ShowTaskbarIcon')[0] in t except EnvironmentError: pass try: hgighlight_taskbaricon = QueryValueEx(hkey, 'HighlightTaskbarIcon')[0] in t except EnvironmentError: pass # Upgrade user's context menu, once per major release try: version2cmenu = QueryValueEx(hkey, 'ContextMenuVersion')[0] == '2' except EnvironmentError: pass try: if not version2cmenu: from _winreg import CreateKey, SetValueEx, REG_SZ try: promoted = QueryValueEx(hkey, 'PromotedItems')[0] except EnvironmentError: promoted = '' plist = [i.strip() for i in promoted.split(',')] hkey = CreateKey(HKEY_CURRENT_USER, r'Software\TortoiseHg') if u'log' in plist: idx = plist.index(u'log') plist[idx] = u'workbench' SetValueEx(hkey, 'PromotedItems', 0, REG_SZ, ','.join(plist)) SetValueEx(hkey, 'ContextMenuVersion', 0, REG_SZ, '2') except EnvironmentError: pass except (ImportError, WindowsError): pass return (show_taskbaricon, hgighlight_taskbaricon) def update(args, hwnd): batch = [] r = args[0] print "got update request %s (first in batch)" % r batch.append(r) print "wait a bit for additional requests..." show, highlight = get_config() if show and highlight: SetIcon(hwnd, "hgB.ico") time.sleep(0.2) deferred_requests = [] try: while True: req = requests.get_nowait() s = req.split('|') cmd, args = s[0], s[1:] if cmd == 'update': print "got update request %s" % req batch.append(args[0]) else: deferred_requests.append(req) except Queue.Empty: pass for req in deferred_requests: requests.put(req) msg = "processing batch with %i update requests" print msg % len(batch) update_batch(batch) if show and highlight: SetIcon(hwnd, "hg.ico") def remove(args): path = args[0] logger.msg('Removing ' + path) roots, notifypaths = getrepos([path]) if roots: for r in sorted(roots): tfn = os.path.join(r, '.hg', 'thgstatus') try: f = posixfile(tfn, 'rb') e = f.readline() f.close() if not e.startswith('@@noicons'): unlink(tfn) except (IOError, OSError), e: logger.msg("Error while trying to remove %s (%s)" % (tfn, e)) pass if notifypaths: shlib.shell_notify(list(notifypaths)) def dispatch(req, cmd, args, hwnd): print "dispatch(%s)" % req if cmd == 'update': update(args, hwnd) elif cmd == 'remove': remove(args) elif cmd == 'error': logger.msg("**** Error: %s" % args[0]) else: logger.msg("**** Error: unknown request '%s'" % req) class Updater(threading.Thread): def __init__(self, hwnd): threading.Thread.__init__(self) self.hwnd = hwnd def run(self): while True: req = requests.get() s = req.split('|') cmd, args = s[0], s[1:] if cmd == 'terminate': logger.msg('Updater thread terminating') return dispatch(req, cmd, args, self.hwnd) gc.collect() class PipeServer: def __init__(self, hwnd): self.hwnd = hwnd self.updater = Updater(hwnd) self.updater.start() # Create an event which we will use to wait on. # The "service stop" request will set this event. self.hWaitStop = win32event.CreateEvent(None, 0, 0, None) # We need to use overlapped IO for this, so we dont block when # waiting for a client to connect. This is the only effective way # to handle either a client connection, or a service stop request. self.overlapped = pywintypes.OVERLAPPED() # And create an event to be used in the OVERLAPPED object. self.overlapped.hEvent = win32event.CreateEvent(None,0,0,None) def SvcStop(self): logger.msg("PipeServer.SvcStop") win32event.SetEvent(self.hWaitStop) requests.put('terminate|') def SvcDoRun(self): logger.msg("PipeServer.SvcDoRun") # We create our named pipe. pipeName = PIPENAME openMode = win32pipe.PIPE_ACCESS_DUPLEX | win32file.FILE_FLAG_OVERLAPPED pipeMode = win32pipe.PIPE_TYPE_MESSAGE # When running as a service, we must use special security for the pipe sa = pywintypes.SECURITY_ATTRIBUTES() # Say we do have a DACL, and it is empty # (ie, allow full access!) sa.SetSecurityDescriptorDacl ( 1, None, 0 ) pipeHandle = win32pipe.CreateNamedPipe(pipeName, openMode, pipeMode, win32pipe.PIPE_UNLIMITED_INSTANCES, 0, 0, 6000, # default buffers, and 6 second timeout. sa) # Loop accepting and processing connections while True: try: hr = win32pipe.ConnectNamedPipe(pipeHandle, self.overlapped) except pywintypes.error, inst: logger.msg("Error connecting pipe: %s" % inst) pipeHandle.Close() break if hr==winerror.ERROR_PIPE_CONNECTED: # Client is fast, and already connected - signal event win32event.SetEvent(self.overlapped.hEvent) # Wait for either a connection, or a service stop request. timeout = win32event.INFINITE waitHandles = self.hWaitStop, self.overlapped.hEvent rc = win32event.WaitForMultipleObjects(waitHandles, 0, timeout) if rc==win32event.WAIT_OBJECT_0: # Stop event return else: # read pipe and process request try: hr, data = win32file.ReadFile(pipeHandle, PIPEBUFSIZE) if not data: raise SystemExit # signal by dispatch terminate win32pipe.DisconnectNamedPipe(pipeHandle) except win32file.error: # Client disconnected without sending data # or before reading the response. # Thats OK - just get the next connection continue try: requests.put(data) if data == 'terminate|': logger.msg('PipeServer received terminate from pipe') PostMessage(self.hwnd, win32con.WM_COMMAND, EXIT_CMD, 0) break except SystemExit: raise SystemExit # interrupted by thread2.terminate() except: logger.msg("WARNING: something went wrong in requests.put") logger.msg(traceback.format_exc()) status = "ERROR" # Clean up when we exit self.SvcStop() RUNMUTEXNAME = 'thgtaskbar-' + GetUserName() def ehook(etype, values, tracebackobj): elist = traceback.format_exception(etype, values, tracebackobj) logger.msg(''.join(elist)) def main(): args = sys.argv[1:] sa = win32security.SECURITY_ATTRIBUTES() sa.SetSecurityDescriptorDacl(1, None, 0) # allow full access runmutex = win32event.CreateMutex(sa, 1, RUNMUTEXNAME) if GetLastError() == winerror.ERROR_ALREADY_EXISTS: print "another instance is already running" return logfilename = None for arg in args: if arg[0] == '-': pass else: logfilename = arg if logfilename: logger.setfile(logfilename) else: try: from win32com.shell import shell, shellcon appdir = shell.SHGetSpecialFolderPath(0, shellcon.CSIDL_APPDATA) except pywintypes.com_error: appdir = os.environ['APPDATA'] logfilename = os.path.join(appdir, 'TortoiseHg', 'OverlayServerLog.txt') try: os.makedirs(os.path.dirname(logfilename)) except EnvironmentError: pass logger.setfile(logfilename) sys.excepthook = ehook w=MainWindow() PumpMessages() if __name__=='__main__': main()